@twin.org/auditable-item-graph-models 0.0.1-next.8 → 0.0.1

package/docs/changelog.md

@@ -1,5 +1,94 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([0ce06f7](https://github.com/twinfoundation/auditable-item-graph/commit/0ce06f7825aa72d04b7a2ffd8c98cb56290b9d16))
+
+## [0.0.1-next.44](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.43...auditable-item-graph-models-v0.0.1-next.44) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
+
+## [0.0.1-next.43](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.42...auditable-item-graph-models-v0.0.1-next.43) (2025-06-17)
+
+
+### Features
+
+* improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
+
+## [0.0.1-next.42](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.41...auditable-item-graph-models-v0.0.1-next.42) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
+
+## [0.0.1-next.41](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.40...auditable-item-graph-models-v0.0.1-next.41) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
+
+## [0.0.1-next.40](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.39...auditable-item-graph-models-v0.0.1-next.40) (2025-05-28)
+
+
+### Features
+
+* add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
+
+## [0.0.1-next.39](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.38...auditable-item-graph-models-v0.0.1-next.39) (2025-05-08)
+
+
+### Features
+
+* use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
+
+## [0.0.1-next.38](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.37...auditable-item-graph-models-v0.0.1-next.38) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
+
+## [0.0.1-next.37](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.36...auditable-item-graph-models-v0.0.1-next.37) (2025-04-11)
+
+
+### Features
+
+* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+
+
+### Bug Fixes
+
+* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+
+## [0.0.1-next.36](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.35...auditable-item-graph-models-v0.0.1-next.36) (2025-04-11)
+
+
+### Bug Fixes
+
+* only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
+
+## [0.0.1-next.35](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.34...auditable-item-graph-models-v0.0.1-next.35) (2025-04-10)
+
+
+### Miscellaneous Chores
+
+* **auditable-item-graph-models:** Synchronize repo versions
+
+## [0.0.1-next.34](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.33...auditable-item-graph-models-v0.0.1-next.34) (2025-03-28)
+
+
+### Features
+
+* improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
+
+## v0.0.1-next.33
 
 - Initial Release

package/docs/reference/classes/AuditableItemGraphDataTypes.md

@@ -4,13 +4,13 @@ Handle all the data types for auditable item graph.
 
 ## Constructors
 
-### new AuditableItemGraphDataTypes()
+### Constructor
 
-> **new AuditableItemGraphDataTypes**(): [`AuditableItemGraphDataTypes`](AuditableItemGraphDataTypes.md)
+> **new AuditableItemGraphDataTypes**(): `AuditableItemGraphDataTypes`
 
 #### Returns
 
-[`AuditableItemGraphDataTypes`](AuditableItemGraphDataTypes.md)
+`AuditableItemGraphDataTypes`
 
 ## Methods
 

package/docs/reference/index.md

@@ -10,11 +10,9 @@
 - [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
 - [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
 - [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
-- [IAuditableItemGraphCredential](interfaces/IAuditableItemGraphCredential.md)
 - [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
 - [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
-- [IAuditableItemGraphVerification](interfaces/IAuditableItemGraphVerification.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
 - [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
 - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
@@ -23,15 +21,19 @@
 - [IAuditableItemGraphListRequest](interfaces/IAuditableItemGraphListRequest.md)
 - [IAuditableItemGraphListResponse](interfaces/IAuditableItemGraphListResponse.md)
 - [IAuditableItemGraphUpdateRequest](interfaces/IAuditableItemGraphUpdateRequest.md)
+- [IAuditableItemGraphEventBusVertexCreated](interfaces/IAuditableItemGraphEventBusVertexCreated.md)
+- [IAuditableItemGraphEventBusVertexUpdated](interfaces/IAuditableItemGraphEventBusVertexUpdated.md)
 
 ## Type Aliases
 
+- [AuditableItemGraphContexts](type-aliases/AuditableItemGraphContexts.md)
+- [AuditableItemGraphTopics](type-aliases/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](type-aliases/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)
 
 ## Variables
 
+- [AuditableItemGraphContexts](variables/AuditableItemGraphContexts.md)
+- [AuditableItemGraphTopics](variables/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
-- [AuditableItemGraphVerificationState](variables/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](variables/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -10,12 +10,24 @@ Interface describing an alias for a vertex.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphAlias"`
@@ -24,11 +36,11 @@ JSON-LD Type.
 
 ***
 
-### aliasObject?
+### annotationObject?
 
-> `optional` **aliasObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the alias.
+The JSON-LD annotation object for the alias.
 
 ***
 
@@ -40,21 +52,9 @@ The format of the id in the alias.
 
 ***
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
-
-***
-
-### dateCreated
+### dateCreated?
 
-> **dateCreated**: `string`
+> `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
 

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -10,17 +10,17 @@ Interface describing the base properties for auditable elements.
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 
 ***
 
-### dateCreated
+### dateCreated?
 
-> **dateCreated**: `string`
+> `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
 

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -1,12 +1,12 @@
 # Interface: IAuditableItemGraphChangeset
 
-Interface describing a set of updates to the vertex.
+Interface describing a set of changes to the vertex.
 
 ## Properties
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -20,6 +20,14 @@ JSON-LD Type.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the changeset.
+
+***
+
 ### dateCreated
 
 > **dateCreated**: `string`
@@ -44,32 +52,16 @@ The patches in the changeset.
 
 ***
 
-### hash
-
-> **hash**: `string`
-
-The hash for the changeset.
-
-***
-
-### signature
-
-> **signature**: `string`
-
-The signature for the changeset.
-
-***
-
-### immutableStorageId?
+### proofId?
 
-> `optional` **immutableStorageId**: `string`
+> `optional` **proofId**: `string`
 
-The immutable storage id containing the signature for the changeset.
+The immutable proof id which contains the signature for this changeset.
 
 ***
 
 ### verification?
 
-> `optional` **verification**: [`IAuditableItemGraphVerification`](IAuditableItemGraphVerification.md)
+> `optional` **verification**: `IImmutableProofVerification`
 
 The verification for the changeset.

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,33 +10,49 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-• **vertexObject?**: `IJsonLdNodeObject`
+##### vertex
 
-The object for the vertex as JSON-LD.
+The vertex to create.
 
-• **aliases?**: `object`[]
+###### annotationObject?
+
+`IJsonLdNodeObject`
+
+The annotation object for the vertex as JSON-LD.
+
+###### aliases?
+
+`object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-• **resources?**: `object`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item graph operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -50,37 +66,55 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`id`, `vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update a graph vertex.
 
 #### Parameters
 
-• **id**: `string`
+##### vertex
+
+The vertex to update.
+
+###### id
+
+`string`
 
 The id of the vertex to update.
 
-• **vertexObject?**: `IJsonLdNodeObject`
+###### annotationObject?
+
+`IJsonLdNodeObject`
 
-The object for the vertex as JSON-LD.
+The annotation object for the vertex as JSON-LD.
 
-• **aliases?**: `object`[]
+###### aliases?
+
+`object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-• **resources?**: `object`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item graph operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -94,29 +128,37 @@ Nothing.
 
 ### get()
 
-> **get**(`id`, `options`?): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 Get a graph vertex.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the vertex to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-• **options.includeChangesets?**: `boolean`
+###### includeChangesets?
+
+`boolean`
 
 Whether to include the changesets of the vertex, defaults to false.
 
-• **options.verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+###### verifySignatureDepth?
+
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
 How many signatures to verify, defaults to "none".
 
@@ -132,19 +174,23 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove the immutable storage for an item.
+Remove the verifiable storage for an item.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the vertex to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -162,41 +208,67 @@ NotFoundError if the vertex is not found.
 
 ### query()
 
-> **query**(`options`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
 #### Parameters
 
-• **options?**
+##### options?
 
 The query options.
 
-• **options.id?**: `string`
+###### id?
+
+`string`
 
 The optional id to look for.
 
-• **options.idMode?**: `"both"` \| `"id"` \| `"alias"`
+###### idMode?
+
+`"id"` \| `"alias"` \| `"both"`
 
 Look in id, alias or both, defaults to both.
 
-• **orderBy?**: `"dateCreated"` \| `"dateModified"`
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
+
+##### conditions?
+
+`IComparator`[]
+
+Conditions to use in the query.
+
+##### orderBy?
 
 The order for the results, defaults to dateCreated.
 
-• **orderByDirection?**: `SortDirection`
+`"dateCreated"` | `"dateModified"`
+
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to descending.
 
-• **properties?**: keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+##### properties?
+
+keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The properties to return, if not provided defaults to id, dateCreated, aliases and object.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -4,15 +4,15 @@ Create an auditable item graph vertex.
 
 ## Properties
 
-### body?
+### body
 
-> `optional` **body**: `object`
+> **body**: `object`
 
 The data to be used in the vertex.
 
-#### vertexObject?
+#### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The object to be used in the vertex as JSON-LD.
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -8,21 +8,9 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Properties
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
-
-***
-
-### dateCreated
+### dateCreated?
 
-> **dateCreated**: `string`
+> `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
 
@@ -58,12 +46,24 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphEdge"`
@@ -72,16 +72,16 @@ JSON-LD Type.
 
 ***
 
-### edgeObject?
+### annotationObject?
 
-> `optional` **edgeObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the edge.
+The JSON-LD annotation object for the edge.
 
 ***
 
-### edgeRelationship
+### edgeRelationships
 
-> **edgeRelationship**: `string`
+> **edgeRelationships**: `string`[]
 
-The relationship between the two vertices.
+The relationships between the two vertices.

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexCreated.md

@@ -0,0 +1,11 @@
+# Interface: IAuditableItemGraphEventBusVertexCreated
+
+Event bus payload for vertex created.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the vertex created.