npm - @digitaldefiance/node-express-suite - Versions diffs - 3.11.32 → 3.12.0 - Mend

@digitaldefiance/node-express-suite 3.11.32 → 3.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (146) hide show

package/README.md +858 -0
package/package.json +1 -1
package/src/controllers/openapi.d.ts +67 -0
package/src/controllers/openapi.d.ts.map +1 -0
package/src/controllers/openapi.js +89 -0
package/src/controllers/openapi.js.map +1 -0
package/src/decorators/auth.d.ts +128 -0
package/src/decorators/auth.d.ts.map +1 -0
package/src/decorators/auth.js +230 -0
package/src/decorators/auth.js.map +1 -0
package/src/decorators/base-controller.d.ts +144 -6
package/src/decorators/base-controller.d.ts.map +1 -1
package/src/decorators/base-controller.js +487 -31
package/src/decorators/base-controller.js.map +1 -1
package/src/decorators/controller.d.ts +63 -7
package/src/decorators/controller.d.ts.map +1 -1
package/src/decorators/controller.js +70 -39
package/src/decorators/controller.js.map +1 -1
package/src/decorators/handler-args.d.ts +68 -0
package/src/decorators/handler-args.d.ts.map +1 -0
package/src/decorators/handler-args.js +83 -0
package/src/decorators/handler-args.js.map +1 -0
package/src/decorators/http-methods.d.ts +143 -0
package/src/decorators/http-methods.d.ts.map +1 -0
package/src/decorators/http-methods.js +265 -0
package/src/decorators/http-methods.js.map +1 -0
package/src/decorators/index.d.ts +22 -0
package/src/decorators/index.d.ts.map +1 -1
package/src/decorators/index.js +56 -0
package/src/decorators/index.js.map +1 -1
package/src/decorators/lifecycle.d.ts +248 -0
package/src/decorators/lifecycle.d.ts.map +1 -0
package/src/decorators/lifecycle.js +301 -0
package/src/decorators/lifecycle.js.map +1 -0
package/src/decorators/metadata-collector.d.ts +175 -0
package/src/decorators/metadata-collector.d.ts.map +1 -0
package/src/decorators/metadata-collector.js +272 -0
package/src/decorators/metadata-collector.js.map +1 -0
package/src/decorators/metadata-keys.d.ts +121 -0
package/src/decorators/metadata-keys.d.ts.map +1 -0
package/src/decorators/metadata-keys.js +116 -0
package/src/decorators/metadata-keys.js.map +1 -0
package/src/decorators/middleware.d.ts +181 -0
package/src/decorators/middleware.d.ts.map +1 -0
package/src/decorators/middleware.js +400 -0
package/src/decorators/middleware.js.map +1 -0
package/src/decorators/openapi-params.d.ts +192 -0
package/src/decorators/openapi-params.d.ts.map +1 -0
package/src/decorators/openapi-params.js +332 -0
package/src/decorators/openapi-params.js.map +1 -0
package/src/decorators/openapi.d.ts +201 -0
package/src/decorators/openapi.d.ts.map +1 -0
package/src/decorators/openapi.js +334 -0
package/src/decorators/openapi.js.map +1 -0
package/src/decorators/params.d.ts +217 -0
package/src/decorators/params.d.ts.map +1 -0
package/src/decorators/params.js +323 -0
package/src/decorators/params.js.map +1 -0
package/src/decorators/response.d.ts +200 -0
package/src/decorators/response.d.ts.map +1 -0
package/src/decorators/response.js +315 -0
package/src/decorators/response.js.map +1 -0
package/src/decorators/schema.d.ts +99 -0
package/src/decorators/schema.d.ts.map +1 -0
package/src/decorators/schema.js +329 -0
package/src/decorators/schema.js.map +1 -0
package/src/decorators/transaction.d.ts +69 -0
package/src/decorators/transaction.d.ts.map +1 -0
package/src/decorators/transaction.js +80 -0
package/src/decorators/transaction.js.map +1 -0
package/src/decorators/validation.d.ts +188 -0
package/src/decorators/validation.d.ts.map +1 -0
package/src/decorators/validation.js +269 -0
package/src/decorators/validation.js.map +1 -0
package/src/decorators/zod-validation.d.ts +164 -4
package/src/decorators/zod-validation.d.ts.map +1 -1
package/src/decorators/zod-validation.js +692 -13
package/src/decorators/zod-validation.js.map +1 -1
package/src/index.d.ts +1 -0
package/src/index.d.ts.map +1 -1
package/src/index.js +1 -0
package/src/index.js.map +1 -1
package/src/interfaces/openApi/decoratorOptions.d.ts +760 -0
package/src/interfaces/openApi/decoratorOptions.d.ts.map +1 -0
package/src/interfaces/openApi/decoratorOptions.js +734 -0
package/src/interfaces/openApi/decoratorOptions.js.map +1 -0
package/src/interfaces/openApi/index.d.ts +1 -0
package/src/interfaces/openApi/index.d.ts.map +1 -1
package/src/interfaces/openApi/index.js +23 -0
package/src/interfaces/openApi/index.js.map +1 -1
package/src/interfaces/openApi/parameter.d.ts +2 -0
package/src/interfaces/openApi/parameter.d.ts.map +1 -1
package/src/interfaces/openApi/parameter.js +3 -1
package/src/interfaces/openApi/parameter.js.map +1 -1
package/src/interfaces/openApi/parameterSchema.d.ts +2 -0
package/src/interfaces/openApi/parameterSchema.d.ts.map +1 -1
package/src/interfaces/openApi/parameterSchema.js +3 -0
package/src/interfaces/openApi/parameterSchema.js.map +1 -1
package/src/openapi/builder.d.ts +249 -0
package/src/openapi/builder.d.ts.map +1 -0
package/src/openapi/builder.js +352 -0
package/src/openapi/builder.js.map +1 -0
package/src/openapi/controller.d.ts +153 -0
package/src/openapi/controller.d.ts.map +1 -0
package/src/openapi/controller.js +331 -0
package/src/openapi/controller.js.map +1 -0
package/src/openapi/index.d.ts +12 -0
package/src/openapi/index.d.ts.map +1 -0
package/src/openapi/index.js +20 -0
package/src/openapi/index.js.map +1 -0
package/src/openapi/markdown-generator.d.ts +52 -0
package/src/openapi/markdown-generator.d.ts.map +1 -0
package/src/openapi/markdown-generator.js +569 -0
package/src/openapi/markdown-generator.js.map +1 -0
package/src/openapi/middleware/index.d.ts +9 -0
package/src/openapi/middleware/index.d.ts.map +1 -0
package/src/openapi/middleware/index.js +15 -0
package/src/openapi/middleware/index.js.map +1 -0
package/src/openapi/middleware/redoc.d.ts +314 -0
package/src/openapi/middleware/redoc.d.ts.map +1 -0
package/src/openapi/middleware/redoc.js +181 -0
package/src/openapi/middleware/redoc.js.map +1 -0
package/src/openapi/middleware/swagger-ui.d.ts +123 -0
package/src/openapi/middleware/swagger-ui.d.ts.map +1 -0
package/src/openapi/middleware/swagger-ui.js +227 -0
package/src/openapi/middleware/swagger-ui.js.map +1 -0
package/src/openapi/schemas.d.ts +170 -0
package/src/openapi/schemas.d.ts.map +1 -0
package/src/openapi/schemas.js +340 -0
package/src/openapi/schemas.js.map +1 -0
package/src/registry/controller-registry.d.ts +78 -0
package/src/registry/controller-registry.d.ts.map +1 -0
package/src/registry/controller-registry.js +86 -0
package/src/registry/controller-registry.js.map +1 -0
package/src/registry/index.d.ts +2 -0
package/src/registry/index.d.ts.map +1 -1
package/src/registry/index.js +3 -1
package/src/registry/index.js.map +1 -1
package/src/routers/api.d.ts +2 -1
package/src/routers/api.d.ts.map +1 -1
package/src/routers/api.js +7 -1
package/src/routers/api.js.map +1 -1
package/src/types.d.ts +1 -0
package/src/types.d.ts.map +1 -1
package/src/types.js +1 -0
package/src/types.js.map +1 -1

