@junobuild/admin 0.0.48-next-2024-05-17.4 → 0.0.49-next-2024-05-21

package/dist/types/services/mission-control.services.d.ts

@@ -2,20 +2,55 @@ import { Principal } from '@dfinity/principal';
 import type { Controller } from '../../declarations/mission_control/mission_control.did';
 import type { MissionControlParameters } from '../types/actor.types';
 import type { SetControllerParams } from '../types/controllers.types';
+/**
+ * Retrieves the version of Mission Control.
+ * @param {Object} params - The parameters for Mission Control.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of Mission Control.
+ */
 export declare const missionControlVersion: (params: {
     missionControl: MissionControlParameters;
 }) => Promise<string>;
+/**
+ * Upgrades the Mission Control with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading Mission Control.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @throws Will throw an error if no mission control principal is defined.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
 export declare const upgradeMissionControl: ({ missionControl, wasm_module }: {
     missionControl: MissionControlParameters;
     wasm_module: Uint8Array;
 }) => Promise<void>;
+/**
+ * Sets the controller for the specified satellites.
+ * @param {Object} params - The parameters for setting the satellites controller.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @param {Principal[]} params.satelliteIds - The IDs of the satellites.
+ * @param {SetControllerParams} params - Additional parameters for setting the controller.
+ * @returns {Promise<void>} A promise that resolves when the controller is set.
+ */
 export declare const setSatellitesController: ({ controllerId, profile, ...rest }: {
     missionControl: MissionControlParameters;
     satelliteIds: Principal[];
-} & SetControllerParams) => Promise<undefined>;
+} & SetControllerParams) => Promise<void>;
+/**
+ * Sets the controller for Mission Control.
+ * @param {Object} params - The parameters for setting the Mission Control controller.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @param {SetControllerParams} params - Additional parameters for setting the controller.
+ * @returns {Promise<void>} A promise that resolves when the controller is set.
+ */
 export declare const setMissionControlController: ({ controllerId, profile, ...rest }: {
     missionControl: MissionControlParameters;
-} & SetControllerParams) => Promise<undefined>;
+} & SetControllerParams) => Promise<void>;
+/**
+ * Lists the controllers of Mission Control.
+ * @param {Object} params - The parameters for listing the controllers.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
 export declare const listMissionControlControllers: (params: {
     missionControl: MissionControlParameters;
 }) => Promise<[Principal, Controller][]>;

package/dist/types/services/orbiter.services.d.ts

@@ -2,17 +2,44 @@ import { Principal } from '@dfinity/principal';
 import type { Controller } from '../../declarations/mission_control/mission_control.did';
 import type { MemorySize } from '../../declarations/orbiter/orbiter.did';
 import type { OrbiterParameters } from '../types/actor.types';
+/**
+ * Retrieves the version of the Orbiter.
+ * @param {Object} params - The parameters for the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of the Orbiter.
+ */
 export declare const orbiterVersion: (params: {
     orbiter: OrbiterParameters;
 }) => Promise<string>;
+/**
+ * Upgrades the Orbiter with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @param {boolean} [params.reset=false] - Whether to reset the Orbiter (reinstall) instead of upgrading.
+ * @throws Will throw an error if no orbiter principal is defined.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
 export declare const upgradeOrbiter: ({ orbiter, wasm_module, reset }: {
     orbiter: OrbiterParameters;
     wasm_module: Uint8Array;
     reset?: boolean;
 }) => Promise<void>;
+/**
+ * Retrieves the memory size of the Orbiter.
+ * @param {Object} params - The parameters for the Orbiter.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<MemorySize>} A promise that resolves to the memory size of the Orbiter.
+ */
 export declare const orbiterMemorySize: (params: {
     orbiter: OrbiterParameters;
 }) => Promise<MemorySize>;
