@twin.org/attestation-models 0.0.3-next.7 → 0.0.3-next.9

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 (23) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/attestationDataTypes.js.map +1 -1
  3. package/dist/es/models/IAttestationInformation.js.map +1 -1
  4. package/dist/es/models/IAttestationJwtProof.js.map +1 -1
  5. package/dist/es/schemas/AttestationInformation.json +12 -15
  6. package/dist/es/schemas/AttestationJwtProof.json +4 -6
  7. package/dist/types/models/IAttestationInformation.d.ts +8 -8
  8. package/dist/types/models/IAttestationJwtProof.d.ts +1 -1
  9. package/docs/changelog.md +63 -49
  10. package/docs/examples.md +12 -1
  11. package/docs/reference/classes/AttestationDataTypes.md +1 -1
  12. package/docs/reference/interfaces/IAttestationComponent.md +4 -4
  13. package/docs/reference/interfaces/IAttestationConnector.md +4 -4
  14. package/docs/reference/interfaces/IAttestationCreateRequest.md +2 -2
  15. package/docs/reference/interfaces/IAttestationDestroyRequest.md +1 -1
  16. package/docs/reference/interfaces/IAttestationGetRequest.md +3 -3
  17. package/docs/reference/interfaces/IAttestationGetResponse.md +3 -3
  18. package/docs/reference/interfaces/IAttestationInformation.md +16 -24
  19. package/docs/reference/interfaces/IAttestationJwtProof.md +3 -4
  20. package/docs/reference/interfaces/IAttestationTransferRequest.md +2 -2
  21. package/docs/reference/variables/AttestationContexts.md +6 -6
  22. package/docs/reference/variables/AttestationTypes.md +2 -2
  23. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # TWIN Attestation Models
2
2
 
3
- Models which define the structure of the attestation contracts and connectors.
3
+ Shared models and data types for attestation connectors and services.
4
4
 
5
5
  ## Installation
6
6
 
package/dist/es/dataTypes/attestationDataTypes.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"attestationDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/attestationDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,4BAA4B,MAAM,wCAAwC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxG,OAAO,yBAAyB,MAAM,qCAAqC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAElG;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,WAAW,EAAE,EACjE,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,WAAW;YAClC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,4BAA2C;SACnE,CAAC,CACF,CAAC;QACF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,EAAE,EAC9D,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,yBAAwC;SAChE,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { AttestationContexts } from \"../models/attestationContexts.js\";\nimport { AttestationTypes } from \"../models/attestationTypes.js\";\nimport AttestationInformationSchema from \"../schemas/AttestationInformation.json\" with { type: \"json\" };\nimport AttestationJwtProofSchema from \"../schemas/AttestationJwtProof.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for attestation.\n */\nexport class AttestationDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.Information}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.Information,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationInformationSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.JwtProof}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.JwtProof,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationJwtProofSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}
1
+ {"version":3,"file":"attestationDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/attestationDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,4BAA4B,MAAM,wCAAwC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AACxG,OAAO,yBAAyB,MAAM,qCAAqC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAElG;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,WAAW,EAAE,EACjE,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,WAAW;YAClC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,4BAA4B;SACpD,CAAC,CACF,CAAC;QACF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,SAAS,GAAG,gBAAgB,CAAC,QAAQ,EAAE,EAC9D,GAAG,EAAE,CAAC,CAAC;YACN,SAAS,EAAE,mBAAmB,CAAC,SAAS;YACxC,IAAI,EAAE,gBAAgB,CAAC,QAAQ;YAC/B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,yBAAyB;SACjD,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory } from \"@twin.org/data-core\";\nimport { AttestationContexts } from \"../models/attestationContexts.js\";\nimport { AttestationTypes } from \"../models/attestationTypes.js\";\nimport AttestationInformationSchema from \"../schemas/AttestationInformation.json\" with { type: \"json\" };\nimport AttestationJwtProofSchema from \"../schemas/AttestationJwtProof.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for attestation.\n */\nexport class AttestationDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.Information}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.Information,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationInformationSchema\n\t\t\t})\n\t\t);\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${AttestationContexts.Namespace}${AttestationTypes.JwtProof}`,\n\t\t\t() => ({\n\t\t\t\tnamespace: AttestationContexts.Namespace,\n\t\t\t\ttype: AttestationTypes.JwtProof,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => AttestationJwtProofSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}
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 SchemaOrgContexts.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"]}
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 SchemaOrgContexts.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 * json-ld type:schema:Text\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
@@ -1,33 +1,30 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.twindev.org/attestation/AttestationInformation",
4
+ "title": "AttestationInformation",
4
5
  "description": "Interface describing the collated attestation information.",
5
6
  "type": "object",
6
7
  "properties": {
7
8
  "@context": {
8
9
  "type": "array",
9
- "minItems": 3,
10
- "description": "JSON-LD Context.",
11
10
  "prefixItems": [
12
11
  {
13
- "type": "string",
14
12
  "const": "https://schema.org"
15
13
  },
16
14
  {
17
- "type": "string",
18
15
  "const": "https://schema.twindev.org/attestation/"
19
16
  },
20
17
  {
21
- "type": "string",
22
18
  "const": "https://schema.twindev.org/common/"
23
19
  }
24
20
  ],
25
21
  "items": {
26
22
  "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
27
- }
23
+ },
24
+ "minItems": 3,
25
+ "description": "JSON-LD Context."
28
26
  },
29
27
  "type": {
30
- "type": "string",
31
28
  "const": "Information",
32
29
  "description": "JSON-LD Type."
33
30
  },
@@ -37,35 +34,35 @@
37
34
  },
