@twin.org/entity 0.0.2-next.9 → 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 (60) hide show
  1. package/dist/es/decorators/entityDecorator.js +19 -0
  2. package/dist/es/decorators/entityDecorator.js.map +1 -0
  3. package/dist/es/decorators/propertyDecorator.js +31 -0
  4. package/dist/es/decorators/propertyDecorator.js.map +1 -0
  5. package/dist/es/factories/entitySchemaFactory.js +9 -0
  6. package/dist/es/factories/entitySchemaFactory.js.map +1 -0
  7. package/dist/es/index.js +22 -0
  8. package/dist/es/index.js.map +1 -0
  9. package/dist/es/models/IComparator.js +2 -0
  10. package/dist/es/models/IComparator.js.map +1 -0
  11. package/dist/es/models/IComparatorGroup.js +2 -0
  12. package/dist/es/models/IComparatorGroup.js.map +1 -0
  13. package/dist/es/models/IEntitySchema.js +2 -0
  14. package/dist/es/models/IEntitySchema.js.map +1 -0
  15. package/dist/es/models/IEntitySchemaOptions.js +4 -0
  16. package/dist/es/models/IEntitySchemaOptions.js.map +1 -0
  17. package/dist/es/models/IEntitySchemaProperty.js +2 -0
  18. package/dist/es/models/IEntitySchemaProperty.js.map +1 -0
  19. package/dist/es/models/IEntitySort.js +2 -0
  20. package/dist/es/models/IEntitySort.js.map +1 -0
  21. package/dist/es/models/comparisonOperator.js +52 -0
  22. package/dist/es/models/comparisonOperator.js.map +1 -0
  23. package/dist/es/models/entityCondition.js +2 -0
  24. package/dist/es/models/entityCondition.js.map +1 -0
  25. package/dist/es/models/entitySchemaPropertyFormat.js +77 -0
  26. package/dist/es/models/entitySchemaPropertyFormat.js.map +1 -0
  27. package/dist/es/models/entitySchemaPropertyType.js +33 -0
  28. package/dist/es/models/entitySchemaPropertyType.js.map +1 -0
  29. package/dist/es/models/logicalOperator.js +17 -0
  30. package/dist/es/models/logicalOperator.js.map +1 -0
  31. package/dist/es/models/sortDirection.js +17 -0
  32. package/dist/es/models/sortDirection.js.map +1 -0
  33. package/dist/es/utils/decoratorHelper.js +29 -0
  34. package/dist/es/utils/decoratorHelper.js.map +1 -0
  35. package/dist/es/utils/entityConditions.js +175 -0
  36. package/dist/es/utils/entityConditions.js.map +1 -0
  37. package/dist/es/utils/entitySchemaHelper.js +143 -0
  38. package/dist/es/utils/entitySchemaHelper.js.map +1 -0
  39. package/dist/es/utils/entitySorter.js +72 -0
  40. package/dist/es/utils/entitySorter.js.map +1 -0
  41. package/dist/types/decorators/entityDecorator.d.ts +1 -1
  42. package/dist/types/decorators/propertyDecorator.d.ts +1 -1
  43. package/dist/types/factories/entitySchemaFactory.d.ts +1 -1
  44. package/dist/types/index.d.ts +19 -19
  45. package/dist/types/models/IComparator.d.ts +1 -1
  46. package/dist/types/models/IComparatorGroup.d.ts +2 -2
  47. package/dist/types/models/IEntitySchema.d.ts +2 -2
  48. package/dist/types/models/IEntitySchemaProperty.d.ts +3 -3
  49. package/dist/types/models/IEntitySort.d.ts +2 -2
  50. package/dist/types/models/entityCondition.d.ts +2 -2
  51. package/dist/types/utils/decoratorHelper.d.ts +1 -1
  52. package/dist/types/utils/entityConditions.d.ts +2 -2
  53. package/dist/types/utils/entitySchemaHelper.d.ts +8 -4
  54. package/dist/types/utils/entitySorter.d.ts +3 -3
  55. package/docs/changelog.md +262 -0
  56. package/docs/reference/classes/EntitySchemaHelper.md +12 -4
  57. package/docs/reference/interfaces/IEntitySchema.md +1 -1
  58. package/package.json +19 -10
  59. package/dist/cjs/index.cjs +0 -673
  60. package/dist/esm/index.mjs +0 -660
