@2bad/bitrix 2.5.1 → 3.0.0-beta.0

package/build/module/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/module/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/module/bitrix.js

@@ -1,40 +0,0 @@
-import Client from './client';
-import CompaniesService from './services/companies';
-import ContactsService from './services/contacts';
-import DealsService from './services/deals';
-import LeadsService from './services/leads';
-import StatusesService from './services/statuses';
-import UsersService from './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`.
- */
-export const Bitrix = (restURI, accessToken, clientOptions) => {
-    const { call, batch, list } = Client(restURI, accessToken, clientOptions);
-    return {
-        call,
-        batch,
-        list,
-        companies: CompaniesService({ call, list }),
-        contacts: ContactsService({ call, list }),
-        deals: DealsService({ call, list }),
-        leads: LeadsService({ call, list }),
-        statuses: StatusesService({ call }),
-        users: UsersService({ call })
-    };
-};
-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/module/bitrix.unit.test.d.ts

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

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

@@ -1,16 +0,0 @@
-import Bitrix from './bitrix';
-import * as client from './client';
-describe('Bitrix', () => {
-    it('should init', () => {
-        expect(() => Bitrix('https://test.com', 'test_token')).not.toThrow();
-    });
-    it('should pass endpoint and access token to the client', () => {
-        const SpiedClient = jest.spyOn(client, 'default');
-        Bitrix('https://test.com', 'test_token');
-        expect(SpiedClient.mock.calls).toMatchSnapshot();
-    });
-    it('should expose API methods', () => {
-        const bitrix = Bitrix('https://test.com', 'test_token');
-        expect(bitrix).toMatchSnapshot();
-    });
-});

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

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

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

@@ -1,65 +0,0 @@
-import got from 'got';
-import nock from 'nock';
-import Queue from 'p-queue';
-import { Method } from '../methods';
-import Client from './index';
-const TEST_URI = 'https://test.com/rest';
-const TEST_ACCESS_TOKEN = 'test_access_token';
-const RESPONSE_200 = 200;
-const spiedQueueAdd = jest.spyOn(Queue.prototype, 'add');
-const client = Client(TEST_URI, TEST_ACCESS_TOKEN);
-describe('Client', () => {
-    beforeEach(() => {
-        spiedQueueAdd.mockClear();
-    });
-    it('should init', () => {
-        expect(() => Client(TEST_URI, TEST_ACCESS_TOKEN)).not.toThrow();
-    });
-    it('should extend `Got` instance with a specified parameters', () => {
-        const spiedGotExtend = jest.spyOn(got, 'extend');
-        Client('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 = Method.CRM_DEAL_LIST;
-            nock(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: Method.CRM_DEAL_GET },
-                { 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}`)
-                .reply(RESPONSE_200, payload);
-            await client.batch(commands, 1);
-            expect(spiedQueueAdd.mock.calls).toMatchSnapshot();
-        });
-    });
-});

package/build/module/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/module/client/hooks/addAccessToken.js

@@ -1,11 +0,0 @@
-/**
- * Got can't merge `query` option with other queries if they are string. But that hook can.
- */
-export 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/module/client/hooks/addAccessToken.unit.test.d.ts

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

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

@@ -1,26 +0,0 @@
-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 = merge({ path: 'test', responseType: 'json' });
-        addAccessToken(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' });
-        addAccessToken(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' });
-        addAccessToken()(options);
-        expect(options.path).toBe('test');
-    });
-    it('should not add access token when URL is undefined', () => {
-        const options = merge({ path: undefined, responseType: 'json' });
-        addAccessToken(token)(options);
-        expect(options.path).toBe(undefined);
-    });
-});

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

@@ -1,76 +0,0 @@
-import chunk from 'lodash.chunk';
-import fromPairs from 'lodash.frompairs';
-import { stringify as toQuery } from 'qs';
-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) => ({
-        result: {
-            result: merge(merged.result.result || [], payload.result.result),
-            result_error: merge(merged.result.result_error || [], payload.result.result_error),
-            result_next: merge(merged.result.result_next || [], payload.result.result_next),
-            result_time: merge(merged.result.result_time || [], payload.result.result_time),
-            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, { searchParams: prepareCommandsQueries(c) })
-            .then(({ body }) => body);
-        const calls = chunkCommands(commands, commandsPerRequest)
-            .map(call);
-        return await Promise.all(calls)
-            .then((chunkedPayloads) => {
-            const payloads = mergeBatchPayloads(chunkedPayloads);
-            return handlePayload(payloads);
-        });
-    };
-    return batch;
-};

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

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