chore(release): 🚀 api docs v5.2.0

uport-project · Jul 26, 2023 · e05078c · e05078c
1 parent cb2206d
commit e05078c
Show file tree

Hide file tree

Showing 1,218 changed files with 3,565 additions and 3,085 deletions.
diff --git a/docs/api/core-types.authorizeddidcontext.authorizeddid.md b/docs/api/core-types.authorizeddidcontext.authorizeddid.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 authorizedDID?: string;

diff --git a/docs/api/core-types.authorizeddidcontext.md b/docs/api/core-types.authorizeddidcontext.md
@@ -16,16 +16,16 @@ This does not constitute an authorization mechanism, but relies on an authorizat
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface AuthorizedDIDContext extends IAgentContext<{}>
 ```
 
-<b>Extends:</b> [IAgentContext](./core-types.iagentcontext.md)&lt;{}&gt;
+**Extends:** [IAgentContext](./core-types.iagentcontext.md)&lt;{}&gt;
 
 ## Properties
 
-| Property                                                             | Modifiers | Type   | Description                            |
-| -------------------------------------------------------------------- | --------- | ------ | -------------------------------------- |
-| [authorizedDID?](./core-types.authorizeddidcontext.authorizeddid.md) |           | string | <b><i>(BETA)</i></b> <i>(Optional)</i> |
+| Property                                                             | Modifiers | Type   | Description               |
+| -------------------------------------------------------------------- | --------- | ------ | ------------------------- |
+| [authorizedDID?](./core-types.authorizeddidcontext.authorizeddid.md) |           | string | **_(BETA)_** _(Optional)_ |
diff --git a/docs/api/core-types.compactjwt.md b/docs/api/core-types.compactjwt.md
@@ -14,7 +14,7 @@ Represents a Json Web Token in compact form. "header.payload.signature"
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type CompactJWT = string

diff --git a/docs/api/core-types.contexttype.md b/docs/api/core-types.contexttype.md
@@ -14,7 +14,7 @@ The data type for `@context` properties of credentials, presentations, etc.
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type ContextType = string | Record<string, any> | (string | Record<string, any>)[]

diff --git a/docs/api/core-types.coreevents.md b/docs/api/core-types.coreevents.md
@@ -10,7 +10,7 @@ hide_title: true
 
 This collection defines the core event types.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 CoreEvents: {

diff --git a/docs/api/core-types.credentialpayload.__context_.md b/docs/api/core-types.credentialpayload.__context_.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 '@context'?: ContextType;

diff --git a/docs/api/core-types.credentialpayload.credentialstatus.md b/docs/api/core-types.credentialpayload.credentialstatus.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 credentialStatus?: CredentialStatusReference;

diff --git a/docs/api/core-types.credentialpayload.credentialsubject.md b/docs/api/core-types.credentialpayload.credentialsubject.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 credentialSubject?: CredentialSubject;

diff --git a/docs/api/core-types.credentialpayload.expirationdate.md b/docs/api/core-types.credentialpayload.expirationdate.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 expirationDate?: DateType;

diff --git a/docs/api/core-types.credentialpayload.id.md b/docs/api/core-types.credentialpayload.id.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 id?: string;

diff --git a/docs/api/core-types.credentialpayload.issuancedate.md b/docs/api/core-types.credentialpayload.issuancedate.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 issuanceDate?: DateType;

diff --git a/docs/api/core-types.credentialpayload.issuer.md b/docs/api/core-types.credentialpayload.issuer.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 issuer: IssuerType

diff --git a/docs/api/core-types.credentialpayload.md b/docs/api/core-types.credentialpayload.md
@@ -14,21 +14,21 @@ Used as input when creating Verifiable Credentials
 
 This API may change without prior notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface CredentialPayload
 ```
 
 ## Properties
 
