express-zod-api 9.2.1 → 10.0.0-beta2

package/dist/open-api.d.ts

@@ -1,25 +0,0 @@
-import { OpenApiBuilder, SecuritySchemeObject, SecuritySchemeType } from "openapi3-ts";
-import { CommonConfig } from "./config-type";
-import { Method } from "./method";
-import { Routing } from "./routing";
-interface GeneratorParams {
-    title: string;
-    version: string;
-    serverUrl: string;
-    routing: Routing;
-    config: CommonConfig;
-    /** @default Successful response */
-    successfulResponseDescription?: string;
-    /** @default Error response */
-    errorResponseDescription?: string;
-    /** @default true */
-    hasSummaryFromDescription?: boolean;
-}
-export declare class OpenAPI extends OpenApiBuilder {
-    protected lastSecuritySchemaIds: Partial<Record<SecuritySchemeType, number>>;
-    protected lastOperationIdSuffixes: Record<string, number>;
-    protected ensureUniqOperationId(path: string, method: Method): string;
-    protected ensureUniqSecuritySchemaName(subject: SecuritySchemeObject): string;
-    constructor({ routing, config, title, version, serverUrl, successfulResponseDescription, errorResponseDescription, hasSummaryFromDescription, }: GeneratorParams);
-}
-export {};

package/dist/open-api.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenAPI = void 0;
-const openapi3_ts_1 = require("openapi3-ts");
-const common_helpers_1 = require("./common-helpers");
-const logical_container_1 = require("./logical-container");
-const open_api_helpers_1 = require("./open-api-helpers");
-const routing_walker_1 = require("./routing-walker");
-class OpenAPI extends openapi3_ts_1.OpenApiBuilder {
-    ensureUniqOperationId(path, method) {
-        const operationId = (0, common_helpers_1.makeCleanId)(path, method);
-        if (operationId in this.lastOperationIdSuffixes) {
-            this.lastOperationIdSuffixes[operationId]++;
-            return `${operationId}${this.lastOperationIdSuffixes[operationId]}`;
-        }
-        this.lastOperationIdSuffixes[operationId] = 1;
-        return operationId;
-    }
-    ensureUniqSecuritySchemaName(subject) {
-        for (const name in this.rootDoc.components?.securitySchemes || {}) {
-            if (JSON.stringify(subject) ===
-                JSON.stringify(this.rootDoc.components?.securitySchemes?.[name])) {
-                return name;
-            }
-        }
-        this.lastSecuritySchemaIds[subject.type] =
-            (this.lastSecuritySchemaIds?.[subject.type] || 0) + 1;
-        return `${subject.type.toUpperCase()}_${this.lastSecuritySchemaIds[subject.type]}`;
-    }
-    constructor({ routing, config, title, version, serverUrl, successfulResponseDescription = "Successful response", errorResponseDescription = "Error response", hasSummaryFromDescription = true, }) {
-        super();
-        this.lastSecuritySchemaIds = {};
-        this.lastOperationIdSuffixes = {};
-        this.addInfo({ title, version }).addServer({ url: serverUrl });
-        const onEndpoint = (endpoint, path, _method) => {
-            const method = _method;
-            const commonParams = { path, method, endpoint };
-            const [shortDesc, longDesc] = ["short", "long"].map(endpoint.getDescription.bind(endpoint));
-            const inputSources = config.inputSources?.[method] || common_helpers_1.defaultInputSources[method];
-            const depictedParams = (0, open_api_helpers_1.depictRequestParams)({
-                ...commonParams,
-                inputSources,
-            });
-            const operation = {
-                operationId: this.ensureUniqOperationId(path, method),
-                responses: {
-                    [endpoint.getStatusCode("positive")]: (0, open_api_helpers_1.depictResponse)({
-                        ...commonParams,
-                        description: successfulResponseDescription,
-                        isPositive: true,
-                    }),
-                    [endpoint.getStatusCode("negative")]: (0, open_api_helpers_1.depictResponse)({
-                        ...commonParams,
-                        description: errorResponseDescription,
-                        isPositive: false,
-                    }),
-                },
-            };
-            if (longDesc) {
-                operation.description = longDesc;
-                if (hasSummaryFromDescription && shortDesc === undefined) {
-                    operation.summary = (0, open_api_helpers_1.ensureShortDescription)(longDesc);
-                }
-            }
-            if (shortDesc) {
-                operation.summary = (0, open_api_helpers_1.ensureShortDescription)(shortDesc);
-            }
-            if (endpoint.getTags().length > 0) {
-                operation.tags = endpoint.getTags();
-            }
-            if (depictedParams.length > 0) {
-                operation.parameters = depictedParams;
-            }
-            if (inputSources.includes("body")) {
-                operation.requestBody = (0, open_api_helpers_1.depictRequest)(commonParams);
-            }
-            const securityRefs = (0, open_api_helpers_1.depictSecurityRefs)((0, logical_container_1.mapLogicalContainer)((0, open_api_helpers_1.depictSecurity)(endpoint.getSecurity()), (securitySchema) => {
-                const name = this.ensureUniqSecuritySchemaName(securitySchema);
-                const scopes = ["oauth2", "openIdConnect"].includes(securitySchema.type)
-                    ? endpoint.getScopes()
-                    : [];
-                this.addSecurityScheme(name, securitySchema);
-                return { name, scopes };
-            }));
-            if (securityRefs.length > 0) {
-                operation.security = securityRefs;
-            }
-            const swaggerCompatiblePath = (0, open_api_helpers_1.reformatParamsInPath)(path);
-            this.addPath(swaggerCompatiblePath, {
-                [method]: operation,
-            });
-        };
-        (0, routing_walker_1.walkRouting)({ routing, onEndpoint });
-        this.rootDoc.tags = config.tags ? (0, open_api_helpers_1.depictTags)(config.tags) : [];
-    }
-}
-exports.OpenAPI = OpenAPI;
-//# sourceMappingURL=open-api.js.map

