miqro 1.7.4 → 1.7.8

package/dist/cli.js

@@ -6,7 +6,6 @@ const utils_1 = require("./utils");
 const start_1 = require("./cmds/start");
 const new_1 = require("./cmds/new");
 const new_2 = require("./cmds/new");
-const test_1 = require("./cmds/test");
 const doc_json_1 = require("./cmds/doc-json");
 const doc_md_1 = require("./cmds/doc-md");
 const config_init_1 = require("./cmds/config-init");
@@ -14,6 +13,8 @@ const config_1 = require("./cmds/config");
 const config_bash_1 = require("./cmds/config-bash");
 const config_env_1 = require("./cmds/config-env");
 const handler_apiroute_new_1 = require("./cmds/handler-apiroute-new");
+const new_test_1 = require("./cmds/new-test");
+const serve_1 = require("./cmds/serve");
 const handler_main_new_1 = require("./cmds/handler-main-new");
 //@miqro/database
 const db_init_1 = require("./cmds/db-init");
@@ -37,9 +38,10 @@ const db_dump_data_1 = require("./cmds/db-dump-data");
     ["config:env"]: { cb: config_env_1.main, description: "\t\t\toutputs to stdout the config as a env file" },
     ["config:init"]: { cb: config_init_1.main, description: "\t\t\tinits your config folder" },
     ["start"]: { section: "cluster start", cb: start_1.main, description: "\t\t\t\tstart a nodejs script in cluster mode and restart if crash." },
+    ["serve"]: { section: "serve static files", cb: serve_1.main, description: "\t\t\t\tserve static files." },
     ["doc"]: { section: "api documentation", cb: doc_json_1.main, description: "\t\t\t\toutputs to stdout an api folder auto doc as a json" },
     ["doc:md"]: { cb: doc_md_1.main, description: "\t\t\t\toutputs to a file an api folder auto doc as a markdown" },
-    ["test"]: { cb: test_1.main, description: "\t\t\t\trun test files." },
+    ["test:new"]: { section: "testing", cb: new_test_1.main, description: "\t\t\tcreate new test.js file." },
     ["db:console"]: { section: "sequelize helpers", cb: db_console_1.main, description: "\t\t\truns a readline interface that send the input as a query" },
     ["db:dump:data"]: { cb: db_dump_data_1.main, description: "\t\t\tdump the data of the database (only defined models)" },
     ["db:push:data"]: { cb: db_push_data_1.main, description: "\t\t\tpush a dump to the database" },

package/dist/cmds/doc-md.js

