arkos 2.0.0-next.2 → 2.0.0-next.20

package/dist/cjs/utils/arkos-router/arkos-router-openapi-manager.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"arkos-router-openapi-manager.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/arkos-router-openapi-manager.ts"],"names":[],"mappings":";;;;;AACA,mFAAoD;AAGpD,MAAM,yBAAyB;IAsB7B,eAAe,CACb,YAA0B,EAC1B,iBAAyC,EAAE;QAE3C,MAAM,YAAY,GAAQ;YACxB,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,QAAQ,EAAE,EAAE;SACb,CAAC;QAEF,IAAI,YAAY,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACnC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG;gBAC5C,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;gBAChB,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI;oBAC1B,WAAW,EAAE,aAAa,YAAY,CAAC,OAAO,QAAQ;iBACvD,CAAC;aACH,CAAC;YACF,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAC1B,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;aAAM,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACzC,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG;gBAC5C,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,QAAQ;iBACjB;gBACD,GAAG,CAAC,YAAY,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE,CAAC;gBACjE,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI;oBAC1B,WAAW,EAAE,sBAAsB,YAAY,CAAC,OAAO,QAAQ;iBAChE,CAAC;aACH,CAAC;YACF,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;gBAC1B,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;QACH,CAAC;aAAM,IAAI,YAAY,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1C,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxC,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG;oBACpC,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,QAAQ;qBACjB;oBACD,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;oBACnD,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI;wBAC1B,WAAW,EAAE,sBAAsB,YAAY,CAAC,OAAO,QAAQ;qBAChE,CAAC;iBACH,CAAC;gBACF,IAAI,YAAY,CAAC,QAAQ,EAAE,CAAC;oBAC1B,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC;QACH,CAAC;QAGD,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,YAAY,CAAC,QAAQ,CAAC;QAErE,OAAO,IAAA,0BAAS,EAAC,cAAqB,EAAE,YAAY,CAAC,CAAC;IACxD,CAAC;IAkBD,yBAAyB,CACvB,0BAA+B,EAC/B,SAAiB,EACjB,YAA2B;QAE3B,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,UAAU,GAAG,0BAA0B,EAAE,UAAU,IAAI,EAAE,CAAC;QAChE,MAAM,cAAc,GAAG,0BAA0B,EAAE,QAAQ,IAAI,EAAE,CAAC;QAElE,MAAM,cAAc,GAIf,EAAE,CAAC;QAER,IAAI,YAAY,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,cAAc,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,YAAY,CAAC,KAAK;gBACxB,QAAQ,EAAE,YAAY,CAAC,QAAQ,IAAI,KAAK;gBACxC,YAAY,EAAE,QAAQ;aACvB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,YAAY,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YAC1C,cAAc,CAAC,IAAI,CAAC;gBAClB,IAAI,EAAE,YAAY,CAAC,KAAK;gBACxB,QAAQ,EAAE,YAAY,CAAC,QAAQ,IAAI,KAAK;gBACxC,YAAY,EAAE,OAAO;aACtB,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,YAAY,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3C,KAAK,MAAM,KAAK,IAAI,YAAY,CAAC,MAAM,EAAE,CAAC;gBACxC,cAAc,CAAC,IAAI,CAAC;oBAClB,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,QAAQ,EAAE,YAAY,CAAC,QAAQ,IAAI,KAAK;oBACxC,YAAY,EAAE,OAAO;iBACtB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,cAAc,EAAE,CAAC;YAC9D,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAErC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,CACT,yBAAyB,IAAI,iCAAiC,CAC/D,CAAC;gBACF,SAAS;YACX,CAAC;YAED,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;gBAC9B,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ;oBAC/B,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,mCAAmC,WAAW,CAAC,IAAI,GAAG,CAC5E,CAAC;gBAEJ,IAAI,WAAW,CAAC,MAAM,KAAK,QAAQ;oBACjC,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,qCAAqC,WAAW,CAAC,MAAM,IAAI,WAAW,GAAG,CAC/F,CAAC;YACN,CAAC;iBAAM,IAAI,YAAY,KAAK,OAAO,EAAE,CAAC;gBACpC,IAAI,WAAW,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBACjC,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,kCAAkC,WAAW,CAAC,IAAI,GAAG,CAC3E,CAAC;gBACJ,CAAC;qBAAM,IACL,CAAC,WAAW,CAAC,KAAK;oBAClB,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ;oBACnC,WAAW,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ;oBAErC,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,0DAA0D,CAChF,CAAC;YACN,CAAC;YAED,MAAM,gBAAgB,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACvD,IAAI,QAAQ,IAAI,CAAC,gBAAgB;gBAC/B,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,8DAA8D,CACpF,CAAC;YAEJ,IAAI,CAAC,QAAQ,IAAI,gBAAgB;gBAC/B,MAAM,CAAC,IAAI,CACT,iBAAiB,IAAI,8DAA8D,CACpF,CAAC;QACN,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,kEAAkE,SAAS,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC7H,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED,MAAM,yBAAyB,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAElE,kBAAe,yBAAyB,CAAC","sourcesContent":["import { OpenAPIV3 } from \"openapi-types\";\nimport deepmerge from \"../helpers/deepmerge.helper\";\nimport { UploadConfig } from \"./types/upload-config\";\n\nclass ArkosRouterOpenAPIManager {\n  /**\n   * Generates OpenAPI schema for file upload fields in multipart/form-data requests.\n   * Converts upload configuration into OpenAPI-compliant schema and merges with existing body schema.\n   *\n   * @param {UploadConfig} uploadConfig - The upload configuration from config.experimental.uploads\n   * @param {any} existingSchema - Existing JSON schema from config.validation.body (optional)\n   * @returns {{ schema: any }} OpenAPI schema object for multipart/form-data content type\n   *\n   * @example\n   * // Single file upload\n   * addUploadFields({ type: 'single', field: 'avatar', maxSize: 5242880 })\n   * // Returns: { schema: { type: 'object', properties: { avatar: { type: 'string', format: 'binary' } } } }\n   *\n   * @example\n   * // Array file upload\n   * addUploadFields({ type: 'array', field: 'gallery', maxCount: 10 })\n   *\n   * @example\n   * // Multiple fields upload\n   * addUploadFields({ type: 'fields', fields: [{ name: 'avatar', maxCount: 1 }, { name: 'resume', maxCount: 1 }] })\n   */\n  addUploadFields(\n    uploadConfig: UploadConfig,\n    existingSchema: OpenAPIV3.SchemaObject = {}\n  ): OpenAPIV3.SchemaObject {\n    const uploadSchema: any = {\n      type: \"object\",\n      properties: {},\n      required: [],\n    };\n\n    if (uploadConfig.type === \"single\") {\n      uploadSchema.properties[uploadConfig.field] = {\n        type: \"string\",\n        format: \"binary\",\n        ...(uploadConfig.maxSize && {\n          description: `Max size: ${uploadConfig.maxSize} bytes`,\n        }),\n      };\n      if (uploadConfig.required) {\n        uploadSchema.required.push(uploadConfig.field);\n      }\n    } else if (uploadConfig.type === \"array\") {\n      uploadSchema.properties[uploadConfig.field] = {\n        type: \"array\",\n        items: {\n          type: \"string\",\n          format: \"binary\",\n        },\n        ...(uploadConfig.maxCount && { maxItems: uploadConfig.maxCount }),\n        ...(uploadConfig.maxSize && {\n          description: `Max size per file: ${uploadConfig.maxSize} bytes`,\n        }),\n      };\n      if (uploadConfig.required) {\n        uploadSchema.required.push(uploadConfig.field);\n      }\n    } else if (uploadConfig.type === \"fields\") {\n      for (const field of uploadConfig.fields) {\n        uploadSchema.properties[field.name] = {\n          type: \"array\",\n          items: {\n            type: \"string\",\n            format: \"binary\",\n          },\n          ...(field.maxCount && { maxItems: field.maxCount }),\n          ...(uploadConfig.maxSize && {\n            description: `Max size per file: ${uploadConfig.maxSize} bytes`,\n          }),\n        };\n        if (uploadConfig.required) {\n          uploadSchema.required.push(field.name);\n        }\n      }\n    }\n\n    // Clean up empty required array\n    if (uploadSchema.required.length === 0) delete uploadSchema.required;\n\n    return deepmerge(existingSchema as any, uploadSchema);\n  }\n\n  /**\n   * Validates that a user-defined multipart/form-data schema includes all required upload fields\n   * with correct types, formats, and required flags.\n   *\n   * @param {any} userDefinedMultipartSchema - The schema object from openapi.requestBody.content['multipart/form-data'].schema\n   * @param {UploadConfig} uploadConfig - The upload configuration from config.experimental.uploads\n   * @param {string} routePath - The route path for error context\n   * @throws {Error} If upload fields are missing or incorrectly defined\n   *\n   * @example\n   * validateMultipartFormDocs(\n   *   { type: 'object', properties: { avatar: { type: 'string', format: 'binary' } } },\n   *   { type: 'single', field: 'avatar', required: true },\n   *   '/users/:id/avatar'\n   * )\n   */\n  validateMultipartFormDocs(\n    userDefinedMultipartSchema: any,\n    routePath: string,\n    uploadConfig?: UploadConfig\n  ): void {\n    const errors: string[] = [];\n    const properties = userDefinedMultipartSchema?.properties || {};\n    const requiredFields = userDefinedMultipartSchema?.required || [];\n\n    const expectedFields: Array<{\n      name: string;\n      required: boolean;\n      expectedType: \"single\" | \"array\";\n    }> = [];\n\n    if (uploadConfig?.type === \"single\") {\n      expectedFields.push({\n        name: uploadConfig.field,\n        required: uploadConfig.required || false,\n        expectedType: \"single\",\n      });\n    } else if (uploadConfig?.type === \"array\") {\n      expectedFields.push({\n        name: uploadConfig.field,\n        required: uploadConfig.required || false,\n        expectedType: \"array\",\n      });\n    } else if (uploadConfig?.type === \"fields\") {\n      for (const field of uploadConfig.fields) {\n        expectedFields.push({\n          name: field.name,\n          required: uploadConfig.required || false,\n          expectedType: \"array\",\n        });\n      }\n    }\n\n    for (const { name, required, expectedType } of expectedFields) {\n      const fieldSchema = properties[name];\n\n      if (!fieldSchema) {\n        errors.push(\n          `Missing upload field '${name}' in multipart/form-data schema`\n        );\n        continue;\n      }\n\n      if (expectedType === \"single\") {\n        if (fieldSchema.type !== \"string\")\n          errors.push(\n            `Upload field '${name}' must have type 'string', got '${fieldSchema.type}'`\n          );\n\n        if (fieldSchema.format !== \"binary\")\n          errors.push(\n            `Upload field '${name}' must have format 'binary', got '${fieldSchema.format || \"undefined\"}'`\n          );\n      } else if (expectedType === \"array\") {\n        if (fieldSchema.type !== \"array\") {\n          errors.push(\n            `Upload field '${name}' must have type 'array', got '${fieldSchema.type}'`\n          );\n        } else if (\n          !fieldSchema.items ||\n          fieldSchema.items.type !== \"string\" ||\n          fieldSchema.items.format !== \"binary\"\n        )\n          errors.push(\n            `Upload field '${name}' must have items with type 'string' and format 'binary'`\n          );\n      }\n\n      const isMarkedRequired = requiredFields.includes(name);\n      if (required && !isMarkedRequired)\n        errors.push(\n          `Upload field '${name}' is required in config but not marked as required in schema`\n        );\n\n      if (!required && isMarkedRequired)\n        errors.push(\n          `Upload field '${name}' is not required in config but marked as required in schema`\n        );\n    }\n\n    if (errors.length > 0) {\n      throw new Error(\n        `ValidationError: Invalid multipart/form-data schema for route '${routePath}':\\n${errors.map((e) => `  - ${e}`).join(\"\\n\")}`\n      );\n    }\n  }\n}\n\nconst arkosRouterOpenApiManager = new ArkosRouterOpenAPIManager();\n\nexport default arkosRouterOpenApiManager;\n"]}

