chore(release): 🚀 api docs v5.4.0

uport-project · Aug 1, 2023 · 0e3953b · 0e3953b
1 parent 7cf73a4
commit 0e3953b
Show file tree

Hide file tree

Showing 14 changed files with 199 additions and 53 deletions.
diff --git a/docs/api/credential-eip712.credentialissuereip712.md b/docs/api/credential-eip712.credentialissuereip712.md
diff --git a/docs/api/credential-eip712.credentialissuereip712.schema.md b/docs/api/credential-eip712.credentialissuereip712.schema.md
@@ -47,7 +47,7 @@ readonly schema: {
                             };
                         };
                         "@context": {
-                            $ref: string; /** {@inheritdoc ICredentialIssuerEIP712.createVerifiableCredentialEIP712} */
+                            $ref: string;
                         };
                         issuanceDate: {
                             $ref: string;

diff --git a/docs/api/did-comm.didcomm.md b/docs/api/did-comm.didcomm.md
diff --git a/docs/api/did-comm.didcomm.schema.md b/docs/api/did-comm.didcomm.schema.md
@@ -170,6 +170,16 @@ readonly schema: {
                             };
                             description: string;
                         };
+                        enc: {
+                            type: string;
+                            enum: string[];
+                            description: string;
+                        };
+                        alg: {
+                            type: string;
+                            enum: string[];
+                            description: string;
+                        };
                     };
                     description: string;
                 };

diff --git a/docs/api/did-comm.ididcommoptions.alg.md b/docs/api/did-comm.ididcommoptions.alg.md
@@ -0,0 +1,19 @@
+---
+id: did-comm.ididcommoptions.alg
+title: IDIDCommOptions.alg property
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## IDIDCommOptions.alg property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Optional key wrapping algorithm to use. Defaults to 'ECDH-ES+A256KW'
+
+**Signature:**
+
+```typescript
+alg?: 'ECDH-ES+A256KW' | 'ECDH-1PU+A256KW' | 'ECDH-ES+XC20PKW' | 'ECDH-1PU+XC20PKW';
+```
diff --git a/docs/api/did-comm.ididcommoptions.enc.md b/docs/api/did-comm.ididcommoptions.enc.md
@@ -0,0 +1,19 @@
+---
+id: did-comm.ididcommoptions.enc
+title: IDIDCommOptions.enc property
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## IDIDCommOptions.enc property
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Optional content encryption algorithm to use. Defaults to 'A256GCM'
+
+**Signature:**
+
+```typescript
+enc?: 'XC20P' | 'A256GCM' | 'A256CBC-HS512';
+```
diff --git a/docs/api/did-comm.ididcommoptions.md b/docs/api/did-comm.ididcommoptions.md
@@ -22,7 +22,9 @@ export interface IDIDCommOptions
 
 ## Properties
 
-| Property                                                      | Modifiers | Type       | Description                                                            |
-| ------------------------------------------------------------- | --------- | ---------- | ---------------------------------------------------------------------- |
-| [bcc?](./did-comm.ididcommoptions.bcc.md)                     |           | string\[\] | **_(BETA)_** _(Optional)_ Add extra recipients for the packed message. |
-| [recipientKids?](./did-comm.ididcommoptions.recipientkids.md) |           | string\[\] | **_(BETA)_** _(Optional)_ Restrict to a set of kids for recipient      |
+| Property                                                      | Modifiers | Type                                                                                         | Description                                                                                    |
+| ------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| [alg?](./did-comm.ididcommoptions.alg.md)                     |           | 'ECDH-ES+A256KW' &#124; 'ECDH-1PU+A256KW' &#124; 'ECDH-ES+XC20PKW' &#124; 'ECDH-1PU+XC20PKW' | **_(BETA)_** _(Optional)_ Optional key wrapping algorithm to use. Defaults to 'ECDH-ES+A256KW' |
+| [bcc?](./did-comm.ididcommoptions.bcc.md)                     |           | string\[\]                                                                                   | **_(BETA)_** _(Optional)_ Add extra recipients for the packed message.                         |
+| [enc?](./did-comm.ididcommoptions.enc.md)                     |           | 'XC20P' &#124; 'A256GCM' &#124; 'A256CBC-HS512'                                              | **_(BETA)_** _(Optional)_ Optional content encryption algorithm to use. Defaults to 'A256GCM'  |
+| [recipientKids?](./did-comm.ididcommoptions.recipientkids.md) |           | string\[\]                                                                                   | **_(BETA)_** _(Optional)_ Restrict to a set of kids for recipient                              |
diff --git a/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md b/docs/api/did-provider-jwk.jwkdidsupportedkeytypes.md
@@ -11,5 +11,7 @@ hide_title: true
 **Signature:**
 
 ```typescript
-export type JwkDidSupportedKeyTypes = 'Secp256r1' | 'Secp256k1' | 'Ed25519' | 'X25519'
+export type JwkDidSupportedKeyTypes = keyof typeof SupportedKeyTypes
 ```
