@junobuild/admin 0.0.59 → 0.0.61-next-2024-12-20

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

@@ -1,5 +1,6 @@
 import { CanisterStatus } from '@dfinity/agent';
-import { type chunk_hash, type InstallChunkedCodeParams, type UploadChunkParams, InstallCodeParams } from '@dfinity/ic-management';
+import { type chunk_hash, type InstallChunkedCodeParams, type UploadChunkParams, InstallCodeParams, list_canister_snapshots_result, snapshot_id } from '@dfinity/ic-management';
+import type { take_canister_snapshot_result } from '@dfinity/ic-management/dist/candid/ic-management';
 import type { CanisterStatusResponse } from '@dfinity/ic-management/dist/types/types/ic-management.responses';
 import { Principal } from '@dfinity/principal';
 import type { ActorParameters } from '../types/actor.types';
@@ -39,3 +40,12 @@ export declare const canisterMetadata: ({ canisterId, path, ...rest }: ActorPara
     canisterId: string | undefined;
     path: string;
 }) => Promise<CanisterStatus.Status | undefined>;
+export declare const listCanisterSnapshots: ({ actor, canisterId }: {
+    actor: ActorParameters;
+    canisterId: Principal;
+}) => Promise<list_canister_snapshots_result>;
+export declare const takeCanisterSnapshot: ({ actor, ...rest }: {
+    actor: ActorParameters;
+    canisterId: Principal;
+    snapshotId?: snapshot_id;
+}) => Promise<take_canister_snapshot_result>;

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

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

package/dist/types/index.d.ts

@@ -2,6 +2,7 @@ export * from './errors/upgrade.errors';
 export * from './services/mission-control.controllers.services';
 export * from './services/mission-control.upgrade.services';
 export * from './services/mission-control.version.services';
+export * from './services/module.upgrade.services';
 export * from './services/orbiter.controllers.services';
 export * from './services/orbiter.memory.services';
 export * from './services/orbiter.upgrade.services';

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

@@ -6,10 +6,11 @@ import { UpgradeCodeParams } from '../types/upgrade.types';
  * @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 {boolean} [params.takeSnapshot=true] - Optional. Whether to take a snapshot before performing the upgrade. Defaults to true.
  * @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, ...rest }: {
     missionControl: MissionControlParameters;
-} & Pick<UpgradeCodeParams, "wasmModule" | "preClearChunks" | "onProgress">) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "preClearChunks" | "takeSnapshot" | "onProgress">) => Promise<void>;

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

@@ -0,0 +1,22 @@
+import type { ActorParameters } from '../types/actor.types';
+import type { UpgradeCodeParams } from '../types/upgrade.types';
+/**
+ * Upgrades a module with the provided WASM code and arguments. This generic is notably useful for Juno Docker.
+ *
+ * @param {Object} params - Parameters for upgrading the module.
+ * @param {ActorParameters} params.actor - The actor parameters associated with the module.
+ * @param {Principal} params.canisterId - The ID of the canister being upgraded.
+ * @param {Principal} [params.missionControlId] - Optional. An ID to store and reuse WASM chunks across installations.
+ * @param {Uint8Array} params.wasmModule - The WASM code to be installed during the upgrade.
+ * @param {Uint8Array} params.arg - The initialization argument for the module upgrade.
+ * @param {canister_install_mode} params.mode - The installation mode, e.g., `upgrade` or `reinstall`.
+ * @param {boolean} [params.preClearChunks] - Optional. Forces clearing existing chunks before uploading a chunked WASM module. Recommended for WASM modules larger than 2MB.
+ * @param {function} [params.onProgress] - Optional. Callback function to track progress during the upgrade process.
+ * @param {boolean} [params.reset=false] - Optional. Specifies whether to reset the module (reinstall) instead of performing an upgrade. Defaults to `false`.
+ * @throws {Error} Will throw an error if the parameters are invalid or if the upgrade process fails.
+ * @returns {Promise<void>} Resolves when the upgrade process is complete.
+ */
+export declare const upgradeModule: (params: {
+    actor: ActorParameters;
+    reset?: boolean;
+} & UpgradeCodeParams) => Promise<void>;

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

@@ -8,6 +8,7 @@ import { UpgradeCodeParams } from '../types/upgrade.types';
  * @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 {boolean} [params.takeSnapshot=true] - Optional. Whether to take a snapshot before performing the upgrade. Defaults to true.
  * @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.
@@ -15,4 +16,4 @@ import { UpgradeCodeParams } from '../types/upgrade.types';
 export declare const upgradeOrbiter: ({ orbiter, reset, ...rest }: {
     orbiter: OrbiterParameters;
     reset?: boolean;
-} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "onProgress">) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "takeSnapshot" | "onProgress">) => Promise<void>;

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

@@ -10,6 +10,7 @@ import { UpgradeCodeParams } from '../types/upgrade.types';
  * @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 {boolean} [params.takeSnapshot=true] - Optional. Whether to take a snapshot before performing the upgrade. Defaults to true.
  * @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.
@@ -19,4 +20,4 @@ export declare const upgradeSatellite: ({ satellite, deprecated, deprecatedNoSco
     deprecated: boolean;
     deprecatedNoScope: boolean;
     reset?: boolean;
-} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "onProgress">) => Promise<void>;
+} & Pick<UpgradeCodeParams, "wasmModule" | "missionControlId" | "preClearChunks" | "takeSnapshot" | "onProgress">) => Promise<void>;

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

@@ -4,8 +4,9 @@ import { ActorParameters } from './actor.types';
 export declare enum UpgradeCodeProgressStep {
     AssertingExistingCode = 0,
     StoppingCanister = 1,
-    UpgradingCode = 2,
-    RestartingCanister = 3
+    TakingSnapshot = 2,
+    UpgradingCode = 3,
+    RestartingCanister = 4
 }
 export type UpgradeCodeProgressState = 'in_progress' | 'success' | 'error';
 export interface UpgradeCodeProgress {
@@ -20,5 +21,6 @@ export interface UpgradeCodeParams {
     arg: Uint8Array;
     mode: canister_install_mode;
     preClearChunks?: boolean;
+    takeSnapshot?: boolean;
     onProgress?: (progress: UpgradeCodeProgress) => void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.0.59",
+  "version": "0.0.61-next-2024-12-20",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -50,12 +50,13 @@
   ],
   "homepage": "https://juno.build",
   "peerDependencies": {
-    "@dfinity/agent": "^2.1.3",
-    "@dfinity/ic-management": "^6.0.0-next-2024-11-27.1",
-    "@dfinity/identity": "^2.1.3",
-    "@dfinity/principal": "^2.1.3",
+    "@dfinity/agent": "*",
+    "@dfinity/candid": "*",
+    "@dfinity/ic-management": "*",
+    "@dfinity/identity": "*",
+    "@dfinity/principal": "*",
     "@junobuild/config": "*",
     "@junobuild/utils": "*",
-    "semver": "7.*"
+    "semver": "*"
   }
-}
+}