chore: split @dfinity/vetkeys/tools entry point into @dfinity/vetkeys/{key_manager,encrypted_maps} (#98)

altkdf · web-flow · commit b1f241c9597e · 2025-05-16T15:45:21.000+02:00
diff --git a/examples/basic_ibe/frontend/vite.config.ts b/examples/basic_ibe/frontend/vite.config.ts
@@ -23,7 +23,7 @@ export default defineConfig({
   resolve: {
     alias: {
       'ic_vetkeys': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src'),
-      'ic_vetkeys/tools': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/tools'),
+      'ic_vetkeys/encrypted_maps': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/encrypted_maps'),
     }
   },
   root: "./",
diff --git a/examples/basic_timelock_ibe/frontend/vite.config.ts b/examples/basic_timelock_ibe/frontend/vite.config.ts
@@ -23,7 +23,7 @@ export default defineConfig({
   resolve: {
     alias: {
       'ic_vetkeys': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src'),
-      'ic_vetkeys/tools': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/tools'),
+      'ic_vetkeys/encrypted_maps': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/encrypted_maps'),
     }
   },
   root: "./",
diff --git a/examples/password_manager/frontend/src/components/EditPassword.svelte b/examples/password_manager/frontend/src/components/EditPassword.svelte
@@ -16,7 +16,7 @@
     import Spinner from "./Spinner.svelte";
     import { onDestroy } from "svelte";
     import { Principal } from "@dfinity/principal";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let currentRoute = "";
     const unsubscribe = location.subscribe((value) => {
diff --git a/examples/password_manager/frontend/src/components/SharingEditor.svelte b/examples/password_manager/frontend/src/components/SharingEditor.svelte
@@ -9,7 +9,7 @@
     } from "../store/vaults";
     import { addNotification, showError } from "../store/notifications";
     import { Principal } from "@dfinity/principal";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let editedVault: VaultModel;
     export let canManage = false;
diff --git a/examples/password_manager/frontend/src/components/Vault.svelte b/examples/password_manager/frontend/src/components/Vault.svelte
@@ -10,7 +10,7 @@
     import GiOpenTreasureChest from "svelte-icons/gi/GiOpenTreasureChest.svelte";
     import { auth } from "../store/auth";
     import SharingEditor from "./SharingEditor.svelte";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let vault: VaultModel = {
         name: "",
diff --git a/examples/password_manager/frontend/src/lib/encrypted_maps.ts b/examples/password_manager/frontend/src/lib/encrypted_maps.ts
@@ -1,7 +1,9 @@
 import "./init.ts";
 import { HttpAgent, type HttpAgentOptions } from "@dfinity/agent";
-import { DefaultEncryptedMapsClient } from "@dfinity/vetkeys/tools";
-import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+import {
+    DefaultEncryptedMapsClient,
+    EncryptedMaps,
+} from "@dfinity/vetkeys/encrypted_maps";
 
 export async function createEncryptedMaps(
     agentOptions?: HttpAgentOptions,
diff --git a/examples/password_manager/frontend/src/lib/vault.ts b/examples/password_manager/frontend/src/lib/vault.ts
@@ -1,6 +1,6 @@
 import type { Principal } from "@dfinity/principal";
 import type { PasswordModel } from "./password";
-import type { AccessRights } from "@dfinity/vetkeys/tools";
+import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
 export interface VaultModel {
     owner: Principal;
diff --git a/examples/password_manager/frontend/src/store/auth.ts b/examples/password_manager/frontend/src/store/auth.ts
@@ -4,7 +4,7 @@ import { AuthClient } from "@dfinity/auth-client";
 import type { JsonnableDelegationChain } from "@dfinity/identity/lib/cjs/identity/delegation";
 import { replace } from "svelte-spa-router";
 import { createEncryptedMaps } from "../lib/encrypted_maps.js";
-import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+import { EncryptedMaps } from "@dfinity/vetkeys/encrypted_maps";
 
 export type AuthState =
     | {
diff --git a/examples/password_manager/frontend/src/store/vaults.ts b/examples/password_manager/frontend/src/store/vaults.ts
@@ -3,7 +3,10 @@ import { passwordFromContent, type PasswordModel } from "../lib/password";
 import { vaultFromContent, type VaultModel } from "../lib/vault";
 import { auth } from "./auth";
 import { showError } from "./notifications";
-import { type AccessRights, EncryptedMaps } from "@dfinity/vetkeys/tools";
+import {
+    type AccessRights,
+    EncryptedMaps,
+} from "@dfinity/vetkeys/encrypted_maps";
 import type { Principal } from "@dfinity/principal";
 
 export const vaultsStore = writable<
diff --git a/examples/password_manager/frontend/vite.config.ts b/examples/password_manager/frontend/vite.config.ts
@@ -34,7 +34,7 @@ export default defineConfig({
   resolve: {
     alias: {
       'ic_vetkeys': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src'),
-      'ic_vetkeys/tools': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/tools'),
+      'ic_vetkeys/encrypted_maps': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/encrypted_maps'),
     }
   },
   root: "./",
diff --git a/examples/password_manager_with_metadata/frontend/src/components/EditPassword.svelte b/examples/password_manager_with_metadata/frontend/src/components/EditPassword.svelte
@@ -12,7 +12,7 @@
     import Spinner from "./Spinner.svelte";
     import { onDestroy } from "svelte";
     import { Principal } from "@dfinity/principal";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let currentRoute = "";
     const unsubscribe = location.subscribe((value) => {
diff --git a/examples/password_manager_with_metadata/frontend/src/components/SharingEditor.svelte b/examples/password_manager_with_metadata/frontend/src/components/SharingEditor.svelte
@@ -9,7 +9,7 @@
     } from "../store/vaults";
     import { addNotification, showError } from "../store/notifications";
     import { Principal } from "@dfinity/principal";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let editedVault: VaultModel;
     export let canManage = false;
diff --git a/examples/password_manager_with_metadata/frontend/src/components/Vault.svelte b/examples/password_manager_with_metadata/frontend/src/components/Vault.svelte
@@ -10,7 +10,7 @@
     import GiOpenTreasureChest from "svelte-icons/gi/GiOpenTreasureChest.svelte";
     import { auth } from "../store/auth";
     import SharingEditor from "./SharingEditor.svelte";
-    import type { AccessRights } from "@dfinity/vetkeys/tools";
+    import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
     export let vault: VaultModel = {
         name: "",
diff --git a/examples/password_manager_with_metadata/frontend/src/lib/encrypted_maps.ts b/examples/password_manager_with_metadata/frontend/src/lib/encrypted_maps.ts
@@ -1,7 +1,9 @@
 import "./init.ts";
 import { HttpAgent, type HttpAgentOptions } from "@dfinity/agent";
-import { DefaultEncryptedMapsClient } from "@dfinity/vetkeys/tools";
-import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+import {
+    DefaultEncryptedMapsClient,
+    EncryptedMaps,
+} from "@dfinity/vetkeys/encrypted_maps";
 
 export async function createEncryptedMaps(
     agentOptions: HttpAgentOptions,
diff --git a/examples/password_manager_with_metadata/frontend/src/lib/password_manager.ts b/examples/password_manager_with_metadata/frontend/src/lib/password_manager.ts
@@ -1,6 +1,6 @@
 import "./init.ts";
 import { type ActorSubclass, type HttpAgentOptions } from "@dfinity/agent";
-import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+import { EncryptedMaps } from "@dfinity/vetkeys/encrypted_maps";
 import { createEncryptedMaps } from "./encrypted_maps";
 import type { Principal } from "@dfinity/principal";
 import { createActor } from "../declarations/index";
diff --git a/examples/password_manager_with_metadata/frontend/src/lib/vault.ts b/examples/password_manager_with_metadata/frontend/src/lib/vault.ts
@@ -1,6 +1,6 @@
 import type { Principal } from "@dfinity/principal";
 import type { PasswordModel } from "./password";
-import type { AccessRights } from "@dfinity/vetkeys/tools";
+import type { AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 
 export interface VaultModel {
     owner: Principal;
diff --git a/examples/password_manager_with_metadata/frontend/src/store/vaults.ts b/examples/password_manager_with_metadata/frontend/src/store/vaults.ts
@@ -3,7 +3,7 @@ import { type PasswordModel } from "../lib/password";
 import { type VaultModel } from "../lib/vault";
 import { auth, type AuthState } from "./auth";
 import { showError } from "./notifications";
-import { type AccessRights } from "@dfinity/vetkeys/tools";
+import { type AccessRights } from "@dfinity/vetkeys/encrypted_maps";
 import type { Principal } from "@dfinity/principal";
 import type { PasswordManager } from "../lib/password_manager";
 
diff --git a/examples/password_manager_with_metadata/frontend/vite.config.js b/examples/password_manager_with_metadata/frontend/vite.config.js
@@ -53,9 +53,9 @@ export default defineConfig({
                 __dirname,
                 "../../../frontend/ic_vetkeys/src",
             ),
-            "ic_vetkeys/tools": path.resolve(
+            "ic_vetkeys/encrypted_maps": path.resolve(
                 __dirname,
-                "../../../frontend/ic_vetkeys/src/tools",
+                "../../../frontend/ic_vetkeys/src/encrypted_maps",
             ),
         },
     },
diff --git a/frontend/ic_vetkeys/README.md b/frontend/ic_vetkeys/README.md
@@ -9,7 +9,7 @@
 
 <br>
 
-This package contains two entry points:
+This package contains three entry points:
 
 <br>
 
@@ -21,16 +21,16 @@ Provides frontend utilities for the low-level use of VetKeys such as decryption
 
 <br>
 
-[`ic_vetkeys/tools`](https://5lfyp-mqaaa-aaaag-aleqa-cai.icp0.io/modules/ic_vetkeys_tools.html)
+[`ic_vetkeys/key_manager`](https://5lfyp-mqaaa-aaaag-aleqa-cai.icp0.io/modules/ic_vetkeys_key_manager.html)
 
 ---
 
-Provides high-level tools for frontend integration with the Internet Computer (ICP) applications using the respective [`ic_vetkeys` backend tools](https://docs.rs/ic_vetkeys/latest/).
+A frontend library facilitating communication with a [key manager enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
 
-### [Encrypted Maps](https://5lfyp-mqaaa-aaaag-aleqa-cai.icp0.io/classes/ic_vetkeys_tools.EncryptedMaps.html)
+<br>
 
-A frontend library facilitating communication with an [encrypted maps enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
+[`ic_vetkeys/encrypted_maps`](https://5lfyp-mqaaa-aaaag-aleqa-cai.icp0.io/modules/ic_vetkeys_encrypted_maps.html)
 
-### [Key Manager](https://5lfyp-mqaaa-aaaag-aleqa-cai.icp0.io/classes/ic_vetkeys_tools.KeyManager.html)
+---
 
-A frontend library facilitating communication with a [key manager enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
+A frontend library facilitating communication with an [encrypted maps enabled canister](https://docs.rs/ic_vetkeys/latest/TODO).
diff --git a/frontend/ic_vetkeys/package.json b/frontend/ic_vetkeys/package.json
@@ -45,9 +45,13 @@
             "import": "./dist/lib/index.es.js",
             "types": "./dist/types/src/index.d.ts"
         },
-        "./tools": {
-            "import": "./dist/lib/tools.es.js",
-            "types": "./dist/types/src/tools/index.d.ts"
+        "./key_manager": {
+            "import": "./dist/lib/key_manager.es.js",
+            "types": "./dist/types/src/key_manager/index.d.ts"
+        },
+        "./encrypted_maps": {
+            "import": "./dist/lib/encrypted_maps.es.js",
+            "types": "./dist/types/src/encrypted_maps/index.d.ts"
         }
     },
     "module": "dist/lib/index.es.js",
@@ -78,7 +82,7 @@
         "build": "tsc && vite build",
         "coverage": "npm run test:deploy_all && export $(cat .test1.env .test2.env | xargs) && vitest run --coverage",
         "lint": "eslint",
-        "make:docs": "mkdir -p $(git rev-parse --show-toplevel)/docs/tools && typedoc --out $(git rev-parse --show-toplevel)/docs",
+        "make:docs": "mkdir -p $(git rev-parse --show-toplevel)/docs/key_manager && mkdir -p $(git rev-parse --show-toplevel)/docs/encrypted_maps && typedoc --out $(git rev-parse --show-toplevel)/docs",
         "prettier": "prettier --write .",
         "prettier-check": "prettier --check .",
         "test_utils": "vitest utils",
diff --git a/frontend/ic_vetkeys/src/encrypted_maps/encrypted_maps_canister.test.ts b/frontend/ic_vetkeys/src/encrypted_maps/encrypted_maps_canister.test.ts
@@ -3,7 +3,7 @@ import { DefaultEncryptedMapsClient } from "./encrypted_maps_canister";
 import { expect, test } from "vitest";
 import fetch from "isomorphic-fetch";
 import { Ed25519KeyIdentity } from "@dfinity/identity";
-import { EncryptedMaps } from "./encrypted_maps";
+import { EncryptedMaps } from "./index";
 import { randomBytes } from "node:crypto";
 
 function randomId(): Ed25519KeyIdentity {
diff --git a/frontend/ic_vetkeys/src/encrypted_maps/encrypted_maps_canister.ts b/frontend/ic_vetkeys/src/encrypted_maps/encrypted_maps_canister.ts
@@ -7,7 +7,7 @@ import {
     ByteBuf,
     EncryptedMapData,
 } from "../declarations/ic_vetkeys_encrypted_maps_canister/ic_vetkeys_encrypted_maps_canister.did";
-import { EncryptedMapsClient } from "./encrypted_maps";
+import { EncryptedMapsClient } from "./index";
 
 export class DefaultEncryptedMapsClient implements EncryptedMapsClient {
     actor: ActorSubclass<_DEFAULT_ENCRYPTED_MAPS_SERVICE>;
diff --git a/frontend/ic_vetkeys/src/encrypted_maps/index.ts b/frontend/ic_vetkeys/src/encrypted_maps/index.ts
@@ -1,3 +1,15 @@
+/**
+ * @module @dfinity/vetkeys/encrypted_maps
+ *
+ * @description See { @link EncryptedMaps }.
+ *
+ * > [!IMPORTANT]
+ * > These support libraries are under active development and are subject to change. Access to the repositories has been opened to allow for early feedback. Check back regularly for updates.
+ * >
+ * > Please share your feedback on the [developer forum](https://forum.dfinity.org/t/threshold-key-derivation-privacy-on-the-ic/16560/179).
+ *
+ */
+
 import { Principal } from "@dfinity/principal";
 import { get, set } from "idb-keyval";
 import {
@@ -11,6 +23,12 @@ import {
     ByteBuf,
 } from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";
 
+export { DefaultEncryptedMapsClient } from "./encrypted_maps_canister";
+export type {
+    AccessRights,
+    ByteBuf,
+} from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";
+
 /**
  * > [!IMPORTANT]
  * > These support libraries are under active development and are subject to change. Access to the repositories has been opened to allow for early feedback. Check back regularly for updates.
@@ -35,7 +53,7 @@ import {
  *
  * @example
  * ```ts
- * import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+ * import { EncryptedMaps } from "@dfinity/vetkeys/encrypted_maps";
  *
  * // Initialize the EncryptedMaps Client
  * const encryptedMaps = new EncryptedMaps(encryptedMapsClientInstance);
@@ -76,7 +94,7 @@ export class EncryptedMaps {
      *
      * @example
      * ```ts
-     * import { EncryptedMaps } from "@dfinity/vetkeys/tools";
+     * import { EncryptedMaps } from "@dfinity/vetkeys/encrypted_maps";
      *
      * const encryptedMaps = new EncryptedMaps(encryptedMapsClientInstance);
      * ```
diff --git a/frontend/ic_vetkeys/src/index.ts b/frontend/ic_vetkeys/src/index.ts
@@ -1,5 +1,5 @@
 /**
- * @module ic_vetkeys
+ * @module @dfinity/vetkeys
  *
  * @description Provides frontend utilities for the low-level use of Verifiably Encrypted Threshold Keys (VetKeys) on the Internet Computer (IC) such as decryption of encrypted VetKeys, identity based encryption (IBE), and symmetric key derivation from a VetKey.
  *
diff --git a/frontend/ic_vetkeys/src/key_manager/index.ts b/frontend/ic_vetkeys/src/key_manager/index.ts
@@ -1,3 +1,15 @@
+/**
+ * @module @dfinity/vetkeys/key_manager
+ *
+ * @description See { @link KeyManager }.
+ *
+ * > [!IMPORTANT]
+ * > These support libraries are under active development and are subject to change. Access to the repositories has been opened to allow for early feedback. Check back regularly for updates.
+ * >
+ * > Please share your feedback on the [developer forum](https://forum.dfinity.org/t/threshold-key-derivation-privacy-on-the-ic/16560/179).
+ *
+ */
+
 import { Principal } from "@dfinity/principal";
 import {
     TransportSecretKey,
@@ -9,6 +21,12 @@ import {
     ByteBuf,
 } from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";
 
+export { DefaultKeyManagerClient } from "./key_manager_canister";
+export type {
+    AccessRights,
+    ByteBuf,
+} from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did";
+
 /**
  * > [!IMPORTANT]
  * > These support libraries are under active development and are subject to change. Access to the repositories has been opened to allow for early feedback. Check back regularly for updates.
@@ -32,7 +50,7 @@ import {
  *
  * @example
  * ```ts
- * import { KeyManager } from "@dfinity/vetkeys/tools";
+ * import { KeyManager } from "@dfinity/vetkeys/key_manager";
  *
  * // Initialize the KeyManager
  * const keyManager = new KeyManager(keyManagerClientInstance);
@@ -62,7 +80,7 @@ export class KeyManager {
      *
      * @example
      * ```ts
-     * import { KeyManager } from "@dfinity/vetkeys/tools";
+     * import { KeyManager } from "@dfinity/vetkeys/key_manager";
      *
      * const keyManager = new KeyManager(keyManagerClientInstance);
      * ```
diff --git a/frontend/ic_vetkeys/src/key_manager/key_manager_canister.test.ts b/frontend/ic_vetkeys/src/key_manager/key_manager_canister.test.ts
@@ -2,7 +2,7 @@ import { HttpAgent } from "@dfinity/agent";
 import { Ed25519KeyIdentity } from "@dfinity/identity";
 import fetch from "isomorphic-fetch";
 import { expect, test } from "vitest";
-import { KeyManager } from "./key_manager";
+import { KeyManager } from "./index";
 import { DefaultKeyManagerClient } from "./key_manager_canister";
 import { randomBytes } from "node:crypto";
 
diff --git a/frontend/ic_vetkeys/src/key_manager/key_manager_canister.ts b/frontend/ic_vetkeys/src/key_manager/key_manager_canister.ts
@@ -6,7 +6,7 @@ import {
     AccessRights,
     ByteBuf,
 } from "../declarations/ic_vetkeys_manager_canister/ic_vetkeys_manager_canister.did.js";
-import { KeyManagerClient } from "./key_manager.js";
+import { KeyManagerClient } from "./index";
 
 export class DefaultKeyManagerClient implements KeyManagerClient {
     canisterId: string;
diff --git a/frontend/ic_vetkeys/src/tools/index.ts b/frontend/ic_vetkeys/src/tools/index.ts
diff --git a/frontend/ic_vetkeys/typedoc.json b/frontend/ic_vetkeys/typedoc.json
diff --git a/frontend/ic_vetkeys/vite.config.ts b/frontend/ic_vetkeys/vite.config.ts

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ export default defineConfig({`
`23`	`23`	`resolve: {`
`24`	`24`	`alias: {`
`25`	`25`	`'ic_vetkeys': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src'),`
`26`		`- 'ic_vetkeys/tools': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/tools'),`
	`26`	`+ 'ic_vetkeys/encrypted_maps': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/encrypted_maps'),`
`27`	`27`	`}`
`28`	`28`	`},`
`29`	`29`	`root: "./",`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ export default defineConfig({`
`34`	`34`	`resolve: {`
`35`	`35`	`alias: {`
`36`	`36`	`'ic_vetkeys': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src'),`
`37`		`- 'ic_vetkeys/tools': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/tools'),`
	`37`	`+ 'ic_vetkeys/encrypted_maps': path.resolve(__dirname, '../../../frontend/ic_vetkeys/src/encrypted_maps'),`
`38`	`38`	`}`
`39`	`39`	`},`
`40`	`40`	`root: "./",`