@twin.org/core 0.0.3-next.3 → 0.0.3-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 (92) hide show
  1. package/README.md +1 -9
  2. package/dist/es/encoding/base32.js +1 -1
  3. package/dist/es/encoding/base32.js.map +1 -1
  4. package/dist/es/factories/factory.js +41 -0
  5. package/dist/es/factories/factory.js.map +1 -1
  6. package/dist/es/helpers/arrayHelper.js.map +1 -1
  7. package/dist/es/helpers/randomHelper.js +50 -2
  8. package/dist/es/helpers/randomHelper.js.map +1 -1
  9. package/dist/es/index.js +2 -1
  10. package/dist/es/index.js.map +1 -1
  11. package/dist/es/types/objectOrArray.js.map +1 -0
  12. package/dist/es/types/singleOccurrenceArray.js +2 -0
  13. package/dist/es/types/singleOccurrenceArray.js.map +1 -0
  14. package/dist/es/types/urn.js +1 -2
  15. package/dist/es/types/urn.js.map +1 -1
  16. package/dist/es/utils/asyncCache.js +92 -74
  17. package/dist/es/utils/asyncCache.js.map +1 -1
  18. package/dist/es/utils/guards.js +16 -0
  19. package/dist/es/utils/guards.js.map +1 -1
  20. package/dist/es/utils/is.js +16 -0
  21. package/dist/es/utils/is.js.map +1 -1
  22. package/dist/types/encoding/base32.d.ts +1 -1
  23. package/dist/types/factories/factory.d.ts +23 -1
  24. package/dist/types/helpers/arrayHelper.d.ts +1 -1
  25. package/dist/types/helpers/randomHelper.d.ts +16 -0
  26. package/dist/types/index.d.ts +2 -1
  27. package/dist/types/types/singleOccurrenceArray.d.ts +9 -0
  28. package/dist/types/utils/asyncCache.d.ts +7 -0
  29. package/dist/types/utils/guards.d.ts +10 -1
  30. package/dist/types/utils/is.d.ts +7 -0
  31. package/docs/changelog.md +524 -1
  32. package/docs/examples.md +308 -1
  33. package/docs/reference/classes/AlreadyExistsError.md +35 -35
  34. package/docs/reference/classes/ArrayHelper.md +2 -2
  35. package/docs/reference/classes/AsyncCache.md +8 -8
  36. package/docs/reference/classes/Base32.md +4 -4
  37. package/docs/reference/classes/Base58.md +3 -3
  38. package/docs/reference/classes/Base64.md +4 -4
  39. package/docs/reference/classes/Base64Url.md +3 -3
  40. package/docs/reference/classes/BaseError.md +34 -34
  41. package/docs/reference/classes/BitString.md +6 -6
  42. package/docs/reference/classes/Coerce.md +11 -11
  43. package/docs/reference/classes/Compression.md +3 -3
  44. package/docs/reference/classes/ConflictError.md +35 -35
  45. package/docs/reference/classes/Converter.md +18 -18
  46. package/docs/reference/classes/EnvHelper.md +1 -1
  47. package/docs/reference/classes/ErrorHelper.md +3 -3
  48. package/docs/reference/classes/Factory.md +112 -18
  49. package/docs/reference/classes/FilenameHelper.md +1 -1
  50. package/docs/reference/classes/GeneralError.md +35 -35
  51. package/docs/reference/classes/GuardError.md +35 -35
  52. package/docs/reference/classes/Guards.md +72 -30
  53. package/docs/reference/classes/HexHelper.md +6 -6
  54. package/docs/reference/classes/I18n.md +14 -14
  55. package/docs/reference/classes/Is.md +67 -39
  56. package/docs/reference/classes/JsonHelper.md +10 -10
  57. package/docs/reference/classes/NotFoundError.md +35 -35
  58. package/docs/reference/classes/NotImplementedError.md +35 -35
  59. package/docs/reference/classes/NotSupportedError.md +35 -35
  60. package/docs/reference/classes/NumberHelper.md +2 -2
  61. package/docs/reference/classes/ObjectHelper.md +32 -32
  62. package/docs/reference/classes/RandomHelper.md +53 -1
  63. package/docs/reference/classes/SharedStore.md +3 -3
  64. package/docs/reference/classes/StringHelper.md +23 -23
  65. package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
  66. package/docs/reference/classes/UnauthorizedError.md +35 -35
  67. package/docs/reference/classes/UnprocessableError.md +35 -35
  68. package/docs/reference/classes/Url.md +8 -8
  69. package/docs/reference/classes/Urn.md +24 -24
  70. package/docs/reference/classes/Validation.md +25 -25
  71. package/docs/reference/classes/ValidationError.md +35 -35
  72. package/docs/reference/index.md +2 -0
  73. package/docs/reference/interfaces/IComponent.md +4 -4
  74. package/docs/reference/interfaces/IError.md +10 -10
  75. package/docs/reference/interfaces/II18nShared.md +4 -4
  76. package/docs/reference/interfaces/IKeyValue.md +2 -2
  77. package/docs/reference/interfaces/ILabelledValue.md +2 -2
  78. package/docs/reference/interfaces/ILocale.md +2 -2
  79. package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
  80. package/docs/reference/interfaces/ILocalesIndex.md +1 -1
  81. package/docs/reference/interfaces/IPatchOperation.md +6 -6
  82. package/docs/reference/interfaces/IUrlParts.md +9 -9
  83. package/docs/reference/interfaces/IValidationFailure.md +4 -4
  84. package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
  85. package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
  86. package/docs/reference/variables/CoerceType.md +10 -10
  87. package/docs/reference/variables/CompressionType.md +2 -2
  88. package/locales/en.json +5 -2
  89. package/package.json +4 -4
  90. package/dist/es/models/objectOrArray.js.map +0 -1
  91. /package/dist/es/{models → types}/objectOrArray.js +0 -0
  92. /package/dist/types/{models → types}/objectOrArray.d.ts +0 -0
