@enbox/api 0.0.1

package/dist/types/utils.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Converts various data types to a `Blob` object, automatically detecting the data type or using
+ * the specified `dataFormat` to set the Blob's MIME type.
+ *
+ * This function supports plain text, JSON objects, binary data (Uint8Array, ArrayBuffer), and Blob
+ * inputs and will attempt to automatically detect the type of the data if `dataFormat` is not
+ * explicitly provided.
+ *
+ * @beta
+ *
+ * @example
+ * ```ts
+ * // Convert a JSON object to a Blob
+ * const { dataBlob, dataFormat } = dataToBlob({ key: 'value' }, 'application/json');
+ *
+ * // Convert a plain text string to a Blob without specifying dataFormat
+ * const { dataBlob: textBlob } = dataToBlob('Hello, world!');
+ *
+ * // Convert binary data to a Blob
+ * const binaryData = new Uint8Array([0, 1, 2, 3]);
+ * const { dataBlob: binaryBlob } = dataToBlob(binaryData);
+ * ```
+ *
+ * @param data - The data to be converted into a `Blob`. This can be a string, an object, binary
+ *               data (Uint8Array or ArrayBuffer), or a Blob.
+ * @param dataFormat - An optional MIME type string that specifies the format of the data. Common
+ *                     types include 'text/plain' for string data, 'application/json' for JSON
+ *                     objects, and 'application/octet-stream' for binary data. If not provided, the
+ *                     function will attempt to detect the format based on the data type or default
+ *                     to 'application/octet-stream'.
+ * @returns An object containing the `dataBlob`, a Blob representation of the input data, and
+ *          `dataFormat`, the MIME type of the data as determined by the function or specified by the caller.
+ * @throws An error if the data type is not supported or cannot be converted to a Blob.
+ */
+export declare function dataToBlob(data: any, dataFormat?: string): {
+    /** A Blob representation of the input data. */
+    dataBlob: Blob;
+    /** The MIME type of the data. */
+    dataFormat: string;
+};
+/**
+ * The `SendCache` class provides a static caching mechanism to optimize the process of sending
+ * records to remote DWN targets by minimizing redundant sends.
+ *
+ * It maintains a cache of record IDs and their associated target DIDs to which they have been sent.
+ * This helps in avoiding unnecessary network requests and ensures efficient data synchronization
+ * across Decentralized Web Nodes (DWNs).
+ *
+ * The cache employs a simple eviction policy to maintain a manageable size, ensuring that the cache
+ * does not grow indefinitely and consume excessive memory resources.
+ *
+ * @beta
+ */
+export declare class SendCache {
+    /**
+     * A private static map that serves as the core storage mechanism for the cache. It maps record
+     * IDs to a set of target DIDs, indicating which records have been sent to which targets.
+    */
+    private static cache;
+    /**
+     * The maximum number of entries allowed in the cache. Once this limit is exceeded, the oldest
+     * entries are evicted to make room for new ones. This limit applies both to the number of records
+     * and the number of targets per record.
+     */
+    private static sendCacheLimit;
+    /**
+     * Checks if a given record ID has been sent to a specified target DID. This method is used to
+     * determine whether a send operation is necessary or if it can be skipped to avoid redundancy.
+     *
+     * @param id - The unique identifier of the record.
+     * @param target - The DID of the target to check against.
+     * @returns A boolean indicating whether the record has been sent to the target.
+     */
+    static check(id: string, target: string): boolean;
+    /**
+     * Adds or updates an entry in the cache for a given record ID and target DID. If the cache
+     * exceeds its size limit, the oldest entry is removed. This method ensures that the cache
+     * reflects the most recent sends.
+     *
+     * @param id - The unique identifier of the record.
+     * @param target - The DID of the target to which the record has been sent.
+     */
+    static set(id: string, target: string): void;
+}
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG;IAC1D,+CAA+C;IAC/C,QAAQ,EAAE,IAAI,CAAC;IACf,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAC;CACpB,CAqBA;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,SAAS;IACpB;;;MAGE;IACF,OAAO,CAAC,MAAM,CAAC,KAAK,CAAkC;IAEtD;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc,CAAO;IAEpC;;;;;;;OAOG;WACW,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAKxD;;;;;;;OAOG;WACW,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAepD"}

