api-machine 1.0.0

package/error/http-errors/index.js

@@ -0,0 +1,67 @@
+"use strict";
+/* eslint-disable max-len */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnavailableForLegalReasonsError = exports.RequestHeaderFieldsTooLargeError = exports.TooManyRequestsError = exports.PreconditionRequiredError = exports.UpgradeRequiredError = exports.TooEarlyError = exports.FailedDependencyError = exports.LockedError = exports.UnprocessableEntityError = exports.MisdirectedRequestError = exports.ImATeapotError = exports.ExpectationFailedError = exports.RangeNotSatisfiableError = exports.UnsupportedMediaTypeError = exports.URITooLongError = exports.PayloadTooLargeError = exports.PreconditionFailedError = exports.LengthRequiredError = exports.GoneError = exports.ConflictError = exports.RequestTimeoutError = exports.ProxyAuthenticationRequiredError = exports.NotAcceptableError = exports.MethodNotAllowedError = exports.NotFoundError = exports.ForbiddenError = exports.PaymentRequiredError = exports.UnauthorizedError = exports.BadRequestError = exports.HTTPError = void 0;
+// Base HTTP Error
+var http_error_1 = require("./http-error");
+Object.defineProperty(exports, "HTTPError", { enumerable: true, get: function () { return http_error_1.HTTPError; } });
+// 4xx Client Errors (in order)
+var _400_bad_request_error_1 = require("./400-bad-request-error");
+Object.defineProperty(exports, "BadRequestError", { enumerable: true, get: function () { return _400_bad_request_error_1.BadRequestError; } });
+var _401_unauthorized_error_1 = require("./401-unauthorized-error");
+Object.defineProperty(exports, "UnauthorizedError", { enumerable: true, get: function () { return _401_unauthorized_error_1.UnauthorizedError; } });
+var _402_payment_required_error_1 = require("./402-payment-required-error");
+Object.defineProperty(exports, "PaymentRequiredError", { enumerable: true, get: function () { return _402_payment_required_error_1.PaymentRequiredError; } });
+var _403_forbidden_error_1 = require("./403-forbidden-error");
+Object.defineProperty(exports, "ForbiddenError", { enumerable: true, get: function () { return _403_forbidden_error_1.ForbiddenError; } });
+var _404_not_found_error_1 = require("./404-not-found-error");
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return _404_not_found_error_1.NotFoundError; } });
+var _405_method_not_allowed_error_1 = require("./405-method-not-allowed-error");
+Object.defineProperty(exports, "MethodNotAllowedError", { enumerable: true, get: function () { return _405_method_not_allowed_error_1.MethodNotAllowedError; } });
+var _406_not_acceptable_error_1 = require("./406-not-acceptable-error");
+Object.defineProperty(exports, "NotAcceptableError", { enumerable: true, get: function () { return _406_not_acceptable_error_1.NotAcceptableError; } });
+var _407_proxy_authentication_required_error_1 = require("./407-proxy-authentication-required-error");
+Object.defineProperty(exports, "ProxyAuthenticationRequiredError", { enumerable: true, get: function () { return _407_proxy_authentication_required_error_1.ProxyAuthenticationRequiredError; } });
+var _408_request_timeout_error_1 = require("./408-request-timeout-error");
+Object.defineProperty(exports, "RequestTimeoutError", { enumerable: true, get: function () { return _408_request_timeout_error_1.RequestTimeoutError; } });
+var _409_conflict_error_1 = require("./409-conflict-error");
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return _409_conflict_error_1.ConflictError; } });
+var _410_gone_error_1 = require("./410-gone-error");
+Object.defineProperty(exports, "GoneError", { enumerable: true, get: function () { return _410_gone_error_1.GoneError; } });
+var _411_length_required_error_1 = require("./411-length-required-error");
+Object.defineProperty(exports, "LengthRequiredError", { enumerable: true, get: function () { return _411_length_required_error_1.LengthRequiredError; } });
+var _412_precondition_failed_error_1 = require("./412-precondition-failed-error");
+Object.defineProperty(exports, "PreconditionFailedError", { enumerable: true, get: function () { return _412_precondition_failed_error_1.PreconditionFailedError; } });
+var _413_payload_too_large_error_1 = require("./413-payload-too-large-error");
+Object.defineProperty(exports, "PayloadTooLargeError", { enumerable: true, get: function () { return _413_payload_too_large_error_1.PayloadTooLargeError; } });
+var _414_uri_too_long_error_1 = require("./414-uri-too-long-error");
+Object.defineProperty(exports, "URITooLongError", { enumerable: true, get: function () { return _414_uri_too_long_error_1.URITooLongError; } });
+var _415_unsupported_media_type_error_1 = require("./415-unsupported-media-type-error");
+Object.defineProperty(exports, "UnsupportedMediaTypeError", { enumerable: true, get: function () { return _415_unsupported_media_type_error_1.UnsupportedMediaTypeError; } });
+var _416_range_not_satisfiable_error_1 = require("./416-range-not-satisfiable-error");
+Object.defineProperty(exports, "RangeNotSatisfiableError", { enumerable: true, get: function () { return _416_range_not_satisfiable_error_1.RangeNotSatisfiableError; } });
+var _417_expectation_failed_error_1 = require("./417-expectation-failed-error");
+Object.defineProperty(exports, "ExpectationFailedError", { enumerable: true, get: function () { return _417_expectation_failed_error_1.ExpectationFailedError; } });
+var _418_im_a_teapot_error_1 = require("./418-im-a-teapot-error");
+Object.defineProperty(exports, "ImATeapotError", { enumerable: true, get: function () { return _418_im_a_teapot_error_1.ImATeapotError; } });
+var _421_misdirected_request_error_1 = require("./421-misdirected-request-error");
+Object.defineProperty(exports, "MisdirectedRequestError", { enumerable: true, get: function () { return _421_misdirected_request_error_1.MisdirectedRequestError; } });
+var _422_unprocessable_entity_error_1 = require("./422-unprocessable-entity-error");
+Object.defineProperty(exports, "UnprocessableEntityError", { enumerable: true, get: function () { return _422_unprocessable_entity_error_1.UnprocessableEntityError; } });
+var _423_locked_error_1 = require("./423-locked-error");
+Object.defineProperty(exports, "LockedError", { enumerable: true, get: function () { return _423_locked_error_1.LockedError; } });
+var _424_failed_dependency_error_1 = require("./424-failed-dependency-error");
+Object.defineProperty(exports, "FailedDependencyError", { enumerable: true, get: function () { return _424_failed_dependency_error_1.FailedDependencyError; } });
+var _425_too_early_error_1 = require("./425-too-early-error");
+Object.defineProperty(exports, "TooEarlyError", { enumerable: true, get: function () { return _425_too_early_error_1.TooEarlyError; } });
+var _426_upgrade_required_error_1 = require("./426-upgrade-required-error");
+Object.defineProperty(exports, "UpgradeRequiredError", { enumerable: true, get: function () { return _426_upgrade_required_error_1.UpgradeRequiredError; } });
+var _428_precondition_required_error_1 = require("./428-precondition-required-error");
+Object.defineProperty(exports, "PreconditionRequiredError", { enumerable: true, get: function () { return _428_precondition_required_error_1.PreconditionRequiredError; } });
+var _429_too_many_requests_error_1 = require("./429-too-many-requests-error");
+Object.defineProperty(exports, "TooManyRequestsError", { enumerable: true, get: function () { return _429_too_many_requests_error_1.TooManyRequestsError; } });
+var _431_request_header_fields_too_large_error_1 = require("./431-request-header-fields-too-large-error");
+Object.defineProperty(exports, "RequestHeaderFieldsTooLargeError", { enumerable: true, get: function () { return _431_request_header_fields_too_large_error_1.RequestHeaderFieldsTooLargeError; } });
+var _451_unavailable_for_legal_reasons_error_1 = require("./451-unavailable-for-legal-reasons-error");
+Object.defineProperty(exports, "UnavailableForLegalReasonsError", { enumerable: true, get: function () { return _451_unavailable_for_legal_reasons_error_1.UnavailableForLegalReasonsError; } });
+//# sourceMappingURL=index.js.map

