@underpostnet/underpost 2.7.9

package/conf.js

@@ -0,0 +1,265 @@
+const DefaultConf = {
+  client: {
+    default: {
+      metadata: {
+        title: 'Demo App',
+        backgroundImage: './src/client/public/default/assets/background/white0-min.jpg',
+        description: 'Web application',
+        keywords: ['web', 'app', 'spa', 'demo', 'github-pages'],
+        author: 'https://github.com/underpostnet',
+        thumbnail: 'android-chrome-384x384.png',
+        themeColor: '#ececec',
+        pwaAssetsPath: '',
+      },
+      components: {
+        core: [
+          'CommonJs',
+          'VanillaJs',
+          'Responsive',
+          'Keyboard',
+          'Translate',
+          'Modal',
+          'BtnIcon',
+          'Logger',
+          'Css',
+          'NotificationManager',
+          'ToggleSwitch',
+          'DropDown',
+          'LoadingAnimation',
+          'EventsUI',
+          'AgGrid',
+          'Input',
+          'Validator',
+          'SignUp',
+          'LogIn',
+          'LogOut',
+          'Router',
+          'Account',
+          'Auth',
+          'FullScreen',
+          'RichText',
+          'CalendarCore',
+          'D3Chart',
+          'Stream',
+          'SocketIo',
+          'Docs',
+          'Content',
+          'FileExplorer',
+          'Chat',
+          'Worker',
+          'CssCore',
+          'Wallet',
+          'Badge',
+          'ToolTip',
+          'Webhook',
+          'Recover',
+          'Panel',
+          'PanelForm',
+          'Scroll',
+        ],
+        default: [
+          'MenuDefault',
+          'RoutesDefault',
+          'ElementsDefault',
+          'CommonDefault',
+          'CssDefault',
+          'LogInDefault',
+          'LogOutDefault',
+          'SignUpDefault',
+          'TranslateDefault',
+          'SettingsDefault',
+          'SocketIoDefault',
+        ],
+      },
+      views: [
+        {
+          path: '/',
+          title: 'Home',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/home',
+          title: 'Home',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/settings',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/log-in',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/sign-up',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/log-out',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/account',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/docs',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/recover',
+          client: 'Default',
+          ssr: 'Default',
+        },
+        {
+          path: '/default-management',
+          client: 'Default',
+          ssr: 'Default',
+        },
+      ],
+      dists: [
+        {
+          folder: './node_modules/@neodrag/vanilla/dist/min',
+          public_folder: '/dist/@neodrag-vanilla',
+          import_name: '@neodrag/vanilla',
+          import_name_build: '/dist/@neodrag-vanilla/index.js',
+        },
+        {
+          folder: './node_modules/@fortawesome/fontawesome-free',
+          public_folder: '/dist/fontawesome',
+        },
+        {
+          folder: './node_modules/sortablejs/modular',
+          public_folder: '/dist/sortablejs',
+          import_name: 'sortablejs',
+          import_name_build: '/dist/sortablejs/sortable.complete.esm.js',
+        },
+        {
+          folder: './node_modules/validator',
+          public_folder: '/dist/validator',
+        },
+        {
+          folder: './node_modules/@loadingio/css-spinner/entries',
+          public_folder: '/dist/loadingio',
+        },
+        {
+          import_name: 'ag-grid-community',
+          import_name_build: '/dist/ag-grid-community/ag-grid-community.auto.complete.esm.min.js',
+          folder: './node_modules/ag-grid-community/dist',
+          public_folder: '/dist/ag-grid-community',
+          styles: './node_modules/ag-grid-community/styles',
+          public_styles_folder: '/styles/ag-grid-community',
+        },
+        {
+          folder: './node_modules/socket.io/client-dist',
+          public_folder: '/dist/socket.io',
+          import_name: 'socket.io/client-dist/socket.io.esm.min.js',
+          import_name_build: '/dist/socket.io/socket.io.esm.min.js',
+        },
+        {
+          folder: './node_modules/peerjs/dist',
+          public_folder: '/dist/peerjs',
+        },
+      ],
+      services: ['default', 'core', 'user', 'test', 'file'],
+    },
+  },
+  ssr: {
+    Default: {
+      head: ['Seo', 'Pwa', 'Css', 'DefaultScripts', 'Production'],
+      body: ['CacheControl', 'DefaultSplashScreen'],
+    },
+  },
+  server: {
+    'default.net': {
+      '/': {
+        client: 'default',
+        runtime: 'nodejs',
+        apis: ['default', 'core', 'user', 'test', 'file'],
+        origins: [],
+        minifyBuild: false,
+        iconsBuild: true,
+        liteBuild: false,
+        docsBuild: false,
+        ws: 'core',
+        peer: true,
+        proxy: [80, 443],
+        db: {
+          provider: 'mongoose',
+          host: 'mongodb://127.0.0.1:27017',
+          name: 'default',
+        },
+        mailer: {
+          sender: {
+            email: 'noreply@default.net',
+            name: 'Default',
+          },
+          transport: {
+            host: 'smtp.default.com',
+            port: 465,
+            secure: true,
+            auth: {
+              user: 'noreply@default.net',
+              pass: '',
+            },
+          },
+          templates: {
+            userVerifyEmail: 'DefaultVerifyEmail',
+            userRecoverEmail: 'DefaultRecoverEmail',
+          },
+        },
+      },
+    },
+    'www.default.net': {
+      '/': {
+        client: null,
+        runtime: 'nodejs',
+        apis: [],
+        origins: [],
+        minifyBuild: false,
+        liteBuild: true,
+        proxy: [80, 443],
+      },
+    },
+  },
+  cron: {
+    ipDaemon: {
+      ip: null,
+    },
+    records: {
+      A: [
+        {
+          host: 'example.com',
+          dns: 'dondominio',
+          api_key: '???',
+          user: '???',
+        },
+      ],
+    },
+    backups: [
+      {
+        deployGroupId: 'default-group',
+      },
+    ],
+    jobs: {
+      dns: {
+        expression: '* * * * *',
+        enabled: true,
+      },
+      backups: {
+        expression: '0 1 * * *',
+        enabled: true,
+      },
+    },
+  },
+};
+
+export { DefaultConf };

