bx-rest 0.23.0 → 0.25.0

package/map/calendar/event.d.ts

@@ -1,6 +1,16 @@
 import { iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetAnswerHttp } from '../../typification/rest/calendar/event/get';
 export declare class BXRestMapCalendarEvent {
-    static getById(item: iBXRestCalendarEventGetAnswerHttp | undefined | null): iBXRestCalendarEventGetAnswer | undefined;
-    static get(item: iBXRestCalendarEventGetAnswerHttp[] | undefined): iBXRestCalendarEventGetAnswer[] | undefined;
-    static CalendarEventGetAnswerHttpToCalendarEventGetAnswer(item: iBXRestCalendarEventGetAnswerHttp): iBXRestCalendarEventGetAnswer;
+    /**
+     * @param item
+     * @param dateTimeFormat Формат полей с датой и временем (`DATE_CREATE`, `DATE_FROM`, `DATE_TO`, `TIMESTAMP_X`
+     *   и т.д.). По умолчанию — распространённый на многих порталах `'dd.MM.yyyy HH:mm:ss'`, но реальный формат
+     *   зависит от настроек портала (Настройки → формат даты и времени) — если он известен, передавайте его явно.
+     *   Формат для полей только с датой (`EXDATE`, `RRULE.UNTIL`) выводится из этого же значения
+     *   (отбрасыванием `HH:mm:ss`) — передавать его отдельно не нужно.
+     */
+    static getById(item: iBXRestCalendarEventGetAnswerHttp | undefined | null, dateTimeFormat?: string): iBXRestCalendarEventGetAnswer | undefined;
+    /** @see getById */
+    static get(item: iBXRestCalendarEventGetAnswerHttp[] | undefined, dateTimeFormat?: string): iBXRestCalendarEventGetAnswer[] | undefined;
+    /** @see getById */
+    static CalendarEventGetAnswerHttpToCalendarEventGetAnswer(item: iBXRestCalendarEventGetAnswerHttp, dateTimeFormat?: string): iBXRestCalendarEventGetAnswer;
 }

package/map/calendar/section.d.ts

@@ -1,5 +1,12 @@
 import { iBXRestCalendarSectionGet, iBXRestCalendarSectionGetHttp } from '../../typification/rest/calendar/section/get';
 export declare class BXRestMapCalendarSection {
-    static get(item: iBXRestCalendarSectionGetHttp[] | undefined): iBXRestCalendarSectionGet[] | undefined;
-    static CalendarSectionGetHttpToCalendarSectionGetHttp(item: iBXRestCalendarSectionGetHttp): iBXRestCalendarSectionGet;
+    /**
+     * @param item
+     * @param dateTimeFormat Формат полей `DATE_CREATE`/`TIMESTAMP_X`. По умолчанию — распространённый на многих
+     *   порталах `'dd.MM.yyyy HH:mm:ss'`, но реальный формат зависит от настроек портала (Настройки → формат
+     *   даты и времени) — если он известен, передавайте его явно.
+     */
+    static get(item: iBXRestCalendarSectionGetHttp[] | undefined, dateTimeFormat?: string): iBXRestCalendarSectionGet[] | undefined;
+    /** @see get */
+    static CalendarSectionGetHttpToCalendarSectionGetHttp(item: iBXRestCalendarSectionGetHttp, dateTimeFormat?: string): iBXRestCalendarSectionGet;
 }

package/map/crm/calllist.d.ts

