npm - @twin.org/core - Versions diffs - 0.0.1-next.4 → 0.0.1-next.40 - Mend

@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

package/dist/cjs/index.cjs +1379 -738
package/dist/esm/index.mjs +1376 -739
package/dist/types/encoding/base58.d.ts +18 -0
package/dist/types/factories/factory.d.ts +20 -1
package/dist/types/helpers/envHelper.d.ts +16 -0
package/dist/types/helpers/jsonHelper.d.ts +29 -0
package/dist/types/helpers/objectHelper.d.ts +33 -0
package/dist/types/helpers/uint8ArrayHelper.d.ts +11 -0
package/dist/types/index.d.ts +4 -0
package/dist/types/models/IComponent.d.ts +12 -3
package/dist/types/models/coerceType.d.ts +49 -0
package/dist/types/models/compressionType.d.ts +1 -1
package/dist/types/utils/coerce.d.ts +22 -0
package/dist/types/utils/converter.d.ts +12 -0
package/dist/types/utils/guards.d.ts +16 -0
package/dist/types/utils/is.d.ts +12 -0
package/dist/types/utils/validation.d.ts +2 -0
package/docs/changelog.md +1 -1
package/docs/reference/classes/AlreadyExistsError.md +67 -25
package/docs/reference/classes/ArrayHelper.md +6 -2
package/docs/reference/classes/AsyncCache.md +18 -6
package/docs/reference/classes/Base32.md +6 -2
package/docs/reference/classes/Base58.md +61 -0
package/docs/reference/classes/Base64.md +9 -3
package/docs/reference/classes/Base64Url.md +6 -2
package/docs/reference/classes/BaseError.md +65 -23
package/docs/reference/classes/BitString.md +18 -6
package/docs/reference/classes/Coerce.md +104 -8
package/docs/reference/classes/Compression.md +12 -4
package/docs/reference/classes/ConflictError.md +70 -26
package/docs/reference/classes/Converter.md +104 -20
package/docs/reference/classes/EnvHelper.md +43 -0
package/docs/reference/classes/ErrorHelper.md +9 -3
package/docs/reference/classes/Factory.md +78 -10
package/docs/reference/classes/FilenameHelper.md +3 -1
package/docs/reference/classes/GeneralError.md +65 -25
package/docs/reference/classes/GuardError.md +70 -26
package/docs/reference/classes/Guards.md +284 -72
package/docs/reference/classes/HexHelper.md +15 -5
package/docs/reference/classes/I18n.md +42 -16
package/docs/reference/classes/Is.md +156 -40
package/docs/reference/classes/JsonHelper.md +133 -5
package/docs/reference/classes/NotFoundError.md +67 -25
package/docs/reference/classes/NotImplementedError.md +61 -23
package/docs/reference/classes/NotSupportedError.md +64 -24
package/docs/reference/classes/ObjectHelper.md +188 -20
package/docs/reference/classes/RandomHelper.md +3 -1
package/docs/reference/classes/StringHelper.md +51 -17
package/docs/reference/classes/Uint8ArrayHelper.md +35 -0
package/docs/reference/classes/UnauthorizedError.md +64 -24
package/docs/reference/classes/UnprocessableError.md +65 -25
package/docs/reference/classes/Url.md +30 -10
package/docs/reference/classes/Urn.md +54 -18
package/docs/reference/classes/Validation.md +313 -107
package/docs/reference/classes/ValidationError.md +64 -24
package/docs/reference/index.md +5 -0
package/docs/reference/interfaces/IComponent.md +30 -8
package/docs/reference/interfaces/IError.md +1 -1
package/docs/reference/interfaces/ILocaleDictionary.md +1 -1
package/docs/reference/interfaces/IValidationFailure.md +1 -1
package/docs/reference/type-aliases/CoerceType.md +5 -0
package/docs/reference/variables/CoerceType.md +67 -0
package/docs/reference/variables/CompressionType.md +1 -1
package/locales/en.json +18 -1
package/package.json +6 -6

package/docs/reference/classes/Uint8ArrayHelper.md ADDED Viewed

@@ -0,0 +1,35 @@
+# Class: Uint8ArrayHelper
+Class to help with uint8 arrays.
+## Constructors
+### new Uint8ArrayHelper()
+> **new Uint8ArrayHelper**(): [`Uint8ArrayHelper`](Uint8ArrayHelper.md)
+#### Returns
+[`Uint8ArrayHelper`](Uint8ArrayHelper.md)
+## Methods
+### concat()
+> `static` **concat**(`arrays`): `Uint8Array`
+Concatenate multiple arrays.
+#### Parameters
+##### arrays
+`Uint8Array`[]
+The array to concatenate.
+#### Returns
+`Uint8Array`
+The combined array.

package/docs/reference/classes/UnauthorizedError.md CHANGED Viewed

@@ -16,15 +16,21 @@ Create a new instance of UnauthorizedError.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **message**: `string`
+##### message
+`string`
 The message as a code.
-• **inner?**: `unknown`
+##### inner?
+`unknown`
 The inner error if we have wrapped another error.
@@ -46,7 +52,7 @@ The source of the error.
 #### Inherited from
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 ***
@@ -58,11 +64,11 @@ Any additional information for the error.
 #### Index Signature
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 #### Inherited from
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
 ***
