szdl-utils-kit 0.2.25 → 0.2.27

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/Readme.md +161 -161
  2. package/package.json +41 -41
  3. package/dist/index.js +0 -1567
  4. package/dist/index.umd.cjs +0 -2
  5. package/dist/types/batch.d.ts +0 -72
  6. package/dist/types/bx-boot.d.ts +0 -177
  7. package/dist/types/bx-helper.d.ts +0 -28
  8. package/dist/types/bx-logger.d.ts +0 -44
  9. package/dist/types/index.d.ts +0 -15
package/Readme.md CHANGED
@@ -1,162 +1,162 @@
1
- ## ***UTILS-KIT***
2
- ### **Подключение и использование**
3
- ```sh
4
- npm i szdl-utils-kit
5
- ```
6
- ```JavaScript
7
- import { Batch, BxBoot, tempus } from 'szdl-utils-kit';
8
- ```
9
-
10
- ### ***{ Batch }***
11
- Утилита пакетного запроса данных из B24
12
-
13
- ```JavaScript
14
- import { Batch } from 'szdl-utils-kit';
15
-
16
- const rest = new Batch(BX24.callBatch);
17
- ```
18
-
19
- #### **Свойства**
20
- <b><i>serial</i></b> - флаг режима передачи <br>
21
-
22
- #### **Методы**
23
- <b><i>setSerial()</i></b> - установка последовательного режима <br>
24
- <b><i>setParallel()</i></b> - установка параллельного режима <br>
25
- <b><i>stop()</i></b> - принудительно остановить выгрузку данных <br>
26
- <b><i>batch(commandList, progressCall)</i></b> - запрос данных <br>
27
- <b><i>batchTotalCount(commandList, progressCall)</i></b> - запрос количества элементов по сущностям <br>
28
-
29
-
30
- ### ***{ BxBoot }***
31
- Утилита Promise-обертка над некоторыми методами BX24.
32
-
33
- #### **Свойства**
34
- <b><i>domain</i></b> - доменное имя портала <br>
35
- <b><i>isAdmin</i></b> - флаг проверки текущего пользователя на админа <br>
36
-
37
- <b><i>appInfo</i></b> - Информация о приложении
38
- ```TypeScript
39
- type appInfo = {
40
- ID: number,
41
- CODE: string,
42
- VERSION: number,
43
- STATUS: string,
44
- INSTALLED: boolean,
45
- PAYMENT_EXPIRED: string,
46
- DAYS: null | number,
47
- LANGUAGE_ID: string,
48
- LICENSE: string,
49
- LICENSE_TYPE: string,
50
- LICENSE_FAMILY: string
51
- };
52
- ```
53
- <b><i>appConst</i></b> - Параметры приложения
54
- ```TypeScript
55
- type appConst = {
56
- appName: string,
57
- appNameEng: string,
58
- pathApp: string,
59
- zip: string,
60
- chatBotLogo: string,
61
- entity: { key: string, name: string }[],
62
- };
63
- ```
64
- <b><i>userInfo</i></b> - Информация о текущем пользователе
65
- <b><i>placeData</i></b> - Информация о встройках
66
-
67
- <b><i>placeInfo</i></b> - Информация о текущем месте встройки
68
- ```TypeScript
69
- type placeInfo = {
70
- placement: string;
71
- options: Record<string, string>;
72
- };
73
- ```
74
-
75
- #### **Методы**
76
- <b><i>init()</i></b> - Метод инициализации библиотеки rest api BX24
77
- ```TypeScript
78
- init(): Promise<boolean>;
79
- ```
80
-
81
- <b><i>userOption(key, ?value)</i></b> - Получение\изменение опций юзера.
82
- * Если передан 'key', то возвращает опцию по ключу. <br>
83
- * Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.
84
- ```TypeScript
85
- userOption(key: string, value?: string | number)
86
- ```
87
-
88
- <b><i>call({ method, params })</i></b> - Вызывает указанный метод REST-сервиса с указанными параметрам
89
- ```TypeScript
90
- call({ method, params }: TCommand): Promise<unknown[] | boolean>;
91
- type TCommand = {
92
- method: string,
93
- params: Record<string, unknown> | {
94
- select?: string[],
95
- filter?: Record<string, string | string[]>,
96
- } | {
97
- id?: string,
98
- params?: Record<string, string>,
99
- fields?: Record<string, unknown>,
100
- }
101
- }
102
- ```
103
-
104
- <b><i>batch(commandList, ?progressCall)</i></b> - Пакетный запрос данных
105
- * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
106
- * progressCall - принимает callback в который передается статус загрузки данных в процентах
107
- ```TypeScript
108
- batch(
109
- commandList: Record<string, TCommand>,
110
- progressCall?: (data:{ percent: number })=>void
111
- ): Promise<Record<string, unknown[]> | boolean>;
112
- ```
113
-
114
- <b><i>batchTotalCount(commandList, ?progressCall)</i></b> - Пакетный запрос количества элементов по запрошенным сущностям
115
- * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
116
- * progressCall - принимает callback в который передается статус загрузки данных в процентах
117
- ```TypeScript
118
- batchTotalCount(
119
- commandList: Record<string, TCommand>,
120
- progressCall?: (data:{ percent: number })=>void
121
- ): Promise<Record<string, number> | boolean>;
122
- ```
123
-
124
- <b><i>getPlacement()</i></b> - Запрос данных о местах встройки приложения
125
- ```TypeScript
126
- getPlacement(): Promise<unknown[] | boolean>;
127
- ```
128
-
129
- <b><i>placementBind(place)</i></b> - Встройка приложения в place
130
- * place - индификатор места встройки
131
- ```TypeScript
132
- placementBind(place: string): void;
133
- ```
134
-
135
- <b><i>placementUnBind(place)</i></b> - Отвязка встройки из place
136
- * place - индификатор места встройки
137
- ```TypeScript
138
- placementUnBind(place: string): Promise<boolean>;
139
- ```
140
-
141
- <b><i>getBotList()</i></b> - Получение списка чат-ботов
142
- ```TypeScript
143
- getBotList(): Promise<unknown[] | boolean>;
144
- ```
145
-
146
- <b><i>regBot({ code, type, name })</i></b> - Регистрация чат-бота
147
- * code - Строковой идентификатор бота, уникальный в рамках вашего приложения
148
- * type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
149
- * name - Имя чат-бота
150
- ```TypeScript
151
- regBot({ code, type, name }:{
152
- code: string, type: string, name: string
153
- }): Promise<unknown | boolean>;
154
- ```
155
-
156
- <b><i>unRegBot(id)</i></b> - Удаление чат-бота
157
- ```TypeScript
158
- unRegBot(id: number|string): Promise<unknown | boolean>;
159
- ```
160
-
161
- ### ***{ tempus }***
1
+ ## ***UTILS-KIT***
2
+ ### **Подключение и использование**
3
+ ```sh
4
+ npm i szdl-utils-kit
5
+ ```
6
+ ```JavaScript
7
+ import { Batch, BxBoot, tempus } from 'szdl-utils-kit';
8
+ ```
9
+
10
+ ### ***{ Batch }***
11
+ Утилита пакетного запроса данных из B24
12
+
13
+ ```JavaScript
14
+ import { Batch } from 'szdl-utils-kit';
15
+
16
+ const rest = new Batch(BX24.callBatch);
17
+ ```
18
+
19
+ #### **Свойства**
20
+ <b><i>serial</i></b> - флаг режима передачи <br>
21
+
22
+ #### **Методы**
23
+ <b><i>setSerial()</i></b> - установка последовательного режима <br>
24
+ <b><i>setParallel()</i></b> - установка параллельного режима <br>
25
+ <b><i>stop()</i></b> - принудительно остановить выгрузку данных <br>
26
+ <b><i>batch(commandList, progressCall)</i></b> - запрос данных <br>
27
+ <b><i>batchTotalCount(commandList, progressCall)</i></b> - запрос количества элементов по сущностям <br>
28
+
29
+
30
+ ### ***{ BxBoot }***
31
+ Утилита Promise-обертка над некоторыми методами BX24.
32
+
33
+ #### **Свойства**
34
+ <b><i>domain</i></b> - доменное имя портала <br>
35
+ <b><i>isAdmin</i></b> - флаг проверки текущего пользователя на админа <br>
36
+
37
+ <b><i>appInfo</i></b> - Информация о приложении
38
+ ```TypeScript
39
+ type appInfo = {
40
+ ID: number,
41
+ CODE: string,
42
+ VERSION: number,
43
+ STATUS: string,
44
+ INSTALLED: boolean,
45
+ PAYMENT_EXPIRED: string,
46
+ DAYS: null | number,
47
+ LANGUAGE_ID: string,
48
+ LICENSE: string,
49
+ LICENSE_TYPE: string,
50
+ LICENSE_FAMILY: string
51
+ };
52
+ ```
53
+ <b><i>appConst</i></b> - Параметры приложения
54
+ ```TypeScript
55
+ type appConst = {
56
+ appName: string,
57
+ appNameEng: string,
58
+ pathApp: string,
59
+ zip: string,
60
+ chatBotLogo: string,
61
+ entity: { key: string, name: string }[],
62
+ };
63
+ ```
64
+ <b><i>userInfo</i></b> - Информация о текущем пользователе
65
+ <b><i>placeData</i></b> - Информация о встройках
66
+
67
+ <b><i>placeInfo</i></b> - Информация о текущем месте встройки
68
+ ```TypeScript
69
+ type placeInfo = {
70
+ placement: string;
71
+ options: Record<string, string>;
72
+ };
73
+ ```
74
+
75
+ #### **Методы**
76
+ <b><i>init()</i></b> - Метод инициализации библиотеки rest api BX24
77
+ ```TypeScript
78
+ init(): Promise<boolean>;
79
+ ```
80
+
81
+ <b><i>userOption(key, ?value)</i></b> - Получение\изменение опций юзера.
82
+ * Если передан 'key', то возвращает опцию по ключу. <br>
83
+ * Если передан 'key' и 'value', то функция изменяет ключ по переданному значению.
84
+ ```TypeScript
85
+ userOption(key: string, value?: string | number)
86
+ ```
87
+
88
+ <b><i>call({ method, params })</i></b> - Вызывает указанный метод REST-сервиса с указанными параметрам
89
+ ```TypeScript
90
+ call({ method, params }: TCommand): Promise<unknown[] | boolean>;
91
+ type TCommand = {
92
+ method: string,
93
+ params: Record<string, unknown> | {
94
+ select?: string[],
95
+ filter?: Record<string, string | string[]>,
96
+ } | {
97
+ id?: string,
98
+ params?: Record<string, string>,
99
+ fields?: Record<string, unknown>,
100
+ }
101
+ }
102
+ ```
103
+
104
+ <b><i>batch(commandList, ?progressCall)</i></b> - Пакетный запрос данных
105
+ * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
106
+ * progressCall - принимает callback в который передается статус загрузки данных в процентах
107
+ ```TypeScript
108
+ batch(
109
+ commandList: Record<string, TCommand>,
110
+ progressCall?: (data:{ percent: number })=>void
111
+ ): Promise<Record<string, unknown[]> | boolean>;
112
+ ```
113
+
114
+ <b><i>batchTotalCount(commandList, ?progressCall)</i></b> - Пакетный запрос количества элементов по запрошенным сущностям
115
+ * commandList - лист команд можно передавать как в виде объекта, так и в виде массива команд
116
+ * progressCall - принимает callback в который передается статус загрузки данных в процентах
117
+ ```TypeScript
118
+ batchTotalCount(
119
+ commandList: Record<string, TCommand>,
120
+ progressCall?: (data:{ percent: number })=>void
121
+ ): Promise<Record<string, number> | boolean>;
122
+ ```
123
+
124
+ <b><i>getPlacement()</i></b> - Запрос данных о местах встройки приложения
125
+ ```TypeScript
126
+ getPlacement(): Promise<unknown[] | boolean>;
127
+ ```
128
+
129
+ <b><i>placementBind(place)</i></b> - Встройка приложения в place
130
+ * place - индификатор места встройки
131
+ ```TypeScript
132
+ placementBind(place: string): void;
133
+ ```
134
+
135
+ <b><i>placementUnBind(place)</i></b> - Отвязка встройки из place
136
+ * place - индификатор места встройки
137
+ ```TypeScript
138
+ placementUnBind(place: string): Promise<boolean>;
139
+ ```
140
+
141
+ <b><i>getBotList()</i></b> - Получение списка чат-ботов
142
+ ```TypeScript
143
+ getBotList(): Promise<unknown[] | boolean>;
144
+ ```
145
+
146
+ <b><i>regBot({ code, type, name })</i></b> - Регистрация чат-бота
147
+ * code - Строковой идентификатор бота, уникальный в рамках вашего приложения
148
+ * type - Тип бота, B - чат-бот, ответы поступают сразу, H - человек, ответы поступают с задержкой от 2-х до 10 секунд, O - чат-бот для Открытых линий, S - чат-бот с повышенными привилегиями (supervisor)
149
+ * name - Имя чат-бота
150
+ ```TypeScript
151
+ regBot({ code, type, name }:{
152
+ code: string, type: string, name: string
153
+ }): Promise<unknown | boolean>;
154
+ ```
155
+
156
+ <b><i>unRegBot(id)</i></b> - Удаление чат-бота
157
+ ```TypeScript
158
+ unRegBot(id: number|string): Promise<unknown | boolean>;
159
+ ```
160
+
161
+ ### ***{ tempus }***
162
162
  Утилита для работы с датами и временем, [документация](https://habr.com/ru/articles/204162/)
package/package.json CHANGED
@@ -1,41 +1,41 @@
1
- {
2
- "name": "szdl-utils-kit",
3
- "description": "utils-kit library",
4
- "private": false,
5
- "version": "0.2.25",
6
- "type": "module",
7
- "author": "Stanislav Ovv",
8
- "license": "BSD",
9
- "module": "./dist/index.js",
10
- "main": "./dist/index.umd.cjs",
11
- "types": "./dist/types/index.d.ts",
12
- "exports": {
13
- ".": {
14
- "import": "./dist/index.js",
15
- "require": "./dist/index.umd.cjs"
16
- }
17
- },
18
- "files": [
19
- "dist"
20
- ],
21
- "keywords": [
22
- "szdl",
23
- "utils",
24
- "szdl-utils-kit"
25
- ],
26
- "scripts": {
27
- "dev": "vite --host",
28
- "watch": "vite build --watch",
29
- "build": "vite build",
30
- "preview": "vite preview",
31
- "pub": "npm version patch && npm publish"
32
- },
33
- "devDependencies": {
34
- "vite": "^4.4.5",
35
- "vite-plugin-dts": "^3.6.0",
36
- "vite-plugin-static-copy": "^0.17.0"
37
- },
38
- "dependencies": {
39
- "tempusjs": "^0.2.18"
40
- }
41
- }
1
+ {
2
+ "name": "szdl-utils-kit",
3
+ "description": "utils-kit library",
4
+ "private": false,
5
+ "version": "0.2.27",
6
+ "type": "module",
7
+ "author": "Stanislav Ovv",
8
+ "license": "BSD",
9
+ "module": "./dist/index.js",
10
+ "main": "./dist/index.umd.cjs",
11
+ "types": "./dist/types/index.d.ts",
12
+ "exports": {
13
+ ".": {
14
+ "import": "./dist/index.js",
15
+ "require": "./dist/index.umd.cjs"
16
+ }
17
+ },
18
+ "files": [
19
+ "dist"
20
+ ],
21
+ "keywords": [
22
+ "szdl",
23
+ "utils",
24
+ "szdl-utils-kit"
25
+ ],
26
+ "scripts": {
27
+ "dev": "vite --host",
28
+ "watch": "vite build --watch",
29
+ "build": "vite build",
30
+ "preview": "vite preview",
31
+ "pub": "npm version patch && npm publish"
32
+ },
33
+ "devDependencies": {
34
+ "vite": "^4.4.5",
35
+ "vite-plugin-dts": "^3.6.0",
36
+ "vite-plugin-static-copy": "^0.17.0"
37
+ },
38
+ "dependencies": {
39
+ "tempusjs": "^0.2.18"
40
+ }
41
+ }