@twin.org/attestation-models 0.0.3-next.1 → 0.0.3-next.11

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 (33) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/attestationDataTypes.js +4 -4
  3. package/dist/es/dataTypes/attestationDataTypes.js.map +1 -1
  4. package/dist/es/models/IAttestationComponent.js.map +1 -1
  5. package/dist/es/models/IAttestationConnector.js.map +1 -1
  6. package/dist/es/models/IAttestationInformation.js.map +1 -1
  7. package/dist/es/models/IAttestationJwtProof.js.map +1 -1
  8. package/dist/es/models/api/IAttestationTransferRequest.js.map +1 -1
  9. package/dist/es/models/attestationContexts.js +20 -4
  10. package/dist/es/models/attestationContexts.js.map +1 -1
  11. package/dist/es/schemas/AttestationInformation.json +9 -17
  12. package/dist/es/schemas/AttestationJwtProof.json +4 -7
  13. package/dist/types/models/IAttestationComponent.d.ts +1 -2
  14. package/dist/types/models/IAttestationConnector.d.ts +1 -2
  15. package/dist/types/models/IAttestationInformation.d.ts +11 -8
  16. package/dist/types/models/IAttestationJwtProof.d.ts +2 -1
  17. package/dist/types/models/api/IAttestationTransferRequest.d.ts +0 -4
  18. package/dist/types/models/attestationContexts.d.ts +20 -4
  19. package/docs/changelog.md +108 -37
  20. package/docs/examples.md +12 -1
  21. package/docs/reference/classes/AttestationDataTypes.md +1 -1
  22. package/docs/reference/interfaces/IAttestationComponent.md +5 -11
  23. package/docs/reference/interfaces/IAttestationConnector.md +5 -11
  24. package/docs/reference/interfaces/IAttestationCreateRequest.md +2 -2
  25. package/docs/reference/interfaces/IAttestationDestroyRequest.md +1 -1
  26. package/docs/reference/interfaces/IAttestationGetRequest.md +3 -3
  27. package/docs/reference/interfaces/IAttestationGetResponse.md +3 -3
  28. package/docs/reference/interfaces/IAttestationInformation.md +16 -24
  29. package/docs/reference/interfaces/IAttestationJwtProof.md +3 -3
  30. package/docs/reference/interfaces/IAttestationTransferRequest.md +2 -8
  31. package/docs/reference/variables/AttestationContexts.md +30 -6
  32. package/docs/reference/variables/AttestationTypes.md +2 -2
  33. 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
 