package/dist/open-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"open-api.js","sourceRoot":"","sources":["../src/open-api.ts"],"names":[],"mappings":";;;AAAA,6CAKqB;AACrB,qDAAoE;AAEpE,2DAA0D;AAE1D,yDAS4B;AAE5B,qDAAoE;AAgBpE,MAAa,OAAQ,SAAQ,4BAAc;IAK/B,qBAAqB,CAAC,IAAY,EAAE,MAAc;QAC1D,MAAM,WAAW,GAAG,IAAA,4BAAW,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC9C,IAAI,WAAW,IAAI,IAAI,CAAC,uBAAuB,EAAE;YAC/C,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,WAAW,GAAG,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;SACrE;QACD,IAAI,CAAC,uBAAuB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,WAAW,CAAC;IACrB,CAAC;IAES,4BAA4B,CAAC,OAA6B;QAClE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,IAAI,EAAE,EAAE;YACjE,IACE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;gBACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,EAChE;gBACA,OAAO,IAAI,CAAC;aACb;SACF;QACD,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC;YACtC,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;QACxD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAClC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CACzC,EAAE,CAAC;IACL,CAAC;IAED,YAAmB,EACjB,OAAO,EACP,MAAM,EACN,KAAK,EACL,OAAO,EACP,SAAS,EACT,6BAA6B,GAAG,qBAAqB,EACrD,wBAAwB,GAAG,gBAAgB,EAC3C,yBAAyB,GAAG,IAAI,GAChB;QAChB,KAAK,EAAE,CAAC;QAxCA,0BAAqB,GAC7B,EAAE,CAAC;QACK,4BAAuB,GAA2B,EAAE,CAAC;QAuC7D,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAsC,CACpD,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,EAAE;YACF,MAAM,MAAM,GAAG,OAAiB,CAAC;YACjC,MAAM,YAAY,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;YAChD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAI,CAAC,OAAO,EAAE,MAAM,CAAW,CAAC,GAAG,CAC5D,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CACvC,CAAC;YACF,MAAM,YAAY,GAChB,MAAM,CAAC,YAAY,EAAE,CAAC,MAAM,CAAC,IAAI,oCAAmB,CAAC,MAAM,CAAC,CAAC;YAC/D,MAAM,cAAc,GAAG,IAAA,sCAAmB,EAAC;gBACzC,GAAG,YAAY;gBACf,YAAY;aACb,CAAC,CAAC;YACH,MAAM,SAAS,GAAoB;gBACjC,WAAW,EAAE,IAAI,CAAC,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC;gBACrD,SAAS,EAAE;oBACT,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,IAAA,iCAAc,EAAC;wBACnD,GAAG,YAAY;wBACf,WAAW,EAAE,6BAA6B;wBAC1C,UAAU,EAAE,IAAI;qBACjB,CAAC;oBACF,CAAC,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,EAAE,IAAA,iCAAc,EAAC;wBACnD,GAAG,YAAY;wBACf,WAAW,EAAE,wBAAwB;wBACrC,UAAU,EAAE,KAAK;qBAClB,CAAC;iBACH;aACF,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,SAAS,CAAC,WAAW,GAAG,QAAQ,CAAC;gBACjC,IAAI,yBAAyB,IAAI,SAAS,KAAK,SAAS,EAAE;oBACxD,SAAS,CAAC,OAAO,GAAG,IAAA,yCAAsB,EAAC,QAAQ,CAAC,CAAC;iBACtD;aACF;YACD,IAAI,SAAS,EAAE;gBACb,SAAS,CAAC,OAAO,GAAG,IAAA,yCAAsB,EAAC,SAAS,CAAC,CAAC;aACvD;YACD,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;gBACjC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,CAAC;aACrC;YACD,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC7B,SAAS,CAAC,UAAU,GAAG,cAAc,CAAC;aACvC;YACD,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBACjC,SAAS,CAAC,WAAW,GAAG,IAAA,gCAAa,EAAC,YAAY,CAAC,CAAC;aACrD;YACD,MAAM,YAAY,GAAG,IAAA,qCAAkB,EACrC,IAAA,uCAAmB,EACjB,IAAA,iCAAc,EAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EACtC,CAAC,cAAc,EAAE,EAAE;gBACjB,MAAM,IAAI,GAAG,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC;gBAC/D,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC,QAAQ,CACjD,cAAc,CAAC,IAAI,CACpB;oBACC,CAAC,CAAC,QAAQ,CAAC,SAAS,EAAE;oBACtB,CAAC,CAAC,EAAE,CAAC;gBACP,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;gBAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;YAC1B,CAAC,CACF,CACF,CAAC;YACF,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,SAAS,CAAC,QAAQ,GAAG,YAAY,CAAC;aACnC;YACD,MAAM,qBAAqB,GAAG,IAAA,uCAAoB,EAAC,IAAI,CAAC,CAAC;YACzD,IAAI,CAAC,OAAO,CAAC,qBAAqB,EAAE;gBAClC,CAAC,MAAM,CAAC,EAAE,SAAS;aACpB,CAAC,CAAC;QACL,CAAC,CAAC;QACF,IAAA,4BAAW,EAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,6BAAU,EAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC;CACF;AAtHD,0BAsHC"}

