feat(monodog): merge pull request #15 from mindfiredigital/installable-package

feat(monodog): Updated project structure, improve security, added swagger and morgan, code cleanup

Author: anandmindfire

.github/ISSUE_TEMPLATE/config.yml

@@ -2,4 +2,4 @@ blank_issues_enabled: true
 contact_links:
   - name: MonoDog
     url: https://mindfiredigital.github.io/MonoDog/
-    about: MonoDog is a dashboard provides visual management and monitoring for packages in monorepos using pnpm, Turborepo, and Nx, with automated CI/CD integration, semantic versioning, and development workflow optimization.
+    about: MonoDog is a dashboard provides visual management and monitoring for packages in monorepos using pnpm with automated CI/CD integration, semantic versioning, and development workflow optimization.

.github/changeset-autogenerate.mjs

@@ -21,7 +21,7 @@ let packageScope = null;
 let changeType = null;
 let description = null;
 
-    // 1. Check for Major Change using the "!" subject indicator
+// Check for Major Change using the "!" subject indicator
 if (commitPatterns.major.test(commitMessage)) {
   const scope = commitMessage.match(commitPatterns.major)?.[2];
   if (validScopes.includes(scope)) {
@@ -63,9 +63,9 @@ if (packageScope) {
 
   // Write to a changeset file
   fs.writeFileSync(`.changeset/auto-${Date.now()}.md`, changesetContent);
-  console.log(`✅ Changeset file created for package: ${packageName}`);
+  console.log(`Changeset file created for package: ${packageName}`);
 } else {
   console.log(
-    '⚠️ No valid package scope found in commit message. Valid scopes are: monodog'
+    'No valid package scope found in commit message. Valid scopes are: monodog'
   );
 }

documentation/docs/api-reference/config.md

@@ -14,6 +14,7 @@ GET /api/config/files
 ```
 
 Returns all configuration files found in the monorepo (tsconfig, eslintrc, etc.).
+
 Response:
 ```json
 {
@@ -44,4 +45,33 @@ Response:
     ...
   ]
 }
-```
+```
+
+## Update Configuration File
+
+```bash
+PUT /api/config/files/ID
+```
+ID is the path of configuration file.
+
+Update content of the configuration file.
+
+Response:
+```json
+{
+  "success": true,
+  "file":
+    {
+      "id": "/packages/packageB/tsconfig.json",
+      "name": "tsconfig.json",
+      "path": "/packages/packageB/tsconfig.json",
+      "type": "json",
+      "content": "{\n  \"files\": [],\n  \"references\": [\n    { \"path\": \"./tsconfig.app.json\" },\n    { \"path\": \"./tsconfig.node.json\" }\n  ]\n}\n",
+      "size": 119,
+      "lastModified": "2020-12-05T08:59:38.762Z",
+      "hasSecrets": false,
+      "isEditable": true
+    },
+  "message": "File saved successfully"
+}
+```

documentation/docs/api-reference/overview.md

@@ -3,37 +3,37 @@ sidebar_position: 1
 title: API Overview
 ---
 
-# API Reference Overview  
+# API Reference Overview
 
-Monodog has a complete REST API that lets developers access all monorepo data using the HTTP protocol.  
+Monodog has a complete REST API that lets developers access all monorepo data using the HTTP protocol.
 
-## Base URL  
+## Base URL
 
 ```
 http://localhost:8999/api
-```  
-
-## Endpoints  
+```
 
-### Packages  
-- `GET /packages` - List all packages  
-- `GET /packages/{name}` - Get package details  
-- `GET /packages/refresh` - Refresh package data  
+## Endpoints
 
-### Health  
-- `GET /health/packages` - Get health metrics for all packages  
-- `POST /health/refresh` - Refresh health data  
+### Packages
+- `GET /packages` - List all packages
+- `GET /packages/{NAME}` - Get package details
+- `POST /packages/refresh` - Refresh package data
 
-### Commits  
-- `GET /commits/{packagePath}` - Get commit history  
+### Health
+- `GET /health/packages` - Get health metrics for all packages
+- `POST /health/refresh` - Refresh health data
 
-### Config  
-- `GET /config/files` - Get configuration files  
+### Commits
+- `GET /commits/{PACKAGE_PATH}` - Get commit history
 
+### Config
+- `GET /config/files` - Get configuration files
+- `PUT /config/files/{ID}` - Get configuration files
 
-## Next Steps  
+## Next Steps
 
-- [Packages Endpoint](/api-reference/packages)  
-- [Health Endpoint](/api-reference/health)  
-- [Commits Endpoint](/api-reference/commits)  
-- [Config Endpoint](/api-reference/config)  
+- [Packages Endpoint](/api-reference/packages)
+- [Health Endpoint](/api-reference/health)
+- [Commits Endpoint](/api-reference/commits)
+- [Config Endpoint](/api-reference/config)

documentation/docs/api-reference/packages.md

@@ -50,7 +50,7 @@ Response:
         "vue-tsc": "^2.0.29"
       },
       "peerDependencies": {
-        
+
       }
     },
     ...
@@ -68,8 +68,6 @@ PACKAGE_NAME is the name of package
 Response:
 ```json
 {
-  "packages": [
-     {
       "name": "package-name",
       "version": "1.0.3",
       "type": "lib",
@@ -102,7 +100,7 @@ Response:
         "vue-tsc": "^2.0.29"
       },
       "peerDependencies": {
-        
+
       },
       "dependenciesInfo": [
         {
@@ -138,24 +136,65 @@ Response:
         "packageDependencies": "",
         "createdAt": "2020-12-05T14:16:54.484Z",
         "updatedAt": "2020-12-09T14:35:49.183Z"
+    }
+}
+```
+
+## Update Package Configuration
+
+```bash
+PUT /api/packages/update-config
+```
+Response:
+```json
+{
+  "success": true,
+  "message": "Package configuration updated successfully",
+     {
+      "name": "package-name",
+      "version": "1.0.3",
+      "type": "lib",
+      "createdAt": "2020-12-05T10:43:14.208Z",
+      "lastUpdated": "2020-12-05T10:43:14.208Z",
+      "dependencies": {
+        "@org/package2": "workspace:*",
+        "vue": "^3.5.21"
       },
-      "successRate": 50,
-      "averageDuration": 1050000,
-      "lastCommit": "abc1234",
-      "lastCommitDate": "2020-12-09T14:08:18.949Z",
-      "branch": "main",
-      "isHealthy": false,
-      "issues": []
+      "maintainers": [],
+      "path": "path-to-package",
+      "description": "my package description",
+      "license": "MIT",
+      "repository": {
+        "type": "git",
+        "url": "http://github.com/reponame.git",
+        "directory": "package/"
+      },
+      "scripts": {
+        "dev": "vite",
+        "build": "vite build",
+        "build:check": "vue-tsc && vite build",
+        "preview": "vite preview"
+      },
+      "devDependencies": {
+        "@types/node": "^24.3.1",
+        "@vitejs/plugin-vue": "^4.4.0",
+        "typescript": "^5.7.2",
+        "vite": "^4.4.5",
+        "vue-tsc": "^2.0.29"
+      },
+      "peerDependencies": {
+
+      }
     },
-    ...
-  ],
+    "preservedFields": true
 }
 ```
 
+
 ## Refresh Packages
 
 ```bash
-GET /api/packages/refresh
+POST /api/packages/refresh
 ```
 Response:
 ```json
@@ -194,7 +233,7 @@ Response:
         "vue-tsc": "^2.0.29"
       },
       "peerDependencies": {
-        
+
       }
     },
     ...