@@ -13,14 +13,14 @@ export class AttestationDataTypes {
13
13
  * Register all the data types.
14
14
  */
15
15
  static registerTypes() {
16
- DataTypeHandlerFactory.register(`${AttestationContexts.ContextRoot}${AttestationTypes.Information}`, () => ({
17
- context: AttestationContexts.ContextRoot,
16
+ DataTypeHandlerFactory.register(`${AttestationContexts.Namespace}${AttestationTypes.Information}`, () => ({
17
+ namespace: AttestationContexts.Namespace,
18
18
  type: AttestationTypes.Information,
19
19
  defaultValue: {},
20
20
  jsonSchema: async () => AttestationInformationSchema
21
21
  }));
22
- DataTypeHandlerFactory.register(`${AttestationContexts.ContextRoot}${AttestationTypes.JwtProof}`, () => ({
23
- context: AttestationContexts.ContextRoot,
22
+ DataTypeHandlerFactory.register(`${AttestationContexts.Namespace}${AttestationTypes.JwtProof}`, () => ({
23
+ namespace: AttestationContexts.Namespace,
24
24
  type: AttestationTypes.JwtProof,
25
25
  defaultValue: {},
26
26
  jsonSchema: async () => AttestationJwtProofSchema
@@ -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,WAAW,GAAG,gBAAgB,CAAC,WAAW,EAAE,EACnE,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,mBAAmB,CAAC,WAAW;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,WAAW,GAAG,gBAAgB,CAAC,QAAQ,EAAE,EAChE,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,mBAAmB,CAAC,WAAW;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.ContextRoot}${AttestationTypes.Information}`,\n\t\t\t() => ({\n\t\t\t\tcontext: AttestationContexts.ContextRoot,\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.ContextRoot}${AttestationTypes.JwtProof}`,\n\t\t\t() => ({\n\t\t\t\tcontext: AttestationContexts.ContextRoot,\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"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IAttestationComponent.js","sourceRoot":"","sources":["../../../src/models/IAttestationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation contract.\n */\nexport interface IAttestationComponent extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param attestationObject The data to attest.\n\t * @param namespace The namespace of the connector to use for the attestation, defaults to component configured namespace.\n\t * @returns The id of the attestation.\n\t */\n\tcreate(attestationObject: IJsonLdNodeObject, namespace?: string): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderIdentity The identity to transfer the attestation to.\n\t * @param holderAddress The address to transfer the attestation to.\n\t * @returns Nothing.\n\t */\n\ttransfer(attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param attestationId The attestation to transfer.\n\t * @returns Nothing.\n\t */\n\tdestroy(attestationId: string): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"IAttestationComponent.js","sourceRoot":"","sources":["../../../src/models/IAttestationComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation contract.\n */\nexport interface IAttestationComponent extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param attestationObject The data to attest.\n\t * @param namespace The namespace of the connector to use for the attestation, defaults to component configured namespace.\n\t * @returns The id of the attestation.\n\t */\n\tcreate(attestationObject: IJsonLdNodeObject, namespace?: string): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderAddress The address to transfer the attestation to.\n\t * @returns Nothing.\n\t */\n\ttransfer(attestationId: string, holderAddress: string): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param attestationId The attestation to transfer.\n\t * @returns Nothing.\n\t */\n\tdestroy(attestationId: string): Promise<void>;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IAttestationConnector.js","sourceRoot":"","sources":["../../../src/models/IAttestationConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation connector.\n */\nexport interface IAttestationConnector extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param verificationMethodId The identity verification method to use for attesting the data.\n\t * @param attestationObject The data to attest.\n\t * @returns The collated attestation data.\n\t */\n\tcreate(\n\t\tcontroller: string,\n\t\tverificationMethodId: string,\n\t\tattestationObject: IJsonLdNodeObject\n\t): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderIdentity The holder identity of the attestation.\n\t * @param holderAddress The new controller address of the attestation belonging to the holder.\n\t * @returns Nothing.\n\t */\n\ttransfer(\n\t\tcontroller: string,\n\t\tattestationId: string,\n\t\tholderIdentity: string,\n\t\tholderAddress: string\n\t): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to destroy.\n\t * @returns Nothing.\n\t */\n\tdestroy(controller: string, attestationId: string): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"IAttestationConnector.js","sourceRoot":"","sources":["../../../src/models/IAttestationConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { IAttestationInformation } from \"./IAttestationInformation.js\";\n\n/**\n * Interface describing an attestation connector.\n */\nexport interface IAttestationConnector extends IComponent {\n\t/**\n\t * Attest the data and return the collated information.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param verificationMethodId The identity verification method to use for attesting the data.\n\t * @param attestationObject The data to attest.\n\t * @returns The collated attestation data.\n\t */\n\tcreate(\n\t\tcontroller: string,\n\t\tverificationMethodId: string,\n\t\tattestationObject: IJsonLdNodeObject\n\t): Promise<string>;\n\n\t/**\n\t * Resolve and verify the attestation id.\n\t * @param id The attestation id to verify.\n\t * @returns The verified attestation details.\n\t */\n\tget(id: string): Promise<IAttestationInformation>;\n\n\t/**\n\t * Transfer the attestation to a new holder.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to transfer.\n\t * @param holderAddress The new controller address of the attestation belonging to the holder.\n\t * @returns Nothing.\n\t */\n\ttransfer(controller: string, attestationId: string, holderAddress: string): Promise<void>;\n\n\t/**\n\t * Destroy the attestation.\n\t * @param controller The controller identity of the user to access the vault keys.\n\t * @param attestationId The attestation to destroy.\n\t * @returns Nothing.\n\t */\n\tdestroy(controller: string, attestationId: string): Promise<void>;\n}\n"]}
@@ -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.ContextRoot,\n\t\ttypeof AttestationContexts.ContextRootCommon,\n\t\ttypeof SchemaOrgContexts.ContextRoot,\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 { 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 not yet transferred.\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 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 +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.ContextRoot\n\t\t| [typeof AttestationContexts.ContextRoot, ...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"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IAttestationTransferRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationTransferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Transfer the attestation to a new holder.\n */\nexport interface IAttestationTransferRequest {\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The attestation id to transfer.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The new holder identity.\n\t\t */\n\t\tholderIdentity: string;\n\n\t\t/**\n\t\t * The new holder address.\n\t\t */\n\t\tholderAddress: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IAttestationTransferRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAttestationTransferRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Transfer the attestation to a new holder.\n */\nexport interface IAttestationTransferRequest {\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The attestation id to transfer.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The parameters to be used in the transfer.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The new holder address.\n\t\t */\n\t\tholderAddress: string;\n\t};\n}\n"]}
@@ -6,12 +6,28 @@
6
6
  // eslint-disable-next-line @typescript-eslint/naming-convention
7
7
  export const AttestationContexts = {
8
8
  /**
9
- * The context root for the attestation types.
9
+ * The canonical RDF namespace URI for Attestation.
10
10
  */
11
- ContextRoot: "https://schema.twindev.org/attestation/",
11
+ Namespace: "https://schema.twindev.org/attestation/",
12
12
  /**
13
- * The context root for the common types.
13
+ * The value to use in context for Attestation.
14
14
  */
15
- ContextRootCommon: "https://schema.twindev.org/common/"
15
+ Context: "https://schema.twindev.org/attestation/",
16
+ /**
17
+ * The JSON-LD Context URL for Attestation.
18
+ */
19
+ JsonLdContext: "https://schema.twindev.org/attestation/types.jsonld",
20
+ /**
21
+ * The canonical RDF namespace URI for TWIN Common.
22
+ */
23
+ NamespaceCommon: "https://schema.twindev.org/common/",
24
+ /**
25
+ * The value to use in JSON-LD context for TWIN Common.
26
+ */
27
+ ContextCommon: "https://schema.twindev.org/common/",
28
+ /**
29
+ * The JSON-LD Context URL for TWIN Common.
30
+ */
31
+ JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld"
16
32
  };
17
33
  //# sourceMappingURL=attestationContexts.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"attestationContexts.js","sourceRoot":"","sources":["../../../src/models/attestationContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,yCAAyC;IAEtD;;OAEG;IACH,iBAAiB,EAAE,oCAAoC;CAC9C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of attestation data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AttestationContexts = {\n\t/**\n\t * The context root for the attestation types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/attestation/\",\n\n\t/**\n\t * The context root for the common types.\n\t */\n\tContextRootCommon: \"https://schema.twindev.org/common/\"\n} as const;\n\n/**\n * The contexts of attestation data.\n */\nexport type AttestationContexts = (typeof AttestationContexts)[keyof typeof AttestationContexts];\n"]}
1
+ {"version":3,"file":"attestationContexts.js","sourceRoot":"","sources":["../../../src/models/attestationContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,yCAAyC;IAEpD;;OAEG;IACH,OAAO,EAAE,yCAAyC;IAElD;;OAEG;IACH,aAAa,EAAE,qDAAqD;IAEpE;;OAEG;IACH,eAAe,EAAE,oCAAoC;IAErD;;OAEG;IACH,aAAa,EAAE,oCAAoC;IAEnD;;OAEG;IACH,mBAAmB,EAAE,gDAAgD;CAC5D,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of attestation data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AttestationContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Attestation.\n\t */\n\tNamespace: \"https://schema.twindev.org/attestation/\",\n\n\t/**\n\t * The value to use in context for Attestation.\n\t */\n\tContext: \"https://schema.twindev.org/attestation/\",\n\n\t/**\n\t * The JSON-LD Context URL for Attestation.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/attestation/types.jsonld\",\n\n\t/**\n\t * The canonical RDF namespace URI for TWIN Common.\n\t */\n\tNamespaceCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The value to use in JSON-LD context for TWIN Common.\n\t */\n\tContextCommon: \"https://schema.twindev.org/common/\",\n\n\t/**\n\t * The JSON-LD Context URL for TWIN Common.\n\t */\n\tJsonLdContextCommon: \"https://schema.twindev.org/common/types.jsonld\"\n} as const;\n\n/**\n * The contexts of attestation data.\n */\nexport type AttestationContexts = (typeof AttestationContexts)[keyof typeof AttestationContexts];\n"]}
@@ -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
- "const": "https://schema.twindev.org/attestation/"
12
+ "const": "https://schema.org"
15
13
  },
16
14
  {
17
- "type": "string",
18
- "const": "https://schema.twindev.org/common/"
15
+ "const": "https://schema.twindev.org/attestation/"
19
16
  },
20
17
  {
21
- "type": "string",
22
- "const": "https://schema.org"
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
  },
@@ -41,16 +38,12 @@
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."
41
+ "description": "Transferred date/time of the attestation in ISO format, can be blank if not yet transferred."
45
42
  },
46
43
  "ownerIdentity": {
47
44
  "type": "string",
48
45
  "description": "The identity of the owner."
49
46
  },
50
- "holderIdentity": {
51
- "type": "string",
52
- "description": "The identity of the current holder, can be undefined if owner is still the holder."
53
- },
54
47
  "attestationObject": {
55
48
  "$ref": "https://schema.twindev.org/json-ld/JsonLdNodeObject",
56
49
  "description": "The data that was attested."
@@ -75,6 +68,5 @@
75
68
  "dateCreated",
76
69
  "ownerIdentity",
77
70
  "attestationObject"
78
- ],
79
- "additionalProperties": false
71
+ ]
80
72
  }
@@ -1,33 +1,31 @@
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
  },
@@ -40,6 +38,5 @@
40
38
  "@context",
41
39
  "type",
42
40
  "value"
43
- ],
44
- "additionalProperties": false
41
+ ]
45
42
  }
@@ -21,11 +21,10 @@ export interface IAttestationComponent extends IComponent {
21
21
  /**
22
22
  * Transfer the attestation to a new holder.
23
23
  * @param attestationId The attestation to transfer.
24
- * @param holderIdentity The identity to transfer the attestation to.
25
24
  * @param holderAddress The address to transfer the attestation to.
26
25
  * @returns Nothing.
27
26
  */
28
- transfer(attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;
27
+ transfer(attestationId: string, holderAddress: string): Promise<void>;
29
28
  /**
30
29
  * Destroy the attestation.
31
30
  * @param attestationId The attestation to transfer.
@@ -23,11 +23,10 @@ export interface IAttestationConnector extends IComponent {
23
23
  * Transfer the attestation to a new holder.
24
24
  * @param controller The controller identity of the user to access the vault keys.
25
25
  * @param attestationId The attestation to transfer.
26
- * @param holderIdentity The holder identity of the attestation.
27
26
  * @param holderAddress The new controller address of the attestation belonging to the holder.
28
27
  * @returns Nothing.
29
28
  */
30
- transfer(controller: string, attestationId: string, holderIdentity: string, holderAddress: string): Promise<void>;
29
+ transfer(controller: string, attestationId: string, holderAddress: string): Promise<void>;
31
30
  /**
32
31
  * Destroy the attestation.
33
32
  * @param controller The controller identity of the user to access the vault keys.
@@ -10,9 +10,9 @@ export interface IAttestationInformation {
10
10
  * JSON-LD Context.
11
11
  */
12
12
  "@context": [
13
- typeof AttestationContexts.ContextRoot,
14
- typeof AttestationContexts.ContextRootCommon,
15
- typeof SchemaOrgContexts.ContextRoot,
13
+ typeof SchemaOrgContexts.Context,
14
+ typeof AttestationContexts.Context,
15
+ typeof AttestationContexts.ContextCommon,
16
16
  ...IJsonLdContextDefinitionElement[]
17
17
  ];
18
18
  /**
@@ -25,34 +25,37 @@ 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
29
  */
29
30
  dateCreated: string;
30
31
  /**
31
- * Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
32
+ * Transferred date/time of the attestation in ISO format, can be blank if not yet transferred.
33
+ * @json-ld type:schema:Date
32
34
  */
33
35
  dateTransferred?: string;
34
36
  /**
35
37
  * The identity of the owner.
38
+ * @json-ld type:schema:identifier
36
39
  */
37
40
  ownerIdentity: string;
38
- /**
39
- * The identity of the current holder, can be undefined if owner is still the holder.
40
- */
41
- holderIdentity?: string;
42
41
  /**
43
42
  * The data that was attested.
43
+ * @json-ld namespace:twin-common
44
44
  */
45
45
  attestationObject: IJsonLdNodeObject;
46
46
  /**
47
47
  * The proof for the attested data.
48
+ * @json-ld namespace:twin-attestation
48
49
  */
49
50
  proof?: IJsonLdNodeObject;
50
51
  /**
51
52
  * Whether the attestation has been verified.
53
+ * @json-ld namespace:twin-common
52
54
  */
53
55
  verified?: boolean;
54
56
  /**
55
57
  * The verification failure message.
58
+ * @json-ld type:schema:Text
56
59
  */
57
60
  verificationFailure?: string;
58
61
  }
@@ -8,13 +8,14 @@ export interface IAttestationJwtProof {
8
8
  /**
9
9
  * JSON-LD Context.
10
10
  */
11
- "@context": typeof AttestationContexts.ContextRoot | [typeof AttestationContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
11
+ "@context": typeof AttestationContexts.Context | [typeof AttestationContexts.Context, ...IJsonLdContextDefinitionElement[]];
12
12
  /**
13
13
  * The type of the proof.
14
14
  */
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
  }
@@ -15,10 +15,6 @@ export interface IAttestationTransferRequest {
15
15
  * The parameters to be used in the transfer.
16
16
  */
17
17
  body: {
18
- /**
19
- * The new holder identity.
20
- */
21
- holderIdentity: string;
22
18
  /**
23
19
  * The new holder address.
24
20
  */
@@ -3,13 +3,29 @@
3
3
  */
4
4
  export declare const AttestationContexts: {
5
5
  /**
6
- * The context root for the attestation types.
6
+ * The canonical RDF namespace URI for Attestation.
7
7
  */
8
- readonly ContextRoot: "https://schema.twindev.org/attestation/";
8
+ readonly Namespace: "https://schema.twindev.org/attestation/";
9
9
  /**
10
- * The context root for the common types.
10
+ * The value to use in context for Attestation.
11
11
  */
12
- readonly ContextRootCommon: "https://schema.twindev.org/common/";
12
+ readonly Context: "https://schema.twindev.org/attestation/";
13
+ /**
14
+ * The JSON-LD Context URL for Attestation.
15
+ */
16
+ readonly JsonLdContext: "https://schema.twindev.org/attestation/types.jsonld";
17
+ /**
18
+ * The canonical RDF namespace URI for TWIN Common.
19
+ */
20
+ readonly NamespaceCommon: "https://schema.twindev.org/common/";
21
+ /**
22
+ * The value to use in JSON-LD context for TWIN Common.
23
+ */
24
+ readonly ContextCommon: "https://schema.twindev.org/common/";
25
+ /**
26
+ * The JSON-LD Context URL for TWIN Common.
27
+ */
28
+ readonly JsonLdContextCommon: "https://schema.twindev.org/common/types.jsonld";
13
29
  };
14
30
  /**
15
31
  * The contexts of attestation data.
package/docs/changelog.md CHANGED
@@ -1,99 +1,170 @@
1
- # @twin.org/attestation-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [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)
3
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.10...attestation-models-v0.0.3-next.11) (2026-05-22)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * add context id features ([#21](https://github.com/twinfoundation/attestation/issues/21)) ([640deab](https://github.com/twinfoundation/attestation/commit/640deabfc00340e619283f94570c5e1ec45e83af))
9
- * add validate-locales ([a1f9e13](https://github.com/twinfoundation/attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
10
- * eslint migration to flat config ([7c768ff](https://github.com/twinfoundation/attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
11
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
12
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
13
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
14
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
15
- * update framework core ([02326d4](https://github.com/twinfoundation/attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
16
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
17
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
8
+ * remove holder identity ([#38](https://github.com/iotaledger/twin-attestation/issues/38)) ([4862d7f](https://github.com/iotaledger/twin-attestation/commit/4862d7f22345b82bcb90f27adc0d64ed75484813))
18
9
 
19
- ## [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)
10
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-attestation/compare/attestation-models-v0.0.3-next.9...attestation-models-v0.0.3-next.10) (2026-05-20)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **attestation-models:** Synchronize repo versions
16
+
17
+ ## [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)
18
+
19
+
20
+ ### Features
21
+
22
+ * typescript 6 update ([9484667](https://github.com/iotaledger/twin-attestation/commit/948466713dc980e4b2d89e72ebb927b3fe530280))
23
+
24
+ ## [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)
25
+
26
+
27
+ ### Miscellaneous Chores
28
+
29
+ * **attestation-models:** Synchronize repo versions
30
+
31
+ ## [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)
32
+
33
+
34
+ ### Features
35
+
36
+ * update schemas ([c163f36](https://github.com/iotaledger/twin-attestation/commit/c163f3623d54a0e87a97cf5eab25327b9aeac0fe))
37
+
38
+ ## [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)
39
+
40
+
41
+ ### Bug Fixes
42
+
43
+ * correct context ordering ([c7cded2](https://github.com/iotaledger/twin-attestation/commit/c7cded248662b8b78ff41b19749bc182ff5105c0))
44
+
45
+ ## [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)
46
+
47
+
48
+ ### Miscellaneous Chores
49
+
50
+ * **attestation-models:** Synchronize repo versions
51
+
52
+ ## [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)
53
+
54
+
55
+ ### Features
56
+
57
+ * add ts-to-jsonld-context tool ([df7edd0](https://github.com/iotaledger/twin-attestation/commit/df7edd0d32cabc2b0f9f6dc7b216f569f739324d))
58
+ * remove unused schemas causing conflict ([#27](https://github.com/iotaledger/twin-attestation/issues/27)) ([9723bc3](https://github.com/iotaledger/twin-attestation/commit/9723bc3757f87ce8a943f5f091a92d258f867892))
59
+
60
+ ## [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)
61
+
62
+
63
+ ### Features
64
+
65
+ * context updates ([#25](https://github.com/iotaledger/twin-attestation/issues/25)) ([1ea71b2](https://github.com/iotaledger/twin-attestation/commit/1ea71b28d874daef4d0bca594fb5dbf5f2a47571))
66
+
67
+ ## [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)
68
+
69
+
70
+ ### Features
71
+
72
+ * update contexts and namespaces ([#23](https://github.com/iotaledger/twin-attestation/issues/23)) ([7e7ffb4](https://github.com/iotaledger/twin-attestation/commit/7e7ffb4056bfe296dd3cedcaa7a9bfb91fd830d7))
73
+
74
+ ## [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)
75
+
76
+
77
+ ### Features
78
+
79
+ * add context id features ([#21](https://github.com/iotaledger/twin-attestation/issues/21)) ([640deab](https://github.com/iotaledger/twin-attestation/commit/640deabfc00340e619283f94570c5e1ec45e83af))
80
+ * add validate-locales ([a1f9e13](https://github.com/iotaledger/twin-attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
81
+ * eslint migration to flat config ([7c768ff](https://github.com/iotaledger/twin-attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
82
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
83
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
84
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
85
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
86
+ * update framework core ([02326d4](https://github.com/iotaledger/twin-attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
87
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
88
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
89
+
90
+ ## [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)
20
91
 
21
92
 
22
93
  ### Features
23
94
 
24
- * add validate-locales ([a1f9e13](https://github.com/twinfoundation/attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
95
+ * add validate-locales ([a1f9e13](https://github.com/iotaledger/twin-attestation/commit/a1f9e13875a661f612ce16dd9896e7df20c6a7ff))
25
96
 
26
- ## [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)
97
+ ## [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)
27
98
 
28
99
 
29
100
  ### Miscellaneous Chores
30
101
 
31
102
  * **attestation-models:** Synchronize repo versions
32
103
 
33
- ## [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)
104
+ ## [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)
34
105
 
35
106
 
36
107
  ### Features
37
108
 
38
- * eslint migration to flat config ([7c768ff](https://github.com/twinfoundation/attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
109
+ * eslint migration to flat config ([7c768ff](https://github.com/iotaledger/twin-attestation/commit/7c768ffae02456d60fd62ba8b4b488c307ceff32))
39
110
 
40
- ## [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)
111
+ ## [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)
41
112
 
42
113
 
43
114
  ### Features
44
115
 
45
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
46
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
47
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
48
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
49
- * update framework core ([02326d4](https://github.com/twinfoundation/attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
50
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
51
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
116
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
117
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
118
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
119
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
120
+ * update framework core ([02326d4](https://github.com/iotaledger/twin-attestation/commit/02326d41238862c13587c19bb3d04c1cb3b606d8))
121
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
122
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
52
123
 
53
124
  ## 0.0.1 (2025-07-09)
54
125
 
55
126
 
56
127
  ### Features
57
128
 
58
- * release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
59
- * release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
129
+ * release to production ([aa69a08](https://github.com/iotaledger/twin-attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
130
+ * release to production ([89ca987](https://github.com/iotaledger/twin-attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
60
131
 
61
- ## [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)
132
+ ## [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)
62
133
 
63
134
 
64
135
  ### Features
65
136
 
66
- * update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
137
+ * update dependencies ([1d96d2e](https://github.com/iotaledger/twin-attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
67
138
 
68
- ## [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)
139
+ ## [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)
69
140
 
70
141
 
71
142
  ### Features
72
143
 
73
- * update ts-to-schema generation ([0f23298](https://github.com/twinfoundation/attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
144
+ * update ts-to-schema generation ([0f23298](https://github.com/iotaledger/twin-attestation/commit/0f23298f6e8accb19c0faaf74220cce02155b48a))
74
145
 
75
- ## [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)
146
+ ## [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)
76
147
 
77
148
 
78
149
  ### Features
79
150
 
80
- * update data type registration with fully qualified names ([5982245](https://github.com/twinfoundation/attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
151
+ * update data type registration with fully qualified names ([5982245](https://github.com/iotaledger/twin-attestation/commit/59822454a027a9c6dfa72ffa9aabb9622b925929))
81
152
 
82
- ## [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)
153
+ ## [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)
83
154
 
84
155
 
85
156
  ### Miscellaneous Chores
86
157
 
87
158
  * **attestation-models:** Synchronize repo versions
88
159
 
89
- ## [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)
160
+ ## [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)
90
161
 
91
162
 
92
163
  ### Features
93
164
 
94
- * use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
165
+ * use shared store mechanism ([#5](https://github.com/iotaledger/twin-attestation/issues/5)) ([3768cf7](https://github.com/iotaledger/twin-attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
95
166
 
96
- ## [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)
167
+ ## [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)
97
168
 
98
169
 
99
170
  ### 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
+ ```
@@ -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
 
@@ -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,9 +58,9 @@ The verified attestation details.
58
58
 
59
59
  ***
60
60
 
61
- ### transfer()
61
+ ### transfer() {#transfer}
62
62
 
63
- > **transfer**(`attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
63
+ > **transfer**(`attestationId`, `holderAddress`): `Promise`\<`void`\>
64
64
 
65
65
  Transfer the attestation to a new holder.
66
66
 
@@ -72,12 +72,6 @@ Transfer the attestation to a new holder.
72
72
 
73
73
  The attestation to transfer.
74
74
 
75
- ##### holderIdentity
76
-
77
- `string`
78
-
79
- The identity to transfer the attestation to.
80
-
81
75
  ##### holderAddress
82
76
 
83
77
  `string`
@@ -92,7 +86,7 @@ Nothing.
92
86
 
93
87
  ***
94
88
 
95
- ### destroy()
89
+ ### destroy() {#destroy}
96
90
 
97
91
  > **destroy**(`attestationId`): `Promise`\<`void`\>
98
92
 
@@ -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,9 +64,9 @@ The verified attestation details.
64
64
 
65
65
  ***
66
66
 
67
- ### transfer()
67
+ ### transfer() {#transfer}
68
68
 
69
- > **transfer**(`controller`, `attestationId`, `holderIdentity`, `holderAddress`): `Promise`\<`void`\>
69
+ > **transfer**(`controller`, `attestationId`, `holderAddress`): `Promise`\<`void`\>
70
70
 
71
71
  Transfer the attestation to a new holder.
72
72
 
@@ -84,12 +84,6 @@ The controller identity of the user to access the vault keys.
84
84
 
85
85
  The attestation to transfer.
86
86
 
87
- ##### holderIdentity
88
-
89
- `string`
90
-
91
- The holder identity of the attestation.
92
-
93
87
  ##### holderAddress
94
88
 
95
89
  `string`
@@ -104,7 +98,7 @@ Nothing.
104
98
 
105
99
  ***
106
100
 
107
- ### destroy()
101
+ ### destroy() {#destroy}
108
102
 
109
103
  > **destroy**(`controller`, `attestationId`): `Promise`\<`void`\>
110
104
 
@@ -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.
@@ -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
 
@@ -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
 
@@ -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
 
@@ -4,15 +4,15 @@ Interface describing the collated attestation information.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### @context
7
+ ### @context {#context}
8
8
 
9
- > **@context**: \[`"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`, `...IJsonLdContextDefinitionElement[]`\]
9
+ > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/attestation/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  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,7 +28,7 @@ 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
 
@@ -36,15 +36,15 @@ Created date/time of the attestation in ISO format.
36
36
 
37
37
  ***
38
38
 
39
- ### dateTransferred?
39
+ ### dateTransferred? {#datetransferred}
40
40
 
41
- > `optional` **dateTransferred**: `string`
41
+ > `optional` **dateTransferred?**: `string`
42
42
 
43
- Transferred date/time of the attestation in ISO format, can be blank if holder identity is owner.
43
+ Transferred date/time of the attestation in ISO format, can be blank if not yet transferred.
44
44
 
45
45
  ***
46
46
 
47
- ### ownerIdentity
47
+ ### ownerIdentity {#owneridentity}
48
48
 
49
49
  > **ownerIdentity**: `string`
50
50
 
@@ -52,15 +52,7 @@ The identity of the owner.
52
52
 
53
53
  ***
54
54
 
55
- ### holderIdentity?
56
-
57
- > `optional` **holderIdentity**: `string`
58
-
59
- The identity of the current holder, can be undefined if owner is still the holder.
60
-
61
- ***
62
-
63
- ### attestationObject
55
+ ### attestationObject {#attestationobject}
64
56
 
65
57
  > **attestationObject**: `IJsonLdNodeObject`
66
58
 
@@ -68,24 +60,24 @@ The data that was attested.
68
60
 
69
61
  ***
70
62
 
71
- ### proof?
63
+ ### proof? {#proof}
72
64
 
73
- > `optional` **proof**: `IJsonLdNodeObject`
65
+ > `optional` **proof?**: `IJsonLdNodeObject`
74
66
 
75
67
  The proof for the attested data.
76
68
 
77
69
  ***
78
70
 
79
- ### verified?
71
+ ### verified? {#verified}
80
72
 
81
- > `optional` **verified**: `boolean`
73
+ > `optional` **verified?**: `boolean`
82
74
 
83
75
  Whether the attestation has been verified.
84
76
 
85
77
  ***
86
78
 
87
- ### verificationFailure?
79
+ ### verificationFailure? {#verificationfailure}
88
80
 
89
- > `optional` **verificationFailure**: `string`
81
+ > `optional` **verificationFailure?**: `string`
90
82
 
91
83
  The verification failure message.
@@ -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,7 +20,7 @@ The type of the proof.
20
20
 
21
21
  ***
22
22
 
23
- ### value
23
+ ### value {#value}
24
24
 
25
25
  > **value**: `string`
26
26
 
@@ -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,18 +18,12 @@ The attestation id to transfer.
18
18
 
19
19
  ***
20
20
 
21
- ### body
21
+ ### body {#body}
22
22
 
23
23
  > **body**: `object`
24
24
 
25
25
  The parameters to be used in the transfer.
26
26
 
27
- #### holderIdentity
28
-
29
- > **holderIdentity**: `string`
30
-
31
- The new holder identity.
32
-
33
27
  #### holderAddress
34
28
 
35
29
  > **holderAddress**: `string`
@@ -6,14 +6,38 @@ The contexts of attestation data.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### ContextRoot
9
+ ### Namespace {#namespace}
10
10
 
11
- > `readonly` **ContextRoot**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
11
+ > `readonly` **Namespace**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
12
12
 
13
- The context root for the attestation types.
13
+ The canonical RDF namespace URI for Attestation.
14
14
 
15
- ### ContextRootCommon
15
+ ### Context {#context}
16
16
 
17
- > `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
17
+ > `readonly` **Context**: `"https://schema.twindev.org/attestation/"` = `"https://schema.twindev.org/attestation/"`
18
18
 
19
- The context root for the common types.
19
+ The value to use in context for Attestation.
20
+
21
+ ### JsonLdContext {#jsonldcontext}
22
+
23
+ > `readonly` **JsonLdContext**: `"https://schema.twindev.org/attestation/types.jsonld"` = `"https://schema.twindev.org/attestation/types.jsonld"`
24
+
25
+ The JSON-LD Context URL for Attestation.
26
+
27
+ ### NamespaceCommon {#namespacecommon}
28
+
29
+ > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
30
+
31
+ The canonical RDF namespace URI for TWIN Common.
32
+
33
+ ### ContextCommon {#contextcommon}
34
+
35
+ > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
36
+
37
+ The value to use in JSON-LD context for TWIN Common.
38
+
39
+ ### JsonLdContextCommon {#jsonldcontextcommon}
40
+
41
+ > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
42
+
43
+ The JSON-LD Context URL for TWIN Common.
@@ -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.1",
4
- "description": "Models which define the structure of the attestation connectors and services",
3
+ "version": "0.0.3-next.11",
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
  }