package/dist/result-handler.d.ts

@@ -1,151 +0,0 @@
-import { Request, Response } from "express";
-import { Logger } from "winston";
-import { z } from "zod";
-import { ApiResponse } from "./api-response";
-import { ResultHandlerError } from "./errors";
-import { IOSchema } from "./io-schema";
-interface LastResortHandlerParams {
-    error: ResultHandlerError;
-    logger: Logger;
-    response: Response;
-}
-interface ResultHandlerParams<RES> {
-    error: Error | null;
-    input: any;
-    output: any;
-    request: Request;
-    response: Response<RES>;
-    logger: Logger;
-}
-type ResultHandler<RES> = (params: ResultHandlerParams<RES>) => void | Promise<void>;
-export interface ResultHandlerDefinition<POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny> {
-    getPositiveResponse: (output: IOSchema) => POS | ApiResponse<POS>;
-    getNegativeResponse: () => NEG | ApiResponse<NEG>;
-    handler: ResultHandler<z.output<POS> | z.output<NEG>>;
-}
-export declare const defaultStatusCodes: {
-    positive: number;
-    negative: number;
-};
-export declare const createResultHandler: <POS extends z.ZodTypeAny, NEG extends z.ZodTypeAny>(definition: ResultHandlerDefinition<POS, NEG>) => ResultHandlerDefinition<POS, NEG>;
-export declare const defaultResultHandler: ResultHandlerDefinition<z.ZodObject<{
-    status: z.ZodLiteral<"success">;
-    data: IOSchema<any>;
-}, "strip", z.ZodTypeAny, {
-    status: "success";
-    data?: unknown;
-}, {
-    status: "success";
-    data?: unknown;
-}> & {
-    keyof: () => z.ZodEnum<never>;
-} & {
-    _def: z.ZodObjectDef<{
-        status: z.ZodLiteral<"success">;
-        data: IOSchema<any>;
-    }, "strip", z.ZodTypeAny> & import("./metadata").MetaDef<z.ZodObject<{
-        status: z.ZodLiteral<"success">;
-        data: IOSchema<any>;
-    }, "strip", z.ZodTypeAny, {
-        status: "success";
-        data?: unknown;
-    }, {
-        status: "success";
-        data?: unknown;
-    }>>;
-    example: (example: {
-        status: "success";
-        data?: unknown;
-    }) => z.ZodObject<{
-        status: z.ZodLiteral<"success">;
-        data: IOSchema<any>;
-    }, "strip", z.ZodTypeAny, {
-        status: "success";
-        data?: unknown;
-    }, {
-        status: "success";
-        data?: unknown;
-    }> & {
-        keyof: () => z.ZodEnum<never>;
-    } & any;
-}, z.ZodObject<{
-    status: z.ZodLiteral<"error">;
-    error: z.ZodObject<{
-        message: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-    }, {
-        message: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    status: "error";
-    error: {
-        message: string;
-    };
-}, {
-    status: "error";
-    error: {
-        message: string;
-    };
-}> & {
-    keyof: () => z.ZodEnum<never>;
-} & {
-    _def: z.ZodObjectDef<{
-        status: z.ZodLiteral<"error">;
-        error: z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            message: string;
-        }, {
-            message: string;
-        }>;
-    }, "strip", z.ZodTypeAny> & import("./metadata").MetaDef<z.ZodObject<{
-        status: z.ZodLiteral<"error">;
-        error: z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            message: string;
-        }, {
-            message: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        status: "error";
-        error: {
-            message: string;
-        };
-    }, {
-        status: "error";
-        error: {
-            message: string;
-        };
-    }>>;
-    example: (example: {
-        status: "error";
-        error: {
-            message: string;
-        };
-    }) => z.ZodObject<{
-        status: z.ZodLiteral<"error">;
-        error: z.ZodObject<{
-            message: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            message: string;
-        }, {
-            message: string;
-        }>;
-    }, "strip", z.ZodTypeAny, {
-        status: "error";
-        error: {
-            message: string;
-        };
-    }, {
-        status: "error";
-        error: {
-            message: string;
-        };
-    }> & {
-        keyof: () => z.ZodEnum<never>;
-    } & any;
-}>;
-export declare const lastResortHandler: ({ error, logger, response, }: LastResortHandlerParams) => void;
-export {};