package/error/http-errors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/error/http-errors/index.ts"],"names":[],"mappings":";AAAA,4BAA4B;;;AAE5B,kBAAkB;AAClB,2CAAyC;AAAhC,uGAAA,SAAS,OAAA;AAElB,+BAA+B;AAC/B,kEAA0D;AAAjD,yHAAA,eAAe,OAAA;AACxB,oEAGkC;AAFjC,4HAAA,iBAAiB,OAAA;AAGlB,4EAAoE;AAA3D,mIAAA,oBAAoB,OAAA;AAC7B,8DAAuD;AAA9C,sHAAA,cAAc,OAAA;AACvB,8DAAsD;AAA7C,qHAAA,aAAa,OAAA;AACtB,gFAGwC;AAFvC,sIAAA,qBAAqB,OAAA;AAGtB,wEAAgE;AAAvD,+HAAA,kBAAkB,OAAA;AAC3B,sGAGmD;AAFlD,4JAAA,gCAAgC,OAAA;AAGjC,0EAAkE;AAAzD,iIAAA,mBAAmB,OAAA;AAC5B,4DAAqD;AAA5C,oHAAA,aAAa,OAAA;AACtB,oDAA6C;AAApC,4GAAA,SAAS,OAAA;AAClB,0EAAkE;AAAzD,iIAAA,mBAAmB,OAAA;AAC5B,kFAA0E;AAAjE,yIAAA,uBAAuB,OAAA;AAChC,8EAAqE;AAA5D,oIAAA,oBAAoB,OAAA;AAC7B,oEAA2D;AAAlD,0HAAA,eAAe,OAAA;AACxB,wFAG4C;AAF3C,8IAAA,yBAAyB,OAAA;AAG1B,sFAG2C;AAF1C,4IAAA,wBAAwB,OAAA;AAGzB,gFAAwE;AAA/D,uIAAA,sBAAsB,OAAA;AAC/B,kEAAyD;AAAhD,wHAAA,cAAc,OAAA;AACvB,kFAA0E;AAAjE,yIAAA,uBAAuB,OAAA;AAChC,oFAA4E;AAAnE,2IAAA,wBAAwB,OAAA;AACjC,wDAAiD;AAAxC,gHAAA,WAAW,OAAA;AACpB,8EAAsE;AAA7D,qIAAA,qBAAqB,OAAA;AAC9B,8DAAsD;AAA7C,qHAAA,aAAa,OAAA;AACtB,4EAGsC;AAFrC,mIAAA,oBAAoB,OAAA;AAGrB,sFAA8E;AAArE,6IAAA,yBAAyB,OAAA;AAClC,8EAGuC;AAFtC,oIAAA,oBAAoB,OAAA;AAGrB,0GAA+F;AAAtF,8JAAA,gCAAgC,OAAA;AACzC,sGAA4F;AAAnF,2JAAA,+BAA+B,OAAA"}

