@enbox/dids 0.0.3 → 0.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enbox/dids",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "TBD DIDs library",
   "type": "module",
   "main": "./dist/esm/index.js",
@@ -9,14 +9,14 @@
   "scripts": {
     "clean": "rimraf dist",
     "build:esm": "rimraf dist/esm dist/types && bun tsc -p tsconfig.json",
-    "build:browser": "rimraf dist/browser.mjs dist/browser.js && bun build/bundles.js",
-    "build:tests:browser": "rimraf tests/compiled && bun build/esbuild-tests.cjs",
+    "build:browser": "rimraf dist/browser.mjs && bun ../../build/browser-bundle.js --extra-entry src/utils.ts:dist/utils.js",
     "build": "bun run clean && bun run build:esm && bun run build:browser",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
     "test:node": "bun test tests/",
     "test:node:coverage": "bun test --coverage --coverage-reporter=text --coverage-reporter=lcov --coverage-dir=coverage tests/",
-    "test:browser": "bun run build:tests:browser && bunx web-test-runner"
+    "test:browser": "bunx --bun vitest --config vitest.browser.config.ts --run",
+    "test:browser:coverage": "bunx --bun vitest --config vitest.browser.config.ts --run --coverage --coverage.provider=istanbul --coverage.reportsDirectory=./coverage-browser"
   },
   "homepage": "https://github.com/enboxorg/enbox/tree/main/packages/dids#readme",
   "bugs": "https://github.com/enboxorg/enbox/issues",
@@ -50,10 +50,12 @@
   ],
   "exports": {
     ".": {
+      "browser": "./dist/browser.mjs",
       "types": "./dist/types/index.d.ts",
       "import": "./dist/esm/index.js"
     },
     "./utils": {
+      "browser": "./dist/utils.js",
       "types": "./dist/types/utils.d.ts",
       "import": "./dist/esm/utils.js"
     }
@@ -79,28 +81,24 @@
     "@decentralized-identity/ion-sdk": "1.0.4",
     "@dnsquery/dns-packet": "6.1.1",
     "@enbox/common": "0.0.3",
-    "@enbox/crypto": "0.0.3",
+    "@enbox/crypto": "0.0.4",
     "abstract-level": "1.0.4",
     "bencode": "4.0.0",
     "level": "8.0.1",
     "ms": "2.1.3"
   },
   "devDependencies": {
-    "buffer": "6.0.3",
-    "@playwright/test": "1.45.3",
     "@types/bencode": "2.0.4",
     "@types/ms": "0.7.34",
     "@types/node": "20.14.8",
     "@typescript-eslint/eslint-plugin": "8.32.1",
     "@typescript-eslint/parser": "8.32.1",
-    "@web/test-runner": "0.18.2",
-    "@web/test-runner-playwright": "0.11.0",
+    "@vitest/browser-playwright": "4.0.18",
+    "@vitest/coverage-istanbul": "4.0.18",
     "bun-types": "latest",
-    "esbuild": "0.23.0",
     "eslint": "9.7.0",
-    "playwright": "1.45.3",
     "rimraf": "5.0.7",
-    "source-map-loader": "5.0.0",
-    "typescript": "5.5.4"
+    "typescript": "5.5.4",
+    "vitest": "4.0.18"
   }
 }

package/src/bearer-did.ts

