@twin.org/core 0.0.3-next.21 → 0.0.3-next.23

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 (78) 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 +1 -13
  5. package/dist/es/factories/factory.js.map +1 -1
  6. package/dist/es/helpers/arrayHelper.js.map +1 -1
  7. package/dist/es/index.js +2 -1
  8. package/dist/es/index.js.map +1 -1
  9. package/dist/es/types/objectOrArray.js.map +1 -0
  10. package/dist/es/types/singleOccurrenceArray.js +2 -0
  11. package/dist/es/types/singleOccurrenceArray.js.map +1 -0
  12. package/dist/es/utils/guards.js.map +1 -1
  13. package/dist/types/encoding/base32.d.ts +1 -1
  14. package/dist/types/factories/factory.d.ts +1 -5
  15. package/dist/types/helpers/arrayHelper.d.ts +1 -1
  16. package/dist/types/index.d.ts +2 -1
  17. package/dist/types/types/singleOccurrenceArray.d.ts +9 -0
  18. package/dist/types/utils/guards.d.ts +1 -1
  19. package/docs/changelog.md +36 -1
  20. package/docs/examples.md +308 -1
  21. package/docs/reference/classes/AlreadyExistsError.md +18 -18
  22. package/docs/reference/classes/ArrayHelper.md +2 -2
  23. package/docs/reference/classes/AsyncCache.md +6 -6
  24. package/docs/reference/classes/Base32.md +4 -4
  25. package/docs/reference/classes/Base58.md +3 -3
  26. package/docs/reference/classes/Base64.md +4 -4
  27. package/docs/reference/classes/Base64Url.md +3 -3
  28. package/docs/reference/classes/BaseError.md +17 -17
  29. package/docs/reference/classes/BitString.md +6 -6
  30. package/docs/reference/classes/Coerce.md +11 -11
  31. package/docs/reference/classes/Compression.md +3 -3
  32. package/docs/reference/classes/ConflictError.md +18 -18
  33. package/docs/reference/classes/Converter.md +18 -18
  34. package/docs/reference/classes/EnvHelper.md +1 -1
  35. package/docs/reference/classes/ErrorHelper.md +3 -3
  36. package/docs/reference/classes/Factory.md +21 -31
  37. package/docs/reference/classes/FilenameHelper.md +1 -1
  38. package/docs/reference/classes/GeneralError.md +18 -18
  39. package/docs/reference/classes/GuardError.md +18 -18
  40. package/docs/reference/classes/Guards.md +31 -31
  41. package/docs/reference/classes/HexHelper.md +6 -6
  42. package/docs/reference/classes/I18n.md +14 -14
  43. package/docs/reference/classes/Is.md +40 -40
  44. package/docs/reference/classes/JsonHelper.md +8 -8
  45. package/docs/reference/classes/NotFoundError.md +18 -18
  46. package/docs/reference/classes/NotImplementedError.md +18 -18
  47. package/docs/reference/classes/NotSupportedError.md +18 -18
  48. package/docs/reference/classes/NumberHelper.md +2 -2
  49. package/docs/reference/classes/ObjectHelper.md +20 -20
  50. package/docs/reference/classes/RandomHelper.md +6 -6
  51. package/docs/reference/classes/SharedStore.md +3 -3
  52. package/docs/reference/classes/StringHelper.md +23 -23
  53. package/docs/reference/classes/Uint8ArrayHelper.md +1 -1
  54. package/docs/reference/classes/UnauthorizedError.md +18 -18
  55. package/docs/reference/classes/UnprocessableError.md +18 -18
  56. package/docs/reference/classes/Url.md +8 -8
  57. package/docs/reference/classes/Urn.md +22 -22
  58. package/docs/reference/classes/Validation.md +25 -25
  59. package/docs/reference/classes/ValidationError.md +18 -18
  60. package/docs/reference/index.md +2 -0
  61. package/docs/reference/interfaces/IComponent.md +4 -4
  62. package/docs/reference/interfaces/IError.md +6 -6
  63. package/docs/reference/interfaces/II18nShared.md +4 -4
  64. package/docs/reference/interfaces/IKeyValue.md +2 -2
  65. package/docs/reference/interfaces/ILabelledValue.md +2 -2
  66. package/docs/reference/interfaces/ILocale.md +2 -2
  67. package/docs/reference/interfaces/ILocalesIndex.md +1 -1
  68. package/docs/reference/interfaces/IPatchOperation.md +4 -4
  69. package/docs/reference/interfaces/IUrlParts.md +6 -6
  70. package/docs/reference/interfaces/IValidationFailure.md +3 -3
  71. package/docs/reference/type-aliases/SingleOccurrenceArray.md +15 -0
  72. package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md +19 -0
  73. package/docs/reference/variables/CoerceType.md +10 -10
  74. package/docs/reference/variables/CompressionType.md +2 -2
  75. package/package.json +4 -4
  76. package/dist/es/models/objectOrArray.js.map +0 -1
  77. /package/dist/es/{models → types}/objectOrArray.js +0 -0
  78. /package/dist/types/{models → types}/objectOrArray.d.ts +0 -0
