miqro 1.9.3 → 2.0.2

package/README.md

@@ -24,7 +24,6 @@ config:bash			    print config as a bash script.
 config:env			    print config as a env file.
 config:init			    inits your config folder.
 doc				        api folder auto doc as a json.
-doc:md				    api folder auto doc as a markdown.
 
 ==start helpers==
 

package/dist/cli.js

@@ -7,7 +7,7 @@ const test_1 = require("./cmds/test");
 const watch_1 = require("./cmds/watch");
 const new_1 = require("./cmds/new");
 const doc_json_1 = require("./cmds/doc-json");
-const doc_md_1 = require("./cmds/doc-md");
+//import {main as apiDocMD} from "./cmds/doc-md.ts.disable";
 const config_init_1 = require("./cmds/config-init");
 const config_1 = require("./cmds/config");
 const config_bash_1 = require("./cmds/config-bash");
@@ -58,11 +58,11 @@ const db_migrate_1 = require("./cmds/db-migrate");
         cb: doc_json_1.main,
         description: `api folder auto doc as a json.`
     },
-    ["doc:md"]: {
-        cb: doc_md_1.main,
-        tabs: 4,
-        description: `api folder auto doc as a markdown.`
-    },
+    /*["doc:md"]: {
+      cb: apiDocMD,
+      tabs: 4,
+      description: `api folder auto doc as a markdown.`
+    },*/
     /*["new:front"]: {
       section: "front end development",
       cb: newTSFront,
@@ -75,6 +75,11 @@ const db_migrate_1 = require("./cmds/db-migrate");
         cb: start_1.main,
         description: `start script in cluster mode.`
     },
+    ["cluster"]: {
+        tabs: 4,
+        cb: start_1.main,
+        description: `alias for start command.`
+    },
     ["watch"]: {
         //section: "watch",
         cb: watch_1.main,

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

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

package/dist/cmds/doc-json.js

@@ -3,14 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = exports.usage = void 0;
 const core_1 = require("@miqro/core");
 const doc_1 = require("../utils/doc");
-exports.usage = `usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath>`;
+exports.usage = `usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName]`;
 const main = () => {
-    if (process.argv.length !== 5) {
+    if (process.argv.length < 5 || process.argv.length > 6) {
         throw new Error(exports.usage);
     }
     const dirname = process.argv[3];
     const subPath = process.argv[4];
+    const apiName = process.argv[5];
     (0, core_1.loadConfig)();
-    console.log(JSON.stringify((0, doc_1.getDOCJSON)({ dirname, subPath }, (0, core_1.getLogger)("miqro")), undefined, 2));
+    console.log(JSON.stringify((0, doc_1.getDOCJSON)({ dirname, subPath, apiName }, (0, core_1.getLogger)("miqro")), undefined, 2));
 };
 exports.main = main;

package/dist/cmds/start.d.ts

@@ -1,2 +1,2 @@
-export declare const usage = "usage: [NODE_ENV=development] CLUSTER_COUNT=1 [DISABLE_RESTART=true|false] npx miqro start <script> [...args]";
+export declare const usage = "usage: [NODE_ENV=development] CLUSTER_COUNT=os.cpus().length [DISABLE_RESTART=true|false] npx miqro start <script> [...args]";
 export declare const main: () => void;

package/dist/cmds/start.js

@@ -4,7 +4,7 @@ exports.main = exports.usage = void 0;
 const utils_1 = require("../utils");
 const runner_1 = require("@miqro/runner");
 const core_1 = require("@miqro/core");
-exports.usage = "usage: [NODE_ENV=development] CLUSTER_COUNT=1 [DISABLE_RESTART=true|false] npx miqro start <script> [...args]";
+exports.usage = "usage: [NODE_ENV=development] CLUSTER_COUNT=os.cpus().length [DISABLE_RESTART=true|false] npx miqro start <script> [...args]";
 const main = () => {
     if (process.argv.length <= 3) {
         throw new Error(`invalid number of args\n${exports.usage}`);

package/dist/utils/db/index.js

@@ -21,12 +21,12 @@ const loadSequelizeRC = (sequelizercPath = core_1.ConfigPathResolver.getSequeliz
         // noinspection SpellCheckingInspection
         /* eslint-disable  @typescript-eslint/no-var-requires */
         const sequelizerc = require(sequelizercPath);
-        return (0, parser_1.parse)(sequelizerc, [
-            { name: "config", type: "string", required: true },
-            { name: "migrations-path", type: "string", required: true },
-            { name: "seeders-path", type: "string", required: true },
-            { name: "models-path", type: "string", required: true }
-        ], "no_extra", sequelizercPath);
+        return (0, parser_1.parse)(sequelizerc, {
+            config: "string",
+            "migrations-path": "string",
+            "seeders-path": "string",
+            "models-path": "string"
+        }, "no_extra", sequelizercPath);
     }
 };
 exports.loadSequelizeRC = loadSequelizeRC;