package/dist/cjs/utils/arkos-router/index.js

@@ -1,253 +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.default = ArkosRouter;
-exports.generateOpenAPIFromApp = generateOpenAPIFromApp;
-const express_1 = require("express");
-const route_config_validator_1 = __importDefault(require("./route-config-validator.js"));
-const route_config_registry_1 = __importDefault(require("./route-config-registry.js"));
-const helpers_1 = require("./utils/helpers/index.js");
-const exports_1 = require("../../exports/index.js");
-const error_handler_1 = require("../../exports/error-handler/index.js");
-const zod_to_json_schema_1 = __importDefault(require("zod-to-json-schema"));
-const class_validator_to_json_schema_1 = __importDefault(require("../../modules/swagger/utils/helpers/class-validator-to-json-schema.js"));
-const openapi_schema_converter_1 = __importDefault(require("../../modules/swagger/utils/helpers/openapi-schema-converter.js"));
-const upload_manager_1 = __importDefault(require("./utils/helpers/upload-manager.js"));
-const fs_helpers_1 = require("../helpers/fs.helpers.js");
-const arkos_router_openapi_manager_1 = __importDefault(require("./arkos-router-openapi-manager.js"));
-const deepmerge_helper_1 = __importDefault(require("../helpers/deepmerge.helper.js"));
-function ArkosRouter(options) {
-    const router = (0, express_1.Router)(options);
-    return new Proxy(router, {
-        get(target, prop, receiver) {
-            const originalMethod = Reflect.get(target, prop, receiver);
-            const httpMethods = [
-                "get",
-                "post",
-                "put",
-                "patch",
-                "delete",
-                "all",
-                "head",
-                "trace",
-                "options",
-            ];
-            if (prop === "route") {
-                return function (path) {
-                    const routeChain = {};
-                    httpMethods.forEach((method) => {
-                        routeChain[method] = function (config, ...handlers) {
-                            const fullConfig = {
-                                authentication: true,
-                                ...config,
-                                ...(options?.openapi
-                                    ? {
-                                        experimental: {
-                                            openapi: options.openapi,
-                                        },
-                                    }
-                                    : {}),
-                                path,
-                            };
-                            receiver[method](fullConfig, ...handlers);
-                            return routeChain;
-                        };
-                    });
-                    return routeChain;
-                };
-            }
-            if (httpMethods.includes(prop)) {
-                return function (config, ...handlers) {
-                    if (config.disabled)
-                        return;
-                    if (!route_config_validator_1.default.isArkosRouteConfig(config))
-                        throw Error(`First argument of ArkosRouter().${prop}() must be a valid ArkosRouteConfig object with path field, but recevied ${typeof config === "object" ? JSON.stringify(config, null, 2) : config}`);
-                    const path = (0, helpers_1.applyPrefix)(options?.prefix, config.path);
-                    config = {
-                        authentication: true,
-                        ...config,
-                        ...(options?.openapi
-                            ? {
-                                experimental: {
-                                    ...config?.experimental,
-                                    openapi: (0, deepmerge_helper_1.default)(options.openapi || {}, config?.experimental?.openapi || {}),
-                                },
-                            }
-                            : {}),
-                        path,
-                    };
-                    if ([null, undefined].includes(path))
-                        throw Error("Please pass valid value for path field to use in your route");
-                    const method = prop;
-                    const UndefinedHandlerError = (handler) => Error(`Wrong value for handler in route ${method.toUpperCase()} ${path}, recevied ${handler}.`);
-                    if (handlers.length > 0) {
-                        const flattenHandlers = (arr) => {
-                            return arr.reduce((flat, item) => {
-                                return flat.concat(Array.isArray(item) ? flattenHandlers(item) : item);
-                            }, []);
-                        };
-                        const flatHandlers = flattenHandlers(handlers);
-                        handlers = flatHandlers.map((handler) => {
-                            if (!handler)
-                                throw UndefinedHandlerError(handler);
-                            if (typeof handler !== "function") {
-                                throw UndefinedHandlerError(handler);
-                            }
-                            return (0, error_handler_1.catchAsync)(handler, {
-                                type: handler.length > 3 ? "error" : "normal",
-                            });
-                        });
-                        const finalHandler = handlers[handlers.length - 1];
-                        route_config_registry_1.default.register(finalHandler, config, method);
-                    }
-                    const arkosConfig = (0, exports_1.getArkosConfig)();
-                    const validationConfig = arkosConfig.validation;
-                    const authenticationConfig = arkosConfig.authentication;
-                    const strictValidation = validationConfig?.strict;
-                    const route = `${method.toUpperCase()} ${path}`;
-                    if (strictValidation &&
-                        (!("validation" in config) ||
-                            ("validation" in config &&
-                                !config.validation &&
-                                config.validation !== undefined)))
-                        throw Error("When using strict validation you must either pass { validation: false } in order to explicitly tell that no input will be received, or pass `undefined` for each input type e.g { validation: { query: undefined } } in order to deny the input of given request input.");
-                    if (!validationConfig?.resolver &&
-                        Object.keys(config.validation || {}).length > 0)
-                        throw Error(`Trying to pass validators into route ${route} config validation option without choosing a validation resolver under arkos.init({ validation: { resolver: '' } })`);
-                    if (config.authentication && !authenticationConfig?.mode)
-                        throw Error(`Trying to authenticate route ${route} without choosing an authentication mode under arkos.config.${(0, fs_helpers_1.getUserFileExtension)()}
-
-For further help see https://www.arkosjs.com/docs/core-concepts/authentication-system.`);
-                    handlers = [...(0, helpers_1.getMiddlewareStack)(config), ...handlers];
-                    if (config.experimental?.uploads &&
-                        config.experimental.uploads.deleteOnError !== false)
-                        handlers.push((0, error_handler_1.catchAsync)(upload_manager_1.default.handleFileCleanup(config.experimental.uploads), { type: "error" }));
-                    return originalMethod.call(target, path, ...handlers);
-                };
-            }
-            return originalMethod;
-        },
-    });
-}
-function generateOpenAPIFromApp(app) {
-    const routes = (0, helpers_1.extractArkosRoutes)(app);
-    const arkosConfig = (0, exports_1.getArkosConfig)();
-    let paths = {};
-    routes.forEach(({ path, method, config }) => {
-        if (config?.experimental?.openapi === false)
-            return;
-        const originalPath = path;
-        const pathParatemersFromRoutePath = (0, helpers_1.extractPathParams)(path);
-        for (const parameter of pathParatemersFromRoutePath) {
-            path = path.replaceAll(`:${parameter}`, parameter.endsWith("?") ? `{${parameter}}?` : `{${parameter}}`);
-        }
-        if (!paths[path])
-            paths[path] = {};
-        if (typeof config?.experimental?.openapi === "boolean") {
-            config = {
-                ...config,
-                experimental: {
-                    ...config.experimental,
-                    openapi: {},
-                },
-            };
-        }
-        const openapi = typeof config?.experimental?.openapi === "object" &&
-            config.experimental.openapi !== null
-            ? config.experimental.openapi
-            : {};
-        const validatorToJsonSchema = arkosConfig?.validation?.resolver === "zod"
-            ? zod_to_json_schema_1.default
-            : class_validator_to_json_schema_1.default;
-        let parameters = [];
-        const validationToParameterMapping = {
-            query: "query",
-            params: "path",
-            headers: "header",
-            cookies: "cookie",
-        };
-        if (typeof config?.validation !== "boolean" && config?.validation) {
-            for (const [key, val] of Object.entries(config?.validation)) {
-                if (["body"].includes(key))
-                    continue;
-                if ((config?.validation)[key]) {
-                    const jsonSchema = validatorToJsonSchema(val);
-                    const params = openapi_schema_converter_1.default.jsonSchemaToOpenApiParameters(validationToParameterMapping[key], jsonSchema);
-                    parameters.push(...params);
-                }
-            }
-        }
-        const convertedOpenAPI = openapi_schema_converter_1.default.convertOpenAPIConfig(openapi);
-        const allParameters = [
-            ...(convertedOpenAPI.parameters || []),
-            ...parameters,
-        ];
-        for (const parameter of pathParatemersFromRoutePath) {
-            if (!allParameters.find(({ name, in: paramIn }) => name === parameter.replace("?", "") && paramIn === "path"))
-                allParameters.push({
-                    name: parameter,
-                    in: "path",
-                    required: !parameter.includes("?"),
-                    schema: { type: "string" },
-                });
-        }
-        for (const param of allParameters) {
-            if (!pathParatemersFromRoutePath.includes(param.name) &&
-                !pathParatemersFromRoutePath.includes(`${param.name}?`) &&
-                param.in === "path")
-                throw new Error(`ValidationError: Trying to define path parameter '${param.name}' but it is not present in your pathname ${originalPath}`);
-        }
-        delete convertedOpenAPI.parameters;
-        const hasUploadFields = Object.keys(config?.experimental?.uploads || {}).length > 0;
-        const multipartFormSchema = convertedOpenAPI?.requestBody?.content?.["multipart/form-data"];
-        if (hasUploadFields && multipartFormSchema)
-            arkos_router_openapi_manager_1.default.validateMultipartFormDocs(multipartFormSchema, path, config?.experimental?.uploads);
-        paths[path][method.toLowerCase()] = {
-            summary: openapi?.summary || `${path}`,
-            description: openapi?.description || `${method} ${path}`,
-            tags: openapi?.tags || ["Defaults"],
-            operationId: `${method.toLowerCase()}:${path}`,
-            parameters: allParameters,
-            ...(!convertedOpenAPI.requestBody &&
-                config?.validation &&
-                config?.validation?.body && {
-                requestBody: {
-                    content: (() => {
-                        const schema = validatorToJsonSchema(config?.validation?.body);
-                        return {
-                            ...(hasUploadFields && {
-                                "multipart/form-data": {
-                                    schema: openapi_schema_converter_1.default.flattenSchema(arkos_router_openapi_manager_1.default.addUploadFields(config.experimental?.uploads, schema)),
-                                },
-                            }),
-                            "application/json": {
-                                schema,
-                            },
-                        };
-                    })(),
-                },
-            }),
-            ...(convertedOpenAPI?.requestBody?.content?.["application/json"] &&
-                !multipartFormSchema &&
-                !config?.validation?.body &&
-                hasUploadFields && {
-                requestBody: {
-                    content: (() => {
-                        const schema = convertedOpenAPI?.requestBody?.content?.["application/json"];
-                        return {
-                            "multipart/form-data": {
-                                schema: openapi_schema_converter_1.default.flattenSchema(arkos_router_openapi_manager_1.default.addUploadFields(config?.experimental?.uploads || {}, schema)),
-                            },
-                            ...convertedOpenAPI?.requestBody,
-                        };
-                    })(),
-                },
-            }),
-            ...convertedOpenAPI,
-        };
-    });
-    return paths;
-}
-//# sourceMappingURL=index.js.map

