arkos 2.0.0-next.2 → 2.0.0-next.21

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

@@ -1,4 +1,5 @@
-class RouteConfigRegistry {
+export default class RouteConfigRegistry {
+    static configs = new WeakMap();
     static register(handler, config, method) {
         this.configs.set(handler, { ...config, method });
     }
@@ -9,6 +10,4 @@ class RouteConfigRegistry {
         return this.configs;
     }
 }
-RouteConfigRegistry.configs = new WeakMap();
-export default RouteConfigRegistry;
 //# sourceMappingURL=route-config-registry.js.map

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

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

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

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

package/dist/esm/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":["import { ArkosFile } from \"../../../exports\";\n\nexport 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?:\n    | \"pathname\"\n    | \"url\"\n    | \"file\"\n    | false\n    | ((file: ArkosFile) => any);\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"]}

package/dist/esm/utils/arkos-router/utils/helpers/apply-arkos-router-proxy.js

@@ -0,0 +1,188 @@
+import RouteConfigValidator from "../../route-config-validator.js";
+import { applyPrefix, getMiddlewareStack } from "./index.js";
+import { getUserFileExtension } from "../../../helpers/fs.helpers.js";
+import { getArkosConfig } from "../../../../server.js";
+import RouteConfigRegistry from "../../route-config-registry.js";
+import { catchAsync } from "../../../../exports/error-handler/index.js";
+import deepmerge from "../../../helpers/deepmerge.helper.js";
+import ExitError from "../../../helpers/exit-error.js";
+import uploadManager from "./upload-manager.js";
+import loadableRegistry from "../../../../components/arkos-loadable-registry/index.js";
+import { state } from "../../../../app.js";
+import { docsLink } from "../../../../app.js";
+const flattenHandlers = (arr) => {
+    return arr.reduce((flat, item) => {
+        return flat.concat(Array.isArray(item) ? flattenHandlers(item) : item);
+    }, []);
+};
+export function applyArkosRouterProxy(target, options, component = "router") {
+    target._arkos = {
+        options,
+        routes: [],
+    };
+    target.load = (...items) => {
+        if (state !== "idle")
+            throw ExitError(`app.load() must be called before app.${state === "listening" ? "listen" : "build"}(), see ${docsLink}`);
+        if (Array.isArray(items[0]))
+            items = items[0];
+        items = Array.isArray(items) ? items : [items];
+        items.forEach((item) => loadableRegistry.register(item));
+        return target;
+    };
+    return new Proxy(target, {
+        get(target, prop, receiver) {
+            const originalMethod = Reflect.get(target, prop, receiver);
+            const httpMethods = [
+                "get",
+                "post",
+                "put",
+                "patch",
+                "delete",
+                "all",
+                "head",
+                "trace",
+                "options",
+            ];
+            if (prop === "use") {
+                return function (config, ...handlers) {
+                    if (typeof config === "function" || Array.isArray(config)) {
+                        handlers = [config, ...handlers];
+                        config = {};
+                    }
+                    else if (!config ||
+                        typeof config !== "object" ||
+                        typeof config === "string" ||
+                        config instanceof RegExp) {
+                        throw ExitError(`First argument of ${component}.use() must be a valid ArkosRouteConfig object or a middleware function, but received ${typeof config === "object" ? JSON.stringify(config, null, 2) : config}.`);
+                    }
+                    if (config.disabled)
+                        return;
+                    const useConfig = config;
+                    const path = applyPrefix(options?.prefix, useConfig.path ?? "/");
+                    const arkosConfig = getArkosConfig();
+                    const authenticationConfig = arkosConfig.authentication;
+                    if (useConfig.authentication && !authenticationConfig?.mode)
+                        throw ExitError(`Trying to authenticate route ${path ? `${path}` : ""} without choosing an authentication mode under arkos.config.${getUserFileExtension()}
+
+For further help see https://www.arkosjs.com/docs/core-concepts/authentication/setup.`);
+                    const flatHandlers = flattenHandlers(handlers);
+                    handlers = flatHandlers.map((handler) => {
+                        if (!handler || typeof handler !== "function")
+                            throw ExitError(`Wrong value for handler in route ${path}, recevied ${handler}.`);
+                        return "param" in handler
+                            ? handler
+                            : catchAsync(handler, {
+                                type: handler.length > 3 ? "error" : "normal",
+                            });
+                    });
+                    const middlewareStack = getMiddlewareStack(useConfig);
+                    const allHandlers = [...middlewareStack, ...handlers];
+                    return originalMethod.call(target, path, ...allHandlers);
+                };
+            }
+            if (prop === "route") {
+                return function (path) {
+                    const routeChain = {};
+                    httpMethods.forEach((method) => {
+                        routeChain[method] = function (config, ...handlers) {
+                            if (typeof config === "function" || Array.isArray(config))
+                                throw ExitError(`First argument of ${component}.route("${path}").${method}() must be a valid ArkosRouteConfig object without path field, but received ${typeof config === "object" ? JSON.stringify(config, null, 2) : config}`);
+                            const fullConfig = {
+                                ...config,
+                                path,
+                            };
+                            receiver[method](fullConfig, ...handlers);
+                            return routeChain;
+                        };
+                    });
+                    return routeChain;
+                };
+            }
+            if (httpMethods.includes(prop)) {
+                return function (config, ...handlers) {
+                    if (!config || !RouteConfigValidator.isArkosRouteConfig(config))
+                        throw ExitError(`First argument of ${component}.${prop}() must be a valid ArkosRouteConfig object with path field, but recevied ${typeof config === "object" ? JSON.stringify(config, null, 2) : config}`);
+                    if (config?.disabled)
+                        return;
+                    const path = applyPrefix(options?.prefix, config.path);
+                    config = {
+                        ...config,
+                        ...(options?.openapi
+                            ? {
+                                experimental: {
+                                    ...config?.experimental,
+                                    openapi: deepmerge(options.openapi || {}, config?.experimental?.openapi || {}),
+                                },
+                            }
+                            : {}),
+                        path,
+                    };
+                    config = {
+                        ...config,
+                        ...(options?.uploads
+                            ? {
+                                experimental: {
+                                    ...config?.experimental,
+                                    ...(config?.experimental?.uploads
+                                        ? {
+                                            uploads: deepmerge(options.uploads, config.experimental.uploads),
+                                        }
+                                        : {}),
+                                },
+                            }
+                            : {}),
+                        path,
+                    };
+                    if ([null, undefined].includes(path))
+                        throw new Error("Please pass valid value for path field to use in your route");
+                    const method = prop;
+                    const UndefinedHandlerError = (handler) => ExitError(`Wrong value for handler in route ${method.toUpperCase()} ${path}, recevied ${handler}.`);
+                    if (handlers.length > 0) {
+                        const flatHandlers = flattenHandlers(handlers);
+                        handlers = flatHandlers.map((handler) => {
+                            if (!handler || typeof handler !== "function")
+                                throw UndefinedHandlerError(handler);
+                            return catchAsync(handler, {
+                                type: handler.length > 3 ? "error" : "normal",
+                            });
+                        });
+                        const finalHandler = handlers[handlers.length - 1];
+                        RouteConfigRegistry.register(finalHandler, config, method);
+                        target._arkos.routes.push({
+                            handler: finalHandler,
+                            config,
+                            method,
+                        });
+                    }
+                    const arkosConfig = getArkosConfig();
+                    const validationConfig = arkosConfig.validation;
+                    const authenticationConfig = arkosConfig.authentication;
+                    const strictValidation = validationConfig?.strict;
+                    const route = `${method.toUpperCase()} ${path}`;
+                    if (strictValidation &&
+                        (!("validation" in config) ||
+                            ("validation" in config &&
+                                !config.validation &&
+                                config.validation !== undefined)))
+                        throw ExitError("When using strict validation you must either pass { validation: false } in order to explicitly tell that no input will be received, or pass `undefined` for each input type e.g { validation: { query: undefined } } in order to deny the input of given request input.");
+                    if (!validationConfig?.resolver &&
+                        Object.keys(config.validation || {}).length > 0)
+                        throw ExitError(`Trying to pass validators into route ${route} config validation option without choosing a validation resolver under arkos.init({ validation: { resolver: '' } })`);
+                    if (config.authentication && !authenticationConfig?.mode)
+                        throw ExitError(`Trying to authenticate route ${route} without choosing an authentication mode under arkos.config.${getUserFileExtension()}
+
+For further help see https://www.arkosjs.com/docs/core-concepts/authentication/setup.`);
+                    handlers = [...getMiddlewareStack(config), ...handlers];
+                    if (handlers.length === 0)
+                        throw ExitError(`No handlers provided for route ${method.toUpperCase()} ${path}.`);
+                    if (config.experimental?.uploads &&
+                        config.experimental.uploads.deleteOnError !== false)
+                        handlers.push(catchAsync(uploadManager.handleFileCleanup(config.experimental.uploads), { type: "error" }));
+                    return originalMethod.call(target, path, ...handlers);
+                };
+            }
+            return originalMethod;
+        },
+    });
+}
+//# sourceMappingURL=apply-arkos-router-proxy.js.map

