@twin.org/attestation-models 0.0.3-next.3 → 0.0.3-next.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/es/models/IAttestationInformation.js.map +1 -1
  2. package/dist/es/models/IAttestationJwtProof.js.map +1 -1
  3. package/dist/es/schemas/AttestationInformation.json +9 -13
  4. package/dist/es/schemas/AttestationJwtProof.json +1 -1
  5. package/dist/types/models/IAttestationInformation.d.ts +8 -2
  6. package/dist/types/models/IAttestationJwtProof.d.ts +1 -0
  7. package/docs/changelog.md +15 -0
  8. package/docs/reference/interfaces/IAttestationInformation.md +9 -1
  9. package/docs/reference/interfaces/IAttestationJwtProof.md +1 -0
  10. package/package.json +1 -2
package/dist/es/models/IAttestationInformation.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IAttestationInformation.js","sourceRoot":"","sources":["../../../src/models/IAttestationInformation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts } from \"@twin.org/standards-schema-org\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing the collated attestation information.\n */\nexport interface IAttestationInformation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof AttestationContexts.Context,\n\t\ttypeof AttestationContexts.ContextCommon,\n\t\ttypeof SchemaOrgContexts.Context,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AttestationTypes.Information;\n\n\t/**\n\t * The unique identifier of the attestation.\n\t */\n\tid: string;\n\n\t/**\n\t * Created date/time of the attestation in ISO format.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.\n\t */\n\tdateTransferred?: string;\n\n\t/**\n\t * The identity of the owner.\n\t */\n\townerIdentity: string;\n\n\t/**\n\t * The identity of the current holder, can be undefined if owner is still the holder.\n\t */\n\tholderIdentity?: string;\n\n\t/**\n\t * The data that was attested.\n\t */\n\tattestationObject: IJsonLdNodeObject;\n\n\t/**\n\t * The proof for the attested data.\n\t */\n\tproof?: IJsonLdNodeObject;\n\n\t/**\n\t * Whether the attestation has been verified.\n\t */\n\tverified?: boolean;\n\n\t/**\n\t * The verification failure message.\n\t */\n\tverificationFailure?: string;\n}\n"]}
1
+ {"version":3,"file":"IAttestationInformation.js","sourceRoot":"","sources":["../../../src/models/IAttestationInformation.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing the collated attestation information.\n */\nexport interface IAttestationInformation {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof AttestationContexts.Context,\n\t\ttypeof AttestationContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AttestationTypes.Information;\n\n\t/**\n\t * The unique identifier of the attestation.\n\t */\n\tid: string;\n\n\t/**\n\t * Created date/time of the attestation in ISO format.\n\t * json-ld namespace:schema\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.\n\t * json-ld type:schema:Date\n\t */\n\tdateTransferred?: string;\n\n\t/**\n\t * The identity of the owner.\n\t * json-ld type:schema:identifier\n\t */\n\townerIdentity: string;\n\n\t/**\n\t * The identity of the current holder, can be undefined if owner is still the holder.\n\t * json-ld type:schema:identifier\n\t */\n\tholderIdentity?: string;\n\n\t/**\n\t * The data that was attested.\n\t * json-ld namespace:twin-common\n\t */\n\tattestationObject: IJsonLdNodeObject;\n\n\t/**\n\t * The proof for the attested data.\n\t * json-ld namespace:twin-attestation\n\t */\n\tproof?: IJsonLdNodeObject;\n\n\t/**\n\t * Whether the attestation has been verified.\n\t * json-ld namespace:twin-common\n\t */\n\tverified?: boolean;\n\n\t/**\n\t * The verification failure message.\n\t * json-ld type:schema:Text\n\t */\n\tverificationFailure?: string;\n}\n"]}
package/dist/es/models/IAttestationJwtProof.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IAttestationJwtProof.js","sourceRoot":"","sources":["../../../src/models/IAttestationJwtProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing an attestation proof.\n */\nexport interface IAttestationJwtProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\":\n\t\t| typeof AttestationContexts.Context\n\t\t| [typeof AttestationContexts.Context, ...IJsonLdContextDefinitionElement[]];\n\n\t/**\n\t * The type of the proof.\n\t */\n\ttype: typeof AttestationTypes.JwtProof;\n\n\t/**\n\t * The value of the proof.\n\t */\n\tvalue: string;\n}\n"]}
1
+ {"version":3,"file":"IAttestationJwtProof.js","sourceRoot":"","sources":["../../../src/models/IAttestationJwtProof.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { AttestationContexts } from \"./attestationContexts.js\";\nimport type { AttestationTypes } from \"./attestationTypes.js\";\n\n/**\n * Interface describing an attestation proof.\n */\nexport interface IAttestationJwtProof {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\":\n\t\t| typeof AttestationContexts.Context\n\t\t| [typeof AttestationContexts.Context, ...IJsonLdContextDefinitionElement[]];\n\n\t/**\n\t * The type of the proof.\n\t */\n\ttype: typeof AttestationTypes.JwtProof;\n\n\t/**\n\t * The value of the proof.\n\t * json-ld type:schema:Text\n\t */\n\tvalue: string;\n}\n"]}
package/dist/es/schemas/AttestationInformation.json CHANGED
@@ -6,7 +6,7 @@
6
6
  "properties": {
7
7
  "@context": {
8
8
  "type": "array",
9
- "minItems": 3,
9
+ "minItems": 2,
10
10
  "description": "JSON-LD Context.",
11
11
  "prefixItems": [
12
12
  {
@@ -16,10 +16,6 @@
16
16
  {
17
17
  "type": "string",
18
18
  "const": "https://schema.twindev.org/common/"
19
- },
20
- {
21
- "type": "string",
22
- "const": "https://schema.org"
23
19
  }
24
20
  ],
25
21
  "items": {
@@ -37,35 +33,35 @@
37
33
  },
38
34
  "dateCreated": {
39
35
  "type": "string",
40
- "description": "Created date/time of the attestation in ISO format."
36
+ "description": "Created date/time of the attestation in ISO format. json-ld namespace:schema"
41
37
  },
42
38
  "dateTransferred": {
43
39
  "type": "string",
44
- "description": "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner."
40
+ "description": "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner. json-ld type:schema:Date"
45
41
  },
46
42
  "ownerIdentity": {
47
43
  "type": "string",
48
- "description": "The identity of the owner."
44
+ "description": "The identity of the owner. json-ld type:schema:identifier"
49
45
  },
50
46
  "holderIdentity": {
51
47
  "type": "string",
52
- "description": "The identity of the current holder, can be undefined if owner is still the holder."
48
+ "description": "The identity of the current holder, can be undefined if owner is still the holder. json-ld type:schema:identifier"
53
49
  },
54
50
  "attestationObject": {
55
51
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
56
- "description": "The data that was attested."
52
+ "description": "The data that was attested. json-ld namespace:twin-common"
57
53
  },
58
54
  "proof": {
59
55
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
60
- "description": "The proof for the attested data."
56
+ "description": "The proof for the attested data. json-ld namespace:twin-attestation"
61
57
  },
62
58
  "verified": {
63
59
  "type": "boolean",
64
- "description": "Whether the attestation has been verified."
60
+ "description": "Whether the attestation has been verified. json-ld namespace:twin-common"
65
61
  },
66
62
  "verificationFailure": {
67
63
  "type": "string",
68
- "description": "The verification failure message."
64
+ "description": "The verification failure message. json-ld type:schema:Text"
69
65
  }
70
66
  },
71
67
  "required": [
package/dist/es/schemas/AttestationJwtProof.json CHANGED
@@ -33,7 +33,7 @@
33
33
  },
34
34
  "value": {
35
35
  "type": "string",
36
- "description": "The value of the proof."
36
+ "description": "The value of the proof. json-ld type:schema:Text"
37
37
  }
38
38
  },
39
39
  "required": [
package/dist/types/models/IAttestationInformation.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
- import type { SchemaOrgContexts } from "@twin.org/standards-schema-org";
3
2
  import type { AttestationContexts } from "./attestationContexts.js";
4
3
  import type { AttestationTypes } from "./attestationTypes.js";
5
4
  /**
@@ -12,7 +11,6 @@ export interface IAttestationInformation {
12
11
  "@context": [
13
12
  typeof AttestationContexts.Context,
14
13
  typeof AttestationContexts.ContextCommon,
15
- typeof SchemaOrgContexts.Context,
16
14
  ...IJsonLdContextDefinitionElement[]
17
15
  ];
18
16
  /**
@@ -25,34 +23,42 @@ export interface IAttestationInformation {
25
23
  id: string;
26
24
  /**
27
25
  * Created date/time of the attestation in ISO format.
26
+ * json-ld namespace:schema
28
27
  */
29
28
  dateCreated: string;
30
29
  /**
31
30
  * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
31
+ * json-ld type:schema:Date
32
32
  */
33
33
  dateTransferred?: string;
34
34
  /**
35
35
  * The identity of the owner.
36
+ * json-ld type:schema:identifier
36
37
  */
37
38
  ownerIdentity: string;
38
39
  /**
39
40
  * The identity of the current holder, can be undefined if owner is still the holder.
41
+ * json-ld type:schema:identifier
40
42
  */
41
43
  holderIdentity?: string;
42
44
  /**
43
45
  * The data that was attested.
46
+ * json-ld namespace:twin-common
44
47
  */
45
48
  attestationObject: IJsonLdNodeObject;
46
49
  /**
47
50
  * The proof for the attested data.
51
+ * json-ld namespace:twin-attestation
48
52
  */
49
53
  proof?: IJsonLdNodeObject;
50
54
  /**
51
55
  * Whether the attestation has been verified.
56
+ * json-ld namespace:twin-common
52
57
  */
53
58
  verified?: boolean;
54
59
  /**
55
60
  * The verification failure message.
61
+ * json-ld type:schema:Text
56
62
  */
57
63
  verificationFailure?: string;
58
64
  }
package/dist/types/models/IAttestationJwtProof.d.ts CHANGED
@@ -15,6 +15,7 @@ export interface IAttestationJwtProof {
15
15
  type: typeof AttestationTypes.JwtProof;
16
16
  /**
17
17
  * The value of the proof.
18
+ * json-ld type:schema:Text
18
19
  */
19
20
  value: string;
20
21
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,20 @@
1
1
  # @twin.org/attestation-models - Changelog
2
2
 
3
+ ## [0.0.3-next.5](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.4...attestation-models-v0.0.3-next.5) (2026-02-11)
4
+
5
+
6
+ ### Miscellaneous Chores
7
+
8
+ * **attestation-models:** Synchronize repo versions
9
+
10
+ ## [0.0.3-next.4](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.3...attestation-models-v0.0.3-next.4) (2026-02-11)
11
+
12
+
13
+ ### Features
14
+
15
+ * add ts-to-jsonld-context tool ([df7edd0](https://github.com/twinfoundation/attestation/commit/df7edd0d32cabc2b0f9f6dc7b216f569f739324d))
16
+ * remove unused schemas causing conflict ([#27](https://github.com/twinfoundation/attestation/issues/27)) ([9723bc3](https://github.com/twinfoundation/attestation/commit/9723bc3757f87ce8a943f5f091a92d258f867892))
17
+
3
18
  ## [0.0.3-next.3](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.2...attestation-models-v0.0.3-next.3) (2026-01-21)
4
19
 
5
20
 
package/docs/reference/interfaces/IAttestationInformation.md CHANGED
@@ -6,7 +6,7 @@ Interface describing the collated attestation information.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: \[`"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`, `...IJsonLdContextDefinitionElement[]`\]
9
+ > **@context**: \[`"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -33,6 +33,7 @@ The unique identifier of the attestation.
33
33
  > **dateCreated**: `string`
34
34
 
35
35
  Created date/time of the attestation in ISO format.
36
+ json-ld namespace:schema
36
37
 
37
38
  ***
38
39
 
@@ -41,6 +42,7 @@ Created date/time of the attestation in ISO format.
41
42
  > `optional` **dateTransferred**: `string`
42
43
 
43
44
  Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
45
+ json-ld type:schema:Date
44
46
 
45
47
  ***
46
48
 
@@ -49,6 +51,7 @@ Transferred date/time of the attestation in ISO format, can be blank if holder i
49
51
  > **ownerIdentity**: `string`
50
52
 
51
53
  The identity of the owner.
54
+ json-ld type:schema:identifier
52
55
 
53
56
  ***
54
57
 
@@ -57,6 +60,7 @@ The identity of the owner.
57
60
  > `optional` **holderIdentity**: `string`
58
61
 
59
62
  The identity of the current holder, can be undefined if owner is still the holder.
63
+ json-ld type:schema:identifier
60
64
 
61
65
  ***
62
66
 
@@ -65,6 +69,7 @@ The identity of the current holder, can be undefined if owner is still the holde
65
69
  > **attestationObject**: `IJsonLdNodeObject`
66
70
 
67
71
  The data that was attested.
72
+ json-ld namespace:twin-common
68
73
 
69
74
  ***
70
75
 
@@ -73,6 +78,7 @@ The data that was attested.
73
78
  > `optional` **proof**: `IJsonLdNodeObject`
74
79
 
75
80
  The proof for the attested data.
81
+ json-ld namespace:twin-attestation
76
82
 
77
83
  ***
78
84
 
@@ -81,6 +87,7 @@ The proof for the attested data.
81
87
  > `optional` **verified**: `boolean`
82
88
 
83
89
  Whether the attestation has been verified.
90
+ json-ld namespace:twin-common
84
91
 
85
92
  ***
86
93
 
@@ -89,3 +96,4 @@ Whether the attestation has been verified.
89
96
  > `optional` **verificationFailure**: `string`
90
97
 
91
98
  The verification failure message.
99
+ json-ld type:schema:Text
package/docs/reference/interfaces/IAttestationJwtProof.md CHANGED
@@ -25,3 +25,4 @@ The type of the proof.
25
25
  > **value**: `string`
26
26
 
27
27
  The value of the proof.
28
+ json-ld type:schema:Text
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/attestation-models",
3
- "version": "0.0.3-next.3",
3
+ "version": "0.0.3-next.5",
4
4
  "description": "Models which define the structure of the attestation connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -19,7 +19,6 @@
19
19
  "@twin.org/data-json-ld": "next",
20
20
  "@twin.org/entity": "next",
21
21
  "@twin.org/nameof": "next",
22
- "@twin.org/standards-schema-org": "next",
23
22
  "@twin.org/standards-w3c-did": "next",
24
23
  "@twin.org/web": "next"
25
24
  },