@twin.org/entity-storage-models 0.0.1-next.27 → 0.0.1-next.29

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 (4) hide show
  1. package/docs/changelog.md +14 -0
  2. package/docs/reference/interfaces/IEntityStorageComponent.md +7 -5
  3. package/docs/reference/interfaces/IEntityStorageConnector.md +7 -5
  4. package/package.json +1 -1
package/docs/changelog.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @twin.org/entity-storage-models - Changelog
2
2
 
3
+ ## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.28...entity-storage-models-v0.0.1-next.29) (2025-04-17)
4
+
5
+
6
+ ### Features
7
+
8
+ * use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
9
+
10
+ ## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.27...entity-storage-models-v0.0.1-next.28) (2025-04-09)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **entity-storage-models:** Synchronize repo versions
16
+
3
17
  ## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-models-v0.0.1-next.26...entity-storage-models-v0.0.1-next.27) (2025-03-28)
4
18
 
5
19
 
package/docs/reference/interfaces/IEntityStorageComponent.md CHANGED
@@ -8,13 +8,15 @@ Interface describing an entity storage component.
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- • **T** = `unknown`
11
+ ### T
12
+
13
+ `T` = `unknown`
12
14
 
13
15
  ## Methods
14
16
 
15
17
  ### set()
16
18
 
17
- > **set**(`entity`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
19
+ > **set**(`entity`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
18
20
 
19
21
  Set an entity.
20
22
 
@@ -48,7 +50,7 @@ The id of the entity.
48
50
 
49
51
  ### get()
50
52
 
51
- > **get**(`id`, `secondaryIndex`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`undefined` \| `T`\>
53
+ > **get**(`id`, `secondaryIndex?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`undefined` \| `T`\>
52
54
 
53
55
  Get an entity.
54
56
 
@@ -88,7 +90,7 @@ The object if it can be found or undefined.
88
90
 
89
91
  ### remove()
90
92
 
91
- > **remove**(`id`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
93
+ > **remove**(`id`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
92
94
 
93
95
  Remove the entity.
94
96
 
@@ -122,7 +124,7 @@ Nothing.
122
124
 
123
125
  ### query()
124
126
 
125
- > **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `properties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
127
+ > **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `properties?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
126
128
 
127
129
  Query all the entities which match the conditions.
128
130
 
package/docs/reference/interfaces/IEntityStorageConnector.md CHANGED
@@ -8,7 +8,9 @@ Interface describing an entity storage connector.
8
8
 
9
9
  ## Type Parameters
10
10
 
11
- • **T** = `unknown`
11
+ ### T
12
+
13
+ `T` = `unknown`
12
14
 
13
15
  ## Methods
14
16
 
@@ -28,7 +30,7 @@ The schema for the entities.
28
30
 
29
31
  ### set()
30
32
 
31
- > **set**(`entity`, `conditions`?): `Promise`\<`void`\>
33
+ > **set**(`entity`, `conditions?`): `Promise`\<`void`\>
32
34
 
33
35
  Set an entity.
34
36
 
@@ -56,7 +58,7 @@ The id of the entity.
56
58
 
57
59
  ### get()
58
60
 
59
- > **get**(`id`, `secondaryIndex`?, `conditions`?): `Promise`\<`undefined` \| `T`\>
61
+ > **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
60
62
 
61
63
  Get an entity.
62
64
 
@@ -90,7 +92,7 @@ The object if it can be found or undefined.
90
92
 
91
93
  ### remove()
92
94
 
93
- > **remove**(`id`, `conditions`?): `Promise`\<`void`\>
95
+ > **remove**(`id`, `conditions?`): `Promise`\<`void`\>
94
96
 
95
97
  Remove the entity.
96
98
 
@@ -118,7 +120,7 @@ Nothing.
118
120
 
119
121
  ### query()
120
122
 
121
- > **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
123
+ > **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor`: `string`; \}\>
122
124
 
123
125
  Query all the entities which match the conditions.
124
126
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/entity-storage-models",
3
- "version": "0.0.1-next.27",
3
+ "version": "0.0.1-next.29",
4
4
  "description": "Models which define the structure of the entity storage contracts and connectors",
5
5
  "repository": {
6
6
  "type": "git",