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

package/bin/v16/config/actions.json

@@ -31,5 +31,16 @@
             "importLine": "import distinctFunc from './Distinct/controller.js';",
             "usageLine": "router.get('/Distinct/:columnName', (req, res) => distinctFunc({ req, res, inTableName : tableName}));"
         }
+    },
+    {
+        "cmd": "FilterColumns",
+        "file": "filterColumns",
+        "exportFile": "FilterColumns",
+        "group": "PostMethods",
+        "description": "Generate FilterColumns POST action",
+        "endPointsJs": {
+            "importLine": "import filterColumnsFunc from './FilterColumns/controller.js';",
+            "usageLine": "router.post('/FilterColumns', express.json(), (req, res) => filterColumnsFunc({ req, res, inTableName : tableName}));"
+        }
     }
 ]

package/bin/v16/config/actionsV3.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/tasks/actions/PostMethods/FilterColumns/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/FilterColumns/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/FilterColumns/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/FilterColumns/steps/UpdateRoutesJs/updateImports/checkDuplicate.js

@@ -0,0 +1,8 @@
+const checkUseDuplicate = ({ inContent, inFuncName }) => {
+    const localContent = inContent;
+    const toCheckLine = `import { ${inFuncName} } from`;
+
+    return localContent.includes(toCheckLine);
+};
+
+export default checkUseDuplicate;

package/bin/v16/tasks/actions/PostMethods/FilterColumns/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/FilterColumns/steps/UpdateRoutesJs/updateImports/index.js

