@twin.org/auditable-item-graph-models 0.0.3-next.5 → 0.0.3-next.7

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -126,11 +126,53 @@ Additional options for the get operation.
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-###### includeChangesets?
+###### verifySignatureDepth?
 
-`boolean`
+[`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**(`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`
 
-Whether to include the changesets of the vertex, defaults to false.
+Limit the number of entities to return.
+
+##### options?
+
+Additional options for the get operation.
 
 ###### verifySignatureDepth?
 
@@ -140,9 +182,9 @@ How many signatures to verify, defaults to "none".
 
 #### Returns
 
-`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+`Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
 
-The vertex if found.
+The changeset if found.
 
 #### Throws
 
@@ -150,6 +192,42 @@ NotFoundError if the vertex is not found.
 
 ***
 
+### 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.
+
+***
+
 ### removeVerifiable()
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -13,6 +13,7 @@ Interface describing an edge between two vertices in an auditable item graph.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -25,6 +26,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -37,6 +39,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -69,6 +72,7 @@ The id of the element.
 > **targetId**: `string`
 
 The target vertex id the edge connects to.
+json-ld type:@id
 
 ***
 
@@ -85,6 +89,7 @@ JSON-LD Type.
 > `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the edge.
+json-ld namespace:twin-common
 
 ***
 
@@ -93,3 +98,4 @@ The JSON-LD annotation object for the edge.
 > **edgeRelationships**: `string`[]
 
 The relationships between the two vertices.
+json-ld container:set

package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md

@@ -42,12 +42,6 @@ The query parameters.
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-#### includeChangesets?
-
-> `optional` **includeChangesets**: `string`
-
-Whether to include the changesets of the vertex, defaults to false.
-
 #### verifySignatureDepth?
 
 > `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -4,9 +4,9 @@ The patch operation for JSON diffs.
 
 ## Properties
 
-### @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.
 
@@ -25,6 +25,7 @@ JSON-LD Type.
 > **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
 The operation that was performed on the item.
+json-ld type:schema:Text
 
 ***
 
@@ -33,6 +34,7 @@ The operation that was performed on the item.
 > **patchPath**: `string`
 
 The path to the object that was changed.
+json-ld type:schema:Text
 
 ***
 
@@ -41,6 +43,7 @@ The path to the object that was changed.
 > `optional` **patchFrom**: `string`
 
 The path the value was copied or moved from.
+json-ld type:schema:Text
 
 ***
 
@@ -49,3 +52,4 @@ The path the value was copied or moved from.
 > `optional` **patchValue**: `unknown`
 
 The value to add.
+json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -25,6 +25,7 @@ The id of the element.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -37,6 +38,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -49,6 +51,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -77,3 +80,4 @@ JSON-LD Type.
 > `optional` **resourceObject**: `IJsonLdNodeObject`
 
 The JSON-LD object for the resource.
+json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -13,6 +13,7 @@ Interface describing an auditable item graph vertex.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -25,6 +26,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -37,6 +39,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:schema
 
 #### Inherited from
 
@@ -77,6 +80,7 @@ JSON-LD Type.
 > `optional` **organizationIdentity**: `string`
 
 The identity of the organization which controls the vertex.
+json-ld namespace:twin-common
 
 ***
 
@@ -85,6 +89,7 @@ The identity of the organization which controls the vertex.
 > `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the vertex.
+json-ld namespace:twin-common
 
 ***
 
@@ -93,6 +98,7 @@ The JSON-LD annotation object for the vertex.
 > `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
+json-ld container:set
 
 ***
 
@@ -101,6 +107,7 @@ Alternative aliases that can be used to identify the vertex.
 > `optional` **resources**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
+json-ld container:set
 
 ***
 
@@ -109,14 +116,7 @@ The resources attached to the vertex.
 > `optional` **edges**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
-
-***
-
-### changesets?
-
-> `optional` **changesets**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
-
-Changesets for the vertex.
+json-ld container:set
 
 ***
 
@@ -125,3 +125,4 @@ Changesets for the vertex.
 > `optional` **verified**: `boolean`
 
 Is the vertex verified, will only be populated when verification is requested.
+json-ld namespace:twin-common

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -25,3 +25,4 @@ JSON-LD Type.
 > **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The list of vertices.
+json-ld namespace:schema

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -40,7 +40,13 @@ Represents auditable item graph edge.
 
 > `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
 
-Represents auditable item graph  changeset.
+Represents auditable item graph changeset.
+
+### ChangesetList
+
+> `readonly` **ChangesetList**: `"AuditableItemGraphChangesetList"` = `"AuditableItemGraphChangesetList"`
+
+Represents auditable item graph changeset list.
 
 ### PatchOperation
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.5",
+	"version": "0.0.3-next.7",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",