miqro 2.0.2 → 3.0.0

package/README.md

@@ -7,43 +7,25 @@ npm install miqro --save-dev
 to see available cmds
 
 ```
-npx miqro
+npx miqro help
 ```
 
 ```
-Available commands:
-
-
-==api development==
-
-new:api				    create a new project.
-new:api:main		    creates a new main file.
-new:api:route		    creates a new route.
-config				    print config as a json.
-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.
-
-==start helpers==
-
-start				    start script in cluster mode.
-watch				    watch folder for changes.
-serve			    	serve static files.
-
-==testing==
-
-test		    		run test files.
-new:test    			create new test.js file.
-
-==sequelize helpers==
-
-db:console			    a query console for sequelize.
-db:dump:data			dump the data of the database.
-db:push:data			push a dump to the database.
-db:make:migration		generate migrations from model changes.
-db:migration:forceclean	force 'local' model state.
-db:migrate			    loads config and run migrations.
-db:init				    init sequelize configuration.
-db:create:model			creates an example model.
+npx miqro <command> [args]Available commands:
+
+new:api				create a new project.
+new:api:main			creates a new main file.
+new:api:route			creates a new route.
+new:api:route:test		create new test.js file for an apirouter.
+config				print config as a json.
+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				start script in cluster mode.
+cluster				alias for start command.
+watch				watch folder for changes.
+serve				serve static files.
+help				prints this page
 ```

package/build/cli.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cmd_map_1 = require("./cmd-map");
+const utils_1 = require("./utils");
+(0, utils_1.mainCMD)(cmd_map_1.CMDS, cmd_map_1.usage, console);

package/build/cmd-map.d.ts

