@twin.org/core 0.0.1-next.9 → 0.0.2-next.3

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 (77) hide show
  1. package/dist/cjs/index.cjs +1574 -833
  2. package/dist/esm/index.mjs +1571 -834
  3. package/dist/types/errors/baseError.d.ts +8 -1
  4. package/dist/types/factories/factory.d.ts +20 -1
  5. package/dist/types/helpers/arrayHelper.d.ts +13 -0
  6. package/dist/types/helpers/envHelper.d.ts +16 -0
  7. package/dist/types/helpers/errorHelper.d.ts +2 -1
  8. package/dist/types/helpers/jsonHelper.d.ts +30 -0
  9. package/dist/types/helpers/objectHelper.d.ts +25 -0
  10. package/dist/types/helpers/uint8ArrayHelper.d.ts +11 -0
  11. package/dist/types/index.d.ts +6 -0
  12. package/dist/types/models/IComponent.d.ts +12 -3
  13. package/dist/types/models/II18nShared.d.ts +29 -0
  14. package/dist/types/models/coerceType.d.ts +49 -0
  15. package/dist/types/models/compressionType.d.ts +1 -1
  16. package/dist/types/models/objectOrArray.d.ts +4 -0
  17. package/dist/types/utils/asyncCache.d.ts +10 -1
  18. package/dist/types/utils/coerce.d.ts +22 -0
  19. package/dist/types/utils/guards.d.ts +35 -0
  20. package/dist/types/utils/is.d.ts +12 -0
  21. package/dist/types/utils/sharedStore.d.ts +23 -0
  22. package/dist/types/utils/validation.d.ts +2 -0
  23. package/docs/changelog.md +323 -1
  24. package/docs/reference/classes/AlreadyExistsError.md +103 -27
  25. package/docs/reference/classes/ArrayHelper.md +71 -5
  26. package/docs/reference/classes/AsyncCache.md +75 -13
  27. package/docs/reference/classes/Base32.md +9 -5
  28. package/docs/reference/classes/Base58.md +9 -5
  29. package/docs/reference/classes/Base64.md +12 -6
  30. package/docs/reference/classes/Base64Url.md +9 -5
  31. package/docs/reference/classes/BaseError.md +101 -29
  32. package/docs/reference/classes/BitString.md +23 -11
  33. package/docs/reference/classes/Coerce.md +110 -12
  34. package/docs/reference/classes/Compression.md +19 -11
  35. package/docs/reference/classes/ConflictError.md +106 -28
  36. package/docs/reference/classes/Converter.md +72 -28
  37. package/docs/reference/classes/EnvHelper.md +45 -0
  38. package/docs/reference/classes/ErrorHelper.md +19 -7
  39. package/docs/reference/classes/Factory.md +95 -17
  40. package/docs/reference/classes/FilenameHelper.md +6 -4
  41. package/docs/reference/classes/GeneralError.md +101 -27
  42. package/docs/reference/classes/GuardError.md +106 -28
  43. package/docs/reference/classes/Guards.md +398 -80
  44. package/docs/reference/classes/HexHelper.md +18 -8
  45. package/docs/reference/classes/I18n.md +46 -20
  46. package/docs/reference/classes/Is.md +179 -51
  47. package/docs/reference/classes/JsonHelper.md +146 -10
  48. package/docs/reference/classes/NotFoundError.md +103 -27
  49. package/docs/reference/classes/NotImplementedError.md +97 -25
  50. package/docs/reference/classes/NotSupportedError.md +100 -26
  51. package/docs/reference/classes/ObjectHelper.md +197 -39
  52. package/docs/reference/classes/RandomHelper.md +6 -4
  53. package/docs/reference/classes/SharedStore.md +94 -0
  54. package/docs/reference/classes/StringHelper.md +54 -20
  55. package/docs/reference/classes/Uint8ArrayHelper.md +35 -0
  56. package/docs/reference/classes/UnauthorizedError.md +100 -26
  57. package/docs/reference/classes/UnprocessableError.md +101 -27
  58. package/docs/reference/classes/Url.md +37 -17
  59. package/docs/reference/classes/Urn.md +63 -27
  60. package/docs/reference/classes/Validation.md +349 -135
  61. package/docs/reference/classes/ValidationError.md +100 -26
  62. package/docs/reference/index.md +7 -0
  63. package/docs/reference/interfaces/IComponent.md +30 -8
  64. package/docs/reference/interfaces/IError.md +2 -2
  65. package/docs/reference/interfaces/II18nShared.md +47 -0
  66. package/docs/reference/interfaces/IKeyValue.md +3 -1
  67. package/docs/reference/interfaces/ILabelledValue.md +3 -1
  68. package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
  69. package/docs/reference/interfaces/IPatchOperation.md +1 -1
  70. package/docs/reference/interfaces/IValidationFailure.md +1 -1
  71. package/docs/reference/type-aliases/CoerceType.md +5 -0
  72. package/docs/reference/type-aliases/CompressionType.md +1 -1
  73. package/docs/reference/type-aliases/ObjectOrArray.md +11 -0
  74. package/docs/reference/variables/CoerceType.md +67 -0
  75. package/docs/reference/variables/CompressionType.md +1 -1
  76. package/locales/en.json +14 -1
  77. package/package.json +7 -7
