@3sixty/immutable-proof-models 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IImmutableProofComponent.md

@@ -0,0 +1,143 @@
+# Interface: IImmutableProofComponent
+
+Interface describing an immutable proof contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`document`, `options?`): `Promise`\<`string`\>
+
+Create a new proof.
+
+#### Parameters
+
+##### document
+
+`IJsonLdNodeObject`
+
+The document to create the proof for.
+
+##### options?
+
+Optional settings for the proof.
+
+###### deleteLock?
+
+`string`
+
+An ISO 8601 date-time string specifying when the notarization lock expires; if omitted no lock is applied.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new proof.
+
+***
+
+### get() {#get}
+
+> **get**(`id`): `Promise`\<[`IImmutableProofCredential`](IImmutableProofCredential.md)\>
+
+Get a proof.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the proof to get.
+
+#### Returns
+
+`Promise`\<[`IImmutableProofCredential`](IImmutableProofCredential.md)\>
+
+The proof.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+***
+
+### verify() {#verify}
+
+> **verify**(`id`): `Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
+
+Verify a proof.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the proof to verify.
+
+#### Returns
+
+`Promise`\<[`IImmutableProofVerification`](IImmutableProofVerification.md)\>
+
+The result of the verification and any failures.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+***
+
+### remove() {#remove}
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove the proof and its notarization.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the proof to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the proof and its notarization have been removed.
+
+#### Throws
+
+NotFoundError if the proof is not found.
+
+***
+
+### removeNotarization() {#removenotarization}
+
+> **removeNotarization**(`id`): `Promise`\<`void`\>
+
+Remove only the notarization for the proof, keeping the proof entity.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the proof to remove the notarization from.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the notarization has been removed.
+
+#### Throws
+
+NotFoundError if the proof is not found.

package/docs/reference/interfaces/IImmutableProofCreateRequest.md

@@ -0,0 +1,30 @@
+# Interface: IImmutableProofCreateRequest
+
+Create a proof.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The parameters from the body.
+
+#### document
+
+> **document**: `IJsonLdNodeObject`
+
+The document to create the proof for.
+
+#### options?
+
+> `optional` **options?**: `object`
+
+Optional settings for the proof.
+
+##### options.deleteLock?
+
+> `optional` **deleteLock?**: `string`
+
+An ISO 8601 date-time string specifying when the notarization lock expires.
+If omitted, no deletion lock is applied.

package/docs/reference/interfaces/IImmutableProofCredential.md

@@ -0,0 +1,15 @@
+# Interface: IImmutableProofCredential
+
+Interface describing an immutable proof credential.
+
+## Extends
+
+- `Omit`\<`IDidVerifiableCredential`, `"proof"`\>
+
+## Properties
+
+### proof? {#proof}
+
+> `optional` **proof?**: IProof & IImmutableProofDataIntegrity
+
+The proof of the verifiable credential, which includes the data integrity information.

package/docs/reference/interfaces/IImmutableProofDataIntegrity.md

@@ -0,0 +1,11 @@
+# Interface: IImmutableProofDataIntegrity
+
+Interface describing additional data integrity fields attached.
+
+## Properties
+
+### notarizationId? {#notarizationid}
+
+> `optional` **notarizationId?**: `string`
+
+The notarization id.

package/docs/reference/interfaces/IImmutableProofEventBusProofCreated.md

@@ -0,0 +1,11 @@
+# Interface: IImmutableProofEventBusProofCreated
+
+Event bus payload for proof created.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the proof created.

package/docs/reference/interfaces/IImmutableProofGetRequest.md

@@ -0,0 +1,29 @@
+# Interface: IImmutableProofGetRequest
+
+Get a proof.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to get.

package/docs/reference/interfaces/IImmutableProofGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IImmutableProofGetResponse
+
+Response to getting an immutable proof.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IImmutableProofCredential`](IImmutableProofCredential.md)
+
+The response body.

package/docs/reference/interfaces/IImmutableProofRemoveNotarizationRequest.md

@@ -0,0 +1,17 @@
+# Interface: IImmutableProofRemoveNotarizationRequest
+
+Remove the notarization for a proof.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to remove the notarization from.

package/docs/reference/interfaces/IImmutableProofRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IImmutableProofRemoveRequest
+
+Remove a proof.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to remove.

package/docs/reference/interfaces/IImmutableProofVerification.md

@@ -0,0 +1,35 @@
+# Interface: IImmutableProofVerification
+
+Interface describing an immutable proof verification.
+
+## Properties
+
+### @context {#context}
+
+> **@context**: `"https://schema.3sixty.global/immutable-proof/"`
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: `"ImmutableProofVerification"`
+
+JSON-LD Type.
+
+***
+
+### verified {#verified}
+
+> **verified**: `boolean`
+
+Was the verification successful.
+
+***
+
+### failure? {#failure}
+
+> `optional` **failure?**: [`ImmutableProofFailure`](../type-aliases/ImmutableProofFailure.md)
+
+If the verification was unsuccessful the failure reason.