package/dist/cjs/utils/arkos-router/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/index.ts"],"names":[],"mappings":";;;;;AAmDA,8BAiLC;AAED,wDA8KC;AApZD,qCAAgD;AAShD,sFAA4D;AAC5D,oFAA0D;AAC1D,6CAKyB;AACzB,2CAA+C;AAC/C,+DAAyD;AACzD,4EAAiD;AACjD,wIAA4G;AAC5G,4HAAkG;AAClG,oFAA2D;AAC3D,sDAA6D;AAC7D,kGAAuE;AACvE,mFAAoD;AA0BpD,SAAwB,WAAW,CACjC,OAGC;IAED,MAAM,MAAM,GAAG,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC;IAE/B,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACxB,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YAE3D,MAAM,WAAW,GAAG;gBAClB,KAAK;gBACL,MAAM;gBACN,KAAK;gBACL,OAAO;gBACP,QAAQ;gBACR,KAAK;gBACL,MAAM;gBACN,OAAO;gBACP,SAAS;aACD,CAAC;YAEX,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,UAAU,IAAgB;oBAC/B,MAAM,UAAU,GAAQ,EAAE,CAAC;oBAE3B,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC7B,UAAU,CAAC,MAAM,CAAC,GAAG,UACnB,MAA+D,EAC/D,GAAG,QAAkC;4BAErC,MAAM,UAAU,GAAqB;gCACnC,cAAc,EAAE,IAAI;gCACpB,GAAG,MAAM;gCACT,GAAG,CAAC,OAAO,EAAE,OAAO;oCAClB,CAAC,CAAC;wCACE,YAAY,EAAE;4CACZ,OAAO,EAAE,OAAO,CAAC,OAAO;yCACzB;qCACF;oCACH,CAAC,CAAC,EAAE,CAAC;gCACP,IAAI;6BACL,CAAC;4BAEF,QAAQ,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC,CAAC;4BAE1C,OAAO,UAAyB,CAAC;wBACnC,CAAC,CAAC;oBACJ,CAAC,CAAC,CAAC;oBAEH,OAAO,UAAU,CAAC;gBACpB,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAW,CAAC,EAAE,CAAC;gBACtC,OAAO,UACL,MAAwB,EACxB,GAAG,QAAkC;oBAErC,IAAI,MAAM,CAAC,QAAQ;wBAAE,OAAO;oBAE5B,IAAI,CAAC,gCAAoB,CAAC,kBAAkB,CAAC,MAAM,CAAC;wBAClD,MAAM,KAAK,CACT,mCAAmC,IAAc,4EAA4E,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CACrM,CAAC;oBAEJ,MAAM,IAAI,GAAG,IAAA,qBAAW,EAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;oBAEvD,MAAM,GAAG;wBACP,cAAc,EAAE,IAAI;wBACpB,GAAG,MAAM;wBACT,GAAG,CAAC,OAAO,EAAE,OAAO;4BAClB,CAAC,CAAC;gCACE,YAAY,EAAE;oCACZ,GAAG,MAAM,EAAE,YAAY;oCACvB,OAAO,EAAE,IAAA,0BAAS,EAChB,OAAO,CAAC,OAAO,IAAI,EAAE,EACrB,MAAM,EAAE,YAAY,EAAE,OAAO,IAAI,EAAE,CACpC;iCACF;6BACF;4BACH,CAAC,CAAC,EAAE,CAAC;wBACP,IAAI;qBACL,CAAC;oBAEF,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAW,CAAC;wBACzC,MAAM,KAAK,CACT,6DAA6D,CAC9D,CAAC;oBAEJ,MAAM,MAAM,GAAG,IAAc,CAAC;oBAC9B,MAAM,qBAAqB,GAAG,CAAC,OAAY,EAAE,EAAE,CAC7C,KAAK,CACH,oCAAoC,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,cAAc,OAAO,GAAG,CACzF,CAAC;oBAEJ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACxB,MAAM,eAAe,GAAG,CAAC,GAAU,EAA4B,EAAE;4BAC/D,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;gCAC/B,OAAO,IAAI,CAAC,MAAM,CAChB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CACnD,CAAC;4BACJ,CAAC,EAAE,EAAE,CAAC,CAAC;wBACT,CAAC,CAAC;wBAEF,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;wBAE/C,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,OAA+B,EAAE,EAAE;4BAC9D,IAAI,CAAC,OAAO;gCAAE,MAAM,qBAAqB,CAAC,OAAO,CAAC,CAAC;4BAEnD,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE,CAAC;gCAClC,MAAM,qBAAqB,CAAC,OAAO,CAAC,CAAC;4BACvC,CAAC;4BAED,OAAO,IAAA,0BAAU,EAAC,OAAO,EAAE;gCACzB,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ;6BAC9C,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;wBAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wBACnD,+BAAmB,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;oBAC7D,CAAC;oBAED,MAAM,WAAW,GAAG,IAAA,wBAAc,GAAE,CAAC;oBACrC,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC;oBAChD,MAAM,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC;oBACxD,MAAM,gBAAgB,GAAG,gBAAgB,EAAE,MAAM,CAAC;oBAClD,MAAM,KAAK,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;oBAEhD,IACE,gBAAgB;wBAChB,CAAC,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC;4BACxB,CAAC,YAAY,IAAI,MAAM;gCACrB,CAAC,MAAM,CAAC,UAAU;gCAClB,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC;wBAErC,MAAM,KAAK,CACT,yQAAyQ,CAC1Q,CAAC;oBAEJ,IACE,CAAC,gBAAgB,EAAE,QAAQ;wBAC3B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;wBAE/C,MAAM,KAAK,CACT,wCAAwC,KAAK,qHAAqH,CACnK,CAAC;oBAEJ,IAAI,MAAM,CAAC,cAAc,IAAI,CAAC,oBAAoB,EAAE,IAAI;wBACtD,MAAM,KAAK,CACT,gCAAgC,KAAK,+DAA+D,IAAA,iCAAoB,GAAE;;uFAEjD,CAC1E,CAAC;oBAEJ,QAAQ,GAAG,CAAC,GAAG,IAAA,4BAAkB,EAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC;oBAExD,IACE,MAAM,CAAC,YAAY,EAAE,OAAO;wBAC5B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,KAAK;wBAEnD,QAAQ,CAAC,IAAI,CACX,IAAA,0BAAU,EACR,wBAAa,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAC5D,EAAE,IAAI,EAAE,OAAO,EAAE,CAClB,CACF,CAAC;oBAEJ,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC;gBACxD,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,cAAc,CAAC;QACxB,CAAC;KACF,CAAiB,CAAC;AACrB,CAAC;AAED,SAAgB,sBAAsB,CAAC,GAAQ;IAC7C,MAAM,MAAM,GAAG,IAAA,4BAAkB,EAAC,GAAG,CAAC,CAAC;IACvC,MAAM,WAAW,GAAG,IAAA,wBAAc,GAAE,CAAC;IAErC,IAAI,KAAK,GAGL,EAAE,CAAC;IAEP,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE;QAC1C,IAAI,MAAM,EAAE,YAAY,EAAE,OAAO,KAAK,KAAK;YAAE,OAAO;QACpD,MAAM,YAAY,GAAG,IAAI,CAAC;QAE1B,MAAM,2BAA2B,GAAG,IAAA,2BAAiB,EAAC,IAAI,CAAC,CAAC;QAC5D,KAAK,MAAM,SAAS,IAAI,2BAA2B,EAAE,CAAC;YACpD,IAAI,GAAG,IAAI,CAAC,UAAU,CACpB,IAAI,SAAS,EAAE,EACf,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,SAAS,IAAI,CAAC,CAAC,CAAC,IAAI,SAAS,GAAG,CAC/D,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnC,IAAI,OAAO,MAAM,EAAE,YAAY,EAAE,OAAO,KAAK,SAAS,EAAE,CAAC;YACvD,MAAM,GAAG;gBACP,GAAG,MAAM;gBACT,YAAY,EAAE;oBACZ,GAAG,MAAM,CAAC,YAAY;oBACtB,OAAO,EAAE,EAAE;iBACZ;aACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,GACX,OAAO,MAAM,EAAE,YAAY,EAAE,OAAO,KAAK,QAAQ;YACjD,MAAM,CAAC,YAAY,CAAC,OAAO,KAAK,IAAI;YAClC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO;YAC7B,CAAC,CAAC,EAAE,CAAC;QAET,MAAM,qBAAqB,GACzB,WAAW,EAAE,UAAU,EAAE,QAAQ,KAAK,KAAK;YACzC,CAAC,CAAC,4BAAe;YACjB,CAAC,CAAC,wCAA0B,CAAC;QAEjC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,MAAM,4BAA4B,GAAG;YACnC,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,QAAQ;SAClB,CAAC;QAEF,IAAI,OAAO,MAAM,EAAE,UAAU,KAAK,SAAS,IAAI,MAAM,EAAE,UAAU,EAAE,CAAC;YAClE,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,CAAC;gBAC5D,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAAE,SAAS;gBACrC,IAAI,CAAC,MAAM,EAAE,UAAkB,CAAA,CAAC,GAAG,CAAC,EAAE,CAAC;oBACrC,MAAM,UAAU,GAAG,qBAAqB,CAAC,GAAU,CAAC,CAAC;oBACrD,MAAM,MAAM,GAAG,kCAAsB,CAAC,6BAA6B,CAChE,4BAAoC,CAAC,GAAG,CAAC,EAC1C,UAAU,CACX,CAAC;oBACF,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;gBAC7B,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,gBAAgB,GACpB,kCAAsB,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;QAEvD,MAAM,aAAa,GAAgC;YACjD,GAAG,CAAC,gBAAgB,CAAC,UAAU,IAAI,EAAE,CAAC;YACtC,GAAG,UAAU;SACd,CAAC;QAEF,KAAK,MAAM,SAAS,IAAI,2BAA2B,EAAE,CAAC;YACpD,IACE,CAAC,aAAa,CAAC,IAAI,CACjB,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CACxB,IAAI,KAAK,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,OAAO,KAAK,MAAM,CAC5D;gBAED,aAAa,CAAC,IAAI,CAAC;oBACjB,IAAI,EAAE,SAAS;oBACf,EAAE,EAAE,MAAM;oBACV,QAAQ,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC;oBAClC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC3B,CAAC,CAAC;QACP,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;YAClC,IACE,CAAC,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC;gBACjD,CAAC,2BAA2B,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,IAAI,GAAG,CAAC;gBACvD,KAAK,CAAC,EAAE,KAAK,MAAM;gBAEnB,MAAM,IAAI,KAAK,CACb,qDAAqD,KAAK,CAAC,IAAI,4CAA4C,YAAY,EAAE,CAC1H,CAAC;QACN,CAAC;QAED,OAAO,gBAAgB,CAAC,UAAU,CAAC;QACnC,MAAM,eAAe,GACnB,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QAC9D,MAAM,mBAAmB,GACvB,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,qBAAqB,CAAC,CAAC;QAElE,IAAI,eAAe,IAAI,mBAAmB;YACxC,sCAAyB,CAAC,yBAAyB,CACjD,mBAAmB,EACnB,IAAI,EACJ,MAAM,EAAE,YAAY,EAAE,OAAO,CAC9B,CAAC;QAEH,KAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG;YAC3C,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,GAAG,IAAI,EAAE;YACtC,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,MAAM,IAAI,IAAI,EAAE;YACxD,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC;YACnC,WAAW,EAAE,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE;YAC9C,UAAU,EAAE,aAAa;YACzB,GAAG,CAAC,CAAC,gBAAgB,CAAC,WAAW;gBAC/B,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE,UAAU,EAAE,IAAI,IAAI;gBAC1B,WAAW,EAAE;oBACX,OAAO,EAAE,CAAC,GAAG,EAAE;wBACb,MAAM,MAAM,GAAG,qBAAqB,CAClC,MAAM,EAAE,UAAU,EAAE,IAAW,CAChC,CAAC;wBAEF,OAAO;4BACL,GAAG,CAAC,eAAe,IAAI;gCACrB,qBAAqB,EAAE;oCACrB,MAAM,EAAE,kCAAsB,CAAC,aAAa,CAC1C,sCAAyB,CAAC,eAAe,CACvC,MAAM,CAAC,YAAY,EAAE,OAAQ,EAC7B,MAAM,CACP,CACF;iCACF;6BACF,CAAC;4BACF,kBAAkB,EAAE;gCAClB,MAAM;6BACP;yBACF,CAAC;oBACJ,CAAC,CAAC,EAAE;iBACL;aACF,CAAC;YACJ,GAAG,CAAC,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC;gBAC9D,CAAC,mBAAmB;gBACpB,CAAE,MAAc,EAAE,UAAU,EAAE,IAAI;gBAClC,eAAe,IAAI;gBACjB,WAAW,EAAE;oBACX,OAAO,EAAE,CAAC,GAAG,EAAE;wBACb,MAAM,MAAM,GACV,gBAAgB,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,kBAAkB,CAAC,CAAC;wBAE/D,OAAO;4BACL,qBAAqB,EAAE;gCACrB,MAAM,EAAE,kCAAsB,CAAC,aAAa,CAC1C,sCAAyB,CAAC,eAAe,CACvC,MAAM,EAAE,YAAY,EAAE,OAAQ,IAAI,EAAE,EACpC,MAAM,CACP,CACF;6BACF;4BACD,GAAG,gBAAgB,EAAE,WAAW;yBACjC,CAAC;oBACJ,CAAC,CAAC,EAAE;iBACL;aACF,CAAC;YACJ,GAAG,gBAAgB;SACpB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { Router, RouterOptions } from \"express\";\nimport {\n  IArkosRouter,\n  ArkosRouteConfig,\n  ArkosAnyRequestHandler,\n  PathParams,\n  ArkosIRoute,\n} from \"./types\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport RouteConfigValidator from \"./route-config-validator\";\nimport RouteConfigRegistry from \"./route-config-registry\";\nimport {\n  applyPrefix,\n  extractArkosRoutes,\n  extractPathParams,\n  getMiddlewareStack,\n} from \"./utils/helpers\";\nimport { getArkosConfig } from \"../../exports\";\nimport { catchAsync } from \"../../exports/error-handler\";\nimport zodToJsonSchema from \"zod-to-json-schema\";\nimport classValidatorToJsonSchema from \"../../modules/swagger/utils/helpers/class-validator-to-json-schema\";\nimport openApiSchemaConverter from \"../../modules/swagger/utils/helpers/openapi-schema-converter\";\nimport uploadManager from \"./utils/helpers/upload-manager\";\nimport { getUserFileExtension } from \"../helpers/fs.helpers\";\nimport arkosRouterOpenApiManager from \"./arkos-router-openapi-manager\";\nimport deepmerge from \"../helpers/deepmerge.helper\";\n\n/**\n * Creates an enhanced Express Router with features like OpenAPI documentation capabilities and smart data validation.\n *\n * The ArkosRouter extends the standard Express Router with the ability to\n * automatically capture OpenAPI metadata from route configurations.\n *\n * @example\n * const router = ArkosRouter();\n *\n * router.get(\n *   {\n *     path: \"/users/:id\",\n *     openapi: {\n *       summary: \"Get user by ID\",\n *       tags: [\"Users\"]\n *     }\n *   },\n *   (req, res) => { ... }\n * );\n *\n * @returns {IArkosRouter} A proxied Express Router instance with enhanced OpenAPI capabilities\n *\n * @see {@link ArkosRouteConfig} for configuration options\n */\nexport default function ArkosRouter(\n  options?: RouterOptions & {\n    prefix?: string | RegExp | Array<string | RegExp>;\n    openapi?: { tags?: string[] };\n  }\n): IArkosRouter {\n  const router = Router(options);\n\n  return new Proxy(router, {\n    get(target, prop, receiver) {\n      const originalMethod = Reflect.get(target, prop, receiver);\n\n      const httpMethods = [\n        \"get\",\n        \"post\",\n        \"put\",\n        \"patch\",\n        \"delete\",\n        \"all\",\n        \"head\",\n        \"trace\",\n        \"options\",\n      ] as const;\n\n      if (prop === \"route\") {\n        return function (path: PathParams) {\n          const routeChain: any = {};\n\n          httpMethods.forEach((method) => {\n            routeChain[method] = function (\n              config: ArkosAnyRequestHandler | Omit<ArkosRouteConfig, \"path\">,\n              ...handlers: ArkosAnyRequestHandler[]\n            ) {\n              const fullConfig: ArkosRouteConfig = {\n                authentication: true,\n                ...config,\n                ...(options?.openapi\n                  ? {\n                      experimental: {\n                        openapi: options.openapi,\n                      },\n                    }\n                  : {}),\n                path,\n              };\n\n              receiver[method](fullConfig, ...handlers);\n\n              return routeChain as ArkosIRoute;\n            };\n          });\n\n          return routeChain;\n        };\n      }\n\n      if (httpMethods.includes(prop as any)) {\n        return function (\n          config: ArkosRouteConfig,\n          ...handlers: ArkosAnyRequestHandler[]\n        ) {\n          if (config.disabled) return;\n\n          if (!RouteConfigValidator.isArkosRouteConfig(config))\n            throw Error(\n              `First argument of ArkosRouter().${prop as string}() must be a valid ArkosRouteConfig object with path field, but recevied ${typeof config === \"object\" ? JSON.stringify(config, null, 2) : config}`\n            );\n\n          const path = applyPrefix(options?.prefix, config.path);\n\n          config = {\n            authentication: true,\n            ...config,\n            ...(options?.openapi\n              ? {\n                  experimental: {\n                    ...config?.experimental,\n                    openapi: deepmerge(\n                      options.openapi || {},\n                      config?.experimental?.openapi || {}\n                    ),\n                  },\n                }\n              : {}),\n            path,\n          };\n\n          if ([null, undefined].includes(path as any))\n            throw Error(\n              \"Please pass valid value for path field to use in your route\"\n            );\n\n          const method = prop as string;\n          const UndefinedHandlerError = (handler: any) =>\n            Error(\n              `Wrong value for handler in route ${method.toUpperCase()} ${path}, recevied ${handler}.`\n            );\n\n          if (handlers.length > 0) {\n            const flattenHandlers = (arr: any[]): ArkosAnyRequestHandler[] => {\n              return arr.reduce((flat, item) => {\n                return flat.concat(\n                  Array.isArray(item) ? flattenHandlers(item) : item\n                );\n              }, []);\n            };\n\n            const flatHandlers = flattenHandlers(handlers);\n\n            handlers = flatHandlers.map((handler: ArkosAnyRequestHandler) => {\n              if (!handler) throw UndefinedHandlerError(handler);\n\n              if (typeof handler !== \"function\") {\n                throw UndefinedHandlerError(handler);\n              }\n\n              return catchAsync(handler, {\n                type: handler.length > 3 ? \"error\" : \"normal\",\n              });\n            });\n\n            const finalHandler = handlers[handlers.length - 1];\n            RouteConfigRegistry.register(finalHandler, config, method);\n          }\n\n          const arkosConfig = getArkosConfig();\n          const validationConfig = arkosConfig.validation;\n          const authenticationConfig = arkosConfig.authentication;\n          const strictValidation = validationConfig?.strict;\n          const route = `${method.toUpperCase()} ${path}`;\n\n          if (\n            strictValidation &&\n            (!(\"validation\" in config) ||\n              (\"validation\" in config &&\n                !config.validation &&\n                config.validation !== undefined))\n          )\n            throw Error(\n              \"When using strict validation you must either pass { validation: false } in order to explicitly tell that no input will be received, or pass `undefined` for each input type e.g { validation: { query: undefined } } in order to deny the input of given request input.\"\n            );\n\n          if (\n            !validationConfig?.resolver &&\n            Object.keys(config.validation || {}).length > 0\n          )\n            throw Error(\n              `Trying to pass validators into route ${route} config validation option without choosing a validation resolver under arkos.init({ validation: { resolver: '' } })`\n            );\n\n          if (config.authentication && !authenticationConfig?.mode)\n            throw Error(\n              `Trying to authenticate route ${route} without choosing an authentication mode under arkos.config.${getUserFileExtension()}\n\nFor further help see https://www.arkosjs.com/docs/core-concepts/authentication-system.`\n            );\n\n          handlers = [...getMiddlewareStack(config), ...handlers];\n\n          if (\n            config.experimental?.uploads &&\n            config.experimental.uploads.deleteOnError !== false\n          )\n            handlers.push(\n              catchAsync(\n                uploadManager.handleFileCleanup(config.experimental.uploads),\n                { type: \"error\" }\n              )\n            );\n\n          return originalMethod.call(target, path, ...handlers);\n        };\n      }\n      // }\n      return originalMethod;\n    },\n  }) as IArkosRouter;\n}\n\nexport function generateOpenAPIFromApp(app: any) {\n  const routes = extractArkosRoutes(app);\n  const arkosConfig = getArkosConfig();\n\n  let paths: Record<\n    string,\n    Record<string, Partial<OpenAPIV3.OperationObject>>\n  > = {};\n\n  routes.forEach(({ path, method, config }) => {\n    if (config?.experimental?.openapi === false) return;\n    const originalPath = path;\n\n    const pathParatemersFromRoutePath = extractPathParams(path);\n    for (const parameter of pathParatemersFromRoutePath) {\n      path = path.replaceAll(\n        `:${parameter}`,\n        parameter.endsWith(\"?\") ? `{${parameter}}?` : `{${parameter}}`\n      );\n    }\n\n    if (!paths[path]) paths[path] = {};\n\n    if (typeof config?.experimental?.openapi === \"boolean\") {\n      config = {\n        ...config,\n        experimental: {\n          ...config.experimental,\n          openapi: {},\n        },\n      };\n    }\n\n    const openapi =\n      typeof config?.experimental?.openapi === \"object\" &&\n      config.experimental.openapi !== null\n        ? config.experimental.openapi\n        : {};\n\n    const validatorToJsonSchema =\n      arkosConfig?.validation?.resolver === \"zod\"\n        ? zodToJsonSchema\n        : classValidatorToJsonSchema;\n\n    let parameters = [];\n    const validationToParameterMapping = {\n      query: \"query\",\n      params: \"path\",\n      headers: \"header\",\n      cookies: \"cookie\",\n    };\n\n    if (typeof config?.validation !== \"boolean\" && config?.validation) {\n      for (const [key, val] of Object.entries(config?.validation)) {\n        if ([\"body\"].includes(key)) continue;\n        if ((config?.validation as any)[key]) {\n          const jsonSchema = validatorToJsonSchema(val as any);\n          const params = openApiSchemaConverter.jsonSchemaToOpenApiParameters(\n            (validationToParameterMapping as any)[key],\n            jsonSchema\n          );\n          parameters.push(...params);\n        }\n      }\n    }\n\n    const convertedOpenAPI =\n      openApiSchemaConverter.convertOpenAPIConfig(openapi);\n\n    const allParameters: OpenAPIV3.ParameterObject[] = [\n      ...(convertedOpenAPI.parameters || []),\n      ...parameters,\n    ];\n\n    for (const parameter of pathParatemersFromRoutePath) {\n      if (\n        !allParameters.find(\n          ({ name, in: paramIn }) =>\n            name === parameter.replace(\"?\", \"\") && paramIn === \"path\"\n        )\n      )\n        allParameters.push({\n          name: parameter,\n          in: \"path\",\n          required: !parameter.includes(\"?\"),\n          schema: { type: \"string\" },\n        });\n    }\n\n    for (const param of allParameters) {\n      if (\n        !pathParatemersFromRoutePath.includes(param.name) &&\n        !pathParatemersFromRoutePath.includes(`${param.name}?`) &&\n        param.in === \"path\"\n      )\n        throw new Error(\n          `ValidationError: Trying to define path parameter '${param.name}' but it is not present in your pathname ${originalPath}`\n        );\n    }\n\n    delete convertedOpenAPI.parameters;\n    const hasUploadFields =\n      Object.keys(config?.experimental?.uploads || {}).length > 0;\n    const multipartFormSchema =\n      convertedOpenAPI?.requestBody?.content?.[\"multipart/form-data\"];\n\n    if (hasUploadFields && multipartFormSchema)\n      arkosRouterOpenApiManager.validateMultipartFormDocs(\n        multipartFormSchema,\n        path,\n        config?.experimental?.uploads\n      );\n\n    (paths as any)[path][method.toLowerCase()] = {\n      summary: openapi?.summary || `${path}`,\n      description: openapi?.description || `${method} ${path}`,\n      tags: openapi?.tags || [\"Defaults\"],\n      operationId: `${method.toLowerCase()}:${path}`,\n      parameters: allParameters,\n      ...(!convertedOpenAPI.requestBody &&\n        config?.validation &&\n        config?.validation?.body && {\n          requestBody: {\n            content: (() => {\n              const schema = validatorToJsonSchema(\n                config?.validation?.body as any\n              );\n\n              return {\n                ...(hasUploadFields && {\n                  \"multipart/form-data\": {\n                    schema: openApiSchemaConverter.flattenSchema(\n                      arkosRouterOpenApiManager.addUploadFields(\n                        config.experimental?.uploads!,\n                        schema\n                      )\n                    ),\n                  },\n                }),\n                \"application/json\": {\n                  schema,\n                },\n              };\n            })(),\n          },\n        }),\n      ...(convertedOpenAPI?.requestBody?.content?.[\"application/json\"] &&\n        !multipartFormSchema &&\n        !(config as any)?.validation?.body &&\n        hasUploadFields && {\n          requestBody: {\n            content: (() => {\n              const schema =\n                convertedOpenAPI?.requestBody?.content?.[\"application/json\"];\n\n              return {\n                \"multipart/form-data\": {\n                  schema: openApiSchemaConverter.flattenSchema(\n                    arkosRouterOpenApiManager.addUploadFields(\n                      config?.experimental?.uploads! || {},\n                      schema\n                    )\n                  ),\n                },\n                ...convertedOpenAPI?.requestBody,\n              };\n            })(),\n          },\n        }),\n      ...convertedOpenAPI,\n    };\n  });\n\n  return paths;\n}\n"]}