package/dist/result-handler.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lastResortHandler = exports.defaultResultHandler = exports.createResultHandler = exports.defaultStatusCodes = void 0;
-const zod_1 = require("zod");
-const common_helpers_1 = require("./common-helpers");
-const metadata_1 = require("./metadata");
-exports.defaultStatusCodes = {
-    positive: 200,
-    negative: 400,
-};
-const createResultHandler = (definition) => definition;
-exports.createResultHandler = createResultHandler;
-exports.defaultResultHandler = (0, exports.createResultHandler)({
-    getPositiveResponse: (output) => {
-        const examples = (0, metadata_1.getMeta)(output, "examples") || [];
-        const responseSchema = (0, metadata_1.withMeta)(zod_1.z.object({
-            status: zod_1.z.literal("success"),
-            data: output,
-        }));
-        for (const example of examples) {
-            // forwarding output examples to response schema
-            responseSchema.example({
-                status: "success",
-                data: example,
-            });
-        }
-        return responseSchema;
-    },
-    getNegativeResponse: () => (0, metadata_1.withMeta)(zod_1.z.object({
-        status: zod_1.z.literal("error"),
-        error: zod_1.z.object({
-            message: zod_1.z.string(),
-        }),
-    })).example({
-        status: "error",
-        error: {
-            message: (0, common_helpers_1.getMessageFromError)(new Error("Sample error message")),
-        },
-    }),
-    handler: ({ error, input, output, request, response, logger }) => {
-        if (!error) {
-            response.status(exports.defaultStatusCodes.positive).json({
-                status: "success",
-                data: output,
-            });
-            return;
-        }
-        const statusCode = (0, common_helpers_1.getStatusCodeFromError)(error);
-        if (statusCode === 500) {
-            logger.error(`Internal server error\n${error.stack}\n`, {
-                url: request.url,
-                payload: input,
-            });
-        }
-        response.status(statusCode).json({
-            status: "error",
-            error: { message: (0, common_helpers_1.getMessageFromError)(error) },
-        });
-    },
-});
-const lastResortHandler = ({ error, logger, response, }) => {
-    logger.error(`Result handler failure: ${error.message}.`);
-    response
-        .status(500)
-        .end(`An error occurred while serving the result: ${error.message}.` +
-        (error.originalError
-            ? `\nOriginal error: ${error.originalError.message}.`
-            : ""));
-};
-exports.lastResortHandler = lastResortHandler;
-//# sourceMappingURL=result-handler.js.map

