@bitrix24/b24jssdk 0.4.10 → 1.0.1

package/dist/esm/core/actions/manager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"manager.mjs","sources":["../../../../src/core/actions/manager.ts"],"sourcesContent":["import type { TypeB24 } from '../../types/b24'\nimport type { LoggerInterface } from '../../types/logger'\nimport { LoggerFactory } from '../../logger'\nimport { ApiVersion } from '../../types/b24'\nimport { ActionsManagerV2 } from './v2/manager-v2'\nimport { ActionsManagerV3 } from './v3/manager-v3'\n\nconst apiV2Name = Symbol(ApiVersion.v2)\nconst apiV3Name = Symbol(ApiVersion.v3)\n/**\n * Some actions for TypeB24\n */\nexport class ActionsManager {\n  protected _b24: TypeB24\n  protected _logger: LoggerInterface\n\n  protected _mapActions: Map<symbol, any>\n\n  constructor(b24: TypeB24) {\n    this._b24 = b24\n    this._logger = LoggerFactory.createNullLogger()\n\n    this._mapActions = new Map()\n  }\n\n  public setLogger(logger: LoggerInterface): void {\n    this._logger = logger\n    this.v2.setLogger(this._logger)\n    this.v3.setLogger(this._logger)\n  }\n\n  public getLogger(): LoggerInterface {\n    return this._logger\n  }\n\n  get v2(): ActionsManagerV2 {\n    if (!this._mapActions.has(apiV2Name)) {\n      this._mapActions.set(apiV2Name, new ActionsManagerV2(this._b24))\n    }\n    return this._mapActions.get(apiV2Name)! as ActionsManagerV2\n  }\n\n  get v3(): ActionsManagerV3 {\n    if (!this._mapActions.has(apiV3Name)) {\n      this._mapActions.set(apiV3Name, new ActionsManagerV3(this._b24))\n    }\n    return this._mapActions.get(apiV3Name)! as ActionsManagerV3\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,MAAM,SAAA,GAAY,MAAA,CAAO,UAAA,CAAW,EAAE,CAAA;AACtC,MAAM,SAAA,GAAY,MAAA,CAAO,UAAA,CAAW,EAAE,CAAA;AAI/B,MAAM,cAAA,CAAe;AAAA,EAZ5B;AAY4B,IAAA,MAAA,CAAA,IAAA,EAAA,gBAAA,CAAA;AAAA;AAAA,EAChB,IAAA;AAAA,EACA,OAAA;AAAA,EAEA,WAAA;AAAA,EAEV,YAAY,GAAA,EAAc;AACxB,IAAA,IAAA,CAAK,IAAA,GAAO,GAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,cAAc,gBAAA,EAAiB;AAE9C,IAAA,IAAA,CAAK,WAAA,uBAAkB,GAAA,EAAI;AAAA,EAC7B;AAAA,EAEO,UAAU,MAAA,EAA+B;AAC9C,IAAA,IAAA,CAAK,OAAA,GAAU,MAAA;AACf,IAAA,IAAA,CAAK,EAAA,CAAG,SAAA,CAAU,IAAA,CAAK,OAAO,CAAA;AAC9B,IAAA,IAAA,CAAK,EAAA,CAAG,SAAA,CAAU,IAAA,CAAK,OAAO,CAAA;AAAA,EAChC;AAAA,EAEO,SAAA,GAA6B;AAClC,IAAA,OAAO,IAAA,CAAK,OAAA;AAAA,EACd;AAAA,EAEA,IAAI,EAAA,GAAuB;AACzB,IAAA,IAAI,CAAC,IAAA,CAAK,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA,EAAG;AACpC,MAAA,IAAA,CAAK,YAAY,GAAA,CAAI,SAAA,EAAW,IAAI,gBAAA,CAAiB,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,IACjE;AACA,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA;AAAA,EACvC;AAAA,EAEA,IAAI,EAAA,GAAuB;AACzB,IAAA,IAAI,CAAC,IAAA,CAAK,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA,EAAG;AACpC,MAAA,IAAA,CAAK,YAAY,GAAA,CAAI,SAAA,EAAW,IAAI,gBAAA,CAAiB,IAAA,CAAK,IAAI,CAAC,CAAA;AAAA,IACjE;AACA,IAAA,OAAO,IAAA,CAAK,WAAA,CAAY,GAAA,CAAI,SAAS,CAAA;AAAA,EACvC;AACF;;;;"}

package/dist/esm/core/actions/v2/batch-by-chunk.mjs

@@ -0,0 +1,92 @@
+/**
+ * @package @bitrix24/b24jssdk
+ * @version 1.0.1
+ * @copyright (c) 2026 Bitrix24
+ * @license MIT
+ * @see https://github.com/bitrix24/b24jssdk
+ * @see https://bitrix24.github.io/b24jssdk/
+ */
+import { AbstractBatch } from '../abstract-batch.mjs';
+import { ApiVersion } from '../../../types/b24.mjs';
+import { Result } from '../../result.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class BatchByChunkV2 extends AbstractBatch {
+  static {
+    __name(this, "BatchByChunkV2");
+  }
+  /**
+   * Executes a batch request with automatic chunking for any number of commands.
+   * Unlike `BatchV2`, which is limited to 50 commands, this method automatically splits
+   * a large set of commands into multiple batches and executes them sequentially.
+   *
+   * @template T - The data type returned by commands (default: `unknown`)
+   *
+   * @param {ActionBatchByChunkV2} options - parameters for executing the request.
+   *     - `calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal` - Commands to execute in a batch.
+   *        Supports several formats:
+   *        1. Array of tuples: `[['method1', params1], ['method2', params2], ...]`
+   *        2. Array of objects: `[{ method: 'method1', params: params1 }, { method: 'method2', params: params2 }, ...]`
+   *        - Note: Named commands are not supported as they are difficult to process when chunking.
+   *     - `options?: Omit<IB24BatchOptions, 'returnAjaxResult'>` - Additional options for executing a batch request.
+   *        - `isHaltOnError?: boolean` - Whether to stop execution on the first error (default: true)
+   *        - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging (default: undefined)
+   *
+   * @returns {Promise<Result<T[]>>} A promise that is resolved by the result of executing all commands.
+   *
+   * @example
+   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'
+   *
+   * interface Contact { id: number, name: string }
+   * const commands = Array.from({ length: 150 }, (_, i) =>
+   *   ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: i + 1 }]
+   * )
+   *
+   * const response = await b24.actions.v2.batchByChunk.make<{ item: Contact }>({
+   *   calls: commands,
+   *   options: {
+   *     isHaltOnError: false,
+   *     requestId: 'batch-by-chunk-123'
+   *   }
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   *
+   * const resultData = response.getData()
+   * const items: Contact[] = []
+   * resultData.forEach((chunkRow) => {
+   *   items.push(chunkRow.item)
+   * })
+   * console.log(`Successfully retrieved ${items.length} items`)
+   *
+   * @tip For very large command sets, consider using server-side task queues instead of bulk batch requests.
+   */
+  async make(options) {
+    const batchSize = 50;
+    const opts = {
+      ...options.options,
+      returnAjaxResult: false,
+      apiVersion: ApiVersion.v2
+    };
+    const result = new Result();
+    const dataResult = [];
+    const chunks = this.chunkArray(options.calls, batchSize);
+    for (const chunkRequest of chunks) {
+      const response = await this._b24.getHttpClient(ApiVersion.v2).batch(chunkRequest, opts);
+      if (!response.isSuccess) {
+        this._addBatchErrorsIfAny(response, result);
+      }
+      for (const [_index, data] of response.getData().result) {
+        if (data.isSuccess) {
+          dataResult.push(data.getData().result);
+        }
+      }
+    }
+    return result.setData(dataResult);
+  }
+}
+
+export { BatchByChunkV2 };
+//# sourceMappingURL=batch-by-chunk.mjs.map

