@keshavsoft/kschema-api-gen-actions 1.14.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KeshavSoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,320 @@
+# @keshavsoft/kschema-api-gen-actions
+
+> Generate Express.js API action boilerplate instantly.
+
+A lightweight developer-first CLI that scaffolds API action modules for Express.js applications with automatic route registration and structured architecture.
+
+---
+
+# Features
+
+- ⚡ Generate API actions in seconds
+- 📁 Auto-create folders and files
+- 🛣 Auto-register routes in `end-points.js`
+- 🧠 Convention-based code generation
+- 🔥 Minimal setup
+- 📦 ESM-first architecture
+- 🚀 Optimized for rapid backend development
+- 🧩 Scalable folder structure
+
+---
+
+# Installation
+
+## Global Installation
+
+```bash
+npm install -g @keshavsoft/kschema-api-gen-actions
+```
+
+---
+
+## Using NPX
+
+```bash
+npx @keshavsoft/kschema-api-gen-actions
+```
+
+---
+
+# Quick Start
+
+Assume your current project contains:
+
+```txt
+end-points.js
+```
+
+Example:
+
+```js
+import express from 'express';
+
+const tableName = "journals";
+
+const router = express.Router();
+
+export { router };
+```
+
+---
+
+# Generate ShowAll Action
+
+```bash
+npx kschema-api-gen ShowAll
+```
+
+Generated:
+
+```txt
+ShowAll/
+├── controller.js
+├── dal.js
+├── route.js
+└── validation.js
+```
+
+And updates:
+
+```js
+import { getFunc } from "./ShowAll/controller.js";
+
+router.get('/ShowAll', (req, res) =>
+    getFunc({
+        res,
+        inTableName: tableName
+    })
+);
+```
+
+---
+
+# Generate Insert Action
+
+```bash
+npx kschema-api-gen Insert
+```
+
+Generated:
+
+```txt
+Insert/
+├── controller.js
+├── dal.js
+├── route.js
+└── validation.js
+```
+
+And updates:
+
+```js
+import { postFunc } from "./Insert/controller.js";
+
+router.post('/Insert', express.json(), (req, res) =>
+    postFunc({
+        req,
+        res,
+        inTableName: tableName
+    })
+);
+```
+
+---
+
+# Final Result Example
+
+```txt
+project/
+├── end-points.js
+├── Insert/
+│   ├── controller.js
+│   ├── dal.js
+│   ├── route.js
+│   └── validation.js
+│
+├── ShowAll/
+│   ├── controller.js
+│   ├── dal.js
+│   ├── route.js
+│   └── validation.js
+```
+
+---
+
+# CLI Usage
+
+```bash
+npx kschema-api-gen <ActionName>
+```
+
+---
+
+# Supported Actions
+
+| Action | Method | Description |
+|---|---|---|
+| ShowAll | GET | Fetch all records |
+| Insert | POST | Insert new record |
+
+---
+
+# Example Workflow
+
+## Step 1
+
+Create route container:
+
+```js
+import express from 'express';
+
+const tableName = "journals";
+
+const router = express.Router();
+
+export { router };
+```
+
+---
+
+## Step 2
+
+Run:
+
+```bash
+npx kschema-api-gen ShowAll
+```
+
+---
+
+## Step 3
+
+Run:
+
+```bash
+npx kschema-api-gen Insert
+```
+
+---
+
+## Step 4
+
+Your routes become:
+
+```js
+import express from 'express';
+
+import { postFunc } from "./Insert/controller.js";
+import { getFunc } from "./ShowAll/controller.js";
+
+const tableName = "journals";
+
+const router = express.Router();
+
+router.get('/ShowAll', (req, res) =>
+    getFunc({
+        res,
+        inTableName: tableName
+    })
+);
+
+router.post('/Insert', express.json(), (req, res) =>
+    postFunc({
+        req,
+        res,
+        inTableName: tableName
+    })
+);
+
+export { router };
+```
+
+---
+
+# Philosophy
+
+This package is designed around:
+
+- Convention over configuration
+- Fast backend development
+- Predictable architecture
+- Reduced boilerplate
+- Clean scalable Express.js APIs
+
+---
+
+# Tech Stack
+
+- Node.js
+- Express.js
+- JavaScript
+- ESM Modules
+
+---
+
+# Local Development
+
+Clone repository:
+
+```bash
+git clone <repo-url>
+```
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Run locally:
+
+```bash
+node ./bin/cli.js ShowAll
+```
+
+---
+
+# Package Structure
+
+```txt
+bin/
+├── cli.js
+├── v11/
+│   ├── commands/
+│   ├── core/
+│   └── tasks/
+```
+
+---
+
+# Roadmap
+
+- [ ] Update action generation
+- [ ] Delete action generation
+- [ ] Validation schema generation
+- [ ] TypeScript support
+- [ ] Swagger/OpenAPI support
+- [ ] Prisma templates
+- [ ] Sequelize templates
+- [ ] MongoDB templates
+- [ ] Custom middleware generation
+
+---
+
+# Contributing
+
+Pull requests are welcome.
+
+For major changes, please open an issue first to discuss proposed improvements.
+
+---
+
+# License
+
+MIT
+
+---
+
+# Author
+
+Created by KeshavSoft.