package/error/index.d.ts

@@ -0,0 +1,3 @@
+export { ErrorResponse } from './error-response';
+export { HttpErrorOptions } from './error-options';
+export * from './http-errors';

package/error/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./http-errors"), exports);
+//# sourceMappingURL=index.js.map

package/error/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/error/index.ts"],"names":[],"mappings":";;;AAEA,wDAA8B"}

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from './router';
+export * from './server';
+export * from './error';
+export * from './authentication';

package/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./router"), exports);
+tslib_1.__exportStar(require("./server"), exports);
+tslib_1.__exportStar(require("./error"), exports);
+tslib_1.__exportStar(require("./authentication"), exports);
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,mDAAyB;AACzB,kDAAwB;AACxB,2DAAiC"}

package/log/index.d.ts

@@ -0,0 +1 @@
+export { LogInterface } from './log-interface';

package/log/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/log/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/log/index.ts"],"names":[],"mappings":""}

package/log/log-interface.d.ts

@@ -0,0 +1,7 @@
+export interface LogInterface {
+    fatal: (...args: any[]) => void;
+    error: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    info: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+}

package/log/log-interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=log-interface.js.map

package/log/log-interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-interface.js","sourceRoot":"","sources":["../../../src/log/log-interface.ts"],"names":[],"mappings":""}

package/oas/index.d.ts

@@ -0,0 +1,2 @@
+export { OasRestServerConverter } from './oas-rest-server-converter';
+export { OasEndpointConverter } from './oas-endpoint-converter';

package/oas/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasEndpointConverter = exports.OasRestServerConverter = void 0;
+var oas_rest_server_converter_1 = require("./oas-rest-server-converter");
+Object.defineProperty(exports, "OasRestServerConverter", { enumerable: true, get: function () { return oas_rest_server_converter_1.OasRestServerConverter; } });
+var oas_endpoint_converter_1 = require("./oas-endpoint-converter");
+Object.defineProperty(exports, "OasEndpointConverter", { enumerable: true, get: function () { return oas_endpoint_converter_1.OasEndpointConverter; } });
+//# sourceMappingURL=index.js.map

package/oas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/oas/index.ts"],"names":[],"mappings":";;;AAAA,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAC/B,mEAAgE;AAAvD,8HAAA,oBAAoB,OAAA"}

package/oas/oas-endpoint-component-converter.d.ts

@@ -0,0 +1,15 @@
+import { ObjectSanitizer } from 'valsan';
+import { SchemaObject } from 'auto-oas/oas/v3.1';
+import { BaseApiEndpoint } from '../router';
+/**
+ * Builds OpenAPI component schemas for an endpoint from valsans
+ */
+export declare class OasEndpointComponentConverter {
+    protected schemas: Record<string, SchemaObject>;
+    getSchemas(endpoint: BaseApiEndpoint): Record<string, SchemaObject>;
+    protected addSchema({ name, sanitizer, example, }: {
+        name: string;
+        sanitizer: ObjectSanitizer;
+        example?: any;
+    }): void;
+}