package/dist/utils/doc/index.d.ts

@@ -1,18 +1,7 @@
-import { GroupPolicy, Logger, Method, SessionHandlerOptions } from "@miqro/core";
-import { ParseOptions } from "@miqro/parser";
-export declare const getDOCJSON: ({ dirname, subPath }: {
+import { Logger } from "@miqro/core";
+import { RouterJSONDoc } from "@miqro/core/dist/common/router-utils";
+export declare const getDOCJSON: ({ dirname, subPath, apiName }: {
+    apiName?: string | undefined;
     dirname: string;
     subPath: string;
-}, logger: Logger) => {
-    path?: string | string[];
-    method?: Method | Method[];
-    description?: string;
-    policy?: GroupPolicy;
-    headers?: ParseOptions | ParseOptions[];
-    session?: false | true | SessionHandlerOptions;
-    params?: boolean | ParseOptions | ParseOptions[] | string;
-    query?: boolean | ParseOptions | ParseOptions[] | string;
-    body?: boolean | ParseOptions | ParseOptions[] | string;
-    response?: ParseOptions | ParseOptions[] | string;
-    featureName: string;
-}[];
+}, logger: Logger) => RouterJSONDoc;

package/dist/utils/doc/index.js

@@ -2,35 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDOCJSON = void 0;
 const core_1 = require("@miqro/core");
-const api_router_utils_1 = require("@miqro/core/dist/common/api-router-utils");
 const path_1 = require("path");
-const getDOCJSON = ({ dirname, subPath }, logger) => {
-    const apiTraverse = (0, api_router_utils_1.traverseAPIRouteDir)((0, path_1.basename)(dirname).toUpperCase(), (0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), dirname), subPath, undefined, logger);
-    const docJSON = Object.keys(apiTraverse).map(featureName => {
-        const { path, method, options } = apiTraverse[featureName];
-        const { session, policy, description } = options ? options : {
-            session: undefined,
-            policy: undefined,
-            description: undefined
-        };
-        const { params, query, body, headers } = options && options.request ? options.request : {
-            params: undefined,
-            query: undefined,
-            body: undefined,
-            headers: undefined
-        };
-        const result = options && options.response !== true ? options.response : undefined;
-        return {
-            path,
-            method,
-            headers,
-            session: session ? typeof session === "function" ? true : session : false,
-            policy,
-            params,
-            description, query, body, result,
-            featureName
-        };
-    });
-    return docJSON;
+const getDOCJSON = ({ dirname, subPath, apiName }, logger) => {
+    //const apiTraverse = traverseAPIRouteDir(basename(dirname).toUpperCase(), resolve(ConfigPathResolver.getBaseDirname(), dirname), subPath, undefined, logger);
+    console.log(apiName);
+    const router = (0, core_1.APIRouter)({
+        apiName,
+        dirname: (0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), dirname),
+        path: subPath
+    }, logger);
+    return router.getJSONDoc();
 };
 exports.getDOCJSON = getDOCJSON;

package/dist/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]: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miqro",
-  "version": "1.9.3",
+  "version": "2.0.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,17 +17,17 @@
   "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",
