@twin.org/core 0.0.2-next.9 → 0.0.3-next.2

package/docs/reference/classes/ObjectHelper.md

@@ -12,6 +12,14 @@ Class to help with objects.
 
 `ObjectHelper`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### toBytes()
@@ -32,7 +40,7 @@ Convert an object to bytes.
 
 The object to convert.
 
-`undefined` | `T`
+`T` | `undefined`
 
 ##### format
 
@@ -66,7 +74,7 @@ Convert a bytes to an object.
 
 The bytes to convert to an object.
 
-`undefined` | `null` | `Uint8Array`\<`ArrayBufferLike`\>
+`Uint8Array`\<`ArrayBufferLike`\> | `null` | `undefined`
 
 #### Returns
 
@@ -188,7 +196,7 @@ True is the objects are equal.
 
 ### propertyGet()
 
-> `static` **propertyGet**\<`T`\>(`obj`, `property`): `undefined` \| `T`
+> `static` **propertyGet**\<`T`\>(`obj`, `property`): `T` \| `undefined`
 
 Get the property of an unknown object.
 
@@ -214,7 +222,7 @@ The property to get, can be separated by dots for nested path.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property.
 
@@ -284,7 +292,7 @@ The property to set
 
 ### extractProperty()
 
-> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `undefined` \| `T`
+> `static` **extractProperty**\<`T`\>(`obj`, `propertyNames`, `removeProperties`): `T` \| `undefined`
 
 Extract a property from the object, providing alternative names.
 
@@ -316,7 +324,7 @@ Remove the properties from the object, defaults to true.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property if available.
 
@@ -340,7 +348,7 @@ Pick a subset of properties from an object.
 
 The object to pick the properties from.
 
-`undefined` | `T`
+`T` | `undefined`
 
 ##### keys?
 
@@ -374,7 +382,7 @@ Omit a subset of properties from an object.
 
 The object to omit the properties from.
 
-`undefined` | `T`
+`T` | `undefined`
 
 ##### keys?
 
@@ -390,6 +398,48 @@ The partial object.
 
 ***
 
+### split()
+
+> `static` **split**\<`T`\>(`obj`, `keys?`): `object`
+
+Split an object into two with the specified keys.
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### obj
+
+The object to split.
+
+`T` | `undefined`
+
+##### keys?
+
+keyof `T`[]
+
+The property keys to split.
+
+#### Returns
+
+`object`
+
+The two partial objects.
+
+##### picked
+
+> **picked**: `Partial`\<`T`\> \| `undefined`
+
+##### omitted
+
+> **omitted**: `Partial`\<`T`\> \| `undefined`
+
+***
+
 ### toExtended()
 
 > `static` **toExtended**(`obj`): `any`

package/docs/reference/classes/SharedStore.md

@@ -17,7 +17,7 @@ instance loads of a packages.
 
 ### get()
 
-> `static` **get**\<`T`\>(`prop`): `undefined` \| `T`
+> `static` **get**\<`T`\>(`prop`): `T` \| `undefined`
 
 Get a property from the shared store.
 
@@ -37,7 +37,7 @@ The name of the property to get.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property if it exists.
 

package/docs/reference/classes/StringHelper.md

@@ -18,21 +18,21 @@ Class to help with string.
 
 > `static` **trimTrailingSlashes**(`value`): `string`
 
-Trim trailing slashes from a string.
+Implementation signature for trimTrailingSlashes.
 
 #### Parameters
 
 ##### value
 
-The value to trim.
+`string`
 
-`undefined` | `string`
+The value to trim.
 
 #### Returns
 
 `string`
 
-The trimmed value.
+The trimmed string or the original.
 
 ***
 
@@ -40,21 +40,21 @@ The trimmed value.
 
 > `static` **trimLeadingSlashes**(`value`): `string`
 
-Trim leading slashes from a string.
+Implementation signature for trimLeadingSlashes.
 
 #### Parameters
 
 ##### value
 
-The value to trim.
+`string`
 
-`undefined` | `string`
+The value to trim.
 
 #### Returns
 
 `string`
 
-The trimmed value.
+The trimmed string or the original.
 
 ***
 

