delore-crm-core 1.0.0 → 1.0.3

package/README.md

@@ -1,81 +1,193 @@
 # delore-crm-core
 
-Core CRM utilities used across Delore projects. This package centralizes route
-registration, access metadata, and a few shared helpers.
+Biblioteca central de utilidades do CRM da Delore. Reúne registro de rotas e acesso, helpers compartilhados, autenticação/token, sincronismo de permissões, conexão com banco (MySQL + MongoDB), modelos e utilidades de impressão (PDF/Excel).
 
-## Install
+## Instalação
 
 ```bash
 npm i delore-crm-core
 ```
 
-## Quick Start
+## Uso rápido (rotas e acesso)
 
 ```js
-const express = require('express');
-const core = require('delore-crm-core');
+const express = require("express");
+const core = require("delore-crm-core");
 
 const app = express();
 
-core.add(
-  'get',
-  '/s/example',
-  'Example',
-  'Example route',
-  core.const.GROUPOPE,
-  (req, res) => {
-    res.json({ ok: true });
-  }
+core.access.add(
+  "get",
+  "/s/exemplo",
+  "Exemplo",
+  "Rota de exemplo",
+  core.access.const.GROUPOPE,
+  (req, res) => res.json({ ok: true }),
 );
 
-app.use(core.makeRouter());
+app.use(core.access.makeRouter());
 app.listen(3000);
 ```
 
-## Access Helpers
+## Exportações principais
 
-All access entries are stored in-memory in the module. Typical flow:
+O módulo principal exporta:
 
-1. Register routes with `add`, `addMenu`, `addOpen`, or `addNoAccessControl`.
-2. Build the Express router with `makeRouter()`.
-3. Export access metadata with `getAccess()` or `makeAccessScope*()` for ACL sync.
+- `access`: registro de rotas, metadados de acesso e criação de `router`.
+- `util`: helpers de data, máscara, número, telefone, validações e afins.
+- `logger`: logger baseado em `pino`/`pino-pretty`.
+- `memory`: cache simples em memória (chave/valor).
+- `print`: geração de PDF e Excel.
+- `authControl`: controle de segredo de autenticação (MongoDB + cache em memória).
+- `ret`: helpers de retorno e geração/validação de tokens.
+- `validRequest`: middlewares de validação de token.
+- `syncAccess`: sincronismo de acessos com o banco.
+- `sequelizeDB`: conexão com MySQL (Sequelize) + MongoDB.
+- `models`: helpers de models, sync, migration e utilidades.
 
-### Functions
+Exemplo de import:
 
-- `add(method, path, name, desc, group, fn)`
-- `addMenu(method, path, name, desc, group, fn)` marks as menu entry
-- `addOpen(method, path, name, desc, group, fn)` open by default for existing users
-- `addNoAccessControl(method, path, fn)` skips access control tracking
-- `addEsp(name, desc, group)` creates a non-route access entry (returns `id`)
-- `makeRouter()` returns an Express router with all registered routes
-- `getAccess()` returns the raw list of registered entries
-- `makeAccessScope()` returns JSON string of access IDs
-- `makeAccessScopeAll()` returns JSON string of `id#name#desc#group#isMenu`
-- `getResourceFromReq(req)` maps a request to its access metadata
+```js
+const { access, util, logger } = require("delore-crm-core");
+```
+
+## Access (rotas e ACL)
+
+Registra rotas e mantém os metadados de acesso em memória. Depois monta um `router` do Express.
 
-### Constants
+Funções principais:
 
-The `const` export provides group labels:
+- `access.add(method, path, name, desc, group, fn)`
+- `access.addMenu(method, path, name, desc, group, fn)`
+- `access.addOpen(method, path, name, desc, group, fn)`
+- `access.addNoAccessControl(method, path, fn)`
+- `access.addEsp(name, desc, group)`
+- `access.makeRouter()`
+- `access.getAccess()`
+- `access.makeAccessScope()`
+- `access.makeAccessScopeAll()`
+- `access.getResourceFromReq(req)`
+
+Constantes de grupos:
 
 - `GROUPSYS`, `GROUPCAD`, `GROUPOPE`, `GROUPUTL`, `GROUPESP`, `GROUPCON`, `GROUPADM`
 