package/dist/result-handler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"result-handler.js","sourceRoot":"","sources":["../src/result-handler.ts"],"names":[],"mappings":";;;AAEA,6BAAwB;AAGxB,qDAA+E;AAE/E,yCAA+C;AA8BlC,QAAA,kBAAkB,GAAG;IAChC,QAAQ,EAAE,GAAG;IACb,QAAQ,EAAE,GAAG;CACd,CAAC;AAEK,MAAM,mBAAmB,GAAG,CAIjC,UAA6C,EAC7C,EAAE,CAAC,UAAU,CAAC;AALH,QAAA,mBAAmB,uBAKhB;AAEH,QAAA,oBAAoB,GAAG,IAAA,2BAAmB,EAAC;IACtD,mBAAmB,EAAE,CAAC,MAAgB,EAAE,EAAE;QACxC,MAAM,QAAQ,GAAG,IAAA,kBAAO,EAAC,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC;QACnD,MAAM,cAAc,GAAG,IAAA,mBAAQ,EAC7B,OAAC,CAAC,MAAM,CAAC;YACP,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YAC5B,IAAI,EAAE,MAAM;SACb,CAAC,CACH,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;YAC9B,gDAAgD;YAChD,cAAc,CAAC,OAAO,CAAC;gBACrB,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;SACJ;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,mBAAmB,EAAE,GAAG,EAAE,CACxB,IAAA,mBAAQ,EACN,OAAC,CAAC,MAAM,CAAC;QACP,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;QAC1B,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC;YACd,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;SACpB,CAAC;KACH,CAAC,CACH,CAAC,OAAO,CAAC;QACR,MAAM,EAAE,OAAO;QACf,KAAK,EAAE;YACL,OAAO,EAAE,IAAA,oCAAmB,EAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SAChE;KACF,CAAC;IACJ,OAAO,EAAE,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE;QAC/D,IAAI,CAAC,KAAK,EAAE;YACV,QAAQ,CAAC,MAAM,CAAC,0BAAkB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC;gBAChD,MAAM,EAAE,SAAkB;gBAC1B,IAAI,EAAE,MAAM;aACb,CAAC,CAAC;YACH,OAAO;SACR;QACD,MAAM,UAAU,GAAG,IAAA,uCAAsB,EAAC,KAAK,CAAC,CAAC;QACjD,IAAI,UAAU,KAAK,GAAG,EAAE;YACtB,MAAM,CAAC,KAAK,CAAC,0BAA0B,KAAK,CAAC,KAAK,IAAI,EAAE;gBACtD,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;SACJ;QACD,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;YAC/B,MAAM,EAAE,OAAgB;YACxB,KAAK,EAAE,EAAE,OAAO,EAAE,IAAA,oCAAmB,EAAC,KAAK,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEI,MAAM,iBAAiB,GAAG,CAAC,EAChC,KAAK,EACL,MAAM,EACN,QAAQ,GACgB,EAAE,EAAE;IAC5B,MAAM,CAAC,KAAK,CAAC,2BAA2B,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC;IAC1D,QAAQ;SACL,MAAM,CAAC,GAAG,CAAC;SACX,GAAG,CACF,+CAA+C,KAAK,CAAC,OAAO,GAAG;QAC7D,CAAC,KAAK,CAAC,aAAa;YAClB,CAAC,CAAC,qBAAqB,KAAK,CAAC,aAAa,CAAC,OAAO,GAAG;YACrD,CAAC,CAAC,EAAE,CAAC,CACV,CAAC;AACN,CAAC,CAAC;AAdW,QAAA,iBAAiB,qBAc5B"}

package/dist/routing-walker.d.ts

@@ -1,12 +0,0 @@
-import { AbstractEndpoint } from "./endpoint";
-import { AuxMethod, Method } from "./method";
-import { Routing } from "./routing";
-import { StaticHandler } from "./serve-static";
-export interface RoutingWalkerParams {
-    routing: Routing;
-    onEndpoint: (endpoint: AbstractEndpoint, path: string, method: Method | AuxMethod) => void;
-    onStatic?: (path: string, handler: StaticHandler) => void;
-    parentPath?: string;
-    hasCors?: boolean;
-}
-export declare const walkRouting: ({ routing, onEndpoint, onStatic, parentPath, hasCors, }: RoutingWalkerParams) => void;

package/dist/routing-walker.js