package/docker-compose.yml

@@ -0,0 +1,67 @@
+# https://docs.docker.com/compose/compose-file/compose-file-v3
+# https://docs.docker.com/engine/reference/commandline/compose/
+version: '3'
+services:
+  prometheus:
+    image: prom/prometheus
+    ports:
+      - 9090:9090
+    volumes:
+      - ./prometheus_data:/prometheus
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+    networks:
+      - load-balancer
+
+  grafana:
+    image: grafana/grafana
+    ports:
+      - 3000:3000
+    volumes:
+      - ./grafana_data:/var/lib/grafana
+    #  - ./grafana.ini:/etc/grafana/grafana.ini
+    networks:
+      - load-balancer
+    depends_on:
+      - prometheus
+
+  underpost-engine:
+    build:
+      dockerfile: ./Dockerfile
+      context: . # workdir path
+    # image: underpost-engine
+    # container_name: <name> ignore for replicas
+    ports:
+      - '22'
+      - '80' # host port allocated dynamically, host ports are unique independent of replicas
+      - '443'
+      - '3306'
+      - '27017'
+      - '4001-4002:3001'
+      - '3002-3020'
+    volumes:
+      - ./logs:/code/logs
+    deploy:
+      mode: replicated
+      replicas: 2
+      restart_policy:
+        condition: on-failure
+        delay: 5s
+        max_attempts: 3
+        window: 120s
+      resources:
+        limits:
+          cpus: '2'
+          memory: 400M
+        reservations:
+          cpus: '0.25'
+          memory: 20M
+    labels: # labels in Compose file instead of Dockerfile
+      engine.version: '2.7.9'
+    networks:
+      - load-balancer
+
+networks:
+  load-balancer:
+    driver: bridge

package/jsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "target": "ES6"
+  },
+  "exclude": ["node_modules", "public", "engine-private"]
+}

package/jsdoc.json

