@twin.org/attestation-models 0.0.1-next.3 → 0.0.1-next.30

package/docs/reference/interfaces/IAttestationInformation.md

@@ -1,12 +1,24 @@
-# Interface: IAttestationInformation\<T\>
+# Interface: IAttestationInformation
 
 Interface describing the collated attestation information.
 
-## Type Parameters
+## Properties
 
-• **T** = `unknown`
+### @context
 
-## Properties
+> **@context**: \[`"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"Information"`
+
+JSON-LD Type.
+
+***
 
 ### id
 
@@ -16,27 +28,27 @@ The unique identifier of the attestation.
 
 ***
 
-### created
+### dateCreated
 
-> **created**: `string`
+> **dateCreated**: `string`
 
 Created date/time of the attestation in ISO format.
 
 ***
 
-### ownerIdentity
+### dateTransferred?
 
-> **ownerIdentity**: `string`
+> `optional` **dateTransferred**: `string`
 
-The identity of the owner.
+Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
 
 ***
 
-### transferred?
+### ownerIdentity
 
-> `optional` **transferred**: `string`
+> **ownerIdentity**: `string`
 
-Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
+The identity of the owner.
 
 ***
 
@@ -48,16 +60,32 @@ The identity of the current holder, can be undefined if owner is still the holde
 
 ***
 
-### data
+### attestationObject
 
-> **data**: `T`
+> **attestationObject**: `IJsonLdNodeObject`
 
 The data that was attested.
 
 ***
 
-### proof
+### proof?
 
-> **proof**: [`IAttestationProof`](IAttestationProof.md)
+> `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/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+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

@@ -14,7 +14,7 @@ The parameters to be used in the transfer.
 
 > **id**: `string`
 
-The attestation id to verify.
+The attestation id to transfer.
 
 ***
 
@@ -29,3 +29,9 @@ The parameters to be used in the transfer.
 > **holderIdentity**: `string`
 
 The new holder identity.
+
+#### holderAddress
+
+> **holderAddress**: `string`
+
+The new holder address.

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

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

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/AttestationContexts.md

@@ -0,0 +1,19 @@
+# Variable: AttestationContexts
+
+> `const` **AttestationContexts**: `object`
+
+The contexts 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.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/AttestationTypes.md

@@ -0,0 +1,19 @@
+# Variable: AttestationTypes
+
+> `const` **AttestationTypes**: `object`
+
+The types of attestation data.
+
+## Type declaration
+
+### Information
+
+> `readonly` **Information**: `"Information"` = `"Information"`
+
+Represents attestation information.
+
+### JwtProof
+
+> `readonly` **JwtProof**: `"JwtProof"` = `"JwtProof"`
+
+Represents attestation JWT proof.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/attestation-models",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.30",
 	"description": "Models which define the structure of the attestation connectors and services",
 	"repository": {
 		"type": "git",
@@ -13,48 +13,26 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"scripts": {
-		"clean": "rimraf dist coverage docs/reference",
-		"build": "tspc",
-		"test": "vitest --run --config ./vitest.config.ts --no-cache",
-		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
-		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
-		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
-		"bundle": "npm run bundle:esm && npm run bundle:cjs",
-		"docs:clean": "rimraf docs/reference",
-		"docs:generate": "typedoc",
-		"docs": "npm run docs:clean && npm run docs:generate",
-		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
-	},
 	"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"
-	},
-	"devDependencies": {
-		"@twin.org/nameof-transformer": "next",
-		"@vitest/coverage-v8": "2.1.1",
-		"copyfiles": "2.4.1",
-		"rimraf": "6.0.1",
-		"rollup": "4.22.0",
-		"rollup-plugin-typescript2": "0.36.0",
-		"ts-patch": "3.2.1",
-		"typedoc": "0.26.7",
-		"typedoc-plugin-markdown": "4.2.7",
-		"typescript": "5.6.2",
-		"vitest": "2.1.1"
+		"@twin.org/standards-schema-org": "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": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",

package/dist/types/models/IAttestationProof.d.ts

@@ -1,13 +0,0 @@
-/**
- * Interface describing an attestation proof.
- */
-export interface IAttestationProof {
-    /**
-     * The type of the proof.
-     */
-    type: string;
-    /**
-     * The value of the proof.
-     */
-    value: string;
-}

package/dist/types/models/api/IAttestationAttestResponse.d.ts

@@ -1,12 +0,0 @@
-import type { IAttestationInformation } from "../IAttestationInformation";
-/**
- * The response when creating the attestation for some data.
- */
-export interface IAttestationAttestResponse {
-    /**
-     * The result of the attestation process.
-     */
-    body: {
-        information: IAttestationInformation;
-    };
-}

package/dist/types/models/api/IAttestationTransferResponse.d.ts

@@ -1,15 +0,0 @@
-import type { IAttestationInformation } from "../IAttestationInformation";
-/**
- * The response to transferring the attestation.
- */
-export interface IAttestationTransferResponse {
-    /**
-     * The data returned from the transfer response.
-     */
-    body: {
-        /**
-         * The updated attestation information.
-         */
-        information: IAttestationInformation;
-    };
-}

package/dist/types/models/api/IAttestationVerifyRequest.d.ts

@@ -1,14 +0,0 @@
-/**
- * Verify that the proof is valid for the attestation.
- */
-export interface IAttestationVerifyRequest {
-    /**
-     * The parameters to be used in the verification.
-     */
-    pathParams: {
-        /**
-         * The attestation id to verify.
-         */
-        id: string;
-    };
-}

package/dist/types/models/api/IAttestationVerifyResponse.d.ts

@@ -1,23 +0,0 @@
-import type { IAttestationInformation } from "../IAttestationInformation";
-/**
- * The response to verifying the attestation.
- */
-export interface IAttestationVerifyResponse {
-    /**
-     * The data returned from the verification response.
-     */
-    body: {
-        /**
-         * Whether the attestation is verified.
-         */
-        verified: boolean;
-        /**
-         * The failure message if the attestation is not verified.
-         */
-        failure?: string;
-        /**
-         * The attestation information.
-         */
-        information?: Partial<IAttestationInformation>;
-    };
-}

package/docs/reference/interfaces/IAttestationAttestResponse.md

@@ -1,15 +0,0 @@
-# Interface: IAttestationAttestResponse
-
-The response when creating the attestation for some data.
-
-## Properties
-
-### body
-
-> **body**: `object`
-
-The result of the attestation process.
-
-#### information
-
-> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>

package/docs/reference/interfaces/IAttestationProof.md

@@ -1,19 +0,0 @@
-# Interface: IAttestationProof
-
-Interface describing an attestation proof.
-
-## Properties
-
-### type
-
-> **type**: `string`
-
-The type of the proof.
-
-***
-
-### value
-
-> **value**: `string`
-
-The value of the proof.

package/docs/reference/interfaces/IAttestationTransferResponse.md

@@ -1,17 +0,0 @@
-# Interface: IAttestationTransferResponse
-
-The response to transferring the attestation.
-
-## Properties
-
-### body
-
-> **body**: `object`
-
-The data returned from the transfer response.
-
-#### information
-
-> **information**: [`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>
-
-The updated attestation information.

package/docs/reference/interfaces/IAttestationVerifyRequest.md

@@ -1,17 +0,0 @@
-# Interface: IAttestationVerifyRequest
-
-Verify that the proof is valid for the attestation.
-
-## Properties
-
-### pathParams
-
-> **pathParams**: `object`
-
-The parameters to be used in the verification.
-
-#### id
-
-> **id**: `string`
-
-The attestation id to verify.

package/docs/reference/interfaces/IAttestationVerifyResponse.md

@@ -1,29 +0,0 @@
-# Interface: IAttestationVerifyResponse
-
-The response to verifying the attestation.
-
-## Properties
-
-### body
-
-> **body**: `object`
-
-The data returned from the verification response.
-
-#### verified
-
-> **verified**: `boolean`
-
-Whether the attestation is verified.
-
-#### failure?
-
-> `optional` **failure**: `string`
-
-The failure message if the attestation is not verified.
-
-#### information?
-
-> `optional` **information**: `Partial`\<[`IAttestationInformation`](IAttestationInformation.md)\<`unknown`\>\>
-
-The attestation information.