package/docs/reference/classes/HexHelper.md CHANGED
@@ -4,13 +4,13 @@ Helper methods for hex conversions.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new HexHelper()
7
+ ### Constructor
8
8
 
9
- > **new HexHelper**(): [`HexHelper`](HexHelper.md)
9
+ > **new HexHelper**(): `HexHelper`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`HexHelper`](HexHelper.md)
13
+ `HexHelper`
14
14
 
15
15
  ## Methods
16
16
 
@@ -22,7 +22,9 @@ Strip the 0x prefix if it exists.
22
22
 
23
23
  #### Parameters
24
24
 
25
- • **hex**: `string`
25
+ ##### hex
26
+
27
+ `string`
26
28
 
27
29
  The hex value to strip.
28
30
 
@@ -42,7 +44,9 @@ Add the 0x prefix if it does not exist.
42
44
 
43
45
  #### Parameters
44
46
 
45
- • **hex**: `string`
47
+ ##### hex
48
+
49
+ `string`
46
50
 
47
51
  The hex value to add the prefix to.
48
52
 
@@ -62,7 +66,9 @@ Does the hex string have the prefix.
62
66
 
63
67
  #### Parameters
64
68
 
65
- • **hex**: `string`
69
+ ##### hex
70
+
71
+ `string`
66
72
 
67
73
  The hex value to check for the prefix.
68
74
 
@@ -82,11 +88,15 @@ Is the data hex format.
82
88
 
83
89
  #### Parameters
84
90
 
85
- • **value**: `string`
91
+ ##### value
92
+
93
+ `string`
86
94
 
87
95
  The value to test.
88
96
 
89
- • **allowPrefix**: `boolean` = `false`
97
+ ##### allowPrefix
98
+
99
+ `boolean` = `false`
90
100
 
91
101
  Allow the hex to have the 0x prefix.
92
102
 
package/docs/reference/classes/I18n.md CHANGED
@@ -4,13 +4,13 @@ Class to perform internationalization.
4
4
 
5
5
  ## Constructors
6
6
 
7
- ### new I18n()
7
+ ### Constructor
8
8
 
9
- > **new I18n**(): [`I18n`](I18n.md)
9
+ > **new I18n**(): `I18n`
10
10
 
11
11
  #### Returns
12
12
 
13
- [`I18n`](I18n.md)
13
+ `I18n`
14
14
 
15
15
  ## Properties
16
16
 
@@ -30,7 +30,9 @@ Set the locale.
30
30
 
31
31
  #### Parameters
32
32
 
33
- • **locale**: `string`
33
+ ##### locale
34
+
35
+ `string`
34
36
 
35
37
  The new locale.
36
38
 
