@2bad/bitrix 2.4.0 → 2.5.1

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

@@ -0,0 +1,183 @@
+"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 got_1 = __importDefault(require("got"));
+const nock_1 = __importDefault(require("nock"));
+const methods_1 = require("../../methods");
+const call_1 = __importStar(require("./call"));
+const TEST_URI = 'https://test.com/rest';
+const call = (0, call_1.default)({
+    get: got_1.default.extend({ prefixUrl: TEST_URI, responseType: 'json' }).get
+});
+const RESPONSE_200 = 200;
+describe('Client `handlePayload` method', () => {
+    it('should return `GetPayload`', () => {
+        const payload = {
+            result: 'done',
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        expect((0, call_1.handlePayload)(payload)).toBe(payload);
+    });
+    it('should return `ListPayload`', () => {
+        const payload = {
+            error: undefined,
+            next: undefined,
+            result: ['done'],
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' },
+            total: 1
+        };
+        expect((0, call_1.handlePayload)(payload)).toBe(payload);
+    });
+    it('should throw when getting error in `ListPayload`', () => {
+        const payload = {
+            error: 'Expected error for `handlePayload`',
+            next: undefined,
+            result: ['done'],
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' },
+            total: 1
+        };
+        expect(() => (0, call_1.handlePayload)(payload)).toThrowErrorMatchingSnapshot();
+    });
+    it('should return `BatchPayload` with numbered commands', () => {
+        const payload = {
+            result: {
+                result: { one: 'done' },
+                result_error: [],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        expect((0, call_1.handlePayload)(payload)).toBe(payload);
+    });
+    it('should return `BatchPayload` with result from array of commands', () => {
+        const payload = {
+            result: {
+                result: ['done'],
+                result_error: [],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        expect((0, call_1.handlePayload)(payload)).toBe(payload);
+    });
+    it('should throw when getting errors in `BatchPayload` with result from named commands', () => {
+        const payload = {
+            result: {
+                result: { one: 'done' },
+                result_error: { one: 'Expected error for `handlePayload`' },
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        expect(() => (0, call_1.handlePayload)(payload)).toThrowErrorMatchingSnapshot();
+    });
+    it('should throw when getting errors in `BatchPayload` with result from array of commands', () => {
+        const payload = {
+            result: {
+                result: ['done'],
+                result_error: ['Expected error for `handlePayload`'],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        expect(() => (0, call_1.handlePayload)(payload)).toThrowErrorMatchingSnapshot();
+    });
+});
+describe('Client `call` method', () => {
+    it('should form a proper request', async () => {
+        const params = { id: '1' };
+        const scope = (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.CRM_DEAL_GET}`)
+            .query(params)
+            .reply(RESPONSE_200);
+        await call(methods_1.Method.CRM_DEAL_GET, params);
+        expect(scope.done()).toBe(undefined);
+    });
+    it('should form a proper request with list methods', async () => {
+        const params = {
+            filter: { '>PROBABILITY': 50 },
+            order: { STAGE_ID: 'ASC' },
+            select: ['ID', 'TITLE'],
+            start: 50
+        };
+        const scope = (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.CRM_DEAL_LIST}`)
+            .query(params)
+            .reply(RESPONSE_200);
+        await call(methods_1.Method.CRM_DEAL_LIST, params);
+        expect(scope.done()).toBe(undefined);
+    });
+    it('should return body as payload', async () => {
+        const params = { id: '1' };
+        const payload = { test: 'value' };
+        (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.CRM_DEAL_GET}`)
+            .query(params)
+            .reply(RESPONSE_200, payload);
+        expect(await call(methods_1.Method.CRM_DEAL_GET, params)).toEqual(payload);
+    });
+    it('should return body as payload with list methods', async () => {
+        const payload = { result: ['done'] };
+        (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.CRM_DEAL_LIST}`)
+            .reply(RESPONSE_200, payload);
+        expect(await call(methods_1.Method.CRM_DEAL_LIST, {})).toEqual(payload);
+    });
+    it('should throw when getting errors in payload', () => {
+        const payload = { result: ['done'], error: 'Expected error for `getList`' };
+        (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.CRM_DEAL_LIST}`)
+            .reply(RESPONSE_200, payload);
+        return expect(call(methods_1.Method.CRM_DEAL_LIST, {})).rejects.toMatchSnapshot();
+    });
+    it('should throw when getting errors in batch payload', () => {
+        const payload = {
+            result: {
+                result: ['done'],
+                result_error: ['Expected error'],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: { start: 1, finish: 1, duration: 1, processing: 1, date_start: 'date', date_finish: 'date' }
+        };
+        (0, nock_1.default)(TEST_URI)
+            .get(`/${methods_1.Method.BATCH}`)
+            .reply(RESPONSE_200, payload);
+        return expect(call(methods_1.Method.BATCH, {})).rejects.toMatchSnapshot();
+    });
+    it.todo('should cast payload to the <P>');
+});

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

@@ -3,16 +3,28 @@ import { ListableMethod, MethodParams, MethodPayloadType } from '../../methods';
 import { BatchPayload, ListPayload } from '../../payloads';
 import { Batch } from './batch';
 import { Call } from './call';
+/**
+ * Generates required amount of commands to process specified amount of entries
+ */
 export declare const fillWithCommands: <C extends Command>({ method, params }: C, start: number, toProcess: number, entriesPerCommand: number) => readonly {
     readonly method: C["method"];
     readonly params?: C["params"] | undefined;
 }[];
+/**
+ * Get the highest value from object or an array if there's any
+ */
 export declare const highest: (input: ReadonlyArray<number | undefined> | Record<string, number | undefined>) => number | undefined;
+/**
+ * Converts batch payload to a list payload
+ */
 export declare const batchToListPayload: <P>(payload: BatchPayload<Record<string, P> | readonly P[]>) => ListPayload<P>;
 declare type Dependencies = {
     readonly call: Call;
     readonly batch: Batch;
 };
 export declare type List = <M extends ListableMethod>(method: M, params: MethodParams<M>) => Promise<ListPayload<MethodPayloadType<M>>>;
+/**
+ * Gets all entries by dispatching required amount of requests. Will fill figure out payload type based on the Method.
+ */
 declare const _default: ({ call, batch }: Dependencies) => List;
 export default _default;

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

@@ -6,12 +6,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.batchToListPayload = exports.highest = exports.fillWithCommands = void 0;
 const lodash_range_1 = __importDefault(require("lodash.range"));
 const MAX_ENTRIES_PER_COMMAND = 50;
+/**
+ * Generates required amount of commands to process specified amount of entries
+ */
 const fillWithCommands = ({ method, params }, start, toProcess, entriesPerCommand) => {
     const requiresCommands = Math.ceil((toProcess - start) / entriesPerCommand);
-    return lodash_range_1.default(0, requiresCommands)
+    return (0, lodash_range_1.default)(0, requiresCommands)
         .map((i) => ({ method, params: { ...params, start: start + (entriesPerCommand * i) } }));
 };
 exports.fillWithCommands = fillWithCommands;
+/**
+ * Get the highest value from object or an array if there's any
+ */
 const highest = (input) => Object.values(input).reduce((a, b) => a !== undefined && b !== undefined
     ? a > b ? a : b
     : a !== undefined && b === undefined
@@ -20,31 +26,41 @@ const highest = (input) => Object.values(input).reduce((a, b) => a !== undefined
             ? b
             : undefined, undefined);
 exports.highest = highest;
+/**
+ * Converts batch payload to a list payload
+ */
 const batchToListPayload = (payload) => {
     var _a;
+    // eslint-disable-next-line @typescript-eslint/naming-convention
     const { result: { result, result_total, result_error, result_next }, time } = payload;
-    const flattenResult = Object.entries(result).reduce((flatten, [_key, r]) => !r ? flatten : [...flatten, ...r], []);
+    const flattenResult = Object.entries(result).reduce(
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    // @ts-expect-error ignore this for now
+    (flatten, [_key, r]) => !r ? flatten : [...flatten, ...r], []);
     return {
         error: Object.values(result_error).join('\n'),
-        next: exports.highest(result_next),
+        next: (0, exports.highest)(result_next),
         result: flattenResult,
+        // @todo Not accurate, we do not care
         time,
-        total: (_a = exports.highest(result_total)) !== null && _a !== void 0 ? _a : 0
+        total: (_a = (0, exports.highest)(result_total)) !== null && _a !== void 0 ? _a : 0
     };
 };
 exports.batchToListPayload = batchToListPayload;
+/**
+ * Gets all entries by dispatching required amount of requests. Will fill figure out payload type based on the Method.
+ */
 exports.default = ({ call, batch }) => {
     const list = async (method, params) => {
         var _a;
         const start = (_a = params.start) !== null && _a !== void 0 ? _a : 0;
         const listAll = async () => {
-            const batchCommands = exports.fillWithCommands({ method, params }, start, firstCall.total, MAX_ENTRIES_PER_COMMAND);
+            const batchCommands = (0, exports.fillWithCommands)({ method, params }, start, firstCall.total, MAX_ENTRIES_PER_COMMAND);
             const payload = await batch(batchCommands);
-            return exports.batchToListPayload(payload);
+            return (0, exports.batchToListPayload)(payload);
         };
         const firstCall = await call(method, { ...params, start });
         return !firstCall.next ? firstCall : await listAll();
     };
     return list;
 };
-//# sourceMappingURL=list.js.map

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

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

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

@@ -0,0 +1,277 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const methods_1 = require("../../methods");
+const list_1 = __importStar(require("./list"));
+describe('Client `fillWithCommands` method', () => {
+    it('should fill array with required amount of commands to process all entries', () => {
+        const command = { method: methods_1.Method.CRM_DEAL_LIST, params: { select: ['*'] } };
+        const start = 0;
+        const toProcess = 7;
+        const entriesPerCommand = 2;
+        expect((0, list_1.fillWithCommands)(command, start, toProcess, entriesPerCommand)).toMatchSnapshot();
+    });
+    it('should properly take into account start', () => {
+        const command = { method: methods_1.Method.CRM_DEAL_LIST, params: { select: ['*'] } };
+        const start = 2;
+        const toProcess = 7;
+        const entriesPerCommand = 2;
+        expect((0, list_1.fillWithCommands)(command, start, toProcess, entriesPerCommand)).toMatchSnapshot();
+    });
+    it('should override `params.start`', () => {
+        const wrongStart = 99;
+        const command = { method: methods_1.Method.CRM_DEAL_LIST, params: { start: wrongStart } };
+        const start = 0;
+        const toProcess = 2;
+        const entriesPerCommand = 1;
+        const commands = (0, list_1.fillWithCommands)(command, start, toProcess, entriesPerCommand);
+        expect(Object.values(commands).map((c) => c.params)).toMatchSnapshot();
+    });
+});
+describe('Client `highest` method', () => {
+    it('should get highest value from object', () => {
+        expect((0, list_1.highest)({ a: undefined })).toBe(undefined);
+        expect((0, list_1.highest)({ a: undefined, b: undefined })).toBe(undefined);
+        expect((0, list_1.highest)({ a: 1, b: undefined })).toBe(1);
+        expect((0, list_1.highest)({ a: undefined, b: 1 })).toBe(1);
+        expect((0, list_1.highest)({ a: 1, b: 2 })).toBe(2);
+        expect((0, list_1.highest)({ a: 2, b: 1 })).toBe(2);
+    });
+    it('should get highest value from array', () => {
+        expect((0, list_1.highest)([undefined])).toBe(undefined);
+        expect((0, list_1.highest)([undefined, undefined])).toBe(undefined);
+        expect((0, list_1.highest)([1, undefined])).toBe(1);
+        expect((0, list_1.highest)([undefined, 1])).toBe(1);
+        expect((0, list_1.highest)([1, 2])).toBe(2);
+        expect((0, list_1.highest)([2, 1])).toBe(2);
+    });
+});
+describe('Client `batchToListPayload` method', () => {
+    it('should convert batch with named payloads to a list payload', () => {
+        const payload = {
+            result: {
+                result: {
+                    a: [{ ID: '1' }, { ID: '2' }],
+                    b: [{ ID: '3' }, { ID: '4' }]
+                },
+                result_error: { a: 'Expected error A', b: 'Expected error B' },
+                result_total: { a: 4, b: 4 },
+                result_next: { a: 2, b: 4 },
+                result_time: {
+                    a: {
+                        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'
+                    },
+                    b: {
+                        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,
+                finish: 1567196891.223739,
+                duration: 0.2647218704223633,
+                processing: 0.21567082405090332,
+                date_start: '2019-08-30T23:28:10+03:00',
+                date_finish: '2019-08-30T23:28:11+03:00'
+            }
+        };
+        expect((0, list_1.batchToListPayload)(payload)).toMatchSnapshot();
+    });
+    it('should convert batch with payload of arrays to a list payload', () => {
+        const payload = {
+            result: {
+                result: [
+                    [{ ID: '1' }, { ID: '2' }],
+                    [{ ID: '3' }, { ID: '4' }]
+                ],
+                result_error: ['Expected error 1', 'Expected error 2'],
+                result_total: [4, 4],
+                result_next: [2, 4],
+                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,
+                finish: 1567196891.223739,
+                duration: 0.2647218704223633,
+                processing: 0.21567082405090332,
+                date_start: '2019-08-30T23:28:10+03:00',
+                date_finish: '2019-08-30T23:28:11+03:00'
+            }
+        };
+        expect((0, list_1.batchToListPayload)(payload)).toMatchSnapshot();
+    });
+    it('should handle undefined in `result`', () => {
+        const payload = {
+            result: {
+                result: [undefined, [{ ID: '1' }], undefined],
+                result_error: [],
+                result_total: [],
+                result_next: [],
+                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,
+                finish: 1567196891.223739,
+                duration: 0.2647218704223633,
+                processing: 0.21567082405090332,
+                date_start: '2019-08-30T23:28:10+03:00',
+                date_finish: '2019-08-30T23:28:11+03:00'
+            }
+        };
+        expect((0, list_1.batchToListPayload)(payload)).toMatchSnapshot();
+    });
+});
+describe('Client `list` method', () => {
+    it('should make one request when entries can be fetched in one go', async () => {
+        const callMock = jest.fn(() => Promise.resolve({ next: false }));
+        const batchMock = jest.fn(() => Promise.resolve({}));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        await list(methods_1.Method.CRM_DEAL_LIST, {});
+        expect(callMock.mock.calls).toMatchSnapshot();
+        expect(batchMock).not.toBeCalled();
+    });
+    it('should make multiple requests when entries can not be fetched in one go', async () => {
+        const callMock = jest.fn(() => Promise.resolve({ next: 2, total: 120 }));
+        const batchMock = jest.fn(() => Promise.resolve({
+            result: {
+                result: ['done'],
+                result_error: [],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: {}
+        }));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        await list(methods_1.Method.CRM_DEAL_LIST, {});
+        expect(callMock.mock.calls).toMatchSnapshot();
+        expect(batchMock.mock.calls).toMatchSnapshot();
+    });
+    it('should return a first request payload when entities can be fetched in a single request', async () => {
+        const mockPayload = { next: false, result: 'test' };
+        const callMock = jest.fn(() => Promise.resolve(mockPayload));
+        const batchMock = jest.fn(() => Promise.resolve({}));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        const payload = await list(methods_1.Method.CRM_DEAL_LIST, {});
+        expect(payload).toEqual(mockPayload);
+    });
+    it('should return a flatten payload when entities can not be fetched in a single request', async () => {
+        const mockPayload = {
+            result: {
+                result: {
+                    a: [{ ID: '1' }, { ID: '2' }],
+                    b: [{ ID: '3' }, { ID: '4' }]
+                },
+                result_error: { a: 'Expected error A', b: 'Expected error B' },
+                result_total: { a: 4, b: 4 },
+                result_next: { a: 2, b: 4 },
+                result_time: {
+                    a: { start: 1567196891.008149 },
+                    b: { start: 1567196891.022316 }
+                }
+            },
+            time: { start: 1567196890.959017 }
+        };
+        const callMock = jest.fn(() => Promise.resolve({ next: 2 }));
+        const batchMock = jest.fn(() => Promise.resolve(mockPayload));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        const payload = await list(methods_1.Method.CRM_DEAL_LIST, {});
+        expect(payload).toMatchSnapshot();
+    });
+    it('should default start to 0', async () => {
+        const callMock = jest.fn(() => Promise.resolve({ next: 2, total: 20 }));
+        const batchMock = jest.fn(() => Promise.resolve({
+            result: {
+                result: ['done'],
+                result_error: [],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: {}
+        }));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        await list(methods_1.Method.CRM_DEAL_LIST, {});
+        expect(callMock.mock.calls[0]).toMatchSnapshot();
+        expect(batchMock.mock.calls[0]).toMatchSnapshot();
+    });
+    it('should properly take into account start', async () => {
+        const callMock = jest.fn(() => Promise.resolve({ next: 2, total: 120 }));
+        const batchMock = jest.fn(() => Promise.resolve({
+            result: {
+                result: ['done'],
+                result_error: [],
+                result_next: [],
+                result_time: [],
+                result_total: []
+            },
+            time: {}
+        }));
+        const list = (0, list_1.default)({ call: callMock, batch: batchMock });
+        await list(methods_1.Method.CRM_DEAL_LIST, { start: 27 });
+        expect(callMock.mock.calls).toMatchSnapshot();
+        expect(batchMock.mock.calls).toMatchSnapshot();
+    });
+    it.todo('should cast first request payload to the <P>');
+    it.todo('should cast payload results to the <P>');
+});

package/build/main/commands.js

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

package/build/main/methods.d.ts

@@ -59,6 +59,13 @@ export declare type ListParams = {
     };
     readonly select?: readonly string[];
 };
+/**
+ * A mega map of all supported Bitrix methods to their parameters. Used to resolve
+ * low-level client method required params and payload types.
+ * - `type` — a type that method associated with
+ * - `payload` — a payload that method returns
+ * - `params` — params that method accepts
+ */
 export declare type Methods = MethodsMap & CompaniesMethods & ContactsMethods & DealsMethods & LeadsMethods & StatusesMethods & UsersMethods & {
     readonly [Method.BATCH]: {
         readonly type: unknown;
@@ -66,8 +73,20 @@ export declare type Methods = MethodsMap & CompaniesMethods & ContactsMethods &
         readonly params: Commands;
     };
 };
+/**
+ * Retrieve specified method data
+ */
 export declare type MethodData<M extends Method> = ExtractValue<Methods, M>;
+/**
+ * Retrieve associated with specified method type
+ */
 export declare type MethodPayloadType<M extends Method> = MethodData<M>['type'];
+/**
+ * Retrieve specified method payload type
+ */
 export declare type MethodPayload<M extends Method> = MethodData<M>['payload'];
+/**
+ * Retrieve specified method params
+ */
 export declare type MethodParams<M extends Method> = MethodData<M>['params'];
 export {};

package/build/main/methods.js

@@ -39,4 +39,3 @@ const LISTABLE_METHODS = [
     Method.CRM_DEAL_LIST,
     Method.CRM_LEAD_LIST
 ];
-//# sourceMappingURL=methods.js.map

package/build/main/payloads.js

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

package/build/main/services/common.d.ts

@@ -19,3 +19,4 @@ export declare type MultiField = {
     readonly VALUE: string;
     readonly TYPE_ID: string;
 };
+export declare type MultiFieldArray = ReadonlyArray<Pick<MultiField, 'VALUE' | 'VALUE_TYPE'>>;

package/build/main/services/common.js

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

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

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

package/build/main/services/companies/index.integration.test.d.ts

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

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

@@ -0,0 +1,19 @@
+"use strict";
+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 WEBHOOK_URL = process.env['WEBHOOK_URL'];
+if (!WEBHOOK_URL) {
+    throw Error('Integration tests require environmental variable `WEBHOOK_URL` to be set');
+}
+const { companies } = (0, bitrix_1.default)(WEBHOOK_URL);
+describe('Companies', () => {
+    describe('fields', () => {
+        it('should get all fields', async () => {
+            const { result } = await companies.fields();
+            expect(result).toMatchSnapshot();
+        });
+    });
+});

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

@@ -8,4 +8,3 @@ exports.default = ({ call, list }) => ({
     list: (params = {}) => list(methods_1.Method.CRM_COMPANY_LIST, params),
     update: (id, fields, params) => call(methods_1.Method.CRM_COMPANY_UPDATE, { id, fields, params })
 });
-//# sourceMappingURL=index.js.map

package/build/main/services/companies/index.unit.test.d.ts

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