@junobuild/config 0.1.8 → 0.2.0

package/dist/types/satellite/dev/juno.dev.config.d.ts

@@ -1,22 +1,119 @@
-import type { Rule } from '../types/rules';
+import { type PrincipalText } from '@dfinity/zod-schemas';
+import * as z from 'zod/v4';
+import { type Rule } from '../types/rules';
+/**
+ * @see SatelliteDevDataStoreCollection
+ */
+export declare const SatelliteDevDataStoreCollectionSchema: z.ZodObject<{
+    collection: z.ZodString;
+    read: z.ZodEnum<{
+        controllers: "controllers";
+        public: "public";
+        private: "private";
+        managed: "managed";
+    }>;
+    write: z.ZodEnum<{
+        controllers: "controllers";
+        public: "public";
+        private: "private";
+        managed: "managed";
+    }>;
+    memory: z.ZodEnum<{
+        heap: "heap";
+        stable: "stable";
+    }>;
+    maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+    maxCapacity: z.ZodOptional<z.ZodNumber>;
+    mutablePermissions: z.ZodBoolean;
+    maxTokens: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
 /**
  * Represents a database collection configuration for a satellite in a development environment.
  * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>} SatelliteDevDataStoreCollection
  */
 export type SatelliteDevDataStoreCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>;
 /**
- * This type is an alias for SatelliteDevDataStoreCollection and is now deprecated.
- *
- * @see SatelliteDevDataStoreCollection
- * @deprecated Use {@link SatelliteDevDataStoreCollection} instead.
- * @typedef {SatelliteDevDataStoreCollection} SatelliteDevDbCollection
+ * @see SatelliteDevStorageCollection
  */
-export type SatelliteDevDbCollection = SatelliteDevDataStoreCollection;
+export declare const SatelliteDevStorageCollectionSchema: z.ZodObject<{
+    collection: z.ZodString;
+    read: z.ZodEnum<{
+        controllers: "controllers";
+        public: "public";
+        private: "private";
+        managed: "managed";
+    }>;
+    write: z.ZodEnum<{
+        controllers: "controllers";
+        public: "public";
+        private: "private";
+        managed: "managed";
+    }>;
+    memory: z.ZodEnum<{
+        heap: "heap";
+        stable: "stable";
+    }>;
+    maxSize: z.ZodOptional<z.ZodNumber>;
+    maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+    mutablePermissions: z.ZodBoolean;
+    maxTokens: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
 /**
  * Represents a Storage collection configuration for a satellite in a development environment.
  * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity' | 'version'>} SatelliteDevStorageCollection
  */
 export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity' | 'version'>;
+/**
+ * @see SatelliteDevCollections
+ */
+export declare const SatelliteDevCollectionsSchema: z.ZodObject<{
+    datastore: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        collection: z.ZodString;
+        read: z.ZodEnum<{
+            controllers: "controllers";
+            public: "public";
+            private: "private";
+            managed: "managed";
+        }>;
+        write: z.ZodEnum<{
+            controllers: "controllers";
+            public: "public";
+            private: "private";
+            managed: "managed";
+        }>;
+        memory: z.ZodEnum<{
+            heap: "heap";
+            stable: "stable";
+        }>;
+        maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+        maxCapacity: z.ZodOptional<z.ZodNumber>;
+        mutablePermissions: z.ZodBoolean;
+        maxTokens: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>>;
+    storage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        collection: z.ZodString;
+        read: z.ZodEnum<{
+            controllers: "controllers";
+            public: "public";
+            private: "private";
+            managed: "managed";
+        }>;
+        write: z.ZodEnum<{
+            controllers: "controllers";
+            public: "public";
+            private: "private";
+            managed: "managed";
+        }>;
+        memory: z.ZodEnum<{
+            heap: "heap";
+            stable: "stable";
+        }>;
+        maxSize: z.ZodOptional<z.ZodNumber>;
+        maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+        mutablePermissions: z.ZodBoolean;
+        maxTokens: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
 /**
  * Represents the collections configuration for a satellite in a development environment.
  * @interface SatelliteDevCollections
@@ -28,14 +125,6 @@ export interface SatelliteDevCollections {
      * @optional
      */
     datastore?: SatelliteDevDataStoreCollection[];
-    /**
-     * The Datastore collections configuration.
-     * This property is deprecated. Use {@link datastore} instead.
-     *
-     * @deprecated
-     * @type {SatelliteDevDbCollection[]}
-     */
-    db?: SatelliteDevDbCollection[];
     /**
      * The Storage collections configuration.
      * @type {SatelliteDevStorageCollection[]}
@@ -43,6 +132,17 @@ export interface SatelliteDevCollections {
      */
     storage?: SatelliteDevStorageCollection[];
 }
+/**
+ * @see SatelliteDevController
+ */
+export declare const SatelliteDevControllerSchema: z.ZodObject<{
+    id: z.ZodString;
+    scope: z.ZodEnum<{
+        write: "write";
+        admin: "admin";
+        submit: "submit";
+    }>;
+}, z.core.$strict>;
 /**
  * Represents a controller configuration for a satellite in a development environment.
  * @interface SatelliteDevController
@@ -52,13 +152,74 @@ export interface SatelliteDevController {
      * The unique identifier of the controller.
      * @type {string}
      */
-    id: string;
+    id: PrincipalText;
     /**
      * The scope of the controller's permissions.
      * @type {'write' | 'admin'}
      */
-    scope: 'write' | 'admin';
+    scope: 'write' | 'admin' | 'submit';
 }
+/**
+ * @see SatelliteDevConfig
+ */
+export declare const SatelliteDevConfigSchema: z.ZodObject<{
+    collections: z.ZodObject<{
+        datastore: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            collection: z.ZodString;
+            read: z.ZodEnum<{
+                controllers: "controllers";
+                public: "public";
+                private: "private";
+                managed: "managed";
+            }>;
+            write: z.ZodEnum<{
+                controllers: "controllers";
+                public: "public";
+                private: "private";
+                managed: "managed";
+            }>;
+            memory: z.ZodEnum<{
+                heap: "heap";
+                stable: "stable";
+            }>;
+            maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+            maxCapacity: z.ZodOptional<z.ZodNumber>;
+            mutablePermissions: z.ZodBoolean;
+            maxTokens: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>>;
+        storage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            collection: z.ZodString;
+            read: z.ZodEnum<{
+                controllers: "controllers";
+                public: "public";
+                private: "private";
+                managed: "managed";
+            }>;
+            write: z.ZodEnum<{
+                controllers: "controllers";
+                public: "public";
+                private: "private";
+                managed: "managed";
+            }>;
+            memory: z.ZodEnum<{
+                heap: "heap";
+                stable: "stable";
+            }>;
+            maxSize: z.ZodOptional<z.ZodNumber>;
+            maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+            mutablePermissions: z.ZodBoolean;
+            maxTokens: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+    controllers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        scope: z.ZodEnum<{
+            write: "write";
+            admin: "admin";
+            submit: "submit";
+        }>;
+    }, z.core.$strict>>>;
+}, z.core.$strict>;
 /**
  * Represents the development configuration for a satellite.
  * @interface SatelliteDevConfig
@@ -76,6 +237,69 @@ export interface SatelliteDevConfig {
      */
     controllers?: SatelliteDevController[];
 }
