@opengis/cms 0.0.2 → 0.0.3

package/.gitlab-ci.yml

@@ -0,0 +1,36 @@
+stages:
+  - build
+  - doc
+
+build-dev:
+  tags:
+    - "1_140"
+  stage: build
+  variables:
+    GIT_STRATEGY: none
+  script:
+    - cd /data/server/local-cms && sudo git reset --hard HEAD
+    - cd /data/server/local-cms && sudo git pull
+    - sudo sed -i 's/3000/3004/g' /data/server/local-cms/server/index.js
+    - cd /data/server/local-cms && sudo npm i
+    - cd /data/server/local-cms && sudo npm run build
+    - cd /data/server/local-cms && pm2 restart 3004-local-cms
+  only:
+    - dev
+
+
+docs-253:
+  stage: doc
+  tags:
+    - cdn
+  variables:
+    GIT_STRATEGY: none
+  script:
+    - cd /data/softpro/docs/$CI_PROJECT_NAME && git pull
+    - npm install
+    - npm run docs:build
+    - rm -rf /data/softpro/apidocs/$CI_PROJECT_NAME || true
+    - mkdir -p /data/softpro/apidocs/$CI_PROJECT_NAME
+    - cp -r /data/softpro/docs/$CI_PROJECT_NAME/docs/.vitepress/dist/* /data/softpro/apidocs/$CI_PROJECT_NAME
+  only:
+    - dev

package/config.example

@@ -0,0 +1,21 @@
+{
+    "folder": "site/ip_ukraine",
+    "pg": {
+        "host": "192.168.3.160",
+        "port": 5439,
+        "database": "ip_ukraine",
+        "user": "postgres",
+        "password": "postgres"
+    },
+    "redis": {
+        "host": "192.168.3.160",
+        "port": 6379,
+        "family": 4
+    },
+    "s3": {
+        "endpoint": "http://192.168.3.160:9000",
+        "user": "minioadmin",
+        "password": "minioadmin"
+    },    
+    "convertServerAddress": "192.168.3.160:4003"    
+}

package/docs/.vitepress/abbr.mjs

@@ -0,0 +1,26 @@
+import abbr from '../abbr.json';
+
+function handleAbbr(md) {
+  if (!abbr || typeof abbr !== 'object') {
+    return false;
+  }
+
+  const defaultRender = md.renderer.render.bind(md.renderer);
+
+  md.renderer.render = function(tokens, options, env) {
+    let result = defaultRender(tokens, options, env);
+
+    for (const key in abbr) {
+      const pattern = new RegExp(`${key}(?!\s*<\/abbr>)`, 'gm');
+      const replacement = `<abbr title="${abbr[key]}">${key}</abbr>`;
+
+      result = result.replace(pattern, replacement);
+    }
+
+    return result;
+  };
+
+  return true;
+}
+
+export default handleAbbr;

package/docs/.vitepress/config.mjs

@@ -0,0 +1,119 @@
+import { defineConfig } from 'vitepress';
+import { withMermaid } from 'vitepress-plugin-mermaid';
+import { tabsMarkdownPlugin } from 'vitepress-plugin-tabs';
+import markdownItAbbr from 'markdown-it-abbr';
+import navigation from './navigation.mjs';
+import handleAbbr from './abbr.mjs';
+
+// Автоматична генерація одночасно nav (меню в хедері) і сайдбару для кожного пункту nav
+const { nav, sidebar } = navigation(
+  /*
+    Перший параметр функції (обов'язковий) - масив об'єктів з ключами:
+      1) text (обов'язковий) - назва пункта меню, яка буде відображатись в хедері
+      2) folder (обов'язковий) - назва папки з документацією, яка повинна відкриватись по кліку на пункт меню з хедера
+        (на основі цієї папки буде автоматично сформований сайдбар)
+      3) link (необов'язковий) - кастомне посилання, по стандарту веде на файл `docs/${forder}/index.md`
+      4) інші необов'язкові ключі (activeMatch, target...) описані тут - https://vitepress.dev/reference/default-theme-nav#navigation-links
+  */
+  [
+    {
+      text: 'DB',
+      folder: 'db',
+    },
+    {
+      text: 'API',
+      folder: 'api',
+    },
+    {
+      text: 'Vue',
+      folder: 'vue',
+    },
+    {
+      text: 'Readme',
+      folder: 'readme',
+    },
+  ],
+  /*
+    Другий параметр функції (НЕобов'язковий) - об'єкт з двома ключами:
+      1) nav - параметри для налаштування хедера, може містити наступні ключі:
+        * disableHome (Booleadn, default: false) - чи скрити пункт меню, який веде на головну
+        * homeTitle (String, default: 'Головна') - назва пункту меню, який веде на головну
+      2) sidebar - параметри для налаштування сайдбару, може містити наступні ключі:
+        * ${назва_папки} (Object) - референс до кожного окремого сайдбару, який вказаний в першому параметрі функції. Ключем виступає те що вказано в folder. Перелік доступних ключів стандартний і описаний тут - https://github.com/jooy2/vitepress-sidebar#options
+  */
+  {
+    // nav: {
+    //   disableHome: false,
+    //   homeTitle: 'Головна',
+    // },
+    // sidebar: {
+    //   'api': {
+    //     includeFolderIndexFile: true,
+    //   }
+    // }
+  },
+  /*
+    Третій параметр функції (НЕобов'язковий, default: '/docs') - вказує папку, в якій знаходиться конфігураційна папка .vitepress:
+      - наприклад, якщо у вас в проєкті вже є інша документація і папка docs зайнята, то тут потрібно вказати нову назву папки
+      - детальніше тут - https://github.com/jooy2/vitepress-sidebar?tab=readme-ov-file#documentrootpath
+  */
+  // '/docs-dev',
+);
+
+export default withMermaid(
+  defineConfig({
+    base: '/cms/',
+
+    title: "Content Management System",
+    description: "Система Керування Контентом",
+
+    ignoreDeadLinks: true,
+
+    markdown: {
+      config(md) {
+        md.use(tabsMarkdownPlugin);
+        md.use(markdownItAbbr);
+        md.use(handleAbbr);
+      },
+      languageAlias: {
+        'example': 'r',
+        'schema-api': 'r',
+        'scheme-api': 'r',
+        'schema': 'r',
+        'scheme': 'r'
+      },
+    },
+
+    head: [
+      ['script', { src: 'https://cdn.tailwindcss.com' }],
+      ['link', { rel: 'icon shortcut', href: './logo-short.svg' }],
+      ['link', { href: 'https://cdn.softpro.ua/vue/v3-core/dev/style.css' }],
+    ],
+
+    // https://vitepress.dev/reference/default-theme-config
+    themeConfig: {
+      nav,
+      sidebar,
+
+      logo: '/logo.svg',
+      siteTitle: false,
+
+      outline: 'deep',
+
+      search: {
+        provider: 'local',
+      },
+
+      socialLinks: [
+        { icon: 'github', link: 'https://git.softpro.ua/', },
+      ],
+
+      // Додаткові посилання в навігації - https://prnt.sc/5K70IDQh8J-f
+      // Виводиться на всіх сторінках
+      // Також можна оверрайдити/доповнювати на окремих сторінках, просто в потрібному .md файлі - https://prnt.sc/VAGE3r_RU389
+      navigationLinks: [
+        { icon: 'brand-gitlab', link: 'https://git.softpro.ua/', text: 'GitLab', },
+      ],
+    },
+  })
+);