@@ -1,55 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.walkRouting = void 0;
-const depends_on_method_1 = require("./depends-on-method");
-const endpoint_1 = require("./endpoint");
-const errors_1 = require("./errors");
-const serve_static_1 = require("./serve-static");
-const walkRouting = ({ routing, onEndpoint, onStatic, parentPath, hasCors, }) => {
-    Object.entries(routing).forEach(([segment, element]) => {
-        segment = segment.trim();
-        if (segment.match(/\//)) {
-            throw new errors_1.RoutingError("Routing elements should not contain '/' character.\n" +
-                `The error caused by ${parentPath
-                    ? `'${parentPath}' route that has a '${segment}'`
-                    : `'${segment}'`} entry.`);
-        }
-        const path = `${parentPath || ""}${segment ? `/${segment}` : ""}`;
-        if (element instanceof endpoint_1.AbstractEndpoint) {
-            const methods = element.getMethods().slice();
-            if (hasCors) {
-                methods.push("options");
-            }
-            methods.forEach((method) => {
-                onEndpoint(element, path, method);
-            });
-        }
-        else if (element instanceof serve_static_1.ServeStatic) {
-            if (onStatic) {
-                element.apply(path, onStatic);
-            }
-        }
-        else if (element instanceof depends_on_method_1.DependsOnMethod) {
-            Object.entries(element.methods).forEach(([method, endpoint]) => {
-                onEndpoint(endpoint, path, method);
-            });
-            if (hasCors && Object.keys(element.methods).length > 0) {
-                const [firstMethod, ...siblingMethods] = Object.keys(element.methods);
-                const firstEndpoint = element.methods[firstMethod];
-                firstEndpoint._setSiblingMethods(siblingMethods);
-                onEndpoint(firstEndpoint, path, "options");
-            }
-        }
-        else {
-            (0, exports.walkRouting)({
-                onEndpoint,
-                onStatic,
-                hasCors,
-                routing: element,
-                parentPath: path,
-            });
-        }
-    });
-};
-exports.walkRouting = walkRouting;
-//# sourceMappingURL=routing-walker.js.map

package/dist/routing-walker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"routing-walker.js","sourceRoot":"","sources":["../src/routing-walker.ts"],"names":[],"mappings":";;;AAAA,2DAAsD;AACtD,yCAA8C;AAC9C,qCAAwC;AAGxC,iDAA4D;AAcrD,MAAM,WAAW,GAAG,CAAC,EAC1B,OAAO,EACP,UAAU,EACV,QAAQ,EACR,UAAU,EACV,OAAO,GACa,EAAE,EAAE;IACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE;QACrD,OAAO,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;QACzB,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YACvB,MAAM,IAAI,qBAAY,CACpB,sDAAsD;gBACpD,uBACE,UAAU;oBACR,CAAC,CAAC,IAAI,UAAU,uBAAuB,OAAO,GAAG;oBACjD,CAAC,CAAC,IAAI,OAAO,GACjB,SAAS,CACZ,CAAC;SACH;QACD,MAAM,IAAI,GAAG,GAAG,UAAU,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;QAClE,IAAI,OAAO,YAAY,2BAAgB,EAAE;YACvC,MAAM,OAAO,GAA2B,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;YACrE,IAAI,OAAO,EAAE;gBACX,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;aACzB;YACD,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACzB,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;SACJ;aAAM,IAAI,OAAO,YAAY,0BAAW,EAAE;YACzC,IAAI,QAAQ,EAAE;gBACZ,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC/B;SACF;aAAM,IAAI,OAAO,YAAY,mCAAe,EAAE;YAC7C,MAAM,CAAC,OAAO,CAAmB,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CACvD,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE;gBACrB,UAAU,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAgB,CAAC,CAAC;YAC/C,CAAC,CACF,CAAC;YACF,IAAI,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;gBACtD,MAAM,CAAC,WAAW,EAAE,GAAG,cAAc,CAAC,GAAG,MAAM,CAAC,IAAI,CAClD,OAAO,CAAC,OAAO,CACJ,CAAC;gBACd,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAE,CAAC;gBACpD,aAAa,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC;gBACjD,UAAU,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;aAC5C;SACF;aAAM;YACL,IAAA,mBAAW,EAAC;gBACV,UAAU;gBACV,QAAQ;gBACR,OAAO;gBACP,OAAO,EAAE,OAAO;gBAChB,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAxDW,QAAA,WAAW,eAwDtB"}

package/dist/routing.d.ts

@@ -1,15 +0,0 @@
-import { Express } from "express";
-import { Logger } from "winston";
-import { CommonConfig } from "./config-type";
-import { DependsOnMethod } from "./depends-on-method";
-import { AbstractEndpoint } from "./endpoint";
-import { ServeStatic } from "./serve-static";
-export interface Routing {
-    [SEGMENT: string]: Routing | DependsOnMethod | AbstractEndpoint | ServeStatic;
-}
-export declare const initRouting: ({ app, logger, config, routing, }: {
-    app: Express;
-    logger: Logger;
-    config: CommonConfig;
-    routing: Routing;
-}) => void;

package/dist/routing.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initRouting = void 0;
-const routing_walker_1 = require("./routing-walker");
-const startup_logo_1 = require("./startup-logo");
-const initRouting = ({ app, logger, config, routing, }) => {
-    if (config.startupLogo !== false) {
-        console.log((0, startup_logo_1.getStartupLogo)());
-    }
-    (0, routing_walker_1.walkRouting)({
-        routing,
-        hasCors: !!config.cors,
-        onEndpoint: (endpoint, path, method) => {
-            app[method](path, async (request, response) => {
-                logger.info(`${request.method}: ${path}`);
-                await endpoint.execute({ request, response, logger, config });
-            });
-        },
-        onStatic: (path, handler) => {
-            app.use(path, handler);
-        },
-    });
-};
-exports.initRouting = initRouting;
-//# sourceMappingURL=routing.js.map

