@twin.org/auditable-item-graph-models 0.0.1-next.4 → 0.0.1-next.40

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,33 +10,49 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`metadata`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-• **metadata?**: `IJsonLdNodeObject`
+##### vertex
 
-The metadata for the vertex as JSON-LD.
+The vertex to create.
 
-• **aliases?**: `object`[]
+###### 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`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item graph operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -50,37 +66,55 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`id`, `metadata`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
 Update a graph vertex.
 
 #### Parameters
 
-• **id**: `string`
+##### vertex
+
+The vertex to update.
+
+###### id
+
+`string`
 
 The id of the vertex to update.
 
-• **metadata?**: `IJsonLdNodeObject`
+###### annotationObject?
 
-The metadata for the vertex as JSON-LD.
+`IJsonLdNodeObject`
 
-• **aliases?**: `object`[]
+The annotation object for the vertex as JSON-LD.
+
+###### aliases?
+
+`object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-• **resources?**: `object`[]
+###### resources?
+
+`object`[]
 
 The resources attached to the vertex.
 
-• **edges?**: `object`[]
+###### edges?
+
+`object`[]
 
 The edges connected to the vertex.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the auditable item graph operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -94,43 +128,43 @@ Nothing.
 
 ### get()
 
-> **get**\<`T`\>(`id`, `options`?, `responseType`?): `Promise`\<[`JsonReturnType`](../type-aliases/JsonReturnType.md)\<`T`, [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md) & `object`, `IJsonLdDocument`\>\>
+> **get**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 Get a graph vertex.
 
-#### Type Parameters
-
-• **T** *extends* `"json"` \| `"jsonld"` = `"json"`
-
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the vertex to get.
 
-• **options?**
+##### options?
 
 Additional options for the get operation.
 
-• **options.includeDeleted?**: `boolean`
+###### includeDeleted?
+
+`boolean`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-• **options.includeChangesets?**: `boolean`
+###### includeChangesets?
 
-Whether to include the changesets of the vertex, defaults to false.
+`boolean`
 
-• **options.verifySignatureDepth?**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
+Whether to include the changesets of the vertex, defaults to false.
 
-How many signatures to verify, defaults to "none".
+###### verifySignatureDepth?
 
-• **responseType?**: `T`
+[`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
-The response type to return, defaults to application/json.
+How many signatures to verify, defaults to "none".
 
 #### Returns
 
-`Promise`\<[`JsonReturnType`](../type-aliases/JsonReturnType.md)\<`T`, [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md) & `object`, `IJsonLdDocument`\>\>
+`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 The vertex if found.
 
@@ -140,19 +174,23 @@ NotFoundError if the vertex is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove the immutable storage for an item.
+Remove the verifiable storage for an item.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the vertex to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -170,54 +208,72 @@ NotFoundError if the vertex is not found.
 
 ### query()
 
-> **query**\<`T`\>(`options`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?, `responseType`?): `Promise`\<[`JsonReturnType`](../type-aliases/JsonReturnType.md)\<`T`, `object`, `IJsonLdDocument`\>\>
+> **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
-#### Type Parameters
-
-• **T** *extends* `"json"` \| `"jsonld"` = `"json"`
-
 #### Parameters
 
-• **options?**
+##### options?
 
 The query options.
 
-• **options.id?**: `string`
+###### id?
+
+`string`
 
 The optional id to look for.
 
-• **options.idMode?**: `"both"` \| `"id"` \| `"alias"`
+###### idMode?
+
+`"both"` \| `"id"` \| `"alias"`
 
 Look in id, alias or both, defaults to both.
 
-• **orderBy?**: `"created"` \| `"updated"`
+###### resourceTypes?
+
+`string`[]
+
+Include vertices with specific resource types.
 
-The order for the results, defaults to created.
+##### conditions?
 
-• **orderByDirection?**: `SortDirection`
+`IComparator`[]
+
+Conditions to use in the query.
+
+##### orderBy?
+
+The order for the results, defaults to dateCreated.
+
+`"dateCreated"` | `"dateModified"`
+
+##### orderByDirection?
+
+`SortDirection`
 
 The direction for the order, defaults to descending.
 
-• **properties?**: keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+##### properties?
 
-The properties to return, if not provided defaults to id, created, aliases and metadata.
+keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
-• **cursor?**: `string`
+The properties to return, if not provided defaults to id, dateCreated, aliases and object.
 
-The cursor to request the next page of entities.
+##### cursor?
 
-• **pageSize?**: `number`
+`string`
 
-The maximum number of entities in a page.
+The cursor to request the next page of entities.
 
-• **responseType?**: `T`
+##### pageSize?
 
-The response type to return, defaults to application/json.
+`number`
+
+The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<[`JsonReturnType`](../type-aliases/JsonReturnType.md)\<`T`, `object`, `IJsonLdDocument`\>\>
+`Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 The entities, which can be partial if a limited keys list was provided.

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -4,17 +4,17 @@ Create an auditable item graph vertex.
 
 ## Properties
 
-### body?
+### body
 
-> `optional` **body**: `object`
+> **body**: `object`
 
 The data to be used in the vertex.
 
