@twin.org/auditable-item-graph-models 0.0.3-next.2 → 0.0.3-next.21

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -8,7 +8,7 @@ Interface describing an auditable item graph contract.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`vertex`): `Promise`\<`string`\>
 
@@ -18,95 +18,113 @@ Create a new graph vertex.
 
 ##### vertex
 
-The vertex to create.
+`Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
-###### annotationObject?
+The vertex to create.
 
-`IJsonLdNodeObject`
+#### Returns
 
-The annotation object for the vertex as JSON-LD.
+`Promise`\<`string`\>
 
-###### aliases?
+The id of the new graph item.
 
-`object`[]
+***
 
-Alternative aliases that can be used to identify the vertex.
+### update() {#update}
 
-###### resources?
+> **update**(`vertex`): `Promise`\<`void`\>
 
-`object`[]
+Update a graph vertex (PUT — full replacement of vertex state).
+Concurrent updates for the same vertex are serialized via `Mutex` on the vertex id.
+Multi-replica deployments are not coordinated.
 
-The resources attached to the vertex.
+#### Parameters
 
-###### edges?
+##### vertex
 
-`object`[]
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
 
-The edges connected to the vertex.
+The vertex to update.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`void`\>
 
-The id of the new graph item.
+Nothing.
 
 ***
 
-### update()
+### updatePartial() {#updatepartial}
 
-> **update**(`vertex`): `Promise`\<`void`\>
+> **updatePartial**(`partial`): `Promise`\<`void`\>
 
-Update a graph vertex.
+Partially update a graph vertex (PATCH); only properties that are not undefined are applied.
+Sub-lists use explicit `{ add, remove }` patch objects. Serialized with `update()` via `Mutex`
+on the same vertex id.
 
 #### Parameters
 
-##### vertex
+##### partial
 
-The vertex to update.
+[`IAuditableItemGraphPartialVertex`](IAuditableItemGraphPartialVertex.md)
 
-###### id
+The partial vertex update (must include `id`).
 
-`string`
+#### Returns
 
-The id of the vertex to update.
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get() {#get}
+
+> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+Get a graph vertex.
 
-###### annotationObject?
+#### Parameters
 
-`IJsonLdNodeObject`
+##### id
 
-The annotation object for the vertex as JSON-LD.
+`string`
 
-###### aliases?
+The id of the vertex to get.
 
-`object`[]
+##### options?
 
-Alternative aliases that can be used to identify the vertex.
+Additional options for the get operation.
 
-###### resources?
+###### includeDeleted?
 
-`object`[]
+`boolean`
 
-The resources attached to the vertex.
+Whether to include deleted aliases, resource, edges, defaults to false.
 
-###### edges?
+###### verifySignatureDepth?
 
-`object`[]
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
-The edges connected to the vertex.
+How many signatures to verify, defaults to "none".
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
-Nothing.
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
 
 ***
 
-### get()
+### getChangesets() {#getchangesets}
 
-> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+> **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
 
-Get a graph vertex.
+Get a graph vertex changeset list.
 
 #### Parameters
 
@@ -116,21 +134,57 @@ Get a graph vertex.
 
 The id of the vertex to get.
 
+##### cursor?
+
+`string`
+
+The optional cursor to get next chunk.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
 ##### options?
 
 Additional options for the get operation.
 
-###### includeDeleted?
+###### verifySignatureDepth?
 
-`boolean`
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
-Whether to include deleted aliases, resource, edges, defaults to false.
+How many signatures to verify, defaults to "none".
 
-###### includeChangesets?
+#### Returns
 
-`boolean`
+`Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
 
-Whether to include the changesets of the vertex, defaults to false.
+The changeset if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+***
+
+### getChangeset() {#getchangeset}
+
+> **getChangeset**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
+
+Get a graph vertex changeset.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### options?
+
+Additional options for the get operation.
 
 ###### verifySignatureDepth?
 
@@ -140,9 +194,83 @@ How many signatures to verify, defaults to "none".
 
 #### Returns
 
+`Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
+
+The changeset if found.
+
+#### Throws
+
+NotFoundError if the vertex or changeset is not found.
+
+***
+
+### getVersion() {#getversion}
+
+> **getVersion**(`id`, `version`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+Get a graph vertex at a specific version.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### version
+
+`number`
+
+The version number to retrieve.
+
+#### Returns
+
 `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
