@medusajs/types 3.0.0-snapshot-20250410112222 → 3.0.0-snapshot-20251104011621

package/dist/common/config-module.d.ts

@@ -1,7 +1,9 @@
+import type { Secret, SignOptions, VerifyOptions } from "jsonwebtoken";
 import { ExternalModuleDeclaration, InternalModuleDeclaration } from "../modules-sdk";
 import type { RedisOptions } from "ioredis";
 import { ConnectionOptions } from "node:tls";
 import type { InlineConfig } from "vite";
+import type { Logger } from "../logger";
 /**
  * @interface
  *
@@ -13,7 +15,7 @@ export interface AdminOptions {
      * in both development and production environments. The default value is `false`.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   admin: {
      *     disable: process.env.ADMIN_DISABLED === "true" ||
@@ -34,7 +36,7 @@ export interface AdminOptions {
      * - `/`
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```ts title="medusa-config.ts"
      * module.exports = defineConfig({
      *   admin: {
      *     path: process.env.ADMIN_PATH || `/app`,
@@ -48,7 +50,7 @@ export interface AdminOptions {
      * The URL of your Medusa application. Defaults to the browser origin. This is useful to set when running the admin on a separate domain.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   admin: {
      *     backendUrl: process.env.MEDUSA_BACKEND_URL ||
@@ -64,7 +66,7 @@ export interface AdminOptions {
      * to provide to customers to complete any processes
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   admin: {
      *     storefrontUrl: process.env.MEDUSA_STOREFRONT_URL ||
@@ -75,6 +77,11 @@ export interface AdminOptions {
      * ```
      */
     storefrontUrl?: string;
+    /**
+     * The directory where the admin build is output. This is where the build process places the generated files.
+     * The default value is `./build`.
+     */
+    outDir?: string;
     /**
      * Configure the Vite configuration for the admin dashboard. This function receives the default Vite configuration
      * and returns the modified configuration. The default value is `undefined`.
@@ -88,7 +95,7 @@ export interface AdminOptions {
  *
  * Options to pass to `express-session`.
  */
-type SessionOptions = {
+export type SessionOptions = {
     /**
      * The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.
      * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.
@@ -119,6 +126,50 @@ type SessionOptions = {
      * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.
      */
     ttl?: number;
+    /**
+     * Specify the options for storing session data to dynamoDB. Make
+     * sure to install the following dependencies first.
+     *
+     * - @aws-sdk/client-dynamodb@^3.218.0
+     * - connect-dynamodb@^3.0.5
+     */
+    dynamodbOptions?: {
+        clientOptions?: {
+            endpoint?: string;
+        };
+        table?: string;
+        /** Defaults to 'sess:' */
+        prefix?: string;
+        /** Defaults to 'id' */
+        hashKey?: string;
+        readCapacityUnits?: number;
+        writeCapacityUnits?: number;
+        specialKeys?: {
+            name: string;
+            type: string;
+        }[];
+        skipThrowMissingSpecialKeys?: boolean;
+        /**
+         * Disable initialization.
+         * Useful if the table already exists or if you want to skip existence checks in a serverless environment such as AWS Lambda.
+         */
+        initialized?: boolean;
+    };
+};
+/**
+ * @interface
+ *
+ * Options to pass to `express-session`.
+ */
+export type CookieOptions = Record<string, any> & {
+    secure?: boolean;
+    sameSite?: "lax" | "strict" | "none";
+    maxAge?: number;
+    httpOnly?: boolean;
+    priority?: "low" | "medium" | "high";
+    domain?: string;
+    path?: string;
+    signed?: boolean;
 };
 /**
  * @interface
@@ -146,6 +197,37 @@ export type HttpCompressionOptions = {
      */
     threshold?: number | string;
 };
