@enbox/agent 0.1.2 → 0.1.4

package/dist/types/prototyping/crypto/types/params-kms.d.ts

@@ -1,63 +0,0 @@
-import type { Jwk, KeyIdentifier } from '@enbox/crypto';
-/**
- * Parameters for KMS-based encryption and decryption operations.
- *
- * Intended for use with a Key Management System.
- */
-export interface KmsCipherParams {
-    /** Identifier for the private key in the KMS. */
-    keyUri: KeyIdentifier;
-    /** Data to be encrypted or decrypted. */
-    data: Uint8Array;
-}
-/**
- * Parameters for KMS-based derivation of a cryptographic key from a given base key.
- *
- * Intended for use with a Key Management System.
- */
-export interface KmsDeriveKeyParams {
-    /** Identifier for the base key used in derivation in the KMS. */
-    baseKeyUri: KeyIdentifier;
-    /** An object defining the algorithm-specific parameters for the derived key. */
-    derivedKeyParams: unknown;
-}
-/**
- * Parameters for KMS-based derivation of a byte array from a given base key.
- *
- * Intended for use with a Key Management System.
- */
-export interface KmsDeriveKeyBytesParams {
-    /** Identifier for the base key used in derivation in the KMS. */
-    baseKeyUri: KeyIdentifier;
-    /** The desired length of the derived key in bits. */
-    length: number;
-}
-/**
- * Parameters for unwrapping a key using a KMS. Intended for use with a Key Management System.
- */
-export interface KmsUnwrapKeyParams {
-    /** Identifier for the private key in the KMS used for decrypting the wrapped key. */
-    decryptionKeyUri: KeyIdentifier;
-    /** The wrapped private key as a byte array. */
-    wrappedKeyBytes: Uint8Array;
-    /** The algorithm identifier of the key encrypted in `wrappedKeyBytes`. */
-    wrappedKeyAlgorithm: string;
-    /** An object defining the algorithm-specific parameters for decrypting the `wrappedKeyBytes`. */
-    decryptParams?: unknown;
-}
-/**
- * Parameters for wrapping a key using a KMS. Intended for use with a Key Management System.
- */
-export interface KmsWrapKeyParams {
-    /** Identifier for the private key in the KMS used for encrypting the unwrapped key. */
-    encryptionKeyUri: KeyIdentifier;
-    /** A {@link Jwk} containing the private key to be wrapped. */
-    unwrappedKey: Jwk;
-    /** An object defining the algorithm-specific parameters for encrypting the `unwrappedKey`. */
-    encryptParams?: unknown;
-}
-export interface KmsDeleteKeyParams {
-    /** Identifier for the key to be deleted in the KMS. */
-    keyUri: KeyIdentifier;
-}
-//# sourceMappingURL=params-kms.d.ts.map

package/dist/types/prototyping/crypto/types/params-kms.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"params-kms.d.ts","sourceRoot":"","sources":["../../../../../src/prototyping/crypto/types/params-kms.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAExD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B,iDAAiD;IACjD,MAAM,EAAE,aAAa,CAAC;IAEtB,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAC;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,iEAAiE;IACjE,UAAU,EAAE,aAAa,CAAC;IAE1B,gFAAgF;IAChF,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,iEAAiE;IACjE,UAAU,EAAE,aAAa,CAAC;IAE1B,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qFAAqF;IACrF,gBAAgB,EAAE,aAAa,CAAC;IAEhC,+CAA+C;IAC/C,eAAe,EAAE,UAAU,CAAC;IAE5B,0EAA0E;IAC1E,mBAAmB,EAAE,MAAM,CAAC;IAE5B,iGAAiG;IACjG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,uFAAuF;IACvF,gBAAgB,EAAE,aAAa,CAAC;IAEhC,8DAA8D;IAC9D,YAAY,EAAE,GAAG,CAAC;IAElB,8FAA8F;IAC9F,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,uDAAuD;IACvD,MAAM,EAAE,aAAa,CAAC;CACvB"}

package/dist/types/prototyping/crypto/utils.d.ts

