@twin.org/core 0.0.2-next.8 → 0.0.2

package/docs/reference/interfaces/IHealth.md

@@ -0,0 +1,55 @@
+# Interface: IHealth
+
+Provides health information for a component.
+
+## Properties
+
+### source {#source}
+
+> **source**: `string`
+
+The source of the health information.
+
+***
+
+### description? {#description}
+
+> `optional` **description?**: `string`
+
+The description of the component as an i18n key.
+
+***
+
+### status {#status}
+
+> **status**: [`HealthStatus`](../type-aliases/HealthStatus.md)
+
+The overall status of the component, the entries can also report their own health.
+
+***
+
+### message? {#message}
+
+> `optional` **message?**: `string`
+
+The message for the status if there are further details to provide as an i18n key.
+
+***
+
+### data? {#data}
+
+> `optional` **data?**: `object`
+
+Data to substitute in the i18n key for the message.
+
+#### Index Signature
+
+\[`id`: `string`\]: `unknown`
+
+***
+
+### grouped? {#grouped}
+
+> `optional` **grouped?**: `IHealth`[]
+
+The grouped child components, if any.

package/docs/reference/interfaces/II18nShared.md

@@ -4,7 +4,7 @@ The shared state for the I18n global.
 
 ## Properties
 
-### localeDictionaries
+### localeDictionaries {#localedictionaries}
 
 > **localeDictionaries**: `object`
 
@@ -16,7 +16,7 @@ Dictionaries for lookups.
 
 ***
 
-### currentLocale
+### currentLocale {#currentlocale}
 
 > **currentLocale**: `string`
 
@@ -24,7 +24,7 @@ The current locale.
 
 ***
 
-### localeChangedHandlers
+### localeChangedHandlers {#localechangedhandlers}
 
 > **localeChangedHandlers**: `object`
 
@@ -36,7 +36,7 @@ Change handler for the locale being updated.
 
 ***
 
-### dictionaryChangedHandlers
+### dictionaryChangedHandlers {#dictionarychangedhandlers}
 
 > **dictionaryChangedHandlers**: `object`
 

package/docs/reference/interfaces/IKeyValue.md

@@ -10,7 +10,7 @@ Interface describing a key/value pair.
 
 ## Properties
 
-### key
+### key {#key}
 
 > **key**: `string`
 
@@ -18,7 +18,7 @@ The key for the item.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `T`
 

package/docs/reference/interfaces/ILabelledValue.md

@@ -10,7 +10,7 @@ Interface describing a label/value pair.
 
 ## Properties
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -18,7 +18,7 @@ The label for the item.
 
 ***
 
-### value
+### value {#value}
 
 > **value**: `T`
 

package/docs/reference/interfaces/ILocale.md

@@ -4,7 +4,7 @@ Model for a local.
 
 ## Properties
 
-### label
+### label {#label}
 
 > **label**: `string`
 
@@ -12,7 +12,7 @@ The label.
 
 ***
 
-### code
+### code {#code}
 
 > **code**: `string`
 

package/docs/reference/interfaces/ILocaleDictionary.md

@@ -4,4 +4,4 @@ Type for the JSON locale dictionary files.
 
 ## Indexable
 
-\[`key`: `string`\]: `string` \| `ILocaleDictionary`
+> \[`key`: `string`\]: `string` \| `ILocaleDictionary`

package/docs/reference/interfaces/ILocalesIndex.md

@@ -4,7 +4,7 @@ Model for a locales index.
 
 ## Properties
 
-### locales
+### locales {#locales}
 
 > **locales**: [`ILocale`](ILocale.md)[]
 

package/docs/reference/interfaces/IPatchOperation.md

@@ -4,7 +4,7 @@ Interface describing a patch operation to add a property.
 
 ## Properties
 
-### op
+### op {#op}
 
 > **op**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
@@ -12,7 +12,7 @@ The operation that was performed on the item.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -20,16 +20,16 @@ The path to the object that was changed.
 
 ***
 
-### from?
+### from? {#from}
 
-> `optional` **from**: `string`
+> `optional` **from?**: `string`
 
 The path the value was copied or moved from.
 
 ***
 
-### value?
+### value? {#value}
 
-> `optional` **value**: `unknown`
+> `optional` **value?**: `unknown`
 
 The value to add.

package/docs/reference/interfaces/IUrlParts.md

@@ -4,7 +4,7 @@ Model to describe the parts of a url.
 
 ## Properties
 
-### schema
+### schema {#schema}
 
 > **schema**: `string`
 
@@ -12,7 +12,7 @@ The schema for the url.
 
 ***
 
-### host
+### host {#host}
 
 > **host**: `string`
 
@@ -20,15 +20,15 @@ The host for the url.
 
 ***
 
-### port?
+### port? {#port}
 
-> `optional` **port**: `number`
+> `optional` **port?**: `number`
 
 The port for the url.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -36,16 +36,16 @@ The path for the url.
 
 ***
 
-### params?
+### params? {#params}
 
-> `optional` **params**: `string`
+> `optional` **params?**: `string`
 
 The params for the url.
 
 ***
 
-### hash?
+### hash? {#hash}
 
-> `optional` **hash**: `string`
+> `optional` **hash?**: `string`
 
 The hash for the url.

package/docs/reference/interfaces/IValidationFailure.md

@@ -4,7 +4,7 @@ Interface describing the reason a validation failed.
 
 ## Properties
 
-### property
+### property {#property}
 
 > **property**: `string`
 
@@ -12,7 +12,7 @@ The property that failed validation.
 
 ***
 
-### reason
+### reason {#reason}
 
 > **reason**: `string`
 
@@ -20,17 +20,9 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### fieldName?
+### properties? {#properties}
 