package/src/openapi/middleware/swagger-ui.js ADDED Viewed

@@ -0,0 +1,227 @@
+"use strict";
+/**
+ * @fileoverview Swagger UI middleware for serving interactive API documentation.
+ * Provides a configurable middleware that serves Swagger UI with the OpenAPI spec.
+ * @module openapi/middleware/swagger-ui
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSwaggerUIHtml = generateSwaggerUIHtml;
+exports.SwaggerUIMiddleware = SwaggerUIMiddleware;
+exports.createSwaggerUIHandler = createSwaggerUIHandler;
+const express_1 = require("express");
+/**
+ * Default Swagger UI CDN URLs.
+ */
+const SWAGGER_UI_CDN = {
+    css: 'https://unpkg.com/swagger-ui-dist@5/swagger-ui.css',
+    bundle: 'https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js',
+    standalonePreset: 'https://unpkg.com/swagger-ui-dist@5/swagger-ui-standalone-preset.js',
+    favicon: 'https://unpkg.com/swagger-ui-dist@5/favicon-32x32.png',
+};
+/**
+ * Generates the HTML page for Swagger UI.
+ * @param spec - The OpenAPI specification object
+ * @param options - Swagger UI customization options
+ * @returns HTML string for the Swagger UI page
+ */
+function generateSwaggerUIHtml(spec, options = {}) {
+    const title = options.siteTitle ?? options.title ?? spec.info.title;
+    const favicon = options.favicon ?? SWAGGER_UI_CDN.favicon;
+    const showTopBar = options.showTopBar !== false;
+    // Build Swagger UI config
+    const swaggerConfig = {
+        spec,
+        dom_id: '#swagger-ui',
+        presets: ['SwaggerUIBundle.presets.apis', 'SwaggerUIStandalonePreset'],
+        plugins: ['SwaggerUIBundle.plugins.DownloadUrl'],
+        layout: 'StandaloneLayout',
+        ...options.swaggerOptions,
+    };
+    // Convert config to JavaScript object literal (not JSON)
+    const configString = objectToJsLiteral(swaggerConfig);
+    // Build custom CSS
+    let customStyles = '';
+    if (!showTopBar) {
+        customStyles += '.topbar { display: none; }';
+    }
+    if (options.customCss) {
+        customStyles += options.customCss;
+    }
+    return `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${escapeHtml(title)}</title>
+  <link rel="icon" type="image/png" href="${escapeHtml(favicon)}">
+  <link rel="stylesheet" href="${SWAGGER_UI_CDN.css}">
+  ${options.customCssUrl ? `<link rel="stylesheet" href="${escapeHtml(options.customCssUrl)}">` : ''}
+  ${customStyles ? `<style>${customStyles}</style>` : ''}
+</head>
+<body>
+  <div id="swagger-ui"></div>
+  <script src="${SWAGGER_UI_CDN.bundle}"></script>
+  <script src="${SWAGGER_UI_CDN.standalonePreset}"></script>
+  ${options.customJsUrl ? `<script src="${escapeHtml(options.customJsUrl)}"></script>` : ''}
+  <script>
+    window.onload = function() {
+      window.ui = SwaggerUIBundle(${configString});
+    };
+  </script>
+  ${options.customJs ? `<script>${options.customJs}</script>` : ''}
+</body>
+</html>`;
+}
+/**
+ * Converts a JavaScript object to a JS object literal string.
+ * Handles special cases like function references (presets, plugins).
+ * @param obj - Object to convert
+ * @returns JavaScript object literal string
+ */
+function objectToJsLiteral(obj) {
+    const entries = Object.entries(obj).map(([key, value]) => {
+        const formattedValue = formatValue(value);
+        return `${key}: ${formattedValue}`;
+    });
+    return `{\n      ${entries.join(',\n      ')}\n    }`;
+}
+/**
+ * Formats a value for JavaScript object literal.
+ * @param value - Value to format
+ * @returns Formatted string representation
+ */
+function formatValue(value) {
+    if (value === null || value === undefined) {
+        return 'null';
+    }
+    if (typeof value === 'string') {
+        // Check if it's a reference to a global (like SwaggerUIBundle.presets.apis)
+        if (value.startsWith('SwaggerUIBundle.') ||
+            value.startsWith('SwaggerUIStandalonePreset')) {
+            return value;
+        }
+        return JSON.stringify(value);
+    }
+    if (typeof value === 'number' || typeof value === 'boolean') {
+        return String(value);
+    }
+    if (Array.isArray(value)) {
+        const items = value.map((item) => formatValue(item));
+        return `[${items.join(', ')}]`;
+    }
+    if (typeof value === 'object') {
+        // For nested objects (like spec), use JSON.stringify
+        return JSON.stringify(value);
+    }
+    return String(value);
+}
+/**
+ * Escapes HTML special characters to prevent XSS.
+ * @param str - String to escape
+ * @returns Escaped string
+ */
+function escapeHtml(str) {
+    const htmlEscapes = {
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+        '"': '&quot;',
+        "'": '&#39;',
+    };
+    return str.replace(/[&<>"']/g, (char) => htmlEscapes[char]);
+}
+/**
+ * Creates Express middleware that serves Swagger UI.
+ *
+ * @param specOrProvider - OpenAPI spec object or a function that returns the spec
+ * @param options - Swagger UI customization options
+ * @returns Express Router configured to serve Swagger UI
+ *
+ * @example
+ * ```typescript
+ * // With static spec
+ * const spec = openApiBuilder.build();
+ * app.use('/docs', SwaggerUIMiddleware(spec));
+ *
+ * // With dynamic spec provider
+ * app.use('/docs', SwaggerUIMiddleware(() => openApiBuilder.build()));
+ *
+ * // With customization
+ * app.use('/docs', SwaggerUIMiddleware(spec, {
+ *   title: 'My API Documentation',
+ *   customCss: '.topbar { background-color: #333; }',
+ *   swaggerOptions: {
+ *     docExpansion: 'list',
+ *     filter: true,
+ *     persistAuthorization: true
+ *   }
+ * }));
+ * ```
+ */
+function SwaggerUIMiddleware(specOrProvider, options = {}) {
+    const router = (0, express_1.Router)();
+    // Determine if we have a static spec or a provider function
+    const isProvider = typeof specOrProvider === 'function';
+    /**
+     * Handler for serving the Swagger UI HTML page.
+     */
+    const serveSwaggerUI = async (_req, res) => {
+        try {
+            const spec = isProvider
+                ? await specOrProvider()
+                : specOrProvider;
+            const html = generateSwaggerUIHtml(spec, options);
+            res.type('html').send(html);
+        }
+        catch (error) {
+            res.status(500).json({
+                error: {
+                    code: 'SWAGGER_UI_ERROR',
+                    message: error instanceof Error
+                        ? error.message
+                        : 'Failed to generate Swagger UI',
+                },
+            });
+        }
+    };
+    // Serve Swagger UI at root and /index.html
+    router.get('/', serveSwaggerUI);
+    router.get('/index.html', serveSwaggerUI);
+    return router;
+}
+/**
+ * Creates a simple middleware function (not a router) for serving Swagger UI.
+ * Useful when you need more control over routing.
+ *
+ * @param specOrProvider - OpenAPI spec object or a function that returns the spec
+ * @param options - Swagger UI customization options
+ * @returns Express RequestHandler
+ *
+ * @example
+ * ```typescript
+ * app.get('/docs', createSwaggerUIHandler(spec));
+ * ```
+ */
+function createSwaggerUIHandler(specOrProvider, options = {}) {
+    const isProvider = typeof specOrProvider === 'function';
+    return async (_req, res) => {
+        try {
+            const spec = isProvider
+                ? await specOrProvider()
+                : specOrProvider;
+            const html = generateSwaggerUIHtml(spec, options);
+            res.type('html').send(html);
+        }
+        catch (error) {
+            res.status(500).json({
+                error: {
+                    code: 'SWAGGER_UI_ERROR',
+                    message: error instanceof Error
+                        ? error.message
+                        : 'Failed to generate Swagger UI',
+                },
+            });
+        }
+    };
+}
+//# sourceMappingURL=swagger-ui.js.map

package/src/openapi/middleware/swagger-ui.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"swagger-ui.js","sourceRoot":"","sources":["../../../../../../packages/digitaldefiance-node-express-suite/src/openapi/middleware/swagger-ui.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA4FH,sDAsDC;AAwGD,kDAyCC;AAeD,wDA0BC;AA1UD,qCAAoE;AAyEpE;;GAEG;AACH,MAAM,cAAc,GAAG;IACrB,GAAG,EAAE,oDAAoD;IACzD,MAAM,EAAE,0DAA0D;IAClE,gBAAgB,EACd,qEAAqE;IACvE,OAAO,EAAE,uDAAuD;CACjE,CAAC;AAEF;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,IAAiB,EACjB,UAA4B,EAAE;IAE9B,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACpE,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC;IAC1D,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,KAAK,KAAK,CAAC;IAEhD,0BAA0B;IAC1B,MAAM,aAAa,GAA4B;QAC7C,IAAI;QACJ,MAAM,EAAE,aAAa;QACrB,OAAO,EAAE,CAAC,8BAA8B,EAAE,2BAA2B,CAAC;QACtE,OAAO,EAAE,CAAC,qCAAqC,CAAC;QAChD,MAAM,EAAE,kBAAkB;QAC1B,GAAG,OAAO,CAAC,cAAc;KAC1B,CAAC;IAEF,yDAAyD;IACzD,MAAM,YAAY,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IAEtD,mBAAmB;IACnB,IAAI,YAAY,GAAG,EAAE,CAAC;IACtB,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,YAAY,IAAI,4BAA4B,CAAC;IAC/C,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC;IACpC,CAAC;IAED,OAAO;;;;;WAKE,UAAU,CAAC,KAAK,CAAC;4CACgB,UAAU,CAAC,OAAO,CAAC;iCAC9B,cAAc,CAAC,GAAG;IAC/C,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,gCAAgC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;IAChG,YAAY,CAAC,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,CAAC,CAAC,EAAE;;;;iBAIvC,cAAc,CAAC,MAAM;iBACrB,cAAc,CAAC,gBAAgB;IAC5C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,gBAAgB,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;;;oCAGvD,YAAY;;;IAG5C,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,QAAQ,WAAW,CAAC,CAAC,CAAC,EAAE;;QAE1D,CAAC;AACT,CAAC;AAED;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,GAA4B;IACrD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACvD,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;QAC1C,OAAO,GAAG,GAAG,KAAK,cAAc,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC;IACH,OAAO,YAAY,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,4EAA4E;QAC5E,IACE,KAAK,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACpC,KAAK,CAAC,UAAU,CAAC,2BAA2B,CAAC,EAC7C,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QAC5D,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;QACrD,OAAO,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACjC,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,qDAAqD;QACrD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,GAAW;IAC7B,MAAM,WAAW,GAA2B;QAC1C,GAAG,EAAE,OAAO;QACZ,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,MAAM;QACX,GAAG,EAAE,QAAQ;QACb,GAAG,EAAE,OAAO;KACb,CAAC;IACF,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAC9D,CAAC;AAQD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,SAAgB,mBAAmB,CACjC,cAA0C,EAC1C,UAA4B,EAAE;IAE9B,MAAM,MAAM,GAAG,IAAA,gBAAM,GAAE,CAAC;IAExB,4DAA4D;IAC5D,MAAM,UAAU,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC;IAExD;;OAEG;IACH,MAAM,cAAc,GAAmB,KAAK,EAC1C,IAAa,EACb,GAAa,EACE,EAAE;QACjB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,UAAU;gBACrB,CAAC,CAAC,MAAO,cAA+B,EAAE;gBAC1C,CAAC,CAAE,cAA8B,CAAC;YAEpC,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,KAAK,EAAE;oBACL,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EACL,KAAK,YAAY,KAAK;wBACpB,CAAC,CAAC,KAAK,CAAC,OAAO;wBACf,CAAC,CAAC,+BAA+B;iBACtC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;IAEF,2CAA2C;IAC3C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IAE1C,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,sBAAsB,CACpC,cAA0C,EAC1C,UAA4B,EAAE;IAE9B,MAAM,UAAU,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC;IAExD,OAAO,KAAK,EAAE,IAAa,EAAE,GAAa,EAAiB,EAAE;QAC3D,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,UAAU;gBACrB,CAAC,CAAC,MAAO,cAA+B,EAAE;gBAC1C,CAAC,CAAE,cAA8B,CAAC;YAEpC,MAAM,IAAI,GAAG,qBAAqB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAClD,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;gBACnB,KAAK,EAAE;oBACL,IAAI,EAAE,kBAAkB;oBACxB,OAAO,EACL,KAAK,YAAY,KAAK;wBACpB,CAAC,CAAC,KAAK,CAAC,OAAO;wBACf,CAAC,CAAC,+BAA+B;iBACtC;aACF,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/src/openapi/schemas.d.ts ADDED Viewed

@@ -0,0 +1,170 @@
+/**
+ * @fileoverview OpenAPI schema registry for component schemas.
+ * Provides a centralized place to register and retrieve OpenAPI schemas.
+ * Supports schema validation, removal, and inheritance tracking.
+ * @module openapi/schemas
+ */
+/**
+ * Schema definition with optional metadata.
+ */
+export interface SchemaDefinition {
+    /** The OpenAPI schema object */
+    schema: Record<string, unknown>;
+    /** Optional description of the schema */
+    description?: string;
+    /** Optional parent schema name for inheritance tracking */
+    parent?: string;
+    /** Whether this schema was auto-generated from decorators */
+    autoGenerated?: boolean;
+}
+/**
+ * Registry for OpenAPI component schemas.
+ * Schemas are referenced by name in route metadata and resolved here.
+ */
+declare class OpenAPISchemaRegistryClass {
+    private schemas;
+    private securitySchemes;
+    /**
+     * Register a schema.
+     * @param name - Schema name (used in $ref)
+     * @param schema - OpenAPI schema object
+     * @param options - Optional metadata for the schema
+     */
+    registerSchema(name: string, schema: Record<string, unknown>, options?: {
+        description?: string;
+        parent?: string;
+        autoGenerated?: boolean;
+    }): void;
+    /**
+     * Register multiple schemas at once.
+     * @param schemas - Object mapping schema names to schema definitions
+     */
+    registerSchemas(schemas: Record<string, Record<string, unknown>>): void;
+    /**
+     * Unregister a schema.
+     * @param name - Schema name to remove
+     * @returns True if the schema was removed, false if it didn't exist
+     */
+    unregisterSchema(name: string): boolean;
+    /**
+     * Get a schema by name.
+     * @param name - Schema name
+     * @returns The schema or undefined
+     */
+    getSchema(name: string): Record<string, unknown> | undefined;
+    /**
+     * Get a schema definition with metadata.
+     * @param name - Schema name
+     * @returns The schema definition or undefined
+     */
+    getSchemaDefinition(name: string): SchemaDefinition | undefined;
+    /**
+     * Get all registered schemas.
+     * @returns Object mapping schema names to definitions
+     */
+    getAllSchemas(): Record<string, Record<string, unknown>>;
+    /**
+     * Get all schema definitions with metadata.
+     * @returns Object mapping schema names to full definitions
+     */
+    getAllSchemaDefinitions(): Record<string, SchemaDefinition>;
+    /**
+     * Get schemas that inherit from a parent schema.
+     * @param parentName - Parent schema name
+     * @returns Array of child schema names
+     */
+    getChildSchemas(parentName: string): string[];
+    /**
+     * Register a security scheme.
+     * @param name - Security scheme name
+     * @param scheme - OpenAPI security scheme object
+     */
+    registerSecurityScheme(name: string, scheme: Record<string, unknown>): void;
+    /**
+     * Register multiple security schemes at once.
+     * @param schemes - Object mapping scheme names to definitions
+     */
+    registerSecuritySchemes(schemes: Record<string, Record<string, unknown>>): void;
+    /**
+     * Unregister a security scheme.
+     * @param name - Security scheme name to remove
+     * @returns True if the scheme was removed, false if it didn't exist
+     */
+    unregisterSecurityScheme(name: string): boolean;
+    /**
+     * Get a security scheme by name.
+     * @param name - Security scheme name
+     * @returns The security scheme or undefined
+     */
+    getSecurityScheme(name: string): Record<string, unknown> | undefined;
+    /**
+     * Get all registered security schemes.
+     * @returns Object mapping scheme names to definitions
+     */
+    getAllSecuritySchemes(): Record<string, Record<string, unknown>>;
+    /**
+     * Clear all registrations (useful for testing).
+     */
+    clear(): void;
+    /**
+     * Clear only auto-generated schemas.
+     * Useful when re-scanning decorated classes.
+     */
+    clearAutoGenerated(): void;
+    /**
+     * Get count of registered schemas.
+     */
+    get schemaCount(): number;
+    /**
+     * Get count of registered security schemes.
+     */
+    get securitySchemeCount(): number;
+    /**
+     * Check if a schema is registered.
+     * @param name - Schema name
+     * @returns True if the schema is registered
+     */
+    hasSchema(name: string): boolean;
+    /**
+     * Check if a security scheme is registered.
+     * @param name - Security scheme name
+     * @returns True if the security scheme is registered
+     */
+    hasSecurityScheme(name: string): boolean;
+    /**
+     * Validate that all schema references can be resolved.
+     * @returns Array of unresolved schema references
+     */
+    validateSchemaReferences(): string[];
+    /**
+     * Extract schema references from a schema object.
+     * @param schema - Schema object to scan
+     * @returns Array of referenced schema names
+     */
+    private extractSchemaRefs;
+    /**
+     * Get all schema names.
+     * @returns Array of registered schema names
+     */
+    getSchemaNames(): string[];
+    /**
+     * Get all security scheme names.
+     * @returns Array of registered security scheme names
+     */
+    getSecuritySchemeNames(): string[];
+}
+/**
+ * Singleton instance of the schema registry.
+ */
+export declare const OpenAPISchemaRegistry: OpenAPISchemaRegistryClass;
+/**
+ * Common schemas that are typically needed.
+ * Applications can register these or define their own.
+ */
+export declare const CommonSchemas: Record<string, Record<string, unknown>>;
+/**
+ * Common security schemes.
+ */
+export declare const CommonSecuritySchemes: Record<string, Record<string, unknown>>;
+export {};
+//# sourceMappingURL=schemas.d.ts.map

package/src/openapi/schemas.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-node-express-suite/src/openapi/schemas.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,cAAM,0BAA0B;IAC9B,OAAO,CAAC,OAAO,CAA4C;IAC3D,OAAO,CAAC,eAAe,CAAmD;IAE1E;;;;;OAKG;IACH,cAAc,CACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,OAAO,CAAC;KACzB,GACA,IAAI;IASP;;;OAGG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,IAAI;IAMvE;;;;OAIG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIvC;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAI5D;;;;OAIG;IACH,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI/D;;;OAGG;IACH,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAQxD;;;OAGG;IACH,uBAAuB,IAAI,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAQ3D;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;IAU7C;;;;OAIG;IACH,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAI3E;;;OAGG;IACH,uBAAuB,CACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAC/C,IAAI;IAMP;;;;OAIG;IACH,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI/C;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;IAIpE;;;OAGG;IACH,qBAAqB,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAQhE;;OAEG;IACH,KAAK,IAAI,IAAI;IAKb;;;OAGG;IACH,kBAAkB,IAAI,IAAI;IAQ1B;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIhC;;;;OAIG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAIxC;;;OAGG;IACH,wBAAwB,IAAI,MAAM,EAAE;IAepC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAiCzB;;;OAGG;IACH,cAAc,IAAI,MAAM,EAAE;IAI1B;;;OAGG;IACH,sBAAsB,IAAI,MAAM,EAAE;CAGnC;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,4BAAmC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CA8DjE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAazE,CAAC"}