package/bin/cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+import getLatestVersion from "./core/getLatestVersion.js";
+import loadRunner from "./core/loadRunner.js";
+
+const run = async () => {
+  const version = getLatestVersion();
+  const runner = await loadRunner(version);
+  await runner();
+};
+
+run();

package/bin/core/getLatestVersion.js

@@ -0,0 +1,13 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+export default function getLatestVersion() {
+    const versions = fs.readdirSync(path.join(__dirname, ".."))
+        .filter(n => /^v\d+$/.test(n))
+        .sort((a, b) => parseInt(a.slice(1)) - parseInt(b.slice(1)));
+
+    return versions.at(-1);
+};

package/bin/core/loadRunner.js

@@ -0,0 +1,9 @@
+export default async function loadRunner(version) {
+    const mod = await import(`../${version}/start.js`);
+
+    if (typeof mod.default !== "function") {
+        throw new Error(`Invalid start.js in ${version}`);
+    }
+
+    return mod.default;
+};

package/bin/v13/commands/loadCommand.js

@@ -0,0 +1,11 @@
+import actions from "../config/actions.json" with { type: "json" };
+
+export default async function loadCommand(name) {
+    const matched = actions.find(x => x.exportFile === name);
+
+    if (!matched) return null;
+
+    const module = await import(`../tasks/actions/${matched.file}.js`);
+
+    return module.default;
+};

package/bin/v13/config/actions.json

@@ -0,0 +1,20 @@
+[
+    {
+        "cmd": "showAll",
+        "file": "showAll",
+        "exportFile": "ShowAll",
+        "group": "GetMethods"
+    },
+    {
+        "cmd": "insert",
+        "file": "insert",
+        "exportFile": "Insert",
+        "group": "PostMethods"
+    },
+    {
+        "cmd": "distinct",
+        "file": "distinct",
+        "exportFile": "Distinct",
+        "group": "GetMethods"
+    }
+]

package/bin/v13/core/createFolder.js

@@ -0,0 +1,34 @@
+import fs from "fs";
+
+export const createFolder = ({ source, destination, checkBeforeCreate = false, isAnnounce = true }) => {
+    if (checkBeforeCreate) {
+        return createFolderWithCheck({ source, destination, isAnnounce });
+    } else {
+        return createOnly({ source, destination });
+    };
+};
+
+const createOnly = ({ source, destination }) => {
+    fs.mkdirSync(destination, { recursive: true });
+
+    fs.cpSync(source, destination, { recursive: true });
+
+    return {
+        KTF: true
+    };
+};
+
+const createFolderWithCheck = ({ source, destination, isAnnounce }) => {
+    if (fs.existsSync(destination)) {
+        if (isAnnounce) console.log("Folder already exists :", destination);
+
+        return {
+            KTF: false,
+            KReason: "Folder already exists"
+        };
+    };
+
+    if (isAnnounce) console.log("Folder created :", destination);
+
+    return createOnly({ source, destination });
+};

