bx-rest 0.26.1 → 1.1.0

package/fesm2022/bx-rest.mjs

@@ -1,5 +1,5 @@
 import { switchMap, map, catchError, take, mergeMap as mergeMap$1 } from 'rxjs/operators';
-import { Subscription, of, throwError, from, forkJoin, last, shareReplay, mergeMap, concatMap, toArray, map as map$1, tap } from 'rxjs';
+import { Subscription, of, throwError, from, forkJoin, defer, 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';
@@ -20,7 +20,7 @@ const DEFAULT_BX_REST_SETTINGS = {
     }
 };
 const BXRestSettings = {
-    date: {
+    value: {
         auth: {
             source: 'cookies',
             key: 'auth',
@@ -31,8 +31,20 @@ const BXRestSettings = {
             additional_part: 'rest',
         },
     },
+    /**
+     * @deprecated Переименовано в `BXRestSettings.value` — имя `date` не
+     * отражало содержимое (настройки auth/urls, а не дату) и сбивало с толку
+     * в публичном API. Геттер/сеттер оставлен только для обратной совместимости
+     * с кодом, написанным против API до 1.0.
+     */
+    get date() {
+        return this.value;
+    },
+    set date(newValue) {
+        this.value = newValue;
+    },
     update(newSettings) {
-        this.date = { ...this.date, ...newSettings };
+        this.value = { ...this.value, ...newSettings };
     },
 };
 
@@ -514,12 +526,20 @@ class SessionKeyError extends Error {
     }
 }
 class SessionKeyServices {
+    // Геттер, а не поле с одноразовым снимком: BXRestSettings.update() создаёт
+    // НОВЫЙ объект (this.value = {...this.value, ...}), а не мутирует старый —
+    // поэтому `= BXRestSettings.value` в виде обычного поля навсегда
+    // "заморозил" бы то, что было на момент создания SessionKeyServices.
+    // Геттер вместо этого читает актуальный BXRestSettings.value при каждом
+    // обращении.
+    get BX_REST_SETTINGS() {
+        return BXRestSettings.value;
+    }
     constructor() {
         this.authHave = false;
         this.subscribe = {
             authData: new Subscription()
         };
-        this.BX_REST_SETTINGS = BXRestSettings.date;
         const authData = this.getSessionItem(this.constructor.name);
         if (this.getAuth().length > 0) {
             this.authHave = true;
@@ -556,6 +576,17 @@ class SessionKeyServices {
             return 'auth';
         }
     }
+    /**
+     * Стоит ли прикладывать браузерные cookie к запросу (axios `withCredentials`).
+     * Явный `BXRestSettings.withCredentials` имеет приоритет; если не задан —
+     * сохраняется историческое поведение: включаем только для `auth.key === 'OAuth2'`.
+     */
+    getWithCredentials() {
+        if (typeof this.BX_REST_SETTINGS.withCredentials === 'boolean') {
+            return this.BX_REST_SETTINGS.withCredentials;
+        }
+        return this.getKeyAuth() === 'OAuth2';
+    }
     getSessid() {
         const check = this.getSearchParam('sessid');
         if (check) {
@@ -894,7 +925,7 @@ function serializeBitrixParams(params) {
 
 class HttpBXServices extends HttpServices {
     /**
-     * Это пиздец а не метод
+     * Не считайте этот метод образцом/финальным API.
      * TODO: Удалить данный метод после реализации его в разделе Navvy
      * @param param
      */
@@ -954,37 +985,70 @@ class HttpBXServices extends HttpServices {
         return this.httpGet(this.getNameMethod(name), params);
     }
     httpPost(url, params = {}) {
-        const paramsClone = clone(params);
-        const key = this.session.getKeyAuth();
-        const auth = this.session.getAuthParams();
-        const checkIsOn = this.session.getCheckAuthParamsIsOn();
-        if (checkIsOn) {
-            if (!auth) {
-                return throwError(() => this.session.getAuthError('post'));
-            }
-            if (key !== 'OAuth2') {
-                paramsClone[key] = auth;
-            }
-        }
-        return this.session.getBaseUrl().pipe(switchMap((baseUrl) => {
-            if (!baseUrl) {
-                return throwError(() => this.session.getBaseUrlError('post'));
+        // defer() откладывает всё содержимое (в том числе чтение BXRestSettings
+        // через this.session.*) до реальной подписки — иначе даже с "живым"
+        // геттером в SessionKeyServices настройки читались бы в момент вызова
+        // .res(), а не в момент subscribe()/firstValueFrom(), что и обещано
+        // в README как поведение "ленивого" REST-вызова.
+        return defer(() => {
+            const paramsClone = clone(params);
+            const key = this.session.getKeyAuth();
+            const auth = this.session.getAuthParams();
+            const checkIsOn = this.session.getCheckAuthParamsIsOn();
+            if (checkIsOn) {
+                if (!auth) {
+                    return throwError(() => this.session.getAuthError('post'));
+                }
+                if (key !== 'OAuth2') {
+                    paramsClone[key] = auth;
+                }
             }
-            const fullUrl = prepareBaseAddress(baseUrl) + url;
-            if (key === 'sessid') {
-                // Преобразуем параметры в формат x-www-form-urlencoded
-                const bodyString = this.serializeBitrixParams(paramsClone);
-                return from(this.axiosInstance.post(fullUrl, bodyString, {
-                    headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            return this.session.getBaseUrl().pipe(switchMap((baseUrl) => {
+                if (!baseUrl) {
+                    return throwError(() => this.session.getBaseUrlError('post'));
+                }
+                const fullUrl = prepareBaseAddress(baseUrl) + url;
+                if (key === 'sessid') {
+                    // Преобразуем параметры в формат x-www-form-urlencoded
+                    const bodyString = this.serializeBitrixParams(paramsClone);
+                    return from(this.axiosInstance.post(fullUrl, bodyString, {
+                        headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+                    }).then((response) => response.data));
+                }
+                return from(this.axiosInstance.post(fullUrl, paramsClone, {
+                    withCredentials: this.session.getWithCredentials(),
+                    headers: {
+                        'Content-Type': 'application/json',
+                    }
                 }).then((response) => response.data));
+            }));
+        });
+    }
+    httpGet(url, params = {}) {
+        // Та же причина, что и у httpPost выше: откладываем чтение BXRestSettings
+        // до подписки, чтобы `get()` вёл себя так же "лениво", как и `post()`
+        // (симметрия, которой не было до этого — GET резолвил настройки в момент
+        // вызова, а не в момент subscribe()).
+        return defer(() => {
+            const paramsClone = clone(params);
+            const auth = this.session.getAuthParams();
+            const checkIsOn = this.session.getCheckAuthParamsIsOn();
+            if (checkIsOn) {
+                if (!auth) {
+                    return throwError(() => this.session.getAuthError('get'));
+                }
+                paramsClone[this.session.getKeyAuth()] = auth;
             }
-            return from(this.axiosInstance.post(fullUrl, paramsClone, {
-                withCredentials: key === 'OAuth2',
-                headers: {
-                    'Content-Type': 'application/json',
+            return this.session.getBaseUrl().pipe(switchMap((baseUrl) => {
+                if (!baseUrl) {
+                    return throwError(() => this.session.getBaseUrlError('get'));
                 }
-            }).then((response) => response.data));
-        }));
+                const fullUrl = prepareBaseAddress(baseUrl) + url;
+                const queryString = new URLSearchParams(paramsClone).toString();
+                const finalUrl = `${fullUrl}?${queryString}`;
+                return from(this.axiosInstance.get(finalUrl).then((response) => response.data));
+            }));
+        });
     }
     serializeBitrixParams(params) {
         return serializeBitrixParams(params);
@@ -9139,6 +9203,29 @@ class BXRestNavvyPull {
     }
 }
 
+/**
+ * crm.deal.list, crm.lead.list, crm.contact.list и crm.company.list — в
+ * отличие от остального REST API Bitrix24 — принимают значения `order` в
+ * нижнем регистре (`'asc'`/`'desc'`), а не в верхнем (`'ASC'`/`'DESC'`, как
+ * везде остальном, см. {@link iBXRestParamSort}). Публичный тип этих
+ * четырёх методов унифицирован на `iBXRestParamSort` ради единообразия
+ * во всей библиотеке — эта функция перед отправкой запроса приводит
+ * значения обратно к регистру, которого реально ожидает конкретно этот
+ * метод, так что на бэкенд уходит то же самое, что уходило бы и без
+ * унификации типов.
+ *
+ * @hidden
+ */
+function lowerCaseOrder(order) {
+    if (!order)
+        return undefined;
+    const result = {};
+    for (const field of Object.keys(order)) {
+        result[field] = order[field].toLowerCase();
+    }
+    return result;
+}
+
 class BXRestMapCrmLead {
     /**
      * Преобразует массив лидов из HTTP формата в локальный
@@ -9743,7 +9830,12 @@ class BXRestNavvyCrmLead {
      * @param param
      */
     list(param) {
-        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmLead.list);
+        return this.Navvy.pagNav(this.url.list, 
+        // crm.lead.list ждёт order в нижнем регистре ('asc'/'desc'), в отличие
+        // от остального REST API — публичный тип унифицирован на iBXRestParamSort
+        // ('ASC'/'DESC'), а тут приводим обратно к тому, что реально нужно
+        // отправить на бэкенд. См. lowerCaseOrder.
+        { ...param, order: lowerCaseOrder(param.order) }, BXRestMapCrmLead.list);
     }
     /**
      * Обновляет существующий лид
@@ -10015,7 +10107,12 @@ class BXRestNavvyCrmDeal {
      * @param param
      */
     list(param) {
-        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmDeal.list);
+        return this.Navvy.pagNav(this.url.list, 
+        // crm.deal.list ждёт order в нижнем регистре ('asc'/'desc'), в отличие
+        // от остального REST API — публичный тип унифицирован на iBXRestParamSort
+        // ('ASC'/'DESC'), а тут приводим обратно к тому, что реально нужно
+        // отправить на бэкенд. См. lowerCaseOrder.
+        { ...param, order: lowerCaseOrder(param.order) }, BXRestMapCrmDeal.list);
     }
     /**
      * Обновляет существующую сделку
@@ -10227,7 +10324,12 @@ class BXRestNavvyCrmContact {
      * @param param
      */
     list(param) {
-        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmContact.list);
+        return this.Navvy.pagNav(this.url.list, 
+        // crm.contact.list ждёт order в нижнем регистре ('asc'/'desc'), в отличие
+        // от остального REST API — публичный тип унифицирован на iBXRestParamSort
+        // ('ASC'/'DESC'), а тут приводим обратно к тому, что реально нужно
+        // отправить на бэкенд. См. lowerCaseOrder.
+        { ...param, order: lowerCaseOrder(param.order) }, BXRestMapCrmContact.list);
     }
     /**
      * Обновляет существующий контакт
@@ -10439,7 +10541,12 @@ class BXRestNavvyCrmCompany {
      * @param param
      */
     list(param) {
-        return this.Navvy.pagNav(this.url.list, param, BXRestMapCrmCompany.list);
+        return this.Navvy.pagNav(this.url.list, 
+        // crm.company.list ждёт order в нижнем регистре ('asc'/'desc'), в отличие
+        // от остального REST API — публичный тип унифицирован на iBXRestParamSort
+        // ('ASC'/'DESC'), а тут приводим обратно к тому, что реально нужно
+        // отправить на бэкенд. См. lowerCaseOrder.
+        { ...param, order: lowerCaseOrder(param.order) }, BXRestMapCrmCompany.list);
     }
     /**
      * Обновляет существующую компанию