Version 9 (#340)

* Version 9, beta 1

* Prepare for stable version 9

* link to v8 [skip ci]

.eslintignore

@@ -11,4 +11,4 @@ samples
 
 main.d.ts
 
-docs
+docs

.eslintrc.cjs

@@ -0,0 +1,56 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ["./tsconfig.eslint.json"],
+    ecmaVersion: 2022,
+  },
+  plugins: ["@typescript-eslint", "node", "prettier"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:node/recommended",
+    "plugin:import/recommended",
+    "plugin:import/typescript",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "prettier",
+  ],
+  rules: {
+    "prettier/prettier": "error",
+    "@typescript-eslint/consistent-type-assertions": [
+      "warn",
+      {
+        assertionStyle: "angle-bracket",
+      },
+    ],
+    "@typescript-eslint/no-explicit-any": "off",
+    "node/file-extension-in-import": [
+      "error",
+      "always",
+      { tryExtensions: [".js", ".json", ".node"] },
+    ],
+    "node/no-missing-import": "off",
+    "node/no-unpublished-import": ["off"],
+    "import/no-unresolved": "error",
+    "import/no-named-as-default": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-argument": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "@typescript-eslint/unbound-method": "off",
+  },
+  settings: {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".tsx"],
+    },
+    "import/resolver": {
+      typescript: {
+        alwaysTryTypes: true,
+        typescript: true,
+        node: true,
+      },
+    },
+  },
+};

README.md

@@ -9,6 +9,8 @@ Official Node interface for the [Lokalise API](https://app.lokalise.com/api2docs
 
 ## Quickstart
 
+**Please note that starting from version 9 this SDK is a pure [ESM](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) module. It does not provide a CommonJS export (`require`) anymore.** Therefore you should either [convert your project to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c), use [dynamic import](https://v8.dev/features/dynamic-import), or stay on [version 8](https://github.com/lokalise/node-lokalise-api/tree/v8) which we are fully supporting.
+
 Install the library:
 
 ```bash
@@ -18,10 +20,10 @@ npm install @lokalise/node-api
 Obtain Lokalise API token in your personal profile, initialize and use the client:
 
 ```ts
-const { LokaliseApi } = require('@lokalise/node-api');
+import { LokaliseApi } from "@lokalise/node-api";
 
 const lokaliseApi = new LokaliseApi({ apiKey: '<apiKey>'});
-const projects = lokaliseApi.projects().list();
+const projects = await lokaliseApi.projects().list();
 projects.items[0].name;
 
 process = await lokaliseApi.files().upload(project_id,

dist/collections/base_collection.d.ts

@@ -1,9 +1,9 @@
 import { Options } from "got";
-import { ApiError } from "../models/api_error";
-import { PaginatedResult } from "../models/paginated_result";
-import { Keyable } from "../interfaces/keyable";
-import { ClientData } from "../interfaces/client_data";
-import { BulkResult } from "../interfaces/bulk_result";
+import { ApiError } from "../models/api_error.js";
+import { PaginatedResult } from "../models/paginated_result.js";
+import { Keyable } from "../interfaces/keyable.js";
+import { ClientData } from "../interfaces/client_data.js";
+import { BulkResult } from "../interfaces/bulk_result.js";
 declare type RejectHandler = (data: any) => ApiError;
 declare type ResolveHandler = (json: Keyable, headers: Keyable, ...args: any[]) => any;
 export declare abstract class BaseCollection {

dist/collections/branches.d.ts

@@ -1,8 +1,8 @@
-import { BaseCollection } from "./base_collection";
-import { Branch } from "../models/branch";
-import { PaginatedResult } from "../interfaces/paginated_result";
-import { ProjectWithPagination } from "../interfaces/project_with_pagination";
-import { ProjectOnly } from "../interfaces/project_only";
+import { BaseCollection } from "./base_collection.js";
+import { Branch } from "../models/branch.js";
+import { PaginatedResult } from "../interfaces/paginated_result.js";
+import { ProjectWithPagination } from "../interfaces/project_with_pagination.js";
+import { ProjectOnly } from "../interfaces/project_only.js";
 declare type BranchParams = {
     name?: string;
 };

dist/collections/comments.d.ts

@@ -1,8 +1,8 @@
-import { BaseCollection } from "./base_collection";
-import { Comment } from "../models/comment";
-import { PaginatedResult } from "../interfaces/paginated_result";
-import { ProjectWithPagination } from "../interfaces/project_with_pagination";
-import { ProjectOnly } from "../interfaces/project_only";
+import { BaseCollection } from "./base_collection.js";
+import { Comment } from "../models/comment.js";
+import { PaginatedResult } from "../interfaces/paginated_result.js";
+import { ProjectWithPagination } from "../interfaces/project_with_pagination.js";
+import { ProjectOnly } from "../interfaces/project_only.js";
 interface ParamsWithPagination extends ProjectWithPagination {
     key_id: number | string;
 }