@digicroz/node-backend-kit 1.0.0

package/dist/utils/progress.d.ts

@@ -0,0 +1,65 @@
+import { Ora } from 'ora';
+/**
+ * Creates and starts a spinner with the given text
+ * @param text The text to display next to the spinner
+ * @returns The spinner instance
+ */
+export declare function startProgress(text: string): Ora;
+/**
+ * Updates the spinner text
+ * @param spinner The spinner instance
+ * @param text The new text to display
+ */
+export declare function updateProgress(spinner: Ora, text: string): void;
+/**
+ * Stops the spinner with a success message
+ * @param spinner The spinner instance
+ * @param text The success message
+ */
+export declare function successProgress(spinner: Ora, text: string): void;
+/**
+ * Stops the spinner with a failure message
+ * @param spinner The spinner instance
+ * @param text The failure message
+ */
+export declare function failProgress(spinner: Ora, text: string): void;
+/**
+ * Shows a spinner for a promise
+ * @param text The text to display
+ * @param promise The promise to track
+ * @param successText The text to display on success
+ * @param failText The text to display on failure
+ * @returns The result of the promise
+ */
+export declare function withProgress<T>(text: string, promise: Promise<T>, successText?: string, failText?: string): Promise<T>;
+/**
+ * Creates a progress manager for tracking multiple tasks
+ * @returns An object with methods to manage multiple tasks with progress
+ */
+export declare function createMultiProgress(): {
+    /**
+     * Start the progress tracking
+     * @param text The initial text to display
+     */
+    start: (text?: string) => void;
+    /**
+     * Sets the total number of tasks
+     * @param count The total number of tasks
+     */
+    setTotal: (count: number) => void;
+    /**
+     * Increment the completed tasks counter
+     * @param successText Optional text to display for the completed task
+     */
+    incrementCompleted: (successText?: string) => void;
+    /**
+     * Increment the failed tasks counter
+     * @param failText Optional text to display for the failed task
+     */
+    incrementFailed: (failText?: string) => void;
+    /**
+     * Complete the progress tracking
+     * @param text The final text to display
+     */
+    complete: (text?: string) => void;
+};

package/dist/utils/progress.js

@@ -0,0 +1,108 @@
+import ora from 'ora';
+/**
+ * Creates and starts a spinner with the given text
+ * @param text The text to display next to the spinner
+ * @returns The spinner instance
+ */
+export function startProgress(text) {
+    return ora(text).start();
+}
+/**
+ * Updates the spinner text
+ * @param spinner The spinner instance
+ * @param text The new text to display
+ */
+export function updateProgress(spinner, text) {
+    spinner.text = text;
+}
+/**
+ * Stops the spinner with a success message
+ * @param spinner The spinner instance
+ * @param text The success message
+ */
+export function successProgress(spinner, text) {
+    spinner.succeed(text);
+}
+/**
+ * Stops the spinner with a failure message
+ * @param spinner The spinner instance
+ * @param text The failure message
+ */
+export function failProgress(spinner, text) {
+    spinner.fail(text);
+}
+/**
+ * Shows a spinner for a promise
+ * @param text The text to display
+ * @param promise The promise to track
+ * @param successText The text to display on success
+ * @param failText The text to display on failure
+ * @returns The result of the promise
+ */
+export async function withProgress(text, promise, successText = 'Completed successfully', failText = 'Failed') {
+    const spinner = startProgress(text);
+    try {
+        const result = await promise;
+        successProgress(spinner, successText);
+        return result;
+    }
+    catch (error) {
+        failProgress(spinner, failText);
+        throw error;
+    }
+}
+/**
+ * Creates a progress manager for tracking multiple tasks
+ * @returns An object with methods to manage multiple tasks with progress
+ */
+export function createMultiProgress() {
+    const spinner = ora('Starting tasks...');
+    let totalTasks = 0;
+    let completedTasks = 0;
+    let failedTasks = 0;
+    return {
+        /**
+         * Start the progress tracking
+         * @param text The initial text to display
+         */
+        start: (text = 'Starting tasks...') => {
+            spinner.start(text);
+        },
+        /**
+         * Sets the total number of tasks
+         * @param count The total number of tasks
+         */
+        setTotal: (count) => {
+            totalTasks = count;
+            spinner.text = `0/${totalTasks} tasks completed`;
+        },
+        /**
+         * Increment the completed tasks counter
+         * @param successText Optional text to display for the completed task
+         */
+        incrementCompleted: (successText) => {
+            completedTasks++;
+            spinner.text = `${completedTasks}/${totalTasks} tasks completed${successText ? ` - ${successText}` : ''}`;
+        },
+        /**
+         * Increment the failed tasks counter
+         * @param failText Optional text to display for the failed task
+         */
+        incrementFailed: (failText) => {
+            failedTasks++;
+            spinner.text = `${completedTasks}/${totalTasks} tasks completed, ${failedTasks} failed${failText ? ` - ${failText}` : ''}`;
+        },
+        /**
+         * Complete the progress tracking
+         * @param text The final text to display
+         */
+        complete: (text) => {
+            if (failedTasks > 0) {
+                spinner.fail(text || `Completed with errors: ${completedTasks}/${totalTasks} tasks completed, ${failedTasks} failed`);
+            }
+            else {
+                spinner.succeed(text || `All ${totalTasks} tasks completed successfully`);
+            }
+        }
+    };
+}

