@keshavsoft/kschema-api-gen-actions 1.14.3 → 1.16.2

package/README.md

@@ -301,6 +301,8 @@ bin/
 
 ---
 
+this is config driven
+
 # Contributing
 
 Pull requests are welcome.
@@ -317,4 +319,5 @@ MIT
 
 # Author
 
-Created by KeshavSoft.
+Created by KeshavSoft.
+

package/bin/cli.js

@@ -1,4 +1,4 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 import getLatestVersion from "./core/getLatestVersion.js";
 import loadRunner from "./core/loadRunner.js";

package/bin/{v14/tasks/actions/GetMethods/ShowAll → v15/tasks/actions/GetMethods/Distinct}/template/controller.js

@@ -1,9 +1,14 @@
 import { fromJsonPath } from './service.js';
 import { ConflictError, StorageError } from './errors.js';
 
-const getFunc = ({ res, inTableName }) => {
+const getFunc = ({ req, res, inTableName }) => {
     try {
-        const message = fromJsonPath({ inTableName });
+        const columnName = req.params.columnName;
+
+        const message = fromJsonPath({
+            inTableName,
+            inColumnName: columnName
+        });
 
         res.type("application/json").send(message);
     } catch (err) {

package/bin/v15/tasks/actions/GetMethods/Distinct/template/service.js

@@ -0,0 +1,12 @@
+import { kschema } from "@keshavsoft/kschema";
+
+const fromJsonPath = ({ inTableName, inColumnName }) => {
+    const tableName = inTableName;
+
+    const array = kschema.table(tableName).query.aggregate.distinct(inColumnName);
+    const collection = array.map(str => ({ [inColumnName]: str }));
+
+    return collection;
+};
+
+export { fromJsonPath };

package/bin/{v13 → v15}/tasks/actions/distinct.js

@@ -1,16 +1,15 @@
 import path from "path";
 import { endPointsJs } from "@keshavsoft/kschema-api-check";
 
-import { locateSource } from "./GetMethods/ShowAll/steps/locateSource.js";
-import { locateDestination } from "./GetMethods/ShowAll/steps/locateDestination.js";
+import { locateSource } from "./GetMethods/Distinct/steps/locateSource.js";
+import { locateDestination } from "./GetMethods/Distinct/steps/locateDestination.js";
 import { createFolder } from "../core/createFolder.js";
 
-// import updateEndPointsJs from "./ShowAll/steps/updateEndPointsJs.js";
-import createHttpFile from "./GetMethods/ShowAll/steps/createHttpFile.js";
+import createHttpFile from "./GetMethods/Distinct/steps/createHttpFile.js";
 
-import { announce } from "./GetMethods/ShowAll/steps/announce.js";
+import { announce } from "./GetMethods/Distinct/steps/announce.js";
 
-import resolveFolderName from "./GetMethods/ShowAll/steps/resolveFolderName.js";
+import resolveFolderName from "./GetMethods/Distinct/steps/resolveFolderName.js";
 
 export default ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true }) => {
     const localToPath = toPath;

package/bin/{v14 → v15}/tasks/actions/showAll.js

@@ -1,5 +1,5 @@
 import path from "path";
-import { endPointsJs } from "@keshavsoft/kschema-api-check";
+import endPointsJs from "@keshavsoft/kschema-api-check";
 
 import { locateSource } from "./GetMethods/ShowAll/steps/locateSource.js";
 import { locateDestination } from "./GetMethods/ShowAll/steps/locateDestination.js";
@@ -12,7 +12,7 @@ import { announce } from "./GetMethods/ShowAll/steps/announce.js";
 
 import resolveFolderName from "./GetMethods/ShowAll/steps/resolveFolderName.js";
 
-export default ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true }) => {
+export default async ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true }) => {
     const localToPath = toPath;
 
     const resolvedFolderName = resolveFolderName({
@@ -37,11 +37,18 @@ export default ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true
     });
 
     if (createFolderResponse.KTF) {
-        endPointsJs({
+        const loadEndPointsJs = await endPointsJs();
+
+        await loadEndPointsJs({
             toPath: localToPath,
             action: resolvedFolderName
         });
 
+        // await endPointsJs({
+        //     toPath: localToPath,
+        //     action: resolvedFolderName
+        // });
+
         // updateEndPointsJs({
         //     appJsPath: `${localToPath}/end-points.js`,
         //     endpoint: resolvedFolderName

package/bin/v16/config/actions.json

@@ -0,0 +1,35 @@
+[
+    {
+        "cmd": "ShowAll",
+        "file": "showAll",
+        "exportFile": "ShowAll",
+        "group": "GetMethods",
+        "description": "Generate ShowAll GET action",
+        "endPointsJs": {
+            "importLine": "import { getFunc } from './ShowAll/controller.js';",
+            "usageLine": "router.get('/ShowAll', (req, res) => getFunc({ res, inTableName : tableName}));"
+        }
+    },
+    {
+        "cmd": "Insert",
+        "file": "insert",
+        "exportFile": "Insert",
+        "group": "PostMethods",
+        "description": "Generate Insert POST action",
+        "endPointsJs": {
+            "importLine": "import { postFunc } from './Insert/controller.js';",
+            "usageLine": "router.post('/Insert', express.json(), (req, res) => postFunc({ req, res, inTableName : tableName}));"
+        }
+    },
+    {
+        "cmd": "Distinct",
+        "file": "distinct",
+        "exportFile": "Distinct",
+        "group": "GetMethods",
+        "description": "Generate Distinct GET action",
+        "endPointsJs": {
+            "importLine": "import distinctFunc from './Distinct/controller.js';",
+            "usageLine": "router.get('/Distinct/:columnName', (req, res) => distinctFunc({ req, res, inTableName : tableName}));"
+        }
+    }
+]

package/bin/v16/config/actionsV2.json

@@ -0,0 +1,23 @@
+[
+    {
+        "cmd": "ShowAll",
+        "file": "showAll",
+        "exportFile": "ShowAll",
+        "group": "GetMethods",
+        "description": "Generate ShowAll GET action"
+    },
+    {
+        "cmd": "Insert",
+        "file": "insert",
+        "exportFile": "Insert",
+        "group": "PostMethods",
+        "description": "Generate Insert POST action"
+    },
+    {
+        "cmd": "Distinct",
+        "file": "distinct",
+        "exportFile": "Distinct",
+        "group": "GetMethods",
+        "description": "Generate Distinct GET action"
+    }
+]

package/bin/v16/core/showUsage.js

@@ -0,0 +1,49 @@
+/*
+KSchema CLI – Execution Flow
+
+1. Parse terminal input
+2. Show usage if command/help missing
+3. Resolve command dynamically
+4. Load command dynamically
+5. Execute action
+
+Architecture Goals:
+- JSON driven command system
+- Zero hardcoded command maps
+- Single source of truth
+- Easy scalability
+- Beginner friendly structure
+*/
+import actions from "../config/actions.json" with { type: "json" };
+
+export default function showUsage(version) {
+  const g = "\x1b[32m";
+  const y = "\x1b[33m";
+  const c = "\x1b[36m";
+  const gray = "\x1b[90m";
+  const r = "\x1b[0m";
+
+  const commandsText = actions.map((item) => {
+    return `  ${g}${item.exportFile}${r}     ${item.description}`;
+  }).join("\n");
+
+  const examplesText = actions.map((item) => {
+    return `  ${gray}npx @keshavsoft/kschema-api-gen-actions ${item.exportFile}${r}`;
+  }).join("\n");
+
+  console.log(`
+${c}🚀 KSchema Api Generator v${version}${r}
+
+${y}Usage:${r}
+  ${g}npx @keshavsoft/kschema-api-gen-actions${r} <command> [options]
+
+${y}Commands:${r}
+${commandsText}
+
+${y}Examples:${r}
+${examplesText}
+
+${y}Tip:${r}
+  ${gray}npm i -g @keshavsoft/kschema-api-gen-actions${r}
+`);
+}

package/bin/{v13 → v16}/start.js

@@ -12,7 +12,7 @@ const run = async () => {
 
   if (input.cmd === "--help" || input.cmd === "-h" || input.cmd === "help") return showUsage(version);
 
-  const command = resolveCommand(input.cmd);
+  const command = await resolveCommand(input.cmd);
 
   if (!command) return (console.log(`Unknown command: ${input.cmd}\n`), showUsage(version));
 

package/bin/{v14/tasks/actions/GetMethods/Distinct → v16/tasks/actions/GetMethods/Distinct/V1}/template/controller.js

@@ -1,9 +1,14 @@
 import { fromJsonPath } from './service.js';
 import { ConflictError, StorageError } from './errors.js';
 
-const getFunc = ({ res, inTableName }) => {
+const getFunc = ({ req, res, inTableName }) => {
     try {
-        const message = fromJsonPath({ inTableName });
+        const columnName = req.params.columnName;
+
+        const message = fromJsonPath({
+            inTableName,
+            inColumnName: columnName
+        });
 
         res.type("application/json").send(message);
     } catch (err) {

package/bin/v16/tasks/actions/GetMethods/Distinct/V1/template/service.js

@@ -0,0 +1,12 @@
+import { kschema } from "@keshavsoft/kschema";
+
+const fromJsonPath = ({ inTableName, inColumnName }) => {
+    const tableName = inTableName;
+
+    const array = kschema.table(tableName).query.aggregate.distinct(inColumnName);
+    const collection = array.map(str => ({ [inColumnName]: str }));
+
+    return collection;
+};
+
+export { fromJsonPath };

package/bin/v16/tasks/actions/GetMethods/Distinct/V2/template/controller.js

@@ -0,0 +1,26 @@
+import { fromJsonPath } from './service.js';
+import { ConflictError, StorageError } from './errors.js';
+
+const distinctFunc = ({ req, res, inTableName }) => {
+    try {
+        const columnName = req.params.columnName;
+
+        const message = fromJsonPath({
+            inTableName,
+            inColumnName: columnName
+        });
+
+        res.type("application/json").send(message);
+    } catch (err) {
+        if (err instanceof ConflictError)
+            return res.status(409).send(err.message);
+
+        if (err instanceof StorageError)
+            return res.status(500).send("Failed to persist data");
+
+        console.error(err);
+        res.status(500).send("Unexpected error");
+    }
+};
+
+export default distinctFunc;

package/bin/v16/tasks/actions/GetMethods/Distinct/V2/template/service.js

@@ -0,0 +1,12 @@
+import { kschema } from "@keshavsoft/kschema";
+
+const fromJsonPath = ({ inTableName, inColumnName }) => {
+    const tableName = inTableName;
+
+    const array = kschema.table(tableName).query.aggregate.distinct(inColumnName);
+    const collection = array.map(str => ({ [inColumnName]: str }));
+
+    return collection;
+};
+
+export { fromJsonPath };

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/UpdateRoutesJs/updateImports/checkDuplicate.js

@@ -0,0 +1,8 @@
+const checkUseDuplicate = (inContent, inEndpoint) => {
+    const localContent = inContent;
+    const localEndpoint = inEndpoint;
+
+    return localContent.includes(`app.use("/${localEndpoint}"`);
+};
+
+export default checkUseDuplicate;

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/UpdateRoutesJs/updateImports/index.js

@@ -0,0 +1,45 @@
+import readFile from "../common/readFile.js";
+import buildImport from "./buildImport.js";
+import checkDuplicate from "./checkDuplicate.js";
+import findInsertIndex from "./findInsertIndex.js";
+import writeFile from "../common/writeFile.js";
+
+const updateImports = ({ appJsPath, endpoint, showLog, inFuncName }) => {
+    const summary = {
+        import: { added: false, line: null },
+    };
+
+    const content = readFile(appJsPath);
+
+    const importLine = buildImport({
+        inEndpoint: endpoint,
+        inFuncName
+    });
+
+    if (checkDuplicate(content, endpoint)) {
+        summary.import.skipped = true;
+
+        if (showLog) console.log(summary);
+
+        return summary;
+    };
+
+    const index = findInsertIndex(content);
+
+    const before = content.slice(0, index);
+    const lineNumber = before.split("\n").length + 1;
+
+    const updated =
+        before + "\n" + importLine + content.slice(index);
+
+    writeFile(appJsPath, updated);
+
+    summary.import.added = true;
+    summary.import.line = lineNumber;
+
+    if (showLog) console.log(summary);
+
+    return summary;
+};
+
+export default updateImports;

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/UpdateRoutesJs/updateUse/buildUseLine.js

@@ -0,0 +1,9 @@
+const appOrRouter = "router";
+
+const buildUseLine = ({ inEndpoint, inFuncName }) => {
+    return `${appOrRouter}.get('/${inEndpoint}', (req, res) => ${inFuncName}({ res, inTableName : tableName}));`;
+
+    // return `${appOrRouter}.use("/${inEndpoint}", ${inFuncName});`;
+};
+
+export default buildUseLine;

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/UpdateRoutesJs/updateUse/checkDuplicate.js

@@ -0,0 +1,8 @@
+const checkDuplicate = (inContent, inEndpoint) => {
+    const localContent = inContent;
+    const localEndpoint = inEndpoint;
+
+    return localContent.includes(`app.use("/${localEndpoint}"`);
+};
+
+export default checkDuplicate;

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/UpdateRoutesJs/updateUse/index.js

@@ -0,0 +1,46 @@
+import readFile from "../common/readFile.js";
+import writeFile from "../common/writeFile.js";
+
+import buildUseLine from "./buildUseLine.js";
+import checkDuplicate from "./checkDuplicate.js";
+import findUseInsertIndex from "./findInsertIndex.js";
+
+const updateAppUse = ({ appJsPath, endpoint, showLog, inFuncName }) => {
+    const summary = {
+        use: { added: false, skipped: false, line: null }
+    };
+
+    const content = readFile(appJsPath);
+
+    const useLine = buildUseLine({
+        inEndpoint: endpoint,
+        inFuncName
+    });
+
+    if (checkDuplicate(content, endpoint)) {
+        summary.use.skipped = true;
+
+        if (showLog) console.log(summary);
+
+        return summary;
+    };
+
+    const index = findUseInsertIndex(content);
+
+    const before = content.slice(0, index);
+    const lineNumber = before.split("\n").length + 1;
+
+    const updated =
+        before + "\n" + useLine + content.slice(index);
+
+    writeFile(appJsPath, updated);
+
+    summary.use.added = true;
+    summary.use.line = lineNumber;
+
+    if (showLog) console.log(summary);
+
+    return summary;
+};
+
+export default updateAppUse;

package/bin/v16/tasks/actions/GetMethods/ShowAll/steps/resolveFolderName.js

@@ -0,0 +1,20 @@
+import fs from "fs";
+
+export default function resolveFolderName({ name }) {
+    const defaultFolerName = "ShowAll";
+
+    // case 1: force new → timestamp
+    if (name === null) {
+        name = defaultFolerName;
+    };
+
+    // case 2: user provided → strict
+    if (fs.existsSync(name)) {
+        return {
+            KTF: false,
+            KReason: `Folder already exists : ${name}`
+        };
+    };
+
+    return name;
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/UpdateRoutesJs/common/readFile.js

@@ -0,0 +1,8 @@
+import fs from "fs";
+
+const readFile = (inAppJsPath) => {
+    const localPath = inAppJsPath;
+    return fs.readFileSync(localPath, "utf-8");
+};
+
+export default readFile;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/UpdateRoutesJs/common/writeFile.js

@@ -0,0 +1,10 @@
+import fs from "fs";
+
+const writeFile = (inAppJsPath, inContent) => {
+    const localPath = inAppJsPath;
+    const localContent = inContent;
+
+    fs.writeFileSync(localPath, localContent);
+};
+
+export default writeFile;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/UpdateRoutesJs/updateImports/buildImport.js

@@ -0,0 +1,9 @@
+const buildImport = ({ inFuncName, inEndpoint }) => {
+    const localEndpoint = inEndpoint;
+
+    const safeName = localEndpoint.replace(/[^a-zA-Z0-9]/g, "_");
+
+    return `import { ${inFuncName} } from "./${localEndpoint}/controller.js";`;
+};
+
+export default buildImport;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/UpdateRoutesJs/updateImports/findInsertIndex.js

@@ -0,0 +1,10 @@
+const findInsertIndex = (inContent) => {
+    const localContent = inContent;
+
+    const matches = [...localContent.matchAll(/^\s*import.*$/gm)];
+    const last = matches.at(-1);
+
+    return last ? last.index + last[0].length : 0;
+};
+
+export default findInsertIndex;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/UpdateRoutesJs/updateUse/findInsertIndex.js

@@ -0,0 +1,10 @@
+const findUseInsertIndex = (inContent) => {
+    const localContent = inContent;
+
+    const matches = [...localContent.matchAll(/const\s+router\s*=\s*express\.Router\(\)/g)];
+    const match = matches.at(0);
+
+    return match ? match.index + match[0].length : localContent.length;
+};
+
+export default findUseInsertIndex;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/announce.js

@@ -0,0 +1,9 @@
+export const announce = ({ inResolvedFolderName }) => {
+    console.log(`[keshavsoft] Folder created: ${inResolvedFolderName}`);
+
+    console.log("");
+    console.log("Next:");
+    console.log("");
+    console.log(`cd ${inResolvedFolderName}`);
+    console.log(`npx kschema-api-gen AddSubRoute`);
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/createFolder.js

@@ -0,0 +1,7 @@
+import fs from "fs";
+
+export const createFolder = ({ source, destination }) => {
+    fs.mkdirSync(destination, { recursive: true });
+
+    fs.cpSync(source, destination, { recursive: true });
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/createHttpFile.js

@@ -0,0 +1,12 @@
+import fs from "fs";
+import path from "path";
+
+const createHttpFile = ({ inTargetPath, toPath }) => {
+    const relative = inTargetPath.replace(toPath, "").replace(/\\/g, "/");
+
+    const content = `GET http://localhost:3000${relative}`;
+
+    fs.writeFileSync(path.join(inTargetPath, "rest.http"), content);
+};
+
+export default createHttpFile;

package/bin/v16/tasks/actions/PostMethods/Insert/steps/decideTemplate.js

@@ -0,0 +1,3 @@
+export const decideTemplate = ({ inTemplate }) => {
+    return inTemplate || "basic";
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/locateDestination.js

@@ -0,0 +1,7 @@
+import path from "path";
+
+export const locateDestination = ({ inResolvedFolderName, toPath }) => {
+    const localToPath = toPath;
+
+    return path.join(localToPath, inResolvedFolderName);
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/locateSource.js

@@ -0,0 +1,13 @@
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const locateSource = () => {
+    return path.join(
+        __dirname,
+        "..",
+        "template"
+    );
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/updateAppJs.js

@@ -0,0 +1,7 @@
+import updateImports from "./UpdateRoutesJs/updateImports/index.js";
+import updateAppUse from "./UpdateRoutesJs/updateUse/index.js";
+
+export default ({ appJsPath, endpoint }) => {
+    updateImports({ appJsPath, endpoint });
+    updateAppUse({ appJsPath, endpoint });
+};

package/bin/v16/tasks/actions/PostMethods/Insert/steps/updateEndPointsFile.js

@@ -0,0 +1,30 @@
+import fs from 'fs';
+
+function updateEndPointsFile({ filePath, inTableName }) {
+    try {
+        let content = readFile(filePath);
+
+        content = content.replace("<TABLE_NAME>", inTableName);
+
+        writeFile(filePath, content);
+    } catch (e) {
+        handleError(e);
+    };
+};
+
+// read
+function readFile(filePath) {
+    return fs.readFileSync(filePath, "utf-8");
+};
+
+// write
+function writeFile(filePath, content) {
+    fs.writeFileSync(filePath, content);
+};
+
+// error handler
+function handleError(e) {
+    console.error("ROUTE USE ERROR:", e.message);
+};
+
+export { updateEndPointsFile };

package/bin/v16/tasks/actions/PostMethods/Insert/steps/updateEndPointsJs.js

@@ -0,0 +1,16 @@
+import updateImports from "./UpdateRoutesJs/updateImports/index.js";
+import updateAppUse from "./UpdateRoutesJs/updateUse/index.js";
+
+const funcName = "getFunc";
+
+export default ({ appJsPath, endpoint }) => {
+    updateImports({
+        appJsPath, endpoint,
+        inFuncName: funcName
+    });
+
+    updateAppUse({
+        appJsPath, endpoint,
+        inFuncName: funcName
+    });
+};

package/bin/v16/tasks/actions/PostMethods/Insert/template/errors.js

@@ -0,0 +1,11 @@
+class AppError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = this.constructor.name;
+    }
+}
+
+class ConflictError extends AppError { }
+class StorageError extends AppError { }
+
+export { AppError, ConflictError, StorageError };