@twin.org/auditable-item-graph-models 0.0.1-next.19 → 0.0.1-next.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/dist/cjs/index.cjs +9 -13
  2. package/dist/esm/index.mjs +9 -13
  3. package/dist/types/models/IAuditableItemGraphAlias.d.ts +2 -2
  4. package/dist/types/models/IAuditableItemGraphAuditedElement.d.ts +1 -1
  5. package/dist/types/models/IAuditableItemGraphChangeset.d.ts +2 -1
  6. package/dist/types/models/IAuditableItemGraphComponent.d.ts +43 -30
  7. package/dist/types/models/IAuditableItemGraphEdge.d.ts +2 -2
  8. package/dist/types/models/IAuditableItemGraphPatchOperation.d.ts +2 -1
  9. package/dist/types/models/IAuditableItemGraphResource.d.ts +2 -2
  10. package/dist/types/models/IAuditableItemGraphVertex.d.ts +2 -2
  11. package/dist/types/models/IAuditableItemGraphVertexList.d.ts +2 -1
  12. package/dist/types/models/api/IAuditableItemGraphCreateRequest.d.ts +1 -1
  13. package/dist/types/models/api/IAuditableItemGraphUpdateRequest.d.ts +1 -1
  14. package/docs/changelog.md +1 -1
  15. package/docs/reference/interfaces/IAuditableItemGraphAlias.md +3 -3
  16. package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md +2 -2
  17. package/docs/reference/interfaces/IAuditableItemGraphChangeset.md +1 -1
  18. package/docs/reference/interfaces/IAuditableItemGraphComponent.md +19 -11
  19. package/docs/reference/interfaces/IAuditableItemGraphCreateRequest.md +2 -2
  20. package/docs/reference/interfaces/IAuditableItemGraphEdge.md +3 -3
  21. package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md +1 -1
  22. package/docs/reference/interfaces/IAuditableItemGraphResource.md +3 -3
  23. package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md +2 -2
  24. package/docs/reference/interfaces/IAuditableItemGraphVertex.md +3 -3
  25. package/docs/reference/interfaces/IAuditableItemGraphVertexList.md +1 -1
  26. package/package.json +1 -1
@@ -77,7 +77,7 @@ var properties$6 = {
77
77
  }
78
78
  ],
79
79
  additionalItems: {
80
- type: "string"
80
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
81
81
  }
82
82
  }
83
83
  ],
@@ -99,7 +99,6 @@ var properties$6 = {
99
99
  };
100
100
  var required$6 = [
101
101
  "@context",
102
- "dateCreated",
103
102
  "id",
104
103
  "type"
105
104
  ];
@@ -131,7 +130,7 @@ var properties$5 = {
131
130
  }
132
131
  ],
133
132
  additionalItems: {
134
- type: "string"
133
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
135
134
  }
136
135
  }
137
136
  ],
@@ -222,7 +221,7 @@ var properties$4 = {
222
221
  }
223
222
  ],
224
223
  additionalItems: {
225
- type: "string"
224
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
226
225
  }
227
226
  }
228
227
  ],
@@ -244,10 +243,9 @@ var properties$4 = {
244
243
  };
245
244
  var required$4 = [
246
245
  "@context",
247
- "dateCreated",
248
- "edgeRelationship",
249
246
  "id",
250
- "type"
247
+ "type",
248
+ "edgeRelationship"
251
249
  ];
252
250
  var additionalProperties$4 = false;
253
251
  var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
@@ -277,7 +275,7 @@ var properties$3 = {
277
275
  }
278
276
  ],
279
277
  additionalItems: {
280
- type: "string"
278
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
281
279
  }
282
280
  }
283
281
  ],
@@ -362,7 +360,7 @@ var properties$2 = {
362
360
  }
363
361
  ],
364
362
  additionalItems: {
365
- type: "string"
363
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
366
364
  }
367
365
  }
368
366
  ],
@@ -380,7 +378,6 @@ var properties$2 = {
380
378
  };
381
379
  var required$2 = [
382
380
  "@context",
383
- "dateCreated",
384
381
  "type"
385
382
  ];
386
383
  var additionalProperties$2 = false;
@@ -427,7 +424,7 @@ var properties$1 = {
427
424
  }
428
425
  ],
429
426
  additionalItems: {
430
- type: "string"
427
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
431
428
  }
432
429
  }
433
430
  ],
