@2bad/bitrix 2.3.1 → 2.5.0

package/build/main/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/main/client/methods/batch.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeBatchPayloads = exports.prepareCommandsQueries = exports.chunkCommands = exports.MAX_COMMANDS_PER_BATCH = void 0;
 const lodash_chunk_1 = __importDefault(require("lodash.chunk"));
 const lodash_frompairs_1 = __importDefault(require("lodash.frompairs"));
 const qs_1 = require("qs");
@@ -10,21 +11,44 @@ const methods_1 = require("../../methods");
 const isArray_1 = __importDefault(require("../../utils/isArray"));
 const call_1 = require("./call");
 exports.MAX_COMMANDS_PER_BATCH = 50;
-exports.chunkCommands = (commands, size = exports.MAX_COMMANDS_PER_BATCH) => {
-    const commandsIsArray = isArray_1.default(commands);
-    const chunks = lodash_chunk_1.default(Object.entries(commands), size);
+/**
+ * Split any number of commands into the chunks with max commands per batch in each chunk
+ */
+const chunkCommands = (commands, size = exports.MAX_COMMANDS_PER_BATCH) => {
+    const commandsIsArray = (0, isArray_1.default)(commands);
+    const chunks = (0, lodash_chunk_1.default)(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)
-        : lodash_frompairs_1.default(c));
+        : (0, lodash_frompairs_1.default)(c));
 };
