@twin.org/core 0.0.1-next.4 → 0.0.1-next.40

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 (65) hide show
  1. package/dist/cjs/index.cjs +1379 -738
  2. package/dist/esm/index.mjs +1376 -739
  3. package/dist/types/encoding/base58.d.ts +18 -0
  4. package/dist/types/factories/factory.d.ts +20 -1
  5. package/dist/types/helpers/envHelper.d.ts +16 -0
  6. package/dist/types/helpers/jsonHelper.d.ts +29 -0
  7. package/dist/types/helpers/objectHelper.d.ts +33 -0
  8. package/dist/types/helpers/uint8ArrayHelper.d.ts +11 -0
  9. package/dist/types/index.d.ts +4 -0
  10. package/dist/types/models/IComponent.d.ts +12 -3
  11. package/dist/types/models/coerceType.d.ts +49 -0
  12. package/dist/types/models/compressionType.d.ts +1 -1
  13. package/dist/types/utils/coerce.d.ts +22 -0
  14. package/dist/types/utils/converter.d.ts +12 -0
  15. package/dist/types/utils/guards.d.ts +16 -0
  16. package/dist/types/utils/is.d.ts +12 -0
  17. package/dist/types/utils/validation.d.ts +2 -0
  18. package/docs/changelog.md +1 -1
  19. package/docs/reference/classes/AlreadyExistsError.md +67 -25
  20. package/docs/reference/classes/ArrayHelper.md +6 -2
  21. package/docs/reference/classes/AsyncCache.md +18 -6
  22. package/docs/reference/classes/Base32.md +6 -2
  23. package/docs/reference/classes/Base58.md +61 -0
  24. package/docs/reference/classes/Base64.md +9 -3
  25. package/docs/reference/classes/Base64Url.md +6 -2
  26. package/docs/reference/classes/BaseError.md +65 -23
  27. package/docs/reference/classes/BitString.md +18 -6
  28. package/docs/reference/classes/Coerce.md +104 -8
  29. package/docs/reference/classes/Compression.md +12 -4
  30. package/docs/reference/classes/ConflictError.md +70 -26
  31. package/docs/reference/classes/Converter.md +104 -20
  32. package/docs/reference/classes/EnvHelper.md +43 -0
  33. package/docs/reference/classes/ErrorHelper.md +9 -3
  34. package/docs/reference/classes/Factory.md +78 -10
  35. package/docs/reference/classes/FilenameHelper.md +3 -1
  36. package/docs/reference/classes/GeneralError.md +65 -25
  37. package/docs/reference/classes/GuardError.md +70 -26
  38. package/docs/reference/classes/Guards.md +284 -72
  39. package/docs/reference/classes/HexHelper.md +15 -5
  40. package/docs/reference/classes/I18n.md +42 -16
  41. package/docs/reference/classes/Is.md +156 -40
  42. package/docs/reference/classes/JsonHelper.md +133 -5
  43. package/docs/reference/classes/NotFoundError.md +67 -25
  44. package/docs/reference/classes/NotImplementedError.md +61 -23
  45. package/docs/reference/classes/NotSupportedError.md +64 -24
  46. package/docs/reference/classes/ObjectHelper.md +188 -20
  47. package/docs/reference/classes/RandomHelper.md +3 -1
  48. package/docs/reference/classes/StringHelper.md +51 -17
  49. package/docs/reference/classes/Uint8ArrayHelper.md +35 -0
  50. package/docs/reference/classes/UnauthorizedError.md +64 -24
  51. package/docs/reference/classes/UnprocessableError.md +65 -25
  52. package/docs/reference/classes/Url.md +30 -10
  53. package/docs/reference/classes/Urn.md +54 -18
  54. package/docs/reference/classes/Validation.md +313 -107
  55. package/docs/reference/classes/ValidationError.md +64 -24
  56. package/docs/reference/index.md +5 -0
  57. package/docs/reference/interfaces/IComponent.md +30 -8
  58. package/docs/reference/interfaces/IError.md +1 -1
  59. package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
  60. package/docs/reference/interfaces/IValidationFailure.md +1 -1
  61. package/docs/reference/type-aliases/CoerceType.md +5 -0
  62. package/docs/reference/variables/CoerceType.md +67 -0
  63. package/docs/reference/variables/CompressionType.md +1 -1
  64. package/locales/en.json +18 -1
  65. package/package.json +6 -6
package/docs/reference/classes/Urn.md CHANGED
@@ -12,14 +12,18 @@ Create a new instance of Urn.
12
12
 
13
13
  #### Parameters
14
14
 
