@opengis/fastify-table 1.1.51 → 1.1.52

package/README.md

@@ -1,26 +1,26 @@
-# fastify-table
-
-[![NPM version](https://img.shields.io/npm/v/@opengis/fastify-table)](https://www.npmjs.com/package/@opengis/fastify-table)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
-
-It standardizes the entire form building process, while taking care of everything from rendering to validation and processing:
-
-- pg
-- redis
-- crud
-
-## Install
-
-```bash
-npm i @opengis/fastify-table
-```
-
-## Usage
-
-```js
-fastify.register(import('@opengis/fastify-table'), config);
-```
-
-## Documenation
-
-For a detailed understanding fastify-table, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/gis.storage/).
+# fastify-table
+
+[![NPM version](https://img.shields.io/npm/v/@opengis/fastify-table)](https://www.npmjs.com/package/@opengis/fastify-table)
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
+
+It standardizes the entire form building process, while taking care of everything from rendering to validation and processing:
+
+- pg
+- redis
+- crud
+
+## Install
+
+```bash
+npm i @opengis/fastify-table
+```
+
+## Usage
+
+```js
+fastify.register(import('@opengis/fastify-table'), config);
+```
+
+## Documenation
+
+For a detailed understanding fastify-table, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/gis.storage/).

package/config.js

@@ -1,10 +1,10 @@
-import fs from 'fs';
-
-const fileName = ['config.json', '/data/local/config.json'].find(el => (fs.existsSync(el) ? el : null));
-const config = fileName ? JSON.parse(fs.readFileSync(fileName)) : {};
-
-Object.assign(config, {
-  allTemplates: config?.allTemplates || {},
-});
-
-export default config;
+import fs from 'fs';
+
+const fileName = ['config.json', '/data/local/config.json'].find(el => (fs.existsSync(el) ? el : null));
+const config = fileName ? JSON.parse(fs.readFileSync(fileName)) : {};
+
+Object.assign(config, {
+  allTemplates: config?.allTemplates || {},
+});
+
+export default config;

package/cron/controllers/cronApi.js

@@ -1,22 +1,22 @@
-import cronList from './utils/cronList.js';
-
-export default async function cronApi(req) {
-  const {
-    params = {}, user = {}, hostname,
-  } = req;
-
-  if ((!user.uid || !user.user_type?.includes('admin')) && !hostname?.includes('localhost')) {
-    return { message: 'access restricted', status: 403 };
-  }
-
-  if (params.name === 'list') {
-    return { data: Object.keys(cronList || {}) };
-  }
-
-  if (!cronList[params.name]) {
-    return { message: `cron not found: ${params.name}`, status: 404 };
-  }
-
-  const result = await cronList[params.name](req);
-  return result;
-}
+import cronList from './utils/cronList.js';
+
+export default async function cronApi(req) {
+  const {
+    params = {}, user = {}, hostname,
+  } = req;
+
+  if ((!user.uid || !user.user_type?.includes('admin')) && !hostname?.includes('localhost')) {
+    return { message: 'access restricted', status: 403 };
+  }
+
+  if (params.name === 'list') {
+    return { data: Object.keys(cronList || {}) };
+  }
+
+  if (!cronList[params.name]) {
+    return { message: `cron not found: ${params.name}`, status: 404 };
+  }
+
+  const result = await cronList[params.name](req);
+  return result;
+}

package/cron/controllers/utils/cronList.js

@@ -1 +1 @@
-export default {};
+export default {};

package/cron/funcs/addCron.js

@@ -1,132 +1,132 @@
-import { createHash } from 'crypto';
-
-import cronList from '../controllers/utils/cronList.js';
-import getRedis from '../../redis/funcs/getRedis.js';
-import getPG from '../../pg/funcs/getPG.js';
-import config from '../../config.js';
-
-const md5 = (string) => createHash('md5').update(string).digest('hex');
-
-async function verifyUnique(name, rclient) {
-  const cronId = config.port || 3000 + md5(name);
-  // one per node check
-  const key = `cron:unique:${cronId}`;
-  const unique = await rclient.setnx(key, 1);
-  const ttl = await rclient.ttl(key);
-  if (!unique && ttl !== -1) {
-    return false;
-  }
-  await rclient.expire(key, 20);
-  return true;
-}
-
-const intervalStringMs = {
-  everyMin: 1000 * 60,
-  tenMin: 1000 * 60 * 10,
-  everyHour: 1000 * 60 * 60,
-  isHalfday: 1000 * 60 * 60 * 12,
-  dailyHour: 1000 * 60 * 60 * 24,
-};
-
-const interval2ms = {
-  string: (interval) => {
-    const date = new Date();
-    const intervarSplit = interval.match(/^(\*{2}|(\*)?(\d{1,2})):(\*(\d)|(\d{2}))/);
-    if (!intervarSplit) {
-      throw new Error(`interval ${interval} not suported`);
-    }
-    const [, , isHalfday, dailyHour, , tenMin, HourlyMin] = intervarSplit;
-    const intervalMs = (isHalfday && intervalStringMs.isHalfday)
-      || (dailyHour && intervalStringMs.dailyHour)
-      || (tenMin && intervalStringMs.tenMin)
-      || intervalStringMs.everyHour;
-    const offsetDay = ((+dailyHour || 0) * 60 + (+tenMin || +HourlyMin)) * 60 * 1000;
-    const offsetCur = (date - date.getTimezoneOffset() * 1000 * 60) % intervalMs;
-    const waitMs = (offsetDay - offsetCur + intervalMs) % intervalMs;
-    return [waitMs, intervalMs];
-  },
-  number: (interval) => {
-    const date = new Date();
-    const intervalMs = interval * 1000;
-    const dateWithTZ = date - date.getTimezoneOffset() * 1000 * 60;
-    const offsetCur = dateWithTZ % intervalMs;
-    // start every cron within 1 hour
-    const sixtyMinutesStartMs = 3600000;
-    const waitMs = (intervalMs - offsetCur) % sixtyMinutesStartMs;
-    return [waitMs, intervalMs];
-  },
-};
-
-async function runCron({
-  pg, funcs, func, name, rclient, log,
-}) {
-  const unique = await verifyUnique(name, rclient);
-
-  if (!unique) return;
-  const db = pg.options.database;
-  log.debug(`cron.${name}`, 1, db);
-  try {
-    const data = await func({ pg, funcs, log });
-    log.debug('cron', { db, name, result: data });
-    log.info('cron', { db, name, result: data });
-  }
-  catch (err) {
-    log.debug('cron', { db, name, error: err.toString() });
-    log.error('cron', { db, name, error: err.toString() });
-  }
-}
-
-/**
- * interval:
- * -   02:54 - every day
- * -    2:03 - every day
- * -   *1:43 - 2 times a day
- * -  *12:03 - 2 times a day
- * -   **:54 - every hour
- * -   **:*3 - every 10 minutes
- * -      60 - every minute
- * - 10 * 60 - every 10 minutes
- */
-
-export default async function addCron(func, interval, fastify) {
-  if (!fastify) {
-    throw new Error('not enough params: fastify');
-  }
-
-  const { log } = fastify;
-  const { time = {}, disabled = [] } = config.cron || {};
-  const pg = getPG();
-  const rclient = getRedis();
-
-  const name = func.name || func.toString().split('/').at(-1).split('\'')[0];
-
-  // if (!config.isServer) return;
-
-  if (disabled.includes(name)) {
-    log.debug('cron', { name, message: 'cron disabled' });
-    return;
-  }
-
-  cronList[name] = func;
-
-  const userInterval = time[name] || interval;
-  const [waitMs, intervalMs] = interval2ms[typeof interval](userInterval);
-
-  if (intervalMs < 1000) {
-    log.warn('cron', { name, error: `interval ${interval} to small` });
-    return;
-  }
-
-  // setTimeout to w8 for the time to start
-  setTimeout(() => {
-    runCron({
-      pg, funcs: fastify, func, name, rclient, log,
-    });
-    // interval
-    setInterval(() => {
-      runCron({
-        pg, funcs: fastify, func, name, rclient, log,
-      });
-    }, intervalMs);
-  }, waitMs);
-}
+import { createHash } from 'crypto';
+
+import cronList from '../controllers/utils/cronList.js';
+import getRedis from '../../redis/funcs/getRedis.js';
+import getPG from '../../pg/funcs/getPG.js';
+import config from '../../config.js';
+
+const md5 = (string) => createHash('md5').update(string).digest('hex');
+
+async function verifyUnique(name, rclient) {
+  const cronId = config.port || 3000 + md5(name);
+  // one per node check
+  const key = `cron:unique:${cronId}`;
+  const unique = await rclient.setnx(key, 1);
+  const ttl = await rclient.ttl(key);
+  if (!unique && ttl !== -1) {
+    return false;
+  }
+  await rclient.expire(key, 20);
+  return true;
+}
+
+const intervalStringMs = {
+  everyMin: 1000 * 60,
+  tenMin: 1000 * 60 * 10,
+  everyHour: 1000 * 60 * 60,
+  isHalfday: 1000 * 60 * 60 * 12,
+  dailyHour: 1000 * 60 * 60 * 24,
+};
+
+const interval2ms = {
+  string: (interval) => {
+    const date = new Date();
+    const intervarSplit = interval.match(/^(\*{2}|(\*)?(\d{1,2})):(\*(\d)|(\d{2}))/);
+    if (!intervarSplit) {
+      throw new Error(`interval ${interval} not suported`);
+    }
+    const [, , isHalfday, dailyHour, , tenMin, HourlyMin] = intervarSplit;
+    const intervalMs = (isHalfday && intervalStringMs.isHalfday)
+      || (dailyHour && intervalStringMs.dailyHour)
+      || (tenMin && intervalStringMs.tenMin)
+      || intervalStringMs.everyHour;
+    const offsetDay = ((+dailyHour || 0) * 60 + (+tenMin || +HourlyMin)) * 60 * 1000;
+    const offsetCur = (date - date.getTimezoneOffset() * 1000 * 60) % intervalMs;
+    const waitMs = (offsetDay - offsetCur + intervalMs) % intervalMs;
+    return [waitMs, intervalMs];
+  },
+  number: (interval) => {
+    const date = new Date();
+    const intervalMs = interval * 1000;
+    const dateWithTZ = date - date.getTimezoneOffset() * 1000 * 60;
+    const offsetCur = dateWithTZ % intervalMs;
+    // start every cron within 1 hour
+    const sixtyMinutesStartMs = 3600000;
+    const waitMs = (intervalMs - offsetCur) % sixtyMinutesStartMs;
+    return [waitMs, intervalMs];
+  },
+};
+
+async function runCron({
+  pg, funcs, func, name, rclient, log,
+}) {
+  const unique = await verifyUnique(name, rclient);
+
+  if (!unique) return;
+  const db = pg.options.database;
+  log.debug(`cron.${name}`, 1, db);
+  try {
+    const data = await func({ pg, funcs, log });
+    log.debug('cron', { db, name, result: data });
+    log.info('cron', { db, name, result: data });
+  }
+  catch (err) {
+    log.debug('cron', { db, name, error: err.toString() });
+    log.error('cron', { db, name, error: err.toString() });
+  }
+}
+
+/**
+ * interval:
+ * -   02:54 - every day
+ * -    2:03 - every day
+ * -   *1:43 - 2 times a day
+ * -  *12:03 - 2 times a day
+ * -   **:54 - every hour
+ * -   **:*3 - every 10 minutes
+ * -      60 - every minute
+ * - 10 * 60 - every 10 minutes
+ */
+
+export default async function addCron(func, interval, fastify) {
+  if (!fastify) {
+    throw new Error('not enough params: fastify');
+  }
+
+  const { log } = fastify;
+  const { time = {}, disabled = [] } = config.cron || {};
+  const pg = getPG();
+  const rclient = getRedis();
+
+  const name = func.name || func.toString().split('/').at(-1).split('\'')[0];
+
+  // if (!config.isServer) return;
+
+  if (disabled.includes(name)) {
+    log.debug('cron', { name, message: 'cron disabled' });
+    return;
+  }
+
+  cronList[name] = func;
+
+  const userInterval = time[name] || interval;
+  const [waitMs, intervalMs] = interval2ms[typeof interval](userInterval);
+
+  if (intervalMs < 1000) {
+    log.warn('cron', { name, error: `interval ${interval} to small` });
+    return;
+  }
+
+  // setTimeout to w8 for the time to start
+  setTimeout(() => {
+    runCron({
+      pg, funcs: fastify, func, name, rclient, log,
+    });
+    // interval
+    setInterval(() => {
+      runCron({
+        pg, funcs: fastify, func, name, rclient, log,
+      });
+    }, intervalMs);
+  }, waitMs);
+}

package/cron/index.js

@@ -1,10 +1,12 @@
-import cronApi from './controllers/cronApi.js';
-import addCron from './funcs/addCron.js';
-
-async function plugin(fastify, config = {}) {
-  const prefix = config.prefix || '/api';
-  fastify.decorate('addCron', addCron);
-  fastify.get(`${prefix}/cron/:name`, {}, cronApi);
-}
-
-export default plugin;
+import cronApi from './controllers/cronApi.js';
+import addCron from './funcs/addCron.js';
+
+import { cronSchema } from './schema.js'
+
+async function plugin(fastify, config = {}) {
+  const prefix = config.prefix || '/api';
+  fastify.decorate('addCron', addCron);
+  fastify.get(`${prefix}/cron/:name`, { schema: cronSchema }, cronApi);
+}
+
+export default plugin;

package/cron/schema.js

@@ -0,0 +1,8 @@
+const cronSchema = {
+  params: {
+    name: { type: 'string', pattern: '^([\\d\\w._-]+)$' },
+  },
+};
+
+export default null;
+export { cronSchema };

package/crud/controllers/deleteCrud.js

@@ -1,36 +1,36 @@
-import {
-  dataDelete, getTemplate, getAccess, applyHook, getToken, config,
-} from '../../utils.js';
-
-export default async function deleteCrud(req) {
-  const { user, params = {} } = req || {};
-  const hookData = await applyHook('preDelete', {
-    table: params?.table, id: params?.id, user,
-  });
-  if (hookData?.message && hookData?.status) {
-    return { message: hookData?.message, status: hookData?.status };
-  }
-
-  const tokenData = await getToken({
-    uid: user.uid, token: params.table, mode: 'w', json: 1,
-  });
-
-  const { table: del, id } = hookData || tokenData || (config.auth?.disable ? req.params : {});
-  const { actions = [] } = await getAccess({ table: del, id, user }) || {};
-
-  if (!actions.includes('del')) {
-    return { message: 'access restricted', status: 403 };
-  }
-  const loadTemplate = await getTemplate('table', del);
-
-  const { table } = loadTemplate || hookData || req.params || {};
-
-  if (!table) return { status: 404, message: 'table is required' };
-  if (!id) return { status: 404, message: 'id is required' };
-
-  const data = await dataDelete({
-    table, id, uid: user?.uid,
-  });
-
-  return { rowCount: data.rowCount, msg: !data.rowCount ? data : null };
-}
+import {
+  dataDelete, getTemplate, getAccess, applyHook, getToken, config,
+} from '../../utils.js';
+
+export default async function deleteCrud(req) {
+  const { user, params = {} } = req || {};
+  const hookData = await applyHook('preDelete', {
+    table: params?.table, id: params?.id, user,
+  });
+  if (hookData?.message && hookData?.status) {
+    return { message: hookData?.message, status: hookData?.status };
+  }
+
+  const tokenData = await getToken({
+    uid: user.uid, token: params.table, mode: 'w', json: 1,
+  });
+
+  const { table: del, id } = hookData || tokenData || (config.auth?.disable ? req.params : {});
+  const { actions = [] } = await getAccess({ table: del, id, user }) || {};
+
+  if (!actions.includes('del')) {
+    return { message: 'access restricted', status: 403 };
+  }
+  const loadTemplate = await getTemplate('table', del);
+
+  const { table } = loadTemplate || hookData || req.params || {};
+
+  if (!table) return { status: 404, message: 'table is required' };
+  if (!id) return { status: 404, message: 'id is required' };
+
+  const data = await dataDelete({
+    table, id, uid: user?.uid,
+  });
+
+  return { rowCount: data.rowCount, msg: !data.rowCount ? data : null };
+}

package/crud/controllers/insert.js

@@ -1,71 +1,71 @@
-import {
-  applyHook, getAccess, getTemplate, checkXSS, dataInsert, getToken, config,
-} from '../../utils.js';
-
-export default async function insert(req) {
-  const {
-    user, params = {}, body = {},
-  } = req || {};
-  const hookData = await applyHook('preInsert', { table: params?.table, user });
-  if (hookData?.message && hookData?.status) {
-    return { message: hookData?.message, status: hookData?.status };
-  }
-  const tokenData = await getToken({
-    uid: user.uid, token: params.table, mode: 'a', json: 1,
-  });
-
-  const { form, table: add } = hookData || tokenData || (config.auth?.disable ? req.params : {});
-
-  const { actions = [] } = await getAccess({ table: add, user }) || {};
-
-  if (!actions.includes('add')) return { message: 'access restricted', status: 403 };
-
-  if (!add) {
-    return { message: 'table is required', status: 400 };
-  }
-
-  const loadTemplate = await getTemplate('table', add);
-  const { table } = loadTemplate || hookData || req.params || {};
-  if (!table) {
-    return { message: 'table not found', status: 404 };
-  }
-
-  const formData = form || loadTemplate?.form ? (await getTemplate('form', form || loadTemplate?.form) || {}) : {};
-
-  const xssCheck = checkXSS({ body, schema: formData?.schema || formData });
-
-  if (xssCheck.error && formData?.xssCheck !== false) {
-    req.log.warn({ name: 'injection/xss', msg: xssCheck.error, table }, req);
-    return { message: 'Дані містять заборонені символи. Приберіть їх та спробуйте ще раз', status: 409 };
-  }
-
-  const uid = user?.uid;
-  if ((add || table) !== 'admin.users') {
-    Object.assign(body, { uid, editor_id: uid });
-  }
-  const res = await dataInsert({
-    table: loadTemplate?.table, data: body, uid,
-  });
-
-  // admin.custom_column
-  await applyHook('afterInsert', {
-    table, body, payload: res, user,
-  });
-  // form DataTable
-  const extraKeys = Object.keys(formData)?.filter((key) => formData?.[key]?.type === 'DataTable' && formData?.[key]?.table && formData?.[key]?.parent_id && body[key].length);
-  if (extraKeys?.length) {
-    res.extra = {};
-    await Promise.all(extraKeys?.map(async (key) => {
-      const objId = body[formData[key].parent_id] || req.body?.id;
-      const extraRows = await Promise.all(body[key].map(async (row) => {
-        const extraRes = await dataInsert({
-          table: formData[key].table, data: { ...row, [formData[key].parent_id]: objId }, uid,
-        });
-        return extraRes?.rows?.[0];
-      }));
-      Object.assign(res.extra, { [key]: extraRows.filter((el) => el) });
-    }));
-  }
-
-  return { rows: res.rows, extra: res.extra };
-}
+import {
+  applyHook, getAccess, getTemplate, checkXSS, dataInsert, getToken, config,
+} from '../../utils.js';
+
+export default async function insert(req) {
+  const {
+    user, params = {}, body = {},
+  } = req || {};
+  const hookData = await applyHook('preInsert', { table: params?.table, user });
+  if (hookData?.message && hookData?.status) {
+    return { message: hookData?.message, status: hookData?.status };
+  }
+  const tokenData = await getToken({
+    uid: user.uid, token: params.table, mode: 'a', json: 1,
+  });
+
+  const { form, table: add } = hookData || tokenData || (config.auth?.disable ? req.params : {});
+
+  const { actions = [] } = await getAccess({ table: add, user }) || {};
+
+  if (!actions.includes('add')) return { message: 'access restricted', status: 403 };
+
+  if (!add) {
+    return { message: 'table is required', status: 400 };
+  }
+
+  const loadTemplate = await getTemplate('table', add);
+  const { table } = loadTemplate || hookData || req.params || {};
+  if (!table) {
+    return { message: 'table not found', status: 404 };
+  }
+
+  const formData = form || loadTemplate?.form ? (await getTemplate('form', form || loadTemplate?.form) || {}) : {};
+
+  const xssCheck = checkXSS({ body, schema: formData?.schema || formData });
+
+  if (xssCheck.error && formData?.xssCheck !== false) {
+    req.log.warn({ name: 'injection/xss', msg: xssCheck.error, table }, req);
+    return { message: 'Дані містять заборонені символи. Приберіть їх та спробуйте ще раз', status: 409 };
+  }
+
+  const uid = user?.uid;
+  if ((add || table) !== 'admin.users') {
+    Object.assign(body, { uid, editor_id: uid });
+  }
+  const res = await dataInsert({
+    table: loadTemplate?.table, data: body, uid,
+  });
+
+  // admin.custom_column
+  await applyHook('afterInsert', {
+    table, body, payload: res, user,
+  });
+  // form DataTable
+  const extraKeys = Object.keys(formData)?.filter((key) => formData?.[key]?.type === 'DataTable' && formData?.[key]?.table && formData?.[key]?.parent_id && body[key].length);
+  if (extraKeys?.length) {
+    res.extra = {};
+    await Promise.all(extraKeys?.map(async (key) => {
+      const objId = body[formData[key].parent_id] || req.body?.id;
+      const extraRows = await Promise.all(body[key].map(async (row) => {
+        const extraRes = await dataInsert({
+          table: formData[key].table, data: { ...row, [formData[key].parent_id]: objId }, uid,
+        });
+        return extraRes?.rows?.[0];
+      }));
+      Object.assign(res.extra, { [key]: extraRows.filter((el) => el) });
+    }));
+  }
+
+  return { rows: res.rows, extra: res.extra };
+}