@zhin.js/middleware 1.1.10 → 1.1.12

package/lib/definition.d.ts

@@ -2,7 +2,7 @@
  * Middleware authoring API consumed from `zhin.js/middleware`.
  * @module zhin.js/middleware
  */
-import type { AdapterClient, CapabilityContext, RegisteredAdapterName } from '@zhin.js/feature-kit';
+import type { AdapterClient, OperationSession, CapabilityContext, RegisteredAdapterName } from '@zhin.js/feature-kit';
 import type { MiddlewareContinuation } from './continuation.js';
 export type { MiddlewareContinuation } from './continuation.js';
 declare const middlewareBrand: "zhin.middleware/1";
@@ -14,6 +14,7 @@ export interface MiddlewareContext<TInput = unknown, TConfig = unknown, TAdapter
     readonly input: TInput;
     /** Lazily resolved native Client. Without `adapter`, its static type is `unknown`. */
     readonly $client: AdapterClient<TAdapter>;
+    readonly session: OperationSession<TAdapter> | undefined;
 }
 /** Shared metadata for the public inbound and outbound definition contracts. */
 export interface MiddlewareDefinitionBase<TAdapter extends string | undefined = string | undefined> {
@@ -28,6 +29,8 @@ export type MiddlewareDefinition<TInput = unknown, TConfig = unknown, TAdapter e
     handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: MiddlewareNext): unknown;
 } | {
     readonly target: 'outbound';
+    /** Opt in to cumulative prefixes. Previously published text, format and addressing must stay stable. */
+    readonly incremental?: true;
     handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void>;
 });
 declare module '@zhin.js/plugin-runtime' {
@@ -49,6 +52,9 @@ type AuthoringForAdapter<TInput, TConfig, TAdapter extends string | undefined> =
     handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: MiddlewareNext): unknown;
 } | {
     readonly target: 'outbound';
+    /** Opt in to cumulative prefixes. Previously published text, format and addressing must stay stable;
+     * do not repeat approvals, external sends or other side effects. */
+    readonly incremental?: true;
     handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void>;
 });
 /** @internal Shape shared with the typed IM facade; not a separate authoring API. */

package/lib/middleware-index.d.ts

@@ -19,6 +19,7 @@ export interface MiddlewareDescriptor {
     readonly target: MiddlewareTarget;
     readonly order: number;
     readonly adapter?: string;
+    readonly incremental?: true;
 }
 /** @internal Runtime middleware executor. */
 export declare class MiddlewareIndex {

package/lib/middleware-index.js

@@ -1,4 +1,4 @@
-import { createCapabilityContext, bindOperationInput, operationClientAdapter, readOperationClient, } from '@zhin.js/feature-kit';
+import { createCapabilityContext, bindOperationInput, operationClientAdapter, readOperationClient, readOperationSession, } from '@zhin.js/feature-kit';
 import { continuationBrand } from './continuation.js';
 /** @internal Runtime middleware executor. */
 export class MiddlewareIndex {
@@ -16,6 +16,7 @@ export class MiddlewareIndex {
             target: slot.definition.target,
             order: slot.definition.order,
             ...(slot.definition.adapter ? { adapter: slot.definition.adapter } : {}),
+            ...(slot.definition.target === 'outbound' && slot.definition.incremental === true ? { incremental: true } : {}),
             slot,
         })).sort((left, right) => compareMiddleware(left, right, topology)));
     }
