backend-plus 2.0.0-rc.13 → 2.0.0-rc.14

package/lib/backend-plus.d.ts

@@ -12,9 +12,7 @@ export type LangId = 'en'|'es'|'etc...';
 
 export type Server=net.Server;
 
-export interface CoreFunctionParameters{
-    [key:string]: any
-}
+export type CoreFunctionParameters<T extends Record<string, any>> = T;
 
 export type MarkdownDoc = 'markdown documentation with `` can content newlines. The identation of the first line is deleted in all others'|'etc...'; 
 
@@ -365,6 +363,126 @@ export interface Caches {
     procedures:Record<string, {timestamp:number, result:any}>
 }
 
+export interface AppConfigBin {                                    // executables in SO
+    "zip-password-parameter-flag": string // parameter to pass the password to the zipper
+    "zip-password-prefix": string         // password prefix
+    "zip-fixed-parameters":string         // fixed parameters to pass to zipper
+}
+
+export interface AppConfig {
+    server: {
+        "base-url": string                 // rool path in the url
+        port: number                       // port of the API services
+        "session-store": string            // strategies to store session info
+        "ip-replacer": string              // ip that can be not showed or deduced in logs
+        "silent-startup": boolean          // less logs when startup
+        "kill-9": string                   // a way to kill from URL with a token
+        bitacoraSchema: string
+        bitacoraTableName: string 
+    }
+    db: {
+        motor: 'postgresql'
+        database: string
+        user: string
+        password: string
+        schema: string
+        search_path: string
+        tablespace: string                 // for creation scripts
+        "min-version": string              // min version of the motor needed
+        nodb: boolean                      // if there is no database needed in the app
+        no_login: boolean                  // if no login is needed. Used only for all public sites
+        "downloadable-backup-path": string // OS path of the encrypted downloadable backup
+    }
+    login: {
+        schema: string                     // schema of the user table
+        table: string                      // user table
+        userFieldname: string              // fieldname in user table that stores the user name
+        passFieldname: string              // fieldname in user table that stores the password hash
+        rolFieldname: string               // fieldname in user table that stores the rol
+        unloggedLandPage: string           // land page when there is no user logged when the backend has public services
+        noLoggedUrlPath: string            // path of non logged users when the backend has no public services
+        "preserve-case": boolean           // preserve the case of the user name
+        activeClausule: string             // SQL expression over the user table to check if a user is active
+        lockedClausule: string             // SQL expression over the user table to check if a user is locked
+        disableChangePassword: boolean     // disallow password change
+        skipBitacora: boolean              // don't register logins
+        keepAlive: number                  // secs to keep alive a session if only keep alive request where received
+        plus: {
+            userFieldName:string
+            store:{
+                module: string
+            }
+        }
+        forget: {                          // forget password configurations:
+            urlPath: string                // url sent by mail. default: `/new-pass`
+            urlPathOk: string              // confirmation page
+            mailFields: string[]           // fields for the forget pass mail
+
+        }
+        "double-dragon": boolean           // app user must match db user
+    }
+    install: {
+        "table-data-dir": string           // SO path to the .tab files in the db creation script
+        dump: {                            // configuration of --dump-db, the db creation script
+            "drop-his": boolean            // include drop schema his in the db creation script
+            db: {                          
+                owner: string              
+                extensions: string[]       // extensions to be installed (gist, pg_trgm, pgcrypto)
+                enances: 'file'            // if the enances must be dumped in a separate file
+                // from here info to set the owner and replace owner and user used in devel when script creation
+                "owner4special-scripts": string
+                "user4special-scripts": string
+                "apply-generic-user-replaces": string
+            }
+            "admin-can-create-tables": boolean // for apps that allows the user to create tables
+            "skip-content": boolean        // don't create data from "table-data-dir"
+            folders: string                //
+            scripts: {
+                prepare: string            // SO path to the prepare scripts that will be run before the functions creations and inserts
+                "post-adapt": string       // SO path to the post-adapt scripts that will be run after data inserts (of .tab tables)
+            }
+        }
+    }
+    "client-setup": {                      // front-end config
+        title:string                       // title of the app (common sufix of the title bar)
+    }
+    log: {
+        "serve-content": never
+        req: {
+            "keep-alive": boolean
+        }
+        db: {
+            "last-error": boolean          // store last db error in a log file
+            devel: boolean                 //
+            "on-demand": string            // if log db level can be changed on the fly
+            until: string | Date           // full log until...
+            results: boolean               // if query results must be included in full db logs
+        }
+        session: boolean                   // if all session activity must be logged
+    }
+    devel: {
+        delay: number                      // msec avg random delay in API responses (to emulate slow nets)
+        "cache-content": boolean           // if the cache header must be sent to the client (when no devel config the default is true)
+        forceShowAsEditable: boolean       // force "editable" behavior in grids 
+    }
+    mailer: {                              // config to send mails
+        conn: string                       // connection string
+        "mail-info": {}                    // static mail config
+        supervise: {
+            to: string                     // email addres of the supervisor
+            event: {
+            }
+        }
+    }
+    bin: AppConfigBin 
+    data: {
+        transformers: {
+            text: string                   // define the inputTransformers for text comming from the fron-end via the API
+        }
+    }
+    skipUnknownFieldsAtImport: boolean     // if unknown fields must be skipped by default in import
+}
+
 export class AppBackend{
     procedures:ProcedureDef[]
     procedure:{ [key:string]:ProcedureDef }
@@ -372,7 +490,7 @@ export class AppBackend{
     getTableDefinition: TableDefinitionsGetters
     tableStructures: TableDefinitions
     db: MotorDb
-    config: any
+    config: AppConfig
     rootPath: string
     caches:Caches
     fieldDomain:{[k:string]:Partial<FieldDefinition>}

package/lib/backend-plus.js

@@ -2878,8 +2878,14 @@ AppBackend.prototype.dumpDbSchemaPartial = async function dumpDbSchemaPartial(pa
         if (err.code != 'ENOENT') throw err;
         try {
             var allTableContent = await fs.readFile('install/local-dump.psql','utf-8');
-            var startIndex = allTableContent.search(/\n-- Data for Name: /);
-            var lastIndex = allTableContent.search(/\nSELECT pg_catalog.setval/);
+            var startIndex = allTableContent.indexOf('-- Data for Name: ');
+            console.log('startIndex', startIndex);
+            var lastUseful = allTableContent.lastIndexOf('\nSELECT pg_catalog.setval') 
+            console.log('lastUseful', lastUseful);
+            if (lastUseful == -1) lastUseful = allTableContent.lastIndexOf('\n\\.\n');
+            console.log('lastUseful', lastUseful);
+            var lastIndex = allTableContent.indexOf('\n--', lastUseful);
+            console.log('lastIndex', lastIndex);
             allTableData = allTableContent.slice(startIndex, lastIndex);
         } catch(err) {
             if (err.code != 'ENOENT') throw err;
@@ -3003,27 +3009,33 @@ AppBackend.prototype.dumpDbSchemaPartial = async function dumpDbSchemaPartial(pa
     }
     let installFolders = be.config.install.dump.folders ?? ['install']
     let texts = await Promise.all(
-        ['prepare.sql','pre-adapt.sql','adapt.sql']
-        .concat(be.config.install.dump.scripts['prepare'])
-        .concat(be.config.install.dump.scripts['post-adapt'])
-        .map(async function(fileName){
-            if (!fileName) return '';
+        [
+            ['prepare.sql'],
+            ['pre-adapt.sql'].concat(be.config.install.dump.scripts['pre-adapt']),
+            ['adapt.sql'],
+            be.config.install.dump.scripts['prepare'] ?? [],
+            be.config.install.dump.scripts['post-adapt'] ?? []
+        ]
+        .map(async function(fileNames){
+            if (!fileNames) return '';
             var i = 0; 
-            var content;
-            do {
-                var folder = installFolders[i];
-                try{
-                    content = await fs.readFile(be.rootPath+'/'+folder+'/'+fileName, {encoding:'UTF8'});
-                } catch (err) {
-                    if(err.code!='ENOENT') throw err;
-                }
-                i++;
-            } while (i < installFolders.length && !content);
-            if (!content) {
-                return '-- no '+fileName+'\n';
-            } else {
-                return '-- '+folder+'/'+fileName+'\n'+content;
-            };
+            return (await Promise.all(fileNames.map(async fileName => {
+                var content;
+                do {
+                    var folder = installFolders[i];
+                    try{
+                        content = await fs.readFile(be.rootPath+'/'+folder+'/'+fileName, {encoding:'UTF8'});
+                    } catch (err) {
+                        if(err.code!='ENOENT') throw err;
+                    }
+                    i++;
+                } while (i < installFolders.length && !content);
+                if (!content) {
+                    return '-- no '+fileName+'\n';
+                } else {
+                    return '-- '+folder+'/'+fileName+'\n'+content;
+                };
+            }))).join('\n')
         })
     );
 
@@ -3053,7 +3065,7 @@ AppBackend.prototype.dumpDbSchemaPartial = async function dumpDbSchemaPartial(pa
         '\n-- common'+
         common+'\n'+
         (complete? '\n\n--prepare.sql\n'+ texts[0]+'\n\n' :'' )+
-        (complete? texts.slice(3,3+prepareList.length).join('\n\n')+'\n\n' : '' )+
+        (complete? texts[3] + '\n\n' : '' )+
         '\n-- functions\n' + functionLines.join('\n')+
         '\n-- lines \n' + lines.join('\n')+
         (complete? ('\n\n-- pre-ADAPTs\n'+texts[1]+'\n\n') : '' )+
@@ -3063,7 +3075,7 @@ AppBackend.prototype.dumpDbSchemaPartial = async function dumpDbSchemaPartial(pa
         '\n-- FKs\n' + fkLines.join('\n')+
         '\n-- index\n' + indexLines.join('\n')+
         '\n-- policies\n' + policyLines.join('\n')+
-        (complete? texts.slice(3+prepareList.length).join('\n\n')+'\n\n' : '' )+
+        (complete? texts[4] + '\n\n' : '' )+
         (complete? (be.config.install.dump.enances==='inline'?enancePart:'') :'')
     ).replace(/\uFEFF/g /*inner BOM replacing*/,'\n\n').replace(
         new RegExp(escapeRegExp(db.quoteIdent(be.config.install.dump.db["owner4special-scripts"])),'g'),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backend-plus",
   "description": "Backend for the anti Pareto rule",
-  "version": "2.0.0-rc.13",
+  "version": "2.0.0-rc.14",
   "author": "Codenautas <codenautas@googlegroups.com>",
   "license": "MIT",
   "repository": "codenautas/backend-plus",
@@ -30,16 +30,16 @@
   ],
   "dependencies": {
     "@upgraded/locate-path": "^6.0.0-alfa.1",
-    "ajax-best-promise": "^0.4.0",
+    "ajax-best-promise": "^0.4.2",
     "backend-skins": "^0.1.15",
     "best-globals": "^1.1.4",
     "big.js": "^6.2.1",
     "body-parser": "^1.20.2",
     "cast-error": "^0.1.1",
-    "castellano": "^0.1.3",
+    "castellano": "^0.1.4",
     "connect-pg-simple": "^9.0.1",
     "cookie-parser": "^1.4.6",
-    "dialog-promise": "^0.9.15",
+    "dialog-promise": "^0.10.0",
     "discrepances": "^0.2.8",
     "express": "^4.19.2",
     "express-session": "^1.18.0",
@@ -63,7 +63,7 @@
     "read-yaml-promise": "^1.0.2",
     "regexplicit": "^0.1.3",
     "require-bro": "^0.3.1",
-    "self-explain": "^0.10.22",
+    "self-explain": "^0.11.0",
     "serve-content": "^0.3.19",
     "session-file-store": "^1.5.0",
     "sql-tools": "^0.1.2",
@@ -82,8 +82,8 @@
     "@types/js-yaml": "^4.0.9",
     "@types/mocha": "^10.0.6",
     "@types/multiparty": "~0.0.36",
-    "@types/node": "^20.12.6",
-    "@types/nodemailer": "^6.4.14",
+    "@types/node": "^20.12.11",
+    "@types/nodemailer": "^6.4.15",
     "@types/numeral": "~2.0.5",
     "@types/session-file-store": "^1.2.5",
     "@types/stack-trace": "~0.0.33",
@@ -99,11 +99,11 @@
     "kill-9": "~0.4.3",
     "mocha": "^10.4.0",
     "nyc": "^15.1.0",
-    "puppeteer": "^22.6.3",
-    "sinon": "^17.0.1",
-    "supertest": "^6.3.4",
+    "puppeteer": "^22.8.0",
+    "sinon": "^17.0.2",
+    "supertest": "^7.0.0",
     "types.d.ts": "~0.6.21",
-    "typescript": "^5.4.4",
+    "typescript": "^5.4.5",
     "why-is-node-running": "^2.2.2"
   },
   "engines": {