-#### metadata?
+#### annotationObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The metadata to be used in the vertex as JSON-LD.
+The object to be used in the vertex as JSON-LD.
 
 #### aliases?
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -4,72 +4,84 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
-### id
+### dateCreated?
 
-> **id**: `string`
+> `optional` **dateCreated**: `string`
 
-The id of the element.
+The date/time of when the element was created.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
 
 ***
 
-### created
+### dateModified?
 
-> **created**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was created.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`created`](IAuditableItemGraphAuditedElement.md#created)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
 
 ***
 
-### updated?
+### dateDeleted?
 
-> `optional` **updated**: `number`
+> `optional` **dateDeleted**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`updated`](IAuditableItemGraphAuditedElement.md#updated)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
 
 ***
 
-### deleted?
+### @context
 
-> `optional` **deleted**: `number`
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The timestamp of when the element was deleted, as we never actually remove items.
+JSON-LD Context.
 
-#### Inherited from
+***
+
+### id
+
+> **id**: `string`
+
+The id of the element.
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`deleted`](IAuditableItemGraphAuditedElement.md#deleted)
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
 
 ***
 
-### relationship
+### type
 
-> **relationship**: `string`
+> **type**: `"AuditableItemGraphEdge"`
 
-The relationship between the two vertices.
+JSON-LD Type.
 
 ***
 
-### metadata?
+### annotationObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The metadata to associate with the element as JSON-LD.
+The JSON-LD annotation object for the edge.
 
-#### Inherited from
+***
+
+### edgeRelationships
+
+> **edgeRelationships**: `string`[]
 
-`IAuditableItemGraphMetadataElement.metadata`
+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**: `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**: `string`
+
+The id of the vertex updated.
+
+***
+
+### patches
+
+> **patches**: `IPatchOperation`[]
+
+The patches in the changeset.

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -10,9 +10,9 @@ Get an auditable item graph vertex.
 
 The headers which can be used to determine the response data type.
 
-#### Accept
+#### accept
 
-> **Accept**: `"application/json"` \| `"application/ld+json"`
+> **accept**: `"application/json"` \| `"application/ld+json"`
 
 ***
 

package/docs/reference/interfaces/IAuditableItemGraphGetResponse.md

@@ -10,14 +10,14 @@ Response to getting an auditable item graph vertex.
 
 The headers which can be used to determine the response data type.
 
-#### Content-Type
+#### content-type
 
-> **Content-Type**: `"application/json"` \| `"application/ld+json"`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
 ***
 
 ### body
 
-> **body**: `IJsonLdDocument` \| [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md) & `object`
+> **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
 
-The response body, if accept header is set to application/ld+json the return object is JSON-LD document.
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -10,9 +10,9 @@ Get the a list of the vertices with matching ids or aliases.
 
 The headers which can be used to determine the response data type.
 
-#### Accept
+#### accept
 
-> **Accept**: `"application/json"` \| `"application/ld+json"`
+> **accept**: `"application/json"` \| `"application/ld+json"`
 
 ***
 
@@ -34,11 +34,23 @@ The id or alias to try and find.
 
 Which field to look in with the id, defaults to both.
 
+#### resourceTypes?
+
+> `optional` **resourceTypes**: `string`
+
+Include vertices with specific resource types, comma separated.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The conditions to filter the streams, JSON stringified IComparator[].
+
 #### orderBy?
 
-> `optional` **orderBy**: `"created"` \| `"updated"`
+> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
 
-The order for the results, default to created.
+The order for the results, default to dateCreated.
 
 #### orderByDirection?
 
@@ -50,7 +62,7 @@ The direction for the order, defaults to desc.
 
 > `optional` **properties**: `string`
 
-The properties to return as a comma separated list, defaults to "id,created,aliases,metadata".
+The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
 
 #### cursor?
 

package/docs/reference/interfaces/IAuditableItemGraphListResponse.md

@@ -10,14 +10,14 @@ The response to getting the a list of the vertices with matching ids or aliases.
 
 The headers which can be used to determine the response data type.
 
-#### Content-Type
+#### content-type
 
-> **Content-Type**: `"application/json"` \| `"application/ld+json"`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
 ***
 
 ### body
 
-> **body**: `IJsonLdDocument` \| `object`
+> **body**: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)
 
 The response payload.

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -2,6 +2,50 @@
 
 The patch operation for JSON diffs.
 
-## Extends
+## Properties
 
-- `IPatchOperation`
+### @context
+
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphPatchOperation"`
+
+JSON-LD Type.
+
+***
+
+### patchOperation
+
+> **patchOperation**: `"replace"` \| `"add"` \| `"remove"` \| `"copy"` \| `"move"` \| `"test"`
+
+The operation that was performed on the item.
+
+***
+
+### patchPath
+
+> **patchPath**: `string`
+
+The path to the object that was changed.
+
+***
+
+### patchFrom?
+
+> `optional` **patchFrom**: `string`
+
+The path the value was copied or moved from.
+
+***
+
+### patchValue?
+
+> `optional` **patchValue**: `unknown`
+
+The value to add.