package/dist/types/vc-api.d.ts

@@ -0,0 +1,24 @@
+import type { Web5Agent } from '@enbox/agent';
+/**
+ * The VC API is used to issue, present and verify VCs
+ *
+ * @beta
+ */
+export declare class VcApi {
+    /**
+     * Holds the instance of a {@link Web5Agent} that represents the current execution context for
+     * the `VcApi`. This agent is used to process VC requests.
+     */
+    private agent;
+    /** The DID of the tenant under which DID operations are being performed. */
+    private connectedDid;
+    constructor(options: {
+        agent: Web5Agent;
+        connectedDid: string;
+    });
+    /**
+     * Issues a VC (Not implemented yet)
+     */
+    create(): Promise<void>;
+}
+//# sourceMappingURL=vc-api.d.ts.map

package/dist/types/vc-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vc-api.d.ts","sourceRoot":"","sources":["../../src/vc-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C;;;;GAIG;AACH,qBAAa,KAAK;IAChB;;;OAGG;IACH,OAAO,CAAC,KAAK,CAAY;IAEzB,4EAA4E;IAC5E,OAAO,CAAC,YAAY,CAAS;gBAEjB,OAAO,EAAE;QAAE,KAAK,EAAE,SAAS,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE;IAK/D;;OAEG;IACG,MAAM;CAIb"}

package/dist/types/web5.d.ts

@@ -0,0 +1,219 @@
+/**
+ * NOTE: Added reference types here to avoid a `pnpm` bug during build.
+ * https://github.com/TBD54566975/web5-js/pull/507
+ */
+import type { DwnDataEncodedRecordsWriteMessage, DwnProtocolDefinition, HdIdentityVault, Permission, WalletConnectOptions, Web5Agent } from '@enbox/agent';
+import { DidApi } from './did-api.js';
+import { DwnApi } from './dwn-api.js';
+import { VcApi } from './vc-api.js';
+/** Override defaults configured during the technical preview phase. */
+export type TechPreviewOptions = {
+    /** Override default dwnEndpoints provided for technical preview. */
+    dwnEndpoints?: string[];
+};
+/** Override defaults for DID creation. */
+export type DidCreateOptions = {
+    /** Override default dwnEndpoints provided during DID creation. */
+    dwnEndpoints?: string[];
+};
+/**
+ * Represents a permission request for a protocol definition.
+ */
+export type ConnectPermissionRequest = {
+    /**
+     * The protocol definition for the protocol being requested.
+     */
+    protocolDefinition: DwnProtocolDefinition;
+    /**
+     * The permissions being requested for the protocol. If none are provided, the default is to request all permissions.
+     */
+    permissions?: Permission[];
+};
+/**
+ * Options for connecting to a Web5 agent. This includes the ability to connect to an external wallet.
+ *
+ * NOTE: the returned `ConnectPermissionRequest` type is different to the `ConnectPermissionRequest` type in the `@enbox/agent` package.
+ */
+export type ConnectOptions = Omit<WalletConnectOptions, 'permissionRequests'> & {
+    /** The user friendly name of the client/app to be displayed when prompting end-user with permission requests. */
+    displayName: string;
+    /**
+     * The permissions that are being requested for the connected DID.
+     * This is used to create the {@link ConnectPermissionRequest} for the wallet connect flow.
+     */
+    permissionRequests: ConnectPermissionRequest[];
+};
+/** Optional overrides that can be provided when calling {@link Web5.connect}. */
+export type Web5ConnectOptions = {
+    /**
+     * When specified, external wallet connect flow is triggered.
+     * This param currently will not work in apps that are currently connected.
+     * It must only be invoked at registration with a reset and empty DWN and agent.
+     */
+    walletConnectOptions?: ConnectOptions;
+    /**
+     * Provide a {@link Web5Agent} implementation. Defaults to creating a local
+     * {@link Web5UserAgent} if one isn't provided
+     **/
+    agent?: Web5Agent;
+    /**
+     * Provide an instance of a {@link HdIdentityVault} implementation. Defaults to
+     * a LevelDB-backed store with an insecure, static unlock password if one
+     * isn't provided. To allow the app user to enter a secure password of
+     * their choosing, provide an initialized {@link HdIdentityVault} instance.
+     **/
+    agentVault?: HdIdentityVault;
+    /** Specify an existing DID to connect to. */
+    connectedDid?: string;
+    /**
+     * The Web5 app `password` is used to protect data on the device the application is running on.
+     *
+     * Only the end user should know this password: it should not be stored on the device or
+     * transmitted over the network.
+     *
+     * This password is crucial for the security of an identity vault that stores the local Agent's
+     * cryptographic keys and decentralized identifier (DID). The vault's content is encrypted using
+     * the password, making it accessible only to those who know the password.
+     *
+     * App users should be advised to use a strong, unique passphrase that is not shared across
+     * different services or applications. The password should be kept confidential and not be
+     * exposed to unauthorized entities. Losing the password may result in irreversible loss of
+     * access to the vault's contents.
+     */
+    password?: string;
+    /**
+     * The `recoveryPhrase` is a unique, secure key for recovering the identity vault.
+     *
+     * This phrase is a series of 12 words generated securely and known only to the user. It plays a
+     * critical role in the security of the identity vault by enabling the recovery of the vault's
+     * contents, including cryptographic keys and the Agent's decentralized identifier (DID), across
+     * different devices or if the original device is compromised or lost.
+     *
+     * The recovery phrase is akin to a master key, as anyone with access to this phrase can restore
+     * and access the vault's contents. It’s combined with the app `password` to encrypt the vault's
+     * content.
+     *
+     * Unlike a password, the recovery phrase is not intended for regular use but as a secure backup
+     * method for vault recovery. Losing this phrase can result in permanent loss of access to the
+     * vault's contents, as it cannot be reset or retrieved if forgotten.
+     *
+     * Users should treat the recovery phrase with the highest level of security, ensuring it is
+     * never shared, stored online, or exposed to potential threats. It is the user's responsibility
+     * to keep this phrase safe to maintain the integrity and accessibility of their secured data. It
+     * is recommended to write it down and store it in a secure location, separate from the device and
+     * digital backups.
+     */
+    recoveryPhrase?: string;
+    /**
+     * Enable synchronization of DWN records between local and remote DWNs.
+     * Sync defaults to running every 2 minutes and can be set to any value accepted by `ms()`.
+     * To disable sync set to 'off'.
+     */
+    sync?: string;
+    /**
+     * Override defaults configured during the technical preview phase.
+     * See {@link TechPreviewOptions} for available options.
+     */
+    techPreview?: TechPreviewOptions;
+    /**
+     * Override defaults configured options for creating a DID during connect.
+     * See {@link DidCreateOptions} for available options.
+     */
+    didCreateOptions?: DidCreateOptions;
+    /**
+     * If the `registration` option is provided, the agent DID and the connected DID will be registered with the DWN endpoints provided by `techPreview` or `didCreateOptions`.
+     *
+     * If registration fails, the `onFailure` callback will be called with the error.
+     * If registration is successful, the `onSuccess` callback will be called.
+     */
+    registration?: {
+        /** Called when all of the DWN registrations are successful */
+        onSuccess: () => void;
+        /** Called when any of the DWN registrations fail */
+        onFailure: (error: any) => void;
+    };
+};
+/**
+ * Represents the result of the Web5 connection process, including the Web5 instance,
+ * the connected decentralized identifier (DID), and optionally the recovery phrase used
+ * during the agent's initialization.
+ */
+export type Web5ConnectResult = {
+    /** The Web5 instance, providing access to the agent, DID, DWN, and VC APIs. */
+    web5: Web5;
+    /** The DID that has been connected or created during the connection process. */
+    did: string;
+    /**
+     * The first time a Web5 agent is initialized, the recovery phrase that was used to generate the
+     * agent's DID and keys is returned. This phrase can be used to recover the agent's vault contents
+     * and should be stored securely by the user.
+     */
+    recoveryPhrase?: string;
+    /**
+     * The resulting did of a successful wallet connect. Only returned on success if
+     * {@link WalletConnectOptions} was provided.
+     */
+    delegateDid?: string;
+};
+/**
+ * Parameters that are passed to Web5 constructor.
+ *
+ * @see {@link Web5ConnectOptions}
+ */
+export type Web5Params = {
+    /**
+     * A {@link Web5Agent} instance that handles DIDs, DWNs and VCs requests. The agent manages the
+     * user keys and identities, and is responsible to sign and verify messages.
+     */
+    agent: Web5Agent;
+    /** The DID of the tenant under which all DID, DWN, and VC requests are being performed. */
+    connectedDid: string;
+    /** The DID that will be signing Web5 messages using grants from the connectedDid */
+    delegateDid?: string;
+};
+/**
+ * The main Web5 API interface. It manages the creation of a DID if needed, the connection to the
+ * local DWN and all the web5 main foundational APIs such as VC, syncing, etc.
+ */
+export declare class Web5 {
+    /**
+     * A {@link Web5Agent} instance that handles DIDs, DWNs and VCs requests. The agent manages the
+     * user keys and identities, and is responsible to sign and verify messages.
+     */
+    agent: Web5Agent;
+    /** Exposed instance to the DID APIs, allow users to create and resolve DIDs  */
+    did: DidApi;
+    /** Exposed instance to the DWN APIs, allow users to read/write records */
+    dwn: DwnApi;
+    /** Exposed instance to the VC APIs, allow users to issue, present and verify VCs */
+    vc: VcApi;
+    constructor({ agent, connectedDid, delegateDid }: Web5Params);
+    /**
+     * Connects to a {@link Web5Agent}. Defaults to creating a local {@link Web5UserAgent} if one
+     * isn't provided.
+     *
+     * If `walletConnectOptions` are provided, a WalletConnect flow will be initiated to import a delegated DID from an external wallet.
+     * If there is a failure at any point during connecting and processing grants, all created DIDs and Identities as well as the provided grants
+     * will be cleaned up and an error thrown. This allows for subsequent Connect attempts to be made without any errors.
+     *
+     * @param options - Optional overrides that can be provided when calling {@link Web5.connect}.
+     * @returns A promise that resolves to a {@link Web5} instance and the connected DID.
+     */
+    static connect({ agent, agentVault, connectedDid, password, recoveryPhrase, sync, techPreview, didCreateOptions, registration, walletConnectOptions, }?: Web5ConnectOptions): Promise<Web5ConnectResult>;
+    /**
+     * Cleans up the DID, Keys and Identity. Primarily used by a failed WalletConnect import.
+     * Does not throw on error, but logs to console.
+     */
+    private static cleanUpIdentity;
+    /**
+     * A static method to process connected grants for a delegate DID.
+     *
+     * This will store the grants as the DWN owner to be used later when impersonating the connected DID.
+     */
+    static processConnectedGrants({ grants, agent, delegateDid }: {
+        grants: DwnDataEncodedRecordsWriteMessage[];
+        agent: Web5Agent;
+        delegateDid: string;
+    }): Promise<string[]>;
+}
+//# sourceMappingURL=web5.d.ts.map