+/**
+ * @see JunoDevConfig
+ */
+export declare const JunoDevConfigSchema: z.ZodObject<{
+    satellite: z.ZodObject<{
+        collections: z.ZodObject<{
+            datastore: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                collection: z.ZodString;
+                read: z.ZodEnum<{
+                    controllers: "controllers";
+                    public: "public";
+                    private: "private";
+                    managed: "managed";
+                }>;
+                write: z.ZodEnum<{
+                    controllers: "controllers";
+                    public: "public";
+                    private: "private";
+                    managed: "managed";
+                }>;
+                memory: z.ZodEnum<{
+                    heap: "heap";
+                    stable: "stable";
+                }>;
+                maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+                maxCapacity: z.ZodOptional<z.ZodNumber>;
+                mutablePermissions: z.ZodBoolean;
+                maxTokens: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>>;
+            storage: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                collection: z.ZodString;
+                read: z.ZodEnum<{
+                    controllers: "controllers";
+                    public: "public";
+                    private: "private";
+                    managed: "managed";
+                }>;
+                write: z.ZodEnum<{
+                    controllers: "controllers";
+                    public: "public";
+                    private: "private";
+                    managed: "managed";
+                }>;
+                memory: z.ZodEnum<{
+                    heap: "heap";
+                    stable: "stable";
+                }>;
+                maxSize: z.ZodOptional<z.ZodNumber>;
+                maxChangesPerUser: z.ZodOptional<z.ZodNumber>;
+                mutablePermissions: z.ZodBoolean;
+                maxTokens: z.ZodOptional<z.ZodNumber>;
+            }, z.core.$strict>>>;
+        }, z.core.$strict>;
+        controllers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            scope: z.ZodEnum<{
+                write: "write";
+                admin: "admin";
+                submit: "submit";
+            }>;
+        }, z.core.$strict>>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
 /**
  * Represents the development configuration for Juno.
  * @interface JunoDevConfig

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

@@ -1,3 +1,10 @@
+import * as z from 'zod/v4';
+/**
+ * @see SatelliteAssertions
+ */
+export declare const SatelliteAssertionsSchema: z.ZodObject<{
+    heapMemory: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodBoolean]>>;
+}, z.core.$strict>;
 /**
  * Configuration for satellite assertions.
  * @interface SatelliteAssertions

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

@@ -1,3 +1,11 @@
+import * as z from 'zod/v4';
+/**
+ * @see AuthenticationConfigInternetIdentity
+ */
+export declare const AuthenticationConfigInternetIdentitySchema: z.ZodObject<{
+    derivationOrigin: z.ZodOptional<z.ZodURL>;
+    externalAlternativeOrigins: z.ZodOptional<z.ZodArray<z.ZodURL>>;
+}, z.core.$strict>;
 /**
  * Configure the behavior of Internet Identity.
  * @interface AuthenticationConfigInternetIdentity
@@ -17,6 +25,15 @@ export interface AuthenticationConfigInternetIdentity {
      */
     externalAlternativeOrigins?: string[];
 }