@@ -0,0 +1,79 @@
+import { main as help } from "./cmds/help";
+export declare const usage = "npx miqro <command> [args]";
+export declare const CMDS: {
+    "new:api": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "new:api:main": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "new:api:route": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "new:api:route:test": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    config: {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "config:bash": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "config:env": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    "config:init": {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    doc: {
+        tabs: number;
+        cb: () => Promise<void>;
+        description: string;
+    };
+    "doc:md": {
+        cb: () => Promise<void>;
+        tabs: number;
+        description: string;
+    };
+    start: {
+        tabs: number;
+        cb: () => void;
+        description: string;
+    };
+    cluster: {
+        tabs: number;
+        cb: () => void;
+        description: string;
+    };
+    watch: {
+        cb: () => void;
+        tabs: number;
+        description: string;
+    };
+    serve: {
+        tabs: number;
+        cb: () => Promise<void>;
+        description: string;
+    };
+    help: {
+        cb: typeof help;
+        tabs: number;
+        description: string;
+    };
+};

package/{dist/cli.js → build/cmd-map.js}

@@ -1,13 +1,11 @@
-#!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("./utils");
+exports.CMDS = exports.usage = void 0;
 const start_1 = require("./cmds/start");
-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");
-//import {main as apiDocMD} from "./cmds/doc-md.ts.disable";
+const doc_md_1 = require("./cmds/doc-md");
 const config_init_1 = require("./cmds/config-init");
 const config_1 = require("./cmds/config");
 const config_bash_1 = require("./cmds/config-bash");
@@ -15,18 +13,14 @@ 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 help_1 = require("./cmds/help");
 const handler_main_new_1 = require("./cmds/handler-main-new");
-const db_init_1 = require("./cmds/db-init");
-const db_makemigrations_1 = require("./cmds/db-makemigrations");
-const db_sync_makemigrations_1 = require("./cmds/db-sync-makemigrations");
-const db_console_1 = require("./cmds/db-console");
-const db_createmodel_1 = require("./cmds/db-createmodel");
-const db_push_data_1 = require("./cmds/db-push-data");
-const db_dump_data_1 = require("./cmds/db-dump-data");
-const db_migrate_1 = require("./cmds/db-migrate");
-// noinspection SpellCheckingInspection
-(0, utils_1.mainCMD)({
-    ["new:api"]: { section: "api development", cb: new_1.mainTS, tabs: 4, description: `create a new project.` },
+exports.usage = "npx miqro <command> [args]";
+exports.CMDS = {
+    ["new:api"]: {
+        //section: "api development", 
+        cb: new_1.mainTS, tabs: 4, description: `create a new project.`
+    },
     //["new:typescript"]: {cb: newTS, tabs: 4, description: `create a new typescript project.`},
     ["new:api:main"]: {
         //section: "http scafolding",
@@ -35,6 +29,7 @@ const db_migrate_1 = require("./cmds/db-migrate");
         description: `creates a new main file.`
     },
     ["new:api:route"]: { cb: handler_apiroute_new_1.main, tabs: 3, description: `creates a new route.` },
+    ["new:api:route:test"]: { cb: new_test_1.main, tabs: 2, description: `create new test.js file for an apirouter.` },
     ["config"]: {
         //section: "config managment",
         cb: config_1.main,
@@ -58,11 +53,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: apiDocMD,
-      tabs: 4,
-      description: `api folder auto doc as a markdown.`
-    },*/
+    ["doc:md"]: {
+        cb: doc_md_1.main,
+        tabs: 4,
+        description: `api folder auto doc as a markdown.`
+    },
     /*["new:front"]: {
       section: "front end development",
       cb: newTSFront,
@@ -70,7 +65,7 @@ const db_migrate_1 = require("./cmds/db-migrate");
       description: `create a new web-components project.`
     },*/
     ["start"]: {
-        section: "start helpers",
+        //section: "start helpers",
         tabs: 4,
         cb: start_1.main,
         description: `start script in cluster mode.`
@@ -91,31 +86,9 @@ const db_migrate_1 = require("./cmds/db-migrate");
         tabs: 4,
         cb: serve_1.main, description: `serve static files.`
     },
-    ["test"]: { section: "testing", cb: test_1.main, tabs: 4, description: `run test files.` },
-    ["new:test"]: { cb: new_test_1.main, tabs: 3, description: `create new test.js file.` },
-    ["db:console"]: {
-        section: "sequelize helpers",
-        cb: db_console_1.main,
-        tabs: 3,
-        description: `a query console for sequelize.`
-    },
-    ["db:dump:data"]: {
-        cb: db_dump_data_1.main,
-        tabs: 3,
-        description: `dump the data of the database.`
-    },
-    ["db:push:data"]: { cb: db_push_data_1.main, tabs: 3, description: `push a dump to the database.` },
-    ["db:make:migration"]: {
-        cb: db_makemigrations_1.main,
-        tabs: 2,
-        description: `generate migrations from model changes.`
-    },
-    ["db:migration:forceclean"]: {
-        cb: db_sync_makemigrations_1.main,
-        tabs: 2,
-        description: `force 'local' model state.`
-    },
-    ["db:migrate"]: { cb: db_migrate_1.main, tabs: 3, description: `loads config and run migrations.` },
-    ["db:init"]: { cb: db_init_1.main, tabs: 4, description: `init sequelize configuration.` },
-    ["db:create:model"]: { cb: db_createmodel_1.main, tabs: 3, description: `creates an example model.` }
-}, "npx miqro <command> [args]", console);
+    ["help"]: {
+        //section: "help",
+        cb: help_1.main,
+        tabs: 4, description: "prints this page"
+    }
+};

package/{dist → build}/cmds/doc-json.d.ts

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

package/{dist → build}/cmds/doc-json.js

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

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

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

package/build/cmds/doc-md.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = exports.usage = void 0;
+const core_1 = require("@miqro/core");
+const md_1 = require("../utils/doc/md");
+exports.usage = `usage: [NODE_ENV=development] npx miqro doc <api_folder> <subPath> [apiName]`;
+const main = async () => {
+    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(await (0, md_1.getMDDoc)({ dirname, subPath, apiName }));
+};
+exports.main = main;

package/{dist → build}/cmds/handler-main-new.js

@@ -5,7 +5,7 @@ const core_1 = require("@miqro/core");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const mainTemplates = {
-    ts: () => `import { APIRouter, App, checkEnvVariables, getLogger, middleware } from "@miqro/core";
+    ts: () => `import { APIRouter, Server, checkEnvVariables, getLogger, middleware } from "@miqro/core";
 import { resolve } from "path";
 
 /*
@@ -17,14 +17,17 @@ const [PORT] = checkEnvVariables(["PORT"], ["8080"]);
 
 const logger = getLogger("server");
 
-const app = new App();
-app.use(middleware());
-app.use(APIRouter({
-  dirname: resolve(__dirname, "api")
-}, logger));
-app.listen(PORT, () => {
+async function main() {
+  const app = new Server();
+  app.use(middleware());
+  app.use(await APIRouter({
+    dirname: resolve("./build/api")
+  }, logger));
+  await app.listen();
   logger.info("listening on " + PORT);
-});
+}
+
+main().catch(e => logger.error(e));
 `,
     js: () => `const { APIRouter, App, checkEnvVariables, getLogger, middleware } = require("@miqro/core");
 const { resolve } = require("path");
@@ -38,14 +41,17 @@ const [PORT] = checkEnvVariables(["PORT"], ["8080"]);
 
 const logger = getLogger("server");
 
-const app = new App();
-app.use(middleware());
-app.use(APIRouter({
-  dirname: resolve(__dirname, "api")
-}, logger));
-app.listen(PORT, () => {
+async function main() {
+  const app = new App();
+  app.use(middleware());
+  app.use(await APIRouter({
+    dirname: resolve(__dirname, "api")
+  }, logger));
+  await app.listen();
   logger.info("listening on " + PORT);
-});
+}
+
+main().catch(e => logger.error(e));
 `
 };
 exports.usage = `usage: [NODE_ENV=development] npx miqro new:api:main <identifier ex: NEW_APP>`;

package/build/cmds/help.d.ts

@@ -0,0 +1 @@
+export declare function main(): void;

package/build/cmds/help.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const cmd_map_1 = require("../cmd-map");
+const utils_1 = require("../utils");
+function main() {
+    console.log((0, utils_1.getUsage)(cmd_map_1.CMDS, cmd_map_1.usage));
+}
+exports.main = main;

package/{dist → build}/cmds/new-test.js

@@ -6,9 +6,20 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 exports.usage = `usage: [NODE_ENV=development] npx miqro new:test <identifier ex: TEST_SOMEFILE>`;
 const testTemplates = {
-    js: (category) => `it("happy path", async () => {
+    js: (category) => `import { it } from "node:test";
+import { TestHelper } from "@miqro/test-http";
+import { Server, APIRouter } from "@miqro/core";
+import { resolve } from "path";
+import { strictEqual } from "assert";
 
-})
+it("happy path health", async () => {
+  const response = await TestHelper(new Server().use(await APIRouter({
+    dirname: resolve("./build/api")
+  })), {
+    url: "/api/health"
+  });
+  strictEqual(response.status, 200);
+});
 `
 };
 const main = () => {

package/{dist → build}/cmds/new.js

@@ -13,41 +13,43 @@ dist/
 const packageTemplate = {
     ts: (name) => `{
   "name": "${name}",
+  "type": "module",
   "version": "1.0.0",
   "description": "",
   "private": true,
-  "main": "dist/main.js",
   "scripts": {
-    "prebuild": "rm -Rf dist/;",
+    "prebuild": "rm -Rf build/;",
     "build": "tsc",
     "prestart": "npm run build",
-    "start": "node dist/main.js",
+    "start": "node --enable-source-maps build/main.js",
+    "cluster": "NODE_OPTIONS=--enable-source-maps miqro cluster build/main.js",
     "pretest": "npm run build",
-    "test": "miqro-test -r test/ -n"
+    "test": "node --enable-source-maps --test test/",
+    "coverage": "node --enable-source-maps --experimental-test-coverage --test test/"
   },
   "devDependencies": {
   },
   "dependencies": {
   },
-  "author": "",
-  "license": "ISC"
+  "author": ""
 }`,
     js: (name) => `{
   "name": "${name}",
+  "type": "module",
   "version": "1.0.0",
   "description": "",
   "private": true,
-  "main": "src/main.js",
   "scripts": {
     "start": "node src/main.js",
-    "test": "miqro-test -r test/ -n"
+    "cluster": "miqro cluster src/main.js",
+    "test": "node --test test/",
+    "coverage": "node --experimental-test-coverage --test test/"
   },
   "devDependencies": {
   },
   "dependencies": {
   },
-  "author": "",
-  "license": "ISC"
+  "author": ""
 }`
 };
 exports.usageTS = `usage: npx miqro new:api <identifier ex: NEW_APP>`;
@@ -75,11 +77,11 @@ const mainTS = () => {
   "compileOnSave": true,
   "compilerOptions": {
     "lib": ["es2021"],
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "module": "es2022",
+    "moduleResolution": "Node16",
     "target": "es2021",
     "strict": false,
-    "outDir": "./dist/",
+    "outDir": "./build/",
     "removeComments": true,
     "noImplicitAny": false,
     "preserveConstEnums": true,
@@ -102,7 +104,7 @@ const mainTS = () => {
         cwd: appFolder
     });
     (0, fs_1.writeFileSync)((0, path_1.resolve)(appFolder, ".gitignore"), gitignoreTemplate.ts());
-    (0, utils_1.execSync)(`npm install @miqro/test --save-dev`, {
+    (0, utils_1.execSync)(`npm install @miqro/test-http --save-dev`, {
         cwd: appFolder
     });
     (0, utils_1.execSync)(`npx miqro new:api:main src_main`, {
@@ -114,11 +116,14 @@ const mainTS = () => {
     (0, fs_1.mkdirSync)((0, path_1.resolve)(appFolder, "test"), {
         recursive: true
     });
-    (0, utils_1.execSync)(`npx miqro new:test test_api_health`, {
+    (0, utils_1.execSync)(`npx miqro new:api:route:test test_api_health`, {
         cwd: appFolder
     });
+    console.log("");
+    console.log("");
     console.log(`new project created on ${appFolder}`);
     console.log(`cd ${identifier}`);
     console.log(`npm run start`);
+    console.log("");
 };
 exports.mainTS = mainTS;

package/{dist → build}/cmds/serve.d.ts

@@ -1,2 +1,2 @@
 export declare const usage = "usage: [NODE_ENV=development] npx miqro serve [directory=./] [path=/] [--index404 ./index.html] [--proxy-cert-ignore] [--port 8080] [--proxy /api=https://host/api]";
-export declare const main: () => void;
+export declare const main: () => Promise<void>;

package/{dist → build}/cmds/serve.js

@@ -4,12 +4,14 @@ exports.main = exports.usage = void 0;
 const core_1 = require("@miqro/core");
 const utils_1 = require("../utils");
 const url_1 = require("url");
-const tokenize_match_1 = require("@miqro/core/dist/common/tokenize-match");
 const fs_1 = require("fs");
 exports.usage = `usage: [NODE_ENV=development] npx miqro serve [directory=./] [path=/] [--index404 ./index.html] [--proxy-cert-ignore] [--port 8080] [--proxy /api=https://host/api]`;
-const main = () => {
+const main = async () => {
     const flags = (0, utils_1.extractFlags)(process.argv.slice(3), {
         flags: {
+            "help": {
+                description: "get help page", hasValue: false
+            },
             "index404Status": {
                 description: "status to handle index404 status", hasValue: true
             },
@@ -24,6 +26,10 @@ const main = () => {
             }
         }
     });
+    if (flags.flags.help !== undefined) {
+        console.log(exports.usage);
+        process.exit(102);
+    }
     if (flags.files.length > 2) {
         throw new Error(`invalid arguments.\n${exports.usage}`);
     }
@@ -53,9 +59,9 @@ const main = () => {
             if (proxySplit.length !== 2) {
                 throw new Error("proxy must be in the form. /path=proxy");
             }
-            const proxyPath = (0, tokenize_match_1.normalizePath)(proxySplit[0]);
+            const proxyPath = (0, core_1.normalizePath)(proxySplit[0]);
             const proxyURL = new url_1.URL(proxySplit[1]);
-            proxyURL.pathname = (0, tokenize_match_1.normalizePath)(proxyURL.pathname);
+            proxyURL.pathname = (0, core_1.normalizePath)(proxyURL.pathname);
             const proxyRouter = (0, core_1.Proxy)({
                 url: proxyURL.toString(), rejectUnauthorized: flags.flags["proxy-cert-ignore"] ? true : false
             });
@@ -70,8 +76,7 @@ const main = () => {
         index404: flags.flags.index404 ? flags.flags.index404 : undefined,
         index404Status: flags.flags.index404Status ? parseInt(flags.flags.index404Status, 10) : undefined
     }), path);
-    app.listen(PORT, () => {
-        console.log("serving " + directory + " on http://localhost:%s%s", PORT, path);
-    });
+    await app.listen(PORT);
+    console.log("serving " + directory + " on http://localhost:%s%s", PORT, path);
 };
 exports.main = main;

package/build/utils/doc/json.d.ts

@@ -0,0 +1,6 @@
+import { RouterJSONDoc, Logger } from "@miqro/core";
+export declare const getDOCJSON: ({ dirname, subPath, apiName }: {
+    apiName?: string | undefined;
+    dirname: string;
+    subPath: string;
+}, logger?: Logger) => Promise<RouterJSONDoc>;

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

@@ -3,10 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDOCJSON = void 0;
 const core_1 = require("@miqro/core");
 const path_1 = require("path");
-const getDOCJSON = ({ dirname, subPath, apiName }, logger) => {
+const getDOCJSON = async ({ 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)({
+    const router = await (0, core_1.APIRouter)({
         apiName,
         dirname: (0, path_1.resolve)(core_1.ConfigPathResolver.getBaseDirname(), dirname),
         path: subPath

package/build/utils/doc/md.d.ts

@@ -0,0 +1,18 @@
+import { Logger } from "@miqro/core";
+import { ParserArgs, ParserMode } from "@miqro/parser";
+export declare function getMDDoc(args: {
+    showFilePath?: boolean;
+    apiName?: string;
+    dirname: string;
+    subPath: string;
+}, logger?: Logger): Promise<string>;
+export declare function parserToString(parser: {
+    headers?: ParserArgs | ParserArgs[];
+    headersMode?: ParserMode;
+    query?: ParserArgs | boolean | ParserArgs[];
+    queryMode?: ParserMode;
+    params?: ParserArgs | boolean | ParserArgs[];
+    paramsMode?: ParserMode;
+    body?: ParserArgs | boolean | ParserArgs[];
+    bodyMode?: ParserMode;
+}): string;