bx-rest 0.6.7 → 0.8.1

package/functions/errorHandler.d.ts

@@ -0,0 +1,10 @@
+export declare function CatchError(options?: {
+    rethrow?: boolean;
+    defaultValue?: any;
+}): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+export declare function formatError(info: {
+    message: string;
+    args?: any[];
+    error?: string;
+    stack?: string;
+}): string;

package/map/im/recent.d.ts

@@ -1,6 +1,7 @@
-import { iBXRestImDialogRecentGet, iBXRestImDialogRecentGetHttp } from '../../typification/rest/im/dialog/recent/get';
+import { iBXRestImDialogRecentGet, iBXRestImDialogRecentGetChatChatDataHttp, iBXRestImDialogRecentGetChatUserDataBase, iBXRestImDialogRecentGetHttp } from '../../typification/rest/im/dialog/recent/get';
 import { iBXRestImDialogRecentList, iBXRestImDialogRecentListHttp } from '../../typification/rest/im/dialog/recent/list';
 export declare class BXRestMapImRecent {
     static get(value: iBXRestImDialogRecentGetHttp[] | undefined): iBXRestImDialogRecentGet[] | undefined;
     static list(value: iBXRestImDialogRecentListHttp | undefined): iBXRestImDialogRecentList | undefined;
+    static isIBXRestImDialogRecentGetChatChatDataHttp(item: iBXRestImDialogRecentGetChatChatDataHttp | iBXRestImDialogRecentGetChatUserDataBase): item is iBXRestImDialogRecentGetChatChatDataHttp;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-rest",
-  "version": "0.6.7",
+  "version": "0.8.1",
   "description": "Bitrix24 REST API client angular, vue or typescript",
   "keywords": [
     "bitrix",

package/request-navvy/pull/config.d.ts

@@ -9,5 +9,9 @@ export declare class BXRestNavvyPullConfig {
     };
     private Navvy;
     static public: BXRestMapPullChannelPublic;
+    /**
+     * @experimental
+     * Этот метод находится в процессе тестирования и может измениться.
+     */
     get(): import("../../services/navvy/navvy-simple").NavvySimple<iBXRestPullConfigGetHttp, iBXRestPullConfigGet, undefined>;
 }

package/services/base.d.ts

@@ -1,13 +1,65 @@
 import { DateTimeOptions } from 'luxon/src/datetime';
+/**
+ * Преобразует значение в строку
+ *
+ * @param val
+ * @param throwError
+ */
 export declare function toStr(val: any, throwError?: boolean): string;
+/**
+ * Преобразует значение в число
+ */
 export declare function toNum(val: any, throwError?: boolean, defValue?: number): number;
+/**
+ * Кастомный тип ошибки для числовых преобразований
+ */
+export declare class ToNumError extends Error {
+    readonly value: any;
+    constructor(value: any);
+    toString(): string;
+}
+/**
+ * Преобразует значение в дату
+ */
 export declare function toDate(val: number | string | Date, format?: string, opt?: DateTimeOptions, throwError?: boolean): Date;
+/**
+ * Преобразует дату в строку с учетом временной зоны
+ *
+ * @param date
+ * @param throwError
+ */
 export declare function toISOStringWithTimezone(date: Date, throwError?: boolean): string;
+/**
+ * Преобразует значение в булево значение
+ *
+ * @param val
+ * @param throwError
+ */
 export declare function toBool(val: any, throwError?: boolean): boolean;
+/**
+ * Преобразует булево значение в 'Y' или 'N'
+ *
+ * @param val
+ */
 export declare function toBXYorN(val: boolean): string;
 export declare function getBaseUrlHttps(url: string, component?: boolean): string;
+/**
+ * Обрезает URL (удаляет протокол)
+ *
+ * @param url
+ */
 export declare function cropUrl(url: string): string;
+/**
+ * Преобразует файл в base64
+ *
+ * @param file
+ */
 export declare function getBase64File(file: File): Promise<string>;
+/**
+ * Получить файл в формате base64 с разбивкой на заголовок и данные
+ *
+ * @param file
+ */
 export declare function getBase64FileLikeStr(file: File): Promise<{
     header: string;
     val: string;

package/services/http/HttpBX.d.ts

@@ -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>;
+    serializeBitrixParams(obj: any, prefix?: string): string;
     httpGet<T>(url: string, params?: any): Observable<T | undefined>;
     getNameMethod(arr: string[]): string;
 }

package/typification/rest/im/dialog/recent/get.d.ts

@@ -92,19 +92,24 @@ export interface iBXRestImDialogRecentGetUserDataBase {
     /** Дата, когда пользователь отошел от компьютера, или false */
     idle: string | false;
 }
-export interface iBXRestImDialogRecentGetChatData extends iBXRestImDialogRecentGetChatDataBase {
+export interface iBXRestImDialogRecentGetChatChatData extends iBXRestImDialogRecentGetChatChatDataBase {
     /** Идентификатор чата */
     id: number;
     /** Дата создания чата */
     date_create: Date;
 }
-export interface iBXRestImDialogRecentGetChatDataHttp extends iBXRestImDialogRecentGetChatDataBase {
+export interface iBXRestImDialogRecentGetChatChatDataHttp extends iBXRestImDialogRecentGetChatChatDataBase {
     /** Идентификатор чата */
     id: string;
     /** Дата создания чата */
     date_create: string;
 }
-export interface iBXRestImDialogRecentGetChatDataBase {
+export type iBXRestImDialogRecentGetChatDataBase = iBXRestImDialogRecentGetChatChatDataBase | iBXRestImDialogRecentGetChatUserDataBase;
+export interface iBXRestImDialogRecentGetChatChatDataBase {
+    background_id: null;
+    text_field_enabled: true;
+}
+export interface iBXRestImDialogRecentGetChatUserDataBase {
     /** Название чата */
     title: string;
     /** Идентификатор владельца чата */
@@ -136,21 +141,20 @@ export interface iBXRestImDialogRecentGet extends iBXRestImDialogRecentGetBase {
     /** Объект пользователя, если type === 'user' */
     user?: iBXRestImDialogRecentGetUserData;
     /** Объект чата, если type === 'chat' */
-    chat?: iBXRestImDialogRecentGetChatData;
+    chat?: iBXRestImDialogRecentGetChatChatData | iBXRestImDialogRecentGetChatUserDataBase;
 }
 export interface iBXRestImDialogRecentGetHttp extends iBXRestImDialogRecentGetBase {
     /** Дата последнего сообщения */
     date_update: string;
     /**
      * Объект пользователя, если type === 'user'
-     * Посмотреть бы в глаза тому человеку что эту хуету сделала, ну тип {id: 0} это ахуй
-     *
+     * Посмотреть бы в глаза тому человеку, что эту хуету сделала, ну тип {id: 0} это ахуй
      */
     user?: iBXRestImDialogRecentGetUserDataHttp | {
         id: 0;
     };
     /** Объект чата, если type === 'chat' */
-    chat?: iBXRestImDialogRecentGetChatDataHttp;
+    chat?: iBXRestImDialogRecentGetChatChatDataHttp | iBXRestImDialogRecentGetChatUserDataBase;
 }
 export interface iBXRestImDialogRecentGetBase {
     /** Идентификатор записи: число для пользователя, строка "chatXXX" для чата */

package/typification/settings.d.ts

@@ -1,11 +1,11 @@
 export interface iBXRestSettings {
     auth: {
-        source: 'cookies' | 'localStorage' | 'off';
+        source: 'cookies' | 'localStorage' | 'off' | (() => string);
         key: 'auth' | 'sessid' | string;
     };
     urls: {
         source: 'string' | 'localStorage';
-        key: string;
+        key: string | 'OAuth2';
         additional_part?: string;
     };
 }