package/dist/esm/utils/arkos-router/utils/helpers/apply-arkos-router-proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-arkos-router-proxy.js","sourceRoot":"","sources":["../../../../../../src/utils/arkos-router/utils/helpers/apply-arkos-router-proxy.ts"],"names":[],"mappings":"AASA,OAAO,oBAAoB,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,GAAG,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,mBAAmB,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAC/D,OAAO,SAAS,MAAM,mCAAmC,CAAC;AAC1D,OAAO,SAAS,MAAM,6BAA6B,CAAC;AACpD,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAM7C,OAAO,gBAAgB,MAAM,gDAAgD,CAAC;AAC9E,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAE3C,MAAM,eAAe,GAAG,CAAC,GAAU,EAA4B,EAAE;IAC/D,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QAC/B,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACzE,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC;AAEF,MAAM,UAAU,qBAAqB,CACnC,MAAS,EACT,OAA4C,EAC5C,YAA8B,QAAQ;IAErC,MAA+B,CAAC,MAAM,GAAG;QACxC,OAAO;QACP,MAAM,EAAE,EAAE;KACX,CAAC;IAED,MAAc,CAAC,IAAI,GAAG,CAAC,GAAG,KAAsB,EAAE,EAAE;QACnD,IAAI,KAAK,KAAK,MAAM;YAClB,MAAM,SAAS,CACb,wCAAwC,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,WAAW,QAAQ,EAAE,CACxG,CAAC;QAEJ,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAC9C,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAE/C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACzD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;IAEF,OAAO,IAAI,KAAK,CAAC,MAAa,EAAE;QAC9B,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ;YACxB,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAa,CAAC;YAEvE,MAAM,WAAW,GAAG;gBAClB,KAAK;gBACL,MAAM;gBACN,KAAK;gBACL,OAAO;gBACP,QAAQ;gBACR,KAAK;gBACL,MAAM;gBACN,OAAO;gBACP,SAAS;aACD,CAAC;YAEX,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnB,OAAO,UACL,MAA4D,EAC5D,GAAG,QAAkC;oBAGrC,IAAI,OAAO,MAAM,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;wBAC1D,QAAQ,GAAG,CAAC,MAAgC,EAAE,GAAG,QAAQ,CAAC,CAAC;wBAC3D,MAAM,GAAG,EAAoB,CAAC;oBAChC,CAAC;yBAAM,IACL,CAAC,MAAM;wBACP,OAAO,MAAM,KAAK,QAAQ;wBAC1B,OAAO,MAAM,KAAK,QAAQ;wBAC1B,MAAM,YAAY,MAAM,EACxB,CAAC;wBACD,MAAM,SAAS,CACb,qBAAqB,SAAS,yFAAyF,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAChM,CAAC;oBACJ,CAAC;oBAED,IAAK,MAAyB,CAAC,QAAQ;wBAAE,OAAO;oBAEhD,MAAM,SAAS,GAAG,MAAwB,CAAC;oBAC3C,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;oBAEjE,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;oBACrC,MAAM,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC;oBAExD,IAAI,SAAS,CAAC,cAAc,IAAI,CAAC,oBAAoB,EAAE,IAAI;wBACzD,MAAM,SAAS,CACb,gCAAgC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,+DAA+D,oBAAoB,EAAE;;sFAElE,CACzE,CAAC;oBAEJ,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;oBAE/C,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,OAA+B,EAAE,EAAE;wBAC9D,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,UAAU;4BAC3C,MAAM,SAAS,CACb,oCAAoC,IAAI,cAAc,OAAO,GAAG,CACjE,CAAC;wBAEJ,OAAO,OAAO,IAAI,OAAO;4BACvB,CAAC,CAAC,OAAO;4BACT,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE;gCACpB,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ;6BAC9C,CAAC,CAAC;oBACP,CAAC,CAAC,CAAC;oBAEH,MAAM,eAAe,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;oBACtD,MAAM,WAAW,GAAG,CAAC,GAAG,eAAe,EAAE,GAAG,QAAQ,CAAC,CAAC;oBAEtD,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,CAAC;gBAC3D,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC;gBACrB,OAAO,UAAS,IAAgB;oBAC9B,MAAM,UAAU,GAAQ,EAAE,CAAC;oBAE3B,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC7B,UAAU,CAAC,MAAM,CAAC,GAAG,UACnB,MAA+D,EAC/D,GAAG,QAAkC;4BAErC,IAAI,OAAO,MAAM,KAAK,UAAU,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;gCACvD,MAAM,SAAS,CACb,qBAAqB,SAAS,WAAW,IAAI,MAAM,MAAM,+EAA+E,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAChN,CAAC;4BAEJ,MAAM,UAAU,GAAqB;gCACnC,GAAG,MAAM;gCACT,IAAI;6BACL,CAAC;4BAEF,QAAQ,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,GAAG,QAAQ,CAAC,CAAC;4BAC1C,OAAO,UAAyB,CAAC;wBACnC,CAAC,CAAC;oBACJ,CAAC,CAAC,CAAC;oBAEH,OAAO,UAAU,CAAC;gBACpB,CAAC,CAAC;YACJ,CAAC;YAED,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAW,CAAC,EAAE,CAAC;gBACtC,OAAO,UACL,MAAwB,EACxB,GAAG,QAAkC;oBAErC,IAAI,CAAC,MAAM,IAAI,CAAC,oBAAoB,CAAC,kBAAkB,CAAC,MAAM,CAAC;wBAC7D,MAAM,SAAS,CACb,qBAAqB,SAAS,IAAI,IAAc,4EAA4E,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CACpM,CAAC;oBAEJ,IAAI,MAAM,EAAE,QAAQ;wBAAE,OAAO;oBAE7B,MAAM,IAAI,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;oBAEvD,MAAM,GAAG;wBACP,GAAG,MAAM;wBACT,GAAG,CAAC,OAAO,EAAE,OAAO;4BAClB,CAAC,CAAC;gCACA,YAAY,EAAE;oCACZ,GAAG,MAAM,EAAE,YAAY;oCACvB,OAAO,EAAE,SAAS,CAChB,OAAO,CAAC,OAAO,IAAI,EAAE,EACrB,MAAM,EAAE,YAAY,EAAE,OAAO,IAAI,EAAE,CACpC;iCACF;6BACF;4BACD,CAAC,CAAC,EAAE,CAAC;wBACP,IAAI;qBACL,CAAC;oBAEF,MAAM,GAAG;wBACP,GAAG,MAAM;wBACT,GAAG,CAAC,OAAO,EAAE,OAAO;4BAClB,CAAC,CAAC;gCACA,YAAY,EAAE;oCACZ,GAAG,MAAM,EAAE,YAAY;oCACvB,GAAI,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO;wCAChC,CAAC,CAAC;4CACA,OAAO,EAAE,SAAS,CAChB,OAAO,CAAC,OAAO,EACf,MAAM,CAAC,YAAY,CAAC,OAAO,CAC5B;yCACF;wCACD,CAAC,CAAC,EAAE,CAAkB;iCACzB;6BACF;4BACD,CAAC,CAAC,EAAE,CAAC;wBACP,IAAI;qBACL,CAAC;oBAEF,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAW,CAAC;wBACzC,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;oBAEJ,MAAM,MAAM,GAAG,IAAc,CAAC;oBAC9B,MAAM,qBAAqB,GAAG,CAAC,OAAY,EAAE,EAAE,CAC7C,SAAS,CACP,oCAAoC,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,cAAc,OAAO,GAAG,CACzF,CAAC;oBAEJ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACxB,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC;wBAE/C,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,OAA+B,EAAE,EAAE;4BAC9D,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,UAAU;gCAC3C,MAAM,qBAAqB,CAAC,OAAO,CAAC,CAAC;4BAEvC,OAAO,UAAU,CAAC,OAAO,EAAE;gCACzB,IAAI,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ;6BAC9C,CAAC,CAAC;wBACL,CAAC,CAAC,CAAC;wBAEH,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;wBACnD,mBAAmB,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;wBAC1D,MAA+B,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;4BAClD,OAAO,EAAE,YAAY;4BACrB,MAAM;4BACN,MAAM;yBACP,CAAC,CAAC;oBACL,CAAC;oBAED,MAAM,WAAW,GAAG,cAAc,EAAE,CAAC;oBACrC,MAAM,gBAAgB,GAAG,WAAW,CAAC,UAAU,CAAC;oBAChD,MAAM,oBAAoB,GAAG,WAAW,CAAC,cAAc,CAAC;oBACxD,MAAM,gBAAgB,GAAG,gBAAgB,EAAE,MAAM,CAAC;oBAClD,MAAM,KAAK,GAAG,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;oBAEhD,IACE,gBAAgB;wBAChB,CAAC,CAAC,CAAC,YAAY,IAAI,MAAM,CAAC;4BACxB,CAAC,YAAY,IAAI,MAAM;gCACrB,CAAC,MAAM,CAAC,UAAU;gCAClB,MAAM,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC;wBAErC,MAAM,SAAS,CACb,yQAAyQ,CAC1Q,CAAC;oBAEJ,IACE,CAAC,gBAAgB,EAAE,QAAQ;wBAC3B,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;wBAE/C,MAAM,SAAS,CACb,wCAAwC,KAAK,qHAAqH,CACnK,CAAC;oBAEJ,IAAI,MAAM,CAAC,cAAc,IAAI,CAAC,oBAAoB,EAAE,IAAI;wBACtD,MAAM,SAAS,CACb,gCAAgC,KAAK,+DAA+D,oBAAoB,EAAE;;sFAElD,CACzE,CAAC;oBAEJ,QAAQ,GAAG,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,CAAC;oBAExD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;wBACvB,MAAM,SAAS,CACb,kCAAkC,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,GAAG,CAClE,CAAC;oBAEJ,IACE,MAAM,CAAC,YAAY,EAAE,OAAO;wBAC5B,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,KAAK;wBAEnD,QAAQ,CAAC,IAAI,CACX,UAAU,CACR,aAAa,CAAC,iBAAiB,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EAC5D,EAAE,IAAI,EAAE,OAAO,EAAE,CAClB,CACF,CAAC;oBAEJ,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC;gBACxD,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,cAAc,CAAC;QACxB,CAAC;KACF,CAAC,CAAC;AACL,CAAC","sourcesContent":["import { IRouter, RouterOptions } from \"express\";\nimport {\n  ArkosRouteConfig,\n  ArkosUseConfig,\n  IArkosRoute,\n  IArkosRouter,\n  InternalIArkosRouter,\n  PathParams,\n} from \"../../types\";\nimport RouteConfigValidator from \"../../route-config-validator\";\nimport { applyPrefix, getMiddlewareStack } from \".\";\nimport { getUserFileExtension } from \"../../../helpers/fs.helpers\";\nimport { getArkosConfig } from \"../../../../server\";\nimport RouteConfigRegistry from \"../../route-config-registry\";\nimport { catchAsync } from \"../../../../exports/error-handler\";\nimport deepmerge from \"../../../helpers/deepmerge.helper\";\nimport ExitError from \"../../../helpers/exit-error\";\nimport uploadManager from \"./upload-manager\";\nimport { ArkosAnyRequestHandler } from \"../../../../types\";\nimport { ArkosRouterOptions } from \"../..\";\nimport { UploadConfig } from \"../../types/upload-config\";\nimport { Arkos, ArkosLoadable } from \"../../../../types/arkos\";\nimport { Express } from \"express\";\nimport loadableRegistry from \"../../../../components/arkos-loadable-registry\";\nimport { state } from \"../../../../app\";\nimport { docsLink } from \"../../../../app\";\n\nconst flattenHandlers = (arr: any[]): ArkosAnyRequestHandler[] => {\n  return arr.reduce((flat, item) => {\n    return flat.concat(Array.isArray(item) ? flattenHandlers(item) : item);\n  }, []);\n};\n\nexport function applyArkosRouterProxy<T extends Express | IRouter>(\n  target: T,\n  options?: RouterOptions & ArkosRouterOptions,\n  component: \"app\" | \"router\" = \"router\"\n): T extends Express ? Arkos : IArkosRouter {\n  (target as InternalIArkosRouter)._arkos = {\n    options,\n    routes: [],\n  };\n\n  (target as any).load = (...items: ArkosLoadable[]) => {\n    if (state !== \"idle\")\n      throw ExitError(\n        `app.load() must be called before app.${state === \"listening\" ? \"listen\" : \"build\"}(), see ${docsLink}`\n      );\n\n    if (Array.isArray(items[0])) items = items[0];\n    items = Array.isArray(items) ? items : [items];\n\n    items.forEach((item) => loadableRegistry.register(item));\n    return target;\n  };\n\n  return new Proxy(target as any, {\n    get(target, prop, receiver) {\n      const originalMethod = Reflect.get(target, prop, receiver) as Function;\n\n      const httpMethods = [\n        \"get\",\n        \"post\",\n        \"put\",\n        \"patch\",\n        \"delete\",\n        \"all\",\n        \"head\",\n        \"trace\",\n        \"options\",\n      ] as const;\n\n      if (prop === \"use\") {\n        return function(\n          config: ArkosUseConfig | PathParams | ArkosAnyRequestHandler,\n          ...handlers: ArkosAnyRequestHandler[]\n        ) {\n          // normalize function/router to ArkosUseConfig\n          if (typeof config === \"function\" || Array.isArray(config)) {\n            handlers = [config as ArkosAnyRequestHandler, ...handlers];\n            config = {} as ArkosUseConfig;\n          } else if (\n            !config ||\n            typeof config !== \"object\" ||\n            typeof config === \"string\" ||\n            config instanceof RegExp\n          ) {\n            throw ExitError(\n              `First argument of ${component}.use() must be a valid ArkosRouteConfig object or a middleware function, but received ${typeof config === \"object\" ? JSON.stringify(config, null, 2) : config}.`\n            );\n          }\n\n          if ((config as ArkosUseConfig).disabled) return;\n\n          const useConfig = config as ArkosUseConfig;\n          const path = applyPrefix(options?.prefix, useConfig.path ?? \"/\");\n\n          const arkosConfig = getArkosConfig();\n          const authenticationConfig = arkosConfig.authentication;\n\n          if (useConfig.authentication && !authenticationConfig?.mode)\n            throw ExitError(\n              `Trying to authenticate route ${path ? `${path}` : \"\"} without choosing an authentication mode under arkos.config.${getUserFileExtension()}\n\nFor further help see https://www.arkosjs.com/docs/core-concepts/authentication/setup.`\n            );\n\n          const flatHandlers = flattenHandlers(handlers);\n\n          handlers = flatHandlers.map((handler: ArkosAnyRequestHandler) => {\n            if (!handler || typeof handler !== \"function\")\n              throw ExitError(\n                `Wrong value for handler in route ${path}, recevied ${handler}.`\n              );\n\n            return \"param\" in handler\n              ? handler\n              : catchAsync(handler, {\n                type: handler.length > 3 ? \"error\" : \"normal\",\n              });\n          });\n\n          const middlewareStack = getMiddlewareStack(useConfig);\n          const allHandlers = [...middlewareStack, ...handlers];\n\n          return originalMethod.call(target, path, ...allHandlers);\n        };\n      }\n\n      if (prop === \"route\") {\n        return function(path: PathParams) {\n          const routeChain: any = {};\n\n          httpMethods.forEach((method) => {\n            routeChain[method] = function(\n              config: ArkosAnyRequestHandler | Omit<ArkosRouteConfig, \"path\">,\n              ...handlers: ArkosAnyRequestHandler[]\n            ) {\n              if (typeof config === \"function\" || Array.isArray(config))\n                throw ExitError(\n                  `First argument of ${component}.route(\"${path}\").${method}() must be a valid ArkosRouteConfig object without path field, but received ${typeof config === \"object\" ? JSON.stringify(config, null, 2) : config}`\n                );\n\n              const fullConfig: ArkosRouteConfig = {\n                ...config,\n                path,\n              };\n\n              receiver[method](fullConfig, ...handlers);\n              return routeChain as IArkosRoute;\n            };\n          });\n\n          return routeChain;\n        };\n      }\n\n      if (httpMethods.includes(prop as any)) {\n        return function(\n          config: ArkosRouteConfig,\n          ...handlers: ArkosAnyRequestHandler[]\n        ) {\n          if (!config || !RouteConfigValidator.isArkosRouteConfig(config))\n            throw ExitError(\n              `First argument of ${component}.${prop as string}() must be a valid ArkosRouteConfig object with path field, but recevied ${typeof config === \"object\" ? JSON.stringify(config, null, 2) : config}`\n            );\n\n          if (config?.disabled) return;\n\n          const path = applyPrefix(options?.prefix, config.path);\n\n          config = {\n            ...config,\n            ...(options?.openapi\n              ? {\n                experimental: {\n                  ...config?.experimental,\n                  openapi: deepmerge(\n                    options.openapi || {},\n                    config?.experimental?.openapi || {}\n                  ),\n                },\n              }\n              : {}),\n            path,\n          };\n\n          config = {\n            ...config,\n            ...(options?.uploads\n              ? {\n                experimental: {\n                  ...config?.experimental,\n                  ...((config?.experimental?.uploads\n                    ? {\n                      uploads: deepmerge(\n                        options.uploads,\n                        config.experimental.uploads\n                      ),\n                    }\n                    : {}) as UploadConfig),\n                },\n              }\n              : {}),\n            path,\n          };\n\n          if ([null, undefined].includes(path as any))\n            throw new Error(\n              \"Please pass valid value for path field to use in your route\"\n            );\n\n          const method = prop as string;\n          const UndefinedHandlerError = (handler: any) =>\n            ExitError(\n              `Wrong value for handler in route ${method.toUpperCase()} ${path}, recevied ${handler}.`\n            );\n\n          if (handlers.length > 0) {\n            const flatHandlers = flattenHandlers(handlers);\n\n            handlers = flatHandlers.map((handler: ArkosAnyRequestHandler) => {\n              if (!handler || typeof handler !== \"function\")\n                throw UndefinedHandlerError(handler);\n\n              return catchAsync(handler, {\n                type: handler.length > 3 ? \"error\" : \"normal\",\n              });\n            });\n\n            const finalHandler = handlers[handlers.length - 1];\n            RouteConfigRegistry.register(finalHandler, config, method);\n            (target as InternalIArkosRouter)._arkos.routes.push({\n              handler: finalHandler,\n              config,\n              method,\n            });\n          }\n\n          const arkosConfig = getArkosConfig();\n          const validationConfig = arkosConfig.validation;\n          const authenticationConfig = arkosConfig.authentication;\n          const strictValidation = validationConfig?.strict;\n          const route = `${method.toUpperCase()} ${path}`;\n\n          if (\n            strictValidation &&\n            (!(\"validation\" in config) ||\n              (\"validation\" in config &&\n                !config.validation &&\n                config.validation !== undefined))\n          )\n            throw ExitError(\n              \"When using strict validation you must either pass { validation: false } in order to explicitly tell that no input will be received, or pass `undefined` for each input type e.g { validation: { query: undefined } } in order to deny the input of given request input.\"\n            );\n\n          if (\n            !validationConfig?.resolver &&\n            Object.keys(config.validation || {}).length > 0\n          )\n            throw ExitError(\n              `Trying to pass validators into route ${route} config validation option without choosing a validation resolver under arkos.init({ validation: { resolver: '' } })`\n            );\n\n          if (config.authentication && !authenticationConfig?.mode)\n            throw ExitError(\n              `Trying to authenticate route ${route} without choosing an authentication mode under arkos.config.${getUserFileExtension()}\n\nFor further help see https://www.arkosjs.com/docs/core-concepts/authentication/setup.`\n            );\n\n          handlers = [...getMiddlewareStack(config), ...handlers];\n\n          if (handlers.length === 0)\n            throw ExitError(\n              `No handlers provided for route ${method.toUpperCase()} ${path}.`\n            );\n\n          if (\n            config.experimental?.uploads &&\n            config.experimental.uploads.deleteOnError !== false\n          )\n            handlers.push(\n              catchAsync(\n                uploadManager.handleFileCleanup(config.experimental.uploads),\n                { type: \"error\" }\n              )\n            );\n\n          return originalMethod.call(target, path, ...handlers);\n        };\n      }\n\n      return originalMethod;\n    },\n  });\n}\n"]}