package/dist/cjs/utils/arkos-router/route-config-registry.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class RouteConfigRegistry {
-    static register(handler, config, method) {
-        this.configs.set(handler, { ...config, method });
-    }
-    static get(handler) {
-        return this.configs.get(handler);
-    }
-    static getAll() {
-        return this.configs;
-    }
-}
-RouteConfigRegistry.configs = new WeakMap();
-exports.default = RouteConfigRegistry;
-//# sourceMappingURL=route-config-registry.js.map

package/dist/cjs/utils/arkos-router/route-config-registry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"route-config-registry.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/route-config-registry.ts"],"names":[],"mappings":";;AAEA,MAAqB,mBAAmB;IAMtC,MAAM,CAAC,QAAQ,CACb,OAAmC,EACnC,MAAwB,EACxB,MAAc;QAEd,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,CAAC,GAAG,CAAC,OAAiB;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;;AAnBc,2BAAO,GAAG,IAAI,OAAO,EAGjC,CAAC;kBAJe,mBAAmB","sourcesContent":["import { ArkosRouteConfig } from \"./types\";\n\nexport default class RouteConfigRegistry {\n  private static configs = new WeakMap<\n    Function | Array<Function>,\n    ArkosRouteConfig & { method: string }\n  >();\n\n  static register(\n    handler: Function | Array<Function>,\n    config: ArkosRouteConfig,\n    method: string\n  ) {\n    this.configs.set(handler, { ...config, method });\n  }\n\n  static get(handler: Function) {\n    return this.configs.get(handler);\n  }\n\n  static getAll() {\n    return this.configs;\n  }\n}\n"]}

