@junobuild/config 0.0.4 → 0.0.5-next-2024-05-06

package/README.md

@@ -69,24 +69,24 @@ Configuration options for [Juno] CLI.
 
 #### :gear: OrbiterConfig
 
-| Property    | Type     | Description                                                              |
-| ----------- | -------- | ------------------------------------------------------------------------ |
-| `id`        | `string` | The identifier of the orbiter used in the dApp.                          |
-| `orbiterId` | `string` | deprecated: `orbiterId` will be removed in the future. Use `id` instead. |
+| Property    | Type                  | Description                                                              |
+| ----------- | --------------------- | ------------------------------------------------------------------------ |
+| `id`        | `string`              | The identifier of the orbiter used in the dApp.                          |
+| `orbiterId` | `string or undefined` | deprecated: `orbiterId` will be removed in the future. Use `id` instead. |
 
 #### :gear: JunoConfig
 
-| Property    | Type              | Description |
-| ----------- | ----------------- | ----------- |
-| `satellite` | `SatelliteConfig` |             |
-| `orbiter`   | `OrbiterConfig`   |             |
+| Property    | Type                         | Description |
+| ----------- | ---------------------------- | ----------- |
+| `satellite` | `SatelliteConfig`            |             |
+| `orbiter`   | `OrbiterConfig or undefined` |             |
 
 #### :gear: SatelliteDevCollections
 
-| Property  | Type                       | Description |
-| --------- | -------------------------- | ----------- |
-| `db`      | `SatelliteDevCollection[]` |             |
-| `storage` | `SatelliteDevCollection[]` |             |
+| Property  | Type                                           | Description |
+| --------- | ---------------------------------------------- | ----------- |
+| `db`      | `SatelliteDevDbCollection[] or undefined`      |             |
+| `storage` | `SatelliteDevStorageCollection[] or undefined` |             |
 
 #### :gear: SatelliteDevController
 
@@ -97,10 +97,10 @@ Configuration options for [Juno] CLI.
 
 #### :gear: SatelliteDevConfig
 
-| Property      | Type                       | Description |
-| ------------- | -------------------------- | ----------- |
-| `collections` | `SatelliteDevCollections`  |             |
-| `controllers` | `SatelliteDevController[]` |             |
+| Property      | Type                                    | Description |
+| ------------- | --------------------------------------- | ----------- |
+| `collections` | `SatelliteDevCollections`               |             |
+| `controllers` | `SatelliteDevController[] or undefined` |             |
 
 #### :gear: JunoDevConfig
 
@@ -112,7 +112,8 @@ Configuration options for [Juno] CLI.
 
 - [ENCODING_TYPE](#gear-encoding_type)
 - [JunoConfigMode](#gear-junoconfigmode)
-- [SatelliteDevCollection](#gear-satellitedevcollection)
+- [SatelliteDevDbCollection](#gear-satellitedevdbcollection)
+- [SatelliteDevStorageCollection](#gear-satellitedevstoragecollection)
 - [JunoDevConfigFn](#gear-junodevconfigfn)
 - [JunoDevConfigFnOrObject](#gear-junodevconfigfnorobject)
 
@@ -132,14 +133,22 @@ Configuration options for [Juno] CLI.
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/mainnet/juno.env.ts#L1)
 
-#### :gear: SatelliteDevCollection
+#### :gear: SatelliteDevDbCollection
 
-| Type                     | Type                                       |
-| ------------------------ | ------------------------------------------ |
-| `SatelliteDevCollection` | `Omit<Rule, 'created_at' or 'updated_at'>` |
+| Type                       | Type                                                  |
+| -------------------------- | ----------------------------------------------------- |
+| `SatelliteDevDbCollection` | `Omit<Rule, 'createdAt' or 'updatedAt' or 'maxSize'>` |
 
 [:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L3)
 
+#### :gear: SatelliteDevStorageCollection
+
+| Type                            | Type                                                      |
+| ------------------------------- | --------------------------------------------------------- |
+| `SatelliteDevStorageCollection` | `Omit<Rule, 'createdAt' or 'updatedAt' or 'maxCapacity'>` |
+
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L5)
+
 #### :gear: JunoDevConfigFn
 
 | Type              | Type                  |

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

@@ -1,8 +1,9 @@
 import type { Rule } from '../types/rules';
-export type SatelliteDevCollection = Omit<Rule, 'created_at' | 'updated_at'>;
+export type SatelliteDevDbCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize'>;
+export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity'>;
 export interface SatelliteDevCollections {
-    db?: SatelliteDevCollection[];
-    storage?: SatelliteDevCollection[];
+    db?: SatelliteDevDbCollection[];
+    storage?: SatelliteDevStorageCollection[];
 }
 export interface SatelliteDevController {
     id: string;

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export type * from './dev/juno.dev.config';
+export type * from './mainnet/authentication.config';
 export type * from './mainnet/juno.config';
 export type * from './mainnet/juno.env';
 export type * from './mainnet/satellite.config';

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

@@ -0,0 +1,19 @@
+/**
+ * Configure the behavior of Internet Identity.
+ */
+export interface AuthenticationConfigInternetIdentity {
+    /**
+     * 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.
+     */
+    derivationOrigin?: string;
+}
+/**
+ * Configures the Authentication options of a Satellite.
+ */
+export interface AuthenticationConfig {
+    /**
+     * Optional configuration of Internet Identity authentication method.
+     */
+    internetIdentity?: AuthenticationConfigInternetIdentity;
+}

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

@@ -1,5 +1,6 @@
 import type { ENCODING_TYPE } from '../types/encoding';
 import type { Either } from '../utils/ts.utils';
+import type { AuthenticationConfig } from './authentication.config';
 import type { JunoConfigMode } from './juno.env';
 import type { StorageConfig } from './storage.config';
 export interface SatelliteAssertions {
@@ -47,9 +48,14 @@ export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
     source?: string;
     /**
      * Optional configuration parameters for the satellite, affecting the operational behavior of its Storage.
-     * Changes to these parameters must be applied manually afterwards using `juno config` commands.
+     * Changes to these parameters must be applied manually afterwards for example with the CLI using `juno config` commands.
      */
     storage?: StorageConfig;
+    /**
+     * 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.
+     */
+    authentication?: AuthenticationConfig;
     /**
      * Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore.
      */

package/dist/types/types/rules.d.ts

@@ -1,13 +1,15 @@
 export type PermissionText = 'public' | 'private' | 'managed' | 'controllers';
-export type MemoryText = 'Heap' | 'Stable';
+export type MemoryText = 'heap' | 'stable';
 export type RulesType = 'db' | 'storage';
 export interface Rule {
     collection: string;
     read: PermissionText;
     write: PermissionText;
     memory: MemoryText;
-    created_at?: bigint;
-    updated_at?: bigint;
-    max_size?: number;
+    createdAt?: bigint;
+    updatedAt?: bigint;
+    version?: bigint;
+    maxSize?: number;
+    maxCapacity?: number;
     mutablePermissions: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/config",
-  "version": "0.0.4",
+  "version": "0.0.5-next-2024-05-06",
   "description": "Configuration options for Juno CLI",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -40,4 +40,4 @@
     "url": "https://github.com/junobuild/juno-js"
   },
   "homepage": "https://juno.build"
-}
+}