38
35
  "dateCreated": {
39
36
  "type": "string",
40
- "description": "Created date/time of the attestation in ISO format. json-ld namespace:schema"
37
+ "description": "Created date/time of the attestation in ISO format."
41
38
  },
42
39
  "dateTransferred": {
43
40
  "type": "string",
44
- "description": "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner. json-ld type:schema:Date"
41
+ "description": "Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner."
45
42
  },
46
43
  "ownerIdentity": {
47
44
  "type": "string",
48
- "description": "The identity of the owner. json-ld type:schema:identifier"
45
+ "description": "The identity of the owner."
49
46
  },
50
47
  "holderIdentity": {
51
48
  "type": "string",
52
- "description": "The identity of the current holder, can be undefined if owner is still the holder. json-ld type:schema:identifier"
49
+ "description": "The identity of the current holder, can be undefined if owner is still the holder."
53
50
  },
54
51
  "attestationObject": {
55
52
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
56
- "description": "The data that was attested. json-ld namespace:twin-common"
53
+ "description": "The data that was attested."
57
54
  },
58
55
  "proof": {
59
56
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
60
- "description": "The proof for the attested data. json-ld namespace:twin-attestation"
57
+ "description": "The proof for the attested data."
61
58
  },
62
59
  "verified": {
63
60
  "type": "boolean",
64
- "description": "Whether the attestation has been verified. json-ld namespace:twin-common"
61
+ "description": "Whether the attestation has been verified."
65
62
  },
66
63
  "verificationFailure": {
67
64
  "type": "string",
68
- "description": "The verification failure message. json-ld type:schema:Text"
65
+ "description": "The verification failure message."
69
66
  }
70
67
  },
71
68
  "required": [
package/dist/es/schemas/AttestationJwtProof.json CHANGED
@@ -1,39 +1,37 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.twindev.org/attestation/AttestationJwtProof",
4
+ "title": "AttestationJwtProof",
4
5
  "description": "Interface describing an attestation proof.",
5
6
  "type": "object",
6
7
  "properties": {
7
8
  "@context": {
8
9
  "anyOf": [
9
10
  {
10
- "type": "string",
11
11
  "const": "https://schema.twindev.org/attestation/"
12
12
  },
13
13
  {
14
14
  "type": "array",
15
- "minItems": 1,
16
15
  "prefixItems": [
17
16
  {
18
- "type": "string",
19
17
  "const": "https://schema.twindev.org/attestation/"
20
18
  }
21
19
  ],
22
20
  "items": {
23
21
  "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
24
- }
22
+ },
23
+ "minItems": 1
25
24
  }
26
25
  ],
27
26
  "description": "JSON-LD Context."
28
27
  },
29
28
  "type": {
30
- "type": "string",
31
29
  "const": "JwtProof",
32
30
  "description": "The type of the proof."
33
31
  },
34
32
  "value": {
35
33
  "type": "string",
36
- "description": "The value of the proof. json-ld type:schema:Text"
34
+ "description": "The value of the proof."
37
35
  }
38
36
  },
