@junobuild/config 0.0.6 → 0.0.7

package/README.md

@@ -63,50 +63,64 @@ Configuration options for [Juno] CLI.
 
 #### :gear: JunoConfigEnv
 
-| Property | Type     | Description |
-| -------- | -------- | ----------- |
-| `mode`   | `string` |             |
+Represents the environment configuration for Juno.
+
+| Property | Type     | Description                                                |
+| -------- | -------- | ---------------------------------------------------------- |
+| `mode`   | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
 
 #### :gear: OrbiterConfig
 
-| 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. |
+Represents the configuration for an orbiter.
+
+| Property    | Type                  | Description                                                                                                                      |
+| ----------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `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: JunoConfig
 
-| Property    | Type                         | Description |
-| ----------- | ---------------------------- | ----------- |
-| `satellite` | `SatelliteConfig`            |             |
-| `orbiter`   | `OrbiterConfig or undefined` |             |
+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 |
 
 #### :gear: SatelliteDevCollections
 
-| Property  | Type                                           | Description |
-| --------- | ---------------------------------------------- | ----------- |
-| `db`      | `SatelliteDevDbCollection[] or undefined`      |             |
-| `storage` | `SatelliteDevStorageCollection[] or undefined` |             |
+Represents the collections configuration for a satellite in a development environment.
+
+| Property  | Type                                           | Description                                                                            |
+| --------- | ---------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `db`      | `SatelliteDevDbCollection[] or undefined`      | The database collections configuration. type: {SatelliteDevDbCollection[]}optional     |
+| `storage` | `SatelliteDevStorageCollection[] or undefined` | The storage collections configuration. type: {SatelliteDevStorageCollection[]}optional |
 
 #### :gear: SatelliteDevController
 
-| Property | Type                 | Description |
-| -------- | -------------------- | ----------- |
-| `id`     | `string`             |             |
-| `scope`  | `"write" or "admin"` |             |
+Represents a controller configuration for a satellite in a development environment.
+
+| Property | Type                 | Description                                               |
+| -------- | -------------------- | --------------------------------------------------------- | -------- |
+| `id`     | `string`             | The unique identifier of the controller. type: {string}   |
+| `scope`  | `"write" or "admin"` | The scope of the controller's permissions. type: {'write' | 'admin'} |
 
 #### :gear: SatelliteDevConfig
 
-| Property      | Type                                    | Description |
-| ------------- | --------------------------------------- | ----------- |
-| `collections` | `SatelliteDevCollections`               |             |
-| `controllers` | `SatelliteDevController[] or undefined` |             |
+Represents the development configuration for a satellite.
+
+| Property      | Type                                    | Description                                                                      |
+| ------------- | --------------------------------------- | -------------------------------------------------------------------------------- |
+| `collections` | `SatelliteDevCollections`               | The collections configuration. type: {SatelliteDevCollections}                   |
+| `controllers` | `SatelliteDevController[] or undefined` | The optional controllers configuration. type: {SatelliteDevController[]}optional |
 
 #### :gear: JunoDevConfig
 
-| Property    | Type                 | Description |
-| ----------- | -------------------- | ----------- |
-| `satellite` | `SatelliteDevConfig` |             |
+Represents the development configuration for Juno.
+
+| Property    | Type                 | Description                                                                 |
+| ----------- | -------------------- | --------------------------------------------------------------------------- |
+| `satellite` | `SatelliteDevConfig` | The development configuration for the satellite. type: {SatelliteDevConfig} |
 
 ### :cocktail: Types
 
@@ -123,7 +137,7 @@ Configuration options for [Juno] CLI.
 | --------------- | --------------------------------------------------------- |
 | `ENCODING_TYPE` | `'identity' or 'gzip' or 'compress' or 'deflate' or 'br'` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L1)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/encoding.ts#L5)
 
 #### :gear: JunoConfigMode
 
@@ -131,7 +145,7 @@ Configuration options for [Juno] CLI.
 | ---------------- | ------------------------ |
 | `JunoConfigMode` | `'production' or string` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/mainnet/juno.env.ts#L1)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/mainnet/juno.env.ts#L5)
 
 #### :gear: SatelliteDevDbCollection
 
@@ -139,7 +153,7 @@ Configuration options for [Juno] CLI.
 | -------------------------- | ----------------------------------------------------- |
 | `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)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L7)
 
 #### :gear: SatelliteDevStorageCollection
 