@@ -481,7 +478,6 @@ var properties$1 = {
481
478
  };
482
479
  var required$1 = [
483
480
  "@context",
484
- "dateCreated",
485
481
  "id",
486
482
  "type"
487
483
  ];
@@ -513,7 +509,7 @@ var properties = {
513
509
  }
514
510
  ],
515
511
  additionalItems: {
516
- type: "string"
512
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
517
513
  }
518
514
  }
519
515
  ],
@@ -75,7 +75,7 @@ var properties$6 = {
75
75
  }
76
76
  ],
77
77
  additionalItems: {
78
- type: "string"
78
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
79
79
  }
80
80
  }
81
81
  ],
@@ -97,7 +97,6 @@ var properties$6 = {
97
97
  };
98
98
  var required$6 = [
99
99
  "@context",
100
- "dateCreated",
101
100
  "id",
102
101
  "type"
103
102
  ];
@@ -129,7 +128,7 @@ var properties$5 = {
129
128
  }
130
129
  ],
131
130
  additionalItems: {
132
- type: "string"
131
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
133
132
  }
134
133
  }
135
134
  ],
@@ -220,7 +219,7 @@ var properties$4 = {
220
219
  }
221
220
  ],
222
221
  additionalItems: {
223
- type: "string"
222
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
224
223
  }
225
224
  }
226
225
  ],
@@ -242,10 +241,9 @@ var properties$4 = {
242
241
  };
243
242
  var required$4 = [
244
243
  "@context",
245
- "dateCreated",
246
- "edgeRelationship",
247
244
  "id",
248
- "type"
245
+ "type",
246
+ "edgeRelationship"
249
247
  ];
250
248
  var additionalProperties$4 = false;
251
249
  var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
@@ -275,7 +273,7 @@ var properties$3 = {
275
273
  }
276
274
  ],
277
275
  additionalItems: {
278
- type: "string"
276
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
279
277
  }
280
278
  }
281
279
  ],
@@ -360,7 +358,7 @@ var properties$2 = {
360
358
  }
361
359
  ],
362
360
  additionalItems: {
363
- type: "string"
361
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
364
362
  }
365
363
  }
366
364
  ],
@@ -378,7 +376,6 @@ var properties$2 = {
378
376
  };
379
377
  var required$2 = [
380
378
  "@context",
381
- "dateCreated",
382
379
  "type"
383
380
  ];
384
381
  var additionalProperties$2 = false;
@@ -425,7 +422,7 @@ var properties$1 = {
425
422
  }
426
423
  ],
427
424
  additionalItems: {
428
- type: "string"
425
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
429
426
  }
430
427
  }
431
428
  ],
@@ -479,7 +476,6 @@ var properties$1 = {
479
476
  };
480
477
  var required$1 = [
481
478
  "@context",
482
- "dateCreated",
483
479
  "id",
484
480
  "type"
485
481
  ];
@@ -511,7 +507,7 @@ var properties = {
511
507
  }
512
508
  ],
513
509
  additionalItems: {
514
- type: "string"
510
+ $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
515
511
  }
516
512
  }
517
513
  ],
@@ -1,4 +1,4 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
1
+ import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
3
3
  import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
4
4
  /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphAlias extends IAuditableItemGraphAuditedElem
8
8
  /**
9
9
  * JSON-LD Context.
10
10
  */
11
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
11
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
12
12
  /**
13
13
  * The id of the element.
14
14
  */
