@manojkmfsi/monodog 1.0.25 → 1.1.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @manojkmfsi/monodog@1.0.25 build /home/runner/work/monodog/monodog/packages/monoapp
+> @manojkmfsi/monodog@1.1.0 build /home/runner/work/monodog/monodog/packages/monoapp
 > rm -rf dist && tsc
 

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @manojkmfsi/monoapp
 
+## 1.1.0
+
+### Minor Changes
+
+- Added Swagger doc, updated req type for resfresh
+
 ## 1.0.25
 
 ### Patch Changes

package/dist/config/swagger-config.js

@@ -0,0 +1,345 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.swaggerOptions = exports.swaggerDefinition = void 0;
+/**
+ * Swagger API Documentation Configuration
+ * Defines OpenAPI specification for MonoDog API
+ */
+const config_loader_1 = require("../config-loader");
+exports.swaggerDefinition = {
+    openapi: '3.0.0',
+    info: {
+        title: 'MonoDog API',
+        version: '1.0.0',
+        description: 'Monorepo Analytics and Health Dashboard API',
+        contact: {
+            name: 'MonoDog Team',
+            url: 'https://github.com/mindfiredigital/monodog',
+        },
+        license: {
+            name: 'MIT',
+            url: 'https://opensource.org/licenses/MIT',
+        },
+    },
+    servers: [
+        {
+            url: `http://${config_loader_1.appConfig.server.host}:${config_loader_1.appConfig.server.port}/api`,
+            description: 'Development server',
+        },
+    ],
+    paths: {
+        '/packages': {
+            get: {
+                tags: ['Packages'],
+                summary: 'Get all packages',
+                operationId: 'getPackages',
+                responses: {
+                    '200': {
+                        description: 'List of packages',
+                        content: {
+                            'application/json': {
+                                schema: { type: 'array', items: { $ref: '#/components/schemas/Package' } },
+                            },
+                        },
+                    },
+                    '500': { description: 'Internal server error' },
+                },
+            },
+        },
+        '/packages/{name}': {
+            get: {
+                tags: ['Packages'],
+                summary: 'Get package by name',
+                operationId: 'getPackageByName',
+                parameters: [{ name: 'name', in: 'path', required: true, schema: { type: 'string' } }],
+                responses: {
+                    '200': {
+                        description: 'Package details',
+                        content: {
+                            'application/json': {
+                                schema: { $ref: '#/components/schemas/Package' },
+                            },
+                        },
+                    },
+                    '404': { description: 'Package not found' },
+                },
+            },
+        },
+        '/packages/refresh': {
+            post: {
+                tags: ['Packages'],
+                summary: 'Refresh packages',
+                operationId: 'refreshPackages',
+                responses: {
+                    '200': { description: 'Packages refreshed successfully' },
+                },
+            },
+        },
+        '/packages/update-config': {
+            put: {
+                tags: ['Packages'],
+                summary: 'Update package configuration',
+                operationId: 'updatePackageConfig',
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/Package' },
+                        },
+                    },
+                },
+                responses: {
+                    '200': { description: 'Package configuration updated successfully' },
+                    '400': { description: 'Invalid request' },
+                    '404': { description: 'Package not found' },
+                },
+            },
+        },
+        '/health/packages': {
+            get: {
+                tags: ['Health'],
+                summary: 'Get packages health status',
+                operationId: 'getPackagesHealth',
+                responses: {
+                    '200': {
+                        description: 'Health status of all packages',
+                        content: {
+                            'application/json': {
+                                schema: { type: 'array', items: { $ref: '#/components/schemas/PackageHealth' } },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        '/health/refresh': {
+            post: {
+                tags: ['Health'],
+                summary: 'Refresh health status',
+                operationId: 'refreshHealth',
+                responses: {
+                    '200': { description: 'Health status refreshed successfully' },
+                },
+            },
+        },
+        '/commits/{packagePath}': {
+            get: {
+                tags: ['Commits'],
+                summary: 'Get commits for a package',
+                operationId: 'getCommits',
+                parameters: [{ name: 'packagePath', in: 'path', required: true, schema: { type: 'string' } }],
+                responses: {
+                    '200': {
+                        description: 'List of commits',
+                        content: {
+                            'application/json': {
+                                schema: { type: 'array', items: { $ref: '#/components/schemas/Commit' } },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        '/config/files': {
+            get: {
+                tags: ['Configuration'],
+                summary: 'Get configuration files',
+                operationId: 'getConfigFiles',
+                responses: {
+                    '200': {
+                        description: 'List of configuration files',
+                        content: {
+                            'application/json': {
+                                schema: { type: 'array', items: { $ref: '#/components/schemas/ConfigFile' } },
+                            },
+                        },
+                    },
+                },
+            },
+        },
+        '/config/files/{id}': {
+            put: {
+                tags: ['Configuration'],
+                summary: 'Update configuration file',
+                operationId: 'updateConfigFile',
+                parameters: [{ name: 'id', in: 'path', required: true, schema: { type: 'string' } }],
+                requestBody: {
+                    required: true,
+                    content: {
+                        'application/json': {
+                            schema: { $ref: '#/components/schemas/ConfigFile' },
+                        },
+                    },
+                },
+                responses: {
+                    '200': { description: 'Configuration file updated successfully' },
+                    '400': { description: 'Invalid request' },
+                    '404': { description: 'Configuration file not found' },
+                },
+            },
+        },
+    },
+    tags: [
+        {
+            name: 'Packages',
+            description: 'Package management and analysis endpoints',
+        },
+        {
+            name: 'Health',
+            description: 'Health monitoring and status endpoints',
+        },
+        {
+            name: 'Commits',
+            description: 'Git commit history and analysis endpoints',
+        },
+        {
+            name: 'Configuration',
+            description: 'Configuration file management endpoints',
+        },
+    ],
+    components: {
+        schemas: {
+            Package: {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string',
+                        description: 'Package name',
+                    },
+                    path: {
+                        type: 'string',
+                        description: 'Package path in monorepo',
+                    },
+                    version: {
+                        type: 'string',
+                        description: 'Package version',
+                    },
+                    size: {
+                        type: 'number',
+                        description: 'Package size in bytes',
+                    },
+                    dependencies: {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                        description: 'List of package dependencies',
+                    },
+                },
+            },
+            PackageHealth: {
+                type: 'object',
+                properties: {
+                    packageName: {
+                        type: 'string',
+                        description: 'Name of the package',
+                    },
+                    healthScore: {
+                        type: 'number',
+                        description: 'Health score (0-100)',
+                        minimum: 0,
+                        maximum: 100,
+                    },
+                    lintStatus: {
+                        type: 'string',
+                        enum: ['pass', 'warning', 'fail'],
+                        description: 'Linting status',
+                    },
+                    buildStatus: {
+                        type: 'string',
+                        enum: ['success', 'failed', 'pending'],
+                        description: 'Build status',
+                    },
+                    securityStatus: {
+                        type: 'string',
+                        enum: ['secure', 'warning', 'vulnerable'],
+                        description: 'Security status',
+                    },
+                    testCoverage: {
+                        type: 'number',
+                        description: 'Test coverage percentage',
+                    },
+                },
+            },
+            Commit: {
+                type: 'object',
+                properties: {
+                    hash: {
+                        type: 'string',
+                        description: 'Commit hash',
+                    },
+                    author: {
+                        type: 'string',
+                        description: 'Commit author',
+                    },
+                    message: {
+                        type: 'string',
+                        description: 'Commit message',
+                    },
+                    date: {
+                        type: 'string',
+                        format: 'date-time',
+                        description: 'Commit date',
+                    },
+                    filesChanged: {
+                        type: 'number',
+                        description: 'Number of files changed',
+                    },
+                },
+            },
+            ConfigFile: {
+                type: 'object',
+                properties: {
+                    id: {
+                        type: 'string',
+                        description: 'Configuration file ID',
+                    },
+                    name: {
+                        type: 'string',
+                        description: 'Configuration file name',
+                    },
+                    path: {
+                        type: 'string',
+                        description: 'Configuration file path',
+                    },
+                    content: {
+                        type: 'string',
+                        description: 'Configuration file content',
+                    },
+                },
+            },
+            Error: {
+                type: 'object',
+                properties: {
+                    error: {
+                        type: 'string',
+                        description: 'Error message',
+                    },
+                    message: {
+                        type: 'string',
+                        description: 'Detailed error message',
+                    },
+                    code: {
+                        type: 'string',
+                        description: 'Error code',
+                    },
+                },
+            },
+        },
+        responses: {
+            UnauthorizedError: {
+                description: 'Unauthorized access',
+            },
+            NotFoundError: {
+                description: 'Resource not found',
+            },
+            InternalServerError: {
+                description: 'Internal server error',
+            },
+        },
+    },
+};
+exports.swaggerOptions = {
+    definition: exports.swaggerDefinition,
+    apis: [], // Using only definition, no JSDoc file scanning
+};

package/dist/constants/index.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * Constants Index
+ * Centralized export of all application constants
+ */
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Port constants
+__exportStar(require("./port"), exports);
+// Security constants
+__exportStar(require("./security"), exports);
+// Middleware constants
+__exportStar(require("./middleware"), exports);

package/dist/constants/middleware.js

@@ -0,0 +1,71 @@
+"use strict";
+/**
+ * Middleware Constants
+ * Defines constants used across middleware modules
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MESSAGE_SHUTDOWN_INSTRUCTION = exports.ERROR_SERVING_INDEX_HTML = exports.CONTENT_TYPE_JAVASCRIPT = exports.MESSAGE_DASHBOARD_CLOSED = exports.MESSAGE_DASHBOARD_GRACEFUL_SHUTDOWN = exports.MESSAGE_SERVER_CLOSED = exports.MESSAGE_GRACEFUL_SHUTDOWN = exports.SUCCESS_DASHBOARD_START = exports.SUCCESS_SERVER_START = exports.ERROR_INTERNAL_SERVER = exports.ERROR_PERMISSION_DENIED = exports.ERROR_PORT_IN_USE = exports.HTTP_STATUS_BAD_REQUEST = exports.HTTP_STATUS_NOT_FOUND = exports.HTTP_STATUS_INTERNAL_SERVER_ERROR = void 0;
+/**
+ * HTTP status code for internal server error
+ */
+exports.HTTP_STATUS_INTERNAL_SERVER_ERROR = 500;
+/**
+ * HTTP status code for not found
+ */
+exports.HTTP_STATUS_NOT_FOUND = 404;
+/**
+ * HTTP status code for bad request
+ */
+exports.HTTP_STATUS_BAD_REQUEST = 400;
+/**
+ * Error message for port already in use
+ */
+const ERROR_PORT_IN_USE = (port) => `Port ${port} is already in use. Please specify a different port.`;
+exports.ERROR_PORT_IN_USE = ERROR_PORT_IN_USE;
+/**
+ * Error message for permission denied
+ */
+const ERROR_PERMISSION_DENIED = (port) => `Permission denied to listen on port ${port}. Use a port above 1024.`;
+exports.ERROR_PERMISSION_DENIED = ERROR_PERMISSION_DENIED;
+/**
+ * Error message for internal server error
+ */
+exports.ERROR_INTERNAL_SERVER = 'Internal server error';
+/**
+ * Success message for server start
+ */
+const SUCCESS_SERVER_START = (host, port) => `Backend server listening on http://${host}:${port}`;
+exports.SUCCESS_SERVER_START = SUCCESS_SERVER_START;
+/**
+ * Success message for dashboard start
+ */
+const SUCCESS_DASHBOARD_START = (host, port) => `Dashboard listening on http://${host}:${port}`;
+exports.SUCCESS_DASHBOARD_START = SUCCESS_DASHBOARD_START;
+/**
+ * Message for graceful shutdown
+ */
+exports.MESSAGE_GRACEFUL_SHUTDOWN = 'SIGTERM signal received: closing HTTP server';
+/**
+ * Message for server closed
+ */
+exports.MESSAGE_SERVER_CLOSED = 'HTTP server closed';
+/**
+ * Message for dashboard graceful shutdown
+ */
+exports.MESSAGE_DASHBOARD_GRACEFUL_SHUTDOWN = 'SIGTERM signal received: closing dashboard server';
+/**
+ * Message for dashboard closed
+ */
+exports.MESSAGE_DASHBOARD_CLOSED = 'Dashboard server closed';
+/**
+ * Content-Type header for JavaScript
+ */
+exports.CONTENT_TYPE_JAVASCRIPT = 'application/javascript';
+/**
+ * Error serving index.html message
+ */
+exports.ERROR_SERVING_INDEX_HTML = 'Error serving index.html:';
+/**
+ * Shutdown instruction message
+ */
+exports.MESSAGE_SHUTDOWN_INSTRUCTION = 'Press Ctrl+C to quit.';

package/dist/constants/port.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * Port Constants
+ * Defines valid port range and port-related configuration
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PORT_VALIDATION_ERROR_MESSAGE = exports.PORT_MAX = exports.PORT_MIN = void 0;
+/**
+ * Minimum valid port number (above system reserved ports)
+ */
+exports.PORT_MIN = 1024;
+/**
+ * Maximum valid port number
+ */
+exports.PORT_MAX = 65535;
+/**
+ * Port validation error message
+ */
+const PORT_VALIDATION_ERROR_MESSAGE = (min, max) => `Port must be between ${min} and ${max}`;
+exports.PORT_VALIDATION_ERROR_MESSAGE = PORT_VALIDATION_ERROR_MESSAGE;

package/dist/constants/security.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * Security Constants
+ * Defines security-related configuration and constants
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRAGMA_HEADER = exports.EXPIRES_HEADER = exports.STATIC_FILE_PATTERN = exports.CSP_DIRECTIVES = exports.HTTP_PROTOCOL = exports.WILDCARD_ADDRESS = exports.DEFAULT_LOCALHOST = exports.CACHE_CONTROL_STATIC = exports.CACHE_CONTROL_NO_CACHE = exports.BODY_PARSER_LIMIT = exports.CORS_ALLOWED_HEADERS = exports.CORS_API_METHODS = exports.RESPONSE_TIMEOUT = exports.REQUEST_TIMEOUT = void 0;
+/**
+ * Request timeout duration in milliseconds (30 seconds)
+ */
+exports.REQUEST_TIMEOUT = 30000;
+/**
+ * Response timeout duration in milliseconds (30 seconds)
+ */
+exports.RESPONSE_TIMEOUT = 30000;
+/**
+ * CORS methods allowed for API
+ */
+exports.CORS_API_METHODS = ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'];
+/**
+ * CORS headers allowed
+ */
+exports.CORS_ALLOWED_HEADERS = ['Content-Type', 'Authorization'];
+/**
+ * Body parser JSON size limit
+ */
+exports.BODY_PARSER_LIMIT = '1mb';
+/**
+ * Cache control header for no-cache responses
+ */
+exports.CACHE_CONTROL_NO_CACHE = 'private, no-cache, no-store, must-revalidate';
+/**
+ * Cache control header for static assets
+ */
+exports.CACHE_CONTROL_STATIC = '1d';
+/**
+ * Default localhost hostname
+ */
+exports.DEFAULT_LOCALHOST = 'localhost';
+/**
+ * Wildcard address for listening on all interfaces
+ */
+exports.WILDCARD_ADDRESS = '0.0.0.0';
+/**
+ * HTTP protocol prefix
+ */
+exports.HTTP_PROTOCOL = 'http://';
+/**
+ * CSP directives for Helmet
+ */
+exports.CSP_DIRECTIVES = {
+    defaultSrc: ["'self'"],
+    scriptSrc: ["'self'"],
+    imgSrc: ["'self'", 'data:', 'https:'],
+};
+/**
+ * Static file extensions pattern
+ */
+exports.STATIC_FILE_PATTERN = /(.ico|.js|.css|.jpg|.png|.map|.woff|.woff2|.ttf)$/i;
+/**
+ * Expires header for no-cache responses
+ */
+exports.EXPIRES_HEADER = '-1';
+/**
+ * Pragma header for no-cache responses
+ */
+exports.PRAGMA_HEADER = 'no-cache';

package/dist/middleware/dashboard-startup.js

@@ -13,16 +13,14 @@ const logger_1 = require("./logger");
 const config_loader_1 = require("../config-loader");
 const error_handler_1 = require("./error-handler");
 const security_1 = require("./security");
-// Security constants
-const PORT_MIN = 1024;
-const PORT_MAX = 65535;
+const constants_1 = require("../constants");
 /**
  * Validate port number
  */
 function validatePort(port) {
     const portNum = typeof port === 'string' ? parseInt(port, 10) : port;
-    if (isNaN(portNum) || portNum < PORT_MIN || portNum > PORT_MAX) {
-        throw new Error(`Port must be between ${PORT_MIN} and ${PORT_MAX}`);
+    if (isNaN(portNum) || portNum < constants_1.PORT_MIN || portNum > constants_1.PORT_MAX) {
+        throw new Error((0, constants_1.PORT_VALIDATION_ERROR_MESSAGE)(constants_1.PORT_MIN, constants_1.PORT_MAX));
     }
     return portNum;
 }
@@ -42,27 +40,26 @@ function createDashboardApp() {
     app.use((0, security_1.createDashboardCorsMiddleware)());
     // Environment config endpoint
     app.get('/env-config.js', (_req, res) => {
-        res.setHeader('Content-Type', 'application/javascript');
-        res.setHeader('Cache-Control', 'private, no-cache, no-store, must-revalidate');
+        res.setHeader('Content-Type', constants_1.CONTENT_TYPE_JAVASCRIPT);
+        res.setHeader('Cache-Control', constants_1.CACHE_CONTROL_NO_CACHE);
         res.send(`window.ENV = { API_URL: "${apiUrl}" };`);
     });
     // Request logging
     app.use(logger_1.httpLogger);
-    // app.use(requestLogger);
     // SPA routing: serve index.html for non-static routes
     app.use((_req, _res, next) => {
-        if (/(.ico|.js|.css|.jpg|.png|.map|.woff|.woff2|.ttf)$/i.test(_req.path)) {
+        if (constants_1.STATIC_FILE_PATTERN.test(_req.path)) {
             next();
         }
         else {
-            _res.header('Cache-Control', 'private, no-cache, no-store, must-revalidate');
-            _res.header('Expires', '-1');
-            _res.header('Pragma', 'no-cache');
+            _res.header('Cache-Control', constants_1.CACHE_CONTROL_NO_CACHE);
+            _res.header('Expires', constants_1.EXPIRES_HEADER);
+            _res.header('Pragma', constants_1.PRAGMA_HEADER);
             _res.sendFile('index.html', {
                 root: path_1.default.resolve(__dirname, '..', '..', 'monodog-dashboard', 'dist'),
             }, (err) => {
                 if (err) {
-                    logger_1.AppLogger.error('Error serving index.html:', err);
+                    logger_1.AppLogger.error(constants_1.ERROR_SERVING_INDEX_HTML, err);
                     _res.status(500).json({ error: 'Internal server error' });
                 }
             });
@@ -90,16 +87,16 @@ function serveDashboard(rootPath) {
         const validatedPort = validatePort(port);
         const app = createDashboardApp();
         const server = app.listen(validatedPort, host, () => {
-            console.log(`Dashboard listening on http://${host}:${validatedPort}`);
+            console.log((0, constants_1.SUCCESS_DASHBOARD_START)(host, validatedPort));
             console.log('Press Ctrl+C to quit.');
         });
         server.on('error', (err) => {
             if (err.code === 'EADDRINUSE') {
-                logger_1.AppLogger.error(`Port ${validatedPort} is already in use.`, err);
+                logger_1.AppLogger.error((0, constants_1.ERROR_PORT_IN_USE)(validatedPort), err);
                 process.exit(1);
             }
             else if (err.code === 'EACCES') {
-                logger_1.AppLogger.error(`Permission denied to listen on port ${validatedPort}.`, err);
+                logger_1.AppLogger.error((0, constants_1.ERROR_PERMISSION_DENIED)(validatedPort), err);
                 process.exit(1);
             }
             else {
@@ -109,9 +106,9 @@ function serveDashboard(rootPath) {
         });
         // Graceful shutdown
         process.on('SIGTERM', () => {
-            logger_1.AppLogger.info('SIGTERM signal received: closing dashboard server');
+            logger_1.AppLogger.info(constants_1.MESSAGE_DASHBOARD_GRACEFUL_SHUTDOWN);
             server.close(() => {
-                logger_1.AppLogger.info('Dashboard server closed');
+                logger_1.AppLogger.info(constants_1.MESSAGE_DASHBOARD_CLOSED);
                 process.exit(0);
             });
         });