@twin.org/core 0.0.3-next.3 → 0.0.3-next.31

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 +102 -75
  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 +541 -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
@@ -14,7 +14,7 @@ Class to help with objects.
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,9 +22,9 @@ Runtime name for the class.
22
22
 
23
23
  ## Methods
24
24
 
25
- ### toBytes()
25
+ ### toBytes() {#tobytes}
26
26
 
27
- > `static` **toBytes**\<`T`\>(`obj`, `format`): `Uint8Array`
27
+ > `static` **toBytes**\<`T`\>(`obj`, `format?`): `Uint8Array`
28
28
 
29
29
  Convert an object to bytes.
30
30
 
@@ -38,11 +38,11 @@ Convert an object to bytes.
38
38
 
39
39
  ##### obj
40
40
 
41
- The object to convert.
41
+ `T` \| `undefined`
42
42
 
43
- `T` | `undefined`
43
+ The object to convert.
44
44
 
45
- ##### format
45
+ ##### format?
46
46
 
47
47
  `boolean` = `false`
48
48
 
@@ -56,7 +56,7 @@ The object as bytes.
56
56
 
57
57
  ***
58
58
 
59
- ### fromBytes()
59
+ ### fromBytes() {#frombytes}
60
60
 
61
61
  > `static` **fromBytes**\<`T`\>(`bytes`): `T`
62
62
 
@@ -72,9 +72,9 @@ Convert a bytes to an object.
72
72
 
73
73
  ##### bytes
74
74
 
75
- The bytes to convert to an object.
75
+ `Uint8Array`\<`ArrayBufferLike`\> \| `null` \| `undefined`
76
76
 
77
- `Uint8Array`\<`ArrayBufferLike`\> | `null` | `undefined`
77
+ The bytes to convert to an object.
78
78
 
79
79
  #### Returns
80
80
 
@@ -88,7 +88,7 @@ GeneralError if there was an error parsing the JSON.
88
88
 
89
89
  ***
90
90
 
91
- ### clone()
91
+ ### clone() {#clone}
92
92
 
93
93
  > `static` **clone**\<`T`\>(`obj`): `T`
94
94
 
@@ -116,7 +116,7 @@ The objects clone.
116
116
 
117
117
  ***
118
118
 
119
- ### merge()
119
+ ### merge() {#merge}
120
120
 
121
121
  > `static` **merge**\<`T`, `U`\>(`obj1`, `obj2`): `T` & `U`
122
122
 
@@ -154,7 +154,7 @@ The combined deep merge of the objects.
154
154
 
155
155
  ***
156
156
 
157
- ### equal()
157
+ ### equal() {#equal}
158
158
 
159
159
  > `static` **equal**\<`T`\>(`obj1`, `obj2`, `strictPropertyOrder?`): `boolean`
160
160
 
@@ -194,7 +194,7 @@ True is the objects are equal.
194
194
 
195
195
  ***
196
196
 
197
- ### propertyGet()
197
+ ### propertyGet() {#propertyget}
198
198
 
199
199
  > `static` **propertyGet**\<`T`\>(`obj`, `property`): `T` \| `undefined`
200
200
 
@@ -228,7 +228,7 @@ The property.
228
228
 
229
229
  ***
230
230
 
231
- ### propertySet()
231
+ ### propertySet() {#propertyset}
232
232
 
233
233
  > `static` **propertySet**(`obj`, `property`, `value`): `void`
234
234
 
@@ -264,7 +264,7 @@ GeneralError if the property target is not an object.
264
264
 
265
265
  ***
266
266
 
267
- ### propertyDelete()
267
+ ### propertyDelete() {#propertydelete}
268
268
 
269
269
  > `static` **propertyDelete**(`obj`, `property`): `void`
270
270
 
@@ -290,9 +290,9 @@ The property to set
290
290
 
291
291
  ***
292
292
 
293
- ### extractProperty()
293
+ ### extractProperty() {#extractproperty}
294
294
 