package/dist/routing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"routing.js","sourceRoot":"","sources":["../src/routing.ts"],"names":[],"mappings":";;;AAKA,qDAA+C;AAE/C,iDAAgD;AAMzC,MAAM,WAAW,GAAG,CAAC,EAC1B,GAAG,EACH,MAAM,EACN,MAAM,EACN,OAAO,GAMR,EAAE,EAAE;IACH,IAAI,MAAM,CAAC,WAAW,KAAK,KAAK,EAAE;QAChC,OAAO,CAAC,GAAG,CAAC,IAAA,6BAAc,GAAE,CAAC,CAAC;KAC/B;IACD,IAAA,4BAAW,EAAC;QACV,OAAO;QACP,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI;QACtB,UAAU,EAAE,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE;YACrC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;gBAC5C,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC,CAAC;gBAC1C,MAAM,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;YAChE,CAAC,CAAC,CAAC;QACL,CAAC;QACD,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE;YAC1B,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AA3BW,QAAA,WAAW,eA2BtB"}

package/dist/schema-walker.d.ts

@@ -1,23 +0,0 @@
-import { z } from "zod";
-import { ZodDateInDef } from "./date-in-schema";
-import { ZodDateOutDef } from "./date-out-schema";
-import { ZodFileDef } from "./file-schema";
-import { ZodUploadDef } from "./upload-schema";
-export type HandlingVariant = "last" | "regular";
-type VariantDependingProps<Variant extends HandlingVariant, U> = Variant extends "regular" ? {
-    next: SchemaHandler<z.ZodTypeAny, U, {}, "last">;
-} : {};
-type SchemaHandlingProps<T extends z.ZodTypeAny, U, Context extends object, Variant extends HandlingVariant> = {
-    schema: T;
-} & Context & VariantDependingProps<Variant, U>;
-export type SchemaHandler<T extends z.ZodTypeAny, U, Context extends object = {}, Variant extends HandlingVariant = "regular"> = (params: SchemaHandlingProps<T, U, Context, Variant>) => U;
-type ProprietaryKinds = ZodFileDef["typeName"] | ZodUploadDef["typeName"] | ZodDateInDef["typeName"] | ZodDateOutDef["typeName"];
-export type HandlingRules<U, Context extends object = {}> = Partial<Record<z.ZodFirstPartyTypeKind | ProprietaryKinds, SchemaHandler<any, U, Context>>>;
-export declare const walkSchema: <U, Context extends object = {}>({ schema, onEach, rules, onMissing, ...context }: {
-    schema: z.ZodTypeAny;
-} & Context & {
-    onEach?: SchemaHandler<z.ZodTypeAny, U, Context, "last"> | undefined;
-    rules: Partial<Record<z.ZodFirstPartyTypeKind | ProprietaryKinds, SchemaHandler<any, U, Context, "regular">>>;
-    onMissing: (schema: z.ZodTypeAny) => U;
-}) => U;
-export {};

package/dist/schema-walker.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.walkSchema = void 0;
-const walkSchema = ({ schema, onEach, rules, onMissing, ...context }) => {
-    const overrides = onEach && onEach({ schema, ...context });
-    const handler = "typeName" in schema._def
-        ? rules[schema._def.typeName]
-        : undefined;
-    const next = (params) => (0, exports.walkSchema)({
-        ...params,
-        ...context,
-        onEach,
-        rules: rules,
-        onMissing,
-    });
-    const result = handler
-        ? handler({
-            schema,
-            ...context,
-            next,
-        })
-        : onMissing(schema);
-    return overrides ? { ...result, ...overrides } : result;
-};
-exports.walkSchema = walkSchema;
-//# sourceMappingURL=schema-walker.js.map

package/dist/schema-walker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema-walker.js","sourceRoot":"","sources":["../src/schema-walker.ts"],"names":[],"mappings":";;;AA8CO,MAAM,UAAU,GAAG,CAAiC,EACzD,MAAM,EACN,MAAM,EACN,KAAK,EACL,SAAS,EACT,GAAG,OAAO,EAKX,EAAK,EAAE;IACN,MAAM,SAAS,GAAG,MAAM,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,GAAI,OAAmB,EAAE,CAAC,CAAC;IACxE,MAAM,OAAO,GACX,UAAU,IAAI,MAAM,CAAC,IAAI;QACvB,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,QAA8B,CAAC;QACnD,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,IAAI,GAA+C,CAAC,MAAM,EAAE,EAAE,CAClE,IAAA,kBAAU,EAAC;QACT,GAAG,MAAM;QACT,GAAI,OAAmB;QACvB,MAAM;QACN,KAAK,EAAE,KAAK;QACZ,SAAS;KACV,CAAC,CAAC;IACL,MAAM,MAAM,GAAG,OAAO;QACpB,CAAC,CAAC,OAAO,CAAC;YACN,MAAM;YACN,GAAI,OAAmB;YACvB,IAAI;SACL,CAAC;QACJ,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACtB,OAAO,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AAC1D,CAAC,CAAC;AAhCW,QAAA,UAAU,cAgCrB"}

