@opengis/bi 1.0.1

package/.eslintrc.cjs

@@ -0,0 +1,42 @@
+/* eslint-env node */
+//require('@rushstack/eslint-patch/modern-module-resolution');
+
+module.exports = {
+  root: true,
+  extends: [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting',
+    'airbnb-base',
+  ],
+  parserOptions: {
+    ecmaVersion: 2024,
+    sourceType: 'module',
+  },
+  rules: {
+    'brace-style': [2, 'stroustrup', { allowSingleLine: true }],
+    'vue/max-attributes-per-line': 0,
+    'vue/valid-v-for': 0,
+
+    // allow async-await
+    'generator-star-spacing': 'off',
+
+    // allow paren-less arrow functions
+    'arrow-parens': 0,
+    'one-var': 0,
+    'max-len': 0,
+    'import/first': 0,
+    'import/named': 2,
+    'import/namespace': 2,
+    'import/default': 2,
+    'import/export': 2,
+    'import/extensions': 0,
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+    'import/no-unresolved': 0,
+    'import/no-extraneous-dependencies': 0,
+    'linebreak-style': ['error', 'unix'],
+    // allow debugger during development
+    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
+  },
+};

package/.prettierrc.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": true,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none",
+  "endOfLine": "lf"
+}

package/README.md