package/docs/.vitepress/navigation.mjs

@@ -0,0 +1,82 @@
+import { generateSidebar } from 'vitepress-sidebar';
+
+function navigation(items = [], options = {}, documentRootPath = '/docs') {
+  const navHeader = [];
+  const navSidebar = [];
+
+  if (!options.nav) {
+    options.nav = {};
+  }
+
+  if (!options.sidebar) {
+    options.sidebar = {};
+  }
+
+  if (!options.nav.disableHome) {
+    navHeader.push(
+      {
+        text: options.nav.homeTitle || 'Головна',
+        link: '/',
+      }
+    );
+  }
+
+  items.forEach(item => {
+    if (item.text && item.items) {
+      navHeader.push(item);
+
+      return true;
+    }
+
+    if (!item.text || !item.folder) {
+      return false;
+    }
+
+    // FORMAT INCOME DATA
+    const itemFolder = item.folder.trim();
+    const itemFolderFormatted = `/${itemFolder}/`;
+
+    // NAVBAR
+    navHeader.push(
+      {
+        ...item,
+        link: item.link || itemFolderFormatted,
+        activeMatch: item.activeMatch || itemFolderFormatted,
+      }
+    );
+
+    // SIDEBAR
+    const sidebarOptions = options.sidebar[item.folder] || {};
+
+    navSidebar.push(
+      // https://github.com/jooy2/vitepress-sidebar#options
+      {
+        documentRootPath,
+        scanStartPath: itemFolder,
+        resolvePath: itemFolderFormatted,
+        useTitleFromFileHeading: true,
+        useTitleFromFrontmatter: true,
+        useFolderTitleFromIndexFile: true,
+        hyphenToSpace: true,
+        underscoreToSpace: true,
+        capitalizeFirst: true,
+        collapsed: true,
+        sortMenusByFrontmatterOrder: true,
+        frontmatterOrderDefaultValue: 1,
+        excludeFiles: [],
+        excludeFolders: [],
+        includeRootIndexFile: true,
+        includeFolderIndexFile: false,
+
+        ...sidebarOptions,
+      }
+    );
+  });
+
+  return {
+    nav: navHeader,
+    sidebar: generateSidebar(navSidebar),
+  };
+}
+
+export default navigation;