package/dist/cjs/utils/arkos-router/route-config-validator.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const dynamic_loader_1 = require("../dynamic-loader.js");
-const exports_1 = require("../../exports/index.js");
-class RouteConfigValidator {
-    static isArkosRouteConfig(arg) {
-        return typeof arg === "object" && arg !== null && "path" in arg;
-    }
-    static validate(config) {
-        const swaggerMode = (0, exports_1.getArkosConfig)()?.validation?.resolver;
-        if (config.validation) {
-            const validators = [
-                { key: "query", schema: config.validation?.query },
-                { key: "body", schema: config.validation?.body },
-                { key: "params", schema: config.validation?.params },
-            ];
-            for (const { key, schema } of validators) {
-                if (!schema)
-                    continue;
-                const isZod = (0, dynamic_loader_1.isZodSchema)(schema);
-                const isClassValidator = (0, dynamic_loader_1.isClass)(schema);
-                if (isZod && swaggerMode !== "zod") {
-                    throw new Error(`Zod schema used in validation.${key} but Swagger mode is '${swaggerMode}'. ` +
-                        `Zod schemas are only supported when swagger.mode is 'zod'.`);
-                }
-                if (isClassValidator && swaggerMode !== "class-validator") {
-                    throw new Error(`Class validator used in validation.${key} but Swagger mode is '${swaggerMode}'. ` +
-                        `Class validators are only supported when swagger.mode is 'class-validator'.`);
-                }
-            }
-        }
-        if (config.validation && typeof config.experimental?.openapi === "object") {
-            const openapi = config.experimental
-                .openapi;
-            if (config.validation.query &&
-                openapi.parameters?.some((p) => p.in === "query")) {
-                throw new Error("Duplicate query validation definitions. " +
-                    "When using validation.query, do not define query parameters in openapi.parameters. " +
-                    "They will be automatically migrated to OpenAPI specification.");
-            }
-            if (config.validation.params &&
-                openapi.parameters?.some((p) => p.in === "params")) {
-                throw new Error("Duplicate path parameter validation definitions. " +
-                    "When using validation.params, do not define path parameters in openapi.parameters. " +
-                    "They will be automatically migrated to OpenAPI specification.");
-            }
-            if (config.validation.body && openapi.requestBody) {
-                throw new Error("Duplicate request body validation definitions. " +
-                    "When using validation.body, do not define openapi.requestBody in openapi. " +
-                    "It will be automatically migrated to OpenAPI specification.");
-            }
-        }
-    }
-}
-exports.default = RouteConfigValidator;
-//# sourceMappingURL=route-config-validator.js.map

