@twin.org/auditable-item-graph-models 0.0.1-next.16 → 0.0.1-next.18

package/dist/cjs/index.cjs

@@ -88,9 +88,9 @@ var properties$6 = {
 		"const": "AuditableItemGraphAlias",
 		description: "JSON-LD Type."
 	},
-	aliasObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the alias."
+		description: "The JSON-LD annotation object for the alias."
 	},
 	aliasFormat: {
 		type: "string",
@@ -233,9 +233,9 @@ var properties$4 = {
 		"const": "AuditableItemGraphEdge",
 		description: "JSON-LD Type."
 	},
-	edgeObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the edge."
+		description: "The JSON-LD annotation object for the edge."
 	},
 	edgeRelationship: {
 		type: "string",
@@ -381,7 +381,6 @@ var properties$2 = {
 var required$2 = [
 	"@context",
 	"dateCreated",
-	"id",
 	"type"
 ];
 var additionalProperties$2 = false;
@@ -443,9 +442,9 @@ var properties$1 = {
 		type: "string",
 		description: "The identity of the node which controls the vertex."
 	},
-	vertexObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the vertex."
+		description: "The JSON-LD annotation object for the vertex."
 	},
 	aliases: {
 		type: "array",

package/dist/esm/index.mjs

@@ -86,9 +86,9 @@ var properties$6 = {
 		"const": "AuditableItemGraphAlias",
 		description: "JSON-LD Type."
 	},
-	aliasObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the alias."
+		description: "The JSON-LD annotation object for the alias."
 	},
 	aliasFormat: {
 		type: "string",
@@ -231,9 +231,9 @@ var properties$4 = {
 		"const": "AuditableItemGraphEdge",
 		description: "JSON-LD Type."
 	},
-	edgeObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the edge."
+		description: "The JSON-LD annotation object for the edge."
 	},
 	edgeRelationship: {
 		type: "string",
@@ -379,7 +379,6 @@ var properties$2 = {
 var required$2 = [
 	"@context",
 	"dateCreated",
-	"id",
 	"type"
 ];
 var additionalProperties$2 = false;
@@ -441,9 +440,9 @@ var properties$1 = {
 		type: "string",
 		description: "The identity of the node which controls the vertex."
 	},
-	vertexObject: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The JSON-LD object for the vertex."
+		description: "The JSON-LD annotation object for the vertex."
 	},
 	aliases: {
 		type: "array",

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

@@ -9,14 +9,18 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
      * JSON-LD Context.
      */
     "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
     /**
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.Alias;
     /**
-     * The JSON-LD object for the alias.
+     * The JSON-LD annotation object for the alias.
      */
-    aliasObject?: IJsonLdNodeObject;
+    annotationObject?: IJsonLdNodeObject;
     /**
      * The format of the id in the alias.
      */

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

@@ -5,7 +5,7 @@ export interface IAuditableItemGraphAuditedElement {
     /**
      * The id of the element.
      */
-    id: string;
+    id?: string;
     /**
      * The date/time of when the element was created.
      */

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { SortDirection } from "@twin.org/entity";
+import type { IComparator, SortDirection } from "@twin.org/entity";
 import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
 import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList";
 import type { VerifyDepth } from "./verifyDepth";
@@ -10,7 +10,7 @@ import type { VerifyDepth } from "./verifyDepth";
 export interface IAuditableItemGraphComponent extends IComponent {
     /**
      * Create a new graph vertex.
-     * @param vertexObject The object for the vertex as JSON-LD.
+     * @param annotationObject The annotation object for the vertex as JSON-LD.
      * @param aliases Alternative aliases that can be used to identify the vertex.
      * @param resources The resources attached to the vertex.
      * @param edges The edges connected to the vertex.
@@ -18,22 +18,22 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns The id of the new graph item.
      */
-    create(vertexObject?: IJsonLdNodeObject, aliases?: {
+    create(annotationObject?: IJsonLdNodeObject, aliases?: {
         id: string;
         aliasFormat?: string;
-        aliasObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
     }[], resources?: {
-        id: string;
+        id?: string;
         resourceObject?: IJsonLdNodeObject;
     }[], edges?: {
         id: string;
         edgeRelationship: string;
-        edgeObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
     }[], userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Update a graph vertex.
      * @param id The id of the vertex to update.
-     * @param vertexObject The object for the vertex as JSON-LD.
+     * @param annotationObject The annotation object for the vertex as JSON-LD.
      * @param aliases Alternative aliases that can be used to identify the vertex.
      * @param resources The resources attached to the vertex.
      * @param edges The edges connected to the vertex.
@@ -41,17 +41,17 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    update(id: string, vertexObject?: IJsonLdNodeObject, aliases?: {
+    update(id: string, annotationObject?: IJsonLdNodeObject, aliases?: {
         id: string;
         aliasFormat?: string;
-        aliasObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
     }[], resources?: {
-        id: string;
+        id?: string;
         resourceObject?: IJsonLdNodeObject;
     }[], edges?: {
         id: string;
         edgeRelationship: string;
-        edgeObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
     }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Get a graph vertex.
@@ -81,6 +81,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
      * @param options The query options.
      * @param options.id The optional id to look for.
      * @param options.idMode Look in id, alias or both, defaults to both.
+     * @param conditions Conditions to use in the query.
      * @param orderBy The order for the results, defaults to dateCreated.
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param properties The properties to return, if not provided defaults to id, dateCreated, aliases and object.
@@ -91,5 +92,5 @@ export interface IAuditableItemGraphComponent extends IComponent {
     query(options?: {
         id?: string;
         idMode?: "id" | "alias" | "both";
-    }, orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+    }, conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
 }

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

@@ -9,14 +9,18 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
      * JSON-LD Context.
      */
     "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
     /**
      * JSON-LD Type.
      */
     type: typeof AuditableItemGraphTypes.Edge;
     /**
-     * The JSON-LD object for the edge.
+     * The JSON-LD annotation object for the edge.
      */
-    edgeObject?: IJsonLdNodeObject;
+    annotationObject?: IJsonLdNodeObject;
     /**
      * The relationship between the two vertices.
      */

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

@@ -13,6 +13,10 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * JSON-LD Context.
      */
     "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    /**
+     * The id of the element.
+     */
+    id: string;
     /**
      * JSON-LD Type.
      */
@@ -22,9 +26,9 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      */
     nodeIdentity?: string;
     /**
-     * The JSON-LD object for the vertex.
+     * The JSON-LD annotation object for the vertex.
      */
-    vertexObject?: IJsonLdNodeObject;
+    annotationObject?: IJsonLdNodeObject;
     /**
      * Alternative aliases that can be used to identify the vertex.
      */

package/dist/types/models/api/IAuditableItemGraphCreateRequest.d.ts

@@ -10,20 +10,20 @@ export interface IAuditableItemGraphCreateRequest {
         /**
          * The object to be used in the vertex as JSON-LD.
          */
-        vertexObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
         /**
          * Alternative aliases that can be used to identify the vertex.
          */
         aliases?: {
             id: string;
             aliasFormat?: string;
-            aliasObject?: IJsonLdNodeObject;
+            annotationObject?: IJsonLdNodeObject;
         }[];
         /**
          * The resources attached to the vertex.
          */
         resources?: {
-            id: string;
+            id?: string;
             resourceObject?: IJsonLdNodeObject;
         }[];
         /**
@@ -32,7 +32,7 @@ export interface IAuditableItemGraphCreateRequest {
         edges?: {
             id: string;
             edgeRelationship: string;
-            edgeObject?: IJsonLdNodeObject;
+            annotationObject?: IJsonLdNodeObject;
         }[];
     };
 }

package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts

@@ -23,6 +23,10 @@ export interface IAuditableItemGraphListRequest {
          * Which field to look in with the id, defaults to both.
          */
         idMode?: "id" | "alias" | "both";
+        /**
+         * The conditions to filter the streams, JSON stringified IComparator[].
+         */
+        conditions?: string;
         /**
          * The order for the results, default to dateCreated.
          */
@@ -32,7 +36,7 @@ export interface IAuditableItemGraphListRequest {
          */
         orderByDirection?: SortDirection;
         /**
-         * The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,vertexObject".
+         * The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
          */
         properties?: string;
         /**

package/dist/types/models/api/IAuditableItemGraphUpdateRequest.d.ts

@@ -19,20 +19,20 @@ export interface IAuditableItemGraphUpdateRequest {
         /**
          * The object to be used in the vertex as JSON-LD.
          */
-        vertexObject?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
         /**
          * Alternative aliases that can be used to identify the vertex.
          */
         aliases?: {
             id: string;
             aliasFormat?: string;
-            aliasObject?: IJsonLdNodeObject;
+            annotationObject?: IJsonLdNodeObject;
         }[];
         /**
          * The resources attached to the vertex.
          */
         resources?: {
-            id: string;
+            id?: string;
             resourceObject?: IJsonLdNodeObject;
         }[];
         /**
@@ -41,7 +41,7 @@ export interface IAuditableItemGraphUpdateRequest {
         edges?: {
             id: string;
             edgeRelationship: string;
-            edgeObject?: IJsonLdNodeObject;
+            annotationObject?: IJsonLdNodeObject;
         }[];
     };
 }

package/docs/changelog.md

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

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -16,6 +16,18 @@ JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphAlias"`
@@ -24,11 +36,11 @@ JSON-LD Type.
 
 ***
 
-### aliasObject?
+### annotationObject?
 
-> `optional` **aliasObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the alias.
+The JSON-LD annotation object for the alias.
 
 ***
 
@@ -40,18 +52,6 @@ The format of the id in the alias.
 
 ***
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
-
-***
-
 ### dateCreated
 
 > **dateCreated**: `string`

package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md

@@ -10,9 +10,9 @@ Interface describing the base properties for auditable elements.
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,17 +10,17 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-##### vertexObject?
+##### annotationObject?
 
 `IJsonLdNodeObject`
 
-The object for the vertex as JSON-LD.
+The annotation object for the vertex as JSON-LD.
 
 ##### aliases?
 
@@ -62,7 +62,7 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`id`, `vertexObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Update a graph vertex.
 
@@ -74,11 +74,11 @@ Update a graph vertex.
 
 The id of the vertex to update.
 
-##### vertexObject?
+##### annotationObject?
 
 `IJsonLdNodeObject`
 
-The object for the vertex as JSON-LD.
+The annotation object for the vertex as JSON-LD.
 
 ##### aliases?
 
@@ -200,7 +200,7 @@ NotFoundError if the vertex is not found.
 
 ### query()
 
-> **query**(`options`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
+> **query**(`options`?, `conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
 
 Query the graph for vertices.
 
@@ -222,6 +222,12 @@ The optional id to look for.
 
 Look in id, alias or both, defaults to both.
 
+##### conditions?
+
+`IComparator`[]
+
+Conditions to use in the query.
+
 ##### orderBy?
 
 The order for the results, defaults to dateCreated.

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -10,9 +10,9 @@ Create an auditable item graph vertex.
 
 The data to be used in the vertex.
 
-#### vertexObject?
+#### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The object to be used in the vertex as JSON-LD.
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -8,18 +8,6 @@ Interface describing an edge between two vertices in an auditable item graph.
 
 ## Properties
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
-
-***
-
 ### dateCreated
 
 > **dateCreated**: `string`
@@ -64,6 +52,18 @@ JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphEdge"`
@@ -72,11 +72,11 @@ JSON-LD Type.
 
 ***
 
-### edgeObject?
+### annotationObject?
 
-> `optional` **edgeObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the edge.
+The JSON-LD annotation object for the edge.
 
 ***
 

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -34,6 +34,12 @@ The id or alias to try and find.
 
 Which field to look in with the id, defaults to both.
 
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The conditions to filter the streams, JSON stringified IComparator[].
+
 #### orderBy?
 
 > `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
@@ -50,7 +56,7 @@ The direction for the order, defaults to desc.
 
 > `optional` **properties**: `string`
 
-The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,vertexObject".
+The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
 
 #### cursor?
 

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -8,9 +8,9 @@ Interface describing an auditable item graph vertex resource.
 
 ## Properties
 
-### id
+### id?
 
-> **id**: `string`
+> `optional` **id**: `string`
 
 The id of the element.
 

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -24,9 +24,9 @@ The id of the vertex to update.
 
 The data to be used in the vertex.
 
-#### vertexObject?
+#### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The object to be used in the vertex as JSON-LD.
 

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -8,18 +8,6 @@ Interface describing an auditable item graph vertex.
 
 ## Properties
 
-### id
-
-> **id**: `string`
-
-The id of the element.
-
-#### Inherited from
-
-`Omit.id`
-
-***
-
 ### dateCreated
 
 > **dateCreated**: `string`
@@ -64,6 +52,18 @@ JSON-LD Context.
 
 ***
 
+### id
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+`Omit.id`
+
+***
+
 ### type
 
 > **type**: `"AuditableItemGraphVertex"`
@@ -80,11 +80,11 @@ The identity of the node which controls the vertex.
 
 ***
 
-### vertexObject?
+### annotationObject?
 
-> `optional` **vertexObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The JSON-LD object for the vertex.
+The JSON-LD annotation object for the vertex.
 
 ***
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.1-next.16",
+	"version": "0.0.1-next.18",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",
@@ -27,9 +27,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},