295
- > `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `T` \| `undefined`
295
+ > `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties?`): `T` \| `undefined`
296
296
 
297
297
  Extract a property from the object, providing alternative names.
298
298
 
@@ -312,11 +312,11 @@ The object to extract from.
312
312
 
313
313
  ##### propertyNames
314
314
 
315
- The possible names for the property.
315
+ `string` \| `string`[]
316
316
 
317
- `string` | `string`[]
317
+ The possible names for the property.
318
318
 
319
- ##### removeProperties
319
+ ##### removeProperties?
320
320
 
321
321
  `boolean` = `true`
322
322
 
@@ -330,7 +330,7 @@ The property if available.
330
330
 
331
331
  ***
332
332
 
333
- ### pick()
333
+ ### pick() {#pick}
334
334
 
335
335
  > `static` **pick**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
336
336
 
@@ -346,9 +346,9 @@ Pick a subset of properties from an object.
346
346
 
347
347
  ##### obj
348
348
 
349
- The object to pick the properties from.
349
+ `T` \| `undefined`
350
350
 
351
- `T` | `undefined`
351
+ The object to pick the properties from.
352
352
 
353
353
  ##### keys?
354
354
 
@@ -364,7 +364,7 @@ The partial object.
364
364
 
365
365
  ***
366
366
 
367
- ### omit()
367
+ ### omit() {#omit}
368
368
 
369
369
  > `static` **omit**\<`T`\>(`obj`, `keys?`): `Partial`\<`T`\>
370
370
 
@@ -380,9 +380,9 @@ Omit a subset of properties from an object.
380
380
 
381
381
  ##### obj
382
382
 
383
- The object to omit the properties from.
383
+ `T` \| `undefined`
384
384
 
385
- `T` | `undefined`
385
+ The object to omit the properties from.
386
386
 
387
387
  ##### keys?
388
388
 
@@ -398,7 +398,7 @@ The partial object.
398
398
 
399
399
  ***
400
400
 
401
- ### split()
401
+ ### split() {#split}
402
402
 
403
403
  > `static` **split**\<`T`\>(`obj`, `keys?`): `object`
404
404
 
@@ -414,9 +414,9 @@ Split an object into two with the specified keys.
414
414
 
415
415
  ##### obj
416
416
 
417
- The object to split.
417
+ `T` \| `undefined`
418
418
 
419
- `T` | `undefined`
419
+ The object to split.
420
420
 
421
421
  ##### keys?
422
422
 
@@ -440,7 +440,7 @@ The two partial objects.
440
440
 
441
441
  ***
442
442
 
443
- ### toExtended()
443
+ ### toExtended() {#toextended}
444
444
 
445
445
  > `static` **toExtended**(`obj`): `any`
446
446
 
@@ -462,7 +462,7 @@ The object with extended properties.
462
462
 
463
463
  ***
464
464
 
465
- ### fromExtended()
465
+ ### fromExtended() {#fromextended}
466
466
 
467
467
  > `static` **fromExtended**(`obj`): `any`
468
468
 
@@ -484,7 +484,7 @@ The object with regular properties.
484
484
 
485
485
  ***
486
486
 
487
- ### removeEmptyProperties()
487
+ ### removeEmptyProperties() {#removeemptyproperties}
488
488
 
489
489
  > `static` **removeEmptyProperties**\<`T`\>(`obj`, `options?`): `T`
490
490
 
@@ -12,9 +12,17 @@ Class to help with random generation.
12
12
 
13
13
  `RandomHelper`
14
14
 
15
+ ## Properties
16
+
17
+ ### CLASS\_NAME {#class_name}
18
+
19
+ > `readonly` `static` **CLASS\_NAME**: `string`
20
+
21
+ Runtime name for the class.
22
+
15
23
  ## Methods
16
24
 
17
- ### generate()
25
+ ### generate() {#generate}
18
26
 
19
27
  > `static` **generate**(`length`): `Uint8Array`
20
28
 
@@ -33,3 +41,47 @@ The length of buffer to create.
33
41
  `Uint8Array`
34
42
 
35
43
  The random array.
44
+
45
+ ***
46
+
47
+ ### generateUuidV7() {#generateuuidv7}
48
+
49
+ > `static` **generateUuidV7**(`format?`): `string`
50
+
51
+ Generate a new UUIDv7.
52
+
53
+ #### Parameters
54
+
55
+ ##### format?
56
+
57
+ `"standard"` \| `"compact"`
58
+
59
+ The format of the UUIDv7 string.
60
+
61
+ #### Returns
62
+
63
+ `string`
64
+
65
+ The UUIDv7 string.
66
+
67
+ ***
68
+
69
+ ### uuidV7ExtractTimestamp() {#uuidv7extracttimestamp}
70
+
71
+ > `static` **uuidV7ExtractTimestamp**(`uuid`): `number`
72
+
73
+ Extract the unix timestamp (ms) from a UUIDv7.
74
+
75
+ #### Parameters
76
+
77
+ ##### uuid
78
+
79
+ `string`
80
+
81
+ The UUIDv7 string.
82
+
83
+ #### Returns
84
+
85
+ `number`
86
+
87
+ The unix timestamp in milliseconds.
@@ -15,7 +15,7 @@ instance loads of a packages.
15
15
 
16
16
  ## Methods
17
17
 
18
- ### get()
18
+ ### get() {#get}
19
19
 
20
20
  > `static` **get**\<`T`\>(`prop`): `T` \| `undefined`
21
21
 
@@ -43,7 +43,7 @@ The property if it exists.
43
43
 
44
44
  ***
45
45
 
46
- ### set()
46
+ ### set() {#set}
47
47
 
48
48
  > `static` **set**\<`T`\>(`prop`, `value`): `void`
49
49
 
@@ -75,7 +75,7 @@ The value to set.
75
75
 
76
76
  ***
77
77
 
78
- ### remove()
78
+ ### remove() {#remove}
79
79
 
80
80
  > `static` **remove**(`prop`): `void`
81
81
 
@@ -14,7 +14,7 @@ Class to help with string.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### trimTrailingSlashes()
17
+ ### trimTrailingSlashes() {#trimtrailingslashes}
18
18
 
19
19
  > `static` **trimTrailingSlashes**(`value`): `string`
20
20
 
@@ -36,7 +36,7 @@ The trimmed string or the original.
36
36
 
37
37
  ***
38
38
 
39
- ### trimLeadingSlashes()
39
+ ### trimLeadingSlashes() {#trimleadingslashes}
40
40
 
41
41
  > `static` **trimLeadingSlashes**(`value`): `string`
42
42
 
@@ -58,9 +58,9 @@ The trimmed string or the original.
58
58
 
59
59
  ***
60
60
 
61
- ### kebabCase()
61
+ ### kebabCase() {#kebabcase}
62
62
 
63
- > `static` **kebabCase**(`input`, `stripInterfacePrefix`): `string`
63
+ > `static` **kebabCase**(`input`, `stripInterfacePrefix?`): `string`
64
64
 
65
65
  Convert the input string to kebab case.
66
66
 
@@ -72,7 +72,7 @@ Convert the input string to kebab case.
72
72
 
73
73
  The input to convert.
74
74
 
75
- ##### stripInterfacePrefix
75
+ ##### stripInterfacePrefix?
76
76
 
77
77
  `boolean` = `true`
78
78
 
@@ -86,9 +86,9 @@ The kebab case version of the input.
86
86
 
87
87
  ***
88
88
 
89
- ### snakeCase()
89
+ ### snakeCase() {#snakecase}
90
90
 
91
- > `static` **snakeCase**(`input`, `stripInterfacePrefix`): `string`
91
+ > `static` **snakeCase**(`input`, `stripInterfacePrefix?`): `string`
92
92
 
93
93
  Convert the input string to snake case.
94
94
 
@@ -100,7 +100,7 @@ Convert the input string to snake case.
100
100
 
101
101
  The input to convert.
102
102
 
103
- ##### stripInterfacePrefix
103
+ ##### stripInterfacePrefix?
104
104
 
105
105
  `boolean` = `true`
106
106
 
@@ -114,9 +114,9 @@ The snake case version of the input.
114
114
 
115
115
  ***
116
116
 
117
- ### titleCase()
117
+ ### titleCase() {#titlecase}
118
118
 
119
- > `static` **titleCase**(`input`, `stripInterfacePrefix`): `string`
119
+ > `static` **titleCase**(`input`, `stripInterfacePrefix?`): `string`
120
120
 
121
121
  Title case all the words.
122
122
 
@@ -128,7 +128,7 @@ Title case all the words.
128
128
 
129
129
  The input to convert.
130
130
 
131
- ##### stripInterfacePrefix
131
+ ##### stripInterfacePrefix?
132
132
 
133
133
  `boolean` = `true`
134
134
 
@@ -142,9 +142,9 @@ The title case version of the input.
142
142
 
143
143
  ***
144
144
 
145
- ### pascalCase()
145
+ ### pascalCase() {#pascalcase}
146
146
 
147
- > `static` **pascalCase**(`input`, `stripInterfacePrefix`): `string`
147
+ > `static` **pascalCase**(`input`, `stripInterfacePrefix?`): `string`
148
148
 
149
149
  Pascal case all the words.
150
150
 
@@ -156,7 +156,7 @@ Pascal case all the words.
156
156
 
157
157
  The input to convert.
158
158
 
159
- ##### stripInterfacePrefix
159
+ ##### stripInterfacePrefix?
160
160
 
161
161
  `boolean` = `true`
162
162
 
@@ -170,9 +170,9 @@ The pascal case version of the input.
170
170
 
171
171
  ***
172
172
 
173
- ### camelCase()
173
+ ### camelCase() {#camelcase}
174
174
 
175
- > `static` **camelCase**(`input`, `stripInterfacePrefix`): `string`
175
+ > `static` **camelCase**(`input`, `stripInterfacePrefix?`): `string`
176
176
 
177
177
  Camel case all the words.
178
178
 
@@ -184,7 +184,7 @@ Camel case all the words.
184
184
 
185
185
  The input to convert.
186
186
 
187
- ##### stripInterfacePrefix
187
+ ##### stripInterfacePrefix?
188
188
 
189
189
  `boolean` = `true`
190
190
 
@@ -198,9 +198,9 @@ The camel case version of the input.
198
198
 
199
199
  ***
200
200
 
201
- ### wordPath()
201
+ ### wordPath() {#wordpath}
202
202
 
203
- > `static` **wordPath**(`input`, `stripInterfacePrefix`): `string`
203
+ > `static` **wordPath**(`input`, `stripInterfacePrefix?`): `string`
204
204
 
205
205
  Convert the words to a path.
206
206
 
@@ -212,7 +212,7 @@ Convert the words to a path.
212
212
 
213
213
  The input to convert.
214
214
 
215
- ##### stripInterfacePrefix
215
+ ##### stripInterfacePrefix?
216
216
 
217
217
  `boolean` = `true`
218
218
 
@@ -226,7 +226,7 @@ The path version of the input.
226
226
 
227
227
  ***
228
228
 
229
- ### stripPrefix()
229
+ ### stripPrefix() {#stripprefix}
230
230
 
231
231
  > `static` **stripPrefix**(`input`): `string`
232
232
 
@@ -248,7 +248,7 @@ The input with any interface prefix stripped.
248
248
 
249
249
  ***
250
250
 
251
- ### words()
251
+ ### words() {#words}
252
252
 
253
253
  > `static` **words**(`input`): `string`[]
254
254
 
@@ -270,7 +270,7 @@ The string split into words.
270
270
 
271
271
  ***
272
272
 
273
- ### isUtf8()
273
+ ### isUtf8() {#isutf8}
274
274
 
275
275
  > `static` **isUtf8**(`data`): `boolean`
276
276
 
@@ -14,7 +14,7 @@ Class to help with uint8 arrays.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### concat()
17
+ ### concat() {#concat}
18
18
 
19
19
  > `static` **concat**(`arrays`): `Uint8Array`
20
20