package/docs/changelog.md CHANGED
@@ -1,5 +1,267 @@
1
1
  # @twin.org/entity - Changelog
2
2
 
3
+ ## [0.0.3-next.1](https://github.com/twinfoundation/framework/compare/entity-v0.0.3-next.0...entity-v0.0.3-next.1) (2025-11-10)
4
+
5
+
6
+ ### Features
7
+
8
+ * add context id features ([#206](https://github.com/twinfoundation/framework/issues/206)) ([ef0d4ee](https://github.com/twinfoundation/framework/commit/ef0d4ee11a4f5fc6cc6f52a4958ce905c04ee13b))
9
+ * add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
10
+ * eslint migration to flat config ([74427d7](https://github.com/twinfoundation/framework/commit/74427d78d342167f7850e49ab87269326355befe))
11
+ * locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
12
+ * relocate core packages from tools ([bcab8f3](https://github.com/twinfoundation/framework/commit/bcab8f3160442ea4fcaf442947462504f3d6a17d))
13
+ * update dependencies ([f3bd015](https://github.com/twinfoundation/framework/commit/f3bd015efd169196b7e0335f5cab876ba6ca1d75))
14
+ * use cause instead of inner for errors ([1f4acc4](https://github.com/twinfoundation/framework/commit/1f4acc4d7a6b71a134d9547da9bf40de1e1e49da))
15
+ * use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
16
+
17
+
18
+ ### Dependencies
19
+
20
+ * The following workspace dependencies were updated
21
+ * dependencies
22
+ * @twin.org/nameof bumped from 0.0.3-next.0 to 0.0.3-next.1
23
+ * @twin.org/core bumped from 0.0.3-next.0 to 0.0.3-next.1
24
+ * devDependencies
25
+ * @twin.org/nameof-transformer bumped from 0.0.3-next.0 to 0.0.3-next.1
26
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.0 to 0.0.3-next.1
27
+ * @twin.org/validate-locales bumped from 0.0.3-next.0 to 0.0.3-next.1
28
+
29
+ ## [0.0.2-next.22](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.21...entity-v0.0.2-next.22) (2025-10-10)
30
+
31
+
32
+ ### Miscellaneous Chores
33
+
34
+ * **entity:** Synchronize repo versions
35
+
36
+
37
+ ### Dependencies
38
+
39
+ * The following workspace dependencies were updated
40
+ * dependencies
41
+ * @twin.org/nameof bumped from 0.0.2-next.21 to 0.0.2-next.22
42
+ * @twin.org/core bumped from 0.0.2-next.21 to 0.0.2-next.22
43
+ * devDependencies
44
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.21 to 0.0.2-next.22
45
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.21 to 0.0.2-next.22
46
+ * @twin.org/validate-locales bumped from 0.0.2-next.21 to 0.0.2-next.22
47
+
48
+ ## [0.0.2-next.21](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.20...entity-v0.0.2-next.21) (2025-10-09)
49
+
50
+
51
+ ### Features
52
+
53
+ * locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
54
+
55
+
56
+ ### Dependencies
57
+
58
+ * The following workspace dependencies were updated
59
+ * dependencies
60
+ * @twin.org/nameof bumped from 0.0.2-next.20 to 0.0.2-next.21
61
+ * @twin.org/core bumped from 0.0.2-next.20 to 0.0.2-next.21
62
+ * devDependencies
63
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.20 to 0.0.2-next.21
64
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.20 to 0.0.2-next.21
65
+ * @twin.org/validate-locales bumped from 0.0.2-next.20 to 0.0.2-next.21
66
+
67
+ ## [0.0.2-next.20](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.19...entity-v0.0.2-next.20) (2025-10-02)
68
+
69
+
70
+ ### Miscellaneous Chores
71
+
72
+ * **entity:** Synchronize repo versions
73
+
74
+
75
+ ### Dependencies
76
+
77
+ * The following workspace dependencies were updated
78
+ * dependencies
79
+ * @twin.org/nameof bumped from 0.0.2-next.19 to 0.0.2-next.20
80
+ * @twin.org/core bumped from 0.0.2-next.19 to 0.0.2-next.20
81
+ * devDependencies
82
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.19 to 0.0.2-next.20
83
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.19 to 0.0.2-next.20
84
+
85
+ ## [0.0.2-next.19](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.18...entity-v0.0.2-next.19) (2025-09-30)
86
+
87
+
88
+ ### Miscellaneous Chores
89
+
90
+ * **entity:** Synchronize repo versions
91
+
92
+
93
+ ### Dependencies
94
+
95
+ * The following workspace dependencies were updated
96
+ * dependencies
97
+ * @twin.org/nameof bumped from 0.0.2-next.18 to 0.0.2-next.19
98
+ * @twin.org/core bumped from 0.0.2-next.18 to 0.0.2-next.19
99
+ * devDependencies
100
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.18 to 0.0.2-next.19
101
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.18 to 0.0.2-next.19
102
+
103
+ ## [0.0.2-next.18](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.17...entity-v0.0.2-next.18) (2025-09-29)
104
+
105
+
106
+ ### Miscellaneous Chores
107
+
108
+ * **entity:** Synchronize repo versions
109
+
110
+
111
+ ### Dependencies
112
+
113
+ * The following workspace dependencies were updated
114
+ * dependencies
115
+ * @twin.org/nameof bumped from 0.0.2-next.17 to 0.0.2-next.18
116
+ * @twin.org/core bumped from 0.0.2-next.17 to 0.0.2-next.18
117
+ * devDependencies
118
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.17 to 0.0.2-next.18
119
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.17 to 0.0.2-next.18
120
+
121
+ ## [0.0.2-next.17](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.16...entity-v0.0.2-next.17) (2025-09-29)
122
+
123
+
124
+ ### Miscellaneous Chores
125
+
126
+ * **entity:** Synchronize repo versions
127
+
128
+
129
+ ### Dependencies
130
+
131
+ * The following workspace dependencies were updated
132
+ * dependencies
133
+ * @twin.org/nameof bumped from 0.0.2-next.16 to 0.0.2-next.17
134
+ * @twin.org/core bumped from 0.0.2-next.16 to 0.0.2-next.17
135
+ * devDependencies
136
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.16 to 0.0.2-next.17
137
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.16 to 0.0.2-next.17
138
+
139
+ ## [0.0.2-next.16](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.15...entity-v0.0.2-next.16) (2025-09-28)
140
+
141
+
142
+ ### Miscellaneous Chores
143
+
144
+ * **entity:** Synchronize repo versions
145
+
146
+
147
+ ### Dependencies
148
+
149
+ * The following workspace dependencies were updated
150
+ * dependencies
151
+ * @twin.org/nameof bumped from 0.0.2-next.15 to 0.0.2-next.16
152
+ * @twin.org/core bumped from 0.0.2-next.15 to 0.0.2-next.16
153
+ * devDependencies
154
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.15 to 0.0.2-next.16
155
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.15 to 0.0.2-next.16
156
+
157
+ ## [0.0.2-next.15](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.14...entity-v0.0.2-next.15) (2025-09-22)
158
+
159
+
160
+ ### Miscellaneous Chores
161
+
162
+ * **entity:** Synchronize repo versions
163
+
164
+
165
+ ### Dependencies
166
+
167
+ * The following workspace dependencies were updated
168
+ * dependencies
169
+ * @twin.org/nameof bumped from 0.0.2-next.14 to 0.0.2-next.15
170
+ * @twin.org/core bumped from 0.0.2-next.14 to 0.0.2-next.15
171
+ * devDependencies
172
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.14 to 0.0.2-next.15
173
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.14 to 0.0.2-next.15
174
+
175
+ ## [0.0.2-next.14](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.13...entity-v0.0.2-next.14) (2025-09-22)
176
+
177
+
178
+ ### Miscellaneous Chores
179
+
180
+ * **entity:** Synchronize repo versions
181
+
182
+
183
+ ### Dependencies
184
+
185
+ * The following workspace dependencies were updated
186
+ * dependencies
187
+ * @twin.org/nameof bumped from 0.0.2-next.13 to 0.0.2-next.14
188
+ * @twin.org/core bumped from 0.0.2-next.13 to 0.0.2-next.14
189
+ * devDependencies
190
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.13 to 0.0.2-next.14
191
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.13 to 0.0.2-next.14
192
+
193
+ ## [0.0.2-next.13](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.12...entity-v0.0.2-next.13) (2025-09-22)
194
+
195
+
196
+ ### Miscellaneous Chores
197
+
198
+ * **entity:** Synchronize repo versions
199
+
200
+
201
+ ### Dependencies
202
+
203
+ * The following workspace dependencies were updated
204
+ * dependencies
205
+ * @twin.org/nameof bumped from 0.0.2-next.12 to 0.0.2-next.13
206
+ * @twin.org/core bumped from 0.0.2-next.12 to 0.0.2-next.13
207
+ * devDependencies
208
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.12 to 0.0.2-next.13
209
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.12 to 0.0.2-next.13
210
+
211
+ ## [0.0.2-next.12](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.11...entity-v0.0.2-next.12) (2025-09-15)
212
+
213
+
214
+ ### Miscellaneous Chores
215
+
216
+ * **entity:** Synchronize repo versions
217
+
218
+
219
+ ### Dependencies
220
+
221
+ * The following workspace dependencies were updated
222
+ * dependencies
223
+ * @twin.org/nameof bumped from 0.0.2-next.11 to 0.0.2-next.12
224
+ * @twin.org/core bumped from 0.0.2-next.11 to 0.0.2-next.12
225
+ * devDependencies
226
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.11 to 0.0.2-next.12
227
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.11 to 0.0.2-next.12
228
+
229
+ ## [0.0.2-next.11](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.10...entity-v0.0.2-next.11) (2025-09-15)
230
+
231
+
232
+ ### Miscellaneous Chores
233
+
234
+ * **entity:** Synchronize repo versions
235
+
236
+
237
+ ### Dependencies
238
+
239
+ * The following workspace dependencies were updated
240
+ * dependencies
241
+ * @twin.org/nameof bumped from 0.0.2-next.10 to 0.0.2-next.11
242
+ * @twin.org/core bumped from 0.0.2-next.10 to 0.0.2-next.11
243
+ * devDependencies
244
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.10 to 0.0.2-next.11
245
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.10 to 0.0.2-next.11
246
+
247
+ ## [0.0.2-next.10](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.9...entity-v0.0.2-next.10) (2025-09-11)
248
+
249
+
250
+ ### Miscellaneous Chores
251
+
252
+ * **entity:** Synchronize repo versions
253
+
254
+
255
+ ### Dependencies
256
+
257
+ * The following workspace dependencies were updated
258
+ * dependencies
259
+ * @twin.org/nameof bumped from 0.0.2-next.9 to 0.0.2-next.10
260
+ * @twin.org/core bumped from 0.0.2-next.9 to 0.0.2-next.10
261
+ * devDependencies
262
+ * @twin.org/nameof-transformer bumped from 0.0.2-next.9 to 0.0.2-next.10
263
+ * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.9 to 0.0.2-next.10
264
+
3
265
  ## [0.0.2-next.9](https://github.com/twinfoundation/framework/compare/entity-v0.0.2-next.8...entity-v0.0.2-next.9) (2025-09-08)
4
266
 
5
267
 
@@ -12,6 +12,14 @@ Class to help with entity schema operations.
12
12
 
13
13
  `EntitySchemaHelper`
14
14
 
15
+ ## Properties
16
+
17
+ ### CLASS\_NAME
18
+
19
+ > `readonly` `static` **CLASS\_NAME**: `string`
20
+
21
+ Runtime name for the class.
22
+
15
23
  ## Methods
16
24
 
17
25
  ### getSchema()
@@ -76,7 +84,7 @@ If no primary key was found, or more than one.
76
84
 
77
85
  ### getSortProperties()
78
86
 
79
- > `static` **getSortProperties**\<`T`\>(`entitySchema`): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
87
+ > `static` **getSortProperties**\<`T`\>(`entitySchema`): [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
80
88
 
81
89
  Get the sort properties from the schema.
82
90
 
@@ -96,7 +104,7 @@ The entity schema to find the primary key from.
96
104
 
97
105
  #### Returns
98
106
 
99
- `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
107
+ [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
100
108
 
101
109
  The sort keys from the schema or undefined if there are none.
102
110
 
@@ -104,7 +112,7 @@ The sort keys from the schema or undefined if there are none.
104
112
 
105
113
  ### buildSortProperties()
106
114
 
107
- > `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys?`): `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
115
+ > `static` **buildSortProperties**\<`T`\>(`entitySchema`, `overrideSortKeys?`): [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
108
116
 
109
117
  Build sort properties from the schema and override if necessary.
110
118
 
@@ -130,7 +138,7 @@ The override sort keys.
130
138
 
131
139
  #### Returns
132
140
 
133
- `undefined` \| [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[]
141
+ [`IEntitySort`](../interfaces/IEntitySort.md)\<`T`\>[] \| `undefined`
134
142
 
135
143
  The finalised sort keys.
136
144
 
@@ -12,7 +12,7 @@ Definition for an entity schema.
12
12
 
13
13
  ### type
14
14
 
15
- > **type**: `undefined` \| `string`
15
+ > **type**: `string` \| `undefined`
16
16
 
17
17
  The type of the entity.
18
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/entity",
3
- "version": "0.0.2-next.9",
3
+ "version": "0.0.3-next.1",
4
4
  "description": "Helpers for defining and working with entities",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,26 +14,35 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/core": "0.0.2-next.9",
18
- "@twin.org/nameof": "0.0.2-next.9",
17
+ "@twin.org/core": "0.0.3-next.1",
18
+ "@twin.org/nameof": "0.0.3-next.1",
19
19
  "reflect-metadata": "0.2.2"
20
20
  },
21
- "main": "./dist/cjs/index.cjs",
22
- "module": "./dist/esm/index.mjs",
21
+ "main": "./dist/es/index.js",
23
22
  "types": "./dist/types/index.d.ts",
24
23
  "exports": {
25
24
  ".": {
26
25
  "types": "./dist/types/index.d.ts",
27
- "require": "./dist/cjs/index.cjs",
28
- "import": "./dist/esm/index.mjs"
26
+ "import": "./dist/es/index.js",
27
+ "default": "./dist/es/index.js"
29
28
  },
30
29
  "./locales/*.json": "./locales/*.json"
31
30
  },
32
31
  "files": [
33
- "dist/cjs",
34
- "dist/esm",
32
+ "dist/es",
35
33
  "dist/types",
36
34
  "locales",
37
35
  "docs"
38
- ]
36
+ ],
37
+ "keywords": [
38
+ "twin",
39
+ "trade",
40
+ "iota",
41
+ "framework",
42
+ "blockchain"
43
+ ],
44
+ "bugs": {
45
+ "url": "git+https://github.com/twinfoundation/framework/issues"
46
+ },
47
+ "homepage": "https://twindev.org"
39
48
  }