@twin.org/auditable-item-graph-models 0.0.3-next.0 → 0.0.3-next.10

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 (79) hide show
  1. package/dist/es/dataTypes/auditableItemGraphDataTypes.js +14 -14
  2. package/dist/es/dataTypes/auditableItemGraphDataTypes.js.map +1 -1
  3. package/dist/es/index.js +5 -0
  4. package/dist/es/index.js.map +1 -1
  5. package/dist/es/models/IAuditableItemGraphAlias.js.map +1 -1
  6. package/dist/es/models/IAuditableItemGraphAuditedElement.js.map +1 -1
  7. package/dist/es/models/IAuditableItemGraphChangeset.js.map +1 -1
  8. package/dist/es/models/IAuditableItemGraphChangesetList.js +2 -0
  9. package/dist/es/models/IAuditableItemGraphChangesetList.js.map +1 -0
  10. package/dist/es/models/IAuditableItemGraphComponent.js.map +1 -1
  11. package/dist/es/models/IAuditableItemGraphEdge.js.map +1 -1
  12. package/dist/es/models/IAuditableItemGraphPatchOperation.js.map +1 -1
  13. package/dist/es/models/IAuditableItemGraphResource.js.map +1 -1
  14. package/dist/es/models/IAuditableItemGraphVertex.js.map +1 -1
  15. package/dist/es/models/IAuditableItemGraphVertexList.js.map +1 -1
  16. package/dist/es/models/api/IAuditableItemGraphChangesetGetRequest.js +2 -0
  17. package/dist/es/models/api/IAuditableItemGraphChangesetGetRequest.js.map +1 -0
  18. package/dist/es/models/api/IAuditableItemGraphChangesetGetResponse.js +2 -0
  19. package/dist/es/models/api/IAuditableItemGraphChangesetGetResponse.js.map +1 -0
  20. package/dist/es/models/api/IAuditableItemGraphChangesetListRequest.js +2 -0
  21. package/dist/es/models/api/IAuditableItemGraphChangesetListRequest.js.map +1 -0
  22. package/dist/es/models/api/IAuditableItemGraphChangesetListResponse.js +2 -0
  23. package/dist/es/models/api/IAuditableItemGraphChangesetListResponse.js.map +1 -0
  24. package/dist/es/models/api/IAuditableItemGraphGetRequest.js.map +1 -1
  25. package/dist/es/models/api/IAuditableItemGraphListRequest.js.map +1 -1
  26. package/dist/es/models/api/IAuditableItemGraphListResponse.js.map +1 -1
  27. package/dist/es/models/auditableItemGraphContexts.js +20 -4
  28. package/dist/es/models/auditableItemGraphContexts.js.map +1 -1
  29. package/dist/es/models/auditableItemGraphTypes.js +5 -1
  30. package/dist/es/models/auditableItemGraphTypes.js.map +1 -1
  31. package/dist/es/schemas/AuditableItemGraphAlias.json +5 -5
  32. package/dist/es/schemas/AuditableItemGraphChangeset.json +5 -6
  33. package/dist/es/schemas/AuditableItemGraphEdge.json +6 -6
  34. package/dist/es/schemas/AuditableItemGraphPatchOperation.json +4 -5
  35. package/dist/es/schemas/AuditableItemGraphResource.json +4 -4
  36. package/dist/es/schemas/AuditableItemGraphVertex.json +9 -16
  37. package/dist/es/schemas/AuditableItemGraphVertexList.json +1 -5
  38. package/dist/types/index.d.ts +5 -0
  39. package/dist/types/models/IAuditableItemGraphAlias.d.ts +3 -1
  40. package/dist/types/models/IAuditableItemGraphAuditedElement.d.ts +3 -0
  41. package/dist/types/models/IAuditableItemGraphChangeset.d.ts +8 -3
  42. package/dist/types/models/IAuditableItemGraphChangesetList.d.ts +27 -0
  43. package/dist/types/models/IAuditableItemGraphComponent.d.ts +33 -3
  44. package/dist/types/models/IAuditableItemGraphEdge.d.ts +4 -1
  45. package/dist/types/models/IAuditableItemGraphPatchOperation.d.ts +5 -1
  46. package/dist/types/models/IAuditableItemGraphResource.d.ts +2 -1
  47. package/dist/types/models/IAuditableItemGraphVertex.d.ts +8 -7
  48. package/dist/types/models/IAuditableItemGraphVertexList.d.ts +3 -6
  49. package/dist/types/models/api/IAuditableItemGraphChangesetGetRequest.d.ts +35 -0
  50. package/dist/types/models/api/IAuditableItemGraphChangesetGetResponse.d.ts +17 -0
  51. package/dist/types/models/api/IAuditableItemGraphChangesetListRequest.d.ts +39 -0
  52. package/dist/types/models/api/IAuditableItemGraphChangesetListResponse.d.ts +18 -0
  53. package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts +1 -5
  54. package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +1 -1
  55. package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts +1 -0
  56. package/dist/types/models/auditableItemGraphContexts.d.ts +20 -4
  57. package/dist/types/models/auditableItemGraphTypes.d.ts +5 -1
  58. package/docs/changelog.md +120 -0
  59. package/docs/reference/index.md +5 -0
  60. package/docs/reference/interfaces/IAuditableItemGraphAlias.md +5 -0
  61. package/docs/reference/interfaces/IAuditableItemGraphAuditedElement.md +3 -0
  62. package/docs/reference/interfaces/IAuditableItemGraphChangeset.md +7 -2
  63. package/docs/reference/interfaces/IAuditableItemGraphChangesetGetRequest.md +49 -0
  64. package/docs/reference/interfaces/IAuditableItemGraphChangesetGetResponse.md +23 -0
  65. package/docs/reference/interfaces/IAuditableItemGraphChangesetList.md +28 -0
  66. package/docs/reference/interfaces/IAuditableItemGraphChangesetListRequest.md +55 -0
  67. package/docs/reference/interfaces/IAuditableItemGraphChangesetListResponse.md +27 -0
  68. package/docs/reference/interfaces/IAuditableItemGraphComponent.md +85 -7
  69. package/docs/reference/interfaces/IAuditableItemGraphEdge.md +6 -0
  70. package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md +1 -7
  71. package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +1 -1
  72. package/docs/reference/interfaces/IAuditableItemGraphListResponse.md +4 -0
  73. package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md +6 -2
  74. package/docs/reference/interfaces/IAuditableItemGraphResource.md +4 -0
  75. package/docs/reference/interfaces/IAuditableItemGraphVertex.md +9 -8
  76. package/docs/reference/interfaces/IAuditableItemGraphVertexList.md +1 -8
  77. package/docs/reference/variables/AuditableItemGraphContexts.md +30 -6
  78. package/docs/reference/variables/AuditableItemGraphTypes.md +7 -1
  79. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,125 @@
