@twin.org/entity-storage-service 0.0.1-next.28 → 0.0.1-next.30
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.
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @twin.org/entity-storage-service - Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.29...entity-storage-service-v0.0.1-next.30) (2025-06-12)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/entity-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
|
|
16
|
+
* devDependencies
|
|
17
|
+
* @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
|
|
18
|
+
|
|
19
|
+
## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.28...entity-storage-service-v0.0.1-next.29) (2025-04-17)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
### Features
|
|
23
|
+
|
|
24
|
+
* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
### Dependencies
|
|
28
|
+
|
|
29
|
+
* The following workspace dependencies were updated
|
|
30
|
+
* dependencies
|
|
31
|
+
* @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
|
|
32
|
+
* devDependencies
|
|
33
|
+
* @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
|
|
34
|
+
|
|
3
35
|
## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-service-v0.0.1-next.27...entity-storage-service-v0.0.1-next.28) (2025-04-09)
|
|
4
36
|
|
|
5
37
|
|
|
@@ -4,7 +4,9 @@ Class for performing entity service operations.
|
|
|
4
4
|
|
|
5
5
|
## Type Parameters
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
### T
|
|
8
|
+
|
|
9
|
+
`T` = `any`
|
|
8
10
|
|
|
9
11
|
## Implements
|
|
10
12
|
|
|
@@ -12,9 +14,9 @@ Class for performing entity service operations.
|
|
|
12
14
|
|
|
13
15
|
## Constructors
|
|
14
16
|
|
|
15
|
-
###
|
|
17
|
+
### Constructor
|
|
16
18
|
|
|
17
|
-
> **new EntityStorageService**\<`T`\>(`options`):
|
|
19
|
+
> **new EntityStorageService**\<`T`\>(`options`): `EntityStorageService`\<`T`\>
|
|
18
20
|
|
|
19
21
|
Create a new instance of EntityStorageService.
|
|
20
22
|
|
|
@@ -28,7 +30,7 @@ The dependencies for the entity storage service.
|
|
|
28
30
|
|
|
29
31
|
#### Returns
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
`EntityStorageService`\<`T`\>
|
|
32
34
|
|
|
33
35
|
## Properties
|
|
34
36
|
|
|
@@ -46,7 +48,7 @@ Runtime name for the class.
|
|
|
46
48
|
|
|
47
49
|
### set()
|
|
48
50
|
|
|
49
|
-
> **set**(`entity`, `userIdentity
|
|
51
|
+
> **set**(`entity`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
|
|
50
52
|
|
|
51
53
|
Set an entity.
|
|
52
54
|
|
|
@@ -84,7 +86,7 @@ The id of the entity.
|
|
|
84
86
|
|
|
85
87
|
### get()
|
|
86
88
|
|
|
87
|
-
> **get**(`id`, `secondaryIndex
|
|
89
|
+
> **get**(`id`, `secondaryIndex?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`undefined` \| `T`\>
|
|
88
90
|
|
|
89
91
|
Get an entity.
|
|
90
92
|
|
|
@@ -128,7 +130,7 @@ The object if it can be found or undefined.
|
|
|
128
130
|
|
|
129
131
|
### remove()
|
|
130
132
|
|
|
131
|
-
> **remove**(`id`, `userIdentity
|
|
133
|
+
> **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
|
|
132
134
|
|
|
133
135
|
Remove the entity.
|
|
134
136
|
|
|
@@ -166,7 +168,7 @@ Nothing.
|
|
|
166
168
|
|
|
167
169
|
### query()
|
|
168
170
|
|
|
169
|
-
> **query**(`conditions
|
|
171
|
+
> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
|
|
170
172
|
|
|
171
173
|
Query all the entities which match the conditions.
|
|
172
174
|
|
|
@@ -222,7 +224,7 @@ The node identity to use with storage operations.
|
|
|
222
224
|
|
|
223
225
|
#### Returns
|
|
224
226
|
|
|
225
|
-
`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor
|
|
227
|
+
`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
|
|
226
228
|
|
|
227
229
|
All the entities for the storage matching the conditions,
|
|
228
230
|
and a cursor which can be used to request more entities.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Function: generateRestRoutesEntityStorage()
|
|
2
2
|
|
|
3
|
-
> **generateRestRoutesEntityStorage**(`baseRouteName`, `componentName`, `options
|
|
3
|
+
> **generateRestRoutesEntityStorage**(`baseRouteName`, `componentName`, `options?`): `IRestRoute`\<`any`, `any`\>[]
|
|
4
4
|
|
|
5
5
|
The REST routes for entity storage.
|
|
6
6
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/entity-storage-service",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.30",
|
|
4
4
|
"description": "Entity Storage contract implementation and REST endpoint definitions",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"@twin.org/api-models": "next",
|
|
18
18
|
"@twin.org/core": "next",
|
|
19
19
|
"@twin.org/entity": "next",
|
|
20
|
-
"@twin.org/entity-storage-models": "0.0.1-next.
|
|
20
|
+
"@twin.org/entity-storage-models": "0.0.1-next.30",
|
|
21
21
|
"@twin.org/nameof": "next",
|
|
22
22
|
"@twin.org/web": "next"
|
|
23
23
|
},
|