39
37
  "required": [
package/dist/types/models/IAttestationInformation.d.ts CHANGED
@@ -25,42 +25,42 @@ export interface IAttestationInformation {
25
25
  id: string;
26
26
  /**
27
27
  * Created date/time of the attestation in ISO format.
28
- * json-ld namespace:schema
28
+ * @json-ld namespace:schema
29
29
  */
30
30
  dateCreated: string;
31
31
  /**
32
32
  * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
33
- * json-ld type:schema:Date
33
+ * @json-ld type:schema:Date
34
34
  */
35
35
  dateTransferred?: string;
36
36
  /**
37
37
  * The identity of the owner.
38
- * json-ld type:schema:identifier
38
+ * @json-ld type:schema:identifier
39
39
  */
40
40
  ownerIdentity: string;
41
41
  /**
42
42
  * The identity of the current holder, can be undefined if owner is still the holder.
43
- * json-ld type:schema:identifier
43
+ * @json-ld type:schema:identifier
44
44
  */
45
45
  holderIdentity?: string;
46
46
  /**
47
47
  * The data that was attested.
48
- * json-ld namespace:twin-common
48
+ * @json-ld namespace:twin-common
49
49
  */
50
50
  attestationObject: IJsonLdNodeObject;
51
51
  /**
52
52
  * The proof for the attested data.
53
- * json-ld namespace:twin-attestation
53
+ * @json-ld namespace:twin-attestation
54
54
  */
55
55
  proof?: IJsonLdNodeObject;
56
56
  /**
57
57
  * Whether the attestation has been verified.
58
- * json-ld namespace:twin-common
58
+ * @json-ld namespace:twin-common
59
59
  */
60
60
  verified?: boolean;
61
61
  /**
62
62
  * The verification failure message.
63
- * json-ld type:schema:Text
63
+ * @json-ld type:schema:Text
64
64
  */
65
65
  verificationFailure?: string;
66
66
  }
package/dist/types/models/IAttestationJwtProof.d.ts CHANGED
@@ -15,7 +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
+ * @json-ld type:schema:Text
19
19
  */
20
20
  value: string;
21
21
  }
