@junobuild/admin 0.1.6 → 0.1.8-next-2025-04-06

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

@@ -1,5 +1,5 @@
 import { CanisterStatus } from '@dfinity/agent';
-import { type chunk_hash, type InstallChunkedCodeParams, type UploadChunkParams, InstallCodeParams, list_canister_snapshots_result, snapshot_id } from '@dfinity/ic-management';
+import { type chunk_hash, type InstallChunkedCodeParams, type InstallCodeParams, type list_canister_snapshots_result, type snapshot_id, type UploadChunkParams } 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';
@@ -37,7 +37,7 @@ export declare const canisterStatus: ({ actor, canisterId }: {
     canisterId: Principal;
 }) => Promise<CanisterStatusResponse>;
 export declare const canisterMetadata: ({ canisterId, path, ...rest }: ActorParameters & {
-    canisterId: string | undefined;
+    canisterId: Principal | string | undefined;
     path: string;
 }) => Promise<CanisterStatus.Status | undefined>;
 export declare const listCanisterSnapshots: ({ actor, canisterId }: {

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

@@ -1,2 +1,2 @@
-import { UpgradeCodeParams } from '../types/upgrade.types';
+import type { 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

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

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

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

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ export * from './services/orbiter.controllers.services';
 export * from './services/orbiter.memory.services';
 export * from './services/orbiter.upgrade.services';
 export * from './services/orbiter.version.services';
+export * from './services/package.services';
 export * from './services/releases.services';
 export * from './services/satellite.assets.services';
 export * from './services/satellite.config.services';

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

@@ -1,4 +1,4 @@
-import { Principal } from '@dfinity/principal';
+import type { 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';

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

@@ -1,5 +1,5 @@
 import type { MissionControlParameters } from '../types/actor.types';
-import { UpgradeCodeParams } from '../types/upgrade.types';
+import type { UpgradeCodeParams } from '../types/upgrade.types';
 /**
  * Upgrades the Mission Control with the provided WASM module.
  * @param {Object} params - The parameters for upgrading the Mission Control.

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

@@ -1,4 +1,4 @@
-import { Principal } from '@dfinity/principal';
+import type { Principal } from '@dfinity/principal';
 import type { Controller } from '../../declarations/mission_control/mission_control.did';
 import type { OrbiterParameters } from '../types/actor.types';
 /**

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

@@ -1,5 +1,5 @@
 import type { OrbiterParameters } from '../types/actor.types';
-import { UpgradeCodeParams } from '../types/upgrade.types';
+import type { UpgradeCodeParams } from '../types/upgrade.types';
 /**
  * Upgrades the Orbiter with the provided WASM module.
  * @param {Object} params - The parameters for upgrading the Orbiter.

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

@@ -0,0 +1,60 @@
+import type { Principal } from '@dfinity/principal';
+import { type JunoPackage } from '@junobuild/config';
+import type { ActorParameters } from '../types/actor.types';
+/**
+ * Parameters required to retrieve a `juno:package` metadata section.
+ *
+ * @typedef {Object} GetJunoPackageParams
+ * @property {Principal | string} moduleId - The ID of the canister module (as a Principal or string).
+ * @property {ActorParameters} [ActorParameters] - Additional actor parameters for making the canister call.
+ */
+export type GetJunoPackageParams = {
+    moduleId: Principal | string;
+} & ActorParameters;
+/**
+ * Get the `juno:package` metadata from the public custom section of a given module.
+ *
+ * @param {Object} params - The parameters to fetch the metadata.
+ * @param {Principal | string} params.moduleId - The canister ID (as a `Principal` or string) from which to retrieve the metadata.
+ * @param {ActorParameters} params - Additional actor parameters required for the call.
+ *
+ * @returns {Promise<JunoPackage | undefined>} A promise that resolves to the parsed `JunoPackage` metadata, or `undefined` if not found.
+ *
+ * @throws {ZodError} If the metadata exists but does not conform to the expected `JunoPackage` schema.
+ */
+export declare const getJunoPackage: ({ moduleId, ...rest }: GetJunoPackageParams) => Promise<JunoPackage | undefined>;
+/**
+ * Retrieves only the `version` field from the `juno:package` metadata.
+ *
+ * @param {GetJunoPackageParams} params - The parameters to fetch the package version.
+ *
+ * @returns {Promise<string | undefined>} A promise that resolves to the version string or `undefined` if not found.
+ *
+ * @throws {ZodError} If the metadata exists but does not conform to the expected `JunoPackage` schema.
+ */
+export declare const getJunoPackageVersion: (params: GetJunoPackageParams) => Promise<JunoPackage["version"] | undefined>;
+/**
+ * Retrieves the `dependencies` field from the `juno:package` metadata.
+ *
+ * @param {GetJunoPackageParams} params - The parameters to fetch the package metadata.
+ *
+ * @returns {Promise<JunoPackage['dependencies'] | undefined>} A promise that resolves to the dependencies object or `undefined` if not found.
+ *
+ * @throws {ZodError} If the metadata exists but does not conform to the expected `JunoPackage` schema.
+ */
+export declare const getJunoPackageDependencies: (params: GetJunoPackageParams) => Promise<JunoPackage["dependencies"] | undefined>;
+/**
+ * Finds a specific dependency entry by its ID from the `juno:package` metadata.
+ *
+ * @param {Object} params - The parameters to fetch and search within the dependencies.
+ * @param {string} params.dependencyId - The ID of the dependency to find (e.g., `@junobuild/satellite`).
+ * @param {Principal | string} params.moduleId - The canister ID (as a `Principal` or string).
+ * @param {ActorParameters} params - Additional actor parameters required for the metadata call.
+ *
+ * @returns {Promise<[string, string] | undefined>} A promise that resolves to the `[dependencyId, version]` tuple if found, or `undefined` otherwise.
+ *
+ * @throws {ZodError} If the metadata exists but does not conform to the expected `JunoPackage` schema.
+ */
+export declare const findJunoPackageDependency: ({ dependencyId, ...params }: GetJunoPackageParams & {
+    dependencyId: string;
+}) => Promise<[string, string] | undefined>;

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

@@ -1,4 +1,4 @@
-import { Principal } from '@dfinity/principal';
+import type { Principal } from '@dfinity/principal';
 import type { Controller, SetControllersArgs } from '../../declarations/satellite/satellite.did';
 import type { SatelliteParameters } from '../types/actor.types';
 /**

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

@@ -1,5 +1,5 @@
 import type { SatelliteParameters } from '../types/actor.types';
-import { UpgradeCodeParams } from '../types/upgrade.types';
+import type { UpgradeCodeParams } from '../types/upgrade.types';
 /**
  * Upgrades a satellite with the provided WASM module.
  * @param {Object} params - The parameters for upgrading the satellite.

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

@@ -1,6 +1,6 @@
 import type { canister_install_mode } from '@dfinity/ic-management';
-import { Principal } from '@dfinity/principal';
-import { ActorParameters } from './actor.types';
+import type { Principal } from '@dfinity/principal';
+import type { ActorParameters } from './actor.types';
 export declare enum UpgradeCodeProgressStep {
     AssertingExistingCode = 0,
     StoppingCanister = 1,

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

@@ -1,7 +1,7 @@
 import { HttpAgent, type ActorConfig, type ActorMethod, type ActorSubclass } from '@dfinity/agent';
 import type { IDL } from '@dfinity/candid';
 import type { ActorParameters } from '../types/actor.types';
-export declare const createActor: <T = Record<string, ActorMethod<unknown[], unknown>>>({ canisterId, idlFactory, config, ...rest }: {
+export declare const createActor: <T = Record<string, ActorMethod>>({ canisterId, idlFactory, config, ...rest }: {
     idlFactory: IDL.InterfaceFactory;
     canisterId: string;
     config?: Pick<ActorConfig, "callTransform" | "queryTransform">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.1.6",
+  "version": "0.1.8-next-2025-04-06",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -50,13 +50,14 @@
   ],
   "homepage": "https://juno.build",
   "peerDependencies": {
-    "@dfinity/agent": "^2.3.0",
-    "@dfinity/candid": "^2.3.0",
-    "@dfinity/ic-management": "^6",
-    "@dfinity/identity": "^2.3.0",
-    "@dfinity/principal": "^2.3.0",
-    "@dfinity/utils": "^2",
+    "@dfinity/agent": "*",
+    "@dfinity/candid": "*",
+    "@dfinity/ic-management": "*",
+    "@dfinity/identity": "*",
+    "@dfinity/principal": "*",
+    "@dfinity/utils": "*",
     "@junobuild/config": "*",
-    "semver": "7.*"
+    "semver": "*",
+    "zod": "*"
   }
-}
+}