@twin.org/core 0.0.4-next.8 → 0.9.0-next.1

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/CoerceType.md

@@ -65,3 +65,9 @@ Object.
 > `readonly` **Uint8Array**: `"uint8array"` = `"uint8array"`
 
 Uint8Array.
+
+### Duration {#duration}
+
+> `readonly` **Duration**: `"duration"` = `"duration"`
+
+Duration in seconds.

package/docs/reference/variables/DURATION_REG_EXP.md

@@ -0,0 +1,3 @@
+# Variable: DURATION\_REG\_EXP
+
+> `const` **DURATION\_REG\_EXP**: `RegExp`

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

@@ -74,7 +74,8 @@
 			"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}\""
+			"uuidV7Compact": "Property \"{property}\" must be a UUIDv7 formatted string in compact mode, it is \"{value}\"",
+			"duration": "Property \"{property}\" must be an ISO 8601 duration string, it is \"{value}\""
 		},
 		"objectHelper": {
 			"failedBytesToJSON": "Failed converting bytes to JSON",
@@ -109,7 +110,13 @@
 			"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"
+			"bufferFetchFailed": "Failed to retrieve shared buffer for key \"{key}\" from the main thread",
+			"invalidTimeout": "The timeout value \"{timeoutMs}\" is invalid, it must be a non-negative integer"
+		},
+		"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,6 +1,6 @@
 {
 	"name": "@twin.org/core",
-	"version": "0.0.4-next.8",
+	"version": "0.9.0-next.1",
 	"description": "Helper methods/classes for data type checking/validation/guarding/error handling",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/nameof": "0.0.4-next.8",
-		"intl-messageformat": "11.2.6",
+		"@twin.org/nameof": "0.9.0-next.1",
+		"intl-messageformat": "11.2.8",
 		"rfc6902": "5.2.0"
 	},
 	"main": "./dist/es/index.js",