@twin.org/auditable-item-graph-models 0.0.2-next.8 → 0.0.3-next.1

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 (75) hide show
  1. package/dist/es/dataTypes/auditableItemGraphDataTypes.js +65 -0
  2. package/dist/es/dataTypes/auditableItemGraphDataTypes.js.map +1 -0
  3. package/dist/es/index.js +25 -0
  4. package/dist/es/index.js.map +1 -0
  5. package/dist/es/models/IAuditableItemGraphAlias.js +2 -0
  6. package/dist/es/models/IAuditableItemGraphAlias.js.map +1 -0
  7. package/dist/es/models/IAuditableItemGraphAuditedElement.js +4 -0
  8. package/dist/es/models/IAuditableItemGraphAuditedElement.js.map +1 -0
  9. package/dist/es/models/IAuditableItemGraphChangeset.js +2 -0
  10. package/dist/es/models/IAuditableItemGraphChangeset.js.map +1 -0
  11. package/dist/es/models/IAuditableItemGraphComponent.js +2 -0
  12. package/dist/es/models/IAuditableItemGraphComponent.js.map +1 -0
  13. package/dist/es/models/IAuditableItemGraphEdge.js +2 -0
  14. package/dist/es/models/IAuditableItemGraphEdge.js.map +1 -0
  15. package/dist/es/models/IAuditableItemGraphPatchOperation.js +2 -0
  16. package/dist/es/models/IAuditableItemGraphPatchOperation.js.map +1 -0
  17. package/dist/es/models/IAuditableItemGraphResource.js +2 -0
  18. package/dist/es/models/IAuditableItemGraphResource.js.map +1 -0
  19. package/dist/es/models/IAuditableItemGraphVertex.js +2 -0
  20. package/dist/es/models/IAuditableItemGraphVertex.js.map +1 -0
  21. package/dist/es/models/IAuditableItemGraphVertexList.js +2 -0
  22. package/dist/es/models/IAuditableItemGraphVertexList.js.map +1 -0
  23. package/dist/es/models/api/IAuditableItemGraphCreateRequest.js +2 -0
  24. package/dist/es/models/api/IAuditableItemGraphCreateRequest.js.map +1 -0
  25. package/dist/es/models/api/IAuditableItemGraphGetRequest.js +2 -0
  26. package/dist/es/models/api/IAuditableItemGraphGetRequest.js.map +1 -0
  27. package/dist/es/models/api/IAuditableItemGraphGetResponse.js +2 -0
  28. package/dist/es/models/api/IAuditableItemGraphGetResponse.js.map +1 -0
  29. package/dist/es/models/api/IAuditableItemGraphListRequest.js +2 -0
  30. package/dist/es/models/api/IAuditableItemGraphListRequest.js.map +1 -0
  31. package/dist/es/models/api/IAuditableItemGraphListResponse.js +2 -0
  32. package/dist/es/models/api/IAuditableItemGraphListResponse.js.map +1 -0
  33. package/dist/es/models/api/IAuditableItemGraphUpdateRequest.js +2 -0
  34. package/dist/es/models/api/IAuditableItemGraphUpdateRequest.js.map +1 -0
  35. package/dist/es/models/auditableItemGraphContexts.js +17 -0
  36. package/dist/es/models/auditableItemGraphContexts.js.map +1 -0
  37. package/dist/es/models/auditableItemGraphTopics.js +17 -0
  38. package/dist/es/models/auditableItemGraphTopics.js.map +1 -0
  39. package/dist/es/models/auditableItemGraphTypes.js +37 -0
  40. package/dist/es/models/auditableItemGraphTypes.js.map +1 -0
  41. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexCreated.js +4 -0
  42. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexCreated.js.map +1 -0
  43. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js +2 -0
  44. package/dist/es/models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js.map +1 -0
  45. package/dist/es/models/verifyDepth.js +21 -0
  46. package/dist/es/models/verifyDepth.js.map +1 -0
  47. package/dist/es/schemas/AuditableItemGraphAlias.json +65 -0
  48. package/dist/es/schemas/AuditableItemGraphChangeset.json +66 -0
  49. package/dist/es/schemas/AuditableItemGraphEdge.json +73 -0
  50. package/dist/es/schemas/AuditableItemGraphPatchOperation.json +65 -0
  51. package/dist/es/schemas/AuditableItemGraphResource.json +60 -0
  52. package/dist/es/schemas/AuditableItemGraphVertex.json +93 -0
  53. package/dist/es/schemas/AuditableItemGraphVertexList.json +59 -0
  54. package/dist/types/index.d.ts +22 -22
  55. package/dist/types/models/IAuditableItemGraphAlias.d.ts +3 -3
  56. package/dist/types/models/IAuditableItemGraphChangeset.d.ts +4 -4
  57. package/dist/types/models/IAuditableItemGraphComponent.d.ts +6 -11
  58. package/dist/types/models/IAuditableItemGraphEdge.d.ts +3 -3
  59. package/dist/types/models/IAuditableItemGraphPatchOperation.d.ts +2 -2
  60. package/dist/types/models/IAuditableItemGraphResource.d.ts +3 -3
  61. package/dist/types/models/IAuditableItemGraphVertex.d.ts +9 -9
  62. package/dist/types/models/IAuditableItemGraphVertexList.d.ts +3 -3
  63. package/dist/types/models/api/IAuditableItemGraphGetRequest.d.ts +3 -3
  64. package/dist/types/models/api/IAuditableItemGraphGetResponse.d.ts +1 -1
  65. package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +2 -2
  66. package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts +1 -1
  67. package/docs/changelog.md +28 -0
  68. package/docs/reference/interfaces/IAuditableItemGraphChangeset.md +2 -2
  69. package/docs/reference/interfaces/IAuditableItemGraphComponent.md +3 -41
  70. package/docs/reference/interfaces/IAuditableItemGraphGetRequest.md +2 -2
  71. package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +1 -1
  72. package/docs/reference/interfaces/IAuditableItemGraphVertex.md +3 -3
  73. package/package.json +5 -7
  74. package/dist/cjs/index.cjs +0 -716
  75. package/dist/esm/index.mjs +0 -710