package/docs/reference/interfaces/IImmutableProofVerifyRequest.md

@@ -0,0 +1,29 @@
+# Interface: IImmutableProofVerifyRequest
+
+Verify a proof.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the immutable proof to verify.

package/docs/reference/interfaces/IImmutableProofVerifyResponse.md

@@ -0,0 +1,23 @@
+# Interface: IImmutableProofVerifyResponse
+
+Response to verifying an immutable proof.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IImmutableProofVerification`](IImmutableProofVerification.md)
+
+The response body.

package/docs/reference/type-aliases/ImmutableProofContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofContexts
+
+> **ImmutableProofContexts** = *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\[keyof *typeof* [`ImmutableProofContexts`](../variables/ImmutableProofContexts.md)\]
+
+The contexts of immutable proof data.

package/docs/reference/type-aliases/ImmutableProofFailure.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofFailure
+
+> **ImmutableProofFailure** = *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\[keyof *typeof* [`ImmutableProofFailure`](../variables/ImmutableProofFailure.md)\]
+
+The failure reason of the proof.

package/docs/reference/type-aliases/ImmutableProofMetricIds.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofMetricIds
+
+> **ImmutableProofMetricIds** = *typeof* [`ImmutableProofMetricIds`](../variables/ImmutableProofMetricIds.md)\[keyof *typeof* [`ImmutableProofMetricIds`](../variables/ImmutableProofMetricIds.md)\]
+
+Union type of all immutable proof service metric ID string values.

package/docs/reference/type-aliases/ImmutableProofTopics.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofTopics
+
+> **ImmutableProofTopics** = *typeof* [`ImmutableProofTopics`](../variables/ImmutableProofTopics.md)\[keyof *typeof* [`ImmutableProofTopics`](../variables/ImmutableProofTopics.md)\]
+
+The topics for immutable proof event bus notifications.

package/docs/reference/type-aliases/ImmutableProofTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: ImmutableProofTypes
+
+> **ImmutableProofTypes** = *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\[keyof *typeof* [`ImmutableProofTypes`](../variables/ImmutableProofTypes.md)\]
+
+The types of immutable proof data.

package/docs/reference/variables/CompiledImmutableProof.md

@@ -0,0 +1,5 @@
+# Variable: CompiledImmutableProof
+
+> `const` **CompiledImmutableProof**: `ICompiledValidator` = `validate52`
+
+Compiled validator for the ImmutableProof schema.

package/docs/reference/variables/CompiledImmutableProofCredential.md

@@ -0,0 +1,5 @@
+# Variable: CompiledImmutableProofCredential
+
+> `const` **CompiledImmutableProofCredential**: `ICompiledValidator` = `validate53`
+
+Compiled validator for the ImmutableProofCredential schema.

package/docs/reference/variables/CompiledImmutableProofDataIntegrity.md

@@ -0,0 +1,5 @@
+# Variable: CompiledImmutableProofDataIntegrity
+
+> `const` **CompiledImmutableProofDataIntegrity**: `ICompiledValidator` = `validate54`
+
+Compiled validator for the ImmutableProofDataIntegrity schema.

package/docs/reference/variables/CompiledImmutableProofFailure.md

@@ -0,0 +1,5 @@
+# Variable: CompiledImmutableProofFailure
+
+> `const` **CompiledImmutableProofFailure**: `ICompiledValidator` = `validate57`
+
+Compiled validator for the ImmutableProofFailure schema.

package/docs/reference/variables/CompiledImmutableProofVerification.md

@@ -0,0 +1,5 @@
+# Variable: CompiledImmutableProofVerification
+
+> `const` **CompiledImmutableProofVerification**: `ICompiledValidator` = `validate56`
+
+Compiled validator for the ImmutableProofVerification schema.

package/docs/reference/variables/ImmutableProofContexts.md

@@ -0,0 +1,43 @@
+# Variable: ImmutableProofContexts
+
+> `const` **ImmutableProofContexts**: `object`
+
+The contexts of immutable proof data.
+
+## Type Declaration
+
+### Namespace {#namespace}
+
+> `readonly` **Namespace**: `"https://schema.3sixty.global/immutable-proof/"` = `"https://schema.3sixty.global/immutable-proof/"`
+
+The canonical RDF namespace URI for Immutable Proof.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://schema.3sixty.global/immutable-proof/"` = `"https://schema.3sixty.global/immutable-proof/"`
+
+The value to use in context for Immutable Proof.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.3sixty.global/immutable-proof/types.jsonld"` = `"https://schema.3sixty.global/immutable-proof/types.jsonld"`
+
+The JSON-LD Context URL for Immutable Proof.
+
+### NamespaceCommon {#namespacecommon}
+
+> `readonly` **NamespaceCommon**: `"https://schema.3sixty.global/common/"` = `"https://schema.3sixty.global/common/"`
+
+The canonical RDF namespace URI for TWIN Common.
+
+### ContextCommon {#contextcommon}
+
+> `readonly` **ContextCommon**: `"https://schema.3sixty.global/common/"` = `"https://schema.3sixty.global/common/"`
+
+The value to use in JSON-LD context for TWIN Common.
+
+### JsonLdContextCommon {#jsonldcontextcommon}
+
+> `readonly` **JsonLdContextCommon**: `"https://schema.3sixty.global/common/types.jsonld"` = `"https://schema.3sixty.global/common/types.jsonld"`
+
+The JSON-LD Context URL for TWIN Common.