+/**
+ * @interface
+ *
+ * Medusa Cloud configurations.
+ */
+export type MedusaCloudOptions = {
+    /**
+     * The environment handle of the Medusa Cloud environment.
+     */
+    environmentHandle?: string;
+    /**
+     * The sandbox handle of the Medusa Cloud sandbox.
+     */
+    sandboxHandle?: string;
+    /**
+     * The API key used to access Medusa Cloud services.
+     */
+    apiKey?: string;
+    /**
+     * The webhook secret used to verify webhooks.
+     */
+    webhookSecret?: string;
+    /**
+     * The endpoint of the Medusa Cloud payment service.
+     */
+    paymentsEndpoint?: string;
+    /**
+     * The endpoint of the Medusa Cloud email service.
+     */
+    emailsEndpoint?: string;
+};
 /**
  * @interface
  *
@@ -159,7 +241,7 @@ export type ProjectConfigOptions = {
      * [PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html).
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     databaseName: process.env.DATABASE_NAME ||
@@ -195,9 +277,9 @@ export type ProjectConfigOptions = {
      * DATABASE_URL=postgres://postgres@localhost/medusa-store
      * ```
      *
-     * Then, use the value in `medusa-config.js`:
+     * Then, use the value in `medusa-config.ts`:
      *
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     databaseUrl: process.env.DATABASE_URL,
@@ -211,7 +293,7 @@ export type ProjectConfigOptions = {
     /**
      * The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`.
      *
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     databaseSchema: process.env.DATABASE_SCHEMA ||
@@ -227,7 +309,7 @@ export type ProjectConfigOptions = {
      * This configuration specifies whether database messages should be logged.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     databaseLogging: false
@@ -252,7 +334,7 @@ export type ProjectConfigOptions = {
      * :::
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     databaseDriverOptions: process.env.NODE_ENV !== "development" ?
@@ -289,7 +371,7 @@ export type ProjectConfigOptions = {
      * For a local Redis installation, the connection URL should be `redis://localhost:6379` unless you’ve made any changes to the Redis configuration during installation.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     redisUrl: process.env.REDIS_URL ||
@@ -307,7 +389,7 @@ export type ProjectConfigOptions = {
      * If this configuration option is provided, it is prepended to `sess:`.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     redisPrefix: process.env.REDIS_URL || "medusa:",
@@ -323,7 +405,7 @@ export type ProjectConfigOptions = {
      * for the list of available options.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     redisOptions: {
@@ -341,7 +423,7 @@ export type ProjectConfigOptions = {
      * This configuration defines additional options to pass to [express-session](https://www.npmjs.com/package/express-session), which is used to store the Medusa server's session.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     sessionOptions: {
@@ -354,11 +436,12 @@ export type ProjectConfigOptions = {
      * ```
      */
     sessionOptions?: SessionOptions;
+    cookieOptions?: CookieOptions;
     /**
      * Configure the number of staged jobs that are polled from the database. Default is `1000`.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     jobsBatchSize: 100
@@ -395,7 +478,7 @@ export type ProjectConfigOptions = {
      * 2. Another having the `workerMode` configuration set to `worker`.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     workerMode: process.env.WORKER_MODE || "shared"
@@ -410,7 +493,7 @@ export type ProjectConfigOptions = {
      * This property configures the application's http-specific settings.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```js title="medusa-config.ts"
      * module.exports = defineConfig({
      *   projectConfig: {
      *     http: {
@@ -433,7 +516,7 @@ export type ProjectConfigOptions = {
          * error is thrown and the application crashes.
          *
          * @example
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -445,14 +528,73 @@ export type ProjectConfigOptions = {
          * })
          * ```
          */
