arkos 1.3.1-beta → 1.3.2-beta

package/dist/cjs/types/arkos-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\n\n/**\n * Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n */\nexport type ArkosConfig = {\n  /**\n   * Allows to configure request configs\n   */\n  request?: {\n    /**\n     * Allows to configure request parameters\n     */\n    parameters?: {\n      /**\n       * Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n       *\n       * See more\n       */\n      allowDangerousPrismaQueryOptions?: boolean;\n    };\n  };\n  /** Message you would like to send, as Json and 200 response when\n   * ```curl\n   * GET /api\n   * ```\n   *\n   * ```json\n   * { \"message\": \"Welcome to YourAppName\" }\n   * ```\n   *\n   * default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n   *\n   *\n   *  */\n  welcomeMessage?: string;\n  /**\n   * Port where the application will run, can be set in 3 ways:\n   *\n   * 1. default is 8000\n   * 2. PORT under environment variables (Lower precedence)\n   * 3. this config option (Higher precedence)\n   */\n  port?: number | undefined;\n  /**\n   * Allows to listen on a different host than localhost only\n   */\n  host?: string;\n  /**\n   * Defines authentication related configurations, by default is undefined.\n   *\n   * See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n   */\n  authentication?: {\n    /**\n     * Defines whether to use Static or Dynamic Role-Based Acess Control\n     *\n     * Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n     */\n    mode: \"static\" | \"dynamic\";\n    /**\n     * Defines auth login related configurations to customize the api.\n     */\n    login?: {\n      /**\n       * Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n       *\n       * ```json\n       *  {\n       *    \"username\": \"johndoe\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       *\n       * **Note:** You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n       *\n       * ```curl\n       * POST /api/auth/login?usernameField=email\n       * ```\n       *\n       * See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n       *\n       * By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n       *\n       * **Example with email**\n       *\n       * ```json\n       *  {\n       *    \"email\": \"john.doe@example.com\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       */\n      allowedUsernames?: string[];\n      /** Defines wether to send the access token in response after login or only send as cookie, defeault is both.*/\n      sendAccessTokenThrough?: \"cookie-only\" | \"response-only\" | \"both\";\n    };\n    /**\n     * Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n     *\n     * **Important**: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n     *\n     * **Default**: ```/^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n     *\n     * **message**: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n     */\n    passwordValidation?: { regex: RegExp; message?: string };\n    /**\n     * Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n     * \n     * #### Default\n     *{\n        windowMs: 5000,\n        limit: 10,\n        standardHeaders: \"draft-7\",\n        legacyHeaders: false,\n      }\n     * \n     * Passing an object not overriding all the default options will only\n     * cause it to be deepmerged and not actually replace with empty fields\n     * \n     *@see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n     */\n    requestRateLimitOptions?: Partial<RateLimitOptions>;\n    /**\n     * JWT (JSON Web Token) authentication configuration.\n     *\n     * You can override these values directly in code, or use environment variables:\n     *\n     * - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n     * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n     * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n     * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n     * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n     *\n     * ⚠️ Values passed here take precedence over environment variables.\n     */\n    jwt?: {\n      /** Secret key used for signing and verifying JWT tokens */\n      secret?: string;\n      /**\n       * Duration after which the JWT token expires.\n       * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n       * Defaults to \"30d\" if not provided.\n       */\n      expiresIn?: MsDuration | number;\n\n      /**\n       * Configuration for the JWT cookie sent to the client\n       */\n      cookie?: {\n        /**\n         * Whether the cookie should be marked as secure (sent only over HTTPS).\n         * Defaults to `true` in production and `false` in development.\n         */\n        secure?: boolean;\n\n        /**\n         * Whether the cookie should be marked as HTTP-only.\n         * Default is `true` to prevent access via JavaScript.\n         */\n        httpOnly?: boolean;\n\n        /**\n         * Controls the SameSite attribute of the cookie.\n         * Defaults to \"none\" in production and \"lax\" in development.\n         * Options: \"lax\" | \"strict\" | \"none\"\n         */\n        sameSite?: \"lax\" | \"strict\" | \"none\";\n      };\n    };\n  };\n  /** Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n   *\n   *```ts\n   * // src/app.ts\n   * import arkos from 'arkos'\n   *\n   * arkos.init({\n   *    validation: {\n   *        resolver: \"zod\"\n   *    }\n   * })\n   * ```\n   *\n   * @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n   */\n  validation?:\n    | {\n        resolver?: \"class-validator\";\n        /**\n         * ValidatorOptions to used while validating request data.\n         *\n         * **Default**:\n         * ```ts\n         * {\n         *  whitelist: true\n         * }\n         * ```\n         */\n        validationOptions?: ValidatorOptions;\n      }\n    | {\n        resolver?: \"zod\";\n        validationOptions?: Record<string, any>;\n      };\n  /**\n   * Defines file upload configurations\n   *\n   * See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n   */\n  fileUpload?: {\n    /**\n     * Defiens the base file upload directory, default is set to /uploads (on root directory)\n     *\n     * When setting up a path dir always now that root directory will be the starting reference.\n     *\n     * #### Example\n     * passing `../my-arkos-uploaded-files`\n     *\n     * Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n     *\n     * NB: You must be aware of permissions on your server to acess files outside your project directory.\n     *\n     */\n    baseUploadDir?: string;\n    /**\n     * Changes the default `/api/uploads` base route for accessing file upload route.\n     *\n     * #### IMPORTANT\n     * Changing this will not affect the `baseUploadDir` folder. You can\n     * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n     *\n     */\n    baseRoute?: string;\n    /**\n     * Defines options for `express.static(somePath, someOptions)`\n     *\n     * #### Default:\n     *\n     * ```ts\n     *{\n          maxAge: \"1y\",\n          etag: true,\n          lastModified: true,\n          dotfiles: \"ignore\",\n          fallthrough: true,\n          index: false,\n          cacheControl: true,\n        }\n     * ```\n     * \n     * By passing your custom options have in mind that it\n     * will be deepmerged with the default.\n     * \n     * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n     * \n     */\n    expressStaticOptions?: Parameters<typeof express.static>[1];\n    /**\n     * Defines upload restrictions for each file type: image, video, document or other.\n     *\n     * #### Important:\n     * Passing an object without overriding everything will only cause it\n     * to be deepmerged with the default options.\n     *\n     * See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n     * ```\n     */\n    restrictions?: {\n      images?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      videos?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      documents?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      files?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n    };\n  };\n  /**\n   * Allows to specify the request rate limit for all endpoints.\n   * \n   * #### Default\n   *```ts\n   *{\n      windowMs: 60 * 1000,\n      limit: 1000,\n      standardHeaders: \"draft-7\",\n      legacyHeaders: false,\n    }\n    ```\n   * \n   * Passing an object not overriding all the default options will only\n   * cause it to be deepmerged and not actually replace with empty fields\n   * \n   * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n   */\n  globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n  /**\n   * Defines options for the built-in express.json() middleware\n   * Nothing is passed by default.\n   */\n  jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n  /**\n   * Allows to pass paremeters to cookieParser from npm package cookie-parser\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n   */\n  cookieParserParameters?: Parameters<typeof cookieParser>;\n  /**\n   * Allows to define options for npm package compression\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n   */\n  compressionOptions?: compression.CompressionOptions;\n  /**\n   * Options to define how query must be parsed.\n   *\n   * #### for 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   * 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  queryParserOptions?: QueryParserOptions;\n  /**\n   * Configuration for CORS (Cross-Origin Resource Sharing).\n   *\n   * @property {string | string[] | \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n   * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n   * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n   *\n   * @remarks\n   * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n   *\n   * See https://www.npmjs.com/package/cors\n   */\n  cors?: {\n    /**\n     * Defines allowed origins to acess the API.\n     */\n    allowedOrigins?: string | string[] | \"*\";\n    options?: cors.CorsOptions;\n    /**\n     * If you would like to override the entire middleware\n     *\n     * see\n     */\n    customHandler?: cors.CorsOptionsDelegate;\n  };\n  /**\n   * Defines express/arkos middlewares configurations\n   */\n  middlewares?: {\n    /**\n     * Allows to add an array of custom express middlewares into the default middleware stack.\n     *\n     * **Tip**: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n     *\n     * **Note**: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.RequestHandler[];\n    /**\n     * An array containing a list of defaults middlewares to be disabled\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     *\n     */\n    disable?: (\n      | \"compression\"\n      | \"global-rate-limit\"\n      | \"auth-rate-limit\"\n      | \"cors\"\n      | \"express-json\"\n      | \"cookie-parser\"\n      | \"query-parser\"\n      | \"request-logger\"\n      | \"global-error-handler\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in middlewares with your own implementation\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default compression middleware\n       */\n      compression?: express.RequestHandler;\n      /**\n       * Replace the default global rate limit middleware\n       */\n      globalRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default authentication rate limit middleware\n       */\n      authRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default CORS middleware\n       */\n      cors?: express.RequestHandler;\n      /**\n       * Replace the default JSON body parser middleware\n       */\n      expressJson?: express.RequestHandler;\n      /**\n       * Replace the default cookie parser middleware\n       */\n      cookieParser?: express.RequestHandler;\n      /**\n       * Replace the default query parser middleware\n       */\n      queryParser?: express.RequestHandler;\n      /**\n       * Replace the default request logger middleware\n       */\n      requestLogger?: express.RequestHandler;\n      /**\n       * Replace the default global error handler middleware\n       */\n      globalErrorHandler?: express.ErrorRequestHandler;\n    };\n  };\n  /**\n   * Defines express/arkos routers configurations\n   */\n  routers?: {\n    /**\n     * Strict mode configuration for routing security\n     *\n     * @default false\n     * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n     *\n     * When enabled:\n     * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n     *   in each model's router configuration\n     * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n     *   by default, while individual operations can be enabled per model\n     *\n     * This provides enhanced security by ensuring no routes are accidentally exposed.\n     * Use this in production environments to follow the principle of least privilege.\n     *\n     * See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n     */\n    strict?: boolean | \"no-bulk\";\n    /**\n     * Allows to add an array of custom express routers into the default middleware/router stack.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n     *\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.Router[];\n    disable?: (\n      | \"auth-router\"\n      | \"prisma-models-router\"\n      | \"file-upload\"\n      | \"welcome-endpoint\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in routers with your own implementation.\n     *\n     * **Note**: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n     *\n     * **Tip**: I you want to disable some prisma models specific endpoint\n     * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default authentication router\n       * @param config The original Arkos configuration\n       * @returns A router handling authentication endpoints\n       */\n      authRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default Prisma models router\n       * @param config The original Arkos configuration\n       * @returns A router handling Prisma model endpoints\n       */\n      prismaModelsRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default file upload router\n       * @param config The original Arkos configuration\n       * @returns A router handling file upload endpoints\n       */\n      fileUpload?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default welcome endpoint handler\n       * @param req Express request object\n       * @param res Express response object\n       * @param next Express next function\n       */\n      welcomeEndpoint?: express.RequestHandler;\n    };\n  };\n  /**\n   * Gives acess to the underlying express app so that you can add custom configurations beyong **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `app.listen` for you.\n   *\n   * If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n   *\n   * See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n   *\n   * @param {express.Express} app\n   * @returns {any}\n   */\n  configureApp?: (app: express.Express) => Promise<any> | any;\n  /**\n   * Gives access to the underlying HTTP server so that you can add custom configurations beyond **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `server.listen` for you.\n   *\n   * If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n   *\n   * See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n   *\n   * @param {http.Server} server - The HTTP server instance\n   * @returns {any}\n   */\n  configureServer?: (server: http.Server) => Promise<any> | any;\n  /**\n   * Allows to configure email configurations for sending emails through `emailService`\n   *\n   * See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n   */\n  email?: {\n    /**\n     * Your email provider url\n     */\n    host: string;\n    /**\n     * Email provider SMTP port, Default is `465`\n     */\n    port?: number;\n    /**\n     * If smtp connection must be secure, Default is `true`\n     */\n    secure?: boolean;\n    /**\n     * Used to authenticate in your smtp server\n     */\n    auth: {\n      /**\n       * Email used for auth as well as sending emails\n       */\n      user: string;\n      /**\n       * Your SMTP password\n       */\n      pass: string;\n    };\n    /**\n     * Email name to used like:\n     *\n     * John Doe\\<john.doe@gmail.com>\n     */\n    name?: string;\n  };\n  /**\n   * Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n   *\n   * **Important**: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n   *\n   * **Usage**\n   *\n   * ```ts\n   * // src/app.ts\n   *\n   * import arkos from \"arkos\"\n   *\n   *  arkos.init({\n   *    // other configs\n   *    swagger: {\n   *      mode: \"zod\",\n   *      options: {\n   *        defintion: {\n   *          info: {\n   *            openapi: \"3.0.0\",\n   *            title: \"API Generated By Arkos.js\",\n   *            description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n   *          }\n   *       }\n   *    }\n   *  }\n   * })\n   * ```\n   * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n   */\n  swagger?: {\n    /**\n     * By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n     * */\n    enableAfterBuild?: boolean;\n    /**\n     * Endpoint where the Swagger UI will be available.\n     *\n     * @default \"/api/api-docs\"\n     */\n    endpoint?: string;\n    /**\n     * Determines how your API schemas should be generated.\n     *\n     * - \"prisma\": Generates schemas based on Prisma models\n     * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n     * - \"zod\": Uses OpenAPI-compliant schemas directly\n     */\n    mode: \"prisma\" | \"class-validator\" | \"zod\";\n    /**\n     * Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n     * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n     *\n     * @default false\n     */\n    strict?: boolean;\n    /**\n     * Defines your swagger configurations\n     */\n    options?: {\n      /**\n       * Swagger definition according to OpenAPI Specification.\n       */\n      definition?: {\n        /**\n         * OpenAPI version.\n         *\n         * @default \"3.0.0\"\n         */\n        openapi?: string;\n\n        /**\n         * Information about your API.\n         */\n        info?: {\n          /**\n           * Title of the API documentation.\n           *\n           *\n           * @example \"My API\"\n           *\n           * @default \"API Generated By Arkos.js\"\n           */\n          title?: string;\n\n          /**\n           * Version of the API.\n           *\n           * @example \"1.0.0\"\n           */\n          version?: string;\n\n          /**\n           * Description of the API.\n           *\n           * @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n           */\n          description?: string;\n        };\n\n        /**\n         * Server configurations for the API.\n         *\n         * @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n         *\n         * This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n         */\n        servers?: {\n          /**\n           * Base URL of the server.\n           *\n           * @example \"http://localhost:8000\"\n           */\n          url: string;\n\n          /**\n           * Human-readable description of the server.\n           *\n           * @example \"Development Server\"\n           */\n          description?: string;\n        }[];\n        /**\n         * Allows adding more paths for your OpenAPI documentation\n         *\n         * */\n        paths?: OpenAPIV3.PathsObject;\n        /**\n         * (Optional) Additional metadata such as terms of service, contact, or license.\n         *\n         * See: https://swagger.io/specification/#infoObject\n         */\n        termsOfService?: string;\n        contact?: {\n          name?: string;\n          url?: string;\n          email?: string;\n        };\n        license?: {\n          name: string;\n          url?: string;\n        };\n\n        /**\n         * Tags to group and describe endpoints.\n         */\n        tags?: {\n          name: string;\n          description?: string;\n        }[];\n\n        /**\n         * Security definitions (e.g., Bearer Auth).\n         */\n        components?: {\n          securitySchemes?: Record<string, any>;\n          schemas?: Record<string, any>;\n        };\n\n        /**\n         * Global security requirements.\n         */\n        security?: Array<Record<string, string[]>>;\n      };\n\n      /**\n       * Glob patterns defining where Swagger should look for API route definitions and comments.\n       *\n       * @default \n       * ```ts\n       *  [\"./src/routers/*.router.{ts,js}\", \"./src/modules/**\\/*.router.{ts,js}\"]\n        ```\n       *\n       * Adjust depending on TypeScript or JavaScript usage.\n       */\n      apis?: string[];\n\n      /**\n       * Enables deep linking in the Swagger UI.\n       *\n       * @default true\n       */\n      deepLinking?: boolean;\n\n      /**\n       * Enable/disable the \"Try it out\" button globally.\n       *\n       * @default true\n       */\n      tryItOutEnabled?: boolean;\n\n      /**\n       * Whether to persist authorization data across page reloads.\n       *\n       * @default false\n       */\n      persistAuthorization?: boolean;\n    };\n    /**\n     * Custom `@scalar/express-api-reference` package options.\n     *\n     * @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n     */\n    scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n  };\n};\n"]}
+{"version":3,"file":"arkos-config.js","sourceRoot":"","sources":["../../../src/types/arkos-config.ts"],"names":[],"mappings":"","sourcesContent":["import http from \"http\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport { Options as RateLimitOptions } from \"express-rate-limit\";\nimport cookieParser from \"cookie-parser\";\nimport compression from \"compression\";\nimport { Options as QueryParserOptions } from \"../utils/helpers/query-parser.helpers\";\nimport { ValidatorOptions } from \"class-validator\";\nimport { MsDuration } from \"../modules/auth/utils/helpers/auth.controller.helpers\";\nimport { OpenAPIV3 } from \"openapi-types\";\nimport type { ApiReferenceConfiguration } from \"@scalar/express-api-reference\" with { \"resolution-mode\": \"import\" };\nimport nodemailer from \"nodemailer\";\n/**\n * Defines the initial configs of the api to be loaded at startup when arkos.init() is called.\n */\nexport type ArkosConfig = {\n  /**\n   * Allows to configure request configs\n   */\n  request?: {\n    /**\n     * Allows to configure request parameters\n     */\n    parameters?: {\n      /**\n       * Toggles allowing `VERY DANGEROUS` request paramateres under `req.query` for passing prisma query options.\n       *\n       * See more\n       */\n      allowDangerousPrismaQueryOptions?: boolean;\n    };\n  };\n  /** Message you would like to send, as Json and 200 response when\n   * ```curl\n   * GET /api\n   * ```\n   *\n   * ```json\n   * { \"message\": \"Welcome to YourAppName\" }\n   * ```\n   *\n   * default message is: Welcome to our Rest API generated by Arkos, find more about Arkos at www.arkosjs.com.\n   *\n   *\n   *  */\n  welcomeMessage?: string;\n  /**\n   * Port where the application will run, can be set in 3 ways:\n   *\n   * 1. default is 8000\n   * 2. PORT under environment variables (Lower precedence)\n   * 3. this config option (Higher precedence)\n   */\n  port?: number | undefined;\n  /**\n   * Allows to listen on a different host than localhost only\n   */\n  host?: string;\n  /**\n   * Defines authentication related configurations, by default is undefined.\n   *\n   * See [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for details.\n   */\n  authentication?: {\n    /**\n     * Defines whether to use Static or Dynamic Role-Based Acess Control\n     *\n     * Visit [www.arkosjs.com/docs/core-concepts/authentication-system](https://www.arkosjs.com/docs/core-concepts/authentication-system) for more details.\n     */\n    mode: \"static\" | \"dynamic\";\n    /**\n     * Defines auth login related configurations to customize the api.\n     */\n    login?: {\n      /**\n       * Defines the field that will be used as username by the built-in auth system, by default arkos will look for the field \"username\" in your model User, hence when making login for example you must send:\n       *\n       * ```json\n       *  {\n       *    \"username\": \"johndoe\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       *\n       * **Note:** You can also modify the usernameField on the fly by passing it to the request query parameters. example:\n       *\n       * ```curl\n       * POST /api/auth/login?usernameField=email\n       * ```\n       *\n       * See more at [www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds](https://www.arkosjs.com/docs/core-concepts/authentication-system#login-with-different-fileds)\n       *\n       * By specifing here another field for username, for example passing \"email\", \"companyCode\" or something else your json will be like:\n       *\n       * **Example with email**\n       *\n       * ```json\n       *  {\n       *    \"email\": \"john.doe@example.com\",\n       *    \"password\": \"somePassword123\"\n       *  }\n       * ```\n       */\n      allowedUsernames?: string[];\n      /** Defines wether to send the access token in response after login or only send as cookie, defeault is both.*/\n      sendAccessTokenThrough?: \"cookie-only\" | \"response-only\" | \"both\";\n    };\n    /**\n     * Specifies the regex pattern used by the authentication system to enforce password strength requirements.\n     *\n     * **Important**: If using validation libraries like Zod or class-validator, this will be completely overwritten.\n     *\n     * **Default**: ```/^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).+$/``` - Ensures the password contains at least one uppercase letter, one lowercase letter, and one numeric digit.\n     *\n     * **message**: (Optional) A custom error message to display when the password does not meet the required strength criteria.\n     */\n    passwordValidation?: { regex: RegExp; message?: string };\n    /**\n     * Allows to specify the request rate limit for all authentication endpoints but `/api/users/me`.\n     * \n     * #### Default\n     *{\n        windowMs: 5000,\n        limit: 10,\n        standardHeaders: \"draft-7\",\n        legacyHeaders: false,\n      }\n     * \n     * Passing an object not overriding all the default options will only\n     * cause it to be deepmerged and not actually replace with empty fields\n     * \n     *@see This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n     */\n    requestRateLimitOptions?: Partial<RateLimitOptions>;\n    /**\n     * JWT (JSON Web Token) authentication configuration.\n     *\n     * You can override these values directly in code, or use environment variables:\n     *\n     * - `JWT_SECRET`: Secret used to sign and verify JWT tokens.\n     * - `JWT_EXPIRES_IN`: Duration string or number indicating when the token should expire (e.g. \"30d\", 3600).\n     * - `JWT_COOKIE_SECURE`: Whether the cookie is sent only over HTTPS. Default: `true` in production.\n     * - `JWT_COOKIE_HTTP_ONLY`: Whether the cookie is HTTP-only. Default: `true`.\n     * - `JWT_COOKIE_SAME_SITE`: Can be \"lax\", \"strict\", or \"none\". Defaults to \"lax\" in dev, \"none\" in prod.\n     *\n     * ⚠️ Values passed here take precedence over environment variables.\n     */\n    jwt?: {\n      /** Secret key used for signing and verifying JWT tokens */\n      secret?: string;\n      /**\n       * Duration after which the JWT token expires.\n       * Accepts either a duration string (e.g. \"30d\", \"1h\") or a number in milliseconds.\n       * Defaults to \"30d\" if not provided.\n       */\n      expiresIn?: MsDuration | number;\n\n      /**\n       * Configuration for the JWT cookie sent to the client\n       */\n      cookie?: {\n        /**\n         * Whether the cookie should be marked as secure (sent only over HTTPS).\n         * Defaults to `true` in production and `false` in development.\n         */\n        secure?: boolean;\n\n        /**\n         * Whether the cookie should be marked as HTTP-only.\n         * Default is `true` to prevent access via JavaScript.\n         */\n        httpOnly?: boolean;\n\n        /**\n         * Controls the SameSite attribute of the cookie.\n         * Defaults to \"none\" in production and \"lax\" in development.\n         * Options: \"lax\" | \"strict\" | \"none\"\n         */\n        sameSite?: \"lax\" | \"strict\" | \"none\";\n      };\n    };\n  };\n  /** Allows to customize and toggle the built-in validation, by default it is set to `false`. If true is passed it will use validation with the default resolver set to `class-validator` if you intend to change the resolver to `zod` do the following:\n   *\n   *```ts\n   * // src/app.ts\n   * import arkos from 'arkos'\n   *\n   * arkos.init({\n   *    validation: {\n   *        resolver: \"zod\"\n   *    }\n   * })\n   * ```\n   *\n   * @See [www.arkosjs.com/docs/core-concepts/request-data-validation](https://www.arkosjs.com/docs/core-concepts/request-data-validation) for more details.\n   */\n  validation?:\n    | {\n        resolver?: \"class-validator\";\n        /**\n         * ValidatorOptions to used while validating request data.\n         *\n         * **Default**:\n         * ```ts\n         * {\n         *  whitelist: true\n         * }\n         * ```\n         */\n        validationOptions?: ValidatorOptions;\n      }\n    | {\n        resolver?: \"zod\";\n        validationOptions?: Record<string, any>;\n      };\n  /**\n   * Defines file upload configurations\n   *\n   * See [www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations](https://www.arkosjs.com/docs/core-concepts/file-upload#costum-configurations)\n   */\n  fileUpload?: {\n    /**\n     * Defiens the base file upload directory, default is set to /uploads (on root directory)\n     *\n     * When setting up a path dir always now that root directory will be the starting reference.\n     *\n     * #### Example\n     * passing `../my-arkos-uploaded-files`\n     *\n     * Will save uploaded files one level outside the root dir inside `my-arkos-uploaded-files`\n     *\n     * NB: You must be aware of permissions on your server to acess files outside your project directory.\n     *\n     */\n    baseUploadDir?: string;\n    /**\n     * Changes the default `/api/uploads` base route for accessing file upload route.\n     *\n     * #### IMPORTANT\n     * Changing this will not affect the `baseUploadDir` folder. You can\n     * pass here `/api/files/my-user-files` and `baseUploadDir` be `/uploaded-files`.\n     *\n     */\n    baseRoute?: string;\n    /**\n     * Defines options for `express.static(somePath, someOptions)`\n     *\n     * #### Default:\n     *\n     * ```ts\n     *{\n          maxAge: \"1y\",\n          etag: true,\n          lastModified: true,\n          dotfiles: \"ignore\",\n          fallthrough: true,\n          index: false,\n          cacheControl: true,\n        }\n     * ```\n     * \n     * By passing your custom options have in mind that it\n     * will be deepmerged with the default.\n     * \n     * Visit [https://expressjs.com/en/4x/api.html#express.static](https://expressjs.com/en/4x/api.html#express.static) for more understanding.\n     * \n     */\n    expressStaticOptions?: Parameters<typeof express.static>[1];\n    /**\n     * Defines upload restrictions for each file type: image, video, document or other.\n     *\n     * #### Important:\n     * Passing an object without overriding everything will only cause it\n     * to be deepmerged with the default options.\n     *\n     * See [www.arkosjs.com/docs/api-reference/default-supported-upload-files](https://www.arkosjs.com/docs/api-reference/default-supported-upload-files) for detailed explanation about default values.\n     * ```\n     */\n    restrictions?: {\n      images?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      videos?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      documents?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n      files?: {\n        maxCount?: number;\n        maxSize?: number;\n        supportedFilesRegex?: RegExp;\n      };\n    };\n  };\n  /**\n   * Allows to specify the request rate limit for all endpoints.\n   * \n   * #### Default\n   *```ts\n   *{\n      windowMs: 60 * 1000,\n      limit: 1000,\n      standardHeaders: \"draft-7\",\n      legacyHeaders: false,\n    }\n    ```\n   * \n   * Passing an object not overriding all the default options will only\n   * cause it to be deepmerged and not actually replace with empty fields\n   * \n   * This is are the options used on the `express-rate-limit` npm package used on epxress. read more about [https://www.npmjs.com/package/express-rate-limit](https://www.npmjs.com/package/express-rate-limit)\n   */\n  globalRequestRateLimitOptions?: Partial<RateLimitOptions>;\n  /**\n   * Defines options for the built-in express.json() middleware\n   * Nothing is passed by default.\n   */\n  jsonBodyParserOptions?: Parameters<typeof express.json>[0];\n  /**\n   * Allows to pass paremeters to cookieParser from npm package cookie-parser\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/cookie-parser](https://www.npmjs.com/package/cookie-parser) for further details.\n   */\n  cookieParserParameters?: Parameters<typeof cookieParser>;\n  /**\n   * Allows to define options for npm package compression\n   * Nothing is passed by default.\n   *\n   * See [www.npmjs.com/package/compression](https://www.npmjs.com/package/compression) for further details.\n   */\n  compressionOptions?: compression.CompressionOptions;\n  /**\n   * Options to define how query must be parsed.\n   *\n   * #### for 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   * 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  queryParserOptions?: QueryParserOptions;\n  /**\n   * Configuration for CORS (Cross-Origin Resource Sharing).\n   *\n   * @property {string | string[] | \"all\"} [allowedOrigins] - List of allowed origins. If set to `\"all\"`, all origins are accepted.\n   * @property {import('cors').CorsOptions} [options] - Additional CORS options passed directly to the `cors` middleware.\n   * @property {import('cors').CorsOptionsDelegate} [customMiddleware] - A custom middleware function that overrides the default behavior.\n   *\n   * @remarks\n   * If `customMiddleware` is provided, both `allowedOrigins` and `options` will be ignored in favor of the custom logic.\n   *\n   * See https://www.npmjs.com/package/cors\n   */\n  cors?: {\n    /**\n     * Defines allowed origins to acess the API.\n     */\n    allowedOrigins?: string | string[] | \"*\";\n    options?: cors.CorsOptions;\n    /**\n     * If you would like to override the entire middleware\n     *\n     * see\n     */\n    customHandler?: cors.CorsOptionsDelegate;\n  };\n  /**\n   * Defines express/arkos middlewares configurations\n   */\n  middlewares?: {\n    /**\n     * Allows to add an array of custom express middlewares into the default middleware stack.\n     *\n     * **Tip**: If you would like to acess the express app before everthing use `configureApp` and pass a function.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order](https://www.arkosjs.com/docs/advanced-guide/replace-or-disable-built-in-middlewares#middleware-execution-order)\n     *\n     * **Note**: If you want to use custom global error handler middleware use `middlewares.replace.globalErrorHandler`.\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.RequestHandler[];\n    /**\n     * An array containing a list of defaults middlewares to be disabled\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     *\n     */\n    disable?: (\n      | \"compression\"\n      | \"global-rate-limit\"\n      | \"auth-rate-limit\"\n      | \"cors\"\n      | \"express-json\"\n      | \"cookie-parser\"\n      | \"query-parser\"\n      | \"request-logger\"\n      | \"global-error-handler\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in middlewares with your own implementation\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default compression middleware\n       */\n      compression?: express.RequestHandler;\n      /**\n       * Replace the default global rate limit middleware\n       */\n      globalRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default authentication rate limit middleware\n       */\n      authRateLimit?: express.RequestHandler;\n      /**\n       * Replace the default CORS middleware\n       */\n      cors?: express.RequestHandler;\n      /**\n       * Replace the default JSON body parser middleware\n       */\n      expressJson?: express.RequestHandler;\n      /**\n       * Replace the default cookie parser middleware\n       */\n      cookieParser?: express.RequestHandler;\n      /**\n       * Replace the default query parser middleware\n       */\n      queryParser?: express.RequestHandler;\n      /**\n       * Replace the default request logger middleware\n       */\n      requestLogger?: express.RequestHandler;\n      /**\n       * Replace the default global error handler middleware\n       */\n      globalErrorHandler?: express.ErrorRequestHandler;\n    };\n  };\n  /**\n   * Defines express/arkos routers configurations\n   */\n  routers?: {\n    /**\n     * Strict mode configuration for routing security\n     *\n     * @default false\n     * - all CRUD + Auth (if using auth) endpoits are enabled and avialable by default.\n     *\n     * When enabled:\n     * - If `true`: All CRUD endpoints start disabled and must be explicitly enabled\n     *   in each model's router configuration\n     * - If `'no-bulk'`: Bulk operations (createMany, updateMany, deleteMany) are disabled\n     *   by default, while individual operations can be enabled per model\n     *\n     * This provides enhanced security by ensuring no routes are accidentally exposed.\n     * Use this in production environments to follow the principle of least privilege.\n     *\n     * See documentation: https://www.arkosjs.com/docs/guide/security#strict-mode\n     */\n    strict?: boolean | \"no-bulk\";\n    /**\n     * Allows to add an array of custom express routers into the default middleware/router stack.\n     *\n     * **Where will these be placed?**: see [www.arkosjs.com/docs/advanced-guide/adding-custom-routers](https://www.arkosjs.com/docs/advanced-guide/adding-custom-routers)\n     *\n     *\n     * Read more about The Arkos Middleware Stack at [www.arkosjs.com/docs/the-middleware-stack](https://www.arkosjs.com/docs/the-middleware-stack) for in-depth details.\n     */\n    additional?: express.Router[];\n    disable?: (\n      | \"auth-router\"\n      | \"prisma-models-router\"\n      | \"file-upload\"\n      | \"welcome-endpoint\"\n    )[];\n    /**\n     * Allows you to replace each of the built-in routers with your own implementation.\n     *\n     * **Note**: Doing this you will lose all default middleware chaining, auth control, handlers from the specific router.\n     *\n     * **Tip**: I you want to disable some prisma models specific endpoint\n     * see [www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints](https://www.arkosjs.com/docs/guide/adding-custom-routers#disabling-auto-generated-endpoints)\n     *\n     * **Caution**: Be careful with this because you may endup breaking your entire application.\n     */\n    replace?: {\n      /**\n       * Replace the default authentication router\n       * @param config The original Arkos configuration\n       * @returns A router handling authentication endpoints\n       */\n      authRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default Prisma models router\n       * @param config The original Arkos configuration\n       * @returns A router handling Prisma model endpoints\n       */\n      prismaModelsRouter?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default file upload router\n       * @param config The original Arkos configuration\n       * @returns A router handling file upload endpoints\n       */\n      fileUpload?: (\n        config: ArkosConfig\n      ) => express.Router | Promise<express.Router>;\n      /**\n       * Replace the default welcome endpoint handler\n       * @param req Express request object\n       * @param res Express response object\n       * @param next Express next function\n       */\n      welcomeEndpoint?: express.RequestHandler;\n    };\n  };\n  /**\n   * Gives acess to the underlying express app so that you can add custom configurations beyong **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `app.listen` for you.\n   *\n   * If you want to call `app.listen` by yourself pass port as `undefined` and then use the return app from `arkos.init()`.\n   *\n   * See how to call `app.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself](https://www.arkosjs.com/docs/guide/accessing-the-express-app#calling-applisten-by-yourself)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app](https://www.arkosjs.com/docs/guide/accessing-the-express-app) for further details on the method configureApp.\n   *\n   * @param {express.Express} app\n   * @returns {any}\n   */\n  configureApp?: (app: express.Express) => Promise<any> | any;\n  /**\n   * Gives access to the underlying HTTP server so that you can add custom configurations beyond **Arkos** customization capabilities\n   *\n   * **Note**: In the end **Arkos** will call `server.listen` for you.\n   *\n   * If you want to call `server.listen` by yourself pass port as `undefined` and then use the return server from `arkos.init()`.\n   *\n   * See how to call `server.listen` correctly [www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#creating-your-own-http-server)\n   *\n   * See [www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server](https://www.arkosjs.com/docs/guide/accessing-the-express-app#accessing-the-http-server) for further details on the method configureServer.\n   *\n   * @param {http.Server} server - The HTTP server instance\n   * @returns {any}\n   */\n  configureServer?: (server: http.Server) => Promise<any> | any;\n  /**\n   * Allows to configure email configurations for sending emails through `emailService`\n   *\n   * See [www.arkosjs.com/docs/core-concepts/sending-emails](https://www.arkosjs.com/docs/core-concepts/sending-emails)\n   */\n  email?: {\n    /**\n     * Email name to used like:\n     *\n     * John Doe\\<john.doe@gmail.com>\n     */\n    name?: string;\n    /**\n     * Your email provider url\n     */\n    host: string;\n    /**\n     * Email provider SMTP port, Default is `465`\n     */\n    port?: number;\n    /**\n     * If smtp connection must be secure, Default is `true`\n     */\n    secure?: boolean;\n    /**\n     * Used to authenticate in your smtp server\n     */\n    auth: {\n      /**\n       * Email used for auth as well as sending emails\n       */\n      user: string;\n      /**\n       * Your SMTP password\n       */\n      pass: string;\n    };\n  } & Parameters<typeof nodemailer.createTransport>[0];\n  /**\n   * Defines Swagger and OpenApi specifications for auto generating swagger documentation UI using whether it is Prisma Schemas, Class-validator DTOs, Zod Schemas or JSON-Schemas.\n   *\n   * **Important**: Is worth mentioning that this works alongside `@scalar/express-api-reference` npm package, you define it's ApiReferenceConfiguration under ``. also consider checking the package documentation at []\n   *\n   * **Usage**\n   *\n   * ```ts\n   * // src/app.ts\n   *\n   * import arkos from \"arkos\"\n   *\n   *  arkos.init({\n   *    // other configs\n   *    swagger: {\n   *      mode: \"zod\",\n   *      options: {\n   *        defintion: {\n   *          info: {\n   *            openapi: \"3.0.0\",\n   *            title: \"API Generated By Arkos.js\",\n   *            description: \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n   *          }\n   *       }\n   *    }\n   *  }\n   * })\n   * ```\n   * @see {@link https://www.arkosjs.com/docs/core-concepts/swagger-api-documentation}\n   */\n  swagger?: {\n    /**\n     * By default Arkos will disable API Documentation when the project is built `npm run build`, it does not matter what node environment is set. If you want to use it even after the `arkos build` command just set this to `true`.\n     * */\n    enableAfterBuild?: boolean;\n    /**\n     * Endpoint where the Swagger UI will be available.\n     *\n     * @default \"/api/api-docs\"\n     */\n    endpoint?: string;\n    /**\n     * Determines how your API schemas should be generated.\n     *\n     * - \"prisma\": Generates schemas based on Prisma models\n     * - \"class-validator\": Uses class-validator and class-transformer DTO classes\n     * - \"zod\": Uses OpenAPI-compliant schemas directly\n     */\n    mode: \"prisma\" | \"class-validator\" | \"zod\";\n    /**\n     * Allows `Arkos.js` to fallback to prisma schema and use them as json schema for defining request body and response data\n     * when a given zod Schema or class-validator Class is not found to be transformed to json schema.\n     *\n     * @default false\n     */\n    strict?: boolean;\n    /**\n     * Defines your swagger configurations\n     */\n    options?: {\n      /**\n       * Swagger definition according to OpenAPI Specification.\n       */\n      definition?: {\n        /**\n         * OpenAPI version.\n         *\n         * @default \"3.0.0\"\n         */\n        openapi?: string;\n\n        /**\n         * Information about your API.\n         */\n        info?: {\n          /**\n           * Title of the API documentation.\n           *\n           *\n           * @example \"My API\"\n           *\n           * @default \"API Generated By Arkos.js\"\n           */\n          title?: string;\n\n          /**\n           * Version of the API.\n           *\n           * @example \"1.0.0\"\n           */\n          version?: string;\n\n          /**\n           * Description of the API.\n           *\n           * @default \"This API was automatically generated by Arkos.js read more about at www.arkosjs.com\"\n           */\n          description?: string;\n        };\n\n        /**\n         * Server configurations for the API.\n         *\n         * @default [{ url: \"http://localhost:8000\", description: \"Development server\" }]\n         *\n         * This can be overridden automatically by Arkos based on CLI, .env, or `arkos.init()`.\n         */\n        servers?: {\n          /**\n           * Base URL of the server.\n           *\n           * @example \"http://localhost:8000\"\n           */\n          url: string;\n\n          /**\n           * Human-readable description of the server.\n           *\n           * @example \"Development Server\"\n           */\n          description?: string;\n        }[];\n        /**\n         * Allows adding more paths for your OpenAPI documentation\n         *\n         * */\n        paths?: OpenAPIV3.PathsObject;\n        /**\n         * (Optional) Additional metadata such as terms of service, contact, or license.\n         *\n         * See: https://swagger.io/specification/#infoObject\n         */\n        termsOfService?: string;\n        contact?: {\n          name?: string;\n          url?: string;\n          email?: string;\n        };\n        license?: {\n          name: string;\n          url?: string;\n        };\n\n        /**\n         * Tags to group and describe endpoints.\n         */\n        tags?: {\n          name: string;\n          description?: string;\n        }[];\n\n        /**\n         * Security definitions (e.g., Bearer Auth).\n         */\n        components?: {\n          securitySchemes?: Record<string, any>;\n          schemas?: Record<string, any>;\n        };\n\n        /**\n         * Global security requirements.\n         */\n        security?: Array<Record<string, string[]>>;\n      };\n\n      /**\n       * Glob patterns defining where Swagger should look for API route definitions and comments.\n       *\n       * @default \n       * ```ts\n       *  [\"./src/routers/*.router.{ts,js}\", \"./src/modules/**\\/*.router.{ts,js}\"]\n        ```\n       *\n       * Adjust depending on TypeScript or JavaScript usage.\n       */\n      apis?: string[];\n\n      /**\n       * Enables deep linking in the Swagger UI.\n       *\n       * @default true\n       */\n      deepLinking?: boolean;\n\n      /**\n       * Enable/disable the \"Try it out\" button globally.\n       *\n       * @default true\n       */\n      tryItOutEnabled?: boolean;\n\n      /**\n       * Whether to persist authorization data across page reloads.\n       *\n       * @default false\n       */\n      persistAuthorization?: boolean;\n    };\n    /**\n     * Custom `@scalar/express-api-reference` package options.\n     *\n     * @see {@link https://guides.scalar.com/scalar/scalar-api-references/integrations/express}\n     */\n    scalarApiReferenceConfiguration?: Partial<ApiReferenceConfiguration>;\n  };\n};\n"]}

