szdl-utils-kit 0.2.28 → 0.2.29

package/Readme.md

@@ -1,162 +1,168 @@
-## ***UTILS-KIT***
-### **Подключение и использование**
-```sh
-npm i szdl-utils-kit
-```
-```JavaScript
-import { Batch, BxBoot, tempus } from 'szdl-utils-kit';
-```
-
-### ***{ Batch }***
-Утилита пакетного запроса данных из B24
-
-```JavaScript
-import { Batch } from 'szdl-utils-kit';
-
-const rest = new Batch(BX24.callBatch);
-```
-
-#### **Свойства**
-<b><i>serial</i></b> - флаг режима передачи <br>
-
-#### **Методы**
-<b><i>setSerial()</i></b> - установка последовательного режима <br>
-<b><i>setParallel()</i></b> - установка параллельного режима <br>
-<b><i>stop()</i></b> - принудительно остановить выгрузку данных <br>
-<b><i>batch(commandList, progressCall)</i></b> - запрос данных <br>
-<b><i>batchTotalCount(commandList, progressCall)</i></b> - запрос количества элементов по сущностям <br>
-
-
-### ***{ BxBoot }***
-Утилита Promise-обертка над некоторыми методами BX24.
-
-#### **Свойства**
-<b><i>domain</i></b> - доменное имя портала <br>
-<b><i>isAdmin</i></b> - флаг проверки текущего пользователя на админа <br>
-
-<b><i>appInfo</i></b> - Информация о приложении
-```TypeScript
-type 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
-	};
-```
-<b><i>appConst</i></b> - Параметры приложения
-```TypeScript
-type appConst = {
-		appName: string,
-		appNameEng: string,
-		pathApp: string,
-		zip: string,
-		chatBotLogo: string,
-		entity: { key: string, name: string }[],
-	};
-```
-<b><i>userInfo</i></b> - Информация о текущем пользователе
-<b><i>placeData</i></b> - Информация о встройках
-
-<b><i>placeInfo</i></b> - Информация о текущем месте встройки
-```TypeScript
-type placeInfo = {
-		placement: string;
-		options: Record<string, string>;
-	};
-```
-
-#### **Методы**
-<b><i>init()</i></b> - Метод инициализации библиотеки rest api BX24
-```TypeScript
-init(): Promise<boolean>;
-```
-
-<b><i>userOption(key, ?value)</i></b> - Получение\изменение опций юзера.
- * Если передан 'key', то возвращает опцию по ключу. <br>
- * Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.
-```TypeScript
-userOption(key: string, value?: string | number)
-```
-
-<b><i>call({ method, params })</i></b> - Вызывает указанный метод REST-сервиса с указанными параметрам
-```TypeScript
-call({ method, params }: TCommand): Promise<unknown[] | boolean>;
-type TCommand = {
-	method: string,
-	params: Record<string, unknown> | {
-		select?: string[],
-		filter?: Record<string, string | string[]>,
-	} | {
-		id?: string,
-		params?: Record<string, string>,
-		fields?: Record<string, unknown>,
-	}
-}
-```
-
-<b><i>batch(commandList, ?progressCall)</i></b> - Пакетный запрос данных
- * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
- * progressCall - принимает callback в который передается статус загрузки данных в процентах
-```TypeScript
-batch(
-		commandList: Record<string, TCommand>,
-		progressCall?: (data:{ percent: number })=>void
-	): Promise<Record<string, unknown[]> | boolean>;
-```
-
-<b><i>batchTotalCount(commandList, ?progressCall)</i></b> - Пакетный запрос количества элементов по запрошенным сущностям
- * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
- * progressCall - принимает callback в который передается статус загрузки данных в процентах
-```TypeScript
-batchTotalCount(
-		commandList: Record<string, TCommand>,
-		progressCall?: (data:{ percent: number })=>void
-	): Promise<Record<string, number> | boolean>;
-```
-
-<b><i>getPlacement()</i></b> - Запрос данных о местах встройки приложения
-```TypeScript
-getPlacement(): Promise<unknown[] | boolean>;
-```
-
-<b><i>placementBind(place)</i></b> - Встройка приложения в place
- * place - индификатор места встройки
-```TypeScript
-placementBind(place: string): void;
-```
-
-<b><i>placementUnBind(place)</i></b> - Отвязка встройки из place
- * place - индификатор места встройки
-```TypeScript
-placementUnBind(place: string): Promise<boolean>;
-```
-
-<b><i>getBotList()</i></b> - Получение списка чат-ботов
-```TypeScript
-getBotList(): Promise<unknown[] | boolean>;
-```
-
-<b><i>regBot({ code, type, name })</i></b> - Регистрация чат-бота
- * code - Строковой идентификатор бота, уникальный в рамках вашего приложения
- * type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
- * name - Имя чат-бота
-```TypeScript
-regBot({ code, type, name }:{
-		code: string, type: string, name: string
-	}): Promise<unknown | boolean>;
-```
-
-<b><i>unRegBot(id)</i></b> - Удаление чат-бота
-```TypeScript
-unRegBot(id: number|string): Promise<unknown | boolean>;
-```
-
-### ***{ tempus }***
-Утилита для работы с датами и временем, [документация](https://habr.com/ru/articles/204162/)
+## ***UTILS-KIT***
+### **Подключение и использование**
+```sh
+npm i szdl-utils-kit
+```
+```JavaScript
+import { Batch, BxBoot, tempus } from 'szdl-utils-kit';
+```
+
+### ***{ Batch }***
+Утилита пакетного запроса данных из B24
+
+```JavaScript
+import { Batch } from 'szdl-utils-kit';
+
+const rest = new Batch(BX24.callBatch);
+```
+
+#### **Свойства**
+<b><i>serial</i></b> - флаг режима передачи <br>
+
+#### **Методы**
+<b><i>setSerial()</i></b> - установка последовательного режима <br>
+<b><i>setParallel()</i></b> - установка параллельного режима <br>
+<b><i>stop()</i></b> - принудительно остановить выгрузку данных <br>
+<b><i>batch(commandList, progressCall)</i></b> - запрос данных <br>
+<b><i>batchTotalCount(commandList, progressCall)</i></b> - запрос количества элементов по сущностям <br>
+
+
+### ***{ BxBoot }***
+Утилита Promise-обертка над некоторыми методами BX24.
+
+#### **Свойства**
+<b><i>domain</i></b> - доменное имя портала <br>
+<b><i>isAdmin</i></b> - флаг проверки текущего пользователя на админа <br>
+
+<b><i>appInfo</i></b> - Информация о приложении
+```TypeScript
+type 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
+	};
+```
+<b><i>appConst</i></b> - Параметры приложения
+```TypeScript
+type appConst = {
+		appName: string,
+		appNameEng: string,
+		pathApp: string,
+		zip: string,
+		chatBotLogo: string,
+		entity: { key: string, name: string }[],
+	};
+```
+<b><i>userInfo</i></b> - Информация о текущем пользователе
+<b><i>placeData</i></b> - Информация о встройках
+
+<b><i>placeInfo</i></b> - Информация о текущем месте встройки
+```TypeScript
+type placeInfo = {
+		placement: string;
+		options: Record<string, string>;
+	};
+```
+
+#### **Методы**
+<b><i>init()</i></b> - Метод инициализации библиотеки rest api BX24
+```TypeScript
+init(): Promise<boolean>;
+```
+
+<b><i>userOption(key, ?value)</i></b> - Получение\изменение опций юзера.
+ * Если передан 'key', то возвращает опцию по ключу. <br>
+ * Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.
+```TypeScript
+userOption(key: string, value?: string | number)
+```
+
+<b><i>call({ method, params })</i></b> - Вызывает указанный метод REST-сервиса с указанными параметрам
+```TypeScript
+call({ method, params }: TCommand): Promise<unknown[] | boolean>;
+type TCommand = {
+	method: string,
+	params: Record<string, unknown> | {
+		select?: string[],
+		filter?: Record<string, string | string[]>,
+	} | {
+		id?: string,
+		params?: Record<string, string>,
+		fields?: Record<string, unknown>,
+	}
+}
+```
+
+<b><i>batch(commandList, ?progressCall)</i></b> - Пакетный запрос данных
+ * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
+ * progressCall - принимает callback в который передается статус загрузки данных в процентах
+```TypeScript
+batch(
+		commandList: Record<string, TCommand>,
+		progressCall?: (data:{ percent: number })=>void
+	): Promise<Record<string, unknown[]> | boolean>;
+```
+
+<b><i>batchTotalCount(commandList, ?progressCall)</i></b> - Пакетный запрос количества элементов по запрошенным сущностям
+ * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
+ * progressCall - принимает callback в который передается статус загрузки данных в процентах
+```TypeScript
+batchTotalCount(
+		commandList: Record<string, TCommand>,
+		progressCall?: (data:{ percent: number })=>void
+	): Promise<Record<string, number> | boolean>;
+```
+
+<b><i>getPlacement()</i></b> - Запрос данных о местах встройки приложения
+```TypeScript
+getPlacement(): Promise<unknown[] | boolean>;
+```
+
+<b><i>placementBind(place)</i></b> - Встройка приложения в place
+ * place - индификатор места встройки
+```TypeScript
+placementBind(place: string): void;
+```
+
+<b><i>placementUnBind(place)</i></b> - Отвязка встройки из place
+ * place - индификатор места встройки
+```TypeScript
+placementUnBind(place: string): Promise<boolean>;
+```
+
+<b><i>getBotList()</i></b> - Получение списка чат-ботов
+```TypeScript
+getBotList(): Promise<unknown[] | boolean>;
+```
+
+<b><i>regBot({ code, type, name })</i></b> - Регистрация чат-бота
+ * code - Строковой идентификатор бота, уникальный в рамках вашего приложения
+ * type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
+ * name - Имя чат-бота
+```TypeScript
+regBot({ code, type, name }:{
+		code: string, type: string, name: string
+	}): Promise<unknown | boolean>;
+```
+
+<b><i>unRegBot(id)</i></b> - Удаление чат-бота
+```TypeScript
+unRegBot(id: number|string): Promise<unknown | boolean>;
+```
+
+### ***{ tempus }***
+Утилита для работы с датами и временем, [документация](https://habr.com/ru/articles/204162/)
+
+### **Инструкция по обновлению npm-пакета**
+- вносим изменения в проект
+- собираем библиотеку в папке dist `npm run build`
+- с помощью `npm login` заходим в аккаунт (вводим логин/пароль, затем получаем временный пароль на почту support@sozdavatel.ru, и вводим его)
+- публикуем библиотеку `npm run pub` (счётчик версии автоматически увеличится, можно указать вручную)