package/docs/reference/variables/ImmutableProofFailure.md

@@ -0,0 +1,31 @@
+# Variable: ImmutableProofFailure
+
+> `const` **ImmutableProofFailure**: `object`
+
+The failure reason of the proof.
+
+## Type Declaration
+
+### NotIssued {#notissued}
+
+> `readonly` **NotIssued**: `"notIssued"` = `"notIssued"`
+
+Proof not yet issued.
+
+### ProofMissing {#proofmissing}
+
+> `readonly` **ProofMissing**: `"proofMissing"` = `"proofMissing"`
+
+Proof missing.
+
+### VerificationFailure {#verificationfailure}
+
+> `readonly` **VerificationFailure**: `"verificationFailure"` = `"verificationFailure"`
+
+Verification failure.
+
+### Revoked {#revoked}
+
+> `readonly` **Revoked**: `"revoked"` = `"revoked"`
+
+Revoked.

package/docs/reference/variables/ImmutableProofMetricIds.md

@@ -0,0 +1,43 @@
+# Variable: ImmutableProofMetricIds
+
+> `const` **ImmutableProofMetricIds**: `object`
+
+Metric IDs for the immutable proof service.
+
+## Type Declaration
+
+### ProofsCreated {#proofscreated}
+
+> `readonly` **ProofsCreated**: `"ip_proofs_created"` = `"ip_proofs_created"`
+
+Number of proofs created.
+
+### VerificationsSucceeded {#verificationssucceeded}
+
+> `readonly` **VerificationsSucceeded**: `"ip_verifications_succeeded"` = `"ip_verifications_succeeded"`
+
+Number of proof verifications succeeded.
+
+### VerificationsFailed {#verificationsfailed}
+
+> `readonly` **VerificationsFailed**: `"ip_verifications_failed"` = `"ip_verifications_failed"`
+
+Number of proof verifications failed.
+
+### ProofsRemoved {#proofsremoved}
+
+> `readonly` **ProofsRemoved**: `"ip_proofs_removed"` = `"ip_proofs_removed"`
+
+Number of proofs removed.
+
+### NotarizationsRemoved {#notarizationsremoved}
+
+> `readonly` **NotarizationsRemoved**: `"ip_notarizations_removed"` = `"ip_notarizations_removed"`
+
+Number of notarizations removed.
+
+### ProofCompletionLag {#proofcompletionlag}
+
+> `readonly` **ProofCompletionLag**: `"ip_proof_completion_lag"` = `"ip_proof_completion_lag"`
+
+Time in milliseconds from a proof being requested to its notarization completing.

package/docs/reference/variables/ImmutableProofMetrics.md

@@ -0,0 +1,5 @@
+# Variable: ImmutableProofMetrics
+
+> `const` **ImmutableProofMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the immutable proof service.

package/docs/reference/variables/ImmutableProofTopics.md

@@ -0,0 +1,13 @@
+# Variable: ImmutableProofTopics
+
+> `const` **ImmutableProofTopics**: `object`
+
+The topics for immutable proof event bus notifications.
+
+## Type Declaration
+
+### ProofCreated {#proofcreated}
+
+> `readonly` **ProofCreated**: `"immutable-proof:proof-created"` = `"immutable-proof:proof-created"`
+
+A proof was created.

package/docs/reference/variables/ImmutableProofTypes.md

@@ -0,0 +1,25 @@
+# Variable: ImmutableProofTypes
+
+> `const` **ImmutableProofTypes**: `object`
+
+The types of immutable proof data.
+
+## Type Declaration
+
+### ImmutableProof {#immutableproof}
+
+> `readonly` **ImmutableProof**: `"ImmutableProof"` = `"ImmutableProof"`
+
+Represents Immutable Proof.
+
+### ImmutableProofVerification {#immutableproofverification}
+
+> `readonly` **ImmutableProofVerification**: `"ImmutableProofVerification"` = `"ImmutableProofVerification"`
+
+Represents Immutable Proof Verification.
+
+### ImmutableProofFailure {#immutableprooffailure}
+
+> `readonly` **ImmutableProofFailure**: `"ImmutableProofFailure"` = `"ImmutableProofFailure"`
+
+Represents Immutable Proof Failure.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}