@twin.org/auditable-item-graph-models 0.0.1-next.38 → 0.0.1-next.39

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.
@@ -32,15 +32,11 @@ const AuditableItemGraphTypes = {
32
32
  /**
33
33
  * Represents patch operation.
34
34
  */
35
- PatchOperation: "AuditableItemGraphPatchOperation",
36
- /**
37
- * Represents auditable item stream vertex list.
38
- */
39
- VertexList: "AuditableItemGraphVertexList"
35
+ PatchOperation: "AuditableItemGraphPatchOperation"
40
36
  };
41
37
 
42
- var type$6 = "object";
43
- var properties$6 = {
38
+ var type$5 = "object";
39
+ var properties$5 = {
44
40
  id: {
45
41
  type: "string",
46
42
  description: "The id of the element."
@@ -93,23 +89,23 @@ var properties$6 = {
93
89
  description: "The format of the id in the alias."
94
90
  }
95
91
  };
96
- var required$6 = [
92
+ var required$5 = [
97
93
  "@context",
98
94
  "id",
99
95
  "type"
100
96
  ];
101
- var additionalProperties$6 = false;
102
- var description$6 = "Interface describing an alias for a vertex.";
97
+ var additionalProperties$5 = false;
98
+ var description$5 = "Interface describing an alias for a vertex.";
103
99
  var AuditableItemGraphAliasSchema = {
104
- type: type$6,
105
- properties: properties$6,
106
- required: required$6,
107
- additionalProperties: additionalProperties$6,
108
- description: description$6
100
+ type: type$5,
101
+ properties: properties$5,
102
+ required: required$5,
103
+ additionalProperties: additionalProperties$5,
104
+ description: description$5
109
105
  };
110
106
 
111
- var type$5 = "object";
112
- var properties$5 = {
107
+ var type$4 = "object";
108
+ var properties$4 = {
113
109
  "@context": {
114
110
  type: "array",
115
111
  minItems: 2,
@@ -161,7 +157,7 @@ var properties$5 = {
161
157
  description: "The verification for the changeset."
162
158
  }
163
159
  };
164
- var required$5 = [
160
+ var required$4 = [
165
161
  "@context",
166
162
  "type",
167
163
  "id",
@@ -169,18 +165,18 @@ var required$5 = [
169
165
  "userIdentity",
170
166
  "patches"
171
167
  ];
172
- var additionalProperties$5 = false;
173
- var description$5 = "Interface describing a set of changes to the vertex.";
168
+ var additionalProperties$4 = false;
169
+ var description$4 = "Interface describing a set of changes to the vertex.";
174
170
  var AuditableItemGraphChangesetSchema = {
175
- type: type$5,
176
- properties: properties$5,
177
- required: required$5,
178
- additionalProperties: additionalProperties$5,
179
- description: description$5
171
+ type: type$4,
172
+ properties: properties$4,
173
+ required: required$4,
174
+ additionalProperties: additionalProperties$4,
175
+ description: description$4
180
176
  };
181
177
 
182
- var type$4 = "object";
183
- var properties$4 = {
178
+ var type$3 = "object";
179
+ var properties$3 = {
184
180
  id: {
185
181
  type: "string",
186
182
  description: "The id of the element."
@@ -236,24 +232,24 @@ var properties$4 = {
236
232
  description: "The relationships between the two vertices."
237
233
  }
238
234
  };
239
- var required$4 = [
235
+ var required$3 = [
240
236
  "@context",
241
237
  "id",
242
238
  "type",
243
239
  "edgeRelationships"
244
240
  ];
245
- var additionalProperties$4 = false;
246
- var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
241
+ var additionalProperties$3 = false;
242
+ var description$3 = "Interface describing an edge between two vertices in an auditable item graph.";
247
243
  var AuditableItemGraphEdgeSchema = {
248
- type: type$4,
249
- properties: properties$4,
250
- required: required$4,
251
- additionalProperties: additionalProperties$4,
252
- description: description$4
244
+ type: type$3,
245
+ properties: properties$3,
246
+ required: required$3,
247
+ additionalProperties: additionalProperties$3,
248
+ description: description$3
253
249
  };
254
250
 
255
- var type$3 = "object";
256
- var properties$3 = {
251
+ var type$2 = "object";
252
+ var properties$2 = {
257
253
  "@context": {
258
254
  anyOf: [
259
255
  {
@@ -305,24 +301,24 @@ var properties$3 = {
305
301
  description: "The value to add."
306
302
  }
307
303
  };
308
- var required$3 = [
304
+ var required$2 = [
309
305
  "@context",
310
306
  "type",
311
307
  "patchOperation",
312
308
  "patchPath"
313
309
  ];
314
- var additionalProperties$3 = false;
315
- var description$3 = "The patch operation for JSON diffs.";
310
+ var additionalProperties$2 = false;
311
+ var description$2 = "The patch operation for JSON diffs.";
316
312
  var AuditableItemGraphPatchOperationSchema = {
317
- type: type$3,
318
- properties: properties$3,
319
- required: required$3,
320
- additionalProperties: additionalProperties$3,
321
- description: description$3
313
+ type: type$2,
314
+ properties: properties$2,
315
+ required: required$2,
316
+ additionalProperties: additionalProperties$2,
317
+ description: description$2
322
318
  };
323
319
 
324
- var type$2 = "object";
325
- var properties$2 = {
320
+ var type$1 = "object";
321
+ var properties$1 = {
326
322
  id: {
327
323
  type: "string",
328
324
  description: "The id of the element."
@@ -371,22 +367,22 @@ var properties$2 = {
371
367
  description: "The JSON-LD object for the resource."
372
368
  }
373
369
  };
374
- var required$2 = [
370
+ var required$1 = [
375
371
  "@context",
376
372
  "type"
377
373
  ];
378
- var additionalProperties$2 = false;
379
- var description$2 = "Interface describing an auditable item graph vertex resource.";
374
+ var additionalProperties$1 = false;
375
+ var description$1 = "Interface describing an auditable item graph vertex resource.";
380
376
  var AuditableItemGraphResourceSchema = {
381
- type: type$2,
382
- properties: properties$2,
383
- required: required$2,
384
- additionalProperties: additionalProperties$2,
385
- description: description$2
377
+ type: type$1,
378
+ properties: properties$1,
379
+ required: required$1,
380
+ additionalProperties: additionalProperties$1,
381
+ description: description$1
386
382
  };
387
383
 
388
- var type$1 = "object";
389
- var properties$1 = {
384
+ var type = "object";
385
+ var properties = {
390
386
  id: {
391
387
  type: "string",
392
388
  description: "The id of the element."
@@ -467,70 +463,14 @@ var properties$1 = {
467
463
  description: "Is the vertex verified, will only be populated when verification is requested."
468
464
  }
469
465
  };
470
- var required$1 = [
466
+ var required = [
471
467
  "@context",
472
468
  "id",
473
469
  "type"
474
470
  ];
475
- var additionalProperties$1 = false;
476
- var description$1 = "Interface describing an auditable item graph vertex.";
477
- var AuditableItemGraphVertexSchema = {
478
- type: type$1,
479
- properties: properties$1,
480
- required: required$1,
481
- additionalProperties: additionalProperties$1,
482
- description: description$1
483
- };
484
-
485
- var type = "object";
486
- var properties = {
487
- "@context": {
488
- anyOf: [
489
- {
490
- type: "string",
491
- "const": "https://schema.twindev.org/aig/"
492
- },
493
- {
494
- type: "array",
495
- minItems: 1,
496
- items: [
497
- {
498
- type: "string",
499
- "const": "https://schema.twindev.org/aig/"
500
- }
501
- ],
502
- additionalItems: {
503
- $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
504
- }
505
- }
506
- ],
507
- description: "JSON-LD Context."
508
- },
509
- type: {
510
- type: "string",
511
- "const": "AuditableItemGraphVertexList",
512
- description: "JSON-LD Type."
513
- },
514
- vertices: {
515
- type: "array",
516
- items: {
517
- $ref: "https://schema.twindev.org/aig/AuditableItemGraphVertex"
518
- },
519
- description: "The list of vertices."
520
- },
521
- cursor: {
522
- type: "string",
523
- description: "The cursor to get the next chunk of vertices."
524
- }
525
- };
526
- var required = [
527
- "@context",
528
- "type",
529
- "vertices"
530
- ];
531
471
  var additionalProperties = false;
532
- var description = "Interface describing an auditable item graph vertex list.";
533
- var AuditableItemGraphVertexListSchema = {
472
+ var description = "Interface describing an auditable item graph vertex.";
473
+ var AuditableItemGraphVertexSchema = {
534
474
  type: type,
535
475
  properties: properties,
536
476
  required: required,
@@ -578,11 +518,6 @@ class AuditableItemGraphDataTypes {
578
518
  defaultValue: {},
579
519
  jsonSchema: async () => AuditableItemGraphPatchOperationSchema
580
520
  }));
581
- dataCore.DataTypeHandlerFactory.register(AuditableItemGraphTypes.VertexList, () => ({
582
- type: AuditableItemGraphTypes.VertexList,
583
- defaultValue: {},
584
- jsonSchema: async () => AuditableItemGraphVertexListSchema
585
- }));
586
521
  }
587
522
  }
588
523
 
@@ -30,15 +30,11 @@ const AuditableItemGraphTypes = {
30
30
  /**
31
31
  * Represents patch operation.
32
32
  */
33
- PatchOperation: "AuditableItemGraphPatchOperation",
34
- /**
35
- * Represents auditable item stream vertex list.
36
- */
37
- VertexList: "AuditableItemGraphVertexList"
33
+ PatchOperation: "AuditableItemGraphPatchOperation"
38
34
  };
39
35
 
40
- var type$6 = "object";
41
- var properties$6 = {
36
+ var type$5 = "object";
37
+ var properties$5 = {
42
38
  id: {
43
39
  type: "string",
44
40
  description: "The id of the element."
@@ -91,23 +87,23 @@ var properties$6 = {
91
87
  description: "The format of the id in the alias."
92
88
  }
93
89
  };
94
- var required$6 = [
90
+ var required$5 = [
95
91
  "@context",
96
92
  "id",
97
93
  "type"
98
94
  ];
99
- var additionalProperties$6 = false;
100
- var description$6 = "Interface describing an alias for a vertex.";
95
+ var additionalProperties$5 = false;
96
+ var description$5 = "Interface describing an alias for a vertex.";
101
97
  var AuditableItemGraphAliasSchema = {
102
- type: type$6,
103
- properties: properties$6,
104
- required: required$6,
105
- additionalProperties: additionalProperties$6,
106
- description: description$6
98
+ type: type$5,
99
+ properties: properties$5,
100
+ required: required$5,
101
+ additionalProperties: additionalProperties$5,
102
+ description: description$5
107
103
  };
108
104
 
109
- var type$5 = "object";
110
- var properties$5 = {
105
+ var type$4 = "object";
106
+ var properties$4 = {
111
107
  "@context": {
112
108
  type: "array",
113
109
  minItems: 2,
@@ -159,7 +155,7 @@ var properties$5 = {
159
155
  description: "The verification for the changeset."
160
156
  }
161
157
  };
162
- var required$5 = [
158
+ var required$4 = [
163
159
  "@context",
164
160
  "type",
165
161
  "id",
@@ -167,18 +163,18 @@ var required$5 = [
167
163
  "userIdentity",
168
164
  "patches"
169
165
  ];
170
- var additionalProperties$5 = false;
171
- var description$5 = "Interface describing a set of changes to the vertex.";
166
+ var additionalProperties$4 = false;
167
+ var description$4 = "Interface describing a set of changes to the vertex.";
172
168
  var AuditableItemGraphChangesetSchema = {
173
- type: type$5,
174
- properties: properties$5,
175
- required: required$5,
176
- additionalProperties: additionalProperties$5,
177
- description: description$5
169
+ type: type$4,
170
+ properties: properties$4,
171
+ required: required$4,
172
+ additionalProperties: additionalProperties$4,
173
+ description: description$4
178
174
  };
179
175
 
180
- var type$4 = "object";
181
- var properties$4 = {
176
+ var type$3 = "object";
177
+ var properties$3 = {
182
178
  id: {
183
179
  type: "string",
184
180
  description: "The id of the element."
@@ -234,24 +230,24 @@ var properties$4 = {
234
230
  description: "The relationships between the two vertices."
235
231
  }
236
232
  };
237
- var required$4 = [
233
+ var required$3 = [
238
234
  "@context",
239
235
  "id",
240
236
  "type",
241
237
  "edgeRelationships"
242
238
  ];
243
- var additionalProperties$4 = false;
244
- var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
239
+ var additionalProperties$3 = false;
240
+ var description$3 = "Interface describing an edge between two vertices in an auditable item graph.";
245
241
  var AuditableItemGraphEdgeSchema = {
246
- type: type$4,
247
- properties: properties$4,
248
- required: required$4,
249
- additionalProperties: additionalProperties$4,
250
- description: description$4
242
+ type: type$3,
243
+ properties: properties$3,
244
+ required: required$3,
245
+ additionalProperties: additionalProperties$3,
246
+ description: description$3
251
247
  };
252
248
 
253
- var type$3 = "object";
254
- var properties$3 = {
249
+ var type$2 = "object";
250
+ var properties$2 = {
255
251
  "@context": {
256
252
  anyOf: [
257
253
  {
@@ -303,24 +299,24 @@ var properties$3 = {
303
299
  description: "The value to add."
304
300
  }
305
301
  };
306
- var required$3 = [
302
+ var required$2 = [
307
303
  "@context",
308
304
  "type",
309
305
  "patchOperation",
310
306
  "patchPath"
311
307
  ];
312
- var additionalProperties$3 = false;
313
- var description$3 = "The patch operation for JSON diffs.";
308
+ var additionalProperties$2 = false;
309
+ var description$2 = "The patch operation for JSON diffs.";
314
310
  var AuditableItemGraphPatchOperationSchema = {
315
- type: type$3,
316
- properties: properties$3,
317
- required: required$3,
318
- additionalProperties: additionalProperties$3,
319
- description: description$3
311
+ type: type$2,
312
+ properties: properties$2,
313
+ required: required$2,
314
+ additionalProperties: additionalProperties$2,
315
+ description: description$2
320
316
  };
321
317
 
322
- var type$2 = "object";
323
- var properties$2 = {
318
+ var type$1 = "object";
319
+ var properties$1 = {
324
320
  id: {
325
321
  type: "string",
326
322
  description: "The id of the element."
@@ -369,22 +365,22 @@ var properties$2 = {
369
365
  description: "The JSON-LD object for the resource."
370
366
  }
371
367
  };
372
- var required$2 = [
368
+ var required$1 = [
373
369
  "@context",
374
370
  "type"
375
371
  ];
376
- var additionalProperties$2 = false;
377
- var description$2 = "Interface describing an auditable item graph vertex resource.";
372
+ var additionalProperties$1 = false;
373
+ var description$1 = "Interface describing an auditable item graph vertex resource.";
378
374
  var AuditableItemGraphResourceSchema = {
379
- type: type$2,
380
- properties: properties$2,
381
- required: required$2,
382
- additionalProperties: additionalProperties$2,
383
- description: description$2
375
+ type: type$1,
376
+ properties: properties$1,
377
+ required: required$1,
378
+ additionalProperties: additionalProperties$1,
379
+ description: description$1
384
380
  };
385
381
 
386
- var type$1 = "object";
387
- var properties$1 = {
382
+ var type = "object";
383
+ var properties = {
388
384
  id: {
389
385
  type: "string",
390
386
  description: "The id of the element."
@@ -465,70 +461,14 @@ var properties$1 = {
465
461
  description: "Is the vertex verified, will only be populated when verification is requested."
466
462
  }
467
463
  };
468
- var required$1 = [
464
+ var required = [
469
465
  "@context",
470
466
  "id",
471
467
  "type"
472
468
  ];
473
- var additionalProperties$1 = false;
474
- var description$1 = "Interface describing an auditable item graph vertex.";
475
- var AuditableItemGraphVertexSchema = {
476
- type: type$1,
477
- properties: properties$1,
478
- required: required$1,
479
- additionalProperties: additionalProperties$1,
480
- description: description$1
481
- };
482
-
483
- var type = "object";
484
- var properties = {
485
- "@context": {
486
- anyOf: [
487
- {
488
- type: "string",
489
- "const": "https://schema.twindev.org/aig/"
490
- },
491
- {
492
- type: "array",
493
- minItems: 1,
494
- items: [
495
- {
496
- type: "string",
497
- "const": "https://schema.twindev.org/aig/"
498
- }
499
- ],
500
- additionalItems: {
501
- $ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
502
- }
503
- }
504
- ],
505
- description: "JSON-LD Context."
506
- },
507
- type: {
508
- type: "string",
509
- "const": "AuditableItemGraphVertexList",
510
- description: "JSON-LD Type."
511
- },
512
- vertices: {
513
- type: "array",
514
- items: {
515
- $ref: "https://schema.twindev.org/aig/AuditableItemGraphVertex"
516
- },
517
- description: "The list of vertices."
518
- },
519
- cursor: {
520
- type: "string",
521
- description: "The cursor to get the next chunk of vertices."
522
- }
523
- };
524
- var required = [
525
- "@context",
526
- "type",
527
- "vertices"
528
- ];
529
469
  var additionalProperties = false;
530
- var description = "Interface describing an auditable item graph vertex list.";
531
- var AuditableItemGraphVertexListSchema = {
470
+ var description = "Interface describing an auditable item graph vertex.";
471
+ var AuditableItemGraphVertexSchema = {
532
472
  type: type,
533
473
  properties: properties,
534
474
  required: required,
@@ -576,11 +516,6 @@ class AuditableItemGraphDataTypes {
576
516
  defaultValue: {},
577
517
  jsonSchema: async () => AuditableItemGraphPatchOperationSchema
578
518
  }));
579
- DataTypeHandlerFactory.register(AuditableItemGraphTypes.VertexList, () => ({
580
- type: AuditableItemGraphTypes.VertexList,
581
- defaultValue: {},
582
- jsonSchema: async () => AuditableItemGraphVertexListSchema
583
- }));
584
519
  }
585
520
  }
586
521
 
@@ -1,6 +1,6 @@
1
1
  import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
2
+ import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
2
3
  import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts";
3
- import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes";
4
4
  import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex";
5
5
  /**
6
6
  * Interface describing an auditable item graph vertex list.
@@ -9,17 +9,21 @@ export interface IAuditableItemGraphVertexList {
9
9
  /**
10
10
  * JSON-LD Context.
11
11
  */
12
- "@context": typeof AuditableItemGraphContexts.ContextRoot | [typeof AuditableItemGraphContexts.ContextRoot, ...IJsonLdContextDefinitionElement[]];
12
+ "@context": [
13
+ typeof SchemaOrgContexts.ContextRoot,
14
+ typeof AuditableItemGraphContexts.ContextRoot,
15
+ ...IJsonLdContextDefinitionElement[]
16
+ ];
13
17
  /**
14
18
  * JSON-LD Type.
15
19
  */
16
- type: typeof AuditableItemGraphTypes.VertexList;
20
+ type: typeof SchemaOrgTypes.ItemList;
17
21
  /**
18
22
  * The list of vertices.
19
23
  */
20
- vertices: IAuditableItemGraphVertex[];
24
+ [SchemaOrgTypes.ItemListElement]: IAuditableItemGraphVertex[];
21
25
  /**
22
26
  * The cursor to get the next chunk of vertices.
23
27
  */
24
- cursor?: string;
28
+ [SchemaOrgTypes.NextItem]?: string;
25
29
  }
@@ -26,10 +26,6 @@ export declare const AuditableItemGraphTypes: {
26
26
  * Represents patch operation.
27
27
  */
28
28
  readonly PatchOperation: "AuditableItemGraphPatchOperation";
29
- /**
30
- * Represents auditable item stream vertex list.
31
- */
32
- readonly VertexList: "AuditableItemGraphVertexList";
33
29
  };
34
30
  /**
35
31
  * The types of auditable item graph data.
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/auditable-item-graph-models - Changelog
2
2
 
3
+ ## [0.0.1-next.39](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.38...auditable-item-graph-models-v0.0.1-next.39) (2025-05-08)
4
+
5
+
6
+ ### Features
7
+
8
+ * use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
9
+
3
10
  ## [0.0.1-next.38](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.1-next.37...auditable-item-graph-models-v0.0.1-next.38) (2025-04-17)
4
11
 
5
12
 
@@ -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/"`, `...IJsonLdContextDefinitionElement[]`\]
9
+ > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -14,22 +14,22 @@ JSON-LD Context.
14
14
 
15
15
  ### type
16
16
 
17
- > **type**: `"AuditableItemGraphVertexList"`
17
+ > **type**: `"ItemList"`
18
18
 
19
19
  JSON-LD Type.
20
20
 
21
21
  ***
22
22
 
23
- ### vertices
23
+ ### itemListElement
24
24
 
25
- > **vertices**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
25
+ > **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
26
26
 
27
27
  The list of vertices.
28
28
 
29
29
  ***
30
30
 
31
- ### cursor?
31
+ ### nextItem?
32
32
 
33
- > `optional` **cursor**: `string`
33
+ > `optional` **nextItem**: `string`
34
34
 
35
35
  The cursor to get the next chunk of vertices.
@@ -41,9 +41,3 @@ Represents auditable item graph changeset.
41
41
  > `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
42
42
 
43
43
  Represents patch operation.
44
-
45
- ### VertexList
46
-
47
- > `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
48
-
49
- Represents auditable item stream vertex list.
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.38",
3
+ "version": "0.0.1-next.39",
4
4
  "description": "Models which define the structure of the auditable item graph connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -20,6 +20,7 @@
20
20
  "@twin.org/entity": "next",
21
21
  "@twin.org/immutable-proof-models": "next",
22
22
  "@twin.org/nameof": "next",
23
+ "@twin.org/standards-schema-org": "next",
23
24
  "@twin.org/web": "next"
24
25
  },
25
26
  "main": "./dist/cjs/index.cjs",