@warlock.js/context 5.19.1 → 5.20.0

package/llms.txt

@@ -6,6 +6,6 @@
 
 ## Skills
 
-- [define-context](@warlock.js/context/define-context/SKILL.md): Define a context in @warlock.js/context; use when you need to define context.
-- [orchestrate-contexts](@warlock.js/context/orchestrate-contexts/SKILL.md): Orchestrate contexts — contextManager in @warlock.js/context; use when you need to orchestrate contexts.
+- [define-context](@warlock.js/context/define-context/SKILL.md): (no description)
+- [orchestrate-contexts](@warlock.js/context/orchestrate-contexts/SKILL.md): (no description)
 - [overview](@warlock.js/context/overview/SKILL.md): @warlock.js/context overview for orientation and choosing the focused skill for the task.

package/package.json

@@ -24,7 +24,7 @@
   "engines": {
     "node": ">=18.0.0"
   },
-  "version": "5.19.1",
+  "version": "5.20.0",
   "main": "./cjs/index.cjs",
   "module": "./esm/index.mjs",
   "types": "./esm/index.d.mts",

package/skills/define-context/SKILL.md

@@ -1,160 +1,160 @@
----
-name: define-context
-description: "Define a context in @warlock.js/context; use when you need to define context."
----
-
-# Define a context
-
-`@warlock.js/context` is a tiny wrapper on Node.js's `AsyncLocalStorage`. You extend the abstract `Context<TStore>` class to declare what your context stores, and you get a typed get/set/run API that propagates through every async call inside the scope.
-
-## Install
-
-```bash
-npm install @warlock.js/context
-```
-
-## Shape
-
-```ts
-import { Context } from "@warlock.js/context";
-
-interface UserContextStore {
-  userId: string;
-  role: "admin" | "user";
-  tenantId: string;
-}
-
-class UserContext extends Context<UserContextStore> {
-  /**
-   * Called by `contextManager.buildStores(payload)` for each registered context.
-   * Override to provide initialization logic for this context's store.
-   */
-  public buildStore(payload?: Record<string, any>): UserContextStore {
-    return {
-      userId: payload?.userId ?? "",
-      role: payload?.role ?? "user",
-      tenantId: payload?.tenantId ?? "",
-    };
-  }
-}
-
-export const userContext = new UserContext();
-```
-
-`buildStore` is the **only** abstract method. Everything else is provided by `Context<TStore>`.
-
-## Usage modes
-
-### `run()` — scoped execution
-
-```ts
-await userContext.run(
-  { userId: "123", role: "admin", tenantId: "acme" },
-  async () => {
-    // Context is available throughout this async scope and any awaited calls inside it.
-    const userId = userContext.get("userId");   // "123"
-    const role = userContext.get("role");       // "admin"
-
-    await someAsyncOperation();                  // context propagates through awaits
-  },
-);
-```
-
-Use `run()` when you have a clear scope boundary (a request handler, a job, a CLI command). The context is auto-cleaned when the callback returns.
-
-### `enter()` — middleware-style, no callback
-
-```ts
-function authMiddleware(req, res, next) {
-  userContext.enter({
-    userId: req.user.id,
-    role: req.user.role,
-    tenantId: req.headers["x-tenant-id"],
-  });
-
-  next();   // context lives for the rest of the request
-}
-```
-
-Use `enter()` when the framework doesn't give you a callback to wrap (Express-style middleware). Under the hood it's `AsyncLocalStorage.enterWith(store)`.
-
-### `update()` — merge into the current context
-
-```ts
-userContext.update({ role: "admin" });
-// existing store: { userId, role, tenantId } → { userId, role: "admin", tenantId }
-```
-
-If there's no current store, `update` creates one with the partial (cast to the full type). Use for incremental enrichment as the request flows through layers.
-
-`update()` (and `set()`, which calls it) silently drops `__proto__` / `constructor` / `prototype` keys instead of merging them — merging with `Object.assign` would otherwise let a caller-shaped payload (e.g. `userContext.update(req.body)`) pollute `Object.prototype` for the whole process, since the context store is shared. The rest of the payload still merges normally; this closes only the prototype-pollution vector, not general trust of merged input — validate before you merge caller-supplied data.
-
-## Reading
-
-```ts
-const userId = userContext.get("userId");         // TStore[K] | undefined
-const store = userContext.getStore();              // TStore | undefined
-const inside = userContext.hasContext();           // boolean
-```
-
-`get` is the daily-use accessor. `getStore` returns the whole record. `hasContext` distinguishes "key absent" from "no context at all" (which matters for safety checks at the framework boundary).
-
-## Writing within a context
-
-```ts
-userContext.set("role", "admin");                  // sugar for update({ role: "admin" })
-```
-
-Only call `set` inside an active context. Outside one, it enters a new context with just that key set — usually not what you want.
-
-## Clearing
-
-```ts
-userContext.clear();
-// replaces the current store with an empty object of TStore
-```
-
-Rare in app code. The auto-cleanup at the end of `run()` is the normal path.
-
-## Convenience getters via subclass
-
-Add domain-friendly getters on the subclass when a key is read a lot:
-
-```ts
-class TenantContext extends Context<TenantStore> {
-  public buildStore(payload?: Record<string, any>): TenantStore {
-    return {
-      tenantId: payload?.tenantId ?? "",
-      tenantName: payload?.tenantName ?? "",
-      config: payload?.config ?? {},
-    };
-  }
-
-  public get tenantId() {
-    return this.get("tenantId");
-  }
-
-  public get config() {
-    return this.get("config");
-  }
-}
-```
-
-Now `tenantContext.tenantId` reads better than `tenantContext.get("tenantId")` at the call site.
-
-## What it's NOT for
-
-- **Persistent state across requests.** AsyncLocalStorage is per-call-tree; data dies when the scope ends. Use a cache, a database, or a singleton for cross-request data.
-- **Thread-safe shared mutable state.** Each `run()` gets a fresh store. Two parallel `run()` calls don't see each other's updates.
-- **Sync code that doesn't `await` anything.** Works, but if there's no async boundary the context add-overhead is wasted — just pass the data as a parameter.
-
-## See also
-
-- [`@warlock.js/context/orchestrate-contexts/SKILL.md`](@warlock.js/context/orchestrate-contexts/SKILL.md) — running multiple contexts together via the `contextManager` singleton.
-
-## Things NOT to do
-
-- Don't make every cross-cutting concern a context. Build one when it has its own lifecycle (request, db transaction, trace span). For one-off data, a function argument is clearer.
-- Don't capture the store reference outside the scope — it's freed when `run()` ends. Read the value out before exiting the scope if you need it later.
-- Don't mutate the store object directly without `update`/`set` — works, but obscures intent. The methods exist to make state changes searchable.
-- Don't share one context instance across unrelated concerns. One typed context per domain concept reads better than one fat `globalContext`.
+---
+name: define-context
+description: 'Extend Context<TStore> to define an AsyncLocalStorage-backed typed context — implement buildStore, use run / enter / update / get / set / getStore / clear / hasContext. Triggers: `Context`, `Context<TStore>`, `buildStore`, `run`, `enter`, `update`, `get`, `set`, `getStore`, `clear`, `hasContext`; "share user/tenant/trace id across async calls", "AsyncLocalStorage typed wrapper", "request-scoped store without thread-through"; typical import `import { Context } from "@warlock.js/context"`. Skip: orchestrating multiple contexts — `@warlock.js/context/orchestrate-contexts/SKILL.md`; native `AsyncLocalStorage`, `cls-hooked`, `nest-context`, React Context.'
+---
+
+# Define a context
+
+`@warlock.js/context` is a tiny wrapper on Node.js's `AsyncLocalStorage`. You extend the abstract `Context<TStore>` class to declare what your context stores, and you get a typed get/set/run API that propagates through every async call inside the scope.
+
+## Install
+
+```bash
+npm install @warlock.js/context
+```
+
+## Shape
+
+```ts
+import { Context } from "@warlock.js/context";
+
+interface UserContextStore {
+  userId: string;
+  role: "admin" | "user";
+  tenantId: string;
+}
+
+class UserContext extends Context<UserContextStore> {
+  /**
+   * Called by `contextManager.buildStores(payload)` for each registered context.
+   * Override to provide initialization logic for this context's store.
+   */
+  public buildStore(payload?: Record<string, any>): UserContextStore {
+    return {
+      userId: payload?.userId ?? "",
+      role: payload?.role ?? "user",
+      tenantId: payload?.tenantId ?? "",
+    };
+  }
+}
+
+export const userContext = new UserContext();
+```
+
+`buildStore` is the **only** abstract method. Everything else is provided by `Context<TStore>`.
+
+## Usage modes
+
+### `run()` — scoped execution
+
+```ts
+await userContext.run(
+  { userId: "123", role: "admin", tenantId: "acme" },
+  async () => {
+    // Context is available throughout this async scope and any awaited calls inside it.
+    const userId = userContext.get("userId");   // "123"
+    const role = userContext.get("role");       // "admin"
+
+    await someAsyncOperation();                  // context propagates through awaits
+  },
+);
+```
+
+Use `run()` when you have a clear scope boundary (a request handler, a job, a CLI command). The context is auto-cleaned when the callback returns.
+
+### `enter()` — middleware-style, no callback
+
+```ts
+function authMiddleware(req, res, next) {
+  userContext.enter({
+    userId: req.user.id,
+    role: req.user.role,
+    tenantId: req.headers["x-tenant-id"],
+  });
+
+  next();   // context lives for the rest of the request
+}
+```
+
+Use `enter()` when the framework doesn't give you a callback to wrap (Express-style middleware). Under the hood it's `AsyncLocalStorage.enterWith(store)`.
+
+### `update()` — merge into the current context
+
+```ts
+userContext.update({ role: "admin" });
+// existing store: { userId, role, tenantId } → { userId, role: "admin", tenantId }
+```
+
+If there's no current store, `update` creates one with the partial (cast to the full type). Use for incremental enrichment as the request flows through layers.
+
+`update()` (and `set()`, which calls it) silently drops `__proto__` / `constructor` / `prototype` keys instead of merging them — merging with `Object.assign` would otherwise let a caller-shaped payload (e.g. `userContext.update(req.body)`) pollute `Object.prototype` for the whole process, since the context store is shared. The rest of the payload still merges normally; this closes only the prototype-pollution vector, not general trust of merged input — validate before you merge caller-supplied data.
+
+## Reading
+
+```ts
+const userId = userContext.get("userId");         // TStore[K] | undefined
+const store = userContext.getStore();              // TStore | undefined
+const inside = userContext.hasContext();           // boolean
+```
+
+`get` is the daily-use accessor. `getStore` returns the whole record. `hasContext` distinguishes "key absent" from "no context at all" (which matters for safety checks at the framework boundary).
+
+## Writing within a context
+
+```ts
+userContext.set("role", "admin");                  // sugar for update({ role: "admin" })
+```
+
+Only call `set` inside an active context. Outside one, it enters a new context with just that key set — usually not what you want.
+
+## Clearing
+
+```ts
+userContext.clear();
+// replaces the current store with an empty object of TStore
+```
+
+Rare in app code. The auto-cleanup at the end of `run()` is the normal path.
+
+## Convenience getters via subclass
+
+Add domain-friendly getters on the subclass when a key is read a lot:
+
+```ts
+class TenantContext extends Context<TenantStore> {
+  public buildStore(payload?: Record<string, any>): TenantStore {
+    return {
+      tenantId: payload?.tenantId ?? "",
+      tenantName: payload?.tenantName ?? "",
+      config: payload?.config ?? {},
+    };
+  }
+
+  public get tenantId() {
+    return this.get("tenantId");
+  }
+
+  public get config() {
+    return this.get("config");
+  }
+}
+```
+
+Now `tenantContext.tenantId` reads better than `tenantContext.get("tenantId")` at the call site.
+
+## What it's NOT for
+
+- **Persistent state across requests.** AsyncLocalStorage is per-call-tree; data dies when the scope ends. Use a cache, a database, or a singleton for cross-request data.
+- **Thread-safe shared mutable state.** Each `run()` gets a fresh store. Two parallel `run()` calls don't see each other's updates.
+- **Sync code that doesn't `await` anything.** Works, but if there's no async boundary the context add-overhead is wasted — just pass the data as a parameter.
+
+## See also
+
+- [`@warlock.js/context/orchestrate-contexts/SKILL.md`](@warlock.js/context/orchestrate-contexts/SKILL.md) — running multiple contexts together via the `contextManager` singleton.
+
+## Things NOT to do
+
+- Don't make every cross-cutting concern a context. Build one when it has its own lifecycle (request, db transaction, trace span). For one-off data, a function argument is clearer.
+- Don't capture the store reference outside the scope — it's freed when `run()` ends. Read the value out before exiting the scope if you need it later.
+- Don't mutate the store object directly without `update`/`set` — works, but obscures intent. The methods exist to make state changes searchable.
+- Don't share one context instance across unrelated concerns. One typed context per domain concept reads better than one fat `globalContext`.

