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

package/dist/cjs/index.cjs

@@ -77,7 +77,7 @@ var properties$6 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -131,7 +131,7 @@ var properties$5 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -222,7 +222,7 @@ var properties$4 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -277,7 +277,7 @@ var properties$3 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -362,7 +362,7 @@ var properties$2 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -427,7 +427,7 @@ var properties$1 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -513,7 +513,7 @@ var properties = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],

package/dist/esm/index.mjs

@@ -75,7 +75,7 @@ var properties$6 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -129,7 +129,7 @@ var properties$5 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -220,7 +220,7 @@ var properties$4 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -275,7 +275,7 @@ var properties$3 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -360,7 +360,7 @@ var properties$2 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -425,7 +425,7 @@ var properties$1 = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],
@@ -511,7 +511,7 @@ var properties = {
 					}
 				],
 				additionalItems: {
-					type: "string"
+					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
 				}
 			}
 		],

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

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */

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

@@ -1,3 +1,4 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { IImmutableProofVerification } from "@twin.org/immutable-proof-models";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation";
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphChangeset {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -10,49 +10,62 @@ import type { VerifyDepth } from "./verifyDepth";
 export interface IAuditableItemGraphComponent extends IComponent {
     /**
      * Create a new graph vertex.
-     * @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.
+     * @param vertex The vertex to create.
+     * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
+     * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
+     * @param vertex.resources The resources attached to the vertex.
+     * @param vertex.edges The edges connected to the vertex.
      * @param userIdentity The identity to create the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns The id of the new graph item.
      */
-    create(annotationObject?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        aliasFormat?: string;
-        annotationObject?: IJsonLdNodeObject;
-    }[], resources?: {
-        id?: string;
-        resourceObject?: IJsonLdNodeObject;
-    }[], edges?: {
-        id: string;
-        edgeRelationship: string;
+    create(vertex: {
         annotationObject?: IJsonLdNodeObject;
-    }[], userIdentity?: string, nodeIdentity?: string): Promise<string>;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Update a graph vertex.
-     * @param id The id of the vertex to update.
-     * @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.
+     * @param vertex The vertex to update.
+     * @param vertex.id The id of the vertex to update.
+     * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
+     * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
+     * @param vertex.resources The resources attached to the vertex.
+     * @param vertex.edges The edges connected to the vertex.
      * @param userIdentity The identity to create the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    update(id: string, annotationObject?: IJsonLdNodeObject, aliases?: {
-        id: string;
-        aliasFormat?: string;
-        annotationObject?: IJsonLdNodeObject;
-    }[], resources?: {
-        id?: string;
-        resourceObject?: IJsonLdNodeObject;
-    }[], edges?: {
+    update(vertex: {
         id: string;
-        edgeRelationship: string;
         annotationObject?: IJsonLdNodeObject;
-    }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
+        aliases?: {
+            id: string;
+            aliasFormat?: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+        resources?: {
+            id?: string;
+            resourceObject?: IJsonLdNodeObject;
+        }[];
+        edges?: {
+            id: string;
+            edgeRelationship: string;
+            annotationObject?: IJsonLdNodeObject;
+        }[];
+    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Get a graph vertex.
      * @param id The id of the vertex to get.

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

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */

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

@@ -1,3 +1,4 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 /**
  * The patch operation for JSON diffs.
@@ -6,7 +7,7 @@ export interface IAuditableItemGraphPatchOperation {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
 /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -1,4 +1,4 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias";
 import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
@@ -12,7 +12,7 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * The id of the element.
      */

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

@@ -1,3 +1,4 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
 import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
 /**
@@ -7,7 +8,7 @@ export interface IAuditableItemGraphVertexList {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
+    "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
     /**
      * JSON-LD Type.
      */

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

@@ -6,7 +6,7 @@ export interface IAuditableItemGraphCreateRequest {
     /**
      * The data to be used in the vertex.
      */
-    body?: {
+    body: {
         /**
          * The object to be used in the vertex as JSON-LD.
          */

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

@@ -15,7 +15,7 @@ export interface IAuditableItemGraphUpdateRequest {
     /**
      * The data to be used in the vertex.
      */
-    body?: {
+    body: {
         /**
          * The object to be used in the vertex as JSON-LD.
          */

package/docs/changelog.md

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

package/docs/reference/interfaces/IAuditableItemGraphAlias.md

@@ -10,7 +10,7 @@ Interface describing an alias for a vertex.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -6,7 +6,7 @@ Interface describing a set of updates to the vertex.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -10,31 +10,35 @@ Interface describing an auditable item graph contract.
 
 ### create()
 
-> **create**(`annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Create a new graph vertex.
 
 #### Parameters
 
-##### annotationObject?
+##### vertex
+
+The vertex to create.
+
+###### annotationObject?
 
 `IJsonLdNodeObject`
 
 The annotation object for the vertex as JSON-LD.
 
-##### aliases?
+###### aliases?
 
 `object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-##### resources?
+###### resources?
 
 `object`[]
 
 The resources attached to the vertex.
 
-##### edges?
+###### edges?
 
 `object`[]
 
@@ -62,37 +66,41 @@ The id of the new graph item.
 
 ### update()
 
-> **update**(`id`, `annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Update a graph vertex.
 
 #### Parameters
 
-##### id
+##### vertex
+
+The vertex to update.
+
+###### id
 
 `string`
 
 The id of the vertex to update.
 
-##### annotationObject?
+###### annotationObject?
 
 `IJsonLdNodeObject`
 
 The annotation object for the vertex as JSON-LD.
 
-##### aliases?
+###### aliases?
 
 `object`[]
 
 Alternative aliases that can be used to identify the vertex.
 
-##### resources?
+###### resources?
 
 `object`[]
 
 The resources attached to the vertex.
 
-##### edges?
+###### edges?
 
 `object`[]
 
@@ -136,19 +144,19 @@ The id of the vertex to get.
 
 Additional options for the get operation.
 
-###### includeDeleted
+###### includeDeleted?
 
 `boolean`
 
 Whether to include deleted aliases, resource, edges, defaults to false.
 
-###### includeChangesets
+###### includeChangesets?
 
 `boolean`
 
 Whether to include the changesets of the vertex, defaults to false.
 
-###### verifySignatureDepth
+###### verifySignatureDepth?
 
 [`VerifyDepth`](../type-aliases/VerifyDepth.md)
 
@@ -210,13 +218,13 @@ Query the graph for vertices.
 
 The query options.
 
-###### id
+###### id?
 
 `string`
 
 The optional id to look for.
 
-###### idMode
+###### idMode?
 
 `"both"` \| `"id"` \| `"alias"`
 

package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md

@@ -4,9 +4,9 @@ Create an auditable item graph vertex.
 
 ## Properties
 
-### body?
+### body
 
-> `optional` **body**: `object`
+> **body**: `object`
 
 The data to be used in the vertex.
 

package/docs/reference/interfaces/IAuditableItemGraphEdge.md

@@ -46,7 +46,7 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -6,7 +6,7 @@ The patch operation for JSON diffs.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -58,7 +58,7 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -18,9 +18,9 @@ The id of the vertex to update.
 
 ***
 
-### body?
+### body
 
-> `optional` **body**: `object`
+> **body**: `object`
 
 The data to be used in the vertex.
 

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -46,7 +46,7 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -6,7 +6,7 @@ Interface describing an auditable item graph vertex list.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
+> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/package.json

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