package/docs/.vitepress/theme/Layout.vue

@@ -0,0 +1,17 @@
+<script setup>
+import DefaultTheme from 'vitepress/theme';
+import Panzoom from './components/Panzoom.vue';
+import NavigationLinks from './components/NavigationLinks.vue';
+
+const { Layout } = DefaultTheme;
+</script>
+
+<template>
+  <Layout>
+    <template #aside-outline-after>
+      <NavigationLinks />
+    </template>
+  </Layout>
+
+  <Panzoom />
+</template>

package/docs/.vitepress/theme/components/NavigationLinks.vue

@@ -0,0 +1,102 @@
+<script setup>
+import { computed } from 'vue';
+import { useData } from 'vitepress';
+
+const { frontmatter, theme } = useData();
+
+const headingLabel = computed(() => frontmatter.value.navigationLinksLabel || 'Resources');
+
+const links = computed(() => {
+  const arr = [];
+
+  if (frontmatter.value.navigationLinks && Array.isArray(frontmatter.value.navigationLinks) && frontmatter.value.navigationLinks.length) {
+    frontmatter.value.navigationLinks.forEach(link => {
+      arr.push(formatLink(link));
+    });
+  }
+
+  if (theme.value.navigationLinks && Array.isArray(theme.value.navigationLinks) && theme.value.navigationLinks.length && !frontmatter.value.navigationLinksHideGlobal) {
+    theme.value.navigationLinks.forEach(link => {
+      arr.push(formatLink(link));
+    });
+  }
+
+  return arr;
+});
+
+function formatLink(linkObj) {
+  const { link } = linkObj;
+
+  return {
+    ...linkObj,
+    isTargetBlank: link.startsWith('http') || link.startsWith('www'),
+  }
+}
+</script>
+
+<template>
+  <div v-if="links.length" class="nav-links">
+    <div v-if="headingLabel?.length" class="nav-links__item">
+      <span class="nav-links__heading">{{ headingLabel }}</span>
+    </div>
+
+    <a v-for="(link, idx) in links" :key="idx" :href="link.link" :target="link.isTargetBlank ? '_blank' : '_self'" class="nav-links__item">
+      <i v-if="link.icon" :class="`nav-links__icon ti ti-${link.icon}`"></i>
+
+      <span v-if="link.text" class="nav-links__text">{{ link.text }}</span>
+
+      <i v-if="link.isTargetBlank" class="nav-links__target ti ti-arrow-up-right"></i>
+    </a>
+  </div>
+</template>
+
+<style lang="scss" scoped>
+.nav-links {
+  display: flex;
+  flex-direction: column;
+  margin: 30px 0 0;
+  padding-left: 16px;
+  border-left: 1px solid var(--vp-c-divider);
+
+  // .nav-links__item
+  &__item {
+    display: flex;
+    align-items: center;
+    gap: 8px;
+    padding: 8px 0;
+    color: var(--vp-c-text-2);
+    transition: color 0.5s;
+
+    &:hover {
+      color: var(--vp-c-text);
+    }
+  }
+
+  // .nav-links__icon
+  &__icon {
+    font-size: 18px;
+  }
+
+  // .nav-links__heading
+  &__heading {
+    font-size: 14px;
+    font-weight: 600;
+    line-height: 1;
+    color: rgba(60, 60, 67);
+  }
+
+  // .nav-links__text
+  &__text {
+    font-size: 14px;
+    font-weight: 400;
+    line-height: 1;
+  }
+
+  // .nav-links__target
+  &__target {
+    align-self: flex-start;
+    font-size: 12px;
+    margin-left: -4px;
+  }
+}
+</style>

package/docs/.vitepress/theme/components/Panzoom.vue