+
+**References:** [SupportedKeyTypes](./did-provider-jwk.supportedkeytypes.md)
diff --git a/docs/api/utils.converted25519privatekeytox25519.md b/docs/api/utils.converted25519privatekeytox25519.md
@@ -0,0 +1,29 @@
+---
+id: utils.converted25519privatekeytox25519
+title: convertEd25519PrivateKeyToX25519() function
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## convertEd25519PrivateKeyToX25519() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Converts Ed25519 private keys to X25519
+
+**Signature:**
+
+```typescript
+export declare function convertEd25519PrivateKeyToX25519(privateKey: Uint8Array): Uint8Array
+```
+
+## Parameters
+
+| Parameter  | Type       | Description                                                                                             |
+| ---------- | ---------- | ------------------------------------------------------------------------------------------------------- |
+| privateKey | Uint8Array | <p>The bytes of an Ed25519P private key</p><p>This API may change without a BREAKING CHANGE notice.</p> |
+
+**Returns:**
+
+Uint8Array
diff --git a/docs/api/utils.converted25519publickeytox25519.md b/docs/api/utils.converted25519publickeytox25519.md
@@ -0,0 +1,29 @@
+---
+id: utils.converted25519publickeytox25519
+title: convertEd25519PublicKeyToX25519() function
+hide_title: true
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## convertEd25519PublicKeyToX25519() function
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Converts Ed25519 public keys to X25519
+
+**Signature:**
+
+```typescript
+export declare function convertEd25519PublicKeyToX25519(publicKey: Uint8Array): Uint8Array
+```
+
+## Parameters
+
+| Parameter | Type       | Description                                                                                            |
+| --------- | ---------- | ------------------------------------------------------------------------------------------------------ |
+| publicKey | Uint8Array | <p>The bytes of an Ed25519P public key</p><p>This API may change without a BREAKING CHANGE notice.</p> |
+
+**Returns:**
+
+Uint8Array
diff --git a/docs/api/utils.extractissuer.md b/docs/api/utils.extractissuer.md
@@ -22,14 +22,18 @@ export declare function extractIssuer(
     | CredentialPayload
     | PresentationPayload
     | null,
+  options?: {
+    removeParameters?: boolean
+  },
 ): string
 ```
 
 ## Parameters
 
-| Parameter | Type                                                                                                                                                                                                                                                                                         | Description                                                                                                                                               |
-| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| input     | [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) &#124; [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) &#124; [CredentialPayload](./core-types.credentialpayload.md) &#124; [PresentationPayload](./core-types.presentationpayload.md) &#124; null | <p>_(Optional)_ the credential or presentation whose issuer/holder needs to be extracted.</p><p>This API may change without a BREAKING CHANGE notice.</p> |
+| Parameter | Type                                                                                                                                                                                                                                                                                         | Description                                                                                                                                     |
+| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| input     | [W3CVerifiableCredential](./core-types.w3cverifiablecredential.md) &#124; [W3CVerifiablePresentation](./core-types.w3cverifiablepresentation.md) &#124; [CredentialPayload](./core-types.credentialpayload.md) &#124; [PresentationPayload](./core-types.presentationpayload.md) &#124; null | _(Optional)_ the credential or presentation whose issuer/holder needs to be extracted.                                                          |
+| options   | { removeParameters?: boolean; }                                                                                                                                                                                                                                                              | <p>_(Optional)_ removeParameters - Remove all DID parameters from the issuer ID</p><p>This API may change without a BREAKING CHANGE notice.</p> |
 
 **Returns:**