@2bad/bitrix 2.5.1 → 3.0.0

package/build/index.js

@@ -0,0 +1 @@
+export { n as BitrixError, t as createClient } from "./client-Bk76ySik.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@2bad/bitrix",
-  "version": "2.5.1",
+  "version": "3.0.0",
   "description": "Bitrix24 REST API client that doesn't suck",
   "keywords": [
     "api",
@@ -19,85 +19,58 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/2BAD/bitrix.git"
+    "url": "git+https://github.com/2BAD/bitrix.git"
   },
   "license": "MIT",
   "author": "2BAD (https://github.com/2BAD)",
-  "main": "build/main/bitrix.js",
-  "module": "build/module/bitrix.js",
-  "typings": "build/main/bitrix.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./build/index.d.ts",
+        "default": "./build/index.js"
+      }
+    }
+  },
+  "bin": {
+    "bitrix-types": "./build/bin.js"
+  },
   "files": [
     "build"
   ],
-  "scripts": {
-    "build": "run-s clean && run-p build:*",
-    "build:main": "tsc --project tsconfig.main.json",
-    "build:module": "tsc --project tsconfig.json",
-    "clean": "rimraf build",
-    "lint": "eslint . --ext .ts",
-    "lint:fix": "run-s \"lint -- --fix\"",
-    "prepublishOnly": "run-s clean build",
-    "test": "jest --coverage",
-    "test:integration": "jest integration --coverage",
-    "test:unit": "jest unit --coverage",
-    "preversion": "run-s clean lint test:unit build"
-  },
-  "prettier": {
-    "printWidth": 100,
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "none"
-  },
-  "jest": {
-    "collectCoverageFrom": [
-      "source/**/*.ts"
-    ],
-    "coverageDirectory": "coverage",
-    "modulePathIgnorePatterns": [
-      "<rootDir>/build/"
-    ],
-    "preset": "ts-jest",
-    "setupFiles": [
-      "dotenv/config"
-    ],
-    "testEnvironment": "node",
-    "testMatch": [
-      "**/?(*.)+(spec|test).[jt]s?(x)"
-    ]
-  },
-  "dependencies": {
-    "@types/lodash.chunk": "4.2.7",
-    "@types/lodash.frompairs": "4.0.7",
-    "@types/lodash.range": "3.2.7",
-    "@types/qs": "6.9.7",
-    "got": "11.8.2",
-    "lodash.chunk": "4.2.0",
-    "lodash.frompairs": "4.0.1",
-    "lodash.range": "3.2.0",
-    "p-queue": "6.6.2",
-    "qs": "6.11.0"
+  "volta": {
+    "node": "26.13.0",
+    "pnpm": "12.16.1"
   },
   "devDependencies": {
-    "@2bad/tsconfig": "1.4.0",
-    "@types/jest": "26.0.23",
-    "@types/node": "18.11.2",
-    "@typescript-eslint/eslint-plugin": "4.22.0",
-    "codecov": "3.8.2",
-    "dotenv": "16.0.3",
-    "eslint": "7.25.0",
-    "eslint-config-standard-with-typescript": "20.0.0",
-    "eslint-plugin-import": "2.22.1",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "4.2.1",
-    "eslint-plugin-standard": "4.1.0",
-    "jest": "26.6.3",
-    "nock": "13.2.9",
-    "npm-run-all": "4.1.5",
-    "rimraf": "3.0.2",
-    "ts-jest": "26.5.5",
-    "typescript": "4.8.4"
+    "@2bad/axiom": "2.1.0",
+    "@2bad/tsconfig": "4.0.0",
+    "@arethetypeswrong/cli": "0.18.5",
+    "@types/node": "26.6.6",
+    "@vitest/coverage-v8": "5.0.5",
+    "npm-run-all2": "9.0.4",
+    "oxfmt": "0.75.0",
+    "oxlint": "1.90.0",
+    "publint": "0.3.25",
+    "tsdown": "0.23.4",
+    "typescript": "7.0.2",
+    "vitest": "5.0.5"
   },
-  "volta": {
-    "node": "19.0.0"
+  "engines": {
+    "node": ">=26"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "check": "run-p check:**",
+    "check:code": "oxlint ./source",
+    "check:format": "oxfmt --check ./source",
+    "check:types": "tsc --noEmit",
+    "fix": "run-p fix:**",
+    "fix:code": "oxlint --fix ./source",
+    "fix:format": "oxfmt ./source",
+    "preversion": "run-s check test:unit build",
+    "test": "vitest run",
+    "test:integration": "vitest run integration --coverage",
+    "test:unit": "vitest run unit --coverage"
   }
-}
+}

