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

package/docs/reference/classes/Is.md

@@ -32,7 +32,7 @@ The value to test.
 
 `value is undefined`
 
-True if the value is a empty.
+True if the value is undefined.
 
 ***
 
@@ -54,7 +54,7 @@ The value to test.
 
 `value is null`
 
-True if the value is a empty.
+True if the value is null.
 
 ***
 
@@ -76,7 +76,7 @@ The value to test.
 
 value is null \| undefined
 
-True if the value is a empty.
+True if the value is null or undefined.
 
 ***
 
@@ -84,7 +84,7 @@ True if the value is a empty.
 
 > `static` **notEmpty**(`value`): `boolean`
 
-Is the property is not null or undefined.
+Is the property not null or undefined.
 
 #### Parameters
 
@@ -98,7 +98,7 @@ The value to test.
 
 `boolean`
 
-True if the value is a not empty.
+True if the value is not null or undefined.
 
 ***
 
@@ -128,7 +128,7 @@ True if the value is a string.
 
 > `static` **stringValue**(`value`): `value is string`
 
-Is the value a string.
+Is the value a non-empty string.
 
 #### Parameters
 
@@ -142,7 +142,7 @@ The value to test.
 
 `value is string`
 
-True if the value is a string.
+True if the value is a non-empty string.
 
 ***
 
@@ -512,7 +512,7 @@ The value to test.
 
 `value is number`
 
-True if the value is a date.
+True if the value is a timestamp in seconds.
 
 ***
 
@@ -534,7 +534,7 @@ The value to test.
 
 `value is number`
 
-True if the value is a date.
+True if the value is a timestamp in milliseconds.
 
 ***
 
@@ -881,3 +881,25 @@ The format of the UUIDv7 string.
 `value is string`
 
 True if the value is a uuidV7 string.
+
+***
+
+### duration() {#duration}
+
+> `static` **duration**(`value`): value is string \| IDuration
+
+Is the value a valid ISO 8601 duration string or an IDuration object.
+
+#### Parameters
+
+##### value
+
+`unknown`
+
+The value to test.
+
+#### Returns
+
+value is string \| IDuration
+
+True if the value is a valid ISO 8601 duration string or an IDuration object.

package/docs/reference/classes/JsonHelper.md

@@ -105,7 +105,7 @@ The object to patch.
 
 [`IPatchOperation`](../interfaces/IPatchOperation.md)[]
 
-The second object.
+The patch operations to apply.
 
 #### Returns
 

package/docs/reference/classes/Mutex.md

@@ -35,6 +35,44 @@ Runtime name for the class.
 
 ## Methods
 
+### getDefaultTimeoutMs() {#getdefaulttimeoutms}
+
+> `static` **getDefaultTimeoutMs**(): `number`
+
+Gets the default timeout in milliseconds for lock acquisition.
+
+#### Returns
+
+`number`
+
+The default timeout in milliseconds.
+
+***
+
+### setDefaultTimeoutMs() {#setdefaulttimeoutms}
+
+> `static` **setDefaultTimeoutMs**(`timeoutMs`): `void`
+
+Sets the default timeout in milliseconds for lock acquisition.
+
+#### Parameters
+
+##### timeoutMs
+
+`number`
+
+The default timeout in milliseconds.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if timeoutMs is not a non-negative integer.
+
+***
+
 ### lock() {#lock}
 
 > `static` **lock**(`key`, `options?`): `Promise`\<`boolean`\>
@@ -62,7 +100,7 @@ Lock options.
 
 `number`
 
-The maximum time to wait for the lock in milliseconds, default is 5000.
+The maximum time to wait for the lock in milliseconds, defaults to getDefaultTimeoutMs().
 
 ###### throwOnTimeout?
 

package/docs/reference/classes/NotImplementedError.md

@@ -1,6 +1,6 @@
 # Class: NotImplementedError
 
-Class to handle errors.
+Class to handle errors raised when a method has not been implemented.
 
 ## Extends
 

package/docs/reference/classes/ObjectHelper.md

@@ -336,10 +336,14 @@ Pick a subset of properties from an object.
 
 #### Param
 
+**obj**
+
 The object to pick the properties from.
 
 #### Param
 
+**keys**
+
 The property keys to pick.
 
 #### Call Signature
@@ -422,10 +426,14 @@ Omit a subset of properties from an object.
 
 #### Param
 
+**obj**
+
 The object to omit the properties from.
 
 #### Param
 
+**keys**
+
 The property keys to omit.
 
 #### Call Signature
@@ -506,7 +514,7 @@ The object without the omitted keys, or undefined if the input was undefined.
 
 > `static` **toExtended**(`obj`): `any`
 
-Converter the non JSON primitives to extended types.
+Convert the non JSON primitives to extended types.
 
 #### Parameters
 
@@ -528,7 +536,7 @@ The object with extended properties.
 
 > `static` **fromExtended**(`obj`): `any`
 
