@opengis/fastify-table 2.0.111 → 2.0.113

package/dist/helper.d.ts

@@ -0,0 +1,8 @@
+import config from "./config.js";
+import { pgClients } from "./utils.js";
+declare const prefix: any;
+export declare function setup(): Promise<void>;
+export declare function teardown(): Promise<void>;
+export declare function build(): any;
+export { prefix, config, pgClients, };
+//# sourceMappingURL=helper.d.ts.map

package/dist/helper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../helper.ts"],"names":[],"mappings":"AAGA,OAAO,MAAM,MAAM,aAAa,CAAC;AAGjC,OAAO,EAAE,SAAS,EAAkB,MAAM,YAAY,CAAC;AAEvD,QAAA,MAAQ,MAAM,KAAoB,CAAC;AAInC,wBAAsB,KAAK,kBAI1B;AAGD,wBAAsB,QAAQ,kBAW7B;AAED,wBAAgB,KAAK,QAQpB;AAED,OAAO,EAEL,MAAM,EACN,MAAM,EACN,SAAS,GACV,CAAC"}

package/dist/helper.js

@@ -0,0 +1,34 @@
+import path from "node:path";
+import Fastify from "fastify";
+import config from "./config.js";
+import appService from "./index.js";
+import { pgClients, addTemplateDir } from "./utils.js";
+const { prefix = "/api" } = config;
+let app;
+export async function setup() {
+    console.log("Global setup");
+    app = await build();
+    console.log("Global setup finish");
+}
+// ? close clients via vitest.config.js settings deploy, for npx vitest run
+export async function teardown() {
+    console.log("Global teardown: closing all clients");
+    if (app) {
+        app.close();
+        console.log("Global teardown: app closed");
+    }
+    console.log("Global teardown: all clients closed");
+    process.exit(0);
+}
+export function build() {
+    if (!app) {
+        app = Fastify({ logger: false });
+        app.register(appService, config);
+        addTemplateDir(path.join(process.cwd(), "module/test"));
+        // await app.ready(); // ? ensure plugins registered, can not add fastify hooks after app is ready
+    }
+    return app;
+}
+export { 
+// teardown,
+prefix, config, pgClients, };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAuFA,iBAAS,MAAM,CAAC,OAAO,EAAE,GAAG,QA6J3B;;AACD,wBAA0B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AA2FA,iBAAS,MAAM,CAAC,OAAO,EAAE,GAAG,QAyJ3B;;AACD,wBAA0B"}

package/dist/index.js

@@ -2,6 +2,12 @@ import fp from "fastify-plugin";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import proxy from "@fastify/http-proxy";
+import addTemplateDir from "./server/plugins/table/funcs/addTemplateDir.js";
+const filename = fileURLToPath(import.meta.url);
+const cwd = path.dirname(filename);
+// core templates && cls
+config.templates?.forEach((el) => addTemplateDir(el));
+addTemplateDir(path.join(cwd, "module/core"));
 import config from "./config.js";
 import { preForm, afterInsert, afterTable, afterTemplate, afterUpdate, preTemplate, onReady, onListen1, onListen2, } from "./functions.js";
 import addHook from "./server/plugins/hook/addHook.js";
@@ -29,7 +35,6 @@ import redisPlugin from "./server/plugins/redis/index.js";
 import loggerPlugin from "./server/plugins/logger/index.js";
 import authPlugin from "./server/plugins/auth/index.js";
 // utils
-import addTemplateDir from "./server/plugins/table/funcs/addTemplateDir.js";
 import execMigrations from "./server/plugins/migration/exec.migrations.js";
 import pgClients from "./server/plugins/pg/pgClients.js";
 // routes
@@ -49,8 +54,6 @@ import fileRoutes from "./server/routes/file/index.js";
 import uploadChunkRoutes from "./server/routes/upload/index.js";
 import grpcRoutes from "./server/routes/grpc/index.js";
 import notificationsRoutes from "./server/routes/notifications/index.js";
-const filename = fileURLToPath(import.meta.url);
-const cwd = path.dirname(filename);
 addHook("preForm", preForm);
 addHook("afterTable", afterTable);
 addHook("preTemplate", preTemplate);