-### Environment
+## Auth e validação
+
+### Tokens e respostas
 
-`SERVICE_NAME` is read from `process.env.SERVICE_NAME` and attached to each entry.
+O módulo `ret` centraliza geração de token e respostas padronizadas:
 
-## Utility Export
+- `ret.returnLogin(...)`, `ret.returnLoginADM(...)`, `ret.returnLoginMASTER(...)`, `ret.returnLoginDEVELOPER(...)`
+- `ret.validToken(req)`, `ret.validTokenADM(req)`, `ret.validTokenMASTER(req)`, `ret.validTokenDEVELOPER(req)`
+- `ret.makeTokenSocketIo(...)`, `ret.validTokenSocketIo(...)`
+- `ret.returnTokenMsg(...)`, `ret.validTokenMSG(req)`
+- `ret.makeTokenForRememberUser(...)`, `ret.validTokenForRememberUser(token)`
 
-The helper module is available as `core.util` or via direct import:
+### Middlewares
 
 ```js
-const util = require('delore-crm-core/util');
-const url = util.getUrlFromReq('/crm/s/example');
+const { validRequest } = require("delore-crm-core");
+
+app.use("/s", validRequest.validaRequestSystem);
+app.use("/adm", validRequest.validaRequestADM);
 ```
 
-## Direct Imports
+## Conexão com banco (MySQL + MongoDB)
 
-If you only need a subset:
+O `sequelizeDB` conecta ao MySQL via Sequelize e ao MongoDB (coleção `authControl`), carregando secrets em memória.
 
 ```js
-const access = require('delore-crm-core/access');
+const { sequelizeDB } = require("delore-crm-core");
+
+sequelizeDB.init(() => {
+  console.log("DB conectado");
+});
 ```
+
+Variáveis de ambiente usadas:
+
+- `DB_DATABASE`, `DB_USER`, `DB_PASS`, `DB_HOST`
+- `MONGODB_URI`
+- `SECRET_LOGIN_USER`, `SECRET_REMEMBER_USER`
+- `PINO_LOG_LEVEL`
+- `TELEGRAM_BOT_TOKEN_NOTIFY`, `TELEGRAM_BOT_ENV_NOTIFY`
+
+## Models e sincronismo
+
+O módulo `models` dá suporte para:
+
+- registrar models: `addModel`, `addModelIn`, `addModelInOne`
+- sincronizar: `initSync(callback)`
+- migration: `Migration()`
+- exportar modelos para front: `ExportModels()`
+- utilitários: `canDelete`, `canDelete2`, `makeSQLTransf`, `seedFrom`
+
+O módulo `syncAccess` sincroniza a lista de acessos registrados em memória com a tabela `access`.
+
+```js
+const { syncAccess } = require("delore-crm-core");
+
+syncAccess.init("crm-service");
+await syncAccess.sync();
+```
+
+## Print (PDF e Excel)
+
+Gera relatórios em PDF (tabela/linhas) e exporta para Excel.
+
+```js
+const { print } = require("delore-crm-core");
+
+const report = print.getPrint(req, res);
+report.addColumns("Nome", "name", "L", 30);
+report.addColumVal("Valor", "amount", "R", 12, 2);
+await report.printList(data, req, res);
+```
+
+Para Excel:
+
+```js
+await report.printListEXCEL(data, req, res);
+```
+
+## Util, Logger e Memory
+
+### Util
+
+Helpers variados: datas (timezone America/Sao_Paulo), máscaras, números, telefone, validação de CPF, geração de schema JSON, etc.
+
+```js
+const { util } = require("delore-crm-core");
+
+const today = util.nowDateTime();
+const cpfOk = util.isValidCPF("00000000000");
+```
+
+### Logger
+
+Logger configurado com `pino-pretty`:
+
+```js
+const { logger } = require("delore-crm-core");
+
+logger.info("serviço iniciado");
+logger.setLevel("info");
+```
+
+### Memory
+
+Cache simples em memória:
+
+```js
+const { memory } = require("delore-crm-core");
+
+await memory.addMemory("chave", { x: 1 });
+const value = await memory.findMemory("chave");
+```
+
+## Observações
+
+- O módulo é CommonJS.
+- Os helpers de acesso dependem do registro das rotas antes do `makeRouter()`.
+- Tokens e segredos usam dados do MongoDB (`authControl`).

