@opengis/fastify-table 1.1.56 → 1.1.57

package/docs/api/cron/cronApi.md

@@ -1,56 +0,0 @@
-# `GET` cronApi
-
-## Опис
-
-Виклик списку планувальників або окремого планувальника вручну
-
-Доступна лише для адміністраторів або при локальній розробці
-
-При передачі у якості параметра `name` значення `list` повертає список планувалників
-
-```example
-/api/cron/{name}
-```
-
-## Параметри
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис |
-| ----- | ------ | ---- |
-| name  | String | Назва планувальника |
-
-:::
-
-## Відповідь
-
-::: details Виклик планувальника вручну
-
-```txt
-cron finish: 237 rows updated
-```
-
-:::
-
-::: details Перегляд списку планувальників
-
-```json
-{
-    "data": [
-        "updateParcelObjectGeometry"
-    ]
-}
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="400" /> Bad Request           | Неправильно сформований запит від клієнта |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/crud/deleteCrud.md

@@ -1,58 +0,0 @@
-# `DEL` deleteCrud
-
-## Опис
-
-Видалення даних із таблиці
-
-Є можливість виклику функцій через хук `preDelete` / `afterDelete` після видалення даних з БД
-
-```example
-/api/table/data_user.work/12812255860620427
-```
-
-## Параметри
-
-```scheme-api
-/api/table/:table/:id
-```
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис |
-| ----- | ------ | ---- |
-| table  | String | Таблиця |
-| id  | String | Ідентифікатор / token |
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "rowCount": 1
-}
-```
-
-==404
-
-```text
-table is required
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="400" /> Bad Request           | Неправильно сформований запит від клієнта |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/crud/insert.md

@@ -1,82 +0,0 @@
-# `POST` Insert
-
-## Опис
-
-Імпорт даних у таблицю
-
-Є можливість виклику функцій через хук `preInsert` / `afterInsert` після внесення даних до БД
-
-```example
-/api/table/data_user.work
-```
-
-## Параметри
-
-```scheme-api
-/api/table/:table
-```
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис    |
-| ----- | ------ | ------- |
-| table | String | Таблиця / token |
-
-==body
-
-| Назва           | Тип    | Опис                    |
-| --------------- | ------ | ----------------------- |
-| type_work       | String | Тип                     |
-| date_in         | String | Внесення даних          |
-| date_out        | String | Вилучення даних         |
-| number_services | String | Кількість сервісів      |
-| number_order    | String | Порядок                 |
-| geom            | String | Геометрія               |
-| editor_id       | String | Ідентифікатор редактора |
-| uid             | String | Ідентифікатор           |
-| editor_date     | String | Дата зміни              |
-
-:::
-
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "res": {
-        "id_work": "3342439977240757305",
-        "type_work": 1,
-        "date_in": null,
-        "date_out": null,
-        "number_services": "23",
-        "number_order": null,
-        "shop": null,
-        "geom": null,
-        "editor_id": null,
-        "uid": null,
-        "editor_date": null
-    }
-}
-```
-
-==404
-```text
-table is required
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                       |
-| ---------------------------------------------------------- | -------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит             |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено     |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |

package/docs/api/crud/update.md

@@ -1,85 +0,0 @@
-# `PUT` Update
-
-## Опис
-
-Оновлення даних у таблиці
-
-Є можливість виклику функцій через хук `preUpdate` / `afterUpdate` після внесення даних до БД
-
-```example
-/api/table/data_user.work/3342439977240757305
-```
-
-## Параметри
-
-```scheme-api
-/api/table/:table/:id
-```
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис          |
-| ----- | ------ | ------------- |
-| table | String | Таблиця / token       |
-| id    | String | Ідентифікатор / token |
-
-==body
-
-| Назва           | Тип    | Опис                    |
-| --------------- | ------ | ----------------------- |
-| type_work       | String | Тип                     |
-| date_in         | String | Внесення даних          |
-| date_out        | String | Вилучення даних         |
-| number_services | String | Кількість сервісів      |
-| number_order    | String | Порядок                 |
-| geom            | String | Геометрія               |
-| editor_id       | String | Ідентифікатор редактора |
-| uid             | String | Ідентифікатор           |
-| editor_date     | String | Дата зміни              |
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "res": {
-        "id_work": "3342439977240757305",
-        "type_work": 2,
-        "date_in": null,
-        "date_out": null,
-        "number_services": "25",
-        "number_order": null,
-        "shop": null,
-        "geom": null,
-        "editor_id": null,
-        "uid": null,
-        "editor_date": "2024-04-09T10:53:23.000Z"
-    }
-}
-```
-
-==404
-```text
-table is required
-```
-
-```text
-id is required
-```
-
-:::
-## Статус коди
-
-| Ключ                                                       | Опис                       |
-| ---------------------------------------------------------- | -------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит             |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено     |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера |

package/docs/api/index.md

@@ -1,47 +0,0 @@
----
-order: -1
----
-
-# Список API
-
-
-## CRUD
-
-- **[deleteCrud](./crud/deleteCrud.md)** - Видалення даних із таблиці
-- **[insert](./crud/insert.md)** - Імпорт даних у таблицю
-- **[update](./crud/update.md)** - Оновлення даних у таблиці
-
-## Utils
-
-- **[logger-file](./utils/logger.file.md)** - Для перегляду логів
-- **[nextId](./utils/next.id.md)** - Отримання унікального ідентифікатора
-- **[getProperties](./utils/properties.get.md)** - Отримання додаткових атрибутів
-- **[addProperties](./utils/properties.add.md)** - Додавання додаткових атрибутів
-- **[statusMonitor](./utils/status.monitor.md)** - Отримання поточного стану навантаження серверу
-
-## Table
-
-- **[table](./table/table.md)** - Повертає інформацію про об'єкт, що редагується
-- **[data](./table/data.md)** - Повертає інформацію про таблицю
-- **[card](./table/card.md)** - Повертає інформацію про картки
-- **[search](./table/search.md)** - Пошук даних по тексту з таблиці
-- **[filter](./table/filter.md)** - Повертає інформацію про фільтри таблиці
-- **[form](./table/form.md)** - Повертає шаблон
-- **[suggest](./table/suggest.md)** - Повертає інформацію за запитом
-- **[export](./table/export.md)** - Експорт даних з таблиці
-
-## Widget
-
-- **[get](./widget/widget.get.md)** - Повертає дані по віджету
-- **[post](./widget/widget.set.md)** - Додає або оновлює дані, що відображаються у віджеті
-- **[del](./widget/widget.del.md)** - Видаляє дані відповідного віджету
-
-## Notification
-
-- **[readNotifications](./notification/readNotifications.md)** - Відмічає повідомлення користувача як прочитане
-- **[userNotifications](./notification/userNotifications.md)** - Повертає список повідомлень користувача
-- **[testEmail](./notification/testEmail.md)** - Тест відправки повідомлень на ел. пошту
-
-## Cron
-
-- **[cronApi](./cron/cronApi.md)** - Викликає планувальник

package/docs/api/notification/testEmail.md

@@ -1,91 +0,0 @@
-# `GET` testEmail
-
-## Опис
-
-Тест відправки повідомлень на ел. пошту
-
-Наявне обмеження доступу до API. API доступна для:
-
-* користувачів з правами адміністратора
-* в рамках локальної розробки (параметр `local` у `config.json`)
-
-```example
-/api/test-email?to=username@mail.com&table=rental.charge&id=3388805314823324672&template=charge.pt&nocache=1
-```
-
-## Параметри
-
-```scheme-api
-/api/test-email?to={to}&from={from}&table={table}&id={id}&template={template}&nocache={nocache}
-```
-
-:::tabs
-
-== query
-
-| Назва | Тип    | Опис |
-| ----- | ------ | ---- |
-| to  | String | Ел. пошта отримувача |
-| from  | String | Ел. пошта відправника |
-| table  | String | Таблиця в БД |
-| id  | String | ID об'єкту в БД |
-| template  | String | Шаблон (partial template) |
-| nocache  | Number | Відключити кешування |
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "accepted": [
-        "username@mail.com"
-    ],
-    "rejected": [],
-    "ehlo": [
-        "PIPELINING",
-        "SIZE 15728640",
-        "VRFY",
-        "ETRN",
-        "AUTH PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
-        "AUTH=PLAIN LOGIN DIGEST-MD5 CRAM-MD5",
-        "ENHANCEDSTATUSCODES",
-        "8BITMIME",
-        "SMTPUTF8",
-        "CHUNKING"
-    ],
-    "envelopeTime": 113,
-    "messageTime": 85,
-    "messageSize": 10887,
-    "response": "250 OK queued as f71c7b08-923d-4169-b448-55212979bfd9",
-    "envelope": {
-        "from": "order@mail.com",
-        "to": [
-            "username@mail.com"
-        ]
-    },
-    "messageId": "<53e901b0-88cf-0b37-2c62-080adbce5e5a@softpro.ua>"
-}
-```
-
-==403
-
-```text
-access restricted
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="400" /> Bad Request           | Неправильно сформований запит від клієнта |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/table/card.md