package/oas/oas-endpoint-component-converter.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasEndpointComponentConverter = void 0;
+const auto_oas_1 = require("auto-oas/auto-oas");
+/**
+ * Builds OpenAPI component schemas for an endpoint from valsans
+ */
+class OasEndpointComponentConverter {
+    schemas = {};
+    // Return a map of schema name -> SchemaObject for the endpoint
+    getSchemas(endpoint) {
+        const bodySanitizer = endpoint.body;
+        if (bodySanitizer) {
+            this.addSchema({
+                name: `${endpoint.name}Body`,
+                sanitizer: bodySanitizer,
+                example: endpoint.bodyExample,
+            });
+        }
+        return this.schemas;
+    }
+    addSchema({ name, sanitizer, example, }) {
+        const schema = (0, auto_oas_1.buildObjectSchema)(sanitizer);
+        if (schema) {
+            if (example) {
+                schema.example = example;
+            }
+            this.schemas[name] = schema;
+        }
+    }
+}
+exports.OasEndpointComponentConverter = OasEndpointComponentConverter;
+//# sourceMappingURL=oas-endpoint-component-converter.js.map

package/oas/oas-endpoint-component-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oas-endpoint-component-converter.js","sourceRoot":"","sources":["../../../src/oas/oas-endpoint-component-converter.ts"],"names":[],"mappings":";;;AAIA,gDAAsD;AAEtD;;GAEG;AACH,MAAa,6BAA6B;IAC/B,OAAO,GAAiC,EAAE,CAAC;IAErD,+DAA+D;IACxD,UAAU,CAAC,QAAyB;QAC1C,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAEpC,IAAI,aAAa,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC;gBACd,IAAI,EAAE,GAAG,QAAQ,CAAC,IAAI,MAAM;gBAC5B,SAAS,EAAE,aAAa;gBACxB,OAAO,EAAE,QAAQ,CAAC,WAAW;aAC7B,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IAES,SAAS,CAAC,EACnB,IAAI,EACJ,SAAS,EACT,OAAO,GAMP;QACA,MAAM,MAAM,GAAG,IAAA,4BAAiB,EAAC,SAAS,CAAC,CAAC;QAE5C,IAAI,MAAM,EAAE,CAAC;YACZ,IAAI,OAAO,EAAE,CAAC;gBACb,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;YAC1B,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAC7B,CAAC;IACF,CAAC;CACD;AAtCD,sEAsCC"}

package/oas/oas-endpoint-converter.d.ts

@@ -0,0 +1,17 @@
+import { ObjectSanitizer } from 'valsan';
+import { PathItemObject, ParameterObject } from 'auto-oas/oas/v3.1';
+import { BaseApiEndpoint } from '../router';
+import { AuthenticationScheme } from '../authentication/authentication-scheme';
+/**
+ * Returns OpenAPI path item for an endpoint,
+ * 	based on validation.
+ */
+export declare class OasEndpointConverter {
+    protected parameters: ParameterObject[];
+    getOpenApiPath(endpoint: BaseApiEndpoint, authentication?: AuthenticationScheme | null): PathItemObject;
+    protected addParams({ location, sanitizer, example, }: {
+        location: 'path' | 'query' | 'header';
+        sanitizer?: ObjectSanitizer;
+        example?: any;
+    }): void;
+}

package/oas/oas-endpoint-converter.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasEndpointConverter = void 0;
+const auto_oas_1 = require("auto-oas/auto-oas");
+/**
+ * Returns OpenAPI path item for an endpoint,
+ * 	based on validation.
+ */
+class OasEndpointConverter {
+    parameters = [];
+    getOpenApiPath(endpoint, authentication) {
+        this.addParams({
+            location: 'path',
+            sanitizer: endpoint.params,
+            example: endpoint.paramsExample,
+        });
+        this.addParams({
+            location: 'query',
+            sanitizer: endpoint.query,
+            example: endpoint.queryExample,
+        });
+        this.addParams({
+            location: 'header',
+            sanitizer: endpoint.headers,
+            example: endpoint.headersExample,
+        });
+        let requestBody = undefined;
+        const bodySanitizer = endpoint.body;
+        if (bodySanitizer && bodySanitizer.schema) {
+            requestBody = {
+                required: true,
+                content: {
+                    'application/json': {
+                        schema: {
+                            $ref: '#/components/schemas/' +
+                                endpoint.getName() +
+                                'Body',
+                        },
+                    },
+                },
+            };
+        }
+        // Use statusCode for response
+        const status = endpoint.statusCode;
+        const responses = {
+            [status]: { description: 'Success' },
+        };
+        const errors = endpoint.getErrors();
+        for (const error in errors) {
+            const httpError = errors[error];
+            responses[httpError.getStatusCode()] = {
+                description: httpError.message || 'Error response',
+            };
+        }
+        // Add security requirement if authentication is present
+        // null means explicitly public (no auth),
+        // undefined inherited from parent
+        const security = authentication !== undefined && authentication !== null
+            ? [authentication.getSecurityRequirement()]
+            : authentication === null
+                ? []
+                : undefined;
+        return {
+            [endpoint.method]: {
+                summary: endpoint.getName(),
+                description: endpoint.description,
+                tags: [endpoint.getTag()],
+                parameters: this.parameters.length > 0 ? this.parameters : undefined,
+                requestBody,
+                responses,
+                security,
+            },
+        };
+    }
+    addParams({ location, sanitizer, example, }) {
+        if (sanitizer && sanitizer.schema) {
+            for (const key in sanitizer.schema) {
+                const valSan = sanitizer.schema[key];
+                const param = (0, auto_oas_1.buildParameter)(key, valSan, location);
+                if (example && example[key] !== undefined) {
+                    param.example = example[key];
+                }
+                this.parameters.push(param);
+            }
+        }
+    }
+}
+exports.OasEndpointConverter = OasEndpointConverter;
+//# sourceMappingURL=oas-endpoint-converter.js.map

