@enbox/dids 0.0.3 → 0.0.5

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.
  *