package/dist/types/web5.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web5.d.ts","sourceRoot":"","sources":["../../src/web5.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAEV,iCAAiC,EAEjC,qBAAqB,EAErB,eAAe,EACf,UAAU,EACV,oBAAoB,EACpB,SAAS,EACV,MAAM,cAAc,CAAC;AAKtB,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAGpC,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAC;AAEF,0CAA0C;AAC1C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,kEAAkE;IAClE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,kBAAkB,EAAE,qBAAqB,CAAC;IAE1C;;OAEG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;CAC5B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,GAAG;IAC9E,iHAAiH;IACjH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;CAChD,CAAA;AAED,iFAAiF;AACjF,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,cAAc,CAAC;IAEtC;;;QAGI;IACJ,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;;QAKI;IACJ,UAAU,CAAC,EAAE,eAAe,CAAC;IAE7B,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,WAAW,CAAC,EAAE,kBAAkB,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;;;OAKG;IACH,YAAY,CAAC,EAAG;QACd,8DAA8D;QAC9D,SAAS,EAAE,MAAM,IAAI,CAAC;QACtB,oDAAoD;QACpD,SAAS,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;KACjC,CAAA;CACF,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+EAA+E;IAC/E,IAAI,EAAE,IAAI,CAAC;IAEX,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,2FAA2F;IAC3F,YAAY,EAAE,MAAM,CAAC;IAErB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;GAGG;AACH,qBAAa,IAAI;IACf;;;OAGG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB,gFAAgF;IAChF,GAAG,EAAE,MAAM,CAAC;IAEZ,0EAA0E;IAC1E,GAAG,EAAE,MAAM,CAAC;IAEZ,oFAAoF;IACpF,EAAE,EAAE,KAAK,CAAC;gBAEE,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,UAAU;IAO5D;;;;;;;;;;OAUG;WACU,OAAO,CAAC,EACnB,KAAK,EACL,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,cAAc,EACd,IAAI,EACJ,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,oBAAoB,GACrB,GAAE,kBAAuB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAmMvD;;;OAGG;mBACkB,eAAe;IAuBpC;;;;OAIG;WACU,sBAAsB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAClE,MAAM,EAAE,iCAAiC,EAAE,CAAC;QAC5C,KAAK,EAAE,SAAS,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;CAqBtB"}

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@enbox/api",
+  "version": "0.0.1",
+  "description": "SDK for accessing the features and capabilities of Web5",
+  "type": "module",
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist tests/compiled",
+    "build:esm": "rimraf dist/esm dist/types && pnpm tsc -p tsconfig.json",
+    "build:cjs": "rimraf dist/cjs && pnpm tsc -p tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./dist/cjs/package.json",
+    "build:browser": "rimraf dist/browser.mjs dist/browser.js && node build/bundles.js",
+    "build:tests:node": "rimraf tests/compiled && pnpm tsc -p tests/tsconfig.json",
+    "build:tests:browser": "rimraf tests/compiled && node build/esbuild-tests.cjs",
+    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs && pnpm build:browser",
+    "lint": "eslint . --max-warnings 0",
+    "lint:fix": "eslint . --fix",
+    "test:node": "pnpm build:tests:node && pnpm c8 mocha",
+    "test:browser": "pnpm build:tests:browser && web-test-runner"
+  },
+  "homepage": "https://github.com/enboxorg/enbox/tree/main/packages/api#readme",
+  "bugs": "https://github.com/enboxorg/enbox/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/enboxorg/enbox.git",
+    "directory": "packages/api"
+  },
+  "license": "Apache-2.0",
+  "contributors": [
+    {
+      "name": "Daniel Buchner",
+      "url": "https://github.com/csuwildcat"
+    },
+    {
+      "name": "Frank Hinek",
+      "url": "https://github.com/frankhinek"
+    },
+    {
+      "name": "Moe Jangda",
+      "url": "https://github.com/mistermoe"
+    }
+  ],
+  "files": [
+    "dist",
+    "src"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    },
+    "./browser": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/browser.mjs",
+      "require": "./dist/browser.js"
+    }
+  },
+  "react-native": "./dist/esm/index.js",
+  "keywords": [
+    "decentralized",
+    "decentralized-applications",
+    "decentralized-identity",
+    "decentralized-web",
+    "DID",
+    "sdk",
+    "verifiable-credentials",
+    "web5",
+    "web5-sdk"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@enbox/agent": "workspace:*",
+    "@enbox/common": "workspace:*",
+    "@enbox/crypto": "workspace:*",
+    "@enbox/dids": "workspace:*",
+    "@enbox/user-agent": "workspace:*"
+  },
+  "devDependencies": {
+    "@playwright/test": "1.45.3",
+    "@enbox/dwn-sdk-js": "workspace:*",
+    "@types/chai": "4.3.6",
+    "@types/eslint": "8.56.10",
+    "@types/mocha": "10.0.1",
+    "@types/node": "20.14.8",
+    "@types/sinon": "17.0.3",
+    "@typescript-eslint/eslint-plugin": "7.9.0",
+    "@typescript-eslint/parser": "7.14.1",
+    "@web/test-runner": "0.18.2",
+    "@web/test-runner-playwright": "0.11.0",
+    "c8": "9.1.0",
+    "chai": "4.3.10",
+    "esbuild": "0.19.8",
+    "eslint": "9.3.0",
+    "eslint-plugin-mocha": "10.4.3",
+    "mocha": "10.2.0",
+    "mocha-junit-reporter": "2.2.1",
+    "node-stdlib-browser": "1.2.0",
+    "playwright": "1.45.3",
+    "rimraf": "4.4.0",
+    "sinon": "18.0.0",
+    "source-map-loader": "4.0.2",
+    "typescript": "5.1.6"
+  }
+}

