@monodog/backend 1.1.21 → 1.2.0

package/README.md

@@ -0,0 +1,72 @@
+# Monodog: Monorepo Analytics and Health API
+
+## 🎯 Overview
+
+This is the backend service designed to provide comprehensive analytics, health monitoring, and dependency tracking for a large **JavaScript/TypeScript monorepo**.
+It leverages specialized **@monodog** tools and a database layer (via **Prisma**) to efficiently manage, persist, and expose data about all packages within the repository.
+
+This service is typically run locally or on a central server to power a dedicated frontend dashboard.
+
+---
+
+## 🛠 Technology Stack
+
+| Component | Technology | Description |
+|------------|-------------|--------------|
+| **Language** | TypeScript & Node.js | Core language for runtime execution. |
+| **Framework** | Express.js | Handles all API routing and middleware. |
+| **ORM** | Prisma | Database layer for managing package and health status records. |
+| **Scanning** | @monodog/monorepo-scanner | Core logic for file system scanning and package metadata extraction. |
+| **VCS** | GitService | Used to fetch and analyze commit history per package path. |
+| **Networking** | cors, body-parser | Essential middleware for API connectivity. |
+
+---
+
+## ⚙️ Prerequisites
+
+You must have the following installed to run the service:
+
+- **Node.js:** Version 18+ recommended
+- **Package Manager:** `pnpm` or `npm` (use the one your monorepo uses)
+- **Database:** A running instance of a database supported by Prisma (e.g., PostgreSQL, SQLite, MySQL)
+
+---
+
+## 🚀 Getting Started
+
+###  Installation
+
+Clone the repository and install the dependencies:
+
+```bash
+# Clone the repository
+git clone https://github.com/lakinmindfire/MonoDog.git
+cd packages/backend
+
+# Install dependencies
+pnpm install
+
+# Database Setup (Prisma)
+
+The application requires the database schema to be set up using **Prisma Migrate**.
+
+pnpm prisma generate
+
+pnpm prisma migrate dev
+
+### Run backend server on port 4000 (default)
+
+pnpm monodog-cli --serve --root .
+```
+
+### Key API Endpoints
+
+| Method | Route | Purpose | Persistence |
+|--------|--------|----------|-------------|
+| **GET** | `/api/packages` | Retrieve all package metadata from the database. | Cached / Persistent |
+| **GET** | `/api/packages/refresh` | Trigger a full file scan of the monorepo and update/sync the database. | Triggers write |
+| **GET** | `/api/packages/:name` | Get detailed info, reports, and CI status for a package. | Cached / Persistent |
+| **GET** | `/api/health/packages` | Fetch the latest health metrics (score, build status) for all packages. | Persistent |
+| **GET** | `/api/health/refresh` | Recalculate all package health metrics (tests, lint, security) and update the database. | Triggers write |
+| **GET** | `/api/commits/:packagePath` | Fetch Git commit history for a specific package directory. | Generated runtime |
+| **GET** | `/api/config/files` | Scan the monorepo for essential configuration files (e.g., `tsconfig`, `.eslintrc`). | Generated runtime |

package/dist/cli.js