+/**
+ * Lists the controllers of the Orbiter.
+ * @param {Object} params - The parameters for listing the controllers.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
 export declare const listOrbiterControllers: (params: {
     orbiter: OrbiterParameters;
 }) => Promise<[Principal, Controller][]>;

package/dist/types/services/releases.services.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Checks if the selected version can be upgraded from the current version.
+ * @param {Object} params - The parameters for the version check.
+ * @param {string} params.currentVersion - The current version.
+ * @param {string} params.selectedVersion - The selected version.
+ * @returns {Object} An object indicating whether the upgrade can proceed.
+ * @returns {boolean} returns.canUpgrade - Whether the selected version can be upgraded from the current version.
+ */
 export declare const checkUpgradeVersion: ({ currentVersion, selectedVersion }: {
     currentVersion: string;
     selectedVersion: string;

package/dist/types/services/satellite.services.d.ts

@@ -4,35 +4,104 @@ import type { Controller, MemorySize, SetControllersArgs } from '../../declarati
 import type { SatelliteParameters } from '../types/actor.types';
 import type { BuildType } from '../types/build.types';
 import type { CustomDomain } from '../types/customdomain.types';
+/**
+ * Sets the configuration for a satellite.
+ * @param {Object} params - The parameters for setting the configuration.
+ * @param {Object} params.config - The satellite configuration.
+ * @param {Object} params.config.storage - The storage configuration.
+ * @param {Array<StorageConfigHeader>} params.config.storage.headers - The headers configuration.
+ * @param {Array<StorageConfigRewrite>} params.config.storage.rewrites - The rewrites configuration.
+ * @param {Array<StorageConfigRedirect>} params.config.storage.redirects - The redirects configuration.
+ * @param {string} params.config.storage.iframe - The iframe configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the configuration is set.
+ */
 export declare const setConfig: ({ config: { storage: { headers: configHeaders, rewrites: configRewrites, redirects: configRedirects, iframe: configIFrame } }, satellite }: {
     config: Required<Pick<SatelliteConfig, 'storage'>>;
     satellite: SatelliteParameters;
 }) => Promise<void>;
+/**
+ * Sets the authentication configuration for a satellite.
+ * @param {Object} params - The parameters for setting the authentication configuration.
+ * @param {Object} params.config - The satellite configuration.
+ * @param {Object} params.config.authentication - The authentication configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the authentication configuration is set.
+ */
 export declare const setAuthConfig: ({ config: { authentication: { internetIdentity } }, ...rest }: {
     config: Required<Pick<SatelliteConfig, 'authentication'>>;
     satellite: SatelliteParameters;
 }) => Promise<void>;
+/**
+ * Gets the authentication configuration for a satellite.
+ * @param {Object} params - The parameters for getting the authentication configuration.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<AuthenticationConfig | undefined>} A promise that resolves to the authentication configuration or undefined if not found.
+ */
 export declare const getAuthConfig: ({ satellite }: {
     satellite: SatelliteParameters;
 }) => Promise<AuthenticationConfig | undefined>;
+/**
+ * Lists the rules for a satellite.
+ * @param {Object} params - The parameters for listing the rules.
+ * @param {RulesType} params.type - The type of rules to list.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<Rule[]>} A promise that resolves to an array of rules.
+ */
 export declare const listRules: ({ type, satellite }: {
     type: RulesType;
     satellite: SatelliteParameters;
 }) => Promise<Rule[]>;
+/**
+ * Sets a rule for a satellite.
+ * @param {Object} params - The parameters for setting the rule.
+ * @param {Rule} params.rule - The rule to set.
+ * @param {RulesType} params.type - The type of rule.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the rule is set.
+ */
 export declare const setRule: ({ rule: { collection, ...rest }, type, satellite }: {
     rule: Rule;
     type: RulesType;
     satellite: SatelliteParameters;
 }) => Promise<void>;
+/**
+ * Retrieves the version of the satellite.
+ * @param {Object} params - The parameters for retrieving the version.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<string>} A promise that resolves to the version of the satellite.
+ */
 export declare const satelliteVersion: (params: {
     satellite: SatelliteParameters;
 }) => Promise<string>;
+/**
+ * Retrieves the build version of the satellite.
+ * @param {Object} params - The parameters for retrieving the build version.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<string>} A promise that resolves to the build version of the satellite.
+ */
 export declare const satelliteBuildVersion: (params: {
     satellite: SatelliteParameters;
 }) => Promise<string>;
+/**
+ * Retrieves the build type of the satellite.
+ * @param {Object} params - The parameters for retrieving the build type.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<BuildType | undefined>} A promise that resolves to the build type of the satellite or undefined if not found.
+ */
 export declare const satelliteBuildType: ({ satellite: { satelliteId, ...rest } }: {
     satellite: SatelliteParameters;
 }) => Promise<BuildType | undefined>;
+/**
+ * Upgrades the satellite with the provided WASM module.
+ * @param {Object} params - The parameters for upgrading the satellite.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {Uint8Array} params.wasm_module - The WASM module for the upgrade.
+ * @param {boolean} params.deprecated - Whether the upgrade is deprecated.
+ * @param {boolean} params.deprecatedNoScope - Whether the upgrade is deprecated with no scope.
+ * @param {boolean} [params.reset=false] - Whether to reset the satellite (reinstall) instead of upgrading.
+ * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ */
 export declare const upgradeSatellite: ({ satellite, wasm_module, deprecated, deprecatedNoScope, reset }: {
     satellite: SatelliteParameters;
     wasm_module: Uint8Array;
@@ -40,36 +109,97 @@ export declare const upgradeSatellite: ({ satellite, wasm_module, deprecated, de
     deprecatedNoScope: boolean;
     reset?: boolean;
 }) => Promise<void>;
+/**
+ * Lists the custom domains for a satellite.
+ * @param {Object} params - The parameters for listing the custom domains.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<CustomDomain[]>} A promise that resolves to an array of custom domains.
+ */
 export declare const listCustomDomains: ({ satellite }: {
     satellite: SatelliteParameters;
 }) => Promise<CustomDomain[]>;
+/**
+ * Sets the custom domains for a satellite.
+ * @param {Object} params - The parameters for setting the custom domains.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {CustomDomain[]} params.domains - The custom domains to set.
+ * @returns {Promise<void[]>} A promise that resolves when the custom domains are set.
+ */
 export declare const setCustomDomains: ({ satellite, domains }: {
     satellite: SatelliteParameters;
     domains: CustomDomain[];
 }) => Promise<void[]>;
+/**
+ * Retrieves the memory size of a satellite.
+ * @param {Object} params - The parameters for retrieving the memory size.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<MemorySize>} A promise that resolves to the memory size of the satellite.
+ */
 export declare const satelliteMemorySize: (params: {
     satellite: SatelliteParameters;
 }) => Promise<MemorySize>;
+/**
+ * Counts the documents in a collection.
+ * @param {Object} params - The parameters for counting the documents.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<bigint>} A promise that resolves to the number of documents in the collection.
+ */
 export declare const countDocs: (params: {
     collection: string;
     satellite: SatelliteParameters;
 }) => Promise<bigint>;
+/**
+ * Deletes the documents in a collection.
+ * @param {Object} params - The parameters for deleting the documents.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the documents are deleted.
+ */
 export declare const deleteDocs: (params: {
     collection: string;
     satellite: SatelliteParameters;
 }) => Promise<void>;
+/**
+ * Counts the assets in a collection.
+ * @param {Object} params - The parameters for counting the assets.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<bigint>} A promise that resolves to the number of assets in the collection.
+ */
 export declare const countAssets: (params: {
     collection: string;
     satellite: SatelliteParameters;
 }) => Promise<bigint>;
+/**
+ * Deletes the assets in a collection.
+ * @param {Object} params - The parameters for deleting the assets.
+ * @param {string} params.collection - The name of the collection.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @returns {Promise<void>} A promise that resolves when the assets are deleted.
+ */
 export declare const deleteAssets: (params: {
     collection: string;
     satellite: SatelliteParameters;
 }) => Promise<void>;
+/**
+ * Lists the controllers of a satellite.
+ * @param {Object} params - The parameters for listing the controllers.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {boolean} [params.deprecatedNoScope] - Whether to list deprecated no-scope controllers.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
 export declare const listSatelliteControllers: ({ deprecatedNoScope, ...params }: {
     satellite: SatelliteParameters;
     deprecatedNoScope?: boolean;
 }) => Promise<[Principal, Controller][]>;
+/**
+ * Sets the controllers of a satellite.
+ * @param {Object} params - The parameters for setting the controllers.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters.
+ * @param {SetControllersArgs} params.args - The arguments for setting the controllers.
+ * @returns {Promise<[Principal, Controller][]>} A promise that resolves to a list of controllers.
+ */
 export declare const setSatelliteControllers: (params: {
     satellite: SatelliteParameters;
     args: SetControllersArgs;

package/dist/types/types/actor.types.d.ts

@@ -1,18 +1,76 @@
 import type { Identity } from '@dfinity/agent';
+/**
+ * Represents the parameters for an actor.
+ * @interface
+ */
 export interface ActorParameters {
+    /**
+     * The identity associated with the actor.
+     * @type {Identity}
+     */
     identity: Identity;
+    /**
+     * A custom fetch function to use for network requests. Useful in NodeJS context.
+     * @type {typeof fetch}
+     * @optional
+     */
     fetch?: typeof fetch;
+    /**
+     * Specifies whether the actor is calling the local development Docker container or provides the container URL.
+     * @type {boolean | string}
+     * @optional
+     */
     container?: boolean | string;
 }
+/**
+ * Represents the parameters for a satellite actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
 export interface SatelliteParameters extends ActorParameters {
+    /**
+     * The unique identifier for the satellite.
+     * @type {string}
+     * @optional
+     */
     satelliteId?: string;
 }
+/**
+ * Represents the parameters for a Mission Control actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
 export interface MissionControlParameters extends ActorParameters {
+    /**
+     * The unique identifier for Mission Control.
+     * @type {string}
+     * @optional
+     */
     missionControlId?: string;
 }
+/**
+ * Represents the parameters for a Console actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
 export interface ConsoleParameters extends ActorParameters {
+    /**
+     * The unique identifier for the console.
+     * @type {string}
+     * @optional
+     */
     consoleId?: string;
 }
+/**
+ * Represents the parameters for an Orbiter actor.
+ * @interface
+ * @extends {ActorParameters}
+ */
 export interface OrbiterParameters extends ActorParameters {
+    /**
+     * The unique identifier for the Orbiter.
+     * @type {string}
+     * @optional
+     */
     orbiterId?: string;
 }

package/dist/types/types/build.types.d.ts

@@ -1 +1,5 @@
+/**
+ * Represents the type of build.
+ * @typedef {'stock' | 'extended'} BuildType
+ */
 export type BuildType = 'stock' | 'extended';

package/dist/types/types/controllers.types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Represents the parameters for setting a controller.
+ * @typedef {Object} SetControllerParams
+ * @property {string} controllerId - The ID of the controller.
+ * @property {string | null | undefined} profile - The profile of the controller.
+ */
 export type SetControllerParams = {
     controllerId: string;
     profile: string | null | undefined;

package/dist/types/types/customdomain.types.d.ts

@@ -1,6 +1,27 @@
+/**
+ * Represents a custom domain configuration.
+ * @interface
+ */
 export interface CustomDomain {
+    /**
+     * The custom domain name.
+     * @type {string}
+     */
     domain: string;
+    /**
+     * The boundary nodes ID associated with the custom domain.
+     * @type {string}
+     * @optional
+     */
     bn_id?: string;
+    /**
+     * The timestamp when the custom domain was last updated.
+     * @type {bigint}
+     */
     updated_at: bigint;
+    /**
+     * The timestamp when the custom domain was created.
+     * @type {bigint}
+     */
     created_at: bigint;
 }

package/dist/types/types/ic.types.d.ts

@@ -1,4 +1,12 @@
 import type { canister_id, install_code_args, wasm_module } from '../../declarations/ic/ic.did';
+/**
+ * Represents the parameters for installing code on a canister.
+ * @typedef {Object} InstallCodeParams
+ * @property {Uint8Array} arg - The argument to pass to the installation.
+ * @property {wasm_module} wasm_module - The WebAssembly module to install.
+ * @property {canister_id} canister_id - The ID of the canister.
+ * @property {install_code_args['mode']} mode - The mode of the installation.
+ */
 export type InstallCodeParams = {
     arg: Uint8Array;
     wasm_module: wasm_module;

package/dist/types/types/releases.types.d.ts

@@ -1,14 +1,62 @@
+/**
+ * Represents metadata for a release.
+ * @interface
+ */
 export interface ReleaseMetadata {
+    /**
+     * The tag of the release.
+     * @type {string}
+     */
     tag: string;
+    /**
+     * The version of the console included in the release.
+     * @type {string}
+     */
     console: string;
+    /**
+     * The version of the observatory included in the release.
+     * @type {string}
+     */
     observatory: string;
+    /**
+     * The version of the mission control included in the release.
+     * @type {string}
+     */
     mission_control: string;
+    /**
+     * The version of the satellite included in the release.
+     * @type {string}
+     */
     satellite: string;
+    /**
+     * The version of the orbiter included in the release.
+     * @type {string}
+     */
     orbiter: string;
 }
+/**
+ * Represents metadata for multiple releases.
+ * @interface
+ */
 export interface ReleasesMetadata {
+    /**
+     * The list of mission control versions.
+     * @type {string[]}
+     */
     mission_controls: string[];
+    /**
+     * The list of satellite versions.
+     * @type {string[]}
+     */
     satellites: string[];
+    /**
+     * The list of orbiter versions.
+     * @type {string[]}
+     */
     orbiters: string[];
+    /**
+     * The list of release metadata.
+     * @type {ReleaseMetadata[]}
+     */
     releases: ReleaseMetadata[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.0.48-next-2024-05-17.4",
+  "version": "0.0.49-next-2024-05-21",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",