@medusajs/types 2.7.1-snapshot-20250415100607 → 2.7.1-snapshot-20250415131624
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,7 +13,7 @@ export interface AdminOptions {
|
|
13
13
|
* in both development and production environments. The default value is `false`.
|
14
14
|
*
|
15
15
|
* @example
|
16
|
-
* ```js title="medusa-config.
|
16
|
+
* ```js title="medusa-config.ts"
|
17
17
|
* module.exports = defineConfig({
|
18
18
|
* admin: {
|
19
19
|
* disable: process.env.ADMIN_DISABLED === "true" ||
|
@@ -34,7 +34,7 @@ export interface AdminOptions {
|
|
34
34
|
* - `/`
|
35
35
|
*
|
36
36
|
* @example
|
37
|
-
* ```
|
37
|
+
* ```ts title="medusa-config.ts"
|
38
38
|
* module.exports = defineConfig({
|
39
39
|
* admin: {
|
40
40
|
* path: process.env.ADMIN_PATH || `/app`,
|
@@ -48,7 +48,7 @@ export interface AdminOptions {
|
|
48
48
|
* The URL of your Medusa application. Defaults to the browser origin. This is useful to set when running the admin on a separate domain.
|
49
49
|
*
|
50
50
|
* @example
|
51
|
-
* ```js title="medusa-config.
|
51
|
+
* ```js title="medusa-config.ts"
|
52
52
|
* module.exports = defineConfig({
|
53
53
|
* admin: {
|
54
54
|
* backendUrl: process.env.MEDUSA_BACKEND_URL ||
|
@@ -64,7 +64,7 @@ export interface AdminOptions {
|
|
64
64
|
* to provide to customers to complete any processes
|
65
65
|
*
|
66
66
|
* @example
|
67
|
-
* ```js title="medusa-config.
|
67
|
+
* ```js title="medusa-config.ts"
|
68
68
|
* module.exports = defineConfig({
|
69
69
|
* admin: {
|
70
70
|
* storefrontUrl: process.env.MEDUSA_STOREFRONT_URL ||
|
@@ -75,6 +75,11 @@ export interface AdminOptions {
|
|
75
75
|
* ```
|
76
76
|
*/
|
77
77
|
storefrontUrl?: string;
|
78
|
+
/**
|
79
|
+
* The directory where the admin build is output. This is where the build process places the generated files.
|
80
|
+
* The default value is `./build`.
|
81
|
+
*/
|
82
|
+
outDir?: string;
|
78
83
|
/**
|
79
84
|
* Configure the Vite configuration for the admin dashboard. This function receives the default Vite configuration
|
80
85
|
* and returns the modified configuration. The default value is `undefined`.
|
@@ -88,7 +93,7 @@ export interface AdminOptions {
|
|
88
93
|
*
|
89
94
|
* Options to pass to `express-session`.
|
90
95
|
*/
|
91
|
-
type SessionOptions = {
|
96
|
+
export type SessionOptions = {
|
92
97
|
/**
|
93
98
|
* The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.
|
94
99
|
* Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.
|
@@ -119,6 +124,42 @@ type SessionOptions = {
|
|
119
124
|
* Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.
|
120
125
|
*/
|
121
126
|
ttl?: number;
|
127
|
+
/**
|
128
|
+
* Specify the options for storing session data to dynamoDB. Make
|
129
|
+
* sure to install the following dependencies and set the following
|
130
|
+
* variables too.
|
131
|
+
*
|
132
|
+
* - @aws-sdk/client-dynamodb@^3.218.0
|
133
|
+
* - connect-dynamodb@^3.0.5
|
134
|
+
*
|
135
|
+
* Environment variables to set
|
136
|
+
* - AWS_REGION=<value>
|
137
|
+
* - ENDPOINT=<value>
|
138
|
+
* - AWS_ACCESS_KEY_ID=<value>
|
139
|
+
* - AWS_SECRET_ACCESS_KEY=<value>
|
140
|
+
*/
|
141
|
+
dynamodbOptions?: {
|
142
|
+
clientOptions?: {
|
143
|
+
endpoint?: string;
|
144
|
+
};
|
145
|
+
table?: string;
|
146
|
+
/** Defaults to 'sess:' */
|
147
|
+
prefix?: string;
|
148
|
+
/** Defaults to 'id' */
|
149
|
+
hashKey?: string;
|
150
|
+
readCapacityUnits?: number;
|
151
|
+
writeCapacityUnits?: number;
|
152
|
+
specialKeys?: {
|
153
|
+
name: string;
|
154
|
+
type: string;
|
155
|
+
}[];
|
156
|
+
skipThrowMissingSpecialKeys?: boolean;
|
157
|
+
/**
|
158
|
+
* Disable initialization.
|
159
|
+
* Useful if the table already exists or if you want to skip existence checks in a serverless environment such as AWS Lambda.
|
160
|
+
*/
|
161
|
+
initialized?: boolean;
|
162
|
+
};
|
122
163
|
};
|
123
164
|
/**
|
124
165
|
* @interface
|
@@ -159,7 +200,7 @@ export type ProjectConfigOptions = {
|
|
159
200
|
* [PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html).
|
160
201
|
*
|
161
202
|
* @example
|
162
|
-
* ```js title="medusa-config.
|
203
|
+
* ```js title="medusa-config.ts"
|
163
204
|
* module.exports = defineConfig({
|
164
205
|
* projectConfig: {
|
165
206
|
* databaseName: process.env.DATABASE_NAME ||
|
@@ -195,9 +236,9 @@ export type ProjectConfigOptions = {
|
|
195
236
|
* DATABASE_URL=postgres://postgres@localhost/medusa-store
|
196
237
|
* ```
|
197
238
|
*
|
198
|
-
* Then, use the value in `medusa-config.
|
239
|
+
* Then, use the value in `medusa-config.ts`:
|
199
240
|
*
|
200
|
-
* ```js title="medusa-config.
|
241
|
+
* ```js title="medusa-config.ts"
|
201
242
|
* module.exports = defineConfig({
|
202
243
|
* projectConfig: {
|
203
244
|
* databaseUrl: process.env.DATABASE_URL,
|
@@ -211,7 +252,7 @@ export type ProjectConfigOptions = {
|
|
211
252
|
/**
|
212
253
|
* The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`.
|
213
254
|
*
|
214
|
-
* ```js title="medusa-config.
|
255
|
+
* ```js title="medusa-config.ts"
|
215
256
|
* module.exports = defineConfig({
|
216
257
|
* projectConfig: {
|
217
258
|
* databaseSchema: process.env.DATABASE_SCHEMA ||
|
@@ -227,7 +268,7 @@ export type ProjectConfigOptions = {
|
|
227
268
|
* This configuration specifies whether database messages should be logged.
|
228
269
|
*
|
229
270
|
* @example
|
230
|
-
* ```js title="medusa-config.
|
271
|
+
* ```js title="medusa-config.ts"
|
231
272
|
* module.exports = defineConfig({
|
232
273
|
* projectConfig: {
|
233
274
|
* databaseLogging: false
|
@@ -252,7 +293,7 @@ export type ProjectConfigOptions = {
|
|
252
293
|
* :::
|
253
294
|
*
|
254
295
|
* @example
|
255
|
-
* ```js title="medusa-config.
|
296
|
+
* ```js title="medusa-config.ts"
|
256
297
|
* module.exports = defineConfig({
|
257
298
|
* projectConfig: {
|
258
299
|
* databaseDriverOptions: process.env.NODE_ENV !== "development" ?
|
@@ -289,7 +330,7 @@ export type ProjectConfigOptions = {
|
|
289
330
|
* 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.
|
290
331
|
*
|
291
332
|
* @example
|
292
|
-
* ```js title="medusa-config.
|
333
|
+
* ```js title="medusa-config.ts"
|
293
334
|
* module.exports = defineConfig({
|
294
335
|
* projectConfig: {
|
295
336
|
* redisUrl: process.env.REDIS_URL ||
|
@@ -307,7 +348,7 @@ export type ProjectConfigOptions = {
|
|
307
348
|
* If this configuration option is provided, it is prepended to `sess:`.
|
308
349
|
*
|
309
350
|
* @example
|
310
|
-
* ```js title="medusa-config.
|
351
|
+
* ```js title="medusa-config.ts"
|
311
352
|
* module.exports = defineConfig({
|
312
353
|
* projectConfig: {
|
313
354
|
* redisPrefix: process.env.REDIS_URL || "medusa:",
|
@@ -323,7 +364,7 @@ export type ProjectConfigOptions = {
|
|
323
364
|
* for the list of available options.
|
324
365
|
*
|
325
366
|
* @example
|
326
|
-
* ```js title="medusa-config.
|
367
|
+
* ```js title="medusa-config.ts"
|
327
368
|
* module.exports = defineConfig({
|
328
369
|
* projectConfig: {
|
329
370
|
* redisOptions: {
|
@@ -341,7 +382,7 @@ export type ProjectConfigOptions = {
|
|
341
382
|
* 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.
|
342
383
|
*
|
343
384
|
* @example
|
344
|
-
* ```js title="medusa-config.
|
385
|
+
* ```js title="medusa-config.ts"
|
345
386
|
* module.exports = defineConfig({
|
346
387
|
* projectConfig: {
|
347
388
|
* sessionOptions: {
|
@@ -358,7 +399,7 @@ export type ProjectConfigOptions = {
|
|
358
399
|
* Configure the number of staged jobs that are polled from the database. Default is `1000`.
|
359
400
|
*
|
360
401
|
* @example
|
361
|
-
* ```js title="medusa-config.
|
402
|
+
* ```js title="medusa-config.ts"
|
362
403
|
* module.exports = defineConfig({
|
363
404
|
* projectConfig: {
|
364
405
|
* jobsBatchSize: 100
|
@@ -395,7 +436,7 @@ export type ProjectConfigOptions = {
|
|
395
436
|
* 2. Another having the `workerMode` configuration set to `worker`.
|
396
437
|
*
|
397
438
|
* @example
|
398
|
-
* ```js title="medusa-config.
|
439
|
+
* ```js title="medusa-config.ts"
|
399
440
|
* module.exports = defineConfig({
|
400
441
|
* projectConfig: {
|
401
442
|
* workerMode: process.env.WORKER_MODE || "shared"
|
@@ -410,7 +451,7 @@ export type ProjectConfigOptions = {
|
|
410
451
|
* This property configures the application's http-specific settings.
|
411
452
|
*
|
412
453
|
* @example
|
413
|
-
* ```js title="medusa-config.
|
454
|
+
* ```js title="medusa-config.ts"
|
414
455
|
* module.exports = defineConfig({
|
415
456
|
* projectConfig: {
|
416
457
|
* http: {
|
@@ -433,7 +474,7 @@ export type ProjectConfigOptions = {
|
|
433
474
|
* error is thrown and the application crashes.
|
434
475
|
*
|
435
476
|
* @example
|
436
|
-
* ```js title="medusa-config.
|
477
|
+
* ```js title="medusa-config.ts"
|
437
478
|
* module.exports = defineConfig({
|
438
479
|
* projectConfig: {
|
439
480
|
* http: {
|
@@ -452,7 +493,7 @@ export type ProjectConfigOptions = {
|
|
452
493
|
* If not provided, the default value is `24h`.
|
453
494
|
*
|
454
495
|
* @example
|
455
|
-
* ```js title="medusa-config.
|
496
|
+
* ```js title="medusa-config.ts"
|
456
497
|
* module.exports = defineConfig({
|
457
498
|
* projectConfig: {
|
458
499
|
* http: {
|
@@ -472,7 +513,7 @@ export type ProjectConfigOptions = {
|
|
472
513
|
* the application crashes.
|
473
514
|
*
|
474
515
|
* @example
|
475
|
-
* ```js title="medusa-config.
|
516
|
+
* ```js title="medusa-config.ts"
|
476
517
|
* module.exports = defineConfig({
|
477
518
|
* projectConfig: {
|
478
519
|
* http: {
|
@@ -509,9 +550,9 @@ export type ProjectConfigOptions = {
|
|
509
550
|
* AUTH_CORS=/http:\/\/.+/
|
510
551
|
* ```
|
511
552
|
*
|
512
|
-
* Then, set the configuration in `medusa-config.
|
553
|
+
* Then, set the configuration in `medusa-config.ts`:
|
513
554
|
*
|
514
|
-
* ```js title="medusa-config.
|
555
|
+
* ```js title="medusa-config.ts"
|
515
556
|
* module.exports = defineConfig({
|
516
557
|
* projectConfig: {
|
517
558
|
* http: {
|
@@ -523,9 +564,9 @@ export type ProjectConfigOptions = {
|
|
523
564
|
* })
|
524
565
|
* ```
|
525
566
|
*
|
526
|
-
* If you’re adding the value directly within `medusa-config.
|
567
|
+
* 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:
|
527
568
|
*
|
528
|
-
* ```js title="medusa-config.
|
569
|
+
* ```js title="medusa-config.ts"
|
529
570
|
* module.exports = defineConfig({
|
530
571
|
* projectConfig: {
|
531
572
|
* http: {
|
@@ -547,7 +588,7 @@ export type ProjectConfigOptions = {
|
|
547
588
|
* Learn more in the [API Reference](https://docs.medusajs.com/api/store#http-compression).
|
548
589
|
*
|
549
590
|
* @example
|
550
|
-
* ```js title="medusa-config.
|
591
|
+
* ```js title="medusa-config.ts"
|
551
592
|
* module.exports = defineConfig({
|
552
593
|
* projectConfig: {
|
553
594
|
* http: {
|
@@ -589,9 +630,9 @@ export type ProjectConfigOptions = {
|
|
589
630
|
* STORE_CORS=/http:\/\/.+/
|
590
631
|
* ```
|
591
632
|
*
|
592
|
-
* Then, set the configuration in `medusa-config.
|
633
|
+
* Then, set the configuration in `medusa-config.ts`:
|
593
634
|
*
|
594
|
-
* ```js title="medusa-config.
|
635
|
+
* ```js title="medusa-config.ts"
|
595
636
|
* module.exports = defineConfig({
|
596
637
|
* projectConfig: {
|
597
638
|
* http: {
|
@@ -603,9 +644,9 @@ export type ProjectConfigOptions = {
|
|
603
644
|
* })
|
604
645
|
* ```
|
605
646
|
*
|
606
|
-
* If you’re adding the value directly within `medusa-config.
|
647
|
+
* 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:
|
607
648
|
*
|
608
|
-
* ```js title="medusa-config.
|
649
|
+
* ```js title="medusa-config.ts"
|
609
650
|
* module.exports = defineConfig({
|
610
651
|
* projectConfig: {
|
611
652
|
* http: {
|
@@ -642,9 +683,9 @@ export type ProjectConfigOptions = {
|
|
642
683
|
* ADMIN_CORS=/http:\/\/.+/
|
643
684
|
* ```
|
644
685
|
*
|
645
|
-
* Then, set the configuration in `medusa-config.
|
686
|
+
* Then, set the configuration in `medusa-config.ts`:
|
646
687
|
*
|
647
|
-
* ```js title="medusa-config.
|
688
|
+
* ```js title="medusa-config.ts"
|
648
689
|
* module.exports = defineConfig({
|
649
690
|
* projectConfig: {
|
650
691
|
* http: {
|
@@ -656,9 +697,9 @@ export type ProjectConfigOptions = {
|
|
656
697
|
* })
|
657
698
|
* ```
|
658
699
|
*
|
659
|
-
* If you’re adding the value directly within `medusa-config.
|
700
|
+
* 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:
|
660
701
|
*
|
661
|
-
* ```js title="medusa-config.
|
702
|
+
* ```js title="medusa-config.ts"
|
662
703
|
* module.exports = defineConfig({
|
663
704
|
* projectConfig: {
|
664
705
|
* http: {
|
@@ -680,9 +721,9 @@ export type ProjectConfigOptions = {
|
|
680
721
|
* @example
|
681
722
|
* Some example values of common use cases:
|
682
723
|
*
|
683
|
-
* Then, set the configuration in `medusa-config.
|
724
|
+
* Then, set the configuration in `medusa-config.ts`:
|
684
725
|
*
|
685
|
-
* ```js title="medusa-config.
|
726
|
+
* ```js title="medusa-config.ts"
|
686
727
|
* module.exports = defineConfig({
|
687
728
|
* projectConfig: {
|
688
729
|
* http: {
|
@@ -704,7 +745,7 @@ export type ProjectConfigOptions = {
|
|
704
745
|
*
|
705
746
|
* @example
|
706
747
|
*
|
707
|
-
* ```js title="medusa-config.
|
748
|
+
* ```js title="medusa-config.ts"
|
708
749
|
* module.exports = defineConfig({
|
709
750
|
* projectConfig: {
|
710
751
|
* http: {
|
@@ -722,20 +763,27 @@ export type ProjectConfigOptions = {
|
|
722
763
|
/**
|
723
764
|
* @interface
|
724
765
|
*
|
725
|
-
* The configurations for your Medusa application are in `medusa-config.
|
766
|
+
* 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.
|
767
|
+
*
|
768
|
+
* :::note
|
769
|
+
*
|
770
|
+
* 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).
|
726
771
|
*
|
727
|
-
*
|
772
|
+
* :::
|
773
|
+
*
|
774
|
+
* `medusa-config.ts` exports the value returned by the `defineConfig` utility function imported from `@medusajs/framework/utils`.
|
728
775
|
*
|
729
776
|
* `defineConfig` accepts as a parameter an object with the following properties:
|
730
777
|
*
|
731
778
|
* - {@link ConfigModule.projectConfig | projectConfig} (required): An object that holds general configurations related to the Medusa application, such as database or CORS configurations.
|
779
|
+
* - {@link ConfigModule.plugins | plugins}: An array of strings or objects that hold the configurations of the plugins installed in the Medusa application.
|
732
780
|
* - {@link ConfigModule.admin | admin}: An object that holds admin-related configurations.
|
733
781
|
* - {@link ConfigModule.modules | modules}: An object that configures the Medusa application's modules.
|
734
782
|
* - {@link ConfigModule.featureFlags | featureFlags}: An object that enables or disables features guarded by a feature flag.
|
735
783
|
*
|
736
784
|
* For example:
|
737
785
|
*
|
738
|
-
* ```
|
786
|
+
* ```ts title="medusa-config.ts"
|
739
787
|
* module.exports = defineConfig({
|
740
788
|
* projectConfig: {
|
741
789
|
* // ...
|
@@ -756,7 +804,7 @@ export type ProjectConfigOptions = {
|
|
756
804
|
*
|
757
805
|
* ## Environment Variables
|
758
806
|
*
|
759
|
-
* It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.
|
807
|
+
* It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.ts`.
|
760
808
|
*
|
761
809
|
* During development, you can set your environment variables in the `.env` file at the root of your Medusa application project. In production,
|
762
810
|
* setting the environment variables depends on the hosting provider.
|
@@ -772,7 +820,7 @@ export type ConfigModule = {
|
|
772
820
|
* This property holds configurations for the Medusa Admin dashboard.
|
773
821
|
*
|
774
822
|
* @example
|
775
|
-
* ```
|
823
|
+
* ```ts title="medusa-config.ts"
|
776
824
|
* module.exports = defineConfig({
|
777
825
|
* admin: {
|
778
826
|
* backendUrl: process.env.MEDUSA_BACKEND_URL ||
|
@@ -784,20 +832,22 @@ export type ConfigModule = {
|
|
784
832
|
*/
|
785
833
|
admin: AdminOptions;
|
786
834
|
/**
|
787
|
-
* On your Medusa
|
788
|
-
*
|
835
|
+
* On your Medusa server, you can use [Plugins](https://docs.medusajs.com/learn/fundamentals/plugins) to add re-usable Medusa customizations. Plugins
|
836
|
+
* 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).
|
789
837
|
*
|
790
|
-
* Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.
|
838
|
+
* Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.ts`.
|
791
839
|
*
|
792
840
|
* The items in the array can either be:
|
793
841
|
*
|
794
|
-
* - A string, which is the name of the plugin
|
842
|
+
* - 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.
|
795
843
|
* - An object having the following properties:
|
796
|
-
* - `resolve`: The name of the plugin.
|
797
|
-
* - `options`: An object that includes
|
844
|
+
* - `resolve`: The name of the plugin's package as specified in the plugin's `package.json` file.
|
845
|
+
* - `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).
|
846
|
+
*
|
847
|
+
* Learn how to create a plugin in [this documentation](https://docs.medusajs.com/learn/fundamentals/plugins/create).
|
798
848
|
*
|
799
849
|
* @example
|
800
|
-
* ```
|
850
|
+
* ```ts title="medusa-config.ts"
|
801
851
|
* module.exports = {
|
802
852
|
* plugins: [
|
803
853
|
* `medusa-my-plugin-1`,
|
@@ -813,14 +863,16 @@ export type ConfigModule = {
|
|
813
863
|
* // ...
|
814
864
|
* }
|
815
865
|
* ```
|
816
|
-
*
|
817
|
-
* @ignore
|
818
|
-
*
|
819
|
-
* @privateRemarks
|
820
|
-
* Added the `@\ignore` tag for now so it's not generated in the main docs until we figure out what to do with plugins
|
821
866
|
*/
|
822
867
|
plugins: ({
|
868
|
+
/**
|
869
|
+
* The name of the plugin's package as specified in the plugin's `package.json` file.
|
870
|
+
*/
|
823
871
|
resolve: string;
|
872
|
+
/**
|
873
|
+
* An object that includes options to be passed to the modules within the plugin.
|
874
|
+
* Learn more in [this documentation](https://docs.medusajs.com/learn/fundamentals/modules/options).
|
875
|
+
*/
|
824
876
|
options: Record<string, unknown>;
|
825
877
|
} | string)[];
|
826
878
|
/**
|
@@ -833,21 +885,19 @@ export type ConfigModule = {
|
|
833
885
|
*
|
834
886
|
* :::
|
835
887
|
*
|
836
|
-
*
|
888
|
+
* `modules` is an array of objects, each holding a module's registration configurations. Each object has the following properties:
|
837
889
|
*
|
838
|
-
* 1.
|
839
|
-
* 2.
|
840
|
-
* 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`.
|
841
|
-
* 2. `options`: (optional) an object indicating the options to pass to the module.
|
890
|
+
* 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`.
|
891
|
+
* 2. `options`: (optional) an object indicating the options to pass to the module.
|
842
892
|
*
|
843
893
|
* @example
|
844
|
-
* ```
|
894
|
+
* ```ts title="medusa-config.ts"
|
845
895
|
* module.exports = defineConfig({
|
846
|
-
* modules:
|
847
|
-
*
|
896
|
+
* modules: [
|
897
|
+
* {
|
848
898
|
* resolve: "./modules/hello"
|
849
899
|
* }
|
850
|
-
*
|
900
|
+
* ]
|
851
901
|
* // ...
|
852
902
|
* })
|
853
903
|
* ```
|
@@ -857,14 +907,14 @@ export type ConfigModule = {
|
|
857
907
|
* 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.
|
858
908
|
*
|
859
909
|
* You can enable a feature in your application by enabling its feature flag. Feature flags are enabled through either environment
|
860
|
-
* variables or through this configuration property exported in `medusa-config.
|
910
|
+
* variables or through this configuration property exported in `medusa-config.ts`.
|
861
911
|
*
|
862
912
|
* 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.
|
863
913
|
*
|
864
914
|
* You can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/develop/packages/medusa/src/loaders/feature-flags).
|
865
915
|
*
|
866
916
|
* @example
|
867
|
-
* ```
|
917
|
+
* ```ts title="medusa-config.ts"
|
868
918
|
* module.exports = defineConfig({
|
869
919
|
* featureFlags: {
|
870
920
|
* analytics: true,
|
@@ -910,7 +960,7 @@ export type InputConfigModules = Partial<InternalModuleDeclarationOverride | Ext
|
|
910
960
|
* The configuration accepted by the "defineConfig" helper
|
911
961
|
*/
|
912
962
|
export type InputConfig = Partial<Omit<ConfigModule, "admin" | "modules"> & {
|
913
|
-
admin
|
963
|
+
admin?: Partial<ConfigModule["admin"]>;
|
914
964
|
modules: InputConfigModules
|
915
965
|
/**
|
916
966
|
* @deprecated use the array instead
|
@@ -1 +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;
|
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;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;;;;;;;;;;;;;OAaG;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,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;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,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"}
|