package/dist/esm/utils/arkos-router/utils/helpers/index.js

@@ -1,59 +1,112 @@
 import rateLimit from "express-rate-limit";
 import authService from "../../../../modules/auth/auth.service.js";
 import { validateRequestInputs } from "../../../../modules/base/base.middlewares.js";
-import RouteConfigRegistry from "../../route-config-registry.js";
 import express from "express";
 import compression from "compression";
 import { queryParser } from "../../../helpers/query-parser.helpers.js";
 import uploadManager from "./upload-manager.js";
 import multer from "multer";
 import { catchAsync } from "../../../../exports/error-handler/index.js";
-export function extractArkosRoutes(app, basePath = "") {
+import RouteConfigRegistry from "../../route-config-registry.js";
+export function extractArkosRoutes(app, basePath = "", inheritedRouteOptions) {
+    if (inheritedRouteOptions &&
+        Object.keys(inheritedRouteOptions).length === 0)
+        inheritedRouteOptions = undefined;
     const routes = [];
-    function extractFromStack(stack, prefix = "") {
-        stack.forEach((layer) => {
+    function extractFromStack(stack, prefix = "", inheritedRouteOptions) {
+        if (!stack || !Array.isArray(stack))
+            return;
+        for (const layer of stack) {
             if (layer.route) {
-                const fullPath = prefix + layer.route.path;
-                const methods = Object.keys(layer.route.methods);
-                methods.forEach((method) => {
+                const fullPath = joinPaths(prefix, layer.route.path);
+                const methods = Object.keys(layer.route.methods || {});
+                for (const method of methods) {
                     const handlers = layer.route.stack || [];
-                    let config;
+                    let routeConfig = null;
+                    let routeOptions = inheritedRouteOptions;
                     for (const handler of handlers) {
-                        const foundConfig = RouteConfigRegistry.get(handler.handle);
-                        if (foundConfig) {
-                            config = foundConfig;
+                        const registryConfig = RouteConfigRegistry.get(handler.handle);
+                        if (registryConfig) {
+                            routeConfig = registryConfig;
                             routes.push({
                                 path: fullPath,
                                 method: method.toUpperCase(),
-                                config,
+                                routeOptions,
+                                config: routeConfig || {
+                                    method: method.toUpperCase(),
+                                    path: layer.route.path,
+                                },
                             });
                             break;
                         }
+                        const arkosMeta = handler.handle?._arkos || handler._arkos;
+                        if (arkosMeta) {
+                            routeOptions = arkosMeta.options || routeOptions;
+                        }
                     }
-                });
+                }
             }
-            else if (layer.name === "router" && layer.handle?.stack) {
+            else if (layer.name === "router" ||
+                layer.name === "bound dispatch" ||
+                layer.handle?.stack) {
                 let nestedPrefix = prefix;
-                if (layer.regexp) {
-                    const match = layer.regexp
-                        .toString()
-                        .match(/\/\^?(\\\/[^?]+|\/[^?]+)/);
-                    if (match) {
-                        nestedPrefix = prefix + "/" + match[1].replace(/\\\//g, "/");
-                        nestedPrefix = nestedPrefix
-                            .replace(/\/\//g, "/")
-                            .replace(/\/$/, "");
-                    }
+                if (layer.path) {
+                    nestedPrefix = joinPaths(prefix, layer.path);
+                }
+                else if (layer.regexp) {
+                    const mountPath = extractLayerPath(layer);
+                    nestedPrefix = joinPaths(prefix, mountPath);
+                }
+                const routerStack = layer.handle?.stack || layer.handle?._router?.stack;
+                if (routerStack) {
+                    const currentOptions = layer.handle?._arkos?.options?.openapi
+                        ? layer.handle._arkos.options
+                        : inheritedRouteOptions;
+                    extractFromStack(routerStack, nestedPrefix, currentOptions);
                 }
-                extractFromStack(layer.handle.stack, nestedPrefix);
             }
-        });
+        }
     }
-    const stack = app._router?.stack || app.stack;
+    const stack = app._router?.stack || app.router?.stack || app.stack;
     if (stack)
-        extractFromStack(stack, basePath);
+        extractFromStack(stack, basePath, app._arkos?.options);
     return routes;
 }
+function joinPaths(prefix, path) {
+    if (!path)
+        return prefix || "";
+    if (!prefix) {
+        return path.startsWith("/") ? path : `/${path}`;
+    }
+    return `${prefix.replace(/\/$/, "")}/${path.replace(/^\//, "")}`.replace(/\/+/g, "/");
+}
+export function extractLayerPath(layer) {
+    if (layer.path && typeof layer.path === "string")
+        return layer.path;
+    if (layer.regexp) {
+        const source = layer.regexp.source;
+        if (source === "^\\/?(?=\\/|$)")
+            return "";
+        let cleaned = source
+            .replace(/^\^\\?\//, "/")
+            .replace(/^\^/, "")
+            .replace(/\\\/\?\(\?=\\\/\|\$\)/g, "")
+            .replace(/\(\?=\\\/\|\$\)/g, "")
+            .replace(/\\\//g, "/")
+            .replace(/\(\?:\\\/\?\)?/g, "")
+            .replace(/\(\?:\(\[\^\\\/\]\+\?\)\)/g, ":param")
+            .replace(/\/\?\$?$/, "")
+            .replace(/\$$/, "")
+            .replace(/\/+\/+/g, "/");
+        if (cleaned && !cleaned.startsWith("/"))
+            cleaned = "/" + cleaned;
+        if (cleaned.includes("?") || cleaned.includes("(") || cleaned.includes(")")) {
+            return typeof layer.path === "string" ? layer.path : "";
+        }
+        return cleaned;
+    }
+    return "";
+}
 export function getMiddlewareStack(config) {
     const middlewares = [];
     if (config.authentication)
@@ -61,7 +114,7 @@ export function getMiddlewareStack(config) {
     if (typeof config.authentication === "object" &&
         config.authentication.action &&
         config.authentication.resource)
-        middlewares.push(authService.handleAccessControl(config.authentication.action, config.authentication.resource, { [config.authentication.action]: config.authentication?.rule }));
+        middlewares.push(authService.authorize(config.authentication.action, config.authentication.resource, config.authentication?.rule));
     if (config.rateLimit)
         middlewares.push(rateLimit(config.rateLimit));
     if (config.compression)
@@ -96,6 +149,12 @@ export function extractPathParams(path) {
     const segments = path.split("/");
     for (const segment of segments) {
         if (segment.startsWith(":")) {
+            params.push(segment.substring(1).replace(/\(.*\)$/, ""));
+        }
+        if (segment.startsWith("{*") && segment.endsWith("}")) {
+            params.push(segment.slice(2, -1));
+        }
+        if (segment.startsWith("*")) {
             params.push(segment.substring(1));
         }
     }