@@ -1,73 +0,0 @@
-# `GET` Card
-
-## Опис
-
-Повертає інформацію для картки
-
-```example
-/api/card/gis.dataset.table/1
-```
-
-Поля формуються на основі переліку з масиву `card`, який є атрибутом `meta` шаблону таблиці
-
-Приклад:
-
-```json
-{
-    "meta": {
-        "card": ["name", "status", "date"]
-    }
-}
-````
-
-## Параметри
-
-```scheme-api
-/api/card/:table/:id
-```
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис          |
-| ----- | ------ | ------------- |
-| table | String | Таблиця       |
-| id    | String | Ідентифікатор / token |
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "time": 9,
-    "data": {
-        "Опис": "Оренда ділянки ТРЦ River Mall",
-        "Дата початку дії договору": "2024-06-13T21:00:00.000Z",
-        "Сума": "7000",
-        "Дата кінця дії договору": "2075-08-05T21:00:00.000Z"
-    }
-}
-```
-
-==404
-
-```text
-not found
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/table/data.md

@@ -1,134 +0,0 @@
-# `GET` Data
-
-## Опис
-
-Повертає інформацію про таблицю
-
-```example
-/api/data/gis.dataset.table/1
-```
-
-За наявності параметра `id` у запиті та ключа `cardSql` в шаблоні в запит додаються додаткові колонки
-
-Структура `cardSql`
-
-```json
-{
-      "cardSql": [
-    {
-      "name": "floors",
-      "sql": "select floor_id as id, name, status, type from rental.floors where property_id=t.property_id"
-    },
-  ]
-}
-```
-
-## Параметри
-
-```scheme-api
-/api/data/:table/:id?sql=1
-```
-
-:::tabs
-
-== params
-
-| Назва | Тип    | Опис          |
-| ----- | ------ | ------------- |
-| table | String | Таблиця       |
-| id    | String | Ідентифікатор / token |
-
-== query
-
-| Назва | Тип    | Опис                |
-| ----- | ------ | ------------------- |
-| sql   | String | Повернути sql запит |
-| filter   | String | фільтри  |
-| search   | String | пошук |
-| state   | String | state - номер або ключ |
-| custom   | String | custom - номер або ключ |
-| bbox   | String | Фільтр за BBOX  |
-| polyline | String | Фільтр за Polyline  |
-
-:::
-
-- [filter,state,custom](../../templates/filters.md)
-
-## Запит
-
-::: tabs
-
-==Filter
-::: details Приклад запиту
-
-```txt
-/api/data/test.dataset.table?filter=dataset_id=1&search=test name
-```
-
-==BBOX
-
-::: details Приклад запиту
-
-```txt
-/api/data/test.dataset.table?bbox=20.276526313524393 40.6651677831094,35.27752631352439 50.66616778310941
-```
-
-==Polyline
-
-::: details Приклад запиту
-
-```txt
-/api/data/test.dataset.table?polyline=wfvkH_jsvCoKvj@oKfiB?fw@?nd@?nK?nK~WgEfE?wQfw@gEfE?vQwQvj@wQvcAoKvQoKnKgEnd@_cBgw@wj@fEwj@nKg^vQg^oK?vQgEnKgpAvj@?vcAfEf^fEf^?vj@vQvj@vQgE~Wvj@?~p@gE~iAfEnK?~iA_XnvA?nd@fEf^~p@~bBvQ?nd@wQ?vQfEf^fEnK?vQ?vj@oKfEoKfEvQnd@nKvj@?vQfEvQgEf^gEf^?vQfEvQfEvQfE~W?fE?fE?~W?f^?nd@?nK?nKfEfEg^oKwj@nK_X~W~p@~WvQnKoKn}@wQvj@oK~Wg^vcAgEnK?~Wfw@vgD~p@oKfpAvQnd@nKoKvQoKvQ?fE?fEnKvj@wQvQ?fEod@fw@~Wn}@fEn}@_Xv|A_jA~fEwQwQ_XoKwQoKoKoKoKoKg^gE_XgEoKg^gEgEgE?gEfEgEfEgEf^_XoKwQ?gEgEoK?wQ?gE~WoKoKoKwQfEgEnK_X?gEgE?oKfEoKoKgE_XgEgEwQfEoKod@_Xgw@gEoKgE_Xg^wQoKg^_XnvAgE?gEvQgE?od@fpA?vQ?f^oKvcAwj@oKg^?wQn}@gEf^oK?w|AnKgE??nKwj@gEgEg^oKwQoKoK?gEwQoaD?oKod@oKod@gEod@wQo}@oKfEf^gEfEgpAnd@_XfEgE?wQnKo}@_q@?gEgEwj@?oK?oK?_X?oKfEoK?oKfEoK?oK?oK?gEfEoKwQfEoK?gEwQwj@nKo}@nKwQ~Wod@nKoKfEgw@ovAgEwQgE??oKoKgEoKgEgEwQ?oKfEoKnKwQfEwQoK?g^fE?wQfEg^fEod@gE??fEoKvQ?nKoKnKgEfEgEgE?g^nK_q@nKod@?oKoKoK~Wgw@fEoKnd@fE?_XfEoKfEwQfEoKfEwQfEoKvQ?fEfE?vj@gE~W~WvQvQwj@vQvQf^o}@nKvQ?_XgEg^gEg^nKod@?wQgEgEgE?oK_XgEoK?oKgEoKgE_XoKg^oKg^oKod@?gEfEoKvQgEnK?nKfE?_Xnd@gw@fEwQf^wj@fEwQnd@w|A?gEgEgEgEwQfEoKfEgEnKoKnKwQfEgE?oKfEoKnKgEnKwQ_XwQnKwcAod@wQvQod@~Wgw@nKgw@oKg^f^ovAgEwQ?_X?od@gEwj@gEwQvQg^fEoKnKoKvQnK~WfEnKvQ~Wod@f^wj@~WoKnKg^~W?vQgE~WoKnKoK~WoKfEwQvQwQfEgEnKwQnKwQvQwQnKoKnKgEnKgEnKgEvQnKnK?fE?fE?~WwQnKgEnKgEfE?fE?nK?fE?fE?vQgEfE?nKfEfE?fE?vQ?~W?~WgEfEgEnKgEnKwQfEnKnKfE?wj@?o}@g^o}@_Xod@?gEf^_X?o}@?wQ~W?~WgE~WgEfE?f^gEf^oK~Wg^nKgE?oK~WwQ?od@nK_XfEwQnKoKfEgEfE~W?f^f^fEfEfEnKfEnK?gEf^vQfEnK?~WnKvQnK?vQf^nKfEfEgE~WnKfEnK?fEgEfE?nK?fEfEfEgEnK?nKgEnK?nKfEf^?vQgEvQ?nd@gEnKo}@vQgE~WgEf^gE
-```
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```json
-{
-    "time": 3200,
-    "total": 1,
-    "pk": "dataset_id",
-    "addToken": "biGq3ghd5IbNLtT5Y8",
-    "rows": [
-        {
-            "id": "1",
-            "dataset_id": "1",
-            "dataset_name": "test name",
-            "token": "NkBZYO7i5Un94id"
-        }
-    ],
-    "columns": [
-        {
-            "name": "dataset_id",
-            "title": "22"
-        },
-        {
-            "name": "dataset_name",
-            "title": "dataset_name"
-        }
-    ]
-}
-```
-
-==404
-
-```text
-not found
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |

