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

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -4,7 +4,7 @@ Interface describing an auditable item graph vertex resource.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
@@ -20,48 +20,60 @@ The id of the element.
 
 ***
 
-### created
+### dateCreated
 
-> **created**: `number`
+> **dateCreated**: `string`
 
-The timestamp of when the element was created.
+The date/time of when the element was created.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`created`](IAuditableItemGraphAuditedElement.md#created)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
 
 ***
 
-### updated?
+### dateModified?
 
-> `optional` **updated**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`updated`](IAuditableItemGraphAuditedElement.md#updated)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
 
 ***
 
-### deleted?
+### dateDeleted?
 
-> `optional` **deleted**: `number`
+> `optional` **dateDeleted**: `string`
 
-The timestamp of when the element was deleted, as we never actually remove items.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`deleted`](IAuditableItemGraphAuditedElement.md#deleted)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
 
 ***
 
-### metadata?
+### @context
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
 
-The metadata to associate with the element as JSON-LD.
+JSON-LD Context.
 
-#### Inherited from
+***
+
+### type
+
+> **type**: `"AuditableItemGraphResource"`
+
+JSON-LD Type.
+
+***
+
+### resourceObject?
+
+> `optional` **resourceObject**: `IJsonLdNodeObject`
 
-`IAuditableItemGraphMetadataElement.metadata`
+The JSON-LD object for the resource.

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -24,11 +24,11 @@ The id of the vertex to update.
 
 The data to be used in the vertex.
 
-#### metadata?
+#### vertexObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **vertexObject**: `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/IAuditableItemGraphVerification.md

@@ -2,17 +2,29 @@
 
 Interface describing an auditable item graph verification.
 
-## Indexable
+## Properties
 
- \[`id`: `string`\]: `unknown`
+### @context
 
-## Properties
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
 
-### epoch
+### type
 
-> **epoch**: `number`
+> **type**: `"AuditableItemGraphVerification"`
 
-The epoch of the verification.
+JSON-LD Type.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of the verification.
 
 ***
 
@@ -21,3 +33,15 @@ The epoch of the verification.
 > **state**: [`AuditableItemGraphVerificationState`](../type-aliases/AuditableItemGraphVerificationState.md)
 
 The state of the verification.
+
+***
+
+### stateProperties?
+
+> `optional` **stateProperties**: `object`
+
+The state properties.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -4,7 +4,7 @@ Interface describing an auditable item graph vertex.
 
 ## Extends
 
-- `Omit`\<[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md), `"deleted"`\>.`IAuditableItemGraphMetadataElement`
+- `Omit`\<[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md), `"deleted"`\>
 
 ## Properties
 
@@ -20,39 +20,55 @@ The id of the element.
 
 ***
 
-### created
+### dateCreated
 
-> **created**: `number`
+> **dateCreated**: `string`
 
-The timestamp of when the element was created.
+The date/time of when the element was created.
 
 #### Inherited from
 
-`Omit.created`
+`Omit.dateCreated`
 
 ***
 
-### updated?
+### dateModified?
 
-> `optional` **updated**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-`Omit.updated`
+`Omit.dateModified`
 
 ***
 
-### metadata?
+### dateDeleted?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **dateDeleted**: `string`
 
-The metadata to associate with the element as JSON-LD.
+The date/time of when the element was deleted, as we never actually remove items.
 
 #### Inherited from
 
-`IAuditableItemGraphMetadataElement.metadata`
+`Omit.dateDeleted`
+
+***
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphVertex"`
+
+JSON-LD Type.
 
 ***
 
@@ -64,6 +80,14 @@ The identity of the node which controls the vertex.
 
 ***
 
+### vertexObject?
+
+> `optional` **vertexObject**: `IJsonLdNodeObject`
+
+The JSON-LD object for the vertex.
+
+***
+
 ### aliases?
 
 > `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
@@ -93,3 +117,19 @@ Edges connected to the vertex.
 > `optional` **changesets**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
 
 Changesets for the vertex.
+
+***
+
+### verified?
+
+> `optional` **verified**: `boolean`
+
+Is the vertex verified, will only be populated when verification is requested.
+
+***
+
+### changesetsVerification?
+
+> `optional` **changesetsVerification**: [`IAuditableItemGraphVerification`](IAuditableItemGraphVerification.md)[]
+
+The verification state of the changesets, will only be populated when changesets are requested.

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -0,0 +1,35 @@
+# Interface: IAuditableItemGraphVertexList
+
+Interface describing an auditable item graph vertex list.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphVertexList"`
+
+JSON-LD Type.
+
+***
+
+### vertices
+
+> **vertices**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+
+The list of vertices.
+
+***
+
+### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get the next chunk of vertices.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -14,54 +14,60 @@ The context root for the auditable item graph types.
 
 ### Vertex
 
-> `readonly` **Vertex**: `"https://schema.twindev.org/aig/AuditableItemGraphVertex"` = `"https://schema.twindev.org/aig/AuditableItemGraphVertex"`
+> `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`
 
 Represents auditable item graph vertex.
 
 ### Alias
 
-> `readonly` **Alias**: `"https://schema.twindev.org/aig/AuditableItemGraphAlias"` = `"https://schema.twindev.org/aig/AuditableItemGraphAlias"`
+> `readonly` **Alias**: `"AuditableItemGraphAlias"` = `"AuditableItemGraphAlias"`
 
 Represents auditable item graph alias.
 
 ### Resource
 
-> `readonly` **Resource**: `"https://schema.twindev.org/aig/AuditableItemGraphResource"` = `"https://schema.twindev.org/aig/AuditableItemGraphResource"`
+> `readonly` **Resource**: `"AuditableItemGraphResource"` = `"AuditableItemGraphResource"`
 
 Represents auditable item graph resource.
 
 ### Edge
 
-> `readonly` **Edge**: `"https://schema.twindev.org/aig/AuditableItemGraphEdge"` = `"https://schema.twindev.org/aig/AuditableItemGraphEdge"`
+> `readonly` **Edge**: `"AuditableItemGraphEdge"` = `"AuditableItemGraphEdge"`
 
 Represents auditable item graph edge.
 
 ### Changeset
 
-> `readonly` **Changeset**: `"https://schema.twindev.org/aig/AuditableItemGraphChangeset"` = `"https://schema.twindev.org/aig/AuditableItemGraphChangeset"`
+> `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
 
 Represents auditable item graph  changeset.
 
 ### PatchOperation
 
-> `readonly` **PatchOperation**: `"https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"` = `"https://schema.twindev.org/aig/AuditableItemGraphPatchOperation"`
+> `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
 
 ### Credential
 
-> `readonly` **Credential**: `"https://schema.twindev.org/aig/AuditableItemGraphPatchCredential"` = `"https://schema.twindev.org/aig/AuditableItemGraphPatchCredential"`
+> `readonly` **Credential**: `"AuditableItemGraphPatchCredential"` = `"AuditableItemGraphPatchCredential"`
 
 Represents the immutable credential payload.
 
 ### Verification
 
-> `readonly` **Verification**: `"https://schema.twindev.org/aig/AuditableItemGraphVerification"` = `"https://schema.twindev.org/aig/AuditableItemGraphVerification"`
+> `readonly` **Verification**: `"AuditableItemGraphVerification"` = `"AuditableItemGraphVerification"`
 
 Represents auditable item stream verification.
 
 ### VerificationState
 
-> `readonly` **VerificationState**: `"https://schema.twindev.org/aig/AuditableItemGraphVerificationState"` = `"https://schema.twindev.org/aig/AuditableItemGraphVerificationState"`
+> `readonly` **VerificationState**: `"AuditableItemGraphVerificationState"` = `"AuditableItemGraphVerificationState"`
 
 Represents auditable item stream verification state.
+
+### VertexList
+
+> `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
+
+Represents auditable item stream vertex list.

package/package.json

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

package/dist/types/models/IAuditableItemGraphMetadataElement.d.ts

@@ -1,10 +0,0 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-/**
- * Interface describing the base properties for auditable metadata elements.
- */
-export interface IAuditableItemGraphMetadataElement {
-    /**
-     * The metadata to associate with the element as JSON-LD.
-     */
-    metadata?: IJsonLdNodeObject;
-}

package/docs/reference/type-aliases/JsonReturnType.md

@@ -1,13 +0,0 @@
-# Type Alias: JsonReturnType\<T, U, V\>
-
-> **JsonReturnType**\<`T`, `U`, `V`\>: `T` *extends* `"json"` ? `U` : `V`
-
-The return type based on the response type.
-
-## Type Parameters
-
-• **T**
-
-• **U**
-
-• **V**