@@ -1,7 +0,0 @@
-import type { Cipher, KeyWrapper } from '@enbox/crypto';
-import type { KeyExporter, KeyImporter } from './types/key-io.js';
-export declare function isCipher<EncryptInput, DecryptInput>(obj: unknown): obj is Cipher<EncryptInput, DecryptInput>;
-export declare function isKeyExporter<ExportKeyInput, ExportKeyOutput>(obj: unknown): obj is KeyExporter<ExportKeyInput, ExportKeyOutput>;
-export declare function isKeyImporter<ImportKeyInput, ImportKeyExport>(obj: unknown): obj is KeyImporter<ImportKeyInput, ImportKeyExport>;
-export declare function isKeyWrapper<WrapKeyInput, UnwrapKeyInput>(obj: unknown): obj is KeyWrapper<WrapKeyInput, UnwrapKeyInput>;
-//# sourceMappingURL=utils.d.ts.map

package/dist/types/prototyping/crypto/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/prototyping/crypto/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAExD,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAElE,wBAAgB,QAAQ,CAAC,YAAY,EAAE,YAAY,EACjD,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,CAM3C;AAED,wBAAgB,aAAa,CAAC,cAAc,EAAE,eAAe,EAC3D,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,WAAW,CAAC,cAAc,EAAE,eAAe,CAAC,CAKrD;AAED,wBAAgB,aAAa,CAAC,cAAc,EAAE,eAAe,EAC3D,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,WAAW,CAAC,cAAc,EAAE,eAAe,CAAC,CAKrD;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,cAAc,EACvD,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,UAAU,CAAC,YAAY,EAAE,cAAc,CAAC,CAMjD"}

package/dist/types/prototyping/dids/resolver-cache-memory.d.ts

@@ -1,57 +0,0 @@
-import type { DidResolutionResult, DidResolverCache } from '@enbox/dids';
-/**
- * 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 declare class DidResolverCacheMemory implements DidResolverCache {
-    private cache;
-    constructor({ ttl }?: DidResolverCacheMemoryParams);
-    /**
-     * 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.
-     */
-    get(didUri: string): Promise<DidResolutionResult | void>;
-    /**
-     * 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.
-     */
-    set(didUri: string, resolutionResult: DidResolutionResult): Promise<void>;
-    /**
-     * 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.
-     */
-    delete(didUri: string): Promise<void>;
-    /**
-     * Clears all entries from the cache.
-     *
-     * @returns A promise that resolves when the operation is complete.
-     */
-    clear(): Promise<void>;
-    /**
-     * This method is a no-op but exists to be consistent with other DID Resolver Cache
-     * implementations.
-     *
-     * @returns A promise that resolves immediately.
-     */
-    close(): Promise<void>;
-}
-//# sourceMappingURL=resolver-cache-memory.d.ts.map

package/dist/types/prototyping/dids/resolver-cache-memory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"resolver-cache-memory.d.ts","sourceRoot":"","sources":["../../../../src/prototyping/dids/resolver-cache-memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAKzE;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,qBAAa,sBAAuB,YAAW,gBAAgB;IAC7D,OAAO,CAAC,KAAK,CAAwC;gBAEzC,EAAE,GAAW,EAAE,GAAE,4BAAiC;IAI9D;;;;;;;OAOG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAQrE;;;;;;OAMG;IACU,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAItF;;;;;OAKG;IACU,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;;OAKG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAGpC"}

package/dist/types/prototyping/dids/utils.d.ts

@@ -1,3 +0,0 @@
-import type { PortableDid } from '@enbox/dids';
-export declare function isPortableDid(obj: unknown): obj is PortableDid;
-//# sourceMappingURL=utils.d.ts.map

package/dist/types/prototyping/dids/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/prototyping/dids/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW,CAO9D"}

package/dist/types/rpc-client.d.ts