@@ -0,0 +1,22 @@
+# bi
+
+[![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 bi visualization process:
+
+## Install
+
+```bash
+npm i @opengis/bi
+```
+
+## Usage
+
+```js
+fastify.register(import('@opengis/bi'), config);
+```
+
+## Documenation
+
+For a detailed understanding fastify-table, its features, and how to use them, refer to our [Documentation](https://apidocs.softpro.ua/bi/api/).

package/config.example

@@ -0,0 +1,21 @@
+{
+    "folder": "M:/work/geo/storage",
+    "templateDir": "test/templates",
+    "pg": {
+        "host": "192.168.3.160",
+        "port": 5432,
+        "database": "geo_green_poltava",
+        "user": "postgres",
+        "password": "postgres"
+    },
+    "redis": {
+        "host": "192.168.3.160",
+        "port": 6379,
+        "family": 4
+    },
+    "prefix": "/api",
+    "signServerAddress": "192.168.3.160:4001",
+    "mapServerAddress": "192.168.3.160:4002",
+    "convertServerAddress": "192.168.3.160:4003",
+    "gdalServerAddress": "192.168.3.160:4005"
+}

package/config.js

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

package/dashboard/controllers/dashboard.js

@@ -0,0 +1,22 @@
+
+
+//import { existsSync, readFileSync } from 'fs';
+
+import yaml from './utils/yaml.js';
+import getTemplate from '@opengis/fastify-table/table/controllers/utils/getTemplate.js';
+
+export default async function data({ params, query = {} }) {
+
+  const { id, } = params;
+
+
+  if (!id) {
+    return { message: 'not enough params: dashboard required', status: 400 };
+  }
+
+  const yml = await getTemplate('dashboard', id);
+  if (!yml) return { message: 'not found ' + id, status: 404 };
+  const data = yaml.loadSafe(yml);
+  return data
+
+}

package/dashboard/controllers/data.js

@@ -0,0 +1,108 @@
+import path from 'path';
+import getTemplate from '@opengis/fastify-table/table/controllers/utils/getTemplate.js';
+import autoIndex from '@opengis/fastify-table/pg/funcs/autoIndex.js';
+import pgClients from '@opengis/fastify-table/pg/pgClients.js';
+
+//import { existsSync, readFileSync } from 'fs';
+
+import yaml from './utils/yaml.js';
+
+export default async function data({ pg = pgClients.client, funcs, query = {} }) {
+  const time = Date.now();
+  const {
+    dashboard, chart, filter,
+  } = query;
+
+  if (!chart && !dashboard) {
+    return { message: 'not enough params: chart or dashboard required', status: 400 };
+  }
+
+  const yml = await getTemplate('chart', chart);
+  if (!yml) return { message: 'not found ' + chart, status: 404 };
+  const { data, options, controls } = yaml.loadSafe(yml);
+
+  if (!data?.source) {
+    return { error: json.error || `invalid ${chart ? 'chart' : 'dashboard'}`, status: 500 };
+  }
+
+
+  const granularity = query.granularity || data.granularity || 'month';
+
+  const dimension = (data?.time ? `date_trunc('${granularity}',${data?.time})::date` : null) || data.dimension?.[0]?.name || data.dimension;
+  const metric = data.metrics?.map(el => `${el.operator || 'sum'}(${el.name}) as "${el.title || el.name}"`) || 'count(*)';
+  const groupby = query.groupby || data.groupby?.[0] || data.groupby;
+
+  // filter rows
+  const fData = filter ? await funcs.getFilterSQL({
+    filter, table: json.data.source, json: 1,
+  }) : {};
+
+
+  if (data.columns) {
+    const sql = `select ${data.columns.map(el => el.name || el)}::text from ${data.source} where ${data.query || '1=1'} limit 20 `;
+    const { rows } = await pg.query(sql); // test with limit
+    return { count: rows.length, rows, options }
+  }
+  // auto Index
+  autoIndex({ table: data.source, columns: [data?.time].concat([dimension]).concat([groupby]).filter(el => el) })
+
+
+
+
+
+  const groupSQL = `select ${groupby}::text as x,count(*) from ${data.source} where ${groupby} is not null  group by ${groupby} order by count(*) desc limit 10 `;
+  const { rows: groups } = groupby ? await pg.query(groupSQL) : {}; // test with limit
+  const groupMetric = data.metrics?.map(el => `${el.operator || 'sum'}(${el.name || el})`)?.[0] || 'count(*)';
+
+  // scratch, rewrite 2015, 2016 as separate columns
+  // const { rows: granularityDimensions } = await pg.query('select json_array_elements_text($1)', [granularities]);
+
+  const sql = `select ${dimension}::text as ${(data.time ? granularity : null) || dimension || 'x'} , ${metric}
+  ${groups?.length ? ',' : ''}   ${groups?.map(el => `${groupMetric} filter(where ${groupby} = '${el.x}') as "${el.x}"`).join(',') || ''}
+  from ${data.source}   
+  where ${data.query || '1=1'} 
+  group by ${dimension}`;
+
+  if (query.sql) return sql;
+
+  const { rows, fields } = await pg.query(sql); // test with limit
+  const dimensions = fields.map(el => el.name)
+  // return result
+  const res = {
+    time: Date.now() - time,
+    dimensions,
+    source: rows,
+
+    options,
+    controls,
+  };
+  /*
+  source: [
+      {
+        product: 'Matcha Latte',
+        2015: 43.3,
+        2016: 85.8,
+        2017: 93.7,
+      },
+      {
+        product: 'Milk Tea',
+        2015: 83.1,
+        2016: 73.4,
+        2017: 55.1,
+      },
+      {
+        product: 'Cheese Cocoa',
+        2015: 86.4,
+        2016: 65.2,
+        2017: 82.5,
+      },
+      {
+        product: 'Walnut Brownie',
+        2015: 72.4,
+        2016: 53.9,
+        2017: 39.1,
+      },
+    ],
+  */
+  return res;
+}

package/dashboard/controllers/geojson.js

@@ -0,0 +1,3 @@
+export default async function geojson(req) {
+  return { test: '2' };
+}

package/dashboard/controllers/utils/yaml.js

@@ -0,0 +1,12 @@
+import yaml from 'js-yaml';
+
+yaml.loadSafe = (yml) => {
+  try {
+    return yaml.load(yml);
+  }
+  catch (err) {
+    return { error: err.toString() };
+  }
+};
+
+export default yaml;

package/dashboard/controllers/vtile.js

@@ -0,0 +1,3 @@
+export default async function vtile(req) {
+  return { test: '3' };
+}

package/dashboard/index.mjs

@@ -0,0 +1,35 @@
+const schemaInfo = {};
+
+import config from '../config.js';
+
+import data from './controllers/data.js';
+import dashboard from './controllers/dashboard.js';
+import geojson from './controllers/geojson.js';
+import vtile from './controllers/vtile.js';
+
+export default async function route(fastify, opts) {
+  const prefix = opts?.prefix || config.prefix || '/api';
+  fastify.route({
+    method: 'GET',
+    url: `${prefix}/bi-data`,
+    schema: schemaInfo,
+    handler: data,
+  });
+  fastify.route({
+    method: 'GET',
+    url: `${prefix}/bi-dashboard/:id`,
+    handler: dashboard,
+  });
+  fastify.route({
+    method: 'GET',
+    url: `${prefix}/bi-geojson`,
+    schema: schemaInfo,
+    handler: geojson,
+  });
+  fastify.route({
+    method: 'GET',
+    url: `${prefix}/bi-vtile`,
+    schema: schemaInfo,
+    handler: vtile,
+  });
+}

package/helper.js

@@ -0,0 +1,34 @@
+// This file contains code that we reuse
+// between our tests.
+import Fastify from 'fastify';
+import rclient from '@opengis/fastify-table/redis/client.js';
+import pgClients from '@opengis/fastify-table/pg/pgClients.js';
+
+import config from './test/config.js';
+import appService from './index.js';
+
+// automatically build and tear down our instance
+async function build(t) {
+  await pgClients.client.init()
+  // you can set all the options supported by the fastify CLI command
+  // const argv = [AppPath]
+  process.env.NODE_ENV = 'production';
+  const app = Fastify({ logger: false });
+  app.register(appService, config);
+
+  // unit test
+  // app.register(import('@opengis/fastify-table'), config);
+  // app.register(import('../../../npm/fastify-table/index.js'), config);
+
+  // close the app after we are done
+  t.after(() => {
+    // console.log('close app');
+    pgClients.client?.end();
+    rclient?.quit();
+    app.close();
+  });
+
+  return app;
+}
+
+export default build;

package/index.js

@@ -0,0 +1,28 @@
+import fp from 'fastify-plugin';
+import config from './config.js';
+
+import biPlugin from './dashboard/index.mjs';
+
+async function plugin(fastify, opt) {
+  config.folder = opt.folder;
+  config.root = opt.root;
+
+  config.funcs = fastify;
+  config.pg = opt.pg;
+  config.redis = opt.redis;
+  config.s3 = opt.s3;
+
+  // independent npm start / unit test
+  if (!fastify.config) {
+    fastify.decorate('config', config);
+  }
+
+  if (!fastify.funcs) {
+    fastify.addHook('onRequest', async (req) => {
+      req.funcs = fastify;
+    });
+  }
+
+  biPlugin(fastify); // { prefix: config.prefix }
+}
+export default fp(plugin);

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@opengis/bi",
+  "version": "1.0.1",
+  "description": "BI data visualization module",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
+    "test": "node --test"
+  },
+  "keywords": [],
+  "author": "Softpro",
+  "license": "ISC",
+  "dependencies": {
+    "fastify": "^4.26.1",
+    "fastify-plugin": "^4.0.0",
+    "@opengis/fastify-table": "^1.0.36",
+    "js-yaml": "^4.1.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.49.0",
+    "eslint-config-airbnb": "^19.0.4"
+  }
+}

package/server.js

@@ -0,0 +1,14 @@
+// This file contains code that we reuse
+// between our tests.
+import Fastify from 'fastify';
+import config from './test/config.js';
+import appService from './index.js';
+
+const app = Fastify({ logger: false });
+app.register(appService, config);
+app.listen({ host: '0.0.0.0', port: process.env.PORT || 3000 }, (err) => {
+  if (err) {
+    app.log.error(err);
+    process.exit(1);
+  }
+});

package/test/config.example

@@ -0,0 +1,18 @@
+import config from '../config.js';
+
+Object.assign(config, {
+  templateDir: 'test/templates',
+  pg: {
+    host: '192.168.3.160',
+    port: 5434,
+    database: 'mbk_rivne_dma',
+    user: 'postgres',
+    password: 'postgres',
+  },
+  redis: {
+    host: '192.168.3.160',
+    port: 6379,
+    family: 4,
+  },
+});
+export default config;

package/test/config.js

@@ -0,0 +1,19 @@
+import config from '../config.js';
+
+Object.assign(config, {
+  templateDir: 'test/templates',
+  pg: config.pg || {
+    host: '192.168.3.160',
+    port: 5432,
+    database: 'geo_green_poltava',
+    user: 'postgres',
+    password: 'postgres',
+  },
+  redis: config.redis || {
+    host: '192.168.3.160',
+    port: 6379,
+    family: 4,
+  },
+});
+
+export default config;

package/test/plugins/bi.test.js

@@ -0,0 +1,76 @@
+import { test } from 'node:test';
+import assert from 'node:assert';
+
+import build from '../../helper.js';
+
+import config from '../config.js';
+
+test('api crud', async (t) => {
+  const app = await build(t);
+  const prefix = config.prefix || '/api';
+
+  // 2 metric + dimension 
+  await t.test('GET /bi-data', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/bi-data`,
+      query: { chart: 'bar.zone' }
+    });
+
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep.source);
+  });
+
+  //  count + time  
+  await t.test('GET /bi-data', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/bi-data`,
+      query: { chart: 'user' }
+    });
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep.source);
+  });
+
+  //  dimension + groupby
+  await t.test('GET /bi-data', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/bi-data`,
+      query: { chart: 'user' }
+    });
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep.source);
+  });
+
+  await t.test('GET /bi-data', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/bi-data`,
+      query: { chart: 'bar.zone' }
+    });
+
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep.source);
+  });
+
+  await t.test('GET /bi-vtile', async () => {
+    const res = await app.inject({
+      method: 'GET',
+      url: `${prefix}/bi-vtile`,
+    });
+
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep);
+  });
+
+  await t.test('GET /bi-geojson', async () => {
+    const res = await app.inject({
+      method: 'DELETE',
+      url: `${prefix}/bi-geojson`,
+    });
+
+    const rep = JSON.parse(res?.body);
+    assert.ok(rep);
+  });
+});

