@opengis/fastify-table 1.1.51 → 1.1.53

package/docs/utils/crud/isFileExists.md

@@ -1,38 +1,38 @@
-# isFileExists
-
-## Опис
-
-Перевірка чи існує файл
-
-```js
-isFileExists(filepath);
-```
-
-## Параметри 
-
-::: tabs
-==params
-
-| Параметр | Тип    | Опис    |
-| -------- | ------ | ------- |
-| filepath    | String | Шлях до файлу |
-:::
-
-## Приклад 
-
-```js
-isFileExists('test.txt')
-```
-
-## Відповідь
-
-:::details Приклад відповіді
-
-```js
-true
-```
----
-```js
-false
-```
+# isFileExists
+
+## Опис
+
+Перевірка чи існує файл
+
+```js
+isFileExists(filepath);
+```
+
+## Параметри 
+
+::: tabs
+==params
+
+| Параметр | Тип    | Опис    |
+| -------- | ------ | ------- |
+| filepath    | String | Шлях до файлу |
+:::
+
+## Приклад 
+
+```js
+isFileExists('test.txt')
+```
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```js
+true
+```
+---
+```js
+false
+```
 :::

package/docs/utils/crud/setOpt.md

@@ -1,38 +1,38 @@
-# setOpt
-
-## Опис
-
-Функція призначена для збереження опцій (налаштувань) в базі даних Redis.
-Повертає токен за вхідними параметрами
-
-```js
-setOpt(opt)
-```
-
-## Параметри 
-
-Якщо параметри представлені у вигляді об'єкта, вони конвертуються в JSON-рядок перед обчисленням хешу. Якщо параметри представлені у вигляді рядка, вони використовуються напряму для обчислення хешу
-
-::: tabs
-==params
-
-| Параметр | Тип             | Опис                      |
-| -------- | --------------- | ------------------------- |
-| opt   | Object / String | Параметри для збереження. |
-:::
-
-## Приклад 
-
-```js
-setOpt('data_user.work')
-```
-
-## Відповідь
-
-::: details Приклад відповіді
-
-```
-opt:UfTTVsVKxBXchKlzRKIg
-```
-
+# setOpt
+
+## Опис
+
+Функція призначена для збереження опцій (налаштувань) в базі даних Redis.
+Повертає токен за вхідними параметрами
+
+```js
+setOpt(opt)
+```
+
+## Параметри 
+
+Якщо параметри представлені у вигляді об'єкта, вони конвертуються в JSON-рядок перед обчисленням хешу. Якщо параметри представлені у вигляді рядка, вони використовуються напряму для обчислення хешу
+
+::: tabs
+==params
+
+| Параметр | Тип             | Опис                      |
+| -------- | --------------- | ------------------------- |
+| opt   | Object / String | Параметри для збереження. |
+:::
+
+## Приклад 
+
+```js
+setOpt('data_user.work')
+```
+
+## Відповідь
+
+::: details Приклад відповіді
+
+```
+opt:UfTTVsVKxBXchKlzRKIg
+```
+
 :::

package/docs/utils/hook/addHook.md

