@junobuild/admin 0.0.58-next-2024-11-25.3 → 0.0.58-next-2024-11-26

package/dist/types/handlers/upgrade.handlers.d.ts

@@ -1,2 +1,2 @@
 import { UpgradeCodeParams } from '../types/upgrade.types';
-export declare const upgrade: ({ wasmModule, canisterId, actor, ...rest }: UpgradeCodeParams) => Promise<void>;
+export declare const upgrade: ({ wasmModule, canisterId, actor, onProgress, ...rest }: UpgradeCodeParams) => Promise<void>;

package/dist/types/index.d.ts

@@ -21,5 +21,5 @@ export type * from './types/build.types';
 export type * from './types/controllers.types';
 export type * from './types/customdomain.types';
 export type * from './types/releases.types';
-export type * from './types/upgrade.types';
+export * from './types/upgrade.types';
 export * from './utils/crypto.utils';

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

@@ -1,15 +1,15 @@
 import type { MissionControlParameters } from '../types/actor.types';
+import { UpgradeCodeParams } from '../types/upgrade.types';
 /**
  * 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.
- * @param {boolean} [params.preClearChunks] - An optional parameter to force clearing the chunks before uploading the chunked WASM. Apply if WASM > 2Mb.
- * @throws Will throw an error if no mission control principal is defined.
- * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ * @param {Object} params - The parameters for upgrading the Mission Control.
+ * @param {MissionControlParameters} params.missionControl - The Mission Control parameters, including the actor and mission control ID.
+ * @param {Uint8Array} params.wasmModule - The WASM module to be installed during the upgrade.
+ * @param {boolean} [params.preClearChunks] - Optional. Whether to force clearing chunks before uploading a chunked WASM module. Recommended if the WASM exceeds 2MB.
+ * @param {function} [params.onProgress] - Optional. Callback function to report progress during the upgrade process.
+ * @throws {Error} Will throw an error if the mission control principal is not defined.
+ * @returns {Promise<void>} Resolves when the upgrade process is complete.
  */