@@ -0,0 +1,32 @@
+{
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc"]
+  },
+  "source": {
+    "include": ["./src", "./package.json", "./README.md"],
+    "includePattern": ".js$",
+    "excludePattern": "(node_modules/|docs)"
+  },
+  "plugins": ["plugins/markdown", "plugins/summarize", "plugins/shout"],
+  "opts": {
+    "template": "node_modules/clean-jsdoc-theme",
+    "readme": "./README.md",
+    "recurse": true,
+    "destination": "./public/www.nexodev.org/docs/",
+    "encoding": "utf8",
+    "verbose": true,
+    "theme_opts": {
+      "default_theme": "light",
+      "search": true,
+      "title": "Nexodev - ERP, CRM Development & Cloud DevOps Services",
+      "homepageTitle": "Docs",
+      "favicon": "./public/www.nexodev.org/"
+    },
+    "tutorials": "./public/www.nexodev.org/docs/learn"
+  },
+  "markdown": {
+    "hardwrap": false,
+    "idInHeadings": true
+  }
+}

package/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["./src"],
+  "ext": "js",
+  "delay": 0,
+  "ignore": []
+}

package/package.json

@@ -0,0 +1,134 @@
+{
+    "type": "module",
+    "main": "src/index.js",
+    "name": "@underpostnet/underpost",
+    "version": "2.7.9",
+    "description": "pwa api rest template",
+    "scripts": {
+        "start": "env-cmd -f .env.production node --max-old-space-size=8192 src/server",
+        "pm2": "env-cmd -f .env.production pm2 start src/server.js --node-args=\"--max-old-space-size=8192\" --name engine && pm2 logs",
+        "ssl": "env-cmd -f .env.production node bin/ssl",
+        "pm2-delete": "pm2 delete engine",
+        "build": "node bin/deploy build-full-client",
+        "build-production": "env-cmd -f .env.production node bin/deploy build-full-client",
+        "dev": "env-cmd -f .env.development node src/client.dev --no-warnings",
+        "dev-api": "env-cmd -f .env.development nodemon --watch src --ignore src/client src/api",
+        "docs": "jsdoc -c jsdoc.json",
+        "backup": "node bin/db default.net/ export",
+        "install-template": "npm install && npm run build",
+        "install-global": "npm install -g pm2 && npm install -g jsdoc && npm install -g prettier && npm install -g env-cmd && npm install -g yarn && npm install -g auto-changelog",
+        "install-test": "npm install -g mocha && npm install -g c8 && npm install -g nyc && npm install -g coveralls",
+        "install-vs-extensions": "node bin/vs import",
+        "preinstall": "npm config set audit false && npm config set loglevel error",
+        "restore-preinstall": "npm config set audit true && npm config set loglevel notice",
+        "install": "npm run install-global && npm run install-test && npm run restore-preinstall --no-audit --no-warnings",
+        "docker:start": "docker-compose up",
+        "prettier": "prettier --write .",
+        "coveralls": "nyc npm run test --reporter=text-lcov | coveralls -v",
+        "test": "env-cmd -f .env.test c8 mocha",
+        "update": "npm update -g && npm update && npm audit fix --force && npm audit fix --force",
+        "underpost-publish": "npm publish --provenance --access public",
+        "underpost-unpublish": "npm unpublish underpost@2.5.x",
+        "login": "npm adduser",
+        "bin": "npm link --force"
+    },
+    "bin": {
+        "underpost": "bin/index.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/underpostnet/pwa-microservices-template-ghpkg.git"
+    },
+    "keywords": [
+        "engine",
+        "server",
+        "proxy",
+        "client"
+    ],
+    "author": "https://github.com/underpostnet",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/underpostnet/pwa-microservices-template/issues"
+    },
+    "homepage": "https://github.com/underpostnet/pwa-microservices-template#readme",
+    "dependencies": {
+        "@fortawesome/fontawesome-free": "^6.4.2",
+        "@loadingio/css-spinner": "^2.0.2",
+        "@neodrag/vanilla": "^2.0.3",
+        "@xenova/transformers": "^2.17.2",
+        "adm-zip": "^0.5.10",
+        "ag-grid-community": "31.0.0",
+        "axios": "^1.5.1",
+        "chai": "^5.1.0",
+        "cli-progress": "^3.12.0",
+        "cli-spinners": "^3.0.0",
+        "color": "^4.2.3",
+        "colors": "^1.4.0",
+        "commander": "^12.1.0",
+        "compression": "^1.7.4",
+        "copy-paste": "^1.5.3",
+        "cors": "^2.8.5",
+        "d3": "^7.9.0",
+        "deepmerge": "^4.3.1",
+        "detect-port": "^1.5.1",
+        "dotenv": "^16.3.1",
+        "easymde": "^2.18.0",
+        "env-cmd": "^10.1.0",
+        "eventemitter3": "^5.0.1",
+        "express": "^4.18.2",
+        "express-fileupload": "^1.4.3",
+        "favicons": "^7.2.0",
+        "font-awesome-assets": "^0.0.9",
+        "fs-extra": "^11.1.1",
+        "fullcalendar": "^6.1.15",
+        "html-minifier-terser": "^7.2.0",
+        "http-proxy-middleware": "^2.0.6",
+        "ignore-walk": "^6.0.4",
+        "is-admin": "^4.0.0",
+        "is-ip": "^5.0.1",
+        "jimp": "^0.22.12",
+        "joystick-controller": "^1.0.15",
+        "json-colorizer": "^2.2.2",
+        "jsonwebtoken": "^9.0.2",
+        "kill-port-process": "^3.2.0",
+        "log-update": "^6.0.0",
+        "mariadb": "^3.2.2",
+        "marked": "^12.0.2",
+        "mongoose": "^8.0.1",
+        "morgan": "^1.10.0",
+        "nodemailer": "^6.9.9",
+        "nodemon": "^3.0.1",
+        "pathfinding": "^0.4.18",
+        "peer": "^1.0.2",
+        "peerjs": "^1.5.2",
+        "pixi.js": "7.4.0",
+        "prom-client": "^15.1.2",
+        "public-ip": "^6.0.1",
+        "read": "^2.1.0",
+        "sharp": "^0.32.5",
+        "shelljs": "^0.8.5",
+        "simple-git": "^3.26.0",
+        "simple-icons": "^13.9.0",
+        "sitemap": "^7.1.1",
+        "socket.io": "^4.8.0",
+        "sortablejs": "^1.15.0",
+        "split-file": "^2.3.0",
+        "swagger-ui-express": "^5.0.0",
+        "systeminformation": "^5.21.17",
+        "uglify-js": "^3.17.4",
+        "validator": "^13.11.0",
+        "winston": "^3.11.0"
+    },
+    "devDependencies": {
+        "clean-jsdoc-theme": "^4.3.0",
+        "mocha": "^10.4.0",
+        "plantuml": "^0.0.2",
+        "swagger-autogen": "^2.23.7",
+        "to-json-schema": "^0.2.5"
+    },
+    "publishConfig": {
+        "provenance": true,
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    }
+}