1
1
  # @twin.org/auditable-item-graph-models - Changelog
2
2
 
3
+ ## [0.0.3-next.10](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.9...auditable-item-graph-models-v0.0.3-next.10) (2026-02-24)
4
+
5
+
6
+ ### Features
7
+
8
+ * add context id features ([#30](https://github.com/twinfoundation/auditable-item-graph/issues/30)) ([a35d37c](https://github.com/twinfoundation/auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
9
+ * add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
10
+ * add ts-to-jsonld-context tool ([08d360e](https://github.com/twinfoundation/auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
11
+ * add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
12
+ * add validate-locales ([e76e6f6](https://github.com/twinfoundation/auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
13
+ * changeset endpoints ([#44](https://github.com/twinfoundation/auditable-item-graph/issues/44)) ([7c854de](https://github.com/twinfoundation/auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
14
+ * eslint migration to flat config ([1b42a3a](https://github.com/twinfoundation/auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
15
+ * id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
16
+ * improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
17
+ * improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
18
+ * replace nextItem property with Link header ([#39](https://github.com/twinfoundation/auditable-item-graph/issues/39)) ([b29a333](https://github.com/twinfoundation/auditable-item-graph/commit/b29a333ca78ca2091e54e3e6f4355f84c350007d))
19
+ * update background task service ([e483ddb](https://github.com/twinfoundation/auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
20
+ * update contexts ([#35](https://github.com/twinfoundation/auditable-item-graph/issues/35)) ([cdf0989](https://github.com/twinfoundation/auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
21
+ * update contexts and namespaces ([#33](https://github.com/twinfoundation/auditable-item-graph/issues/33)) ([5dadb99](https://github.com/twinfoundation/auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
22
+ * update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
23
+ * update edges to use targetId instead of id ([6c5d0e3](https://github.com/twinfoundation/auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
24
+ * update framework core ([88ad4e6](https://github.com/twinfoundation/auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
25
+ * update targetid json context type ([1e47ca7](https://github.com/twinfoundation/auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
26
+ * update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
27
+ * use new nameof operators ([3921c4c](https://github.com/twinfoundation/auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
28
+ * use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
29
+ * use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
30
+
31
+
32
+ ### Bug Fixes
33
+
34
+ * only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
35
+ * query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
36
+
37
+ ## [0.0.3-next.9](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.8...auditable-item-graph-models-v0.0.3-next.9) (2026-02-23)
38
+
39
+
40
+ ### Miscellaneous Chores
41
+
42
+ * **auditable-item-graph-models:** Synchronize repo versions
43
+
44
+ ## [0.0.3-next.8](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.7...auditable-item-graph-models-v0.0.3-next.8) (2026-02-11)
45
+
46
+
47
+ ### Miscellaneous Chores
48
+
49
+ * **auditable-item-graph-models:** Synchronize repo versions
50
+
51
+ ## [0.0.3-next.7](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.6...auditable-item-graph-models-v0.0.3-next.7) (2026-02-11)
52
+
53
+
54
+ ### Features
55
+
56
+ * add ts-to-jsonld-context tool ([08d360e](https://github.com/twinfoundation/auditable-item-graph/commit/08d360e05fd7f8c5bbe6ee4d4e691ffd516db418))
57
+ * changeset endpoints ([#44](https://github.com/twinfoundation/auditable-item-graph/issues/44)) ([7c854de](https://github.com/twinfoundation/auditable-item-graph/commit/7c854de39b247d6f24cd94a04a9f99fa9edde51d))
58
+ * update targetid json context type ([1e47ca7](https://github.com/twinfoundation/auditable-item-graph/commit/1e47ca7ec3080251d940fd8e58c44ca4fa9457f7))
59
+
60
+ ## [0.0.3-next.6](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.5...auditable-item-graph-models-v0.0.3-next.6) (2026-01-26)
61
+
62
+
63
+ ### Miscellaneous Chores
64
+
65
+ * **auditable-item-graph-models:** Synchronize repo versions
66
+
67
+ ## [0.0.3-next.5](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.4...auditable-item-graph-models-v0.0.3-next.5) (2026-01-23)
68
+
69
+
70
+ ### Features
71
+
72
+ * replace nextItem property with Link header ([#39](https://github.com/twinfoundation/auditable-item-graph/issues/39)) ([b29a333](https://github.com/twinfoundation/auditable-item-graph/commit/b29a333ca78ca2091e54e3e6f4355f84c350007d))
73
+
74
+ ## [0.0.3-next.4](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.3...auditable-item-graph-models-v0.0.3-next.4) (2026-01-22)
75
+
76
+
77
+ ### Miscellaneous Chores
78
+
79
+ * **auditable-item-graph-models:** Synchronize repo versions
80
+
81
+ ## [0.0.3-next.3](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.2...auditable-item-graph-models-v0.0.3-next.3) (2026-01-21)
82
+
83
+
84
+ ### Features
85
+
86
+ * update contexts ([#35](https://github.com/twinfoundation/auditable-item-graph/issues/35)) ([cdf0989](https://github.com/twinfoundation/auditable-item-graph/commit/cdf0989fe4677a88b757e97e752b7d4c29013a7e))
87
+
88
+ ## [0.0.3-next.2](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.1...auditable-item-graph-models-v0.0.3-next.2) (2026-01-14)
89
+
90
+
91
+ ### Features
92
+
93
+ * update contexts and namespaces ([#33](https://github.com/twinfoundation/auditable-item-graph/issues/33)) ([5dadb99](https://github.com/twinfoundation/auditable-item-graph/commit/5dadb99773d410aceacaba7ed92c1ccb8b46516b))
94
+
95
+ ## [0.0.3-next.1](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.0...auditable-item-graph-models-v0.0.3-next.1) (2025-11-28)
96
+
97
+
98
+ ### Features
99
+
100
+ * add context id features ([#30](https://github.com/twinfoundation/auditable-item-graph/issues/30)) ([a35d37c](https://github.com/twinfoundation/auditable-item-graph/commit/a35d37c0db62a240adde493965c0a9f7971fec45))
101
+ * add data types with fully qualified name ([93e1ee7](https://github.com/twinfoundation/auditable-item-graph/commit/93e1ee7c0f7bad81f003787f797f363864e201af))
102
+ * add unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
103
+ * add validate-locales ([e76e6f6](https://github.com/twinfoundation/auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
104
+ * eslint migration to flat config ([1b42a3a](https://github.com/twinfoundation/auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
105
+ * id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
106
+ * improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
107
+ * improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
108
+ * update background task service ([e483ddb](https://github.com/twinfoundation/auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
109
+ * update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
110
+ * update edges to use targetId instead of id ([6c5d0e3](https://github.com/twinfoundation/auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
111
+ * update framework core ([88ad4e6](https://github.com/twinfoundation/auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
112
+ * update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
113
+ * use new nameof operators ([3921c4c](https://github.com/twinfoundation/auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
114
+ * use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
115
+ * use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
116
+
117
+
118
+ ### Bug Fixes
119
+
120
+ * only include alias in index if not deleted ([#6](https://github.com/twinfoundation/auditable-item-graph/issues/6)) ([5da3c41](https://github.com/twinfoundation/auditable-item-graph/commit/5da3c419fafa2afefd34b1c570d103012b888a75))
121
+ * query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
122
+
3
123
  ## [0.0.2-next.8](https://github.com/twinfoundation/auditable-item-graph/compare/auditable-item-graph-models-v0.0.2-next.7...auditable-item-graph-models-v0.0.2-next.8) (2025-10-09)
4
124
 
5
125
 
@@ -9,12 +9,17 @@
9
9
  - [IAuditableItemGraphAlias](interfaces/IAuditableItemGraphAlias.md)
10
10
  - [IAuditableItemGraphAuditedElement](interfaces/IAuditableItemGraphAuditedElement.md)
11
11
  - [IAuditableItemGraphChangeset](interfaces/IAuditableItemGraphChangeset.md)
12
+ - [IAuditableItemGraphChangesetList](interfaces/IAuditableItemGraphChangesetList.md)
12
13
  - [IAuditableItemGraphComponent](interfaces/IAuditableItemGraphComponent.md)
13
14
  - [IAuditableItemGraphEdge](interfaces/IAuditableItemGraphEdge.md)
14
15
  - [IAuditableItemGraphPatchOperation](interfaces/IAuditableItemGraphPatchOperation.md)
15
16
  - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
16
17
  - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
17
18
  - [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
19
+ - [IAuditableItemGraphChangesetGetRequest](interfaces/IAuditableItemGraphChangesetGetRequest.md)
20
+ - [IAuditableItemGraphChangesetGetResponse](interfaces/IAuditableItemGraphChangesetGetResponse.md)
21
+ - [IAuditableItemGraphChangesetListRequest](interfaces/IAuditableItemGraphChangesetListRequest.md)
22
+ - [IAuditableItemGraphChangesetListResponse](interfaces/IAuditableItemGraphChangesetListResponse.md)
18
23
  - [IAuditableItemGraphCreateRequest](interfaces/IAuditableItemGraphCreateRequest.md)
19
24
  - [IAuditableItemGraphGetRequest](interfaces/IAuditableItemGraphGetRequest.md)
20
25
  - [IAuditableItemGraphGetResponse](interfaces/IAuditableItemGraphGetResponse.md)
@@ -41,6 +41,7 @@ JSON-LD Type.
41
41
  > `optional` **annotationObject**: `IJsonLdNodeObject`
42
42
 
43
43
  The JSON-LD annotation object for the alias.
44
+ json-ld namespace:twin-common
44
45
 
45
46
  ***
46
47
 
@@ -49,6 +50,7 @@ The JSON-LD annotation object for the alias.
49
50
  > `optional` **aliasFormat**: `string`
50
51
 
51
52
  The format of the id in the alias.
53
+ json-ld type:sch:Text
52
54
 
53
55
  ***
54
56
 
@@ -57,6 +59,7 @@ The format of the id in the alias.
57
59
  > `optional` **dateCreated**: `string`
58
60
 
59
61
  The date/time of when the element was created.
62
+ json-ld namespace:sch
60
63
 
61
64
  #### Inherited from
62
65
 
@@ -69,6 +72,7 @@ The date/time of when the element was created.
69
72
  > `optional` **dateModified**: `string`
70
73
 
71
74
  The date/time of when the element was modified.
75
+ json-ld namespace:sch
72
76
 
73
77
  #### Inherited from
74
78
 
@@ -81,6 +85,7 @@ The date/time of when the element was modified.
81
85
  > `optional` **dateDeleted**: `string`
82
86
 
83
87
  The date/time of when the element was deleted, as we never actually remove items.
88
+ json-ld namespace:sch
84
89
 
85
90
  #### Inherited from
86
91
 
@@ -23,6 +23,7 @@ The id of the element.
23
23
  > `optional` **dateCreated**: `string`
24
24
 
25
25
  The date/time of when the element was created.
26
+ json-ld namespace:sch
26
27
 
27
28
  ***
28
29
 
@@ -31,6 +32,7 @@ The date/time of when the element was created.
31
32
  > `optional` **dateModified**: `string`
32
33
 
33
34
  The date/time of when the element was modified.
35
+ json-ld namespace:sch
34
36
 
35
37
  ***
36
38
 
@@ -39,3 +41,4 @@ The date/time of when the element was modified.
39
41
  > `optional` **dateDeleted**: `string`
40
42
 
41
43
  The date/time of when the element was deleted, as we never actually remove items.
44
+ json-ld namespace:sch
@@ -4,9 +4,9 @@ Interface describing a set of changes to the vertex.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### @context
7
+ ### @context?
8
8
 
9
- > **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
9
+ > `optional` **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
11
11
  JSON-LD Context.
12
12
 
@@ -33,6 +33,7 @@ The id of the changeset.
33
33
  > **dateCreated**: `string`
34
34
 
35
35
  The date/time of when the changeset was created.
36
+ json-ld namespace:sch
36
37
 
37
38
  ***
38
39
 
@@ -41,6 +42,7 @@ The date/time of when the changeset was created.
41
42
  > `optional` **userIdentity**: `string`
42
43
 
43
44
  The user identity that created the changes.
45
+ json-ld namespace:twin-common
44
46
 
45
47
  ***
46
48
 
@@ -49,6 +51,7 @@ The user identity that created the changes.
49
51
  > **patches**: [`IAuditableItemGraphPatchOperation`](IAuditableItemGraphPatchOperation.md)[]
50
52
 
51
53
  The patches in the changeset.
54
+ json-ld container:set
52
55
 
53
56
  ***
54
57
 
@@ -57,6 +60,7 @@ The patches in the changeset.
57
60
  > `optional` **proofId**: `string`
58
61
 
59
62
  The immutable proof id which contains the signature for this changeset.
63
+ json-ld type:sch:identifier
60
64
 
61
65
  ***
62
66
 
@@ -65,3 +69,4 @@ The immutable proof id which contains the signature for this changeset.
65
69
  > `optional` **verification**: `IImmutableProofVerification`
66
70
 
67
71
  The verification for the changeset.
72
+ json-ld id
@@ -0,0 +1,49 @@
1
+ # Interface: IAuditableItemGraphChangesetGetRequest
2
+
3
+ Get an auditable item graph vertex changeset.
4
+
5
+ ## Properties
6
+
7
+ ### headers?
8
+
9
+ > `optional` **headers**: `object`
10
+
11
+ The headers which can be used to determine the response data type.
12
+
13
+ #### accept
14
+
15
+ > **accept**: `"application/json"` \| `"application/ld+json"`
16
+
17
+ ***
18
+
19
+ ### pathParams
20
+
21
+ > **pathParams**: `object`
22
+
23
+ The parameters from the path.
24
+
25
+ #### id
26
+
27
+ > **id**: `string`
28
+
29
+ The id of the vertex to get the changeset from.
30
+
31
+ #### changesetId
32
+
33
+ > **changesetId**: `string`
34
+
35
+ The id of the changeset to get.
36
+
37
+ ***
38
+
39
+ ### query?
40
+
41
+ > `optional` **query**: `object`
42
+
43
+ The query parameters.
44
+
45
+ #### verifySignatureDepth?
46
+
47
+ > `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
48
+
49
+ How many signatures to verify, none, current or all, defaults to "none".
@@ -0,0 +1,23 @@
1
+ # Interface: IAuditableItemGraphChangesetGetResponse
2
+
3
+ Response to getting an auditable item graph vertex changeset.
4
+
5
+ ## Properties
6
+
7
+ ### headers?
8
+
9
+ > `optional` **headers**: `object`
10
+
11
+ The headers which can be used to determine the response data type.
12
+
13
+ #### content-type
14
+
15
+ > **content-type**: `"application/json"` \| `"application/ld+json"`
16
+
17
+ ***
18
+
19
+ ### body
20
+
21
+ > **body**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)
22
+
23
+ The response body.
@@ -0,0 +1,28 @@
1
+ # Interface: IAuditableItemGraphChangesetList
2
+
3
+ Interface describing an auditable item graph changeset list.
4
+
5
+ ## Properties
6
+
7
+ ### @context
8
+
9
+ > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
10
+
11
+ JSON-LD Context.
12
+
13
+ ***
14
+
15
+ ### type
16
+
17
+ > **type**: \[`"ItemList"`, `"AuditableItemGraphChangesetList"`\]
18
+
19
+ JSON-LD Type.
20
+
21
+ ***
22
+
23
+ ### itemListElement
24
+
25
+ > **itemListElement**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
26
+
27
+ The list of changesets.
28
+ json-ld namespace:sch
@@ -0,0 +1,55 @@
1
+ # Interface: IAuditableItemGraphChangesetListRequest
2
+
3
+ Get an auditable item graph changeset.
4
+
5
+ ## Properties
6
+
7
+ ### headers?
8
+
9
+ > `optional` **headers**: `object`
10
+
11
+ The headers which can be used to determine the response data type.
12
+
13
+ #### accept
14
+
15
+ > **accept**: `"application/json"` \| `"application/ld+json"`
16
+
17
+ ***
18
+
19
+ ### pathParams
20
+
21
+ > **pathParams**: `object`
22
+
23
+ The parameters from the path.
24
+
25
+ #### id
26
+
27
+ > **id**: `string`
28
+
29
+ The id of the changeset to get.
30
+
31
+ ***
32
+
33
+ ### query?
34
+
35
+ > `optional` **query**: `object`
36
+
37
+ The query parameters.
38
+
39
+ #### cursor?
40
+
41
+ > `optional` **cursor**: `string`
42
+
43
+ The optional cursor to get next chunk.
44
+
45
+ #### limit?
46
+
47
+ > `optional` **limit**: `string`
48
+
49
+ Limit the number of entities to return.
50
+
51
+ #### verifySignatureDepth?
52
+
53
+ > `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
54
+
55
+ How many signatures to verify, none, current or all, defaults to "none".
@@ -0,0 +1,27 @@
1
+ # Interface: IAuditableItemGraphChangesetListResponse
2
+
3
+ Response to getting an auditable item graph changeset list.
4
+
5
+ ## Properties
6
+
7
+ ### headers?
8
+
9
+ > `optional` **headers**: `object`
10
+
11
+ The headers which can be used to determine the response data type.
12
+
13
+ #### content-type
14
+
15
+ > **content-type**: `"application/json"` \| `"application/ld+json"`
16
+
17
+ #### link?
18
+
19
+ > `optional` **link**: `string` \| `string`[]
20
+
21
+ ***
22
+
23
+ ### body
24
+
25
+ > **body**: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md)
26
+
27
+ The response body.
@@ -126,11 +126,53 @@ Additional options for the get operation.
126
126
 
127
127
  Whether to include deleted aliases, resource, edges, defaults to false.
128
128
 
129
- ###### includeChangesets?
129
+ ###### verifySignatureDepth?
130
130
 
131
- `boolean`
131
+ [`VerifyDepth`](../type-aliases/VerifyDepth.md)
132
+
133
+ How many signatures to verify, defaults to "none".
134
+
135
+ #### Returns
136
+
137
+ `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
138
+
139
+ The vertex if found.
140
+
141
+ #### Throws
142
+
143
+ NotFoundError if the vertex is not found.
144
+
145
+ ***
146
+
147
+ ### getChangesets()
148
+
149
+ > **getChangesets**(`id`, `cursor?`, `limit?`, `options?`): `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
150
+
151
+ Get a graph vertex changeset list.
152
+
153
+ #### Parameters
154
+
155
+ ##### id
156
+
157
+ `string`
158
+
159
+ The id of the vertex to get.
160
+
161
+ ##### cursor?
162
+
163
+ `string`
164
+
165
+ The optional cursor to get next chunk.
166
+
167
+ ##### limit?
168
+
169
+ `number`
132
170
 
133
- Whether to include the changesets of the vertex, defaults to false.
171
+ Limit the number of entities to return.
172
+
173
+ ##### options?
174
+
175
+ Additional options for the get operation.
134
176
 
135
177
  ###### verifySignatureDepth?
136
178
 
@@ -140,9 +182,9 @@ How many signatures to verify, defaults to "none".
140
182
 
141
183
  #### Returns
142
184
 
143
- `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
185
+ `Promise`\<\{ `changesets`: [`IAuditableItemGraphChangesetList`](IAuditableItemGraphChangesetList.md); `cursor?`: `string`; \}\>
144
186
 
145
- The vertex if found.
187
+ The changeset if found.
146
188
 
147
189
  #### Throws
148
190
 
@@ -150,6 +192,42 @@ NotFoundError if the vertex is not found.
150
192
 
151
193
  ***
152
194
 
195
+ ### getChangeset()
196
+
197
+ > **getChangeset**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
198
+
199
+ Get a graph vertex changeset.
200
+
201
+ #### Parameters
202
+
203
+ ##### id
204
+
205
+ `string`
206
+
207
+ The id of the vertex to get.
208
+
209
+ ##### options?
210
+
211
+ Additional options for the get operation.
212
+
213
+ ###### verifySignatureDepth?
214
+
215
+ [`VerifyDepth`](../type-aliases/VerifyDepth.md)
216
+
217
+ How many signatures to verify, defaults to "none".
218
+
219
+ #### Returns
220
+
221
+ `Promise`\<[`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)\>
222
+
223
+ The changeset if found.
224
+
225
+ #### Throws
226
+
227
+ NotFoundError if the vertex or changeset is not found.
228
+
229
+ ***
230
+
153
231
  ### removeVerifiable()
154
232
 
155
233
  > **removeVerifiable**(`id`): `Promise`\<`void`\>
@@ -178,7 +256,7 @@ NotFoundError if the vertex is not found.
178
256
 
179
257
  ### query()
180
258
 
181
- > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
259
+ > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
182
260
 
183
261
  Query the graph for vertices.
184
262
 
@@ -250,6 +328,6 @@ Limit the number of entities to return.
250
328
 
251
329
  #### Returns
252
330
 
253
- `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
331
+ `Promise`\<\{ `entries`: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md); `cursor?`: `string`; \}\>
254
332
 
255
333
  The entities, which can be partial if a limited keys list was provided.
@@ -13,6 +13,7 @@ Interface describing an edge between two vertices in an auditable item graph.
13
13
  > `optional` **dateCreated**: `string`
14
14
 
15
15
  The date/time of when the element was created.
16
+ json-ld namespace:sch
16
17
 
17
18
  #### Inherited from
18
19
 
@@ -25,6 +26,7 @@ The date/time of when the element was created.
25
26
  > `optional` **dateModified**: `string`
26
27
 
27
28
  The date/time of when the element was modified.
29
+ json-ld namespace:sch
28
30
 
29
31
  #### Inherited from
30
32
 
@@ -37,6 +39,7 @@ The date/time of when the element was modified.
37
39
  > `optional` **dateDeleted**: `string`
38
40
 
39
41
  The date/time of when the element was deleted, as we never actually remove items.
42
+ json-ld namespace:sch
40
43
 
41
44
  #### Inherited from
42
45
 
@@ -69,6 +72,7 @@ The id of the element.
69
72
  > **targetId**: `string`
70
73
 
71
74
  The target vertex id the edge connects to.
75
+ json-ld type:@id
72
76
 
73
77
  ***
74
78
 
@@ -85,6 +89,7 @@ JSON-LD Type.
85
89
  > `optional` **annotationObject**: `IJsonLdNodeObject`
86
90
 
87
91
  The JSON-LD annotation object for the edge.
92
+ json-ld namespace:twin-common
88
93
 
89
94
  ***
90
95
 
@@ -93,3 +98,4 @@ The JSON-LD annotation object for the edge.
93
98
  > **edgeRelationships**: `string`[]
94
99
 
95
100
  The relationships between the two vertices.
101
+ json-ld container:set
@@ -38,16 +38,10 @@ The query parameters.
38
38
 
39
39
  #### includeDeleted?
40
40
 
41
- > `optional` **includeDeleted**: `string` \| `boolean`
41
+ > `optional` **includeDeleted**: `string`
42
42
 
43
43
  Whether to include deleted aliases, resource, edges, defaults to false.
44
44
 
45
- #### includeChangesets?
46
-
47
- > `optional` **includeChangesets**: `string` \| `boolean`
48
-
49
- Whether to include the changesets of the vertex, defaults to false.
50
-
51
45
  #### verifySignatureDepth?
52
46
 
53
47
  > `optional` **verifySignatureDepth**: [`VerifyDepth`](../type-aliases/VerifyDepth.md)
@@ -36,7 +36,7 @@ Which field to look in with the id, defaults to both.
36
36
 
37
37
  #### idExact?
38
38
 
39
- > `optional` **idExact**: `boolean`
39
+ > `optional` **idExact**: `string`
40
40
 
41
41
  Find only exact matches, default to false meaning partial matching.
42
42
 
@@ -14,6 +14,10 @@ The headers which can be used to determine the response data type.
14
14
 
15
15
  > **content-type**: `"application/json"` \| `"application/ld+json"`
16
16
 
17
+ #### link?
18
+
19
+ > `optional` **link**: `string` \| `string`[]
20
+
17
21
  ***
18
22
 
19
23
  ### body