@junobuild/admin 0.1.6 → 0.1.7

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

@@ -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/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/package.services.d.ts

@@ -0,0 +1,35 @@
+import { Principal } from '@dfinity/principal';
+import { type JunoPackage } from '@junobuild/config';
+import { 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>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@junobuild/admin",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "A library for interfacing with admin features of Juno",
   "author": "David Dal Busco (https://daviddalbusco.com)",
   "license": "MIT",
@@ -57,6 +57,7 @@
     "@dfinity/principal": "^2.3.0",
     "@dfinity/utils": "^2",
     "@junobuild/config": "*",
-    "semver": "7.*"
+    "semver": "7.*",
+    "zod": "^3"
   }
 }