bx-rest 1.3.0 → 1.5.0

package/typification/rest/crm/universal.d.ts

@@ -1,7 +1,123 @@
 import { iBXRestPagination } from '../base/api-pagination-bx';
+import { iBXRestYesNo } from '../base/yes-no';
 export type iBXRestCrmObject = Record<string, unknown>;
 export type iBXRestCrmFields = Record<string, unknown>;
 export type iBXRestCrmParams = Record<string, unknown>;
+/**
+ * Тип поля в ответе `crm.item.fields`. Портал может вернуть и другой тип,
+ * например зарегистрированный приложением через `userfieldtype.add`.
+ */
+export type iBXRestCrmItemFieldType = 'integer' | 'double' | 'string' | 'text' | 'boolean' | 'date' | 'datetime' | 'money' | 'url' | 'address' | 'file' | 'location' | 'user' | 'employee' | 'enumeration' | 'iblock_section' | 'iblock_element' | 'crm' | 'crm_status' | 'crm_category' | 'crm_currency' | 'crm_company' | 'crm_contact' | 'crm_lead' | 'crm_deal' | 'crm_quote' | 'crm_entity' | 'crm_multifield' | (string & {});
+/** Настройки поля. Состав зависит от типа, поэтому описан только ключ, который задокументирован. */
+export interface iBXRestCrmItemFieldSettings {
+    /** У поля связи — `entityTypeId` родителя (`parentId1098` → 1098, `companyId` → 4). */
+    parentEntityTypeId?: number;
+    [setting: string]: unknown;
+}
+/** Описание одного поля элемента CRM. */
+export interface iBXRestCrmItemField {
+    type: iBXRestCrmItemFieldType;
+    title: string;
+    isRequired: boolean;
+    isReadOnly: boolean;
+    isImmutable: boolean;
+    isMultiple: boolean;
+    isDynamic: boolean;
+    upperName: string;
+    settings?: iBXRestCrmItemFieldSettings;
+    /** У поля `crm_status` — справочник значений для `crm.status.list`, например `DYNAMIC_1268_STAGE_52`. */
+    statusType?: string;
+    isDeprecated?: boolean;
+}
+/** Ответ `crm.item.fields`. Ключ — идентификатор поля. */
+export interface iBXRestCrmItemFieldsResult {
+    fields: Record<string, iBXRestCrmItemField>;
+}
+/**
+ * Элемент CRM в методах `crm.item.*`. Описаны поля, общие для типов объектов; какие из них придут,
+ * зависит от типа объекта, настроек смарт-процесса и `select`. Остальное, включая `parentId<entityTypeId>`
+ * и пользовательские поля `ufCrm...`, доступно по индексу: их набор у каждого портала свой.
+ *
+ * Значения приходят как есть: `stageId` — код стадии, `companyId` — идентификатор, поле типа `money` —
+ * строка `1500.00|RUB`. Названия нужно получать отдельно.
+ */
+export interface iBXRestCrmItem {
+    /** В `crm.item.list` при заданном `select` приходит, только если указан в нём. */
+    id?: number;
+    xmlId?: string;
+    /** Нет у контактов: у них имя в `name`, `secondName` и `lastName`. */
+    title?: string;
+    /** Есть только у лидов и контактов, как и `secondName` и `lastName`. Незаполненное значение приходит как `null`. */
+    name?: string | null;
+    secondName?: string | null;
+    lastName?: string | null;
+    assignedById?: number;
+    createdBy?: number;
+    updatedBy?: number;
+    movedBy?: number;
+    createdTime?: string;
+    updatedTime?: string;
+    movedTime?: string;
+    categoryId?: number;
+    stageId?: string;
+    previousStageId?: string;
+    begindate?: string;
+    closedate?: string;
+    /** У контактов устарел, там нужен `companyIds`. */
+    companyId?: number;
+    /** Есть только у контактов. */
+    companyIds?: number[];
+    /** @deprecated Используйте `contactIds`. */
+    contactId?: number;
+    contactIds?: number[];
+    opportunity?: number;
+    taxValue?: number;
+    currencyId?: string;
+    observers?: number[];
+    [field: string]: unknown;
+}
+/** Ответ `crm.item.add`, `crm.item.get` и `crm.item.update`. `select` у них нет, поэтому `id` приходит всегда. */
+export interface iBXRestCrmItemResult {
+    item: iBXRestCrmItem & {
+        id: number;
+    };
+}
+/**
+ * Смарт-процесс в методах `crm.type.*`. Остальное, например `relations` и `linkedUserFields`
+ * в ответе `crm.type.get`, доступно по индексу.
+ */
+export interface iBXRestCrmType {
+    id: number;
+    title: string;
+    code?: string;
+    entityTypeId: number;
+    customSectionId?: number | null;
+    isCategoriesEnabled?: iBXRestYesNo;
+    isStagesEnabled?: iBXRestYesNo;
+    isBeginCloseDatesEnabled?: iBXRestYesNo;
+    isClientEnabled?: iBXRestYesNo;
+    isUseInUserfieldEnabled?: iBXRestYesNo;
+    isLinkWithProductsEnabled?: iBXRestYesNo;
+    isMycompanyEnabled?: iBXRestYesNo;
+    isDocumentsEnabled?: iBXRestYesNo;
+    isSourceEnabled?: iBXRestYesNo;
+    isObserversEnabled?: iBXRestYesNo;
+    isRecyclebinEnabled?: iBXRestYesNo;
+    isAutomationEnabled?: iBXRestYesNo;
+    isBizProcEnabled?: iBXRestYesNo;
+    isSetOpenPermissions?: iBXRestYesNo;
+    isPaymentsEnabled?: iBXRestYesNo;
+    isCountersEnabled?: iBXRestYesNo;
+    createdBy?: number;
+    updatedBy?: number;
+    createdTime?: string;
+    updatedTime?: string;
+    [field: string]: unknown;
+}
+/** Ответ `crm.type.add`, `crm.type.get`, `crm.type.getByEntityTypeId` и `crm.type.update`. */
+export interface iBXRestCrmTypeResult {
+    type: iBXRestCrmType;
+}
 export interface iBXRestParamCrmEntityType {
     entityTypeId: number;
 }

package/typification/settings.d.ts

@@ -2,6 +2,23 @@ export interface iBXRestSettings {
     auth: {
         source: 'cookies' | 'localStorage' | 'off' | (() => string);
         key: 'auth' | 'sessid' | string;
+        /**
+         * Продление авторизации. Если запрос упал с ошибкой авторизации (см.
+         * `isAuthError`), библиотека вызывает эту функцию и повторяет запрос
+         * один раз — заново читая токен, адрес и заголовки из настроек. Поэтому
+         * функция должна положить новый токен туда, откуда его читает `source`
+         * (или, для прокси, передать его на сервер). Значение промиса не
+         * используется. Одновременно упавшие запросы ждут одно общее продление.
+         *
+         * Если не задано — запросы не повторяются (поведение до 1.4.0).
+         */
+        refresh?: () => Promise<unknown>;
+        /**
+         * Какую ошибку запроса считать ошибкой авторизации, которую лечит
+         * `refresh`. Получает исходную ошибку HTTP-запроса — обычно `AxiosError`.
+         * По умолчанию — `isBXRestAuthError`.
+         */
+        isAuthError?: (error: unknown) => boolean;
     };
     urls: {
         source: 'string' | 'localStorage';