-exports.prepareCommandsQueries = (commands) => Object.entries(commands).reduce((calls, [name, { method, params }]) => {
-    const stringifiedParams = params ? `?${qs_1.stringify(params)}` : '';
-    return Object.assign(Object.assign({}, calls), { [`cmd[${name}]`]: `${method}${stringifiedParams}` });
+exports.chunkCommands = chunkCommands;
+/**
+ * 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
+ */
+const prepareCommandsQueries = (commands) => Object.entries(commands).reduce((calls, [name, { method, params }]) => {
+    const stringifiedParams = params ? `?${(0, qs_1.stringify)(params)}` : '';
+    return {
+        ...calls,
+        [`cmd[${name}]`]: `${method}${stringifiedParams}`
+    };
+    // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
 }, {});
-exports.mergeBatchPayloads = (payloads) => {
-    const merge = (a, b) => isArray_1.default(a) && isArray_1.default(b)
+exports.prepareCommandsQueries = prepareCommandsQueries;
+/**
+ * Merges list of batch responses into a single batch
+ * @todo Generics inference is complicated here and might be not super accurate
+ */
+const mergeBatchPayloads = (payloads) => {
+    const merge = (a, b) => (0, isArray_1.default)(a) && (0, isArray_1.default)(b)
+        // @todo Gotta find way to avoid unsafe casting here
         ? [...a, ...b]
-        : (Object.assign(Object.assign({}, a), b));
+        : ({ ...a, ...b });
     return payloads.reduce((merged, payload) => ({
         result: {
             result: merge(merged.result.result || [], payload.result.result),
@@ -33,21 +57,29 @@ exports.mergeBatchPayloads = (payloads) => {
             result_time: merge(merged.result.result_time || [], payload.result.result_time),
             result_total: merge(merged.result.result_total || [], payload.result.result_total)
         },
-        time: Object.assign(Object.assign({}, merged.time), payload.time)
+        time: { ...merged.time, ...payload.time }
+        // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
     }), { result: {}, time: {} });
 };
+exports.mergeBatchPayloads = mergeBatchPayloads;
+/**
+ * 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
+ */
 exports.default = ({ get }) => {
     const batch = async (commands, commandsPerRequest = exports.MAX_COMMANDS_PER_BATCH) => {
-        const call = (c) => get(methods_1.Method.BATCH, { query: exports.prepareCommandsQueries(c) })
+        const call = (c) => get(methods_1.Method.BATCH, { searchParams: (0, exports.prepareCommandsQueries)(c) })
             .then(({ body }) => body);
-        const calls = exports.chunkCommands(commands, commandsPerRequest)
+        const calls = (0, exports.chunkCommands)(commands, commandsPerRequest)
             .map(call);
-        return Promise.all(calls)
+        return await Promise.all(calls)
             .then((chunkedPayloads) => {
-            const payloads = exports.mergeBatchPayloads(chunkedPayloads);
-            return call_1.handlePayload(payloads);
+            const payloads = (0, exports.mergeBatchPayloads)(chunkedPayloads);
+            return (0, call_1.handlePayload)(payloads);
         });
     };
     return batch;
 };
-//# sourceMappingURL=batch.js.map

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

@@ -1,14 +1,30 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+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 (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
-    result["default"] = mod;
+    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 got_1 = __importDefault(require("got"));
 const lodash_range_1 = __importDefault(require("lodash.range"));
@@ -25,7 +41,7 @@ describe('Client `chunkCommands` method', () => {
             d: { method: methods_1.Method.CRM_LEAD_LIST },
             e: { method: methods_1.Method.CRM_STATUS_LIST }
         };
-        expect(batch_1.chunkCommands(commands, chunkSize)).toMatchSnapshot();
+        expect((0, batch_1.chunkCommands)(commands, chunkSize)).toMatchSnapshot();
     });
     it('should chunk array of commands', () => {
         const chunkSize = 2;
@@ -36,13 +52,16 @@ describe('Client `chunkCommands` method', () => {
             { method: methods_1.Method.CRM_LEAD_LIST },
             { method: methods_1.Method.CRM_STATUS_LIST }
         ];
-        expect(batch_1.chunkCommands(commands, chunkSize)).toMatchSnapshot();
+        expect((0, batch_1.chunkCommands)(commands, chunkSize)).toMatchSnapshot();
     });
     it('should by default chunk with a size of `MAX_COMMANDS_PER_BATCH`', () => {
         const commandsSets = 2;
-        const commands = lodash_range_1.default(0, batch_1.MAX_COMMANDS_PER_BATCH * commandsSets).map(() => ({ method: methods_1.Method.CRM_DEAL_GET }));
-        const chunked = batch_1.chunkCommands(commands);
+        const commands = (0, lodash_range_1.default)(0, batch_1.MAX_COMMANDS_PER_BATCH * commandsSets).map(() => ({
+            method: methods_1.Method.CRM_DEAL_GET
+        }));
+        const chunked = (0, batch_1.chunkCommands)(commands);
         expect(chunked.length).toBe(commandsSets);
+        // @ts-ignore we have asserted it length
         expect(chunked[0].length).toBe(batch_1.MAX_COMMANDS_PER_BATCH);
     });
 });
@@ -64,24 +83,21 @@ describe('Client `prepareCommandsQueries` method', () => {
                 }
             }
         };
-        expect(batch_1.prepareCommandsQueries(commands)).toMatchSnapshot();
+        expect((0, batch_1.prepareCommandsQueries)(commands)).toMatchSnapshot();
     });
     it('should work with numbered commands', () => {
         const commands = {
             0: { method: methods_1.Method.CRM_DEAL_GET },
             1: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        expect(batch_1.prepareCommandsQueries(commands)).toMatchSnapshot();
+        expect((0, batch_1.prepareCommandsQueries)(commands)).toMatchSnapshot();
     });
     it('should work with array of commands', () => {
-        const commands = [
-            { method: methods_1.Method.CRM_DEAL_GET },
-            { method: methods_1.Method.CRM_DEAL_LIST }
-        ];
-        expect(batch_1.prepareCommandsQueries(commands)).toMatchSnapshot();
+        const commands = [{ method: methods_1.Method.CRM_DEAL_GET }, { method: methods_1.Method.CRM_DEAL_LIST }];
+        expect((0, batch_1.prepareCommandsQueries)(commands)).toMatchSnapshot();
     });
     it('should return empty query object when no commands provided', () => {
-        expect(batch_1.prepareCommandsQueries({})).toMatchSnapshot();
+        expect((0, batch_1.prepareCommandsQueries)({})).toMatchSnapshot();
     });
 });
 describe('Client `mergeBatchPayloads` method', () => {
@@ -160,7 +176,7 @@ describe('Client `mergeBatchPayloads` method', () => {
                 date_finish: '2019-08-30T23:28:13+03:00'
             }
         };
-        expect(batch_1.mergeBatchPayloads([batch1, batch2])).toMatchSnapshot();
+        expect((0, batch_1.mergeBatchPayloads)([batch1, batch2])).toMatchSnapshot();
     });
     it('should merge array payloads', () => {
         const batch1 = {
@@ -172,21 +188,24 @@ describe('Client `mergeBatchPayloads` method', () => {
                 result_error: [],
                 result_total: [8, 8],
                 result_next: [2, 4],
-                result_time: [{
+                result_time: [
+                    {
                         start: 1567196891.008149,
                         finish: 1567196891.022234,
                         duration: 0.014085054397583008,
                         processing: 0.013998985290527344,
                         date_start: '2019-08-30T23:28:11+03:00',
                         date_finish: '2019-08-30T23:28:11+03:00'
-                    }, {
+                    },
+                    {
                         start: 1567196891.022316,
                         finish: 1567196891.03225,
                         duration: 0.009933948516845703,
                         processing: 0.009846210479736328,
                         date_start: '2019-08-30T23:28:11+03:00',
                         date_finish: '2019-08-30T23:28:11+03:00'
-                    }]
+                    }
+                ]
             },
             time: {
                 start: 1567196890.959017,
@@ -206,21 +225,24 @@ describe('Client `mergeBatchPayloads` method', () => {
                 result_error: [],
                 result_total: [8, 8],
                 result_next: [6, 8],
-                result_time: [{
+                result_time: [
+                    {
                         start: 1567196891.032315,
                         finish: 1567196891.035297,
                         duration: 0.002981901168823242,
                         processing: 0.002897024154663086,
                         date_start: '2019-08-30T23:28:11+03:00',
                         date_finish: '2019-08-30T23:28:11+03:00'
-                    }, {
+                    },
+                    {
                         start: 1567196891.03536,
                         finish: 1567196891.039936,
                         duration: 0.004575967788696289,
                         processing: 0.00450897216796875,
                         date_start: '2019-08-30T23:28:11+03:00',
                         date_finish: '2019-08-30T23:28:11+03:00'
-                    }]
+                    }
+                ]
             },
             time: {
                 start: 1567196890.959517,
@@ -231,12 +253,12 @@ describe('Client `mergeBatchPayloads` method', () => {
                 date_finish: '2019-08-30T23:28:13+03:00'
             }
         };
-        expect(batch_1.mergeBatchPayloads([batch1, batch2])).toMatchSnapshot();
+        expect((0, batch_1.mergeBatchPayloads)([batch1, batch2])).toMatchSnapshot();
     });
 });
 const TEST_URI = 'https://test.com/rest';
-const batch = batch_1.default({
-    get: got_1.default.extend({ baseUrl: TEST_URI, json: true }).get
+const batch = (0, batch_1.default)({
+    get: got_1.default.extend({ prefixUrl: TEST_URI, responseType: 'json' }).get
 });
 const RESPONSE_200 = 200;
 describe('Client `batch` method', () => {
@@ -247,7 +269,10 @@ describe('Client `batch` method', () => {
             one: { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             two: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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%5Bone%5D=${commands.one.method}%3FID%3D${dealId}&cmd%5Btwo%5D=${commands.two.method}`)
             .reply(RESPONSE_200, payload);
         await batch(commands);
@@ -260,7 +285,10 @@ describe('Client `batch` method', () => {
             0: { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             1: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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}%3FID%3D${dealId}&cmd%5B1%5D=${commands[1].method}`)
             .reply(RESPONSE_200, payload);
         await batch(commands);
@@ -273,7 +301,10 @@ describe('Client `batch` method', () => {
             { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             { method: methods_1.Method.CRM_DEAL_LIST }
         ];
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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}%3FID%3D${dealId}&cmd%5B1%5D=${commands[1].method}`)
             .reply(RESPONSE_200, payload);
         await batch(commands);
@@ -287,7 +318,10 @@ describe('Client `batch` method', () => {
             one: { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             two: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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%5Bone%5D=${commands.one.method}%3FID%3D${dealId}`)
             .reply(RESPONSE_200, payload)
             .get(`/${methods_1.Method.BATCH}?cmd%5Btwo%5D=${commands.two.method}`)
@@ -303,7 +337,10 @@ describe('Client `batch` method', () => {
             0: { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             1: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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}%3FID%3D${dealId}`)
             .reply(RESPONSE_200, payload)
             .get(`/${methods_1.Method.BATCH}?cmd%5B1%5D=${commands[1].method}`)
@@ -319,7 +356,10 @@ describe('Client `batch` method', () => {
             { method: methods_1.Method.CRM_DEAL_GET, params: { ID: dealId } },
             { method: methods_1.Method.CRM_DEAL_LIST }
         ];
-        const scope = nock_1.default(TEST_URI)
+        const scope = (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}%3FID%3D${dealId}`)
             .reply(RESPONSE_200, payload)
             .get(`/${methods_1.Method.BATCH}?cmd%5B0%5D=${commands[1].method}`)
@@ -342,11 +382,15 @@ describe('Client `batch` method', () => {
             },
             time: {}
         };
-        nock_1.default(TEST_URI)
+        (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}&cmd%5B1%5D=${commands[1].method}`)
             .reply(RESPONSE_200, payload);
         expect(await batch(commands)).toEqual(payload);
     });
+    // @todo Test this also for named and numbered commands
     it('should merge payloads when more then max allowed commands provided', async () => {
         const maxAllowedCommands = 1;
         const commands = {
@@ -373,7 +417,10 @@ describe('Client `batch` method', () => {
             },
             time: {}
         };
-        nock_1.default(TEST_URI)
+        (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}`)
             .reply(RESPONSE_200, payload1)
             .get(`/${methods_1.Method.BATCH}?cmd%5B1%5D=${commands[1].method}`)
@@ -395,7 +442,10 @@ describe('Client `batch` method', () => {
             one: { method: methods_1.Method.CRM_DEAL_GET },
             two: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        nock_1.default(TEST_URI)
+        (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%5Bone%5D=${commands.one.method}&cmd%5Btwo%5D=${commands.two.method}`)
             .reply(RESPONSE_200, payload);
         return expect(batch(commands)).rejects.toMatchSnapshot();
@@ -404,14 +454,20 @@ describe('Client `batch` method', () => {
         const payload = {
             result: {
                 result: ['done'],
-                result_error: ['Expected error from numbered `batch` 0', 'Expected error from numbered `batch` 1']
+                result_error: [
+                    'Expected error from numbered `batch` 0',
+                    'Expected error from numbered `batch` 1'
+                ]
             }
         };
         const commands = {
             0: { method: methods_1.Method.CRM_DEAL_GET },
             1: { method: methods_1.Method.CRM_DEAL_LIST }
         };
-        nock_1.default(TEST_URI)
+        (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}&cmd%5B1%5D=${commands[1].method}`)
             .reply(RESPONSE_200, payload);
         return expect(batch(commands)).rejects.toMatchSnapshot();
@@ -420,17 +476,19 @@ describe('Client `batch` method', () => {
         const payload = {
             result: {
                 result: ['done'],
-                result_error: ['Expected error from array of command `batch` 0', 'Expected error from array of command `batch` 1']
+                result_error: [
+                    'Expected error from array of command `batch` 0',
+                    'Expected error from array of command `batch` 1'
+                ]
             }
         };
-        const commands = [
-            { method: methods_1.Method.CRM_DEAL_GET },
-            { method: methods_1.Method.CRM_DEAL_LIST }
-        ];
-        nock_1.default(TEST_URI)
+        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}&cmd%5B1%5D=${commands[1].method}`)
             .reply(RESPONSE_200, payload);
         return expect(batch(commands)).rejects.toMatchSnapshot();
     });
 });
-//# sourceMappingURL=batch.unit.test.js.map

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

@@ -1,10 +1,17 @@
-import { GotJSONFn } from 'got';
+import got from 'got';
 import { Method, MethodParams, MethodPayload } from '../../methods';
 import { Payload } from '../../payloads';
+/**
+ * Checks wether payload have any errors and if it does — throws them
+ * Bitrix payload types do not provide discriminators, so we're forced to type cast them
+ */
 export declare const handlePayload: <P extends Payload<unknown>>(payload: P) => P;
 export declare type Call = <M extends Method>(method: M, params: MethodParams<M>) => Promise<MethodPayload<M>>;
-interface Dependencies {
-    readonly get: GotJSONFn;
-}
+declare type Dependencies = {
+    readonly get: typeof got.get;
+};
+/**
+ * Dispatches a request with specified method and params. Will fill figure out payload type based on the Method
+ */
 declare const _default: ({ get }: Dependencies) => Call;
 export default _default;

package/build/main/client/methods/call.js

@@ -3,24 +3,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.handlePayload = void 0;
 const qs_1 = require("qs");
 const isArray_1 = __importDefault(require("../../utils/isArray"));
-exports.handlePayload = (payload) => {
+/**
+ * Checks wether payload have any errors and if it does — throws them
+ * Bitrix payload types do not provide discriminators, so we're forced to type cast them
+ */
+const handlePayload = (payload) => {
+    var _a;
     if (payload.error) {
-        throw new Error(`[call] failed to get the resource: ${payload.error}.`);
+        throw new Error(`[call] failed to get the resource: ${(_a = payload.error) !== null && _a !== void 0 ? _a : ''}.`);
     }
     if (payload.result && payload.result.result_error) {
         const resultErrors = payload.result.result_error;
-        const errors = isArray_1.default(resultErrors) ? resultErrors : Object.values(resultErrors);
+        const errors = (0, isArray_1.default)(resultErrors) ? resultErrors : Object.values(resultErrors);
         if (errors.length > 0) {
+            // @todo We can give better formatting to display errored commands. But it's not important for now
             throw new Error(`[batch] failed to process. Received errors in ${errors.length} commands:\n${errors.join('\n')}`);
         }
     }
     return payload;
 };
+exports.handlePayload = handlePayload;
+/**
+ * Dispatches a request with specified method and params. Will fill figure out payload type based on the Method
+ */
 exports.default = ({ get }) => {
-    const call = (method, params) => get(method, { query: qs_1.stringify(params) })
-        .then(({ body }) => exports.handlePayload(body));
+    const call = (method, params) => get(method, { searchParams: (0, qs_1.stringify)(params) })
+        .then(({ body }) => (0, exports.handlePayload)(body));
     return call;
 };
-//# sourceMappingURL=call.js.map