package/bin/v13/core/parseInput.js

@@ -0,0 +1,8 @@
+export default function parseInput() {
+    const [cmd] = process.argv.slice(2);
+
+    return {
+        cmd: cmd || null,
+        toPath: process.cwd()
+    };
+};

package/bin/v13/core/resolveCommand.js

@@ -0,0 +1,11 @@
+import actions from "../config/actions.json" with { type: "json" };
+
+export default async function resolveCommand(cmd) {
+    const matched = actions.find(x => x.cmd === cmd);
+
+    if (!matched) return null;
+
+    const module = await import(`../tasks/actions/${matched.file}.js`);
+
+    return module.default;
+};

package/bin/v13/core/showUsage.js

@@ -0,0 +1,50 @@
+/*
+KSchema CLI – Entry Flow
+
+1. Read user input from terminal (parseInput)
+2. If no command → show usage (first-time user safety)
+3. If help flags → show usage (quick guidance)
+4. Resolve command dynamically (no hardcoding logic)
+5. If command not found → inform + guide back to usage
+6. Execute command with parsed input
+
+Goal:
+- Zero confusion for user
+- Single source of truth (showUsage)
+- Easy to extend (just add commands, no core changes)
+*/
+
+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";
+
+    console.log(`
+${c}🚀 KSchema Api Generator v${version}${r}
+
+${y}Usage:${r}
+  ${g}npx @keshavsoft/kschema-api-gen${r} <command> [options]
+
+${y}Commands:${r}
+  ${g}StartEndPoint${r}     Initialize a new folder and files
+  ${g}AddSubRoute${r}       Initialize a new folder and files
+  ${g}AddTableName${r}      Initialize a new folder and files for TableName
+  ${g}ShowAll${r}           Initialize a new folder and files for action
+  
+  ${g}CreateApi${r}         Creates new end point and hooks to app.js
+  ${g}InsertApi${r}         Creates new InsertApi end point and hooks to app.js
+  
+${y}Examples:${r}
+  ${gray}npx @keshavsoft/kschema-api-gen StartEndPoint${r}
+  ${gray}npx @keshavsoft/kschema-api-gen AddSubRoute${r}
+  ${gray}npx @keshavsoft/kschema-api-gen AddTableName${r}
+  ${gray}npx @keshavsoft/kschema-api-gen ShowAll${r}
+  ${gray}npx @keshavsoft/kschema-api-gen CreateApi Api/V1/journals/ShowAll${r}
+  ${gray}npx @keshavsoft/kschema-api-gen InsertApi Api/V1/journals/Insert${r}
+
+${y}Tip:${r}
+  ${gray}npm i -g @keshavsoft/kschema-api-gen${r}
+`);
+}

package/bin/v13/start.js

@@ -0,0 +1,22 @@
+import parseInput from "./core/parseInput.js";
+import resolveCommand from "./core/resolveCommand.js";
+import showUsage from './core/showUsage.js';
+import pkg from '../../package.json' with { type: 'json' };
+
+const version = pkg.version;
+
+const run = async () => {
+  const input = parseInput();
+
+  if (!input.cmd) return showUsage(version);
+
+  if (input.cmd === "--help" || input.cmd === "-h" || input.cmd === "help") return showUsage(version);
+
+  const command = resolveCommand(input.cmd);
+
+  if (!command) return (console.log(`Unknown command: ${input.cmd}\n`), showUsage(version));
+
+  await command(input);
+};
+
+export default run;

package/bin/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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/v13/tasks/actions/GetMethods/Distinct/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;