-> `optional` **fieldName**: `string`
-
-The optional human readable name for the field as an i18 resource.
-
-***
-
-### properties?
-
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Additional properties for the validation failure.
 

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

@@ -0,0 +1,5 @@
+# Type Alias: HealthStatus
+
+> **HealthStatus** = *typeof* [`HealthStatus`](../variables/HealthStatus.md)\[keyof *typeof* [`HealthStatus`](../variables/HealthStatus.md)\]
+
+The health status of the component.

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

@@ -0,0 +1,15 @@
+# Type Alias: SingleOccurrenceArray\<T, U\>
+
+> **SingleOccurrenceArray**\<`T`, `U`\> = [`SingleOccurrenceArrayDepthHelper`](SingleOccurrenceArrayDepthHelper.md)\<`T`, `U`, \[\]\>
+
+Utility type to create a non-empty array with values of type T and exactly one value of type U.
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+### U
+
+`U` = `never`

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

@@ -0,0 +1,19 @@
+# Type Alias: SingleOccurrenceArrayDepthHelper\<T, U, Depth\>
+
+> **SingleOccurrenceArrayDepthHelper**\<`T`, `U`, `Depth`\> = `Depth`\[`"length"`\] *extends* `16` ? \[`U`, `...T[]`\] : \[`U`, `...T[]`\] \| \[`T`, `...SingleOccurrenceArrayDepthHelper<T, U, [0, ...Depth]>`\]
+
+Helper with bounded recursion depth to keep type instantiation tractable.
+
+## Type Parameters
+
+### T
+
+`T`
+
+### U
+
+`U`
+
+### Depth
+
+`Depth` *extends* `0`[]

package/docs/reference/variables/CoerceType.md

@@ -6,61 +6,61 @@ The types the extracted data can be coerced to.
 
 ## Type Declaration
 
-### String
+### String {#string}
 
 > `readonly` **String**: `"string"` = `"string"`
 
 String.
 
-### Number
+### Number {#number}
 
 > `readonly` **Number**: `"number"` = `"number"`
 
 Number.
 
-### Integer
+### Integer {#integer}
 
 > `readonly` **Integer**: `"integer"` = `"integer"`
 
 Integer.
 
-### Boolean
+### Boolean {#boolean}
 
 > `readonly` **Boolean**: `"boolean"` = `"boolean"`
 
 Boolean.
 
-### BigInt
+### BigInt {#bigint}
 
 > `readonly` **BigInt**: `"bigint"` = `"bigint"`
 
 Big Integer.
 
-### Date
+### Date {#date}
 
 > `readonly` **Date**: `"date"` = `"date"`
 
 Date.
 
-### DateTime
+### DateTime {#datetime}
 
 > `readonly` **DateTime**: `"datetime"` = `"datetime"`
 
 Date Time.
 
-### Time
+### Time {#time}
 
 > `readonly` **Time**: `"time"` = `"time"`
 
 Time.
 
-### Object
+### Object {#object}
 
 > `readonly` **Object**: `"object"` = `"object"`
 
 Object.
 
-### Uint8Array
+### Uint8Array {#uint8array}
 
 > `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
 

package/docs/reference/variables/CompressionType.md

@@ -6,13 +6,13 @@ Compression types.
 
 ## Type Declaration
 
-### Gzip
+### Gzip {#gzip}
 
 > `readonly` **Gzip**: `"gzip"` = `"gzip"`
 
 Gzip.
 
-### Deflate
+### Deflate {#deflate}
 
 > `readonly` **Deflate**: `"deflate"` = `"deflate"`
 

package/docs/reference/variables/HealthStatus.md

@@ -0,0 +1,25 @@
+# Variable: HealthStatus
+
+> `const` **HealthStatus**: `object`
+
+The health status of the component.
+
+## Type Declaration
+
+### Ok {#ok}
+
+> `readonly` **Ok**: `"ok"` = `"ok"`
+
+OK.
+
+### Warning {#warning}
+
+> `readonly` **Warning**: `"warning"` = `"warning"`
+
+Warning.
+
+### Error {#error}
+
+> `readonly` **Error**: `"error"` = `"error"`
+
+Error.

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}\"",
@@ -71,7 +69,9 @@
 			"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}\""
+			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\"",
+			"uuidV7": "Property \"{property}\" must be a UUIDv7 formatted string, it is \"{value}\"",
+			"uuidV7Compact": "Property \"{property}\" must be a UUIDv7 formatted string in compact mode, it is \"{value}\""
 		},
 		"objectHelper": {
 			"failedBytesToJSON": "Failed converting bytes to JSON",
@@ -84,10 +84,11 @@
 		},
 		"factory": {
 			"noUnregister": "There is no {typeName} registered with the name \"{name}\"",
-			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
+			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory",
+			"noCreate": "The requested {typeName} \"{name}\" cannot be created by the factory, with params \"{params}\""
 		},
 		"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 +113,8 @@
 		"alreadyExistsError": "Already Exists",
 		"notImplementedError": "Not Implemented",
 		"validationError": "Validation",
-		"unprocessableError": "Unprocessable"
+		"unprocessableError": "Unprocessable",
+		"unauthorizedError": "Unauthorized"
 	},
 	"validation": {
 		"defaultFieldName": "The field"

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.2-next.8",
+	"version": "0.0.2",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/framework.git",
+		"url": "git+https://github.com/iotaledger/framework.git",
 		"directory": "packages/core"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,26 +14,38 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.2-next.8",
-		"intl-messageformat": "10.7.16",
-		"rfc6902": "5.1.2"
+		"@twin.org/nameof": "0.0.2",
+		"intl-messageformat": "11.2.6",
+		"rfc6902": "5.2.0"
 	},
-	"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/iotaledger/framework/issues"
+	},
+	"homepage": "https://twindev.org"
 }