package/index.js

@@ -1,6 +1,29 @@
 'use strict';
 
-const access = require('./access');
-const util = require('./util');
+const access = require('./utils/access');
+const util = require('./utils/util');
+const logger = require('./utils/logger');
+const memory = require('./utils/memory');
+const print = require('./print');
+const authControl = require('./auth/auth.control');
+const ret = require('./auth/ret');
+const validRequest = require('./auth/valid.request');
+const syncAccess = require('./sync/sync.access');
+const sequelizeDB = require('./db/sequelize_db');
+const models = require('./db/models');
 
-module.exports = Object.assign({}, access, { util });
+const exported = Object.assign({}, {
+    access,
+    util,
+    logger,
+    memory,
+    print,
+    authControl,
+    ret,
+    validRequest,
+    syncAccess,
+    sequelizeDB,
+    models,
+});
+
+module.exports = exported;

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "delore-crm-core",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Core CRM utilities for Delore projects",
   "main": "index.js",
   "type": "commonjs",
   "exports": {
     ".": "./index.js",
-    "./access": "./access.js",
-    "./util": "./util.js"
+    "./*": "./*.js",
+    "./*/": "./*/index.js",
+    "./*/*": "./*/*.js"
   },
   "files": [
     "index.js",
@@ -45,6 +46,17 @@
   "license": "ISC",
   "dependencies": {
     "express": "^5.2.1",
-    "shorthash2": "^1.0.5"
+    "get-stream": "^9.0.1",
+    "jwt-simple": "^0.5.5",
+    "moment": "^2.29.2",
+    "moment-timezone": "^0.6.0",
+    "mongodb": "^6.13.1",
+    "mysql2": "^3.3.3",
+    "pdfkit": "^0.17.2",
+    "pino": "^10.3.0",
+    "pino-pretty": "^13.1.3",
+    "shorthash2": "^1.0.5",
+    "sequelize": "^6.37.7",
+    "xlsx": "^0.18.5"
   }
 }

package/access.js

