szdl-utils-kit v0.2.25

UTILS-KIT

Подключение и использование

npm i szdl-utils-kit

import { Batch, BxBoot, tempus } from 'szdl-utils-kit';

{ Batch }

Утилита пакетного запроса данных из B24

import { Batch } from 'szdl-utils-kit';

const rest = new Batch(BX24.callBatch);

Свойства

serial - флаг режима передачи

Методы

setSerial() - установка последовательного режима setParallel() - установка параллельного режима stop() - принудительно остановить выгрузку данных batch(commandList, progressCall) - запрос данных batchTotalCount(commandList, progressCall) - запрос количества элементов по сущностям

{ BxBoot }

Утилита Promise-обертка над некоторыми методами BX24.

Свойства

domain - доменное имя портала isAdmin - флаг проверки текущего пользователя на админа

appInfo - Информация о приложении

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
	};

appConst - Параметры приложения

type appConst = {
		appName: string,
		appNameEng: string,
		pathApp: string,
		zip: string,
		chatBotLogo: string,
		entity: { key: string, name: string }[],
	};

userInfo - Информация о текущем пользователе placeData - Информация о встройках

placeInfo - Информация о текущем месте встройки

type placeInfo = {
		placement: string;
		options: Record<string, string>;
	};

Методы

init() - Метод инициализации библиотеки rest api BX24

init(): Promise<boolean>;

userOption(key, ?value) - Получение\изменение опций юзера.

• Если передан 'key', то возвращает опцию по ключу.
• Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.

userOption(key: string, value?: string | number)

call({ method, params }) - Вызывает указанный метод REST-сервиса с указанными параметрам

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>,
	}
}

batch(commandList, ?progressCall) - Пакетный запрос данных

• commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
• progressCall - принимает callback в который передается статус загрузки данных в процентах

batch(
		commandList: Record<string, TCommand>,
		progressCall?: (data:{ percent: number })=>void
	): Promise<Record<string, unknown[]> | boolean>;

batchTotalCount(commandList, ?progressCall) - Пакетный запрос количества элементов по запрошенным сущностям

• commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
• progressCall - принимает callback в который передается статус загрузки данных в процентах

batchTotalCount(
		commandList: Record<string, TCommand>,
		progressCall?: (data:{ percent: number })=>void
	): Promise<Record<string, number> | boolean>;

getPlacement() - Запрос данных о местах встройки приложения

getPlacement(): Promise<unknown[] | boolean>;

placementBind(place) - Встройка приложения в place

• place - индификатор места встройки

placementBind(place: string): void;

placementUnBind(place) - Отвязка встройки из place

• place - индификатор места встройки

placementUnBind(place: string): Promise<boolean>;

getBotList() - Получение списка чат-ботов

getBotList(): Promise<unknown[] | boolean>;

regBot({ code, type, name }) - Регистрация чат-бота

• code - Строковой идентификатор бота, уникальный в рамках вашего приложения
• type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
• name - Имя чат-бота

regBot({ code, type, name }:{
		code: string, type: string, name: string
	}): Promise<unknown | boolean>;

unRegBot(id) - Удаление чат-бота

unRegBot(id: number|string): Promise<unknown | boolean>;

{ tempus }

Утилита для работы с датами и временем, документация