-        jwtSecret?: string;
+        jwtSecret?: Secret;
+        /**
+         * The public key used to verify the JWT token in combination with the JWT secret and the JWT options.
+         * Only used when the JWT secret is a secret key for asymetric validation.
+         *
+         * @example
+         * ```js title="medusa-config.ts"
+         * module.exports = defineConfig({
+         *   projectConfig: {
+         *     http: {
+         *       jwtPublicKey: "public-key"
+         *     }
+         *     // ...
+         *   },
+         *   // ...
+         * })
+         * ```
+         */
+        jwtPublicKey?: Secret;
+        /**
+         * Options for the JWT token when using asymetric signing private/public key. Will be used for validation if `jwtVerifyOptions` is not provided.
+         *
+         * @example
+         * ```js title="medusa-config.ts"
+         * module.exports = defineConfig({
+         *   projectConfig: {
+         *     http: {
+         *       jwtOptions: {
+         *         algorithm: "RS256",
+         *         expiresIn: "1h",
+         *         issuer: "medusa",
+         *         keyid: "medusa",
+         *       }
+         *     }
+         *     // ...
+         *   },
+         *   // ...
+         * })
+         * ```
+         */
+        jwtOptions?: SignOptions;
+        /**
+         * Options for the JWT token when using asymetric validation private/public key.
+         *
+         * @example
+         * ```js title="medusa-config.ts"
+         * module.exports = defineConfig({
+         *   projectConfig: {
+         *     http: {
+         *       jwtVerifyOptions: {
+         *         // ...
+         *       }
+         *     }
+         *     // ...
+         *   },
+         *   // ...
+         * })
+         * ```
+         */
+        jwtVerifyOptions?: VerifyOptions;
         /**
          * The expiration time for the JWT token. Its format is based off the [ms package](https://github.com/vercel/ms).
          *
          * If not provided, the default value is `24h`.
          *
          * @example
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -472,7 +614,7 @@ export type ProjectConfigOptions = {
          * the application crashes.
          *
          * @example
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -509,9 +651,9 @@ export type ProjectConfigOptions = {
          * AUTH_CORS=/http:\/\/.+/
          * ```
          *
-         * Then, set the configuration in `medusa-config.js`:
+         * Then, set the configuration in `medusa-config.ts`:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -523,9 +665,9 @@ export type ProjectConfigOptions = {
          * })
          * ```
          *
-         * If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
+         * If you’re adding the value directly within `medusa-config.ts`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -547,7 +689,7 @@ export type ProjectConfigOptions = {
          * Learn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).
          *
          * @example
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -589,9 +731,9 @@ export type ProjectConfigOptions = {
          * STORE_CORS=/http:\/\/.+/
          * ```
          *
-         * Then, set the configuration in `medusa-config.js`:
+         * Then, set the configuration in `medusa-config.ts`:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -603,9 +745,9 @@ export type ProjectConfigOptions = {
          * })
          * ```
          *
-         * If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
+         * If you’re adding the value directly within `medusa-config.ts`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -642,9 +784,9 @@ export type ProjectConfigOptions = {
          * ADMIN_CORS=/http:\/\/.+/
          * ```
          *
-         * Then, set the configuration in `medusa-config.js`:
+         * Then, set the configuration in `medusa-config.ts`:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -656,9 +798,9 @@ export type ProjectConfigOptions = {
          * })
          * ```
          *
-         * If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
+         * If you’re adding the value directly within `medusa-config.ts`, make sure to add an extra escaping `/` for every backslash in the pattern. For example:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -680,9 +822,9 @@ export type ProjectConfigOptions = {
          * @example
          * Some example values of common use cases:
          *
-         * Then, set the configuration in `medusa-config.js`:
+         * Then, set the configuration in `medusa-config.ts`:
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -704,7 +846,7 @@ export type ProjectConfigOptions = {
          *
          * @example
          *
-         * ```js title="medusa-config.js"
+         * ```js title="medusa-config.ts"
          * module.exports = defineConfig({
          *   projectConfig: {
          *     http: {
@@ -718,24 +860,36 @@ export type ProjectConfigOptions = {
             store?: string[];
         };
     };
+    /**
+     * This property holds configurations for running in Medusa Cloud.
+     * It gets automatically populated in the cloud, and is not needed outside of it.
+     */
+    cloud?: MedusaCloudOptions;
 };
 /**
  * @interface
  *
- * The configurations for your Medusa application are in `medusa-config.js` located in the root of your Medusa project. The configurations include configurations for database, modules, and more.
+ * The configurations for your Medusa application are set in `medusa-config.ts` located in the root of your Medusa project. The configurations include configurations for database, modules, and more.
  *
- * `medusa-config.js` exports the value returned by the `defineConfig` utility function imported from `@medusajs/utils`.
+ * :::note
+ *
+ * Some Medusa configurations are set through environment variables, which you can find in [this documentation](https://docs.medusajs.com/learn/fundamentals/environment-variables#predefined-medusa-environment-variables).
+ *
+ * :::
+ *
+ * `medusa-config.ts` exports the value returned by the `defineConfig` utility function imported from `@medusajs/framework/utils`.
  *
  * `defineConfig` accepts as a parameter an object with the following properties:
  *
  * - {@link ConfigModule.projectConfig | projectConfig} (required): An object that holds general configurations related to the Medusa application, such as database or CORS configurations.
+ * - {@link ConfigModule.plugins | plugins}: An array of strings or objects that hold the configurations of the plugins installed in the Medusa application.
  * - {@link ConfigModule.admin | admin}: An object that holds admin-related configurations.
  * - {@link ConfigModule.modules | modules}: An object that configures the Medusa application's modules.
  * - {@link ConfigModule.featureFlags | featureFlags}: An object that enables or disables features guarded by a feature flag.
  *
  * For example:
  *
- * ```js title="medusa-config.js"
+ * ```ts title="medusa-config.ts"
  * module.exports = defineConfig({
  *   projectConfig: {
  *     // ...
@@ -756,7 +910,7 @@ export type ProjectConfigOptions = {
  *
  * ## Environment Variables
  *
- * It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.js`.
+ * It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.ts`.
  *
  * During development, you can set your environment variables in the `.env` file at the root of your Medusa application project. In production,
  * setting the environment variables depends on the hosting provider.
@@ -765,14 +919,14 @@ export type ProjectConfigOptions = {
  */
 export type ConfigModule = {
     /**
-     * This property holds essential configurations related to the Medusa application, such as database and CORS configurations.
+     * This property holds essential configurations related to the Medusa application, such as database, CORS configurations and Logger.
      */
     projectConfig: ProjectConfigOptions;
     /**
      * This property holds configurations for the Medusa Admin dashboard.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```ts title="medusa-config.ts"
      * module.exports = defineConfig({
      *   admin: {
      *     backendUrl: process.env.MEDUSA_BACKEND_URL ||
@@ -784,20 +938,22 @@ export type ConfigModule = {
      */
     admin: AdminOptions;
     /**
-     * On your Medusa backend, you can use [Plugins](https://docs.medusajs.com/development/plugins/overview) to add custom features or integrate third-party services.
-     * For example, installing a plugin to use Stripe as a payment processor.
+     * On your Medusa server, you can use [Plugins](https://docs.medusajs.com/learn/fundamentals/plugins) to add re-usable Medusa customizations. Plugins
+     * can include modules, workflows, API Routes, and other customizations. Plugins are available starting from [Medusa v2.3.0](https://github.com/medusajs/medusa/releases/tag/v2.3.0).
      *
-     * Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.js`.
+     * Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.ts`.
      *
      * The items in the array can either be:
      *
-     * - A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations.
+     * - A string, which is the name of the plugin's package as specified in the plugin's `package.json` file. You can pass a plugin as a string if it doesn’t require any options.
      * - An object having the following properties:
-     *     - `resolve`: The name of the plugin.
-     *     - `options`: An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for available options.
+     *     - `resolve`: The name of the plugin's package as specified in the plugin's `package.json` file.
+     *     - `options`: An object that includes options to be passed to the modules within the plugin. Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/modules/options).
+     *
+     * Learn how to create a plugin in [this documentation](https://docs.medusajs.com/learn/fundamentals/plugins/create).
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```ts title="medusa-config.ts"
      * module.exports = {
      *   plugins: [
      *     `medusa-my-plugin-1`,
@@ -813,14 +969,16 @@ export type ConfigModule = {
      *   // ...
      * }
      * ```
-     *
-     * @ignore
-     *
-     * @privateRemarks
-     * Added the `@\ignore` tag for now so it's not generated in the main docs until we figure out what to do with plugins
      */
     plugins: ({
+        /**
+         * The name of the plugin's package as specified in the plugin's `package.json` file.
+         */
         resolve: string;
+        /**
+         * An object that includes options to be passed to the modules within the plugin.
+         * Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/modules/options).
+         */
         options: Record<string, unknown>;
     } | string)[];
     /**
@@ -828,26 +986,24 @@ export type ConfigModule = {
      *
      * :::note
      *
-     * Medusa's commerce modules are configured by default, so only
+     * Medusa's Commerce Modules are configured by default, so only
      * add them to this property if you're changing their configurations or adding providers to a module.
      *
      * :::
      *
-     * The keys of the `modules` configuration object refer to the module's registration name. Its value can be one of the following:
+     * `modules` is an array of objects, each holding a module's registration configurations. Each object has the following properties:
      *
-     * 1. A boolean value indicating whether the module type is enabled. This is only supported for Medusa's commerce and architectural modules;
-     * 2. Or an object having the following properties:
-     *     1. `resolve`: a string indicating the path to the module relative to `src`, or the module's NPM package name. For example, `./modules/my-module`.
-     *     2. `options`: (optional) an object indicating the options to pass to the module.
+     * 1. `resolve`: a string indicating the path to the module relative to `src`, or the module's NPM package name. For example, `./modules/my-module`.
+     * 2. `options`: (optional) an object indicating the options to pass to the module.
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```ts title="medusa-config.ts"
      * module.exports = defineConfig({
-     *   modules: {
-     *     helloModuleService: {
+     *   modules: [
+     *     {
      *       resolve: "./modules/hello"
      *     }
-     *   }
+     *   ]
      *   // ...
      * })
      * ```
@@ -857,14 +1013,14 @@ export type ConfigModule = {
      * Some features in the Medusa application are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability.
      *
      * You can enable a feature in your application by enabling its feature flag. Feature flags are enabled through either environment
-     * variables or through this configuration property exported in `medusa-config.js`.
+     * variables or through this configuration property exported in `medusa-config.ts`.
      *
      * The `featureFlags`'s value is an object. Its properties are the names of the feature flags, and their value is a boolean indicating whether the feature flag is enabled.
      *
-     * You can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/develop/packages/medusa/src/loaders/feature-flags).
+     * You can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/develop/packages/medusa/src/feature-flags).
      *
      * @example
-     * ```js title="medusa-config.js"
+     * ```ts title="medusa-config.ts"
      * module.exports = defineConfig({
      *   featureFlags: {
      *     analytics: true,
@@ -881,6 +1037,10 @@ export type ConfigModule = {
      * :::
      */
     featureFlags: Record<string, boolean | string | Record<string, boolean>>;
+    /**
+     * The Logger instance to be used by the application.
+     */
+    logger?: Logger;
 };
 type InternalModuleDeclarationOverride = InternalModuleDeclaration & {
     /**
@@ -910,7 +1070,7 @@ export type InputConfigModules = Partial<InternalModuleDeclarationOverride | Ext
  * The configuration accepted by the "defineConfig" helper
  */
 export type InputConfig = Partial<Omit<ConfigModule, "admin" | "modules"> & {
-    admin: Partial<ConfigModule["admin"]>;
+    admin?: Partial<ConfigModule["admin"]>;
     modules: InputConfigModules
     /**
      * @deprecated use the array instead

package/dist/common/config-module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AAExC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAClB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAA;SAClC,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAClB;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,WAAW,CAAC,EAAE,sBAAsB,CAAA;QACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE9C;;;;;;;;;;;;;;;WAeG;QACH,gBAAgB,CAAC,EAAE;YACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;SAEjB,CAAA;KACF,CAAA;CACF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,OAAO,EAAE,CACL;QACE,OAAO,EAAE,MAAM,CAAA;QACf,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,OAAO,CAAC,EAAE,MAAM,CACd,MAAM,EACN,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CACzE,CAAA;AAED,KAAK,iCAAiC,GAAG,yBAAyB,GAAG;IACnE;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,iCAAiC,GAAG,yBAAyB,GAAG;IACnE;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CACtC,iCAAiC,GAAG,iCAAiC,CACtE,EAAE,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAC/B,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,SAAS,CAAC,GAAG;IACxC,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACrC,OAAO,EACH,kBAAkB;IACpB;;OAEG;OACD,YAAY,CAAC,SAAS,CAAC,CAAA;CAC5B,CACF,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,OAAO,GAAG,SAAS,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAC1B,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B,CAAA"}
+{"version":3,"file":"config-module.d.ts","sourceRoot":"","sources":["../../src/common/config-module.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACtE,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,gBAAgB,CAAA;AAEvB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAA;AACxC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE,IAAI,MAAM,EAAE,CAAA;IAElB;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,YAAY,CAAA;CAC9C;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,eAAe,CAAC,EAAE;QAChB,aAAa,CAAC,EAAE;YACd,QAAQ,CAAC,EAAE,MAAM,CAAA;SAClB,CAAA;QACD,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,0BAA0B;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,uBAAuB;QACvB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;QAC3B,WAAW,CAAC,EAAE;YACZ,IAAI,EAAE,MAAM,CAAA;YACZ,IAAI,EAAE,MAAM,CAAA;SACb,EAAE,CAAA;QACH,2BAA2B,CAAC,EAAE,OAAO,CAAA;QACrC;;;WAGG;QACH,WAAW,CAAC,EAAE,OAAO,CAAA;KACtB,CAAA;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAChD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;IACpC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;QAChD,UAAU,CAAC,EAAE;YACX;;eAEG;YACH,GAAG,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAA;SAClC,CAAA;KACF,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,EAAE,cAAc,CAAA;IAE/B,aAAa,CAAC,EAAE,aAAa,CAAA;IAE7B;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IAE3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,EAAE;QACJ;;;;;;;;;;;;;;;;;;WAkBG;QACH,SAAS,CAAC,EAAE,MAAM,CAAA;QAElB;;;;;;;;;;;;;;;;WAgBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QAErB;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,UAAU,CAAC,EAAE,WAAW,CAAA;QAExB;;;;;;;;;;;;;;;;;WAiBG;QACH,gBAAgB,CAAC,EAAE,aAAa,CAAA;QAEhC;;;;;;;;;;;;;;;;;WAiBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;WAkBG;QACH,YAAY,CAAC,EAAE,MAAM,CAAA;QACrB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,WAAW,CAAC,EAAE,sBAAsB,CAAA;QACpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmDG;QACH,SAAS,EAAE,MAAM,CAAA;QAEjB;;;;;;;;;;;;;;;;;;;;;;;;;WAyBG;QACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAE9C;;;;;;;;;;;;;;;WAeG;QACH,gBAAgB,CAAC,EAAE;YACjB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;SAEjB,CAAA;KACF,CAAA;IAED;;;OAGG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAA;CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,aAAa,EAAE,oBAAoB,CAAA;IAEnC;;;;;;;;;;;;;OAaG;IACH,KAAK,EAAE,YAAY,CAAA;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,OAAO,EAAE,CACL;QACE;;WAEG;QACH,OAAO,EAAE,MAAM,CAAA;QACf;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,GACD,MAAM,CACT,EAAE,CAAA;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,OAAO,CAAC,EAAE,MAAM,CACd,MAAM,EACN,OAAO,GAAG,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,CAAC,CACzE,CAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IAExE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,iCAAiC,GAAG,yBAAyB,GAAG;IACnE;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,KAAK,iCAAiC,GAAG,yBAAyB,GAAG;IACnE;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CACtC,iCAAiC,GAAG,iCAAiC,CACtE,EAAE,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAC/B,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,SAAS,CAAC,GAAG;IACxC,KAAK,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;IACtC,OAAO,EACH,kBAAkB;IACpB;;OAEG;OACD,YAAY,CAAC,SAAS,CAAC,CAAA;CAC5B,CACF,CAAA;AAED,KAAK,kBAAkB,GAAG;IACxB,IAAI,EAAE,OAAO,GAAG,SAAS,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,kBAAkB,CAAA;IAC1B,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B,CAAA"}