@@ -9,7 +9,7 @@ export interface IAuditableItemGraphAuditedElement {
9
9
  /**
10
10
  * The date/time of when the element was created.
11
11
  */
12
- dateCreated: string;
12
+ dateCreated?: string;
13
13
  /**
14
14
  * The date/time of when the element was modified.
15
15
  */
@@ -1,3 +1,4 @@
1
+ import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
1
2
  import type { IImmutableProofVerification } from "@twin.org/immutable-proof-models";
2
3
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
3
4
  import type { IAuditableItemGraphPatchOperation } from "./IAuditableItemGraphPatchOperation";
@@ -8,7 +9,7 @@ export interface IAuditableItemGraphChangeset {
8
9
  /**
9
10
  * JSON-LD Context.
10
11
  */
11
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
12
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
12
13
  /**
13
14
  * JSON-LD Type.
14
15
  */
@@ -10,49 +10,62 @@ import type { VerifyDepth } from "./verifyDepth";
10
10
  export interface IAuditableItemGraphComponent extends IComponent {
11
11
  /**
12
12
  * Create a new graph vertex.
13
- * @param annotationObject The annotation object for the vertex as JSON-LD.
14
- * @param aliases Alternative aliases that can be used to identify the vertex.
15
- * @param resources The resources attached to the vertex.
16
- * @param edges The edges connected to the vertex.
13
+ * @param vertex The vertex to create.
14
+ * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
15
+ * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
16
+ * @param vertex.resources The resources attached to the vertex.
17
+ * @param vertex.edges The edges connected to the vertex.
17
18
  * @param userIdentity The identity to create the auditable item graph operation with.
18
19
  * @param nodeIdentity The node identity to use for vault operations.
19
20
  * @returns The id of the new graph item.
20
21
  */
21
- create(annotationObject?: IJsonLdNodeObject, aliases?: {
22
- id: string;
23
- aliasFormat?: string;
24
- annotationObject?: IJsonLdNodeObject;
25
- }[], resources?: {
26
- id?: string;
27
- resourceObject?: IJsonLdNodeObject;
28
- }[], edges?: {
29
- id: string;
30
- edgeRelationship: string;
22
+ create(vertex: {
31
23
  annotationObject?: IJsonLdNodeObject;
32
- }[], userIdentity?: string, nodeIdentity?: string): Promise<string>;
24
+ aliases?: {
25
+ id: string;
26
+ aliasFormat?: string;
27
+ annotationObject?: IJsonLdNodeObject;
28
+ }[];
29
+ resources?: {
30
+ id?: string;
31
+ resourceObject?: IJsonLdNodeObject;
32
+ }[];
33
+ edges?: {
34
+ id: string;
35
+ edgeRelationship: string;
36
+ annotationObject?: IJsonLdNodeObject;
37
+ }[];
38
+ }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
33
39
  /**
34
40
  * Update a graph vertex.
35
- * @param id The id of the vertex to update.
36
- * @param annotationObject The annotation object for the vertex as JSON-LD.
37
- * @param aliases Alternative aliases that can be used to identify the vertex.
38
- * @param resources The resources attached to the vertex.
39
- * @param edges The edges connected to the vertex.
41
+ * @param vertex The vertex to update.
42
+ * @param vertex.id The id of the vertex to update.
43
+ * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.
44
+ * @param vertex.aliases Alternative aliases that can be used to identify the vertex.
45
+ * @param vertex.resources The resources attached to the vertex.
46
+ * @param vertex.edges The edges connected to the vertex.
40
47
  * @param userIdentity The identity to create the auditable item graph operation with.
41
48
  * @param nodeIdentity The node identity to use for vault operations.
42
49
  * @returns Nothing.
43
50
  */
44
- update(id: string, annotationObject?: IJsonLdNodeObject, aliases?: {
45
- id: string;
46
- aliasFormat?: string;
47
- annotationObject?: IJsonLdNodeObject;
48
- }[], resources?: {
49
- id?: string;
50
- resourceObject?: IJsonLdNodeObject;
51
- }[], edges?: {
51
+ update(vertex: {
52
52
  id: string;
53
- edgeRelationship: string;
54
53
  annotationObject?: IJsonLdNodeObject;
55
- }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
54
+ aliases?: {
55
+ id: string;
56
+ aliasFormat?: string;
57
+ annotationObject?: IJsonLdNodeObject;
58
+ }[];
59
+ resources?: {
60
+ id?: string;
61
+ resourceObject?: IJsonLdNodeObject;
62
+ }[];
63
+ edges?: {
64
+ id: string;
65
+ edgeRelationship: string;
66
+ annotationObject?: IJsonLdNodeObject;
67
+ }[];
68
+ }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
56
69
  /**
57
70
  * Get a graph vertex.
58
71
  * @param id The id of the vertex to get.
@@ -1,4 +1,4 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
1
+ import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
3
3
  import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
4
4
  /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
8
8
  /**
9
9
  * JSON-LD Context.
10
10
  */
11
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
11
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
12
12
  /**
13
13
  * The id of the element.
14
14
  */
@@ -1,3 +1,4 @@
1
+ import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
1
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
2
3
  /**
3
4
  * The patch operation for JSON diffs.
@@ -6,7 +7,7 @@ export interface IAuditableItemGraphPatchOperation {
6
7
  /**
7
8
  * JSON-LD Context.
8
9
  */
9
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
10
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
10
11
  /**
11
12
  * JSON-LD Type.
12
13
  */
@@ -1,4 +1,4 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
1
+ import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
3
3
  import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
4
4
  /**
@@ -8,7 +8,7 @@ export interface IAuditableItemGraphResource extends IAuditableItemGraphAuditedE
8
8
  /**
9
9
  * JSON-LD Context.
10
10
  */
11
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
11
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
12
12
  /**
13
13
  * JSON-LD Type.
14
14
  */
@@ -1,4 +1,4 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
1
+ import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
3
3
  import type { IAuditableItemGraphAlias } from "./IAuditableItemGraphAlias";
4
4
  import type { IAuditableItemGraphAuditedElement } from "./IAuditableItemGraphAuditedElement";
@@ -12,7 +12,7 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
12
12
  /**
13
13
  * JSON-LD Context.
14
14
  */
15
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
15
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
16
16
  /**
17
17
  * The id of the element.
18
18
  */
@@ -1,3 +1,4 @@
1
+ import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
1
2
  import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
2
3
  import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
3
4
  /**
@@ -7,7 +8,7 @@ export interface IAuditableItemGraphVertexList {
7
8
  /**
8
9
  * JSON-LD Context.
9
10
  */
10
- "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...string[]];
11
+ "@context": typeof AuditableItemGraphTypes.ContextRoot | [typeof AuditableItemGraphTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
11
12
  /**
12
13
  * JSON-LD Type.
13
14
  */
@@ -6,7 +6,7 @@ export interface IAuditableItemGraphCreateRequest {
6
6
  /**
7
7
  * The data to be used in the vertex.
8
8
  */
9
- body?: {
9
+ body: {
10
10
  /**
11
11
  * The object to be used in the vertex as JSON-LD.
12
12
  */
@@ -15,7 +15,7 @@ export interface IAuditableItemGraphUpdateRequest {
15
15
  /**
16
16
  * The data to be used in the vertex.
17
17
  */
18
- body?: {
18
+ body: {
19
19
  /**
20
20
  * The object to be used in the vertex as JSON-LD.
21
21
  */
package/docs/changelog.md CHANGED
@@ -1,5 +1,5 @@
1
1
  # @twin.org/auditable-item-graph-models - Changelog
2
2
 
3
- ## v0.0.1-next.19
3
+ ## v0.0.1-next.21
4
4
 
5
5
  - Initial Release
@@ -10,7 +10,7 @@ Interface describing an alias for a vertex.
10
10
 
11
11
  ### @context
12
12
 
13
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
13
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
14
14
 
15
15
  JSON-LD Context.
16
16
 
@@ -52,9 +52,9 @@ The format of the id in the alias.
52
52
 
53
53
  ***
54
54
 
55
- ### dateCreated
55
+ ### dateCreated?
56
56
 
57
- > **dateCreated**: `string`
57
+ > `optional` **dateCreated**: `string`
58
58
 
59
59
  The date/time of when the element was created.
60
60
 
@@ -18,9 +18,9 @@ The id of the element.
18
18
 
19
19
  ***
20
20
 
21
- ### dateCreated
21
+ ### dateCreated?
22
22
 
23
- > **dateCreated**: `string`
23
+ > `optional` **dateCreated**: `string`
24
24
 
25
25
  The date/time of when the element was created.
26
26
 
@@ -6,7 +6,7 @@ Interface describing a set of updates to the vertex.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
9
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -10,31 +10,35 @@ Interface describing an auditable item graph contract.
10
10
 
11
11
  ### create()
12
12
 
13
- > **create**(`annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
13
+ > **create**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
14
14
 
15
15
  Create a new graph vertex.
16
16
 
17
17
  #### Parameters
18
18
 
19
- ##### annotationObject?
19
+ ##### vertex
20
+
21
+ The vertex to create.
22
+
23
+ ###### annotationObject?
20
24
 
21
25
  `IJsonLdNodeObject`
22
26
 
23
27
  The annotation object for the vertex as JSON-LD.
24
28
 
25
- ##### aliases?
29
+ ###### aliases?
26
30
 
27
31
  `object`[]
28
32
 
29
33
  Alternative aliases that can be used to identify the vertex.
30
34
 
31
- ##### resources?
35
+ ###### resources?
32
36
 
33
37
  `object`[]
34
38
 
35
39
  The resources attached to the vertex.
36
40
 
37
- ##### edges?
41
+ ###### edges?
38
42
 
39
43
  `object`[]
40
44
 
@@ -62,37 +66,41 @@ The id of the new graph item.
62
66
 
63
67
  ### update()
64
68
 
65
- > **update**(`id`, `annotationObject`?, `aliases`?, `resources`?, `edges`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
69
+ > **update**(`vertex`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
66
70
 
67
71
  Update a graph vertex.
68
72
 
69
73
  #### Parameters
70
74
 
71
- ##### id
75
+ ##### vertex
76
+
77
+ The vertex to update.
78
+
79
+ ###### id
72
80
 
73
81
  `string`
74
82
 
75
83
  The id of the vertex to update.
76
84
 
77
- ##### annotationObject?
85
+ ###### annotationObject?
78
86
 
79
87
  `IJsonLdNodeObject`
80
88
 
81
89
  The annotation object for the vertex as JSON-LD.
82
90
 
83
- ##### aliases?
91
+ ###### aliases?
84
92
 
85
93
  `object`[]
86
94
 
87
95
  Alternative aliases that can be used to identify the vertex.
88
96
 
89
- ##### resources?
97
+ ###### resources?
90
98
 
91
99
  `object`[]
92
100
 
93
101
  The resources attached to the vertex.
94
102
 
95
- ##### edges?
103
+ ###### edges?
96
104
 
97
105
  `object`[]
98
106
 
@@ -4,9 +4,9 @@ Create an auditable item graph vertex.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body?
7
+ ### body
8
8
 
9
- > `optional` **body**: `object`
9
+ > **body**: `object`
10
10
 
11
11
  The data to be used in the vertex.
12
12
 
@@ -8,9 +8,9 @@ Interface describing an edge between two vertices in an auditable item graph.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### dateCreated
11
+ ### dateCreated?
12
12
 
13
- > **dateCreated**: `string`
13
+ > `optional` **dateCreated**: `string`
14
14
 
15
15
  The date/time of when the element was created.
16
16
 
@@ -46,7 +46,7 @@ The date/time of when the element was deleted, as we never actually remove items
46
46
 
47
47
  ### @context
48
48
 
49
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
49
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
50
50
 
51
51
  JSON-LD Context.
52
52
 
@@ -6,7 +6,7 @@ The patch operation for JSON diffs.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
9
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -20,9 +20,9 @@ The id of the element.
20
20
 
21
21
  ***
22
22
 
23
- ### dateCreated
23
+ ### dateCreated?
24
24
 
25
- > **dateCreated**: `string`
25
+ > `optional` **dateCreated**: `string`
26
26
 
27
27
  The date/time of when the element was created.
28
28
 
@@ -58,7 +58,7 @@ The date/time of when the element was deleted, as we never actually remove items
58
58
 
59
59
  ### @context
60
60
 
61
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
61
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
62
62
 
63
63
  JSON-LD Context.
64
64
 
@@ -18,9 +18,9 @@ The id of the vertex to update.
18
18
 
19
19
  ***
20
20
 
21
- ### body?
21
+ ### body
22
22
 
23
- > `optional` **body**: `object`
23
+ > **body**: `object`
24
24
 
25
25
  The data to be used in the vertex.
26
26
 
@@ -8,9 +8,9 @@ Interface describing an auditable item graph vertex.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### dateCreated
11
+ ### dateCreated?
12
12
 
13
- > **dateCreated**: `string`
13
+ > `optional` **dateCreated**: `string`
14
14
 
15
15
  The date/time of when the element was created.
16
16
 
@@ -46,7 +46,7 @@ The date/time of when the element was deleted, as we never actually remove items
46
46
 
47
47
  ### @context
48
48
 
49
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
49
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
50
50
 
51
51
  JSON-LD Context.
52
52
 
@@ -6,7 +6,7 @@ Interface describing an auditable item graph vertex list.
6
6
 
7
7
  ### @context
8
8
 
9
- > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...string[]`\]
9
+ > **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/auditable-item-graph-models",
3
- "version": "0.0.1-next.19",
3
+ "version": "0.0.1-next.21",
4
4
  "description": "Models which define the structure of the auditable item graph connectors and services",
5
5
  "repository": {
6
6
  "type": "git",