@enbox/dids 0.0.2 → 0.0.4

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/resolver/resolver-cache-noop.ts

@@ -8,19 +8,19 @@ import type { DidResolverCache } from '../types/did-resolution.js';
  * potential for this library to be used in as many JS runtimes as possible.
  */
 export const DidResolverCacheNoop: DidResolverCache = {
-  get: function (_key: string): Promise<DidResolutionResult> {
-    return null as any;
+  get(_key: string): Promise<DidResolutionResult | void> {
+    return Promise.resolve(undefined);
   },
-  set: function (_key: string, _value: DidResolutionResult): Promise<void> {
-    return null as any;
+  set(_key: string, _value: DidResolutionResult): Promise<void> {
+    return Promise.resolve();
   },
-  delete: function (_key: string): Promise<void> {
-    return null as any;
+  delete(_key: string): Promise<boolean | void> {
+    return Promise.resolve();
   },
-  clear: function (): Promise<void> {
-    return null as any;
+  clear(): Promise<void> {
+    return Promise.resolve();
   },
-  close: function (): Promise<void> {
-    return null as any;
+  close(): Promise<void> {
+    return Promise.resolve();
   }
 };

package/src/resolver/universal-resolver.ts

@@ -1,6 +1,6 @@
 import type { DidMethodResolver } from '../methods/did-method.js';
-import type { DidResolver, DidResolverCache, DidUrlDereferencer } from '../types/did-resolution.js';
 import type { DidDereferencingOptions, DidDereferencingResult, DidResolutionOptions, DidResolutionResult, DidResource } from '../types/did-core.js';
+import type { DidResolver, DidResolverCache, DidUrlDereferencer } from '../types/did-resolution.js';
 
 import { Did } from '../did.js';
 import { DidErrorCode } from '../did-error.js';
@@ -33,7 +33,7 @@ export type UniversalResolverParams = {
    * which effectively disables caching.
    */
   cache?: DidResolverCache;
-}
+};
 
 /**
  * The `DidResolver` class provides mechanisms for resolving Decentralized Identifiers (DIDs) to
@@ -153,7 +153,7 @@ export class UniversalResolver implements DidResolver, DidUrlDereferencer {
    * More information on DID URL dereferencing can be found in the
    * {@link https://www.w3.org/TR/did-core/#did-url-dereferencing | DID Core specification}.
    *
-   * TODO: This is a partial implementation and does not fully implement DID URL dereferencing. (https://github.com/TBD54566975/web5-js/issues/387)
+   * TODO: This is a partial implementation and does not fully implement DID URL dereferencing. (https://github.com/enboxorg/enbox/issues/387)
    *
    * @param didUrl - The DID URL string to dereference.
    * @param [_options] - Input options to the dereference function. Optional.
@@ -206,7 +206,7 @@ export class UniversalResolver implements DidResolver, DidUrlDereferencer {
     let didResource: DidResource | undefined;
 
     // Find the first matching verification method in the DID document.
-    for (let vm of verificationMethod) {
+    for (const vm of verificationMethod) {
       if (idSet.has(vm.id)) {
         didResource = vm;
         break;
@@ -214,7 +214,7 @@ export class UniversalResolver implements DidResolver, DidUrlDereferencer {
     }
 
     // Find the first matching service in the DID document.
-    for (let svc of service) {
+    for (const svc of service) {
       if (idSet.has(svc.id)) {
         didResource = svc;
         break;

package/src/types/did-core.ts

@@ -1,4 +1,4 @@
-import { Jwk } from '@enbox/crypto';
+import type { Jwk } from '@enbox/crypto';
 
 /**
  * Represents metadata related to the process of DID dereferencing.
@@ -33,7 +33,7 @@ export type DidDereferencingMetadata = {
 
   // Additional output metadata generated during DID Resolution.
   [key: string]: any;
-}
+};
 
 /**
  * Represents the options that can be used during the process of DID dereferencing.
@@ -90,7 +90,7 @@ export type DidDereferencingResult = {
    * dereferencing is unsuccessful, this output MUST be an empty metadata structure.
    */
   contentMetadata: DidDocumentMetadata;
-}
+};
 
 /**
  * A set of data describing the Decentralized Identifierr (DID) subject.

package/src/utils.ts

@@ -1,19 +1,20 @@
 import type { Jwk } from '@enbox/crypto';
 import type { RequireOnly } from '@enbox/common';
 
-import { Convert, Multicodec } from '@enbox/common';
 import { computeJwkThumbprint } from '@enbox/crypto';
+import { Convert, Multicodec } from '@enbox/common';
 
 import type { KeyWithMulticodec } from './types/multibase.js';
-
-import { DidError, DidErrorCode } from './did-error.js';
-import {
-  DidService,
+import type { PortableDid } from './types/portable-did.js';
+import type {
   DidDocument,
+  DidService,
   DidVerificationMethod,
-  DidVerificationRelationship,
 } from './types/did-core.js';
 
+import { DidVerificationRelationship } from './types/did-core.js';
+import { DidError, DidErrorCode } from './did-error.js';
+
 /**
  * Represents a Decentralized Web Node (DWN) service in a DID Document.
  *
@@ -30,7 +31,7 @@ import {
  * const service: DwnDidService = {
  *   id: 'did:example:123#dwn',
  *   type: 'DecentralizedWebNode',
- *   serviceEndpoint: 'https://enbox-production.up.railway.app',
+ *   serviceEndpoint: 'https://enbox-dwn.fly.dev',
  *   enc: 'did:example:123#key-1',
  *   sig: 'did:example:123#key-2'
  * }
@@ -76,8 +77,8 @@ export interface DwnDidService extends DidService {
  *          without a '#', and complex data structures.
  */
 export function extractDidFragment(input: unknown): string | undefined {
-  if (typeof input !== 'string') return undefined;
-  if (input.length === 0) return undefined;
+  if (typeof input !== 'string') {return undefined;}
+  if (input.length === 0) {return undefined;}
   return input.split('#').pop();
 }
 
@@ -97,8 +98,10 @@ export function extractDidFragment(input: unknown): string | undefined {
  *
  * @param params - An object containing input parameters for retrieving services.
  * @param params.didDocument - The DID document from which services are retrieved.
- * @param params.id - Optional. A string representing the specific service ID to match. If provided, only the service with this ID will be returned.
- * @param params.type - Optional. A string representing the specific service type to match. If provided, only the service(s) of this type will be returned.
+ * @param params.id - Optional. A string representing the specific service ID to match. If provided,
+ * only the service with this ID will be returned.
+ * @param params.type - Optional. A string representing the specific service type to match.
+ * If provided, only the service(s) of this type will be returned.
  * @returns An array of services. If no matching service is found, an empty array is returned.
  */
 export function getServices({ didDocument, id, type }: {
@@ -107,8 +110,8 @@ export function getServices({ didDocument, id, type }: {
   type?: string;
 }): DidService[] {
   return didDocument?.service?.filter(service => {
-    if (id && service.id !== id) return false;
-    if (type && service.type !== type) return false;
+    if (id && service.id !== id) {return false;}
+    if (type && service.type !== type) {return false;}
     return true;
   }) ?? [];
 }
@@ -150,7 +153,7 @@ export async function getVerificationMethodByKey({ didDocument, publicKeyJwk, pu
   // Collect all verification methods from the DID document.
   const verificationMethods = getVerificationMethods({ didDocument });
 
-  for (let method of verificationMethods) {
+  for (const method of verificationMethods) {
     if (publicKeyJwk && method.publicKeyJwk) {
       const publicKeyThumbprint = await computeJwkThumbprint({ jwk: publicKeyJwk });
       if (publicKeyThumbprint === await computeJwkThumbprint({ jwk: method.publicKeyJwk })) {
@@ -191,7 +194,7 @@ export async function getVerificationMethodByKey({ didDocument, publicKeyJwk, pu
 export function getVerificationMethods({ didDocument }: {
   didDocument: DidDocument;
 }): DidVerificationMethod[] {
-  if (!didDocument) throw new TypeError(`Required parameter missing: 'didDocument'`);
+  if (!didDocument) {throw new TypeError(`Required parameter missing: 'didDocument'`);}
 
   const verificationMethods: DidVerificationMethod[] = [];
 
@@ -356,7 +359,7 @@ export function getVerificationRelationshipsById({ didDocument, methodId }: {
  */
 export function isDidService(obj: unknown): obj is DidService {
   // Validate that the given value is an object.
-  if (!obj || typeof obj !== 'object' || obj === null) return false;
+  if (!obj || typeof obj !== 'object' || obj === null) {return false;}
 
   // Validate that the object has the necessary properties of DidService.
   return 'id' in obj && 'type' in obj && 'serviceEndpoint' in obj;
@@ -391,7 +394,7 @@ export function isDidService(obj: unknown): obj is DidService {
  *     {
  *       id: 'did:example:123#dwn',
  *       type: 'DecentralizedWebNode',
- *       serviceEndpoint: 'https://enbox-production.up.railway.app',
+ *       serviceEndpoint: 'https://enbox-dwn.fly.dev',
  *       enc: 'did:example:123#key-1',
  *       sig: 'did:example:123#key-2'
  *     }
@@ -412,13 +415,13 @@ export function isDidService(obj: unknown): obj is DidService {
  */
 export function isDwnDidService(obj: unknown): obj is DwnDidService {
   // Validate that the given value is a {@link DidService}.
-  if (!isDidService(obj)) return false;
+  if (!isDidService(obj)) {return false;}
 
   // Validate that the `type` property is `DecentralizedWebNode`.
-  if (obj.type !== 'DecentralizedWebNode') return false;
+  if (obj.type !== 'DecentralizedWebNode') {return false;}
 
   // Validate that the given object has the `enc` and `sig` properties.
-  if (!('enc' in obj && 'sig' in obj)) return false;
+  if (!('enc' in obj && 'sig' in obj)) {return false;}
 
   // Validate that the `enc` and `sig` properties are either strings or arrays of strings.
   const isStringOrStringArray = (prop: any): boolean =>
@@ -453,18 +456,44 @@ export function isDwnDidService(obj: unknown): obj is DwnDidService {
  */
 export function isDidVerificationMethod(obj: unknown): obj is DidVerificationMethod {
   // Validate that the given value is an object.
-  if (!obj || typeof obj !== 'object' || obj === null) return false;
+  if (!obj || typeof obj !== 'object' || obj === null) {return false;}
 
   // Validate that the object has the necessary properties of a DidVerificationMethod.
-  if (!('id' in obj && 'type' in obj && 'controller' in obj)) return false;
+  if (!('id' in obj && 'type' in obj && 'controller' in obj)) {return false;}
 
-  if (typeof obj.id !== 'string') return false;
-  if (typeof obj.type !== 'string') return false;
-  if (typeof obj.controller !== 'string') return false;
+  if (typeof obj.id !== 'string') {return false;}
+  if (typeof obj.type !== 'string') {return false;}
+  if (typeof obj.controller !== 'string') {return false;}
 
   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.
  *
@@ -526,7 +555,7 @@ export function multibaseIdToKeyBytes({ multibaseKeyId }: {
     const { code, data, name } = Multicodec.removePrefix({ prefixedData: prefixedKey });
 
     return { keyBytes: data, multicodecCode: code, multicodecName: name };
-  } catch (error: any) {
+  } catch {
     throw new DidError(DidErrorCode.InvalidDid, `Invalid multibase identifier: ${multibaseKeyId}`);
   }
 }