@twin.org/core 0.0.3 → 0.0.4-next.10

package/docs/reference/classes/ValidationError.md

@@ -88,7 +88,7 @@ The cause of the error.
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
-Runtime name for the class.s
+Runtime name for the class.
 
 ## Methods
 

package/docs/reference/index.md

@@ -40,6 +40,7 @@
 - [I18n](classes/I18n.md)
 - [Is](classes/Is.md)
 - [Mutex](classes/Mutex.md)
+- [SharedObjectBuffer](classes/SharedObjectBuffer.md)
 - [SharedStore](classes/SharedStore.md)
 - [Validation](classes/Validation.md)
 
@@ -56,6 +57,8 @@
 - [ILocalesIndex](interfaces/ILocalesIndex.md)
 - [IMutexWorkerMessage](interfaces/IMutexWorkerMessage.md)
 - [IPatchOperation](interfaces/IPatchOperation.md)
+- [ISharedObjectBufferOptions](interfaces/ISharedObjectBufferOptions.md)
+- [ISharedObjectBufferWorkerMessage](interfaces/ISharedObjectBufferWorkerMessage.md)
 - [IUrlParts](interfaces/IUrlParts.md)
 - [IValidationFailure](interfaces/IValidationFailure.md)
 
@@ -65,6 +68,7 @@
 - [CompressionType](type-aliases/CompressionType.md)
 - [HealthStatus](type-aliases/HealthStatus.md)
 - [MutexMessageTypes](type-aliases/MutexMessageTypes.md)
+- [SharedObjectBufferMessageTypes](type-aliases/SharedObjectBufferMessageTypes.md)
 - [ObjectOrArray](type-aliases/ObjectOrArray.md)
 - [SingleOccurrenceArray](type-aliases/SingleOccurrenceArray.md)
 - [SingleOccurrenceArrayDepthHelper](type-aliases/SingleOccurrenceArrayDepthHelper.md)
@@ -76,3 +80,4 @@
 - [CompressionType](variables/CompressionType.md)
 - [HealthStatus](variables/HealthStatus.md)
 - [MutexMessageTypes](variables/MutexMessageTypes.md)
+- [SharedObjectBufferMessageTypes](variables/SharedObjectBufferMessageTypes.md)

package/docs/reference/interfaces/IComponent.md

@@ -80,7 +80,7 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the component has started.
 
 ***
 
@@ -102,7 +102,7 @@ The node logging component type.
 
 `Promise`\<`void`\>
 
-Nothing.
+A promise that resolves when the component has stopped.
 
 ***
 

package/docs/reference/interfaces/ILocale.md

@@ -1,6 +1,6 @@
 # Interface: ILocale
 
-Model for a local.
+Model for a locale.
 
 ## Properties
 

package/docs/reference/interfaces/ISharedObjectBufferOptions.md

@@ -0,0 +1,33 @@
+# Interface: ISharedObjectBufferOptions
+
+Options for configuring buffer capacity when creating a shared object buffer.
+
+## Properties
+
+### initialCapacityBytes? {#initialcapacitybytes}
+
+> `optional` **initialCapacityBytes?**: `number`
+
+Initial payload capacity hint in bytes.
+Only honoured when the buffer does not yet exist; ignored on subsequent writes.
+
+#### Default
+
+```ts
+1 MiB.
+```
+
+***
+
+### maxCapacityBytes? {#maxcapacitybytes}
+
+> `optional` **maxCapacityBytes?**: `number`
+
+Maximum allowed payload capacity in bytes. The buffer will never grow beyond this limit.
+Only honoured when the buffer does not yet exist; ignored on subsequent writes.
+
+#### Default
+
+```ts
+256 MiB.
+```

package/docs/reference/interfaces/ISharedObjectBufferWorkerMessage.md

