arkos 2.0.0-next.13 → 2.0.0-next.16

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

@@ -5,6 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const deepmerge_helper_1 = __importDefault(require("../helpers/deepmerge.helper.js"));
 class ArkosRouterOpenAPIManager {
+    resolveSchemaFieldName(name) {
+        return name.replace(/\[\]/g, "[0]");
+    }
     addUploadFields(uploadConfig, existingSchema = {}) {
         const uploadSchema = {
             type: "object",
@@ -12,48 +15,51 @@ class ArkosRouterOpenAPIManager {
             required: [],
         };
         if (uploadConfig.type === "single") {
-            uploadSchema.properties[uploadConfig.field] = {
+            const schemaKey = this.resolveSchemaFieldName(uploadConfig.field);
+            uploadSchema.properties[schemaKey] = {
                 type: "string",
                 format: "binary",
                 ...(uploadConfig.maxSize && {
                     description: `Max size: ${uploadConfig.maxSize} bytes`,
                 }),
+                ...(uploadConfig.description && {
+                    description: uploadConfig.description,
+                }),
             };
-            if (uploadConfig.required) {
-                uploadSchema.required.push(uploadConfig.field);
+            if (uploadConfig.required !== false) {
+                uploadSchema.required.push(schemaKey);
             }
         }
         else if (uploadConfig.type === "array") {
-            uploadSchema.properties[uploadConfig.field] = {
+            const schemaKey = this.resolveSchemaFieldName(uploadConfig.field);
+            uploadSchema.properties[schemaKey] = {
                 type: "array",
                 items: {
                     type: "string",
                     format: "binary",
                 },
                 ...(uploadConfig.maxCount && { maxItems: uploadConfig.maxCount }),
+                ...(uploadConfig.minCount && { minItems: uploadConfig.minCount }),
                 ...(uploadConfig.maxSize && {
                     description: `Max size per file: ${uploadConfig.maxSize} bytes`,
                 }),
+                ...(uploadConfig.description && {
+                    description: uploadConfig.description,
+                }),
             };
-            if (uploadConfig.required) {
-                uploadSchema.required.push(uploadConfig.field);
+            if (uploadConfig.required !== false) {
+                uploadSchema.required.push(schemaKey);
             }
         }
         else if (uploadConfig.type === "fields") {
             for (const field of uploadConfig.fields) {
-                uploadSchema.properties[field.name] = {
-                    type: "array",
-                    items: {
-                        type: "string",
-                        format: "binary",
-                    },
-                    ...(field.maxCount && { maxItems: field.maxCount }),
-                    ...(uploadConfig.maxSize && {
-                        description: `Max size per file: ${uploadConfig.maxSize} bytes`,
-                    }),
-                };
-                if (uploadConfig.required) {
-                    uploadSchema.required.push(field.name);
+                uploadSchema.properties[this.resolveSchemaFieldName(field.name)] =
+                    this.buildFieldSchema(field, uploadConfig);
+                const isRequired = field.type === undefined
+                    ? uploadConfig.required !== false
+                    : field.required !== false;
+                if (isRequired) {
+                    uploadSchema.required.push(this.resolveSchemaFieldName(field.name));
                 }
             }
         }
@@ -61,6 +67,45 @@ class ArkosRouterOpenAPIManager {
             delete uploadSchema.required;
         return (0, deepmerge_helper_1.default)(existingSchema, uploadSchema);
     }
+    buildFieldSchema(field, config) {
+        if (field.type === "single") {
+            return {
+                type: "string",
+                format: "binary",
+                ...(field.maxSize &&
+                    !config.maxSize && {
+                    description: `Max size: ${field.maxSize} bytes`,
+                }),
+                ...(config.maxSize &&
+                    !field.maxSize && {
+                    description: `Max size: ${config.maxSize} bytes`,
+                }),
+                ...(field.description && { description: field.description }),
+            };
+        }
+        return {
+            type: "array",
+            items: {
+                type: "string",
+                format: "binary",
+            },
+            ...(field.maxCount && { maxItems: field.maxCount }),
+            ...(field.type === "array" &&
+                field.minCount && { minItems: field.minCount }),
+            ...((field.maxSize &&
+                !config.maxSize && {
+                description: `Max size per file: ${field.maxSize} bytes`,
+            }) ||
+                (config.maxSize &&
+                    !field.maxSize && {
+                    description: `Max size per file: ${config.maxSize} bytes`,
+                })),
+            ...(field.type === "array" &&
+                field.description && {
+                description: field.description,
+            }),
+        };
+    }
     validateMultipartFormDocs(userDefinedMultipartSchema, routePath, uploadConfig) {
         const errors = [];
         const properties = userDefinedMultipartSchema?.properties || {};
@@ -69,28 +114,41 @@ class ArkosRouterOpenAPIManager {
         if (uploadConfig?.type === "single") {
             expectedFields.push({
                 name: uploadConfig.field,
-                required: uploadConfig.required || false,
+                required: uploadConfig.required !== false,
                 expectedType: "single",
             });
         }
         else if (uploadConfig?.type === "array") {
             expectedFields.push({
                 name: uploadConfig.field,
-                required: uploadConfig.required || false,
+                required: uploadConfig.required !== false,
                 expectedType: "array",
             });
         }
         else if (uploadConfig?.type === "fields") {
             for (const field of uploadConfig.fields) {
-                expectedFields.push({
-                    name: field.name,
-                    required: uploadConfig.required || false,
-                    expectedType: "array",
-                });
+                if (!("type" in field)) {
+                    expectedFields.push({
+                        name: field.name,
+                        required: uploadConfig.required ===
+                            undefined
+                            ? true
+                            : uploadConfig
+                                .required,
+                        expectedType: "array",
+                    });
+                }
+                else if (field.type)
+                    expectedFields.push({
+                        name: field.name,
+                        required: field.type === undefined ? true : field.required !== false,
+                        expectedType: field.type ?? "array",
+                    });
             }
         }
         for (const { name, required, expectedType } of expectedFields) {
-            const fieldSchema = properties[name];
+            const schemaKey = this.resolveSchemaFieldName(name);
+            const fieldSchema = properties[schemaKey];
             if (!fieldSchema) {
                 errors.push(`Missing upload field '${name}' in multipart/form-data schema`);
                 continue;
@@ -110,7 +168,7 @@ class ArkosRouterOpenAPIManager {
                     fieldSchema.items.format !== "binary")
                     errors.push(`Upload field '${name}' must have items with type 'string' and format 'binary'`);
             }
-            const isMarkedRequired = requiredFields.includes(name);
+            const isMarkedRequired = requiredFields.includes(schemaKey);
             if (required && !isMarkedRequired)
                 errors.push(`Upload field '${name}' is required in config but not marked as required in schema`);
             if (!required && isMarkedRequired)

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

@@ -1 +1 @@
-{"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"]}
+{"version":3,"file":"arkos-router-openapi-manager.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/arkos-router-openapi-manager.ts"],"names":[],"mappings":";;;;;AACA,mFAAoD;AAOpD,MAAM,yBAAyB;IACrB,sBAAsB,CAAC,IAAY;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACtC,CAAC;IA6BD,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,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAClE,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG;gBACnC,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;gBAChB,GAAG,CAAC,YAAY,CAAC,OAAO,IAAI;oBAC1B,WAAW,EAAE,aAAa,YAAY,CAAC,OAAO,QAAQ;iBACvD,CAAC;gBACF,GAAG,CAAC,YAAY,CAAC,WAAW,IAAI;oBAC9B,WAAW,EAAE,YAAY,CAAC,WAAW;iBACtC,CAAC;aACH,CAAC;YACF,IAAI,YAAY,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBACpC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;aAAM,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACzC,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAClE,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG;gBACnC,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,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;gBACF,GAAG,CAAC,YAAY,CAAC,WAAW,IAAI;oBAC9B,WAAW,EAAE,YAAY,CAAC,WAAW;iBACtC,CAAC;aACH,CAAC;YACF,IAAI,YAAY,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;gBACpC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACxC,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,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC9D,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;gBAG7C,MAAM,UAAU,GACb,KAAa,CAAC,IAAI,KAAK,SAAS;oBAC/B,CAAC,CAAE,YAAoB,CAAC,QAAQ,KAAK,KAAK;oBAC1C,CAAC,CAAE,KAAa,CAAC,QAAQ,KAAK,KAAK,CAAC;gBAExC,IAAI,UAAU,EAAE,CAAC;oBACf,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBACtE,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;IAMO,gBAAgB,CACtB,KAA6B,EAC7B,MAAmC;QAEnC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;gBAChB,GAAG,CAAC,KAAK,CAAC,OAAO;oBACf,CAAC,MAAM,CAAC,OAAO,IAAI;oBACjB,WAAW,EAAE,aAAa,KAAK,CAAC,OAAO,QAAQ;iBAChD,CAAC;gBACJ,GAAG,CAAC,MAAM,CAAC,OAAO;oBAChB,CAAC,KAAK,CAAC,OAAO,IAAI;oBAChB,WAAW,EAAE,aAAa,MAAM,CAAC,OAAO,QAAQ;iBACjD,CAAC;gBACJ,GAAG,CAAC,KAAK,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;aAC7D,CAAC;QACJ,CAAC;QAGD,OAAO;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,QAAQ;aACjB;YACD,GAAG,CAAC,KAAK,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnD,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO;gBACxB,KAAK,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;YACjD,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO;gBAChB,CAAC,MAAM,CAAC,OAAO,IAAI;gBACjB,WAAW,EAAE,sBAAsB,KAAK,CAAC,OAAO,QAAQ;aACzD,CAAC;gBACF,CAAC,MAAM,CAAC,OAAO;oBACb,CAAC,KAAK,CAAC,OAAO,IAAI;oBAChB,WAAW,EAAE,sBAAsB,MAAM,CAAC,OAAO,QAAQ;iBAC1D,CAAC,CAAC;YACP,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO;gBACxB,KAAK,CAAC,WAAW,IAAI;gBACnB,WAAW,EAAE,KAAK,CAAC,WAAW;aAC/B,CAAC;SACL,CAAC;IACJ,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,KAAK,KAAK;gBACzC,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,KAAK,KAAK;gBACzC,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,IAAI,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,EAAE,CAAC;oBACvB,cAAc,CAAC,IAAI,CAAC;wBAClB,IAAI,EAAE,KAAK,CAAC,IAAI;wBAEhB,QAAQ,EACL,YAA4C,CAAC,QAAQ;4BACtD,SAAS;4BACP,CAAC,CAAC,IAAI;4BACN,CAAC,CAAG,YAA4C;iCAC3C,QAAoB;wBAC7B,YAAY,EAAE,OAAO;qBACtB,CAAC,CAAC;gBACL,CAAC;qBAAM,IAAI,KAAK,CAAC,IAAI;oBACnB,cAAc,CAAC,IAAI,CAAC;wBAClB,IAAI,EAAE,KAAK,CAAC,IAAI;wBAChB,QAAQ,EACN,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,KAAK;wBAC5D,YAAY,EAAE,KAAK,CAAC,IAAI,IAAI,OAAO;qBACpC,CAAC,CAAC;YACP,CAAC;QACH,CAAC;QAED,KAAK,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,EAAE,IAAI,cAAc,EAAE,CAAC;YAC9D,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;YACpD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;YAE1C,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,SAAS,CAAC,CAAC;YAC5D,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 {\n  ArkosRouterBaseUploadConfig,\n  UploadConfig,\n  UploadConfigFieldEntry,\n} from \"./types/upload-config\";\n\nclass ArkosRouterOpenAPIManager {\n  private resolveSchemaFieldName(name: string): string {\n    return name.replace(/\\[\\]/g, \"[0]\");\n  }\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({\n   *   type: 'fields',\n   *   fields: [\n   *     { name: 'avatar', type: 'single', uploadDir: 'images' },\n   *     { name: 'gallery', type: 'array', maxCount: 6, uploadDir: 'gallery' },\n   *     { name: 'banners[][images]', type: 'array', maxCount: 5, uploadDir: 'banners' }\n   *   ]\n   * })\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      const schemaKey = this.resolveSchemaFieldName(uploadConfig.field);\n      uploadSchema.properties[schemaKey] = {\n        type: \"string\",\n        format: \"binary\",\n        ...(uploadConfig.maxSize && {\n          description: `Max size: ${uploadConfig.maxSize} bytes`,\n        }),\n        ...(uploadConfig.description && {\n          description: uploadConfig.description,\n        }),\n      };\n      if (uploadConfig.required !== false) {\n        uploadSchema.required.push(schemaKey);\n      }\n    } else if (uploadConfig.type === \"array\") {\n      const schemaKey = this.resolveSchemaFieldName(uploadConfig.field);\n      uploadSchema.properties[schemaKey] = {\n        type: \"array\",\n        items: {\n          type: \"string\",\n          format: \"binary\",\n        },\n        ...(uploadConfig.maxCount && { maxItems: uploadConfig.maxCount }),\n        ...(uploadConfig.minCount && { minItems: uploadConfig.minCount }),\n        ...(uploadConfig.maxSize && {\n          description: `Max size per file: ${uploadConfig.maxSize} bytes`,\n        }),\n        ...(uploadConfig.description && {\n          description: uploadConfig.description,\n        }),\n      };\n      if (uploadConfig.required !== false) {\n        uploadSchema.required.push(schemaKey);\n      }\n    } else if (uploadConfig.type === \"fields\") {\n      for (const field of uploadConfig.fields) {\n        uploadSchema.properties[this.resolveSchemaFieldName(field.name)] =\n          this.buildFieldSchema(field, uploadConfig);\n\n        // legacy shape has no type and no required — default to required\n        const isRequired =\n          (field as any).type === undefined\n            ? (uploadConfig as any).required !== false\n            : (field as any).required !== false;\n\n        if (isRequired) {\n          uploadSchema.required.push(this.resolveSchemaFieldName(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   * Builds the OpenAPI property schema for a single field entry.\n   * Legacy entries (no type) are treated as array.\n   */\n  private buildFieldSchema(\n    field: UploadConfigFieldEntry,\n    config: ArkosRouterBaseUploadConfig\n  ): object {\n    if (field.type === \"single\") {\n      return {\n        type: \"string\",\n        format: \"binary\",\n        ...(field.maxSize &&\n          !config.maxSize && {\n            description: `Max size: ${field.maxSize} bytes`,\n          }),\n        ...(config.maxSize &&\n          !field.maxSize && {\n            description: `Max size: ${config.maxSize} bytes`,\n          }),\n        ...(field.description && { description: field.description }),\n      };\n    }\n\n    // type === \"array\" or legacy (no type) — both produce array schema\n    return {\n      type: \"array\",\n      items: {\n        type: \"string\",\n        format: \"binary\",\n      },\n      ...(field.maxCount && { maxItems: field.maxCount }),\n      ...(field.type === \"array\" &&\n        field.minCount && { minItems: field.minCount }),\n      ...((field.maxSize &&\n        !config.maxSize && {\n          description: `Max size per file: ${field.maxSize} bytes`,\n        }) ||\n        (config.maxSize &&\n          !field.maxSize && {\n            description: `Max size per file: ${config.maxSize} bytes`,\n          })),\n      ...(field.type === \"array\" &&\n        field.description && {\n          description: field.description,\n        }),\n    };\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        if (!(\"type\" in field)) {\n          expectedFields.push({\n            name: field.name,\n            // legacy shape has no type and no required — default to required\n            required:\n              (uploadConfig as ArkosRouterBaseUploadConfig).required ===\n              undefined\n                ? true\n                : ((uploadConfig as ArkosRouterBaseUploadConfig)\n                    .required as boolean),\n            expectedType: \"array\",\n          });\n        } else if (field.type)\n          expectedFields.push({\n            name: field.name,\n            required:\n              field.type === undefined ? true : field.required !== false,\n            expectedType: field.type ?? \"array\",\n          });\n      }\n    }\n\n    for (const { name, required, expectedType } of expectedFields) {\n      const schemaKey = this.resolveSchemaFieldName(name);\n      const fieldSchema = properties[schemaKey];\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(schemaKey);\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

@@ -17,12 +17,13 @@ function ArkosRouter(options) {
     const router = (0, express_1.Router)(options);
     return (0, apply_arkos_router_proxy_1.applyArkosRouterProxy)(router, options);
 }
+const hasDuplicatedPath = (path) => /^(\/.+)\1/.test(path);
 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)
+    routes.forEach(({ path, method, config, routeOptions }) => {
+        if (config?.experimental?.openapi === false || hasDuplicatedPath(path))
             return;
         const originalPath = path;
         const pathParatemersFromRoutePath = (0, helpers_1.extractPathParams)(path);
@@ -101,7 +102,12 @@ function generateOpenAPIFromApp(app) {
             ...convertedOpenAPI,
             summary: openapi?.summary || `${path}`,
             description: openapi?.description || `${method} ${path}`,
-            tags: openapi?.tags || ["Defaults"],
+            servers: openapi?.servers || routeOptions?.openapi?.servers || undefined,
+            security: openapi?.security || routeOptions?.openapi?.security || undefined,
+            externalDocs: openapi?.externalDocs ||
+                routeOptions?.openapi?.externalDocs ||
+                undefined,
+            tags: openapi?.tags || routeOptions?.openapi?.tags || ["Defaults"],
             operationId: openapi.operationId || `${method.toLowerCase()}:${path}`,
             parameters: allParameters,
             ...(!convertedOpenAPI.requestBody &&
@@ -124,15 +130,13 @@ function generateOpenAPIFromApp(app) {
                     })(),
                 },
             }),
-            ...(convertedOpenAPI?.requestBody?.content?.["application/json"]
-                ?.schema &&
-                !multipartFormSchema &&
+            ...(!multipartFormSchema &&
                 !config?.validation?.body &&
                 hasUploadFields && {
                 requestBody: {
                     content: (() => {
                         const schema = convertedOpenAPI?.requestBody?.content?.["application/json"]
-                            ?.schema;
+                            ?.schema || {};
                         return {
                             "multipart/form-data": {
                                 schema: openapi_schema_converter_1.default.flattenSchema(arkos_router_openapi_manager_1.default.addUploadFields(config?.experimental?.uploads || {}, schema)),

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/index.ts"],"names":[],"mappings":";;;;;AAmCA,8BAQC;AAED,wDAyLC;AAtOD,qCAAgD;AAGhD,6CAAwE;AACxE,2CAA+C;AAC/C,4EAAiD;AACjD,wIAA4G;AAC5G,4HAAkG;AAClG,kGAAuE;AACvE,uFAAiF;AA0BjF,SAAwB,WAAW,CACjC,OAGC;IAED,MAAM,MAAM,GAAG,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,IAAA,gDAAqB,EAAC,MAAM,EAAE,OAAO,CAAiB,CAAC;AAChE,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,aAAa,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACrD,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE;YAC9B,aAAa,EAAE,CAAC;YAChB,OAAO,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,aAAa,GAAG,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,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;gBACnB,KAAK,CAAC,IAAI,KAAK,GAAG;gBAElB,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,GAAG,gBAAgB;YACnB,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,OAAO,CAAC,WAAW,IAAI,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE;YACrE,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,gBAAgB,EAAE,WAAW,EAAE,OAAO;4BACzC,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,EAAE,MAAM;gBACR,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;4BAC1D,EAAE,MAAM,CAAC;wBAEb,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,EAAE,OAAO;yBAC1C,CAAC;oBACJ,CAAC,CAAC,EAAE;iBACL;aACF,CAAC;SACL,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { Router, RouterOptions } from \"express\";\nimport { IArkosRouter, ArkosRouteConfig } from \"./types\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { extractArkosRoutes, extractPathParams } from \"./utils/helpers\";\nimport { getArkosConfig } from \"../../exports\";\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 arkosRouterOpenApiManager from \"./arkos-router-openapi-manager\";\nimport { applyArkosRouterProxy } from \"./utils/helpers/apply-arkos-router-proxy\";\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  return applyArkosRouterProxy(router, options) 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    let wildcardCount = (path.match(/\\*/g) || []).length;\n    let wildcardIndex = 0;\n    path = path.replace(/\\*/g, () => {\n      wildcardIndex++;\n      return wildcardCount === 1 ? \"{path}\" : `{path${wildcardIndex}}`;\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        param.name !== \"*\"\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      ...convertedOpenAPI,\n      summary: openapi?.summary || `${path}`,\n      description: openapi?.description || `${method} ${path}`,\n      tags: openapi?.tags || [\"Defaults\"],\n      operationId: openapi.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                ...convertedOpenAPI?.requestBody?.content,\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        ?.schema &&\n        !multipartFormSchema &&\n        !(config as any)?.validation?.body &&\n        hasUploadFields && {\n          requestBody: {\n            content: (() => {\n              const schema =\n                convertedOpenAPI?.requestBody?.content?.[\"application/json\"]\n                  ?.schema;\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?.content,\n              };\n            })(),\n          },\n        }),\n    };\n  });\n\n  return paths;\n}\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/utils/arkos-router/index.ts"],"names":[],"mappings":";;;;;AA8GA,8BAKC;AAID,wDA+LC;AAtTD,qCAAgD;AAGhD,6CAAwE;AACxE,2CAA+C;AAC/C,4EAAiD;AACjD,wIAA4G;AAC5G,4HAAkG;AAClG,kGAAuE;AACvE,uFAAiF;AAqGjF,SAAwB,WAAW,CACjC,OAA4C;IAE5C,MAAM,MAAM,GAAG,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC;IAC/B,OAAO,IAAA,gDAAqB,EAAC,MAAM,EAAE,OAAO,CAAiB,CAAC;AAChE,CAAC;AAED,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAEnE,SAAgB,sBAAsB,CAAC,GAAU;IAC/C,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,YAAY,EAAE,EAAE,EAAE;QACxD,IAAI,MAAM,EAAE,YAAY,EAAE,OAAO,KAAK,KAAK,IAAI,iBAAiB,CAAC,IAAI,CAAC;YACpE,OAAO;QACT,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,aAAa,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACrD,IAAI,aAAa,GAAG,CAAC,CAAC;QACtB,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE;YAC9B,aAAa,EAAE,CAAC;YAChB,OAAO,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,aAAa,GAAG,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,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;gBACnB,KAAK,CAAC,IAAI,KAAK,GAAG;gBAElB,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,GAAG,gBAAgB;YACnB,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,GAAG,IAAI,EAAE;YACtC,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,GAAG,MAAM,IAAI,IAAI,EAAE;YACxD,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,OAAO,EAAE,OAAO,IAAI,SAAS;YACxE,QAAQ,EACN,OAAO,EAAE,QAAQ,IAAI,YAAY,EAAE,OAAO,EAAE,QAAQ,IAAI,SAAS;YACnE,YAAY,EACV,OAAO,EAAE,YAAY;gBACrB,YAAY,EAAE,OAAO,EAAE,YAAY;gBACnC,SAAS;YACX,IAAI,EAAE,OAAO,EAAE,IAAI,IAAI,YAAY,EAAE,OAAO,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC;YAClE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE;YACrE,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,gBAAgB,EAAE,WAAW,EAAE,OAAO;4BACzC,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,CAAC,mBAAmB;gBACtB,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;4BAC1D,EAAE,MAAM,IAAI,EAAE,CAAC;wBAEnB,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,EAAE,OAAO;yBAC1C,CAAC;oBACJ,CAAC,CAAC,EAAE;iBACL;aACF,CAAC;SACuB,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC","sourcesContent":["import { Router, RouterOptions } from \"express\";\nimport { IArkosRouter } from \"./types\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport { extractArkosRoutes, extractPathParams } from \"./utils/helpers\";\nimport { getArkosConfig } from \"../../exports\";\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 arkosRouterOpenApiManager from \"./arkos-router-openapi-manager\";\nimport { applyArkosRouterProxy } from \"./utils/helpers/apply-arkos-router-proxy\";\nimport { Arkos } from \"../../types/arkos\";\n\nexport type ArkosRouterOptions = {\n  /**\n   * Prefix to apply to all routes in this router.\n   * Nested routers inherit and concatenate prefixes from parent routers.\n   *\n   * @since 1.5.0-beta\n   * @example\n   * // All routes in this router will be prefixed with \"/api\"\n   * prefix: \"/api\"\n   */\n  prefix?: string | RegExp | Array<string | RegExp>;\n  /**\n   * OpenAPI metadata to apply to all routes in this router.\n   * Nested routers inherit from parent routers unless explicitly overridden.\n   * Route-level openapi config fully replaces inherited values when defined.\n   *\n   * @since 1.6.0-beta\n   * @example\n   * openapi: {\n   *   tags: [\"Users\"],\n   *   security: [{ bearerAuth: [] }]\n   * }\n   */\n  openapi?: {\n    /**\n     * Tags to apply to all routes in this router, used to group them in OpenAPI documentation.\n     * Route-level tags fully replaces this value when defined.\n     *\n     * @since 1.6.0-beta\n     * @example\n     * // Group all routes in this router under \"Users\"\n     * tags: [\"Users\"]\n     */\n    tags?: string[];\n    /**\n     * Security requirements to apply to all routes in this router.\n     * Route-level security fully replaces this value when defined.\n     *\n     * @since 1.6.2-canary.1\n     * @example\n     * // Require bearer auth for all routes in this router\n     * security: [{ bearerAuth: [] }]\n     *\n     * // Explicitly make all routes public (overridable per route)\n     * security: []\n     */\n    security?: OpenAPIV3.SecurityRequirementObject[];\n\n    /**\n     * Server definitions to apply to all routes in this router.\n     * Follows the OpenAPI 3.0 Server Object specification.\n     * Route-level servers fully replaces this value when defined.\n     *\n     * @since 1.6.2-canary.1\n     * @example\n     * servers: [{ url: \"https://api.example.com/v2\", description: \"V2 API\" }]\n     */\n    servers?: OpenAPIV3.ServerObject[];\n    /**\n     * External documentation to apply to all routes in this router.\n     * Route-level externalDocs fully replaces this value when defined.\n     *\n     * @since 1.6.2-canary.1\n     * @example\n     * externalDocs: {\n     *   description: \"Find more information here\",\n     *   url: \"https://docs.example.com/users\"\n     * }\n     */\n    externalDocs?: OpenAPIV3.ExternalDocumentationObject;\n  };\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 https://www.arkosjs.com/docs/reference/arkos-router} for configuration options\n * @since 1.4.0-beta\n */\nexport default function ArkosRouter(\n  options?: RouterOptions & ArkosRouterOptions\n): IArkosRouter {\n  const router = Router(options);\n  return applyArkosRouterProxy(router, options) as IArkosRouter;\n}\n\nconst hasDuplicatedPath = (path: string) => /^(\\/.+)\\1/.test(path);\n\nexport function generateOpenAPIFromApp(app: Arkos) {\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, routeOptions }) => {\n    if (config?.experimental?.openapi === false || hasDuplicatedPath(path))\n      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    let wildcardCount = (path.match(/\\*/g) || []).length;\n    let wildcardIndex = 0;\n    path = path.replace(/\\*/g, () => {\n      wildcardIndex++;\n      return wildcardCount === 1 ? \"{path}\" : `{path${wildcardIndex}}`;\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        param.name !== \"*\"\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      ...convertedOpenAPI,\n      summary: openapi?.summary || `${path}`,\n      description: openapi?.description || `${method} ${path}`,\n      servers: openapi?.servers || routeOptions?.openapi?.servers || undefined,\n      security:\n        openapi?.security || routeOptions?.openapi?.security || undefined,\n      externalDocs:\n        openapi?.externalDocs ||\n        routeOptions?.openapi?.externalDocs ||\n        undefined,\n      tags: openapi?.tags || routeOptions?.openapi?.tags || [\"Defaults\"],\n      operationId: openapi.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                ...convertedOpenAPI?.requestBody?.content,\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      ...(!multipartFormSchema &&\n        !(config as any)?.validation?.body &&\n        hasUploadFields && {\n          requestBody: {\n            content: (() => {\n              const schema =\n                convertedOpenAPI?.requestBody?.content?.[\"application/json\"]\n                  ?.schema || {};\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?.content,\n              };\n            })(),\n          },\n        }),\n    } as OpenAPIV3.PathItemObject;\n  });\n\n  return paths;\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IRoute,\n  IRouter,\n  IRouterHandler,\n  IRouterMatcher,\n  Locals,\n} from \"express\";\nimport { z, 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 ArkosUseConfig = Pick<\n  ArkosRouteConfig,\n  | \"authentication\"\n  | \"rateLimit\"\n  | \"compression\"\n  | \"queryParser\"\n  | \"bodyParser\"\n  | \"disabled\"\n> & {\n  path?: PathParams; // optional unlike ArkosRouteConfig where path is required\n};\n\ntype InferValidationType<T, Fallback> = T extends ZodSchema\n  ? z.infer<T>\n  : T extends new (...args: any[]) => infer I\n    ? I\n    : Fallback;\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> = IRouterHandler<T> &\n  IRouterMatcher<T> & {\n    (config: PathParams, ...handlers: Array<ArkosAnyRequestHandler>): T;\n    <\n      TQuery extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n      TBody extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n      TParams extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n    >(\n      config: ArkosRouteConfig<TQuery, TBody, TParams>,\n      ...handlers: Array<\n        | ArkosRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            any\n          >\n        | Array<\n            ArkosRequestHandler<\n              InferValidationType<TParams, Record<string, string>>,\n              any,\n              InferValidationType<TBody, any>,\n              InferValidationType<TQuery, qs.ParsedQs>,\n              any\n            >\n          >\n      >\n    ): T;\n    <\n      TQuery extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n      TBody extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n      TParams extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | false\n        | undefined = any,\n    >(\n      config: ArkosRouteConfig<TQuery, TBody, TParams>,\n      ...handlers: Array<\n        | ArkosErrorRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            any\n          >\n        | Array<\n            ArkosErrorRequestHandler<\n              InferValidationType<TParams, Record<string, string>>,\n              any,\n              InferValidationType<TBody, any>,\n              InferValidationType<TQuery, qs.ParsedQs>,\n              any\n            >\n          >\n      >\n    ): T;\n  };\n\nexport type ArkosRouteMethodHandler<T> = {\n  (\n    config: ArkosAnyRequestHandler | Omit<ArkosRouteConfig, \"path\">,\n    ...handlers: Array<\n      | ArkosRequestHandler\n      | ArkosErrorRequestHandler\n      | Array<ArkosRequestHandler | ArkosErrorRequestHandler>\n    >\n  ): T;\n  <\n    TQuery extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n    TBody extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n    TParams extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n  >(\n    config: Omit<ArkosRouteConfig<TQuery, TBody, TParams>, \"path\">,\n    ...handlers: Array<\n      | ArkosRequestHandler<\n          InferValidationType<TParams, Record<string, string>>,\n          any,\n          InferValidationType<TBody, any>,\n          InferValidationType<TQuery, qs.ParsedQs>,\n          Locals\n        >\n      | Array<\n          ArkosRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            Locals\n          >\n        >\n    >\n  ): T;\n\n  <\n    TQuery extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n    TBody extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n    TParams extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | false\n      | undefined = any,\n  >(\n    config: Omit<ArkosRouteConfig<TQuery, TBody, TParams>, \"path\">,\n    ...handlers: Array<\n      | ArkosErrorRequestHandler<\n          InferValidationType<TParams, Record<string, string>>,\n          any,\n          InferValidationType<TBody, any>,\n          InferValidationType<TQuery, qs.ParsedQs>,\n          Locals\n        >\n      | Array<\n          ArkosErrorRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            Locals\n          >\n        >\n    >\n  ): T;\n};\n\n/**\n * Handler function for `use` that accepts route configuration and middleware handlers.\n *\n * @param {ArkosUseConfig} config - The use configuration object or path.\n * @param {...ArkosAnyRequestHandler} handlers - Middleware handlers.\n * @returns {T} The router instance.\n */\n\nexport type UseMethodHandler<T> = IRouterHandler<T> &\n  IRouterMatcher<T> & {\n    (\n      config: ArkosUseConfig,\n      ...handlers: Array<ArkosRequestHandler | Array<ArkosRequestHandler>>\n    ): T;\n    (\n      config: ArkosUseConfig,\n      ...handlers: Array<\n        ArkosErrorRequestHandler | Array<ArkosErrorRequestHandler>\n      >\n    ): T;\n  };\n\nexport interface IArkosRoute 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  use: UseMethodHandler<this>;\n\n  route<T extends string>(prefix: T): IArkosRoute;\n  route(prefix: PathParams): IArkosRoute;\n}\n\n/**\n * Configuration object for defining routes in Arkos.js.\n */\nexport type ArkosRouteConfig<\n  TQuery extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | false\n    | undefined = any,\n  TBody extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | false\n    | undefined = any,\n  TParams extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | false\n    | undefined = any,\n> = {\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?: TQuery;\n        body?: TBody;\n        params?: TParams;\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"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/utils/arkos-router/types/index.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  IRoute,\n  IRouter,\n  IRouterHandler,\n  IRouterMatcher,\n  Locals,\n} from \"express\";\nimport { z, 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\";\nimport { ArkosRouterOptions } from \"..\";\n\nexport type ArkosUseConfig = Pick<\n  ArkosRouteConfig,\n  | \"authentication\"\n  | \"rateLimit\"\n  | \"compression\"\n  | \"queryParser\"\n  | \"bodyParser\"\n  | \"disabled\"\n> & {\n  path?: PathParams; // optional unlike ArkosRouteConfig where path is required\n};\n\ntype InferValidationType<T, Fallback> = T extends ZodSchema\n  ? z.infer<T>\n  : T extends new (...args: any[]) => infer I\n    ? I\n    : Fallback;\n\nexport type PathParams = string | RegExp | Array<string | RegExp>;\n\nexport type InternalIArkosRouter = IArkosRouter & {\n  _arkos: {\n    options?: ArkosRouterOptions;\n    routes: Array<{\n      handler: ArkosAnyRequestHandler;\n      config: ArkosRouteConfig;\n      method: string;\n    }>;\n  };\n};\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> = IRouterHandler<T> &\n  IRouterMatcher<T> & {\n    (config: PathParams, ...handlers: Array<ArkosAnyRequestHandler>): T;\n    <\n      TQuery extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n      TBody extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n      TParams extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n    >(\n      config: ArkosRouteConfig<TQuery, TBody, TParams>,\n      ...handlers: Array<\n        | ArkosRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            any\n          >\n        | Array<\n            ArkosRequestHandler<\n              InferValidationType<TParams, Record<string, string>>,\n              any,\n              InferValidationType<TBody, any>,\n              InferValidationType<TQuery, qs.ParsedQs>,\n              any\n            >\n          >\n      >\n    ): T;\n    <\n      TQuery extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n      TBody extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n      TParams extends\n        | ZodSchema\n        | (new (...args: any[]) => object)\n        | null\n        | false\n        | undefined = any,\n    >(\n      config: ArkosRouteConfig<TQuery, TBody, TParams>,\n      ...handlers: Array<\n        | ArkosErrorRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            any\n          >\n        | Array<\n            ArkosErrorRequestHandler<\n              InferValidationType<TParams, Record<string, string>>,\n              any,\n              InferValidationType<TBody, any>,\n              InferValidationType<TQuery, qs.ParsedQs>,\n              any\n            >\n          >\n      >\n    ): T;\n  };\n\nexport type ArkosRouteMethodHandler<T> = {\n  (\n    config: ArkosAnyRequestHandler | Omit<ArkosRouteConfig, \"path\">,\n    ...handlers: Array<\n      | ArkosRequestHandler\n      | ArkosErrorRequestHandler\n      | Array<ArkosRequestHandler | ArkosErrorRequestHandler>\n    >\n  ): T;\n  <\n    TQuery extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n    TBody extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n    TParams extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n  >(\n    config: Omit<ArkosRouteConfig<TQuery, TBody, TParams>, \"path\">,\n    ...handlers: Array<\n      | ArkosRequestHandler<\n          InferValidationType<TParams, Record<string, string>>,\n          any,\n          InferValidationType<TBody, any>,\n          InferValidationType<TQuery, qs.ParsedQs>,\n          Locals\n        >\n      | Array<\n          ArkosRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            Locals\n          >\n        >\n    >\n  ): T;\n\n  <\n    TQuery extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n    TBody extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n    TParams extends\n      | ZodSchema\n      | (new (...args: any[]) => object)\n      | null\n      | null\n      | false\n      | undefined = any,\n  >(\n    config: Omit<ArkosRouteConfig<TQuery, TBody, TParams>, \"path\">,\n    ...handlers: Array<\n      | ArkosErrorRequestHandler<\n          InferValidationType<TParams, Record<string, string>>,\n          any,\n          InferValidationType<TBody, any>,\n          InferValidationType<TQuery, qs.ParsedQs>,\n          Locals\n        >\n      | Array<\n          ArkosErrorRequestHandler<\n            InferValidationType<TParams, Record<string, string>>,\n            any,\n            InferValidationType<TBody, any>,\n            InferValidationType<TQuery, qs.ParsedQs>,\n            Locals\n          >\n        >\n    >\n  ): T;\n};\n\n/**\n * Handler function for `use` that accepts route configuration and middleware handlers.\n *\n * @param {ArkosUseConfig} config - The use configuration object or path.\n * @param {...ArkosAnyRequestHandler} handlers - Middleware handlers.\n * @returns {T} The router instance.\n */\n\nexport type UseMethodHandler<T> = IRouterHandler<T> &\n  IRouterMatcher<T> & {\n    (\n      config: ArkosUseConfig,\n      ...handlers: Array<ArkosRequestHandler | Array<ArkosRequestHandler>>\n    ): T;\n    (\n      config: ArkosUseConfig,\n      ...handlers: Array<\n        ArkosErrorRequestHandler | Array<ArkosErrorRequestHandler>\n      >\n    ): T;\n    (...handlers: Array<ArkosRequestHandler | Array<ArkosRequestHandler>>): T;\n  };\n\nexport interface IArkosRoute 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  use: UseMethodHandler<this>;\n\n  route<T extends string>(prefix: T): IArkosRoute;\n  route(prefix: PathParams): IArkosRoute;\n}\n\n/**\n * Configuration object for defining routes in Arkos.js.\n */\nexport type ArkosRouteConfig<\n  TQuery extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | null\n    | false\n    | null\n    | undefined = any,\n  TBody extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | null\n    | false\n    | null\n    | undefined = any,\n  TParams extends\n    | ZodSchema\n    | (new (...args: any[]) => object)\n    | null\n    | false\n    | null\n    | undefined = any,\n> = {\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   * - Set to `null` to forbidden all request inputs.\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    | null\n    | {\n        query?: TQuery;\n        body?: TBody;\n        params?: TParams;\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/upload-config.js.map

@@ -1 +1 @@
-{"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"]}
+{"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. Supports bracket notation, including nested array paths (e.g. \"banners[][image]\") */\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. Supports bracket notation, including nested array paths (e.g. \"banners[][images]\") */\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   * Each field entry is a full single or array upload config with a `name`\n   * property. Field names support bracket notation, including nested array\n   * paths (e.g. \"banners[][images]\").\n   *\n   * @example\n   * uploads: {\n   *   type: \"fields\",\n   *   fields: [\n   *     { name: \"avatar\", type: \"single\", uploadDir: \"images\" },\n   *     { name: \"resume\", type: \"single\", uploadDir: \"documents\" },\n   *     { name: \"banners[][images]\", type: \"array\", maxCount: 5, uploadDir: \"banners\" }\n   *   ]\n   * }\n   */\n  | ({\n      type: \"fields\";\n      /** Array of field configurations describing multipart form fields to process */\n      fields: UploadConfigFieldEntry[];\n    } & Pick<ArkosRouterBaseUploadConfig, \"deleteOnError\">)\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 * A single field entry inside a `fields` upload config.\n * Each entry is a full single or array upload config with an additional\n * `name` property identifying the form field.\n *\n * Field names support bracket notation, including nested array paths\n * (e.g. \"banners[][images]\"). For nested array paths, multer validation\n * is bypassed and constraints (allowedFileTypes, maxSize, minCount, maxCount)\n * are enforced per group after upload.\n */\nexport type UploadConfigFieldEntry =\n  /**\n   * A single-file field entry.\n   *\n   * @example\n   * { name: \"avatar\", type: \"single\", uploadDir: \"images\", required: true }\n   *\n   * @example\n   * // nested array path — one image per banner\n   * { name: \"banners[][image]\", type: \"single\", uploadDir: \"banners\" }\n   */\n  | ({\n      /** Name of the form field. Supports bracket notation including nested array paths. */\n      name: string;\n      type: \"single\";\n    } & Omit<ArkosRouterBaseUploadConfig, \"deleteOnError\">)\n  /**\n   * A multi-file field entry.\n   *\n   * @example\n   * { name: \"gallery\", type: \"array\", maxCount: 6, uploadDir: \"gallery\" }\n   *\n   * @example\n   * // nested array path — multiple images per banner, min 1 max 5\n   * { name: \"banners[][images]\", type: \"array\", minCount: 1, maxCount: 5, uploadDir: \"banners\" }\n   */\n  | ({\n      /** Name of the form field. Supports bracket notation including nested array paths. */\n      name: string;\n      type?: \"array\";\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    } & Omit<ArkosRouterBaseUploadConfig, \"deleteOnError\">); /**\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"]}