package/test/templates/chart/bar.zone.yml

@@ -0,0 +1,23 @@
+data:
+  source: itree.rest_zones # Назва таблиці
+  query: 1=1 # Запит
+
+  dimension: category
+  groupby1: [verif]
+  metrics: # Групування
+    - name: area
+      operator: sum
+      title: Площа
+    - name: area
+      operator: count
+      title: Кількість
+
+controls: [invertAxis, details, switcher]
+filters:
+  - name: cdate
+    type: date
+    default: year
+    title: Дата внесення у БД
+  - name: katotg
+    type: text
+    title: КАТОТТГ

package/test/templates/chart/histogram.yml

@@ -0,0 +1,14 @@
+data:
+  source: itree.rest_zones # Назва таблиці
+  query: uid is null # Запит
+  metrics: # Групування
+    - name: ownership
+      title: Форма власності
+  time: cdate
+  granularity: month
+
+options:
+  formats:
+    - name: metric
+      type: histogram, background
+      color: blue [red,blue]

package/test/templates/chart/line.yml

@@ -0,0 +1,16 @@
+data:
+  source: itree.rest_zones # Назва таблиці
+  query: uid is null # Запит
+
+  metrics: # Групування
+    - name: monetary_valuation
+      title: Нормативна грошова оцінка, грн
+  dimension:
+    - name: balancer
+      title: Балансоутримувач об'єкта
+
+options:
+  formats:
+    - name: metric
+      type: histogram, background
+      color: blue [red,blue]