@@ -41,9 +42,12 @@ export class MiddlewareIndex {
                 return terminal();
             const authorInput = bindOperationInput(input, record.owner, operationSnapshot);
             const context = {
-                ...createCapabilityContext(operationSnapshot, record.owner),
+                ...createCapabilityContext(operationSnapshot, record.owner, undefined, readOperationSession(authorInput, record.adapter)?.signal),
                 input: authorInput,
             };
+            Object.defineProperty(context, 'session', {
+                enumerable: true, get: () => readOperationSession(authorInput, record.adapter),
+            });
             Object.defineProperty(context, '$client', {
                 enumerable: true,
                 get: () => readOperationClient(authorInput, record.adapter),
@@ -72,8 +76,11 @@ export class MiddlewareIndex {
                 throw new Error('Invalid inbound Middleware');
             const authorInput = bindOperationInput(input, record.owner, operationSnapshot);
             const context = {
-                ...createCapabilityContext(operationSnapshot, record.owner), input: authorInput,
+                ...createCapabilityContext(operationSnapshot, record.owner, undefined, readOperationSession(authorInput, record.adapter)?.signal), input: authorInput,
             };
+            Object.defineProperty(context, 'session', {
+                enumerable: true, get: () => readOperationSession(authorInput, record.adapter),
+            });
             Object.defineProperty(context, '$client', {
                 enumerable: true, get: () => readOperationClient(authorInput, record.adapter),
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zhin.js/middleware",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Convention-based Middleware Feature for Zhin Plugin Runtime",
   "type": "module",
   "main": "./lib/index.js",
@@ -16,8 +16,8 @@
     "src"
   ],
   "dependencies": {
-    "@zhin.js/feature-kit": "1.1.9",
-    "@zhin.js/plugin-runtime": "1.1.17"
+    "@zhin.js/feature-kit": "1.1.11",
+    "@zhin.js/plugin-runtime": "1.1.19"
   },
   "devDependencies": {
     "@types/node": "^26.1.2",

package/src/definition.ts

@@ -4,6 +4,7 @@
  */
 import type {
   AdapterClient,
+  OperationSession,
   CapabilityContext,
   RegisteredAdapterName,
 } from '@zhin.js/feature-kit';
@@ -26,6 +27,7 @@ export interface MiddlewareContext<
   readonly input: TInput;
   /** Lazily resolved native Client. Without `adapter`, its static type is `unknown`. */
   readonly $client: AdapterClient<TAdapter>;
+  readonly session: OperationSession<TAdapter> | undefined;
 }
 
 /** Shared metadata for the public inbound and outbound definition contracts. */
@@ -45,7 +47,10 @@ export type MiddlewareDefinition<
   TAdapter extends string | undefined = string | undefined,
 > = MiddlewareDefinitionBase<TAdapter> & (
   | { readonly target: 'inbound'; handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: MiddlewareNext): unknown }
-  | { readonly target: 'outbound'; handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void> }
+  | { readonly target: 'outbound';
+      /** Opt in to cumulative prefixes. Previously published text, format and addressing must stay stable. */
+      readonly incremental?: true;
+      handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void> }
 );
 
 declare module '@zhin.js/plugin-runtime' {
@@ -69,7 +74,13 @@ type AuthoringForAdapter<TInput, TConfig, TAdapter extends string | undefined> =
     readonly order?: number;
   } & (
     | { readonly target?: 'inbound'; handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: MiddlewareNext): unknown }
-    | { readonly target: 'outbound'; handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void> }
+    | {
+        readonly target: 'outbound';
+        /** Opt in to cumulative prefixes. Previously published text, format and addressing must stay stable;
+         * do not repeat approvals, external sends or other side effects. */
+        readonly incremental?: true;
+        handle(context: MiddlewareContext<TInput, TConfig, TAdapter>, next: OutboundMiddlewareNext): void | Promise<void>;
+      }
   );
 
 /** @internal Shape shared with the typed IM facade; not a separate authoring API. */

package/src/middleware-index.ts

@@ -4,6 +4,7 @@ import {
   bindOperationInput,
   operationClientAdapter,
   readOperationClient,
+  readOperationSession,
 } from '@zhin.js/feature-kit';
 import type {
   MiddlewareContext,
@@ -35,6 +36,7 @@ export interface MiddlewareDescriptor {
   readonly target: MiddlewareTarget;
   readonly order: number;
   readonly adapter?: string;
+  readonly incremental?: true;
 }
 
 interface MiddlewareRecord extends MiddlewareDescriptor {
@@ -59,6 +61,7 @@ export class MiddlewareIndex {
       target: slot.definition.target,
       order: slot.definition.order,
       ...(slot.definition.adapter ? { adapter: slot.definition.adapter } : {}),
+      ...(slot.definition.target === 'outbound' && slot.definition.incremental === true ? { incremental: true as const } : {}),
       slot,
     })).sort((left, right) => compareMiddleware(left, right, topology)));
   }
@@ -93,9 +96,12 @@ export class MiddlewareIndex {
       if (!record) return terminal();
       const authorInput = bindOperationInput(input, record.owner, operationSnapshot);
       const context = {
-        ...createCapabilityContext(operationSnapshot, record.owner),
+        ...createCapabilityContext(operationSnapshot, record.owner, undefined, readOperationSession(authorInput, record.adapter)?.signal),
         input: authorInput,
       } as MiddlewareContext<TInput>;
+      Object.defineProperty(context, 'session', {
+        enumerable: true, get: () => readOperationSession(authorInput, record.adapter),
+      });
       Object.defineProperty(context, '$client', {
         enumerable: true,
         get: () => readOperationClient(authorInput, record.adapter),
@@ -126,8 +132,11 @@ export class MiddlewareIndex {
       if (definition.target !== 'inbound') throw new Error('Invalid inbound Middleware');
       const authorInput = bindOperationInput(input, record.owner, operationSnapshot);
       const context = {
-        ...createCapabilityContext(operationSnapshot, record.owner), input: authorInput,
+        ...createCapabilityContext(operationSnapshot, record.owner, undefined, readOperationSession(authorInput, record.adapter)?.signal), input: authorInput,
       } as MiddlewareContext<TInput>;
+      Object.defineProperty(context, 'session', {
+        enumerable: true, get: () => readOperationSession(authorInput, record.adapter),
+      });
       Object.defineProperty(context, '$client', {
         enumerable: true, get: () => readOperationClient(authorInput, record.adapter),
       });