package/dist/cjs/types/auth.js

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

package/dist/cjs/types/index.js

@@ -1 +1,11 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.AuthPermissionAction=void 0;var AuthPermissionAction;(function(e){e.Create="Create",e.View="View",e.Update="Update",e.Delete="Delete"})(AuthPermissionAction||(exports.AuthPermissionAction=AuthPermissionAction={}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthPermissionAction = void 0;
+var AuthPermissionAction;
+(function (AuthPermissionAction) {
+    AuthPermissionAction["Create"] = "Create";
+    AuthPermissionAction["View"] = "View";
+    AuthPermissionAction["Update"] = "Update";
+    AuthPermissionAction["Delete"] = "Delete";
+})(AuthPermissionAction || (exports.AuthPermissionAction = AuthPermissionAction = {}));
+//# sourceMappingURL=index.js.map

package/dist/cjs/types/router-config.js

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

package/dist/cjs/utils/arkos-env.js

@@ -1 +1,9 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0});const arkosEnv={JWT_SECRET:"13a9279eedb286f756212511267152e9585055809ec0606ea9f7eb98a87660c1616fbd39c44d4238a82f29df90b529e24bfdf72a480d1149d79c991c863a22b5ae0fb3ae6f5323bfd6664faef99792637477c38da488e7aa0d39b83ba99aba8e8a20efde7fd5c7ba21a6c938e17a9f99f73226dc61e89cd63f159257841194323f100d1a49b88ce4fdcdf2b066a5f32f88ee12f6487b55b4b5687d7c0caffdd8524e2adc4b941cf52e948f5b330f527eb1354341c876eed12dfa92cef3c341d030d05e6beb1e0a7f6d3e08e7b1aac045130457fd3a53ee469fecdd20fdd2c7a6a72b07cbcb1157c5b1cc581e6767bea32be8e125016a48951e85c7bdb961d9c9fab28444499ce063664fe0bd1a05d60294323bdd69af6d6ff1a2533dac8d4a869f76dbc746ee12f144e0af41029f620471817843140c23d036e731f3ebee21a70ff1549e97486fdf9cbef132ff2ced59fde9be35dd04b358c9a25ec4fd9cc0e36dae651e626d8c13b0c6d2a21f237517a05059680173e71817597062c792ea9c66030ca0d8ed82987e29189947692a0be5fffac4c988ca33f14ce96349661ef850dbff6909c7797676c90a5e47655346f59759482ef8a3a948e97e30f889bd4571610fd19e8ea4818651d37f6529cf32f0fc805bc053e911f0fe96f52b4420d54bd1f40739a95f5853b036c86ab9a51bed57fa9bd48607b5302e88db00900adf",JWT_EXPIRES_IN:"30d",PRISMA_SCHEMA_PATH:"./prisma/schema"};exports.default=arkosEnv;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const arkosEnv = {
+    JWT_SECRET: "13a9279eedb286f756212511267152e9585055809ec0606ea9f7eb98a87660c1616fbd39c44d4238a82f29df90b529e24bfdf72a480d1149d79c991c863a22b5ae0fb3ae6f5323bfd6664faef99792637477c38da488e7aa0d39b83ba99aba8e8a20efde7fd5c7ba21a6c938e17a9f99f73226dc61e89cd63f159257841194323f100d1a49b88ce4fdcdf2b066a5f32f88ee12f6487b55b4b5687d7c0caffdd8524e2adc4b941cf52e948f5b330f527eb1354341c876eed12dfa92cef3c341d030d05e6beb1e0a7f6d3e08e7b1aac045130457fd3a53ee469fecdd20fdd2c7a6a72b07cbcb1157c5b1cc581e6767bea32be8e125016a48951e85c7bdb961d9c9fab28444499ce063664fe0bd1a05d60294323bdd69af6d6ff1a2533dac8d4a869f76dbc746ee12f144e0af41029f620471817843140c23d036e731f3ebee21a70ff1549e97486fdf9cbef132ff2ced59fde9be35dd04b358c9a25ec4fd9cc0e36dae651e626d8c13b0c6d2a21f237517a05059680173e71817597062c792ea9c66030ca0d8ed82987e29189947692a0be5fffac4c988ca33f14ce96349661ef850dbff6909c7797676c90a5e47655346f59759482ef8a3a948e97e30f889bd4571610fd19e8ea4818651d37f6529cf32f0fc805bc053e911f0fe96f52b4420d54bd1f40739a95f5853b036c86ab9a51bed57fa9bd48607b5302e88db00900adf",
+    JWT_EXPIRES_IN: "30d",
+    PRISMA_SCHEMA_PATH: `./prisma/schema`,
+};
+exports.default = arkosEnv;
+//# sourceMappingURL=arkos-env.js.map

