@junobuild/config 0.0.7 → 0.0.8-next-2024-06-15

package/README.md

@@ -53,7 +53,6 @@ Configuration options for [Juno] CLI.
 
 ### :tropical_drink: Interfaces
 
-- [JunoConfigEnv](#gear-junoconfigenv)
 - [OrbiterConfig](#gear-orbiterconfig)
 - [JunoConfig](#gear-junoconfig)
 - [SatelliteDevCollections](#gear-satellitedevcollections)
@@ -61,14 +60,6 @@ Configuration options for [Juno] CLI.
 - [SatelliteDevConfig](#gear-satellitedevconfig)
 - [JunoDevConfig](#gear-junodevconfig)
 
-#### :gear: JunoConfigEnv
-
-Represents the environment configuration for Juno.
-
-| Property | Type     | Description                                                |
-| -------- | -------- | ---------------------------------------------------------- |
-| `mode`   | `string` | The mode of the Juno configuration. type: {JunoConfigMode} |
-
 #### :gear: OrbiterConfig
 
 Represents the configuration for an orbiter.
@@ -125,7 +116,6 @@ Represents the development configuration for Juno.
 ### :cocktail: Types
 
 - [ENCODING_TYPE](#gear-encoding_type)
-- [JunoConfigMode](#gear-junoconfigmode)
 - [SatelliteDevDbCollection](#gear-satellitedevdbcollection)
 - [SatelliteDevStorageCollection](#gear-satellitedevstoragecollection)
 - [JunoDevConfigFn](#gear-junodevconfigfn)
@@ -139,29 +129,31 @@ 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` |
+#### :gear: SatelliteDevDbCollection
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/mainnet/juno.env.ts#L5)
+| Type                       | Type   |
+| -------------------------- | ------ |
+| `SatelliteDevDbCollection` | `Omit< |
 
-#### :gear: SatelliteDevDbCollection
+Rule,
+'createdAt' or 'updatedAt' or 'maxSize' or 'version'
 
-| 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#L7)
 
 #### :gear: SatelliteDevStorageCollection
 
-| Type                            | Type                                                      |
-| ------------------------------- | --------------------------------------------------------- |
-| `SatelliteDevStorageCollection` | `Omit<Rule, 'createdAt' or 'updatedAt' or 'maxCapacity'>` |
+| Type                            | Type   |
+| ------------------------------- | ------ |
+| `SatelliteDevStorageCollection` | `Omit< |
+
+Rule,
+'createdAt' or 'updatedAt' or 'maxCapacity' or 'version'
+
+> ` |
 
-[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L13)
+[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/dev/juno.dev.config.ts#L16)
 
 #### :gear: JunoDevConfigFn
 

package/dist/browser/index.js

@@ -1,2 +1,2 @@
-function o(n){return n}function f(n){return n}export{f as defineConfig,o as defineDevConfig};
+function n(o){return o}function f(o){return o}function t(o){return o}export{t as defineConfig,f as defineDevConfig,n as defineJunoConsoleConfig};
 //# sourceMappingURL=index.js.map

package/dist/browser/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/dev/config.ts", "../../src/mainnet/config.ts"],
-  "sourcesContent": ["import type {JunoDevConfig} from './juno.dev.config';\n\nexport type JunoDevConfigFn = () => JunoDevConfig;\n\nexport type JunoDevConfigFnOrObject = JunoDevConfig | JunoDevConfigFn;\n\nexport function defineDevConfig(config: JunoDevConfig): JunoDevConfig;\nexport function defineDevConfig(config: JunoDevConfigFn): JunoDevConfigFn;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject {\n  return config;\n}\n", "import type {JunoConfig} from './juno.config';\nimport type {JunoConfigEnv} from './juno.env';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
-  "mappings": "AASO,SAASA,EAAgBC,EAA0D,CACxF,OAAOA,CACT,CCDO,SAASC,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
-  "names": ["defineDevConfig", "config", "defineConfig", "config"]
+  "sources": ["../../src/console/config.ts", "../../src/dev/config.ts", "../../src/mainnet/config.ts"],
+  "sourcesContent": ["import type {JunoConfigEnv} from '../types/juno.env';\nimport type {JunoConsoleConfig} from './console.config';\n\nexport type JunoConsoleConfigFn = (config: JunoConfigEnv) => JunoConsoleConfig;\n\nexport type JunoConsoleConfigFnOrObject = JunoConsoleConfig | JunoConsoleConfigFn;\n\nexport function defineJunoConsoleConfig(config: JunoConsoleConfig): JunoConsoleConfig;\nexport function defineJunoConsoleConfig(config: JunoConsoleConfigFn): JunoConsoleConfigFn;\nexport function defineJunoConsoleConfig(\n  config: JunoConsoleConfigFnOrObject\n): JunoConsoleConfigFnOrObject;\nexport function defineJunoConsoleConfig(\n  config: JunoConsoleConfigFnOrObject\n): JunoConsoleConfigFnOrObject {\n  return config;\n}\n", "import type {JunoDevConfig} from './juno.dev.config';\n\nexport type JunoDevConfigFn = () => JunoDevConfig;\n\nexport type JunoDevConfigFnOrObject = JunoDevConfig | JunoDevConfigFn;\n\nexport function defineDevConfig(config: JunoDevConfig): JunoDevConfig;\nexport function defineDevConfig(config: JunoDevConfigFn): JunoDevConfigFn;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject {\n  return config;\n}\n", "import type {JunoConfigEnv} from '../types/juno.env';\nimport type {JunoConfig} from './juno.config';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
+  "mappings": "AAYO,SAASA,EACdC,EAC6B,CAC7B,OAAOA,CACT,CCPO,SAASC,EAAgBC,EAA0D,CACxF,OAAOA,CACT,CCDO,SAASC,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
+  "names": ["defineJunoConsoleConfig", "config", "defineDevConfig", "config", "defineConfig", "config"]
 }

package/dist/node/index.mjs

@@ -1,4 +1,4 @@
 import { createRequire as topLevelCreateRequire } from 'module';
  const require = topLevelCreateRequire(import.meta.url);
-function o(n){return n}function f(n){return n}export{f as defineConfig,o as defineDevConfig};
+function n(o){return o}function f(o){return o}function t(o){return o}export{t as defineConfig,f as defineDevConfig,n as defineJunoConsoleConfig};
 //# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/dev/config.ts", "../../src/mainnet/config.ts"],
-  "sourcesContent": ["import type {JunoDevConfig} from './juno.dev.config';\n\nexport type JunoDevConfigFn = () => JunoDevConfig;\n\nexport type JunoDevConfigFnOrObject = JunoDevConfig | JunoDevConfigFn;\n\nexport function defineDevConfig(config: JunoDevConfig): JunoDevConfig;\nexport function defineDevConfig(config: JunoDevConfigFn): JunoDevConfigFn;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject {\n  return config;\n}\n", "import type {JunoConfig} from './juno.config';\nimport type {JunoConfigEnv} from './juno.env';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
-  "mappings": ";;AASO,SAASA,EAAgBC,EAA0D,CACxF,OAAOA,CACT,CCDO,SAASC,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
-  "names": ["defineDevConfig", "config", "defineConfig", "config"]
+  "sources": ["../../src/console/config.ts", "../../src/dev/config.ts", "../../src/mainnet/config.ts"],
+  "sourcesContent": ["import type {JunoConfigEnv} from '../types/juno.env';\nimport type {JunoConsoleConfig} from './console.config';\n\nexport type JunoConsoleConfigFn = (config: JunoConfigEnv) => JunoConsoleConfig;\n\nexport type JunoConsoleConfigFnOrObject = JunoConsoleConfig | JunoConsoleConfigFn;\n\nexport function defineJunoConsoleConfig(config: JunoConsoleConfig): JunoConsoleConfig;\nexport function defineJunoConsoleConfig(config: JunoConsoleConfigFn): JunoConsoleConfigFn;\nexport function defineJunoConsoleConfig(\n  config: JunoConsoleConfigFnOrObject\n): JunoConsoleConfigFnOrObject;\nexport function defineJunoConsoleConfig(\n  config: JunoConsoleConfigFnOrObject\n): JunoConsoleConfigFnOrObject {\n  return config;\n}\n", "import type {JunoDevConfig} from './juno.dev.config';\n\nexport type JunoDevConfigFn = () => JunoDevConfig;\n\nexport type JunoDevConfigFnOrObject = JunoDevConfig | JunoDevConfigFn;\n\nexport function defineDevConfig(config: JunoDevConfig): JunoDevConfig;\nexport function defineDevConfig(config: JunoDevConfigFn): JunoDevConfigFn;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject;\nexport function defineDevConfig(config: JunoDevConfigFnOrObject): JunoDevConfigFnOrObject {\n  return config;\n}\n", "import type {JunoConfigEnv} from '../types/juno.env';\nimport type {JunoConfig} from './juno.config';\n\nexport type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;\n\nexport type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;\n\nexport function defineConfig(config: JunoConfig): JunoConfig;\nexport function defineConfig(config: JunoConfigFn): JunoConfigFn;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject;\nexport function defineConfig(config: JunoConfigFnOrObject): JunoConfigFnOrObject {\n  return config;\n}\n"],
+  "mappings": ";;AAYO,SAASA,EACdC,EAC6B,CAC7B,OAAOA,CACT,CCPO,SAASC,EAAgBC,EAA0D,CACxF,OAAOA,CACT,CCDO,SAASC,EAAaC,EAAoD,CAC/E,OAAOA,CACT",
+  "names": ["defineJunoConsoleConfig", "config", "defineDevConfig", "config", "defineConfig", "config"]
 }

package/dist/types/console/config.d.ts

@@ -0,0 +1,7 @@
+import type { JunoConfigEnv } from '../types/juno.env';
+import type { JunoConsoleConfig } from './console.config';
+export type JunoConsoleConfigFn = (config: JunoConfigEnv) => JunoConsoleConfig;
+export type JunoConsoleConfigFnOrObject = JunoConsoleConfig | JunoConsoleConfigFn;
+export declare function defineJunoConsoleConfig(config: JunoConsoleConfig): JunoConsoleConfig;
+export declare function defineJunoConsoleConfig(config: JunoConsoleConfigFn): JunoConsoleConfigFn;
+export declare function defineJunoConsoleConfig(config: JunoConsoleConfigFnOrObject): JunoConsoleConfigFnOrObject;

package/dist/types/console/console.config.d.ts

@@ -0,0 +1,40 @@
+import type { StorageConfig } from '../mainnet/storage.config';
+import type { CliConfig } from '../types/cli.config';
+import type { JunoConfigMode } from '../types/juno.env';
+import type { Either } from '../utils/ts.utils';
+/**
+ * Represents the unique identifier for a console.
+ * @interface ConsoleId
+ */
+export interface ConsoleId {
+    /**
+     * The unique identifier (ID) of the console.
+     * @type {string}
+     */
+    id: string;
+}
+/**
+ * Represents a mapping of console identifiers to different configurations based on the mode of the application.
+ * @interface ConsoleIds
+ */
+export interface ConsoleIds {
+    /**
+     * A mapping of console identifiers (IDs) to different configurations based on the mode of the application.
+     *
+     * This allows the application to use different console IDs, such as production, staging, etc.
+     * @type {Record<JunoConfigMode, string>}
+     */
+    ids: Record<JunoConfigMode, string>;
+}
+/**
+ * Represents the configuration for a console.
+ * @typedef {Either<ConsoleId, ConsoleIds>} ConsoleConfig
+ */
+export type JunoConsoleConfig = Either<ConsoleId, ConsoleIds> & CliConfig & {
+    /**
+     * Optional configuration parameters for the console, affecting the operational behavior of its Storage.
+     * @type {StorageConfig}
+     * @optional
+     */
+    storage?: StorageConfig;
+};

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

@@ -1,14 +1,14 @@
 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
+ * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>} SatelliteDevDbCollection
  */
-export type SatelliteDevDbCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize'>;
+export type SatelliteDevDbCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>;
 /**
  * Represents a storage collection configuration for a satellite in a development environment.
- * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity'>} SatelliteDevStorageCollection
+ * @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity' | 'version'>} SatelliteDevStorageCollection
  */
-export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity'>;
+export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity' | 'version'>;
 /**
  * Represents the collections configuration for a satellite in a development environment.
  * @interface SatelliteDevCollections

package/dist/types/index.d.ts

@@ -1,11 +1,14 @@
+export type * from './console/console.config';
 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';
 export type * from './mainnet/storage.config';
+export type * from './types/cli.config';
 export type * from './types/encoding';
+export type * from './types/juno.env';
 export type * from './types/rules';
 export type * from './utils/ts.utils';
+export * from './console/config';
 export * from './dev/config';
 export * from './mainnet/config';

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

@@ -1,5 +1,5 @@
+import type { JunoConfigEnv } from '../types/juno.env';
 import type { JunoConfig } from './juno.config';
-import type { JunoConfigEnv } from './juno.env';
 export type JunoConfigFn = (config: JunoConfigEnv) => JunoConfig;
 export type JunoConfigFnOrObject = JunoConfig | JunoConfigFn;
 export declare function defineConfig(config: JunoConfig): JunoConfig;

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

@@ -1,7 +1,7 @@
-import type { ENCODING_TYPE } from '../types/encoding';
+import type { CliConfig } from '../types/cli.config';
+import type { JunoConfigMode } from '../types/juno.env';
 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.
@@ -59,15 +59,7 @@ export interface SatelliteIds {
  * 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'
-     * @type {string}
-     */
-    source?: string;
+export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & CliConfig & {
     /**
      * 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.
@@ -82,31 +74,6 @@ export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & {
      * @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;
-    /**
-     * Customizes file encoding mapping for HTTP response headers `Content-Encoding` based on file extension:
-     * - `.Z` for compress,
-     * - `.gz` for gzip,
-     * - `.br` for brotli,
-     * - `.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}

package/dist/types/types/cli.config.d.ts

@@ -0,0 +1,36 @@
+import type { ENCODING_TYPE } from './encoding';
+export interface CliConfig {
+    /**
+     * 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'
+     * @type {string}
+     */
+    source?: string;
+    /**
+     * 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;
+    /**
+     * Customizes file encoding mapping for HTTP response headers `Content-Encoding` based on file extension:
+     * - `.Z` for compress,
+     * - `.gz` for gzip,
+     * - `.br` for brotli,
+     * - `.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]>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/config",
-  "version": "0.0.7",
+  "version": "0.0.8-next-2024-06-15",
   "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"
-}
+}