package/docs/reference/classes/UnauthorizedError.md

@@ -10,7 +10,7 @@ Class to handle errors which are triggered by access not being unauthorized.
 
 ### Constructor
 
-> **new UnauthorizedError**(`source`, `message`, `cause?`): `UnauthorizedError`
+> **new UnauthorizedError**(`source`, `message`, `properties?`, `cause?`): `UnauthorizedError`
 
 Create a new instance of UnauthorizedError.
 
@@ -28,6 +28,10 @@ The source of the error.
 
 The message as a code.
 
+##### properties?
+
+Any additional information for the error.
+
 ##### cause?
 
 `unknown`
@@ -146,7 +150,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -156,11 +160,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/UnprocessableError.md

@@ -150,7 +150,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -160,11 +160,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/classes/Url.md

@@ -22,11 +22,19 @@ The url string.
 
 `Url`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`url`): `undefined` \| `Url`
+> `static` **tryParseExact**(`url`): `Url` \| `undefined`
 
 Try and parse a string into the url parts.
 
@@ -40,7 +48,7 @@ The url to parse.
 
 #### Returns
 
-`undefined` \| `Url`
+`Url` \| `undefined`
 
 The formatted url or undefined if the value is not a url.
 
@@ -84,7 +92,7 @@ GuardError If the value does not match the assertion.
 
 ### validate()
 
-> `static` **validate**(`property`, `value`, `failures`): `value is Url`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is Url`
 
 Validate a string as a Url.
 
@@ -108,6 +116,12 @@ The url to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is Url`

package/docs/reference/classes/Urn.md

@@ -28,6 +28,14 @@ The specific part of the namespace.
 
 `Urn`
 
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
 ### generateRandom()
@@ -82,7 +90,7 @@ True if the namespace matches.
 
 ### tryParseExact()
 
-> `static` **tryParseExact**(`urn`): `undefined` \| `Urn`
+> `static` **tryParseExact**(`urn`): `Urn` \| `undefined`
 
 Try and parse a string into the urn parts.
 
@@ -96,7 +104,7 @@ The urn to parse.
 
 #### Returns
 
-`undefined` \| `Urn`
+`Urn` \| `undefined`
 
 The formatted urn or undefined if the value is not a urn.
 
@@ -126,7 +134,7 @@ The formatted urn.
 
 ### addPrefix()
 
-> `static` **addPrefix**(`urn`): `undefined` \| `string`
+> `static` **addPrefix**(`urn`): `string` \| `undefined`
 
 Add a urn: prefix if there isn't one already.
 
@@ -140,7 +148,7 @@ The urn string to add a prefix to.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The urn with a prefix.
 
@@ -184,7 +192,7 @@ GuardError If the value does not match the assertion.
 
 ### validate()
 
-> `static` **validate**(`property`, `value`, `failures`): `value is string`
+> `static` **validate**(`property`, `value`, `failures`, `fieldNameResource?`): `value is string`
 
 Validate a string as a Urn.
 
@@ -208,6 +216,12 @@ The urn to parse.
 
 The list of failures to add to.
 
+##### fieldNameResource?
+
+`string`
+
+The optional human readable name for the field as an i18 resource.
+
 #### Returns
 
 `value is string`

package/docs/reference/classes/Validation.md

@@ -16,7 +16,7 @@ Class to handle validation operations.
 
 ### empty()
 
-> `static` **empty**(`property`, `value`, `failures`, `fieldNameResource?`): value is undefined \| null
+> `static` **empty**(`property`, `value`, `failures`, `fieldNameResource?`): value is null \| undefined
 
 Is the property null or undefined.
 
@@ -48,7 +48,7 @@ Optional i18n resource of the field name to display in the message.
 
 #### Returns
 
-value is undefined \| null
+value is null \| undefined
 
 True if the value is a empty.
 

package/docs/reference/classes/ValidationError.md

@@ -146,7 +146,7 @@ The list of all internal errors.
 
 ### expand()
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -156,11 +156,11 @@ Expand an error tree.
 
 The list of errors to expand.
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+[`IError`](../interfaces/IError.md)[] | `undefined`
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 

