@junobuild/config 0.4.3 → 1.0.0

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.
Files changed (22) hide show
  1. package/README.md +76 -533
  2. package/dist/browser/index.js +1 -1
  3. package/dist/browser/index.js.map +4 -4
  4. package/dist/node/index.mjs +1 -1
  5. package/dist/node/index.mjs.map +4 -4
  6. package/dist/types/console/console.config.d.ts +2 -0
  7. package/dist/types/index.d.ts +10 -11
  8. package/dist/types/satellite/{mainnet/config.d.ts → config.d.ts} +1 -1
  9. package/dist/types/satellite/{mainnet/configs → configs}/authentication.config.d.ts +42 -0
  10. package/dist/types/satellite/configs/collections.d.ts +137 -0
  11. package/dist/types/satellite/{mainnet/configs → configs}/datastore.config.d.ts +12 -1
  12. package/dist/types/satellite/{mainnet/configs → configs}/orbiter.config.d.ts +2 -2
  13. package/dist/types/satellite/{types → configs}/rules.d.ts +7 -6
  14. package/dist/types/satellite/{mainnet/configs → configs}/satellite.config.d.ts +124 -5
  15. package/dist/types/satellite/{mainnet/juno.config.d.ts → juno.config.d.ts} +112 -0
  16. package/dist/types/shared/storage.config.d.ts +11 -0
  17. package/package.json +2 -2
  18. package/dist/types/satellite/dev/config.d.ts +0 -6
  19. package/dist/types/satellite/dev/juno.dev.config.d.ts +0 -313
  20. package/dist/types/tests/mocks/principal.mocks.d.ts +0 -2
  21. /package/dist/types/satellite/{mainnet/configs → configs}/assertions.config.d.ts +0 -0
  22. /package/dist/types/satellite/{mainnet/configs → configs}/emulator.config.d.ts +0 -0
package/README.md CHANGED
@@ -12,141 +12,20 @@ Configuration options for [Juno] CLI.
12
12
 
13
13
  <!-- TSDOC_START -->
14
14
 
15
- ### :toolbox: Functions
16
-
17
- - [defineDevConfig](#gear-definedevconfig)
18
- - [defineDevConfig](#gear-definedevconfig)
19
- - [defineDevConfig](#gear-definedevconfig)
20
- - [defineDevConfig](#gear-definedevconfig)
21
-
22
- #### :gear: defineDevConfig
23
-
24
- | Function | Type |
25
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
27
-
28
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L7)
29
-
30
- #### :gear: defineDevConfig
31
-
32
- | Function | Type |
33
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
34
- | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
35
-
36
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L8)
37
-
38
- #### :gear: defineDevConfig
39
-
40
- | Function | Type |
41
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
42
- | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
43
-
44
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L9)
45
-
46
- #### :gear: defineDevConfig
47
-
48
- | Function | Type |
49
- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
50
- | `defineDevConfig` | `{ (config: JunoDevConfig): JunoDevConfig; (config: JunoDevConfigFn): JunoDevConfigFn; (config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject; }` |
51
-
52
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L10)
53
-
54
15
  ### :wrench: Constants
55
16
 
