@twin.org/context 0.0.3-next.22 → 0.0.3-next.23

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Framework Context
 
-This package contains helper methods and classes for using contexts.
+This package is part of the framework workspace and provides helper methods/classes for context handling to support consistent development workflows across the ecosystem.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [0.0.3-next.23](https://github.com/twinfoundation/framework/compare/context-v0.0.3-next.22...context-v0.0.3-next.23) (2026-03-17)
+
+
+### Miscellaneous Chores
+
+* **context:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/core bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof bumped from 0.0.3-next.22 to 0.0.3-next.23
+  * devDependencies
+    * @twin.org/nameof-transformer bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.22 to 0.0.3-next.23
+    * @twin.org/validate-locales bumped from 0.0.3-next.22 to 0.0.3-next.23
+
 ## [0.0.3-next.22](https://github.com/twinfoundation/framework/compare/context-v0.0.3-next.21...context-v0.0.3-next.22) (2026-02-26)
 
 
@@ -433,4 +452,4 @@
     * @twin.org/nameof-vitest-plugin bumped from 0.0.3-next.0 to 0.0.3-next.1
     * @twin.org/validate-locales bumped from 0.0.3-next.0 to 0.0.3-next.1
 
-## @twin.org/context - Changelog
+## Changelog

package/docs/examples.md

@@ -1 +1,57 @@
-# @twin.org/context - Examples
+# Context Examples
+
+Use these snippets to keep trace identifiers consistent across asynchronous operations and service boundaries.
+
+## ContextIdHelper
+
+```typescript
+import { ContextIdHelper } from '@twin.org/context';
+
+const traceContext = {
+  traceId: 'trc-0011223344556677',
+  spanId: 'spn-9a8b7c6d5e4f3210'
+};
+
+ContextIdHelper.short(traceContext.traceId); // '0011223344556677'
+ContextIdHelper.shortAll(traceContext); // { traceId: '0011223344556677', spanId: '9a8b7c6d5e4f3210' }
+```
+
+```typescript
+import { ContextIdHelper } from '@twin.org/context';
+
+const contextIds = {
+  traceId: 'trace-1234',
+  spanId: 'span-5678',
+  requestId: 'req-90ab'
+};
+
+const combined = ContextIdHelper.shortCombined(contextIds); // '1234:5678:90ab'
+ContextIdHelper.shortSplit(combined); // ['1234', '5678', '90ab']
+```
+
+## ContextIdStore
+
+```typescript
+import { ContextIdStore } from '@twin.org/context';
+
+await ContextIdStore.run({ traceId: 'trc-01', spanId: 'spn-02' }, async () => {
+  ContextIdStore.getContextIds(); // { traceId: 'trc-01', spanId: 'spn-02' }
+});
+```
+
+## ContextIdHandlerFactory
+
+```typescript
+import { ContextIdHandlerFactory } from '@twin.org/context';
+import type { IContextIdHandler } from '@twin.org/context';
+
+class RequestContextHandler implements IContextIdHandler {
+  public getContextIds() {
+    return { traceId: 'trc-1001', spanId: 'spn-2002' };
+  }
+}
+
+ContextIdHandlerFactory.register('request', () => new RequestContextHandler());
+const handler = ContextIdHandlerFactory.create('request');
+handler.getContextIds().traceId; // 'trc-1001'
+```

package/docs/reference/classes/ContextIdHelper.md

@@ -14,7 +14,7 @@ Class to help with context IDs.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### guard()
+### guard() {#guard}
 
 > `static` **guard**\<`T`, `K`\>(`contextIds`, `key`): `asserts contextIds is T & { [P in string]: string }`
 
@@ -62,7 +62,7 @@ Guard error if the value is invalid.
 
 ***
 
-### short()
+### short() {#short}
 
 > `static` **short**(`contextIds`, `key`): `string`
 
@@ -94,7 +94,7 @@ Guard error if the value is invalid.
 
 ***
 
-### guardAll()
+### guardAll() {#guardall}
 
 > `static` **guardAll**\<`T`, `K`\>(`contextIds`, `keys`): `asserts contextIds is T & { [P in string]: string }`
 
@@ -134,7 +134,7 @@ Guard error if the value is invalid.
 
 ***
 
-### shortAll()
+### shortAll() {#shortall}
 
 > `static` **shortAll**(`contextIds`, `keys`): [`IContextIds`](../interfaces/IContextIds.md)
 
@@ -162,9 +162,9 @@ The short versions of the context IDs.
 
 ***
 
-### shortCombined()
+### shortCombined() {#shortcombined}
 
-> `static` **shortCombined**(`contextIds`, `keys`, `separator`): `string` \| `undefined`
+> `static` **shortCombined**(`contextIds`, `keys`, `separator?`): `string` \| `undefined`
 
 Gets the combined short version.
 
@@ -182,7 +182,7 @@ The context ID keys to get the short versions for.
 
 `string`[] | `undefined`
 
-##### separator
+##### separator?
 
 `string` = `"/"`
 
@@ -196,9 +196,9 @@ The short version combined.
 
 ***
 
-### shortSplit()
+### shortSplit() {#shortsplit}
 
-> `static` **shortSplit**(`keys`, `combined`, `separator`): [`IContextIds`](../interfaces/IContextIds.md)
+> `static` **shortSplit**(`keys`, `combined`, `separator?`): [`IContextIds`](../interfaces/IContextIds.md)
 
 Split a combined short version in to the separate context IDs.
 
@@ -216,7 +216,7 @@ The context ID keys to get the short versions for.
 
 The combined short version to separate.
 
-##### separator
+##### separator?
 
 `string` = `"/"`
 
@@ -234,9 +234,9 @@ GeneralError if the number of parts does not match the number of keys.
 
 ***
 
-### combinedContextKey()
+### combinedContextKey() {#combinedcontextkey}
 
-> `static` **combinedContextKey**(`contextIds`, `keys`, `separator`): `string` \| `undefined`
+> `static` **combinedContextKey**(`contextIds`, `keys`, `separator?`): `string` \| `undefined`
 
 Create a combined key.
 
@@ -254,7 +254,7 @@ The context ID keys to get the short versions for.
 
 `string`[] | `undefined`
 
-##### separator
+##### separator?
 
 `string` = `"/"`
 
@@ -268,7 +268,7 @@ The short version combined.
 
 ***
 
-### pickKeysFromAvailable()
+### pickKeysFromAvailable() {#pickkeysfromavailable}
 
 > `static` **pickKeysFromAvailable**(`availableKeys?`, `desiredKeys?`): `string`[]
 

package/docs/reference/classes/ContextIdStore.md

@@ -14,7 +14,7 @@ Class to maintain context ids and execute an async method.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### run()
+### run() {#run}
 
 > `static` **run**\<`T`\>(`contextIds`, `asyncMethod`): `Promise`\<`T`\>
 
@@ -56,7 +56,7 @@ Nothing.
 
 ***
 
-### getContextIds()
+### getContextIds() {#getcontextids}
 
 > `static` **getContextIds**(): `Promise`\<[`IContextIds`](../interfaces/IContextIds.md) \| `undefined`\>
 
@@ -70,7 +70,7 @@ The context IDs.
 
 ***
 
-### getStorage()
+### getStorage() {#getstorage}
 
 > `static` **getStorage**(): `Promise`\<`AsyncLocalStorage`\<[`IContextIds`](../interfaces/IContextIds.md)\>\>
 

package/docs/reference/interfaces/IContextIdHandler.md

@@ -8,7 +8,7 @@ Interface describing a context ID handler.
 
 ## Methods
 
-### short()?
+### short()? {#short}
 
 > `optional` **short**(`value`): `string`
 
@@ -30,7 +30,7 @@ The short form version of the context ID.
 
 ***
 
-### guard()?
+### guard()? {#guard}
 
 > `optional` **guard**(`value`): `void`
 
@@ -51,3 +51,99 @@ The context ID value to guard.
 #### Throws
 
 Guard error if the value is invalid.
+
+***
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Inherited from
+
+`IComponent.className`
+
+***
+
+### bootstrap()? {#bootstrap}
+
+> `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Inherited from
+
+`IComponent.bootstrap`
+
+***
+
+### start()? {#start}
+
+> `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.start`
+
+***
+
+### stop()? {#stop}
+
+> `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.stop`

package/docs/reference/variables/ContextIdKeys.md

@@ -6,25 +6,25 @@ Default definition of some context keys.
 
 ## Type Declaration
 
-### Node
+### Node {#node}
 
 > `readonly` **Node**: `"node"` = `"node"`
 
 Standard property type definition for node.
 
-### Tenant
+### Tenant {#tenant}
 
 > `readonly` **Tenant**: `"tenant"` = `"tenant"`
 
 Standard property type definition for tenant.
 
-### Organization
+### Organization {#organization}
 
 > `readonly` **Organization**: `"organization"` = `"organization"`
 
 Standard property type definition for organization.
 
-### User
+### User {#user}
 
 > `readonly` **User**: `"user"` = `"user"`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/context",
-	"version": "0.0.3-next.22",
+	"version": "0.0.3-next.23",
 	"description": "Helper methods/classes for context handling",
 	"repository": {
 		"type": "git",
@@ -14,8 +14,8 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "0.0.3-next.22",
-		"@twin.org/nameof": "0.0.3-next.22"
+		"@twin.org/core": "0.0.3-next.23",
+		"@twin.org/nameof": "0.0.3-next.23"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",