@@ -62,11 +64,15 @@ Add a locale dictionary.
62
64
 
63
65
  #### Parameters
64
66
 
65
- • **locale**: `string`
67
+ ##### locale
68
+
69
+ `string`
66
70
 
67
71
  The locale.
68
72
 
69
- • **dictionary**: [`ILocaleDictionary`](../interfaces/ILocaleDictionary.md)
73
+ ##### dictionary
74
+
75
+ [`ILocaleDictionary`](../interfaces/ILocaleDictionary.md)
70
76
 
71
77
  The dictionary to add.
72
78
 
@@ -78,19 +84,21 @@ The dictionary to add.
78
84
 
79
85
  ### getDictionary()
80
86
 
81
- > `static` **getDictionary**(`locale`): `undefined` \| `object`
87
+ > `static` **getDictionary**(`locale`): `undefined` \| \{[`key`: `string`]: `string`; \}
82
88
 
83
89
  Get a locale dictionary.
84
90
 
85
91
  #### Parameters
86
92
 
87
- • **locale**: `string`
93
+ ##### locale
94
+
95
+ `string`
88
96
 
89
97
  The locale.
90
98
 
91
99
  #### Returns
92
100
 
93
- `undefined` \| `object`
101
+ `undefined` \| \{[`key`: `string`]: `string`; \}
94
102
 
95
103
  The dictionary of undefined if it does not exist.
96
104
 
@@ -118,11 +126,15 @@ Add a locale changed handler.
118
126
 
119
127
  #### Parameters
120
128
 
121
- • **id**: `string`
129
+ ##### id
130
+
131
+ `string`
122
132
 
123
133
  The id of the handler.
124
134
 
125
- • **handler**
135
+ ##### handler
136
+
137
+ (`locale`) => `void`
126
138
 
127
139
  The handler to add.
128
140
 
@@ -140,7 +152,9 @@ Remove a locale changed handler.
140
152
 
141
153
  #### Parameters
142
154
 
143
- • **id**: `string`
155
+ ##### id
156
+
157
+ `string`
144
158
 
145
159
  The id of the handler.
146
160
 
@@ -158,11 +172,15 @@ Add a dictionary changed handler.
158
172
 
159
173
  #### Parameters
160
174
 
161
- • **id**: `string`
175
+ ##### id
176
+
177
+ `string`
162
178
 
163
179
  The id of the handler.
164
180
 
165
- • **handler**
181
+ ##### handler
182
+
183
+ (`locale`) => `void`
166
184
 
167
185
  The handler to add.
168
186
 
@@ -180,7 +198,9 @@ Remove a dictionary changed handler.
180
198
 
181
199
  #### Parameters
182
200
 
183
- • **id**: `string`
201
+ ##### id
202
+
203
+ `string`
184
204
 
185
205
  The id of the handler.
186
206
 
@@ -192,21 +212,25 @@ The id of the handler.
192
212
 
193
213
  ### formatMessage()
194
214
 
195
- > `static` **formatMessage**(`key`, `values`?, `overrideLocale`?): `string`
215
+ > `static` **formatMessage**(`key`, `values?`, `overrideLocale?`): `string`
196
216
 
197
217
  Format a message.
198
218
 
199
219
  #### Parameters
200
220
 
201
- • **key**: `string`
221
+ ##### key
222
+
223
+ `string`
202
224
 
203
225
  The key of the message to format.
204
226
 
205
- • **values?**
227
+ ##### values?
206
228
 
207
229
  The values to substitute into the message.
208
230
 
209
- • **overrideLocale?**: `string`
231
+ ##### overrideLocale?
232
+
233
+ `string`
210
234
 
211
235
  Override the locale.
212
236
 
@@ -226,7 +250,9 @@ Check if the dictionaries have a message for the given key.
226
250
 
227
251
  #### Parameters
228
252
 
229
- • **key**: `string`
253
+ ##### key
254
+
255
+ `string`
230
256
 
231
257
  The key to check for existence.
232
258