package/dist/cjs/utils/arkos-router/route-config-validator.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"route-config-validator.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/route-config-validator.ts"],"names":[],"mappings":";;AACA,sDAAyD;AACzD,2CAA+C;AAG/C,MAAqB,oBAAoB;IACvC,MAAM,CAAC,kBAAkB,CAAC,GAAQ;QAChC,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,MAAM,IAAI,GAAG,CAAC;IAClE,CAAC;IAED,MAAM,CAAC,QAAQ,CAAC,MAAwB;QACtC,MAAM,WAAW,GAAG,IAAA,wBAAc,GAAE,EAAE,UAAU,EAAE,QAAQ,CAAC;QAE3D,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,UAAU,GAAG;gBACjB,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,KAAK,EAAE;gBAClD,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE;gBAChD,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE;aACrD,CAAC;YAEF,KAAK,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,UAAU,EAAE,CAAC;gBACzC,IAAI,CAAC,MAAM;oBAAE,SAAS;gBAEtB,MAAM,KAAK,GAAG,IAAA,4BAAW,EAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,gBAAgB,GAAG,IAAA,wBAAO,EAAC,MAAM,CAAC,CAAC;gBAEzC,IAAI,KAAK,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;oBACnC,MAAM,IAAI,KAAK,CACb,iCAAiC,GAAG,yBAAyB,WAAW,KAAK;wBAC3E,4DAA4D,CAC/D,CAAC;gBACJ,CAAC;gBAED,IAAI,gBAAgB,IAAI,WAAW,KAAK,iBAAiB,EAAE,CAAC;oBAC1D,MAAM,IAAI,KAAK,CACb,sCAAsC,GAAG,yBAAyB,WAAW,KAAK;wBAChF,6EAA6E,CAChF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,IAAI,OAAO,MAAM,CAAC,YAAY,EAAE,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC1E,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY;iBAChC,OAA6C,CAAC;YAEjD,IACE,MAAM,CAAC,UAAU,CAAC,KAAK;gBACvB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,EACtD,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0CAA0C;oBACxC,qFAAqF;oBACrF,+DAA+D,CAClE,CAAC;YACJ,CAAC;YAED,IACE,MAAM,CAAC,UAAU,CAAC,MAAM;gBACxB,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,EACvD,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,mDAAmD;oBACjD,qFAAqF;oBACrF,+DAA+D,CAClE,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBAClD,MAAM,IAAI,KAAK,CACb,iDAAiD;oBAC/C,4EAA4E;oBAC5E,6DAA6D,CAChE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAxED,uCAwEC","sourcesContent":["import { ArkosRouteConfig } from \"./types\";\nimport { isClass, isZodSchema } from \"../dynamic-loader\";\nimport { getArkosConfig } from \"../../exports\";\nimport { OpenAPIV3 } from \"openapi-types\";\n\nexport default class RouteConfigValidator {\n  static isArkosRouteConfig(arg: any): arg is ArkosRouteConfig {\n    return typeof arg === \"object\" && arg !== null && \"path\" in arg;\n  }\n\n  static validate(config: ArkosRouteConfig) {\n    const swaggerMode = getArkosConfig()?.validation?.resolver;\n\n    if (config.validation) {\n      const validators = [\n        { key: \"query\", schema: config.validation?.query },\n        { key: \"body\", schema: config.validation?.body },\n        { key: \"params\", schema: config.validation?.params },\n      ];\n\n      for (const { key, schema } of validators) {\n        if (!schema) continue;\n\n        const isZod = isZodSchema(schema);\n        const isClassValidator = isClass(schema);\n\n        if (isZod && swaggerMode !== \"zod\") {\n          throw new Error(\n            `Zod schema used in validation.${key} but Swagger mode is '${swaggerMode}'. ` +\n              `Zod schemas are only supported when swagger.mode is 'zod'.`\n          );\n        }\n\n        if (isClassValidator && swaggerMode !== \"class-validator\") {\n          throw new Error(\n            `Class validator used in validation.${key} but Swagger mode is '${swaggerMode}'. ` +\n              `Class validators are only supported when swagger.mode is 'class-validator'.`\n          );\n        }\n      }\n    }\n\n    if (config.validation && typeof config.experimental?.openapi === \"object\") {\n      const openapi = config.experimental\n        .openapi as Partial<OpenAPIV3.OperationObject>;\n\n      if (\n        config.validation.query &&\n        openapi.parameters?.some((p: any) => p.in === \"query\")\n      ) {\n        throw new Error(\n          \"Duplicate query validation definitions. \" +\n            \"When using validation.query, do not define query parameters in openapi.parameters. \" +\n            \"They will be automatically migrated to OpenAPI specification.\"\n        );\n      }\n\n      if (\n        config.validation.params &&\n        openapi.parameters?.some((p: any) => p.in === \"params\")\n      ) {\n        throw new Error(\n          \"Duplicate path parameter validation definitions. \" +\n            \"When using validation.params, do not define path parameters in openapi.parameters. \" +\n            \"They will be automatically migrated to OpenAPI specification.\"\n        );\n      }\n\n      if (config.validation.body && openapi.requestBody) {\n        throw new Error(\n          \"Duplicate request body validation definitions. \" +\n            \"When using validation.body, do not define openapi.requestBody in openapi. \" +\n            \"It will be automatically migrated to OpenAPI specification.\"\n        );\n      }\n    }\n  }\n}\n"]}

package/dist/cjs/utils/arkos-router/types/body-parser-config.js

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

package/dist/cjs/utils/arkos-router/types/body-parser-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"body-parser-config.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/body-parser-config.ts"],"names":[],"mappings":"","sourcesContent":["import express from \"express\";\nimport { Options as MulterOptions } from \"multer\";\n\nexport type BodyParserConfig =\n  | { parser: \"json\"; options?: Parameters<typeof express.json>[0] }\n  | {\n      parser: \"urlencoded\";\n      options?: Parameters<typeof express.urlencoded>[0];\n    }\n  | { parser: \"raw\"; options?: Parameters<typeof express.raw>[0] }\n  | { parser: \"multipart\"; options?: MulterOptions[\"limits\"] }\n  | { parser: \"text\"; options?: Parameters<typeof express.text>[0] };\n"]}

package/dist/cjs/utils/arkos-router/types/index.js

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