package/oas/oas-endpoint-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oas-endpoint-converter.js","sourceRoot":"","sources":["../../../src/oas/oas-endpoint-converter.ts"],"names":[],"mappings":";;;AAQA,gDAAmD;AAGnD;;;GAGG;AACH,MAAa,oBAAoB;IACtB,UAAU,GAAsB,EAAE,CAAC;IAEtC,cAAc,CACpB,QAAyB,EACzB,cAA4C;QAE5C,IAAI,CAAC,SAAS,CAAC;YACd,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,QAAQ,CAAC,MAAM;YAC1B,OAAO,EAAE,QAAQ,CAAC,aAAa;SAC/B,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC;YACd,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,QAAQ,CAAC,KAAK;YACzB,OAAO,EAAE,QAAQ,CAAC,YAAY;SAC9B,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC;YACd,QAAQ,EAAE,QAAQ;YAClB,SAAS,EAAE,QAAQ,CAAC,OAAO;YAC3B,OAAO,EAAE,QAAQ,CAAC,cAAc;SAChC,CAAC,CAAC;QAEH,IAAI,WAAW,GAAkC,SAAS,CAAC;QAC3D,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QAEpC,IAAI,aAAa,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YAC3C,WAAW,GAAG;gBACb,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACR,kBAAkB,EAAE;wBACnB,MAAM,EAAE;4BACP,IAAI,EACH,uBAAuB;gCACvB,QAAQ,CAAC,OAAO,EAAE;gCAClB,MAAM;yBACP;qBACD;iBACD;aACD,CAAC;QACH,CAAC;QAED,8BAA8B;QAC9B,MAAM,MAAM,GAAG,QAAQ,CAAC,UAAU,CAAC;QAEnC,MAAM,SAAS,GAAG;YACjB,CAAC,MAAM,CAAC,EAAE,EAAE,WAAW,EAAE,SAAS,EAAE;SACpC,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,EAAE,CAAC;QACpC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAChC,SAAS,CAAC,SAAS,CAAC,aAAa,EAAE,CAAC,GAAG;gBACtC,WAAW,EAAE,SAAS,CAAC,OAAO,IAAI,gBAAgB;aAClD,CAAC;QACH,CAAC;QAED,wDAAwD;QACxD,0CAA0C;QAC1C,kCAAkC;QAClC,MAAM,QAAQ,GACb,cAAc,KAAK,SAAS,IAAI,cAAc,KAAK,IAAI;YACtD,CAAC,CAAC,CAAC,cAAc,CAAC,sBAAsB,EAAE,CAAC;YAC3C,CAAC,CAAC,cAAc,KAAK,IAAI;gBACxB,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,SAAS,CAAC;QAEf,OAAO;YACN,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAkB;gBAClC,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE;gBAC3B,WAAW,EAAE,QAAQ,CAAC,WAAW;gBACjC,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACzB,UAAU,EACT,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;gBACzD,WAAW;gBACX,SAAS;gBACT,QAAQ;aACR;SACD,CAAC;IACH,CAAC;IAES,SAAS,CAAC,EACnB,QAAQ,EACR,SAAS,EACT,OAAO,GAMP;QACA,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACnC,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;gBACpC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;gBACrC,MAAM,KAAK,GAAG,IAAA,yBAAc,EAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAEpD,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC3C,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;gBAC9B,CAAC;gBAED,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC7B,CAAC;QACF,CAAC;IACF,CAAC;CACD;AA1GD,oDA0GC"}

package/oas/oas-rest-server-converter.d.ts

