kschema-fs-api-gen-get-actions 1.3.2 → 1.4.3

package/bin/v4/tasks/actions/Find/template/v1/controller.js

@@ -0,0 +1,25 @@
+import { startFunc as Service } from "./service.js";
+import { ConflictError, StorageError } from "./errors.js";
+
+const getFunc = async ({ req, res, inTablePath }) => {
+    try {
+        const pk = "";
+        const fromService = await Service({
+            inTablePath
+        });
+
+        res.type("application/json").send(fromService);
+    } 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 getFunc;

package/bin/v4/tasks/actions/Find/template/v2/controller.js

@@ -0,0 +1,27 @@
+import { startFunc as Service } from "./service.js";
+import { ConflictError, StorageError } from "./errors.js";
+
+const getFunc = async ({ req, res, inTablePath }) => {
+    try {
+        const requestPk = req.params.pk;
+
+        const fromService = await Service({
+            inPk: requestPk,
+            inTablePath
+        });
+
+        res.type("application/json").send(fromService);
+    } 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 getFunc;

package/bin/v4/tasks/actions/Find/template/v2/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/v4/tasks/actions/Find/template/v2/getData.js

@@ -0,0 +1,11 @@
+import { JSONFilePreset } from 'lowdb/node'
+
+const startFunc = async ({ inTablePath }) => {
+    const db = await JSONFilePreset(inTablePath, []);
+
+    await db.read();
+
+    return await db.data;
+};
+
+export default startFunc;

package/bin/v4/tasks/actions/Find/template/v2/service.js

@@ -0,0 +1,13 @@
+import getData from "./getData.js";
+
+const startFunc = async ({ inPk, inTablePath }) => {
+    const dataAsArray = await getData({ inTablePath });
+
+    const findRow = dataAsArray.find(element => {
+        return element.pk === inPk;
+    });
+
+    return await findRow;
+};
+
+export { startFunc };

package/bin/v4/tasks/actions/ShowAll/actions.json

@@ -0,0 +1,26 @@
+    {
+        "cmd": "WithMail",
+        "file": "withMail",
+        "exportFile": "WithMail",
+        "group": "PostMethods",
+        "description": "Generate WithMail POST action",
+        "endPointsJs": {
+            "importLines": {
+                "toInsertLine": "import funcFromWithMail from './WithMail/controller.js';",
+                "duplicationCheck": "from './WithMail/controller.js'",
+                "insertAfter": [
+                    "import funcFrom",
+                    "import express"
+                ]
+            },
+            "useLines": {
+                "toInsertLine1": "router.get('/WithMail', (req, res) => funcFromWithMail({ res, inTablePath: tablePath }));",
+                "toInsertLine": "router.post('/WithMail', express.json(), (req, res) => funcFromWithMail({ req, res, inTablePath: tablePath, inConfigPath: configPath }));",
+                "duplicationCheck": "router.use('/WithMail'",
+                "insertAfter": [
+                    "router.",
+                    "const router = "
+                ]
+            }
+        }
+    }

package/bin/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/steps/decideTemplate.js

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

package/bin/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/steps/locateSource.js

@@ -0,0 +1,18 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const locateSource = () => {
+    const templatePath = path.join(__dirname, "..", "template");
+
+    const versions = fs.readdirSync(templatePath);
+
+    const maxVersion = Math.max(
+        ...versions.map(v => Number(v.replace("v", "")))
+    );
+
+    return path.join(templatePath, `v${maxVersion}`);
+};

package/bin/v4/tasks/actions/ShowAll/steps/resolveFolderName.js

@@ -0,0 +1,20 @@
+import fs from "fs";
+
+export default function resolveFolderName({ name, inDefaultFolderName = "InsertGenPk" }) {
+    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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/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/v4/tasks/actions/ShowAll/template/v2/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/v4/tasks/actions/ShowAll/template/v2/getData.js

@@ -0,0 +1,11 @@
+import { JSONFilePreset } from 'lowdb/node'
+
+const startFunc = async ({ inTablePath }) => {
+    const db = await JSONFilePreset(inTablePath, []);
+
+    await db.read();
+
+    return await db.data;
+};
+
+export default startFunc;

package/bin/v4/tasks/actions/ShowAll/template/v2/service.js

@@ -0,0 +1,9 @@
+import getData from "./getData.js";
+
+const startFunc = async ({ inTablePath }) => {
+    const dataAsArray = await getData({ inTablePath });
+
+    return await dataAsArray;
+};
+
+export { startFunc };

package/bin/v4/tasks/actions/find.js

@@ -0,0 +1,63 @@
+import path from "path";
+
+import generateRest from "kschema-fs-api-gen-rest";
+import fixEndpointsJs from "express-fix-endpoints-get-js";
+
+import { locateSource } from "./Find/steps/locateSource.js";
+import { locateDestination } from "./Find/steps/locateDestination.js";
+import { createFolder } from "../../core/createFolder.js";
+
+import { announce } from "./Find/steps/announce.js";
+
+import resolveFolderName from "./Find/steps/resolveFolderName.js";
+import actions from "./Find/actions.json" with { type: "json" };
+
+const startFunc = async ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true,
+    toConfigPath, inTargetPath, inGenerateRest = false, inFolderName
+}) => {
+
+    const matched = actions;
+
+    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) {
+        const fromEndPointsJs = await fixEndpointsJs({
+            endPointsJsPath: path.join(localToPath, "end-points.js"),
+            inActionName: cmd, inFolderName
+        });
+
+        if (inGenerateRest) {
+            generateRest({
+                toConfigPath, inTargetPath,
+                toPath: path.join(localToPath, resolvedFolderName),
+            });
+        };
+    };
+
+    if (isAnnounce) announce({ inResolvedFolderName: resolvedFolderName });
+
+    return resolvedFolderName;
+};
+
+export default startFunc;

