bx-rest 0.26.1 → 1.1.0

package/functions/lowerCaseOrder.d.ts

@@ -0,0 +1,15 @@
+import { iBXRestParamSort } from '../typification/rest/base/sort';
+/**
+ * crm.deal.list, crm.lead.list, crm.contact.list и crm.company.list — в
+ * отличие от остального REST API Bitrix24 — принимают значения `order` в
+ * нижнем регистре (`'asc'`/`'desc'`), а не в верхнем (`'ASC'`/`'DESC'`, как
+ * везде остальном, см. {@link iBXRestParamSort}). Публичный тип этих
+ * четырёх методов унифицирован на `iBXRestParamSort` ради единообразия
+ * во всей библиотеке — эта функция перед отправкой запроса приводит
+ * значения обратно к регистру, которого реально ожидает конкретно этот
+ * метод, так что на бэкенд уходит то же самое, что уходило бы и без
+ * унификации типов.
+ *
+ * @hidden
+ */
+export declare function lowerCaseOrder(order: Record<string, iBXRestParamSort> | undefined): Record<string, 'asc' | 'desc'> | undefined;

package/map/tasks/task.d.ts

@@ -6,9 +6,7 @@ import { iBXRestHttpTask, iBXRestTask } from '../../typification/rest/tasks/task
 import { iBXRestTaskFieldsName } from '../../typification/rest/tasks/base/fields-name';
 export declare class BXRestMapTasksTask {
     readonly result: typeof BXRestMapTasksTaskResult;
-    static getAccess(v: iBXRestTaskGetAccess | undefined): {
-        [key: number]: import("../../typification/rest/task/access/getaccess").iBXRestTaskGetAccessItem;
-    } | undefined;
+    static getAccess(v: iBXRestTaskGetAccess | undefined): Record<number, import("../../typification/rest/task/access/getaccess").iBXRestTaskGetAccessItem> | undefined;
     static add(item: {
         task: iBXRestTasksTaskGetHttpDefault;
     } | undefined): iBXRestTask | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.26.1",
+  "version": "1.1.0",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",
@@ -48,6 +48,7 @@
     "README.md",
     "README.en.md",
     "LICENSE",
+    "CHANGELOG.md",
     "*.d.ts",
     "consts",
     "esm2022",

package/request-navvy/crm/company.d.ts

@@ -56,7 +56,12 @@ export declare class BXRestNavvyCrmCompany {
      * Возвращает список компаний
      * @param param
      */
-    list(param: iBXRestParamCrmCompanyList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmCompanyHttp, import("../../typification/rest/crm").iBXRestCrmCompany, iBXRestParamCrmCompanyList>;
+    list(param: iBXRestParamCrmCompanyList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmCompanyHttp, import("../../typification/rest/crm").iBXRestCrmCompany, {
+        order: Record<string, "asc" | "desc"> | undefined;
+        filter?: Record<string, any>;
+        select?: string[];
+        start?: number;
+    }>;
     /**
      * Обновляет существующую компанию
      * @param param

package/request-navvy/crm/contact.d.ts

@@ -56,7 +56,12 @@ export declare class BXRestNavvyCrmContact {
      * Возвращает список контактов
      * @param param
      */
-    list(param: iBXRestParamCrmContactList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmContactHttp, import("../../typification/rest/crm").iBXRestCrmContact, iBXRestParamCrmContactList>;
+    list(param: iBXRestParamCrmContactList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmContactHttp, import("../../typification/rest/crm").iBXRestCrmContact, {
+        order: Record<string, "asc" | "desc"> | undefined;
+        filter?: Record<string, any>;
+        select?: string[];
+        start?: number;
+    }>;
     /**
      * Обновляет существующий контакт
      * @param param

package/request-navvy/crm/deal.d.ts

@@ -66,7 +66,12 @@ export declare class BXRestNavvyCrmDeal {
      * Возвращает список сделок
      * @param param
      */
-    list(param: iBXRestParamCrmDealList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmDealHttp, import("../../typification/rest/crm").iBXRestCrmDeal, iBXRestParamCrmDealList>;
+    list(param: iBXRestParamCrmDealList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmDealHttp, import("../../typification/rest/crm").iBXRestCrmDeal, {
+        order: Record<string, "asc" | "desc"> | undefined;
+        filter?: Record<string, any>;
+        select?: string[];
+        start?: number;
+    }>;
     /**
      * Обновляет существующую сделку
      * @param param

package/request-navvy/crm/lead.d.ts

@@ -61,7 +61,12 @@ export declare class BXRestNavvyCrmLead {
      * Возвращает список лидов
      * @param param
      */
-    list(param: iBXRestParamCrmLeadList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmLeadHttp, import("../../typification/rest/crm").iBXRestCrmLead, iBXRestParamCrmLeadList>;
+    list(param: iBXRestParamCrmLeadList): import("../../services/navvy").NavvyPag<import("../../typification/rest/crm").iBXRestCrmLeadHttp, import("../../typification/rest/crm").iBXRestCrmLead, {
+        order: Record<string, "asc" | "desc"> | undefined;
+        filter?: Record<string, any>;
+        select?: string[];
+        start?: number;
+    }>;
     /**
      * Обновляет существующий лид
      * @param param

package/services/http/HttpBX.d.ts

@@ -4,7 +4,7 @@ import { iBatchRequestAnswer, iBatchRequestParam, iBatchRequestParamArr, iBatchR
 import { iBXRestAnswer } from '../../typification/rest/base/answer';
 export declare class HttpBXServices extends HttpServices {
     /**
-     * Это пиздец а не метод
+     * Не считайте этот метод образцом/финальным API.
      * TODO: Удалить данный метод после реализации его в разделе Navvy
      * @param param
      */
@@ -27,6 +27,7 @@ export declare class HttpBXServices extends HttpServices {
      */
     get<T>(name: string[], params?: any): Observable<iBXRestAnswer<T> | undefined>;
     httpPost<T>(url: string, params?: any): Observable<T | undefined>;
+    httpGet<T>(url: string, params?: any): Observable<T | undefined>;
     serializeBitrixParams(params: unknown): string;
     getNameMethod(arr: string[]): string;
 }

package/services/http/sessionKey.d.ts

@@ -10,11 +10,17 @@ export declare class SessionKeyServices {
     subscribe: {
         authData: Subscription;
     };
-    private readonly BX_REST_SETTINGS;
+    private get BX_REST_SETTINGS();
     constructor();
     subscribeAll(): void;
     getAuth(): string;
     getKeyAuth(): IKeyAuth;
+    /**
+     * Стоит ли прикладывать браузерные cookie к запросу (axios `withCredentials`).
+     * Явный `BXRestSettings.withCredentials` имеет приоритет; если не задан —
+     * сохраняется историческое поведение: включаем только для `auth.key === 'OAuth2'`.
+     */
+    getWithCredentials(): boolean;
     getSessid(): string;
     getAuthParams(): string | undefined;
     getCheckAuthParamsIsOn(): boolean;

package/settings.d.ts

@@ -1,6 +1,13 @@
 import { iBXRestSettings } from './typification/settings';
 export declare const DEFAULT_BX_REST_SETTINGS: iBXRestSettings;
 export declare const BXRestSettings: {
+    value: iBXRestSettings;
+    /**
+     * @deprecated Переименовано в `BXRestSettings.value` — имя `date` не
+     * отражало содержимое (настройки auth/urls, а не дату) и сбивало с толку
+     * в публичном API. Геттер/сеттер оставлен только для обратной совместимости
+     * с кодом, написанным против API до 1.0.
+     */
     date: iBXRestSettings;
     update(newSettings: Partial<iBXRestSettings>): void;
 };

package/typification/rest/batch/batchRequestParam.d.ts

@@ -4,12 +4,6 @@ export interface iBatchRequestParam<T> {
     name: string;
     param: T;
 }
-export type iBatchRequestParamHttp = {
-    [key: keyBatch]: string;
-};
-export type iBatchRequestParamArr<T> = {
-    [key: keyBatch]: iBatchRequestParam<T>;
-};
-export type iBatchRequestAnswer<T> = iBXRestAnswer<iBXRestAnswer<{
-    [key: keyBatch]: T;
-}>>;
+export type iBatchRequestParamHttp = Record<keyBatch, string>;
+export type iBatchRequestParamArr<T> = Record<keyBatch, iBatchRequestParam<T>>;
+export type iBatchRequestAnswer<T> = iBXRestAnswer<iBXRestAnswer<Record<keyBatch, T>>>;

package/typification/rest/crm/company/list.d.ts

@@ -1,6 +1,7 @@
 import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestParamSort } from '../../base/sort';
 export interface iBXRestParamCrmCompanyList extends iBXRestPagination {
-    order?: Record<string, 'asc' | 'desc'>;
+    order?: Record<string, iBXRestParamSort>;
     filter?: Record<string, any>;
     select?: string[];
 }

package/typification/rest/crm/contact/list.d.ts

@@ -1,6 +1,7 @@
 import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestParamSort } from '../../base/sort';
 export interface iBXRestParamCrmContactList extends iBXRestPagination {
-    order?: Record<string, 'asc' | 'desc'>;
+    order?: Record<string, iBXRestParamSort>;
     filter?: Record<string, any>;
     select?: string[];
 }

package/typification/rest/crm/deal/list.d.ts

@@ -1,6 +1,7 @@
 import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestParamSort } from '../../base/sort';
 export interface iBXRestParamCrmDealList extends iBXRestPagination {
-    order?: Record<string, 'asc' | 'desc'>;
+    order?: Record<string, iBXRestParamSort>;
     filter?: Record<string, any>;
     select?: string[];
 }

package/typification/rest/crm/lead/list.d.ts

@@ -1,6 +1,7 @@
 import { iBXRestPagination } from '../../base/api-pagination-bx';
+import { iBXRestParamSort } from '../../base/sort';
 export interface iBXRestParamCrmLeadList extends iBXRestPagination {
-    order?: Record<string, 'asc' | 'desc'>;
+    order?: Record<string, iBXRestParamSort>;
     filter?: Record<string, any>;
     select?: string[];
 }

package/typification/rest/support/param.d.ts

@@ -1,5 +1,3 @@
 export interface iBXRestBaseParam {
     start?: number;
 }
-export interface iBXRestBaseParamFactor<T extends iBXRestBaseParam> {
-}

package/typification/rest/task/access/getaccess.d.ts

@@ -6,9 +6,7 @@ export interface iBXRestParamTaskGetAccess {
     users?: number[];
 }
 export interface iBXRestTaskGetAccess {
-    allowedActions: {
-        [key: number]: iBXRestTaskGetAccessItem;
-    };
+    allowedActions: Record<number, iBXRestTaskGetAccessItem>;
 }
 export interface iBXRestTaskGetAccessItem {
     ACCEPT: boolean;

package/typification/rest/task/commentitem/commentitem.d.ts

@@ -5,9 +5,7 @@ export interface iBXRestTaskComment extends iBXRestTaskCommentBase {
     POST_DATE: Date;
 }
 export interface iBXRestTaskCommentHtml extends iBXRestTaskCommentBase {
-    ATTACHED_OBJECTS?: {
-        [key: number]: iCommentTaskFileHtml;
-    };
+    ATTACHED_OBJECTS?: Record<number, iCommentTaskFileHtml>;
     AUTHOR_ID: string;
     ID: string;
     POST_DATE: string;

package/typification/rest/tasks/task.d.ts

@@ -68,9 +68,7 @@ export interface iBXRestHttpTask extends iBXRestBaseTask {
     additionalData: any[];
     creator: iBXRestHttpTaskPeople;
     responsible: iBXRestHttpTaskPeople;
-    accomplicesData: {
-        [key: number]: iBXRestHttpTaskPeople;
-    };
+    accomplicesData: Record<number, iBXRestHttpTaskPeople>;
     allowTimeTracking: iBXRestYesNo;
     tags: iBXRestTaskHttpTag;
 }
@@ -78,12 +76,10 @@ export interface iBXRestTaskTag {
     id: number;
     title: string;
 }
-export interface iBXRestTaskHttpTag {
-    [key: string]: {
-        id: string;
-        title: string;
-    };
-}
+export type iBXRestTaskHttpTag = Record<string, {
+    id: string;
+    title: string;
+}>;
 export interface iBXRestHttpTaskGroupHttp {
     id: string;
     name: string;

package/typification/settings.d.ts

@@ -8,4 +8,13 @@ export interface iBXRestSettings {
         key: string | 'OAuth2';
         additional_part?: string;
     };
+    /**
+     * Управляет axios-опцией `withCredentials` (прикладывать ли браузерные
+     * cookie к запросу) независимо от `auth.key`. Если не задано — сохраняется
+     * прежнее поведение: `withCredentials` включается только при
+     * `auth.key === 'OAuth2'`. Явное значение здесь имеет приоритет — нужно,
+     * например, когда `auth.source: 'off'` указывает на собственный прокси,
+     * а браузер должен приложить cookie сессии этого прокси (не Bitrix24).
+     */
+    withCredentials?: boolean;
 }