package/docs/changelog.md CHANGED
@@ -1,142 +1,156 @@
1
- # @twin.org/attestation-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.7](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.6...attestation-models-v0.0.3-next.7) (2026-02-25)
3
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.8...attestation-models-v0.0.3-next.9) (2026-05-12)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * update schemas ([c163f36](https://github.com/twinfoundation/attestation/commit/c163f3623d54a0e87a97cf5eab25327b9aeac0fe))
8
+ * typescript 6 update ([9484667](https://github.com/iotaledger/twin-attestation/commit/948466713dc980e4b2d89e72ebb927b3fe530280))
9
9
 
10
- ## [0.0.3-next.6](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.5...attestation-models-v0.0.3-next.6) (2026-02-11)
10
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.7...attestation-models-v0.0.3-next.8) (2026-04-27)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **attestation-models:** Synchronize repo versions
16
+
17
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.6...attestation-models-v0.0.3-next.7) (2026-02-25)
18
+
19
+
20
+ ### Features
21
+
22
+ * update schemas ([c163f36](https://github.com/iotaledger/twin-attestation/commit/c163f3623d54a0e87a97cf5eab25327b9aeac0fe))
23
+
24
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.5...attestation-models-v0.0.3-next.6) (2026-02-11)
11
25
 
12
26
 
13
27
  ### Bug Fixes
14
28
 
15
- * correct context ordering ([c7cded2](https://github.com/twinfoundation/attestation/commit/c7cded248662b8b78ff41b19749bc182ff5105c0))
29
+ * correct context ordering ([c7cded2](https://github.com/iotaledger/twin-attestation/commit/c7cded248662b8b78ff41b19749bc182ff5105c0))
16
30
 
17
- ## [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)
31
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.4...attestation-models-v0.0.3-next.5) (2026-02-11)
18
32
 
19
33
 
20
34
  ### Miscellaneous Chores
21
35
 
22
36
  * **attestation-models:** Synchronize repo versions
23
37
 
24
- ## [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)
38
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.3...attestation-models-v0.0.3-next.4) (2026-02-11)
25
39
 
26
40
 
27
41
  ### Features
28
42
 
29
- * add ts-to-jsonld-context tool ([df7edd0](https://github.com/twinfoundation/attestation/commit/df7edd0d32cabc2b0f9f6dc7b216f569f739324d))
30
- * remove unused schemas causing conflict ([#27](https://github.com/twinfoundation/attestation/issues/27)) ([9723bc3](https://github.com/twinfoundation/attestation/commit/9723bc3757f87ce8a943f5f091a92d258f867892))
43
+ * add ts-to-jsonld-context tool ([df7edd0](https://github.com/iotaledger/twin-attestation/commit/df7edd0d32cabc2b0f9f6dc7b216f569f739324d))
44
+ * remove unused schemas causing conflict ([#27](https://github.com/iotaledger/twin-attestation/issues/27)) ([9723bc3](https://github.com/iotaledger/twin-attestation/commit/9723bc3757f87ce8a943f5f091a92d258f867892))
31
45
 
32
- ## [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)
46
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.2...attestation-models-v0.0.3-next.3) (2026-01-21)
33
47
 
34
48
 
35
49
  ### Features
36
50
 
37
- * context updates ([#25](https://github.com/twinfoundation/attestation/issues/25)) ([1ea71b2](https://github.com/twinfoundation/attestation/commit/1ea71b28d874daef4d0bca594fb5dbf5f2a47571))
51
+ * context updates ([#25](https://github.com/iotaledger/twin-attestation/issues/25)) ([1ea71b2](https://github.com/iotaledger/twin-attestation/commit/1ea71b28d874daef4d0bca594fb5dbf5f2a47571))
38
52
 
39
- ## [0.0.3-next.2](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.1...attestation-models-v0.0.3-next.2) (2026-01-14)
53
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.1...attestation-models-v0.0.3-next.2) (2026-01-14)
40
54
 
41
55
 
42
56
  ### Features
43
57
 
44
- * update contexts and namespaces ([#23](https://github.com/twinfoundation/attestation/issues/23)) ([7e7ffb4](https://github.com/twinfoundation/attestation/commit/7e7ffb4056bfe296dd3cedcaa7a9bfb91fd830d7))
58
+ * update contexts and namespaces ([#23](https://github.com/iotaledger/twin-attestation/issues/23)) ([7e7ffb4](https://github.com/iotaledger/twin-attestation/commit/7e7ffb4056bfe296dd3cedcaa7a9bfb91fd830d7))
45
59
 
46
- ## [0.0.3-next.1](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.3-next.0...attestation-models-v0.0.3-next.1) (2025-11-12)
60
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.0...attestation-models-v0.0.3-next.1) (2025-11-12)
47
61
 
48
62
 
49
63
  ### Features
50
64
 
51
- * add context id features ([#21](https://github.com/twinfoundation/attestation/issues/21)) ([640deab](https://github.com/twinfoundation/attestation/commit/640deabfc00340e619283f94570c5e1ec45e83af))
52
- * add validate-locales ([a1f9e13](https://github.com/twinfoundation/attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
53
- * eslint migration to flat config ([7c768ff](https://github.com/twinfoundation/attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
54
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
55
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
56
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
57
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
58
- * update framework core ([02326d4](https://github.com/twinfoundation/attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
59
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
60
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
65
+ * add context id features ([#21](https://github.com/iotaledger/twin-attestation/issues/21)) ([640deab](https://github.com/iotaledger/twin-attestation/commit/640deabfc00340e619283f94570c5e1ec45e83af))
66
+ * add validate-locales ([a1f9e13](https://github.com/iotaledger/twin-attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
67
+ * eslint migration to flat config ([7c768ff](https://github.com/iotaledger/twin-attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
68
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
69
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
70
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
71
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
72
+ * update framework core ([02326d4](https://github.com/iotaledger/twin-attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
73
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
74
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
61
75
 
62
- ## [0.0.2-next.4](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.2-next.3...attestation-models-v0.0.2-next.4) (2025-10-09)
76
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.2-next.3...attestation-models-v0.0.2-next.4) (2025-10-09)
63
77
 
64
78
 
65
79
  ### Features
66
80
 
67
- * add validate-locales ([a1f9e13](https://github.com/twinfoundation/attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
81
+ * add validate-locales ([a1f9e13](https://github.com/iotaledger/twin-attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
68
82
 
69
- ## [0.0.2-next.3](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.2-next.2...attestation-models-v0.0.2-next.3) (2025-09-29)
83
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.2-next.2...attestation-models-v0.0.2-next.3) (2025-09-29)
70
84
 
71
85
 
72
86
  ### Miscellaneous Chores
73
87
 
74
88
  * **attestation-models:** Synchronize repo versions
75
89
 
76
- ## [0.0.2-next.2](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.2-next.1...attestation-models-v0.0.2-next.2) (2025-08-29)
90
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.2-next.1...attestation-models-v0.0.2-next.2) (2025-08-29)
77
91
 
78
92
 
79
93
  ### Features
80
94
 
81
- * eslint migration to flat config ([7c768ff](https://github.com/twinfoundation/attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
95
+ * eslint migration to flat config ([7c768ff](https://github.com/iotaledger/twin-attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
82
96
 
83
- ## [0.0.2-next.1](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.2-next.0...attestation-models-v0.0.2-next.1) (2025-08-20)
97
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.2-next.0...attestation-models-v0.0.2-next.1) (2025-08-20)
84
98
 
85
99
 
86
100
  ### Features
87
101
 
88
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
89
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
90
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
91
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
92
- * update framework core ([02326d4](https://github.com/twinfoundation/attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
93
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
94
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
102
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
103
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
104
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
105
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
106
+ * update framework core ([02326d4](https://github.com/iotaledger/twin-attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
107
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
108
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
95
109
 
96
110
  ## 0.0.1 (2025-07-09)
97
111
 
98
112
 
99
113
  ### Features
100
114
 
101
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
102
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
115
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
116
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
103
117
 
104
- ## [0.0.1-next.30](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.29...attestation-models-v0.0.1-next.30) (2025-06-12)
118
+ ## [0.0.1-next.30](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.29...attestation-models-v0.0.1-next.30) (2025-06-12)
105
119
 
106
120
 
107
121
  ### Features
108
122
 
109
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
123
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
110
124
 
111
- ## [0.0.1-next.29](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.28...attestation-models-v0.0.1-next.29) (2025-06-03)
125
+ ## [0.0.1-next.29](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.28...attestation-models-v0.0.1-next.29) (2025-06-03)
112
126
 
113
127
 
114
128
  ### Features
115
129
 
116
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
130
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
117
131
 
118
- ## [0.0.1-next.28](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.27...attestation-models-v0.0.1-next.28) (2025-05-28)
132
+ ## [0.0.1-next.28](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.27...attestation-models-v0.0.1-next.28) (2025-05-28)
119
133
 
120
134
 
121
135
  ### Features
122
136
 
123
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
137
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
124
138
 
125
- ## [0.0.1-next.27](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.26...attestation-models-v0.0.1-next.27) (2025-05-06)
139
+ ## [0.0.1-next.27](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.26...attestation-models-v0.0.1-next.27) (2025-05-06)
126
140
 
127
141
 
128
142
  ### Miscellaneous Chores
129
143
 
130
144
  * **attestation-models:** Synchronize repo versions
131
145
 
132
- ## [0.0.1-next.26](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.25...attestation-models-v0.0.1-next.26) (2025-04-17)
146
+ ## [0.0.1-next.26](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.25...attestation-models-v0.0.1-next.26) (2025-04-17)
133
147
 
134
148
 
135
149
  ### Features
136
150
 
137
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
151
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
138
152
 
139
- ## [0.0.1-next.25](https://github.com/twinfoundation/attestation/compare/attestation-models-v0.0.1-next.24...attestation-models-v0.0.1-next.25) (2025-03-28)
153
+ ## [0.0.1-next.25](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.1-next.24...attestation-models-v0.0.1-next.25) (2025-03-28)
140
154
 
141
155
 
142
156
  ### Miscellaneous Chores
package/docs/examples.md CHANGED
@@ -1 +1,12 @@
1
- # @twin.org/attestation-models - Examples
1
+ # Attestation Models Examples
2
+
3
+ Register the data types at startup so schemas and JSON-LD mappings are available before you parse or validate attestation payloads.
4
+
5
+ ## AttestationDataTypes
6
+
7
+ ```typescript
8
+ import { AttestationDataTypes } from '@twin.org/attestation-models';
9
+
10
+ AttestationDataTypes.registerTypes();
11
+ console.log('Attestation data types registered.'); // Attestation data types registered.
12
+ ```
package/docs/reference/classes/AttestationDataTypes.md CHANGED
@@ -14,7 +14,7 @@ Handle all the data types for attestation.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### registerTypes()
17
+ ### registerTypes() {#registertypes}
18
18
 
19
19
  > `static` **registerTypes**(): `void`
20
20
 
package/docs/reference/interfaces/IAttestationComponent.md CHANGED
@@ -8,7 +8,7 @@ Interface describing an attestation contract.
8
8
 
9
9
  ## Methods
10
10
 
11
- ### create()
11
+ ### create() {#create}
12
12
 
13
13
  > **create**(`attestationObject`, `namespace?`): `Promise`\<`string`\>
14
14
 
@@ -36,7 +36,7 @@ The id of the attestation.
36
36
 
37
37
  ***
38
38
 
39
- ### get()
39
+ ### get() {#get}
40
40
 
41
41
  > **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
42
42
 
@@ -58,7 +58,7 @@ The verified attestation details.
58
58
 
59
59
  ***
60
60
 
61
- ### transfer()
61
+ ### transfer() {#transfer}
62
62
 
63
63
  > **transfer**(`attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
64
64
 
@@ -92,7 +92,7 @@ Nothing.
92
92
 
93
93
  ***
94
94
 
95
- ### destroy()
95
+ ### destroy() {#destroy}
96
96
 
97
97
  > **destroy**(`attestationId`): `Promise`\<`void`\>
98
98
 
package/docs/reference/interfaces/IAttestationConnector.md CHANGED
@@ -8,7 +8,7 @@ Interface describing an attestation connector.
8
8
 
9
9
  ## Methods
10
10
 
11
- ### create()
11
+ ### create() {#create}
12
12
 
13
13
  > **create**(`controller`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
14
14
 
@@ -42,7 +42,7 @@ The collated attestation data.
42
42
 
43
43
  ***
44
44
 
45
- ### get()
45
+ ### get() {#get}
46
46
 
47
47
  > **get**(`id`): `Promise`\<[`IAttestationInformation`](IAttestationInformation.md)\>
48
48
 
@@ -64,7 +64,7 @@ The verified attestation details.
64
64
 
65
65
  ***
66
66
 
67
- ### transfer()
67
+ ### transfer() {#transfer}
68
68
 
69
69
  > **transfer**(`controller`, `attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
70
70
 
@@ -104,7 +104,7 @@ Nothing.
104
104
 
105
105
  ***
106
106
 
107
- ### destroy()
107
+ ### destroy() {#destroy}
108
108
 
109
109
  > **destroy**(`controller`, `attestationId`): `Promise`\<`void`\>
110
110
 
package/docs/reference/interfaces/IAttestationCreateRequest.md CHANGED
@@ -4,7 +4,7 @@ Attest the data and return the id of the attestation.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `object`
10
10
 
@@ -18,6 +18,6 @@ The data object to attest.
18
18
 
19
19
  #### namespace?
20
20
 
21
- > `optional` **namespace**: `string`
21
+ > `optional` **namespace?**: `string`
22
22
 
23
23
  The namespace of the connector to use for the attestation, defaults to component configured namespace.
package/docs/reference/interfaces/IAttestationDestroyRequest.md CHANGED
@@ -4,7 +4,7 @@ Destroy the attestation.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
package/docs/reference/interfaces/IAttestationGetRequest.md CHANGED
@@ -4,9 +4,9 @@ Verify that the proof is valid for the attestation.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### headers?
7
+ ### headers? {#headers}
8
8
 
9
- > `optional` **headers**: `object`
9
+ > `optional` **headers?**: `object`
10
10
 
11
11
  The headers which can be used to determine the response data type.
12
12
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
16
16
 
17
17
  ***
18
18
 
19
- ### pathParams
19
+ ### pathParams {#pathparams}
20
20
 
21
21
  > **pathParams**: `object`
22
22
 
package/docs/reference/interfaces/IAttestationGetResponse.md CHANGED
@@ -4,9 +4,9 @@ The response to verifying the attestation.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### headers?
7
+ ### headers? {#headers}
8
8
 
9
- > `optional` **headers**: `object`
9
+ > `optional` **headers?**: `object`
10
10
 
11
11
  The headers which can be used to determine the response data type.
12
12
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
16
16
 
17
17
  ***
18
18
 
19
- ### body
19
+ ### body {#body}
20
20
 
21
21
  > **body**: [`IAttestationInformation`](IAttestationInformation.md)
22
22
 
package/docs/reference/interfaces/IAttestationInformation.md CHANGED
@@ -4,7 +4,7 @@ Interface describing the collated attestation information.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### @context
7
+ ### @context {#context}
8
8
 
9
9
  > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
@@ -12,7 +12,7 @@ JSON-LD Context.
12
12
 
13
13
  ***
14
14
 
15
- ### type
15
+ ### type {#type}
16
16
 
17
17
  > **type**: `"Information"`
18
18
 
@@ -20,7 +20,7 @@ JSON-LD Type.
20
20
 
21
21
  ***
22
22
 
23
- ### id
23
+ ### id {#id}
24
24
 
25
25
  > **id**: `string`
26
26
 
@@ -28,72 +28,64 @@ The unique identifier of the attestation.
28
28
 
29
29
  ***
30
30
 
31
- ### dateCreated
31
+ ### dateCreated {#datecreated}
32
32
 
33
33
  > **dateCreated**: `string`
34
34
 
35
35
  Created date/time of the attestation in ISO format.
36
- json-ld namespace:schema
37
36
 
38
37
  ***
39
38
 
40
- ### dateTransferred?
39
+ ### dateTransferred? {#datetransferred}
41
40
 
42
- > `optional` **dateTransferred**: `string`
41
+ > `optional` **dateTransferred?**: `string`
43
42
 
44
43
  Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
45
- json-ld type:schema:Date
46
44
 
47
45
  ***
48
46
 
49
- ### ownerIdentity
47
+ ### ownerIdentity {#owneridentity}
50
48
 
51
49
  > **ownerIdentity**: `string`
52
50
 
53
51
  The identity of the owner.
54
- json-ld type:schema:identifier
55
52
 
56
53
  ***
57
54
 
58
- ### holderIdentity?
55
+ ### holderIdentity? {#holderidentity}
59
56
 
60
- > `optional` **holderIdentity**: `string`
57
+ > `optional` **holderIdentity?**: `string`
61
58
 
62
59
  The identity of the current holder, can be undefined if owner is still the holder.
63
- json-ld type:schema:identifier
64
60
 
65
61
  ***
66
62
 
67
- ### attestationObject
63
+ ### attestationObject {#attestationobject}
68
64
 
69
65
  > **attestationObject**: `IJsonLdNodeObject`
70
66
 
71
67
  The data that was attested.
72
- json-ld namespace:twin-common
73
68
 
74
69
  ***
75
70
 
76
- ### proof?
71
+ ### proof? {#proof}
77
72
 
78
- > `optional` **proof**: `IJsonLdNodeObject`
73
+ > `optional` **proof?**: `IJsonLdNodeObject`
79
74
 
80
75
  The proof for the attested data.
81
- json-ld namespace:twin-attestation
82
76
 
83
77
  ***
84
78
 
85
- ### verified?
79
+ ### verified? {#verified}
86
80
 
87
- > `optional` **verified**: `boolean`
81
+ > `optional` **verified?**: `boolean`
88
82
 
89
83
  Whether the attestation has been verified.
90
- json-ld namespace:twin-common
91
84
 
92
85
  ***
93
86
 
94
- ### verificationFailure?
87
+ ### verificationFailure? {#verificationfailure}
95
88
 
96
- > `optional` **verificationFailure**: `string`
89
+ > `optional` **verificationFailure?**: `string`
97
90
 
98
91
  The verification failure message.
99
- json-ld type:schema:Text
package/docs/reference/interfaces/IAttestationJwtProof.md CHANGED
@@ -4,7 +4,7 @@ Interface describing an attestation proof.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### @context
7
+ ### @context {#context}
8
8
 
9
9
  > **@context**: `"https://schema.twindev.org/attestation/"` \| \[`"https://schema.twindev.org/attestation/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
@@ -12,7 +12,7 @@ JSON-LD Context.
12
12
 
13
13
  ***
14
14
 
15
- ### type
15
+ ### type {#type}
16
16
 
17
17
  > **type**: `"JwtProof"`
18
18
 
@@ -20,9 +20,8 @@ The type of the proof.
20
20
 
21
21
  ***
22
22
 
23
- ### value
23
+ ### value {#value}
24
24
 
25
25
  > **value**: `string`
26
26
 
27
27
  The value of the proof.
28
- json-ld type:schema:Text
package/docs/reference/interfaces/IAttestationTransferRequest.md CHANGED
@@ -4,7 +4,7 @@ Transfer the attestation to a new holder.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
@@ -18,7 +18,7 @@ The attestation id to transfer.
18
18
 
19
19
  ***
20
20
 
21
- ### body
21
+ ### body {#body}
22
22
 
23
23
  > **body**: `object`
24
24
 
package/docs/reference/variables/AttestationContexts.md CHANGED
@@ -6,37 +6,37 @@ The contexts of attestation data.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Namespace
9
+ ### Namespace {#namespace}
10
10
 
11
11
  > `readonly` **Namespace**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
12
12
 
13
13
  The canonical RDF namespace URI for Attestation.
14
14
 
15
- ### Context
15
+ ### Context {#context}
16
16
 
17
17
  > `readonly` **Context**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
18
18
 
19
19
  The value to use in context for Attestation.
20
20
 
21
- ### JsonLdContext
21
+ ### JsonLdContext {#jsonldcontext}
22
22
 
23
23
  > `readonly` **JsonLdContext**: `"https://schema.twindev.org/attestation/types.jsonld"` = `"https://schema.twindev.org/attestation/types.jsonld"`
24
24
 
25
25
  The JSON-LD Context URL for Attestation.
26
26
 
27
- ### NamespaceCommon
27
+ ### NamespaceCommon {#namespacecommon}
28
28
 
29
29
  > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
30
30
 
31
31
  The canonical RDF namespace URI for TWIN Common.
32
32
 
33
- ### ContextCommon
33
+ ### ContextCommon {#contextcommon}
34
34
 
35
35
  > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
36
36
 
37
37
  The value to use in JSON-LD context for TWIN Common.
38
38
 
39
- ### JsonLdContextCommon
39
+ ### JsonLdContextCommon {#jsonldcontextcommon}
40
40
 
41
41
  > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
42
42
 
package/docs/reference/variables/AttestationTypes.md CHANGED
@@ -6,13 +6,13 @@ The types of attestation data.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Information
9
+ ### Information {#information}
10
10
 
11
11
  > `readonly` **Information**: `"Information"` = `"Information"`
12
12
 
13
13
  Represents attestation information.
14
14
 
15
- ### JwtProof
15
+ ### JwtProof {#jwtproof}
16
16
 
17
17
  > `readonly` **JwtProof**: `"JwtProof"` = `"JwtProof"`
18
18
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/attestation-models",
3
- "version": "0.0.3-next.7",
4
- "description": "Models which define the structure of the attestation connectors and services",
3
+ "version": "0.0.3-next.9",
4
+ "description": "Shared models and data types for attestation connectors and services.",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/attestation.git",
7
+ "url": "git+https://github.com/iotaledger/attestation.git",
8
8
  "directory": "packages/attestation-models"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -54,7 +54,7 @@
54
54
  "schemas"
55
55
  ],
56
56
  "bugs": {
57
- "url": "git+https://github.com/twinfoundation/attestation/issues"
57
+ "url": "git+https://github.com/iotaledger/attestation/issues"
58
58
  },
59
59
  "homepage": "https://twindev.org"
60
60
  }