@@ -15,7 +15,7 @@ Sourced from https://github.com/beatgammit/base64-js.
15
15
 
16
16
  ## Properties
17
17
 
18
- ### CLASS\_NAME
18
+ ### CLASS\_NAME {#class_name}
19
19
 
20
20
  > `readonly` `static` **CLASS\_NAME**: `string`
21
21
 
@@ -23,7 +23,7 @@ Runtime name for the class.
23
23
 
24
24
  ## Methods
25
25
 
26
- ### byteLength()
26
+ ### byteLength() {#bytelength}
27
27
 
28
28
  > `static` **byteLength**(`base64`): `number`
29
29
 
@@ -45,7 +45,7 @@ The byte length of the data.
45
45
 
46
46
  ***
47
47
 
48
- ### decode()
48
+ ### decode() {#decode}
49
49
 
50
50
  > `static` **decode**(`base64`): `Uint8Array`
51
51
 
@@ -67,7 +67,7 @@ The byte array.
67
67
 
68
68
  ***
69
69
 
70
- ### encode()
70
+ ### encode() {#encode}
71
71
 
72
72
  > `static` **encode**(`bytes`): `string`
73
73
 
@@ -15,7 +15,7 @@ https://www.rfc-editor.org/rfc/rfc4648#section-5.
15
15
 
16
16
  ## Properties
17
17
 
18
- ### CLASS\_NAME
18
+ ### CLASS\_NAME {#class_name}
19
19
 
20
20
  > `readonly` `static` **CLASS\_NAME**: `string`
21
21
 
@@ -23,7 +23,7 @@ Runtime name for the class.
23
23
 
24
24
  ## Methods
25
25
 
26
- ### decode()
26
+ ### decode() {#decode}
27
27
 
28
28
  > `static` **decode**(`base64Url`): `Uint8Array`
29
29
 
@@ -45,7 +45,7 @@ The byte array.
45
45
 
46
46
  ***
47
47
 
48
- ### encode()
48
+ ### encode() {#encode}
49
49
 
50
50
  > `static` **encode**(`bytes`): `string`
51
51
 
@@ -71,9 +71,9 @@ The cause of error if we have wrapped another error.
71
71
 
72
72
  ## Properties
73
73
 
74
- ### source?
74
+ ### source? {#source}
75
75
 
76
- > `optional` **source**: `string`
76
+ > `optional` **source?**: `string`
77
77
 
