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

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

@@ -9,39 +9,43 @@ export declare const AuditableItemGraphTypes: {
     /**
      * Represents auditable item graph vertex.
      */
-    readonly Vertex: "https://schema.twindev.org/aig/AuditableItemGraphVertex";
+    readonly Vertex: "AuditableItemGraphVertex";
     /**
      * Represents auditable item graph alias.
      */
-    readonly Alias: "https://schema.twindev.org/aig/AuditableItemGraphAlias";
+    readonly Alias: "AuditableItemGraphAlias";
     /**
      * Represents auditable item graph resource.
      */
-    readonly Resource: "https://schema.twindev.org/aig/AuditableItemGraphResource";
+    readonly Resource: "AuditableItemGraphResource";
     /**
      * Represents auditable item graph edge.
      */
-    readonly Edge: "https://schema.twindev.org/aig/AuditableItemGraphEdge";
+    readonly Edge: "AuditableItemGraphEdge";
     /**
      * Represents auditable item graph  changeset.
      */
-    readonly Changeset: "https://schema.twindev.org/aig/AuditableItemGraphChangeset";
+    readonly Changeset: "AuditableItemGraphChangeset";
     /**
      * Represents patch operation.
      */
-    readonly PatchOperation: "https://schema.twindev.org/aig/AuditableItemGraphPatchOperation";
+    readonly PatchOperation: "AuditableItemGraphPatchOperation";
     /**
      * Represents the immutable credential payload.
      */
-    readonly Credential: "https://schema.twindev.org/aig/AuditableItemGraphPatchCredential";
+    readonly Credential: "AuditableItemGraphPatchCredential";
     /**
      * Represents auditable item stream verification.
      */
-    readonly Verification: "https://schema.twindev.org/aig/AuditableItemGraphVerification";
+    readonly Verification: "AuditableItemGraphVerification";
     /**
      * Represents auditable item stream verification state.
      */
-    readonly VerificationState: "https://schema.twindev.org/aig/AuditableItemGraphVerificationState";
+    readonly VerificationState: "AuditableItemGraphVerificationState";
+    /**
+     * Represents auditable item stream vertex list.
+     */
+    readonly VertexList: "AuditableItemGraphVertexList";
 };
 /**
  * The types of auditable item graph data.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/auditable-item-graph-models - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.6
 
 - Initial Release

package/docs/reference/index.md

@@ -16,6 +16,7 @@
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
 - [IAuditableItemGraphVerification](interfaces/IAuditableItemGraphVerification.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
+- [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
 - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
 - [IAuditableItemGraphGetRequest](interfaces/IAuditableItemGraphGetRequest.md)
 - [IAuditableItemGraphGetResponse](interfaces/IAuditableItemGraphGetResponse.md)
@@ -25,7 +26,6 @@
 
 ## Type Aliases
 
-- [JsonReturnType](type-aliases/JsonReturnType.md)
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
 - [AuditableItemGraphVerificationState](type-aliases/AuditableItemGraphVerificationState.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -4,72 +4,84 @@ Interface describing an alias for a vertex.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
-### format?
+### @context
 
-> `optional` **format**: `string`
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
 
-The format of the id in the alias.
+JSON-LD Context.
 
 ***
 
-### id
+### type
 
-> **id**: `string`
+> **type**: `"AuditableItemGraphAlias"`
 
-The id of the element.
+JSON-LD Type.
 
-#### Inherited from
+***
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+### aliasObject?
+
+> `optional` **aliasObject**: `IJsonLdNodeObject`
+
+The JSON-LD object for the alias.
 
 ***
 
-### created
+### aliasFormat?
 
-> **created**: `number`
+> `optional` **aliasFormat**: `string`
 
-The timestamp of when the element was created.
+The format of the id in the alias.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id of the element.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`created`](IAuditableItemGraphAuditedElement.md#created)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
 
 ***
 
-### updated?
+### dateCreated
 
-> `optional` **updated**: `number`
+> **dateCreated**: `string`
 
-The timestamp of when the element was updated.
+The date/time of when the element was created.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`updated`](IAuditableItemGraphAuditedElement.md#updated)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
 
 ***
 
-### deleted?
+### dateModified?
 
-> `optional` **deleted**: `number`
+> `optional` **dateModified**: `string`
 
-The timestamp of when the element was deleted, as we never actually remove items.
+The date/time of when the element was modified.
 
 #### Inherited from
 
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`deleted`](IAuditableItemGraphAuditedElement.md#deleted)
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#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`
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -18,24 +18,24 @@ 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.
 
 ***
 
-### 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.
 
 ***
 
-### 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.

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -4,11 +4,27 @@ Interface describing a set of updates to the vertex.
 
 ## Properties
 
-### created
+### @context
 
-> **created**: `number`
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
 
-The timestamp of when the changeset was created.
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphChangeset"`
+
+JSON-LD Type.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the changeset was created.
 
 ***
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,15 +10,15 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`metadata`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-• **metadata?**: `IJsonLdNodeObject`
+• **vertexObject?**: `IJsonLdNodeObject`
 
-The metadata for the vertex as JSON-LD.
+The object for the vertex as JSON-LD.
 
 • **aliases?**: `object`[]
 
@@ -50,7 +50,7 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`id`, `metadata`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Update a graph vertex.
 
@@ -60,9 +60,9 @@ Update a graph vertex.
 
 The id of the vertex to update.
 
-• **metadata?**: `IJsonLdNodeObject`
+• **vertexObject?**: `IJsonLdNodeObject`
 
-The metadata for the vertex as JSON-LD.
+The object for the vertex as JSON-LD.
 
 • **aliases?**: `object`[]
 
@@ -94,14 +94,10 @@ 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`
@@ -124,13 +120,9 @@ Whether to include the changesets of the vertex, defaults to false.
 
 How many signatures to verify, defaults to "none".
 
-• **responseType?**: `T`
-
-The response type to return, defaults to application/json.
-
 #### Returns
 
-`Promise`\<[`JsonReturnType`](../type-aliases/JsonReturnType.md)\<`T`, [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md) & `object`, `IJsonLdDocument`\>\>
+`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 The vertex if found.
 
@@ -170,14 +162,10 @@ 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`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
-#### Type Parameters
-
-• **T** *extends* `"json"` \| `"jsonld"` = `"json"`
-
 #### Parameters
 
 • **options?**
@@ -192,9 +180,9 @@ The optional id to look for.
 
 Look in id, alias or both, defaults to both.
 
-• **orderBy?**: `"created"` \| `"updated"`
+• **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
-The order for the results, defaults to created.
+The order for the results, defaults to dateCreated.
 
 • **orderByDirection?**: `SortDirection`
 
@@ -202,7 +190,7 @@ The direction for the order, defaults to descending.
 
 • **properties?**: keyof [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
-The properties to return, if not provided defaults to id, created, aliases and metadata.
+The properties to return, if not provided defaults to id, dateCreated, aliases and object.
 
 • **cursor?**: `string`
 
@@ -212,12 +200,8 @@ The cursor to request the next page of entities.
 
 The maximum number of entities in a page.
 
-• **responseType?**: `T`
-
-The response type to return, defaults to application/json.
-
 #### 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

@@ -10,11 +10,11 @@ Create an auditable item graph vertex.
 
 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/IAuditableItemGraphCredential.md

@@ -4,11 +4,27 @@ The data stored immutably for the graph in a verifiable credential.
 
 ## Properties
 
-### created
+### @context
 
-> **created**: `number`
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
 
-The timestamp of when the changeset was created.
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"AuditableItemGraphPatchCredential"`
+
+JSON-LD Type.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the changeset was created.
 
 ***
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -4,7 +4,7 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Extends
 
-- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).`IAuditableItemGraphMetadataElement`
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
 
 ## Properties
 
@@ -20,56 +20,68 @@ 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)
 
 ***
 
-### relationship
+### @context
 
-> **relationship**: `string`
+> **@context**: `"https://schema.twindev.org/aig/"` \| [`"https://schema.twindev.org/aig/"`, `...string[]`]
 
-The relationship between the two vertices.
+JSON-LD Context.
 
 ***
 
-### metadata?
+### type
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> **type**: `"AuditableItemGraphEdge"`
 
-The metadata to associate with the element as JSON-LD.
+JSON-LD Type.
 
-#### Inherited from
+***
+
+### edgeObject?
+
+> `optional` **edgeObject**: `IJsonLdNodeObject`
+
+The JSON-LD object for the edge.
 
-`IAuditableItemGraphMetadataElement.metadata`
+***
+
+### edgeRelationship
+
+> **edgeRelationship**: `string`
+
+The relationship between the two vertices.

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"`
 
 ***
 
@@ -36,9 +36,9 @@ Which field to look in with the id, defaults to both.
 
 #### 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 +50,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,vertexObject".
 
 #### 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/"`, `...string[]`]
+
+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.