@@ -1,51 +0,0 @@
-import type { DwnRpc, DwnRpcRequest, DwnRpcResponse } from './prototyping/clients/dwn-rpc-types.js';
-import type { DwnServerInfoRpc, ServerInfo } from './prototyping/clients/server-info-types.js';
-import { HttpDwnRpcClient } from './prototyping/clients/http-dwn-rpc-client.js';
-import { WebSocketDwnRpcClient } from './prototyping/clients/web-socket-clients.js';
-/**
- * Interface that can be implemented to communicate with {@link Web5Agent | Web5 Agent}
- * implementations via JSON-RPC.
- */
-export interface DidRpc {
-    get transportProtocols(): string[];
-    sendDidRequest(request: DidRpcRequest): Promise<DidRpcResponse>;
-}
-export declare enum DidRpcMethod {
-    Create = "did.create",
-    Resolve = "did.resolve"
-}
-export type DidRpcRequest = {
-    data: string;
-    method: DidRpcMethod;
-    url: string;
-};
-export type DidRpcResponse = {
-    data?: string;
-    ok: boolean;
-    status: RpcStatus;
-};
-export type RpcStatus = {
-    code: number;
-    message: string;
-};
-export interface Web5Rpc extends DwnRpc, DidRpc, DwnServerInfoRpc {
-}
-/**
- * Client used to communicate with Dwn Servers
- */
-export declare class Web5RpcClient implements Web5Rpc {
-    private transportClients;
-    constructor(clients?: Web5Rpc[]);
-    get transportProtocols(): string[];
-    sendDidRequest(request: DidRpcRequest): Promise<DidRpcResponse>;
-    sendDwnRequest(request: DwnRpcRequest): Promise<DwnRpcResponse>;
-    getServerInfo(dwnUrl: string): Promise<ServerInfo>;
-}
-export declare class HttpWeb5RpcClient extends HttpDwnRpcClient implements Web5Rpc {
-    sendDidRequest(request: DidRpcRequest): Promise<DidRpcResponse>;
-}
-export declare class WebSocketWeb5RpcClient extends WebSocketDwnRpcClient implements Web5Rpc {
-    sendDidRequest(_request: DidRpcRequest): Promise<DidRpcResponse>;
-    getServerInfo(_dwnUrl: string): Promise<ServerInfo>;
-}
-//# sourceMappingURL=rpc-client.d.ts.map

package/dist/types/rpc-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rpc-client.d.ts","sourceRoot":"","sources":["../../src/rpc-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AACpG,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,4CAA4C,CAAC;AAI/F,OAAO,EAAE,gBAAgB,EAAE,MAAM,8CAA8C,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6CAA6C,CAAC;AAEpF;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,kBAAkB,IAAI,MAAM,EAAE,CAAA;IAClC,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CAChE;AAED,oBAAY,YAAY;IACtB,MAAM,eAAe;IACrB,OAAO,gBAAgB;CACxB;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,YAAY,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,OAAO,CAAC;IACZ,MAAM,EAAE,SAAS,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,OAAQ,SAAQ,MAAM,EAAE,MAAM,EAAE,gBAAgB;CAAG;AAEpE;;GAEG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC3C,OAAO,CAAC,gBAAgB,CAAuB;gBAEnC,OAAO,GAAE,OAAO,EAAO;IAcnC,IAAI,kBAAkB,IAAI,MAAM,EAAE,CAEjC;IAEK,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAerE,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAezD,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAczD;AAED,qBAAa,iBAAkB,SAAQ,gBAAiB,YAAW,OAAO;IAClE,cAAc,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;CAoCtE;AAED,qBAAa,sBAAuB,SAAQ,qBAAsB,YAAW,OAAO;IAC5E,cAAc,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAIhE,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;CAG1D"}

package/src/dwn-registrar.ts

