@opengis/cms 0.0.2 → 0.0.3

package/docs/api/media/del.md

@@ -0,0 +1,64 @@
+# `DELETE` /cms-media/:token
+
+## Опис
+
+Видалення директорій, файлів через токен, який можна отримати із [списку](./list.md)
+
+## Параметри
+
+```scheme-api
+/api/cms-media/:token?
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Токен         |
+
+:::
+
+## Відповідь
+
+:::tabs
+
+== Видалення файлу
+
+DELETE Request:
+
+```url
+/api/cms-media/TR2nTuq8jqQck3RgHExmisRpHM
+```
+
+Response:
+
+```json
+{
+  "id": "288f3b581905",
+  "name": "1234.svg",
+  "size": "530",
+  "extension": "svg",
+  "caption": "Icon",
+  "altname": "image alt name"
+}
+```
+
+== Видалення директорії
+
+DELETE Request:
+
+```url
+/api/cms-media/TR2nTuq8jqQck3RgHExmisRpHM
+```
+
+Response:
+
+```json
+{
+  "name": "subdirname"
+}
+```
+
+:::

package/docs/api/media/edit.md

@@ -0,0 +1,92 @@
+# `PUT` /cms-media/:token
+
+## Опис
+
+Перейменування директорій, редагування метаданих файлів через токен, який можна отримати із [списку](./list.md)
+
+## Параметри
+
+```scheme-api
+/api/cms-media/:token?
+```
+
+:::tabs
+
+== body
+
+| Назва   | Тип    | Опис           |
+| ------- | ------ | -------------- |
+| name    | String | Назва          |
+| caption | String | Заголовок         |
+| altname | String | Альтернативна назва |
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Токен         |
+
+:::
+
+## Відповідь
+
+::: tabs
+
+== Редагування метаданих
+
+PUT Request:
+
+```url
+/api/cms-media/TR2nTuq8jqQck3RgHExmisRpHM
+```
+
+Request payload:
+
+```json
+{
+    "name": "123.svg",
+    "caption": "Icon",
+    "altname": "image alt name"
+}
+```
+
+Response:
+
+```json
+{
+  "id": "da993e9e291b",
+  "name": "123.svg",
+  "relpath": "/media/testdirname/123.svg",
+  "size": "530",
+  "extension": "svg",
+  "caption": "Icon",
+  "altname": "image alt name"
+}
+```
+
+==Перейменування директорії
+
+PUT Request:
+
+```url
+/api/cms-media/100ZjMW2ZbMyTYIaqPfvUmf3A4U
+```
+
+Request payload:
+
+```json
+{
+    "name": "new directory name"
+}
+```
+
+Response:
+
+```json
+{
+  "name": "new directory name",
+  "relpath": "/media/new directory name"
+}
+```
+
+:::

package/docs/api/media/list.md

@@ -0,0 +1,70 @@
+# `GET` /cms-media
+
+## Опис
+
+Повертає список файлів
+
+## Параметри
+
+```scheme-api
+/api/cms-media?dir={dir}
+```
+
+:::tabs
+
+== query
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| dir   | String | Директорія    |
+
+:::
+
+## Відповідь
+
+:::details Приклад відповіді
+
+```url
+/api/cms-media?dir=subdir
+```
+
+```json
+{
+    "token": "kh9GWz8kiQ1ZxqsDHGsiq1jghKc",
+    "data": [
+        {
+            "name": "a24520ac7d302678b1d903900.svg",
+            "type": "file",
+            "size": 530,
+            "extension": "svg",
+            "token": "TR2nTuq8jqQck3RgHExmisRpHM",
+            "ctime": "2025-03-11T12:53:46.055Z",
+            "mtime": "2025-03-11T13:57:15.453Z"
+        },
+        {
+            "name": "subdir2",
+            "type": "dir",
+            "size": 0,
+            "token": "100ZjMW2ZbMyTYIaqPfvUmf3A4U",
+            "ctime": "2025-03-11T12:57:15.453Z",
+            "mtime": "2025-03-11T13:57:15.453Z"
+        }
+    ]
+}
+```
+
+:::
+
+## Параметри відповіді
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Токен для створення піддиректорій в межах даної директорії або завантаження файлів у дану директорію    |
+| data | Array | Список файлів в межах даної директорії |
+| data.name | String | Назва файлу / директорії |
+| data.type | String | Тип |
+| data.size | Number | Розмір файлу |
+| data.token | String | Токен для редагування метаданих файлу, перейменування файлу / директорії |
+| data.extension | String | Розширення файлу |
+| data.ctime | String | Дата створення |
+| data.mtime | String | Дата редагування |

package/docs/api/media/metadata.md

@@ -0,0 +1,57 @@
+# `GET` /cms-media-metadata/:token
+
+## Опис
+
+Отримання метаданих файлу через токен, який можна отримати із [списку](./list.md)
+
+## Параметри
+
+```scheme-api
+/api/cms-media-metadata/:token
+```
+
+:::tabs
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Токен         |
+
+:::
+
+## Відповідь
+
+:::details Приклад відповіді
+
+GET Request:
+
+```url
+/api/cms-media-metadata/TR2nTuq8jqQck3RgHExmisRpHM
+```
+
+Response:
+
+```json
+{
+  "id": "bfcf02f9f34f",
+  "name": "94a501f4216900853e3736e00.svg",
+  "size": 530,
+  "extension": "svg",
+  "ctime": "2025-03-12T08:27:25.944Z",
+  "mtime": "2025-03-12T08:27:25.906Z"
+}
+```
+
+:::
+
+## Параметри відповіді
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| id | Array | ID запису в БД, що містить метадані |
+| name | String | Назва файлу |
+| size | Number | Розмір файлу |
+| extension | String | Розширення файлу |
+| ctime | String | Дата створення |
+| mtime | String | Дата редагування |

package/docs/api/media/preview.md

@@ -0,0 +1,33 @@
+# `GET` /cms-media/:token
+
+## Опис
+
+Дозволяє виконати перегляд файлу за токеном зі [списку](./list.md)
+
+Є можливість викачати його за умови передачі `query` параметру `download`
+
+## Параметри
+
+```scheme-api
+/api/cms-media/:token
+```
+
+:::tabs
+
+== query
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Token    |
+
+:::
+
+## Приклади
+
+```url
+/api/cms-media/TR2nTuq8jqQck3RgHExmisRpHM
+```
+
+```url
+/api/cms-media/TR2nTuq8jqQck3RgHExmisRpHM?download=1
+```

package/docs/api/media/upload.md

@@ -0,0 +1,84 @@
+# `POST` /cms-media/:token
+
+## Опис
+
+Завантаження файлів / Створення директорій через токен, який можна отримати із [списку](./list.md)
+
+## Параметри
+
+```scheme-api
+/api/cms-media/:token
+```
+
+:::tabs
+
+== body
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| name | String | Назва директорії |
+
+== params
+
+| Назва | Тип    | Опис          |
+| ----- | ------ | ------------- |
+| token | String | Токен         |
+
+:::
+
+## Відповідь
+
+::: tabs
+
+==Завантаження файлу
+
+POST Request:
+
+```url
+/api/cms-media/kh9GWz8kiQ1ZxqsDHGsiq1jghKc
+```
+
+Request payload:
+
+file (`multipart/form-data`)
+
+Response:
+
+```json
+{
+  "dir": "testdirname",
+  "id": "1b74cc3b47a0",
+  "name": "31555c4bde0681c618c9a6300.svg",
+  "type": "file",
+  "token": "jbEFF4CQ784KOpcNr0GmO4Rm2Ys"
+}
+```
+
+==Створення директорії
+
+POST Request:
+
+```url
+/api/cms-media/kh9GWz8kiQ1ZxqsDHGsiq1jghKc
+```
+
+Request payload:
+
+```json
+{
+    "name": "new dir name"
+}
+```
+
+Response:
+
+```json
+{
+  "dir": "/media/testdirname",
+  "name": "testdirname",
+  "type": "dir",
+  "token": "dZI9Pv_tc3y3jVEJvuHxstnuQMQ"
+}
+```
+
+:::

package/docs/db/erd.md

@@ -0,0 +1,173 @@
+# ERD DataBase
+
+## Схема
+
+``` mermaid
+erDiagram
+    gis_metadata_role {
+        text metadata_role_id PK
+        text metadata_id FK
+        string role_code
+        text account_id FK
+        timestamp cdate
+        text uid
+        text editor_id
+        timestamp editor_date
+    }
+    gis_metadata_service {
+        text metadata_service_id PK
+        text metadata_id FK
+        text standart_type
+        text link
+        timestamp cdate
+        text uid
+        text editor_id
+        timestamp editor_date
+    }
+    gis_metadata {
+        text metadata_id PK
+        text parent_identifier
+        text title
+        text resource_type
+        text resource_language
+        text md_scope
+        text keywords
+        text coord_ref_system
+        geometry geom
+        text scale
+        text character_encoding
+        text spatial_representation
+    }
+    gis_metadata_service ||--|{ gis_metadata : ""
+    gis_metadata_role ||--|{ gis_metadata : ""
+```
+
+## Метадані - nsdi_metadata.gis_metadata
+
+:::tabs
+
+==sql
+
+```sql
+
+CREATE TABLE nsdi_metadata.gis_metadata
+(
+  metadata_id text NOT NULL DEFAULT admin.next_id(), -- Id метаданих
+  parent_identifier text, -- parent Identifier
+  title text, -- Назва метаданих
+  resource_type text DEFAULT 'dataset'::text, -- Тип метаданих
+  resource_language text DEFAULT 1, -- Мова метаданих
+  md_scope text, -- Опис метаданих
+  keywords text[], -- Ключові слова
+  coord_ref_system text DEFAULT '5561'::text, -- Система координат
+  geom geometry, -- Охоплення (екстент)
+  scale text, -- Масштаб подання даних
+  character_encoding text DEFAULT 'UTF-8'::text, -- Система кодування
+  spatial_representation text, -- Подання просторових даних
+  CONSTRAINT gis_metadata_pkey PRIMARY KEY (metadata_id)
+);
+
+```
+==table
+
+| Назва колонки          | Опис                      | Тип        |
+| ---------------------- | ------------------------- | ---------- |
+| metadata_id            | Id метаданих              | `text`     |
+| parent_identifier      | parent Identifier         | `text`     |
+| title                  | Назва метаданих           | `text`     |
+| resource_type          | Тип метаданих             | `text`     |
+| resource_language      | Мова метаданих            | `text`     |
+| md_scope               | Опис метаданих            | `text`     |
+| keywords               | Ключові слова             | `text`     |
+| coord_ref_system       | Система координат         | `text`     |
+| geom                   | Охоплення (екстент)       | `geometry` |
+| scale                  | Масштаб подання даних     | `text`     |
+| character_encoding     | Система кодування         | `text`     |
+| spatial_representation | Подання просторових даних | `text`     |
+
+:::
+
+## Організації - nsdi_metadata.gis_metadata_role
+
+:::tabs
+
+==sql
+
+```sql
+
+CREATE TABLE nsdi_metadata.gis_metadata_role
+(
+  metadata_role_id text NOT NULL DEFAULT admin.next_id(), -- Id ролі організації в метаданих
+  metadata_id text NOT NULL, -- Id метаданих
+  role_code text, -- Функція відповідальної сторони
+  account_id text, -- Організація
+  cdate timestamp without time zone DEFAULT now(),
+  uid text,
+  editor_id text, -- Ідентифікатор редактора
+  editor_date timestamp without time zone,
+  CONSTRAINT gis_metadata_role_pkey PRIMARY KEY (metadata_role_id),
+  CONSTRAINT fkey_metadata_role FOREIGN KEY (metadata_id)
+      REFERENCES nsdi_metadata.gis_metadata (metadata_id) MATCH SIMPLE
+      ON UPDATE NO ACTION ON DELETE NO ACTION,
+  CONSTRAINT metadata_acc_id_fkey FOREIGN KEY (account_id)
+      REFERENCES nsdi_metadata.gis_metadata_account (metadata_acc_id) MATCH SIMPLE
+      ON UPDATE NO ACTION ON DELETE NO ACTION,
+  CONSTRAINT metadata_id_role_fkey FOREIGN KEY (metadata_id)
+      REFERENCES nsdi_metadata.gis_metadata (metadata_id) MATCH SIMPLE
+      ON UPDATE CASCADE ON DELETE CASCADE
+);
+
+```
+==table
+| Назва колонки    | Опис                            | Тип                           |
+| ---------------- | ------------------------------- | ----------------------------- |
+| metadata_role_id | Id ролі організації в метаданих | `text`                        |
+| metadata_id      | Id метаданих                    | `text`                        |
+| role_code        | Функція відповідальної сторони  | `text`                        |
+| account_id       | Організація                     | `text`                        |
+| cdate            | Дата додавання                  | `timestamp without time zone` |
+| editor_id        | Ідентифікатор редактора         | `text`                        |
+| editor_date      | Дата редагування                | `timestamp without time zone` |
+
+:::
+
+## Сервіси - nsdi_metadata.gis_metadata_service
+
+:::tabs
+==sql
+
+```sql
+
+CREATE TABLE nsdi_metadata.gis_metadata_service
+(
+  metadata_service_id text NOT NULL DEFAULT admin.next_id(), -- Id сервісу в метаданих
+  metadata_id text NOT NULL, -- Id метаданих
+  standard_type text, -- Стандарт, якому відповідає сервіс
+  link text, -- Посилання на сервіс (Онлайн доступ до ресурсу)
+  cdate timestamp without time zone DEFAULT now(),
+  uid text,
+  editor_id text, -- Ідентифікатор редактора
+  editor_date timestamp without time zone,
+  enabled boolean NOT NULL DEFAULT true,
+  CONSTRAINT gis_metadata_service_pkey PRIMARY KEY (metadata_service_id),
+  CONSTRAINT fkey_metadata_service FOREIGN KEY (metadata_id)
+      REFERENCES nsdi_metadata.gis_metadata (metadata_id) MATCH SIMPLE
+      ON UPDATE NO ACTION ON DELETE NO ACTION,
+  CONSTRAINT metadata_id_service_fkey FOREIGN KEY (metadata_id)
+      REFERENCES nsdi_metadata.gis_metadata (metadata_id) MATCH SIMPLE
+      ON UPDATE CASCADE ON DELETE CASCADE
+);
+
+```
+==table
+| Назва колонки    | Опис                                           | Тип                           |
+| ---------------- | ---------------------------------------------- | ----------------------------- |
+| metadata_role_id | Id сервісу в метаданих                         | `text`                        |
+| metadata_id      | Id метаданих                                   | `text`                        |
+| standard_type    | Стандарт, якому відповідає сервіс              | `text`                        |
+| link             | Посилання на сервіс (Онлайн доступ до ресурсу) | `text`                        |
+| cdate            | Дата додавання                                 | `timestamp without time zone` |
+| editor_id        | Ідентифікатор редактора                        | `text`                        |
+| editor_date      | Дата редагування                               | `timestamp without time zone` |
+
+:::

package/docs/db/index.md

@@ -0,0 +1,7 @@
+---
+order: 0
+---
+
+# Список Scheme
+
+- **[ERD](erd.md)**

package/docs/index.md

@@ -0,0 +1,39 @@
+---
+# https://vitepress.dev/reference/default-theme-home-page
+layout: home
+
+hero:
+  name: opengis/cms
+  text: Документація розробника
+  tagline: Документація описує основні процеси розробки в модулі Content Management System
+  image:
+      light: /logo-light.svg
+      dark: /logo-dark.svg
+  actions:
+    - theme: brand
+      text: 'NPM @opengis/cms'
+      link: https://www.npmjs.com/package/@opengis/cms
+    - theme: brand
+      text: GitLab CMS
+      link: https://git.softpro.ua/npm/cms
+    - theme: alt
+      text: Відкрити Readme
+      link: /readme/
+
+features:
+  - icon: 💿
+    title: DB
+    details: Робота з БД
+    link: /db/
+    linkText: Переглянути
+  - icon: 🔗
+    title: API
+    details: Робота з API
+    link: /api/
+    linkText: Переглянути
+  - icon: 🚀
+    title: Vue
+    details: Робота з Vue.js
+    link: /vue/
+    linkText: Переглянути
+---

package/docs/public/logo-dark.svg

@@ -0,0 +1,24 @@
+<svg xmlns="http://www.w3.org/2000/svg" 
+width="24" 
+height="24" 
+viewBox="0 0 24 24" 
+fill="none" 
+stroke="#e6e6dc" 
+stroke-width="2" 
+stroke-linecap="round" 
+stroke-linejoin="round" 
+class="lucide lucide-square-kanban">
+<rect width="18" height="18" x="3" y="3" rx="2"/>
+<path d="M8 7v9"/>
+<path d="M12 7v4"/>
+<path d="M16 7v7"/>
+
+<path d="M19.001 19m-2 0a2 2 0 1 0 4 0a2 2 0 1 0 -4 0" stroke="#3494ef"/>
+  <path d="M19.001 15.5v1.5" stroke="#3494ef"/>
+  <path d="M19.001 21v1.5" stroke="#3494ef"/>
+  <path d="M22.032 17.25l-1.299 .75" stroke="#3494ef"/>
+  <path d="M17.27 20l-1.3 .75" stroke="#3494ef"/>
+  <path d="M15.97 17.25l1.3 .75" stroke="#3494ef"/>
+<path d="M20.733 20l1.3 .75" stroke="#3494ef"/>
+
+</svg>

package/docs/public/logo-light.svg

@@ -0,0 +1,24 @@
+<svg xmlns="http://www.w3.org/2000/svg" 
+width="24" 
+height="24" 
+viewBox="0 0 24 24" 
+fill="none" 
+stroke="#27272b" 
+stroke-width="2" 
+stroke-linecap="round" 
+stroke-linejoin="round" 
+class="lucide lucide-square-kanban">
+<rect width="18" height="18" x="3" y="3" rx="2"/>
+<path d="M8 7v9"/>
+<path d="M12 7v4"/>
+<path d="M16 7v7"/>
+
+<path d="M19.001 19m-2 0a2 2 0 1 0 4 0a2 2 0 1 0 -4 0" stroke="#3494ef"/>
+  <path d="M19.001 15.5v1.5" stroke="#3494ef"/>
+  <path d="M19.001 21v1.5" stroke="#3494ef"/>
+  <path d="M22.032 17.25l-1.299 .75" stroke="#3494ef"/>
+  <path d="M17.27 20l-1.3 .75" stroke="#3494ef"/>
+  <path d="M15.97 17.25l1.3 .75" stroke="#3494ef"/>
+<path d="M20.733 20l1.3 .75" stroke="#3494ef"/>
+
+</svg>

package/docs/public/logo-short.svg

@@ -0,0 +1,15 @@
+<svg width="31" height="30.000000000000004" xmlns="http://www.w3.org/2000/svg" fill="none">
+ <defs>
+  <clipPath id="clip0_200_320">
+   <rect id="svg_1" fill="white" height="30" width="228"/>
+  </clipPath>
+ </defs>
+ <g>
+  <title>Layer 1</title>
+  <g id="svg_2" clip-path="url(#clip0_200_320)">
+   <path id="svg_3" fill="#CE4140" d="m27.3044,11.5405c0.5845,0.3818 1.2274,0.6681 1.9042,0.8501l0,5.1362c-2.7563,0.7427 -4.7867,3.2004 -4.7867,6.1056c0,0.5428 0.0708,1.0797 0.2123,1.5987l-4.5806,2.5651c-0.5138,-0.4892 -1.1044,-0.8918 -1.7535,-1.1931l0,-5.8968c2.2426,-1.029 3.7131,-3.2213 3.7131,-5.7178c0,-0.1581 -0.0062,-0.3162 -0.0185,-0.4743l5.3097,-2.9737zm0.1784,-2.05808l-7.4231,4.15788c0.1323,0.4265 0.2061,0.8799 0.2061,1.3482c0,2.2042 -1.5873,4.0505 -3.7131,4.5218l0,8.2859c1.3105,0.2923 2.4149,1.1066 3.0702,2.2042l7.1985,-4.0296c-0.4122,-0.686 -0.6491,-1.4824 -0.6491,-2.3325c0,-2.5621 2.1442,-4.6411 4.7868,-4.6411l0,-8.0652c-1.3721,0 -2.6026,-0.5578 -3.4763,-1.44958z"/>
+   <path id="svg_4" fill="#CE4140" d="m20.1119,2.21018l4.5099,2.52635c-0.1323,0.50706 -0.2,1.02903 -0.2,1.55399c0,0.17597 0.0061,0.35195 0.0215,0.52793l-5.2697,2.94989c-1.0798,-0.71883 -2.3718,-1.11254 -3.6977,-1.11254c-1.3166,0 -2.6025,0.39073 -3.6792,1.10061l-5.28513,-2.95884c0.01231,-0.16703 0.02154,-0.33704 0.02154,-0.50705c0,-0.52496 -0.06768,-1.04693 -0.19996,-1.55399l4.50675,-2.52337c1.2121,1.18115 2.8733,1.87016 4.6329,1.87016c1.7628,0 3.427,-0.69199 4.6391,-1.87314zm-0.4553,-2.21018c-0.8183,1.42275 -2.3841,2.38616 -4.1838,2.38616c-1.7996,0 -3.3654,-0.96341 -4.1837,-2.38318l-7.1309,3.99086c0.39685,0.67707 0.62757,1.45854 0.62757,2.29369c0,0.48022 -0.07383,0.94254 -0.21534,1.37503l7.41387,4.14894c0.8737,-0.9038 2.1134,-1.4675 3.4916,-1.4675c1.3843,0 2.6333,0.5697 3.507,1.4824l7.4077,-4.14595c-0.1415,-0.44144 -0.2215,-0.90972 -0.2215,-1.3959c0,-0.83516 0.2277,-1.61662 0.6276,-2.2937l-7.1401,-3.99085z"/>
+   <path id="svg_5" fill="#CE4140" d="m3.67003,11.5278l5.29431,2.9648c-0.01231,0.1641 -0.01846,0.3311 -0.01846,0.4982c0,2.4935 1.47052,4.6828 3.70692,5.7148l0,5.8998c-0.646,0.3012 -1.2397,0.7039 -1.7504,1.1901l-4.57753,-2.5622c0.14151,-0.5189 0.21227,-1.0588 0.21227,-1.6017c0,-2.9081 -2.03036,-5.3629 -4.78673,-6.1055l0,-5.1333c0.67987,-0.1849 1.33204,-0.4772 1.91962,-0.865zm-0.18458,-2.061c-0.87367,0.9008 -2.11034,1.4615 -3.48545,1.4615l0,8.0623c2.64254,0 4.78672,2.0789 4.78672,4.641c0,0.8501 -0.23687,1.6465 -0.6491,2.3325l7.19238,4.0267c0.6553,-1.0947 1.7566,-1.909 3.0671,-2.2013l0,-8.28c-2.1227,-0.4742 -3.707,-2.3175 -3.707,-4.5217c0,-0.4773 0.0739,-0.9366 0.2123,-1.3691l-7.41695,-4.1519z"/>
+  </g>
+ </g>
+</svg>