@@ -147,7 +161,7 @@ Configuration options for [Juno] CLI.
 | ------------------------------- | --------------------------------------------------------- |
 | `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)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L13)
 
 #### :gear: JunoDevConfigFn
 

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

@@ -1,18 +1,73 @@
 import type { Rule } from '../types/rules';
+/**
+ * Represents a database collection configuration for a satellite in a development environment.
+ * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize'>} SatelliteDevDbCollection
+ */
 export type SatelliteDevDbCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize'>;
+/**
+ * Represents a storage collection configuration for a satellite in a development environment.
+ * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity'>} SatelliteDevStorageCollection
+ */
 export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity'>;
+/**
+ * Represents the collections configuration for a satellite in a development environment.
+ * @interface SatelliteDevCollections
+ */
 export interface SatelliteDevCollections {
+    /**
+     * The database collections configuration.
+     * @type {SatelliteDevDbCollection[]}
+     * @optional
+     */
     db?: SatelliteDevDbCollection[];
+    /**
+     * The storage collections configuration.
+     * @type {SatelliteDevStorageCollection[]}
+     * @optional
+     */
     storage?: SatelliteDevStorageCollection[];
 }
+/**
+ * Represents a controller configuration for a satellite in a development environment.
+ * @interface SatelliteDevController
+ */
 export interface SatelliteDevController {
+    /**
+     * The unique identifier of the controller.
+     * @type {string}
+     */
     id: string;
+    /**
+     * The scope of the controller's permissions.
+     * @type {'write' | 'admin'}
+     */
     scope: 'write' | 'admin';
 }
+/**
+ * Represents the development configuration for a satellite.
+ * @interface SatelliteDevConfig
+ */
 export interface SatelliteDevConfig {
+    /**
+     * The collections configuration.
+     * @type {SatelliteDevCollections}
+     */
     collections: SatelliteDevCollections;
+    /**
+     * The optional controllers configuration.
+     * @type {SatelliteDevController[]}
+     * @optional
+     */
     controllers?: SatelliteDevController[];
 }
+/**
+ * Represents the development configuration for Juno.
+ * @interface JunoDevConfig
+ */
 export interface JunoDevConfig {
+    /**
+     * The development configuration for the satellite.
+     * @type {SatelliteDevConfig}
+     */
     satellite: SatelliteDevConfig;
 }

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

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

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

@@ -1,15 +1,35 @@
 import type { SatelliteConfig } from './satellite.config';
+/**
+ * Represents the configuration for an orbiter.
+ * @interface OrbiterConfig
+ */
 export interface OrbiterConfig {
     /**
      * 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;
 }
+/**
+ * Represents the overall configuration for Juno.
+ * @interface JunoConfig
+ */
 export interface JunoConfig {
+    /**
+     * The configuration for the satellite.
+     * @type {SatelliteConfig}
+     */
     satellite: SatelliteConfig;
+    /**
+     * The optional configuration for the orbiter.
+     * @type {OrbiterConfig}
+     * @optional
+     */
     orbiter?: OrbiterConfig;
 }

package/dist/types/mainnet/juno.env.d.ts

@@ -1,4 +1,16 @@
+/**
+ * Represents the mode of the Juno configuration.
+ * @typedef {'production' | string} JunoConfigMode
+ */
 export type JunoConfigMode = 'production' | string;
+/**
+ * Represents the environment configuration for Juno.
+ * @interface JunoConfigEnv
+ */
 export interface JunoConfigEnv {
+    /**
+     * The mode of the Juno configuration.
+     * @type {JunoConfigMode}
+     */
     mode: JunoConfigMode;
 }

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

@@ -3,6 +3,10 @@ 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';
+/**
+ * Configuration for satellite assertions.
+ * @interface SatelliteAssertions
+ */
 export interface SatelliteAssertions {
     /**
      * Configuration for the heap memory size check, which can be:
@@ -10,20 +14,32 @@ export interface SatelliteAssertions {
      * - `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 default value.
+     * If not specified, then `true` is used as the default value.
+     * @type {number | boolean}
      */
     heapMemory?: number | boolean;
 }
+/**
+ * Represents the unique identifier for a satellite.
+ * @interface SatelliteId
+ */
 export interface SatelliteId {
     /**
      * The unique identifier (ID) of the satellite for this application.
+     * @type {string}
      */
     id: string;
     /**
+     * The deprecated unique identifier (ID) of the satellite.
      * @deprecated `satelliteId` will be removed in the future. Use `id` instead.
+     * @type {string}
      */
     satelliteId?: string;
 }