78
78
  The source of the error.
79
79
 
@@ -83,9 +83,9 @@ The source of the error.
83
83
 
84
84
  ***
85
85
 
86
- ### properties?
86
+ ### properties? {#properties}
87
87
 
88
- > `optional` **properties**: `object`
88
+ > `optional` **properties?**: `object`
89
89
 
90
90
  Any additional information for the error.
91
91
 
@@ -99,9 +99,9 @@ Any additional information for the error.
99
99
 
100
100
  ***
101
101
 
102
- ### cause?
102
+ ### cause? {#cause}
103
103
 
104
- > `optional` **cause**: [`IError`](../interfaces/IError.md)
104
+ > `optional` **cause?**: [`IError`](../interfaces/IError.md)
105
105
 
106
106
  The cause of the error.
107
107
 
@@ -115,7 +115,7 @@ The cause of the error.
115
115
 
116
116
  ## Methods
117
117
 
118
- ### fromError()
118
+ ### fromError() {#fromerror}
119
119
 
120
120
  > `static` **fromError**(`err`): `BaseError`
121
121
 
@@ -137,7 +137,7 @@ The new instance.
137
137
 
138
138
  ***
139
139
 
140
- ### flatten()
140
+ ### flatten() {#flatten}
141
141
 
142
142
  > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
143
143
 
@@ -159,7 +159,7 @@ The list of all internal errors.
159
159
 
160
160
  ***
161
161
 
162
- ### expand()
162
+ ### expand() {#expand}
163
163
 