@@ -1,127 +0,0 @@
-import { concatenateUrl } from './utils.js';
-import { Convert } from '@enbox/common';
-import { CryptoUtils, Sha256 } from '@enbox/crypto';
-
-/**
- * A client for registering tenants with a DWN.
- */
-export class DwnRegistrar {
-  /**
-   * Registers a new tenant with the given DWN.
-   * NOTE: Assumes the user has already accepted the terms of service.
-   * NOTE: Currently the DWN Server from `dwn-server` does not require user signature.
-   * TODO: bring in types from `dwn-server`.
-   */
-  public static async registerTenant(dwnEndpoint: string, did: string): Promise<void> {
-
-    const registrationEndpoint = concatenateUrl(dwnEndpoint, 'registration');
-    const termsOfUseEndpoint = concatenateUrl(registrationEndpoint, 'terms-of-service');
-    const proofOfWorkEndpoint = concatenateUrl(registrationEndpoint, 'proof-of-work');
-
-    // fetch the terms-of-service
-    const termsOfServiceGetResponse = await fetch(termsOfUseEndpoint, {
-      method: 'GET',
-    });
-
-    if (termsOfServiceGetResponse.status !== 200) {
-      const statusCode = termsOfServiceGetResponse.status;
-      const statusText = termsOfServiceGetResponse.statusText;
-      const errorText = await termsOfServiceGetResponse.text();
-      throw new Error(`Failed fetching terms-of-service: ${statusCode} ${statusText}: ${errorText}`);
-    }
-    const termsOfServiceFetched = await termsOfServiceGetResponse.text();
-
-    // fetch the proof-of-work challenge
-    const proofOfWorkChallengeGetResponse = await fetch(proofOfWorkEndpoint, {
-      method: 'GET',
-    });
-    const { challengeNonce, maximumAllowedHashValue } = await proofOfWorkChallengeGetResponse.json();
-
-    // create registration data based on the hash of the terms-of-service and the DID
-    const registrationData = {
-      did,
-      termsOfServiceHash: await DwnRegistrar.hashAsHexString(termsOfServiceFetched),
-    };
-
-    // compute the proof-of-work response nonce based on the the proof-of-work challenge and the registration data.
-    const responseNonce = await DwnRegistrar.findQualifiedResponseNonce({
-      challengeNonce,
-      maximumAllowedHashValue,
-      requestData: JSON.stringify(registrationData),
-    });
-
-    // send the registration request to the server
-    const registrationRequest = {
-      registrationData,
-      proofOfWork: {
-        challengeNonce,
-        responseNonce,
-      },
-    };
-
-    const registrationResponse = await fetch(registrationEndpoint, {
-      method  : 'POST',
-      headers : { 'Content-Type': 'application/json' },
-      body    : JSON.stringify(registrationRequest),
-    });
-
-    if (registrationResponse.status !== 200) {
-      const statusCode = registrationResponse.status;
-      const statusText = registrationResponse.statusText;
-      const errorText = await registrationResponse.text();
-      throw new Error(`Registration failed: ${statusCode} ${statusText}: ${errorText}`);
-    }
-  }
-
-  /**
-   * Computes the SHA-256 hash of the given array of strings.
-   */
-  public static async hashAsHexString(input: string): Promise<string> {
-    const hashAsBytes = await Sha256.digest({ data: Convert.string(input).toUint8Array() });
-    const hashAsHex = Convert.uint8Array(hashAsBytes).toHex();
-    return hashAsHex;
-  }
-
-  /**
-   * Finds a response nonce that qualifies the difficulty requirement for the given proof-of-work challenge and request data.
-   */
-  public static async findQualifiedResponseNonce(input: {
-    maximumAllowedHashValue: string;
-    challengeNonce: string;
-    requestData: string;
-  }): Promise<string> {
-    const startTime = Date.now();
-
-    const { maximumAllowedHashValue, challengeNonce, requestData } = input;
-    const maximumAllowedHashValueAsBigInt = BigInt(`0x${maximumAllowedHashValue}`);
-
-    let iterations = 1;
-    let responseNonce;
-    let qualifiedSolutionNonceFound = false;
-    do {
-      responseNonce = await this.generateNonce();
-      const computedHash = await DwnRegistrar.hashAsHexString(challengeNonce + responseNonce + requestData);
-      const computedHashAsBigInt = BigInt(`0x${computedHash}`);
-
-      qualifiedSolutionNonceFound = computedHashAsBigInt <= maximumAllowedHashValueAsBigInt;
-
-      iterations++;
-    } while (!qualifiedSolutionNonceFound);
-
-    // Log final/successful iteration.
-    console.log(
-      `iterations: ${iterations}, time lapsed: ${Date.now() - startTime} ms`,
-    );
-
-    return responseNonce;
-  }
-
-  /**
-   * Generates 32 random bytes expressed as a HEX string.
-   */
-  public static async generateNonce(): Promise<string> {
-    const randomBytes = CryptoUtils.randomBytes(32);
-    const hexString = Convert.uint8Array(randomBytes).toHex().toUpperCase();
-    return hexString;
-  }
-}

package/src/prototyping/clients/dwn-rpc-types.ts