package/docs/changelog.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # @twin.org/auditable-item-graph-models - Changelog
2
2
 
3
+ ## [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)
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 unique flag for alias, and exact match option for id query ([33dbd19](https://github.com/twinfoundation/auditable-item-graph/commit/33dbd19cabd9fbfaba81032f1d1a6527584c3f5a))
11
+ * add validate-locales ([e76e6f6](https://github.com/twinfoundation/auditable-item-graph/commit/e76e6f6b3ec9c447a04315d353442e32233601d3))
12
+ * eslint migration to flat config ([1b42a3a](https://github.com/twinfoundation/auditable-item-graph/commit/1b42a3a27bd6e32d7816de406b92b6332472edf6))
13
+ * id optional in edge updates ([6b63fe3](https://github.com/twinfoundation/auditable-item-graph/commit/6b63fe34553104843ae15aa5066775f5872859e9))
14
+ * improve comments ([97f311a](https://github.com/twinfoundation/auditable-item-graph/commit/97f311a9cc4353b5020a48a44420c97a2fa0c8d7))
15
+ * improve JSON schemas ([bec8dc1](https://github.com/twinfoundation/auditable-item-graph/commit/bec8dc1f270c6c9710623a192b984cf46f8a5613))
16
+ * update background task service ([e483ddb](https://github.com/twinfoundation/auditable-item-graph/commit/e483ddbc948f035334f92b8342248caa6abbe441))
17
+ * update dependencies ([6986689](https://github.com/twinfoundation/auditable-item-graph/commit/698668957a1fcb7f85ce2f117914d5980043924f))
18
+ * update edges to use targetId instead of id ([6c5d0e3](https://github.com/twinfoundation/auditable-item-graph/commit/6c5d0e31b6e2ea74bfa2f3344e4be628e5f237af))
19
+ * update framework core ([88ad4e6](https://github.com/twinfoundation/auditable-item-graph/commit/88ad4e6421132c3c6c45579b078d982a26f16990))
20
+ * update ts-to-schema generation ([edce91e](https://github.com/twinfoundation/auditable-item-graph/commit/edce91e8272ab361595489458066040caf582df2))
21
+ * use new nameof operators ([3921c4c](https://github.com/twinfoundation/auditable-item-graph/commit/3921c4c9ac53e42459e45f10d9e702afb2797a23))
22
+ * use shared store mechanism ([#10](https://github.com/twinfoundation/auditable-item-graph/issues/10)) ([da035e5](https://github.com/twinfoundation/auditable-item-graph/commit/da035e5eb8f157482b4eb2bdbc689c6c0647ff7d))
23
+ * use standard list json ld types ([8f53836](https://github.com/twinfoundation/auditable-item-graph/commit/8f53836d4c83a98d64d7f5fe0531bb9af09464ae))
24
+
25
+
26
+ ### Bug Fixes
27
+
28
+ * 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))
29
+ * query params force coercion ([2dd9afe](https://github.com/twinfoundation/auditable-item-graph/commit/2dd9afe9ec37e2a91c110317fe289f7495c187a0))
30
+
3
31
  ## [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
32
 
5
33
 
@@ -36,9 +36,9 @@ The date/time of when the changeset was created.
36
36
 
37
37
  ***
38
38
 
39
- ### userIdentity
39
+ ### userIdentity?
40
40
 
41
- > **userIdentity**: `string`
41
+ > `optional` **userIdentity**: `string`
42
42
 
43
43
  The user identity that created the changes.
44
44
 
@@ -6,19 +6,11 @@ Interface describing an auditable item graph contract.
6
6
 
7
7
  - `IComponent`
8
8
 
9
- ## Indexable
10
-
11
- \[`key`: `string`\]: `any`
12
-
13
- All methods are optional, so we introduce an index signature to allow
14
- any additional properties or methods, which removes the TypeScript error where
15
- the class has no properties in common with the type.
16
-
17
9
  ## Methods
18
10
 
19
11
  ### create()
20
12
 
21
- > **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
13
+ > **create**(`vertex`): `Promise`\<`string`\>
22
14
 
23
15
  Create a new graph vertex.
24
16
 
@@ -52,18 +44,6 @@ The resources attached to the vertex.
52
44
 
53
45
  The edges connected to the vertex.
54
46
 
55
- ##### userIdentity?
56
-
57
- `string`
58
-
59
- The identity to create the auditable item graph operation with.
60
-
61
- ##### nodeIdentity?
62
-
63
- `string`
64
-
65
- The node identity to use for vault operations.
66
-
67
47
  #### Returns
68
48
 
69
49
  `Promise`\<`string`\>
@@ -74,7 +54,7 @@ The id of the new graph item.
74
54
 
75
55
  ### update()
76
56
 
77
- > **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
57
+ > **update**(`vertex`): `Promise`\<`void`\>
78
58
 
79
59
  Update a graph vertex.
80
60
 
@@ -114,18 +94,6 @@ The resources attached to the vertex.
114
94
 
115
95
  The edges connected to the vertex.
116
96
 
117
- ##### userIdentity?
118
-
119
- `string`
120
-
121
- The identity to create the auditable item graph operation with.
122
-
123
- ##### nodeIdentity?
124
-
125
- `string`
126
-
127
- The node identity to use for vault operations.
128
-
129
97
  #### Returns
130
98
 
131
99
  `Promise`\<`void`\>
@@ -184,7 +152,7 @@ NotFoundError if the vertex is not found.
184
152
 
185
153
  ### removeVerifiable()
186
154
 
187
- > **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
155
+ > **removeVerifiable**(`id`): `Promise`\<`void`\>
188
156
 
189
157
  Remove the verifiable storage for an item.
190
158
 
@@ -196,12 +164,6 @@ Remove the verifiable storage for an item.
196
164
 
197
165
  The id of the vertex to remove the storage from.
198
166
 
199
- ##### nodeIdentity?
200
-
201
- `string`
202
-
203
- The node identity to use for vault operations.
204
-
205
167
  #### Returns
206
168
 
207
169
  `Promise`\<`void`\>
@@ -38,13 +38,13 @@ 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
45
  #### includeChangesets?
46
46
 
47
- > `optional` **includeChangesets**: `string` \| `boolean`
47
+ > `optional` **includeChangesets**: `string`
48
48
 
49
49
  Whether to include the changesets of the vertex, defaults to false.
50
50
 
@@ -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
 
@@ -72,11 +72,11 @@ JSON-LD Type.
72
72
 
73
73
  ***
74
74
 
75
- ### nodeIdentity?
75
+ ### organizationIdentity?
76
76
 
77
- > `optional` **nodeIdentity**: `string`
77
+ > `optional` **organizationIdentity**: `string`
78
78
 
79
- The identity of the node which controls the vertex.
79
+ The identity of the organization which controls the vertex.
80
80
 
81
81
  ***
82
82
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/auditable-item-graph-models",
3
- "version": "0.0.2-next.8",
3
+ "version": "0.0.3-next.1",
4
4
  "description": "Models which define the structure of the auditable item graph connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,20 +23,18 @@
23
23
  "@twin.org/standards-schema-org": "next",
24
24
  "@twin.org/web": "next"
25
25
  },
26
- "main": "./dist/cjs/index.cjs",
27
- "module": "./dist/esm/index.mjs",
26
+ "main": "./dist/es/index.js",
28
27
  "types": "./dist/types/index.d.ts",
29
28
  "exports": {
30
29
  ".": {
31
30
  "types": "./dist/types/index.d.ts",
32
- "require": "./dist/cjs/index.cjs",
33
- "import": "./dist/esm/index.mjs"
31
+ "import": "./dist/es/index.js",
32
+ "default": "./dist/es/index.js"
34
33
  },
35
34
  "./locales/*.json": "./locales/*.json"
36
35
  },
37
36
  "files": [
38
- "dist/cjs",
39
- "dist/esm",
37
+ "dist/es",
40
38
  "dist/types",
41
39
  "locales",
42
40
  "docs"