@twin.org/core 0.0.1-next.1

package/docs/reference/interfaces/IUrlParts.md

@@ -0,0 +1,51 @@
+# Interface: IUrlParts
+
+Model to describe the parts of a url.
+
+## Properties
+
+### schema
+
+> **schema**: `string`
+
+The schema for the url.
+
+***
+
+### host
+
+> **host**: `string`
+
+The host for the url.
+
+***
+
+### port?
+
+> `optional` **port**: `number`
+
+The port for the url.
+
+***
+
+### path
+
+> **path**: `string`
+
+The path for the url.
+
+***
+
+### params?
+
+> `optional` **params**: `string`
+
+The params for the url.
+
+***
+
+### hash?
+
+> `optional` **hash**: `string`
+
+The hash for the url.

package/docs/reference/interfaces/IValidationFailure.md

@@ -0,0 +1,39 @@
+# Interface: IValidationFailure
+
+Interface describing the reason a validation failed.
+
+## Properties
+
+### property
+
+> **property**: `string`
+
+The property that failed validation.
+
+***
+
+### reason
+
+> **reason**: `string`
+
+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`
+
+Additional properties for the validation failure.
+
+#### Index Signature
+
+ \[`id`: `string`\]: `unknown`

package/docs/reference/type-aliases/CompressionType.md

@@ -0,0 +1,5 @@
+# Type Alias: CompressionType
+
+> **CompressionType**: *typeof* [`CompressionType`](../variables/CompressionType.md)\[keyof *typeof* [`CompressionType`](../variables/CompressionType.md)\]
+
+Compression types.

package/docs/reference/variables/ComponentFactory.md

@@ -0,0 +1,5 @@
+# Variable: ComponentFactory
+
+> `const` **ComponentFactory**: [`Factory`](../classes/Factory.md)\<[`IComponent`](../interfaces/IComponent.md)\>
+
+Factory for creating implementation of component types.

package/docs/reference/variables/CompressionType.md

@@ -0,0 +1,19 @@
+# Variable: CompressionType
+
+> `const` **CompressionType**: `object`
+
+Compression types.
+
+## Type declaration
+
+### Gzip
+
+> `readonly` **Gzip**: `"gzip"` = `"gzip"`
+
+Gzip.
+
+### Deflate
+
+> `readonly` **Deflate**: `"deflate"` = `"deflate"`
+
+deflate.

package/locales/en.json

@@ -0,0 +1,98 @@
+{
+	"error": {
+		"validation": {
+			"beEmpty": "{fieldName} must be empty",
+			"beNotEmpty": "{fieldName} must not be empty",
+			"beText": "{fieldName} must be text",
+			"beTextValue": "{fieldName} must contain some text",
+			"beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
+			"beTextMin": "{fieldName} must be longer than {minLength} characters",
+			"beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+			"beNumber": "{fieldName} must be a number",
+			"beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
+			"beNumberMin": "{fieldName} must be >= {minValue}",
+			"beNumberMax": "{fieldName} must be <= {maxValue}",
+			"beWholeNumber": "{fieldName} must be a whole number",
+			"beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
+			"beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
+			"beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
+			"beBigInteger": "{fieldName} must be a bigint",
+			"beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
+			"beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
+			"beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
+			"beBoolean": "{fieldName} must be true or false",
+			"beDate": "{fieldName} must be a date",
+			"beDateTime": "{fieldName} must be a date/time",
+			"beTime": "{fieldName} must be a time",
+			"beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
+			"beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
+			"beObject": "{fieldName} must be an object",
+			"beArray": "{fieldName} must be an array",
+			"beArrayValue": "{fieldName} must be an array with at least one item",
+			"beIncluded": "{fieldName} is unrecognised",
+			"beByteArray": "{fieldName} must be a byte array",
+			"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"
+		},
+		"guard": {
+			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
+			"string": "Property \"{property}\" must be a string, it is \"{value}\"",
+			"stringEmpty": "Property \"{property}\" must have a value, it is empty",
+			"stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
+			"stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+			"stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
+			"stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+			"number": "Property \"{property}\" must be a number, it is \"{value}\"",
+			"integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
+			"bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
+			"boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
+			"date": "Property \"{property}\" must be a date, it is \"{value}\"",
+			"timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
+			"timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
+			"objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
+			"object": "Property \"{property}\" must be an object, it is \"{value}\"",
+			"objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
+			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
+			"arrayValue": "Property \"{property}\" must be an array with at least one item",
+			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
+			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
+			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
+			"url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
+			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\""
+		},
+		"objectHelper": {
+			"failedBytesToJSON": "Failed converting bytes to JSON"
+		},
+		"common": {
+			"notImplementedMethod": "The method \"{method}\" has not been implemented",
+			"validation": "Validation failed"
+		},
+		"factory": {
+			"noUnregister": "There is no {typeName} registered with the name \"{name}\"",
+			"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"
+		}
+	},
+	"errorNames": {
+		"error": "Error",
+		"generalError": "General",
+		"guardError": "Guard",
+		"conflictError": "Conflict",
+		"notFoundError": "Not Found",
+		"notSupportedError": "Not Supported",
+		"alreadyExistsError": "Already Exists",
+		"notImplementedError": "Not Implemented",
+		"validationError": "Validation",
+		"unprocessableError": "Unprocessable"
+	},
+	"validation": {
+		"defaultFieldName": "The field"
+	}
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "@twin.org/core",
+	"version": "0.0.1-next.1",
+	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "packages/core"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/nameof": "next",
+		"intl-messageformat": "10.5.14",
+		"rfc6902": "5.1.1"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}