-Converter the extended types to non JSON primitives.
+Convert the extended types to non JSON primitives.
 
 #### Parameters
 

package/docs/reference/classes/SharedObjectBuffer.md

@@ -0,0 +1,192 @@
+# Class: SharedObjectBuffer
+
+Manages per-object SharedArrayBuffers that store objects as UTF-8 JSON.
+Buffer layout: 4-byte Int32 header (current data byte length) followed by the JSON-encoded object.
+Buffers are explicitly created with create and cached in SharedStore.
+On a worker thread an existing buffer is fetched via a MessagePort handshake
+(same protocol as Mutex) and cached locally.
+Buffers grow automatically when the payload exceeds capacity; when the payload drops well below
+capacity the buffer is replaced with a smaller one. The caller must hold the objectId-keyed Mutex
+around every read and write. The main thread's worker message handler must forward messages to
+both Mutex.handleWorkerMessage and SharedObjectBuffer.handleWorkerMessage.
+
+## Constructors
+
+### Constructor
+
+> **new SharedObjectBuffer**(): `SharedObjectBuffer`
+
+#### Returns
+
+`SharedObjectBuffer`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+***
+
+### DEFAULT\_CAPACITY\_BYTES {#default_capacity_bytes}
+
+> `readonly` `static` **DEFAULT\_CAPACITY\_BYTES**: `number`
+
+Default payload capacity per object (1 MiB). The first caller that creates the buffer
+for an object determines its initial capacity; later callers that pass a different value
+are ignored.
+
+***
+
+### MAX\_CAPACITY\_BYTES {#max_capacity_bytes}
+
+> `readonly` `static` **MAX\_CAPACITY\_BYTES**: `number`
+
+Default upper bound for how large a buffer may grow (256 MiB).
+Override per-object via the maxCapacityBytes option on create.
+
+## Methods
+
+### create() {#create}
+
+> `static` **create**(`objectId`, `options?`): `Promise`\<`void`\>
+
+Create the buffer for the given objectId if it does not already exist.
+Must be called while holding Mutex.lock(objectId).
+
+#### Parameters
+
+##### objectId
+
+`string`
+
+The object id that identifies the buffer.
+
+##### options?
+
+[`ISharedObjectBufferOptions`](../interfaces/ISharedObjectBufferOptions.md)
+
+Optional capacity configuration used when creating the buffer.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### read() {#read}
+
+> `static` **read**\<`T`\>(`objectId`): `Promise`\<`T` \| `undefined`\>
+
+Read and decode the object stored for the given objectId.
+Must be called while holding Mutex.lock(objectId).
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### objectId
+
+`string`
+
+The object id that identifies the buffer.
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+The stored object, or undefined when nothing has been written yet.
+
+***
+
+### write() {#write}
+
+> `static` **write**\<`T`\>(`objectId`, `value`): `Promise`\<`void`\>
+
+Encode and write the object into the buffer for the given objectId.
+The buffer must already exist, usually by calling create first.
+When the encoded payload exceeds the current buffer capacity the buffer is grown
+in-place via SharedArrayBuffer.grow so every thread with a reference sees the
+new size without any pointer swap. When the payload is smaller than
+_SHRINK_THRESHOLD of the current capacity and the capacity exceeds
+DEFAULT_CAPACITY_BYTES, the buffer is replaced with a smaller one on the calling thread.
+Must be called while holding Mutex.lock(objectId).
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### objectId
+
+`string`
+
+The object id that identifies the buffer.
+
+##### value
+
+`T`
+
+The object to persist.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### remove() {#remove}
+
+> `static` **remove**(`objectId`): `void`
+
+Remove the stored object and release the buffer for the given objectId.
+The entry is deleted from the local cache so subsequent reads or writes will
+create or fetch a fresh buffer. Worker threads that have cached the old buffer
+reference continue using it until they restart or re-request via the worker protocol.
+Must be called while holding Mutex.lock(objectId).
+
+#### Parameters
+
+##### objectId
+
+`string`
+
+The object id that identifies the buffer.
+
+#### Returns
+
+`void`
+
+***
+
+### handleWorkerMessage() {#handleworkermessage}
+
+> `static` **handleWorkerMessage**(`msg`): `boolean`
+
+Inspect a message from a worker thread and, if it is a SharedObjectBuffer
+buffer-fetch request, respond to it synchronously.
+Call this from the main thread's worker message handler alongside
+Mutex.handleWorkerMessage.
+
+#### Parameters
+
+##### msg
+
+`unknown`
+
+The raw message received from the worker.
+
+#### Returns
+
+`boolean`
+
+True if the message was a SharedObjectBuffer protocol message, false otherwise.

package/docs/reference/classes/SharedStore.md

@@ -1,7 +1,7 @@
 # Class: SharedStore
 
-Provide a store for shared objects which can be accesses through multiple
-instance loads of a packages.
+Provide a store for shared objects which can be accessed through multiple
+instance loads of a package.
 
 ## Constructors
 