@@ -1,8 +1,15 @@
 import { iBXRestCrmCallList, iBXRestCrmCallListHttp, iBXRestCrmCallListListItem, iBXRestCrmCallListListItemHttp } from '../../typification/rest/crm';
 export declare class BXRestMapCrmCallList {
-    /** Преобразует данные списка обзвона из формата Bitrix24 в локальный формат. */
-    static get(value: iBXRestCrmCallListHttp | undefined): iBXRestCrmCallList | undefined;
-    /** Преобразует список обзвонов с учетом полей, выбранных через `SELECT`. */
-    static list(value: iBXRestCrmCallListListItemHttp[] | undefined): iBXRestCrmCallListListItem[] | undefined;
+    /**
+     * Преобразует данные списка обзвона из формата Bitrix24 в локальный формат.
+     *
+     * @param value
+     * @param dateTimeFormat Формат поля `DATE_CREATE`. По умолчанию — `'yyyy-MM-dd HH:mm:ss'`, но реальный
+     *   формат зависит от настроек портала (Настройки → формат даты и времени) — если он известен,
+     *   передавайте его явно.
+     */
+    static get(value: iBXRestCrmCallListHttp | undefined, dateTimeFormat?: string): iBXRestCrmCallList | undefined;
+    /** Преобразует список обзвонов с учетом полей, выбранных через `SELECT`. @see get */
+    static list(value: iBXRestCrmCallListListItemHttp[] | undefined, dateTimeFormat?: string): iBXRestCrmCallListListItem[] | undefined;
     private static mapItem;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.23.0",
+  "version": "0.25.0",
   "description": "Bitrix24 REST API client and TypeScript SDK for Angular, Vue and browser apps",
   "keywords": [
     "bitrix",
@@ -27,6 +27,10 @@
     "url": "https://github.com/Aricatofuka/bx-rest/issues"
   },
   "homepage": "https://github.com/Aricatofuka/bx-rest#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Aricatofuka/bx-rest.git"
+  },
   "dependencies": {
     "axios": "^1.19.0",
     "countries-and-timezones": "^3.7.2",
@@ -34,7 +38,6 @@
     "just-clone": "^6.2.0",
     "just-flatten-it": "^5.2.0",
     "just-values": "^2.2.0",
-    "luxon": "^3.4.4",
     "qs-esm": "^8.0.1",
     "rxjs": "^7.8.1",
     "snake-camel-types": "^1.0.1",
@@ -43,6 +46,7 @@
   },
   "files": [
     "README.md",
+    "README.en.md",
     "LICENSE",
     "*.d.ts",
     "consts",

package/request-navvy/calendar/event.d.ts

@@ -6,12 +6,18 @@ export declare class BXRestNavvyRestCalendarEvent {
     add(param: iBXRestCalendarEventAddParam): import("../../services/navvy").NavvySimple<number, number, iBXRestCalendarEventAddParam | undefined>;
     /** Добавляет событие в календарь */
     delete(param: iBXRestCalendarEventDeleteParam): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestCalendarEventDeleteParam | undefined>;
-    get: ((param: iBXRestCalendarEventGetParam) => import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetParam | undefined>) & {
-        /** Метод получает список будущих событий */
-        nearest: (param: iBXRestCalendarEventGetNearestParam) => import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetNearestParam | undefined>;
+    get: ((param: iBXRestCalendarEventGetParam, dateTimeFormat?: string) => import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetParam | undefined>) & {
+        /** Метод получает список будущих событий. @see get */
+        nearest: (param: iBXRestCalendarEventGetNearestParam, dateTimeFormat?: string) => import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp[], import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer[], iBXRestCalendarEventGetNearestParam | undefined>;
     };
     /** Обновление событие в календарь */
     update(param: iBXRestCalendarEventUpdateParam): import("../../services/navvy").NavvySimple<number, number, iBXRestCalendarEventUpdateParam | undefined>;
-    /** Метод получает информацию о событии календаря по идентификатору */
-    getById(param: iBXRestCalendarEventGetByIdParam): import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp | null, import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetByIdParam | undefined>;
+    /**
+     * Метод получает информацию о событии календаря по идентификатору.
+     *
+     * @param param
+     * @param dateTimeFormat Формат полей с датой и временем в ответе (см. {@link BXRestMapCalendarEvent.getById}).
+     *   Передавайте явно, если формат дат на портале отличается от значения по умолчанию.
+     */
+    getById(param: iBXRestCalendarEventGetByIdParam, dateTimeFormat?: string): import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswerHttp | null, import("../../typification/rest/calendar").iBXRestCalendarEventGetAnswer, iBXRestCalendarEventGetByIdParam | undefined>;
 }

package/request-navvy/calendar/section.d.ts

@@ -2,8 +2,14 @@ import { iBXRestCalendarSectionGetParam, iBXRestCalendarSectionAddParam, iBXRest
 export declare class BXRestNavvyRestCalendarSection {
     private url;
     private readonly Navvy;
-    /** Возвращает описание разделов, всегда весь список, паганации в методе нет да и не нужна */
-    get(param: iBXRestCalendarSectionGetParam): import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarSectionGetHttp[], import("../../typification/rest/calendar").iBXRestCalendarSectionGet[], iBXRestCalendarSectionGetParam | undefined>;
+    /**
+     * Возвращает описание разделов, всегда весь список, паганации в методе нет да и не нужна.
+     *
+     * @param param
+     * @param dateTimeFormat Формат полей `DATE_CREATE`/`TIMESTAMP_X` в ответе (см. {@link BXRestMapCalendarSection.get}).
+     *   Передавайте явно, если формат дат на портале отличается от значения по умолчанию.
+     */
+    get(param: iBXRestCalendarSectionGetParam, dateTimeFormat?: string): import("../../services/navvy").NavvySimple<import("../../typification/rest/calendar").iBXRestCalendarSectionGetHttp[], import("../../typification/rest/calendar").iBXRestCalendarSectionGet[], iBXRestCalendarSectionGetParam | undefined>;
     /** Добавляет новый раздел */
     add(param: iBXRestCalendarSectionAddParam): import("../../services/navvy").NavvySimple<number, number, iBXRestCalendarSectionAddParam | undefined>;
     /** Удаляет раздел */

package/request-navvy/crm/calllist/index.d.ts

@@ -22,18 +22,22 @@ export declare class BXRestNavvyCrmCallList {
      * Участников можно получить через `items.get()`.
      *
      * @param param Идентификатор списка обзвона.
+     * @param dateTimeFormat Формат поля `DATE_CREATE` в ответе (см. {@link BXRestMapCrmCallList.get}).
+     *   Передавайте явно, если формат дат на портале отличается от значения по умолчанию.
      * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-get.html
      */
-    get(param: iBXRestParamCrmCallListGet): import("../../../services/navvy").NavvySimple<iBXRestCrmCallListHttp, iBXRestCrmCallList, iBXRestParamCrmCallListGet | undefined>;
+    get(param: iBXRestParamCrmCallListGet, dateTimeFormat?: string): import("../../../services/navvy").NavvySimple<iBXRestCrmCallListHttp, iBXRestCrmCallList, iBXRestParamCrmCallListGet | undefined>;
     /**
      * Возвращает списки обзвона с выборкой полей, фильтрацией и сортировкой.
      *
      * Набор полей каждого элемента результата зависит от `SELECT`.
      *
      * @param param Выбираемые поля, фильтр и порядок сортировки.
+     * @param dateTimeFormat Формат поля `DATE_CREATE` в ответе (см. {@link BXRestMapCrmCallList.list}).
+     *   Передавайте явно, если формат дат на портале отличается от значения по умолчанию.
      * @see https://apidocs.bitrix24.ru/api-reference/crm/call-list/crm-calllist-list.html
      */
-    list(param?: iBXRestParamCrmCallListList): import("../../../services/navvy").NavvySimple<Partial<iBXRestCrmCallListHttp>[], Partial<iBXRestCrmCallList>[], iBXRestParamCrmCallListList | undefined>;
+    list(param?: iBXRestParamCrmCallListList, dateTimeFormat?: string): import("../../../services/navvy").NavvySimple<Partial<iBXRestCrmCallListHttp>[], Partial<iBXRestCrmCallList>[], iBXRestParamCrmCallListList | undefined>;
     /**
      * Возвращает справочник статусов обзвона.
      *

package/services/base.d.ts

@@ -1,4 +1,3 @@
-import { DateTimeOptions } from 'luxon';
 /**
  * Преобразует значение в строку
  *
@@ -19,9 +18,34 @@ export declare class ToNumError extends Error {
     toString(): string;
 }
 /**
- * Преобразует значение в дату
+ * Опции для toDate(). Оставлены для обратной совместимости сигнатуры — ранее пробрасывались
+ * в luxon (зона/локаль). Разбор даты теперь не зависит от внешних библиотек и поддерживает
+ * только фиксированные числовые токены (см. parseDateWithFormat), поэтому опции сейчас не используются.
  */
-export declare function toDate(val: number | string | Date, format?: string, opt?: DateTimeOptions, throwError?: boolean): Date;
+export interface ToDateOptions {
+    zone?: string;
+    locale?: string;
+}
+/**
+ * Выводит формат "только дата" из формата даты-и-времени — отрезает время и разделитель перед
+ * ним (например, `'dd.MM.yyyy HH:mm:ss'` → `'dd.MM.yyyy'`). Порядок день/месяц/год у полей
+ * "дата" и "дата-время" на одном портале Bitrix24 всегда согласован — различается только
+ * наличие `HH:mm:ss`, поэтому нет смысла заставлять вызывающего передавать оба формата и
+ * держать их в синхроне вручную.
+ */
+export declare function deriveDateOnlyFormat(dateTimeFormat: string): string;
+/**
+ * Преобразует значение в дату.
+ *
+ * Если передан `format`, но значение ему не соответствует (см. FALLBACK_DATE_FORMATS —
+ * актуально для полей, где Bitrix24 отдаёт дату в формате, настроенном на портале, а не в
+ * том, что захардкожен в маппере), перед тем как считать значение невалидным, делаются ещё
+ * две попытки: другие распространённые форматы Bitrix24, а затем — позиционная эвристика
+ * (см. parseDateHeuristically), которая распознаёт практически любой чисто числовой формат
+ * даты независимо от разделителя. Если приложению точно известен формат конкретного портала,
+ * его стоит передавать явным `format` — это всегда приоритетнее угадывания.
+ */
+export declare function toDate(val: number | string | Date, format?: string, opt?: ToDateOptions, throwError?: boolean): Date;
 /**
  * Преобразует дату в строку с учетом временной зоны
  *

package/typification/rest/calendar/event/get.d.ts

@@ -113,8 +113,8 @@ interface iBXRestCalendarEventGetAnswerRuleHttp extends iBXRestCalendarEventGetA
     '~UNTIL': string;
 }
 interface iBXRestCalendarEventGetAnswerRule extends iBXRestCalendarEventGetAnswerRuleBase {
-    UNTIL: Date;
-    '~UNTIL': Date;
+    UNTIL: Date | null;
+    '~UNTIL': Date | null;
 }
 interface iBXRestCalendarEventGetAnswerRuleBase {
     FR?: 'FR';