miqro 1.9.3 → 3.0.0

package/build/utils/doc/md.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parserToString = exports.getMDDoc = void 0;
+const json_1 = require("./json");
+async function getMDDoc(args, logger) {
+    const jsonDOC = await (0, json_1.getDOCJSON)(args, logger);
+    const pathList = Object.keys(jsonDOC);
+    let outMD = "";
+    for (const path of pathList) {
+        const pathData = jsonDOC[path];
+        const methods = Object.keys(pathData);
+        for (const method of methods) {
+            const apiData = pathData[method];
+            outMD += `## ${apiData.identifier}${args.showFilePath ? apiData.___filePath : ""}\n\n`;
+            if (apiData.name) {
+                outMD += `${apiData.name}\n\n`;
+            }
+            if (apiData.description) {
+                outMD += `${apiData.description}\n\n`;
+            }
+            outMD += `[${method}] ${path}\n\n`;
+            if (apiData.policy) {
+                outMD += `### policy\n\n`;
+                outMD += policyToString(apiData.policy);
+            }
+            if (apiData.request) {
+                const requestOutMD = parserToString(apiData.request);
+                outMD += requestOutMD !== "" ? `### request\n\n${requestOutMD}` : "";
+            }
+            if (apiData.response) {
+                const responseOutMD = parserToString(apiData.response);
+                outMD += responseOutMD !== "" ? `### response\n\n${responseOutMD}` : "";
+            }
+        }
+    }
+    return outMD;
+}
+exports.getMDDoc = getMDDoc;
+function policyToString(policy) {
+    let outMD = "| groups | policy |\n";
+    outMD += "|--------|--------|\n";
+    outMD += `| ${(policy.groups instanceof Array ? policy.groups : [policy.groups]).join(",")} | ${policy.groupPolicy} |\n\n`;
+    return outMD;
+}
+function parserToString(parser) {
+    let outMD = "";
+    if (parser.params && typeof parser.params !== "boolean") {
+        outMD += `#### path params\n\n`;
+        outMD += parserPartToString(parser.params, parser.paramsMode);
+    }
+    if (parser.headers) {
+        outMD += `#### headers\n\n`;
+        outMD += parserPartToString(parser.headers, parser.headersMode);
+    }
+    if (parser.query && parser.query !== true) {
+        outMD += `#### query\n\n`;
+        outMD += parserPartToString(parser.query, parser.queryMode);
+    }
+    if (parser.body && parser.body !== true) {
+        outMD += `#### body\n\n`;
+        outMD += parserPartToString(parser.body, parser.bodyMode);
+    }
+    return outMD;
+}
+exports.parserToString = parserToString;
+function parserPartToString(arg, mode) {
+    if (arg === false) {
+        return "not allowed";
+    }
+    let outMD = "";
+    let maxTabulation = 1;
+    const parsers = arg instanceof Array ? arg : [arg];
+    for (const parser of parsers) {
+        const ret = internalParserToString(parser);
+        if (ret.maxTabulation > maxTabulation) {
+            maxTabulation = ret.maxTabulation;
+        }
+        outMD += `| | ${getTabulation(ret.maxTabulation * 2)}\n`;
+        outMD += `|--------|--------${getTabulation(ret.maxTabulation * 2, true)}\n`;
+        outMD += `${ret.out}\n\n`;
+    }
+    return outMD;
+}
+function internalParserToString(parser, tabulation = 1) {
+    let outMD = "";
+    let maxTabulation = tabulation;
+    if (typeof parser === "string") {
+        outMD += `${getTabulation(tabulation)}${parser}|\n`;
+    }
+    else {
+        const attrNames = Object.keys(parser);
+        for (const name of attrNames) {
+            const p = parser[name];
+            if (typeof p === "string") {
+                outMD += `${getTabulation(tabulation)}${name} | ${p}|\n`;
+            }
+            else if (p.type === "nested") {
+                outMD += `${getTabulation(tabulation)}${name} | ${p.type}|\n`;
+                const ret = parserBaseNestedTypeToString(p, tabulation + 1);
+                if (maxTabulation < ret.maxTabulation) {
+                    maxTabulation = ret.maxTabulation;
+                }
+                outMD += `${ret.out}`;
+            }
+            else if (p.type === "regex") {
+                outMD += `${getTabulation(tabulation)}${name} | ${p.regex}|\n`;
+            }
+            else {
+                outMD += `${getTabulation(tabulation)}${name} | ${p.type}|\n`;
+            }
+        }
+    }
+    return {
+        out: outMD,
+        maxTabulation
+    };
+}
+function parserBaseNestedTypeToString(arg, tabulation) {
+    const options = arg.nestedOptions && arg.nestedOptions.options ? arg.nestedOptions.options : {};
+    //const outMD = `${getTabulation(tabulation)}name | type |\n${getTabulation(tabulation)}--------|--------|\n`;
+    return internalParserToString(options, tabulation);
+}
+function getTabulation(n, header = false) {
+    let out = "";
+    for (let i = 0; i < n; i++) {
+        out += header ? "-|" : "| ";
+    }
+    return out;
+}