@@ -0,0 +1,13 @@
+import { ComponentsObject, InfoObject, OpenAPIObject, PathItemObject, SecuritySchemeObject, TagObject } from 'auto-oas/oas/v3.1';
+import { RestServer } from '../server';
+import { BaseApiEndpoint, BaseApiRouter } from '../router';
+export declare class OasRestServerConverter {
+    protected paths: Record<string, PathItemObject>;
+    protected components: ComponentsObject;
+    protected tags: TagObject[];
+    protected securitySchemes: Record<string, SecuritySchemeObject>;
+    getOpenApiSpec(server: RestServer): Promise<OpenAPIObject>;
+    getOpenApiInfo(server: RestServer): Promise<InfoObject>;
+    convertRouter(router: BaseApiRouter): Promise<void>;
+    convertEndpoint(endpoint: BaseApiEndpoint): Promise<void>;
+}

package/oas/oas-rest-server-converter.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OasRestServerConverter = void 0;
+const router_1 = require("../router");
+const oas_endpoint_converter_1 = require("./oas-endpoint-converter");
+// eslint-disable-next-line max-len
+const oas_endpoint_component_converter_1 = require("./oas-endpoint-component-converter");
+class OasRestServerConverter {
+    paths = {};
+    components = {};
+    tags = [];
+    securitySchemes = {};
+    async getOpenApiSpec(server) {
+        await this.convertRouter(server.routerInstance);
+        // Add collected security schemes to components
+        if (Object.keys(this.securitySchemes).length > 0) {
+            if (!this.components.securitySchemes) {
+                this.components.securitySchemes = {};
+            }
+            Object.assign(this.components.securitySchemes, this.securitySchemes);
+        }
+        // Set global security if server has authentication
+        const globalSecurity = [];
+        if (server.authentication) {
+            globalSecurity.push(server.authentication.getSecurityRequirement());
+        }
+        return {
+            openapi: '3.1.0',
+            info: await this.getOpenApiInfo(server),
+            servers: [],
+            paths: this.paths,
+            components: this.components,
+            security: globalSecurity,
+            tags: this.tags,
+        };
+    }
+    async getOpenApiInfo(server) {
+        return {
+            title: server.name,
+            version: server.version,
+            description: server.description,
+        };
+    }
+    async convertRouter(router) {
+        for (const route of router.registeredRoutes) {
+            if (route instanceof router_1.BaseApiEndpoint) {
+                await this.convertEndpoint(route);
+            }
+            else if (route instanceof router_1.BaseApiRouter) {
+                await this.convertRouter(route);
+            }
+        }
+    }
+    async convertEndpoint(endpoint) {
+        // Get effective authentication for this endpoint
+        const effectiveAuth = endpoint.getEffectiveAuthentication();
+        // Collect authentication scheme if present and not null
+        // (null = public)
+        if (effectiveAuth) {
+            const schemeName = effectiveAuth.schemeName;
+            if (!this.securitySchemes[schemeName]) {
+                this.securitySchemes[schemeName] =
+                    effectiveAuth.getSecurityScheme();
+            }
+        }
+        const endpointConverter = new oas_endpoint_converter_1.OasEndpointConverter();
+        const pathItem = endpointConverter.getOpenApiPath(endpoint, effectiveAuth);
+        const path = (endpoint.fullPath || '/').replace(/:([a-zA-Z0-9_]+)/g, '{$1}');
+        if (this.paths[path] === undefined) {
+            this.paths[path] = {};
+        }
+        Object.assign(this.paths[path], pathItem);
+        const endpointComponentConverter = new oas_endpoint_component_converter_1.OasEndpointComponentConverter();
+        const endpointComponents = endpointComponentConverter.getSchemas(endpoint);
+        if (!this.components.schemas) {
+            this.components.schemas = {};
+        }
+        Object.assign(this.components.schemas, endpointComponents);
+    }
+}
+exports.OasRestServerConverter = OasRestServerConverter;
+//# sourceMappingURL=oas-rest-server-converter.js.map