package/docs/reference/classes/StringHelper.md

@@ -297,19 +297,6 @@ The string split into words.
 > `static` **isUtf8**(`data`): `boolean`
 
 Check if a Node.js Buffer or Uint8Array is UTF-8.
-Url https://tools.ietf.org/html/rfc3629
-Source https://github.com/hcodes/isutf8
-UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4.
-UTF8-1    = %x00-7F.
-UTF8-2    = %xC2-DF UTF8-tail.
-UTF8-3    = %xE0 %xA0-BF UTF8-tail.
--           %xE1-EC 2( UTF8-tail ).
--           %xED %x80-9F UTF8-tail.
--           %xEE-EF 2( UTF8-tail ).
-UTF8-4    = %xF0 %x90-BF 2( UTF8-tail ).
--           %xF1-F3 3( UTF8-tail ).
--           %xF4 %x80-8F 2( UTF8-tail ).
-UTF8-tail = %x80-BF.
 
 #### Parameters
 
@@ -324,3 +311,19 @@ The data to check.
 `boolean`
 
 True if the data is utf8.
+
+#### See
+
+ - https://tools.ietf.org/html/rfc3629
+ - https://github.com/hcodes/isutf8
+UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4.
+UTF8-1    = %x00-7F.
+UTF8-2    = %xC2-DF UTF8-tail.
+UTF8-3    = %xE0 %xA0-BF UTF8-tail.
+-           %xE1-EC 2( UTF8-tail ).
+-           %xED %x80-9F UTF8-tail.
+-           %xEE-EF 2( UTF8-tail ).
+UTF8-4    = %xF0 %x90-BF 2( UTF8-tail ).
+-           %xF1-F3 3( UTF8-tail ).
+-           %xF4 %x80-8F 2( UTF8-tail ).
+UTF8-tail = %x80-BF.

package/docs/reference/classes/Url.md

@@ -22,6 +22,10 @@ The url string.
 
 `Url`
 
+#### Throws
+
+GuardError if the url is not valid.
+
 ## Properties
 
 ### CLASS\_NAME {#class_name}

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

@@ -30,6 +30,7 @@
 - [StringHelper](classes/StringHelper.md)
 - [Uint8ArrayHelper](classes/Uint8ArrayHelper.md)
 - [BitString](classes/BitString.md)
+- [Duration](classes/Duration.md)
 - [Url](classes/Url.md)
 - [Urn](classes/Urn.md)
 - [AsyncCache](classes/AsyncCache.md)
@@ -40,12 +41,14 @@
 - [I18n](classes/I18n.md)
 - [Is](classes/Is.md)
 - [Mutex](classes/Mutex.md)
+- [SharedObjectBuffer](classes/SharedObjectBuffer.md)
 - [SharedStore](classes/SharedStore.md)
 - [Validation](classes/Validation.md)
 
 ## Interfaces
 
 - [IComponent](interfaces/IComponent.md)
+- [IDuration](interfaces/IDuration.md)
 - [IError](interfaces/IError.md)
 - [IHealth](interfaces/IHealth.md)
 - [II18nShared](interfaces/II18nShared.md)
@@ -56,6 +59,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 +70,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 +82,5 @@
 - [CompressionType](variables/CompressionType.md)
 - [HealthStatus](variables/HealthStatus.md)
 - [MutexMessageTypes](variables/MutexMessageTypes.md)
+- [SharedObjectBufferMessageTypes](variables/SharedObjectBufferMessageTypes.md)
+- [DURATION\_REG\_EXP](variables/DURATION_REG_EXP.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/IDuration.md

@@ -0,0 +1,83 @@
+# Interface: IDuration
+
+Represents a duration broken down into its component parts.
+
+## Properties
+
+### years {#years}
+
+> **years**: `number`
+
+The number of years.
+
+***
+
+### months {#months}
+
+> **months**: `number`
+
+The number of months.
+
+***
+
+### weeks {#weeks}
+
+> **weeks**: `number`
+
+The number of weeks.
+
+***
+
+### days {#days}
+
+> **days**: `number`
+
+The number of days.
+
+***
+
+### hours {#hours}
+
+> **hours**: `number`
+
+The number of hours.
+
+***
+
+### minutes {#minutes}
+
+> **minutes**: `number`
+
+The number of minutes.
+
+***
+
+### seconds {#seconds}
+
+> **seconds**: `number`
+
+The number of seconds.
+
+***
+
+### milliseconds? {#milliseconds}
+
+> `optional` **milliseconds?**: `number`
+
+The number of milliseconds.
+
+***
+
+### microseconds? {#microseconds}
+
+> `optional` **microseconds?**: `number`
+
+The number of microseconds.
+
+***
+
+### nanoseconds? {#nanoseconds}
+
+> `optional` **nanoseconds?**: `number`
+
+The number of nanoseconds.

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.
+```