@@ -95,9 +98,6 @@ function plugin(fastify) {
     fastify.addHook("onReady", onReady);
     // core migrations (second argument for core only)
     execMigrations(path.join(cwd, "server/migrations"), pgClients.client, true).catch((err) => console.warn(err.toString()));
-    // core templates && cls
-    config.templates?.forEach((el) => addTemplateDir(el));
-    addTemplateDir(path.join(cwd, "module/core"));
     // plugins / utils / funcs
     policyPlugin(fastify);
     authPlugin(fastify); // fastify-auth api + hooks integrated to core

package/dist/module/core/cls/constraint_action.json

@@ -0,0 +1,10 @@
+[
+    {
+        "id": "a",
+        "text": "NO ACTION"
+    },
+    {
+        "id": "c",
+        "text": "CASCADE"
+    }
+]

package/dist/module/core/cls/constraint_matchtype.json

@@ -0,0 +1,6 @@
+[
+    {
+        "id": "s",
+        "text": "SIMPLE"
+    }
+]

package/dist/module/core/cls/constraint_type.json

@@ -0,0 +1,14 @@
+[
+    {
+        "id": "u",
+        "text": "UK"
+    },
+    {
+        "id": "p",
+        "text": "PK"
+    },
+    {
+        "id": "f",
+        "text": "FK"
+    }
+]

package/dist/module/core/cls/constraint_type_full.json

@@ -0,0 +1,18 @@
+[
+    {
+        "id": "u",
+        "text": "UNIQUE"
+    },
+    {
+        "id": "p",
+        "text": "PRIMARY KEY"
+    },
+    {
+        "id": "f",
+        "text": "FOREIGN KEY"
+    },
+    {
+        "id": "c",
+        "text": "CHECK"
+    }
+]

package/dist/module/core/cls/constraint_type_table.json

@@ -0,0 +1,18 @@
+[
+    {
+        "id": "u",
+        "text": "UK"
+    },
+    {
+        "id": "p",
+        "text": "PK"
+    },
+    {
+        "id": "f",
+        "text": "FK"
+    },
+    {
+        "id": "c",
+        "text": "CHECK"
+    }
+]

package/dist/module/core/cls/core.user_type.json

@@ -0,0 +1,14 @@
+[
+    {
+        "id": "regular",
+        "text": "Regular"
+    },
+    {
+        "id": "viewer",
+        "text": "Viewer"
+    },
+    {
+        "id": "admin",
+        "text": "Admin"
+    }
+]

package/dist/module/core/pt/schemaItem.pt.hbs

@@ -0,0 +1,18 @@
+-- schema: {{nspname}}
+
+CREATE schema if not exists {{nspname}};
+
+{{#each rows}}
+-- {{{description}}}
+
+CREATE TABLE if not exists {{nspname}}.{{relname}}
+(
+  {{#each columns}}
+  {{column_name}} {{data_type}} {{#unless is_nullable}}NOT NULL{{/unless}}{{#if column_default}}DEFAULT {{column_default}}{{/if}}{{#ifCond @index '!=' (_math ../columns.length '-' 1)}},{{/ifCond}} -- {{{coalesce description '-'}}}
+  {{/each}}{{#if constraints.length}},{{/if}}
+  {{#each constraints}}
+  CONSTRAINT {{constraint_name}} {{#ifCond constraint_type '==' 'f'}}FOREIGN KEY ({{foreign_column}}) REFERENCES {{foreign_table}} ({{foreign_column}}) MATCH {{select confmatchtype data="constraint_matchtype"}} ON UPDATE {{select confupdtype data="constraint_action"}} ON DELETE {{select confdeltype data="constraint_action"}}{{^}}{{select constraint_type data="constraint_type_full"}} ({{column_name}}){{/ifCond}}{{#ifCond @index '!=' (_math ../constraints.length '-' 1)}},{{/ifCond}}
+  {{/each}}
+);
+
+{{/each}}

package/dist/module/core/select/core.user_mentioned.sql

@@ -0,0 +1,2 @@
+select uid, coalesce(sur_name,'')||coalesce(' '||user_name,'') as text, email from admin.users
+where enabled order by coalesce(sur_name,'')||coalesce(' '||user_name,'')

package/dist/script/dump.d.ts

@@ -0,0 +1,2 @@
+export default function dumpMigrateSQL(): Promise<null | undefined>;
+//# sourceMappingURL=dump.d.ts.map

package/dist/script/dump.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dump.d.ts","sourceRoot":"","sources":["../../script/dump.ts"],"names":[],"mappings":"AAqBA,wBAA8B,cAAc,8BA6D3C"}

package/dist/script/dump.js

@@ -1,105 +1,81 @@
-// Вигрузка схеми бд
-// Usage examples:
-// bun .\script\dump.js --table=bpmn.tasks
-// bun .\script\dump.js --schema=bpmn
-
-import path from 'node:path';
-import { existsSync } from 'node:fs';
-import { mkdir, writeFile, rm, rmdir, stat } from 'node:fs/promises';
-
-import { config, handlebars, pgClients, getTemplate } from '../utils.js';
-
-import { build, teardown } from '../helper.js';
-
-const app = build();
-app.addHook('onClose', async () => teardown());
-dumpMigrateSQL();
-// app.close();
-
-const debug = false;
-
-export default async function dumpMigrateSQL() {
-    try {
-        // const { database, host, port, user, password } = config.pg;
-
-        if (!config.pg) {
-            console.error('empty config.pg, skip...');
-            return null;
-        }
-
-        if (!Bun.argv[2]) {
-            console.error('missing schema / table name, skip...');
-        }
-
-        const [key, value] = Bun.argv[2].substring(2).split('=');
-        const tableName = key === 'table' ? value : null;
-        const schemaName = key === 'schema' ? value : value.split('.').shift();
-
-        const pg = pgClients.client;
-        // const pg = await getPGAsync({ database, host, port, user, password });
-        await pg.query(`select 1`);
-
-        const schemaExists = await pg.query(`SELECT 1 FROM information_schema.schemata WHERE schema_name = $1`, [schemaName]).then(el => el.rowCount);
-
-        if (!schemaExists) {
-            console.error('Вказаної схеми не існує', config.pg?.database);
-            return null;
-        }
-
-        // if (tableName && !pg.pk?.[tableName]) {
-        //     console.error('Вказаної таблиці не існує', config.pg?.database);
-        //     return null;
-        // }
-
-        const dump = await schemaItem({
-            pg,
-            table: tableName,
-            schema: schemaName,
-            debug,
-            is_erd: false
-        });
-
-        if (debug) {
-            console.log(dump);
-            return null;
-        }
-
-        const filepath = await saveFile(dump, tableName || schemaName);
-        console.log('sucess', filepath);
-    } catch (err) {
-        console.error(err);
-    } finally {
-        app.close();
-    }
-}
-
-async function saveFile(data, filename) {
-    if (!data) throw new Error(`no data - ${filename}`);
-
-    const filepath = path.join('log/dump', `${filename}.sql`);
-    const fileExists = existsSync(filepath);
-
-    // overwrite old file
-    if (fileExists) {
-        const stats = await stat(filepath);
-        if (stats.isDirectory()) {
-            await rmdir(filepath, { force: true, recursive: true });
-        } else {
-            await rm(filepath)
-        }
-    }
-
-    await mkdir(path.dirname(filepath), { recursive: true });
-    await writeFile(filepath, Buffer.from(data, 'utf-8'));
-
-    return filepath;
-}
-
-async function schemaItem({
-    pg, table, schema, debug
-}) {
-    if (!schema && !table) return new Error('param schema is required');
-
+// Вигрузка схеми бд
+// Usage examples:
+// bun .\script\dump.js --table=bpmn.tasks
+// bun .\script\dump.js --schema=bpmn
+import path from "node:path";
+import { existsSync } from "node:fs";
+import { mkdir, writeFile, rm } from "node:fs/promises";
+import { config, handlebars, pgClients, getTemplate } from "../utils.js";
+import { build, teardown } from "../helper.js";
+if (import.meta.main) {
+    dumpMigrateSQL();
+}
+const debug = false;
+export default async function dumpMigrateSQL() {
+    const app = build();
+    app.addHook("onClose", async () => teardown());
+    try {
+        // const { database, host, port, user, password } = config.pg;
+        if (!config.pg) {
+            console.error("empty config.pg, skip...");
+            return null;
+        }
+        if (!Bun.argv[2]) {
+            console.error("missing schema / table name, skip...");
+        }
+        const [key, value] = Bun.argv[2]?.substring?.(2)?.split?.("=") || [];
+        const tableName = key === "table" ? value : null;
+        const schemaName = key === "schema" ? value : value?.split?.(".")?.shift?.();
+        const pg = pgClients.client;
+        // const pg = await getPGAsync({ database, host, port, user, password });
+        await pg.query(`select 1`);
+        const schemaExists = await pg
+            .query(`SELECT 1 FROM information_schema.schemata WHERE schema_name = $1`, [schemaName])
+            .then((el) => el.rowCount);
+        if (!schemaExists) {
+            console.error("Вказаної схеми не існує", config.pg?.database);
+            return null;
+        }
+        // if (tableName && !pg.pk?.[tableName]) {
+        //     console.error('Вказаної таблиці не існує', config.pg?.database);
+        //     return null;
+        // }
+        const dump = await schemaItem({
+            pg,
+            table: tableName,
+            schema: schemaName,
+            debug,
+        });
+        if (debug) {
+            console.log(dump);
+            return null;
+        }
+        const filepath = await saveFile(dump, tableName || schemaName || "");
+        console.log("success", filepath);
+    }
+    catch (err) {
+        console.error(err);
+    }
+    finally {
+        app.close();
+    }
+}
+async function saveFile(data, filename) {
+    if (!data)
+        throw new Error(`no data - ${filename}`);
+    const filepath = path.join("log/dump", `${filename}.sql`);
+    const fileExists = existsSync(filepath);
+    // overwrite old file
+    if (fileExists) {
+        await rm(filepath, { force: true, recursive: true });
+    }
+    await mkdir(path.dirname(filepath), { recursive: true });
+    await writeFile(filepath, Buffer.from(data, "utf-8"));
+    return filepath;
+}
+async function schemaItem({ pg, table, schema, debug, }) {
+    if (!schema && !table)
+        return new Error("param schema is required");
     const { rows: schemaInfo } = await pg.query(`select c.oid,relname,nspname,obj_description(c.oid) as description,
     (
       select json_agg(row_to_json(q))
@@ -134,10 +110,9 @@ async function schemaItem({
     from pg_class c
     LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
     where ${table ? `nspname||'.'||relname='${table}'` : `'${schema}'=nspname`} and relam=2
-    order by nspname,relname`);
-
-    if (!schemaInfo?.length) throw new Error('invalid params');
-
+    order by nspname,relname`);
+    if (!schemaInfo?.length)
+        throw new Error("invalid params");
     const { rows: constraints } = await pg.query(`select con.conrelid::regclass as constraint_table, a.column_name,
     con.conname as constraint_name,contype as constraint_type, con.confrelid::regclass as foreign_table, 
     con.confupdtype, con.confdeltype, con.confmatchtype, u.column_name as foreign_column from pg_constraint con
@@ -151,26 +126,24 @@ async function schemaItem({
       select column_name from information_schema.constraint_column_usage u 
         where conname=u.constraint_name limit 1
     )u on 1=1
-    where ${table ? `conrelid::regclass::text = '${table}'` : `nspname = '${schema}'`}`);
-
-    // add table constraints, mermaid
-    schemaInfo?.forEach((row) => {
-        // constraint type to column
-        row?.columns?.forEach((col) => {
-            const { constraint_type } = constraints?.find((con) => con?.column_name === col?.column_name && con.constraint_table === `${row.nspname}.${row.relname}`) || {};
-            Object.assign(col, { constraint_type });
-        });
-
-        // table relations
-        const tableConstraints = constraints?.filter((el) => el?.constraint_table === `${row.nspname}.${row.relname}`);
-        Object.assign(row, { constraints: tableConstraints });
-    });
-
-    if (debug) return schemaInfo;
-
-    const body = await getTemplate('pt', 'schemaItem.pt');
-
-    const schemaContent = await handlebars.compile(body?.hbs || 'template not found: schemaItem.pt')({ nspname: schema, rows: schemaInfo, constraints });
-
-    return schemaContent.replace(/'/g, "'");
-}
+    where ${table ? `conrelid::regclass::text = '${table}'` : `nspname = '${schema}'`}`);
+    // add table constraints, mermaid
+    schemaInfo?.forEach((row) => {
+        // constraint type to column
+        row?.columns?.forEach((col) => {
+            const { constraint_type } = constraints?.find((con) => con?.column_name === col?.column_name &&
+                con.constraint_table === `${row.nspname}.${row.relname}`) || {};
+            Object.assign(col, { constraint_type });
+        });
+        // table relations
+        const tableConstraints = constraints?.filter((el) => el?.constraint_table === `${row.nspname}.${row.relname}`);
+        Object.assign(row, { constraints: tableConstraints });
+    });
+    if (debug)
+        return schemaInfo;
+    const body = await getTemplate("pt", "schemaItem.pt");
+    const schemaContent = await handlebars.compile(typeof body === "string"
+        ? body
+        : body?.hbs || "template not found schemaItem.pt")({ nspname: schema, rows: schemaInfo, constraints });
+    return schemaContent.replace(/'/g, "'");
+}

package/dist/script/dump.ts

@@ -0,0 +1,205 @@
+// Вигрузка схеми бд
+// Usage examples:
+// bun .\script\dump.js --table=bpmn.tasks
+// bun .\script\dump.js --schema=bpmn
+
+import { type ExtendedPG } from "../server/types/core.js";
+
+import path from "node:path";
+import { existsSync } from "node:fs";
+import { mkdir, writeFile, rm } from "node:fs/promises";
+
+import { config, handlebars, pgClients, getTemplate } from "../utils.js";
+
+import { build, teardown } from "../helper.js";
+
+if (import.meta.main) {
+  dumpMigrateSQL();
+}
+
+const debug = false;
+
+export default async function dumpMigrateSQL() {
+  const app = build();
+  app.addHook("onClose", async () => teardown());
+
+  try {
+    // const { database, host, port, user, password } = config.pg;
+
+    if (!config.pg) {
+      console.error("empty config.pg, skip...");
+      return null;
+    }
+
+    if (!Bun.argv[2]) {
+      console.error("missing schema / table name, skip...");
+    }
+
+    const [key, value] = Bun.argv[2]?.substring?.(2)?.split?.("=") || [];
+    const tableName = key === "table" ? value : null;
+    const schemaName =
+      key === "schema" ? value : value?.split?.(".")?.shift?.();
+
+    const pg = pgClients.client;
+    // const pg = await getPGAsync({ database, host, port, user, password });
+    await pg.query(`select 1`);
+
+    const schemaExists = await pg
+      .query(
+        `SELECT 1 FROM information_schema.schemata WHERE schema_name = $1`,
+        [schemaName]
+      )
+      .then((el: any) => el.rowCount);
+
+    if (!schemaExists) {
+      console.error("Вказаної схеми не існує", config.pg?.database);
+      return null;
+    }
+
+    // if (tableName && !pg.pk?.[tableName]) {
+    //     console.error('Вказаної таблиці не існує', config.pg?.database);
+    //     return null;
+    // }
+
+    const dump = await schemaItem({
+      pg,
+      table: tableName,
+      schema: schemaName,
+      debug,
+    });
+
+    if (debug) {
+      console.log(dump);
+      return null;
+    }
+
+    const filepath = await saveFile(dump, tableName || schemaName || "");
+    console.log("success", filepath);
+  } catch (err) {
+    console.error(err);
+  } finally {
+    app.close();
+  }
+}
+
+async function saveFile(data: any, filename: string) {
+  if (!data) throw new Error(`no data - ${filename}`);
+
+  const filepath = path.join("log/dump", `${filename}.sql`);
+  const fileExists = existsSync(filepath);
+
+  // overwrite old file
+  if (fileExists) {
+    await rm(filepath, { force: true, recursive: true });
+  }
+
+  await mkdir(path.dirname(filepath), { recursive: true });
+  await writeFile(filepath, Buffer.from(data, "utf-8"));
+
+  return filepath;
+}
+
+async function schemaItem({
+  pg,
+  table,
+  schema,
+  debug,
+}: {
+  pg: ExtendedPG;
+  table?: string | null;
+  schema?: string;
+  debug?: boolean;
+}) {
+  if (!schema && !table) return new Error("param schema is required");
+
+  const { rows: schemaInfo } =
+    await pg.query(`select c.oid,relname,nspname,obj_description(c.oid) as description,
+    (
+      select json_agg(row_to_json(q))
+      from (
+        select
+          column_name,
+          case 
+            when data_type='USER-DEFINED' AND udt_name='geometry' THEN 'geometry' 
+            when data_type='ARRAY' AND udt_name='_text'  THEN 'text[]' 
+            when data_type='ARRAY' AND udt_name='_int4'  THEN 'integer[]' 
+            else data_type 
+          end as data_type,
+          ordinal_position,
+          column_default,
+          is_nullable,
+          case 
+            when column_name='uid' then 'ідентифікатор автора запису в БД'
+            when column_name='cdate' then 'Дата створення запису в БД'
+            when column_name='editor_id' then 'Ідентифікатор автора, який останій вніс зміни в запис'
+            when column_name='editor_date' then 'Час останії зміни в записі'
+            when column_name='files' then 'Системна колонка'
+            when column_name='doc_status' then 'Статус документа'
+            when column_name='reg_status' then 'Статус реєстрації'
+            when column_name='obj_version' then 'Версія запису'
+          else col_description(a.attrelid,ordinal_position) 
+          end as description
+        from information_schema.columns col
+        LEFT JOIN pg_attribute a ON col.column_name=a.attname and c.oid = a.attrelid
+        where col.table_schema=nspname and col.table_name=relname
+      )q
+    ) as columns
+    from pg_class c
+    LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
+    where ${
+      table ? `nspname||'.'||relname='${table}'` : `'${schema}'=nspname`
+    } and relam=2
+    order by nspname,relname`);
+
+  if (!schemaInfo?.length) throw new Error("invalid params");
+
+  const { rows: constraints } =
+    await pg.query(`select con.conrelid::regclass as constraint_table, a.column_name,
+    con.conname as constraint_name,contype as constraint_type, con.confrelid::regclass as foreign_table, 
+    con.confupdtype, con.confdeltype, con.confmatchtype, u.column_name as foreign_column from pg_constraint con
+    left join pg_class c ON c.oid = con.conrelid              
+    left join pg_namespace n ON n.oid = c.relnamespace
+    left join lateral (
+      select string_agg(a.attname,',') as column_name from pg_attribute a 
+        where con.conrelid = a.attrelid and a.attnum = any(con.conkey) limit 1
+    )a on 1=1
+    left join lateral (
+      select column_name from information_schema.constraint_column_usage u 
+        where conname=u.constraint_name limit 1
+    )u on 1=1
+    where ${
+      table ? `conrelid::regclass::text = '${table}'` : `nspname = '${schema}'`
+    }`);
+
+  // add table constraints, mermaid
+  schemaInfo?.forEach((row: any) => {
+    // constraint type to column
+    row?.columns?.forEach((col: any) => {
+      const { constraint_type } =
+        constraints?.find(
+          (con: any) =>
+            con?.column_name === col?.column_name &&
+            con.constraint_table === `${row.nspname}.${row.relname}`
+        ) || {};
+      Object.assign(col, { constraint_type });
+    });
+
+    // table relations
+    const tableConstraints = constraints?.filter(
+      (el: any) => el?.constraint_table === `${row.nspname}.${row.relname}`
+    );
+    Object.assign(row, { constraints: tableConstraints });
+  });
+
+  if (debug) return schemaInfo;
+
+  const body = await getTemplate("pt", "schemaItem.pt");
+
+  const schemaContent = await handlebars.compile(
+    typeof body === "string"
+      ? body
+      : body?.hbs || "template not found schemaItem.pt"
+  )({ nspname: schema, rows: schemaInfo, constraints });
+
+  return schemaContent.replace(/'/g, "'");
+}