szdl-utils-kit 0.2.28 → 0.2.30

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

@@ -1,177 +1,177 @@
-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>,
-};
-
-type TUpdateList = {
-	method: string,
-	name: string,
-	list: {
-		id: string | number,
-		fields: {
-			[key: string]: {
-				oldValue: string | number | string[] | number[],
-				newValue: string | number | string[] | number[],
-			}
-		}
-	}[]
-}[];
-
-type TCommand = {
-	method: string,
-	params:TCommandParams,
-}
-
-declare class BxBoot{
-	/** В конструктор передаются константы приложения appConst */
-	constructor(appConst: {
-		appName: string,
-		appNameEng: string,
-		pathApp: string,
-		zip: string,
-		chatBotLogo: string,
-		entity: { key: string, name: string }[],
-	}): void;
-
-	/** Доменное имя портала */
-	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 }[],
-	};
-
-	/** Информация о текущем пользователе */
-	userInfo: Record<string, unknown>;
-
-	/** Информация о встройках */
-	placeData: Record<string, unknown>[];
-
-	/** Информация о текущем месте встройки */
-	placeInfo: {
-		placement: string;
-		options: Record<string, string>;
-	};
-
-
-
-	/** Метод инициализации библиотеки rest api BX24 */
-	init(): Promise<boolean>;
-
-	/** Получение\изменение опций юзера.
-	 *
-	 * Если передан '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 в который передается статус загрузки данных в процентах
-	 */
-	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>;
-
-	/** Удаление чат-бота */
-	unRegBot(id: number|string): Promise<unknown | boolean>;
-
-	/**
-	 * Получение списка логирования
-	 * @param progressCall - коллбэк
-	*/
-	async getLoggerList(progressCall: (data:{ percent: number })=>void): Promise<{[key]: any}[]>
-}
-
+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>,
+};
+
+type TUpdateList = {
+	method: string,
+	name: string,
+	list: {
+		id: string | number,
+		fields: {
+			[key: string]: {
+				oldValue: string | number | string[] | number[],
+				newValue: string | number | string[] | number[],
+			}
+		}
+	}[]
+}[];
+
+type TCommand = {
+	method: string,
+	params:TCommandParams,
+}
+
+declare class BxBoot{
+	/** В конструктор передаются константы приложения appConst */
+	constructor(appConst: {
+		appName: string,
+		appNameEng: string,
+		pathApp: string,
+		zip: string,
+		chatBotLogo: string,
+		entity: { key: string, name: string }[],
+	}): void;
+
+	/** Доменное имя портала */
+	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 }[],
+	};
+
+	/** Информация о текущем пользователе */
+	userInfo: Record<string, unknown>;
+
+	/** Информация о встройках */
+	placeData: Record<string, unknown>[];
+
+	/** Информация о текущем месте встройки */
+	placeInfo: {
+		placement: string;
+		options: Record<string, string>;
+	};
+
+
+
+	/** Метод инициализации библиотеки rest api BX24 */
+	init(): Promise<boolean>;
+
+	/** Получение\изменение опций юзера.
+	 *
+	 * Если передан '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 в который передается статус загрузки данных в процентах
+	 */
+	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>;
+
+	/** Удаление чат-бота */
+	unRegBot(id: number|string): Promise<unknown | boolean>;
+
+	/**
+	 * Получение списка логирования
+	 * @param progressCall - коллбэк
+	*/
+	async getLoggerList(progressCall: (data:{ percent: number })=>void): Promise<{[key]: any}[]>
+}
+
 export default BxBoot;

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

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

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

@@ -1,44 +1,44 @@
-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 }:{
-		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
-}
-
+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 }:{
+		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
+}
+
 export default BxLogger;

package/dist/types/index.d.ts

@@ -1,15 +1,15 @@
-import Batch from "./batch";
-import BxBoot from "./bx-boot";
-import BxHelper from "./bx-helper";
-import BxLogger from './bx-logger';
-
-declare function tempus():{
-	format();
-	calc();
-	lang();
-	valid();
-	between();
-	generate();
-};
-
+import Batch from "./batch";
+import BxBoot from "./bx-boot";
+import BxHelper from "./bx-helper";
+import BxLogger from './bx-logger';
+
+declare function tempus():{
+	format();
+	calc();
+	lang();
+	valid();
+	between();
+	generate();
+};
+
 export { Batch, BxBoot, BxHelper, BxLogger, tempus }

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "szdl-utils-kit",
-  "description": "utils-kit library",
-  "private": false,
-  "version": "0.2.28",
-  "type": "module",
-  "author": "Stanislav Ovv",
-  "license": "BSD",
-  "module": "./dist/index.js",
-  "main": "./dist/index.umd.cjs",
-  "types": "./dist/types/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.umd.cjs"
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "keywords": [
-    "szdl",
-    "utils",
-    "szdl-utils-kit"
-  ],
-  "scripts": {
-    "dev": "vite --host",
-    "watch": "vite build --watch",
-    "build": "vite build",
-    "preview": "vite preview",
-    "pub": "npm version patch && npm publish"
-  },
-  "devDependencies": {
-    "vite": "^4.4.5",
-    "vite-plugin-dts": "^3.6.0",
-    "vite-plugin-static-copy": "^0.17.0"
-  },
-  "dependencies": {
-    "tempusjs": "^0.2.18"
-  }
-}
+{
+  "name": "szdl-utils-kit",
+  "description": "utils-kit library",
+  "private": false,
+  "version": "0.2.30",
+  "type": "module",
+  "author": "Stanislav Ovv",
+  "license": "BSD",
+  "module": "./dist/index.js",
+  "main": "./dist/index.umd.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.umd.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "szdl",
+    "utils",
+    "szdl-utils-kit"
+  ],
+  "scripts": {
+    "dev": "vite --host",
+    "watch": "vite build --watch",
+    "build": "vite build",
+    "preview": "vite preview",
+    "pub": "npm version patch && npm publish"
+  },
+  "devDependencies": {
+    "vite": "^4.4.5",
+    "vite-plugin-dts": "^3.6.0",
+    "vite-plugin-static-copy": "^0.17.0"
+  },
+  "dependencies": {
+    "tempusjs": "^0.2.18"
+  }
+}