package/oas/oas-rest-server-converter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oas-rest-server-converter.js","sourceRoot":"","sources":["../../../src/oas/oas-rest-server-converter.ts"],"names":[],"mappings":";;;AASA,sCAA2D;AAC3D,qEAAgE;AAChE,mCAAmC;AACnC,yFAAmF;AAEnF,MAAa,sBAAsB;IACxB,KAAK,GAAmC,EAAE,CAAC;IAC3C,UAAU,GAAqB,EAAE,CAAC;IAClC,IAAI,GAAgB,EAAE,CAAC;IACvB,eAAe,GAAyC,EAAE,CAAC;IAE9D,KAAK,CAAC,cAAc,CAAC,MAAkB;QAC7C,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAEhD,+CAA+C;QAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;YACtC,CAAC;YACD,MAAM,CAAC,MAAM,CACZ,IAAI,CAAC,UAAU,CAAC,eAAe,EAC/B,IAAI,CAAC,eAAe,CACpB,CAAC;QACH,CAAC;QAED,mDAAmD;QACnD,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC3B,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,sBAAsB,EAAE,CAAC,CAAC;QACrE,CAAC;QAED,OAAO;YACN,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YACvC,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,MAAkB;QAC7C,OAAO;YACN,KAAK,EAAE,MAAM,CAAC,IAAI;YAClB,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,WAAW,EAAE,MAAM,CAAC,WAAW;SAC/B,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,MAAqB;QAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC7C,IAAI,KAAK,YAAY,wBAAe,EAAE,CAAC;gBACtC,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;iBACI,IAAI,KAAK,YAAY,sBAAa,EAAE,CAAC;gBACzC,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YACjC,CAAC;QACF,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,QAAyB;QACrD,iDAAiD;QACjD,MAAM,aAAa,GAAG,QAAQ,CAAC,0BAA0B,EAAE,CAAC;QAE5D,wDAAwD;QACxD,kBAAkB;QAClB,IAAI,aAAa,EAAE,CAAC;YACnB,MAAM,UAAU,GAAG,aAAa,CAAC,UAAU,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;oBAC/B,aAAa,CAAC,iBAAiB,EAAE,CAAC;YACpC,CAAC;QACF,CAAC;QAED,MAAM,iBAAiB,GAAG,IAAI,6CAAoB,EAAE,CAAC;QACrD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,cAAc,CAChD,QAAQ,EACR,aAAa,CACb,CAAC;QACF,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,GAAG,CAAC,CAAC,OAAO,CAC9C,mBAAmB,EACnB,MAAM,CACN,CAAC;QAEF,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC;QAE1C,MAAM,0BAA0B,GAAG,IAAI,gEAA6B,EAAE,CAAC;QACvE,MAAM,kBAAkB,GACvB,0BAA0B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,OAAO,GAAG,EAAE,CAAC;QAC9B,CAAC;QAED,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IAC5D,CAAC;CACD;AAhGD,wDAgGC"}

package/oas/routes.d.ts

@@ -0,0 +1,8 @@
+import { Express } from 'express';
+import { RestServer } from '../server';
+export declare function oasRoutes({ router, server, oasPath, swaggerPath, }: {
+    router: Express;
+    server: RestServer;
+    oasPath?: string;
+    swaggerPath?: string;
+}): Promise<void>;

package/oas/routes.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.oasRoutes = void 0;
+const tslib_1 = require("tslib");
+const swagger_ui_express_1 = tslib_1.__importDefault(require("swagger-ui-express"));
+const oas_rest_server_converter_1 = require("./oas-rest-server-converter");
+async function oasRoutes({ router, server, oasPath, swaggerPath, }) {
+    oasPath = oasPath || '/openapi.json';
+    swaggerPath = swaggerPath || '/docs';
+    const converter = new oas_rest_server_converter_1.OasRestServerConverter();
+    const spec = await converter.getOpenApiSpec(server);
+    // Expose OpenAPI spec
+    router.get(oasPath, async (req, res) => {
+        res.json(spec);
+    });
+    // Serve Swagger UI static assets
+    router.use(swaggerPath, swagger_ui_express_1.default.serve);
+    // Serve Swagger UI HTML
+    router.get(swaggerPath, async (req, res, next) => {
+        return swagger_ui_express_1.default.setup(spec)(req, res, next);
+    });
+}
+exports.oasRoutes = oasRoutes;
+//# sourceMappingURL=routes.js.map

package/oas/routes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes.js","sourceRoot":"","sources":["../../../src/oas/routes.ts"],"names":[],"mappings":";;;;AACA,oFAA2C;AAG3C,2EAAqE;AAE9D,KAAK,UAAU,SAAS,CAAC,EAC/B,MAAM,EACN,MAAM,EACN,OAAO,EACP,WAAW,GAMX;IACA,OAAO,GAAG,OAAO,IAAI,eAAe,CAAC;IACrC,WAAW,GAAG,WAAW,IAAI,OAAO,CAAC;IACrC,MAAM,SAAS,GAAG,IAAI,kDAAsB,EAAE,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IAEpD,sBAAsB;IACtB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,iCAAiC;IACjC,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,4BAAS,CAAC,KAAK,CAAC,CAAC;IAEzC,wBAAwB;IACxB,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAChD,OAAO,4BAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACJ,CAAC;AA5BD,8BA4BC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "api-machine",
+	"version": "1.0.0",
+	"description": "api-machine",
+	"typescript-template": {
+		"base": "1.0.1",
+		"jasmine": "1.0.0",
+		"library": "1.0.0"
+	},
+	"scripts": {},
+	"dependencies": {
+		"auto-oas": "^1.2.0",
+		"cors": "^2.8.5",
+		"express": "^5.1.0",
+		"swagger-ui-express": "^5.0.1",
+		"valsan": "^2.2.0"
+	},
+	"peerDependencies": {
+		"valsan": "^2.2.0"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/StatelessStudio/api-machine.git"
+	},
+	"author": "StatelessStudio",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/StatelessStudio/api-machine/issues"
+	},
+	"homepage": "https://github.com/StatelessStudio/api-machine#readme",
+	"keywords": [],
+	"main": "index.js",
+	"types": "index.d.ts"
+}

