@twin.org/attestation-models 0.0.1-next.10

package/docs/reference/interfaces/IAttestationInformation.md

@@ -0,0 +1,91 @@
+# Interface: IAttestationInformation
+
+Interface describing the collated attestation information.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"Information"`
+
+JSON-LD Type.
+
+***
+
+### id
+
+> **id**: `string`
+
+The unique identifier of the attestation.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+Created date/time of the attestation in ISO format.
+
+***
+
+### dateTransferred?
+
+> `optional` **dateTransferred**: `string`
+
+Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+
+***
+
+### ownerIdentity
+
+> **ownerIdentity**: `string`
+
+The identity of the owner.
+
+***
+
+### holderIdentity?
+
+> `optional` **holderIdentity**: `string`
+
+The identity of the current holder, can be undefined if owner is still the holder.
+
+***
+
+### attestationObject
+
+> **attestationObject**: `IJsonLdNodeObject`
+
+The data that was attested.
+
+***
+
+### proof?
+
+> `optional` **proof**: `IJsonLdNodeObject`
+
+The proof for the attested data.
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+Whether the attestation has been verified.
+
+***
+
+### verificationFailure?
+
+> `optional` **verificationFailure**: `string`
+
+The verification failure message.

package/docs/reference/interfaces/IAttestationJwtProof.md

@@ -0,0 +1,27 @@
+# Interface: IAttestationJwtProof
+
+Interface describing an attestation proof.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/attestation/"` \| [`"https://schema.twindev.org/attestation/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"JwtProof"`
+
+The type of the proof.
+
+***
+
+### value
+
+> **value**: `string`
+
+The value of the proof.

package/docs/reference/interfaces/IAttestationTransferRequest.md

@@ -0,0 +1,31 @@
+# Interface: IAttestationTransferRequest
+
+Transfer the attestation to a new holder.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The parameters to be used in the transfer.
+
+#### id
+
+> **id**: `string`
+
+The attestation id to verify.
+
+***
+
+### body
+
+> **body**: `object`
+
+The parameters to be used in the transfer.
+
+#### holderIdentity
+
+> **holderIdentity**: `string`
+
+The new holder identity.

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

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

package/docs/reference/variables/AttestationConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: AttestationConnectorFactory
+
+> `const` **AttestationConnectorFactory**: `Factory`\<[`IAttestationConnector`](../interfaces/IAttestationConnector.md)\>
+
+Factory for creating attestation connectors.

package/docs/reference/variables/AttestationTypes.md

@@ -0,0 +1,25 @@
+# Variable: AttestationTypes
+
+> `const` **AttestationTypes**: `object`
+
+The types of attestation data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
+
+The context root for the attestation types.
+
+### Information
+
+> `readonly` **Information**: `"Information"` = `"Information"`
+
+Represents attestation information.
+
+### JwtProof
+
+> `readonly` **JwtProof**: `"JwtProof"` = `"JwtProof"`
+
+Represents attestation JWT proof.

package/locales/en.json

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

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/attestation-models",
+	"version": "0.0.1-next.10",
+	"description": "Models which define the structure of the attestation connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/attestation.git",
+		"directory": "packages/attestation-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}