56
- - [EmulatorConfigSchema](#gear-emulatorconfigschema)
57
- - [JunoConfigModeSchema](#gear-junoconfigmodeschema)
58
- - [JunoConfigEnvSchema](#gear-junoconfigenvschema)
59
- - [OrbiterIdSchema](#gear-orbiteridschema)
60
- - [OrbiterIdsSchema](#gear-orbiteridsschema)
61
- - [OrbiterConfigSchema](#gear-orbiterconfigschema)
62
- - [ModuleLogVisibilitySchema](#gear-modulelogvisibilityschema)
63
- - [ModuleSettingsSchema](#gear-modulesettingsschema)
64
17
  - [MaxMemorySizeConfigSchema](#gear-maxmemorysizeconfigschema)
65
18
  - [StorageConfigSourceGlobSchema](#gear-storageconfigsourceglobschema)
66
19
  - [StorageConfigHeaderSchema](#gear-storageconfigheaderschema)
67
20
  - [StorageConfigRewriteSchema](#gear-storageconfigrewriteschema)
68
21
  - [StorageConfigRedirectSchema](#gear-storageconfigredirectschema)
69
22
  - [StorageConfigSchema](#gear-storageconfigschema)
23
+ - [ModuleLogVisibilitySchema](#gear-modulelogvisibilityschema)
24
+ - [ModuleSettingsSchema](#gear-modulesettingsschema)
25
+ - [JunoConfigModeSchema](#gear-junoconfigmodeschema)
26
+ - [JunoConfigEnvSchema](#gear-junoconfigenvschema)
70
27
  - [EncodingTypeSchema](#gear-encodingtypeschema)
71
28
  - [CliConfigSchema](#gear-cliconfigschema)
72
- - [SatelliteAssertionsSchema](#gear-satelliteassertionsschema)
73
- - [AuthenticationConfigInternetIdentitySchema](#gear-authenticationconfiginternetidentityschema)
74
- - [AuthenticationConfigSchema](#gear-authenticationconfigschema)
75
- - [DatastoreConfigSchema](#gear-datastoreconfigschema)
76
- - [SatelliteIdSchema](#gear-satelliteidschema)
77
- - [SatelliteIdsSchema](#gear-satelliteidsschema)
78
- - [SatelliteConfigOptionsSchema](#gear-satelliteconfigoptionsschema)
79
- - [JunoConfigSchema](#gear-junoconfigschema)
80
- - [SatelliteDevDataStoreCollectionSchema](#gear-satellitedevdatastorecollectionschema)
81
- - [SatelliteDevStorageCollectionSchema](#gear-satellitedevstoragecollectionschema)
82
- - [SatelliteDevCollectionsSchema](#gear-satellitedevcollectionsschema)
83
- - [SatelliteDevControllerSchema](#gear-satellitedevcontrollerschema)
84
- - [SatelliteDevConfigSchema](#gear-satellitedevconfigschema)
85
- - [JunoDevConfigSchema](#gear-junodevconfigschema)
86
-
87
- #### :gear: EmulatorConfigSchema
88
-
89
- | Constant | Type |
90
- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91
- | `EmulatorConfigSchema` | `ZodUnion<readonly [ZodObject<{ runner: ZodOptional<ZodObject<{ type: ZodEnum<{ docker: "docker"; podman: "podman"; }>; image: ZodOptional<ZodString>; name: ZodOptional<ZodString>; volume: ZodOptional<...>; target: ZodOptional<...>; platform: ZodOptional<...>; }, $strict>>; skylab: ZodObject<...>; }, $strict>, ZodObj...` |
92
-
93
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/emulator.config.ts#L151)
94
-
95
- #### :gear: JunoConfigModeSchema
96
-
97
- | Constant | Type |
98
- | ---------------------- | ---------------------------------------------------------- |
99
- | `JunoConfigModeSchema` | `ZodUnion<readonly [ZodLiteral<"production">, ZodString]>` |
100
-
101
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L6)
102
-
103
- #### :gear: JunoConfigEnvSchema
104
-
105
- | Constant | Type |
106
- | --------------------- | ---------------------------------------------------------------------------------------- |
107
- | `JunoConfigEnvSchema` | `ZodObject<{ mode: ZodUnion<readonly [ZodLiteral<"production">, ZodString]>; }, $strip>` |
108
-
109
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L17)
110
-
111
- #### :gear: OrbiterIdSchema
112
-
113
- | Constant | Type |
114
- | ----------------- | --------------------------------------- |
115
- | `OrbiterIdSchema` | `ZodObject<{ id: ZodString; }, $strip>` |
116
-
117
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/orbiter.config.ts#L10)
118
-
119
- #### :gear: OrbiterIdsSchema
120
-
121
- | Constant | Type |
122
- | ------------------ | ------------------------------------------------------------------------------------------------------------- |
123
- | `OrbiterIdsSchema` | `ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strip>` |
124
-
125
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/orbiter.config.ts#L29)
126
-
127
- #### :gear: OrbiterConfigSchema
128
-
129
- | Constant | Type |
130
- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
131
- | `OrbiterConfigSchema` | `ZodUnion<readonly [ZodObject<{ id: ZodString; }, $strict>, ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strict>]>` |
132
-
133
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/orbiter.config.ts#L56)
134
-
135
- #### :gear: ModuleLogVisibilitySchema
136
-
137
- | Constant | Type |
138
- | --------------------------- | ------------------------------------------------------------ |
139
- | `ModuleLogVisibilitySchema` | `ZodEnum<{ controllers: "controllers"; public: "public"; }>` |
140
-
141
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/module/module.settings.ts#L6)
142
-
143
- #### :gear: ModuleSettingsSchema
144
-
145
- | Constant | Type |
146
- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
147
- | `ModuleSettingsSchema` | `ZodObject<{ freezingThreshold: ZodOptional<ZodBigInt>; reservedCyclesLimit: ZodOptional<ZodBigInt>; logVisibility: ZodOptional<ZodEnum<{ controllers: "controllers"; public: "public"; }>>; heapMemoryLimit: ZodOptional<...>; memoryAllocation: ZodOptional<...>; computeAllocation: ZodOptional<...>; }, $strict>` |
148
-
149
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/module/module.settings.ts#L21)
150
29
 
151
30
  #### :gear: MaxMemorySizeConfigSchema
152
31
 
@@ -190,256 +69,72 @@ Configuration options for [Juno] CLI.
190
69
 
191
70
  #### :gear: StorageConfigSchema
192
71
 
193
- | Constant | Type |
194
- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
195
- | `StorageConfigSchema` | `ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 4 more ...; maxMemorySize: ZodOptional<...>; }, $strip>` |
72
+ | Constant | Type |
73
+ | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74
+ | `StorageConfigSchema` | `ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 5 more ...; version: ZodOptional<...>; }, $strip>` |
196
75
 
197
76
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/shared/storage.config.ts#L114)
198
77
 
199
- #### :gear: EncodingTypeSchema
200
-
201
- see EncodingType
202
-
203
- | Constant | Type |
204
- | -------------------- | ------------------------------------------------------------------------------------------------------ |
205
- | `EncodingTypeSchema` | `ZodEnum<{ identity: "identity"; gzip: "gzip"; compress: "compress"; deflate: "deflate"; br: "br"; }>` |
206
-
207
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L6)
208
-
209
- #### :gear: CliConfigSchema
210
-
211
- | Constant | Type |
212
- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
213
- | `CliConfigSchema` | `ZodObject<{ source: ZodOptional<ZodString>; ignore: ZodOptional<ZodArray<ZodString>>; gzip: ZodOptional<ZodUnion<readonly [ZodString, ZodLiteral<...>]>>; encoding: ZodOptional<...>; predeploy: ZodOptional<...>; postdeploy: ZodOptional<...>; }, $strict>` |
214
-
215
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/cli.config.ts#L7)
216
-
217
- #### :gear: SatelliteAssertionsSchema
218
-
219
- | Constant | Type |
220
- | --------------------------- | ---------------------------------------------------------------------------------------------- |
221
- | `SatelliteAssertionsSchema` | `ZodObject<{ heapMemory: ZodOptional<ZodUnion<readonly [ZodNumber, ZodBoolean]>>; }, $strict>` |
222
-
223
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/assertions.config.ts#L6)
224
-
225
- #### :gear: AuthenticationConfigInternetIdentitySchema
226
-
227
- | Constant | Type |
228
- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
229
- | `AuthenticationConfigInternetIdentitySchema` | `ZodObject<{ derivationOrigin: ZodOptional<ZodURL>; externalAlternativeOrigins: ZodOptional<ZodArray<ZodURL>>; }, $strict>` |
230
-
231
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/authentication.config.ts#L6)
232
-
233
- #### :gear: AuthenticationConfigSchema
234
-
235
- | Constant | Type |
236
- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
237
- | `AuthenticationConfigSchema` | `ZodObject<{ internetIdentity: ZodOptional<ZodObject<{ derivationOrigin: ZodOptional<ZodURL>; externalAlternativeOrigins: ZodOptional<ZodArray<ZodURL>>; }, $strict>>; }, $strict>` |
238
-
239
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/authentication.config.ts#L35)
240
-
241
- #### :gear: DatastoreConfigSchema
242
-
243
- | Constant | Type |
244
- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
245
- | `DatastoreConfigSchema` | `ZodObject<{ maxMemorySize: ZodOptional<ZodObject<{ heap: ZodOptional<ZodBigInt>; stable: ZodOptional<ZodBigInt>; }, $strict>>; }, $strict>` |
246
-
247
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/datastore.config.ts#L7)
248
-
249
- #### :gear: SatelliteIdSchema
250
-
251
- | Constant | Type |
252
- | ------------------- | --------------------------------------- |
253
- | `SatelliteIdSchema` | `ZodObject<{ id: ZodString; }, $strip>` |
254
-
255
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/satellite.config.ts#L16)
256
-
257
- #### :gear: SatelliteIdsSchema
258
-
259
- | Constant | Type |
260
- | -------------------- | ------------------------------------------------------------------------------------------------------------- |
261
- | `SatelliteIdsSchema` | `ZodObject<{ ids: ZodRecord<ZodUnion<readonly [ZodLiteral<"production">, ZodString]>, ZodString>; }, $strip>` |
262
-
263
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/satellite.config.ts#L35)
264
-
265
- #### :gear: SatelliteConfigOptionsSchema
266
-
267
- | Constant | Type |
268
- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
269
- | `SatelliteConfigOptionsSchema` | `ZodUnion<readonly [ZodObject<{ storage: ZodOptional<ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 4 more ...; maxMemorySize: ZodOptional<...>; }, $strip>>; ... 4 more ...; id: ZodString; }, $strict>, ZodObject<.....` |
270
-
271
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/satellite.config.ts#L70)
272
-
273
- #### :gear: JunoConfigSchema
274
-
275
- | Constant | Type |
276
- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
277
- | `JunoConfigSchema` | `ZodObject<{ satellite: ZodUnion<readonly [ZodObject<{ storage: ZodOptional<ZodObject<{ headers: ZodOptional<ZodArray<ZodObject<{ source: ZodString; headers: ZodArray<ZodTuple<[ZodString, ZodString], null>>; }, $strict>>>; ... 4 more ...; maxMemorySize: ZodOptional<...>; }, $strip>>; ... 4 more ...; id: ZodString; },...` |
278
-
279
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/juno.config.ts#L9)
78
+ #### :gear: ModuleLogVisibilitySchema
280
79
 
281
- #### :gear: SatelliteDevDataStoreCollectionSchema
80
+ | Constant | Type |
81
+ | --------------------------- | ------------------------------------------------------------ |
82
+ | `ModuleLogVisibilitySchema` | `ZodEnum<{ controllers: "controllers"; public: "public"; }>` |
282
83
 
283
- | Constant | Type |
284
- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
285
- | `SatelliteDevDataStoreCollectionSchema` | `ZodObject<{ collection: ZodString; read: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; write: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; ... 4 more ...; maxTokens: ZodOptional<...>; }, $strict>` |
84
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/module/module.settings.ts#L6)
286
85
 
287
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L8)
86
+ #### :gear: ModuleSettingsSchema
288
87
 
289
- #### :gear: SatelliteDevStorageCollectionSchema
88
+ | Constant | Type |
89
+ | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
90
+ | `ModuleSettingsSchema` | `ZodObject<{ freezingThreshold: ZodOptional<ZodBigInt>; reservedCyclesLimit: ZodOptional<ZodBigInt>; logVisibility: ZodOptional<ZodEnum<{ controllers: "controllers"; public: "public"; }>>; heapMemoryLimit: ZodOptional<...>; memoryAllocation: ZodOptional<...>; computeAllocation: ZodOptional<...>; }, $strict>` |
290
91
 
291
- | Constant | Type |
292
- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
293
- | `SatelliteDevStorageCollectionSchema` | `ZodObject<{ collection: ZodString; read: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; write: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; ... 4 more ...; maxTokens: ZodOptional<...>; }, $strict>` |
92
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/module/module.settings.ts#L21)
294
93
 
295
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L27)
94
+ #### :gear: JunoConfigModeSchema
296
95
 
297
- #### :gear: SatelliteDevCollectionsSchema
96
+ | Constant | Type |
97
+ | ---------------------- | ---------------------------------------------------------- |
98
+ | `JunoConfigModeSchema` | `ZodUnion<readonly [ZodLiteral<"production">, ZodString]>` |
298
99
 
299
- | Constant | Type |
300
- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
301
- | `SatelliteDevCollectionsSchema` | `ZodObject<{ datastore: ZodOptional<ZodArray<ZodObject<{ collection: ZodString; read: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; write: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; ... 4 more ...; maxTokens...` |
100
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L6)
302
101
 
303
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L46)
102
+ #### :gear: JunoConfigEnvSchema
304
103
 
305
- #### :gear: SatelliteDevControllerSchema
104
+ | Constant | Type |
105
+ | --------------------- | ---------------------------------------------------------------------------------------- |
106
+ | `JunoConfigEnvSchema` | `ZodObject<{ mode: ZodUnion<readonly [ZodLiteral<"production">, ZodString]>; }, $strip>` |
306
107
 
307
- | Constant | Type |
308
- | ------------------------------ | --------------------------------------------------------------------------------------------------------------- |
309
- | `SatelliteDevControllerSchema` | `ZodObject<{ id: ZodString; scope: ZodEnum<{ admin: "admin"; write: "write"; submit: "submit"; }>; }, $strict>` |
108
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L17)
310
109
 
311
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L74)
110
+ #### :gear: EncodingTypeSchema
312
111
 
313
- #### :gear: SatelliteDevConfigSchema
112
+ see EncodingType
314
113
 
315
- | Constant | Type |
316
- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
317
- | `SatelliteDevConfigSchema` | `ZodObject<{ collections: ZodObject<{ datastore: ZodOptional<ZodArray<ZodObject<{ collection: ZodString; read: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; ... 5 more ...; maxTokens: ZodOptional<...>; }, $strict>>>; storage: ZodOptional<...>; }, $strict>; control...` |
114
+ | Constant | Type |
115
+ | -------------------- | ------------------------------------------------------------------------------------------------------ |
116
+ | `EncodingTypeSchema` | `ZodEnum<{ identity: "identity"; gzip: "gzip"; compress: "compress"; deflate: "deflate"; br: "br"; }>` |
318
117
 
319
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L100)
118
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L6)
320
119
 
321
- #### :gear: JunoDevConfigSchema
120
+ #### :gear: CliConfigSchema
322
121
 
323
- | Constant | Type |
324
- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
325
- | `JunoDevConfigSchema` | `ZodObject<{ satellite: ZodObject<{ collections: ZodObject<{ datastore: ZodOptional<ZodArray<ZodObject<{ collection: ZodString; read: ZodEnum<{ controllers: "controllers"; public: "public"; private: "private"; managed: "managed"; }>; ... 5 more ...; maxTokens: ZodOptional<...>; }, $strict>>>; storage: ZodOptional<......` |
122
+ | Constant | Type |
123
+ | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
124
+ | `CliConfigSchema` | `ZodObject<{ source: ZodOptional<ZodString>; ignore: ZodOptional<ZodArray<ZodString>>; gzip: ZodOptional<ZodUnion<readonly [ZodString, ZodLiteral<...>]>>; encoding: ZodOptional<...>; predeploy: ZodOptional<...>; postdeploy: ZodOptional<...>; }, $strict>` |
326
125
 
327
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L127)
126
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/cli.config.ts#L7)
328
127
 
329
128
  ### :tropical_drink: Interfaces
330
129
 
331
- - [EmulatorPorts](#gear-emulatorports)
332
- - [EmulatorSkylab](#gear-emulatorskylab)
333
- - [EmulatorConsole](#gear-emulatorconsole)
334
- - [EmulatorSatellite](#gear-emulatorsatellite)
335
- - [EmulatorRunner](#gear-emulatorrunner)
336
- - [JunoConfigEnv](#gear-junoconfigenv)
337
- - [OrbiterId](#gear-orbiterid)
338
- - [OrbiterIds](#gear-orbiterids)
339
- - [ModuleSettings](#gear-modulesettings)
340
130
  - [MaxMemorySizeConfig](#gear-maxmemorysizeconfig)
341
131
  - [StorageConfigHeader](#gear-storageconfigheader)
342
132
  - [StorageConfigRewrite](#gear-storageconfigrewrite)
343
133
  - [StorageConfigRedirect](#gear-storageconfigredirect)
344
134
  - [StorageConfig](#gear-storageconfig)
135
+ - [ModuleSettings](#gear-modulesettings)
136
+ - [JunoConfigEnv](#gear-junoconfigenv)
345
137
  - [CliConfig](#gear-cliconfig)
346
- - [SatelliteAssertions](#gear-satelliteassertions)
347
- - [AuthenticationConfigInternetIdentity](#gear-authenticationconfiginternetidentity)
348
- - [AuthenticationConfig](#gear-authenticationconfig)
349
- - [DatastoreConfig](#gear-datastoreconfig)
350
- - [SatelliteId](#gear-satelliteid)
351
- - [SatelliteIds](#gear-satelliteids)
352
- - [SatelliteConfigOptions](#gear-satelliteconfigoptions)
353
- - [JunoConfig](#gear-junoconfig)
354
- - [SatelliteDevCollections](#gear-satellitedevcollections)
355
- - [SatelliteDevController](#gear-satellitedevcontroller)
356
- - [SatelliteDevConfig](#gear-satellitedevconfig)
357
- - [JunoDevConfig](#gear-junodevconfig)
358
-
359
- #### :gear: EmulatorPorts
360
-
361
- Represents the ports exposed by an emulator container.
362
-
363
- | Property | Type | Description |
364
- | -------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
365
- | `server` | `number or undefined` | The port of the server used to simulate execution. This is the port your app connects to. Also known as the "local Internet Computer replica" or the "Pocket-IC port". default: 5987 |
366
- | `admin` | `number or undefined` | The port of the admin server used for tasks like transferring ICP from the ledger. default: 5999 |
367
-
368
- #### :gear: EmulatorSkylab
369
-
370
- Configuration for the Skylab emulator.
371
-
372
- | Property | Type | Description |
373
- | -------- | ------------------------------------------------------- | -------------------------------------- |
374
- | `ports` | `(EmulatorPorts and { console: number; }) or undefined` | Ports exposed by the Skylab container. |
375
-
376
- #### :gear: EmulatorConsole
377
-
378
- Configuration for the Console emulator.
379
-
380
- | Property | Type | Description |
381
- | -------- | ---------------------------- | --------------------------------------- |
382
- | `ports` | `EmulatorPorts or undefined` | Ports exposed by the Console container. |
383
-
384
- #### :gear: EmulatorSatellite
385
-
386
- Configuration for the Satellite emulator.
387
-
388
- | Property | Type | Description |
389
- | -------- | ---------------------------- | ----------------------------------------- |
390
- | `ports` | `EmulatorPorts or undefined` | Ports exposed by the Satellite container. |
391
-
392
- #### :gear: EmulatorRunner
393
-
394
- Shared options for all runner variants.
395
-
396
- | Property | Type | Description |
397
- | ---------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
398
- | `type` | `"docker" or "podman"` | The containerization tool to run the emulator. |
399
- | `image` | `string or undefined` | Image reference. default: depends on emulator type, e.g. "junobuild/skylab:latest" |
400
- | `name` | `string or undefined` | Optional container name to use for the emulator. Useful for reusing or managing a specific container. |
401
- | `volume` | `string or undefined` | Persistent volume to store internal state. default: "juno" |
402
- | `target` | `string or undefined` | Shared folder for deploying and hot-reloading serverless functions. |
403
- | `platform` | `"linux/amd64" or "linux/arm64" or undefined` | The platform to use when running the emulator container. |
404
-
405
- #### :gear: JunoConfigEnv
406
-
407
- Represents the environment configuration for Juno.
408
-
409
- | Property | Type | Description |
410
- | -------- | -------- | ---------------------------------------------------------- |
411
- | `mode` | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
412
-
413
- #### :gear: OrbiterId
414
-
415
- Represents the configuration for an orbiter.
416
-
417
- | Property | Type | Description |
418
- | -------- | -------- | -------------------------------------------------------------- |
419
- | `id` | `string` | The identifier of the orbiter used in the dApp. type: {string} |
420
-
421
- #### :gear: OrbiterIds
422
-
423
- Represents a mapping of orbiter identitifiers to different configurations based on the mode of the application.
424
-
425
- | Property | Type | Description |
426
- | -------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
427
- | `ids` | `Record<string, string>` | A mapping of orbiter identifiers (IDs) to different configurations based on the mode of the application. This allows the application to use different orbiter IDs, such as production, development, etc. Example: { "production": "xo2hm-lqaaa-aaaal-ab3oa-cai", "development": "gl6nx-5maaa-aaaaa-qaaqq-cai" } type: {Record<JunoConfigMode, string>} |
428
-
429
- #### :gear: ModuleSettings
430
-
431
- Settings for a module - Satellite, Mission Control or Orbiter.
432
-
433
- These settings control various aspects of the module's behavior and resource usage.
434
-
435
- | Property | Type | Description |
436
- | --------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
437
- | `freezingThreshold` | `bigint or undefined` | The cycle threshold below which the module will automatically stop to avoid running out of cycles. For example, if set to `BigInt(1000000)`, the module will stop when it has fewer than 1,000,000 cycles remaining. type: {bigint} |
438
- | `reservedCyclesLimit` | `bigint or undefined` | The number of cycles reserved for the module's operations to ensure it has enough cycles to function. For example, setting it to `BigInt(5000000)` reserves 5,000,000 cycles for the module. type: {bigint} |
439
- | `logVisibility` | `ModuleLogVisibility or undefined` | Controls who can see the module's logs. type: {ModuleLogVisibility} |
440
- | `heapMemoryLimit` | `bigint or undefined` | The maximum amount of WebAssembly (Wasm) memory the module can use on the heap. For example, setting it to `BigInt(1024 * 1024 * 64)` allows the module to use up to 64 MB of Wasm memory. type: {bigint} |
441
- | `memoryAllocation` | `bigint or undefined` | The amount of memory explicitly allocated to the module. For example, setting it to `BigInt(1024 * 1024 * 128)` allocates 128 MB of memory to the module. type: {bigint} |
442
- | `computeAllocation` | `bigint or undefined` | The proportion of compute capacity allocated to the module. This is a fraction of the total compute capacity of the subnet. For example, setting it to `BigInt(10)` allocates 10% of the compute capacity to the module. type: {bigint} |
443
138
 
444
139
  #### :gear: MaxMemorySizeConfig
445
140
 
@@ -494,6 +189,30 @@ Configures the hosting behavior of the Storage.
494
189
  | `iframe` | `"deny" or "same-origin" or "allow-any" or undefined` | For security reasons and to prevent click-jacking attacks, dapps deployed with Juno are, by default, set to deny embedding in other sites. Options are: - `deny`: Prevents any content from being displayed in an iframe. - `same-origin`: Allows iframe content from the same origin as the page. - `allow-any`: Allows iframe content from any origin. If not specified, then `deny` is used as default value. type: {'deny' or 'same-origin' or 'allow-any'}optional |
495
190
  | `rawAccess` | `boolean or undefined` | Optional flag to enable access for raw URLs. ⚠️ **WARNING: Enabling this option is highly discouraged due to security risks.** Enabling this option allows access to raw URLs (e.g., https://satellite-id.raw.icp0.io), bypassing certificate validation. This creates a security vulnerability where a malicious node in the chain can respond to requests with malicious or invalid content. Since there is no validation on raw URLs, the client may receive and process harmful data. If not specified, the default value is `false`. type: {boolean}optional |
496
191
  | `maxMemorySize` | `MaxMemorySizeConfig or undefined` | Configuration for maximum memory size limits for the Storage. This is used to specify optional limits on heap and stable memory for the smart contract. When the limit is reached, the Storage and smart contract continue to operate normally but reject the upload of new assets. If not specified, no memory limits are enforced. type: {MaxMemorySizeConfig}optional |
192
+ | `version` | `bigint or undefined` | The current version of the config. Optional. The CLI will automatically resolve the version and warn you if there's a potential overwrite. You can provide it if you want to manage versioning manually within your config file. type: {bigint}optional |
193
+
194
+ #### :gear: ModuleSettings
195
+
196
+ Settings for a module - Satellite, Mission Control or Orbiter.
197
+
198
+ These settings control various aspects of the module's behavior and resource usage.
199
+
200
+ | Property | Type | Description |
201
+ | --------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
202
+ | `freezingThreshold` | `bigint or undefined` | The cycle threshold below which the module will automatically stop to avoid running out of cycles. For example, if set to `BigInt(1000000)`, the module will stop when it has fewer than 1,000,000 cycles remaining. type: {bigint} |
203
+ | `reservedCyclesLimit` | `bigint or undefined` | The number of cycles reserved for the module's operations to ensure it has enough cycles to function. For example, setting it to `BigInt(5000000)` reserves 5,000,000 cycles for the module. type: {bigint} |
204
+ | `logVisibility` | `ModuleLogVisibility or undefined` | Controls who can see the module's logs. type: {ModuleLogVisibility} |
205
+ | `heapMemoryLimit` | `bigint or undefined` | The maximum amount of WebAssembly (Wasm) memory the module can use on the heap. For example, setting it to `BigInt(1024 * 1024 * 64)` allows the module to use up to 64 MB of Wasm memory. type: {bigint} |
206
+ | `memoryAllocation` | `bigint or undefined` | The amount of memory explicitly allocated to the module. For example, setting it to `BigInt(1024 * 1024 * 128)` allocates 128 MB of memory to the module. type: {bigint} |
207
+ | `computeAllocation` | `bigint or undefined` | The proportion of compute capacity allocated to the module. This is a fraction of the total compute capacity of the subnet. For example, setting it to `BigInt(10)` allocates 10% of the compute capacity to the module. type: {bigint} |
208
+
209
+ #### :gear: JunoConfigEnv
210
+
211
+ Represents the environment configuration for Juno.
212
+
213
+ | Property | Type | Description |
214
+ | -------- | -------- | ---------------------------------------------------------- |
215
+ | `mode` | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
497
216
 
498
217
  #### :gear: CliConfig
499
218
 
@@ -506,156 +225,20 @@ Configures the hosting behavior of the Storage.
506
225
  | `predeploy` | `string[] or undefined` | Defines a list of scripts or commands to be run before the deployment process begins. This can be useful for tasks such as compiling assets, running tests, or building production-ready files. Example: `json { "predeploy": ["npm run build", "npm run lint"] } ` type: {string[]}optional |
507
226
  | `postdeploy` | `string[] or undefined` | Defines a list of scripts or commands to be run after the deployment process completes. This can be used for tasks such as notifications, cleanup, or sending confirmation messages to services or team members. Example: `json { "postdeploy": ["./scripts/notify-admins.sh", "echo 'Deployment complete'"] } ` type: {string[]}optional |
508
227
 
509
- #### :gear: SatelliteAssertions
510
-
511
- Configuration for satellite assertions.
512
-
513
- | Property | Type | Description |
514
- | ------------ | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
515
- | `heapMemory` | `number or boolean or undefined` | Configuration for the heap memory size check, which can be: - `true` to enable the check with a default threshold of 900MB, - `false` to disable the heap memory size check, - A `number` to specify a custom threshold in MB (megabytes) for the heap memory size check. If not specified, then `true` is used as the default value. type: {number or boolean} |
516
-
517
- #### :gear: AuthenticationConfigInternetIdentity
518
-
519
- Configure the behavior of Internet Identity.
520
-
521
- | Property | Type | Description |
522
- | ---------------------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
523
- | `derivationOrigin` | `string or undefined` | This setting ensures that users are recognized on your app, regardless of whether they use the default URL or any other custom domain. For example, if set to hello.com, a user signing on at https://hello.com will receive the same identifier (principal) as when signing on at https://www.hello.com. type: {string}optional |
524
- | `externalAlternativeOrigins` | `string[] or undefined` | An optional list of external alternative origins allowed for authentication, which can be useful if you want to reuse the same derivation origin across multiple Satellites. type: {string[]}optional |
525
-
526
- #### :gear: AuthenticationConfig
527
-
528
- Configures the Authentication options of a Satellite.
529
-
530
- | Property | Type | Description |
531
- | ------------------ | --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
532
- | `internetIdentity` | `AuthenticationConfigInternetIdentity or undefined` | Optional configuration of Internet Identity authentication method. type: {AuthenticationConfigInternetIdentity}optional |
533
-
534
- #### :gear: DatastoreConfig
535
-
536
- Configures the behavior of the Datastore.
537
-
538
- | Property | Type | Description |
539
- | --------------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
540
- | `maxMemorySize` | `MaxMemorySizeConfig or undefined` | Configuration for maximum memory size limits for the Datastore. This is used to specify optional limits on heap and stable memory for the smart contract. When the limit is reached, the Datastore and smart contract continue to operate normally but reject the creation or updates of documents. If not specified, no memory limits are enforced. type: {MaxMemorySizeConfig}optional |
541
-
542
- #### :gear: SatelliteId
543
-
544
- Represents the unique identifier for a satellite.
545
-
546
- | Property | Type | Description |
547
- | -------- | -------- | -------------------------------------------------------------------------------- |
548
- | `id` | `string` | The unique identifier (ID) of the satellite for this application. type: {string} |
549
-
550
- #### :gear: SatelliteIds
551
-
552
- Represents a mapping of satellite identifiers to different configurations based on the mode of the application.
553
-
554
- | Property | Type | Description |
555
- | -------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
556
- | `ids` | `Record<string, string>` | A mapping of satellite identifiers (IDs) to different configurations based on the mode of the application. This allows the application to use different satellite IDs, such as production, staging, etc. Example: { "production": "xo2hm-lqaaa-aaaal-ab3oa-cai", "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai" } type: {Record<JunoConfigMode, string>} |
557
-
558
- #### :gear: SatelliteConfigOptions
559
-
560
- SatelliteConfigOptions interface provides configuration settings that allow for fine-tuning
561
- the operational behavior of various aspects of a Satellite, such as storage, datastore,
562
- authentication, and deployment assertions.
563
-
564
- These options affect specific modules of the Satellite and may require manual application of
565
- changes, typically through CLI commands (e.g., `juno config`).
566
-
567
- | Property | Type | Description |
568
- | ---------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
569
- | `storage` | `StorageConfig or undefined` | Optional configuration parameters for the satellite, affecting the operational behavior of its Storage. Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands. type: {StorageConfig}optional |
570
- | `datastore` | `DatastoreConfig or undefined` | Optional configuration parameters for the satellite, affecting the operational behavior of its Datastore. Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands. type: {DatastoreConfig}optional |
571
- | `authentication` | `AuthenticationConfig or undefined` | Optional configuration parameters for the satellite, affecting the operational behavior of its Authentication. Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands. type: {AuthenticationConfig}optional |
572
- | `assertions` | `SatelliteAssertions or undefined` | Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions. type: {SatelliteAssertions}optional |
573
- | `settings` | `ModuleSettings or undefined` | Optional configuration parameters for the Satellite. These settings control various aspects of the module's behavior and resource usage. type: {ModuleSettings}optional |
574
-
575
- #### :gear: JunoConfig
576
-
577
- Represents the overall configuration for Juno.
578
-
579
- | Property | Type | Description |
580
- | ----------- | ----------------------------- | ------------------------------------------------------------------------- |
581
- | `satellite` | `SatelliteConfig` | The configuration for the satellite. type: {SatelliteConfig} |
582
- | `orbiter` | `OrbiterConfig or undefined` | The optional configuration for the orbiter. type: {OrbiterConfig}optional |
583
- | `emulator` | `EmulatorConfig or undefined` | Your options for the emulator. |
584
-
585
- #### :gear: SatelliteDevCollections
586
-
587
- Represents the collections configuration for a satellite in a development environment.
588
-
589
- | Property | Type | Description |
590
- | ----------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------ |
591
- | `datastore` | `SatelliteDevDataStoreCollection[] or undefined` | The Datastore collections configuration. type: {SatelliteDevDataStoreCollection[]}optional |
592
- | `storage` | `SatelliteDevStorageCollection[] or undefined` | The Storage collections configuration. type: {SatelliteDevStorageCollection[]}optional |
593
-
594
- #### :gear: SatelliteDevController
595
-
596
- Represents a controller configuration for a satellite in a development environment.
597
-
598
- | Property | Type | Description |
599
- | -------- | -------------------------------- | --------------------------------------------------------------------- |
600
- | `id` | `string` | The unique identifier of the controller. type: {string} |
601
- | `scope` | `"admin" or "write" or "submit"` | The scope of the controller's permissions. type: {'write' or 'admin'} |
602
-
603
- #### :gear: SatelliteDevConfig
604
-
605
- Represents the development configuration for a satellite.
606
-
607
- | Property | Type | Description |
608
- | ------------- | --------------------------------------- | -------------------------------------------------------------------------------- |
609
- | `collections` | `SatelliteDevCollections` | The collections configuration. type: {SatelliteDevCollections} |
610
- | `controllers` | `SatelliteDevController[] or undefined` | The optional controllers configuration. type: {SatelliteDevController[]}optional |
611
-
612
- #### :gear: JunoDevConfig
613
-
614
- Represents the development configuration for Juno.
615
-
616
- | Property | Type | Description |
617
- | ----------- | -------------------- | --------------------------------------------------------------------------- |
618
- | `satellite` | `SatelliteDevConfig` | The development configuration for the satellite. type: {SatelliteDevConfig} |
619
-
620
228
  ### :cocktail: Types
621
229
 
622
- - [EmulatorConfig](#gear-emulatorconfig)
623
- - [JunoConfigMode](#gear-junoconfigmode)
624
- - [OrbiterConfig](#gear-orbiterconfig)
625
- - [ModuleLogVisibility](#gear-modulelogvisibility)
626
230
  - [StorageConfigSourceGlob](#gear-storageconfigsourceglob)
231
+ - [ModuleLogVisibility](#gear-modulelogvisibility)
232
+ - [JunoConfigMode](#gear-junoconfigmode)
627
233
  - [EncodingType](#gear-encodingtype)
628
- - [SatelliteConfig](#gear-satelliteconfig)
629
- - [SatelliteDevDataStoreCollection](#gear-satellitedevdatastorecollection)
630
- - [SatelliteDevStorageCollection](#gear-satellitedevstoragecollection)
631
- - [JunoDevConfigFn](#gear-junodevconfigfn)
632
- - [JunoDevConfigFnOrObject](#gear-junodevconfigfnorobject)
633
-
634
- #### :gear: EmulatorConfig
635
-
636
- The configuration for running the Juno emulator.
637
-
638
- | Type | Type |
639
- | ---------------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
640
- | `EmulatorConfig` | ` | {runner?: EmulatorRunner; skylab: EmulatorSkylab} or {runner?: EmulatorRunner; console: EmulatorConsole} or {runner?: EmulatorRunner; satellite: EmulatorSatellite}` |
641
-
642
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/emulator.config.ts#L169)
643
-
644
- #### :gear: JunoConfigMode
645
234
 
646
- | Type | Type |
647
- | ---------------- | ------------------------ |
648
- | `JunoConfigMode` | `'production' or string` |
649
-
650
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L12)
651
-
652
- #### :gear: OrbiterConfig
235
+ #### :gear: StorageConfigSourceGlob
653
236
 
654
- | Type | Type |
655
- | --------------- | ------------------------------- |
656
- | `OrbiterConfig` | `Either<OrbiterId, OrbiterIds>` |
237
+ | Type | Type |
238
+ | ------------------------- | ---- |
239
+ | `StorageConfigSourceGlob` | |
657
240
 
658
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/orbiter.config.ts#L64)
241
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/shared/storage.config.ts#L13)
659
242
 
660
243
  #### :gear: ModuleLogVisibility
661
244
 
@@ -665,13 +248,13 @@ The configuration for running the Juno emulator.
665
248
 
666
249
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/module/module.settings.ts#L16)
667
250
 
668
- #### :gear: StorageConfigSourceGlob
251
+ #### :gear: JunoConfigMode
669
252
 
670
- | Type | Type |
671
- | ------------------------- | ---- |
672
- | `StorageConfigSourceGlob` | |
253
+ | Type | Type |
254
+ | ---------------- | ------------------------ |
255
+ | `JunoConfigMode` | `'production' or string` |
673
256
 
674
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/shared/storage.config.ts#L13)
257
+ [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L12)
675
258
 
676
259
  #### :gear: EncodingType
677
260
 
@@ -681,46 +264,6 @@ The configuration for running the Juno emulator.
681
264
 
682
265
  [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L12)
683
266
 
684
- #### :gear: SatelliteConfig
685
-
686
- | Type | Type |
687
- | ----------------- | ---------------------------------------------------------------------------- |
688
- | `SatelliteConfig` | `Either<SatelliteId, SatelliteIds> and CliConfig and SatelliteConfigOptions` |
689
-
690
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/satellite.config.ts#L150)
691
-
692
- #### :gear: SatelliteDevDataStoreCollection
693
-
694
- | Type | Type |
695
- | --------------------------------- | -------------------------------------------------------------------- |
696
- | `SatelliteDevDataStoreCollection` | `Omit< Rule, 'createdAt' or 'updatedAt' or 'maxSize' or 'version' >` |
697
-
698
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L19)
699
-
700
- #### :gear: SatelliteDevStorageCollection
701
-
702
- | Type | Type |
703
- | ------------------------------- | ------------------------------------------------------------------------ |
704
- | `SatelliteDevStorageCollection` | `Omit< Rule, 'createdAt' or 'updatedAt' or 'maxCapacity' or 'version' >` |
705
-
706
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L38)
707
-
708
- #### :gear: JunoDevConfigFn
709
-
710
- | Type | Type |
711
- | ----------------- | --------------------- |
712
- | `JunoDevConfigFn` | `() => JunoDevConfig` |
713
-
714
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L3)
715
-
716
- #### :gear: JunoDevConfigFnOrObject
717
-
718
- | Type | Type |
719
- | ------------------------- | ---------------------------------- |
720
- | `JunoDevConfigFnOrObject` | `JunoDevConfig or JunoDevConfigFn` |
721
-
722
- [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/config.ts#L5)
723
-
724
267
  <!-- TSDOC_END -->
725
268
 
726
269
  ## License