package/prometheus.yml

@@ -0,0 +1,36 @@
+# my global config
+global:
+  scrape_interval: 5s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
+  evaluation_interval: 5s # Evaluate rules every 15 seconds. The default is every 1 minute.
+  # scrape_timeout is set to the global default (10s).
+
+# Alertmanager configuration
+alerting:
+  alertmanagers:
+    - static_configs:
+        - targets:
+          # - alertmanager:9093
+
+# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
+rule_files:
+  # - "first_rules.yml"
+  # - "second_rules.yml"
+
+# A scrape configuration containing exactly one endpoint to scrape:
+# Here it's Prometheus itself.
+scrape_configs:
+  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
+  - job_name: 'prometheus_service'
+
+    # metrics_path defaults to '/metrics'
+    # scheme defaults to 'http'.
+
+    static_configs:
+      - targets: ['host.docker.internal:9090']
+
+  - job_name: 'nodejs_service'
+    static_configs:
+      - targets: ['host.docker.internal:4001', 'host.docker.internal:4002']
+      # - targets: ['localhost:4001', 'localhost:4002']
+      # - targets: ["host.docker.internal:3002"] # Windows
+      # - targets: ["docker.for.mac.localhost:9090"] # macOs

package/src/api/core/core.controller.js

@@ -0,0 +1,69 @@
+import { loggerFactory } from '../../server/logger.js';
+import { CoreService } from './core.service.js';
+
+const logger = loggerFactory(import.meta);
+
+const CoreController = {
+  post: async (req, res, options) => {
+    try {
+      const result = await CoreService.post(req, res, options);
+      return res.status(200).json({
+        status: 'success',
+        data: result,
+      });
+    } catch (error) {
+      logger.error(error, error.stack);
+      return res.status(400).json({
+        status: 'error',
+        message: error.message,
+      });
+    }
+  },
+  get: async (req, res, options) => {
+    try {
+      const result = await CoreService.put(req, res, options);
+      return res.status(200).json({
+        status: 'success',
+        data: result,
+      });
+    } catch (error) {
+      logger.error(error, error.stack);
+      return res.status(400).json({
+        status: 'error',
+        message: error.message,
+      });
+    }
+  },
+  put: async (req, res, options) => {
+    try {
+      const result = await CoreService.get(req, res, options);
+      return res.status(200).json({
+        status: 'success',
+        data: result,
+      });
+    } catch (error) {
+      logger.error(error, error.stack);
+      return res.status(400).json({
+        status: 'error',
+        message: error.message,
+      });
+    }
+  },
+  delete: async (req, res, options) => {
+    try {
+      const result = await CoreService.delete(req, res, options);
+      return res.status(200).json({
+        status: 'success',
+        data: result,
+      });
+    } catch (error) {
+      logger.error(error, error.stack);
+      return res.status(400).json({
+        status: 'error',
+        message: error.message,
+      });
+    }
+  },
+};
+
+export { CoreController };