package/docs/reference/index.md

@@ -24,6 +24,7 @@
 - [FilenameHelper](classes/FilenameHelper.md)
 - [HexHelper](classes/HexHelper.md)
 - [JsonHelper](classes/JsonHelper.md)
+- [NumberHelper](classes/NumberHelper.md)
 - [ObjectHelper](classes/ObjectHelper.md)
 - [RandomHelper](classes/RandomHelper.md)
 - [StringHelper](classes/StringHelper.md)

package/docs/reference/interfaces/IComponent.md

@@ -2,29 +2,35 @@
 
 Interface describing a component which can be bootstrapped, started and stopped.
 
-## Properties
+## Methods
 
-### CLASS\_NAME
+### className()
 
-> `readonly` **CLASS\_NAME**: `string`
+> **className**(): `string`
 
-The name of the component.
+Returns the class name of the component.
 
-## Methods
+#### Returns
+
+`string`
+
+The class name of the component.
+
+***
 
 ### bootstrap()?
 
-> `optional` **bootstrap**(`nodeLoggingComponentType`): `Promise`\<`boolean`\>
+> `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-##### nodeLoggingComponentType
+##### nodeLoggingComponentType?
 
-The node logging component type.
+`string`
 
-`undefined` | `string`
+The node logging component type.
 
 #### Returns
 
@@ -36,24 +42,18 @@ True if the bootstrapping process was successful.
 
 ### start()?
 
-> `optional` **start**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
+> `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The component needs to be started when the node is initialized.
 
 #### Parameters
 
-##### nodeIdentity
+##### nodeLoggingComponentType?
 
 `string`
 
-The identity of the node starting the component.
-
-##### nodeLoggingComponentType
-
 The node logging component type.
 
-`undefined` | `string`
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -64,24 +64,18 @@ Nothing.
 
 ### stop()?
 
-> `optional` **stop**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
+> `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
 #### Parameters
 
-##### nodeIdentity
+##### nodeLoggingComponentType?
 
 `string`
 
-The identity of the node stopping the component.
-
-##### nodeLoggingComponentType
-
 The node logging component type.
 
-`undefined` | `string`
-
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/interfaces/IValidationFailure.md

@@ -20,14 +20,6 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### fieldName?
-
-> `optional` **fieldName**: `string`
-
-The optional human readable name for the field as an i18 resource.
-
-***
-
 ### properties?
 
 > `optional` **properties**: `object`

package/locales/.validate-ignore

@@ -0,0 +1 @@
+^errorNames.*$

package/locales/en.json

@@ -38,9 +38,7 @@
 			"beUrn": "{fieldName} must be a correctly formatted urn",
 			"beUrl": "{fieldName} must be a correctly formatted url",
 			"beJSON": "{fieldName} must be correctly formatted JSON",
-			"beEmail": "{fieldName} must be a correctly formatted e-mail address",
-			"failed": "Validation failed",
-			"failedObject": "Validation of \"{objectName}\" failed"
+			"beEmail": "{fieldName} must be a correctly formatted e-mail address"
 		},
 		"guard": {
 			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
@@ -87,7 +85,7 @@
 			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
 		},
 		"bitString": {
-			"outOfRange": "The index should be >= 0 and less than the length of the bit string"
+			"outOfRange": "The index should be >= 0 and less than the length of the bit string, the index is \"{index}\" and the number of bit is \"{numberBits}\""
 		},
 		"base32": {
 			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
@@ -112,7 +110,8 @@
 		"alreadyExistsError": "Already Exists",
 		"notImplementedError": "Not Implemented",
 		"validationError": "Validation",
-		"unprocessableError": "Unprocessable"
+		"unprocessableError": "Unprocessable",
+		"unauthorizedError": "Unauthorized"
 	},
 	"validation": {
 		"defaultFieldName": "The field"

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,26 +14,38 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.2-next.9",
-		"intl-messageformat": "10.7.16",
+		"@twin.org/nameof": "0.0.3-next.2",
+		"intl-messageformat": "10.7.18",
 		"rfc6902": "5.1.2"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"core",
+		"foundation",
+		"utilities"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }