@enbox/dids 0.0.1

package/dist/types/methods/did-dht.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-dht.d.ts","sourceRoot":"","sources":["../../../src/methods/did-dht.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAA2B,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,KAAK,EACV,GAAG,EACH,MAAM,EACN,SAAS,EACT,aAAa,EACb,kBAAkB,EAClB,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAOvB,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACzE,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC5G,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAM7C;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,CAAC,EAAE,UAAU,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,UAAU,CAAC;IAEhB;;;OAGG;IACH,CAAC,EAAE,UAAU,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,IAAI,CAAE,SAAQ,gBAAgB,CAAC,IAAI,CAAC;IACvE;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEhC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,CAAC,uBAAuB,GAAG,MAAM,OAAO,uBAAuB,CAAC,EAAE,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAC;IAEpB,mGAAmG;IACnG,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAqDF;;;;;;;;;GASG;AACH,oBAAY,uBAAuB;IACjC;;;OAGG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,UAAU,IAAI;IAEd;;;OAGG;IACH,WAAW,IAAI;IAEf;;;OAGG;IACH,aAAa,IAAI;IAEjB;;;OAGG;IACH,eAAe,IAAI;IAEnB;;;OAGG;IACH,MAAM,IAAI;IAEV;;;OAGG;IACH,oBAAoB,IAAI;CACzB;AAED;;;;;;;;;GASG;AACH,oBAAY,uBAAuB;IACjC;;;OAGG;IACH,OAAO,IAAI;IAEX;;;OAGG;IACH,SAAS,IAAI;IAEb;;;OAGG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;OAEG;IACH,cAAc,SAAS;IAEvB;;;OAGG;IACH,eAAe,QAAQ;IAEvB;;;OAGG;IACH,oBAAoB,QAAQ;IAE5B;;OAEG;IACH,oBAAoB,QAAQ;IAE5B;;;OAGG;IACH,YAAY,QAAQ;CACrB;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,MAAO,SAAQ,SAAS;IAEnC;;OAEG;IACH,OAAc,UAAU,SAAS;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EAAE,EACzE,UAAkC,EAClC,OAAY,EACb,GAAE;QACD,UAAU,CAAC,EAAE,IAAI,CAAC;QAClB,OAAO,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,SAAS,CAAC;IA6G3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,MAAM,CAAC,EAAE,WAAW,EAAE,UAAkC,EAAE,EAAE;QAC9E,UAAU,CAAC,EAAE,SAAS,GAAG,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;QACpG,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,SAAS,CAAC;IAiBtB;;;;;;;;;;OAUG;WACiB,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAe,EAAE,EAAE;QACrE,WAAW,EAAE,WAAW,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,OAAO,CAAC,EAAE,GAAG,EAAE,UAAgC,EAAE,EAAE;QACrE,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMlC;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgC9G;AAED;;;;;;GAMG;AACH,qBAAa,cAAc;IACzB;;;;;;;;OAQG;WACiB,GAAG,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE;QAC9C,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAmBhC;;;;;;;;OAQG;WACiB,GAAG,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAC3C,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA+BlC;;;;;;;;;MASE;mBACmB,QAAQ;IAkD7B;;;;;;;;;OASG;mBACkB,QAAQ;IAiC7B;;;;;;;;;;OAUG;WACiB,aAAa,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;QACvD,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2JhC;;;;;;;;;;;OAWG;WACiB,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,EAAE;QACxG,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;QACzB,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;QACpC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;KACrC,GAAG,OAAO,CAAC,MAAM,CAAC;IA4LnB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAGlC;AAED;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;;;;;;OAQG;WACiB,qBAAqB,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE;QAC7E,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,UAAU,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,YAAY,CAAC;IAwB3B;;;;;;OAMG;WACiB,uBAAuB,CAAC,EAAE,MAAM,EAAE,EAAE;QACtD,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,GAAG,CAAC;IAUhB;;;;;;OAMG;WACW,4BAA4B,CAAC,EAAE,MAAM,EAAE,EAAE;QACrD,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,UAAU;IA6Bd;;;;;;;;;OASG;WACiB,uBAAuB,CAAC,EAAE,WAAW,EAAE,EAAE;QAC3D,WAAW,EAAE,GAAG,CAAA;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnB;;;;;OAKG;WACW,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB;IAqCjE;;;;;;OAMG;WACiB,oBAAoB,CAAC,EAAE,YAAY,EAAE,EAAE;QACzD,YAAY,EAAE,YAAY,CAAC;KAC5B,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBnB;;;;;OAKG;WACW,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQ5E;;;;;OAKG;WACW,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAY5D;;;;;;OAMG;WACiB,wBAAwB,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE;QACzE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjB;;;;OAIG;WACW,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE;CAajE"}

package/dist/types/methods/did-ion.d.ts

@@ -0,0 +1,492 @@
+import type { CryptoApi, Jwk, KeyIdentifier, KeyImporterExporter, KmsExportKeyParams, KmsImportKeyParams } from '@enbox/crypto';
+import type { IonDocumentModel } from '@decentralized-identity/ion-sdk';
+import type { PortableDid } from '../types/portable-did.js';
+import type { DidCreateOptions, DidCreateVerificationMethod, DidRegistrationResult } from '../methods/did-method.js';
+import type { DidService, DidDocument, DidResolutionResult, DidResolutionOptions, DidVerificationMethod, DidVerificationRelationship } from '../types/did-core.js';
+import { BearerDid } from '../bearer-did.js';
+import { DidMethod } from '../methods/did-method.js';
+/**
+ * Options for creating a Decentralized Identifier (DID) using the DID ION method.
+ */
+export interface DidIonCreateOptions<TKms> extends DidCreateOptions<TKms> {
+    /**
+     * Optional. The URI of a server involved in executing DID method operations. In the context of
+     * DID creation, the endpoint is expected to be a Sidetree node. If not specified, a default
+     * gateway node is used.
+     */
+    gatewayUri?: string;
+    /**
+     * Optional. Determines whether the created DID should be published to a Sidetree node.
+     *
+     * If set to `true` or omitted, the DID is publicly discoverable. If `false`, the DID is not
+     * published and cannot be resolved by others. By default, newly created DIDs are published.
+     *
+     * @see {@link https://identity.foundation/sidetree/spec/#create | Sidetree Protocol Specification, § Create}
+     *
+     * @example
+     * ```ts
+     * const did = await DidIon.create({
+     *  options: {
+     *   publish: false
+     * };
+     * ```
+     */
+    publish?: boolean;
+    /**
+     * Optional. An array of service endpoints associated with the DID.
+     *
+     * Services are used in DID documents to express ways of communicating with the DID subject or
+     * associated entities. A service can be any type of service the DID subject wants to advertise,
+     * including decentralized identity management services for further discovery, authentication,
+     * authorization, or interaction.
+     *
+     * @see {@link https://www.w3.org/TR/did-core/#services | DID Core Specification, § Services}
+     *
+     * @example
+     * ```ts
+     * const did = await DidIon.create({
+     *  options: {
+     *   services: [
+     *     {
+     *       id: 'dwn',
+     *       type: 'DecentralizedWebNode',
+     *       serviceEndpoint: ['https://example.com/dwn1', 'https://example/dwn2']
+     *     }
+     *   ]
+     * };
+     * ```
+     */
+    services?: DidService[];
+    /**
+     * Optional. An array of verification methods to be included in the DID document.
+     *
+     * By default, a newly created DID ION document will contain a single Ed25519 verification method.
+     * Additional verification methods can be added to the DID document using the
+     * `verificationMethods` property.
+     *
+     * @see {@link https://www.w3.org/TR/did-core/#verification-methods | DID Core Specification, § Verification Methods}
+     *
+     * @example
+     * ```ts
+     * const did = await DidIon.create({
+     *  options: {
+     *   verificationMethods: [
+     *     {
+     *       algorithm: 'Ed25519',
+     *       purposes: ['authentication', 'assertionMethod']
+     *     },
+     *     {
+     *       algorithm: 'Ed25519',
+     *       id: 'dwn-sig',
+     *       purposes: ['authentication', 'assertionMethod']
+     *     }
+     *   ]
+     * };
+     * ```
+     */
+    verificationMethods?: DidCreateVerificationMethod<TKms>[];
+}
+/**
+ * Represents the request model for managing DID documents within the ION network, according to the
+ * Sidetree protocol specification.
+ */
+export interface DidIonCreateRequest {
+    /** The type of operation to perform, which is always 'create' for a Create Operation. */
+    type: 'create';
+    /** Contains properties related to the initial state of the DID document. */
+    suffixData: {
+        /** A hash of the `delta` object, representing the initial changes to the DID document. */
+        deltaHash: string;
+        /** A commitment value used for future recovery operations, hashed for security. */
+        recoveryCommitment: string;
+    };
+    /** Details the changes to be applied to the DID document in this operation. */
+    delta: {
+        /** A commitment value used for the next update operation, hashed for security. */
+        updateCommitment: string;
+        /** An array of patch objects specifying the modifications to apply to the DID document. */
+        patches: {
+            /** The type of modification to perform (e.g., adding or removing public keys or service
+             * endpoints). */
+            action: string;
+            /** The document state or partial state to apply with this patch. */
+            document: IonDocumentModel;
+        }[];
+    };
+}
+/**
+ * Represents a {@link DidVerificationMethod | DID verification method} in the context of DID ION
+ * create, update, deactivate, and resolve operations.
+ *
+ * Unlike the DID Core standard {@link DidVerificationMethod} interface, this type is specific to
+ * the ION method operations and only includes the `id`, `publicKeyJwk`, and `purposes` properties:
+ * - The `id` property is optional and specifies the identifier fragment of the verification method.
+ * - The `publicKeyJwk` property is required and represents the public key in JWK format.
+ * - The `purposes` property is required and specifies the purposes for which the verification
+ *  method can be used.
+ *
+ * @example
+ * ```ts
+ * const verificationMethod: DidIonVerificationMethod = {
+ *   id           : 'sig',
+ *   publicKeyJwk : {
+ *     kty : 'OKP',
+ *     crv : 'Ed25519',
+ *     x   : 'o40shZrsco-CfEqk6mFsXfcP94ly3Az3gm84PzAUsXo',
+ *     kid : 'BDp0xim82GswlxnPV8TPtBdUw80wkGIF8gjFbw1x5iQ',
+ *   },
+ *   purposes: ['authentication', 'assertionMethod']
+ * };
+ * ```
+ */
+export interface DidIonVerificationMethod {
+    /**
+     * Optionally specify the identifier fragment of the verification method.
+     *
+     * If not specified, the method's ID will be generated from the key's ID or thumbprint.
+     *
+     * @example
+     * ```ts
+     * const verificationMethod: DidIonVerificationMethod = {
+     *   id: 'sig',
+     *   ...
+     * };
+     * ```
+     */
+    id?: string;
+    /**
+     * A public key in JWK format.
+     *
+     * A JSON Web Key (JWK) that conforms to {@link https://datatracker.ietf.org/doc/html/rfc7517 | RFC 7517}.
+     *
+     * @example
+     * ```ts
+     * const verificationMethod: DidIonVerificationMethod = {
+     *   publicKeyJwk: {
+     *     kty : "OKP",
+     *     crv : "X25519",
+     *     x   : "7XdJtNmJ9pV_O_3mxWdn6YjiHJ-HhNkdYQARzVU_mwY",
+     *     kid : "xtsuKULPh6VN9fuJMRwj66cDfQyLaxuXHkMlmAe_v6I"
+     *   },
+     *   ...
+     * };
+     * ```
+     */
+    publicKeyJwk: Jwk;
+    /**
+     * Specify the purposes for which a verification method is intended to be used in a DID document.
+     *
+     * The `purposes` property defines the specific
+     * {@link DidVerificationRelationship | verification relationships} between the DID subject and
+     * the verification method. This enables the verification method to be utilized for distinct
+     * actions such as authentication, assertion, key agreement, capability delegation, and others. It
+     * is important for verifiers to recognize that a verification method must be associated with the
+     * relevant purpose in the DID document to be valid for that specific use case.
+     *
+     * @example
+     * ```ts
+     * const verificationMethod: DidIonVerificationMethod = {
+     *   purposes: ['authentication', 'assertionMethod'],
+     *   ...
+     * };
+     * ```
+     */
+    purposes: (DidVerificationRelationship | keyof typeof DidVerificationRelationship)[];
+}
+/**
+ * `IonPortableDid` interface extends the {@link PortableDid} interface.
+ *
+ * It represents a Decentralized Identifier (DID) that is portable and can be used across different
+ * domains, including the ION specific recovery and update keys.
+ */
+export interface IonPortableDid extends PortableDid {
+    /** The JSON Web Key (JWK) used for recovery purposes. */
+    recoveryKey: Jwk;
+    /** The JSON Web Key (JWK) used for updating the DID. */
+    updateKey: Jwk;
+}
+/**
+ * Enumerates the types of keys that can be used in a DID ION document.
+ *
+ * The DID ION method supports various cryptographic key types. These key types are essential for
+ * the creation and management of DIDs and their associated cryptographic operations like signing
+ * and encryption.
+ */
+export declare enum DidIonRegisteredKeyType {
+    /**
+     * Ed25519: A public-key signature system using the EdDSA (Edwards-curve Digital Signature
+     * Algorithm) and Curve25519.
+     */
+    Ed25519 = "Ed25519",
+    /**
+     * secp256k1: A cryptographic curve used for digital signatures in a range of decentralized
+     * systems.
+     */
+    secp256k1 = "secp256k1",
+    /**
+     * secp256r1: Also known as P-256 or prime256v1, this curve is used for cryptographic operations
+     * and is widely supported in various cryptographic libraries and standards.
+     */
+    secp256r1 = "secp256r1",
+    /**
+     * X25519: A Diffie-Hellman key exchange algorithm using Curve25519.
+     */
+    X25519 = "X25519"
+}
+/**
+ * The `DidIon` class provides an implementation of the `did:ion` DID method.
+ *
+ * Features:
+ * - DID Creation: Create new `did:ion` DIDs.
+ * - DID Key Management: Instantiate a DID object from an existing key in a Key Management System
+ *                       (KMS). If supported by the KMS, a DID's key can be exported to a portable
+ *                       DID format.
+ * - DID Resolution: Resolve a `did:ion` to its corresponding DID Document stored in the Sidetree
+ *                   network.
+ * - Signature Operations: Sign and verify messages using keys associated with a DID.
+ *
+ * @see {@link https://identity.foundation/sidetree/spec/ | Sidetree Protocol Specification}
+ * @see {@link https://github.com/decentralized-identity/ion/blob/master/docs/design.md | ION Design Document}
+ *
+ * @example
+ * ```ts
+ * // DID Creation
+ * const did = await DidIon.create();
+ *
+ * // DID Creation with a KMS
+ * const keyManager = new LocalKeyManager();
+ * const did = await DidIon.create({ keyManager });
+ *
+ * // DID Resolution
+ * const resolutionResult = await DidIon.resolve({ did: did.uri });
+ *
+ * // Signature Operations
+ * const signer = await did.getSigner();
+ * const signature = await signer.sign({ data: new TextEncoder().encode('Message') });
+ * const isValid = await signer.verify({ data: new TextEncoder().encode('Message'), signature });
+ *
+ * // Key Management
+ *
+ * // Instantiate a DID object for a published DID with existing keys in a KMS
+ * const did = await DidIon.fromKeyManager({
+ *  didUri: 'did:ion:EiAzB7K-xDIKc1csXo5HX2eNBoemK9feNhL3cKwfukYOug',
+ *  keyManager
+ * });
+ *
+ * // Convert a DID object to a portable format
+ * const portableDid = await DidIon.toKeys({ did });
+ * ```
+ */
+export declare class DidIon extends DidMethod {
+    /**
+     * Name of the DID method, as defined in the DID ION specification.
+     */
+    static methodName: string;
+    /**
+     * Creates a new DID using the `did:ion` method formed from a newly generated key.
+     *
+     * Notes:
+     * - If no `options` are given, by default a new Ed25519 key will be generated.
+     *
+     * @example
+     * ```ts
+     * // DID Creation
+     * const did = await DidIon.create();
+     *
+     * // DID Creation with a KMS
+     * const keyManager = new LocalKeyManager();
+     * const did = await DidIon.create({ keyManager });
+     * ```
+     *
+     * @param params - The parameters for the create operation.
+     * @param params.keyManager - Optionally specify a Key Management System (KMS) used to generate
+     *                            keys and sign data.
+     * @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.
+     */
+    static create<TKms extends CryptoApi | undefined = undefined>({ keyManager, options }?: {
+        keyManager?: TKms;
+        options?: DidIonCreateOptions<TKms>;
+    }): Promise<BearerDid>;
+    /**
+     * Given the W3C DID Document of a `did:ion` DID, return the verification method that will be used
+     * for signing messages and credentials. If given, the `methodId` parameter is used to select the
+     * verification method. If not given, the first verification method in the authentication property
+     * in the DID Document is used.
+     *
+     * @param params - The parameters for the `getSigningMethod` operation.
+     * @param params.didDocument - DID Document to get the verification method from.
+     * @param params.methodId - ID of the verification method to use for signing.
+     * @returns Verification method to use for signing.
+     */
+    static getSigningMethod({ didDocument, methodId }: {
+        didDocument: DidDocument;
+        methodId?: string;
+    }): Promise<DidVerificationMethod>;
+    /**
+     * Instantiates a {@link BearerDid} object for the DID ION method from a given {@link PortableDid}.
+     *
+     * This method allows for the creation of a `BearerDid` object using a previously created DID's
+     * key material, DID document, and metadata.
+     *
+     * @example
+     * ```ts
+     * // Export an existing BearerDid to PortableDid format.
+     * const portableDid = await did.export();
+     * // Reconstruct a BearerDid object from the PortableDid.
+     * const did = await DidIon.import({ portableDid });
+     * ```
+     *
+     * @param params - The parameters for the import operation.
+     * @param params.portableDid - The PortableDid object to import.
+     * @param params.keyManager - Optionally specify an external Key Management System (KMS) used to
+     *                            generate keys and sign data. If not given, a new
+     *                            {@link LocalKeyManager} instance will be created and
+     *                            used.
+     * @returns A Promise resolving to a `BearerDid` object representing the DID formed from the
+     *          provided PortableDid.
+     * @throws An error if the DID document does not contain any verification methods or the keys for
+     *         any verification method are missing in the key manager.
+     */
+    static import({ portableDid, keyManager }: {
+        keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+        portableDid: PortableDid;
+    }): Promise<BearerDid>;
+    /**
+     * Publishes a DID to a Sidetree node, making it publicly discoverable and resolvable.
+     *
+     * This method handles the publication of a DID Document associated with a `did:ion` DID to a
+     * Sidetree node.
+     *
+     * @remarks
+     * - This method is typically invoked automatically during the creation of a new DID unless the
+     *   `publish` option is set to `false`.
+     * - For existing, unpublished DIDs, it can be used to publish the DID Document to a Sidetree node.
+     * - The method relies on the specified Sidetree node to interface with the network.
+     *
+     * @param params - The parameters for the `publish` operation.
+     * @param params.did - The `BearerDid` object representing the DID to be published.
+     * @param params.gatewayUri - Optional. The URI of a server involved in executing DID
+     *                                    method operations. In the context of publishing, the
+     *                                    endpoint is expected to be a Sidetree node. If not
+     *                                    specified, a default node is used.
+     * @returns A Promise resolving to a boolean indicating whether the publication was successful.
+     *
+     * @example
+     * ```ts
+     * // Generate a new DID and keys but explicitly disable publishing.
+     * const did = await DidIon.create({ options: { publish: false } });
+     * // Publish the DID to the Sidetree network.
+     * const isPublished = await DidIon.publish({ did });
+     * // `isPublished` is true if the DID was successfully published.
+     * ```
+     */
+    static publish({ did, gatewayUri }: {
+        did: BearerDid;
+        gatewayUri?: string;
+    }): Promise<DidRegistrationResult>;
+    /**
+     * Resolves a `did:ion` identifier to its corresponding DID document.
+     *
+     * This method performs the resolution of a `did:ion` DID, retrieving its DID Document from the
+     * Sidetree-based DID overlay network. The process involves querying a Sidetree node to retrieve
+     * the DID Document that corresponds to the given DID identifier.
+     *
+     * @remarks
+     * - If a `gatewayUri` option is not specified, a default node is used to access the Sidetree
+     *   network.
+     * - It decodes the DID identifier and retrieves the associated DID Document and metadata.
+     * - In case of resolution failure, appropriate error information is returned.
+     *
+     * @example
+     * ```ts
+     * const resolutionResult = await DidIon.resolve('did:ion:example');
+     * ```
+     *
+     * @param didUri - The DID to be resolved.
+     * @param options - Optional parameters for resolving the DID. Unused by this DID method.
+     * @returns A Promise resolving to a {@link DidResolutionResult} object representing the result of the resolution.
+     */
+    static resolve(didUri: string, options?: DidResolutionOptions): Promise<DidResolutionResult>;
+}
+/**
+ * The `DidIonUtils` class provides utility functions to support operations in the DID ION method.
+ */
+export declare class DidIonUtils {
+    /**
+     * Appends a specified path to a base URL, ensuring proper formatting of the resulting URL.
+     *
+     * This method is useful for constructing URLs for accessing various endpoints, such as Sidetree
+     * nodes in the ION network. It handles the nuances of URL path concatenation, including the
+     * addition or removal of leading/trailing slashes, to create a well-formed URL.
+     *
+     * @param params - The parameters for URL construction.
+     * @param params.baseUrl - The base URL to which the path will be appended.
+     * @param params.path - The path to append to the base URL.
+     * @returns The fully constructed URL string with the path appended to the base URL.
+     */
+    static appendPathToUrl({ baseUrl, path }: {
+        baseUrl: string;
+        path: string;
+    }): string;
+    /**
+     * Computes the Long Form DID URI given an ION DID's recovery key, update key, services, and
+     * verification methods.
+     *
+     * @param params - The parameters for computing the Long Form DID URI.
+     * @param params.recoveryKey - The ION Recovery Key.
+     * @param params.updateKey - The ION Update Key.
+     * @param params.services - An array of services associated with the DID.
+     * @param params.verificationMethods - An array of verification methods associated with the DID.
+     * @returns A Promise resolving to the Long Form DID URI.
+     */
+    static computeLongFormDidUri({ recoveryKey, updateKey, services, verificationMethods }: {
+        recoveryKey: Jwk;
+        updateKey: Jwk;
+        services: DidService[];
+        verificationMethods: DidIonVerificationMethod[];
+    }): Promise<string>;
+    /**
+     * Constructs a Sidetree Create Operation request for a DID document within the ION network.
+     *
+     * This method prepares the necessary payload for submitting a Create Operation to a Sidetree
+     * node, encapsulating the details of the DID document, recovery key, and update key.
+     *
+     * @param params - Parameters required to construct the Create Operation request.
+     * @param params.ionDocument - The DID document model containing public keys and service endpoints.
+     * @param params.recoveryKey - The recovery public key in JWK format.
+     * @param params.updateKey - The update public key in JWK format.
+     * @returns A promise resolving to the ION Create Operation request model, ready for submission to a Sidetree node.
+     */
+    static constructCreateRequest({ ionDocument, recoveryKey, updateKey }: {
+        ionDocument: IonDocumentModel;
+        recoveryKey: Jwk;
+        updateKey: Jwk;
+    }): Promise<DidIonCreateRequest>;
+    /**
+     * Assembles an ION document model from provided services and verification methods
+     *
+     * This model serves as the foundation for a DID document in the ION network, facilitating the
+     * creation and management of decentralized identities. It translates service endpoints and
+     * public keys into a format compatible with the Sidetree protocol, ensuring the resulting DID
+     * document adheres to the required specifications for ION DIDs. This method is essential for
+     * constructing the payload needed to register or update DIDs within the ION network.
+     *
+     * @param params - The parameters containing the services and verification methods to include in the ION document.
+     * @param params.services - A list of service endpoints to be included in the DID document, specifying ways to interact with the DID subject.
+     * @param params.verificationMethods - A list of verification methods to be included, detailing the cryptographic keys and their intended uses within the DID document.
+     * @returns A Promise resolving to an `IonDocumentModel`, ready for use in Sidetree operations like DID creation and updates.
+     */
+    static createIonDocument({ services, verificationMethods }: {
+        services: DidService[];
+        verificationMethods: DidIonVerificationMethod[];
+    }): Promise<IonDocumentModel>;
+    /**
+     * Normalize the given JWK to include only specific members and in lexicographic order.
+     *
+     * @param jwk - The JWK to normalize.
+     * @returns The normalized JWK.
+     */
+    private static normalizeJwk;
+}
+//# sourceMappingURL=did-ion.d.ts.map

