@junobuild/config 0.1.6 → 0.1.7

package/README.md

@@ -53,7 +53,9 @@ Configuration options for [Juno] CLI.
 
 ### :tropical_drink: Interfaces
 
-- [OrbiterConfig](#gear-orbiterconfig)
+- [JunoConfigEnv](#gear-junoconfigenv)
+- [OrbiterId](#gear-orbiterid)
+- [OrbiterIds](#gear-orbiterids)
 - [ModuleSettings](#gear-modulesettings)
 - [MaxMemorySizeConfig](#gear-maxmemorysizeconfig)
 - [StorageConfigHeader](#gear-storageconfigheader)
@@ -61,7 +63,6 @@ Configuration options for [Juno] CLI.
 - [StorageConfigRedirect](#gear-storageconfigredirect)
 - [StorageConfig](#gear-storageconfig)
 - [CliConfig](#gear-cliconfig)
-- [JunoConfigEnv](#gear-junoconfigenv)
 - [SatelliteAssertions](#gear-satelliteassertions)
 - [AuthenticationConfigInternetIdentity](#gear-authenticationconfiginternetidentity)
 - [AuthenticationConfig](#gear-authenticationconfig)
@@ -75,7 +76,15 @@ Configuration options for [Juno] CLI.
 - [SatelliteDevConfig](#gear-satellitedevconfig)
 - [JunoDevConfig](#gear-junodevconfig)
 
-#### :gear: OrbiterConfig
+#### :gear: JunoConfigEnv
+
+Represents the environment configuration for Juno.
+
+| Property | Type     | Description                                                |
+| -------- | -------- | ---------------------------------------------------------- |
+| `mode`   | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
+
+#### :gear: OrbiterId
 
 Represents the configuration for an orbiter.
 
@@ -84,6 +93,14 @@ Represents the configuration for an orbiter.
 | `id`        | `string`              | The identifier of the orbiter used in the dApp. type: {string}                                                                   |
 | `orbiterId` | `string or undefined` | The deprecated identifier of the orbiter. deprecated: `orbiterId` will be removed in the future. Use `id` instead.type: {string} |
 
+#### :gear: OrbiterIds
+
+Represents a mapping of orbiter identitifiers to different configurations based on the mode of the application.
+
+| Property | Type                     | Description                                                                                                                                                                                                                                                                                                                                            |
+| -------- | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `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>} |
+
 #### :gear: ModuleSettings
 
 Settings for a module - Satellite, Mission Control or Orbiter.
@@ -164,14 +181,6 @@ Configures the hosting behavior of the Storage.
 | `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                                                                                                   |
 | `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                                                      |
 
-#### :gear: JunoConfigEnv
-
-Represents the environment configuration for Juno.
-
-| Property | Type     | Description                                                |
-| -------- | -------- | ---------------------------------------------------------- |
-| `mode`   | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
-
 #### :gear: SatelliteAssertions
 
 Configuration for satellite assertions.
@@ -243,10 +252,10 @@ changes, typically through CLI commands (e.g., `juno config`).
 
 Represents the overall configuration for Juno.
 
-| Property    | Type                         | Description                                                               |
-| ----------- | ---------------------------- | ------------------------------------------------------------------------- |
-| `satellite` | `SatelliteConfig`            | The configuration for the satellite. type: {SatelliteConfig}              |
-| `orbiter`   | `OrbiterConfig or undefined` | The optional configuration for the orbiter. type: {OrbiterConfig}optional |
+| Property    | Type              | Description                                                               |
+| ----------- | ----------------- | ------------------------------------------------------------------------- |
+| `satellite` | `SatelliteConfig` | The configuration for the satellite. type: {SatelliteConfig}              |
+| `orbiter`   | `undefined`       | The optional configuration for the orbiter. type: {OrbiterConfig}optional |
 
 #### :gear: SatelliteDevCollections
 
@@ -286,10 +295,11 @@ Represents the development configuration for Juno.
 
 ### :cocktail: Types
 
+- [JunoConfigMode](#gear-junoconfigmode)
+- [OrbiterConfig](#gear-orbiterconfig)
 - [ModuleLogVisibility](#gear-modulelogvisibility)
 - [StorageConfigSourceGlob](#gear-storageconfigsourceglob)
 - [ENCODING_TYPE](#gear-encoding_type)
-- [JunoConfigMode](#gear-junoconfigmode)
 - [SatelliteConfig](#gear-satelliteconfig)
 - [SatelliteDevDataStoreCollection](#gear-satellitedevdatastorecollection)
 - [SatelliteDevDbCollection](#gear-satellitedevdbcollection)
@@ -297,6 +307,22 @@ Represents the development configuration for Juno.
 - [JunoDevConfigFn](#gear-junodevconfigfn)
 - [JunoDevConfigFnOrObject](#gear-junodevconfigfnorobject)
 
+#### :gear: JunoConfigMode
+
+| Type             | Type                     |
+| ---------------- | ------------------------ |
+| `JunoConfigMode` | `'production' or string` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L5)
+
+#### :gear: OrbiterConfig
+
+| Type            | Type                           |
+| --------------- | ------------------------------ |
+| `OrbiterConfig` | `Either<OrbiterId, OrbiterId>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/mainnet/configs/orbiter.config.ts#L49)
+
 #### :gear: ModuleLogVisibility
 
 | Type                  | Type                        |
@@ -321,14 +347,6 @@ Represents the development configuration for Juno.
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L5)
 
-#### :gear: JunoConfigMode
-
-| Type             | Type                     |
-| ---------------- | ------------------------ |
-| `JunoConfigMode` | `'production' or string` |
-
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L5)
-
 #### :gear: SatelliteConfig
 
 | Type              | Type                                                                         |

package/dist/types/satellite/mainnet/configs/orbiter.config.d.ts

@@ -1,8 +1,10 @@
+import type { JunoConfigMode } from '../../../types/juno.env';
+import type { Either } from '../../../types/utility.types';
 /**
  * Represents the configuration for an orbiter.
- * @interface OrbiterConfig
+ * @interface OrbiterId
  */
-export interface OrbiterConfig {
+export interface OrbiterId {
     /**
      * The identifier of the orbiter used in the dApp.
      * @type {string}
@@ -15,3 +17,29 @@ export interface OrbiterConfig {
      */
     orbiterId?: string;
 }
+/**
+ * Represents a mapping of orbiter identitifiers to different configurations based on the mode of the application.
+ * @interface OrbiterIds
+ */
+export interface OrbiterIds {
+    /**
+     * 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>}
+     */
+    ids: Record<JunoConfigMode, string>;
+}
+/**
+ * Represents the configuration for an orbiter (analytics).
+ *
+ * @typedef {Either<OrbiterId, OrbiterIds>} OrbiterConfig
+ * @property {OrbiterId | OrbiterIds} OrbiterId or SateOrbiterIdslliteIds - Defines a unique Orbiter or a collection of Orbiters.
+ */
+export type OrbiterConfig = Either<OrbiterId, OrbiterId>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/config",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "Configuration options for Juno CLI",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",