@@ -1,10 +1,10 @@
 import type {
-  CryptoApi,
   EnclosedSignParams,
   EnclosedVerifyParams,
   Jwk,
   KeyIdentifier,
   KeyImporterExporter,
+  KeyManager,
   KmsExportKeyParams,
   KmsImportKeyParams,
   Signer,
@@ -77,13 +77,13 @@ export class BearerDid {
    *
    * Each DID method requires at least one key be present in the provided `keyManager`.
    */
-  keyManager: CryptoApi;
+  keyManager: KeyManager;
 
   constructor({ uri, document, metadata, keyManager }: {
     uri: string,
     document: DidDocument,
     metadata: DidMetadata,
-    keyManager: CryptoApi
+    keyManager: KeyManager
   }) {
     this.uri = uri;
     this.document = document;
@@ -238,7 +238,7 @@ export class BearerDid {
    *         keys for any verification method are missing in the key manager.
    */
   public static async import({ portableDid, keyManager = new LocalKeyManager() }: {
-    keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+    keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
     portableDid: PortableDid;
   }): Promise<BearerDid> {
 

package/src/index.ts

@@ -15,7 +15,9 @@ export * from './methods/did-method.js';
 export * from './methods/did-web.js';
 
 export * from './resolver/resolver-cache-level.js';
+export * from './resolver/resolver-cache-memory.js';
 export * from './resolver/resolver-cache-noop.js';
 export * from './resolver/universal-resolver.js';
 
+export { isPortableDid } from './utils.js';
 export * as utils from './utils.js';

package/src/methods/did-dht.ts

@@ -1,9 +1,9 @@
 import type {
   AsymmetricKeyConverter,
-  CryptoApi,
   Jwk,
   KeyIdentifier,
   KeyImporterExporter,
+  KeyManager,
   KmsExportKeyParams,
   KmsImportKeyParams,
   Signer,
@@ -506,7 +506,7 @@ export class DidDht extends DidMethod {
    * @param params.options - Optional parameters that can be specified when creating a new DID.
    * @returns A Promise resolving to a {@link BearerDid} object representing the new DID.
    */
-  public static async create<TKms extends CryptoApi | undefined = undefined>({
+  public static async create<TKms extends KeyManager | undefined = undefined>({
     keyManager = new LocalKeyManager(),
     options = {}
   }: {
@@ -648,7 +648,7 @@ export class DidDht extends DidMethod {
    *         manager.
    */
   public static async import({ portableDid, keyManager = new LocalKeyManager() }: {
-    keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+    keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
     portableDid: PortableDid;
   }): Promise<BearerDid> {
     // Verify the DID method is supported.

package/src/methods/did-ion.ts

@@ -1,10 +1,17 @@
-import type { CryptoApi, Jwk, KeyIdentifier, KeyImporterExporter, KmsExportKeyParams, KmsImportKeyParams } from '@enbox/crypto';
 import type {
   IonDocumentModel,
   IonPublicKeyModel,
   IonPublicKeyPurpose,
   JwkEs256k,
 } from '@decentralized-identity/ion-sdk';
+import type {
+  Jwk,
+  KeyIdentifier,
+  KeyImporterExporter,
+  KeyManager,
+  KmsExportKeyParams,
+  KmsImportKeyParams,
+} from '@enbox/crypto';
 
 import { computeJwkThumbprint, LocalKeyManager } from '@enbox/crypto';
 import { IonDid, IonRequest } from '@decentralized-identity/ion-sdk';
@@ -364,7 +371,7 @@ export class DidIon extends DidMethod {
    * @param params.options - Optional parameters that can be specified when creating a new DID.
    * @returns A Promise resolving to a {@link BearerDid} object representing the new DID.
    */
-  public static async create<TKms extends CryptoApi | undefined = undefined>({
+  public static async create<TKms extends KeyManager | undefined = undefined>({
     keyManager = new LocalKeyManager(),
     options = {}
   }: {
@@ -517,7 +524,7 @@ export class DidIon extends DidMethod {
    *         any verification method are missing in the key manager.
    */
   public static async import({ portableDid, keyManager = new LocalKeyManager() }: {
-    keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+    keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
     portableDid: PortableDid;
   }): Promise<BearerDid> {
     // Verify the DID method is supported.

package/src/methods/did-jwk.ts

@@ -1,9 +1,9 @@
 import type {
-  CryptoApi,
   InferKeyGeneratorAlgorithm,
   Jwk,
   KeyIdentifier,
   KeyImporterExporter,
+  KeyManager,
   KmsExportKeyParams,
   KmsImportKeyParams,
 } from '@enbox/crypto';
@@ -76,7 +76,7 @@ export interface DidJwkCreateOptions<TKms> extends DidCreateOptions<TKms> {
   /**
    * Optionally specify the algorithm to be used for key generation.
    */
-  algorithm?: TKms extends CryptoApi
+  algorithm?: TKms extends KeyManager
     ? InferKeyGeneratorAlgorithm<TKms>
     : InferKeyGeneratorAlgorithm<LocalKeyManager>;
 
@@ -193,7 +193,7 @@ export class DidJwk extends DidMethod {
    * @param params.options - Optional parameters that can be specified when creating a new DID.
    * @returns A Promise resolving to a {@link BearerDid} object representing the new DID.
    */
-  public static async create<TKms extends CryptoApi | undefined = undefined>({
+  public static async create<TKms extends KeyManager | undefined = undefined>({
     keyManager = new LocalKeyManager(),
     options = {}
   }: {
@@ -305,7 +305,7 @@ export class DidJwk extends DidMethod {
    * @throws An error if the DID document does not contain exactly one verification method.
    */
   public static async import({ portableDid, keyManager = new LocalKeyManager() }: {
-    keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+    keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
     portableDid: PortableDid;
   }): Promise<BearerDid> {
     // Verify the DID method is supported.

package/src/methods/did-key.ts

@@ -1,11 +1,11 @@
 import type {
   AsymmetricKeyConverter,
-  CryptoApi,
   InferKeyGeneratorAlgorithm,
   Jwk,
   KeyCompressor,
   KeyIdentifier,
   KeyImporterExporter,
+  KeyManager,
   KmsExportKeyParams,
   KmsImportKeyParams,
 } from '@enbox/crypto';
@@ -88,7 +88,7 @@ export interface DidKeyCreateOptions<TKms> extends DidCreateOptions<TKms> {
   /**
    * Optionally specify the algorithm to be used for key generation.
    */
-  algorithm?: TKms extends CryptoApi
+  algorithm?: TKms extends KeyManager
     ? InferKeyGeneratorAlgorithm<TKms>
     : InferKeyGeneratorAlgorithm<LocalKeyManager>;
 
@@ -295,7 +295,7 @@ export class DidKey extends DidMethod {
    * @param params.options - Optional parameters that can be specified when creating a new DID.
    * @returns A Promise resolving to a {@link BearerDid} object representing the new DID.
    */
-  public static async create<TKms extends CryptoApi | undefined = undefined>({
+  public static async create<TKms extends KeyManager | undefined = undefined>({
     keyManager = new LocalKeyManager(),
     options = {}
   }: {
@@ -408,7 +408,7 @@ export class DidKey extends DidMethod {
    * @throws An error if the DID document does not contain exactly one verification method.
    */
   public static async import({ portableDid, keyManager = new LocalKeyManager() }: {
-    keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+    keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
     portableDid: PortableDid;
   }): Promise<BearerDid> {
     // Verify the DID method is supported.
@@ -473,7 +473,7 @@ export class DidKey extends DidMethod {
    */
   private static async createDocument({ didUri, options = {} }: {
     didUri: string;
-    options?: Exclude<DidKeyCreateOptions<CryptoApi>, 'algorithm' | 'verificationMethods'> | DidResolutionOptions;
+    options?: Exclude<DidKeyCreateOptions<KeyManager>, 'algorithm' | 'verificationMethods'> | DidResolutionOptions;
   }): Promise<DidDocument> {
     const {
       defaultContext = 'https://www.w3.org/ns/did/v1',
@@ -582,7 +582,7 @@ export class DidKey extends DidMethod {
   private static async createSignatureMethod({ didUri, multibaseValue, options }: {
     didUri: string;
     multibaseValue: string;
-    options: Required<Pick<DidKeyCreateOptions<CryptoApi>, 'enableExperimentalPublicKeyTypes' | 'publicKeyFormat'>>
+    options: Required<Pick<DidKeyCreateOptions<KeyManager>, 'enableExperimentalPublicKeyTypes' | 'publicKeyFormat'>>
   }): Promise<DidVerificationMethod> {
     const { enableExperimentalPublicKeyTypes, publicKeyFormat } = options;
 

package/src/methods/did-method.ts

@@ -1,6 +1,6 @@
 import type {
-  CryptoApi,
   InferKeyGeneratorAlgorithm,
+  KeyManager,
   LocalKeyManager,
 } from '@enbox/crypto';
 
@@ -47,7 +47,7 @@ export interface DidCreateVerificationMethod<TKms> extends Pick<Partial<DidVerif
    * };
    * ```
    */
-  algorithm: TKms extends CryptoApi
+  algorithm: TKms extends KeyManager
     ? InferKeyGeneratorAlgorithm<TKms>
     : InferKeyGeneratorAlgorithm<LocalKeyManager>;
 
@@ -82,7 +82,7 @@ export interface DidCreateVerificationMethod<TKms> extends Pick<Partial<DidVerif
  * @typeparam O - The type of the options used for creating the DID.
  */
 export interface DidMethodApi<
-    TKms extends CryptoApi | undefined = CryptoApi,
+    TKms extends KeyManager | undefined = KeyManager,
     TDid extends BearerDid = BearerDid,
     TOptions extends DidCreateOptions<TKms> = DidCreateOptions<TKms>
   > extends DidMethodResolver {

package/src/resolver/resolver-cache-memory.ts

@@ -0,0 +1,84 @@
+import ms from 'ms';
+import { TtlCache } from '@enbox/common';
+
+import type { DidResolutionResult } from '../types/did-core.js';
+import type { DidResolverCache } from '../types/did-resolution.js';
+
+/**
+ * Configuration parameters for creating an in-memory cache for DID resolution results.
+ *
+ * Allows customization of the cache time-to-live (TTL) setting.
+ */
+export type DidResolverCacheMemoryParams = {
+  /**
+   * Optional. The time-to-live for cache entries, expressed as a string (e.g., '1h', '15m').
+   * Determines how long a cache entry should remain valid before being considered expired.
+   *
+   * Defaults to '15m' if not specified.
+   */
+  ttl?: string;
+};
+
+export class DidResolverCacheMemory implements DidResolverCache {
+  private cache: TtlCache<string, DidResolutionResult>;
+
+  constructor({ ttl = '15m' }: DidResolverCacheMemoryParams = {}) {
+    this.cache = new TtlCache({ ttl: ms(ttl) });
+  }
+
+  /**
+   * Retrieves a DID resolution result from the cache.
+   *
+   * If the cached item has exceeded its TTL, it's scheduled for deletion and undefined is returned.
+   *
+   * @param didUri - The DID string used as the key for retrieving the cached result.
+   * @returns The cached DID resolution result or undefined if not found or expired.
+   */
+  public async get(didUri: string): Promise<DidResolutionResult | void> {
+    if (!didUri) {
+      throw new Error('Key cannot be null or undefined');
+    }
+
+    return this.cache.get(didUri);
+  }
+
+  /**
+   * Stores a DID resolution result in the cache with a TTL.
+   *
+   * @param didUri - The DID string used as the key for storing the result.
+   * @param resolutionResult - The DID resolution result to be cached.
+   * @returns A promise that resolves when the operation is complete.
+   */
+  public async set(didUri: string, resolutionResult: DidResolutionResult): Promise<void> {
+    this.cache.set(didUri, resolutionResult);
+  }
+
+  /**
+   * Deletes a DID resolution result from the cache.
+   *
+   * @param didUri - The DID string used as the key for deletion.
+   * @returns A promise that resolves when the operation is complete.
+   */
+  public async delete(didUri: string): Promise<void> {
+    this.cache.delete(didUri);
+  }
+
+  /**
+   * Clears all entries from the cache.
+   *
+   * @returns A promise that resolves when the operation is complete.
+   */
+  public async clear(): Promise<void> {
+    this.cache.clear();
+  }
+
+  /**
+   * This method is a no-op but exists to be consistent with other DID Resolver Cache
+   * implementations.
+   *
+   * @returns A promise that resolves immediately.
+   */
+  public async close(): Promise<void> {
+    // No-op since there is no underlying store to close.
+  }
+}

package/src/utils.ts

@@ -5,6 +5,7 @@ import { computeJwkThumbprint } from '@enbox/crypto';
 import { Convert, Multicodec } from '@enbox/common';
 
 import type { KeyWithMulticodec } from './types/multibase.js';
+import type { PortableDid } from './types/portable-did.js';
 import type {
   DidDocument,
   DidService,
@@ -467,6 +468,32 @@ export function isDidVerificationMethod(obj: unknown): obj is DidVerificationMet
   return true;
 }
 
+/**
+ * Checks if a given object conforms to the {@link PortableDid} interface.
+ *
+ * A `PortableDid` is an object with `uri`, `document`, and `metadata` properties that does not
+ * have a `keyManager` property (or has it set to `undefined`). This distinguishes it from a
+ * {@link BearerDid}, which includes a `keyManager`.
+ *
+ * @example
+ * ```ts
+ * if (isPortableDid(obj)) {
+ *   console.log('The object is a PortableDid');
+ * }
+ * ```
+ *
+ * @param obj - The object to be checked.
+ * @returns `true` if `obj` is a `PortableDid`; otherwise, `false`.
+ */
+export function isPortableDid(obj: unknown): obj is PortableDid {
+  // Validate that the given value is an object that has the necessary properties of PortableDid.
+  return !(!obj || typeof obj !== 'object' || obj === null)
+    && 'uri' in obj
+    && 'document' in obj
+    && 'metadata' in obj
+    && (!('keyManager' in obj) || obj.keyManager === undefined);
+}
+
 /**
  * Converts a cryptographic key to a multibase identifier.
  *