bx-rest 0.10.0 → 0.10.2

package/fesm2022/bx-rest.mjs

@@ -1,6 +1,6 @@
 import { DateTime } from 'luxon';
 import { switchMap, map, catchError, take, mergeMap as mergeMap$1 } from 'rxjs/operators';
-import { Subscription, of, throwError, from, forkJoin, last, shareReplay, mergeMap, concatMap, toArray, tap } from 'rxjs';
+import { Subscription, of, throwError, from, forkJoin, last, shareReplay, mergeMap, concatMap, toArray, map as map$1, tap } from 'rxjs';
 import clone from 'just-clone';
 import axios from 'axios';
 import flatten from 'just-flatten-it';
@@ -710,8 +710,7 @@ class HttpServices extends BaseHttp {
 const BITRIX_STRINGIFY_OPTIONS = {
     // Добавляет числовые индексы массивов: fields[PHONE][0][VALUE].
     arrayFormat: 'indices',
-    // Использует bracket notation для вложенных объектов: filter[ID], а не filter.ID.
-    allowDots: false,
+    // allowDots не передаётся: значение по умолчанию false сохраняет bracket notation.
     // Выполняет URL-кодирование ключей и значений параметров.
     encode: true,
     // Кодирует не только значения, но и ключи вместе с квадратными скобками.
@@ -1033,7 +1032,13 @@ const $deal = 'deal';
 const $contact = 'contact';
 const $company = 'company';
 const $quote = 'quote';
+const $currency = 'currency';
 const $productrows = 'productrows';
+const $documentgenerator = 'documentgenerator';
+const $numerator = 'numerator';
+const $document = 'document';
+const $enablepublicurl = 'enablepublicurl';
+const $upload = 'upload';
 
 var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -1064,6 +1069,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $counters: $counters,
     $create: $create,
     $crm: $crm,
+    $currency: $currency,
     $deal: $deal,
     $defer: $defer,
     $delegate: $delegate,
@@ -1072,8 +1078,11 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $dialog: $dialog,
     $disapprove: $disapprove,
     $disk: $disk,
+    $document: $document,
+    $documentgenerator: $documentgenerator,
     $elapseditem: $elapseditem,
     $element: $element,
+    $enablepublicurl: $enablepublicurl,
     $end: $end,
     $enum: $enum,
     $event: $event,
@@ -1114,6 +1123,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $multifield: $multifield,
     $mute: $mute,
     $nearest: $nearest,
+    $numerator: $numerator,
     $params: $params,
     $pause: $pause,
     $pin: $pin,
@@ -1158,6 +1168,7 @@ var partNameMethods$1 = /*#__PURE__*/Object.freeze({
     $updateAvatar: $updateAvatar,
     $updateColor: $updateColor,
     $updateTitle: $updateTitle,
+    $upload: $upload,
     $uploadfile: $uploadfile,
     $url: $url,
     $user: $user,
@@ -2361,6 +2372,59 @@ class NavvyPagNavResultKey extends NavvyPagBase {
     }
 }
 
+/** Пагинация для методов, возвращающих коллекцию как объект с идентификаторами в ключах. */
+class NavvyPagNavResultKeyObject extends NavvyPagBase {
+    constructor(url, param, key, mapResult) {
+        super(url, param, mapResult);
+        this.key = key;
+    }
+    resAll() {
+        return this.resultAllEnd().pipe(last(), shareReplay(1));
+    }
+    resultAllEnd() {
+        const bxRest = new BXRest();
+        return this.resVanilla().pipe(mergeMap(items => {
+            if (!items || !instanceOfiBXRestAnswerSuccess(items)) {
+                return from([]);
+            }
+            if (!items.total || items.total <= this.pageSize) {
+                return this.mapResult(items);
+            }
+            const pageCount = Math.ceil(items.total / this.pageSize);
+            const commands = Array.from({ length: pageCount - 1 }, (_, index) => {
+                const param = clone(this.param);
+                param.start = (index + 1) * this.pageSize;
+                return bxRest.batch({
+                    halt: 1,
+                    cmd: [this.http.getNameMethod(this.url) + '?' + serializeBitrixParams(param)]
+                });
+            });
+            return from(commands).pipe(concatMap(request => request), toArray(), mergeMap(results => {
+                const merged = { ...(items.result?.[this.key] ?? {}) };
+                for (const result of results) {
+                    if (result && instanceOfiBXRestAnswerSuccess(result)) {
+                        for (const page of result.result?.result ?? []) {
+                            Object.assign(merged, page?.[this.key] ?? {});
+                        }
+                    }
+                }
+                return this.mapResult({ [this.key]: merged });
+            }));
+        }), catchError(error => {
+            console.error(error);
+            return throwError(() => error);
+        }));
+    }
+    mapResult(items) {
+        if (!instanceOfiBXRestAnswerSuccess(items)) {
+            return from([]);
+        }
+        return from([items.result]).pipe(map$1(value => this.map
+            ? this.map(value)
+            : Object.values(value?.[this.key] ?? {})));
+    }
+}
+
 class NavvySupport {
     constructor(requestClass) {
         this.requestClass = requestClass;
@@ -2410,6 +2474,9 @@ class Navvy {
     pagNavResultKey(url, arg, key, map) {
         return new NavvyPagNavResultKey(url, arg, key, map);
     }
+    pagNavResultKeyObject(url, arg, key, map) {
+        return new NavvyPagNavResultKeyObject(url, arg, key, map);
+    }
     pagNavWithUselessKey(url, 
     // func: (param: A) => Observable<iBXRestAnswer<{ [key: string]: T }> | undefined>,
     arg, map) {
@@ -6124,6 +6191,40 @@ class BXRestMapCrmAutomatedSolution {
     }
 }
 
+class BXRestMapCrmCurrency {
+    /** Преобразует список валют из формата Bitrix24 в локальный формат библиотеки. */
+    static list(value) {
+        return value?.map(item => BXRestMapCrmCurrency.get(item));
+    }
+    /** Преобразует валюту из формата Bitrix24 в локальный формат библиотеки. */
+    static get(value) {
+        if (!value)
+            return undefined;
+        return Object.assign(clone(value), {
+            AMOUNT_CNT: toNum(value.AMOUNT_CNT),
+            AMOUNT: toNum(value.AMOUNT),
+            SORT: toNum(value.SORT),
+            BASE: toBool(value.BASE),
+            DECIMALS: toNum(value.DECIMALS),
+            DATE_UPDATE: toDate(value.DATE_UPDATE),
+            LANG: BXRestMapCrmCurrency.localizations(value.LANG)
+        });
+    }
+    static localizations(value) {
+        if (!value)
+            return undefined;
+        return Object.fromEntries(Object.entries(value).map(([language, localization]) => [
+            language,
+            Object.assign(clone(localization), {
+                DECIMALS: toNum(localization.DECIMALS),
+                HIDE_ZERO: localization.HIDE_ZERO === undefined
+                    ? undefined
+                    : toBool(localization.HIDE_ZERO)
+            })
+        ]));
+    }
+}
+
 class BXRestNavvyCrmLead {
     constructor() {
         this.url = {
@@ -6855,8 +6956,357 @@ class BXRestNavvyCrmAutomatedSolution {
     }
 }
 
+/** Методы документов генератора документов (`crm.documentgenerator.document.*`). */
+class BXRestNavvyCrmDocumentGeneratorDocument {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Создаёт документ по шаблону. */
+            add: [$crm, $documentgenerator, $document, $add],
+            /** Обновляет существующий документ. */
+            update: [$crm, $documentgenerator, $document, $update],
+            /** Возвращает документ по идентификатору. */
+            get: [$crm, $documentgenerator, $document, $get],
+            /** Возвращает список документов. */
+            list: [$crm, $documentgenerator, $document, $list],
+            /** Удаляет документ. */
+            delete: [$crm, $documentgenerator, $document, $delete],
+            /** Включает или выключает публичную ссылку на документ. */
+            enablePublicUrl: [$crm, $documentgenerator, $document, $enablepublicurl],
+            /** Загружает готовый документ и прикрепляет его к CRM-объекту. */
+            upload: [$crm, $documentgenerator, $document, $upload],
+            /** Возвращает доступные поля созданного документа. */
+            getFields: [$crm, $documentgenerator, $document, $getFields]
+        };
+    }
+    /**
+     * Создаёт документ по шаблону для указанного CRM-объекта.
+     *
+     * `pdfUrl` и `imageUrl` могут появиться позднее, поскольку конвертация выполняется асинхронно.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-add.html
+     */
+    add(param) {
+        return this.documentRequest(this.url.add, param);
+    }
+    /**
+     * Обновляет значения существующего документа и запускает его повторную генерацию.
+     *
+     * `pdfUrl` и `imageUrl` могут появиться позднее, поскольку конвертация выполняется асинхронно.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-update.html
+     */
+    update(param) {
+        return this.documentRequest(this.url.update, param);
+    }
+    /**
+     * Возвращает документ по идентификатору.
+     *
+     * Если конвертация ещё не завершилась, повторите запрос через 30–40 секунд.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get.html
+     */
+    get(param) {
+        return this.documentRequest(this.url.get, param);
+    }
+    /**
+     * Возвращает список документов по фильтру с поддержкой постраничной навигации.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNavResultKey(this.url.list, param, 'documents', (result) => result?.documents);
+    }
+    /**
+     * Удаляет документ.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Включает или выключает публичную ссылку на документ.
+     * Если `status` не передан, ссылка включается.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-enable-public-url.html
+     */
+    enablePublicUrl(param) {
+        return this.Navvy.simple(this.url.enablePublicUrl, param);
+    }
+    /**
+     * Загружает готовый DOCX-документ и прикрепляет его к CRM-объекту.
+     * Дополнительно можно передать готовые PDF и изображение в Base64.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-upload.html
+     */
+    upload(param) {
+        return this.documentRequest(this.url.upload, param);
+    }
+    /**
+     * Возвращает карточку полей созданного документа.
+     * Переданные `values` используются только для вычисления ответа и не изменяют документ.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/documents/crm-document-generator-document-get-fields.html
+     */
+    getFields(param) {
+        return this.Navvy.simple(this.url.getFields, param, result => result?.documentFields);
+    }
+    documentRequest(url, param) {
+        return this.Navvy.simple(url, param, result => result?.document);
+    }
+}
+
+/** Методы нумераторов генератора документов (`crm.documentgenerator.numerator.*`). */
+class BXRestNavvyCrmDocumentGeneratorNumerator {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет новый нумератор. */
+            add: [$crm, $documentgenerator, $numerator, $add],
+            /** Обновляет существующий нумератор. */
+            update: [$crm, $documentgenerator, $numerator, $update],
+            /** Возвращает нумератор по идентификатору. */
+            get: [$crm, $documentgenerator, $numerator, $get],
+            /** Возвращает список нумераторов. */
+            list: [$crm, $documentgenerator, $numerator, $list],
+            /** Удаляет созданный через REST нумератор. */
+            delete: [$crm, $documentgenerator, $numerator, $delete]
+        };
+    }
+    /**
+     * Добавляет новый нумератор.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param, result => result?.numerator);
+    }
+    /**
+     * Обновляет существующий нумератор и возвращает его актуальные данные.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает информацию о нумераторе по идентификатору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, result => result?.numerator);
+    }
+    /**
+     * Возвращает список нумераторов с поддержкой постраничной навигации.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNavResultKey(this.url.list, param, 'numerators', (result) => result?.numerators);
+    }
+    /**
+     * Удаляет нумератор. Удалить можно только нумератор, созданный через REST.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/numerator/crm-document-generator-numerator-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+}
+
+/** Методы шаблонов генератора документов (`crm.documentgenerator.template.*`). */
+class BXRestNavvyCrmDocumentGeneratorTemplate {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            /** Добавляет новый шаблон документа. */
+            add: [$crm, $documentgenerator, $template, $add],
+            /** Обновляет существующий шаблон документа. */
+            update: [$crm, $documentgenerator, $template, $update],
+            /** Возвращает шаблон документа по идентификатору. */
+            get: [$crm, $documentgenerator, $template, $get],
+            /** Возвращает список шаблонов документов. */
+            list: [$crm, $documentgenerator, $template, $list],
+            /** Удаляет шаблон документа. */
+            delete: [$crm, $documentgenerator, $template, $delete],
+            /** Возвращает доступные поля шаблона для CRM-объекта. */
+            getFields: [$crm, $documentgenerator, $template, $getFields]
+        };
+    }
+    /**
+     * Добавляет новый шаблон документа из файла DOCX.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param, result => result?.template);
+    }
+    /**
+     * Обновляет существующий шаблон документа.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param, result => result?.template);
+    }
+    /**
+     * Возвращает информацию о шаблоне документа по идентификатору.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, result => result?.template);
+    }
+    /**
+     * Возвращает список шаблонов с поддержкой постраничной навигации.
+     *
+     * В ответе Битрикс24 шаблоны индексированы идентификаторами; навигатор преобразует их в массив.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.pagNavResultKeyObject(this.url.list, param, 'templates', (result) => result?.templates
+            ? Object.values(result.templates)
+            : undefined);
+    }
+    /**
+     * Удаляет шаблон документа.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает карточку полей шаблона для указанного типа и элемента CRM.
+     * Переданные `values` применяются временно и не изменяют данные CRM.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/document-generator/templates/crm-document-generator-template-get-fields.html
+     */
+    getFields(param) {
+        return this.Navvy.simple(this.url.getFields, param, result => result?.templateFields);
+    }
+}
+
+/** Методы генератора документов CRM (`crm.documentgenerator.*`). */
+class BXRestNavvyCrmDocumentGenerator {
+    constructor() {
+        /** Нумераторы задают шаблон номера и параметры счётчика документов. */
+        this.numerator = new BXRestNavvyCrmDocumentGeneratorNumerator();
+        /** Шаблоны DOCX, привязанные к нумераторам и типам CRM-объектов. */
+        this.template = new BXRestNavvyCrmDocumentGeneratorTemplate();
+        /** Создание, загрузка и управление документами CRM. */
+        this.document = new BXRestNavvyCrmDocumentGeneratorDocument();
+    }
+}
+
+/** Методы управления базовой валютой (`crm.currency.base.*`). */
+class BXRestNavvyCrmCurrencyBase {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            get: [$crm, $currency, 'base', $get],
+            set: [$crm, $currency, 'base', $set]
+        };
+    }
+    /**
+     * Возвращает символьный идентификатор базовой валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-get.html
+     */
+    get() {
+        return this.Navvy.simple(this.url.get);
+    }
+    /**
+     * Устанавливает указанную валюту в качестве базовой.
+     * После смены базовой валюты курсы остальных валют необходимо обновить вручную.
+     *
+     * @param param Символьный идентификатор новой базовой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-base-set.html
+     */
+    set(param) {
+        return this.Navvy.simple(this.url.set, param);
+    }
+}
+
+/** Навигатор REST-методов валют CRM (`crm.currency.*`). */
+class BXRestNavvyCrmCurrency {
+    constructor() {
+        this.Navvy = new Navvy();
+        this.url = {
+            add: [$crm, $currency, $add],
+            update: [$crm, $currency, $update],
+            get: [$crm, $currency, $get],
+            list: [$crm, $currency, $list],
+            delete: [$crm, $currency, $delete],
+            fields: [$crm, $currency, 'fields']
+        };
+        /** Базовая валюта (`crm.currency.base.*`). */
+        this.base = new BXRestNavvyCrmCurrencyBase();
+    }
+    /**
+     * Создает новую валюту.
+     *
+     * @param param Поля новой валюты, включая код ISO 4217, номинал и курс.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-add.html
+     */
+    add(param) {
+        return this.Navvy.simple(this.url.add, param);
+    }
+    /**
+     * Обновляет существующую валюту.
+     *
+     * @param param Идентификатор валюты и изменяемые поля.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-update.html
+     */
+    update(param) {
+        return this.Navvy.simple(this.url.update, param);
+    }
+    /**
+     * Возвращает валюту по символьному идентификатору.
+     *
+     * @param param Символьный идентификатор валюты по ISO 4217.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-get.html
+     */
+    get(param) {
+        return this.Navvy.simple(this.url.get, param, BXRestMapCrmCurrency.get);
+    }
+    /**
+     * Возвращает список валют с локализацией для текущего языка портала.
+     *
+     * @param param Необязательный порядок сортировки.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-list.html
+     */
+    list(param = {}) {
+        return this.Navvy.simple(this.url.list, param, BXRestMapCrmCurrency.list);
+    }
+    /**
+     * Удаляет валюту.
+     *
+     * @param param Символьный идентификатор удаляемой валюты.
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-delete.html
+     */
+    delete(param) {
+        return this.Navvy.simple(this.url.delete, param);
+    }
+    /**
+     * Возвращает описание полей валюты.
+     *
+     * @see https://apidocs.bitrix24.ru/api-reference/crm/currency/crm-currency-fields.html
+     */
+    fields() {
+        return this.Navvy.simple(this.url.fields);
+    }
+}
+
 class BXRestNavvyCrm {
     constructor() {
+        /** Валюты CRM (`crm.currency.*`). */
+        this.currency = new BXRestNavvyCrmCurrency();
+        /** Генератор документов CRM (`crm.documentgenerator.*`). */
+        this.documentGenerator = new BXRestNavvyCrmDocumentGenerator();
         /** Цифровые рабочие места (`crm.automatedsolution.*`). */
         this.automatedSolution = new BXRestNavvyCrmAutomatedSolution();
         /** Автоматизация CRM (`crm.automation.*`). */