package/dist/utils/vscodeSettings.d.ts

@@ -0,0 +1 @@
+export declare function updateVSCodeSettings(): void;

package/dist/utils/vscodeSettings.js

@@ -0,0 +1,67 @@
+import fs from "fs";
+import path from "path";
+import { clientRootDirPath } from "./path.js";
+import { cleanTrailingCommas, stripComments } from "./jsonFile.js";
+export function updateVSCodeSettings() {
+    const vscodeDir = path.join(clientRootDirPath, ".vscode");
+    const settingsPath = path.join(vscodeDir, "settings.json");
+    // Create .vscode directory if it doesn't exist
+    if (!fs.existsSync(vscodeDir)) {
+        fs.mkdirSync(vscodeDir, { recursive: true });
+    }
+    // Read existing settings or create new ones
+    let settings = {};
+    let existingContent = "";
+    if (fs.existsSync(settingsPath)) {
+        try {
+            existingContent = fs.readFileSync(settingsPath, "utf-8");
+            // Clean the content before parsing
+            let cleanedContent = stripComments(existingContent);
+            cleanedContent = cleanTrailingCommas(existingContent);
+            // Try to parse the cleaned content
+            settings = JSON.parse(cleanedContent);
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                // Extract position information from the error message
+                const positionMatch = error.message.match(/position (\d+)/);
+                const position = positionMatch ? parseInt(positionMatch[1]) : 0;
+                // Calculate line and column
+                const lines = existingContent.slice(0, position).split("\n");
+                const line = lines.length;
+                const column = lines[lines.length - 1].length + 1;
+                console.error(`JSON Parse Error at line ${line}, column ${column}`);
+                console.error(`Error details: ${error.message}`);
+                // Keep the existing content as is
+                console.log("Keeping existing settings file unchanged due to parse error");
+                return;
+            }
+            console.warn("Error reading .vscode/settings.json:", error);
+            return;
+        }
+    }
+    // Create a deep copy of existing settings to preserve all data
+    const updatedSettings = JSON.parse(JSON.stringify(settings));
+    // Initialize files.associations if it doesn't exist
+    if (!updatedSettings["files.associations"]) {
+        updatedSettings["files.associations"] = {};
+    }
+    // Only add nbk.config.json association if not already present
+    if (!updatedSettings["files.associations"]["nbk.config.json"]) {
+        updatedSettings["files.associations"]["nbk.config.json"] = "jsonc";
+        console.log("Added nbk.config.json association to .vscode/settings.json");
+    }
+    else {
+        console.log("nbk.config.json association already exists in .vscode/settings.json");
+    }
+    // Only write to file if changes were made
+    if (JSON.stringify(settings) !== JSON.stringify(updatedSettings)) {
+        try {
+            fs.writeFileSync(settingsPath, JSON.stringify(updatedSettings, null, 4));
+        }
+        catch (error) {
+            console.error("Error writing to settings file:", error);
+            console.log("Keeping existing settings file unchanged");
+        }
+    }
+}

package/nbk.schema.json