15
- • **namespaceIdentifier**: `string`
15
+ ##### namespaceIdentifier
16
+
17
+ `string`
16
18
 
17
19
  The identifier for the namespace.
18
20
 
19
- • **namespaceSpecific**: `string` \| `string`[]
21
+ ##### namespaceSpecific
20
22
 
21
23
  The specific part of the namespace.
22
24
 
25
+ `string` | `string`[]
26
+
23
27
  #### Returns
24
28
 
25
29
  [`Urn`](Urn.md)
@@ -34,7 +38,9 @@ Generate a random identifier with 32 byte id.
34
38
 
35
39
  #### Parameters
36
40
 
37
- • **namespace**: `string`
41
+ ##### namespace
42
+
43
+ `string`
38
44
 
39
45
  The prefix for the urn.
40
46
 
@@ -54,11 +60,15 @@ Does the provided urn match the namespace.
54
60
 
55
61
  #### Parameters
56
62
 
57
- • **urn**: `string`
63
+ ##### urn
64
+
65
+ `string`
58
66
 
59
67
  The urn to check.
60
68
 
61
- • **namespace**: `string`
69
+ ##### namespace
70
+
71
+ `string`
62
72
 
63
73
  The namespace to match.
64
74
 
@@ -78,7 +88,9 @@ Try and parse a string into the urn parts.
78
88
 
79
89
  #### Parameters
80
90
 
81
- • **urn**: `unknown`
91
+ ##### urn
92
+
93
+ `unknown`
82
94
 
83
95
  The urn to parse.
84
96
 
@@ -98,7 +110,9 @@ Construct a urn from a string that has already been validated.
98
110
 
99
111
  #### Parameters
100
112
 
101
- • **urn**: `string`
113
+ ##### urn
114
+
115
+ `string`
102
116
 
103
117
  The urn to parse.
104
118
 
@@ -118,7 +132,9 @@ Add a urn: prefix if there isn't one already.
118
132
 
119
133
  #### Parameters
120
134
 
121
- • **urn**: `unknown`
135
+ ##### urn
136
+
137
+ `unknown`
122
138
 
123
139
  The urn string to add a prefix to.
124
140
 
@@ -138,15 +154,21 @@ Parse a string into the urn parts.
138
154
 
139
155
  #### Parameters
140
156
 
141
- • **source**: `string`
157
+ ##### source
158
+
159
+ `string`
142
160
 
143
161
  The source of the error.
144
162
 
145
- • **property**: `string`
163
+ ##### property
164
+
165
+ `string`
146
166
 
147
167
  The name of the property.
148
168
 
149
- • **value**: `unknown`
169
+ ##### value
170
+
171
+ `unknown`
150
172
 
151
173
  The urn to parse.
152
174
 
@@ -168,15 +190,21 @@ Validate a string as a Urn.
168
190
 
169
191
  #### Parameters
170
192
 
171
- • **property**: `string`
193
+ ##### property
194
+
195
+ `string`
172
196
 
173
197
  Throw an exception if the urn property is invalid.
174
198
 
175
- • **value**: `unknown`
199
+ ##### value
200
+
201
+ `unknown`
176
202
 
177
203
  The urn to parse.
178
204
 
179
- • **failures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
205
+ ##### failures
206
+
207
+ [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
180
208
 
181
209
  The list of failures to add to.
182
210
 
@@ -196,7 +224,9 @@ Get the parts.
196
224
 
197
225
  #### Parameters
198
226
 
199
- • **startIndex**: `number` = `0`
227
+ ##### startIndex
228
+
229
+ `number` = `0`
200
230
 
201
231
  The index to start from, defaults to 0.
202
232
 
@@ -244,7 +274,9 @@ Get the namespace specific parts.
244
274
 
245
275
  #### Parameters
246
276
 
247
- • **startIndex**: `number` = `0`
277
+ ##### startIndex
278
+
279
+ `number` = `0`
248
280
 
249
281
  The index to start from, defaults to 0.
250
282
 
@@ -264,7 +296,9 @@ Get the namespace specific.
264
296
 
265
297
  #### Parameters
266
298
 
267
- • **startIndex**: `number` = `0`
299
+ ##### startIndex
300
+
301
+ `number` = `0`
268
302
 
269
303
  The index to start from, defaults to 0.
270
304
 
@@ -284,7 +318,9 @@ Convert the parts in to a full string.
284
318
 
285
319
  #### Parameters
286
320
 
287
- • **omitPrefix**: `boolean` = `true`
321
+ ##### omitPrefix
322
+
323
+ `boolean` = `true`
288
324
 
289
325
  Omit the urn: prefix from the string.
290
326