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

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,9 +20,9 @@ The reason the validation failed as an i18 resource error.
 
 ***
 
-### properties?
+### properties? {#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/MutexMessageTypes.md

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

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/docs/reference/variables/MutexMessageTypes.md

@@ -0,0 +1,13 @@
+# Variable: MutexMessageTypes
+
+> `const` **MutexMessageTypes**: `object`
+
+Mutex message types.
+
+## Type Declaration
+
+### GetBuffer {#getbuffer}
+
+> `readonly` **GetBuffer**: `"twin:mutex:getBuffer"` = `"twin:mutex:getBuffer"`
+
+Get buffer.

package/locales/en.json

@@ -84,7 +84,8 @@
 		},
 		"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, the index is \"{index}\" and the number of bit is \"{numberBits}\""
@@ -100,6 +101,12 @@
 		},
 		"jsonHelper": {
 			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
+		},
+		"mutex": {
+			"lockNotFound": "The key \"{key}\" has no active lock",
+			"lockAlreadyReleased": "The key \"{key}\" is not currently locked",
+			"lockTimeout": "Failed to acquire lock for key \"{key}\" within the timeout of {timeout} milliseconds",
+			"bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread"
 		}
 	},
 	"errorNames": {

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.3-next.9",
+	"version": "0.0.3",
 	"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,9 +14,9 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.3-next.9",
-		"intl-messageformat": "10.7.18",
-		"rfc6902": "5.1.2"
+		"@twin.org/nameof": "^0.0.3",
+		"intl-messageformat": "11.2.6",
+		"rfc6902": "5.2.0"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
@@ -45,7 +45,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/framework/issues"
+		"url": "git+https://github.com/iotaledger/framework/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/es/models/objectOrArray.js.map

@@ -1 +0,0 @@
-{"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"]}