@junobuild/admin 0.0.58-next-2024-11-22 → 0.0.58-next-2024-11-24

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

@@ -1,10 +1,32 @@
 import { CanisterStatus } from '@dfinity/agent';
-import { InstallCodeParams } from '@dfinity/ic-management';
+import { type chunk_hash, type InstallChunkedCodeParams, type UploadChunkParams, InstallCodeParams } from '@dfinity/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';
-export declare const upgradeCode: ({ actor, code }: {
+export declare const installCode: ({ actor, code }: {
     actor: ActorParameters;
     code: InstallCodeParams;
 }) => Promise<void>;
+export declare const storedChunks: ({ actor, canisterId }: {
+    actor: ActorParameters;
+    canisterId: Principal;
+}) => Promise<chunk_hash[]>;
+export declare const clearChunkStore: ({ actor, canisterId }: {
+    actor: ActorParameters;
+    canisterId: Principal;
+}) => Promise<void>;
+export declare const uploadChunk: ({ actor, chunk }: {
+    actor: ActorParameters;
+    chunk: UploadChunkParams;
+}) => Promise<chunk_hash>;
+export declare const installChunkedCode: ({ actor, code }: {
+    actor: ActorParameters;
+    code: InstallChunkedCodeParams;
+}) => Promise<void>;
+export declare const canisterStatus: ({ actor, canisterId }: {
+    actor: ActorParameters;
+    canisterId: Principal;
+}) => Promise<CanisterStatusResponse>;
 export declare const canisterMetadata: ({ canisterId, path, ...rest }: ActorParameters & {
     canisterId: string | undefined;
     path: string;

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

@@ -0,0 +1,5 @@
+import type { canister_install_mode } from '@dfinity/ic-management';
+export declare const SIMPLE_INSTALL_MAX_WASM_SIZE = 2000000;
+export declare const INSTALL_MAX_CHUNK_SIZE = 1000000;
+export declare const INSTALL_MODE_RESET: canister_install_mode;
+export declare const INSTALL_MODE_UPGRADE: canister_install_mode;

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

@@ -0,0 +1,3 @@
+export declare class UpgradeCodeUnchangedError extends Error {
+    constructor();
+}

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

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

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

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

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+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';
@@ -20,3 +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 './utils/crypto.utils';

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

@@ -4,10 +4,12 @@ import type { MissionControlParameters } from '../types/actor.types';
  * @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.
  */
-export declare const upgradeMissionControl: ({ missionControl, wasmModule }: {
+export declare const upgradeMissionControl: ({ missionControl, wasmModule, preClearChunks }: {
     missionControl: MissionControlParameters;
     wasmModule: Uint8Array;
+    preClearChunks?: boolean;
 }) => Promise<void>;

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

@@ -1,15 +1,20 @@
+import { Principal } from '@dfinity/principal';
 import type { OrbiterParameters } from '../types/actor.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.
  */
-export declare const upgradeOrbiter: ({ orbiter, wasmModule, reset }: {
+export declare const upgradeOrbiter: ({ orbiter, missionControlId, wasmModule, reset, preClearChunks }: {
     orbiter: OrbiterParameters;
+    missionControlId?: Principal;
     wasmModule: Uint8Array;
     reset?: boolean;
+    preClearChunks?: boolean;
 }) => Promise<void>;

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

@@ -1,18 +1,23 @@
+import { Principal } from '@dfinity/principal';
 import type { SatelliteParameters } from '../types/actor.types';
 /**
  * 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 {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.
  */
-export declare const upgradeSatellite: ({ satellite, wasmModule, deprecated, deprecatedNoScope, reset }: {
+export declare const upgradeSatellite: ({ satellite, missionControlId, wasmModule, deprecated, deprecatedNoScope, reset, preClearChunks }: {
     satellite: SatelliteParameters;
+    missionControlId?: Principal;
     wasmModule: Uint8Array;
     deprecated: boolean;
     deprecatedNoScope: boolean;
     reset?: boolean;
+    preClearChunks?: boolean;
 }) => Promise<void>;

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

@@ -0,0 +1,12 @@
+import type { canister_install_mode } from '@dfinity/ic-management';
+import { Principal } from '@dfinity/principal';
+import { ActorParameters } from './actor.types';
+export interface UpgradeCodeParams {
+    actor: ActorParameters;
+    canisterId: Principal;
+    missionControlId?: Principal;
+    wasmModule: Uint8Array;
+    arg: Uint8Array;
+    mode: canister_install_mode;
+    preClearChunks?: boolean;
+}

package/dist/types/utils/array.utils.d.ts

@@ -0,0 +1 @@
+export declare const uint8ArrayToHexString: (bytes: Uint8Array | number[]) => string;

package/dist/types/utils/crypto.utils.d.ts

@@ -0,0 +1,2 @@
+export declare const blobSha256: (blob: Blob) => Promise<string>;
+export declare const uint8ArraySha256: (data: Uint8Array) => Promise<string>;

package/package.json

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