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

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 (74) 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 +9 -14
  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 +1 -1
  64. package/dist/types/models/api/IAuditableItemGraphGetResponse.d.ts +1 -1
  65. package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +3 -3
  66. package/dist/types/models/api/IAuditableItemGraphListResponse.d.ts +1 -1
  67. package/docs/changelog.md +7 -0
  68. package/docs/reference/interfaces/IAuditableItemGraphChangeset.md +2 -2
  69. package/docs/reference/interfaces/IAuditableItemGraphComponent.md +7 -37
  70. package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +3 -3
  71. package/docs/reference/interfaces/IAuditableItemGraphVertex.md +3 -3
  72. package/package.json +21 -8
  73. package/dist/cjs/index.cjs +0 -716
  74. package/dist/esm/index.mjs +0 -710
@@ -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
 
@@ -10,7 +10,7 @@ Interface describing an auditable item graph contract.
10
10
 
11
11
  ### create()
12
12
 
13
- > **create**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
13
+ > **create**(`vertex`): `Promise`\<`string`\>
14
14
 
15
15
  Create a new graph vertex.
16
16
 
@@ -44,18 +44,6 @@ The resources attached to the vertex.
44
44
 
45
45
  The edges connected to the vertex.
46
46
 
47
- ##### userIdentity?
48
-
49
- `string`
50
-
51
- The identity to create the auditable item graph operation with.
52
-
53
- ##### nodeIdentity?
54
-
55
- `string`
56
-
57
- The node identity to use for vault operations.
58
-
59
47
  #### Returns
60
48
 
61
49
  `Promise`\<`string`\>
@@ -66,7 +54,7 @@ The id of the new graph item.
66
54
 
67
55
  ### update()
68
56
 
69
- > **update**(`vertex`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
57
+ > **update**(`vertex`): `Promise`\<`void`\>
70
58
 
71
59
  Update a graph vertex.
72
60
 
@@ -106,18 +94,6 @@ The resources attached to the vertex.
106
94
 
107
95
  The edges connected to the vertex.
108
96
 
109
- ##### userIdentity?
110
-
111
- `string`
112
-
113
- The identity to create the auditable item graph operation with.
114
-
115
- ##### nodeIdentity?
116
-
117
- `string`
118
-
119
- The node identity to use for vault operations.
120
-
121
97
  #### Returns
122
98
 
123
99
  `Promise`\<`void`\>
@@ -176,7 +152,7 @@ NotFoundError if the vertex is not found.
176
152
 
177
153
  ### removeVerifiable()
178
154
 
179
- > **removeVerifiable**(`id`, `nodeIdentity?`): `Promise`\<`void`\>
155
+ > **removeVerifiable**(`id`): `Promise`\<`void`\>
180
156
 
181
157
  Remove the verifiable storage for an item.
182
158
 
@@ -188,12 +164,6 @@ Remove the verifiable storage for an item.
188
164
 
189
165
  The id of the vertex to remove the storage from.
190
166
 
191
- ##### nodeIdentity?
192
-
193
- `string`
194
-
195
- The node identity to use for vault operations.
196
-
197
167
  #### Returns
198
168
 
199
169
  `Promise`\<`void`\>
@@ -208,7 +178,7 @@ NotFoundError if the vertex is not found.
208
178
 
209
179
  ### query()
210
180
 
211
- > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
181
+ > **query**(`options?`, `conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `limit?`): `Promise`\<[`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)\>
212
182
 
213
183
  Query the graph for vertices.
214
184
 
@@ -270,13 +240,13 @@ The properties to return, if not provided defaults to id, dateCreated, aliases a
270
240
 
271
241
  `string`
272
242
 
273
- The cursor to request the next page of entities.
243
+ The cursor to request the next chunk of entities.
274
244
 
275
- ##### pageSize?
245
+ ##### limit?
276
246
 
277
247
  `number`
278
248
 
279
- The maximum number of entities in a page.
249
+ Limit the number of entities to return.
280
250
 
281
251
  #### Returns
282
252
 
@@ -76,8 +76,8 @@ The properties to return as a comma separated list, defaults to "id,dateCreated,
76
76
 
77
77
  The optional cursor to get next chunk.
78
78
 
79
- #### pageSize?
79
+ #### limit?
80
80
 
81
- > `optional` **pageSize**: `string` \| `number`
81
+ > `optional` **limit**: `string`
82
82
 
83
- The maximum number of entities in a page.
83
+ Limit the number of entities to return.
@@ -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.7",
3
+ "version": "0.0.3-next.0",
4
4
  "description": "Models which define the structure of the auditable item graph connectors and services",
5
5
  "repository": {
6
6
  "type": "git",
@@ -23,22 +23,35 @@
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"
43
- ]
41
+ ],
42
+ "keywords": [
43
+ "twin",
44
+ "trade",
45
+ "iota",
46
+ "framework",
47
+ "blockchain",
48
+ "auditable-item-graph",
49
+ "models",
50
+ "types",
51
+ "schemas"
52
+ ],
53
+ "bugs": {
54
+ "url": "git+https://github.com/twinfoundation/auditable-item-graph/issues"
55
+ },
56
+ "homepage": "https://twindev.org"
44
57
  }