@twin.org/auditable-item-graph-service 0.0.3-next.8 → 0.9.0-next.2

package/docs/reference/classes/AuditableItemGraphAlias.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph alias.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,15 +22,15 @@ The alternative alias for the vertex.
 
 ***
 
-### aliasFormat?
+### aliasFormat? {#aliasformat}
 
-> `optional` **aliasFormat**: `string`
+> `optional` **aliasFormat?**: `string`
 
 The format of the alias for the vertex.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,24 +38,32 @@ The date/time of when the alias was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the alias was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the alias was deleted, as we never actually remove items.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the alias as JSON-LD.
+
+***
+
+### unique? {#unique}
+
+> `optional` **unique?**: `boolean`
+
+Whether the alias should be unique across the graph, meaning that no other vertex can have the same alias. Defaults to false.

package/docs/reference/classes/AuditableItemGraphChangeset.md

@@ -14,7 +14,7 @@ Class describing a set of updates to the vertex.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the changeset.
 
 ***
 
-### vertexId
+### vertexId {#vertexid}
 
 > **vertexId**: `string`
 
@@ -30,7 +30,7 @@ The vertex the changeset belongs to.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,15 +38,15 @@ The date/time of when the changeset was created.
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The identity of the user who made the changeset.
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: [`AuditableItemGraphPatch`](AuditableItemGraphPatch.md)[]
 
@@ -54,8 +54,16 @@ The patches in the changeset.
 
 ***
 
-### proofId?
+### proofId? {#proofid}
 
-> `optional` **proofId**: `string`
+> `optional` **proofId?**: `string`
 
 The immutable proof id which contains the signature for this changeset.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version number of the vertex after this changeset was applied.

package/docs/reference/classes/AuditableItemGraphEdge.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph edge.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the edge.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,23 +30,23 @@ The date/time of when the edge was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the edge was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the edge was deleted, as we never actually remove items.
 
 ***
 
-### targetId
+### targetId {#targetid}
 
 > **targetId**: `string`
 
@@ -54,7 +54,7 @@ The target id of the edge.
 
 ***
 
-### edgeRelationships
+### edgeRelationships {#edgerelationships}
 
 > **edgeRelationships**: `string`[]
 
@@ -62,8 +62,8 @@ The relationships between the two vertices.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the edge as JSON-LD.

package/docs/reference/classes/AuditableItemGraphPatch.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph patches.
 
 ## Properties
 
-### op
+### op {#op}
 
 > **op**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
@@ -22,7 +22,7 @@ The operation for the patch.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -30,16 +30,16 @@ The path for the patch.
 
 ***
 
-### from?
+### from? {#from}
 
-> `optional` **from**: `string`
+> `optional` **from?**: `string`
 
 The from for the patch.
 
 ***
 
-### value?
+### value? {#value}
 
-> `optional` **value**: `unknown`
+> `optional` **value?**: `unknown`
 
 The value for the patch.

package/docs/reference/classes/AuditableItemGraphResource.md

@@ -14,15 +14,15 @@ Class describing the auditable item graph vertex resource.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the resource.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,24 +30,24 @@ The date/time of when the resource was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the resource was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the resource was deleted, as we never actually remove items.
 
 ***
 
-### resourceObject?
+### resourceObject? {#resourceobject}
 
-> `optional` **resourceObject**: `IJsonLdNodeObject`
+> `optional` **resourceObject?**: `IJsonLdNodeObject`
 
 Object to associate with the resource as JSON-LD.

package/docs/reference/classes/AuditableItemGraphService.md

@@ -28,7 +28,7 @@ The dependencies for the auditable item graph connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,7 @@ Runtime name for the class.
 
 ***
 
-### NAMESPACE\_CHANGESET
+### NAMESPACE\_CHANGESET {#namespace_changeset}
 
 > `readonly` `static` **NAMESPACE\_CHANGESET**: `string` = `"changeset"`
 
@@ -44,7 +44,7 @@ The namespace for the service changeset.
 
 ***
 
-### NAMESPACE\_EDGE
+### NAMESPACE\_EDGE {#namespace_edge}
 
 > `readonly` `static` **NAMESPACE\_EDGE**: `string` = `"edge"`
 
@@ -52,7 +52,7 @@ The namespace for the service edge.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -70,7 +70,25 @@ The class name of the component.
 
 ***
 