package/router/base.d.ts

@@ -0,0 +1,35 @@
+import { Router as ExpressRouter, RequestHandler } from 'express';
+import { AuthenticationScheme } from '../authentication/authentication-scheme';
+export declare abstract class BaseApiRoute {
+    path: string;
+    fullPath: string;
+    name: string;
+    description?: string;
+    /**
+     * Optional array of Express middleware to apply
+     */
+    middleware: RequestHandler[];
+    /**
+     * Authentication scheme for this route
+     * Set to null to explicitly make a route public (no authentication)
+     * If undefined, inherits from parent router or server
+     */
+    authentication?: AuthenticationScheme | null;
+    /**
+     * Parent route in the hierarchy (used for authentication cascading)
+     * @internal
+     */
+    parentRoute?: BaseApiRoute;
+    abstract register(parentRouter: ExpressRouter, parentPath: string): Promise<void>;
+    getName(): string;
+    registerRoutePath(parentPath: string): void;
+    /**
+     * Get the effective authentication scheme for this route
+     * Implements cascading logic: endpoint → router → server
+     * @returns The authentication scheme to use, or undefined if public
+     */
+    getEffectiveAuthentication(): AuthenticationScheme | undefined | null;
+}
+export type ApiRoute = {
+    new (): BaseApiRoute;
+};

package/router/base.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseApiRoute = void 0;
+class BaseApiRoute {
+    path;
+    fullPath;
+    name;
+    description;
+    /**
+     * Optional array of Express middleware to apply
+     */
+    middleware = [];
+    /**
+     * Authentication scheme for this route
+     * Set to null to explicitly make a route public (no authentication)
+     * If undefined, inherits from parent router or server
+     */
+    authentication;
+    /**
+     * Parent route in the hierarchy (used for authentication cascading)
+     * @internal
+     */
+    // eslint-disable-next-line no-use-before-define
+    parentRoute;
+    getName() {
+        return this.name || this.constructor.name;
+    }
+    registerRoutePath(parentPath) {
+        if (!this.path) {
+            this.path = '';
+        }
+        else if (!this.path.startsWith('/')) {
+            this.path = '/' + this.path;
+        }
+        if (parentPath.endsWith('/')) {
+            parentPath = parentPath.slice(0, -1);
+        }
+        this.fullPath = parentPath + this.path;
+    }
+    /**
+     * Get the effective authentication scheme for this route
+     * Implements cascading logic: endpoint → router → server
+     * @returns The authentication scheme to use, or undefined if public
+     */
+    getEffectiveAuthentication() {
+        // If explicitly set (including null for public routes), use it
+        if (this.authentication !== undefined) {
+            return this.authentication;
+        }
+        // Otherwise, cascade to parent
+        if (this.parentRoute) {
+            return this.parentRoute.getEffectiveAuthentication();
+        }
+        // No authentication at any level
+        return undefined;
+    }
+}
+exports.BaseApiRoute = BaseApiRoute;
+//# sourceMappingURL=base.js.map

package/router/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/router/base.ts"],"names":[],"mappings":";;;AAGA,MAAsB,YAAY;IAC1B,IAAI,CAAS;IACb,QAAQ,CAAS;IACjB,IAAI,CAAS;IACb,WAAW,CAAU;IAE5B;;OAEG;IACI,UAAU,GAAqB,EAAE,CAAC;IAEzC;;;;OAIG;IACI,cAAc,CAA+B;IAEpD;;;OAGG;IACH,gDAAgD;IACzC,WAAW,CAAgB;IAO3B,OAAO;QACb,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC3C,CAAC;IAEM,iBAAiB,CAAC,UAAkB;QAC1C,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QAChB,CAAC;aACI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YACrC,IAAI,CAAC,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QAC7B,CAAC;QAED,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,0BAA0B;QAIhC,+DAA+D;QAC/D,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,cAAc,CAAC;QAC5B,CAAC;QAED,+BAA+B;QAC/B,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,EAAE,CAAC;QACtD,CAAC;QAED,iCAAiC;QACjC,OAAO,SAAS,CAAC;IAClB,CAAC;CACD;AAvED,oCAuEC"}