@@ -0,0 +1,47 @@
+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
+    });
+
+    const fromCheckDuplicate = checkDuplicate({ inContent: content, inFuncName });
+
+    if (fromCheckDuplicate) {
+        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/PostMethods/FilterColumns/steps/UpdateRoutesJs/updateUse/buildUseLine.js

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

package/bin/v16/tasks/actions/PostMethods/FilterColumns/steps/UpdateRoutesJs/updateUse/checkDuplicate.js

@@ -0,0 +1,9 @@
+const checkDuplicate = ({ inContent, inEndpoint, inAppOrRouter }) => {
+    const localContent = inContent;
+    const localEndpoint = inEndpoint;
+    const stringToSearch = `${inAppOrRouter}.get('/${localEndpoint}'`;
+
+    return localContent.includes(stringToSearch);
+};
+
+export default checkDuplicate;

package/bin/v16/tasks/actions/PostMethods/FilterColumns/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/FilterColumns/steps/UpdateRoutesJs/updateUse/index.js

@@ -0,0 +1,56 @@
+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 appOrRouter = "router";
+
+const updateAppUse = ({ appJsPath, endpoint, showLog, inFuncName }) => {
+    const summary = {
+        use: { added: false, skipped: false, line: null }
+    };
+
+    const content = readFile(appJsPath);
+
+    const useLine = buildUseLine({
+        inAppOrRouter: appOrRouter,
+        inEndpoint: endpoint,
+        inFuncName
+    });
+
+    const fromCheckDuplicate = checkDuplicate({
+        inContent: content,
+        inEndpoint: endpoint,
+        inAppOrRouter: appOrRouter
+    });
+    console.log("fromCheckDuplicate : ", fromCheckDuplicate);
+
+    if (fromCheckDuplicate) {
+        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/PostMethods/FilterColumns/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/FilterColumns/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/FilterColumns/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/FilterColumns/steps/decideTemplate.js

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

package/bin/v16/tasks/actions/PostMethods/FilterColumns/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/FilterColumns/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/FilterColumns/steps/resolveFolderName.js

@@ -0,0 +1,20 @@
+import fs from "fs";
+
+export default function resolveFolderName({ name, inDefaultFolderName = "Insert" }) {
+    const defaultFolderName = inDefaultFolderName;
+
+    // case 1: force new → timestamp
+    if (name === null) {
+        name = defaultFolderName;
+    };
+
+    // 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/FilterColumns/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/FilterColumns/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/FilterColumns/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/FilterColumns/template/controller.js

@@ -0,0 +1,27 @@
+import { filterItems } from "./service.js";
+import { ConflictError, StorageError } from "./errors.js";
+
+const filterColumnsFunc = ({ req, res, inTableName }) => {
+    try {
+        const inRequestBody = req.body;
+
+        const message = filterItems({
+            inRequestBody,
+            inTableName
+        });
+
+        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 filterColumnsFunc;

package/bin/v16/tasks/actions/PostMethods/FilterColumns/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 };

package/bin/v16/tasks/actions/PostMethods/FilterColumns/template/middleware.js

@@ -0,0 +1,19 @@
+const StartFunc = (req, res, next) => {
+    const LocalBody = req.body;
+
+    if (!LocalBody || Object.keys(LocalBody).length === 0) {
+        return res.status(400).send("Request body should not be empty.");
+    }
+
+    if (Array.isArray(LocalBody)) {
+        return res.status(400).send("Remove The Array From The Body.");
+    }
+
+    if (typeof LocalBody === 'object' && Object.keys(LocalBody).length === 0) {
+        return res.status(400).send("Request body should not be an empty object.");
+    }
+
+    next();
+};
+
+export { StartFunc };

package/bin/v16/tasks/actions/PostMethods/FilterColumns/template/rest.http

@@ -0,0 +1,4 @@
+POST http://localhost:3000/Api/V1/journals/FilterColumns
+Content-Type: application/json
+
+{ "AccountName": "VEETI KRISHNA" }

package/bin/v16/tasks/actions/PostMethods/FilterColumns/template/service.js

@@ -0,0 +1,9 @@
+import { kschema } from "@keshavsoft/kschema";
+
+const filterItems = ({ inRequestBody, inTableName }) => {
+    const tableName = inTableName;
+
+    return kschema.table(tableName).query.filterByColumns(inRequestBody);
+};
+
+export { filterItems };

package/bin/v16/tasks/actions/filterColumns.js

@@ -0,0 +1,56 @@
+import path from "path";
+import apiCheck from "@keshavsoft/kschema-api-check";
+
+import { locateSource } from "./PostMethods/FilterColumns/steps/locateSource.js";
+import { locateDestination } from "./PostMethods/FilterColumns/steps/locateDestination.js";
+import { createFolder } from "../../core/createFolder.js";
+
+import updateEndPointsJs from "./PostMethods/FilterColumns/steps/updateEndPointsJs.js";
+import createHttpFile from "./PostMethods/FilterColumns/steps/createHttpFile.js";
+
+import { announce } from "./PostMethods/FilterColumns/steps/announce.js";
+
+import resolveFolderName from "./PostMethods/FilterColumns/steps/resolveFolderName.js";
+
+const startFunc = async ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true }) => {
+    const localToPath = toPath;
+
+    const resolvedFolderName = resolveFolderName({
+        name: cmd
+    });
+
+    if (resolvedFolderName.KTF === false) {
+        console.log(resolvedFolderName.KReason);
+
+        return;
+    };
+
+    const source = locateSource();
+    const destination = locateDestination({
+        inResolvedFolderName: resolvedFolderName,
+        toPath: localToPath
+    });
+
+    const createFolderResponse = createFolder({
+        source, destination,
+        isAnnounce, checkBeforeCreate
+    });
+
+    if (createFolderResponse.KTF) {
+        await apiCheck({
+            toPath: localToPath,
+            action: resolvedFolderName
+        });
+
+        createHttpFile({
+            inTargetPath: path.join(localToPath, resolvedFolderName),
+            toPath: process.cwd()
+        });
+    };
+
+    if (isAnnounce) announce({ inResolvedFolderName: resolvedFolderName });
+
+    return resolvedFolderName;
+};
+
+export default startFunc;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keshavsoft/kschema-api-gen-actions",
-  "version": "1.16.2",
+  "version": "1.16.3",
   "description": "CLI to scaffold projects using templates",
   "keywords": [
     "cli",
@@ -11,7 +11,7 @@
   ],
   "dependencies": {
     "@keshavsoft/kschema": "^1.17.8",
-    "@keshavsoft/kschema-api-check": "^1.12.2"
+    "@keshavsoft/kschema-api-check": "^1.12.3"
   },
   "type": "module",
   "exports": {