package/docs/api/table/export.md

@@ -1,60 +0,0 @@
-# `GET` Export
-
-## Опис
-
-Повертає інформацію про таблицю
-
-```example
-/api/export?table=gis.dataset.table&format=csv&nocache=1
-```
-
-## Параметри
-
-```scheme-api
-/api/export?table={table}nocache={nocache}&format={format}
-```
-
-:::tabs
-
-== query
-
-| Назва | Тип    | Опис                |
-| ----- | ------ | ------------------- |
-| token   | String | Token |
-| table   | String | Таблиця в БД або шаблон |
-| id   | String | ID рядку в таблиці |
-| col   | String | Перелік колонок через кому  |
-| format   | String | Формат з переліку: csv, xlsx, json |
-| filter   | String | Фільтри  |
-| limit   | Number | Ліміт |
-| nocache | Number | Відключити кешування |
-| formatAnswer | String | Тип відповіді (за замовчуванням - file) |
-
-:::
-
-## Відповідь
-
-::: tabs
-
-==200
-::: details Приклад відповіді
-
-```txt
-Файл успішно сформовано. Натистіть кнопку ще раз для завантаження даних
-```
-
-==500
-
-```text
-relation "gis.dataset" does not exist
-```
-
-:::
-
-## Статус коди
-
-| Ключ                                                       | Опис                                      |
-| ---------------------------------------------------------- | ----------------------------------------- |
-| <Badge type="code_2xx" text="200" /> Success               | Успішний запит                            |
-| <Badge type="code_4xx" text="404" /> Not Found             | Інформації не знайдено                    |
-| <Badge type="code_5xx" text="500" /> Internal Server Error | Помилка на стороні сервера                |