package/dist/types/methods/did-ion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"did-ion.d.ts","sourceRoot":"","sources":["../../../src/methods/did-ion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,aAAa,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAChI,OAAO,KAAK,EAEV,gBAAgB,EAGjB,MAAM,iCAAiC,CAAC;AAKzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACrH,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAKrD;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,IAAI,CAAE,SAAQ,gBAAgB,CAAC,IAAI,CAAC;IACvE;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;CAC3D;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,yFAAyF;IACzF,IAAI,EAAE,QAAQ,CAAC;IAEf,4EAA4E;IAC5E,UAAU,EAAE;QACV,0FAA0F;QAC1F,SAAS,EAAE,MAAM,CAAC;QAClB,mFAAmF;QACnF,kBAAkB,EAAE,MAAM,CAAC;KAC5B,CAAC;IAEF,+EAA+E;IAC/E,KAAK,EAAE;QACL,kFAAkF;QAClF,gBAAgB,EAAE,MAAM,CAAC;QACzB,2FAA2F;QAC3F,OAAO,EAAE;YACP;6BACiB;YACjB,MAAM,EAAE,MAAM,CAAC;YACf,oEAAoE;YACpE,QAAQ,EAAE,gBAAgB,CAAC;SAC5B,EAAE,CAAC;KACL,CAAA;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;;;;;;;;OAYG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,EAAE,GAAG,CAAC;IAElB;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,EAAE,CAAC,2BAA2B,GAAG,MAAM,OAAO,2BAA2B,CAAC,EAAE,CAAC;CACtF;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,yDAAyD;IACzD,WAAW,EAAE,GAAG,CAAC;IAEjB,wDAAwD;IACxD,SAAS,EAAE,GAAG,CAAC;CAChB;AAED;;;;;;GAMG;AACH,oBAAY,uBAAuB;IACjC;;;OAGG;IACH,OAAO,YAAY;IAEnB;;;OAGG;IACH,SAAS,cAAc;IAEvB;;;OAGG;IACH,SAAS,cAAc;IAEvB;;OAEG;IACH,MAAM,WAAW;CAClB;AAqBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,qBAAa,MAAO,SAAQ,SAAS;IAEnC;;OAEG;IACH,OAAc,UAAU,SAAS;IAEjC;;;;;;;;;;;;;;;;;;;;;OAqBG;WACiB,MAAM,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EAAE,EACzE,UAAkC,EAClC,OAAY,EACb,GAAE;QACD,UAAU,CAAC,EAAE,IAAI,CAAC;QAClB,OAAO,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,SAAS,CAAC;IAwF3B;;;;;;;;;;OAUG;WACiB,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE;QAC9D,WAAW,EAAE,WAAW,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAmBlC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;WACiB,MAAM,CAAC,EAAE,WAAW,EAAE,UAAkC,EAAE,EAAE;QAC9E,UAAU,CAAC,EAAE,SAAS,GAAG,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;QACpG,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,SAAS,CAAC;IAYtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACiB,OAAO,CAAC,EAAE,GAAG,EAAE,UAAgC,EAAE,EAAE;QACrE,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAgElC;;;;;;;;;;;;;;;;;;;;;OAqBG;WACiB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CA+D9G;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;;;;;;;;;;OAWG;WACW,eAAe,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;QAC/C,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,GAAG,MAAM;IAQV;;;;;;;;;;OAUG;WACiB,qBAAqB,CAAC,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,mBAAmB,EAAE,EAAE;QACnG,WAAW,EAAE,GAAG,CAAC;QACjB,SAAS,EAAE,GAAG,CAAC;QACf,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvB,mBAAmB,EAAE,wBAAwB,EAAE,CAAC;KACjD,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBnB;;;;;;;;;;;OAWG;WACiB,sBAAsB,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,EAAE;QAClF,WAAW,EAAE,gBAAgB,CAAC;QAC9B,WAAW,EAAE,GAAG,CAAC;QACjB,SAAS,EAAE,GAAG,CAAA;KACf,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAWhC;;;;;;;;;;;;;OAaG;WACiB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAE,EAAE;QACvE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACvB,mBAAmB,EAAE,wBAAwB,EAAE,CAAA;KAChD,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAyC7B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;CAkB5B"}