@@ -96,7 +96,7 @@ if (serve) {
 }
 else {
     // Default mode: print usage or run a default report if no command is specified
-    console.log(`Monodog CLI: No operation specified. Use --serve to start the API or -h for help.`);
+    console.log(`Monodog CLI: No operation specified. Use --serve to start the API or -h for help. Ex: pnpm monodog-cli @monodog/dashboard --serve --root .`);
 }
 /**
  * Copies an installed NPM package from node_modules into the local packages/ workspace directory.
@@ -105,11 +105,13 @@ function copyPackageToWorkspace(rootDir) {
     // 1. Get package name from arguments
     // The package name is expected as the first command-line argument (process.argv[2])
     const packageName = process.argv[2];
-    if (!packageName) {
-        console.error("Error: Please provide the package name as an argument.");
-        console.log("Usage: node copy-to-workspace.js <package-name>");
-        console.log("Example: node copy-to-workspace.js @monodog/dashboard");
-        process.exit(1);
+    if (!packageName || packageName.startsWith('--')) {
+        console.error("Error: Please provide the package name as an argument if you want to setup dashboard.");
+        console.log("Usage: pnpm monodog-cli @monodog/dashboard --serve --root .");
+    }
+    if (packageName !== '@monodog/dashboard') {
+        console.log("\n--- Skipping workspace setup for @monodog/dashboard to avoid self-copying. ---");
+        return;
     }
     // const rootDir = process.cwd();
     const sourcePath = path.join(rootDir, 'node_modules', packageName);
@@ -152,14 +154,12 @@ function copyPackageToWorkspace(rootDir) {
         console.log(`\n✅ Success! Contents of '${packageName}' copied to '${destinationPath}'`);
         // Post-copy instructions
         console.log("\n*** IMPORTANT NEXT STEPS (MANDATORY) ***");
-        console.log("1. Add the new workspace path to your root 'package.json':");
-        console.log(`   - Add "packages/${folderName}" to the 'workspaces' array.`);
-        console.log("2. Force pnpm to use the local workspace via 'overrides':");
-        console.log("   - Add the following to your root package.json:");
-        console.log(`   "pnpm": { "overrides": { "${packageName}": "file:./packages/${folderName}" } }`);
-        console.log("3. Run 'pnpm install' in the root to link the new workspace.");
-        console.log("\n--- DEVELOPMENT WARNING ---");
-        console.log("Remember: This copy contains the **compiled output**, not usually the full source code (e.g., missing original TypeScript/Sass/tests). To properly develop this workspace, you may need to replace the contents with the package's original source repository.");
+        console.log("1.Migrate Database:");
+        console.log(`   - pnpm prisma migrate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
+        console.log("2. Generate Client:");
+        console.log(`   - pnpm exec prisma generate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
+        console.log("3. Run Backend app server with dashboard setup");
+        console.log(`   - pnpm monodog-cli @monodog/dashboard --serve --root .`);
     }
     catch (err) {
         const message = err instanceof Error ? err.message : String(err);

package/dist/index.js

@@ -115,7 +115,7 @@ function startServer(rootPath) {
             const packages = (0, helpers_1.scanMonorepo)(rootDir);
             console.log('packages -->', packages.length);
             for (const pkg of packages) {
-                (0, helpers_2.storePackage)(pkg);
+                await (0, helpers_2.storePackage)(pkg);
             }
             res.json(packages);
         }
@@ -229,25 +229,24 @@ function startServer(rootPath) {
         }
     });
     // Get dependency graph
-    app.get('/api/graph', async (_req, res) => {
-        try {
-            const packages = (0, helpers_1.scanMonorepo)(process.cwd());
-            const graph = (0, helpers_1.generateDependencyGraph)(packages);
-            const circularDeps = (0, helpers_1.findCircularDependencies)(packages);
-            res.json({
-                ...graph,
-                circularDependencies: circularDeps,
-                metadata: {
-                    totalNodes: graph.nodes.length,
-                    totalEdges: graph.edges.length,
-                    circularDependencies: circularDeps.length,
-                },
-            });
-        }
-        catch (error) {
-            res.status(500).json({ error: 'Failed to generate dependency graph' });
-        }
-    });
+    // app.get('/api/graph', async (_req, res) => {
+    //   try {
+    //     const packages = scanMonorepo(process.cwd());
+    //     const graph = generateDependencyGraph(packages);
+    //     const circularDeps = findCircularDependencies(packages);
+    //     res.json({
+    //       ...graph,
+    //       circularDependencies: circularDeps,
+    //       metadata: {
+    //         totalNodes: graph.nodes.length,
+    //         totalEdges: graph.edges.length,
+    //         circularDependencies: circularDeps.length,
+    //       },
+    //     });
+    //   } catch (error) {
+    //     res.status(500).json({ error: 'Failed to generate dependency graph' });
+    //   }
+    // });
     // Get monorepo statistics
     app.get('/api/stats', async (_req, res) => {
         try {
@@ -1106,7 +1105,7 @@ function startServer(rootPath) {
         console.log(`   - GET  /api/packages`);
         console.log(`   - GET  /api/packages/:name`);
         console.log(`   - GET  /api/commits/:packagePath`);
-        console.log(`   - GET  /api/graph`);
+        // console.log(`   - GET  /api/graph`);
         console.log(`   - GET  /api/stats`);
         console.log(`   - GET  /api/ci/status`);
         console.log(`   - POST /api/ci/trigger`);

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@monodog/backend",
-  "version": "1.1.21",
+  "version": "1.2.0",
   "description": "Backend API server for monodog monorepo dashboard",
   "main": "dist/index.js",
   "license": "MIT",
   "bin": {
-    "monodog-cli": "dist/cli.js"
+    "monodog-cli": "src/cli.js"
   },
   "dependencies": {
     "@monodog/ci-status": "1.1.1",

package/prisma/schema.prisma

@@ -13,22 +13,6 @@ datasource db {
   url      = "file:./monolite.db"
 }
 
-model User {
-  id    Int    @id @default(autoincrement())
-  name  String
-  email String @unique
-  posts Post[]
-}
-
-model Post {
-  id        Int     @id @default(autoincrement())
-  title     String
-  content   String?
-  published Boolean @default(false)
-  authorId  Int
-  author    User    @relation(fields: [authorId], references: [id])
-}
-
 // --- MONOREPO DATA MODEL ---
 
 /// Represents a single package within the monorepo, based on the pnpm/package.json data.

package/src/cli.ts

@@ -66,7 +66,7 @@ if (serve) {
     copyPackageToWorkspace(rootPath);
 } else {
     // Default mode: print usage or run a default report if no command is specified
-    console.log(`Monodog CLI: No operation specified. Use --serve to start the API or -h for help.`);
+    console.log(`Monodog CLI: No operation specified. Use --serve to start the API or -h for help. Ex: pnpm monodog-cli @monodog/dashboard --serve --root .`);
 }
 
 /**
@@ -77,11 +77,13 @@ function copyPackageToWorkspace(rootDir: string): void  {
     // The package name is expected as the first command-line argument (process.argv[2])
     const packageName = process.argv[2];
 
-    if (!packageName) {
-        console.error("Error: Please provide the package name as an argument.");
-        console.log("Usage: node copy-to-workspace.js <package-name>");
-        console.log("Example: node copy-to-workspace.js @monodog/dashboard");
-        process.exit(1);
+    if (!packageName || packageName.startsWith('--')) {
+        console.error("Error: Please provide the package name as an argument if you want to setup dashboard.");
+        console.log("Usage: pnpm monodog-cli @monodog/dashboard --serve --root .");
+    }
+    if(packageName !== '@monodog/dashboard'){
+        console.log("\n--- Skipping workspace setup for @monodog/dashboard to avoid self-copying. ---");
+        return;
     }
 
     // const rootDir = process.cwd();
@@ -135,14 +137,12 @@ function copyPackageToWorkspace(rootDir: string): void  {
 
         // Post-copy instructions
         console.log("\n*** IMPORTANT NEXT STEPS (MANDATORY) ***");
-        console.log("1. Add the new workspace path to your root 'package.json':");
-        console.log(`   - Add "packages/${folderName}" to the 'workspaces' array.`);
-        console.log("2. Force pnpm to use the local workspace via 'overrides':");
-        console.log("   - Add the following to your root package.json:");
-        console.log(`   "pnpm": { "overrides": { "${packageName}": "file:./packages/${folderName}" } }`);
-        console.log("3. Run 'pnpm install' in the root to link the new workspace.");
-        console.log("\n--- DEVELOPMENT WARNING ---");
-        console.log("Remember: This copy contains the **compiled output**, not usually the full source code (e.g., missing original TypeScript/Sass/tests). To properly develop this workspace, you may need to replace the contents with the package's original source repository.");
+        console.log("1.Migrate Database:");
+        console.log(`   - pnpm prisma migrate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
+        console.log("2. Generate Client:");
+        console.log(`   - pnpm exec prisma generate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
+        console.log("3. Run Backend app server with dashboard setup");
+        console.log(`   - pnpm monodog-cli @monodog/dashboard --serve --root .`);
 
     } catch (err: unknown) {
     const message = err instanceof Error ? err.message : String(err);

package/src/index.ts

@@ -145,7 +145,7 @@ app.get('/api/packages/refresh', async (_req, res) => {
     const packages = scanMonorepo(rootDir);
     console.log('packages -->', packages.length);
     for (const pkg of packages) {
-      storePackage(pkg)
+      await storePackage(pkg)
     }
 
     res.json(packages);
@@ -275,25 +275,25 @@ app.get('/api/commits/:packagePath', async (_req, res) => {
 });
 
 // Get dependency graph
-app.get('/api/graph', async (_req, res) => {
-  try {
-    const packages = scanMonorepo(process.cwd());
-    const graph = generateDependencyGraph(packages);
-    const circularDeps = findCircularDependencies(packages);
+// app.get('/api/graph', async (_req, res) => {
+//   try {
+//     const packages = scanMonorepo(process.cwd());
+//     const graph = generateDependencyGraph(packages);
+//     const circularDeps = findCircularDependencies(packages);
 
-    res.json({
-      ...graph,
-      circularDependencies: circularDeps,
-      metadata: {
-        totalNodes: graph.nodes.length,
-        totalEdges: graph.edges.length,
-        circularDependencies: circularDeps.length,
-      },
-    });
-  } catch (error) {
-    res.status(500).json({ error: 'Failed to generate dependency graph' });
-  }
-});
+//     res.json({
+//       ...graph,
+//       circularDependencies: circularDeps,
+//       metadata: {
+//         totalNodes: graph.nodes.length,
+//         totalEdges: graph.edges.length,
+//         circularDependencies: circularDeps.length,
+//       },
+//     });
+//   } catch (error) {
+//     res.status(500).json({ error: 'Failed to generate dependency graph' });
+//   }
+// });
 
 // Get monorepo statistics
 app.get('/api/stats', async (_req, res) => {
@@ -1279,7 +1279,7 @@ app.listen(PORT, () => {
   console.log(`   - GET  /api/packages`);
   console.log(`   - GET  /api/packages/:name`);
   console.log(`   - GET  /api/commits/:packagePath`);
-  console.log(`   - GET  /api/graph`);
+  // console.log(`   - GET  /api/graph`);
   console.log(`   - GET  /api/stats`);
   console.log(`   - GET  /api/ci/status`);
   console.log(`   - POST /api/ci/trigger`);

package/.turbo/turbo-build.log

@@ -1,4 +0,0 @@
-
-> @monodog/backend@1.1.19 build /home/manoj/Documents/MonoDog/packages/backend
-> rm -rf dist && tsc -p tsconfig.json
-

package/.turbo/turbo-lint.log

@@ -1,17 +0,0 @@
-
-> @monodog/backend@1.0.0 lint /home/manoj/Documents/MonoDog/packages/backend
-> eslint .
-
-=============
-
-WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.
-
-You may find that it works just fine, or you may not.
-
-SUPPORTED TYPESCRIPT VERSIONS: >=4.3.5 <5.4.0
-
-YOUR TYPESCRIPT VERSION: 5.9.3
-
-Please only submit bug reports when using the officially supported version.
-
-=============

package/.turbo/turbo-test.log

@@ -1,6 +0,0 @@
-
-> @monodog/backend@1.0.0 test /home/manoj/Documents/MonoDog/packages/backend
-> jest --coverage
-
-sh: 1: jest: not found
- ELIFECYCLE  Test failed. See above for more details.

package/dist/setup-workspace.js

@@ -1,96 +0,0 @@
-"use strict";
-// src/setup-workspace.ts
-// Converts the original script to TypeScript.
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-function copyPackageToWorkspace() {
-    const packageName = process.argv[2];
-    if (!packageName) {
-        console.error('Error: Please provide the package name as an argument.');
-        console.log('Usage: ts-node src/setup-workspace.ts <package-name>');
-        console.log('Example: ts-node src/setup-workspace.ts @monodog/dashboard');
-        process.exit(1);
-    }
-    const rootDir = process.cwd();
-    const sourcePath = path.join(rootDir, 'node_modules', packageName);
-    const folderName = packageName.replace('@', '').replace('/', '-');
-    const destinationPath = path.join(rootDir, 'packages', folderName);
-    console.log('\n--- Monorepo Workspace Conversion ---');
-    console.log(`Target Package: ${packageName}`);
-    console.log(`New Workspace:  packages/${folderName}`);
-    console.log('-----------------------------------');
-    if (!fs.existsSync(sourcePath)) {
-        console.error(`\n❌ Error: Source package not found at ${sourcePath}.`);
-        console.error("Please ensure the package is installed via 'pnpm install <package-name>' first.");
-        process.exit(1);
-    }
-    if (fs.existsSync(destinationPath)) {
-        console.error(`\n❌ Error: Destination directory already exists at ${destinationPath}.`);
-        console.error('Please manually remove it or rename it before running the script.');
-        process.exit(1);
-    }
-    const packagesDir = path.join(rootDir, 'packages');
-    if (!fs.existsSync(packagesDir)) {
-        fs.mkdirSync(packagesDir, { recursive: true });
-        console.log(`Created packages directory: ${packagesDir}`);
-    }
-    try {
-        console.log(`\nCopying files from ${sourcePath} to ${destinationPath}...`);
-        fs.cpSync(sourcePath, destinationPath, {
-            recursive: true,
-            dereference: true,
-            // explicit typing for the filter parameter
-            filter: (src) => !src.includes('node_modules'),
-        });
-        console.log(`\n✅ Success! Contents of '${packageName}' copied to '${destinationPath}'`);
-        console.log('\n*** IMPORTANT NEXT STEPS (MANDATORY) ***');
-        console.log("1. Add the new workspace path to your root 'package.json':");
-        console.log(`   - Add "packages/${folderName}" to the 'workspaces' array.`);
-        console.log("2. Force pnpm to use the local workspace via 'overrides':");
-        console.log('   - Add the following to your root package.json:');
-        console.log(`   "pnpm": { "overrides": { "${packageName}": "file:./packages/${folderName}" } }`);
-        console.log("3. Run 'pnpm install' in the root to link the new workspace.");
-        console.log('\n--- DEVELOPMENT WARNING ---');
-        console.log('Remember: This copy contains the **compiled output**, not usually the full source code (e.g., missing original TypeScript/Sass/tests). To properly develop this workspace, you may need to replace the contents with the package\'s original source repository.');
-    }
-    catch (err) {
-        const message = err instanceof Error ? err.message : String(err);
-        console.error(`\n❌ Failed to copy files: ${message}`);
-        process.exit(1);
-    }
-}
-copyPackageToWorkspace();

package/src/setup-workspace.ts

@@ -1,74 +0,0 @@
-// src/setup-workspace.ts
-// Converts the original script to TypeScript.
-
-import * as fs from 'fs';
-import * as path from 'path';
-
-function copyPackageToWorkspace(): void {
-  const packageName: string | undefined = process.argv[2];
-
-  if (!packageName) {
-    console.error('Error: Please provide the package name as an argument.');
-    console.log('Usage: ts-node src/setup-workspace.ts <package-name>');
-    console.log('Example: ts-node src/setup-workspace.ts @monodog/dashboard');
-    process.exit(1);
-  }
-
-  const rootDir: string = process.cwd();
-  const sourcePath: string = path.join(rootDir, 'node_modules', packageName);
-
-  const folderName: string = packageName.replace('@', '').replace('/', '-');
-  const destinationPath: string = path.join(rootDir, 'packages', folderName);
-
-  console.log('\n--- Monorepo Workspace Conversion ---');
-  console.log(`Target Package: ${packageName}`);
-  console.log(`New Workspace:  packages/${folderName}`);
-  console.log('-----------------------------------');
-
-  if (!fs.existsSync(sourcePath)) {
-    console.error(`\n❌ Error: Source package not found at ${sourcePath}.`);
-    console.error("Please ensure the package is installed via 'pnpm install <package-name>' first.");
-    process.exit(1);
-  }
-
-  if (fs.existsSync(destinationPath)) {
-    console.error(`\n❌ Error: Destination directory already exists at ${destinationPath}.`);
-    console.error('Please manually remove it or rename it before running the script.');
-    process.exit(1);
-  }
-
-  const packagesDir: string = path.join(rootDir, 'packages');
-  if (!fs.existsSync(packagesDir)) {
-    fs.mkdirSync(packagesDir, { recursive: true });
-    console.log(`Created packages directory: ${packagesDir}`);
-  }
-
-  try {
-    console.log(`\nCopying files from ${sourcePath} to ${destinationPath}...`);
-
-    fs.cpSync(sourcePath, destinationPath, {
-      recursive: true,
-      dereference: true,
-      // explicit typing for the filter parameter
-      filter: (src: string): boolean => !src.includes('node_modules'),
-    });
-
-    console.log(`\n✅ Success! Contents of '${packageName}' copied to '${destinationPath}'`);
-
-    console.log('\n*** IMPORTANT NEXT STEPS (MANDATORY) ***');
-    console.log("1. Add the new workspace path to your root 'package.json':");
-    console.log(`   - Add "packages/${folderName}" to the 'workspaces' array.`);
-    console.log("2. Force pnpm to use the local workspace via 'overrides':");
-    console.log('   - Add the following to your root package.json:');
-    console.log(`   "pnpm": { "overrides": { "${packageName}": "file:./packages/${folderName}" } }`);
-    console.log("3. Run 'pnpm install' in the root to link the new workspace.");
-    console.log('\n--- DEVELOPMENT WARNING ---');
-    console.log('Remember: This copy contains the **compiled output**, not usually the full source code (e.g., missing original TypeScript/Sass/tests). To properly develop this workspace, you may need to replace the contents with the package\'s original source repository.');
-  } catch (err: unknown) {
-    const message = err instanceof Error ? err.message : String(err);
-    console.error(`\n❌ Failed to copy files: ${message}`);
-    process.exit(1);
-  }
-}
-
-copyPackageToWorkspace();

package/tsconfig.o.json

@@ -1,29 +0,0 @@
-{
-  // 1. Inherit rules from the shared monorepo configuration
-  "extends": "@lakinmindfire/tsconfig/node.json",
-
-  "compilerOptions": {
-    // 2. Explicitly set output directory
-    "outDir": "./dist",
-
-    // 3. Ensure compatibility: Set module type to CommonJS
-    "module": "CommonJS",
-    "moduleResolution": "node",
-
-    // 4. Common fixes for Node/TS projects
-    "esModuleInterop": true,
-    "allowSyntheticDefaultImports": true,
-    "verbatimModuleSyntax": false
-  },
-
-  // 5. CRITICAL: Include all source files in the current package directory
-  "include": [
-    "**/*.ts"
-  ],
-
-  // 6. Exclude generated files and dependencies
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}