@@ -1,144 +0,0 @@
-'use strict';
-const express = require('express');
-const router = express.Router();
-const shorthash2 = require('shorthash2');
-
-const util = require('./util');
-var list = [];
-
-exports.const = {
-    GROUPSYS: 'Sistema',
-    GROUPCAD: 'Cadastros',
-    GROUPOPE: 'Operacional',
-    GROUPUTL: 'Utils',
-    GROUPESP: 'Especiais',
-    GROUPCON: 'Consultas',
-    GROUPADM: 'Gerencial',
-};
-
-// Configura acesso para rotas/todos usuários
-exports.add = function (method, path, name, desc, group, fn) {
-    list.push({ service: process.env.SERVICE_NAME, id: shorthash2(method + path), type: 'router', accessControl: true, method: method, path: path, name: name, desc: desc, group: group, fn: fn, general: false, opened: false, isMenu: false });
-};
-
-exports.addMenu = function (method, path, name, desc, group, fn) {
-    list.push({ service: process.env.SERVICE_NAME, id: shorthash2(method + path), type: 'router', accessControl: true, method: method, path: path, name: name, desc: desc, group: group, fn: fn, general: false, opened: false, isMenu: true });
-};
-
-// Configura acesso para rotas/todos usuários - Liberada por Padrão para usuário ativos já cadastrados
-exports.addOpen = function (method, path, name, desc, group, fn) {
-    list.push({ service: process.env.SERVICE_NAME, id: shorthash2(method + path), type: 'router', accessControl: true, method: method, path: path, name: name, desc: desc, group: group, fn: fn, general: false, opened: true, isMenu: false });
-};
-
-// Configura acesso para rotinas
-exports.addEsp = function (name, desc, group) {
-    var id = shorthash2(name, desc, group);
-    list.push({ service: process.env.SERVICE_NAME, id: id, type: 'esp', accessControl: true, method: 'esp', path: '', name: name, desc: desc, group: group, fn: null, general: false, opened: false });
-    return id;
-};
-
-// Configura acesso para rotas liberadas para todos usuários
-exports.addNoAccessControl = function (method, path, fn) {
-    list.push({ service: process.env.SERVICE_NAME, id: shorthash2(method + path), type: 'router', accessControl: false, method: method, path: path, name: '', desc: '', group: '', fn: fn, general: false, opened: false, isMenu: false });
-};
-
-exports.makeRouter = function () {
-    for (var i = 0; i < list.length; i++) {
-        if (list[i].method == 'get') {
-            router.get(list[i].path, list[i].fn);
-        } else if (list[i].method == 'post') {
-            router.post(list[i].path, list[i].fn);
-        } else if (list[i].method == 'put') {
-            router.put(list[i].path, list[i].fn);
-        } else if (list[i].method == 'delete') {
-            router.delete(list[i].path, list[i].fn);
-        }
-    }
-    return router;
-};
-
-exports.makeAccessScope = function () {
-    var ret = '[';
-    for (var i = 0; i < list.length; i++) {
-        if (list[i].accessControl) {
-            if (i == 0) {
-                ret = ret + '"' + list[i].id + '"';
-            } else {
-                ret = ret + ', ' + '"' + list[i].id + '"';
-            }
-        }
-    }
-    ret = ret + ']';
-    return ret;
-};
-
-exports.makeAccessScopeAll = function () {
-    var ret = '[';
-    for (var i = 0; i < list.length; i++) {
-        if (list[i].accessControl) {
-            if (i == 0) {
-                ret = ret + '"' + list[i].id + '#' + list[i].name + '#' + list[i].desc + '#' + list[i].group + '#' + list[i].isMenu + '"';
-            } else {
-                ret = ret + ', ' + '"' + list[i].id + '#' + list[i].name + '#' + list[i].desc + '#' + list[i].group + '#' + list[i].isMenu + '"';
-            }
-        }
-    }
-    ret = ret + ']';
-    return ret;
-};
-
-exports.getAccess = function () {
-    return list;
-};
-
-exports.getResourceFromReq = function (req) {
-    var ret = {};
-    var urlReq = util.getUrlFromReq(req.baseUrl);
-
-    if (urlReq == '') {
-        ret.accessControl = false;
-        ret.id = '';
-        ret.group = '';
-        ret.name = '';
-        ret.desc = '';
-        ret.general = false;
-        return ret;
-    }
-
-    for (var i = 0; i < list.length; i++) {
-        if (list[i].accessControl) {
-            ret.accessControl = true;
-            var urls = getUrlFromReq(list[i].path);
-            if (urlReq == urls && list[i].method == req.method.toLowerCase()) {
-                ret.id = list[i].id;
-                ret.group = list[i].group;
-                ret.name = list[i].name;
-                ret.desc = list[i].desc;
-                ret.general = list[i].general;
-                break;
-            }
-        } else {
-            ret.accessControl = false;
-            ret.id = '';
-            ret.group = '';
-            ret.name = '';
-            ret.desc = '';
-            ret.general = false;
-        }
-    }
-    return ret;
-};
-
-function getUrlFromReq(baseUrl) {
-    var urlReq = '';
-    if (baseUrl.indexOf('/s/') > -1) {
-        urlReq = baseUrl.substring(0, baseUrl.indexOf('/s/') + 3);
-    } else {
-        var partes = baseUrl.split('/s');
-        for (let index = 0; index < partes.length - 1; index++) {
-            const element = partes[index];
-            urlReq = urlReq + '' + element + '/s';
-        }
-    }
-    return urlReq;
-}

package/util.js

@@ -1,19 +0,0 @@
-'use strict';
-
-function getUrlFromReq(baseUrl) {
-  var urlReq = '';
-  if (baseUrl.indexOf('/s/') > -1) {
-    urlReq = baseUrl.substring(0, baseUrl.indexOf('/s/') + 3);
-  } else {
-    var partes = baseUrl.split('/s');
-    for (let index = 0; index < partes.length - 1; index++) {
-      const element = partes[index];
-      urlReq = urlReq + '' + element + '/s';
-    }
-  }
-  return urlReq;
-}
-
-module.exports = {
-  getUrlFromReq,
-};