+/**
+ * @see AuthenticationConfig
+ */
+export declare const AuthenticationConfigSchema: z.ZodObject<{
+    internetIdentity: z.ZodOptional<z.ZodObject<{
+        derivationOrigin: z.ZodOptional<z.ZodURL>;
+        externalAlternativeOrigins: z.ZodOptional<z.ZodArray<z.ZodURL>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
 /**
  * Configures the Authentication options of a Satellite.
  * @interface AuthenticationConfig

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

@@ -1,4 +1,14 @@
-import type { MaxMemorySizeConfig } from '../../../shared/feature.config';
+import * as z from 'zod/v4';
+import { type MaxMemorySizeConfig } from '../../../shared/feature.config';
+/**
+ * @see DatastoreConfig
+ */
+export declare const DatastoreConfigSchema: z.ZodObject<{
+    maxMemorySize: z.ZodOptional<z.ZodObject<{
+        heap: z.ZodOptional<z.ZodBigInt>;
+        stable: z.ZodOptional<z.ZodBigInt>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
 /**
  * Configures the behavior of the Datastore.
  * @interface DatastoreConfig

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

@@ -0,0 +1,151 @@
+import * as z from 'zod/v4';
+/**
+ * Represents the ports exposed by an emulator container.
+ */
+export interface EmulatorPorts {
+    /**
+     * 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
+     */
+    server?: number;
+    /**
+     * The port of the admin server used for tasks like transferring ICP from the ledger.
+     * @default 5999
+     */
+    admin?: number;
+}
+/**
+ * Represents a Juno configuration file path.
+ * Must end in `.mjs`, `.ts`, `.js`, or `.json`.
+ */
+export type JunoConfigFile = string;
+/**
+ * Represents a Juno development config file path.
+ * Must end in `.mjs`, `.ts`, `.js`, or `.json`.
+ */
+export type JunoDevConfigFile = string;
+/**
+ * Configuration for the Skylab emulator.
+ */
+export interface EmulatorSkylab {
+    /**
+     * Ports exposed by the Skylab container.
+     */
+    ports?: EmulatorPorts & {
+        /**
+         * Console UI (like https://console.juno.build) running with the emulator.
+         * @default 5866
+         */
+        console: number;
+    };
+    /**
+     * Path to the Juno config file.
+     */
+    config: JunoConfigFile;
+}
+/**
+ * Configuration for the Console emulator.
+ */
+export interface EmulatorConsole {
+    /**
+     * Ports exposed by the Console container.
+     */
+    ports?: EmulatorPorts;
+}
+/**
+ * Configuration for the Satellite emulator.
+ */
+export interface EmulatorSatellite {
+    /**
+     * Ports exposed by the Satellite container.
+     */
+    ports?: EmulatorPorts;
+    /**
+     * Path to the dev config file to customize Satellite behavior.
+     */
+    config: JunoDevConfigFile;
+}
+/**
+ * Shared options for all emulator variants.
+ */
+export interface EmulatorBaseConfig {
+    /**
+     * The containerization tool to run the emulator.
+     */
+    runner: 'docker';
+    /**
+     * Persistent volume to store internal state.
+     * @default "juno"
+     */
+    volume?: string;
+    /**
+     * Shared folder for deploying and hot-reloading serverless functions.
+     */
+    target?: string;
+}
+/**
+ * @see EmulatorConfig
+ */
+export declare const EmulatorConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
+    runner: z.ZodEnum<{
+        docker: "docker";
+    }>;
+    volume: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    skylab: z.ZodObject<{
+        ports: z.ZodOptional<z.ZodObject<{
+            server: z.ZodOptional<z.ZodNumber>;
+            admin: z.ZodOptional<z.ZodNumber>;
+            console: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+        config: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    runner: z.ZodEnum<{
+        docker: "docker";
+    }>;
+    volume: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    console: z.ZodObject<{
+        ports: z.ZodOptional<z.ZodObject<{
+            /**
+             * @default 5987
+             */
+            server: z.ZodOptional<z.ZodNumber>;
+            /**
+             * @default 5999
+             */
+            admin: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>;
+}, z.core.$strict>, z.ZodObject<{
+    runner: z.ZodEnum<{
+        docker: "docker";
+    }>;
+    volume: z.ZodOptional<z.ZodString>;
+    target: z.ZodOptional<z.ZodString>;
+    satellite: z.ZodObject<{
+        ports: z.ZodOptional<z.ZodObject<{
+            /**
+             * @default 5987
+             */
+            server: z.ZodOptional<z.ZodNumber>;
+            /**
+             * @default 5999
+             */
+            admin: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strict>>;
+        config: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>]>;
+/**
+ * The configuration for running the Juno emulator.
+ */
+export type EmulatorConfig = (EmulatorBaseConfig & {
+    skylab: EmulatorSkylab;
+}) | (EmulatorBaseConfig & {
+    console: EmulatorConsole;
+}) | (EmulatorBaseConfig & {
+    satellite: EmulatorSatellite;
+});

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

@@ -1,5 +1,13 @@
-import type { JunoConfigMode } from '../../../types/juno.env';
+import { type PrincipalText } from '@dfinity/zod-schemas';
+import * as z from 'zod/v4';
+import { type JunoConfigMode } from '../../../types/juno.env';
 import type { Either } from '../../../types/utility.types';
+/**
+ * @see OrbiterId
+ */
+export declare const OrbiterIdSchema: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
 /**
  * Represents the configuration for an orbiter.
  * @interface OrbiterId
@@ -9,14 +17,14 @@ export interface OrbiterId {
      * The identifier of the orbiter used in the dApp.
      * @type {string}
      */
-    id: string;
-    /**
-     * The deprecated identifier of the orbiter.
-     * @deprecated `orbiterId` will be removed in the future. Use `id` instead.
-     * @type {string}
-     */
-    orbiterId?: string;
+    id: PrincipalText;
 }
+/**
+ * @see OrbiterIds
+ */
+export declare const OrbiterIdsSchema: z.ZodObject<{
+    ids: z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"production">, z.ZodString]>, z.ZodString>;
+}, z.core.$strip>;
 /**
  * Represents a mapping of orbiter identitifiers to different configurations based on the mode of the application.
  * @interface OrbiterIds
@@ -34,8 +42,16 @@ export interface OrbiterIds {
      * }
      * @type {Record<JunoConfigMode, string>}
      */
-    ids: Record<JunoConfigMode, string>;
+    ids: Record<JunoConfigMode, PrincipalText>;
 }
+/**
+ * @see OrbiterConfig
+ */
+export declare const OrbiterConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    ids: z.ZodRecord<z.ZodUnion<readonly [z.ZodLiteral<"production">, z.ZodString]>, z.ZodString>;
+}, z.core.$strict>]>;
 /**
  * Represents the configuration for an orbiter (analytics).
  *