-### create()
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Register all AIG metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all metrics have been registered.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.start`
+
+***
+
+### create() {#create}
 
 > **create**(`vertex`): `Promise`\<`string`\>
 
@@ -80,45 +98,77 @@ Create a new graph vertex.
 
 ##### vertex
 
+`Omit`\<`IAuditableItemGraphVertex`, `"id"`\>
+
 The vertex to create.
 
-###### annotationObject?
+#### Returns
 
-`IJsonLdNodeObject`
+`Promise`\<`string`\>
 
-The annotation object for the vertex as JSON-LD.
+The id of the new graph item.
 
-###### aliases?
+#### Implementation of
 
-`object`[]
+`IAuditableItemGraphComponent.create`
 
-Alternative aliases that can be used to identify the vertex.
+***
 
-###### resources?
+### update() {#update}
+
+> **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.
 
-The resources attached to the vertex.
+#### Parameters
 
-###### edges?
+##### vertex
 
-`object`[]
+`IAuditableItemGraphVertex`
 
-The edges connected to the vertex.
+The vertex to update.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`void`\>
 
-The id of the new graph item.
+A promise that resolves when the vertex has been updated.
 
 #### Implementation of
 
-`IAuditableItemGraphComponent.create`
+`IAuditableItemGraphComponent.update`
 
 ***
 
-### get()
+### updatePartial() {#updatepartial}
+
+> **updatePartial**(`partial`): `Promise`\<`void`\>
+
+Partially update a graph vertex (PATCH — explicit list patches; only defined properties applied).
+Serialized with `update` via `Mutex` on the same vertex id within this instance.
+
+#### Parameters
+
+##### partial
+
+`IAuditableItemGraphPartialVertex`
+
+The partial vertex update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the partial update has been applied.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.updatePartial`
+
+***
+
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertex`\>
 
@@ -164,7 +214,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangesets()
+### getChangesets() {#getchangesets}
 
 > **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: `IAuditableItemGraphChangesetList`; `cursor?`: `string`; \}\>
 
@@ -216,7 +266,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangeset()
+### getChangeset() {#getchangeset}
 
 > **getChangeset**(`id`, `options?`): `Promise`\<`IAuditableItemGraphChangeset`\>
 
@@ -256,65 +306,93 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### update()
+### getVersion() {#getversion}
 
-> **update**(`vertex`): `Promise`\<`void`\>
+> **getVersion**(`id`, `version`): `Promise`\<`IAuditableItemGraphVertex`\>
 
-Update a graph vertex.
+Get a graph vertex at a specific version.
 
 #### Parameters
 
-##### vertex
+##### id
 
-The vertex to update.
+`string`
 
-###### id
+The id of the vertex.
 
-`string`
+##### version
+
+`number`
 
-The id of the vertex to update.
+The version number to retrieve.
 
-###### annotationObject?
+#### Returns
 
-`IJsonLdNodeObject`
+`Promise`\<`IAuditableItemGraphVertex`\>
 
-The annotation object for the vertex as JSON-LD.
+The vertex reconstructed at that version.
 
-###### aliases?
+#### Throws
 
-`object`[]
+NotFoundError if the vertex or version is not found.
 
-Alternative aliases that can be used to identify the vertex.
+#### Implementation of
 
-###### resources?
+`IAuditableItemGraphComponent.getVersion`
 
-`object`[]
+***
 
-The resources attached to the vertex.
+### getVersions() {#getversions}
 
-###### edges?
+> **getVersions**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertexVersionList`\>
 
-`object`[]
+Get all versions of a graph vertex.
 
-The edges connected to the 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`\<`void`\>
+`Promise`\<`IAuditableItemGraphVertexVersionList`\>
+
+The list of vertex versions.
+
+#### Throws
 
-Nothing.
+NotFoundError if the vertex is not found.
 
 #### Implementation of
 
-`IAuditableItemGraphComponent.update`
+`IAuditableItemGraphComponent.getVersions`
 
 ***
 
-### 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
 
@@ -322,13 +400,13 @@ Remove the verifiable storage for an item.
 
 `string`
 
-The id of the vertex to get.
+The id of the vertex to remove the proof from.
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the proof has been removed from all changesets.
 
 #### Throws
 
@@ -336,11 +414,11 @@ NotFoundError if the vertex is not found.
 
 #### Implementation of
 
-`IAuditableItemGraphComponent.removeVerifiable`
+`IAuditableItemGraphComponent.removeProof`
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
@@ -370,7 +448,7 @@ Look in id, alias or both, defaults to both.
 
 Find only exact matches, default to false meaning partial matching.
 
-###### includesResourceTypes?
+###### resourceTypes?
 
 `string`[]
 
@@ -378,15 +456,15 @@ Include vertices with specific resource types.
 
 ##### conditions?
 
-`IComparator`[]
+`EntityCondition`\<`IAuditableItemGraphVertex`\>
 
 Conditions to use in the query.
 
 ##### orderBy?
 
-The order for the results, defaults to created.
+`"dateCreated"` \| `"dateModified"`
 
-`"dateCreated"` | `"dateModified"`
+The order for the results, defaults to created.
 
 ##### orderByDirection?