@@ -0,0 +1,169 @@
+<script setup>
+import { onMounted, nextTick, watch } from 'vue';
+import { useRouter } from 'vitepress';
+import Panzoom from '@panzoom/panzoom';
+
+const { route } = useRouter();
+
+onMounted(() => createPanzoom());
+
+watch(
+  () => route.path,
+  async () => {
+    await nextTick();
+
+    createPanzoom();
+  },
+);
+
+function createPanzoom() {
+  document.querySelectorAll('img[alt = "zoom"], .mermaid').forEach(async (m) => {
+    if (m.panzoom) {
+      return false;
+    }
+
+    const wrapper = document.createElement('div');
+    wrapper.classList.add('mermaid-wrapper');
+
+    m.before(wrapper);
+
+    wrapper.appendChild(m);
+
+    await nextTick();
+
+    const pz = Panzoom(m, {
+      maxScale: 20,
+      minScale: 0.5,
+      canvas: true,
+    });
+
+    m.panzoom = pz;
+
+    wrapper.appendChild(createActions(pz, wrapper, m));
+    wrapper.addEventListener('wheel', pz.zoomWithWheel);
+  });
+}
+
+function createActions(panzoom, wrapper, mermaid) {
+  const actions = document.createElement('div');
+  actions.classList.add('mermaid-wrapper__actions');
+
+  actions.appendChild(createZoomIn(panzoom, wrapper, mermaid));
+  actions.appendChild(createZoomOut(panzoom, wrapper, mermaid));
+  actions.appendChild(createZoomRestore(panzoom, wrapper, mermaid));
+  actions.appendChild(createFullScreenToggler(panzoom, wrapper, mermaid));
+
+  return actions;
+}
+
+function createZoomIn(panzoom, wrapper, mermaid) {
+  const zoomIn = document.createElement('div');
+
+  zoomIn.classList.add('mermaid-wrapper__action');
+  zoomIn.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" 
+  stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M12 5l0 14" /><path d="M5 12l14 0" /></svg>`;
+
+  zoomIn.onclick = () => {
+    panzoom.zoomIn();
+  };
+
+  return zoomIn;
+}
+
+function createZoomOut(panzoom, wrapper, mermaid) {
+  const zoomOut = document.createElement('div');
+
+  zoomOut.classList.add('mermaid-wrapper__action');
+  zoomOut.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" 
+  stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M5 12l14 0" /></svg>`;
+
+  zoomOut.onclick = () => {
+    panzoom.zoomOut();
+  };
+
+  return zoomOut;
+}
+
+function createZoomRestore(panzoom, wrapper, mermaid) {
+  const zoomRestore = document.createElement('div');
+
+  zoomRestore.classList.add('mermaid-wrapper__action');
+  zoomRestore.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" 
+  stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M21 21l-6 -6" />
+  <path d="M3.268 12.043a7.017 7.017 0 0 0 6.634 4.957a7.012 7.012 0 0 0 7.043 -6.131a7 7 0 0 0 -5.314 -7.672a7.021 7.021 0 0 0 -8.241 4.403" /><path d="M3 4v4h4" /></svg>`;
+
+  zoomRestore.onclick = () => {
+    panzoom.reset();
+  };
+
+  return zoomRestore;
+}
+
+function createFullScreenToggler(panzoom, wrapper, mermaid) {
+  const fullScreenToggler = document.createElement('div');
+
+  fullScreenToggler.classList.add('mermaid-wrapper__action');
+  fullScreenToggler.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" 
+  stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M4 8v-2a2 2 0 0 1 2 -2h2" />
+  <path d="M4 16v2a2 2 0 0 0 2 2h2" /><path d="M16 4h2a2 2 0 0 1 2 2v2" /><path d="M16 20h2a2 2 0 0 0 2 -2v-2" /></svg>`;
+
+  fullScreenToggler.onclick = () => {
+    panzoom.reset({ animate: false });
+    wrapper.classList.toggle('is-fullscreen');
+  };
+
+  return fullScreenToggler;
+}
+</script>
+
+<template>
+</template>
+
+<style lang="scss">
+.mermaid-wrapper {
+  display: block;
+  min-height: 168px;
+  overflow: hidden;
+  position: relative;
+  background: var(--vp-c-bg);
+
+  &__actions {
+    position: absolute;
+    z-index: 10;
+    right: 16px;
+    bottom: 16px;
+    display: flex;
+    flex-direction: column;
+    gap: 8px;
+  }
+
+  &__action {
+    display: inline-flex;
+    align-items: center;
+    justify-content: center;
+    text-align: center;
+    font-weight: 600;
+    color: var(--vp-button-alt-hover-text);
+    background-color: var(--vp-button-alt-hover-bg);
+    border-radius: 4px;
+    padding: 4px;
+    line-height: 1;
+    white-space: nowrap;
+    cursor: pointer;
+
+    & > * {
+      display: block;
+      width: 20px;
+      height: 20px;
+      font-size: 20px;
+      line-height: 1;
+    }
+  }
+
+  &.is-fullscreen {
+    position: fixed;
+    z-index: 1000;
+    inset: 0;
+  }
+}
+</style>

package/docs/.vitepress/theme/index.mjs

@@ -0,0 +1,15 @@
+// https://vitepress.dev/guide/custom-theme
+import DefaultTheme from 'vitepress/theme';
+import { enhanceAppWithTabs } from 'vitepress-plugin-tabs/client';
+import './style.scss';
+//import "@tabler/icons-webfont/tabler-icons.css";
+import Layout from './Layout.vue';
+
+/** @type {import('vitepress').Theme} */
+export default {
+  extends: DefaultTheme,
+  Layout: Layout,
+  enhanceApp({ app, router, siteData }) {
+    enhanceAppWithTabs(app);
+  }
+};