@@ -0,0 +1,95 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "NBK Configuration Schema",
+  "description": "Schema for nbk.config.json configuration file",
+  "type": "object",
+  "required": [
+    "projects",
+    "b2fPortal",
+    "checkCrossProjectImports"
+  ],
+  "properties": {
+    "projects": {
+      "type": "array",
+      "description": "Array of projects to manage. Each project can have multiple sections like masterPanel, adminPanel, staffPanel, and webApp.",
+      "items": {
+        "type": "object",
+        "required": [
+          "projectName",
+          "projectBaseDirPath",
+          "sections"
+        ],
+        "properties": {
+          "projectName": {
+            "type": "string",
+            "description": "Name of the project (e.g., 'demo_project')"
+          },
+          "projectBaseDirPath": {
+            "type": "string",
+            "description": "Base directory path for the project relative to the config file"
+          },
+          "sharedBackendPath": {
+            "type": "string",
+            "description": "Path to shared backend code, relative to the project root (e.g., '../../shared_one/backend')"
+          },
+          "sections": {
+            "type": "array",
+            "description": "Array of project sections. Each section represents a different part of your application (e.g., masterPanel, adminPanel, staffPanel, webApp)",
+            "items": {
+              "type": "object",
+              "required": [
+                "sectionName",
+                "repository",
+                "localPath",
+                "isZodCreator"
+              ],
+              "properties": {
+                "sectionName": {
+                  "type": "string",
+                  "description": "Name of the section (e.g., 'masterPanel', 'adminPanel', 'staffPanel', 'webApp')"
+                },
+                "repository": {
+                  "type": "object",
+                  "required": [
+                    "name",
+                    "path"
+                  ],
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "description": "Repository name (e.g., 'demo_project_master_panel')"
+                    },
+                    "path": {
+                      "type": "string",
+                      "description": "Repository path relative to the project root (e.g., '../../demo_project/master_panel')"
+                    }
+                  }
+                },
+                "localPath": {
+                  "type": "string",
+                  "description": "Local path where the section code is located relative to the project root (e.g., 'masterPanel')"
+                },
+                "isZodCreator": {
+                  "type": "boolean",
+                  "description": "Whether this section uses Zod for validation. Set to true if the section uses Zod schemas."
+                },
+                "needNextJsPatch": {
+                  "type": "boolean",
+                  "description": "Whether this section needs Next.js patch. Only required for Next.js projects."
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "b2fPortal": {
+      "type": "boolean",
+      "description": "Whether this is a B2F (Business-to-Frontend) portal project. Set to true if your project is a B2F portal."
+    },
+    "checkCrossProjectImports": {
+      "type": "boolean",
+      "description": "Whether to check for cross-project imports. Set to true to enable validation of imports between different project sections."
+    }
+  }
+}

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@digicroz/node-backend-kit",
+  "version": "1.0.0",
+  "description": "NodeJS Backend Kit - A powerful TypeScript utility for managing backend projects with features like B2F Portal integration, cross-project validation, and Next.js support",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "nbk.schema.json"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "nbk": "./dist/bin/nbk.js"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AdarshHatkar/nbk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AdarshHatkar/nbk/issues"
+  },
+  "homepage": "https://github.com/AdarshHatkar/nbk#readme",
+  "scripts": {
+    "prepare": "husky install",
+    "dev": "npm run clean && tsc -w",
+    "clean": "rimraf dist && tsc",
+    "release:patch": "npm version patch",
+    "postversion": "git push && git push --tags && npm publish",
+    "build": "npm run clean && tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "backend",
+    "kit",
+    "primexop",
+    "typescript",
+    "node",
+    "b2f-portal",
+    "nextjs",
+    "validation",
+    "configuration",
+    "cross-project",
+    "development-tools",
+    "typescript-utilities",
+    "backend-management",
+    "project-management",
+    "api-development"
+  ],
+  "author": "AdarshHatkar",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "tsc-path-fix": "^1.0.4",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1"
+  },
+  "dependencies": {
+    "commander": "^13.1.0",
+    "dotenv": "^16.5.0",
+    "husky": "^9.1.7",
+    "ora": "^7.0.1",
+    "rimraf": "^6.0.1",
+    "simple-git": "^3.27.0"
+  }
+}