package/src/did-api.ts

@@ -0,0 +1,90 @@
+import type { DidCreateParams, DidMessageResult, DidResolveParams, ResponseStatus, Web5Agent } from '@enbox/agent';
+
+import { DidInterface } from '@enbox/agent';
+
+/**
+ * Parameters for creating a DID, specifying the method, options for the DID method, and whether to
+ * store the DID.
+ *
+ * @typeParam method - The DID method to use for creating the DID.
+ * @typeParam options - Method-specific options for creating the DID.
+ * @typeParam store - Indicates whether the newly created DID should be stored.
+ */
+export type DidCreateRequest = Pick<DidCreateParams, 'method' | 'options' | 'store'>;
+
+/**
+ * The response from a DID creation request, including the operation's status and, if successful,
+ * the created DID.
+ */
+export type DidCreateResponse = ResponseStatus & {
+  /** The result of the DID creation operation, containing the newly created DID, if successful */
+  did?: DidMessageResult[DidInterface.Create];
+};
+
+/**
+ * The response from resolving a DID, containing the DID Resolution Result.
+ *
+ * This type directly maps to the result of a DID resolution operation, providing detailed
+ * information about the DID document, including any DID document metadata and DID resolution
+ * metadata,
+ */
+export type DidResolveResponse = DidMessageResult[DidInterface.Resolve];
+
+/**
+ * The DID API is used to resolve DIDs.
+ *
+ * @beta
+ */
+export class DidApi {
+  /**
+   * Holds the instance of a {@link Web5Agent} that represents the current execution context for
+   * the `DidApi`. This agent is used to process DID requests.
+   */
+  private agent: Web5Agent;
+
+  /** The DID of the tenant under which DID operations are being performed. */
+  private connectedDid: string;
+
+  constructor(options: { agent: Web5Agent, connectedDid: string }) {
+    this.agent = options.agent;
+    this.connectedDid = options.connectedDid;
+  }
+
+  /**
+   * Initiates the creation of a Decentralized Identifier (DID) using the specified method, options,
+   * and storage preference.
+   *
+   * This method sends a request to the Web5 Agent to create a new DID based on the provided method,
+   * with method-specific options. It also specifies whether the newly created DID should be stored.
+   *
+   * @param request - The request parameters for creating a DID, including the method, options, and
+   *                  storage flag.
+   * @returns A promise that resolves to a `DidCreateResponse`, which includes the operation's
+   *          status and, if successful, the newly created DID.
+   */
+  public async create(request: DidCreateRequest): Promise<DidCreateResponse> {
+    const { result, ...status } = await this.agent.processDidRequest({
+      messageType   : DidInterface.Create,
+      messageParams : { ...request }
+    });
+
+    return { did: result, ...status };
+  }
+
+  /**
+   * Resolves a DID to a DID Resolution Result.
+   *
+   * @param didUri - The DID or DID URL to resolve.
+   * @returns A promise that resolves to the DID Resolution Result.
+   */
+  public async resolve(
+    didUri: DidResolveParams['didUri'], options?: DidResolveParams['options']
+  ): Promise<DidResolveResponse> {
+    const { result: didResolutionResult } = await this.agent.processDidRequest({
+      messageParams : { didUri, options },
+      messageType   : DidInterface.Resolve
+    });
+
+    return didResolutionResult;
+  }
+}