@@ -105,7 +105,7 @@ const main = () => {
         return range;
     };
     const parseOptionTable = (options, subName = "", tableHeaders = 0) => {
-        if (options) {
+        if (typeof options !== "boolean" && options) {
             let padding = "";
             for (let i = 0; i < tableHeaders; i++) {
                 padding += "| ";
@@ -155,13 +155,12 @@ const main = () => {
         const param = doc.params instanceof Array ? doc.params : [doc.params];
         const paramsTable = [];
         for (const q of param) {
-            let paramTable = parseOptionTable(q);
-            // let paramsTable = parseOptionTable(doc.params);
+            let paramTable = typeof q === "string" ? `${q}` : parseOptionTable(q);
             if (paramTable.split("\n").length > 1) {
-                paramTable = `### params${q && q.description ? ` (${q.description})` : ""}\n\n${paramTable}`;
+                paramTable = `### params${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}\n\n${paramTable}`;
             }
             else {
-                paramTable = paramTable === "" ? "" : `### params${q && q.description ? ` (${q.description})` : ""}: ${paramTable}`;
+                paramTable = paramTable === "" ? "" : `### params${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}: ${paramTable}`;
             }
             if (paramTable !== "") {
                 paramsTable.push(paramTable);
@@ -170,13 +169,13 @@ const main = () => {
         const query = doc.query instanceof Array ? doc.query : [doc.query];
         const queryTables = [];
         for (const q of query) {
-            let queryTable = parseOptionTable(q);
+            let queryTable = typeof q === "string" ? `${q}` : parseOptionTable(q);
             // let paramsTable = parseOptionTable(doc.params);
             if (queryTable.split("\n").length > 1) {
-                queryTable = `### query${q && q.description ? ` (${q.description})` : ""}\n\n${queryTable}`;
+                queryTable = `### query${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}\n\n${queryTable}`;
             }
             else {
-                queryTable = queryTable === "" ? "" : `### query${q && q.description ? ` (${q.description})` : ""}: ${queryTable}`;
+                queryTable = queryTable === "" ? "" : `### query${typeof q !== "boolean" && typeof q !== "string" && q && q.description ? ` (${q.description})` : ""}: ${queryTable}`;
             }
             if (queryTable !== "") {
                 queryTables.push(queryTable);
@@ -190,29 +189,29 @@ const main = () => {
         const body = doc.body instanceof Array ? doc.body : [doc.body];
         const bodyTables = [];
         for (const b of body) {
-            let bodyTable = parseOptionTable(b);
+            let bodyTable = typeof b === "string" ? `${b}` : parseOptionTable(b);
             if (bodyTable.split("\n").length > 1) {
-                bodyTable = `### body${b && b.description ? ` (${b.description})` : ""}\n\n${bodyTable}`;
+                bodyTable = `### body${typeof b !== "boolean" && typeof b !== "string" && b && b.description ? ` (${b.description})` : ""}\n\n${bodyTable}`;
             }
             else {
-                bodyTable = bodyTable === "" ? "" : `### body${b && b.description ? ` (${b.description})` : ""}: ${bodyTable}`;
+                bodyTable = bodyTable === "" ? "" : `### body${typeof b !== "boolean" && typeof b !== "string" && b && b.description ? ` (${b.description})` : ""}: ${bodyTable}`;
             }
             if (bodyTable !== "") {
                 bodyTables.push(bodyTable);
             }
         }
-        const results = doc.result instanceof Array ? doc.result : [doc.result];
+        const results = doc.response instanceof Array ? doc.response : [doc.response];
         const resultTables = [];
         for (const r of results) {
             if (!r) {
                 continue;
             }
-            let resultsTable = doc.result ? parseOptionTable(r) : "";
+            let resultsTable = r && typeof r !== "string" && typeof r !== "boolean" ? parseOptionTable(r) : r;
             if (resultsTable.split("\n").length > 1) {
-                resultsTable = `### response${r.description ? ` (${r.description})` : ""}\n\n${resultsTable}`;
+                resultsTable = `### response${typeof r !== "boolean" && typeof r !== "string" && r.description ? ` (${r.description})` : ""}\n\n${resultsTable}`;
             }
             else {
-                resultsTable = resultsTable === "" ? "" : `### response${r.description ? ` (${r.description})` : ""}: ${resultsTable}`;
+                resultsTable = resultsTable === "" ? "" : `### response${typeof r !== "boolean" && typeof r !== "string" && r.description ? ` (${r.description})` : ""}: ${resultsTable}`;
             }
             if (resultsTable !== "") {
                 resultTables.push(resultsTable);

package/dist/cmds/handler-apiroute-new.js

@@ -5,26 +5,38 @@ const core_1 = require("@miqro/core");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const templates = {
-    ts: (path) => `import { APIRoute, Context } from "@miqro/core";
+    ts: (noMethod = false) => noMethod ? `import { APIRoute } from "@miqro/core";
 
-const route: APIRoute = {
-  path: "${path}",
-  method: "POST",
-  handler: async (ctx: Context) => {
+export default {
+  method: "GET",
+  handler: async (ctx) => {
     return {
-      text: \`Hello \${ctx.body.name}!\`
+      text: \`Hello\`
     }
   }
-};
+} as APIRoute;
+` : `import { APIRoute } from "@miqro/core";
 
-export default route;
+export default {
+  handler: async (ctx) => {
+    return {
+      text: \`Hello\`
+    }
+  }
+} as APIRoute;
 `,
-    js: (path) => `module.exports = {
-  path: "${path}",
-  method: "POST",
+    js: (noMethod = false) => noMethod ? `module.exports = {
+  method: "GET
+  handler: async (ctx) => {
+    return {
+      text: \`Hello\`
+    }
+  }
+};
+` : `module.exports = {
   handler: async (ctx) => {
     return {
-      text: \`Hello \${ctx.body.name}!\`
+      text: \`Hello\`
     }
   }
 };
@@ -35,7 +47,7 @@ const main = () => {
         throw new Error(`arguments: <identifier ex: SRC_API_V1_HEALTH>`);
     }
     const identifier = process.argv[3].toLocaleLowerCase();
-    const split = identifier.split("_");
+    const split = identifier.split("_").map(s => s.trim()).filter(s => s);
     const dots = split.filter(s => s.indexOf(".") !== -1);
     if (dots.length > 0) {
         throw new Error(`identifier cannot contain dots\narguments: <identifier ex: SRC_API_V1_HEALTH>`);
@@ -43,6 +55,7 @@ const main = () => {
     (0, core_1.loadConfig)();
     const path = (0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), ...split.splice(0, split.length - 1));
     const ext = (0, fs_1.existsSync)((0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), "tsconfig.json")) ? "ts" : "js";
+    const noMethod = ["post", "get", "put", "delete", "patch", "options"].indexOf(split[0].toLocaleLowerCase()) === -1;
     const filePath = (0, path_1.resolve)(path, `${split[0]}.${ext}`);
     if ((0, fs_1.existsSync)(filePath)) {
         throw new Error(`file ${filePath} already exists! doing nothing`);
@@ -51,6 +64,6 @@ const main = () => {
     (0, fs_1.mkdirSync)(path, {
         recursive: true
     });
-    (0, fs_1.writeFileSync)(filePath, templates[ext](`/${split[0]}`));
+    (0, fs_1.writeFileSync)(filePath, templates[ext](noMethod));
 };
 exports.main = main;

package/dist/cmds/handler-main-new.js

@@ -70,5 +70,6 @@ const main = () => {
         recursive: true
     });
     (0, fs_1.writeFileSync)(filePath, mainTemplates[ext]());
+    console.log(`file ${filePath} created`);
 };
 exports.main = main;

package/dist/cmds/new-test.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const core_1 = require("@miqro/core");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const testTemplates = {
+    js: (category) => `const options = {
+	category: "${category}",
+	before: async () => {
+
+	},
+	after: async () => {
+
+	}
+};
+
+it("happy path", async () => {
+
+}, options)
+`
+};
+const main = () => {
+    if (process.argv.length !== 4 || process.argv[3].length < 1) {
+        throw new Error(`arguments: <identifier ex: SRC_MAIN>`);
+    }
+    const identifier = process.argv[3].toLocaleLowerCase();
+    const split = identifier.split("_");
+    const dots = split.filter(s => s.indexOf(".") !== -1);
+    if (dots.length > 0) {
+        throw new Error(`identifier cannot contain dots\narguments: <identifier ex: TEST_SOMETEST>`);
+    }
+    (0, core_1.loadConfig)();
+    const path = (0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), ...split.splice(0, split.length - 1));
+    const filePath = (0, path_1.resolve)(path, `${split[0]}.test.js`);
+    if ((0, fs_1.existsSync)(filePath)) {
+        throw new Error(`file ${filePath} already exists! doing nothing`);
+    }
+    console.log(`creating ${filePath}`);
+    (0, fs_1.mkdirSync)(path, {
+        recursive: true
+    });
+    (0, fs_1.writeFileSync)(filePath, testTemplates.js(split[0]));
+    console.log(`file ${filePath} created`);
+};
+exports.main = main;

package/dist/cmds/new.js

@@ -4,6 +4,12 @@ exports.mainTS = exports.mainJS = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const utils_1 = require("../utils");
+const gitignoreTemplate = {
+    ts: () => `node_modules/
+dist/
+`,
+    js: () => `node_modules/`
+};
 const packageTemplate = {
     ts: (name) => `{
   "name": "${name}",
@@ -12,8 +18,12 @@ const packageTemplate = {
   "private": true,
   "main": "dist/main.js",
   "scripts": {
+    "prebuild": "rm -Rf dist/;",
     "build": "tsc",
-    "start": "node dist/main.js"
+    "prestart": "npm run build",
+    "start": "node dist/main.js",
+    "pretest": "npm run build",
+    "test": "miqro-test -r test/ -n"
   },
   "devDependencies": {
   },
@@ -29,7 +39,8 @@ const packageTemplate = {
   "private": true,
   "main": "src/main.js",
   "scripts": {
-    "start": "node src/main.js"
+    "start": "node src/main.js",
+    "test": "miqro-test -r test/ -n"
   },
   "devDependencies": {
   },
@@ -63,6 +74,10 @@ const mainJS = (typescript = false) => {
         (0, fs_1.writeFileSync)((0, path_1.resolve)(appFolder, "tsconfig.json"), `{
   "compileOnSave": true,
   "compilerOptions": {
+    "lib": ["es2021"],
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "target": "es2021",
     "strict": false,
     "outDir": "./dist/",
     "removeComments": true,
@@ -70,13 +85,7 @@ const mainJS = (typescript = false) => {
     "preserveConstEnums": true,
     "sourceMap": true,
     "esModuleInterop": true,
-    "declaration": true,
-    "moduleResolution": "node",
-    "module": "commonjs",
-    "target": "es2017",
-    "lib": [
-      "es2017"
-    ]
+    "declaration": true
   },
   "exclude": [
     "node_modules",
@@ -86,19 +95,35 @@ const mainJS = (typescript = false) => {
     "src"
   ]
 }`);
-        /*execSync(`npm install typescript --save-dev`, {
-          cwd: appFolder
+        (0, utils_1.execSync)(`npm install typescript --save-dev`, {
+            cwd: appFolder
+        });
+        (0, utils_1.execSync)(`npm install @types/node --save-dev`, {
+            cwd: appFolder
         });
-        execSync(`npm install @types/node --save-dev`, {
-          cwd: appFolder
-        });*/
+        (0, fs_1.writeFileSync)((0, path_1.resolve)(appFolder, ".gitignore"), gitignoreTemplate.ts());
+    }
+    else {
+        (0, fs_1.writeFileSync)((0, path_1.resolve)(appFolder, ".gitignore"), gitignoreTemplate.js());
     }
+    (0, utils_1.execSync)(`npm install @miqro/test --save-dev`, {
+        cwd: appFolder
+    });
     (0, utils_1.execSync)(`npx miqro new:main src_main`, {
         cwd: appFolder
     });
     (0, utils_1.execSync)(`npx miqro new:route src_api_health`, {
         cwd: appFolder
     });
+    (0, fs_1.mkdirSync)((0, path_1.resolve)(appFolder, "test"), {
+        recursive: true
+    });
+    (0, utils_1.execSync)(`npx miqro test:new test_api_health`, {
+        cwd: appFolder
+    });
+    console.log(`new project created on ${appFolder}`);
+    console.log(`cd ${identifier}`);
+    console.log(`npm run start`);
 };
 exports.mainJS = mainJS;
 const mainTS = () => (0, exports.mainJS)(true);

package/dist/cmds/serve.d.ts

@@ -0,0 +1 @@
+export declare const main: () => void;

package/dist/cmds/serve.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const core_1 = require("@miqro/core");
+const main = () => {
+    if (process.argv.length <= 3 || process.argv.length > 5) {
+        throw new Error(`invalid number of args\nusage: [PORT=8080] npx miqro serve <directory> [path=/]`);
+    }
+    const directory = process.argv[3];
+    const path = process.argv[4] ? process.argv[4] : "/";
+    (0, core_1.loadConfig)();
+    const PORT = process.env.PORT ? process.env.PORT : 8080;
+    if (PORT === undefined) {
+        throw new Error("PORT env var not defined");
+    }
+    const app = new core_1.App();
+    app.use((0, core_1.LoggerHandler)());
+    app.use((0, core_1.Static)({
+        directory,
+        list: true
+    }), path);
+    app.listen(PORT, () => {
+        console.log("serving " + directory + " on " + path + " on port " + PORT);
+    });
+};
+exports.main = main;

package/dist/utils/db/index.js

@@ -6,6 +6,7 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const templates_1 = require("../../utils/templates");
 const core_1 = require("@miqro/core");
+const parser_1 = require("@miqro/parser");
 const logger = console;
 const loadSequelizeRC = (sequelizercPath = core_1.ConfigPathResolver.getSequelizeRCFilePath(), logger) => {
     // noinspection SpellCheckingInspection
@@ -20,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, core_1.parse)(sequelizercPath, sequelizerc, [
+        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");
+        ], "no_extra", sequelizercPath);
     }
 };
 exports.loadSequelizeRC = loadSequelizeRC;

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

@@ -1,4 +1,5 @@
-import { ParseOptions, Logger, SessionHandlerOptions, GroupPolicy, Method } from "@miqro/core";
+import { GroupPolicy, Logger, Method, SessionHandlerOptions } from "@miqro/core";
+import { ParseOptions } from "@miqro/parser";
 export declare const getDOCJSON: ({ dirname, subPath }: {
     dirname: string;
     subPath: string;
@@ -9,9 +10,9 @@ export declare const getDOCJSON: ({ dirname, subPath }: {
     policy?: GroupPolicy;
     headers?: ParseOptions | ParseOptions[];
     session?: false | true | SessionHandlerOptions;
-    params?: false | ParseOptions | ParseOptions[];
-    query?: false | ParseOptions | ParseOptions[];
-    body?: false | ParseOptions | ParseOptions[];
-    result?: ParseOptions | ParseOptions[];
+    params?: boolean | ParseOptions | ParseOptions[] | string;
+    query?: boolean | ParseOptions | ParseOptions[] | string;
+    body?: boolean | ParseOptions | ParseOptions[] | string;
+    response?: ParseOptions | ParseOptions[] | string;
     featureName: string;
 }[];

package/dist/utils/doc/index.js

@@ -8,8 +8,17 @@ 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 { 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,

package/dist/utils/index.js

@@ -78,6 +78,7 @@ const mainCMD = (cmds, usage, logger, cmdArg = process.argv[2], exit = true) =>
                 }
                 logger.info(`\t${cmd}\t${cmds[cmd].description}`);
             }
+            logger.info("");
             if (exit) {
                 process.exit(1);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miqro",
-  "version": "1.7.4",
+  "version": "1.7.8",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,16 +17,17 @@
   "author": "claukers",
   "license": "ISC",
   "dependencies": {
-    "@miqro/core": "^1.5.2",
-    "@miqro/runner": "^1.2.2",
-    "@miqro/test": "^0.0.6",
+    "@miqro/core": "^1.5.4",
+    "@miqro/parser": "^0.0.2",
+    "@miqro/runner": "^1.2.4",
+    "@miqro/test": "^0.0.9",
     "deep-diff": "1.0.2"
   },
   "devDependencies": {
     "@types/cookie": "^0.4.1",
     "@types/deep-diff": "1.0.1",
     "@types/node": "^16.7.10",
-    "typescript": "^4.4.4"
+    "typescript": "^4.5.4"
   },
   "engines": {
     "node": ">=14.0.0",

package/dist/cmds/test.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.main = void 0;
-const utils_1 = require("../utils");
-const test_1 = require("@miqro/test");
-const core_1 = require("@miqro/core");
-const main = () => {
-    if (process.argv.length <= 3) {
-        throw new Error(`invalid number of args\nusage: npx miqro test <test/*.test.js> [...args]`);
-    }
-    (0, core_1.loadConfig)();
-    //execSync(`npx @miqro/test ${process.argv.slice(3).join(" ")}`);
-    (0, utils_1.execSync)(`${process.argv[0]} ${(0, test_1.mainPath)()} ${process.argv.slice(3).join(" ")}`);
-};
-exports.main = main;