package/dist/cjs/utils/arkos-router/types/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import { IRoute, IRouter } from \"express\";\nimport { ZodSchema } from \"zod\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport { Options as QueryParserOptions } from \"../../../utils/helpers/query-parser.helpers\";\nimport { DetailedAccessControlRule } from \"../../../types/auth\";\nimport { ArkosErrorRequestHandler, ArkosRequestHandler } from \"../../../types\";\nimport compression from \"compression\";\nimport { OpenApiConfig } from \"./openapi-config\";\nimport { UploadConfig } from \"./upload-config\";\nimport { BodyParserConfig } from \"./body-parser-config\";\n\nexport type PathParams = string | RegExp | Array<string | RegExp>;\n\nexport type ArkosAnyRequestHandler =\n  | ArkosRequestHandler\n  | ArkosErrorRequestHandler\n  | Array<ArkosRequestHandler | ArkosErrorRequestHandler>;\n\n/**\n * Handler function for HTTP methods that accepts route configuration and request handlers.\n *\n * @param {ArkosRouteConfig} config - The route configuration object.\n * @param {...(ArkosRequestHandler | ArkosErrorRequestHandler)[]} handlers - Request and error handlers for the route.\n * @returns {IRouter} The Express router instance.\n */\ntype RouterMethodHandler<T> = (\n  config: ArkosRouteConfig | PathParams,\n  ...handlers: Array<ArkosAnyRequestHandler>\n) => T;\n\nexport type ArkosRouteMethodHandler<T> = (\n  config: ArkosAnyRequestHandler | Omit<ArkosRouteConfig, \"path\">,\n  ...handlers: Array<\n    | ArkosRequestHandler\n    | ArkosErrorRequestHandler\n    | Array<ArkosRequestHandler | ArkosErrorRequestHandler>\n  >\n) => T;\n\nexport interface ArkosIRoute extends IRoute {\n  /** GET method handler with route configuration support */\n  get: ArkosRouteMethodHandler<this>;\n  /** POST method handler with route configuration support */\n  post: ArkosRouteMethodHandler<this>;\n  /** PUT method handler with route configuration support */\n  put: ArkosRouteMethodHandler<this>;\n  /** PATCH method handler with route configuration support */\n  patch: ArkosRouteMethodHandler<this>;\n  /** DELETE method handler with route configuration support */\n  delete: ArkosRouteMethodHandler<this>;\n  /** OPTIONS method handler with route configuration support */\n  options: ArkosRouteMethodHandler<this>;\n  /** HEAD method handler with route configuration support */\n  head: ArkosRouteMethodHandler<this>;\n  // /** TRACE method handler with route configuration support */\n  trace: ArkosRouteMethodHandler<this>;\n  /** ALL methods handler with route configuration support */\n  all: ArkosRouteMethodHandler<this>;\n}\n\n/**\n * Creates an enhanced Express Router with features like OpenAPI documentation capabilities and smart data validation.\n *\n * The ArkosRouter extends the standard Express Router with the ability to\n * automatically capture OpenAPI metadata from route configurations.\n *\n * @example\n * const router = ArkosRouter();\n *\n * router.get(\n *   {\n *     path: \"/users/:id\",\n *     openapi: {\n *       summary: \"Get user by ID\",\n *       tags: [\"Users\"]\n *     }\n *   },\n *   (req, res) => { ... }\n * );\n *\n * @returns {IArkosRouter} A proxied Express Router instance with enhanced OpenAPI capabilities\n *\n * @see {@link ArkosRouteConfig} for configuration options\n */\nexport interface IArkosRouter extends IRouter {\n  /** GET method handler with route configuration support */\n  get: RouterMethodHandler<this>;\n  /** POST method handler with route configuration support */\n  post: RouterMethodHandler<this>;\n  /** PUT method handler with route configuration support */\n  put: RouterMethodHandler<this>;\n  /** PATCH method handler with route configuration support */\n  patch: RouterMethodHandler<this>;\n  /** DELETE method handler with route configuration support */\n  delete: RouterMethodHandler<this>;\n  /** OPTIONS method handler with route configuration support */\n  options: RouterMethodHandler<this>;\n  /** HEAD method handler with route configuration support */\n  head: RouterMethodHandler<this>;\n  // /** TRACE method handler with route configuration support */\n  trace: RouterMethodHandler<this>;\n  /** ALL methods handler with route configuration support */\n  all: RouterMethodHandler<this>;\n\n  route<T extends string>(prefix: T): ArkosIRoute;\n  route(prefix: PathParams): ArkosIRoute;\n}\n\n/**\n * Configuration object for defining routes in Arkos.js.\n */\nexport type ArkosRouteConfig = {\n  /**\n   * Disables the route by not mounting it internally.\n   */\n  disabled?: boolean;\n  /**\n   * The URL path pattern for the route.\n   *\n   * @example \"/api/users/:id\"\n   */\n  path: PathParams;\n  /**\n   * Authentication and authorization configuration.\n   *\n   * @remarks\n   * - Set to `true` to require authentication without specific permissions.\n   * - Set to `false` or omit to allow unauthenticated access.\n   * - Provide an object to specify resource-based access control with resource name, action, and optional custom rules.\n   */\n  authentication?:\n    | boolean\n    | {\n        resource: string;\n        action: string;\n        rule?: DetailedAccessControlRule | string[] | \"*\";\n      };\n  /**\n   * Request validation configuration using Zod schemas or class constructors.\n   *\n   * @remarks\n   * - Set to `false` to disable all validation.\n   * - Provide an object with `query`, `body`, and/or `params` properties to validate specific parts of the request.\n   * - Each property accepts a Zod schema, a class constructor, or `false` to disable validation for that part.\n   */\n  validation?:\n    | false\n    | {\n        query?: ZodSchema | (new (...args: any[]) => object) | false;\n        body?: ZodSchema | (new (...args: any[]) => object) | false;\n        params?: ZodSchema | (new (...args: any[]) => object) | false;\n      };\n\n  /**\n   * Rate limiting configuration for this route.\n   *\n   * @see {@link https://www.npmjs.com/package/express-rate-limit express-rate-limit} for available options.\n   */\n  rateLimit?: Partial<RateLimitOptions>;\n\n  /**\n   * Allows to define options for npm package compression.\n   * Nothing is passed by default.\n   *\n   * @see {@link https://www.npmjs.com/package/compression compression} for further details.\n   */\n  compression?: compression.CompressionOptions;\n  /**\n   * Options to define how query must be parsed.\n   *\n   * @example\n   * ```\n   * GET /api/product?saleId=null\n   * ```\n   *\n   * Normally would parsed to { saleId: \"null\" } so query parser\n   * trough setting option `parseNull` will transform { saleId: null }\n   *\n   * @default\n   * ```\n   * {\n   *   parseNull: true,\n   *   parseUndefined: true,\n   *   parseBoolean: true,\n   * }\n   * ```\n   *\n   * @remarks\n   * parseNumber may convert fields that are string but you only passed\n   * numbers to query pay attention to this.\n   *\n   * Soon a feature to converted the query to the end prisma type will be added.\n   */\n  queryParser?: QueryParserOptions;\n  /**\n   * Configuration for request body parsing.\n   *\n   * @property {(\"json\" | \"urlencoded\" | \"raw\" | \"text\")} parser - The type of body parser to use.\n   * @property {object} [options] - Parser-specific options passed to the corresponding Express body parser middleware.\n   *\n   * @remarks\n   * - When `parser` is `\"json\"`, options are passed to `express.json()`.\n   * - When `parser` is `\"urlencoded\"`, options are passed to `express.urlencoded()`.\n   * - When `parser` is `\"raw\"`, options are passed to `express.raw()`.\n   * - When `parser` is `\"text\"`, options are passed to `express.text()`.\n   * - Set to `false` to disable body parsing for this route.\n   *\n   * @see {@link https://expressjs.com/en/api.html#express.json Express body parser documentation}\n   */\n  bodyParser?: BodyParserConfig | BodyParserConfig[] | false;\n  /**\n   * Experimental features to be battled tested before being stable\n   *\n   * PS: These features may be changed without any previous warning.\n   */\n  experimental?: {\n    /**\n     * OpenAPI specification for this route.\n     *\n     * @remarks\n     * - Set to `false` to exclude this route from OpenAPI documentation.\n     * - Provide a partial OpenAPI operation object to document the route.\n     */\n    openapi?: false | OpenApiConfig;\n    /**\n     * Configuration for file upload handling in routes.\n     * Supports single file, multiple files from same field, or multiple fields with files.\n     */\n    uploads?: UploadConfig;\n  };\n};\n"]}

package/dist/cjs/utils/arkos-router/types/openapi-config.js

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