package/bin/{v2 → v4}/tasks/actions/showAll.js

@@ -1,7 +1,7 @@
 import path from "path";
 
 import generateRest from "kschema-fs-api-gen-rest";
-import fixEndpointsJs from "express-fix-endpoints-js";
+import fixEndpointsJs from "express-fix-endpoints-get-js";
 
 import { locateSource } from "./ShowAll/steps/locateSource.js";
 import { locateDestination } from "./ShowAll/steps/locateDestination.js";
@@ -13,7 +13,7 @@ import resolveFolderName from "./ShowAll/steps/resolveFolderName.js";
 import actions from "./ShowAll/actions.json" with { type: "json" };
 
 const startFunc = async ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreate = true,
-    toConfigPath, inTargetPath, inGenerateRest = false
+    toConfigPath, inTargetPath, inGenerateRest = false, inFolderName
 }) => {
 
     const matched = actions;
@@ -44,7 +44,7 @@ const startFunc = async ({ cmd = "", toPath, isAnnounce = true, checkBeforeCreat
     if (createFolderResponse.KTF) {
         const fromEndPointsJs = await fixEndpointsJs({
             endPointsJsPath: path.join(localToPath, "end-points.js"),
-            inActionName: cmd
+            inActionName: cmd, inFolderName
         });
 
         if (inGenerateRest) {

package/index.js

@@ -17,6 +17,17 @@ const showAll = async ({ toPath, showLog, inTargetPath }) => {
     });
 };
 
+const find = async ({ toPath, showLog, inTargetPath }) => {
+    const commandToSend = "find";
+
+    const commandFunction = await load(commandToSend);
+    // console.log("  ...args :", args);
+    await commandFunction({
+        toPath, cmd: commandToSend, inTargetPath,
+        inFolderName: commandToSend
+    });
+};
+
 export {
-    showAll
+    showAll, find
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kschema-fs-api-gen-get-actions",
-  "version": "1.3.2",
+  "version": "1.4.3",
   "description": "start from end points js, generate post methods",
   "keywords": [
     "cli",