+/**
+ * Represents a mapping of satellite identifiers to different configurations based on the mode of the application.
+ * @interface SatelliteIds
+ */
 export interface SatelliteIds {
     /**
      * A mapping of satellite identifiers (IDs) to different configurations based on the mode of the application.
@@ -35,34 +51,48 @@ export interface SatelliteIds {
      *   "production": "xo2hm-lqaaa-aaaal-ab3oa-cai",
      *   "staging": "gl6nx-5maaa-aaaaa-qaaqq-cai"
      * }
+     * @type {Record<JunoConfigMode, string>}
      */
     ids: Record<JunoConfigMode, string>;
 }
+/**
+ * Represents the configuration for a satellite.
+ * @typedef {Either<SatelliteId, SatelliteIds>} SatelliteConfig
+ */
 export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
     /**
      * Specifies the directory from which to deploy to storage.
      * For instance, if `npm run build` outputs files to a `dist` folder, use `source: 'dist'`.
      *
-     * @default `build`
+     * @default 'build'
+     * @type {string}
      */
     source?: string;
     /**
      * 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.
+     * Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands.
+     * @type {StorageConfig}
+     * @optional
      */
     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.
+     * Changes to these parameters must be applied manually afterwards, for example with the CLI using `juno config` commands.
+     * @type {AuthenticationConfig}
+     * @optional
      */
     authentication?: AuthenticationConfig;
     /**
      * Specifies files or patterns to ignore during deployment, using glob patterns similar to those in .gitignore.
+     * @type {string[]}
+     * @optional
      */
     ignore?: string[];
     /**
      * Controls the Gzip compression optimization for files in the source folder. By default, it targets JavaScript (js), ES Module (mjs), and CSS (css) files.
      * You can disable this by setting it to `false` or customize it with a different file matching pattern using glob syntax.
+     * @type {string | false}
+     * @optional
      */
     gzip?: string | false;
     /**
@@ -73,10 +103,14 @@ export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
      * - `.zlib` for deflate,
      * - anything else defaults to `identity`.
      * The "encoding" attribute allows overriding default mappings with an array of glob patterns and encoding types.
+     * @type {Array<[string, ENCODING_TYPE]>}
+     * @optional
      */
     encoding?: Array<[string, ENCODING_TYPE]>;
     /**
      * Optional configurations to override default assertions made by the CLI regarding satellite deployment conditions.
+     * @type {SatelliteAssertions}
+     * @optional
      */
     assertions?: SatelliteAssertions;
 };

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