package/src/api/core/core.model.js

@@ -0,0 +1,11 @@
+import { Schema, model, Types } from 'mongoose';
+
+// https://mongoosejs.com/docs/2.7.x/docs/schematypes.html
+
+const CoreSchema = new Schema({});
+
+const CoreModel = model('Core', CoreSchema);
+
+const ProviderSchema = CoreSchema;
+
+export { CoreSchema, CoreModel, ProviderSchema };

package/src/api/core/core.router.js

@@ -0,0 +1,23 @@
+import { adminGuard, authMiddleware } from '../../server/auth.js';
+import { loggerFactory } from '../../server/logger.js';
+import { CoreController } from './core.controller.js';
+import express from 'express';
+
+const logger = loggerFactory(import.meta);
+
+const CoreRouter = (options) => {
+  const router = express.Router();
+  router.post(`/:id`, authMiddleware, adminGuard, async (req, res) => await CoreController.post(req, res, options));
+  router.post(`/`, authMiddleware, adminGuard, async (req, res) => await CoreController.post(req, res, options));
+  router.get(`/:id`, authMiddleware, adminGuard, async (req, res) => await CoreController.get(req, res, options));
+  router.get(`/`, authMiddleware, adminGuard, async (req, res) => await CoreController.get(req, res, options));
+  router.put(`/:id`, authMiddleware, adminGuard, async (req, res) => await CoreController.put(req, res, options));
+  router.put(`/`, authMiddleware, adminGuard, async (req, res) => await CoreController.put(req, res, options));
+  router.delete(`/:id`, authMiddleware, adminGuard, async (req, res) => await CoreController.delete(req, res, options));
+  router.delete(`/`, authMiddleware, adminGuard, async (req, res) => await CoreController.delete(req, res, options));
+  return router;
+};
+
+const ApiRouter = CoreRouter;
+
+export { ApiRouter, CoreRouter };

package/src/api/core/core.service.js

@@ -0,0 +1,31 @@
+import { DataBaseProvider } from '../../db/DataBaseProvider.js';
+import { loggerFactory } from '../../server/logger.js';
+import { shellExec } from '../../server/process.js';
+
+const logger = loggerFactory(import.meta);
+
+const CoreService = {
+  post: async (req, res, options) => {
+    /** @type {import('./core.model.js').CoreModel} */
+    const Core = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.Core;
+    if (req.path.startsWith('/sh')) return shellExec(req.body.sh, { stdout: true });
+    return await new Core(req.body).save();
+  },
+  get: async (req, res, options) => {
+    /** @type {import('./core.model.js').CoreModel} */
+    const Core = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.Core;
+    return await Core.findById(req.params.id);
+  },
+  put: async (req, res, options) => {
+    /** @type {import('./core.model.js').CoreModel} */
+    const Core = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.Core;
+    return await Core.findByIdAndUpdate(req.params.id, req.body);
+  },
+  delete: async (req, res, options) => {
+    /** @type {import('./core.model.js').CoreModel} */
+    const Core = DataBaseProvider.instance[`${options.host}${options.path}`].mongoose.models.Core;
+    return await Core.findByIdAndDelete(req.params.id);
+  },
+};
+
+export { CoreService };