@3sixty/auditable-item-graph-models 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IAuditableItemGraphChangesetListRequest.md

@@ -0,0 +1,55 @@
+# Interface: IAuditableItemGraphChangesetListRequest
+
+Get an auditable item graph changeset.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the changeset to get.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The optional cursor to get next chunk.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Limit the number of entities to return.
+
+#### verifySignatureDepth?
+
+> `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

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphChangesetListResponse
+
+Response to getting an auditable item graph changeset list.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+#### link?
+
+> `optional` **link?**: `string` \| `string`[]
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -0,0 +1,393 @@
+# Interface: IAuditableItemGraphComponent
+
+Interface describing an auditable item graph contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create() {#create}
+
+> **create**(`vertex`): `Promise`\<`string`\>
+
+Create a new graph vertex.
+
+#### Parameters
+
+##### vertex
+
+`Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
+
+The vertex to create.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the new graph item.
+
+***
+
+### update() {#update}
+
+> **update**(`vertex`): `Promise`\<`void`\>
+
+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
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
+
+The vertex to update.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the vertex has been updated.
+
+#### Throws
+
+GeneralError If a bypass vertex is being switched back to audited.
+
+***
+
+### updatePartial() {#updatepartial}
+
+> **updatePartial**(`partial`): `Promise`\<`void`\>
+
+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
+
+##### partial
+
+[`IAuditableItemGraphPartialVertex`](IAuditableItemGraphPartialVertex.md)
+
+The partial vertex update (must include `id`).
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the partial update has been applied.
+
+#### Throws
+
+GeneralError If a bypass vertex is being switched back to audited.
+
+***
+
+### get() {#get}
+
+> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+Get a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeDeleted?
+
+`boolean`
+
+Whether to include deleted aliases, resource, edges, defaults to false.
+
+###### verifySignatureDepth?
+
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+The vertex if found.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+***
+
+### getChangesets() {#getchangesets}
+
+> **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
+
+Get a graph vertex changeset list.
+
+#### Parameters
+
+##### id
+
+`string`
+
+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.
+
+###### verifySignatureDepth?
+
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+How many signatures to verify, defaults to "none".
+
+#### Returns
+
+`Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
+
+The changeset if found, always empty for a bypass vertex.
+
+#### 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?
+
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
+
+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, a bypass vertex never has changesets.
+
+***
+
+### 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, a bypass vertex never has versions.
+
+***
+
+### 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, a bypass vertex returns a single baseline entry for its
+current state when that falls within the requested range.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+***
+
+### removeProof() {#removeproof}
+
+> **removeProof**(`id`): `Promise`\<`void`\>
+
+Remove the proof for an item.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex to remove the proof from.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the proof has been removed from all changesets.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+***
+
+### query() {#query}
+
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
+
+Query the graph for vertices.
+
+#### Parameters
+
+##### options?
+
+The query options.
+
+###### id?
+
+`string`
+
+The optional id to look for.
+
+###### idMode?
+
+`"id"` \| `"alias"` \| `"both"`
+
+Look in id, alias or both, defaults to both.
+
+###### idExact?
+
+`boolean`
+
+Find only exact matches, default to false meaning partial matching.
+
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
+
+##### conditions?
+
+`EntityCondition`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+Conditions to use in the query.
+
+##### orderBy?
+
+`"dateCreated"` \| `"dateModified"`
+
+The order for the results, defaults to dateCreated.
+
+##### orderByDirection?
+
+`SortDirection`
+
+The direction for the order, defaults to descending.
+
+##### properties?
+
+keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+
+The properties to return, if not provided defaults to id, dateCreated, aliases and object.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+The maximum number of entities to return, a page can contain fewer so follow
+the cursor until it is absent to read them all.
+
+#### Returns
+
+`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

@@ -0,0 +1,11 @@
+# Interface: IAuditableItemGraphCreateRequest
+
+Create an auditable item graph vertex.
+
+## Properties
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
+
+The data to be used in the vertex.

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -0,0 +1,95 @@
+# Interface: IAuditableItemGraphEdge
+
+Interface describing an edge between two vertices in an auditable item graph.
+
+## Extends
+
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
+
+## Properties
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
+
+The date/time of when the element was created.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the element was modified.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the element was deleted, as we never actually remove items.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
+
+***
+
+### @context? {#context}
+
+> `optional` **@context?**: `"https://schema.3sixty.global/aig/"` \| \[`"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### id? {#id}
+
+> `optional` **id?**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
+### targetId {#targetid}
+
+> **targetId**: `string`
+
+The target vertex id the edge connects to.
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphEdge"`
+
+JSON-LD Type.
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the edge.
+
+***
+
+### edgeRelationships {#edgerelationships}
+
+> **edgeRelationships**: `string`[]
+
+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}
+
+> **id**: `string`
+
+The id of the vertex created.

package/docs/reference/interfaces/IAuditableItemGraphEventBusVertexUpdated.md

@@ -0,0 +1,19 @@
+# Interface: IAuditableItemGraphEventBusVertexUpdated
+
+Event bus payload for vertex updated.
+
+## Properties
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the vertex updated.
+
+***
+
+### patches {#patches}
+
+> **patches**: `IPatchOperation`[]
+
+The patches in the changeset.

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphGetRequest
+
+Get an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to get.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### includeDeleted?
+
+> `optional` **includeDeleted?**: `string`
+
+Whether to include deleted aliases, resource, edges, defaults to false.
+
+#### verifySignatureDepth?
+
+> `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

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphGetResponse
+
+Response to getting an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
+
+The response body.

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).