package/dist/cjs/utils/cli/build.js

@@ -1,5 +1,214 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.buildCommand=buildCommand;const path_1=__importDefault(require("path")),fs_1=__importDefault(require("fs")),child_process_1=require("child_process"),fs_helpers_1=require("../helpers/fs.helpers"),dotenv_helpers_1=require("../dotenv.helpers"),cli_helpers_1=require("./utils/cli.helpers"),global_helpers_1=require("../helpers/global.helpers"),sheu_1=__importDefault(require("../sheu")),BUILD_DIR=".build",MODULE_TYPES=["cjs","esm"];function buildCommand(e={}){const s=(0,fs_helpers_1.getUserFileExtension)();process.env.NODE_ENV="production",process.env.NODE_ENV="true";const t=(0,dotenv_helpers_1.loadEnvironmentVariables)(),n=validateModuleType(e.module);try{console.info(`  \x1B[1m\x1B[36m  Arkos.js ${(0,cli_helpers_1.getVersion)()}\x1B[0m`),console.info(`  - Environments: ${(0,fs_helpers_1.fullCleanCwd)(t?.join(", ")||"").replaceAll(`${process.cwd()}/`,"").replaceAll("/","")}`),console.info(`
-  Creating an optimized production build...`),ensureBuildDir(),s==="ts"?buildTypeScriptProject(e,n):buildJavaScriptProject(e,n);const r=(0,global_helpers_1.detectPackageManagerFromUserAgent)();console.info(`
-\x1B[1m\x1B[32m  Build complete!\x1B[0m
-`),console.info("  \x1B[1mNext step:\x1B[0m"),console.info(`  Run it using \x1B[1m\x1B[36m${r} run start\x1B[0m
-`)}catch(r){console.info(""),sheu_1.default.error(`Build failed: ${r?.message}`),console.error(r),process.exit(1)}}function validateModuleType(e){if(!e)return"cjs";const s=e.toLowerCase();return s==="cjs"||s==="commonjs"?"cjs":["esm","es","es2020","esnext","module"].includes(s)?"esm":(console.warn(`\u26A0\uFE0F Unrecognized module type "${e}", defaulting to "cjs"`),"cjs")}function ensureBuildDir(){fs_1.default.existsSync(BUILD_DIR)||fs_1.default.mkdirSync(BUILD_DIR,{recursive:!0});for(const e of MODULE_TYPES){const s=path_1.default.join(BUILD_DIR,e);fs_1.default.existsSync(s)||fs_1.default.mkdirSync(s,{recursive:!0})}}function buildTypeScriptProject(e,s){const t=path_1.default.join(process.cwd(),e.config||"tsconfig.json");let n={};try{if(fs_1.default.existsSync(t)){const o=fs_1.default.readFileSync(t,"utf8");n=JSON.parse(o)}}catch(o){console.error("\u274C Error reading tsconfig.json:",o)}const r={...n,compilerOptions:{...n.compilerOptions||{},rootDir:".",outDir:path_1.default.join(`./${BUILD_DIR}`)}},c=path_1.default.join(process.cwd(),"tsconfig.arkos-build.json");fs_1.default.writeFileSync(c,JSON.stringify(r,null,2));try{(0,child_process_1.execSync)(`npx rimraf ${BUILD_DIR} && npx tsc -p ${c}`,{stdio:"inherit",cwd:process.cwd()}),copyAllNonSourceFiles(s,[".ts",".tsx"]),cleanupTempConfig(c)}catch(o){throw cleanupTempConfig(c),o}}function buildJavaScriptProject(e,s){const t=path_1.default.join(BUILD_DIR);try{s==="esm"?((0,child_process_1.execSync)(`npx copyfiles -u 0 "src/**/*.js" "src/**/*.jsx" "src/**/*.mjs" ${t}`,{stdio:"inherit",cwd:process.cwd()}),console.info("Note: .cjs files are skipped in ESM build")):(0,child_process_1.execSync)(`npx copyfiles -u 0 "src/**/*.js" "src/**/*.jsx" "src/**/*.cjs" "src/**/*.mjs" ${t}`,{stdio:"inherit",cwd:process.cwd()}),copyAllNonSourceFiles(s,[".js",".jsx",".mjs",".cjs",".ts",".tsx"]),createModulePackageJson(s)}catch(n){throw console.error("\u274C Error building JavaScript project:",n),n}}function copyAllNonSourceFiles(e,s){const t=path_1.default.join(BUILD_DIR),n="src";try{let r=function(o){if(!fs_1.default.existsSync(o))return;const d=fs_1.default.readdirSync(o);for(const l of d){const a=path_1.default.join(o,l),i=path_1.default.join(t,o.replace(n,""),l),u=fs_1.default.statSync(a);if(u.isDirectory())fs_1.default.existsSync(i)||fs_1.default.mkdirSync(i,{recursive:!0}),r(a);else if(u.isFile()){const p=path_1.default.extname(l).toLowerCase();if(!s.includes(p)){const f=path_1.default.dirname(i);fs_1.default.existsSync(f)||fs_1.default.mkdirSync(f,{recursive:!0}),fs_1.default.copyFileSync(a,i)}}}};r(n);const c=["README.md","LICENSE"];for(const o of c)fs_1.default.existsSync(path_1.default.join(process.cwd(),o))&&fs_1.default.copyFileSync(path_1.default.join(process.cwd(),o),path_1.default.join(t,o))}catch(r){console.warn("Warning: Error copying project files:",r),console.error(r)}}function createModulePackageJson(e){const s=path_1.default.join(process.cwd(),"package.json");if(fs_1.default.existsSync(s))try{const t=JSON.parse(fs_1.default.readFileSync(s,"utf8")),n={name:t.name,version:t.version,description:t.description,main:"index.js",dependencies:t.dependencies};e==="esm"&&(n.type="module");const r=path_1.default.join(BUILD_DIR,e);fs_1.default.writeFileSync(path_1.default.join(r,"package.json"),JSON.stringify(n,null,2))}catch(t){console.warn("Warning: Failed to create module-specific package.json",t)}}function cleanupTempConfig(e){try{fs_1.default.existsSync(e)&&fs_1.default.unlinkSync(e)}catch(s){console.warn("Warning: Error cleaning up temporary config:",s)}}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildCommand = buildCommand;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+const fs_helpers_1 = require("../helpers/fs.helpers");
+const dotenv_helpers_1 = require("../dotenv.helpers");
+const cli_helpers_1 = require("./utils/cli.helpers");
+const global_helpers_1 = require("../helpers/global.helpers");
+const sheu_1 = __importDefault(require("../sheu"));
+const BUILD_DIR = ".build";
+const MODULE_TYPES = ["cjs", "esm"];
+function buildCommand(options = {}) {
+    const fileExt = (0, fs_helpers_1.getUserFileExtension)();
+    process.env.NODE_ENV = "production";
+    process.env.NODE_ENV = "true";
+    const envFiles = (0, dotenv_helpers_1.loadEnvironmentVariables)();
+    const moduleType = validateModuleType(options.module);
+    try {
+        console.info(`  \x1b[1m\x1b[36m  Arkos.js ${(0, cli_helpers_1.getVersion)()}\x1b[0m`);
+        console.info(`  - Environments: ${(0, fs_helpers_1.fullCleanCwd)(envFiles?.join(", ") || "")
+            .replaceAll(`${process.cwd()}/`, "")
+            .replaceAll("/", "")}`);
+        console.info(`\n  Creating an optimized production build...`);
+        ensureBuildDir();
+        if (fileExt === "ts") {
+            buildTypeScriptProject(options, moduleType);
+        }
+        else {
+            buildJavaScriptProject(options, moduleType);
+        }
+        const packageManger = (0, global_helpers_1.detectPackageManagerFromUserAgent)();
+        console.info(`\n\x1b[1m\x1b[32m  Build complete!\x1b[0m\n`);
+        console.info(`  \x1b[1mNext step:\x1b[0m`);
+        console.info(`  Run it using \x1b[1m\x1b[36m${packageManger} run start\x1b[0m\n`);
+    }
+    catch (err) {
+        console.info("");
+        sheu_1.default.error(`Build failed: ${err?.message}`);
+        console.error(err);
+        process.exit(1);
+    }
+}
+function validateModuleType(moduleType) {
+    if (!moduleType)
+        return "cjs";
+    const normalizedType = moduleType.toLowerCase();
+    if (normalizedType === "cjs" || normalizedType === "commonjs") {
+        return "cjs";
+    }
+    else if (["esm", "es", "es2020", "esnext", "module"].includes(normalizedType)) {
+        return "esm";
+    }
+    console.warn(`⚠️ Unrecognized module type "${moduleType}", defaulting to "cjs"`);
+    return "cjs";
+}
+function ensureBuildDir() {
+    if (!fs_1.default.existsSync(BUILD_DIR)) {
+        fs_1.default.mkdirSync(BUILD_DIR, { recursive: true });
+    }
+    for (const moduleType of MODULE_TYPES) {
+        const moduleDir = path_1.default.join(BUILD_DIR, moduleType);
+        if (!fs_1.default.existsSync(moduleDir)) {
+            fs_1.default.mkdirSync(moduleDir, { recursive: true });
+        }
+    }
+}
+function buildTypeScriptProject(options, moduleType) {
+    const tsconfigPath = path_1.default.join(process.cwd(), options.config || "tsconfig.json");
+    let tsconfig = {};
+    try {
+        if (fs_1.default.existsSync(tsconfigPath)) {
+            const tsconfigContent = fs_1.default.readFileSync(tsconfigPath, "utf8");
+            tsconfig = JSON.parse(tsconfigContent);
+        }
+    }
+    catch (error) {
+        console.error("❌ Error reading tsconfig.json:", error);
+    }
+    const tempTsconfig = {
+        ...tsconfig,
+        compilerOptions: {
+            ...(tsconfig.compilerOptions || {}),
+            rootDir: ".",
+            outDir: path_1.default.join(`./${BUILD_DIR}`),
+        },
+    };
+    const tempTsconfigPath = path_1.default.join(process.cwd(), `tsconfig.arkos-build.json`);
+    fs_1.default.writeFileSync(tempTsconfigPath, JSON.stringify(tempTsconfig, null, 2));
+    try {
+        (0, child_process_1.execSync)(`npx rimraf ${BUILD_DIR} && npx tsc -p ${tempTsconfigPath}`, {
+            stdio: "inherit",
+            cwd: process.cwd(),
+        });
+        copyAllNonSourceFiles(moduleType, [".ts", ".tsx"]);
+        cleanupTempConfig(tempTsconfigPath);
+    }
+    catch (error) {
+        cleanupTempConfig(tempTsconfigPath);
+        throw error;
+    }
+}
+function buildJavaScriptProject(_, moduleType) {
+    const targetDir = path_1.default.join(BUILD_DIR);
+    try {
+        if (moduleType === "esm") {
+            (0, child_process_1.execSync)(`npx copyfiles -u 0 "src/**/*.js" "src/**/*.jsx" "src/**/*.mjs" ${targetDir}`, {
+                stdio: "inherit",
+                cwd: process.cwd(),
+            });
+            console.info("Note: .cjs files are skipped in ESM build");
+        }
+        else {
+            (0, child_process_1.execSync)(`npx copyfiles -u 0 "src/**/*.js" "src/**/*.jsx" "src/**/*.cjs" "src/**/*.mjs" ${targetDir}`, {
+                stdio: "inherit",
+                cwd: process.cwd(),
+            });
+        }
+        copyAllNonSourceFiles(moduleType, [
+            ".js",
+            ".jsx",
+            ".mjs",
+            ".cjs",
+            ".ts",
+            ".tsx",
+        ]);
+        createModulePackageJson(moduleType);
+    }
+    catch (error) {
+        console.error("❌ Error building JavaScript project:", error);
+        throw error;
+    }
+}
+function copyAllNonSourceFiles(_, skipExtensions) {
+    const targetDir = path_1.default.join(BUILD_DIR);
+    const sourceDir = "src";
+    try {
+        function copyDirRecursive(dir) {
+            if (!fs_1.default.existsSync(dir))
+                return;
+            const items = fs_1.default.readdirSync(dir);
+            for (const item of items) {
+                const sourcePath = path_1.default.join(dir, item);
+                const targetPath = path_1.default.join(targetDir, dir.replace(sourceDir, ""), item);
+                const stats = fs_1.default.statSync(sourcePath);
+                if (stats.isDirectory()) {
+                    if (!fs_1.default.existsSync(targetPath)) {
+                        fs_1.default.mkdirSync(targetPath, { recursive: true });
+                    }
+                    copyDirRecursive(sourcePath);
+                }
+                else if (stats.isFile()) {
+                    const ext = path_1.default.extname(item).toLowerCase();
+                    if (!skipExtensions.includes(ext)) {
+                        const targetDir = path_1.default.dirname(targetPath);
+                        if (!fs_1.default.existsSync(targetDir)) {
+                            fs_1.default.mkdirSync(targetDir, { recursive: true });
+                        }
+                        fs_1.default.copyFileSync(sourcePath, targetPath);
+                    }
+                }
+            }
+        }
+        copyDirRecursive(sourceDir);
+        const rootFilesToCopy = ["README.md", "LICENSE"];
+        for (const file of rootFilesToCopy) {
+            if (fs_1.default.existsSync(path_1.default.join(process.cwd(), file))) {
+                fs_1.default.copyFileSync(path_1.default.join(process.cwd(), file), path_1.default.join(targetDir, file));
+            }
+        }
+    }
+    catch (error) {
+        console.warn("Warning: Error copying project files:", error);
+        console.error(error);
+    }
+}
+function createModulePackageJson(moduleType) {
+    const packageJsonPath = path_1.default.join(process.cwd(), "package.json");
+    if (!fs_1.default.existsSync(packageJsonPath)) {
+        return;
+    }
+    try {
+        const packageJson = JSON.parse(fs_1.default.readFileSync(packageJsonPath, "utf8"));
+        const buildPackageJson = {
+            name: packageJson.name,
+            version: packageJson.version,
+            description: packageJson.description,
+            main: "index.js",
+            dependencies: packageJson.dependencies,
+        };
+        if (moduleType === "esm") {
+            buildPackageJson.type = "module";
+        }
+        const targetDir = path_1.default.join(BUILD_DIR, moduleType);
+        fs_1.default.writeFileSync(path_1.default.join(targetDir, "package.json"), JSON.stringify(buildPackageJson, null, 2));
+    }
+    catch (error) {
+        console.warn("Warning: Failed to create module-specific package.json", error);
+    }
+}
+function cleanupTempConfig(configPath) {
+    try {
+        if (fs_1.default.existsSync(configPath))
+            fs_1.default.unlinkSync(configPath);
+    }
+    catch (error) {
+        console.warn("Warning: Error cleaning up temporary config:", error);
+    }
+}
+//# sourceMappingURL=build.js.map