164
164
  > `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
165
165
 
@@ -169,9 +169,9 @@ Expand an error tree.
169
169
 
170
170
  ##### errors
171
171
 
172
- The list of errors to expand.
172
+ [`IError`](../interfaces/IError.md)[] \| `undefined`
173
173
 
174
- [`IError`](../interfaces/IError.md)[] | `undefined`
174
+ The list of errors to expand.
175
175
 
176
176
  #### Returns
177
177
 
@@ -181,7 +181,7 @@ The first level error.
181
181
 
182
182
  ***
183
183
 
184
- ### isErrorName()
184
+ ### isErrorName() {#iserrorname}
185
185
 
186
186
  > `static` **isErrorName**(`error`, `name`): `error is BaseError`
187
187
 
@@ -197,9 +197,9 @@ The error to test.
197
197
 
198
198
  ##### name
199
199
 
200
- The name to check for.
200
+ `string` \| `RegExp`
201
201
 
202
- `string` | `RegExp`
202
+ The name to check for.
203
203
 
204
204
  #### Returns
205
205
 
@@ -209,7 +209,7 @@ True if the error has the name.
209
209
 
210
210
  ***
211
211
 
212
- ### isErrorMessage()
212
+ ### isErrorMessage() {#iserrormessage}
213
213
 
214
214
  > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
215
215
 
@@ -225,9 +225,9 @@ The error to test.
225
225
 
226
226
  ##### message
227
227
 
228
- The message to check for.
228
+ `string` \| `RegExp`
229
229
 
230
- `string` | `RegExp`
230
+ The message to check for.
231
231
 
232
232
  #### Returns
233
233
 
@@ -237,7 +237,7 @@ True if the error has the name.
237
237
 
238
238
  ***
239
239
 
240
- ### isErrorCode()
240
+ ### isErrorCode() {#iserrorcode}
241
241
 
242
242
  > `static` **isErrorCode**(`error`, `code`): `boolean`
243
243
 
@@ -253,9 +253,9 @@ The error to test.
253
253
 
254
254
  ##### code
255
255
 
256
- The code to check for.
256
+ `string` \| `RegExp`
257
257
 
258
- `string` | `RegExp`
258
+ The code to check for.
259
259
 
260
260
  #### Returns
261
261
 
@@ -265,7 +265,7 @@ True if the error has the code.
265
265
 
266
266
  ***
267
267
 
268
- ### someErrorName()
268
+ ### someErrorName() {#someerrorname}
269
269
 
270
270
  > `static` **someErrorName**(`error`, `name`): `error is BaseError`
271
271
 
@@ -281,9 +281,9 @@ The error to test.
281
281
 
282
282
  ##### name
283
283
 
284
- The name to check for.
284
+ `string` \| `RegExp`
285
285
 
286
- `string` | `RegExp`
286
+ The name to check for.
287
287
 
288
288
  #### Returns
289
289
 
@@ -293,7 +293,7 @@ True if the error has the name.
293
293
 
294
294
  ***
295
295
 
296
- ### someErrorMessage()
296
+ ### someErrorMessage() {#someerrormessage}
297
297
 
298
298
  > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
299
299
 
@@ -309,9 +309,9 @@ The error to test.
309
309
 
310
310
  ##### message
311
311
 
312
- The message to check for.
312
+ `string` \| `RegExp`
313
313
 
314
- `string` | `RegExp`
314
+ The message to check for.
315
315
 
316
316
  #### Returns
317
317
 
@@ -321,7 +321,7 @@ True if the error has the name.
321
321
 
322
322
  ***
323
323
 
324
- ### someErrorClass()
324
+ ### someErrorClass() {#someerrorclass}
325
325
 
326
326
  > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
327
327
 
@@ -349,7 +349,7 @@ True if the error has the specific class.
349
349
 
350
350
  ***
351
351
 
352
- ### someErrorCode()
352
+ ### someErrorCode() {#someerrorcode}
353
353
 
354
354
  > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
355
355
 
@@ -365,9 +365,9 @@ The error to test.
365
365
 
366
366
  ##### code
367
367
 
368
- The code to check for.
368
+ `string` \| `RegExp`
369
369
 
370
- `string` | `RegExp`
370
+ The code to check for.
371
371
 
372
372
  #### Returns
373
373
 
@@ -377,7 +377,7 @@ True if the error has the name.
377
377
 
378
378
  ***
379
379
 
380
- ### isEmpty()
380
+ ### isEmpty() {#isempty}
381
381
 
382
382
  > `static` **isEmpty**(`err`): `boolean`
383
383
 
@@ -399,7 +399,7 @@ True if the error is empty.
399
399
 
400
400
  ***
401
401
 
402
- ### isAggregateError()
402
+ ### isAggregateError() {#isaggregateerror}
403
403
 
404
404
  > `static` **isAggregateError**(`err`): `err is AggregateError`
405
405
 
@@ -421,7 +421,7 @@ True if the error is an aggregate error.
421
421
 
422
422
  ***
423
423
 
424
- ### fromAggregate()
424
+ ### fromAggregate() {#fromaggregate}
425
425
 
426
426
  > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
427
427
 
@@ -449,7 +449,7 @@ The array of errors.
449
449
 
450
450
  ***
451
451
 
452
- ### toJsonObject()
452
+ ### toJsonObject() {#tojsonobject}
453
453
 
454
454
  > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
455
455
 
@@ -24,7 +24,7 @@ The length of the bit string.
24
24
 
25
25
  ## Properties
26
26
 
27
- ### CLASS\_NAME
27
+ ### CLASS\_NAME {#class_name}
28
28
 
29
29
  > `readonly` `static` **CLASS\_NAME**: `string`
30
30
 
@@ -32,7 +32,7 @@ Runtime name for the class.
32
32
 
33
33
  ## Methods
34
34
 
35
- ### fromBits()
35
+ ### fromBits() {#frombits}
36
36
 
37
37
  > `static` **fromBits**(`bits`, `numberBits`): `BitString`
38
38
 
@@ -60,7 +60,7 @@ The new instance of BitString.
60
60
 
61
61
  ***
62
62
 
63
- ### getBit()
63
+ ### getBit() {#getbit}
64
64
 
65
65
  > **getBit**(`index`): `boolean`
66
66
 
@@ -86,7 +86,7 @@ GeneralError if the index is out of range.
86
86
 
87
87
  ***
88
88
 
89
- ### setBit()
89
+ ### setBit() {#setbit}
90
90
 
91
91
  > **setBit**(`index`, `value`): `void`
92
92
 
@@ -116,7 +116,7 @@ GeneralError if the index is out of range.
116
116
 
117
117
  ***
118
118
 
119
- ### getBits()
119
+ ### getBits() {#getbits}
120
120
 
121
121
  > **getBits**(): `Uint8Array`
122
122
 
@@ -130,7 +130,7 @@ The bits stored in a Uint8Array.
130
130
 
131
131
  ***
132
132
 
133
- ### getLength()
133
+ ### getLength() {#getlength}
134
134
 
135
135
  > **getLength**(): `number`
136
136
 
@@ -14,7 +14,7 @@ Coerce an object from one type to another.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### string()
17
+ ### string() {#string}
18
18
 
19
19
  > `static` **string**(`value`): `string` \| `undefined`
20
20
 
@@ -40,7 +40,7 @@ TypeError If the value can not be coerced.
40
40
 
41
41
  ***
42
42
 
43
- ### number()
43
+ ### number() {#number}
44
44
 
45
45
  > `static` **number**(`value`): `number` \| `undefined`
46
46
 
@@ -66,7 +66,7 @@ TypeError If the value can not be coerced.
66
66
 
67
67
  ***
68
68
 
69
- ### integer()
69
+ ### integer() {#integer}
70
70
 
71
71
  > `static` **integer**(`value`): `number` \| `undefined`
72
72
 
@@ -92,7 +92,7 @@ TypeError If the value can not be coerced.
92
92
 
93
93
  ***
94
94
 
95
- ### bigint()
95
+ ### bigint() {#bigint}
96
96
 
97
97
  > `static` **bigint**(`value`): `bigint` \| `undefined`
98
98
 
@@ -118,7 +118,7 @@ TypeError If the value can not be coerced.
118
118
 
119
119
  ***
120
120
 
121
- ### boolean()
121
+ ### boolean() {#boolean}
122
122
 
123
123
  > `static` **boolean**(`value`): `boolean` \| `undefined`
124
124
 
@@ -144,7 +144,7 @@ TypeError If the value can not be coerced.
144
144
 
145
145
  ***
146
146
 
147
- ### date()
147
+ ### date() {#date}
148
148
 
149
149
  > `static` **date**(`value`): `Date` \| `undefined`
150
150
 
@@ -170,7 +170,7 @@ TypeError If the value can not be coerced.
170
170
 
171
171
  ***
172
172
 
173
- ### dateTime()
173
+ ### dateTime() {#datetime}
174
174
 
175
175
  > `static` **dateTime**(`value`): `Date` \| `undefined`
176
176
 
@@ -196,7 +196,7 @@ TypeError If the value can not be coerced.
196
196
 
197
197
  ***
198
198
 
199
- ### time()
199
+ ### time() {#time}
200
200
 
201
201
  > `static` **time**(`value`): `Date` \| `undefined`
202
202
 
@@ -222,7 +222,7 @@ TypeError If the value can not be coerced.
222
222
 
223
223
  ***
224
224
 
225
- ### object()
225
+ ### object() {#object}
226
226
 
227
227
  > `static` **object**\<`T`\>(`value`): `T` \| `undefined`
228
228
 
@@ -254,7 +254,7 @@ TypeError If the value can not be coerced.
254
254
 
255
255
  ***
256
256
 
257
- ### uint8Array()
257
+ ### uint8Array() {#uint8array}
258
258
 
259
259
  > `static` **uint8Array**(`value`): `Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
260
260
 
@@ -280,7 +280,7 @@ TypeError If the value can not be coerced.
280
280
 
281
281
  ***
282
282
 
283
- ### byType()
283
+ ### byType() {#bytype}
284
284
 
285
285
  > `static` **byType**(`value`, `type?`): `unknown`
286
286
 
@@ -14,7 +14,7 @@ A class to handle compression.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### CLASS\_NAME
17
+ ### CLASS\_NAME {#class_name}
18
18
 
19
19
  > `readonly` `static` **CLASS\_NAME**: `string`
20
20
 
@@ -22,7 +22,7 @@ Runtime name for the class.
22
22
 
23
23
  ## Methods
24
24
 
25
- ### compress()
25
+ ### compress() {#compress}
26
26
 
27
27
  > `static` **compress**(`bytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
28
28
 
@@ -50,7 +50,7 @@ The compressed bytes.
50
50
 
51
51
  ***
52
52
 
53
- ### decompress()
53
+ ### decompress() {#decompress}
54
54
 
55
55
  > `static` **decompress**(`compressedBytes`, `type`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
56
56