@2bad/bitrix 2.3.1 → 2.5.0

package/build/main/services/statuses/methods.d.ts

@@ -2,11 +2,11 @@ import { Method } from '../../methods';
 import { GetPayload, ListPayload } from '../../payloads';
 import { Fields } from '../common';
 import { Status } from './entities';
-export interface StatusesMethods {
+export declare type StatusesMethods = {
     readonly [Method.CRM_STATUS_FIELDS]: {
         readonly type: Status;
         readonly payload: GetPayload<Fields>;
-        readonly params?: {};
+        readonly params?: Record<string, unknown>;
     };
     readonly [Method.CRM_STATUS_ADD]: {
         readonly type: Status;
@@ -36,8 +36,8 @@ export interface StatusesMethods {
         readonly type: Status;
         readonly payload: ListPayload<Status>;
         readonly params: {
-            readonly order?: Record<string, any>;
-            readonly filter?: Record<string, any>;
+            readonly order?: Record<string, unknown>;
+            readonly filter?: Record<string, unknown>;
         };
     };
     readonly [Method.CRM_STATUS_UPDATE]: {
@@ -45,7 +45,7 @@ export interface StatusesMethods {
         readonly payload: GetPayload<boolean>;
         readonly params: {
             readonly id: string | number;
-            readonly fields: Record<string, any>;
+            readonly fields: Record<string, unknown>;
         };
     };
-}
+};

package/build/main/services/statuses/methods.js

@@ -1,4 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const methods_1 = require("../../methods");
-//# sourceMappingURL=methods.js.map

package/build/main/services/users/entities.d.ts

@@ -1,5 +1,6 @@
 import { GenderString, ISODate, NumberString } from '../common';
-export interface User {
+export declare type User = {
+    readonly [key: string]: string | boolean | null | readonly number[];
     readonly ID: NumberString;
     readonly ACTIVE: boolean;
     readonly EMAIL: string | null;
@@ -24,7 +25,7 @@ export interface User {
     readonly WORK_COMPANY: string | null;
     readonly WORK_POSITION: string | null;
     readonly WORK_PHONE: string | null;
-    readonly UF_DEPARTMENT: ReadonlyArray<number>;
+    readonly UF_DEPARTMENT: readonly number[];
     readonly UF_INTERESTS: string | null;
     readonly UF_SKILLS: string | null;
     readonly UF_WEB_SITES: string | null;
@@ -36,4 +37,4 @@ export interface User {
     readonly UF_DISTRICT: string | null;
     readonly UF_PHONE_INNER: NumberString | null;
     readonly USER_TYPE: 'employee';
-}
+};

package/build/main/services/users/entities.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=entities.js.map

package/build/main/services/users/index.d.ts

@@ -1,9 +1,9 @@
 import { Call } from '../../client/methods/call';
-interface Dependencies {
+declare type Dependencies = {
     readonly call: Call;
-}
+};
 declare const _default: ({ call }: Dependencies) => {
     fields: () => Promise<import("../../payloads").GetPayload<import("./entities").User>>;
-    get: (id?: string | undefined) => Promise<import("../../payloads").GetPayload<readonly import("./entities").User[]>>;
+    get: (id?: string) => Promise<import("../../payloads").GetPayload<readonly import("./entities").User[]>>;
 };
 export default _default;

package/build/main/services/users/index.integration.test.js

@@ -4,11 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const bitrix_1 = __importDefault(require("./../../bitrix"));
-const WEBHOOK_URL = process.env.WEBHOOK_URL;
+const WEBHOOK_URL = process.env['WEBHOOK_URL'];
 if (!WEBHOOK_URL) {
     throw Error('Integration tests require environmental variable `WEBHOOK_URL` to be set');
 }
-const { users } = bitrix_1.default(WEBHOOK_URL);
+const { users } = (0, bitrix_1.default)(WEBHOOK_URL);
 describe('Users', () => {
     describe('fields', () => {
         it('should get all fields', async () => {
@@ -31,4 +31,3 @@ describe('Users', () => {
         });
     });
 });
-//# sourceMappingURL=index.integration.test.js.map

package/build/main/services/users/index.js

@@ -5,4 +5,3 @@ exports.default = ({ call }) => ({
     fields: () => call(methods_1.Method.USER_FIELDS, {}),
     get: (id) => call(methods_1.Method.USER_GET, { id })
 });
-//# sourceMappingURL=index.js.map

package/build/main/services/users/index.unit.test.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const _1 = __importDefault(require("."));
 const mockCall = jest.fn(() => Promise.resolve());
 const mockList = jest.fn(() => Promise.resolve());
-const users = _1.default({ call: mockCall });
+const users = (0, _1.default)({ call: mockCall });
 const ID = '77';
 describe('Users', () => {
     beforeEach(() => {
@@ -23,4 +23,3 @@ describe('Users', () => {
         });
     });
 });
-//# sourceMappingURL=index.unit.test.js.map

package/build/main/services/users/methods.d.ts

@@ -1,17 +1,17 @@
 import { Method } from '../../methods';
 import { GetPayload } from '../../payloads';
 import { User } from './entities';
-export interface UsersMethods {
+export declare type UsersMethods = {
     readonly [Method.USER_FIELDS]: {
         readonly type: User;
         readonly payload: GetPayload<User>;
-        readonly params?: {};
+        readonly params?: Record<string, unknown>;
     };
     readonly [Method.USER_GET]: {
         readonly type: User;
-        readonly payload: GetPayload<ReadonlyArray<User>>;
+        readonly payload: GetPayload<readonly User[]>;
         readonly params: {
             readonly id?: string;
         };
     };
-}
+};

package/build/main/services/users/methods.js

@@ -1,4 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const methods_1 = require("../../methods");
-//# sourceMappingURL=methods.js.map

package/build/main/utils/Diff.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Diff.js.map

package/build/main/utils/ExtractValue.d.ts

@@ -1 +1,6 @@
-export declare type ExtractValue<MAP extends Record<string, any>, KEY extends string | number | symbol, MAPKEY extends keyof MAP = KEY extends keyof MAP ? KEY : never> = MAP[MAPKEY];
+/**
+ * Extract value from the `MAP` following the `KEY`
+ * It works with `enum` as a `KEY` when matched against dict as `enum` values as a keys,
+ * which justifies whole existence of that helper.
+ */
+export declare type ExtractValue<MAP extends Record<string, unknown>, KEY extends string | number | symbol, MAPKEY extends keyof MAP = KEY extends keyof MAP ? KEY : never> = MAP[MAPKEY];

package/build/main/utils/ExtractValue.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ExtractValue.js.map

package/build/main/utils/isArray.d.ts

@@ -1,2 +1,2 @@
-declare const _default: <E>(x: any) => x is readonly E[];
+declare const _default: <E>(x: unknown) => x is readonly E[];
 export default _default;

package/build/main/utils/isArray.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// Because `Array.isArray` itself give a strange result with `any[]`
 exports.default = (x) => Array.isArray(x);
-//# sourceMappingURL=isArray.js.map

package/build/module/bitrix.d.ts

@@ -1,4 +1,13 @@
-declare const _default: (restURI: string, accessToken?: string | undefined) => {
+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`.
+ */
+declare const _default: (restURI: string, accessToken?: string, clientOptions?: ExtendOptions) => {
     call: import("./client/methods/call").Call;
     batch: import("./client/methods/batch").Batch;
     list: import("./client/methods/list").List;
@@ -7,16 +16,16 @@ declare const _default: (restURI: string, accessToken?: string | undefined) => {
         create: <D extends {
             readonly fields: Partial<import("./services/companies/entities").Company>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                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, any>;
+            readonly fields: Record<string, unknown>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                readonly REGISTER_SONET_EVENT: "Y" | "N";
             } | undefined;
         }>(id: string, fields: D_1["fields"], params?: D_1["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
     };
@@ -25,16 +34,16 @@ declare const _default: (restURI: string, accessToken?: string | undefined) => {
         create: <D_2 extends {
             readonly fields: Partial<import("./services/contacts/entities").Contact>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                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, any>;
+            readonly fields: Record<string, unknown>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                readonly REGISTER_SONET_EVENT: "Y" | "N";
             } | undefined;
         }>(id: string, fields: D_3["fields"], params?: D_3["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
     };
@@ -43,16 +52,16 @@ declare const _default: (restURI: string, accessToken?: string | undefined) => {
         create: <D_4 extends {
             readonly fields: Partial<import("./services/deals/entities").Deal>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                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, any>;
+            readonly fields: Record<string, unknown>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                readonly REGISTER_SONET_EVENT: "Y" | "N";
             } | undefined;
         }>(id: string, fields: D_5["fields"], params?: D_5["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
     };
@@ -61,16 +70,16 @@ declare const _default: (restURI: string, accessToken?: string | undefined) => {
         create: <D_6 extends {
             readonly fields: Partial<import("./services/leads/entities").Lead>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                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, any>;
+            readonly fields: Record<string, unknown>;
             readonly params?: {
-                readonly REGISTER_SONET_EVENT: import("./services/common").BoolString;
+                readonly REGISTER_SONET_EVENT: "Y" | "N";
             } | undefined;
         }>(id: string, fields: D_7["fields"], params?: D_7["params"] | undefined) => Promise<import("./payloads").GetPayload<boolean>>;
     };
@@ -82,10 +91,10 @@ declare const _default: (restURI: string, accessToken?: string | 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, any> | undefined;
-            readonly filter?: Record<string, any> | undefined;
+            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, any>) => Promise<import("./payloads").GetPayload<boolean>>;
+        update: (id: string | number, fields: Record<string, unknown>) => Promise<import("./payloads").GetPayload<boolean>>;
     };
     users: {
         fields: () => Promise<import("./payloads").GetPayload<import("./services/users/entities").User>>;

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

@@ -29,4 +29,3 @@ describe('Bitrix API', () => {
         });
     });
 });
-//# sourceMappingURL=bitrix.integration.test.js.map

package/build/module/bitrix.js

@@ -5,8 +5,16 @@ import DealsService from './services/deals';
 import LeadsService from './services/leads';
 import StatusesService from './services/statuses';
 import UsersService from './services/users';
-export default (restURI, accessToken) => {
-    const { call, batch, list } = Client(restURI, accessToken);
+/**
+ * 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 default (restURI, accessToken, clientOptions) => {
+    const { call, batch, list } = Client(restURI, accessToken, clientOptions);
     return {
         call,
         batch,
@@ -20,4 +28,12 @@ export default (restURI, accessToken) => {
     };
 };
 export * from './methods';
-//# sourceMappingURL=bitrix.js.map
+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/module/bitrix.unit.test.js

@@ -14,4 +14,3 @@ describe('Bitrix', () => {
         expect(bitrix).toMatchSnapshot();
     });
 });
-//# sourceMappingURL=bitrix.unit.test.js.map

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

@@ -17,20 +17,20 @@ describe('Client', () => {
     });
     it('should extend `Got` instance with a specified parameters', () => {
         const spiedGotExtend = jest.spyOn(got, 'extend');
-        Client('https://test.com', 'test_token');
+        Client('https://test.com', 'test_token', { https: { rejectUnauthorized: false } });
         expect(spiedGotExtend.mock.calls).toMatchSnapshot();
     });
     it('should expose API methods', () => {
         expect(client).toMatchSnapshot();
     });
     describe('`call`', () => {
-        it('should add to queue', async () => {
+        // @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 = Method.CRM_DEAL_LIST;
             nock(TEST_URI)
                 .get(`/${method}?access_token=${TEST_ACCESS_TOKEN}`)
-                .reply(RESPONSE_200, payload)
-                .get(`/${method}?access_token=${TEST_ACCESS_TOKEN}`)
+                .twice()
                 .reply(RESPONSE_200, payload);
             await client.call(method, {});
             await client.call(method, {});
@@ -38,7 +38,8 @@ describe('Client', () => {
         });
     });
     describe('`batch`', () => {
-        it('should add to queue', async () => {
+        // @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'],
@@ -50,6 +51,9 @@ describe('Client', () => {
                 { method: Method.CRM_DEAL_LIST }
             ];
             nock(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(`/${Method.BATCH}?cmd%5B0%5D=${commands[0].method}&access_token=${TEST_ACCESS_TOKEN}`)
                 .reply(RESPONSE_200, payload)
                 .get(`/${Method.BATCH}?cmd%5B0%5D=${commands[1].method}&access_token=${TEST_ACCESS_TOKEN}`)
@@ -59,4 +63,3 @@ describe('Client', () => {
         });
     });
 });
-//# sourceMappingURL=client.unit.test.js.map

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

@@ -1,3 +1,6 @@
-import got from 'got';
-declare const _default: (accessToken?: string | undefined) => (options: got.GotJSONOptions) => void;
+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/module/client/hooks/addAccessToken.js

@@ -1,3 +1,6 @@
+/**
+ * Got can't merge `query` option with other queries if they are string. But that hook can.
+ */
 export default (accessToken) => (options) => {
     if (!accessToken)
         return;
@@ -6,4 +9,3 @@ export default (accessToken) => (options) => {
     const hasQuery = options.path.includes('?');
     options.path = `${options.path}${hasQuery ? '&' : '?'}access_token=${accessToken}`;
 };
-//# sourceMappingURL=addAccessToken.js.map

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

@@ -1,25 +1,26 @@
+import got from 'got';
 import addAccessToken from './addAccessToken';
 const token = 'mock_token';
+const merge = got.mergeOptions;
 describe('Client `addAccessToken` hook', () => {
     it('should add access token to URL without a query', () => {
-        const options = { json: true, path: '/test' };
+        const options = merge({ path: 'test', responseType: 'json' });
         addAccessToken(token)(options);
-        expect(options.path).toBe(`/test?access_token=${token}`);
+        expect(options.path).toBe(`test?access_token=${token}`);
     });
     it('should add access token to URL with a query', () => {
-        const options = { json: true, path: '/test?value=1' };
+        const options = merge({ path: 'test?value=1', responseType: 'json' });
         addAccessToken(token)(options);
-        expect(options.path).toBe(`/test?value=1&access_token=${token}`);
+        expect(options.path).toBe(`test?value=1&access_token=${token}`);
     });
     it('should not add access token when it is undefined', () => {
-        const options = { json: true, path: '/test' };
+        const options = merge({ path: 'test', responseType: 'json' });
         addAccessToken()(options);
-        expect(options.path).toBe('/test');
+        expect(options.path).toBe('test');
     });
     it('should not add access token when URL is undefined', () => {
-        const options = { json: true, path: undefined };
+        const options = merge({ path: undefined, responseType: 'json' });
         addAccessToken(token)(options);
         expect(options.path).toBe(undefined);
     });
 });
-//# sourceMappingURL=addAccessToken.unit.test.js.map

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

@@ -1,4 +1,13 @@
-declare const _default: (restURI: string, accessToken?: string | undefined) => {
+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;

package/build/module/client/index.js

@@ -5,26 +5,39 @@ import Batch from './methods/batch';
 import Call from './methods/call';
 import List from './methods/list';
 const BITRIX_API_RATE_LIMIT = 2;
-const BITRIX_API_RATE_INTERVAL = 1000;
-export default (restURI, accessToken) => {
+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`.
+ */
+export default (restURI, accessToken, options) => {
     const client = got.extend({
-        baseUrl: restURI,
+        prefixUrl: restURI,
         headers: {
-            'user-agent': `@2bad/bitrix`
+            'user-agent': '@2bad/bitrix'
         },
-        json: true,
+        responseType: 'json',
         hooks: {
             beforeRequest: [
                 addAccessToken(accessToken)
             ]
-        }
+        },
+        ...options ?? {}
     });
     const queue = new Queue({
         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 = Call({ 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 = Batch({ get: queuedGet });
     const list = List({ call, batch });
     return {
@@ -33,4 +46,3 @@ export default (restURI, accessToken) => {
         list
     };
 };
-//# sourceMappingURL=index.js.map

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

@@ -1,11 +1,23 @@
-import { GotJSONFn } from 'got';
+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;
-export declare const mergeBatchPayloads: <B extends BatchPayload<any>, P = B extends BatchPayload<infer U> ? U : never>(payloads: readonly B[]) => BatchPayload<P>;
+/**
+ * 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;
@@ -14,8 +26,15 @@ export declare type CommandsPayloads<C extends Commands, CM = {
     [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>>;
-interface Dependencies {
-    readonly get: GotJSONFn;
-}
+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;

package/build/module/client/methods/batch.js

@@ -5,22 +5,40 @@ import { Method } from '../../methods';
 import isArray from '../../utils/isArray';
 import { handlePayload } from './call';
 export const MAX_COMMANDS_PER_BATCH = 50;
+/**
+ * Split any number of commands into the chunks with max commands per batch in each chunk
+ */
 export const chunkCommands = (commands, size = MAX_COMMANDS_PER_BATCH) => {
     const commandsIsArray = isArray(commands);
     const chunks = chunk(Object.entries(commands), size);
+    // @todo Generated return type isn't very accurate since it says that it will make array of <C>, while
+    //       in fact <C> will be distributed among chunks. That gives wrong hints with named commands and arrays as const.
     return chunks.map((c) => commandsIsArray
+        // @todo Figure out how to avoid unsafe casting to <C> here
+        //       Without `<C>` generic it won't work with complex functions like `batch`
         ? c.map(([_key, command]) => command)
         : fromPairs(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 const prepareCommandsQueries = (commands) => Object.entries(commands).reduce((calls, [name, { method, params }]) => {
     const stringifiedParams = params ? `?${toQuery(params)}` : '';
     return {
         ...calls,
         [`cmd[${name}]`]: `${method}${stringifiedParams}`
     };
+    // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
 }, {});
+/**
+ * Merges list of batch responses into a single batch
+ * @todo Generics inference is complicated here and might be not super accurate
+ */
 export const mergeBatchPayloads = (payloads) => {
     const merge = (a, b) => isArray(a) && isArray(b)
+        // @todo Gotta find way to avoid unsafe casting here
         ? [...a, ...b]
         : ({ ...a, ...b });
     return payloads.reduce((merged, payload) => ({
@@ -32,15 +50,23 @@ export const mergeBatchPayloads = (payloads) => {
             result_total: merge(merged.result.result_total || [], payload.result.result_total)
         },
         time: { ...merged.time, ...payload.time }
+        // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
     }), { result: {}, time: {} });
 };
+/**
+ * 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
+ */
 export default ({ get }) => {
     const batch = async (commands, commandsPerRequest = MAX_COMMANDS_PER_BATCH) => {
-        const call = (c) => get(Method.BATCH, { query: prepareCommandsQueries(c) })
+        const call = (c) => get(Method.BATCH, { searchParams: prepareCommandsQueries(c) })
             .then(({ body }) => body);
         const calls = chunkCommands(commands, commandsPerRequest)
             .map(call);
-        return Promise.all(calls)
+        return await Promise.all(calls)
             .then((chunkedPayloads) => {
             const payloads = mergeBatchPayloads(chunkedPayloads);
             return handlePayload(payloads);
@@ -48,4 +74,3 @@ export default ({ get }) => {
     };
     return batch;
 };
-//# sourceMappingURL=batch.js.map