@junobuild/config 0.0.10 → 0.0.11

package/dist/browser/index.js

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

package/dist/node/index.mjs

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

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

@@ -1,4 +1,4 @@
-import type { StorageConfig } from '../satellite/mainnet/storage.config';
+import type { StorageConfig } from '../storage/storage.config';
 import type { CliConfig } from '../types/cli.config';
 import type { JunoConfigMode } from '../types/juno.env';
 import type { Either } from '../utils/ts.utils';

package/dist/types/index.d.ts

@@ -1,10 +1,13 @@
 export type * from './console/console.config';
+export type * from './module/module.settings';
 export type * from './satellite/dev/juno.dev.config';
-export type * from './satellite/mainnet/authentication.config';
+export type * from './satellite/mainnet/configs/assertions.config';
+export type * from './satellite/mainnet/configs/authentication.config';
+export type * from './satellite/mainnet/configs/orbiter.config';
+export type * from './satellite/mainnet/configs/satellite.config';
 export type * from './satellite/mainnet/juno.config';
-export type * from './satellite/mainnet/satellite.config';
-export type * from './satellite/mainnet/storage.config';
 export type * from './satellite/types/rules';
+export type * from './storage/storage.config';
 export type * from './types/cli.config';
 export type * from './types/encoding';
 export type * from './types/juno.env';

package/dist/types/module/module.settings.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Specifies who can see the logs of the module.
+ *
+ * - 'controllers': Only the controllers of the module can see the logs.
+ * - 'public': Everyone can see the logs.
+ *
+ * @typedef {'controllers' | 'public'} ModuleLogVisibility
+ */
+export type ModuleLogVisibility = 'controllers' | 'public';
+/**
+ * Settings for a module - Satellite, Mission Control or Orbiter.
+ *
+ * These settings control various aspects of the module's behavior and resource usage.
+ *
+ * @interface ModuleSettings
+ */
+export interface ModuleSettings {
+    /**
+     * The cycle threshold below which the module will automatically stop to avoid running out of cycles.
+     *
+     * For example, if set to `BigInt(1000000)`, the module will stop when it has fewer than 1,000,000 cycles remaining.
+     *
+     * @type {bigint}
+     */
+    freezingThreshold: bigint;
+    /**
+     * The number of cycles reserved for the module's operations to ensure it has enough cycles to function.
+     *
+     * For example, setting it to `BigInt(5000000)` reserves 5,000,000 cycles for the module.
+     *
+     * @type {bigint}
+     */
+    reservedCyclesLimit: bigint;
+    /**
+     * Controls who can see the module's logs.
+     *
+     * @type {ModuleLogVisibility}
+     */
+    logVisibility: ModuleLogVisibility;
+    /**
+     * The maximum amount of WebAssembly (Wasm) memory the module can use on the heap.
+     *
+     * For example, setting it to `BigInt(1024 * 1024 * 64)` allows the module to use up to 64 MB of Wasm memory.
+     *
+     * @type {bigint}
+     */
+    wasmMemoryLimit: bigint;
+    /**
+     * The amount of memory explicitly allocated to the module.
+     *
+     * For example, setting it to `BigInt(1024 * 1024 * 128)` allocates 128 MB of memory to the module.
+     *
+     * @type {bigint}
+     */
+    memoryAllocation: bigint;
+    /**
+     * The proportion of compute capacity allocated to the module.
+     *
+     * This is a fraction of the total compute capacity of the subnet. For example, setting it to `BigInt(10)` allocates 10% of the compute capacity to the module.
+     *
+     * @type {bigint}
+     */
+    computeAllocation: bigint;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * Configuration for satellite assertions.
+ * @interface SatelliteAssertions
+ */
+export interface SatelliteAssertions {
+    /**
+     * Configuration for the heap memory size check, which can be:
+     * - `true` to enable the check with a default threshold of 900MB,
+     * - `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 the default value.
+     * @type {number | boolean}
+     */
+    heapMemory?: number | boolean;
+}

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

@@ -0,0 +1,17 @@
+/**
+ * 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;
+}

package/dist/types/satellite/mainnet/{satellite.config.d.ts → configs/satellite.config.d.ts}

@@ -1,24 +1,10 @@
-import type { CliConfig } from '../../types/cli.config';
-import type { JunoConfigMode } from '../../types/juno.env';
-import type { Either } from '../../utils/ts.utils';
+import { ModuleSettings } from '../../../module/module.settings';
+import type { StorageConfig } from '../../../storage/storage.config';
+import type { CliConfig } from '../../../types/cli.config';
+import type { JunoConfigMode } from '../../../types/juno.env';
+import type { Either } from '../../../utils/ts.utils';
+import type { SatelliteAssertions } from './assertions.config';
 import type { AuthenticationConfig } from './authentication.config';
-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:
-     * - `true` to enable the check with a default threshold of 900MB,
-     * - `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 the default value.
-     * @type {number | boolean}
-     */
-    heapMemory?: number | boolean;
-}
 /**
  * Represents the unique identifier for a satellite.
  * @interface SatelliteId
@@ -80,4 +66,11 @@ export type SatelliteConfig = Either<SatelliteId, SatelliteIds> & CliConfig & {
      * @optional
      */
     assertions?: SatelliteAssertions;
+    /**
+     * Optional configuration parameters for the Satellite.
+     * These settings control various aspects of the module's behavior and resource usage.
+     * @type {ModuleSettings}
+     * @optional
+     */
+    settings?: ModuleSettings;
 };

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

@@ -1,21 +1,5 @@
-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;
-}
+import type { OrbiterConfig } from './configs/orbiter.config';
+import type { SatelliteConfig } from './configs/satellite.config';
 /**
  * Represents the overall configuration for Juno.
  * @interface JunoConfig

package/package.json

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