@opengis/fastify-table 1.1.45 → 1.1.47

package/docs/utils/index.md

@@ -0,0 +1,48 @@
+---
+order: -1
+---
+
+# Список функцій
+
+## CRUD
+
+- **[dataInsert](./crud/dataInsert.md)** - Імпорт даних у таблицю
+- **[dataUpdate](./crud/dataUpdate.md)** - Оновлення даних у таблиці
+- **[getOpt](./crud/getOpt.md)** - Отримання опцій (налаштувань) за токеном
+- **[setOpt](./crud/setOpt.md)** - Для збереження опцій (налаштувань) в базі даних Redis
+- **[isFileExists](./crud/isFileExists.md)** - Перевірка чи існує файл
+
+## PG
+
+- **[pg](./pg/pg.md)** - Дозволяє виконувати запити до бази даних
+- **[autoIndex](./pg/autoIndex.md)** - Для автоматичного створення індексів у базі даних
+- **[getMeta](./pg/getMeta.md)** - Метадані таблиці
+- **[getPG](./pg/getPG.md)** - Повертає об'єкт для взаємодії з базою даних
+- **[init](./pg/init.md)** - Init
+
+## Notification
+
+- **[addNotification](./notification/addNotification.md)** - додавання повідомлень до таблиці
+- **[notification](./notification/notification.md)** - відправка повідомлень
+
+## Cron
+
+- **[addCron](./cron/addCron.md)** - додавання планувальника
+
+## Redis
+
+- **[rclient](./redis/rclient.md)** - Дозволяє виконувати [redis command](https://redis.io/commands/)
+- **[getRedis](./redis//getRedis.md)** - Отримує конфіг Redis
+
+## Table
+
+- **[getForm](./table/getForm.md)** - Для отримання форм
+- **[getMeta](./table/getMeta.md)** - Метадані таблиці
+- **[getSelect](./table/getSelect.md)** - Отримує дані селекту
+- **[getSelectMeta](./table/getSelectMeta.md)** - Отримує дані з таблиці
+- **[getTable](./table/getTable.md)** - Завантажує таблицю
+
+## Hook
+
+- **[addHook](./hook/addHook.md)** - Додає кастомний хук
+- **[applyHook](./hook/applyHook.md)** - Виконує кастомний хук

package/docs/utils/notification/addNotification.md

@@ -0,0 +1,28 @@
+# addNotification
+
+## Опис
+
+Функція `addNotification` призначена для додавання даних до таблиці `crm.notifications`  з метою відправки повідомлень
+
+``` js
+addNotification({
+  pg, funcs, session, subject, body, link, uid,
+});
+```
+
+## Параметри
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис                                                |
+| -------- | ------ | --------------------------------------------------- |
+| `pg`  | String | Клієнт postgres                          |
+| `funcs` | Object  | Функції  |
+| `session` | Object  | Сесія користувача  |
+| `subject` | String  | Заголовок повідомлення  |
+| `body` | String  | Текст повідомлення  |
+| `link` | String  | Посилання  |
+| `uid` | String  | Отримувач повідомлення  |
+
+:::

package/docs/utils/notification/notification.md

@@ -0,0 +1,41 @@
+# notification
+
+## Опис
+
+Функція `notification` призначена для відправки повідомлень
+
+``` js
+notification({
+      pg,
+      funcs,
+      log,
+      to,
+      title: `Test email title`,
+      message: `Lorem Ipsum Lorem Ipsum`,
+      template,
+      table,
+      id,
+      nocache,
+      file,
+    });
+```
+
+## Параметри
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис                      |
+| -------- | ------ | ------------------------- |
+| `pg`       | Object  | Клієнт postgres        |
+| `funcs`    | Object  | Функції                |
+| `log`      | Object  | Pino logger            |
+| `to`       | String  | Ел. пошта отримувача   |
+| `title`    | String  | Заголовок повідомлення |
+| `message`  | String  | Текст повідомлення     |
+| `template` | String  | Шаблон (pt)            |
+| `table`    | String  | Таблиця БД             |
+| `id`       | String  | ID об'єкту             |
+| `nocache`  | Number  | Відключити кешування   |
+| `file`     | Array   | Шляхи до файлів        |
+:::

package/docs/utils/pg/autoIndex.md

@@ -0,0 +1,22 @@
+# autoindex
+
+## Опис
+
+Функція `autoIndex` призначена для автоматичного створення індексів у базі даних на основі заданих фільтрів. Вона використовує клієнт PostgreSQL та Redis для управління індексами.
+
+``` js
+autoIndex({
+  table, columns: filter,
+});
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис                                                |
+| -------- | ------ | --------------------------------------------------- |
+| `table`  | String | Назва таблиці в базі даних                          |
+| `columns` | Array  | Масив фільтрів, на основі яких створюються індекси  |
+:::

package/docs/utils/pg/getMeta.md

@@ -0,0 +1,59 @@
+# getMeta
+
+## Опис
+
+Метадані таблиці
+
+```js
+getMeta({table: 'data_user.work'});
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис    |
+| -------- | ------ | ------- |
+| table    | string | Таблиця |
+
+:::
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```json
+{
+    "res": {
+        "pk": "id_work",
+        "columns": [
+            {
+                "name": "id_work",
+                "tableID": 8966220,
+                "columnID": 1,
+                "dataTypeID": 25,
+                "dataTypeSize": -1,
+                "dataTypeModifier": -1,
+                "format": "text"
+            },
+            {
+                "name": "type_work",
+                "tableID": 8966220,
+                "columnID": 2,
+                "dataTypeID": 23,
+                "dataTypeSize": 4,
+                "dataTypeModifier": -1,
+                "format": "text"
+            }
+        ],
+        "geom": {
+            "bounds": null,
+            "count": "0",
+            "srid": null,
+            "geometry": null
+        }
+    }
+}
+```
+:::

package/docs/utils/pg/getPG.md

@@ -0,0 +1,34 @@
+# getPG
+
+## Опис
+
+Функція створює та повертає об'єкт для взаємодії з базою даних PostgreSQL. Використовується для отримання екземпляру підключення до бази даних.
+
+```js
+getPG({ db: 'mbk_rivne_dma' });
+```
+
+## Параметри
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис       |
+| -------- | ------ | ---------- |
+| user     | object | Користувач |
+| password | object | Пароль     |
+| host     | object | Хост       |
+| port     | object | Порт       |
+| db       | object | База даних |
+
+:::
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```txt
+pg client function
+```
+
+:::

package/docs/utils/pg/init.md

@@ -0,0 +1,30 @@
+# init
+
+## Опис
+
+Init
+
+```js
+init(client);
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис   |
+| -------- | ------ | ------ |
+| client   | String | Клієнт |
+
+
+:::
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```json
+
+```
+:::

package/docs/utils/pg/pg.md

@@ -0,0 +1,70 @@
+# pg
+
+[node pg](https://node-postgres.com/features/queries) - документація модуля `pg`
+
+## PG Props
+
+```js
+pg.pk["admin.cls"]                      // cls_id ; pk[table]
+pg.pgType[12]                           // int;     type[typeid]
+pg.procList.includes("admin.next_id")   // true
+pg.tableList.includes("admin.cls")      // true
+pg.geom["admin.cls"]                    // false    
+```
+
+## Параметри
+
+```js
+pg.query(query, args?)
+```
+
+| Назва | Тип     | Опис                                |
+| -------- | ------- | -------------------------------- |
+| query      | string  | Запит sql                      |
+| args     | array   | Параметри запиту                 |
+
+```js
+const query = 'INSERT INTO users(name, email) VALUES($1, $2) RETURNING *'
+const args = ['brianc', 'brian.m.carlson@gmail.com']
+const querySelect = 'select  * from users where name = $1 and email = $2'
+
+pg.query(query)               // Query Native
+pg.query(query, args)         // Parameterized query Native
+
+pg.queryCache(querySelect)          // Query with Cache Result
+pg.queryCache(querySelect, args)    // Parameterized query with Cache Result
+```
+
+## pg.queryCache
+
+Повертає один рядок/об'єкт => `object`
+
+Отримай запит кешує в редіс. Якщо вже є кеш по цьому запиту, то повертає кеш.
+Якщо кеша немає то робить новий запит до бази даних.
+
+```js
+const { sid } = await pg.queryCache('select sid from admin.site');
+console.log(sid); // 35
+```
+
+## pg.query
+
+Повертає масив рядків/об'єктів та структуру => `object`
+
+```js
+const { rows, fields } = await pg.query('select sid from admin.site');
+console.log(rows);      // [{sid:35}]
+console.log(fields);    // опис полів запиту
+
+```
+
+## pg.queryNotice
+
+Повертає масив рядків /об'єктів, а також дозволяє вивести notice при відпрацюванні функції БД => `object`
+
+```js
+const send = (txt) => { console.log(txt); };
+const { rows } = await pg.queryNotice('select gis_sync_sandbox.upload_data_check($1)', [{ din, uid }], send);
+console.log(rows);      // [{ status: 2 }]
+
+```

package/docs/utils/redis/getRedis.md

@@ -0,0 +1,36 @@
+# getRedis
+
+## Опис
+
+Отримує конфіг Redis
+
+```js
+getRedis({ db: 0 });
+```
+
+## Параметри
+
+::: tabs
+==params
+
+| Параметр | Тип    | Опис       |
+| -------- | ------ | ---------- |
+| db       | Object | База даних |
+
+:::
+
+## Приклад
+
+```js
+getRedis({ db: 0 })
+```
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```txt
+rclient function
+```
+
+:::

package/docs/utils/redis/rclient.md

@@ -0,0 +1,74 @@
+# rclient
+
+Дозволяє виконувати [redis command](https://redis.io/commands/)
+
+```js
+const data = await rclient.get(`auth:${params.token}`); // отримує з cache 
+```
+
+::: details Робота з `object`, `array` / об'єктами та масивами
+
+Redis підтримує роботу з даними у форматі `string`
+
+Для запису `object` або `array` можна
+
+- зробити `JSON.stringify` - для запису, `JSON.parse` - для читання.
+- використати функції `setJSON`, `getJSON`
+- використати `hgetall`, `hmset` -  для `object`
+- використати `sadd` - для `array`
+:::
+
+## Key / Ключі
+
+Робота з ключами key
+
+| Команда          | Опис                          |
+| ---------------- | ---------------------------------- |
+| [get](https://redis.io/commands/get)         | Get the value of key. If the key does not exist the special value nil is returned.      |
+| [del](https://redis.io/commands/del)         | Removes the specified keys. A key is ignored if it does not exist.      |
+| [set](https://redis.io/commands/set)         | Set key to hold the string value. If key already holds a value, it is overwritten, regardless of its type.       |
+| [setnx](https://redis.io/commands/setnx)     | Set key to hold string value if key does not exist. In that case, it is equal to SET. When key already holds a value, no operation is performed.     |
+| [expire](https://redis.io/commands/expire)   | Set a timeout on key. After the timeout has expired, the key will automatically be deleted.   |
+| [incr](https://redis.io/commands/incr)       | Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation.     |
+| [exists](https://redis.io/commands/exists)   | The user should be aware that if the same existing key is mentioned in the arguments multiple times, it will be counted multiple times.   |
+| [scan](https://redis.io/commands/scan)       | Iterates the set of keys in the currently selected Redis database.      |
+
+## Hash stored / Hash об'єкти
+
+Команди роботи з асоціативними масивами
+
+| Команда          | Опис                          |
+| ---------------- | ---------------------------------- |
+| [hget](https://redis.io/commands/hget)        | Returns the value associated with field in the hash stored at key.     |
+| [hgetall](https://redis.io/commands/hget)     | Returns the value associated with field in the hash stored at key.     |
+| [hmget](https://redis.io/commands/hmget)       | Returns the values associated with the specified fields in the hash stored at key. For every field that does not exist in the hash, a nil value is returned.    |
+| [hmset](https://redis.io/commands/hmset)       | Sets the specified fields to their respective values in the hash stored at key. This command overwrites any specified fields already existing in the hash. If key does not exist, a new key holding a hash is created.    |
+
+## Set  / Списки
+
+Запис масивів унікальних значень
+
+| Команда          | Опис                          |
+| ---------------- | ---------------------------------- |
+| [sadd](https://redis.io/commands/sadd)        | Add the specified members to the set stored at key. Specified members that are already a member of this set are ignored. If key does not exist, a new set is created before adding the specified members.     |
+| [rpush](https://redis.io/commands/rpush)       | Insert all the specified values at the tail of the list stored at key. If key does not exist, it is created as empty list before performing the push operation.    |
+| [smembers](https://redis.io/commands/smembers)    | Returns all the members of the set value stored at key. |
+| [llen](https://redis.io/commands/llen)        | Returns the length of the list stored at key. If key does not exist, it is interpreted as an empty list and 0 is returned.     |
+
+## Sorted set / Сортовані списки
+
+Використовується в `suggest` в пошуку по тексту
+
+| Команда          | Опис                          |
+| ---------------- | ---------------------------------- |
+| [zadd](https://redis.io/commands/zadd)        | Adds all the specified members with the specified scores to the sorted set stored at key. If key does not exist, a new sorted set with the specified members as sole members is created, like if the sorted set was empty.     |
+| [zcard](https://redis.io/commands/zcard)       | Returns the sorted set cardinality (number of elements) of the sorted set stored at key.    |
+| [lrange](https://redis.io/commands/lrange)      | Returns the specified elements of the list stored at key.    |
+| [zrangebylex](https://redis.io/commands/zrange) | Returns the specified range of elements in the sorted set stored at key.  |
+
+## Службові команди
+
+| Команда          | Опис                          |
+| ---------------- | ---------------------------------- |
+| [latency](https://redis.io/commands/latency)     | This is a container command for latency diagnostics commands.   |
+| [flushdb](https://redis.io/commands/flushdb)          | Delete all the keys of the currently selected DB. This command never fails.  |

package/docs/utils/table/getForm.md

@@ -0,0 +1,69 @@
+# getForm
+
+## Опис
+
+Функція для отримання форм
+
+```js
+getForm(name)
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис          |
+| -------- | ------ | ------------- |
+| name     | String | Форма `.json` |
+
+:::
+
+## Приклад
+
+```js
+getForm('cp_building.form')
+```
+
+
+## Відповідь
+
+::: details Приклад відповіді
+
+```json
+{
+    "schema": {
+        
+        "cp_umuni_id": {
+            "type": "Text",
+            "ua": "ID UMUNI"
+        },
+        "cp_year": {
+            "type": "Text",
+            "ua": "Рік будівництва"
+        },
+        "cp_date_en_audit": {
+            "type": "DatePicker",
+            "ua": "Дата проведення останнього енергоаудиту"
+        },
+        "cp_certificate": {
+            "type": "Text",
+            "ua": "Сертифікат енергоефективності будівлі",
+            "help": "Вкажіть посилання"
+        },
+        "cp_pkd": {
+            "type": "Autocomplete",
+            "data": "customer_name",
+            "add": {
+                "model": "crm_acc.crm_account",
+                "ua": "Додати",
+                "form": "account_light.form"
+            },
+            "ua": "Замовник ПКД"
+        }
+    },
+    "label_style": "vertical"
+}
+```
+
+:::

package/docs/utils/table/getMeta.md

@@ -0,0 +1,56 @@
+# getMeta
+
+## Опис
+
+Метадані таблиці
+
+```js
+getMeta(table);
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис    |
+| -------- | ------ | ------- |
+| table    | String | Таблиця |
+
+:::
+
+## Приклад
+
+```js
+getMeta('gis.dataset')
+```
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```json
+{
+  "pk": "dataset_id",
+  "columns": [
+    {
+      "name": "dataset_id",
+      "tableID": 7649248,
+      "columnID": 1,
+      "dataTypeID": 25,
+      "dataTypeSize": -1,
+      "dataTypeModifier": -1,
+      "format": "text"
+    },
+    {
+      "name": "dataset_name",
+      "tableID": 7649248,
+      "columnID": 2,
+      "dataTypeID": 25,
+      "dataTypeSize": -1,
+      "dataTypeModifier": -1,
+      "format": "text"
+    },
+
+```
+:::

package/docs/utils/table/getSelect.md

@@ -0,0 +1,39 @@
+# getSelect
+
+## Опис
+
+Отримує дані селекту.
+
+```js
+getSelect(name)
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис          |
+| -------- | ------ | ------------- |
+| name     | String | Назва таблиці |
+
+:::
+
+## Приклад
+
+```js
+getSelect('storage.data')
+```
+
+## Відповідь
+
+::: details Приклад відповіді
+
+```json
+{
+    "key": "data_id",
+    "original": "select data_id from storage.data"
+}
+```
+
+:::

package/docs/utils/table/getSelectMeta.md

@@ -0,0 +1,47 @@
+# getSelectMeta
+
+## Опис
+
+Отримує дані з класифікатора або селекта.
+
+```js
+getSelectMeta(name)
+```
+
+## Параметри 
+
+:::tabs
+== params
+
+| Параметр | Тип    | Опис          |
+| -------- | ------ | ------------- |
+| name     | String | Назва класифікатора/селекта |
+
+:::
+## Приклад
+
+```js
+getSelectMeta({name: 'test'})
+```
+
+## Відповідь
+
+::: details Приклад відповіді
+
+```json
+{
+  "arr": [
+    {
+      "id": 1,
+      "text": "test"
+    },
+    {
+      "id": 2,
+      "text": "test2"
+    }
+  ]
+}
+
+```
+
+:::