package/build/main/bitrix.d.ts

@@ -1,114 +0,0 @@
-import { ExtendOptions } from 'got';
-/**
- * Construct a Bitrix client with generic methods
- * @param restURI REST endpoint, like a `https://hello.bitrix24.ua/rest` or an inbound webhook endpoint,
- *                like a `https://hello.bitrix24.ua/rest/1/WEBHOOK_TOKEN`.
- * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
- * @param clientOptions an object that will overwrite underlying configuration for HTTP client,
- *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
- */
-export declare const Bitrix: (restURI: string, accessToken?: string, clientOptions?: ExtendOptions) => {
-    call: import("./client/methods/call").Call;
-    batch: import("./client/methods/batch").Batch;
-    list: import("./client/methods/list").List;
-    companies: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/common").Fields>>;
-        create: <D extends {
-            readonly fields: Partial<import("./services/companies/entities").Company>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(fields: D["fields"], params?: D["params"] | undefined) => Promise<import("./payloads").GetPayload<number>>;
-        get: (id: string) => Promise<import("./payloads").GetPayload<import("./services/companies/entities").Company>>;
-        list: (params?: import("./methods").ListParams) => Promise<import("./payloads").ListPayload<import("./services/companies/entities").Company>>;
-        update: <D_1 extends {
-            readonly id: string;
-            readonly fields: Record<string, unknown>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(id: string, fields: D_1["fields"], params?: D_1["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
-    };
-    contacts: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/common").Fields>>;
-        create: <D_2 extends {
-            readonly fields: Partial<import("./services/contacts/entities").Contact>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(fields: D_2["fields"], params?: D_2["params"] | undefined) => Promise<import("./payloads").GetPayload<number>>;
-        get: (id: string) => Promise<import("./payloads").GetPayload<import("./services/contacts/entities").Contact>>;
-        list: (params?: import("./methods").ListParams) => Promise<import("./payloads").ListPayload<import("./services/contacts/entities").Contact>>;
-        update: <D_3 extends {
-            readonly id: string;
-            readonly fields: Record<string, unknown>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(id: string, fields: D_3["fields"], params?: D_3["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
-    };
-    deals: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/common").Fields>>;
-        create: <D_4 extends {
-            readonly fields: Partial<import("./services/deals/entities").Deal>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(fields: D_4["fields"], params?: D_4["params"] | undefined) => Promise<import("./payloads").GetPayload<number>>;
-        get: (id: string) => Promise<import("./payloads").GetPayload<import("./services/deals/entities").Deal>>;
-        list: (params?: import("./methods").ListParams) => Promise<import("./payloads").ListPayload<import("./services/deals/entities").Deal>>;
-        update: <D_5 extends {
-            readonly id: string;
-            readonly fields: Record<string, unknown>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(id: string, fields: D_5["fields"], params?: D_5["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
-    };
-    leads: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/common").Fields>>;
-        create: <D_6 extends {
-            readonly fields: Partial<import("./services/leads/entities").Lead>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(fields: D_6["fields"], params?: D_6["params"] | undefined) => Promise<import("./payloads").GetPayload<number>>;
-        get: (id: string) => Promise<import("./payloads").GetPayload<import("./services/leads/entities").Lead>>;
-        list: (params?: import("./methods").ListParams) => Promise<import("./payloads").ListPayload<import("./services/leads/entities").Lead>>;
-        update: <D_7 extends {
-            readonly id: string;
-            readonly fields: Record<string, unknown>;
-            readonly params?: {
-                readonly REGISTER_SONET_EVENT: "Y" | "N";
-            } | undefined;
-        }>(id: string, fields: D_7["fields"], params?: D_7["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
-    };
-    statuses: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/common").Fields>>;
-        create: (fields: Partial<import("./services/statuses/entities").Status>) => Promise<import("./payloads").GetPayload<number>>;
-        delete: (id: string | number, params?: {
-            readonly FORCED?: "Y" | "N" | undefined;
-        } | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
-        get: (id: string | number) => Promise<import("./payloads").GetPayload<import("./services/statuses/entities").Status>>;
-        list: (params?: {
-            readonly order?: Record<string, unknown> | undefined;
-            readonly filter?: Record<string, unknown> | undefined;
-        }) => Promise<import("./payloads").ListPayload<import("./services/statuses/entities").Status>>;
-        update: (id: string | number, fields: Record<string, unknown>) => Promise<import("./payloads").GetPayload<boolean>>;
-    };
-    users: {
-        fields: () => Promise<import("./payloads").GetPayload<import("./services/users/entities").User>>;
-        get: (id?: string | undefined) => Promise<import("./payloads").GetPayload<readonly import("./services/users/entities").User[]>>;
-    };
-};
-export default Bitrix;
-export * from './methods';
-export * from './commands';
-export * from './services/common';
-export * from './services/companies/entities';
-export * from './services/contacts/entities';
-export * from './services/currencies/entities';
-export * from './services/deals/entities';
-export * from './services/leads/entities';
-export * from './services/statuses/entities';
-export * from './services/users/entities';

package/build/main/bitrix.integration.test.js

@@ -1,31 +0,0 @@
-"use strict";
-describe('Bitrix API', () => {
-    describe('`get` method', () => {
-        it.todo('should get result');
-        it.todo('should reject on error');
-    });
-    describe('`batch` method', () => {
-        it.todo('should execute the batch');
-        it.todo('should reject on errors');
-    });
-    describe('`deals`', () => {
-        describe('`get` method', () => {
-            it.todo('should get entry');
-            it.todo('should reject on error');
-        });
-        describe('`list` method', () => {
-            it.todo('should all entries');
-            it.todo('should reject on error');
-        });
-    });
-    describe('`leads`', () => {
-        describe('`get` method', () => {
-            it.todo('should get entry');
-            it.todo('should reject on error');
-        });
-        describe('`list` method', () => {
-            it.todo('should get all entries');
-            it.todo('should reject on error');
-        });
-    });
-});

package/build/main/bitrix.js

@@ -1,61 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Bitrix = void 0;
-const client_1 = __importDefault(require("./client"));
-const companies_1 = __importDefault(require("./services/companies"));
-const contacts_1 = __importDefault(require("./services/contacts"));
-const deals_1 = __importDefault(require("./services/deals"));
-const leads_1 = __importDefault(require("./services/leads"));
-const statuses_1 = __importDefault(require("./services/statuses"));
-const users_1 = __importDefault(require("./services/users"));
-/**
- * Construct a Bitrix client with generic methods
- * @param restURI REST endpoint, like a `https://hello.bitrix24.ua/rest` or an inbound webhook endpoint,
- *                like a `https://hello.bitrix24.ua/rest/1/WEBHOOK_TOKEN`.
- * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
- * @param clientOptions an object that will overwrite underlying configuration for HTTP client,
- *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
- */
-const Bitrix = (restURI, accessToken, clientOptions) => {
-    const { call, batch, list } = (0, client_1.default)(restURI, accessToken, clientOptions);
-    return {
-        call,
-        batch,
-        list,
-        companies: (0, companies_1.default)({ call, list }),
-        contacts: (0, contacts_1.default)({ call, list }),
-        deals: (0, deals_1.default)({ call, list }),
-        leads: (0, leads_1.default)({ call, list }),
-        statuses: (0, statuses_1.default)({ call }),
-        users: (0, users_1.default)({ call })
-    };
-};
-exports.Bitrix = Bitrix;
-exports.default = exports.Bitrix;
-__exportStar(require("./methods"), exports);
-__exportStar(require("./commands"), exports);
-__exportStar(require("./services/common"), exports);
-__exportStar(require("./services/companies/entities"), exports);
-__exportStar(require("./services/contacts/entities"), exports);
-__exportStar(require("./services/currencies/entities"), exports);
-__exportStar(require("./services/deals/entities"), exports);
-__exportStar(require("./services/leads/entities"), exports);
-__exportStar(require("./services/statuses/entities"), exports);
-__exportStar(require("./services/users/entities"), exports);

package/build/main/bitrix.unit.test.d.ts

@@ -1 +0,0 @@
-export {};

package/build/main/bitrix.unit.test.js

@@ -1,44 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const bitrix_1 = __importDefault(require("./bitrix"));
-const client = __importStar(require("./client"));
-describe('Bitrix', () => {
-    it('should init', () => {
-        expect(() => (0, bitrix_1.default)('https://test.com', 'test_token')).not.toThrow();
-    });
-    it('should pass endpoint and access token to the client', () => {
-        const SpiedClient = jest.spyOn(client, 'default');
-        (0, bitrix_1.default)('https://test.com', 'test_token');
-        expect(SpiedClient.mock.calls).toMatchSnapshot();
-    });
-    it('should expose API methods', () => {
-        const bitrix = (0, bitrix_1.default)('https://test.com', 'test_token');
-        expect(bitrix).toMatchSnapshot();
-    });
-});

package/build/main/client/client.unit.test.d.ts

@@ -1 +0,0 @@
-export {};

package/build/main/client/client.unit.test.js

@@ -1,70 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const got_1 = __importDefault(require("got"));
-const nock_1 = __importDefault(require("nock"));
-const p_queue_1 = __importDefault(require("p-queue"));
-const methods_1 = require("../methods");
-const index_1 = __importDefault(require("./index"));
-const TEST_URI = 'https://test.com/rest';
-const TEST_ACCESS_TOKEN = 'test_access_token';
-const RESPONSE_200 = 200;
-const spiedQueueAdd = jest.spyOn(p_queue_1.default.prototype, 'add');
-const client = (0, index_1.default)(TEST_URI, TEST_ACCESS_TOKEN);
-describe('Client', () => {
-    beforeEach(() => {
-        spiedQueueAdd.mockClear();
-    });
-    it('should init', () => {
-        expect(() => (0, index_1.default)(TEST_URI, TEST_ACCESS_TOKEN)).not.toThrow();
-    });
-    it('should extend `Got` instance with a specified parameters', () => {
-        const spiedGotExtend = jest.spyOn(got_1.default, 'extend');
-        (0, index_1.default)('https://test.com', 'test_token', { https: { rejectUnauthorized: false } });
-        expect(spiedGotExtend.mock.calls).toMatchSnapshot();
-    });
-    it('should expose API methods', () => {
-        expect(client).toMatchSnapshot();
-    });
-    describe('`call`', () => {
-        // @todo restore test when issue is resolved (https://github.com/nock/nock/issues/1832)
-        it.skip('should add to queue', async () => {
-            const payload = {};
-            const method = methods_1.Method.CRM_DEAL_LIST;
-            (0, nock_1.default)(TEST_URI)
-                .get(`/${method}?access_token=${TEST_ACCESS_TOKEN}`)
-                .twice()
-                .reply(RESPONSE_200, payload);
-            await client.call(method, {});
-            await client.call(method, {});
-            expect(spiedQueueAdd.mock.calls).toMatchSnapshot();
-        });
-    });
-    describe('`batch`', () => {
-        // @todo restore test when issue is resolved (https://github.com/nock/nock/issues/1832)
-        it.skip('should add to queue', async () => {
-            const payload = {
-                result: {
-                    result: ['done'],
-                    result_error: []
-                }
-            };
-            const commands = [
-                { method: methods_1.Method.CRM_DEAL_GET },
-                { method: methods_1.Method.CRM_DEAL_LIST }
-            ];
-            (0, nock_1.default)(TEST_URI)
-                // @todo We'd want to use `query` object here as it is much more readable, but nock for some reason
-                //       fails to match request when it contains `cmd[someName]`. The issue definitely connected
-                //       to the `[]`, since it does not appear when only one bracket present
-                .get(`/${methods_1.Method.BATCH}?cmd%5B0%5D=${commands[0].method}&access_token=${TEST_ACCESS_TOKEN}`)
-                .reply(RESPONSE_200, payload)
-                .get(`/${methods_1.Method.BATCH}?cmd%5B0%5D=${commands[1].method}&access_token=${TEST_ACCESS_TOKEN}`)
-                .reply(RESPONSE_200, payload);
-            await client.batch(commands, 1);
-            expect(spiedQueueAdd.mock.calls).toMatchSnapshot();
-        });
-    });
-});

package/build/main/client/hooks/addAccessToken.d.ts

@@ -1,6 +0,0 @@
-import { BeforeRequestHook } from 'got';
-/**
- * Got can't merge `query` option with other queries if they are string. But that hook can.
- */
-declare const _default: (accessToken?: string) => BeforeRequestHook;
-export default _default;

package/build/main/client/hooks/addAccessToken.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Got can't merge `query` option with other queries if they are string. But that hook can.
- */
-exports.default = (accessToken) => (options) => {
-    if (!accessToken)
-        return;
-    if (!options.path)
-        return;
-    const hasQuery = options.path.includes('?');
-    options.path = `${options.path}${hasQuery ? '&' : '?'}access_token=${accessToken}`;
-};

package/build/main/client/hooks/addAccessToken.unit.test.d.ts

@@ -1 +0,0 @@
-export {};

package/build/main/client/hooks/addAccessToken.unit.test.js

@@ -1,31 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const got_1 = __importDefault(require("got"));
-const addAccessToken_1 = __importDefault(require("./addAccessToken"));
-const token = 'mock_token';
-const merge = got_1.default.mergeOptions;
-describe('Client `addAccessToken` hook', () => {
-    it('should add access token to URL without a query', () => {
-        const options = merge({ path: 'test', responseType: 'json' });
-        (0, addAccessToken_1.default)(token)(options);
-        expect(options.path).toBe(`test?access_token=${token}`);
-    });
-    it('should add access token to URL with a query', () => {
-        const options = merge({ path: 'test?value=1', responseType: 'json' });
-        (0, addAccessToken_1.default)(token)(options);
-        expect(options.path).toBe(`test?value=1&access_token=${token}`);
-    });
-    it('should not add access token when it is undefined', () => {
-        const options = merge({ path: 'test', responseType: 'json' });
-        (0, addAccessToken_1.default)()(options);
-        expect(options.path).toBe('test');
-    });
-    it('should not add access token when URL is undefined', () => {
-        const options = merge({ path: undefined, responseType: 'json' });
-        (0, addAccessToken_1.default)(token)(options);
-        expect(options.path).toBe(undefined);
-    });
-});

package/build/main/client/index.d.ts

@@ -1,15 +0,0 @@
-import { ExtendOptions } from 'got';
-/**
- * Construct a Bitrix client with generic methods
- * @param restURI REST endpoint, like a `https://hello.bitrix24.ru/rest` or an inbound webhook endpoint,
- *                like a `https://hello.bitrix24.ru/rest/1/WEBHOOK_TOKEN`.
- * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
- * @param options an object that will overwrite underlying configuration for HTTP client,
- *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
- */
-declare const _default: (restURI: string, accessToken?: string, options?: ExtendOptions) => {
-    call: import("./methods/call").Call;
-    batch: import("./methods/batch").Batch;
-    list: import("./methods/list").List;
-};
-export default _default;

package/build/main/client/index.js

@@ -1,53 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const got_1 = __importDefault(require("got"));
-const p_queue_1 = __importDefault(require("p-queue"));
-const addAccessToken_1 = __importDefault(require("./hooks/addAccessToken"));
-const batch_1 = __importDefault(require("./methods/batch"));
-const call_1 = __importDefault(require("./methods/call"));
-const list_1 = __importDefault(require("./methods/list"));
-const BITRIX_API_RATE_LIMIT = 2;
-const BITRIX_API_RATE_INTERVAL = 1000; // 1 second
-/**
- * Construct a Bitrix client with generic methods
- * @param restURI REST endpoint, like a `https://hello.bitrix24.ru/rest` or an inbound webhook endpoint,
- *                like a `https://hello.bitrix24.ru/rest/1/WEBHOOK_TOKEN`.
- * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
- * @param options an object that will overwrite underlying configuration for HTTP client,
- *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
- */
-exports.default = (restURI, accessToken, options) => {
-    const client = got_1.default.extend({
-        prefixUrl: restURI,
-        headers: {
-            'user-agent': '@2bad/bitrix'
-        },
-        responseType: 'json',
-        hooks: {
-            beforeRequest: [
-                (0, addAccessToken_1.default)(accessToken)
-            ]
-        },
-        ...options !== null && options !== void 0 ? options : {}
-    });
-    const queue = new p_queue_1.default({
-        intervalCap: BITRIX_API_RATE_LIMIT,
-        interval: BITRIX_API_RATE_INTERVAL
-    });
-    const queuedGet = (...args) => queue.add(() => client.get(...args));
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-expect-error @todo remove after issue is resolved (https://github.com/sindresorhus/got/issues/954)
-    const call = (0, call_1.default)({ get: queuedGet });
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-    // @ts-expect-error @todo remove after issue is resolved (https://github.com/sindresorhus/got/issues/954)
-    const batch = (0, batch_1.default)({ get: queuedGet });
-    const list = (0, list_1.default)({ call, batch });
-    return {
-        call,
-        batch,
-        list
-    };
-};

package/build/main/client/methods/batch.d.ts

@@ -1,40 +0,0 @@
-import got from 'got';
-import { Commands } from '../../commands';
-import { Method, MethodPayloadType } from '../../methods';
-import { BatchPayload } from '../../payloads';
-export declare const MAX_COMMANDS_PER_BATCH = 50;
-/**
- * Split any number of commands into the chunks with max commands per batch in each chunk
- */
-export declare const chunkCommands: <C extends Commands>(commands: C, size?: number) => readonly C[];
-/**
- * Prepares list of commands to be used in requests to the Bitrix
- * @note We could avoid that function... if only Bitrix API would support posting of the batch commands as
- *       plain objects, like it does with other methods. Instead, it should be a dict or array of string queries
- */
-export declare const prepareCommandsQueries: <C extends Commands, R = { [K in keyof C]: string; }>(commands: C) => R;
-/**
- * Merges list of batch responses into a single batch
- * @todo Generics inference is complicated here and might be not super accurate
- */
-export declare const mergeBatchPayloads: <B extends BatchPayload<unknown>, P = B extends BatchPayload<infer U> ? U : never>(payloads: readonly B[]) => BatchPayload<P>;
-export declare type CommandsPayloads<C extends Commands, CM = {
-    [K in keyof C]: C[K] extends {
-        readonly method: infer M;
-    } ? M : never;
-}> = {
-    [K in keyof CM]: MethodPayloadType<CM[K] extends Method ? CM[K] : never>;
-};
-export declare type Batch = <C extends Commands, P = CommandsPayloads<C>>(commands: C, commandsPerRequest?: number) => Promise<BatchPayload<P>>;
-declare type Dependencies = {
-    readonly get: typeof got.get;
-};
-/**
- * Dispatches a batch request with specified commands. Will fill figure out payload type based on the Methods.
- * Supports unlimited number of commands. If they do exceed max amount of commands per batch, will dispatch
- * multiple request and merge result into single batch payload
- * @todo For now due to issues with types it won't check `params` of command, so any Method can be used
- *       with any (even wrong) params
- */
-declare const _default: ({ get }: Dependencies) => Batch;
-export default _default;