@@ -1,55 +0,0 @@
-import type { MessageSubscriptionHandler, RecordsReadReply, RecordSubscriptionHandler, UnionMessageReply } from '@enbox/dwn-sdk-js';
-
-export interface SerializableDwnMessage {
-  toJSON(): string;
-}
-
-export type DwnSubscriptionHandler = MessageSubscriptionHandler | RecordSubscriptionHandler;
-
-/**
- * Interface for communicating with {@link https://github.com/enboxorg/enbox | DWN Servers}
- * via JSON-RPC, supporting operations like sending DWN requests.
- */
-export interface DwnRpc {
-  /**
-   * Lists the transport protocols supported by the DWN RPC client, such as HTTP or HTTPS.
-   * @returns An array of strings representing the supported transport protocols.
-   */
-  get transportProtocols(): string[]
-
-  /**
-   * Sends a request to a DWN Server using the specified DWN RPC request parameters.
-   *
-   * @param request - The DWN RPC request containing the URL, target DID, message, and optional data.
-   * @returns A promise that resolves to the response from the DWN server.
-   */
-  sendDwnRequest(request: DwnRpcRequest): Promise<DwnRpcResponse>
-}
-
-
-/**
- * Represents a JSON RPC request to a DWN server, including the URL, target DID, the message to be
- * processed, and optional data.
- */
-export type DwnRpcRequest = {
-  /** Optional data to be sent with the request. */
-  data?: any;
-
-  /** The URL of the DWN server to which the request is sent. */
-  dwnUrl: string;
-
-  /** The message to be processed by the DWN server, which can be a serializable DWN message. */
-  message: SerializableDwnMessage | any;
-
-  /** The DID of the target to which the message is addressed. */
-  targetDid: string;
-
-  /** Optional subscription handler for DWN message events. */
-  subscriptionHandler?: DwnSubscriptionHandler;
-};
-
-/**
- * Represents the JSON RPC response from a DWN server to a request, combining the results of various
- * DWN operations.
- */
-export type DwnRpcResponse = UnionMessageReply & RecordsReadReply;

package/src/prototyping/clients/dwn-server-info-cache-memory.ts