package/dist/esm/core/actions/v2/batch-by-chunk.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch-by-chunk.mjs","sources":["../../../../../src/core/actions/v2/batch-by-chunk.ts"],"sourcesContent":["import type { ActionOptions } from '../abstract-action'\nimport type {\n  BatchCommandsArrayUniversal,\n  BatchCommandsObjectUniversal, BatchCommandsUniversal\n} from '../../../types/http'\nimport type { IB24BatchOptions } from '../../../types/b24'\nimport { AbstractBatch } from '../abstract-batch'\nimport { ApiVersion } from '../../../types/b24'\nimport { Result } from '../../result'\n\nexport type ActionBatchByChunkV2 = ActionOptions & {\n  calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal\n  options?: Omit<IB24BatchOptions, 'returnAjaxResult'>\n}\n\n/**\n * Executes a batch request with automatic chunking for any number of commands. `restApi:v2`\n *\n * @todo add docs\n */\nexport class BatchByChunkV2 extends AbstractBatch {\n  /**\n   * Executes a batch request with automatic chunking for any number of commands.\n   * Unlike `BatchV2`, which is limited to 50 commands, this method automatically splits\n   * a large set of commands into multiple batches and executes them sequentially.\n   *\n   * @template T - The data type returned by commands (default: `unknown`)\n   *\n   * @param {ActionBatchByChunkV2} options - parameters for executing the request.\n   *     - `calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal` - Commands to execute in a batch.\n   *        Supports several formats:\n   *        1. Array of tuples: `[['method1', params1], ['method2', params2], ...]`\n   *        2. Array of objects: `[{ method: 'method1', params: params1 }, { method: 'method2', params: params2 }, ...]`\n   *        - Note: Named commands are not supported as they are difficult to process when chunking.\n   *     - `options?: Omit<IB24BatchOptions, 'returnAjaxResult'>` - Additional options for executing a batch request.\n   *        - `isHaltOnError?: boolean` - Whether to stop execution on the first error (default: true)\n   *        - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging (default: undefined)\n   *\n   * @returns {Promise<Result<T[]>>} A promise that is resolved by the result of executing all commands.\n   *\n   * @example\n   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'\n   *\n   * interface Contact { id: number, name: string }\n   * const commands = Array.from({ length: 150 }, (_, i) =>\n   *   ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: i + 1 }]\n   * )\n   *\n   * const response = await b24.actions.v2.batchByChunk.make<{ item: Contact }>({\n   *   calls: commands,\n   *   options: {\n   *     isHaltOnError: false,\n   *     requestId: 'batch-by-chunk-123'\n   *   }\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   *\n   * const resultData = response.getData()\n   * const items: Contact[] = []\n   * resultData.forEach((chunkRow) => {\n   *   items.push(chunkRow.item)\n   * })\n   * console.log(`Successfully retrieved ${items.length} items`)\n   *\n   * @tip For very large command sets, consider using server-side task queues instead of bulk batch requests.\n   */\n  public override async make<T = unknown>(options: ActionBatchByChunkV2): Promise<Result<T[]>> {\n    const batchSize = 50\n\n    const opts = {\n      ...options.options,\n      returnAjaxResult: false,\n      apiVersion: ApiVersion.v2\n    }\n\n    // callBatchByChunk\n    const result = new Result<T[]>()\n\n    const dataResult: T[] = []\n    const chunks = this.chunkArray(options.calls as BatchCommandsUniversal, batchSize) as BatchCommandsArrayUniversal[] | BatchCommandsObjectUniversal[]\n\n    for (const chunkRequest of chunks) {\n      const response = await this._b24.getHttpClient(ApiVersion.v2).batch<T[]>(chunkRequest, opts)\n\n      if (!response.isSuccess) {\n        this._addBatchErrorsIfAny(response, result)\n      }\n\n      for (const [_index, data] of response.getData()!.result!) {\n        // @memo Add only success rows\n        if (data.isSuccess) {\n          dataResult.push(data.getData()!.result)\n        }\n      }\n    }\n\n    return result.setData(dataResult)\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;AAoBO,MAAM,uBAAuB,aAAA,CAAc;AAAA,EApBlD;AAoBkD,IAAA,MAAA,CAAA,IAAA,EAAA,gBAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgDhD,MAAsB,KAAkB,OAAA,EAAqD;AAC3F,IAAA,MAAM,SAAA,GAAY,EAAA;AAElB,IAAA,MAAM,IAAA,GAAO;AAAA,MACX,GAAG,OAAA,CAAQ,OAAA;AAAA,MACX,gBAAA,EAAkB,KAAA;AAAA,MAClB,YAAY,UAAA,CAAW;AAAA,KACzB;AAGA,IAAA,MAAM,MAAA,GAAS,IAAI,MAAA,EAAY;AAE/B,IAAA,MAAM,aAAkB,EAAC;AACzB,IAAA,MAAM,MAAA,GAAS,IAAA,CAAK,UAAA,CAAW,OAAA,CAAQ,OAAiC,SAAS,CAAA;AAEjF,IAAA,KAAA,MAAW,gBAAgB,MAAA,EAAQ;AACjC,MAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,IAAA,CAAK,aAAA,CAAc,WAAW,EAAE,CAAA,CAAE,KAAA,CAAW,YAAA,EAAc,IAAI,CAAA;AAE3F,MAAA,IAAI,CAAC,SAAS,SAAA,EAAW;AACvB,QAAA,IAAA,CAAK,oBAAA,CAAqB,UAAU,MAAM,CAAA;AAAA,MAC5C;AAEA,MAAA,KAAA,MAAW,CAAC,MAAA,EAAQ,IAAI,KAAK,QAAA,CAAS,OAAA,GAAW,MAAA,EAAS;AAExD,QAAA,IAAI,KAAK,SAAA,EAAW;AAClB,UAAA,UAAA,CAAW,IAAA,CAAK,IAAA,CAAK,OAAA,EAAQ,CAAG,MAAM,CAAA;AAAA,QACxC;AAAA,MACF;AAAA,IACF;AAEA,IAAA,OAAO,MAAA,CAAO,QAAQ,UAAU,CAAA;AAAA,EAClC;AACF;;;;"}

package/dist/esm/core/actions/v2/batch.mjs

@@ -0,0 +1,126 @@
+/**
+ * @package @bitrix24/b24jssdk
+ * @version 1.0.1
+ * @copyright (c) 2026 Bitrix24
+ * @license MIT
+ * @see https://github.com/bitrix24/b24jssdk
+ * @see https://bitrix24.github.io/b24jssdk/
+ */
+import { AbstractBatch } from '../abstract-batch.mjs';
+import { ApiVersion } from '../../../types/b24.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class BatchV2 extends AbstractBatch {
+  static {
+    __name(this, "BatchV2");
+  }
+  /**
+   * Executes a batch request to the Bitrix24 REST API with a maximum number of commands of no more than 50.
+   * Allows you to execute multiple requests in a single API call, significantly improving performance.
+   *
+   * @template T - The data type returned by batch query commands (default is `unknown`)
+   *
+   * @param {ActionBatchV2} options - parameters for executing the request.
+   *     - `calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal | BatchNamedCommandsUniversal` - Commands to execute in a batch.
+   *        Supports several formats:
+   *        1. Array of tuples: `[['method1', params1], ['method2', params2], ...]`
+   *        2. Array of objects: `[{ method: 'method1', params: params1 }, { method: 'method2', params: params2 }, ...]`
+   *        3. An object with named commands: `{ cmd1: { method: 'method1', params: params1 }, cmd2: ['method2', params2], ...}`
+   *     - `options?: IB24BatchOptions` - Additional options for executing a batch request.
+   *        - `isHaltOnError?: boolean` - Whether to stop execution on the first error (default: true)
+   *        - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging (default: undefined)
+   *        - `returnAjaxResult?: boolean` - Whether to return an AjaxResult object instead of data (default: false)
+   *
+   * @returns {Promise<CallBatchResult<T>>} A promise that is resolved by the result of executing a batch request:
+   *     - On success: a `Result` object with the command execution results
+   *     - The structure of the results depends on the format of the `calls` input data:
+   *          - For an array of commands, an array of results in the same order
+   *          - For named commands, an object with keys corresponding to the command names
+   *
+   * @example
+   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'
+   *
+   * interface Contact { id: number, name: string }
+   * const response = await b24.actions.v2.batch.make<{ item: Contact }>({
+   *   calls: [
+   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 }],
+   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 2 }],
+   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 3 }]
+   *   ],
+   *   options: {
+   *     isHaltOnError: true,
+   *     returnAjaxResult: true,
+   *     requestId: 'batch-123'
+   *   }
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   *
+   * const resultData = (response as Result<AjaxResult<{ item: Contact }>[]>).getData()
+   * resultData.forEach((resultRow, index) => {
+   *   if (resultRow.isSuccess) {
+   *    console.log(`Item ${index + 1}:`, resultRow.getData().result.item)
+   *   }
+   * })
+   *
+   * @example
+   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'
+   *
+   * const response = await b24.actions.v2.batch.make({
+   *   calls: [
+   *     { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 } },
+   *     { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 2 } }
+   *   ],
+   *   options: {
+   *     isHaltOnError: true,
+   *     returnAjaxResult: true,
+   *     requestId: 'batch-123'
+   *   }
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   *
+   * @example
+   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'
+   *
+   * interface Contact { id: number, name: string }
+   * interface Deal { id: number, title: string }
+   * const response = await b24.actions.v2.batch.make<{ item: Contact } | { item: Deal }>({
+   *   calls: {
+   *     Contact: { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 } },
+   *     Deal: ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.deal, id: 2 }]
+   *   },
+   *   options: {
+   *     isHaltOnError: true,
+   *     returnAjaxResult: true,
+   *     requestId: 'batch-123'
+   *   }
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   *
+   * const results = response.getData() as Record<string, AjaxResult<{ item: Contact } | { item: Deal }>>
+   * console.log('Contact:', results.Contact.getData().result.item as Contact)
+   * console.log('Deal:', results.Deal.getData().result.item as Deal)
+   *
+   * @warning The maximum number of commands in one batch request is 50.
+   * @note A batch request executes faster than sequential single calls,
+   *     but if one command fails, the entire batch may fail
+   *     (depending on API settings and options).
+   */
+  async make(options) {
+    const opts = {
+      ...options.options,
+      apiVersion: ApiVersion.v2
+    };
+    const response = await this._b24.getHttpClient(ApiVersion.v2).batch(options.calls, opts);
+    return this._processBatchResponse(response, options.calls, opts);
+  }
+}
+
+export { BatchV2 };
+//# sourceMappingURL=batch.mjs.map

package/dist/esm/core/actions/v2/batch.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batch.mjs","sources":["../../../../../src/core/actions/v2/batch.ts"],"sourcesContent":["import type { ActionOptions } from '../abstract-action'\nimport type { CallBatchResult, IB24BatchOptions } from '../../../types/b24'\nimport type {\n  BatchCommandsArrayUniversal,\n  BatchCommandsObjectUniversal,\n  BatchNamedCommandsUniversal\n} from '../../../types/http'\nimport { AbstractBatch } from '../abstract-batch'\nimport { ApiVersion } from '../../../types/b24'\n\nexport type ActionBatchV2 = ActionOptions & {\n  calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal | BatchNamedCommandsUniversal\n  options?: IB24BatchOptions\n}\n\n/**\n * Executes a batch request to the Bitrix24 REST API with a maximum number of commands of no more than 50. `restApi:v2`\n * Allows you to execute multiple requests in a single API call, significantly improving performance.\n *\n * @todo add docs\n */\nexport class BatchV2 extends AbstractBatch {\n  /**\n   * Executes a batch request to the Bitrix24 REST API with a maximum number of commands of no more than 50.\n   * Allows you to execute multiple requests in a single API call, significantly improving performance.\n   *\n   * @template T - The data type returned by batch query commands (default is `unknown`)\n   *\n   * @param {ActionBatchV2} options - parameters for executing the request.\n   *     - `calls: BatchCommandsArrayUniversal | BatchCommandsObjectUniversal | BatchNamedCommandsUniversal` - Commands to execute in a batch.\n   *        Supports several formats:\n   *        1. Array of tuples: `[['method1', params1], ['method2', params2], ...]`\n   *        2. Array of objects: `[{ method: 'method1', params: params1 }, { method: 'method2', params: params2 }, ...]`\n   *        3. An object with named commands: `{ cmd1: { method: 'method1', params: params1 }, cmd2: ['method2', params2], ...}`\n   *     - `options?: IB24BatchOptions` - Additional options for executing a batch request.\n   *        - `isHaltOnError?: boolean` - Whether to stop execution on the first error (default: true)\n   *        - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging (default: undefined)\n   *        - `returnAjaxResult?: boolean` - Whether to return an AjaxResult object instead of data (default: false)\n   *\n   * @returns {Promise<CallBatchResult<T>>} A promise that is resolved by the result of executing a batch request:\n   *     - On success: a `Result` object with the command execution results\n   *     - The structure of the results depends on the format of the `calls` input data:\n   *          - For an array of commands, an array of results in the same order\n   *          - For named commands, an object with keys corresponding to the command names\n   *\n   * @example\n   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'\n   *\n   * interface Contact { id: number, name: string }\n   * const response = await b24.actions.v2.batch.make<{ item: Contact }>({\n   *   calls: [\n   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 }],\n   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 2 }],\n   *     ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.contact, id: 3 }]\n   *   ],\n   *   options: {\n   *     isHaltOnError: true,\n   *     returnAjaxResult: true,\n   *     requestId: 'batch-123'\n   *   }\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   *\n   * const resultData = (response as Result<AjaxResult<{ item: Contact }>[]>).getData()\n   * resultData.forEach((resultRow, index) => {\n   *   if (resultRow.isSuccess) {\n   *    console.log(`Item ${index + 1}:`, resultRow.getData().result.item)\n   *   }\n   * })\n   *\n   * @example\n   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'\n   *\n   * const response = await b24.actions.v2.batch.make({\n   *   calls: [\n   *     { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 } },\n   *     { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 2 } }\n   *   ],\n   *   options: {\n   *     isHaltOnError: true,\n   *     returnAjaxResult: true,\n   *     requestId: 'batch-123'\n   *   }\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   *\n   * @example\n   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'\n   *\n   * interface Contact { id: number, name: string }\n   * interface Deal { id: number, title: string }\n   * const response = await b24.actions.v2.batch.make<{ item: Contact } | { item: Deal }>({\n   *   calls: {\n   *     Contact: { method: 'crm.item.get', params: { entityTypeId: EnumCrmEntityTypeId.contact, id: 1 } },\n   *     Deal: ['crm.item.get', { entityTypeId: EnumCrmEntityTypeId.deal, id: 2 }]\n   *   },\n   *   options: {\n   *     isHaltOnError: true,\n   *     returnAjaxResult: true,\n   *     requestId: 'batch-123'\n   *   }\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   *\n   * const results = response.getData() as Record<string, AjaxResult<{ item: Contact } | { item: Deal }>>\n   * console.log('Contact:', results.Contact.getData().result.item as Contact)\n   * console.log('Deal:', results.Deal.getData().result.item as Deal)\n   *\n   * @warning The maximum number of commands in one batch request is 50.\n   * @note A batch request executes faster than sequential single calls,\n   *     but if one command fails, the entire batch may fail\n   *     (depending on API settings and options).\n   */\n  public override async make<T = unknown>(options: ActionBatchV2): Promise<CallBatchResult<T>> {\n    const opts = {\n      ...options.options,\n      apiVersion: ApiVersion.v2\n    }\n\n    const response = await this._b24.getHttpClient(ApiVersion.v2).batch<T>(options.calls, opts)\n\n    return this._processBatchResponse<T>(response, options.calls, opts)\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;AAqBO,MAAM,gBAAgB,aAAA,CAAc;AAAA,EArB3C;AAqB2C,IAAA,MAAA,CAAA,IAAA,EAAA,SAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkGzC,MAAsB,KAAkB,OAAA,EAAqD;AAC3F,IAAA,MAAM,IAAA,GAAO;AAAA,MACX,GAAG,OAAA,CAAQ,OAAA;AAAA,MACX,YAAY,UAAA,CAAW;AAAA,KACzB;AAEA,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,IAAA,CAAK,aAAA,CAAc,UAAA,CAAW,EAAE,CAAA,CAAE,KAAA,CAAS,OAAA,CAAQ,KAAA,EAAO,IAAI,CAAA;AAE1F,IAAA,OAAO,IAAA,CAAK,qBAAA,CAAyB,QAAA,EAAU,OAAA,CAAQ,OAAO,IAAI,CAAA;AAAA,EACpE;AACF;;;;"}

package/dist/esm/core/actions/v2/call-list.mjs

@@ -0,0 +1,131 @@
+/**
+ * @package @bitrix24/b24jssdk
+ * @version 1.0.1
+ * @copyright (c) 2026 Bitrix24
+ * @license MIT
+ * @see https://github.com/bitrix24/b24jssdk
+ * @see https://bitrix24.github.io/b24jssdk/
+ */
+import { AbstractAction } from '../abstract-action.mjs';
+import { Result } from '../../result.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class CallListV2 extends AbstractAction {
+  static {
+    __name(this, "CallListV2");
+  }
+  /**
+   * Fast data retrieval without counting the total number of records.
+   *
+   * @template T - The type of the elements of the returned array (default is `unknown`).
+   *
+   * @param {ActionCallListV2} options - parameters for executing the request.
+   *     - `method: string` - The name of the REST API method that returns a list of data (for example: `crm.item.list`, `tasks.task.list`)
+   *     - `params?: Omit<TypeCallParams, 'start'>` - Request parameters, excluding the `start` parameter,
+   *         since the method is designed to obtain all data in one call.
+   *         Note: Use `filter`, `order`, and `select` to control the selection.
+   *     - `idKey?: string` - The name of the field containing the unique identifier of the element.
+   *         Default is 'ID' (uppercase). Alternatively, it can be 'id' (lowercase).
+   *         or another field, depending on the REST API data structure.
+   *     - `customKeyForResult?: string` - A custom key indicating that the response REST API will be
+   *        grouped by this field.
+   *        Example: `items` to group a list of CRM items.
+   *    - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.
+   *
+   * @returns {Promise<Result<T[]>>} A promise that resolves to the result of an REST API call.
+   *
+   * @example
+   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'
+   *
+   * interface CrmItem { id: number, title: string }
+   * const sixMonthAgo = new Date()
+   * sixMonthAgo.setMonth((new Date()).getMonth() - 6)
+   * sixMonthAgo.setHours(0, 0, 0)
+   * const response = await b24.actions.v2.callList.make<CrmItem>({
+   *   method: 'crm.item.list',
+   *   params: {
+   *     entityTypeId:  EnumCrmEntityTypeId.company,
+   *     filter: {
+   *       '=%title': 'A%',
+   *       '>=createdTime': Text.toB24Format(sixMonthAgo) // created at least 6 months ago
+   *     },
+   *     select: ['id', 'title']
+   *   },
+   *   idKey: 'id',
+   *   customKeyForResult: 'items',
+   *   requestId: 'list-123'
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   * const list = response.getData()
+   * console.log(`Result: ${list?.length}`) // Number of items received
+   */
+  async make(options) {
+    const batchSize = 50;
+    const result = new Result();
+    const idKey = options?.idKey ?? "ID";
+    const customKeyForResult = options?.customKeyForResult ?? null;
+    const params = options?.params ?? {};
+    const moreIdKey = `>${idKey}`;
+    const requestParams = {
+      ...params,
+      order: { ...params["order"] || {}, [idKey]: "ASC" },
+      filter: { ...params["filter"] || {}, [moreIdKey]: 0 },
+      start: -1
+    };
+    let allItems = [];
+    let isContinue = true;
+    do {
+      const response = await this._b24.actions.v2.call.make({
+        method: options.method,
+        params: requestParams,
+        requestId: options.requestId
+      });
+      if (!response.isSuccess) {
+        this._logger.error("callFastListMethod", {
+          method: options.method,
+          requestId: options.requestId,
+          messages: response.getErrorMessages()
+        });
+        for (const [index, error] of response.errors) {
+          result.addError(error, index);
+        }
+        isContinue = false;
+        break;
+      }
+      const responseData = response.getData();
+      if (!responseData) {
+        isContinue = false;
+        break;
+      }
+      let resultData = [];
+      if (null === customKeyForResult) {
+        resultData = responseData.result;
+      } else {
+        resultData = responseData.result[customKeyForResult];
+      }
+      if (resultData.length === 0) {
+        isContinue = false;
+        break;
+      }
+      allItems = [...allItems, ...resultData];
+      if (resultData.length < batchSize) {
+        isContinue = false;
+        break;
+      }
+      const lastItem = resultData[resultData.length - 1];
+      if (lastItem && typeof lastItem[idKey] !== "undefined") {
+        requestParams.filter[moreIdKey] = Number.parseInt(lastItem[idKey]);
+      } else {
+        isContinue = false;
+        break;
+      }
+    } while (isContinue);
+    return result.setData(allItems);
+  }
+}
+
+export { CallListV2 };
+//# sourceMappingURL=call-list.mjs.map

package/dist/esm/core/actions/v2/call-list.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"call-list.mjs","sources":["../../../../../src/core/actions/v2/call-list.ts"],"sourcesContent":["import type { ActionOptions } from '../abstract-action'\nimport type { TypeCallParams } from '../../../types/http'\nimport type { AjaxResult } from '../../http/ajax-result'\nimport { AbstractAction } from '../abstract-action'\nimport { Result } from '../../result'\n\nexport type ActionCallListV2 = ActionOptions & {\n  method: string\n  params?: Omit<TypeCallParams, 'start'>\n  idKey?: string\n  customKeyForResult?: string\n  requestId?: string\n}\n\n/**\n * Fast data retrieval without counting the total number of records. `restApi:v2`\n *\n * @todo add docs\n */\nexport class CallListV2 extends AbstractAction {\n  /**\n   * Fast data retrieval without counting the total number of records.\n   *\n   * @template T - The type of the elements of the returned array (default is `unknown`).\n   *\n   * @param {ActionCallListV2} options - parameters for executing the request.\n   *     - `method: string` - The name of the REST API method that returns a list of data (for example: `crm.item.list`, `tasks.task.list`)\n   *     - `params?: Omit<TypeCallParams, 'start'>` - Request parameters, excluding the `start` parameter,\n   *         since the method is designed to obtain all data in one call.\n   *         Note: Use `filter`, `order`, and `select` to control the selection.\n   *     - `idKey?: string` - The name of the field containing the unique identifier of the element.\n   *         Default is 'ID' (uppercase). Alternatively, it can be 'id' (lowercase).\n   *         or another field, depending on the REST API data structure.\n   *     - `customKeyForResult?: string` - A custom key indicating that the response REST API will be\n   *        grouped by this field.\n   *        Example: `items` to group a list of CRM items.\n   *    - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.\n   *\n   * @returns {Promise<Result<T[]>>} A promise that resolves to the result of an REST API call.\n   *\n   * @example\n   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'\n   *\n   * interface CrmItem { id: number, title: string }\n   * const sixMonthAgo = new Date()\n   * sixMonthAgo.setMonth((new Date()).getMonth() - 6)\n   * sixMonthAgo.setHours(0, 0, 0)\n   * const response = await b24.actions.v2.callList.make<CrmItem>({\n   *   method: 'crm.item.list',\n   *   params: {\n   *     entityTypeId:  EnumCrmEntityTypeId.company,\n   *     filter: {\n   *       '=%title': 'A%',\n   *       '>=createdTime': Text.toB24Format(sixMonthAgo) // created at least 6 months ago\n   *     },\n   *     select: ['id', 'title']\n   *   },\n   *   idKey: 'id',\n   *   customKeyForResult: 'items',\n   *   requestId: 'list-123'\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   * const list = response.getData()\n   * console.log(`Result: ${list?.length}`) // Number of items received\n   */\n  public override async make<T = unknown>(options: ActionCallListV2): Promise<Result<T[]>> {\n    const batchSize = 50\n    const result: Result<T[]> = new Result()\n\n    const idKey = options?.idKey ?? 'ID'\n    const customKeyForResult = options?.customKeyForResult ?? null\n    const params = options?.params ?? {}\n\n    const moreIdKey = `>${idKey}`\n    const requestParams: TypeCallParams = {\n      ...params,\n      order: { ...(params['order'] || {}), [idKey]: 'ASC' },\n      filter: { ...(params['filter'] || {}), [moreIdKey]: 0 },\n      start: -1\n    }\n\n    let allItems: T[] = []\n    let isContinue = true\n\n    do {\n      const response: AjaxResult<T> = await this._b24.actions.v2.call.make<T>({\n        method: options.method,\n        params: requestParams,\n        requestId: options.requestId\n      })\n\n      if (!response.isSuccess) {\n        this._logger.error('callFastListMethod', {\n          method: options.method,\n          requestId: options.requestId,\n          messages: response.getErrorMessages()\n        })\n        for (const [index, error] of response.errors) {\n          result.addError(error, index)\n        }\n        isContinue = false\n        break\n      }\n      const responseData = response.getData()\n      if (!responseData) {\n        isContinue = false\n        break\n      }\n\n      let resultData: T[] = []\n      if (null === customKeyForResult) {\n        resultData = responseData.result as T[]\n      } else {\n        resultData = responseData.result[customKeyForResult] as T[]\n      }\n\n      if (resultData.length === 0) {\n        isContinue = false\n        break\n      }\n\n      allItems = [...allItems, ...resultData]\n\n      if (resultData.length < batchSize) {\n        isContinue = false\n        break\n      }\n\n      // Update the filter for the next iteration\n      const lastItem = resultData[resultData.length - 1] as Record<string, any>\n      if (\n        lastItem\n        && typeof lastItem[idKey] !== 'undefined'\n      ) {\n        requestParams.filter[moreIdKey] = Number.parseInt(lastItem[idKey])\n      } else {\n        isContinue = false\n        break\n      }\n    } while (isContinue)\n\n    return result.setData(allItems)\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;AAmBO,MAAM,mBAAmB,cAAA,CAAe;AAAA,EAnB/C;AAmB+C,IAAA,MAAA,CAAA,IAAA,EAAA,YAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgD7C,MAAsB,KAAkB,OAAA,EAAiD;AACvF,IAAA,MAAM,SAAA,GAAY,EAAA;AAClB,IAAA,MAAM,MAAA,GAAsB,IAAI,MAAA,EAAO;AAEvC,IAAA,MAAM,KAAA,GAAQ,SAAS,KAAA,IAAS,IAAA;AAChC,IAAA,MAAM,kBAAA,GAAqB,SAAS,kBAAA,IAAsB,IAAA;AAC1D,IAAA,MAAM,MAAA,GAAS,OAAA,EAAS,MAAA,IAAU,EAAC;AAEnC,IAAA,MAAM,SAAA,GAAY,IAAI,KAAK,CAAA,CAAA;AAC3B,IAAA,MAAM,aAAA,GAAgC;AAAA,MACpC,GAAG,MAAA;AAAA,MACH,KAAA,EAAO,EAAE,GAAI,MAAA,CAAO,OAAO,CAAA,IAAK,EAAC,EAAI,CAAC,KAAK,GAAG,KAAA,EAAM;AAAA,MACpD,MAAA,EAAQ,EAAE,GAAI,MAAA,CAAO,QAAQ,CAAA,IAAK,EAAC,EAAI,CAAC,SAAS,GAAG,CAAA,EAAE;AAAA,MACtD,KAAA,EAAO;AAAA,KACT;AAEA,IAAA,IAAI,WAAgB,EAAC;AACrB,IAAA,IAAI,UAAA,GAAa,IAAA;AAEjB,IAAA,GAAG;AACD,MAAA,MAAM,WAA0B,MAAM,IAAA,CAAK,KAAK,OAAA,CAAQ,EAAA,CAAG,KAAK,IAAA,CAAQ;AAAA,QACtE,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,MAAA,EAAQ,aAAA;AAAA,QACR,WAAW,OAAA,CAAQ;AAAA,OACpB,CAAA;AAED,MAAA,IAAI,CAAC,SAAS,SAAA,EAAW;AACvB,QAAA,IAAA,CAAK,OAAA,CAAQ,MAAM,oBAAA,EAAsB;AAAA,UACvC,QAAQ,OAAA,CAAQ,MAAA;AAAA,UAChB,WAAW,OAAA,CAAQ,SAAA;AAAA,UACnB,QAAA,EAAU,SAAS,gBAAA;AAAiB,SACrC,CAAA;AACD,QAAA,KAAA,MAAW,CAAC,KAAA,EAAO,KAAK,CAAA,IAAK,SAAS,MAAA,EAAQ;AAC5C,UAAA,MAAA,CAAO,QAAA,CAAS,OAAO,KAAK,CAAA;AAAA,QAC9B;AACA,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AACA,MAAA,MAAM,YAAA,GAAe,SAAS,OAAA,EAAQ;AACtC,MAAA,IAAI,CAAC,YAAA,EAAc;AACjB,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAEA,MAAA,IAAI,aAAkB,EAAC;AACvB,MAAA,IAAI,SAAS,kBAAA,EAAoB;AAC/B,QAAA,UAAA,GAAa,YAAA,CAAa,MAAA;AAAA,MAC5B,CAAA,MAAO;AACL,QAAA,UAAA,GAAa,YAAA,CAAa,OAAO,kBAAkB,CAAA;AAAA,MACrD;AAEA,MAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAEA,MAAA,QAAA,GAAW,CAAC,GAAG,QAAA,EAAU,GAAG,UAAU,CAAA;AAEtC,MAAA,IAAI,UAAA,CAAW,SAAS,SAAA,EAAW;AACjC,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAGA,MAAA,MAAM,QAAA,GAAW,UAAA,CAAW,UAAA,CAAW,MAAA,GAAS,CAAC,CAAA;AACjD,MAAA,IACE,QAAA,IACG,OAAO,QAAA,CAAS,KAAK,MAAM,WAAA,EAC9B;AACA,QAAA,aAAA,CAAc,OAAO,SAAS,CAAA,GAAI,OAAO,QAAA,CAAS,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,MACnE,CAAA,MAAO;AACL,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAAA,IACF,CAAA,QAAS,UAAA;AAET,IAAA,OAAO,MAAA,CAAO,QAAQ,QAAQ,CAAA;AAAA,EAChC;AACF;;;;"}

package/dist/esm/core/actions/v2/call.mjs

@@ -0,0 +1,68 @@
+/**
+ * @package @bitrix24/b24jssdk
+ * @version 1.0.1
+ * @copyright (c) 2026 Bitrix24
+ * @license MIT
+ * @see https://github.com/bitrix24/b24jssdk
+ * @see https://bitrix24.github.io/b24jssdk/
+ */
+import { AbstractAction } from '../abstract-action.mjs';
+import { versionManager } from '../../version-manager.mjs';
+import { ApiVersion } from '../../../types/b24.mjs';
+import { LoggerFactory } from '../../../logger/logger-factory.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class CallV2 extends AbstractAction {
+  static {
+    __name(this, "CallV2");
+  }
+  /**
+   * Calls the Bitrix24 REST API method.
+   *
+   * @template T - The expected data type in the response (default is `unknown`).
+   *
+   * @param {ActionCallV2} options - parameters for executing the request.
+   *     - `method: string` - REST API method name (eg: `crm.item.get`)
+   *     - `params?: TypeCallParams` - Parameters for calling the method.
+   *     - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.
+   *
+   * @returns {Promise<AjaxResult<T>>} A promise that resolves to the result of an REST API call.
+   *
+   * @example
+   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'
+   *
+   * interface CrmItem { id: number, name: string, lastName: string }
+   * const response = await b24.actions.v2.call.make<{ item: CrmItem }>({
+   *   method: 'crm.item.get',
+   *   params: {
+   *     entityTypeId: EnumCrmEntityTypeId.contact,
+   *     id: 123
+   *   },
+   *   requestId: 'item-123'
+   * })
+   * if (!response.isSuccess) {
+   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)
+   * }
+   * console.log(response.getData().result.item.name)
+   */
+  async make(options) {
+    if (versionManager.isSupport(ApiVersion.v3, options.method)) {
+      LoggerFactory.forcedLog(
+        this._logger,
+        "warning",
+        `The method ${options.method} is available in restApi:v3. It's worth migrating to the new API.`,
+        {
+          method: options.method,
+          requestId: options.requestId,
+          code: "JSSDK_CORE_METHOD_AVAILABLE_IN_API_V3"
+        }
+      );
+    }
+    const params = options.params || {};
+    return this._b24.getHttpClient(ApiVersion.v2).call(options.method, params, options.requestId);
+  }
+}
+
+export { CallV2 };
+//# sourceMappingURL=call.mjs.map

package/dist/esm/core/actions/v2/call.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"call.mjs","sources":["../../../../../src/core/actions/v2/call.ts"],"sourcesContent":["import type { ActionOptions } from '../abstract-action'\nimport type { TypeCallParams } from '../../../types/http'\nimport type { AjaxResult } from '../../http/ajax-result'\nimport { AbstractAction } from '../abstract-action'\nimport { versionManager } from '../../version-manager'\nimport { ApiVersion } from '../../../types/b24'\nimport { LoggerFactory } from '../../../logger'\n\nexport type ActionCallV2 = ActionOptions & {\n  method: string\n  params?: TypeCallParams\n  requestId?: string\n}\n\n/**\n * Calls the Bitrix24 REST API method `restApi:v2`\n *\n * @todo add docs\n */\nexport class CallV2 extends AbstractAction {\n  /**\n   * Calls the Bitrix24 REST API method.\n   *\n   * @template T - The expected data type in the response (default is `unknown`).\n   *\n   * @param {ActionCallV2} options - parameters for executing the request.\n   *     - `method: string` - REST API method name (eg: `crm.item.get`)\n   *     - `params?: TypeCallParams` - Parameters for calling the method.\n   *     - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.\n   *\n   * @returns {Promise<AjaxResult<T>>} A promise that resolves to the result of an REST API call.\n   *\n   * @example\n   * import { EnumCrmEntityTypeId } from '@bitrix24/b24jssdk'\n   *\n   * interface CrmItem { id: number, name: string, lastName: string }\n   * const response = await b24.actions.v2.call.make<{ item: CrmItem }>({\n   *   method: 'crm.item.get',\n   *   params: {\n   *     entityTypeId: EnumCrmEntityTypeId.contact,\n   *     id: 123\n   *   },\n   *   requestId: 'item-123'\n   * })\n   * if (!response.isSuccess) {\n   *   throw new Error(`Problem: ${response.getErrorMessages().join('; ')}`)\n   * }\n   * console.log(response.getData().result.item.name)\n   */\n  public override async make<T = unknown>(options: ActionCallV2): Promise<AjaxResult<T>> {\n    if (versionManager.isSupport(ApiVersion.v3, options.method)) {\n      LoggerFactory.forcedLog(\n        this._logger,\n        'warning',\n        `The method ${options.method} is available in restApi:v3. It's worth migrating to the new API.`,\n        {\n          method: options.method,\n          requestId: options.requestId,\n          code: 'JSSDK_CORE_METHOD_AVAILABLE_IN_API_V3'\n        }\n      )\n    }\n\n    const params = options.params || {}\n    return this._b24.getHttpClient(ApiVersion.v2).call<T>(options.method, params, options.requestId)\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;;;AAmBO,MAAM,eAAe,cAAA,CAAe;AAAA,EAnB3C;AAmB2C,IAAA,MAAA,CAAA,IAAA,EAAA,QAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA8BzC,MAAsB,KAAkB,OAAA,EAA+C;AACrF,IAAA,IAAI,eAAe,SAAA,CAAU,UAAA,CAAW,EAAA,EAAI,OAAA,CAAQ,MAAM,CAAA,EAAG;AAC3D,MAAA,aAAA,CAAc,SAAA;AAAA,QACZ,IAAA,CAAK,OAAA;AAAA,QACL,SAAA;AAAA,QACA,CAAA,WAAA,EAAc,QAAQ,MAAM,CAAA,iEAAA,CAAA;AAAA,QAC5B;AAAA,UACE,QAAQ,OAAA,CAAQ,MAAA;AAAA,UAChB,WAAW,OAAA,CAAQ,SAAA;AAAA,UACnB,IAAA,EAAM;AAAA;AACR,OACF;AAAA,IACF;AAEA,IAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,MAAA,IAAU,EAAC;AAClC,IAAA,OAAO,IAAA,CAAK,IAAA,CAAK,aAAA,CAAc,UAAA,CAAW,EAAE,CAAA,CAAE,IAAA,CAAQ,OAAA,CAAQ,MAAA,EAAQ,MAAA,EAAQ,OAAA,CAAQ,SAAS,CAAA;AAAA,EACjG;AACF;;;;"}

package/dist/esm/core/actions/v2/fetch-list.mjs

@@ -0,0 +1,132 @@
+/**
+ * @package @bitrix24/b24jssdk
+ * @version 1.0.1
+ * @copyright (c) 2026 Bitrix24
+ * @license MIT
+ * @see https://github.com/bitrix24/b24jssdk
+ * @see https://bitrix24.github.io/b24jssdk/
+ */
+import { AbstractAction } from '../abstract-action.mjs';
+import { SdkError } from '../../sdk-error.mjs';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class FetchListV2 extends AbstractAction {
+  static {
+    __name(this, "FetchListV2");
+  }
+  /**
+   * Calls a REST API list method and returns an async generator for efficient large data retrieval.
+   * Implements the fast algorithm for iterating over large datasets without loading all data into memory at once.
+   *
+   * @template T - The type of items in the returned arrays (default is `unknown`).
+   *
+   * @param {ActionFetchListV2} options - parameters for executing the request.
+   *     - `method: string` - The name of the REST API method that returns a list of data (for example: `crm.item.list`, `tasks.task.list`)
+   *     - `params?: Omit<TypeCallParams, 'start'>` - Request parameters, excluding the `start` parameter,
+   *         since the method is designed to obtain all data in one call.
+   *         Note: Use `filter`, `order`, and `select` to control the selection.
+   *     - `idKey?: string` - The name of the field containing the unique identifier of the element.
+   *         Default is 'ID' (uppercase). Alternatively, it can be 'id' (lowercase).
+   *         or another field, depending on the REST API data structure.
+   *     - `customKeyForResult?: string` - A custom key indicating that the response REST API will be
+   *        grouped by this field.
+   *        Example: `items` to group a list of CRM items.
+   *    - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.
+   *
+   * @returns {AsyncGenerator<T[]>} An async generator that yields chunks of data as arrays of type `T`.
+   *     Each iteration returns the next page/batch of results until all data is fetched.
+   *
+   * @example
+   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'
+   *
+   * interface CrmItem { id: number, title: string }
+   * const sixMonthAgo = new Date()
+   * sixMonthAgo.setMonth((new Date()).getMonth() - 6)
+   * sixMonthAgo.setHours(0, 0, 0)
+   * const generator = b24.actions.v2.fetchList.make<CrmItem>({
+   *   method: 'crm.item.list',
+   *   params: {
+   *     entityTypeId: EnumCrmEntityTypeId.company,
+   *     filter: {
+   *       '=%title': 'A%',
+   *       '>=createdTime': Text.toB24Format(sixMonthAgo) // created at least 6 months ago
+   *     },
+   *     select: ['id', 'title']
+   *   },
+   *   idKey: 'id',
+   *   customKeyForResult: 'items',
+   *   requestId: 'list-123'
+   * })
+   *
+   * for await (const chunk of generator) {
+   *   // Process chunk (e.g., save to database, analyze, etc.)
+   *   console.log(`Processing ${chunk.length} items`)
+   * }
+   *
+   * @see {@link https://apidocs.bitrix24.com/settings/performance/huge-data.html Bitrix24: Fast algorithm for large data}
+   */
+  async *make(options) {
+    const batchSize = 50;
+    const idKey = options?.idKey ?? "ID";
+    const customKeyForResult = options?.customKeyForResult ?? null;
+    const params = options?.params ?? {};
+    const moreIdKey = `>${idKey}`;
+    const requestParams = {
+      ...params,
+      order: { ...params["order"] || {}, [idKey]: "ASC" },
+      filter: { ...params["filter"] || {}, [moreIdKey]: 0 },
+      start: -1
+    };
+    let isContinue = true;
+    do {
+      const response = await this._b24.actions.v2.call.make({
+        method: options.method,
+        params: requestParams,
+        requestId: options.requestId
+      });
+      if (!response.isSuccess) {
+        this._logger.error("fetchListMethod", {
+          method: options.method,
+          requestId: options.requestId,
+          messages: response.getErrorMessages()
+        });
+        throw new SdkError({
+          code: "JSSDK_CORE_B24_FETCH_LIST_METHOD_API_V2",
+          description: `API Error: ${response.getErrorMessages().join("; ")}`,
+          status: 500
+        });
+      }
+      const responseData = response.getData();
+      if (!responseData) {
+        isContinue = false;
+        break;
+      }
+      let resultData = [];
+      if (null === customKeyForResult) {
+        resultData = responseData.result;
+      } else {
+        resultData = responseData.result[customKeyForResult];
+      }
+      if (resultData.length === 0) {
+        isContinue = false;
+        break;
+      }
+      yield resultData;
+      if (resultData.length < batchSize) {
+        isContinue = false;
+        break;
+      }
+      const lastItem = resultData[resultData.length - 1];
+      if (lastItem && typeof lastItem[idKey] !== "undefined") {
+        requestParams.filter[moreIdKey] = Number.parseInt(lastItem[idKey]);
+      } else {
+        isContinue = false;
+        break;
+      }
+    } while (isContinue);
+  }
+}
+
+export { FetchListV2 };
+//# sourceMappingURL=fetch-list.mjs.map

package/dist/esm/core/actions/v2/fetch-list.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch-list.mjs","sources":["../../../../../src/core/actions/v2/fetch-list.ts"],"sourcesContent":["import type { ActionOptions } from '../abstract-action'\nimport type { TypeCallParams } from '../../../types/http'\nimport type { AjaxResult } from '../../http/ajax-result'\nimport { AbstractAction } from '../abstract-action'\nimport { SdkError } from '../../sdk-error'\n\nexport type ActionFetchListV2 = ActionOptions & {\n  method: string\n  params?: Omit<TypeCallParams, 'start'>\n  idKey?: string\n  customKeyForResult?: string\n  requestId?: string\n}\n\n/**\n * Calls a REST API list method and returns an async generator for efficient large data retrieval. `restApi:v2`\n *\n * @todo add docs\n */\nexport class FetchListV2 extends AbstractAction {\n  /**\n   * Calls a REST API list method and returns an async generator for efficient large data retrieval.\n   * Implements the fast algorithm for iterating over large datasets without loading all data into memory at once.\n   *\n   * @template T - The type of items in the returned arrays (default is `unknown`).\n   *\n   * @param {ActionFetchListV2} options - parameters for executing the request.\n   *     - `method: string` - The name of the REST API method that returns a list of data (for example: `crm.item.list`, `tasks.task.list`)\n   *     - `params?: Omit<TypeCallParams, 'start'>` - Request parameters, excluding the `start` parameter,\n   *         since the method is designed to obtain all data in one call.\n   *         Note: Use `filter`, `order`, and `select` to control the selection.\n   *     - `idKey?: string` - The name of the field containing the unique identifier of the element.\n   *         Default is 'ID' (uppercase). Alternatively, it can be 'id' (lowercase).\n   *         or another field, depending on the REST API data structure.\n   *     - `customKeyForResult?: string` - A custom key indicating that the response REST API will be\n   *        grouped by this field.\n   *        Example: `items` to group a list of CRM items.\n   *    - `requestId?: string` - Unique request identifier for tracking. Used for query deduplication and debugging.\n   *\n   * @returns {AsyncGenerator<T[]>} An async generator that yields chunks of data as arrays of type `T`.\n   *     Each iteration returns the next page/batch of results until all data is fetched.\n   *\n   * @example\n   * import { EnumCrmEntityTypeId, Text } from '@bitrix24/b24jssdk'\n   *\n   * interface CrmItem { id: number, title: string }\n   * const sixMonthAgo = new Date()\n   * sixMonthAgo.setMonth((new Date()).getMonth() - 6)\n   * sixMonthAgo.setHours(0, 0, 0)\n   * const generator = b24.actions.v2.fetchList.make<CrmItem>({\n   *   method: 'crm.item.list',\n   *   params: {\n   *     entityTypeId: EnumCrmEntityTypeId.company,\n   *     filter: {\n   *       '=%title': 'A%',\n   *       '>=createdTime': Text.toB24Format(sixMonthAgo) // created at least 6 months ago\n   *     },\n   *     select: ['id', 'title']\n   *   },\n   *   idKey: 'id',\n   *   customKeyForResult: 'items',\n   *   requestId: 'list-123'\n   * })\n   *\n   * for await (const chunk of generator) {\n   *   // Process chunk (e.g., save to database, analyze, etc.)\n   *   console.log(`Processing ${chunk.length} items`)\n   * }\n   *\n   * @see {@link https://apidocs.bitrix24.com/settings/performance/huge-data.html Bitrix24: Fast algorithm for large data}\n   */\n  public override async* make<T = unknown>(options: ActionFetchListV2): AsyncGenerator<T[]> {\n    const batchSize = 50\n\n    const idKey = options?.idKey ?? 'ID'\n    const customKeyForResult = options?.customKeyForResult ?? null\n    const params = options?.params ?? {}\n\n    const moreIdKey = `>${idKey}`\n    const requestParams: TypeCallParams = {\n      ...params,\n      order: { ...(params['order'] || {}), [idKey]: 'ASC' },\n      filter: { ...(params['filter'] || {}), [moreIdKey]: 0 },\n      start: -1\n    }\n\n    let isContinue = true\n\n    do {\n      const response: AjaxResult<T> = await this._b24.actions.v2.call.make<T>({\n        method: options.method,\n        params: requestParams,\n        requestId: options.requestId\n      })\n\n      if (!response.isSuccess) {\n        this._logger.error('fetchListMethod', {\n          method: options.method,\n          requestId: options.requestId,\n          messages: response.getErrorMessages()\n        })\n        throw new SdkError({\n          code: 'JSSDK_CORE_B24_FETCH_LIST_METHOD_API_V2',\n          description: `API Error: ${response.getErrorMessages().join('; ')}`,\n          status: 500\n        })\n      }\n      const responseData = response.getData()\n      if (!responseData) {\n        isContinue = false\n        break\n      }\n\n      let resultData: T[] = []\n      if (null === customKeyForResult) {\n        resultData = responseData.result as T[]\n      } else {\n        resultData = responseData.result[customKeyForResult] as T[]\n      }\n\n      if (resultData.length === 0) {\n        isContinue = false\n        break\n      }\n\n      yield resultData\n\n      if (resultData.length < batchSize) {\n        isContinue = false\n        break\n      }\n\n      // Update the filter for the next iteration\n      const lastItem = resultData[resultData.length - 1] as Record<string, any>\n      if (\n        lastItem\n        && typeof lastItem[idKey] !== 'undefined'\n      ) {\n        requestParams.filter[moreIdKey] = Number.parseInt(lastItem[idKey])\n      } else {\n        isContinue = false\n        break\n      }\n    } while (isContinue)\n  }\n}\n"],"names":[],"mappings":";;;;;;;;;;;;;AAmBO,MAAM,oBAAoB,cAAA,CAAe;AAAA,EAnBhD;AAmBgD,IAAA,MAAA,CAAA,IAAA,EAAA,aAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoD9C,OAAuB,KAAkB,OAAA,EAAiD;AACxF,IAAA,MAAM,SAAA,GAAY,EAAA;AAElB,IAAA,MAAM,KAAA,GAAQ,SAAS,KAAA,IAAS,IAAA;AAChC,IAAA,MAAM,kBAAA,GAAqB,SAAS,kBAAA,IAAsB,IAAA;AAC1D,IAAA,MAAM,MAAA,GAAS,OAAA,EAAS,MAAA,IAAU,EAAC;AAEnC,IAAA,MAAM,SAAA,GAAY,IAAI,KAAK,CAAA,CAAA;AAC3B,IAAA,MAAM,aAAA,GAAgC;AAAA,MACpC,GAAG,MAAA;AAAA,MACH,KAAA,EAAO,EAAE,GAAI,MAAA,CAAO,OAAO,CAAA,IAAK,EAAC,EAAI,CAAC,KAAK,GAAG,KAAA,EAAM;AAAA,MACpD,MAAA,EAAQ,EAAE,GAAI,MAAA,CAAO,QAAQ,CAAA,IAAK,EAAC,EAAI,CAAC,SAAS,GAAG,CAAA,EAAE;AAAA,MACtD,KAAA,EAAO;AAAA,KACT;AAEA,IAAA,IAAI,UAAA,GAAa,IAAA;AAEjB,IAAA,GAAG;AACD,MAAA,MAAM,WAA0B,MAAM,IAAA,CAAK,KAAK,OAAA,CAAQ,EAAA,CAAG,KAAK,IAAA,CAAQ;AAAA,QACtE,QAAQ,OAAA,CAAQ,MAAA;AAAA,QAChB,MAAA,EAAQ,aAAA;AAAA,QACR,WAAW,OAAA,CAAQ;AAAA,OACpB,CAAA;AAED,MAAA,IAAI,CAAC,SAAS,SAAA,EAAW;AACvB,QAAA,IAAA,CAAK,OAAA,CAAQ,MAAM,iBAAA,EAAmB;AAAA,UACpC,QAAQ,OAAA,CAAQ,MAAA;AAAA,UAChB,WAAW,OAAA,CAAQ,SAAA;AAAA,UACnB,QAAA,EAAU,SAAS,gBAAA;AAAiB,SACrC,CAAA;AACD,QAAA,MAAM,IAAI,QAAA,CAAS;AAAA,UACjB,IAAA,EAAM,yCAAA;AAAA,UACN,aAAa,CAAA,WAAA,EAAc,QAAA,CAAS,kBAAiB,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA;AAAA,UACjE,MAAA,EAAQ;AAAA,SACT,CAAA;AAAA,MACH;AACA,MAAA,MAAM,YAAA,GAAe,SAAS,OAAA,EAAQ;AACtC,MAAA,IAAI,CAAC,YAAA,EAAc;AACjB,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAEA,MAAA,IAAI,aAAkB,EAAC;AACvB,MAAA,IAAI,SAAS,kBAAA,EAAoB;AAC/B,QAAA,UAAA,GAAa,YAAA,CAAa,MAAA;AAAA,MAC5B,CAAA,MAAO;AACL,QAAA,UAAA,GAAa,YAAA,CAAa,OAAO,kBAAkB,CAAA;AAAA,MACrD;AAEA,MAAA,IAAI,UAAA,CAAW,WAAW,CAAA,EAAG;AAC3B,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAEA,MAAA,MAAM,UAAA;AAEN,MAAA,IAAI,UAAA,CAAW,SAAS,SAAA,EAAW;AACjC,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAGA,MAAA,MAAM,QAAA,GAAW,UAAA,CAAW,UAAA,CAAW,MAAA,GAAS,CAAC,CAAA;AACjD,MAAA,IACE,QAAA,IACG,OAAO,QAAA,CAAS,KAAK,MAAM,WAAA,EAC9B;AACA,QAAA,aAAA,CAAc,OAAO,SAAS,CAAA,GAAI,OAAO,QAAA,CAAS,QAAA,CAAS,KAAK,CAAC,CAAA;AAAA,MACnE,CAAA,MAAO;AACL,QAAA,UAAA,GAAa,KAAA;AACb,QAAA;AAAA,MACF;AAAA,IACF,CAAA,QAAS,UAAA;AAAA,EACX;AACF;;;;"}