documentation/docs/features/package-scanning.md

@@ -22,7 +22,7 @@ Package scanning is the core of Monodog. It:
 
 ### 1. Workspace Detection
 
-Monodog first identifies your monorepo type by looking for `package.json` with `"workspaces"` for npm workspaces.
+Monodog first identifies your packages by looking for `"workspaces"` in `package.json` or else `"packages"` in `pnpm-workspaces.yaml`.
 
 ### 2. Package Discovery
 
@@ -80,7 +80,7 @@ Monodog examines:
 Start a scan via API:
 
 ```bash
-curl -X GET http://localhost:8999/api/packages/refresh
+curl -X POST http://localhost:8999/api/packages/refresh
 ```
 
 ## Accessing Scan Results
@@ -107,7 +107,7 @@ Check your workspace configuration and included paths:
 
 ```bash
 # Verify config
-cat pnpm-workspace.yaml 
+cat pnpm-workspace.yaml
 ```
 
 ### Missing Dependencies
@@ -123,4 +123,4 @@ cat packages/my-package/package.json | grep -A 10 dependencies
 
 - [Health Monitoring](/features/health-monitoring)
 - [Dependency Analysis](/features/dependency-analysis)
-- [API Reference - Packages](/api-reference/packages)
+- [API Reference - Packages](/api-reference/packages)