@@ -1,79 +0,0 @@
-
-import ms from 'ms';
-import { TtlCache } from '@enbox/common';
-import type { DwnServerInfoCache, ServerInfo } from './server-info-types.js';
-
-/**
- * Configuration parameters for creating an in-memory cache for DWN ServerInfo entries.
- *
- * Allows customization of the cache time-to-live (TTL) setting.
- */
-export type DwnServerInfoCacheMemoryParams = {
-  /**
-   * 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 DwnServerInfoCacheMemory implements DwnServerInfoCache {
-  private cache: TtlCache<string, ServerInfo>;
-
-  constructor({ ttl = '15m' }: DwnServerInfoCacheMemoryParams= {}) {
-    this.cache = new TtlCache({ ttl: ms(ttl) });
-  }
-
-  /**
-   * Retrieves a DWN ServerInfo entry from the cache.
-   *
-   * If the cached item has exceeded its TTL, it's scheduled for deletion and undefined is returned.
-   *
-   * @param dwnUrl - The DWN URL endpoint string used as the key for getting the entry.
-   * @returns The cached DWN ServerInfo entry or undefined if not found or expired.
-   */
-  public async get(dwnUrl: string): Promise<ServerInfo| undefined> {
-    return this.cache.get(dwnUrl);
-  }
-
-  /**
-   * Stores a DWN ServerInfo entry in the cache with a TTL.
-   *
-   * @param dwnUrl - The DWN URL endpoint string used as the key for storing the entry.
-   * @param value - The DWN ServerInfo entry to be cached.
-   * @returns A promise that resolves when the operation is complete.
-   */
-  public async set(dwnUrl: string, value: ServerInfo): Promise<void> {
-    this.cache.set(dwnUrl, value);
-  }
-
-  /**
-   * Deletes a DWN ServerInfo entry from the cache.
-   *
-   * @param dwnUrl - The DWN URL endpoint string used as the key for deletion.
-   * @returns A promise that resolves when the operation is complete.
-   */
-  public async delete(dwnUrl: string): Promise<void> {
-    this.cache.delete(dwnUrl);
-  }
-
-  /**
-   * 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 DWN ServerInfo 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/prototyping/clients/http-dwn-rpc-client.ts

@@ -1,119 +0,0 @@
-import type { JsonRpcResponse } from './json-rpc.js';
-import type { DwnRpc, DwnRpcRequest, DwnRpcResponse } from './dwn-rpc-types.js';
-import type { DwnServerInfoCache, ServerInfo } from './server-info-types.js';
-
-import { CryptoUtils } from '@enbox/crypto';
-import { DataStream } from '@enbox/dwn-sdk-js';
-import { DwnServerInfoCacheMemory } from './dwn-server-info-cache-memory.js';
-import { createJsonRpcRequest, parseJson } from './json-rpc.js';
-
-/**
- * HTTP client that can be used to communicate with Dwn Servers
- */
-export class HttpDwnRpcClient implements DwnRpc {
-  private serverInfoCache: DwnServerInfoCache;
-  constructor(serverInfoCache?: DwnServerInfoCache) {
-    this.serverInfoCache = serverInfoCache ?? new DwnServerInfoCacheMemory();
-  }
-
-  get transportProtocols(): string[] { return ['http:', 'https:']; }
-
-  async sendDwnRequest(request: DwnRpcRequest): Promise<DwnRpcResponse> {
-    const requestId = CryptoUtils.randomUuid();
-    const jsonRpcRequest = createJsonRpcRequest(requestId, 'dwn.processMessage', {
-      target  : request.targetDid,
-      message : request.message
-    });
-
-    const requestHeaders: Record<string, string> = {
-      'dwn-request': JSON.stringify(jsonRpcRequest)
-    };
-
-    const fetchOpts: RequestInit = {
-      method  : 'POST',
-      headers : requestHeaders,
-    };
-
-    if (request.data) {
-      requestHeaders['content-type'] = 'application/octet-stream';
-      fetchOpts.body = request.data;
-    }
-
-    const resp = await fetch(request.dwnUrl, fetchOpts);
-    let dwnRpcResponse: JsonRpcResponse;
-
-    // When the server streams record data back, the JSON-RPC envelope is in the
-    // `dwn-response` header and the body is the raw data stream.  Otherwise the
-    // entire JSON-RPC response is the body.
-    const hasDataStream = resp.headers.has('dwn-response');
-
-    if (hasDataStream) {
-      const jsonRpcResponse = parseJson(resp.headers.get('dwn-response')!) as JsonRpcResponse;
-
-      if (jsonRpcResponse == null) {
-        throw new Error(`failed to parse json rpc response. dwn url: ${request.dwnUrl}`);
-      }
-
-      dwnRpcResponse = jsonRpcResponse;
-    } else {
-      const responseBody = await resp.text();
-      dwnRpcResponse = JSON.parse(responseBody);
-    }
-
-    if (dwnRpcResponse.error) {
-      const { code, message } = dwnRpcResponse.error;
-      throw new Error(`(${code}) - ${message}`);
-    }
-
-    // Materialise the response body before attaching to the reply.
-    // Bun (<=1.3.9) has a bug where resp.body.getReader() can intermittently
-    // return undefined, crashing DataStream.toBytes() in its finally block.
-    // Buffering via arrayBuffer() is a safe workaround.
-    // TODO: https://github.com/enboxorg/enbox/issues/90 — remove once Bun ships fix
-    const { reply } = dwnRpcResponse.result;
-    if (hasDataStream) {
-      const bodyBytes = new Uint8Array(await resp.arrayBuffer());
-      const dataStream = DataStream.fromBytes(bodyBytes);
-      if (reply.record) {
-        reply.record.data = dataStream;
-      } else if (reply.entry) {
-        reply.entry.data = dataStream;
-      }
-    }
-
-    return reply as DwnRpcResponse;
-  }
-
-  async getServerInfo(dwnUrl: string): Promise<ServerInfo> {
-    const serverInfo = await this.serverInfoCache.get(dwnUrl);
-    if (serverInfo) {
-      return serverInfo;
-    }
-
-    const url = new URL(dwnUrl);
-
-    // add `/info` to the dwn server url path
-    url.pathname.endsWith('/') ? url.pathname += 'info' : url.pathname += '/info';
-
-    try {
-      const response = await fetch(url.toString());
-      if (response.ok) {
-        const results = await response.json() as ServerInfo;
-
-        // explicitly return and cache only the desired properties.
-        const serverInfo = {
-          registrationRequirements : results.registrationRequirements,
-          maxFileSize              : results.maxFileSize,
-          webSocketSupport         : results.webSocketSupport,
-        };
-        this.serverInfoCache.set(dwnUrl, serverInfo);
-
-        return serverInfo;
-      } else {
-        throw new Error(`HTTP (${response.status}) - ${response.statusText}`);
-      }
-    } catch (error: any) {
-      throw new Error(`Error encountered while processing response from ${url.toString()}: ${error.message}`);
-    }
-  }
-}