@@ -74,7 +80,7 @@ The inner error if there was one.
 #### Inherited from
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
 ***
@@ -94,7 +100,9 @@ Construct an error from an existing one.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The existing error.
@@ -118,7 +126,9 @@ Flatten an error tree.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The starting error.
@@ -142,10 +152,12 @@ Expand an error tree.
 #### Parameters
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 The list of errors to expand.
+`undefined` | [`IError`](../interfaces/IError.md)[]
 #### Returns
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -166,14 +178,18 @@ Test to see if the error has the specified error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -194,14 +210,18 @@ Test to see if the error has the specified error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -222,14 +242,18 @@ Test to see if the error has the specified error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `boolean`
@@ -250,14 +274,18 @@ Test to see if any of the errors or children have the given error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -278,14 +306,18 @@ Test to see if any of the errors or children have the given error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -306,11 +338,15 @@ Test to see if any of the errors or children are from a specific class.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **cls**: `string`
+##### cls
+`string`
 The class to check for.
@@ -334,14 +370,18 @@ Test to see if any of the errors or children have the given error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`

package/docs/reference/classes/UnprocessableError.md CHANGED Viewed

@@ -16,19 +16,25 @@ Create a new instance of UnprocessableError.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **message**: `string`
+##### message
+`string`
 The message as a code.
-• **properties?**
+##### properties?
 Any additional information for the error.
-• **inner?**: `unknown`
+##### inner?
+`unknown`
 The inner error if we have wrapped another error.
@@ -50,7 +56,7 @@ The source of the error.
 #### Inherited from
-[`BaseError`](BaseError.md).[`source`](BaseError.md#source)
+[`BaseError`](BaseError.md).[`source`](BaseError.md#source-1)
 ***
@@ -62,11 +68,11 @@ Any additional information for the error.
 #### Index Signature
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 #### Inherited from
-[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties)
+[`BaseError`](BaseError.md).[`properties`](BaseError.md#properties-1)
 ***
@@ -78,7 +84,7 @@ The inner error if there was one.
 #### Inherited from
-[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner)
+[`BaseError`](BaseError.md).[`inner`](BaseError.md#inner-1)
 ***
@@ -98,7 +104,9 @@ Construct an error from an existing one.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The existing error.
@@ -122,7 +130,9 @@ Flatten an error tree.
 #### Parameters
-• **err**: `unknown`
+##### err
+`unknown`
 The starting error.
@@ -146,10 +156,12 @@ Expand an error tree.
 #### Parameters
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 The list of errors to expand.
+`undefined` | [`IError`](../interfaces/IError.md)[]
 #### Returns
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -170,14 +182,18 @@ Test to see if the error has the specified error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -198,14 +214,18 @@ Test to see if the error has the specified error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -226,14 +246,18 @@ Test to see if the error has the specified error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `boolean`
@@ -254,14 +278,18 @@ Test to see if any of the errors or children have the given error name.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **name**: `string` \| `RegExp`
+##### name
 The name to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -282,14 +310,18 @@ Test to see if any of the errors or children have the given error message.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **message**: `string` \| `RegExp`
+##### message
 The message to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`
@@ -310,11 +342,15 @@ Test to see if any of the errors or children are from a specific class.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **cls**: `string`
+##### cls
+`string`
 The class to check for.
@@ -338,14 +374,18 @@ Test to see if any of the errors or children have the given error code.
 #### Parameters
-• **error**: `unknown`
+##### error
+`unknown`
 The error to test.
-• **code**: `string` \| `RegExp`
+##### code
 The code to check for.
+`string` | `RegExp`
 #### Returns
 `error is BaseError`

package/docs/reference/classes/Url.md CHANGED Viewed

@@ -12,7 +12,9 @@ Create a new instance of Url.
 #### Parameters
-• **url**: `string`
+##### url
+`string`
 The url string.
@@ -30,7 +32,9 @@ Try and parse a string into the url parts.
 #### Parameters
-• **url**: `unknown`
+##### url
+`unknown`
 The url to parse.
@@ -50,15 +54,21 @@ Parse a string into the url parts.
 #### Parameters
-• **source**: `string`
+##### source
+`string`
 The source of the error.
-• **property**: `string`
+##### property
+`string`
 The name of the property.
-• **value**: `unknown`
+##### value
+`unknown`
 The url to parse.
@@ -80,15 +90,21 @@ Validate a string as a Url.
 #### Parameters
-• **property**: `string`
+##### property
+`string`
 Throw an exception if the url property is invalid.
-• **value**: `unknown`
+##### value
+`unknown`
 The url to parse.
-• **failures**: [`IValidationFailure`](../interfaces/IValidationFailure.md)[]
+##### failures
+[`IValidationFailure`](../interfaces/IValidationFailure.md)[]
 The list of failures to add to.
@@ -108,7 +124,9 @@ Construct a url from a URL.
 #### Parameters
-• **url**: `URL`
+##### url
+`URL`
 The url to construct from.
@@ -128,7 +146,9 @@ Construct a url from valid parts.
 #### Parameters
-• **urlParts**: [`IUrlParts`](../interfaces/IUrlParts.md)
+##### urlParts
+[`IUrlParts`](../interfaces/IUrlParts.md)
 The url to create the parts from.