package/test/templates/chart/pivot.yml

@@ -0,0 +1,11 @@
+data:
+  source: itree.rest_zones # Назва таблиці
+  query: 1=1 # Запит
+
+  time: cdate
+  granularity: month
+  groupby: [category]
+  metrics: # Групування
+    - name: area
+      operator: count
+      title: Площа

package/test/templates/chart/table.yml

@@ -0,0 +1,15 @@
+data:
+  source: itree.rest_zones # Назва таблиці
+  query: uid is null # Запит
+
+  columns:
+    - name
+    - ownership
+    - purpose
+
+type: table
+options:
+  formats:
+    - name: metric
+      type: table, background
+      color: blue [red,blue]

package/test/templates/chart/test.map.yml

@@ -0,0 +1,28 @@
+data:
+  source: data_address.addr_city        # Назва таблиці
+  query: verified                       # Запит
+  
+  columns: 
+  - city_name
+  - city_koatuu
+
+  geom: geom
+
+  country: ua
+
+  cluster:                              # закачати через cdn
+  - region
+  - community       
+
+controls: []
+
+options:
+  style:
+    color: red
+    size: 5
+  colorAttr: status
+
+filters: 
+  - name: cdate
+    type: date
+    title: Creation year

package/test/templates/chart/user.yml

@@ -0,0 +1,7 @@
+data:
+  source: crm_acc.crm_contact # Назва таблиці
+  query: uid is null # Запит
+
+  title: Дата
+  time: cdate
+  granularity: month

package/test/templates/dashboard/dashboard1.yml

@@ -0,0 +1,11 @@
+title: Audience
+description: Understand your audience
+panels:
+  - chart: line
+    type: line
+    title: Daily Active Users
+    col: 6
+  - chart: bar.zone
+    type: bar
+  - chart: table
+    type: table