@2bad/bitrix 2.4.0 → 2.5.0

package/README.md

@@ -1,30 +1,25 @@
----
-description: that doesn't suck
----
+![@2bad/bitrix](https://user-images.githubusercontent.com/4460311/64487745-c4a1ea00-d246-11e9-9d6e-a0b0227c801c.png)
 
-# Bitrix24 REST API client
+# Bitrix24 REST API client that doesn't suck
 
-![](https://user-images.githubusercontent.com/4460311/64487745-c4a1ea00-d246-11e9-9d6e-a0b0227c801c.png)
+[![NPM version](https://img.shields.io/npm/v/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix)
+[![License](https://img.shields.io/npm/l/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix)
+[![Code coverage](https://img.shields.io/codecov/c/github/2BAD/bitrix)](https://codecov.io/gh/2BAD/bitrix)
+[![Travis Build Status](https://img.shields.io/travis/2BAD/bitrix?logo=Travis)](https://travis-ci.org/github/2BAD/bitrix)
+[![GitHub Build Status](https://img.shields.io/github/workflow/status/2BAD/bitrix/Integration%20testing?logo=GitHub)](https://github.com/2BAD/bitrix/actions?query=workflow%3A%22Integration+testing%22)
+[![Written in TypeScript](https://img.shields.io/github/languages/top/2BAD/bitrix)](https://github.com/2BAD/bitrix/search?l=typescript)
 
- [![NPM version](https://img.shields.io/npm/v/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix)
- [![License](https://img.shields.io/npm/l/@2bad/bitrix)](https://www.npmjs.com/package/@2bad/bitrix)
- [![Code coverage](https://img.shields.io/codecov/c/github/2BAD/bitrix)](https://codecov.io/gh/2BAD/bitrix)
- [![Travis Build Status](https://img.shields.io/travis/2BAD/bitrix?logo=Travis)](https://travis-ci.org/github/2BAD/bitrix)
- [![GitHub Build Status](https://img.shields.io/github/workflow/status/2BAD/bitrix/Integration%20testing?logo=GitHub)](https://github.com/2BAD/bitrix/actions?query=workflow%3A%22Integration+testing%22)
- [![Dependency Status](https://img.shields.io/david/2BAD/bitrix)](https://david-dm.org/2BAD/bitrix)
- [![Written in TypeScript](https://img.shields.io/github/languages/top/2BAD/bitrix)](https://github.com/2BAD/bitrix/search?l=typescript)
-
-* 🔥 No bullshit
-* ✨ Expressive API
-* 💪 Strongly typed methods and requests results with TypeScript
-* 🚀 Handles records batching and rate limiting for you
-* ❤️ Promise-based
+- 🔥 No bullshit
+- ✨ Expressive API
+- 💪 Strongly typed methods and requests results with TypeScript
+- 🚀 Handles records batching and rate limiting for you
+- ❤️ Promise-based
 
 ![@2bad/bitrix usage example](https://user-images.githubusercontent.com/4460311/64130824-7798c080-cdcd-11e9-99f0-7ded87541a85.png)
 
 ### Install
 
-```text
+```shell
 npm install @2bad/bitrix
 ```
 
@@ -85,18 +80,18 @@ There are two ways to do that:
 
 ### API
 
-* Generic
-  * [`call()`](docs/methods.md#call)
-  * [`list()`](docs/methods.md#list)
-  * [`batch()`](docs/methods.md#batch)
-* CRM
-  * [Company](docs/services/companies.md)
-  * [Contact](docs/services/contacts.md)
-  * [Currency](docs/services/currencies.md)
-  * [Deal](docs/services/deals.md)
-  * [Lead](docs/services/leads.md)
-  * [Status](docs/services/statuses.md)
-* [User](docs/services/users.md)
+- Generic
+  - [`call()`](docs/methods.md#call)
+  - [`list()`](docs/methods.md#list)
+  - [`batch()`](docs/methods.md#batch)
+- CRM
+  - [Company](docs/services/companies.md)
+  - [Contact](docs/services/contacts.md)
+  - [Currency](docs/services/currencies.md)
+  - [Deal](docs/services/deals.md)
+  - [Lead](docs/services/leads.md)
+  - [Status](docs/services/statuses.md)
+- [User](docs/services/users.md)
 
 ### How it works
 
@@ -106,14 +101,14 @@ It takes care of the any necessary batching to run "large" commands, like retrie
 
 All client methods are automatically rate-limited and queued if needed to cope with Bitrix REST API limitation of 2 requests per second, so you should never see Bitrix errors about exceeding rate limits.
 
-Methods required params and returned payload types are automatically resolved based on [Methods](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/types.ts) interface, which effectively describes all currently supported methods.
+Methods required params and returned payload types are automatically resolved based on [Methods](source/types.ts) interface, which effectively describes all currently supported methods.
 
 To facilitate better architecture, the client divided into layers:
 
 1. **Methods** — a mostly generic [methods](docs/methods.md) like `call` to work with Bitrix API methods. They take care of the routine and provide a foundation for more complex operations.
-2. **Client** — a generic [client](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/client/README.md), which takes care of some additional routine tasks like setting access token on every request, setting up a queue for the rate limiting, and providing generic methods.
-3. **Services** — each [service](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/docs/services/README.md) provides an expressive interface to work with a specific group of Bitrix REST API operations. In essence, they do orchestrate generic client methods and parameters to get proper results.
-4. **Bitrix client** — a top-level [provider](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/bitrix.ts) of generic method and services. An effortless way to deal with Bitrix REST API by using an intuitive API, which takes care of all underlying complexity.
+2. **Client** — a generic [client](source/client/README.md), which takes care of some additional routine tasks like setting access token on every request, setting up a queue for the rate limiting, and providing generic methods.
+3. **Services** — each [service](docs/services/README.md) provides an expressive interface to work with a specific group of Bitrix REST API operations. In essence, they do orchestrate generic client methods and parameters to get proper results.
+4. **Bitrix client** — a top-level [provider](source/bitrix.ts) of generic method and services. An effortless way to deal with Bitrix REST API by using an intuitive API, which takes care of all underlying complexity.
 
 ### FAQ
 
@@ -123,7 +118,7 @@ The core is ready and stable. It can be used to arbitrary invoke any Bitrix REST
 
 However, not all Bitrix REST API methods are exposed as convenient client services yet \(the ones like `bitrix.deals.list()`\).
 
-If you need specific service, add one by making a Pull Request, following the structure of already existing [services](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/services/README.md) and ["Adding new methods"](./#adding-new-methods) instructions.
+If you need specific service, add one by making a Pull Request, following the structure of already existing [services](source/services/README.md) and ["Adding new methods"](./#adding-new-methods) instructions.
 
 > I'm not a Typed Language Master Race user. Can I use it with a regular JavaScript?
 
@@ -176,6 +171,14 @@ bitrix.list('some.new.list' as any, { select: ["TITLE"] })
 
 Use the `batch` method. It will handle all routine:
 
+> I'm using a self-signed SSL certificate and I'm getting a `[RequestError]: self signed certificate`. What should I do?
+
+Override [`got options`](https://github.com/sindresorhus/got/blob/main/documentation/2-options.md) in constructor:
+
+```typescript
+const bitrix = Bitrix('https://PORTAL_NAME.bitrix24.ru/rest', 'ACCESS_TOKEN', {https: { rejectUnauthorized: false }})
+```
+
 ```typescript
 bitrix.batch({
   lead: { method: Method.GET_LEAD, params: { ID: '77' } },
@@ -185,25 +188,25 @@ bitrix.batch({
 
 ### Development
 
-* `npm test` — run all tests and collect full coverage report
-* `npm run test:unit` — run unit tests and collect coverage report
-* `npm run test:integration` — run integration tests and collect coverage report
-* `npm run test:watch` — watch for changes and run all tests
-* `npm run test:unit:watch` — watch for changes and run unit tests
-* `npm run test:integration:watch` — watch for changes and run integration tests
-* `npm run build` — build the library for the release
+- `npm test` — run all tests and collect full coverage report
+- `npm run test:unit` — run unit tests and collect coverage report
+- `npm run test:integration` — run integration tests and collect coverage report
+- `npm run test:watch` — watch for changes and run all tests
+- `npm run test:unit:watch` — watch for changes and run unit tests
+- `npm run test:integration:watch` — watch for changes and run integration tests
+- `npm run build` — build the library for the release
 
 #### Adding new methods
 
 Proper method parameters and payload types handling requires some routine when adding any new method. Hopefully, we can do it better in future, but for now follow those steps:
 
-1. Add new method into the [`Method`](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/methods.ts) enum.
-2. Add it into the [`LISTABLE_METHODS`](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/methods.ts) array if it is listable \(paginated\). Not everything that lists is listable, so check it.
-3. Add or update related [service](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/services/README.md):
+1. Add new method into the [`Method`](source/methods.ts) enum.
+2. Add it into the [`LISTABLE_METHODS`](source/methods.ts) array if it is listable \(paginated\). Not everything that lists is listable, so check it.
+3. Add or update related [service](source/services/README.md):
    1. Put exposed by the service public methods into the `index.ts` file. Ensure that you're properly mapping service method arguments to `call` or `list` params.
    2. Add related entities into the `entities.ts`.
    3. Add interface describing service methods into the `methods.ts`. Test and check method payload type to be sure you've described it correctly!
-   4. Extend [`Methods`](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/methods.ts) interface with the added service-specific interface. That way the client will know how to resolve parameters and payload types for the added method.
+   4. Extend [`Methods`](source/methods.ts) interface with the added service-specific interface. That way the client will know how to resolve parameters and payload types for the added method.
    5. Add tests into the `index.unit.test.ts`.
-4. Re-export service public types like Entities in the [bitrix.ts](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/source/bitrix.ts) to make them available to the end-users.
-5. Document addition in the [docs](https://github.com/2BAD/bitrix/tree/b0db508dcebe77f486f7db833183f28de7de14db/docs/README.md).
+4. Re-export service public types like Entities in the [bitrix.ts](source/bitrix.ts) to make them available to the end-users.
+5. Document addition in the [docs](docs/README.md).

package/build/main/bitrix.d.ts

@@ -1,5 +1,13 @@
 import { ExtendOptions } from 'got';
-declare const _default: (restURI: string, accessToken?: string | undefined, clientOptions?: ExtendOptions | undefined) => {
+/**
+ * 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;

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

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

package/build/main/bitrix.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -20,18 +24,26 @@ const deals_1 = __importDefault(require("./services/deals"));
 const leads_1 = __importDefault(require("./services/leads"));
 const statuses_1 = __importDefault(require("./services/statuses"));
 const users_1 = __importDefault(require("./services/users"));
+/**
+ * Construct a Bitrix client with generic methods
+ * @param restURI REST endpoint, like a `https://hello.bitrix24.ua/rest` or an inbound webhook endpoint,
+ *                like a `https://hello.bitrix24.ua/rest/1/WEBHOOK_TOKEN`.
+ * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
+ * @param clientOptions an object that will overwrite underlying configuration for HTTP client,
+ *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
+ */
 exports.default = (restURI, accessToken, clientOptions) => {
-    const { call, batch, list } = client_1.default(restURI, accessToken, clientOptions);
+    const { call, batch, list } = (0, client_1.default)(restURI, accessToken, clientOptions);
     return {
         call,
         batch,
         list,
-        companies: companies_1.default({ call, list }),
-        contacts: contacts_1.default({ call, list }),
-        deals: deals_1.default({ call, list }),
-        leads: leads_1.default({ call, list }),
-        statuses: statuses_1.default({ call }),
-        users: users_1.default({ call })
+        companies: (0, companies_1.default)({ call, list }),
+        contacts: (0, contacts_1.default)({ call, list }),
+        deals: (0, deals_1.default)({ call, list }),
+        leads: (0, leads_1.default)({ call, list }),
+        statuses: (0, statuses_1.default)({ call }),
+        users: (0, users_1.default)({ call })
     };
 };
 __exportStar(require("./methods"), exports);
@@ -44,4 +56,3 @@ __exportStar(require("./services/deals/entities"), exports);
 __exportStar(require("./services/leads/entities"), exports);
 __exportStar(require("./services/statuses/entities"), exports);
 __exportStar(require("./services/users/entities"), exports);
-//# sourceMappingURL=bitrix.js.map

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,5 +1,13 @@
 import { ExtendOptions } from 'got';
-declare const _default: (restURI: string, accessToken?: string | undefined, options?: ExtendOptions | undefined) => {
+/**
+ * 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/main/client/index.js

@@ -10,7 +10,15 @@ const batch_1 = __importDefault(require("./methods/batch"));
 const call_1 = __importDefault(require("./methods/call"));
 const list_1 = __importDefault(require("./methods/list"));
 const BITRIX_API_RATE_LIMIT = 2;
-const BITRIX_API_RATE_INTERVAL = 1000;
+const BITRIX_API_RATE_INTERVAL = 1000; // 1 second
+/**
+ * Construct a Bitrix client with generic methods
+ * @param restURI REST endpoint, like a `https://hello.bitrix24.ru/rest` or an inbound webhook endpoint,
+ *                like a `https://hello.bitrix24.ru/rest/1/WEBHOOK_TOKEN`.
+ * @param accessToken Bitrix application Access Token. Do not specify in case inbound webhook endpoint used.
+ * @param options an object that will overwrite underlying configuration for HTTP client,
+ *                see `https://github.com/sindresorhus/got/blob/main/documentation/2-options.md`.
+ */
 exports.default = (restURI, accessToken, options) => {
     const client = got_1.default.extend({
         prefixUrl: restURI,
@@ -20,7 +28,7 @@ exports.default = (restURI, accessToken, options) => {
         responseType: 'json',
         hooks: {
             beforeRequest: [
-                addAccessToken_1.default(accessToken)
+                (0, addAccessToken_1.default)(accessToken)
             ]
         },
         ...options !== null && options !== void 0 ? options : {}
@@ -30,13 +38,16 @@ exports.default = (restURI, accessToken, options) => {
         interval: BITRIX_API_RATE_INTERVAL
     });
     const queuedGet = (...args) => queue.add(() => client.get(...args));
-    const call = call_1.default({ get: queuedGet });
-    const batch = batch_1.default({ get: queuedGet });
-    const list = list_1.default({ call, batch });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error @todo remove after issue is resolved (https://github.com/sindresorhus/got/issues/954)
+    const call = (0, call_1.default)({ get: queuedGet });
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error @todo remove after issue is resolved (https://github.com/sindresorhus/got/issues/954)
+    const batch = (0, batch_1.default)({ get: queuedGet });
+    const list = (0, list_1.default)({ call, batch });
     return {
         call,
         batch,
         list
     };
 };
-//# sourceMappingURL=index.js.map

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

@@ -3,8 +3,20 @@ import { Commands } from '../../commands';
 import { Method, MethodPayloadType } from '../../methods';
 import { BatchPayload } from '../../payloads';
 export declare const MAX_COMMANDS_PER_BATCH = 50;
+/**
+ * Split any number of commands into the chunks with max commands per batch in each chunk
+ */
 export declare const chunkCommands: <C extends Commands>(commands: C, size?: number) => readonly C[];
+/**
+ * Prepares list of commands to be used in requests to the Bitrix
+ * @note We could avoid that function... if only Bitrix API would support posting of the batch commands as
+ *       plain objects, like it does with other methods. Instead, it should be a dict or array of string queries
+ */
 export declare const prepareCommandsQueries: <C extends Commands, R = { [K in keyof C]: string; }>(commands: C) => R;
+/**
+ * Merges list of batch responses into a single batch
+ * @todo Generics inference is complicated here and might be not super accurate
+ */
 export declare const mergeBatchPayloads: <B extends BatchPayload<unknown>, P = B extends BatchPayload<infer U> ? U : never>(payloads: readonly B[]) => BatchPayload<P>;
 export declare type CommandsPayloads<C extends Commands, CM = {
     [K in keyof C]: C[K] extends {
@@ -17,5 +29,12 @@ export declare type Batch = <C extends Commands, P = CommandsPayloads<C>>(comman
 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

@@ -11,24 +11,42 @@ const methods_1 = require("../../methods");
 const isArray_1 = __importDefault(require("../../utils/isArray"));
 const call_1 = require("./call");
 exports.MAX_COMMANDS_PER_BATCH = 50;
+/**
+ * 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 = isArray_1.default(commands);
-    const chunks = lodash_chunk_1.default(Object.entries(commands), size);
+    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.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 ? `?${qs_1.stringify(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.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) => isArray_1.default(a) && isArray_1.default(b)
+    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]
         : ({ ...a, ...b });
     return payloads.reduce((merged, payload) => ({
@@ -40,21 +58,28 @@ 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: {} });
 };
 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, { searchParams: 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 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.d.ts

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