-The vertex if found.
+The vertex reconstructed at that version.
+
+#### Throws
+
+NotFoundError if the vertex or version is not found.
+
+***
+
+### getVersions() {#getversions}
+
+> **getVersions**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)\>
+
+Get all versions of a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### options?
+
+Additional options for the operation.
+
+###### after?
+
+`string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+###### before?
+
+`string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).
+
+#### Returns
+
+`Promise`\<[`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)\>
+
+The list of vertex versions.
 
 #### Throws
 
@@ -150,11 +278,11 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### removeVerifiable()
+### removeProof() {#removeproof}
 
-> **removeVerifiable**(`id`): `Promise`\<`void`\>
+> **removeProof**(`id`): `Promise`\<`void`\>
 
-Remove the verifiable storage for an item.
+Remove the proof for an item.
 
 #### Parameters
 
@@ -162,7 +290,7 @@ Remove the verifiable storage for an item.
 
 `string`
 
-The id of the vertex to remove the storage from.
+The id of the vertex to remove the proof from.
 
 #### Returns
 
@@ -176,9 +304,9 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### query()
+### query() {#query}
 
-> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
 
 Query the graph for vertices.
 
@@ -220,9 +348,9 @@ Conditions to use in the query.
 
 ##### orderBy?
 
-The order for the results, defaults to dateCreated.
+`"dateCreated"` \| `"dateModified"`
 
-`"dateCreated"` | `"dateModified"`
+The order for the results, defaults to dateCreated.
 
 ##### orderByDirection?
 
@@ -250,6 +378,6 @@ Limit the number of entities to return.
 
 #### Returns
 
-`Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
+`Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
 
 The entities, which can be partial if a limited keys list was provided.

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -4,32 +4,8 @@ Create an auditable item graph vertex.
 
 ## Properties
 
-### body
+### body {#body}
 
-> **body**: `object`
+> **body**: `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
 The data to be used in the vertex.
-
-#### annotationObject?
-
-> `optional` **annotationObject**: `IJsonLdNodeObject`
-
-The object to be used in the vertex as JSON-LD.
-
-#### aliases?
-
-> `optional` **aliases**: `object`[]
-
-Alternative aliases that can be used to identify the vertex.
-
-#### resources?
-
-> `optional` **resources**: `object`[]
-
-The resources attached to the vertex.
-
-#### edges?
-
-> `optional` **edges**: `object`[]
-
-The edges connected to the vertex.

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -8,9 +8,9 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Properties
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
 
@@ -20,9 +20,9 @@ The date/time of when the element was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
 
@@ -32,9 +32,9 @@ The date/time of when the element was modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
 
@@ -44,17 +44,17 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ***
 
-### @context
+### @context? {#context}
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
@@ -64,7 +64,7 @@ The id of the element.
 
 ***
 
-### targetId
+### targetId {#targetid}
 
 > **targetId**: `string`
 
@@ -72,7 +72,7 @@ The target vertex id the edge connects to.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphEdge"`
 
@@ -80,15 +80,15 @@ JSON-LD Type.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the edge.
 
 ***
 
-### edgeRelationships
+### edgeRelationships {#edgerelationships}
 
 > **edgeRelationships**: `string`[]
 

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexCreated.md

@@ -4,7 +4,7 @@ Event bus payload for vertex created.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexUpdated.md

@@ -4,7 +4,7 @@ Event bus payload for vertex updated.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -12,7 +12,7 @@ The id of the vertex updated.
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: `IPatchOperation`[]
 

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,26 +30,20 @@ The id of the vertex to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeDeleted?
 
-> `optional` **includeDeleted**: `string`
+> `optional` **includeDeleted?**: `string`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-#### includeChangesets?
-
-> `optional` **includeChangesets**: `string`
-
-Whether to include the changesets of the vertex, defaults to false.
-
 #### verifySignatureDepth?
 
-> `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+> `optional` **verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
 How many signatures to verify, none, current or all, defaults to "none".

package/docs/reference/interfaces/IAuditableItemGraphGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
 

package/docs/reference/interfaces/IAuditableItemGraphListPatch.md

@@ -0,0 +1,25 @@
+# Interface: IAuditableItemGraphListPatch\<TItem\>
+
+PATCH operations for a sub-list on a vertex.
+
+## Type Parameters
+
+### TItem
+
+`TItem` = [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md) \| [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md) \| [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)
+
+## Properties
+
+### add? {#add}
+
+> `optional` **add?**: `TItem`[]
+
+Items to add or update in the active set.
+
+***
+
+### remove? {#remove}
+
+> `optional` **remove?**: `string`[]
+
+Identifiers of items to remove from the active set (soft-delete).