package/{dist → build}/utils/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { ExecSyncOptionsWithBufferEncoding } from "child_process";
 export declare const execSync: (cmd: string, options?: ExecSyncOptionsWithBufferEncoding) => void;
-export declare type Callback<T = any> = (...args: any[]) => T;
+export type Callback<T = any> = (...args: any[]) => T;
 export declare const extractFlags: (args: string[], options?: {
     flags: {
         [name: string]: {
@@ -15,14 +15,17 @@ export declare const extractFlags: (args: string[], options?: {
     };
     files: string[];
 };
-export declare const mainCMD: (cmds: {
+export declare function getUsage(cmds: CMDMap, usage: string): string;
+interface CMDMap {
     [key: string]: {
         cb: Callback<void> | Callback<Promise<void>>;
         description: string;
-        section?: string | undefined;
-        tabs?: number | undefined;
+        section?: string;
+        tabs?: number;
     };
-}, usage: string, logger: Console | {
+}
+export declare const mainCMD: (cmds: CMDMap, usage: string, logger: Console | {
     error: (...args: any[]) => void;
     info: (...args: any[]) => void;
 }, cmdArg?: string, exit?: boolean) => void;
+export {};

package/{dist → build}/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mainCMD = exports.extractFlags = exports.execSync = void 0;
+exports.mainCMD = exports.getUsage = exports.extractFlags = exports.execSync = void 0;
 const child_process_1 = require("child_process");
 const execSync = (cmd, options) => {
     console.log(cmd);
@@ -69,6 +69,24 @@ const getTabs = (n) => {
     }
     return ret;
 };
+function getUsage(cmds, usage) {
+    let out = "";
+    out += `${usage}`;
+    out += `Available commands:\n\n`;
+    for (const cmd of Object.keys(cmds)) {
+        if (cmds[cmd].section) {
+            out += `\n==${cmds[cmd].section}==\n\n`;
+        }
+        //const description = cmds[cmd].description.split("\n").map(s => `${getTabs(/*cmds[cmd].tabs*/2)}${s}`).join("\n");
+        //const description = cmds[cmd].description.split("\n").map(s => `${getTabs(/*cmds[cmd].tabs*/1)}${s}`).join("\n");
+        const description = cmds[cmd].description.split("\n").map(s => `${getTabs(cmds[cmd].tabs)}${s}`).join("\n");
+        out += `${cmd}${description}\n`;
+        //logger.info(`${cmd}\n${description}`);
+    }
+    out += "\n";
+    return out;
+}
+exports.getUsage = getUsage;
 const mainCMD = (cmds, usage, logger, cmdArg = process.argv[2], exit = true) => {
     const flow = async () => {
         try {
@@ -78,19 +96,7 @@ const mainCMD = (cmds, usage, logger, cmdArg = process.argv[2], exit = true) =>
             if (e && e.message) {
                 logger.error(e.message);
             }
-            logger.info(`${usage}`);
-            logger.info(`Available commands:\n`);
-            for (const cmd of Object.keys(cmds)) {
-                if (cmds[cmd].section) {
-                    logger.info(`\n==${cmds[cmd].section}==\n`);
-                }
-                //const description = cmds[cmd].description.split("\n").map(s => `${getTabs(/*cmds[cmd].tabs*/2)}${s}`).join("\n");
-                //const description = cmds[cmd].description.split("\n").map(s => `${getTabs(/*cmds[cmd].tabs*/1)}${s}`).join("\n");
-                const description = cmds[cmd].description.split("\n").map(s => `${getTabs(cmds[cmd].tabs)}${s}`).join("\n");
-                logger.info(`${cmd}${description}`);
-                //logger.info(`${cmd}\n${description}`);
-            }
-            logger.info("");
+            logger.info(getUsage(cmds, usage));
             if (exit) {
                 process.exit(1);
             }

package/package.json

@@ -1,36 +1,35 @@
 {
   "name": "miqro",
-  "version": "1.9.3",
+  "version": "3.0.0",
   "description": "",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "bin": {
-    "miqro": "dist/cli.js"
+    "miqro": "build/cli.js"
   },
   "scripts": {
-    "prepare": "npm run build",
-    "prebuild": "rm -Rf dist;",
+    "prepare2": "npm run build",
+    "prebuild": "rm -Rf build;",
     "build": "tsc",
     "pretest": "npm run build",
-    "test": "miqro-test test/*.test.js"
+    "test": "node --enable-source-maps --test test/",
+    "coverage": "node --enable-source-maps --experimental-test-coverage --test test/"
   },
   "author": "claukers",
   "license": "ISC",
   "dependencies": {
-    "@miqro/core": "^1.7.3",
-    "@miqro/parser": "^0.1.6",
-    "@miqro/runner": "^1.2.9",
-    "@miqro/test": "^0.2.8",
-    "deep-diff": "1.0.2"
+    "@miqro/core": "^3.0.1",
+    "@miqro/parser": "^1.0.1",
+    "@miqro/runner": "^1.3.0"
   },
   "devDependencies": {
+    "@miqro/test": "^0.2.9",
     "@types/cookie": "0.4.1",
-    "@types/deep-diff": "1.0.1",
-    "@types/node": "17.0.23",
-    "typescript": "4.7.4"
+    "@types/node": "^20.4.5",
+    "typescript": "5.0.4"
   },
   "engines": {
-    "node": ">=14.0.0",
+    "node": ">=18.0.0",
     "npm": ">=6.0.0"
   }
 }

package/dist/cmds/db-console.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:console";
-export declare const main: () => void;

package/dist/cmds/db-console.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const core_1 = require("@miqro/core");
-const readline_1 = require("readline");
-const db_1 = require("../utils/db");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:console";
-const main = () => {
-    if (process.argv.length !== 3) {
-        throw new Error(`invalid number of args. ${exports.usage}`);
-    }
-    (0, core_1.loadConfig)();
-    const logger = (0, core_1.getLogger)("db:console");
-    const rl = (0, readline_1.createInterface)({
-        input: process.stdin,
-        output: process.stdout
-    });
-    const db = (0, db_1.loadSequelize)();
-    const questionLoop = () => {
-        rl.question('>', async (query) => {
-            try {
-                logger.info(`${query}`);
-                const [result] = await db.query({
-                    query,
-                    values: []
-                });
-                logger.info(`${JSON.stringify(result, undefined, 4)}`);
-                questionLoop();
-            }
-            catch (e) {
-                logger.error(e);
-                questionLoop();
-            }
-        });
-    };
-    questionLoop();
-};
-exports.main = main;

package/dist/cmds/db-createmodel.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:create:model <modelname>";
-export declare const main: () => void;

package/dist/cmds/db-createmodel.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const fs_1 = require("fs");
-const path_1 = require("path");
-const templates_1 = require("../utils/templates");
-const core_1 = require("@miqro/core");
-const db_1 = require("../utils/db");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:create:model <modelname>";
-const main = () => {
-    const logger = console;
-    const modelName = process.argv[3];
-    if (process.argv.length !== 4) {
-        throw new Error(exports.usage);
-    }
-    if (typeof modelName !== "string") {
-        throw new Error(`<modelname> must be a string!`);
-    }
-    (0, core_1.loadConfig)();
-    const config = (0, db_1.loadSequelizeRC)();
-    // disable experimental typescript support
-    const modelsFolder = config["models-path"];
-    if (!(0, fs_1.existsSync)(modelsFolder)) {
-        logger.warn(`models folder [${modelsFolder}] doesnt exists!`);
-        logger.warn(`creating [${modelsFolder}]!`);
-        (0, fs_1.mkdirSync)(modelsFolder, {
-            recursive: true
-        });
-    }
-    const modelPath = (0, path_1.resolve)(modelsFolder, `${modelName.toLowerCase()}.js`);
-    if ((0, fs_1.existsSync)(modelPath)) {
-        throw new Error(`${modelPath} already exists!`);
-    }
-    logger.info(`creating [${modelPath}]!`);
-    (0, fs_1.writeFileSync)(modelPath, templates_1.templates.exampleModel(modelName));
-};
-exports.main = main;

package/dist/cmds/db-dump-data.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] [LIMIT_COUNT=100] npx miqro db:dump:data <outfile>";
-export declare const main: () => Promise<void>;

package/dist/cmds/db-dump-data.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const core_1 = require("@miqro/core");
-const path_1 = require("path");
-const fs_1 = require("fs");
-const db_1 = require("../utils/db");
-exports.usage = "usage: [NODE_ENV=development] [LIMIT_COUNT=100] npx miqro db:dump:data <outfile>";
-const main = async () => {
-    const logger = console;
-    const outfile = process.argv[3];
-    if (process.argv.length !== 4) {
-        throw new Error(`invalid number of args. ${exports.usage}`);
-    }
-    if (typeof outfile !== "string") {
-        throw new Error(`<outfile> must be a string!`);
-    }
-    const [LIMIT] = (0, core_1.checkEnvVariables)(["LIMIT"], ["100"]);
-    const limit = parseInt(LIMIT, 10);
-    if (isNaN(limit) || limit <= 0) {
-        throw new Error(`LIMIT must be a number grater than 0!`);
-    }
-    (0, core_1.loadConfig)();
-    const db = (0, db_1.loadSequelize)();
-    const out = {};
-    logger.info(`beware that if the model is not implicitly defined in db.models it will be dumped.`);
-    const models = Object.keys(db.models);
-    for (const modelName of models) {
-        let rows;
-        let offset = 0;
-        out[modelName] = [];
-        while ((rows = await db.models[modelName].findAndCountAll({
-            offset,
-            limit
-        })).rows.length > 0) {
-            out[modelName] = out[modelName].concat(rows.rows);
-            offset += limit;
-        }
-    }
-    await db.close();
-    (0, fs_1.writeFileSync)((0, path_1.resolve)(process.cwd(), outfile), JSON.stringify(out, undefined, 2));
-};
-exports.main = main;

package/dist/cmds/db-init.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:init";
-export declare const main: () => void;

package/dist/cmds/db-init.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const core_1 = require("@miqro/core");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const utils_1 = require("../utils");
-const db_1 = require("../utils/db");
-const templates_1 = require("../utils/templates");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:init";
-const main = () => {
-    const logger = console;
-    if (process.argv.length !== 3) {
-        throw new Error(`invalid number of args. ${exports.usage}`);
-    }
-    const initEnvFile = (path, template) => {
-        if (!(0, fs_1.existsSync)(path)) {
-            logger.warn(`creating ${path} env file`);
-            (0, fs_1.writeFileSync)(path, template);
-        }
-        else {
-            logger.warn(`${path} already exists!. init will not create it.`);
-        }
-    };
-    (0, core_1.loadConfig)();
-    if ((0, db_1.initDBConfig)()) {
-        const configPath = core_1.ConfigPathResolver.getConfigDirname();
-        if (!(0, fs_1.existsSync)(configPath)) {
-            logger.warn(`[${configPath}] doesnt exists!`);
-            (0, fs_1.mkdirSync)(configPath, {
-                recursive: true
-            });
-        }
-        initEnvFile((0, path_1.resolve)(configPath, `db.env`), templates_1.templates.dbEnvFile);
-        (0, utils_1.execSync)(`npm install sequelize --save`);
-    }
-};
-exports.main = main;

package/dist/cmds/db-makemigrations.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:make:migration";
-export declare const main: () => void;

package/dist/cmds/db-makemigrations.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const db_1 = require("../utils/db");
-const core_1 = require("@miqro/core");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:make:migration";
-const main = () => {
-    if (process.argv.length !== 3) {
-        throw new Error(`invalid number of args. ${exports.usage}`);
-    }
-    (0, core_1.loadConfig)();
-    (0, db_1.makemigrations)();
-};
-exports.main = main;

package/dist/cmds/db-migrate.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:migrate [...args]";
-export declare const main: () => void;

package/dist/cmds/db-migrate.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const utils_1 = require("../utils");
-const core_1 = require("@miqro/core");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:migrate [...args]";
-const main = () => {
-    (0, core_1.loadConfig)();
-    const args = process.argv.slice(3).join(" ");
-    (0, utils_1.execSync)(`npx sequelize-cli db:migrate${args ? ` ${args}` : ""}`);
-};
-exports.main = main;

package/dist/cmds/db-push-data.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] [BULK_CREATE_COUNT=10] [BULK_CREATE_IGNORE_ERROR=true] npx miqro db:push:data <outfile> <modelA,..>";
-export declare const main: () => Promise<void>;

package/dist/cmds/db-push-data.js

@@ -1,79 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const core_1 = require("@miqro/core");
-const path_1 = require("path");
-const fs_1 = require("fs");
-const db_1 = require("../utils/db");
-exports.usage = "usage: [NODE_ENV=development] [BULK_CREATE_COUNT=10] [BULK_CREATE_IGNORE_ERROR=true] npx miqro db:push:data <outfile> <modelA,..>";
-const main = async () => {
-    const outfile = process.argv[3];
-    const models = process.argv[4];
-    if (process.argv.length !== 5) {
-        throw new Error(exports.usage);
-    }
-    if (typeof outfile !== "string") {
-        throw new Error(`<outfile> must be a string!`);
-    }
-    if (typeof models !== "string") {
-        throw new Error(`<modelA,..> must be a list of model names!`);
-    }
-    (0, core_1.loadConfig)();
-    const [BULK_CREATE_COUNT, BULK_CREATE_IGNORE_ERROR] = (0, core_1.checkEnvVariables)(["BULK_CREATE_COUNT", "BULK_CREATE_IGNORE_ERROR"], ["10", "true"]);
-    const bulkCount = parseInt(BULK_CREATE_COUNT, 10);
-    if (isNaN(bulkCount) || bulkCount < 0) {
-        throw new Error(`BULK_CREATE_COUNT must be a number grater or equal than 0!`);
-    }
-    const modelList = models.split(",").map(o => o.trim());
-    const db = (0, db_1.loadSequelize)();
-    const out = JSON.parse((0, fs_1.readFileSync)((0, path_1.resolve)(process.cwd(), outfile)).toString());
-    for (const modelName of modelList) {
-        if (out[modelName] && db.models[modelName]) {
-            const list = out[modelName].map(i => {
-                const ret = {};
-                const attrs = Object.keys(i);
-                for (const a of attrs) {
-                    ret[a] = i[a] && i[a].type === "Buffer" ? Buffer.from(i[a]) : i[a];
-                }
-                return ret;
-            });
-            if (bulkCount === 0) {
-                for (const m of list) {
-                    try {
-                        await db.models[modelName].create(m);
-                    }
-                    catch (e) {
-                        if (BULK_CREATE_IGNORE_ERROR === "true") {
-                            console.error("error pushing");
-                            console.error(e.message);
-                            console.error("");
-                        }
-                        else {
-                            throw e;
-                        }
-                    }
-                }
-            }
-            else {
-                let current;
-                while ((current = list.splice(0, bulkCount)).length > 0) {
-                    try {
-                        await db.models[modelName].bulkCreate(current);
-                    }
-                    catch (e) {
-                        if (BULK_CREATE_IGNORE_ERROR === "true") {
-                            console.error("error pushing");
-                            console.error(e.message);
-                            console.error("");
-                        }
-                        else {
-                            throw e;
-                        }
-                    }
-                }
-            }
-        }
-    }
-    await db.close();
-};
-exports.main = main;

package/dist/cmds/db-sync-makemigrations.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro db:migration:forceclean";
-export declare const main: () => void;

package/dist/cmds/db-sync-makemigrations.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = exports.usage = void 0;
-const db_1 = require("../utils/db");
-const core_1 = require("@miqro/core");
-exports.usage = "usage: [NODE_ENV=development] npx miqro db:migration:forceclean";
-const main = () => {
-    if (process.argv.length !== 3) {
-        throw new Error(`invalid number of args`);
-    }
-    (0, core_1.loadConfig)();
-    (0, db_1.syncMakeMigrations)();
-};
-exports.main = main;

package/dist/cmds/doc-json.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath>";
-export declare const main: () => void;

package/dist/cmds/doc-md.d.ts

@@ -1,2 +0,0 @@
-export declare const usage = "usage: [NODE_ENV=development] npx miqro doc:md <api_folder> <subPath> <out.md>";
-export declare const main: () => void;