package/skills/index.md

@@ -0,0 +1,19 @@
+---
+description: "Typed request-scoped context on Node AsyncLocalStorage, so data (user, tenant, trace id, transaction) flows through awaits without parameter threading. Exports `Context`, `contextManager`, `ContextManager`. Use for: \"share the current user or tenant across async calls\", \"request-scoped storage\", \"AsyncLocalStorage wrapper\", \"run several contexts together\", \"avoid passing data through every function\". Not this package: cross-request state → @warlock.js/cache or a database; HTTP request/response objects → @warlock.js/core."
+---
+# @warlock.js/context
+
+A thin typed wrapper over `AsyncLocalStorage`. Each `Context<TStore>` subclass declares its store shape and how `buildStore` creates it; the store lives for the scope and propagates through every `await` inside. `contextManager` runs several contexts together. Zero dependencies; the framework uses it internally for request, user and tenant.
+
+## The 80% path
+1. Orient with `overview.md`.
+2. Subclass `Context`, implement `buildStore`, read with `get` / `set` anywhere down the call tree: `define-context.md`.
+3. Wrap work with `run(store, callback)`, or `enter(store)` for middleware that cannot wrap a callback: `define-context.md`.
+4. With two or more active contexts, register them on `contextManager` and use `runAll` / `enterAll`: `orchestrate-contexts.md`.
+
+## Conventions and pitfalls
+- Outside a `run`/`enter` scope there is no store; guard with `hasContext` when code may run unscoped.
+- `enter` leaks until cleared; pair `enterAll` with `clearAll` at the end of the request.
+- Worker threads do not share the store; serialize data across and re-enter.
+- Context is not shared state: it vanishes with the scope.
+- One context in a cooperative framework needs no manager; use plain `run`.