package/dist/cjs/utils/arkos-router/types/openapi-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"openapi-config.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/openapi-config.ts"],"names":[],"mappings":"","sourcesContent":["import { OpenAPIV3 } from \"openapi-types\";\nimport { ZodSchema } from \"zod\";\n\n/**\n * Represents a schema-like object that can be used for OpenAPI documentation.\n * Accepts Zod schemas, class constructors (DTOs), or plain JSON Schema objects.\n */\ntype SchemaLike =\n  | ZodSchema\n  | (new (...args: any[]) => object)\n  | OpenAPIV3.SchemaObject;\n\n/**\n * Extended media type object that accepts SchemaLike in addition to standard OpenAPI schemas.\n */\ntype ExtendedMediaTypeObject = Omit<OpenAPIV3.MediaTypeObject, \"schema\"> & {\n  schema: SchemaLike;\n};\n\n/**\n * Represents a parameter object with support for Zod schemas, class constructors, or JSON Schema.\n * Extends OpenAPI's ParameterObject to accept SchemaLike types for the schema field.\n *\n * @example\n * // Using JSON Schema (standard OpenAPI)\n * {\n *   name: \"userId\",\n *   in: \"path\",\n *   required: true,\n *   schema: { type: \"string\", format: \"uuid\" }\n * }\n *\n * @example\n * // Using Zod schema\n * {\n *   name: \"limit\",\n *   in: \"query\",\n *   schema: z.number().int().min(1).max(100)\n * }\n *\n * @example\n * // Using class constructor (DTO)\n * {\n *   name: \"filter\",\n *   in: \"query\",\n *   schema: FilterDto\n * }\n */\nexport type ExtendedParameterObject = Omit<\n  OpenAPIV3.ParameterObject,\n  \"schema\"\n> & {\n  /**\n   * The schema defining the type used for the parameter.\n   * Can be a Zod schema, class constructor, or standard JSON Schema object.\n   */\n  schema?: SchemaLike;\n};\n\n/**\n * Shorthand response definition. Can be:\n * - A SchemaLike (assumes application/json content-type and default description)\n * - An object with `content` as SchemaLike and optional `description`\n * - A full OpenAPI response object with custom content-types\n *\n * @example\n * // Shorthand: Just the schema (assumes application/json + \"Success\" description)\n * 200: ProfileDto\n *\n * @example\n * // Medium: Schema with custom description\n * 404: {\n *   content: ErrorDto,\n *   description: \"User not found\"\n * }\n *\n * @example\n * // Full: Multiple content-types with custom configuration\n * 500: {\n *   content: {\n *     \"application/json\": { schema: ErrorDto },\n *     \"text/plain\": { schema: PlainErrorDto }\n *   },\n *   description: \"Internal server error\"\n * }\n */\ntype ResponseDefinition =\n  | SchemaLike\n  | {\n      content: SchemaLike;\n      description?: string;\n    }\n  | (Omit<OpenAPIV3.ResponseObject, \"content\"> & {\n      content?: {\n        [media: string]: ExtendedMediaTypeObject;\n      };\n    });\n\n/**\n * Shorthand request body definition. Can be:\n * - A SchemaLike (assumes application/json content-type)\n * - An object with `content` as SchemaLike and optional configuration\n * - A full OpenAPI request body object with custom content-types\n *\n * @example\n * // Shorthand: Just the schema (assumes application/json)\n * requestBody: CreateUserDto\n *\n * @example\n * // Medium: Schema with configuration\n * requestBody: {\n *   content: CreateUserDto,\n *   required: true,\n *   description: \"User creation payload\"\n * }\n *\n * @example\n * // Full: Multiple content-types\n * requestBody: {\n *   content: {\n *     \"application/json\": { schema: CreateUserDto },\n *     \"multipart/form-data\": { schema: CreateUserFormDto }\n *   },\n *   required: true\n * }\n */\ntype RequestBodyDefinition =\n  | SchemaLike\n  | {\n      content: SchemaLike;\n      required?: boolean;\n      description?: string;\n    }\n  | (Omit<OpenAPIV3.RequestBodyObject, \"content\"> & {\n      content: {\n        [media: string]: ExtendedMediaTypeObject;\n      };\n    });\n\n/**\n * Extended OpenAPI Operation object with enhanced requestBody and responses.\n *\n * NOTE: If you define validation in the `validation` field, DO NOT redefine\n * the same schemas here. The framework will automatically generate OpenAPI docs\n * from your validation schemas. This field is only for:\n * - Endpoints that don't use validation (docs-only)\n * - Additional metadata (summary, description, tags, etc.)\n *\n * Defining both validation and openapi schemas for the same field will cause\n * a startup error to prevent documentation drift.\n */\ntype ExtendedOperationObject = Omit<\n  OpenAPIV3.OperationObject,\n  \"responses\" | \"requestBody\"\n> & {\n  /**\n   * Response definitions keyed by HTTP status code.\n   * Supports shorthand, medium, and full OpenAPI formats.\n   */\n  responses?: {\n    [statusCode: number]: ResponseDefinition;\n  };\n\n  /**\n   * Request body definition.\n   * Supports shorthand, medium, and full OpenAPI formats.\n   *\n   * WARNING: Do not define this if you're using `validation.body` -\n   * it will be auto-generated from your validation schema.\n   */\n  requestBody?: RequestBodyDefinition;\n  /**\n   * Array of parameter definitions for path, query, header, and cookie parameters.\n   * Each parameter's schema can be a Zod schema, class constructor, or JSON Schema.\n   *\n   * WARNING: Do NOT define parameters here if you're using `validation.query`,\n   * `validation.params`, `validation.headers`, or `validation.cookies`.\n   * Those validation schemas will automatically generate parameter documentation.\n   * Defining both will cause a startup error.\n   *\n   * Only use this field for:\n   * - Documentation-only endpoints (no validation)\n   * - Routes where you explicitly don't want validation\n   *\n   * Note: In practice, documenting parameters without validation is rare.\n   * Most APIs validate their inputs, so you'll typically use the `validation` field instead.\n   *\n   * @example\n   * // Standard JSON Schema (most common for parameters)\n   * parameters: [\n   *   {\n   *     name: \"userId\",\n   *     in: \"path\",\n   *     required: true,\n   *     schema: { type: \"string\", format: \"uuid\" }\n   *   },\n   *   {\n   *     name: \"limit\",\n   *     in: \"query\",\n   *     schema: { type: \"integer\", minimum: 1, maximum: 100 }\n   *   }\n   * ]\n   *\n   * @example\n   * // Using Zod (less common for parameters, but supported)\n   * parameters: [\n   *   {\n   *     name: \"page\",\n   *     in: \"query\",\n   *     schema: z.number().int().positive()\n   *   }\n   * ]\n   */\n  parameters?: (ExtendedParameterObject | OpenAPIV3.ReferenceObject)[];\n};\n\n/**\n * OpenAPI configuration for a route.\n * Set to `false` to exclude this route from OpenAPI documentation.\n * Otherwise, provide operation metadata and schema definitions.\n *\n * @example\n * // Exclude from docs\n * openapi: false\n *\n * @example\n * // Simple documentation with shorthand\n * openapi: {\n *   summary: \"Get user profile\",\n *   responses: {\n *     200: ProfileDto,\n *     404: ErrorDto\n *   }\n * }\n *\n * @example\n * // Complex documentation with multiple content-types\n * openapi: {\n *   summary: \"Upload file\",\n *   requestBody: {\n *     content: {\n *       \"multipart/form-data\": { schema: FileUploadDto }\n *     },\n *     required: true\n *   },\n *   responses: {\n *     200: {\n *       content: {\n *         \"application/json\": { schema: UploadResultDto }\n *       },\n *       description: \"File uploaded successfully\"\n *     }\n *   }\n * }\n */\nexport type OpenApiConfig = false | Partial<ExtendedOperationObject>;\n"]}

package/dist/cjs/utils/arkos-router/types/upload-config.js

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

package/dist/cjs/utils/arkos-router/types/upload-config.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"upload-config.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/upload-config.ts"],"names":[],"mappings":"","sourcesContent":["export type UploadConfig =\n  /**\n   * Creates middleware that processes a single file associated with the\n   * given form field.\n   *\n   * The `Request` object will be populated with a `file` object containing\n   * information about the processed file.\n   *\n   * @example\n   * uploads: {\n   *   type: \"single\",\n   *   field: \"avatar\",\n   *   uploadDir: \"images\",\n   *   maxSize: 1024 * 1024 * 5 // 5MB\n   * }\n   */\n  | ({\n      type: \"single\";\n      /** Name of the multipart form field to process */\n      field: string;\n    } & ArkosRouterBaseUploadConfig)\n  /**\n   * Returns middleware that processes multiple files sharing the same field\n   * name.\n   *\n   * The `Request` object will be populated with a `files` array containing\n   * an information object for each processed file.\n   *\n   * @throws `MulterError('LIMIT_UNEXPECTED_FILE')` if more than `maxCount` files are associated with `fieldName`\n   *\n   * @example\n   * uploads: {\n   *   type: \"array\",\n   *   field: \"gallery\",\n   *   maxCount: 10,\n   *   minCount: 1,\n   *   uploadDir: \"images\"\n   * }\n   */\n  | ({\n      type: \"array\";\n      /** Shared name of the multipart form fields to process */\n      field: string;\n      /** Maximum number of files to process (defaults to framework config) */\n      maxCount?: number;\n      /** Minimum number of files required */\n      // minCount?: number;\n    } & ArkosRouterBaseUploadConfig)\n  /**\n   * Creates middleware that processes multiple files associated with the\n   * given form fields.\n   *\n   * The `Request` object will be populated with a `files` object which\n   * maps each field name to an array of the associated file information\n   * objects.\n   *\n   * @throws `MulterError('LIMIT_UNEXPECTED_FILE')` if more than `maxCount` files are associated with `fieldName` for any field\n   *\n   * @example\n   * uploads: {\n   *   type: \"fields\",\n   *   fields: [\n   *     { field: \"avatar\", maxCount: 1, uploadDir: \"images\" },\n   *     { field: \"resume\", maxCount: 1, uploadDir: \"documents\" }\n   *   ]\n   * }\n   */\n  | ({\n      type: \"fields\";\n      /** Array of field configurations describing multipart form fields to process */\n      fields: {\n        /** Name of the form field */\n        name: string;\n        /** Maximum number of files for this field (defaults to framework config) */\n        maxCount?: number;\n        // /** Minimum number of files required for this field */\n        // minCount?: number;\n      }[];\n    } & ArkosRouterBaseUploadConfig);\n\n/**\n * Base configuration options for file uploads.\n * These settings can override framework-level defaults for specific routes.\n */\nexport type ArkosRouterBaseUploadConfig = {\n  /**\n   * Directory category where files will be stored.\n   * Each category has its own default restrictions defined in framework config.\n   *\n   * @remarks Do not include the `baseUploadDir` defined under your arkos config\n   * @default Depends on the file type which is descovered by the file mimetype, otherwise falls to files.\n   */\n  uploadDir?: string;\n  /**\n   * Whether to automatically delete uploaded files if an error occurs during request processing.\n   * Cleanup happens when errors are thrown and not caught within the route handler.\n   *\n   * @default false\n   */\n  deleteOnError?: boolean;\n  /**\n   * How to attach file information to req.body for easier access in handlers and validation.\n   * - \"pathname\": Just the relative path (e.g., \"images/avatar-123.jpg\")\n   * - \"url\": Complete URL (e.g., \"https://api.com/uploads/images/avatar-123.jpg\")\n   * - \"file\": The complete Multer file object with all metadata\n   *\n   * @default \"pathname\"\n   *\n   * @remarks\n   * When using validation, the attached format will be available in your validated body.\n   * For array/fields uploads, an array of the specified format will be attached.\n   */\n  attachToBody?: \"pathname\" | \"url\" | \"file\" | false;\n  /**\n   * Maximum file size in bytes.\n   * Overrides the framework-level default for this uploadDir category.\n   *\n   * @example\n   * maxSize: 1024 * 1024 * 5 // 5MB\n   * maxSize: 1024 * 1024 * 50 // 50MB\n   */\n  maxSize?: number;\n  /**\n   * Allowed file types/extensions.\n   * Can be an array of extensions/MIME types or a RegExp pattern.\n   * Overrides the framework-level default for this uploadDir category.\n   *\n   * @example\n   * // Array of extensions\n   * allowedFileTypes: [\".jpg\", \".png\", \".gif\"]\n   *\n   * @example\n   * // Array of MIME types\n   * allowedFileTypes: [\"image/jpeg\", \"image/png\"]\n   *\n   * @example\n   * // RegExp pattern\n   * allowedFileTypes: /jpeg|jpg|png|gif/\n   */\n  allowedFileTypes?: string[] | RegExp;\n  /**\n   * Defines if this file field is required\n   *\n   * @default true\n   */\n  required?: boolean;\n  /**\n   * Open API field description\n   */\n  description?: string;\n};\n"]}