miqro 5.0.3 → 5.0.4

package/build/cmd-map.d.ts

@@ -1,4 +1,4 @@
-export declare const usage = "npx miqro <command> [args]";
+export declare const usage = "npx miqro <command> [args]\n";
 export declare const CMD_MAP: {
     "new:api": {
         cb: () => void;
@@ -70,6 +70,16 @@ export declare const CMD_MAP: {
         cb: () => Promise<void>;
         description: string;
     };
+    "migration:up": {
+        tabs: number;
+        description: string;
+        cb: () => Promise<void>;
+    };
+    "migration:down": {
+        tabs: number;
+        description: string;
+        cb: () => Promise<void>;
+    };
     help: {
         cb: () => void;
         tabs: number;

package/build/cmd-map.js

@@ -1,13 +1,14 @@
 import { resolve } from "path";
-import { existsSync, mkdirSync, statSync, writeFileSync } from "fs";
+import { existsSync, lstatSync, mkdirSync, statSync, writeFileSync } from "fs";
 import { apiRouteTemplate, gitignoreTemplate, mainTemplates, packageTemplate, templates, testTemplates } from "./utils/templates.js";
-import { App, ConfigPathResolver, LoggerHandler, Proxy, ReadBuffer, Static, loadConfig, normalizePath } from "@miqro/core";
+import { App, ConfigPathResolver, LoggerHandler, Proxy, ReadBuffer, Static, getLogger, loadConfig, normalizePath } from "@miqro/core";
 import { getDOCJSON } from "./utils/doc/json.js";
 import { getMDDoc } from "./utils/doc/md.js";
 import { mainPath } from "@miqro/runner";
 import { setupWatch } from "./utils/watch.js";
 import { extractFlags, getUsage, execSync } from "./utils/exec.js";
-export const usage = "npx miqro <command> [args]";
+import { migration } from "@miqro/query";
+export const usage = "npx miqro <command> [args]\n";
 export const CMD_MAP = {
     ["new:api"]: {
         //section: "api development", 
@@ -380,6 +381,68 @@ export const CMD_MAP = {
             console.log("serving " + directory + " on http://localhost:%s%s", PORT, path);
         }, description: `serve static files.`
     },
+    ["migration:up"]: {
+        tabs: 3,
+        description: "'up' on migrations in order.",
+        cb: async () => {
+            const usageMessage = (message) => `${message ? `${message}.\n` : ""}usage: npx miqro migration:up <db.js> <migrations-folder|migration-file>`;
+            if (process.argv.length < 5) {
+                throw new Error(usageMessage("invalid number of args"));
+            }
+            const dbJSPath = resolve(process.cwd(), process.argv[3]);
+            const migrationFolder = resolve(process.cwd(), process.argv[4]);
+            if (!existsSync(migrationFolder)) {
+                throw new Error(usageMessage(`invalid args. [${migrationFolder}] doesnt exists!`));
+            }
+            if (lstatSync(migrationFolder).isSymbolicLink()) {
+                throw new Error(usageMessage(`invalid args. [${migrationFolder}] simbolic links not supported.`));
+            }
+            if (!lstatSync(migrationFolder).isDirectory()) {
+                const db = (await import(dbJSPath)).default;
+                await db.connect();
+                await migration.init(db, getLogger("migrationUp"));
+                await migration.up.file(db, migrationFolder, getLogger("migrationUp"));
+                await db.disconnect();
+            }
+            else {
+                const db = (await import(dbJSPath)).default;
+                await db.connect();
+                await migration.up.folder(db, migrationFolder, getLogger("migrationUp"));
+                await db.disconnect();
+            }
+        }
+    },
+    ["migration:down"]: {
+        tabs: 3,
+        description: "'down' on migrations in reverse.",
+        cb: async () => {
+            const usageMessage = (message) => `${message ? `${message}.\n` : ""}usage: npx miqro migration:down <db.js> <migrations-folder|migration-file>`;
+            if (process.argv.length < 5) {
+                throw new Error(usageMessage("invalid number of args"));
+            }
+            const dbJSPath = resolve(process.cwd(), process.argv[3]);
+            const migrationFolder = resolve(process.cwd(), process.argv[4]);
+            if (!existsSync(migrationFolder)) {
+                throw new Error(usageMessage(`invalid args. [${migrationFolder}] doesnt exists!`));
+            }
+            if (lstatSync(migrationFolder).isSymbolicLink()) {
+                throw new Error(usageMessage(`invalid args. [${migrationFolder}] simbolic links not supported.`));
+            }
+            if (!lstatSync(migrationFolder).isDirectory()) {
+                const db = (await import(dbJSPath)).default;
+                await db.connect();
+                await migration.init(db, getLogger("migrationDown"));
+                await migration.down.file(db, migrationFolder, getLogger("migrationDown"));
+                await db.disconnect();
+            }
+            else {
+                const db = (await import(dbJSPath)).default;
+                await db.connect();
+                await migration.down.folder(db, migrationFolder, getLogger("migrationDown"));
+                await db.disconnect();
+            }
+        }
+    },
     ["help"]: {
         //section: "help",
         cb: () => {

package/build/utils/doc/md.js

@@ -8,36 +8,47 @@ export async function getMDDoc(args, logger) {
     const jsonDOC = await getDOCJSON(args, logger);
     const pathList = Object.keys(jsonDOC);
     let outMD = "";
+    const tableIndexItems = [];
     for (const path of pathList) {
         const pathData = jsonDOC[path];
         const methods = Object.keys(pathData);
         for (const method of methods) {
-            const apiDataList = pathData[method];
-            for (const apiData of apiDataList) {
-                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 && typeof apiData.response !== "boolean") {
-                    const responseOutMD = parserToString(apiData.response);
-                    outMD += responseOutMD !== "" ? `### response\n\n${responseOutMD}` : "";
+            if (method) {
+                const apiDataList = pathData[method];
+                for (const apiData of apiDataList) {
+                    tableIndexItems.push({
+                        apiData
+                    });
+                    outMD += `## ${apiData.identifier}\n\n`;
+                    outMD += `${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 && typeof apiData.response !== "boolean") {
+                        const responseOutMD = parserToString(apiData.response);
+                        outMD += responseOutMD !== "" ? `### response\n\n${responseOutMD}` : "";
+                    }
                 }
             }
         }
     }
-    return outMD;
+    const indexTable = getIndexTable(tableIndexItems);
+    return `${indexTable}\n\n# endoints\n\n${outMD}`;
+}
+function getIndexTable(data) {
+    return `# endpoint list\n\n${data.map(api => `[${api.apiData.identifier}](#${api.apiData.identifier.toLocaleLowerCase()})${api.apiData.name || api.apiData.description ? `\n\n\t${api.apiData.name ? api.apiData.name + " " : ""}${api.apiData.description ? api.apiData.description : ""}` : ""}`).join("\n\n")}`;
 }
 function policyToString(policy) {
     let outMD = "| groups | policy |\n";
@@ -80,7 +91,7 @@ function parserPartToString(arg, mode) {
         if (ret.maxTabulation > maxTabulation) {
             maxTabulation = ret.maxTabulation;
         }
-        outMD += `| name | type | description | ${getTabulation(ret.maxTabulation * 2)}\n`;
+        outMD += `| | | | ${getTabulation(ret.maxTabulation * 2)}\n`;
         outMD += `|--------|-------|-------|${getTabulation(ret.maxTabulation * 2, true)}\n`;
         outMD += `${ret.out}\n\n`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miqro",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -19,8 +19,9 @@
   "author": "claukers",
   "license": "ISC",
   "dependencies": {
-    "@miqro/core": "^5.0.10",
-    "@miqro/parser": "^2.0.3",
+    "@miqro/core": "^5.0.11",
+    "@miqro/query": "^0.0.1",
+    "@miqro/parser": "^2.0.4",
     "@miqro/runner": "^2.0.1"
   },
   "devDependencies": {