-export declare const upgradeMissionControl: ({ missionControl, wasmModule, preClearChunks }: {
+export declare const upgradeMissionControl: ({ missionControl, ...rest }: {
     missionControl: MissionControlParameters;
-    wasmModule: Uint8Array;
-    preClearChunks?: boolean;
-}) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "preClearChunks" | "onProgress">) => Promise<void>;

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

@@ -1,20 +1,18 @@
-import { Principal } from '@dfinity/principal';
 import type { OrbiterParameters } from '../types/actor.types';
+import { UpgradeCodeParams } from '../types/upgrade.types';
 /**
  * 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 {Principal} [params.missionControlId] - The optional Mission Control ID in which the WASM chunks can potentially be stored. Useful to reuse chunks across installations.
- * @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.
- * @param {boolean} [params.preClearChunks] - An optional parameter to force clearing the chunks before uploading the chunked WASM. Apply if WASM > 2Mb.
- * @throws Will throw an error if no orbiter principal is defined.
- * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ * @param {OrbiterParameters} params.orbiter - The Orbiter parameters, including the actor and orbiter ID.
+ * @param {Principal} [params.missionControlId] - Optional. The Mission Control ID to potentially store WASM chunks, enabling reuse across installations.
+ * @param {Uint8Array} params.wasmModule - The WASM module to be installed during the upgrade.
+ * @param {boolean} [params.reset=false] - Optional. Indicates whether to reset the Orbiter (reinstall) instead of performing an upgrade. Defaults to `false`.
+ * @param {boolean} [params.preClearChunks] - Optional. Forces clearing existing chunks before uploading a chunked WASM module. Recommended if the WASM exceeds 2MB.
+ * @param {function} [params.onProgress] - Optional. Callback function to track progress during the upgrade process.
+ * @throws {Error} Will throw an error if the Orbiter principal is not defined.
+ * @returns {Promise<void>} Resolves when the upgrade process is complete.
  */
-export declare const upgradeOrbiter: ({ orbiter, missionControlId, wasmModule, reset, preClearChunks }: {
+export declare const upgradeOrbiter: ({ orbiter, reset, ...rest }: {
     orbiter: OrbiterParameters;
-    missionControlId?: Principal;
-    wasmModule: Uint8Array;
     reset?: boolean;
-    preClearChunks?: boolean;
-}) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "onProgress">) => Promise<void>;

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

@@ -1,23 +1,22 @@
-import { Principal } from '@dfinity/principal';
 import type { SatelliteParameters } from '../types/actor.types';
+import { UpgradeCodeParams } from '../types/upgrade.types';
 /**
- * Upgrades the satellite with the provided WASM module.
+ * Upgrades a satellite with the provided WASM module.
  * @param {Object} params - The parameters for upgrading the satellite.
- * @param {SatelliteParameters} params.satellite - The satellite parameters.
- * @param {Principal} [params.missionControlId] - The optional Mission Control ID in which the WASM chunks can potentially be stored. Useful to reuse chunks across installations.
- * @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.
- * @param {boolean} [params.preClearChunks] - An optional parameter to force clearing the chunks before uploading the chunked WASM. Apply if WASM > 2Mb.
- * @returns {Promise<void>} A promise that resolves when the upgrade is complete.
+ * @param {SatelliteParameters} params.satellite - The satellite parameters, including the actor and satellite ID.
+ * @param {Principal} [params.missionControlId] - Optional. The Mission Control ID to potentially store WASM chunks, enabling reuse across installations.
+ * @param {Uint8Array} params.wasmModule - The WASM module to be installed during the upgrade.
+ * @param {boolean} params.deprecated - Indicates whether the upgrade is deprecated.
+ * @param {boolean} params.deprecatedNoScope - Indicates whether the upgrade is deprecated and has no scope.
+ * @param {boolean} [params.reset=false] - Optional. Specifies whether to reset the satellite (reinstall) instead of performing an upgrade. Defaults to `false`.
+ * @param {boolean} [params.preClearChunks] - Optional. Forces clearing existing chunks before uploading a chunked WASM module. Recommended if the WASM exceeds 2MB.
+ * @param {function} [params.onProgress] - Optional. Callback function to track progress during the upgrade process.
+ * @throws {Error} Will throw an error if the satellite parameters are invalid or missing required fields.
+ * @returns {Promise<void>} Resolves when the upgrade process is complete.
  */
-export declare const upgradeSatellite: ({ satellite, missionControlId, wasmModule, deprecated, deprecatedNoScope, reset, preClearChunks }: {
+export declare const upgradeSatellite: ({ satellite, deprecated, deprecatedNoScope, reset, ...rest }: {
     satellite: SatelliteParameters;
-    missionControlId?: Principal;
-    wasmModule: Uint8Array;
     deprecated: boolean;
     deprecatedNoScope: boolean;
     reset?: boolean;
-    preClearChunks?: boolean;
-}) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "onProgress">) => Promise<void>;

package/dist/types/types/upgrade.types.d.ts

@@ -1,6 +1,12 @@
 import type { canister_install_mode } from '@dfinity/ic-management';
 import { Principal } from '@dfinity/principal';
 import { ActorParameters } from './actor.types';
+export declare enum UpgradeCodeProgress {
+    AssertingExistingCode = 0,
+    StoppingCanister = 1,
+    UpgradingCode = 2,
+    RestartingCanister = 3
+}
 export interface UpgradeCodeParams {
     actor: ActorParameters;
     canisterId: Principal;
@@ -9,4 +15,5 @@ export interface UpgradeCodeParams {
     arg: Uint8Array;
     mode: canister_install_mode;
     preClearChunks?: boolean;
+    onProgress?: (progress: UpgradeCodeProgress) => void;
 }

package/package.json

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