@@ -0,0 +1,44 @@
+# Interface: ISharedObjectBufferWorkerMessage
+
+Message sent from a worker thread to the main thread to request the SharedArrayBuffer for an object.
+
+## Properties
+
+### type {#type}
+
+> **type**: `"twin:sharedObjectBuffer:getBuffer"`
+
+The message type discriminant.
+
+***
+
+### objectId {#objectid}
+
+> **objectId**: `string`
+
+The object id name that identifies which buffer is being requested.
+
+***
+
+### signal {#signal}
+
+> **signal**: `SharedArrayBuffer`
+
+One-shot SharedArrayBuffer used for the Atomics.wait/notify handshake so the
+worker can block synchronously until the main thread has posted the response.
+
+***
+
+### port {#port}
+
+> **port**: `MessagePort`
+
+MessagePort through which the main thread returns the object buffer.
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: [`ISharedObjectBufferOptions`](ISharedObjectBufferOptions.md)
+
+Options for creating or fetching the buffer.

package/docs/reference/interfaces/IValidationFailure.md

@@ -16,7 +16,7 @@ The property that failed validation.
 
 > **reason**: `string`
 
-The reason the validation failed as an i18 resource error.
+The reason the validation failed as an i18n resource key.
 
 ***
 

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

@@ -0,0 +1,5 @@
+# Type Alias: SharedObjectBufferMessageTypes
+
+> **SharedObjectBufferMessageTypes** = *typeof* [`SharedObjectBufferMessageTypes`](../variables/SharedObjectBufferMessageTypes.md)\[keyof *typeof* [`SharedObjectBufferMessageTypes`](../variables/SharedObjectBufferMessageTypes.md)\]
+
+Union of all SharedObjectBuffer message type strings.

package/docs/reference/variables/SharedObjectBufferMessageTypes.md

@@ -0,0 +1,13 @@
+# Variable: SharedObjectBufferMessageTypes
+
+> `const` **SharedObjectBufferMessageTypes**: `object`
+
+Message type constants for the SharedObjectBuffer worker-to-main-thread protocol.
+
+## Type Declaration
+
+### GetBuffer {#getbuffer}
+
+> `readonly` **GetBuffer**: `"twin:sharedObjectBuffer:getBuffer"` = `"twin:sharedObjectBuffer:getBuffer"`
+
+Worker requests the SharedArrayBuffer for a named object from the main thread.

package/locales/en.json

@@ -55,6 +55,9 @@
 			"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}\"",
+			"dateString": "Property \"{property}\" must be a date-only string in ISO 8601 format, it is \"{value}\"",
+			"dateTimeString": "Property \"{property}\" must be a date-time string in ISO 8601 format, it is \"{value}\"",
+			"timeString": "Property \"{property}\" must be a time string in ISO 8601 format, 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\"",
@@ -67,8 +70,8 @@
 			"arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], 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}\"",
+			"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}\"",
 			"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}\""
@@ -107,6 +110,11 @@
 			"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"
+		},
+		"sharedObjectBuffer": {
+			"notCreated": "The shared buffer for object \"{objectId}\" has not been created",
+			"capacityExceeded": "The payload size of {required} bytes exceeds the maximum capacity of {capacity} bytes for object \"{objectId}\"",
+			"bufferFetchFailed": "Failed to retrieve shared buffer for object \"{objectId}\" from the main thread"
 		}
 	},
 	"errorNames": {

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.3",
+	"version": "0.0.4-next.10",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/iotaledger/framework.git",
+		"url": "git+https://github.com/iotaledger/twin-framework.git",
 		"directory": "packages/core"
 	},
 	"author": "martyn.janes@iota.org",
@@ -14,7 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "^0.0.3",
+		"@twin.org/nameof": "0.0.4-next.10",
 		"intl-messageformat": "11.2.6",
 		"rfc6902": "5.2.0"
 	},
@@ -45,7 +45,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/iotaledger/framework/issues"
+		"url": "git+https://github.com/iotaledger/twin-framework/issues"
 	},
 	"homepage": "https://twindev.org"
 }