package/dist/cjs/utils/cli/dev.js

@@ -1,3 +1,154 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(r){return r&&r.__esModule?r:{default:r}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.devCommand=devCommand,exports.killDevelopmentServerChildProcess=killDevelopmentServerChildProcess;const child_process_1=require("child_process"),chokidar_1=__importDefault(require("chokidar")),fs_helpers_1=require("../helpers/fs.helpers"),cli_helpers_1=require("./utils/cli.helpers"),dotenv_helpers_1=require("../dotenv.helpers"),fs_1=__importDefault(require("fs")),path_1=__importDefault(require("path")),sheu_1=__importDefault(require("../sheu")),port_and_host_allocator_1=__importDefault(require("../features/port-and-host-allocator"));let child=null,envFiles;async function devCommand(r={}){process.env.NODE_ENV="development",envFiles=(0,dotenv_helpers_1.loadEnvironmentVariables)(),child=null;let o=null;try{const{port:n,host:p}=r;let i=!1,d=new Set;const f=(0,fs_helpers_1.getUserFileExtension)(),l=path_1.default.resolve(process.cwd(),`src/app.${f}`);fs_1.default.existsSync(l)||(console.error(`Could not find application entry point at ${l}`),process.exit(1));const h=()=>({NODE_ENV:"development",...process.env,...n&&{CLI_PORT:n},...p&&{CLI_HOST:p}}),c=()=>{child&&(child.kill(),child=null);const e=h();f==="ts"?child=(0,child_process_1.spawn)("npx",["tsx-strict","--watch",l],{stdio:"inherit",env:e,shell:!0}):child=(0,child_process_1.spawn)("npx",["tsx-strict","--no-type-check","--watch",l],{stdio:"inherit",env:e,shell:!0}),child&&(child.on("error",t=>{console.error("Failed to start server:",t)}),child.on("exit",(t,s)=>{!i&&s!=="SIGTERM"&&s!=="SIGINT"&&(console.info(`Server exited with code ${t}, restarting...`),c())}))},m=(e,t)=>{t&&d.add(t),o&&clearTimeout(o);const u=new Date().toTimeString().split(" ")[0];i=!0,child&&(child.kill(),child=null),o=setTimeout(()=>{sheu_1.default.info(`\x1B[90m${u}\x1B[0m Restarting: ${e.toLowerCase()}`),c(),i=!1,o=null,t&&d.delete(t)},1e3)},x=()=>{const e=chokidar_1.default.watch((0,fs_helpers_1.fullCleanCwd)(envFiles?.join(",")||"").replaceAll("/","").split(",")||[],{ignoreInitial:!0,persistent:!0});return e.on("all",(t,s)=>{try{envFiles=(0,dotenv_helpers_1.loadEnvironmentVariables)(),m("Environment files changed","env-files")}catch(u){console.error(`Error reloading ${s}:`,u)}}),e};c();const v=x(),E=h(),_=await port_and_host_allocator_1.default.getHostAndAvailablePort(E,{logWarning:!0});console.info(`
-  \x1B[1m\x1B[36m  Arkos.js ${(0,cli_helpers_1.getVersion)()}\x1B[0m`),console.info(`  - Local:        http://${_?.host}:${_?.port}`),console.info(`  - Environments: ${(0,fs_helpers_1.fullCleanCwd)(envFiles?.join(", ")||"").replaceAll(`${process.cwd()}/`,"").replaceAll("/","")}
-`);const a=()=>{o&&clearTimeout(o),v&&v.close(),child&&(child.kill("SIGTERM"),setTimeout(()=>{child&&!child.killed&&child.kill("SIGKILL")},5e3)),process.exit(0)};process.on("SIGINT",a),process.on("SIGTERM",a),process.on("uncaughtException",e=>{console.error("Uncaught Exception:",e),a()})}catch(n){console.error("Development server failed to start:",n),child&&(child?.kill?.(),child=null),process.exit(1)}}function killDevelopmentServerChildProcess(){child?.kill?.(),child=null}
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.devCommand = devCommand;
+exports.killDevelopmentServerChildProcess = killDevelopmentServerChildProcess;
+const child_process_1 = require("child_process");
+const chokidar_1 = __importDefault(require("chokidar"));
+const fs_helpers_1 = require("../helpers/fs.helpers");
+const cli_helpers_1 = require("./utils/cli.helpers");
+const dotenv_helpers_1 = require("../dotenv.helpers");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const sheu_1 = __importDefault(require("../sheu"));
+const port_and_host_allocator_1 = __importDefault(require("../features/port-and-host-allocator"));
+let child = null;
+let envFiles;
+async function devCommand(options = {}) {
+    process.env.NODE_ENV = "development";
+    envFiles = (0, dotenv_helpers_1.loadEnvironmentVariables)();
+    child = null;
+    let restartTimeout = null;
+    try {
+        const { port, host } = options;
+        let isRestarting = false;
+        let restartingFiles = new Set();
+        const fileExt = (0, fs_helpers_1.getUserFileExtension)();
+        const entryPoint = path_1.default.resolve(process.cwd(), `src/app.${fileExt}`);
+        if (!fs_1.default.existsSync(entryPoint)) {
+            console.error(`Could not find application entry point at ${entryPoint}`);
+            process.exit(1);
+        }
+        const getEnv = () => ({
+            NODE_ENV: "development",
+            ...process.env,
+            ...(port && { CLI_PORT: port }),
+            ...(host && { CLI_HOST: host }),
+        });
+        const startServer = () => {
+            if (child) {
+                child.kill();
+                child = null;
+            }
+            const env = getEnv();
+            if (fileExt === "ts") {
+                child = (0, child_process_1.spawn)("npx", ["tsx-strict", "--watch", entryPoint], {
+                    stdio: "inherit",
+                    env,
+                    shell: true,
+                });
+            }
+            else {
+                child = (0, child_process_1.spawn)("npx", ["tsx-strict", "--no-type-check", "--watch", entryPoint], {
+                    stdio: "inherit",
+                    env,
+                    shell: true,
+                });
+            }
+            if (child) {
+                child.on("error", (error) => {
+                    console.error("Failed to start server:", error);
+                });
+                child.on("exit", (code, signal) => {
+                    if (!isRestarting && signal !== "SIGTERM" && signal !== "SIGINT") {
+                        console.info(`Server exited with code ${code}, restarting...`);
+                        startServer();
+                    }
+                });
+            }
+        };
+        const scheduleRestart = (reason, filePath) => {
+            if (filePath)
+                restartingFiles.add(filePath);
+            if (restartTimeout)
+                clearTimeout(restartTimeout);
+            const now = new Date();
+            const time = now.toTimeString().split(" ")[0];
+            isRestarting = true;
+            if (child) {
+                child.kill();
+                child = null;
+            }
+            restartTimeout = setTimeout(() => {
+                sheu_1.default.info(`\x1b[90m${time}\x1b[0m Restarting: ${reason.toLowerCase()}`);
+                startServer();
+                isRestarting = false;
+                restartTimeout = null;
+                if (filePath)
+                    restartingFiles.delete(filePath);
+            }, 1000);
+        };
+        const setupEnvWatcher = () => {
+            const envWatcher = chokidar_1.default.watch((0, fs_helpers_1.fullCleanCwd)(envFiles?.join(",") || "")
+                .replaceAll("/", "")
+                .split(",") || [], {
+                ignoreInitial: true,
+                persistent: true,
+            });
+            envWatcher.on("all", (_, filePath) => {
+                try {
+                    envFiles = (0, dotenv_helpers_1.loadEnvironmentVariables)();
+                    scheduleRestart("Environment files changed", "env-files");
+                }
+                catch (error) {
+                    console.error(`Error reloading ${filePath}:`, error);
+                }
+            });
+            return envWatcher;
+        };
+        startServer();
+        const envWatcher = setupEnvWatcher();
+        const env = getEnv();
+        const hostAndPort = await port_and_host_allocator_1.default.getHostAndAvailablePort(env, { logWarning: true });
+        console.info(`\n  \x1b[1m\x1b[36m  Arkos.js ${(0, cli_helpers_1.getVersion)()}\x1b[0m`);
+        console.info(`  - Local:        http://${hostAndPort?.host}:${hostAndPort?.port}`);
+        console.info(`  - Environments: ${(0, fs_helpers_1.fullCleanCwd)(envFiles?.join(", ") || "")
+            .replaceAll(`${process.cwd()}/`, "")
+            .replaceAll("/", "")}\n`);
+        const cleanup = () => {
+            if (restartTimeout)
+                clearTimeout(restartTimeout);
+            if (envWatcher)
+                envWatcher.close();
+            if (child) {
+                child.kill("SIGTERM");
+                setTimeout(() => {
+                    if (child && !child.killed)
+                        child.kill("SIGKILL");
+                }, 5000);
+            }
+            process.exit(0);
+        };
+        process.on("SIGINT", cleanup);
+        process.on("SIGTERM", cleanup);
+        process.on("uncaughtException", (error) => {
+            console.error("Uncaught Exception:", error);
+            cleanup();
+        });
+    }
+    catch (error) {
+        console.error("Development server failed to start:", error);
+        if (child) {
+            child?.kill?.();
+            child = null;
+        }
+        process.exit(1);
+    }
+}
+function killDevelopmentServerChildProcess() {
+    child?.kill?.();
+    child = null;
+}
+//# sourceMappingURL=dev.js.map