package/docs/reference/type-aliases/SingleOccurrenceArrayDepthHelper.md ADDED
@@ -0,0 +1,19 @@
1
+ # Type Alias: SingleOccurrenceArrayDepthHelper\<T, U, Depth\>
2
+
3
+ > **SingleOccurrenceArrayDepthHelper**\<`T`, `U`, `Depth`\> = `Depth`\[`"length"`\] *extends* `16` ? \[`U`, `...T[]`\] : \[`U`, `...T[]`\] \| \[`T`, `...SingleOccurrenceArrayDepthHelper<T, U, [0, ...Depth]>`\]
4
+
5
+ Helper with bounded recursion depth to keep type instantiation tractable.
6
+
7
+ ## Type Parameters
8
+
9
+ ### T
10
+
11
+ `T`
12
+
13
+ ### U
14
+
15
+ `U`
16
+
17
+ ### Depth
18
+
19
+ `Depth` *extends* `0`[]
package/docs/reference/variables/CoerceType.md CHANGED
@@ -6,61 +6,61 @@ The types the extracted data can be coerced to.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### String
9
+ ### String {#string}
10
10
 
11
11
  > `readonly` **String**: `"string"` = `"string"`
12
12
 
13
13
  String.
14
14
 
15
- ### Number
15
+ ### Number {#number}
16
16
 
17
17
  > `readonly` **Number**: `"number"` = `"number"`
18
18
 
19
19
  Number.
20
20
 
21
- ### Integer
21
+ ### Integer {#integer}
22
22
 
23
23
  > `readonly` **Integer**: `"integer"` = `"integer"`
24
24
 
25
25
  Integer.
26
26
 
27
- ### Boolean
27
+ ### Boolean {#boolean}
28
28
 
29
29
  > `readonly` **Boolean**: `"boolean"` = `"boolean"`
30
30
 
31
31
  Boolean.
32
32
 
33
- ### BigInt
33
+ ### BigInt {#bigint}
34
34
 
35
35
  > `readonly` **BigInt**: `"bigint"` = `"bigint"`
36
36
 
37
37
  Big Integer.
38
38
 
39
- ### Date
39
+ ### Date {#date}
40
40
 
41
41
  > `readonly` **Date**: `"date"` = `"date"`
42
42
 
43
43
  Date.
44
44
 
45
- ### DateTime
45
+ ### DateTime {#datetime}
46
46
 
47
47
  > `readonly` **DateTime**: `"datetime"` = `"datetime"`
48
48
 
49
49
  Date Time.
50
50
 
51
- ### Time
51
+ ### Time {#time}
52
52
 
53
53
  > `readonly` **Time**: `"time"` = `"time"`
54
54
 
55
55
  Time.
56
56
 
57
- ### Object
57
+ ### Object {#object}
58
58
 
59
59
  > `readonly` **Object**: `"object"` = `"object"`
60
60
 
61
61
  Object.
62
62
 
63
- ### Uint8Array
63
+ ### Uint8Array {#uint8array}
64
64
 
65
65
  > `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
66
66
 
package/docs/reference/variables/CompressionType.md CHANGED
@@ -6,13 +6,13 @@ Compression types.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Gzip
9
+ ### Gzip {#gzip}
10
10
 
11
11
  > `readonly` **Gzip**: `"gzip"` = `"gzip"`
12
12
 
13
13
  Gzip.
14
14
 
15
- ### Deflate
15
+ ### Deflate {#deflate}
16
16
 
17
17
  > `readonly` **Deflate**: `"deflate"` = `"deflate"`
18
18
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/core",
3
- "version": "0.0.3-next.21",
3
+ "version": "0.0.3-next.23",
4
4
  "description": "Helper methods/classes for data type checking/validation/guarding/error handling",
5
5
  "repository": {
6
6
  "type": "git",
@@ -14,9 +14,9 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/nameof": "0.0.3-next.21",
18
- "intl-messageformat": "10.7.18",
19
- "rfc6902": "5.1.2"
17
+ "@twin.org/nameof": "0.0.3-next.23",
18
+ "intl-messageformat": "11.1.2",
19
+ "rfc6902": "5.2.0"
20
20
  },
21
21
  "main": "./dist/es/index.js",
22
22
  "types": "./dist/types/index.d.ts",
package/dist/es/models/objectOrArray.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"objectOrArray.js","sourceRoot":"","sources":["../../../src/models/objectOrArray.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n/**\n * Object or array data type\n */\nexport type ObjectOrArray<T = unknown> = T | T[];\n"]}
/package/dist/es/{models → types}/objectOrArray.js RENAMED
File without changes
/package/dist/types/{models → types}/objectOrArray.d.ts RENAMED
File without changes