@travetto/context 8.0.0-alpha.2 → 8.0.0-alpha.21

package/README.md

@@ -15,7 +15,7 @@ yarn add @travetto/context
 
 This module provides a wrapper around node's [async_hooks](https://nodejs.org/api/async_hooks.html) to maintain context across async calls. This is generally used for retaining contextual user information at various levels of async flow. 
 
-The most common way of utilizing the context, is via the [@WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L9) decorator.  The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L12) member, as it is the source of the contextual information. 
+The most common way of utilizing the context, is via the [@WithAsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/decorator.ts#L9) decorator. The decorator requires the class it's being used in, to have a [AsyncContext](https://github.com/travetto/travetto/tree/main/module/context/src/service.ts#L12) member, as it is the source of the contextual information. 
 
 The decorator will load the context on invocation, and will keep the context active during the entire asynchronous call chain. 
 
@@ -29,7 +29,6 @@ import { Inject } from '@travetto/di';
 const NameSymbol = Symbol();
 
 export class ContextAwareService {
-
   @Inject()
   context: AsyncContext;
 
@@ -54,7 +53,7 @@ export class ContextAwareService {
 ```
 
 ## AsyncContextValue
-Within the framework that is a need to access context values, in a type safe fashion.  Additionally, we have the requirement to keep the data accesses isolated from other operations.  To this end, [AsyncContextValue](https://github.com/travetto/travetto/tree/main/module/context/src/value.ts#L16) was created to support this use case.  This class represents the ability to define a simple read/write contract for a given context field.  It also provides some supplemental functionality, e.g., the ability to suppress errors if a context is not initialized.
+Within the framework that is a need to access context values, in a type safe fashion. Additionally, we have the requirement to keep the data accesses isolated from other operations. To this end, [AsyncContextValue](https://github.com/travetto/travetto/tree/main/module/context/src/value.ts#L16) was created to support this use case. This class represents the ability to define a simple read/write contract for a given context field. It also provides some supplemental functionality, e.g., the ability to suppress errors if a context is not initialized.
 
 **Code: Source for AsyncContextValue**
 ```typescript
@@ -77,7 +76,6 @@ import { type AsyncContext, AsyncContextValue, WithAsyncContext } from '@travett
 import { Inject } from '@travetto/di';
 
 export class ContextValueService {
-
   @Inject()
   context: AsyncContext;
 

package/__index__.ts

@@ -1,3 +1,3 @@
+export * from './src/decorator.ts';
 export * from './src/service.ts';
 export * from './src/value.ts';
-export * from './src/decorator.ts';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/context",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-alpha.21",
   "type": "module",
   "description": "Async-aware state management, maintaining context across asynchronous calls.",
   "keywords": [
@@ -27,10 +27,10 @@
     "directory": "module/context"
   },
   "dependencies": {
-    "@travetto/di": "^8.0.0-alpha.2"
+    "@travetto/di": "^8.0.0-alpha.21"
   },
   "peerDependencies": {
-    "@travetto/test": "^8.0.0-alpha.2"
+    "@travetto/test": "^8.0.0-alpha.22"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/decorator.ts

@@ -21,4 +21,4 @@ export function WithAsyncContext() {
 
     return descriptor;
   };
-}
+}

package/src/service.ts

@@ -1,7 +1,7 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 
 import { Injectable } from '@travetto/di';
-import { RuntimeError, AsyncQueue, castTo } from '@travetto/runtime';
+import { AsyncQueue, castTo, RuntimeError } from '@travetto/runtime';
 
 type Ctx<T = unknown> = Record<string | symbol, T>;
 
@@ -10,7 +10,6 @@ type Ctx<T = unknown> = Record<string | symbol, T>;
  */
 @Injectable()
 export class AsyncContext {
-
   storage = new AsyncLocalStorage<Ctx>();
 
   constructor() {
@@ -79,4 +78,4 @@ export class AsyncContext {
     });
     return out;
   }
-}
+}

package/src/value.ts

@@ -1,34 +1,29 @@
 import type { AsyncLocalStorage } from 'node:async_hooks';
 
-import { RuntimeError, castTo } from '@travetto/runtime';
+import { castTo, RuntimeError } from '@travetto/runtime';
 
 type Payload<T> = Record<string | symbol, T | undefined>;
 type Storage<T = unknown> = AsyncLocalStorage<Payload<T>>;
 type Key = string | symbol;
 type StorageSource = Storage | (() => Storage) | { storage: Storage } | { context: { storage: Storage } };
 
-type ReadWriteConfig = { read?: boolean, write?: boolean };
+type ReadWriteConfig = { read?: boolean; write?: boolean };
 type ContextConfig = { failIfUnbound?: ReadWriteConfig };
 
 /**
  * Async Context Value
  */
 export class AsyncContextValue<T = unknown> {
-
   #source: () => Storage<T>;
   #storage?: Storage<T>;
   #key: Key = Symbol();
   #failIfUnbound: ReadWriteConfig;
 
   constructor(source: StorageSource, config?: ContextConfig) {
-    this.#source = castTo(typeof source === 'function' ?
-      source :
-      ((): Storage => 'getStore' in source ?
-        source :
-        ('storage' in source ?
-          source.storage :
-          source.context.storage
-        ))
+    this.#source = castTo(
+      typeof source === 'function'
+        ? source
+        : (): Storage => ('getStore' in source ? source : 'storage' in source ? source.storage : source.context.storage)
     );
     this.#failIfUnbound = { read: true, write: true, ...config?.failIfUnbound };
   }

package/support/test/context.ts

@@ -1,7 +1,7 @@
 import { DependencyRegistryIndex } from '@travetto/di';
-import { castKey, castTo, type Class } from '@travetto/runtime';
 import { Registry } from '@travetto/registry';
-import { SuiteRegistryIndex, type SuitePhaseHandler } from '@travetto/test';
+import { type Class, castKey, castTo } from '@travetto/runtime';
+import { type SuitePhaseHandler, SuiteRegistryIndex } from '@travetto/test';
 
 import { AsyncContext } from '../../src/service.ts';
 
@@ -19,7 +19,9 @@ class ContextSuiteHandler<T extends object> implements SuitePhaseHandler<T> {
       const methodName = castKey<typeof instance>(test.methodName);
       if (methodName in instance && typeof instance[methodName] === 'function') {
         const og = instance[methodName];
-        const wrapped = function (this: unknown) { return ctx.run(og.bind(this)); };
+        const wrapped = function (this: unknown) {
+          return ctx.run(og.bind(this));
+        };
         Object.defineProperty(wrapped, 'name', { value: test.methodName });
         instance[methodName] = castTo(wrapped);
       }
@@ -37,4 +39,4 @@ export function WithSuiteContext() {
       phaseHandlers: [new ContextSuiteHandler(target)]
     });
   };
-}
+}