miqro 1.5.5 → 1.6.1

package/src/cmds/doc-md.ts

@@ -0,0 +1,233 @@
+import { ConfigPathResolver, getLogger, GroupPolicy, loadConfig, Method, ParseOption, ParseOptionMap } from "@miqro/core";
+import { resolve } from "path";
+import { writeFileSync } from "fs";
+
+import { getDOCJSON } from "../utils/doc";
+
+export const main = (): void => {
+
+  if (process.argv.length !== 6) {
+    throw new Error(`arguments: <api_folder> <subPath> <out.md>`);
+  }
+
+  const dirname = process.argv[3];
+  const subPath = process.argv[4];
+  const outPath = process.argv[5];
+
+  loadConfig();
+
+  const parseOptionMap2ParseOptionList = (map: ParseOptionMap): ParseOption[] => {
+    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 = getDOCJSON({ dirname, subPath }, getLogger("miqro"));
+
+  const policyTable = (policy: GroupPolicy | undefined | false): string => {
+    if (policy) {
+      return `|policy|groups|\n|----|----|\n|${policy.groupPolicy}|${policy.groups.join(", ")}|`;
+    } else {
+      return "```no policy provided!!```";
+    }
+
+  };
+
+  const methodUrlTable = (options?: { path?: string | string[]; method?: Method | Method[] }): string => {
+    if (options && options.path) {
+      const rows: string[] = [];
+      const paths = (options.path as any) 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: ParseOption, t: string): string => {
+    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: { options: ParseOption[] | ParseOptionMap; } | false | undefined, subName = "", tableHeaders = 0): string => {
+    if (options) {
+      let padding = "";
+      for (let i = 0; i < tableHeaders; i++) {
+        padding += "| ";
+      }
+      const hl = "|----|----|----|----|----|----|----|----|----|----|";
+      const list: ParseOption[] = 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 "not defined";
+    }
+  };
+
+  const FAKE_TAB = "    ";
+  const FAKE_DOUBLE_TAB = `${FAKE_TAB}${FAKE_TAB}`;
+
+  const featureIndex = `## Features\n\n${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")}`;
+
+  writeFileSync(resolve(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 = parseOptionTable(q);
+      // let paramsTable = parseOptionTable(doc.params);
+      if (paramTable.split("\n").length > 1) {
+        paramTable = `#### params${q && q.description ? ` (${q.description})` : ""}\n\n${paramTable}`;
+      } else {
+        paramTable = paramTable === "" ? "" : `#### params${q && q.description ? ` (${q.description})` : ""}: ${paramTable}`;
+      }
+      paramsTable.push(paramTable);
+    }
+
+    const query = doc.query instanceof Array ? doc.query : [doc.query];
+    const queryTables = [];
+    for (const q of query) {
+      let queryTable = parseOptionTable(q);
+      // let paramsTable = parseOptionTable(doc.params);
+      if (queryTable.split("\n").length > 1) {
+        queryTable = `#### query${q && q.description ? ` (${q.description})` : ""}\n\n${queryTable}`;
+      } else {
+        queryTable = queryTable === "" ? "" : `#### query${q && q.description ? ` (${q.description})` : ""}: ${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 = parseOptionTable(b);
+
+      if (bodyTable.split("\n").length > 1) {
+        bodyTable = `#### body${b && b.description ? ` (${b.description})` : ""}\n\n${bodyTable}`;
+      } else {
+        bodyTable = bodyTable === "" ? "" : `#### body${b && b.description ? ` (${b.description})` : ""}: ${bodyTable}`;
+      }
+      bodyTables.push(bodyTable);
+    }
+
+    const results = doc.result instanceof Array ? doc.result : [doc.result];
+    const resultTables = [];
+    for (const r of results) {
+      if (!r) {
+        continue;
+      }
+      let resultsTable = doc.result ? parseOptionTable(r) : "";
+      if (resultsTable.split("\n").length > 1) {
+        resultsTable = `#### response.data${r.description ? ` (${r.description})` : ""}\n\n${resultsTable}`;
+      } else {
+        resultsTable = resultsTable === "" ? "" : `#### response.data${r.description ? ` (${r.description})` : ""}: ${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"));
+
+}

package/src/cmds/handler-apiroute-new.ts

@@ -0,0 +1,67 @@
+import { ConfigPathResolver, loadConfig } from "@miqro/core";
+import { mkdirSync, writeFileSync, existsSync } from "fs";
+import { resolve } from "path";
+
+const templates = {
+  ts: (path: string) =>
+    `import { APIRoute, Context } from "@miqro/core";
+
+const route: APIRoute = {
+  path: "${path}",
+  method: "POST",
+  handler: async (ctx: Context) => {
+    return {
+      text: \`Hello \${ctx.body.name}!\`
+    }
+  }
+};
+
+export default route;
+`,
+  js: (path: string) =>
+    `module.exports = {
+  path: "${path}",
+  method: "POST",
+  handler: async (ctx) => {
+    return {
+      text: \`Hello \${ctx.body.name}!\`
+    }
+  }
+};
+`
+}
+
+export const main = (): void => {
+
+  if (process.argv.length !== 4 || process.argv[3].length < 1) {
+    throw new Error(`arguments: <identifier ex: SRC_API_V1_HEALTH>`);
+  }
+
+  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: SRC_API_V1_HEALTH>`);
+  }
+
+  loadConfig();
+
+  const path = resolve(ConfigPathResolver.getBaseDirname(), ...split.splice(0, split.length - 1));
+
+  const ext = existsSync(resolve(ConfigPathResolver.getBaseDirname(), "tsconfig.json")) ? "ts" : "js";
+
+  const filePath = resolve(path, `${split[0]}.${ext}`);
+  if (existsSync(filePath)) {
+    throw new Error(`file ${filePath} already exists! doing nothing`);
+  }
+
+  console.log(`creating ${filePath}`);
+
+  mkdirSync(path, {
+    recursive: true
+  });
+
+  writeFileSync(filePath, templates[ext](`/${split[0]}`));
+}

package/src/cmds/handler-main-new.ts

@@ -0,0 +1,85 @@
+import { ConfigPathResolver, loadConfig } from "@miqro/core";
+import { mkdirSync, writeFileSync, existsSync } from "fs";
+import { resolve } from "path";
+
+const mainTemplates = {
+  ts: () =>
+    `import { APIRouter, App, checkEnvVariables, getLogger, middleware } from "@miqro/core";
+import { resolve } from "path";
+
+/*
+To be start as a main file
+node file.js
+*/
+
+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, () => {
+  logger.info("listening on " + PORT);
+});
+`,
+  js: () =>
+    `const { APIRouter, App, checkEnvVariables, getLogger, middleware } = require("@miqro/core");
+const { resolve } = require("path");
+
+/*
+To be start as a main file
+node file.js
+*/
+
+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, () => {
+  logger.info("listening on " + PORT);
+});
+`
+}
+
+export const main = (): void => {
+
+  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: SRC_MAIN>`);
+  }
+
+  loadConfig();
+
+  const path = resolve(ConfigPathResolver.getBaseDirname(), ...split.splice(0, split.length - 1));
+
+  const ext = existsSync(resolve(ConfigPathResolver.getBaseDirname(), "tsconfig.json")) ? "ts" : "js";
+
+  const filePath = resolve(path, `${split[0]}.${ext}`);
+  if (existsSync(filePath)) {
+    throw new Error(`file ${filePath} already exists! doing nothing`);
+  }
+
+  console.log(`creating ${filePath}`);
+
+  mkdirSync(path, {
+    recursive: true
+  });
+
+  writeFileSync(filePath, mainTemplates[ext]());
+}

package/src/cmds/new.ts

@@ -0,0 +1,128 @@
+import { mkdirSync, writeFileSync, existsSync } from "fs";
+import { resolve } from "path";
+import { execSync } from "../utils";
+
+const packageTemplate = {
+  ts: (name: string) =>
+    `{
+  "name": "${name}",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "main": "dist/main.js",
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/main.js"
+  },
+  "devDependencies": {
+  },
+  "dependencies": {
+  },
+  "author": "",
+  "license": "ISC"
+}`,
+  js: (name: string) =>
+    `{
+  "name": "${name}",
+  "version": "1.0.0",
+  "description": "",
+  "private": true,
+  "main": "src/main.js",
+  "scripts": {
+    "start": "node src/main.js"
+  },
+  "devDependencies": {
+  },
+  "dependencies": {
+  },
+  "author": "",
+  "license": "ISC"
+}`
+}
+
+export const mainJS = (typescript = false): void => {
+  if (process.argv.length !== 4 || process.argv[3].length < 1) {
+    throw new Error(`arguments: <name ex: NEW_APP>`);
+  }
+
+  const identifier = process.argv[3].toLocaleLowerCase();
+
+  const appFolder = resolve(process.cwd(), identifier);
+
+  if (existsSync(appFolder)) {
+    throw new Error(`${appFolder} already exists!`);
+  }
+
+  console.log(`creating ${appFolder}`);
+
+  mkdirSync(appFolder, {
+    recursive: true
+  });
+
+  writeFileSync(resolve(appFolder, "package.json"), packageTemplate[typescript ? "ts" : "js"](identifier));
+
+  execSync(
+    `npm install miqro --save-dev`,
+    {
+      cwd: appFolder
+    }
+  );
+
+  execSync(
+    `npm install @miqro/core --save`,
+    {
+      cwd: appFolder
+    }
+  );
+
+  if (typescript) {
+    writeFileSync(resolve(appFolder, "tsconfig.json"), `{
+  "compileOnSave": true,
+  "compilerOptions": {
+    "strict": false,
+    "outDir": "./dist/",
+    "removeComments": true,
+    "noImplicitAny": false,
+    "preserveConstEnums": true,
+    "sourceMap": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "target": "es2017",
+    "lib": [
+      "es2017"
+    ]
+  },
+  "exclude": [
+    "node_modules",
+    "test"
+  ],
+  "include": [
+    "src"
+  ]
+}`);
+    execSync(`npm install typescript --save-dev`, {
+      cwd: appFolder
+    });
+    execSync(`npm install @types/node --save-dev`, {
+      cwd: appFolder
+    });
+  }
+
+  execSync(
+    `npx miqro new:main src_main`,
+    {
+      cwd: appFolder
+    }
+  );
+
+  execSync(
+    `npx miqro new:route src_api_health`,
+    {
+      cwd: appFolder
+    }
+  );
+}
+
+export const mainTS = (): void => mainJS(true);

package/src/cmds/start.ts

@@ -0,0 +1,16 @@
+import { execSync } from "../utils";
+import { mainPath } from "@miqro/runner";
+import { loadConfig } from "@miqro/core";
+
+export const main = (): void => {
+
+  if (process.argv.length <= 3) {
+    throw new Error(`invalid number of args\nusage: CLUSTER_COUNT=1 [DISABLE_RESTART=true|false] npx miqro start <script> [...args]`);
+  }
+
+  loadConfig();
+
+  //execSync(`npx @miqro/runner ${process.argv.slice(3).join(" ")}`);
+  execSync(`${process.argv[0]} ${mainPath()} ${process.argv.slice(3).join(" ")}`)
+}
+

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "@miqro/core";
+export * from "@miqro/runner";