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

package/docs/reference/classes/AuditableItemGraphAlias.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph alias.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,15 +22,15 @@ The alternative alias for the vertex.
 
 ***
 
-### aliasFormat?
+### aliasFormat? {#aliasformat}
 
-> `optional` **aliasFormat**: `string`
+> `optional` **aliasFormat?**: `string`
 
 The format of the alias for the vertex.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,24 +38,32 @@ The date/time of when the alias was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the alias was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the alias was deleted, as we never actually remove items.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the alias as JSON-LD.
+
+***
+
+### unique? {#unique}
+
+> `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.

package/docs/reference/classes/AuditableItemGraphChangeset.md

@@ -14,7 +14,7 @@ Class describing a set of updates to the vertex.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the changeset.
 
 ***
 
-### vertexId
+### vertexId {#vertexid}
 
 > **vertexId**: `string`
 
@@ -30,7 +30,7 @@ The vertex the changeset belongs to.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,15 +38,15 @@ The date/time of when the changeset was created.
 
 ***
 
-### userIdentity?
+### userIdentity? {#useridentity}
 
-> `optional` **userIdentity**: `string`
+> `optional` **userIdentity?**: `string`
 
 The identity of the user who made the changeset.
 
 ***
 
-### patches
+### patches {#patches}
 
 > **patches**: [`AuditableItemGraphPatch`](AuditableItemGraphPatch.md)[]
 
@@ -54,8 +54,16 @@ The patches in the changeset.
 
 ***
 
-### proofId?
+### proofId? {#proofid}
 
-> `optional` **proofId**: `string`
+> `optional` **proofId?**: `string`
 
 The immutable proof id which contains the signature for this changeset.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version number of the vertex after this changeset was applied.

package/docs/reference/classes/AuditableItemGraphEdge.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph edge.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id of the edge.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,23 +30,23 @@ The date/time of when the edge was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the edge was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the edge was deleted, as we never actually remove items.
 
 ***
 
-### targetId
+### targetId {#targetid}
 
 > **targetId**: `string`
 
@@ -54,7 +54,7 @@ The target id of the edge.
 
 ***
 
-### edgeRelationships
+### edgeRelationships {#edgerelationships}
 
 > **edgeRelationships**: `string`[]
 
@@ -62,8 +62,8 @@ The relationships between the two vertices.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the edge as JSON-LD.

package/docs/reference/classes/AuditableItemGraphPatch.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph patches.
 
 ## Properties
 
-### op
+### op {#op}
 
 > **op**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
@@ -22,7 +22,7 @@ The operation for the patch.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -30,16 +30,16 @@ The path for the patch.
 
 ***
 
-### from?
+### from? {#from}
 
-> `optional` **from**: `string`
+> `optional` **from?**: `string`
 
 The from for the patch.
 
 ***
 
-### value?
+### value? {#value}
 
-> `optional` **value**: `unknown`
+> `optional` **value?**: `unknown`
 
 The value for the patch.

package/docs/reference/classes/AuditableItemGraphResource.md

@@ -14,15 +14,15 @@ Class describing the auditable item graph vertex resource.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the resource.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -30,24 +30,24 @@ The date/time of when the resource was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the resource was last modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The timestamp of when the resource was deleted, as we never actually remove items.
 
 ***
 
-### resourceObject?
+### resourceObject? {#resourceobject}
 
-> `optional` **resourceObject**: `IJsonLdNodeObject`
+> `optional` **resourceObject?**: `IJsonLdNodeObject`
 
 Object to associate with the resource as JSON-LD.