@twin.org/auditable-item-graph-models 0.0.3-next.8 → 0.9.0-next.1

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -8,15 +8,15 @@ Interface describing an alias for a vertex.
 
 ## Properties
 
-### @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}
 
 > **id**: `string`
 
@@ -28,7 +28,7 @@ The id of the element.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphAlias"`
 
@@ -36,30 +36,35 @@ JSON-LD Type.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the alias.
-json-ld namespace:twin-common
 
 ***
 
-### aliasFormat?
+### aliasFormat? {#aliasformat}
 
-> `optional` **aliasFormat**: `string`
+> `optional` **aliasFormat?**: `string`
 
 The format of the id in the alias.
-json-ld type:schema:Text
 
 ***
 
-### dateCreated?
+### unique? {#unique}
 
-> `optional` **dateCreated**: `string`
+> `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.
+
+***
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:schema
 
 #### Inherited from
 
@@ -67,12 +72,11 @@ json-ld namespace:schema
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:schema
 
 #### Inherited from
 
@@ -80,12 +84,11 @@ json-ld namespace:schema
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
-json-ld namespace:schema
 
 #### Inherited from
 

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -10,35 +10,32 @@ Interface describing the base properties for auditable elements.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
 ***
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:schema
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:schema
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
-json-ld namespace:schema

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -4,15 +4,15 @@ Interface describing a set of changes to the vertex.
 
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphChangeset"`
 
@@ -20,7 +20,7 @@ JSON-LD Type.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -28,45 +28,49 @@ The id of the changeset.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time of when the changeset was created.
-json-ld namespace:schema
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The user identity that created the changes.
-json-ld namespace:twin-common
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: [`IAuditableItemGraphPatchOperation`](IAuditableItemGraphPatchOperation.md)[]
 
 The patches in the changeset.
-json-ld container:set
 
 ***
 
-### proofId?
+### proofId? {#proofid}
 
-> `optional` **proofId**: `string`
+> `optional` **proofId?**: `string`
 
 The immutable proof id which contains the signature for this changeset.
-json-ld type:schema:identifier
 
 ***
 
-### verification?
+### verification? {#verification}
 
-> `optional` **verification**: `IImmutableProofVerification`
+> `optional` **verification?**: `IImmutableProofVerification`
 
 The verification for the changeset.
-json-ld id
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version number of the vertex after this changeset was applied.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphChangesetGetRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph vertex changeset.
 
 ## 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`
 
@@ -36,14 +36,14 @@ The id of the changeset to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### 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/IAuditableItemGraphChangesetGetResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph vertex changeset.
 
 ## 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**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)
 

package/docs/reference/interfaces/IAuditableItemGraphChangesetList.md

@@ -4,7 +4,7 @@ Interface describing an auditable item graph changeset list.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: \[`"ItemList"`, `"AuditableItemGraphChangesetList"`\]
 
@@ -20,9 +20,8 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
 
 The list of changesets.
-json-ld namespace:schema

package/docs/reference/interfaces/IAuditableItemGraphChangesetListRequest.md

@@ -4,9 +4,9 @@ Get an auditable item graph changeset.
 
 ## 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,26 @@ The id of the changeset to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The optional cursor to get next chunk.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit the number of entities to return.
 
 #### 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/IAuditableItemGraphChangesetListResponse.md

@@ -4,9 +4,9 @@ Response to getting an auditable item graph changeset list.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md)
 

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,31 +18,9 @@ Create a new graph vertex.
 
 ##### vertex
 
-The vertex to create.
-
-###### 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`[]
-
-The resources attached to the vertex.
+`Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
-###### edges?
-
-`object`[]
-
-The edges connected to the vertex.
+The vertex to create.
 
 #### Returns
 
@@ -52,57 +30,55 @@ The id of the new graph item.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`vertex`): `Promise`\<`void`\>
 
-Update a graph 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.
+Multi-replica deployments are not coordinated.
 
 #### Parameters
 
 ##### vertex
 
-The vertex to update.
-
-###### id
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
 
-`string`
-
-The id of the vertex to update.
-
-###### annotationObject?
+The vertex to update.
 
-`IJsonLdNodeObject`
+#### Returns
 
-The annotation object for the vertex as JSON-LD.
+`Promise`\<`void`\>
 
-###### aliases?
+A promise that resolves when the vertex has been updated.
 
-`object`[]
+***
 
-Alternative aliases that can be used to identify the vertex.
+### updatePartial() {#updatepartial}
 
-###### resources?
+> **updatePartial**(`partial`): `Promise`\<`void`\>
 
-`object`[]
+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.
 
-The resources attached to the vertex.
+#### Parameters
 
-###### edges?
+##### partial
 
-`object`[]
+[`IAuditableItemGraphPartialVertex`](IAuditableItemGraphPartialVertex.md)
 
-The edges connected to the vertex.
+The partial vertex update (must include `id`).
 
 #### Returns
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the partial update has been applied.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
@@ -144,7 +120,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangesets()
+### getChangesets() {#getchangesets}
 
 > **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
 
@@ -192,7 +168,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### getChangeset()
+### getChangeset() {#getchangeset}
 
 > **getChangeset**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
 
@@ -228,11 +204,85 @@ NotFoundError if the vertex or changeset is not found.
 
 ***
 
-### removeVerifiable()
+### 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 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
+
+NotFoundError if the vertex is not found.
+
+***
+
+### removeProof() {#removeproof}
 
-> **removeVerifiable**(`id`): `Promise`\<`void`\>
+> **removeProof**(`id`): `Promise`\<`void`\>
 
-Remove the verifiable storage for an item.
+Remove the proof for an item.
 
 #### Parameters
 
@@ -240,13 +290,13 @@ 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
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the proof has been removed from all changesets.
 
 #### Throws
 
@@ -254,7 +304,7 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
 
@@ -298,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?
 

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.