@twin.org/entity-storage-rest-client 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.
Files changed (3) hide show
  1. package/docs/changelog.md +28 -0
  2. package/docs/reference/classes/EntityStorageClient.md +9 -7
  3. package/package.json +2 -2
package/docs/changelog.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # @twin.org/entity-storage-rest-client - Changelog
2
2
 
3
+ ## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-rest-client-v0.0.1-next.29...entity-storage-rest-client-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
+
17
+ ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-rest-client-v0.0.1-next.28...entity-storage-rest-client-v0.0.1-next.29) (2025-04-17)
18
+
19
+
20
+ ### Features
21
+
22
+ * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
23
+
24
+
25
+ ### Dependencies
26
+
27
+ * The following workspace dependencies were updated
28
+ * dependencies
29
+ * @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
30
+
3
31
  ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-rest-client-v0.0.1-next.27...entity-storage-rest-client-v0.0.1-next.28) (2025-04-09)
4
32
 
5
33
 
package/docs/reference/classes/EntityStorageClient.md CHANGED
@@ -8,7 +8,9 @@ Client for performing entity storage through to REST endpoints.
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- • **T**
11
+ ### T
12
+
13
+ `T`
12
14
 
13
15
  ## Implements
14
16
 
@@ -16,9 +18,9 @@ Client for performing entity storage through to REST endpoints.
16
18
 
17
19
  ## Constructors
18
20
 
19
- ### new EntityStorageClient()
21
+ ### Constructor
20
22
 
21
- > **new EntityStorageClient**\<`T`\>(`config`): [`EntityStorageClient`](EntityStorageClient.md)\<`T`\>
23
+ > **new EntityStorageClient**\<`T`\>(`config`): `EntityStorageClient`\<`T`\>
22
24
 
23
25
  Create a new instance of EntityStorageClient.
24
26
 
@@ -32,7 +34,7 @@ The configuration for the client.
32
34
 
33
35
  #### Returns
34
36
 
35
- [`EntityStorageClient`](EntityStorageClient.md)\<`T`\>
37
+ `EntityStorageClient`\<`T`\>
36
38
 
37
39
  #### Overrides
38
40
 
@@ -80,7 +82,7 @@ The id of the entity.
80
82
 
81
83
  ### get()
82
84
 
83
- > **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
85
+ > **get**(`id`, `secondaryIndex?`): `Promise`\<`undefined` \| `T`\>
84
86
 
85
87
  Get an entity.
86
88
 
@@ -138,7 +140,7 @@ Nothing.
138
140
 
139
141
  ### query()
140
142
 
141
- > **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
143
+ > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
142
144
 
143
145
  Query all the entities which match the conditions.
144
146
 
@@ -182,7 +184,7 @@ The suggested number of entities to return in each chunk, in some scenarios can
182
184
 
183
185
  #### Returns
184
186
 
185
- `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
187
+ `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
186
188
 
187
189
  All the entities for the storage matching the conditions,
188
190
  and a cursor which can be used to request more entities.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/entity-storage-rest-client",
3
- "version": "0.0.1-next.28",
3
+ "version": "0.0.1-next.30",
4
4
  "description": "Entity Storage contract implementation which can connect to REST endpoints",
5
5
  "repository": {
6
6
  "type": "git",
@@ -18,7 +18,7 @@
18
18
  "@twin.org/api-models": "next",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/entity": "next",
21
- "@twin.org/entity-storage-models": "0.0.1-next.28",
21
+ "@twin.org/entity-storage-models": "0.0.1-next.30",
22
22
  "@twin.org/nameof": "next",
23
23
  "@twin.org/web": "next"
24
24
  },