@@ -1,74 +1,74 @@
-# addHook
-
-## Опис
-
-Функція використовується для додавання хуків (функцій-обробників) до списку хуків.
-
-Можна додавати кастомні хуки у файлі `hooks.js`
-
-Всі необхідні параметри передаються явно
-
-На даний момент підтримуються наступні кастомні хуки:
-
-* preData - попередня обробка, можливість блокування доступу
-* afterData - `модифікація` результату, додавання пов'язаних даних тощо
-* preForm - попередня обробка, можливість блокування доступу
-* afterForm - `модифікація` форми, додавання користувацьких полів тощо
-* preTable - попередня обробка, можливість блокування доступу
-* afterTable - `модифікація` результату, додавання пов'язаних даних тощо
-* preTemplate - попередня обробка, можливість блокування доступу [template](https://apidocs.softpro.ua/admin/api/templates/template.html)
-* afterTemplate - `модифікації` payload [template](https://apidocs.softpro.ua/admin/api/templates/template.html)
-* preInsert - попередня обробка, можливість блокування доступу
-* afterInsert - виконання додаткових дій після внесення даних до БД [insert](../../api/crud/insert.md)
-* preUpdate - попередня обробка, можливість блокування доступу
-* afterUpdate - виконання додаткових дій після внесення змін до БД [update](../../api/crud/update.md)
-* preDelete - попередня обробка, можливість блокування доступу
-* afterDelete - виконання додаткових дій після внесення змін до БД [delete](../../api/crud/deleteCrud.md)
-
-Приклади виклику кастомних хуків можна переглянути [тут](./applyHook.md)
-
-## Параметри
-
-```js
-addHook(name, fn);
-```
-
-| Параметр | Тип      | Опис                                          |
-| -------- | -------- | --------------------------------------------- |
-| name     | string   | Назва хука, до якого буде доданий обробник    |
-| fn       | function | Функція-обробник, яку потрібно додати до хука |
-
-## Приклади
-
-:::details
-
-```js
-import { addHook, config, getTemplate, pgClients } from '@opengis/fastify-table/utils.js';
-
-addHook('afterInsert', async ({ table, body = {}, payload: res = {}, user = {} }) => {
-    const { client: pg } = pgClients || {};
-    const { uid } = config?.auth?.disable ? { uid: '1' } : user;
-    if (!uid || !table || !Object.keys(body)?.length) return null;
-
-    const loadTable = await getTemplate('table', table);
-    if (!pg.pk[loadTable?.table || table]) return null;
-    const pk = pg.pk[loadTable?.table || table];
-    const id = res.rows?.[0]?.[pk];
-
-    const { rows: properties = [] } = await pg.query(`select column_id, name, title, format, data from admin.custom_column 
-    where entity=$1 and uid=$2`, [table, uid]);
-
-    if (!id || !properties?.length) return null;
-
-    const q = properties
-        .filter((el) => Object.keys(body).includes(el.name))
-        .map((el) => `insert into crm.extra_data(property_id,property_key,property_entity,object_id,${el.format?.toLowerCase() === 'date' ? 'value_date' : 'value_text'})
-    select '${el.column_id}', '${el.name}', '${table}', '${id}', ${el.format?.toLowerCase() === 'date' ? `'${body[el.name]}'::timestamp without time zone` : `'${body[el.name]}'::text`}`)
-        .join(';\n');
-    return pg.query(q);
-});
-```
-
-:::
-
-Більше прикладів можна переглянути [тут](../../hook/index.md)
+# addHook
+
+## Опис
+
+Функція використовується для додавання хуків (функцій-обробників) до списку хуків.
+
+Можна додавати кастомні хуки у файлі `hooks.js`
+
+Всі необхідні параметри передаються явно
+
+На даний момент підтримуються наступні кастомні хуки:
+
+* preData - попередня обробка, можливість блокування доступу
+* afterData - `модифікація` результату, додавання пов'язаних даних тощо
+* preForm - попередня обробка, можливість блокування доступу
+* afterForm - `модифікація` форми, додавання користувацьких полів тощо
+* preTable - попередня обробка, можливість блокування доступу
+* afterTable - `модифікація` результату, додавання пов'язаних даних тощо
+* preTemplate - попередня обробка, можливість блокування доступу [template](https://apidocs.softpro.ua/admin/api/templates/template.html)
+* afterTemplate - `модифікації` payload [template](https://apidocs.softpro.ua/admin/api/templates/template.html)
+* preInsert - попередня обробка, можливість блокування доступу
+* afterInsert - виконання додаткових дій після внесення даних до БД [insert](../../api/crud/insert.md)
+* preUpdate - попередня обробка, можливість блокування доступу
+* afterUpdate - виконання додаткових дій після внесення змін до БД [update](../../api/crud/update.md)
+* preDelete - попередня обробка, можливість блокування доступу
+* afterDelete - виконання додаткових дій після внесення змін до БД [delete](../../api/crud/deleteCrud.md)
+
+Приклади виклику кастомних хуків можна переглянути [тут](./applyHook.md)
+
+## Параметри
+
+```js
+addHook(name, fn);
+```
+
+| Параметр | Тип      | Опис                                          |
+| -------- | -------- | --------------------------------------------- |
+| name     | string   | Назва хука, до якого буде доданий обробник    |
+| fn       | function | Функція-обробник, яку потрібно додати до хука |
+
+## Приклади
+
+:::details
+
+```js
+import { addHook, config, getTemplate, pgClients } from '@opengis/fastify-table/utils.js';
+
+addHook('afterInsert', async ({ table, body = {}, payload: res = {}, user = {} }) => {
+    const { client: pg } = pgClients || {};
+    const { uid } = config?.auth?.disable ? { uid: '1' } : user;
+    if (!uid || !table || !Object.keys(body)?.length) return null;
+
+    const loadTable = await getTemplate('table', table);
+    if (!pg.pk[loadTable?.table || table]) return null;
+    const pk = pg.pk[loadTable?.table || table];
+    const id = res.rows?.[0]?.[pk];
+
+    const { rows: properties = [] } = await pg.query(`select column_id, name, title, format, data from admin.custom_column 
+    where entity=$1 and uid=$2`, [table, uid]);
+
+    if (!id || !properties?.length) return null;
+
+    const q = properties
+        .filter((el) => Object.keys(body).includes(el.name))
+        .map((el) => `insert into crm.extra_data(property_id,property_key,property_entity,object_id,${el.format?.toLowerCase() === 'date' ? 'value_date' : 'value_text'})
+    select '${el.column_id}', '${el.name}', '${table}', '${id}', ${el.format?.toLowerCase() === 'date' ? `'${body[el.name]}'::timestamp without time zone` : `'${body[el.name]}'::text`}`)
+        .join(';\n');
+    return pg.query(q);
+});
+```
+
+:::
+
+Більше прикладів можна переглянути [тут](../../hook/index.md)

package/docs/utils/hook/applyHook.md

@@ -1,64 +1,64 @@
-# applyHook
-
-## Опис
-
-Функція призначена для виклику хуків (функцій-обробників) з певним ім'ям та передачі їм даних та додаткових аргументів.
-
-Хуки можуть бути використані для повернення відповіді. Для цього достатньо повернути `messagge` та `status`
-
-Приклади додавання кастомних хуків можна переглянути [тут](./addHook.md)
-
-## Параметри
-
-```js
-import { applyHook } from '@opengis/fastify-table/utils.js';
-applyHook(name, data);
-```
-
-| Параметр | Тип    | Опис                                                                               |
-| -------- | ------ | ---------------------------------------------------------------------------------- |
-| name     | string | Назва хука, який потрібно викликати                                                |
-| data     | object | Дані, які будуть передані кожному обробнику хука                                   |
-
-## Приклади
-
-:::tabs
-
-==data
-
-```js
-import { applyHook } from '@opengis/fastify-table/utils.js';
-
-export default async function data(req) {
-    const check = await applyHook('preData', { req });
-    if (check?.message && check?.status) {
-        return { message: check?.message, status: check?.status};
-    }
-    const { pg, funcs, query, params, user } = req;
-    const { rows = [] } = await pg.query(`select * from admin.users where 1=1`);
-    const res = { rows };
-    const hookData = await applyHook('afterData', { table, payload: res, user });
-    return hookData || res;
-}
-```
-
-==table
-
-```js
-import { applyHook, getTemplate } from '@opengis/fastify-table/utils.js';
-
-export default async function table(req) {
-    const timeStart = Date.now();
-    const { pg, funcs, query, params, user } = req;
-    const { table } = await getTemplate('table', params?.table);
-    const hookData = await applyHook('preTable', { table: params.table, id: params.id, user });
-    if (hookData?.message && hookData?.status) {
-        return { message: hookData?.message, status: hookData?.status};
-    }
-    const { rows = [] } = await pg.query(`select * from admin.users where 1=1 limit 1`);
-    const afterHookData = await applyHook('afterTable', { table, payload: rows[0], user });
-    return afterHookData || rows[0];
-}
-```
-
-:::
+# applyHook
+
+## Опис
+
+Функція призначена для виклику хуків (функцій-обробників) з певним ім'ям та передачі їм даних та додаткових аргументів.
+
+Хуки можуть бути використані для повернення відповіді. Для цього достатньо повернути `messagge` та `status`
+
+Приклади додавання кастомних хуків можна переглянути [тут](./addHook.md)
+
+## Параметри
+
+```js
+import { applyHook } from '@opengis/fastify-table/utils.js';
+applyHook(name, data);
+```
+
+| Параметр | Тип    | Опис                                                                               |
+| -------- | ------ | ---------------------------------------------------------------------------------- |
+| name     | string | Назва хука, який потрібно викликати                                                |
+| data     | object | Дані, які будуть передані кожному обробнику хука                                   |
+
+## Приклади
+
+:::tabs
+
+==data
+
+```js
+import { applyHook } from '@opengis/fastify-table/utils.js';
+
+export default async function data(req) {
+    const check = await applyHook('preData', { req });
+    if (check?.message && check?.status) {
+        return { message: check?.message, status: check?.status};
+    }
+    const { pg, funcs, query, params, user } = req;
+    const { rows = [] } = await pg.query(`select * from admin.users where 1=1`);
+    const res = { rows };
+    const hookData = await applyHook('afterData', { table, payload: res, user });
+    return hookData || res;
+}
+```
+
+==table
+
+```js
+import { applyHook, getTemplate } from '@opengis/fastify-table/utils.js';
+
+export default async function table(req) {
+    const timeStart = Date.now();
+    const { pg, funcs, query, params, user } = req;
+    const { table } = await getTemplate('table', params?.table);
+    const hookData = await applyHook('preTable', { table: params.table, id: params.id, user });
+    if (hookData?.message && hookData?.status) {
+        return { message: hookData?.message, status: hookData?.status};
+    }
+    const { rows = [] } = await pg.query(`select * from admin.users where 1=1 limit 1`);
+    const afterHookData = await applyHook('afterTable', { table, payload: rows[0], user });
+    return afterHookData || rows[0];
+}
+```
+
+:::

package/docs/utils/index.md

@@ -1,48 +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)** - Додає кастомний хук
+---
+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

@@ -1,28 +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  | Отримувач повідомлення  |
-
-:::
+# 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  | Отримувач повідомлення  |
+
+:::