-| Property                                                                  | Modifiers | Type                                                                   | Description                            |
-| ------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------- | -------------------------------------- |
-| ["@context"?](./core-types.credentialpayload.__context_.md)               |           | [ContextType](./core-types.contexttype.md)                             | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [credentialStatus?](./core-types.credentialpayload.credentialstatus.md)   |           | [CredentialStatusReference](./core-types.credentialstatusreference.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [credentialSubject?](./core-types.credentialpayload.credentialsubject.md) |           | [CredentialSubject](./core-types.credentialsubject.md)                 | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [expirationDate?](./core-types.credentialpayload.expirationdate.md)       |           | [DateType](./core-types.datetype.md)                                   | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [id?](./core-types.credentialpayload.id.md)                               |           | string                                                                 | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [issuanceDate?](./core-types.credentialpayload.issuancedate.md)           |           | [DateType](./core-types.datetype.md)                                   | <b><i>(BETA)</i></b> <i>(Optional)</i> |
-| [issuer](./core-types.credentialpayload.issuer.md)                        |           | [IssuerType](./core-types.issuertype.md)                               | <b><i>(BETA)</i></b>                   |
-| [type?](./core-types.credentialpayload.type.md)                           |           | string\[\]                                                             | <b><i>(BETA)</i></b> <i>(Optional)</i> |
+| Property                                                                  | Modifiers | Type                                                                   | Description               |
+| ------------------------------------------------------------------------- | --------- | ---------------------------------------------------------------------- | ------------------------- |
+| ["@context"?](./core-types.credentialpayload.__context_.md)               |           | [ContextType](./core-types.contexttype.md)                             | **_(BETA)_** _(Optional)_ |
+| [credentialStatus?](./core-types.credentialpayload.credentialstatus.md)   |           | [CredentialStatusReference](./core-types.credentialstatusreference.md) | **_(BETA)_** _(Optional)_ |
+| [credentialSubject?](./core-types.credentialpayload.credentialsubject.md) |           | [CredentialSubject](./core-types.credentialsubject.md)                 | **_(BETA)_** _(Optional)_ |
+| [expirationDate?](./core-types.credentialpayload.expirationdate.md)       |           | [DateType](./core-types.datetype.md)                                   | **_(BETA)_** _(Optional)_ |
+| [id?](./core-types.credentialpayload.id.md)                               |           | string                                                                 | **_(BETA)_** _(Optional)_ |
+| [issuanceDate?](./core-types.credentialpayload.issuancedate.md)           |           | [DateType](./core-types.datetype.md)                                   | **_(BETA)_** _(Optional)_ |
+| [issuer](./core-types.credentialpayload.issuer.md)                        |           | [IssuerType](./core-types.issuertype.md)                               | **_(BETA)_**              |
+| [type?](./core-types.credentialpayload.type.md)                           |           | string\[\]                                                             | **_(BETA)_** _(Optional)_ |
diff --git a/docs/api/core-types.credentialpayload.type.md b/docs/api/core-types.credentialpayload.type.md
@@ -10,7 +10,7 @@ hide_title: true
 
 > 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.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 type?: string[];

diff --git a/docs/api/core-types.credentialstatus.md b/docs/api/core-types.credentialstatus.md
@@ -14,7 +14,7 @@ Represents the result of a status check.
 
 Implementations MUST populate the `revoked` boolean property, but they can return additional metadata that is method specific.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type CredentialStatus = {

diff --git a/docs/api/core-types.credentialstatusgenerateargs.md b/docs/api/core-types.credentialstatusgenerateargs.md
@@ -12,14 +12,14 @@ hide_title: true
 
 Arguments for generating a `credentialStatus` property for a [VerifiableCredential](./core-types.verifiablecredential.md).
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface CredentialStatusGenerateArgs
 ```
 
 ## Properties
 
-| Property                                                  | Modifiers | Type   | Description                                                                                                                                |
-| --------------------------------------------------------- | --------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [type](./core-types.credentialstatusgenerateargs.type.md) |           | string | <b><i>(BETA)</i></b> The credential status type (aka credential status method) to be used in the <code>credentialStatus</code> generation. |
+| Property                                                  | Modifiers | Type   | Description                                                                                                                        |
+| --------------------------------------------------------- | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
+| [type](./core-types.credentialstatusgenerateargs.type.md) |           | string | **_(BETA)_** The credential status type (aka credential status method) to be used in the <code>credentialStatus</code> generation. |
diff --git a/docs/api/core-types.credentialstatusgenerateargs.type.md b/docs/api/core-types.credentialstatusgenerateargs.type.md
@@ -12,7 +12,7 @@ hide_title: true
 
 The credential status type (aka credential status method) to be used in the `credentialStatus` generation.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 type: string

diff --git a/docs/api/core-types.credentialstatusreference.md b/docs/api/core-types.credentialstatusreference.md
@@ -16,7 +16,7 @@ See [Credential Status](https://www.w3.org/TR/vc-data-model/#status)
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type CredentialStatusReference = {

diff --git a/docs/api/core-types.credentialstatusupdateargs.md b/docs/api/core-types.credentialstatusupdateargs.md
@@ -12,15 +12,15 @@ hide_title: true
 
 Input arguments for [credentialStatusUpdate](./core-types.icredentialstatusmanager.credentialstatusupdate.md)
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface CredentialStatusUpdateArgs
 ```
 
 ## Properties
 
-| Property                                                       | Modifiers | Type                                                         | Description                                                                                                            |
-| -------------------------------------------------------------- | --------- | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| [options?](./core-types.credentialstatusupdateargs.options.md) |           | CredentialStatusUpdateOptions                                | <b><i>(BETA)</i></b> <i>(Optional)</i> Options that will be forwarded to the credentialStatus method specific manager. |
-| [vc](./core-types.credentialstatusupdateargs.vc.md)            |           | [VerifiableCredential](./core-types.verifiablecredential.md) | <b><i>(BETA)</i></b> The verifiable credential whose status will be updated.                                           |
+| Property                                                       | Modifiers | Type                                                         | Description                                                                                               |
+| -------------------------------------------------------------- | --------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
+| [options?](./core-types.credentialstatusupdateargs.options.md) |           | CredentialStatusUpdateOptions                                | **_(BETA)_** _(Optional)_ Options that will be forwarded to the credentialStatus method specific manager. |
+| [vc](./core-types.credentialstatusupdateargs.vc.md)            |           | [VerifiableCredential](./core-types.verifiablecredential.md) | **_(BETA)_** The verifiable credential whose status will be updated.                                      |
diff --git a/docs/api/core-types.credentialstatusupdateargs.options.md b/docs/api/core-types.credentialstatusupdateargs.options.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Options that will be forwarded to the credentialStatus method specific manager.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 options?: CredentialStatusUpdateOptions;

diff --git a/docs/api/core-types.credentialstatusupdateargs.vc.md b/docs/api/core-types.credentialstatusupdateargs.vc.md
@@ -12,7 +12,7 @@ hide_title: true
 
 The verifiable credential whose status will be updated.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 vc: VerifiableCredential

diff --git a/docs/api/core-types.credentialsubject.md b/docs/api/core-types.credentialsubject.md
@@ -16,7 +16,7 @@ See [Credential Subject](https://www.w3.org/TR/vc-data-model/#credential-subject
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type CredentialSubject = {

diff --git a/docs/api/core-types.datetype.md b/docs/api/core-types.datetype.md
@@ -14,7 +14,7 @@ Represents an issuance or expiration date for Credentials / Presentations. This
 
 This API may change without prior notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type DateType = string | Date

diff --git a/docs/api/core-types.diddoccomponent.md b/docs/api/core-types.diddoccomponent.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Return type of [getDIDComponentById](./core-types.iresolver.getdidcomponentbyid.md) represents a `VerificationMethod` or a `ServiceEndpoint` entry from a This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type DIDDocComponent = VerificationMethod | ServiceEndpoint

diff --git a/docs/api/core-types.diddocumentsection.md b/docs/api/core-types.diddocumentsection.md
@@ -12,7 +12,7 @@ Refers to a section of a DID document. Either the list of verification methods o
 
 See [verification relationships](https://www.w3.org/TR/did-core/#verification-relationships)
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type DIDDocumentSection =

diff --git a/docs/api/core-types.findargs.md b/docs/api/core-types.findargs.md
@@ -14,17 +14,17 @@ Represents an [IDataStoreORM](./core-types.idatastoreorm.md) Query.
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export interface FindArgs<TColumns>
 ```
 
 ## Properties
 
-| Property                                 | Modifiers | Type                                               | Description                                                                                                                                  |
-| ---------------------------------------- | --------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
-| [order?](./core-types.findargs.order.md) |           | [Order](./core-types.order.md)&lt;TColumns&gt;\[\] | <b><i>(BETA)</i></b> <i>(Optional)</i> Sorts the results according to the given array of column priorities.                                  |
-| [skip?](./core-types.findargs.skip.md)   |           | number                                             | <b><i>(BETA)</i></b> <i>(Optional)</i> Ignores the first number of entries in a [IDataStoreORM](./core-types.idatastoreorm.md) query result. |
-| [take?](./core-types.findargs.take.md)   |           | number                                             | <b><i>(BETA)</i></b> <i>(Optional)</i> Returns at most this number of results from a [IDataStoreORM](./core-types.idatastoreorm.md) query.   |
-| [where?](./core-types.findargs.where.md) |           | [Where](./core-types.where.md)&lt;TColumns&gt;\[\] | <b><i>(BETA)</i></b> <i>(Optional)</i> Imposes constraints on the values of the given columns. WHERE clauses are combined using AND.         |
+| Property                                 | Modifiers | Type                                               | Description                                                                                                                     |
+| ---------------------------------------- | --------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| [order?](./core-types.findargs.order.md) |           | [Order](./core-types.order.md)&lt;TColumns&gt;\[\] | **_(BETA)_** _(Optional)_ Sorts the results according to the given array of column priorities.                                  |
+| [skip?](./core-types.findargs.skip.md)   |           | number                                             | **_(BETA)_** _(Optional)_ Ignores the first number of entries in a [IDataStoreORM](./core-types.idatastoreorm.md) query result. |
+| [take?](./core-types.findargs.take.md)   |           | number                                             | **_(BETA)_** _(Optional)_ Returns at most this number of results from a [IDataStoreORM](./core-types.idatastoreorm.md) query.   |
+| [where?](./core-types.findargs.where.md) |           | [Where](./core-types.where.md)&lt;TColumns&gt;\[\] | **_(BETA)_** _(Optional)_ Imposes constraints on the values of the given columns. WHERE clauses are combined using AND.         |
diff --git a/docs/api/core-types.findargs.order.md b/docs/api/core-types.findargs.order.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Sorts the results according to the given array of column priorities.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 order?: Order<TColumns>[];

diff --git a/docs/api/core-types.findargs.skip.md b/docs/api/core-types.findargs.skip.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Ignores the first number of entries in a [IDataStoreORM](./core-types.idatastoreorm.md) query result.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 skip?: number;

diff --git a/docs/api/core-types.findargs.take.md b/docs/api/core-types.findargs.take.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Returns at most this number of results from a [IDataStoreORM](./core-types.idatastoreorm.md) query.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 take?: number;

diff --git a/docs/api/core-types.findargs.where.md b/docs/api/core-types.findargs.where.md
@@ -12,7 +12,7 @@ hide_title: true
 
 Imposes constraints on the values of the given columns. WHERE clauses are combined using AND.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 where?: Where<TColumns>[];

diff --git a/docs/api/core-types.findclaimsargs.md b/docs/api/core-types.findclaimsargs.md
@@ -14,10 +14,10 @@ The filter that can be used to find [VerifiableCredential](./core-types.verifiab
 
 See [IDataStoreORM.dataStoreORMGetVerifiableCredentialsByClaims()](./core-types.idatastoreorm.datastoreormgetverifiablecredentialsbyclaims.md) This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type FindClaimsArgs = FindArgs<TClaimsColumns>
 ```
 
-<b>References:</b> [FindArgs](./core-types.findargs.md), [TClaimsColumns](./core-types.tclaimscolumns.md)
+**References:** [FindArgs](./core-types.findargs.md), [TClaimsColumns](./core-types.tclaimscolumns.md)
diff --git a/docs/api/core-types.findcredentialsargs.md b/docs/api/core-types.findcredentialsargs.md
@@ -14,10 +14,10 @@ The filter that can be used to find [VerifiableCredential](./core-types.verifiab
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type FindCredentialsArgs = FindArgs<TCredentialColumns>
 ```
 
-<b>References:</b> [FindArgs](./core-types.findargs.md), [TCredentialColumns](./core-types.tcredentialcolumns.md)
+**References:** [FindArgs](./core-types.findargs.md), [TCredentialColumns](./core-types.tcredentialcolumns.md)
diff --git a/docs/api/core-types.findidentifiersargs.md b/docs/api/core-types.findidentifiersargs.md
@@ -14,10 +14,10 @@ The filter that can be used to find [IIdentifier](./core-types.iidentifier.md)s
 
 This API may change without a BREAKING CHANGE notice.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export type FindIdentifiersArgs = FindArgs<TIdentifiersColumns>
 ```
 
-<b>References:</b> [FindArgs](./core-types.findargs.md), [TIdentifiersColumns](./core-types.tidentifierscolumns.md)
+**References:** [FindArgs](./core-types.findargs.md), [TIdentifiersColumns](./core-types.tidentifierscolumns.md)