documentation/docs/getting-started/quick-start.md

@@ -12,7 +12,7 @@ Monodog can be started working within your monorepo in less than 5 minutes.
 In your monorepo root directory, run:
 
 ```bash
-pnpm dlx  @mindfiredigital/monodog
+pnpm dlx @mindfiredigital/monodog
 ```
 the installation script will create a new directory on project root: `monodog`
 
@@ -32,13 +32,13 @@ npm run serve
 
 You should see output like:
 ```
-[monodog] Checking for monodog-conf.json
+[monodog] Checking for monodog-config.json
 Starting Monodog API server...
 Analyzing monorepo at root:
 Serving static files from:
-App listening on 0.0.0.0:3010
+App listening on localhost:3010
 [Database] Total packages found: 15
-🚀 Backend server running on http://0.0.0.0:8999
+🚀 Backend server running on http://localhost:8999
 ```
 
 ## Step 3: Access the Dashboard
@@ -96,13 +96,13 @@ If Monodog is installed, you can explore:
 
 ### Port 3010 Already in Use
 
-If port 3010 is already in use, specify a different port in monodog-conf.json:
+If port 3010 is already in use, specify a different port in monodog-config.json:
 ```
   "dashboard": {
     "port": 3011
   }
 ```
-If port 8999 is already in use, specify a different port in monodog-conf.json:
+If port 8999 is already in use, specify a different port in monodog-config.json:
 ```
   "server": {
     "port": 8990

documentation/docs/installation/configure-monorepo.md

@@ -9,8 +9,6 @@ Once Monodog is installed, configure it for your monorepo setup.
 
 ## Supported Workspace Types
 
-Monodog supports all major monorepo tools:
-
 ### pnpm Workspaces (Recommended)
 
 If using pnpm workspaces, Monodog will auto-detect:
@@ -125,7 +123,7 @@ In order to install node packages in non-default locations, you will then need t
 ```
 ### Configure Workspaces Scanning
 
-In order to scan only limited workspaces, you will then need to configure the `monodog-conf.json` file accordingly:
+In order to scan only limited workspaces, you will then need to configure the `monodog-config.json` file accordingly:
 ```json
 {
   "workspaces": [

documentation/docs/installation/first-run.md

@@ -24,13 +24,13 @@ npm run serve
 You should see output like:
 
 ```
-[monodog] Checking for monodog-conf.json
+[monodog] Checking for monodog-config.json
 Starting Monodog API server...
 Analyzing monorepo at root:
 Serving static files from:
-App listening on 0.0.0.0:3010
+App listening on localhost:3010
 [Database] Total packages found: 15
-🚀 Backend server running on http://0.0.0.0:8999
+Backend server running on http://localhost:8999
 ```
 
 ## Access the dashboard
@@ -129,7 +129,7 @@ This might take a few minutes depending on your monorepo size.
 
 ### Run on Custom Port
 
-To run app on custom port update monodog-conf.json
+To run app on custom port update monodog-config.json
 
 ````json
   "server": {

documentation/docs/installation/install-npm.md

@@ -38,14 +38,12 @@ monodog/
 ├── dist/                    # Compiled JavaScript
 ├── monodog-dashboard/       # Frontend
 │   ├── dist                 # Compiled JavaScript
-├── src/                     # TypeScript source
 ├── node_modules/            # Dependencies
 ├── prisma/
-│   ├── schema.prisma        # Database schema
+│   ├── schema/              # Database schema and database
 │   ├── migrations/          # Database migrations
-│   └── monodog.db          # SQLite database
 ├── package.json
-└── tsconfig.json
+└── monodog-config.json      # Customize port, host and scan workspaces
 ```