package/dist/security.d.ts

@@ -1,72 +0,0 @@
-interface BasicSecurity {
-    type: "basic";
-}
-interface BearerSecurity {
-    type: "bearer";
-    format?: "JWT" | string;
-}
-interface InputSecurity<K extends string> {
-    type: "input";
-    name: K;
-}
-interface CustomHeaderSecurity {
-    type: "header";
-    name: string;
-}
-interface CookieSecurity {
-    type: "cookie";
-    name: string;
-}
-/**
- * @see https://swagger.io/docs/specification/authentication/openid-connect-discovery/
- * @desc available scopes has to be provided via the specified URL
- */
-interface OpenIdSecurity {
-    type: "openid";
-    url: string;
-}
-interface AuthUrl {
-    /**
-     * @desc The authorization URL to use for this flow. Can be relative to the API server URL.
-     * @see https://swagger.io/docs/specification/api-host-and-base-path/
-     */
-    authorizationUrl: string;
-}
-interface TokenUrl {
-    /** @desc The token URL to use for this flow. Can be relative to the API server URL. */
-    tokenUrl: string;
-}
-interface RefreshUrl {
-    /** @desc The URL to be used for obtaining refresh tokens. Can be relative to the API server URL. */
-    refreshUrl?: string;
-}
-interface Scopes<K extends string> {
-    /** @desc The available scopes for the OAuth2 security and their short descriptions. Optional. */
-    scopes?: Record<K, string>;
-}
-type AuthCodeFlow<S extends string> = AuthUrl & TokenUrl & RefreshUrl & Scopes<S>;
-type ImplicitFlow<S extends string> = AuthUrl & RefreshUrl & Scopes<S>;
-type PasswordFlow<S extends string> = TokenUrl & RefreshUrl & Scopes<S>;
-type ClientCredFlow<S extends string> = TokenUrl & RefreshUrl & Scopes<S>;
-/**
- * @see https://swagger.io/docs/specification/authentication/oauth2/
- */
-interface OAuth2Security<S extends string> {
-    type: "oauth2";
-    flows?: {
-        /** @desc Authorization Code flow (previously called accessCode in OpenAPI 2.0) */
-        authorizationCode?: AuthCodeFlow<S>;
-        /** @desc Implicit flow */
-        implicit?: ImplicitFlow<S>;
-        /** @desc Resource Owner Password flow */
-        password?: PasswordFlow<S>;
-        /** @desc Client Credentials flow (previously called application in OpenAPI 2.0) */
-        clientCredentials?: ClientCredFlow<S>;
-    };
-}
-/**
- * @desc K is an optional input field used by InputSecurity
- * @desc S is an optional union of scopes used by OAuth2Security
- * */
-export type Security<K extends string = string, S extends string = string> = BasicSecurity | BearerSecurity | InputSecurity<K> | CustomHeaderSecurity | CookieSecurity | OpenIdSecurity | OAuth2Security<S>;
-export {};

package/dist/security.js

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

package/dist/security.js.map

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

package/dist/serve-static.d.ts

@@ -1,9 +0,0 @@
-import express from "express";
-type OriginalStatic = typeof express.static;
-export type StaticHandler = ReturnType<OriginalStatic>;
-export declare class ServeStatic {
-    params: Parameters<OriginalStatic>;
-    constructor(...params: Parameters<OriginalStatic>);
-    apply(path: string, cb: (path: string, handler: StaticHandler) => void): void;
-}
-export {};

package/dist/serve-static.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServeStatic = void 0;
-const express_1 = __importDefault(require("express"));
-class ServeStatic {
-    constructor(...params) {
-        this.params = params;
-    }
-    apply(path, cb) {
-        return cb(path, express_1.default.static(...this.params));
-    }
-}
-exports.ServeStatic = ServeStatic;
-//# sourceMappingURL=serve-static.js.map

package/dist/serve-static.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"serve-static.js","sourceRoot":"","sources":["../src/serve-static.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA8B;AAK9B,MAAa,WAAW;IAGtB,YAAY,GAAG,MAAkC;QAC/C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAEM,KAAK,CACV,IAAY,EACZ,EAAkD;QAElD,OAAO,EAAE,CAAC,IAAI,EAAE,iBAAO,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAClD,CAAC;CACF;AAbD,kCAaC"}