@@ -1,65 +1,87 @@
 /**
  * Represents a glob pattern for matching files in the storage configuration.
+ * @typedef {string} StorageConfigSourceGlob
  */
 export type StorageConfigSourceGlob = string;
 /**
- * Headers allow the client and the satellite to pass additional information along with a request or a response. Some sets of headers can affect how the browser handles the page and its content.
+ * Headers allow the client and the satellite to pass additional information along with a request or a response.
+ * Some sets of headers can affect how the browser handles the page and its content.
+ * @interface StorageConfigHeader
  */
 export interface StorageConfigHeader {
     /**
      * The glob pattern used to match files within the storage that these headers will apply to.
+     * @type {StorageConfigSourceGlob}
      */
     source: StorageConfigSourceGlob;
     /**
-     * An array of key-value pairs representing the headers to apply. Each pair includes the header name and its value.
+     * An array of key-value pairs representing the headers to apply.
+     * Each pair includes the header name and its value.
      * Example: `[["Cache-Control", "max-age=3600"], ["X-Custom-Header", "value"]]`
+     * @type {Array<[string, string]>}
      */
     headers: [string, string][];
 }
 /**
- * You can utilize optional rewrites to display the same content for multiple URLs. Rewrites are especially useful when combined with pattern matching, allowing acceptance of any URL that matches the pattern.
+ * You can utilize optional rewrites to display the same content for multiple URLs.
+ * Rewrites are especially useful when combined with pattern matching, allowing acceptance of any URL that matches the pattern.
+ * @interface StorageConfigRewrite
  */
 export interface StorageConfigRewrite {
     /**
-     * The glob pattern or specific path to match for incoming requests. Matches are rewritten to the specified destination.
+     * The glob pattern or specific path to match for incoming requests.
+     * Matches are rewritten to the specified destination.
+     * @type {StorageConfigSourceGlob}
      */
     source: StorageConfigSourceGlob;
     /**
      * The destination path or file to which matching requests should be rewritten.
+     * @type {string}
      */
     destination: string;
 }
 /**
  * Use a URL redirect to prevent broken links if you've moved a page or to shorten URLs.
+ * @interface StorageConfigRedirect
  */
 export interface StorageConfigRedirect {
     /**
      * The glob pattern or specific path to match for incoming requests that should be redirected.
+     * @type {StorageConfigSourceGlob}
      */
     source: StorageConfigSourceGlob;
     /**
      * The URL or path to which the request should be redirected.
+     * @type {string}
      */
     location: string;
     /**
      * The HTTP status code to use for the redirect, typically 301 (permanent redirect) or 302 (temporary redirect).
+     * @type {301 | 302}
      */
     code: 301 | 302;
 }
 /**
- * Configures the Hosting behavior of the Storage.
+ * Configures the hosting behavior of the storage.
+ * @interface StorageConfig
  */
 export interface StorageConfig {
     /**
      * Optional array of `StorageConfigHeader` objects to define custom HTTP headers for specific files or patterns.
+     * @type {StorageConfigHeader[]}
+     * @optional
      */
     headers?: StorageConfigHeader[];
     /**
      * Optional array of `StorageConfigRewrite` objects to define rewrite rules.
+     * @type {StorageConfigRewrite[]}
+     * @optional
      */
     rewrites?: StorageConfigRewrite[];
     /**
      * Optional array of `StorageConfigRedirect` objects to define HTTP redirects.
+     * @type {StorageConfigRedirect[]}
+     * @optional
      */
     redirects?: StorageConfigRedirect[];
     /**
@@ -71,6 +93,8 @@ export interface StorageConfig {
      * - `allow-any`: Allows iframe content from any origin.
      *
      * If not specified, then `deny` is used as default value.
+     * @type {'deny' | 'same-origin' | 'allow-any'}
+     * @optional
      */
     iframe?: 'deny' | 'same-origin' | 'allow-any';
 }

package/dist/types/types/encoding.d.ts

@@ -1 +1,5 @@
+/**
+ * Represents the encoding types for assets.
+ * @typedef {'identity' | 'gzip' | 'compress' | 'deflate' | 'br'} ENCODING_TYPE
+ */
 export type ENCODING_TYPE = 'identity' | 'gzip' | 'compress' | 'deflate' | 'br';

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

@@ -1,15 +1,77 @@
+/**
+ * Represents the permission levels for read and write access.
+ * @typedef {'public' | 'private' | 'managed' | 'controllers'} PermissionText
+ */
 export type PermissionText = 'public' | 'private' | 'managed' | 'controllers';
+/**
+ * Represents the memory types.
+ * @typedef {'heap' | 'stable'} MemoryText
+ */
 export type MemoryText = 'heap' | 'stable';
+/**
+ * Represents the types of rules.
+ * @typedef {'db' | 'storage'} RulesType
+ */
 export type RulesType = 'db' | 'storage';
+/**
+ * Represents a rule configuration for a collection.
+ * @interface Rule
+ */
 export interface Rule {
+    /**
+     * The name of the collection the rule applies to.
+     * @type {string}
+     */
     collection: string;
+    /**
+     * The permission level for read access.
+     * @type {PermissionText}
+     */
     read: PermissionText;
+    /**
+     * The permission level for write access.
+     * @type {PermissionText}
+     */
     write: PermissionText;
+    /**
+     * The type of memory allocated for the collection.
+     * @type {MemoryText}
+     */
     memory: MemoryText;
+    /**
+     * The timestamp when the rule was created.
+     * @type {bigint}
+     * @optional
+     */
     createdAt?: bigint;
+    /**
+     * The timestamp when the rule was last updated.
+     * @type {bigint}
+     * @optional
+     */
     updatedAt?: bigint;
+    /**
+     * The version of the rule.
+     * @type {bigint}
+     * @optional
+     * @description Must be provided when updating the rule to ensure the correct version is being updated.
+     */
     version?: bigint;
+    /**
+     * The maximum size of the collection in bytes.
+     * @type {number}
+     * @optional
+     */
     maxSize?: number;
+    /**
+     * The maximum capacity of the collection.
+     * @type {number}
+     * @optional
+     */
     maxCapacity?: number;
+    /**
+     * Indicates whether the permissions are mutable.
+     * @type {boolean}
+     */
     mutablePermissions: boolean;
 }

package/package.json

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