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

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,23 @@ The class name of the component.
 
 ***
 
-### create()
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Register all AIG metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.start`
+
+***
+
+### create() {#create}
 
 > **create**(`vertex`): `Promise`\<`string`\>
 
@@ -80,45 +96,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}
 
-`object`[]
+> **update**(`vertex`): `Promise`\<`void`\>
 
-The resources attached to the vertex.
+Update a graph vertex (PUT — full replacement of vertex state).
+Concurrent updates for the same vertex are serialized via `Mutex` on the vertex id.
 
-###### edges?
+#### Parameters
 
-`object`[]
+##### vertex
 
-The edges connected to the vertex.
+`IAuditableItemGraphVertex`
+
+The vertex to update.
 
 #### Returns
 
-`Promise`\<`string`\>
+`Promise`\<`void`\>
 
-The id of the new graph item.
+Nothing.
 
 #### 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`\>
+
+Nothing.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.updatePartial`
+
+***
+
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertex`\>
 
@@ -142,11 +190,57 @@ Additional options for the get operation.
 
 Whether to include deleted/updated aliases, resource, edges, defaults to false.
 
-###### includeChangesets?
+###### verifySignatureDepth?
 
-`boolean`
+`VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertex`\>
+
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.get`
+
+***
+
+### getChangesets() {#getchangesets}
+
+> **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: `IAuditableItemGraphChangesetList`; `cursor?`: `string`; \}\>
+
+Get a graph vertex changeset list.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### cursor?
+
+`string`
 
-Whether to include the changesets of the vertex, defaults to false.
+The optional cursor to get next chunk.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+##### options?
+
+Additional options for the get operation.
 
 ###### verifySignatureDepth?
 
@@ -156,7 +250,7 @@ How many signatures to verify, defaults to "none".
 
 #### Returns
 
-`Promise`\<`IAuditableItemGraphVertex`\>
+`Promise`\<\{ `changesets`: `IAuditableItemGraphChangesetList`; `cursor?`: `string`; \}\>
 
 The vertex if found.
 
@@ -166,69 +260,137 @@ NotFoundError if the vertex is not found.
 
 #### Implementation of
 
-`IAuditableItemGraphComponent.get`
+`IAuditableItemGraphComponent.getChangesets`
 
 ***
 
-### update()
+### getChangeset() {#getchangeset}
 
-> **update**(`vertex`): `Promise`\<`void`\>
+> **getChangeset**(`id`, `options?`): `Promise`\<`IAuditableItemGraphChangeset`\>
 
-Update a graph vertex.
+Get a graph vertex changeset.
 
 #### Parameters
 
-##### vertex
+##### id
 
-The vertex to update.
+`string`
+
+The id of the vertex to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### verifySignatureDepth?
+
+`VerifyDepth`
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphChangeset`\>
+
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getChangeset`
+
+***
 
-###### id
+### getVersion() {#getversion}
+
+> **getVersion**(`id`, `version`): `Promise`\<`IAuditableItemGraphVertex`\>
+
+Get a graph vertex at a specific version.
+
+#### Parameters
+
+##### id
 
 `string`
 
-The id of the vertex to update.
+The id of the vertex.
+
+##### version
+
+`number`
+
+The version number to retrieve.
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertex`\>
+
+The vertex reconstructed at that version.
+
+#### Throws
+
+NotFoundError if the vertex or version is not found.
+
+#### Implementation of
+
+`IAuditableItemGraphComponent.getVersion`
 
-###### annotationObject?
+***
+
+### getVersions() {#getversions}
 
-`IJsonLdNodeObject`
+> **getVersions**(`id`, `options?`): `Promise`\<`IAuditableItemGraphVertexVersionList`\>
 
-The annotation object for the vertex as JSON-LD.
+Get all versions of a graph vertex.
 
-###### aliases?
+#### Parameters
 
-`object`[]
+##### id
 
-Alternative aliases that can be used to identify the vertex.
+`string`
 
-###### resources?
+The id of the vertex.
 
-`object`[]
+##### options?
 
-The resources attached to the vertex.
+Additional options for the operation.
 
-###### edges?
+###### after?
 
-`object`[]
+`string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+###### before?
+
+`string`
 
-The edges connected to the vertex.
+Only return versions created before this ISO 8601 timestamp (exclusive).
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`IAuditableItemGraphVertexVersionList`\>
 
-Nothing.
+The list of vertex versions.
+
+#### Throws
+
+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
 
@@ -236,7 +398,7 @@ 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
 
@@ -250,13 +412,13 @@ 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`\<`IAuditableItemGraphVertexList`\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 Query the graph for vertices.
 
@@ -284,7 +446,7 @@ Look in id, alias or both, defaults to both.
 
 Find only exact matches, default to false meaning partial matching.
 
-###### includesResourceTypes?
+###### resourceTypes?
 
 `string`[]
 
@@ -298,9 +460,9 @@ 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?
 
@@ -328,7 +490,7 @@ Limit the number of entities to return.
 
 #### Returns
 
-`Promise`\<`IAuditableItemGraphVertexList`\>
+`Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 
 The entities, which can be partial if a limited keys list was provided.
 

package/docs/reference/classes/AuditableItemGraphVertex.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph vertex.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,15 +22,15 @@ The id of the vertex.
 
 ***
 
-### organizationIdentity?
+### organizationIdentity? {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> `optional` **organizationIdentity?**: `string`
 
 The identity of the organization which controls the vertex.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,56 +38,64 @@ The date/time of when the vertex was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the vertex was last modified.
 
 ***
 
-### aliasIndex?
+### aliasIndex? {#aliasindex}
 
-> `optional` **aliasIndex**: `string`
+> `optional` **aliasIndex?**: `string`
 
 Combined alias index for the vertex used for querying.
 
 ***
 
-### resourceTypeIndex?
+### resourceTypeIndex? {#resourcetypeindex}
 
-> `optional` **resourceTypeIndex**: `string`
+> `optional` **resourceTypeIndex?**: `string`
 
 Combined resource type index for the vertex used for querying.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the vertex as JSON-LD.
 
 ***
 
-### aliases?
+### aliases? {#aliases}
 
-> `optional` **aliases**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
+> `optional` **aliases?**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
 
 ***
 
-### resources?
+### resources? {#resources}
 
-> `optional` **resources**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
+> `optional` **resources?**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
+> `optional` **edges?**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The current version of the vertex, incremented on each changeset.

package/docs/reference/functions/auditableItemGraphChangesetGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphChangesetGet()
+
+> **auditableItemGraphChangesetGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphChangesetGetResponse`\>
+
+Get the graph vertex changeset.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphChangesetGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphChangesetGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphChangesetList.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphChangesetList()
+
+> **auditableItemGraphChangesetList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphChangesetListResponse`\>
+
+Get the graph vertex changeset list.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphChangesetListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphChangesetListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphUpdate.md

@@ -2,7 +2,7 @@
 
 > **auditableItemGraphUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
-Update the graph vertex.
+Update the graph vertex (PUT — full replacement of vertex state).
 
 ## Parameters
 

package/docs/reference/functions/auditableItemGraphUpdatePartial.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphUpdatePartial()
+
+> **auditableItemGraphUpdatePartial**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Partially update the graph vertex (PATCH — optional scalars; list fields use `{ add, remove }`).
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphUpdatePartialRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphVersionGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphVersionGet()
+
+> **auditableItemGraphVersionGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+Get the graph vertex at a specific version.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphVersionGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+The response object with additional http response properties.