+    "@miqro/core": "^2.0.2",
+    "@miqro/parser": "^1.0.1",
+    "@miqro/runner": "^1.2.10",
+    "@miqro/test": "^0.2.9",
     "deep-diff": "1.0.2"
   },
   "devDependencies": {
     "@types/cookie": "0.4.1",
     "@types/deep-diff": "1.0.1",
     "@types/node": "17.0.23",
-    "typescript": "4.7.4"
+    "typescript": "5.0.4"
   },
   "engines": {
     "node": ">=14.0.0",

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;

package/dist/cmds/doc-md.js

@@ -1,234 +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 doc_1 = require("../utils/doc");
-exports.usage = `usage: [NODE_ENV=development] npx miqro doc:md <api_folder> <subPath> <out.md>`;
-const main = () => {
-    if (process.argv.length !== 6) {
-        throw new Error(exports.usage);
-    }
-    const dirname = process.argv[3];
-    const subPath = process.argv[4];
-    const outPath = process.argv[5];
-    (0, core_1.loadConfig)();
-    const parseOptionMap2ParseOptionList = (map) => {
-        return Object.keys(map).map(name => {
-            const val = map[name];
-            return typeof val !== "object" ? {
-                name,
-                required: true,
-                type: val
-            } : val.required === undefined ? {
-                ...val,
-                required: true,
-                name
-            } : {
-                ...val,
-                name
-            };
-        });
-    };
-    const docJSON = (0, doc_1.getDOCJSON)({ dirname, subPath }, (0, core_1.getLogger)("miqro"));
-    const policyTable = (policy) => {
-        if (policy) {
-            return `|policy|groups|\n|----|----|\n|${policy.groupPolicy}|${policy.groups.join(", ")}|`;
-        }
-        else {
-            return "";
-        }
-    };
-    const methodUrlTable = (options) => {
-        if (options && options.path) {
-            const rows = [];
-            const paths = options.path instanceof Array ? options.path : [options.path];
-            for (const p of paths) {
-                if (options.method instanceof Array) {
-                    for (const m of options.method) {
-                        rows.push(`|${m}|${p}|`);
-                    }
-                }
-                else {
-                    rows.push(`|${options.method}|${p}|`);
-                }
-            }
-            return `|method|path|\n|----|----|\n${rows.join("\n")}`;
-        }
-        else {
-            return "";
-        }
-    };
-    const getRange = (o, t) => {
-        let range = " ";
-        switch (t) {
-            case "string":
-                if (o.stringMinLength !== undefined || o.stringMaxLength !== undefined) {
-                    range = "";
-                }
-                if (o.stringMinLength !== undefined) {
-                    range = `${o.stringMinLength}:`;
-                }
-                if (o.stringMaxLength !== undefined) {
-                    range += `:${o.stringMaxLength}`;
-                }
-                break;
-            case "number":
-                if (o.numberMin !== undefined || o.numberMax !== undefined) {
-                    range = "";
-                }
-                if (o.numberMin !== undefined) {
-                    range = `${o.numberMin}:`;
-                }
-                if (o.numberMax !== undefined) {
-                    range += `:${o.numberMax}`;
-                }
-                if (o.numberMinDecimals !== undefined) {
-                    range = `${range ? " " : ""}decimal ${o.numberMinDecimals}:`;
-                }
-                if (o.numberMaxDecimals !== undefined) {
-                    range += `${range ? " " : ""}${o.numberMinDecimals !== undefined ? "" : "decimal "}:${o.numberMaxDecimals}`;
-                }
-                break;
-            case "array":
-                if (o.arrayMinLength !== undefined || o.arrayMaxLength !== undefined) {
-                    range = "";
-                }
-                if (o.arrayMinLength !== undefined) {
-                    range = `${o.arrayMinLength}:`;
-                }
-                if (o.arrayMaxLength !== undefined) {
-                    range += `:${o.arrayMaxLength}`;
-                }
-                break;
-        }
-        return range;
-    };
-    const parseOptionTable = (options, subName = "", tableHeaders = 0) => {
-        if (typeof options !== "boolean" && options) {
-            let padding = "";
-            for (let i = 0; i < tableHeaders; i++) {
-                padding += "| ";
-            }
-            const hl = "|----|----|----|----|----|----|----|----|----|----|";
-            const list = options.options instanceof Array ? options.options : parseOptionMap2ParseOptionList(options.options);
-            const headers = `|**name**|**description**|**type**|**arrayRange**|**arrayType**|**range**|**values**|**defaultValue**|**required**|**allowNull**|`;
-            return `${tableHeaders >= 0 ? `${padding}${headers}\n${tableHeaders === 0 ? `${padding}${hl}\n` : ""}` : ""}${list.map(o => {
-                const arrayRange = o.type === "array" ? getRange(o, o.type) : " ";
-                const range = o.type === "array" ? (o.arrayType ? getRange(o, o.arrayType) : " ") : getRange(o, o.type);
-                let out = `${padding}|${subName}${o.name}|${o.description ? o.description : " "}|${o.type}|${arrayRange}|${o.arrayType ? o.arrayType : " "}|` +
-                    `${range}|` +
-                    `${o.enumValues ? o.enumValues.join(", ") : " "}|${o.defaultValue !== undefined ? o.defaultValue : " "}|${o.required === undefined ? true : o.required}|${o.allowNull ? "true" : "false"}|`;
-                if (o.type === "multiple" || o.arrayType === "multiple") {
-                    out += `\n${(o.multipleOptions ? o.multipleOptions : []).map(oM => {
-                        return parseOptionTable({
-                            options: [{
-                                    name: o.name,
-                                    ...oM
-                                }]
-                        }, "", tableHeaders ? tableHeaders + 1 : 1);
-                    })}`;
-                    return out;
-                }
-                else if (o.type === "nested" || o.arrayType === "nested") {
-                    out += `\n${parseOptionTable({ options: o.nestedOptions ? o.nestedOptions.options : [] }, `${subName}${o.name}${o.type === "array" ? "[..]" : ""}.`, tableHeaders ? tableHeaders + 1 : 1)}`;
-                    return out;
-                }
-                else {
-                    return out;
-                }
-            }).join("\n")}`;
-        }
-        else if (options === false) {
-            return "";
-        }
-        else {
-            return "";
-        }
-    };
-    const FAKE_TAB = "    ";
-    const FAKE_DOUBLE_TAB = `${FAKE_TAB}${FAKE_TAB}`;
-    const featureIndex = `${docJSON.map(doc => {
-        return `- [${doc.featureName}](#${doc.featureName.toLowerCase()})\n\n${doc.description ? `${FAKE_TAB}${doc.description}\n\n` : ""}${FAKE_DOUBLE_TAB}${doc.path}`;
-    }).join("\n\n")}`;
-    (0, fs_1.writeFileSync)((0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), outPath), `${featureIndex}\n\n` + docJSON.map(doc => {
-        const param = doc.params instanceof Array ? doc.params : [doc.params];
-        const paramsTable = [];
-        for (const q of param) {
-            let paramTable = typeof q === "string" ? `${q}` : parseOptionTable(q);
-            if (paramTable.split("\n").length > 1) {
-                paramTable = `### params${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}\n\n${paramTable}`;
-            }
-            else {
-                paramTable = paramTable === "" ? "" : `### params${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}: ${paramTable}`;
-            }
-            if (paramTable !== "") {
-                paramsTable.push(paramTable);
-            }
-        }
-        const query = doc.query instanceof Array ? doc.query : [doc.query];
-        const queryTables = [];
-        for (const q of query) {
-            let queryTable = typeof q === "string" ? `${q}` : parseOptionTable(q);
-            // let paramsTable = parseOptionTable(doc.params);
-            if (queryTable.split("\n").length > 1) {
-                queryTable = `### query${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}\n\n${queryTable}`;
-            }
-            else {
-                queryTable = queryTable === "" ? "" : `### query${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}: ${queryTable}`;
-            }
-            if (queryTable !== "") {
-                queryTables.push(queryTable);
-            }
-        }
-        /*if (paramsTable.split("\n").length > 1) {
-          paramsTable = `- params\n\n${paramsTable}`;
-        } else {
-          paramsTable = paramsTable === "" ? "" : `- params: ${paramsTable}`;
-        }*/
-        const body = doc.body instanceof Array ? doc.body : [doc.body];
-        const bodyTables = [];
-        for (const b of body) {
-            let bodyTable = typeof b === "string" ? `${b}` : parseOptionTable(b);
-            if (bodyTable.split("\n").length > 1) {
-                bodyTable = `### body${typeof b !== "boolean" && typeof b !== "string" && b && b.description ? ` (${b.description})` : ""}\n\n${bodyTable}`;
-            }
-            else {
-                bodyTable = bodyTable === "" ? "" : `### body${typeof b !== "boolean" && typeof b !== "string" && b && b.description ? ` (${b.description})` : ""}: ${bodyTable}`;
-            }
-            if (bodyTable !== "") {
-                bodyTables.push(bodyTable);
-            }
-        }
-        const results = doc.response instanceof Array ? doc.response : [doc.response];
-        const resultTables = [];
-        for (const r of results) {
-            if (!r) {
-                continue;
-            }
-            let resultsTable = r && typeof r !== "string" && typeof r !== "boolean" ? parseOptionTable(r) : r;
-            if (resultsTable.split("\n").length > 1) {
-                resultsTable = `### response${typeof r !== "boolean" && typeof r !== "string" && r.description ? ` (${r.description})` : ""}\n\n${resultsTable}`;
-            }
-            else {
-                resultsTable = resultsTable === "" ? "" : `### response${typeof r !== "boolean" && typeof r !== "string" && r.description ? ` (${r.description})` : ""}: ${resultsTable}`;
-            }
-            if (resultsTable !== "") {
-                resultTables.push(resultsTable);
-            }
-        }
-        const pTable = policyTable(doc.policy);
-        return `## ${doc.featureName}\n\n` +
-            `${doc.description ? `${doc.description}\n\n` : ""}` +
-            `${pTable ? `${pTable}\n\n` : ""}` +
-            `### endpoint\n\n` +
-            `${methodUrlTable(doc)}\n\n` +
-            // `${paramsTable ? `${paramsTable}\n\n` : ""}` +
-            `${paramsTable.length > 0 ? `${paramsTable.join("\n\n")}\n\n` : ""}` +
-            `${queryTables.length > 0 ? `${queryTables.join("\n\n")}\n\n` : ""}` +
-            `${bodyTables.length > 0 ? `${bodyTables.join("\n\n")}\n\n` : ""}` +
-            `${resultTables.length > 0 ? `${resultTables.join("\n\n")}\n\n` : ""}`;
-    }).join("\n\n"));
-};
-exports.main = main;