szdl-utils-kit 0.2.30 → 0.3.5

package/dist/types/bx-boot.d.ts

@@ -1,177 +1,132 @@
-type TAppConst = {
-	appName: string,
-	appNameEng: string,
-	pathApp: string,
-	zip: string,
-	chatBotLogo: string,
-	entity: { key: string, name: string }[],
-}
-type UserOptionReturnType<T> = T extends undefined ? string | number : void;
-
-type TCommandParams = Record<string, unknown> | {
-	select?: string[],
-	filter?: Record<string, string | string[]>,
-} | {
-	id?: string,
-	params?: Record<string, string>,
-	fields?: Record<string, unknown>,
+import type {
+	TCommand,
+	TCommandList,
+	TBatchResult,
+	TBatchProgressCallback,
+	TBatchLimitCallback,
+} from './batch';
+import type BxLogger from './bx-logger';
+
+type BxAppEntity = {
+	key: string;
+	name: string;
+};
+
+type BxAppConst = {
+	appName: string;
+	pathApp: string;
+	appNameEng?: string;
+	zip?: string;
+	chatBotLogo?: string;
+	entity?: BxAppEntity[];
 };
 
-type TUpdateList = {
-	method: string,
-	name: string,
-	list: {
-		id: string | number,
-		fields: {
-			[key: string]: {
-				oldValue: string | number | string[] | number[],
-				newValue: string | number | string[] | number[],
-			}
+type BxUserOptionReturn<T> = T extends undefined ? string | number | undefined : void;
+
+type UpdateListChange = {
+	id: string | number;
+	fields: Record<
+		string,
+		{
+			oldValue: string | number | string[] | number[];
+			newValue: string | number | string[] | number[];
 		}
-	}[]
-}[];
+	>;
+};
 
-type TCommand = {
-	method: string,
-	params:TCommandParams,
-}
+type UpdateListItem = {
+	method: string;
+	name: string;
+	list: UpdateListChange[];
+};
 
-declare class BxBoot{
-	/** В конструктор передаются константы приложения appConst */
-	constructor(appConst: {
-		appName: string,
-		appNameEng: string,
-		pathApp: string,
-		zip: string,
-		chatBotLogo: string,
-		entity: { key: string, name: string }[],
-	}): void;
+type UpdateList = UpdateListItem[];
+
+type BatchOptions = {
+	updateList?: UpdateList;
+	errorCall?: (errors: Record<string, string>) => void;
+	limitCommandSerial?: number;
+	limitCall?: TBatchLimitCallback;
+};
+
+type LoggerStub = {
+	start: (...args: unknown[]) => void;
+	stop: (...args: unknown[]) => void;
+	getEntityList: (...args: unknown[]) => void;
+};
+
+declare class BxBoot {
+	constructor(appConst: BxAppConst);
 
 	/** Доменное имя портала */
 	domain: string;
+	/** Флаг администратора для текущего пользователя */
 	isAdmin: boolean;
-
-	/** Информация о приложении */
-	appInfo: {
-		ID: number,
-		CODE: string,
-		VERSION: number,
-		STATUS: string,
-		INSTALLED: boolean,
-		PAYMENT_EXPIRED: string,
-		DAYS: null | number,
-		LANGUAGE_ID: string,
-		LICENSE: string,
-		LICENSE_TYPE: string,
-		LICENSE_FAMILY: string
-	};
-
-	/** Параметры приложения */
-	appConst: {
-		appName: string,
-		appNameEng: string,
-		pathApp: string,
-		zip: string,
-		chatBotLogo: string,
-		entity: { key: string, name: string }[],
-	};
-
+	/** Информация о приложении, предоставленная Bitrix24 */
+	appInfo: Record<string, unknown> | null;
+	/** Константы приложения, переданные в конструктор */
+	appConst: BxAppConst;
 	/** Информация о текущем пользователе */
-	userInfo: Record<string, unknown>;
-
-	/** Информация о встройках */
-	placeData: Record<string, unknown>[];
-
+	userInfo: Record<string, unknown> | null;
+	/** Список существующих встройкок приложения */
+	placeData: Array<Record<string, unknown>> | null;
 	/** Информация о текущем месте встройки */
-	placeInfo: {
-		placement: string;
-		options: Record<string, string>;
-	};
+	placeInfo: { placement: string; options: Record<string, string> } | null;
+	/** Экземпляр логгера или заглушка, если логирование отключено */
+	logger: false | BxLogger | LoggerStub;
 
+	/** Инициализация SDK BX24 */
+	init(): Promise<boolean>;
 
+	/** Получение или установка пользовательской опции */
+	userOption<T extends string | number | undefined>(key: string, value?: T): BxUserOptionReturn<T>;
 
-	/** Метод инициализации библиотеки rest api BX24 */
-	init(): Promise<boolean>;
+	/** Вызов REST-метода Bitrix24 */
+	call(params: {
+		method: string;
+		params?: Record<string, unknown>;
+		updateList?: UpdateList;
+	}): Promise<unknown | false>;
 
-	/** Получение\изменение опций юзера.
-	 *
-	 * Если передан 'key', то возвращает опцию по ключу. <br>
-	 * Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.
-	 */
-	userOption<T extends string | number | undefined>(key: string, value?: T): UserOptionReturnType<T>
-
-
-	/** Вызывает указанный метод REST-сервиса с указанными параметрам */
-	call({ method, params, updateList}: {
-		method: string,
-		params: TCommandParams,
-		updateList: TUpdateList,
-	 }): Promise<unknown[] | boolean>;
-
-	/**
-	 * Пакетный запрос данных
-	 * @param commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
-	 * @param progressCall - принимает callback, в котором возвращается передается статус загрузки данных в процентах
-	 * @param updateList - лист update данных, которые нужно записать в сессию логгера,
-	 * для возможности отката к старым значениям
-	 * @param errorCall - принимает callback, в котором возвращается объект ошибок
-	 * @param limitCommandSerial - лимит команд при котором происходит переключение батча в последовательный режим по дефолту 50
-	 */
+	/** Выполнение пакетного списка запросов */
 	batch(
-			commandList: Record<string, TCommand>,
-			progressCall?: (data:{ percent: number })=>void,
-			param:{
-				updateList: TUpdateList,
-				errorCall: (errors)=>void,
-				limitCommandSerial: number,
-			}
-		): Promise<Record<string, unknown[]> | boolean>;
-
-	/**
-	 * Пакетный запрос количества элементов по запрошенным сущностям
-	 * @param commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
-	 * @param progressCall - принимает callback в который передается статус загрузки данных в процентах
-	 */
+		commandList: TCommandList,
+		progressCall?: TBatchProgressCallback,
+		options?: BatchOptions
+	): Promise<TBatchResult | false>;
+
+	/** Получение количества элементов по списку запросов */
 	batchTotalCount(
-			commandList: Record<string, TCommand>,
-			progressCall?: (data:{ percent: number })=>void
-		): Promise<Record<string, number> | boolean>;
-
-	/** Запрос данных о местах встройки приложения */
-	getPlacement(): Promise<unknown[] | boolean>;
-
-	/** Встройка приложения в place
-	 *
-	 * @param place - индификатор места встройки
-	 */
-	placementBind(place: string): void;
-
-	/** Отвязка встройки из place
-	 *
-	 * @param place - индификатор места встройки
-	*/
-	placementUnBind(place: string): Promise<boolean>;
-
-	/** Получение списка чат-ботов */
-	getBotList(): Promise<unknown[] | boolean>;
-
-	/** Регистрация чат-бота
-	 * @param code - Строковой идентификатор бота, уникальный в рамках вашего приложения
-	 * @param type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
-	 * @param name - Имя чат-бота
-	 */
-	regBot({ code, type, name }:{
-		code: string, type: string, name: string
-	}): Promise<unknown | boolean>;
+		commandList: TCommandList,
+		progressCall?: TBatchProgressCallback,
+		options?: BatchOptions
+	): Promise<TBatchResult | false>;
+
+	/** Получение информации о местах встройки приложения */
+	getPlacement(): Promise<unknown[] | false>;
+
+	/** Привязка приложения к указанному месту встройки */
+	placementBind(place: string | string[], userId?: number | string): Promise<void>;
+
+	/** Отвязка приложения от места встройки */
+	placementUnBind(place: string | string[], handlerUrl?: string): Promise<void>;
+
+	/** Проверка и актуализация существующих встройкок приложения */
+	placementCheck(): Promise<void>;
+
+	/** Получение списка зарегистрированных чат-ботов */
+	getBotList(): Promise<unknown[] | false>;
+
+	/** Регистрация чат-бота */
+	regBot(params: { code?: string; type?: string; name?: string }): Promise<unknown | false>;
 
 	/** Удаление чат-бота */
-	unRegBot(id: number|string): Promise<unknown | boolean>;
+	unRegBot(id: number | string): Promise<unknown | false>;
 
-	/**
-	 * Получение списка логирования
-	 * @param progressCall - коллбэк
-	*/
-	async getLoggerList(progressCall: (data:{ percent: number })=>void): Promise<{[key]: any}[]>
+	/** Получение списка записей логгера */
+	getLoggerList(progressCall?: TBatchProgressCallback): Promise<unknown>;
 }
 
+export type { BxAppConst, UpdateList, UpdateListItem };
+
 export default BxBoot;

package/dist/types/bx-helper.d.ts

@@ -1,28 +1,22 @@
-declare class BxHelper{
+declare class BxHelper {
 	/** Уникальная 8-символьная хэш-строка */
-	get hash(): string
+	get hash(): string;
 
-	/** Генератор хеш-кода
-	 * @param length - длина хэш строки
-	*/
-	createHash(length:number):string
+	/** Генератор хеша указанной длины */
+	createHash(length?: number): string;
 
-	/** Фильтр часто запускаемых действий
-	 * @param keyTimer - уникальный ключ таймера
-	 * @param duration - время задержки для срабатывания action
-	 * @param action - действие которое должно отработать
-	*/
-	actionFilter({ keyTimer, duration=10, action }:{
+	/** Debounce-фильтр для часто запускаемых действий */
+	actionFilter(params: {
 		keyTimer: string;
-		duration: number;
-		action: ()=>void;
-	}):void
+		duration?: number;
+		action?: () => void;
+	}): void;
 
-	/** Включение режима NO-SLEEP */
-	noSleep(): void
+	/** Активация режима NO-SLEEP через скрытое видео */
+	noSleep(): Promise<void>;
 
-	/** Скачать данные в JSON-файл */
-	downloadFileJson(data, filename:string ): void
+	/** Выгрузка данных в JSON-файл */
+	downloadFileJson(data: unknown, filename: string): void;
 }
 
-export default BxHelper
+export default BxHelper;

package/dist/types/bx-logger.d.ts

@@ -1,44 +1,41 @@
+type LoggerType = 'call' | 'batch' | 'batch-total-count';
+
+type LoggerData =
+	| {
+			method: string;
+			params: Record<string, unknown>;
+	  }
+	| {
+			commandList: Record<string, unknown>;
+	  };
+
+type LoggerStopStatus = 'success' | 'fail' | 'fail-runtime';
+
 declare class BxLogger {
 	/** Очистка хранилища элементов старше 'N' месяцев */
 	periodClear: number;
 
 	/** Инициализация логгера */
-	async init(): Promise<boolean>;
-
-	/** Старт сессии логгера
-	 * @param type - тип логирования
-	 * @param data - данные для сохранения сессии логирования
-	 * @return - генерирует уникальный ключ сессии логирования в виде строки
-	 */
-	start({ type, data }:{
-		type: 'call'|'batch'|'batch-total-count';
-		data: {
-			method: string,
-			params: { [key]: any }
-		}|{ commandList: { [key]: any } };
-	}):string;
-
-	/** Конец сессии логирования
-	 * @param key - уникальный ключ сессии
-	 * @param errorList - массив ошибок
-	 * @param status - статус сессии
-	 * @param answer - служебная информация
-	 */
-	stop({ key, errorList, status, answer }:{
+	init(): Promise<boolean>;
+
+	/** Старт новой сессии логирования */
+	start(params: { type: LoggerType; data: LoggerData }): string | null;
+
+	/** Остановка сессии логирования */
+	stop(params: {
 		key: string;
-		errorList: any[];
-		status: 'success'|'fail'|'fail-runtime';
-		answer: { [key]: unknown };
-	}):void
-
-	/**
-	 * Получение списка логирования
-	 * @param progressCall - коллбэк
-	*/
-	async getEntityList(progressCall: (data:{ percent: number })=>void): Promise<{[key]: any}[]>
-
-	/** Выгрузка всех данных из хранилища в JSON-файл */
-	downAllEntityJson(): void
+		errorList?: Record<string, unknown>;
+		status?: LoggerStopStatus;
+		answer?: Record<string, unknown> | null;
+	}): Promise<void>;
+
+	/** Получение списка записей логгера */
+	getEntityList(progressCall?: (data: { percent: number }) => void): Promise<Record<string, unknown>[]>;
+
+	/** Выгрузка всех записей логгера в JSON */
+	downAllEntityJson(): Promise<boolean>;
 }
 
+export type { LoggerType, LoggerData, LoggerStopStatus };
+
 export default BxLogger;

package/dist/types/index.d.ts

@@ -1,7 +1,8 @@
 import Batch from "./batch";
 import BxBoot from "./bx-boot";
 import BxHelper from "./bx-helper";
-import BxLogger from './bx-logger';
+import BxLogger from "./bx-logger";
+import BackgroundWorker from "./background-worker";
 
 declare function tempus():{
 	format();
@@ -12,4 +13,4 @@ declare function tempus():{
 	generate();
 };
 
-export { Batch, BxBoot, BxHelper, BxLogger, tempus }
+export { Batch, BxBoot, BxHelper, BxLogger, BackgroundWorker, tempus }

package/package.json

@@ -2,7 +2,7 @@
   "name": "szdl-utils-kit",
   "description": "utils-kit library",
   "private": false,
-  "version": "0.2.30",
+  "version": "0.3.5",
   "type": "module",
   "author": "Stanislav Ovv",
   "license": "BSD",