@techspokes/typescript-wsdl-client 0.15.2 → 0.17.0

package/docs/concepts.md

@@ -34,12 +34,12 @@ interface Price {
 All XSD numeric and date-time types map to `string` by default. This prevents
 precision loss at the cost of convenience.
 
-| XSD Type | Default | Override Options | When to Override |
-|----------|---------|-----------------|-----------------|
-| xs:long | string | number, bigint | Use number if values fit JS range |
-| xs:integer | string | number | Use string for arbitrary-size ints |
-| xs:decimal | string | number | Use string for precise decimals |
-| xs:dateTime | string | Date | Use Date if runtime parsing is okay |
+| XSD Type      | Default  | Override Options   | When to Override                      |
+|---------------|----------|--------------------|---------------------------------------|
+| `xs:long`     | `string` | `number`, `bigint` | Use `number` if values fit JS range   |
+| `xs:integer`  | `string` | `number`           | Use `string` for arbitrary-size ints  |
+| `xs:decimal`  | `string` | `number`           | Use `string` for precise decimals     |
+| `xs:dateTime` | `string` | `Date`             | Use `Date` if runtime parsing is okay |
 
 Override with CLI flags:
 
@@ -47,6 +47,92 @@ Override with CLI flags:
 - `--client-decimal-as`
 - `--client-date-as`
 
+## Simple Type Aliases
+
+Named `xs:simpleType` declarations generate scalar TypeScript aliases. Enumerated restrictions generate string literal unions.
+
+```xml
+<xs:simpleType name="MyEnum">
+  <xs:restriction base="xs:string">
+    <xs:enumeration value="Red"/>
+    <xs:enumeration value="Green"/>
+  </xs:restriction>
+</xs:simpleType>
+```
+
+The generated TypeScript type preserves the enum as a scalar alias:
+
+```typescript
+export type MyEnum = "Red" | "Green";
+```
+
+The generated OpenAPI schema uses the same component name with a scalar enum schema:
+
+```json
+{
+  "MyEnum": {
+    "type": "string",
+    "enum": ["Red", "Green"]
+  }
+}
+```
+
+### Same-Name Global Elements
+
+Some WSDLs declare a named simple type and a global element with the same local name. When the element references that simple type, the generator treats the element as the scalar alias rather than creating a wrapper interface.
+
+```xml
+<xs:simpleType name="MyEnum">
+  <xs:restriction base="xs:string">
+    <xs:enumeration value="Red"/>
+    <xs:enumeration value="Green"/>
+  </xs:restriction>
+</xs:simpleType>
+<xs:element name="MyEnum" nillable="true" type="tns:MyEnum"/>
+```
+
+The generated TypeScript remains a single declaration:
+
+```typescript
+export type MyEnum = "Red" | "Green";
+```
+
+Operation methods that use `tns:MyEnum` as their root element accept and return `MyEnum` directly:
+
+```typescript
+interface EnumServiceOperations {
+  Echo(args: MyEnum): Promise<{ response: MyEnum; headers: unknown }>;
+}
+```
+
+This avoids invalid duplicate declarations such as `type MyEnum` plus `interface MyEnum`. It also keeps OpenAPI request and response schemas pointed at the scalar `MyEnum` component.
+
+The same-name scalar element does not create an object wrapper only to carry element metadata. A root element marked `nillable="true"` still uses the scalar alias as the operation type.
+
+### Different-Name Simple Elements
+
+When a global element has a different name from the named simple type it references, the element remains a wrapper surface type. The simple type alias is still generated separately.
+
+```xml
+<xs:simpleType name="MyEnum">
+  <xs:restriction base="xs:string">
+    <xs:enumeration value="Red"/>
+    <xs:enumeration value="Green"/>
+  </xs:restriction>
+</xs:simpleType>
+<xs:element name="FavoriteColor" type="tns:MyEnum"/>
+```
+
+The generated surface type keeps the element name and stores the scalar value in `$value`:
+
+```typescript
+export type MyEnum = "Red" | "Green";
+
+export interface FavoriteColor {
+  $value?: MyEnum;
+}
+```
+
 ## Deterministic Generation
 
 All output is stable and diff-friendly for CI/CD pipelines.
@@ -69,6 +155,8 @@ automatically placed alongside generated output.
 
 The catalog stores optional human-readable `doc` fields extracted from WSDL/XSD documentation nodes. These fields are additive metadata used by TypeScript, OpenAPI, gateway, and generated-test emitters and do not change runtime behavior.
 
+The catalog may also store optional `diagnostics.notes` entries. These notes record non-error modeling decisions, such as reusing a same-name simple type alias instead of emitting a duplicate wrapper interface. CLI commands print these entries as `Note:` lines during compilation.
+
 The catalog also stores optional `wsdlDocs` metadata for selected WSDL nodes:
 
 - `bindings[]`
@@ -81,11 +169,11 @@ OpenAPI uses operation docs for both `description` and default `summary` values.
 
 ### Catalog Locations by Command
 
-| Command | Location |
-|---------|----------|
-| client | `{client-dir}/catalog.json` |
-| openapi | `{openapi-dir}/catalog.json` |
-| pipeline | First available output directory |
+| Command    | Location                         |
+|------------|----------------------------------|
+| `client`   | `{client-dir}/catalog.json`      |
+| `openapi`  | `{openapi-dir}/catalog.json`     |
+| `pipeline` | First available output directory |
 
 ## Response Envelope
 
@@ -142,6 +230,10 @@ details:
 }
 ```
 
+### Streaming Bypass
+
+Operations opted into streaming with `--stream-config` bypass the success envelope on the `200` response path. The OpenAPI response content is declared as the configured stream media type (default `application/x-ndjson`) and the gateway writes raw NDJSON lines straight to the response body. Error responses (400, 502, and the rest) still use the normal envelope so clients always see structured failures before the first record. See [ADR-002](decisions/002-streamable-responses.md) for the full rationale.
+
 ### Envelope Naming
 
 The base envelope is named `${serviceName}ResponseEnvelope`. Override with
@@ -249,3 +341,50 @@ schemas, and detects circular dependencies.
 
 Disable with `--openapi-validate false` or `validate: false` in the
 programmatic API.
+
+## Streaming vs Buffered Responses
+
+The generator produces two response execution models. Buffered is the default and only path for operations not listed in a stream config. Streaming is opt-in and operation-scoped; it changes the emitted client method signature, the OpenAPI response description, and the Fastify route shape for that operation only.
+
+### Execution Model Contrast
+
+Buffered operations call `node-soap`, wait for the full response to materialize, and return `{ response, headers, responseRaw, requestRaw }`. Streaming operations bypass `node-soap`, POST a hand-built SOAP envelope via `fetch`, and return `StreamOperationResponse<RecordType>` with `records: AsyncIterable<RecordType>`. The SAX parser in `runtime/streamXml.ts` walks the configured `recordPath` and yields each record as its closing tag arrives.
+
+The catalog is the source of truth for stream metadata. Each opted-in operation carries an `OperationStreamMetadata` entry, and downstream emitters (client, OpenAPI, gateway, tests) all read from the catalog. OpenAPI carries a derived view via the `x-wsdl-tsc-stream` extension.
+
+### Terminal-Error Policy
+
+Errors before the first record use the normal gateway error envelope because the response headers and status have not been committed yet. Errors mid-stream truncate the chunked response without a terminating zero-chunk; consumers detect this as an incomplete HTTP response and must treat it as a failure. NDJSON has no native error frame, and emitting a fake one would conflict with the item schema. This behavior is documented for operators in the [Production Guide](production.md#terminal-error-policy).
+
+## Companion Catalogs and Shape Resolution
+
+Some vendor WSDLs split their types across multiple services. The stream wrapper operation lives in one WSDL while the concrete record type lives in a companion WSDL. The stream config's `shapeCatalogs` section names additional WSDL or catalog inputs used only to resolve record shapes.
+
+### How Resolution Works
+
+When an operation names a `shapeCatalog`, the compiler loads the companion catalog once, copies the reachable record-type graph into the current compilation, and fails loudly on structural name collisions. Structurally identical types dedupe silently, so two catalogs that share a common base type do not conflict.
+
+```json
+{
+  "shapeCatalogs": {
+    "main": { "wsdlSource": "https://api.example.com/Main.svc?singleWsdl" }
+  },
+  "operations": {
+    "StreamOp": {
+      "recordType": "ConcreteRecordType",
+      "recordPath": ["StreamOpResponse", "Records", "Record"],
+      "shapeCatalog": "main"
+    }
+  }
+}
+```
+
+### Collision Handling
+
+A structural collision means two types share a name but differ in fields. The build fails with a diagnostic naming both source catalogs. Rename in the companion source or point `recordType` at a distinct subtree. Silent renames are intentionally disallowed because they would produce ambiguous public APIs.
+
+## xs:any Wildcard Retention
+
+XSD wildcards (`<xs:any>`) were silently dropped by earlier compiler versions. Since 0.17.0 the compiler retains them on the compiled type alongside any concrete children. This enables two downstream behaviors: honest stream-candidate detection (a wrapper that contains a wildcard is a likely streaming target) and accurate companion-catalog resolution (the compiler knows which elements are open for record types to slot into).
+
+The retained wildcard is metadata only. It does not emit TypeScript `any` or loosen the generated types; concrete fields remain strictly typed.

package/docs/configuration.md

@@ -65,6 +65,46 @@ Per-operation overrides for method, summary, description, and deprecation.
 }
 ```
 
+## Stream Configuration
+
+The `--stream-config <file>` flag (available on `compile`, `client`, `pipeline`)
+opts selected WSDL operations into streaming. Buffered output is unchanged for
+operations not listed in the file.
+
+```json
+{
+  "shapeCatalogs": {
+    "main": { "wsdlSource": "https://api.example.com/Main.svc?singleWsdl" }
+  },
+  "operations": {
+    "UnitDescriptiveInfoStream": {
+      "format": "ndjson",
+      "mediaType": "application/x-ndjson",
+      "recordType": "UnitDescriptiveContentType",
+      "recordPath": [
+        "UnitDescriptiveInfoStream",
+        "EVRN_UnitDescriptiveInfoRS",
+        "UnitDescriptiveContents",
+        "UnitDescriptiveContent"
+      ],
+      "shapeCatalog": "main"
+    }
+  }
+}
+```
+
+- `recordType` and `recordPath` are required; `format` defaults to `ndjson` and
+  `mediaType` to `application/x-ndjson`.
+- `shapeCatalog` references a `shapeCatalogs` entry and is only needed when
+  the record type lives in a different WSDL than the one driving generation.
+- Shape catalogs accept either `wsdlSource` (fetched and compiled on the fly)
+  or `catalogFile` (path to a pre-compiled `catalog.json`).
+- Structural name collisions across catalogs fail the build; structurally
+  identical types dedupe silently.
+
+See [ADR-002](decisions/002-streamable-responses.md) for rationale and the
+terminal-error policy.
+
 ## Example Files
 
 Example configuration files are available in the `examples/openapi/` directory:

package/docs/decisions/002-streamable-responses.md

@@ -0,0 +1,308 @@
+# ADR 002: Streamable SOAP Responses and JSON Gateway Output
+
+Proposal for opt-in streamable SOAP response support, with Escapia EVRN Content Service as the concrete driver.
+
+See the root [README](../../README.md) for the authoritative documentation index and [Architecture](../architecture.md) for the current generator pipeline.
+
+## Status
+
+Accepted (2026-04-20). Implementation shipped in 0.17.0 across five phases
+(Phase 0 research → Phase 5 integration). See
+`scratches/plans/v017/streamable-responses.plan.yaml` for phase-by-phase
+notes and verification gates.
+
+## Context
+
+The current generator handles WSDL operations as buffered request and response calls. A generated client method awaits the SOAP runtime callback, receives a fully materialized result object, and returns `{ response, headers, responseRaw, requestRaw }`. The generated OpenAPI document describes each operation as `application/json`. The generated Fastify route calls the client method, optionally unwraps array wrapper types, and returns the standard response envelope.
+
+Escapia exposes two related SOAP services:
+
+- `EVRNService` contains the normal operation and type model.
+- `EVRNContentService` contains content-oriented operations that are intended for large responses.
+
+The Escapia content WSDL includes stream-like operations such as `UnitDescriptiveInfoStream` and `UnitCalendarAvailBatch`. Their output wrapper types contain schema and wildcard payload sections instead of clean concrete response members. The practical record shapes come from the main EVRN service WSDL, for example `UnitDescriptiveContentType` and `UnitCalendarAvailType`.
+
+This means the current package has two gaps:
+
+- It does not stream SOAP responses through generated clients or gateways.
+- It does not let users map opaque WSDL response wrappers to concrete JSON record shapes from the same or a companion WSDL.
+
+## Current Architecture Review
+
+The compile stage produces `catalog.json`, which is the only artifact that understands WSDL types, operation input and output elements, attribute metadata, child type metadata, and primitive mapping options.
+
+The client stage generates a `node-soap` wrapper. Every operation is generated as a promise-returning method. The public operations interface mirrors that buffered shape, which is useful for mocks but cannot currently express an `AsyncIterable` or stream response.
+
+The OpenAPI stage generates paths from catalog operations. It assumes every operation has a JSON request body and a JSON response body. Since version 0.7.1, successful responses are always wrapped in the standard envelope schema.
+
+The gateway stage reads the OpenAPI document first and enriches operation metadata from `catalog.json` when the catalog is available. This lets route generation stay OpenAPI-driven, but stream support needs metadata that OpenAPI alone cannot represent.
+
+The app and test generators assume ordinary JSON route responses. Generated tests use mock clients that implement the buffered operations interface.
+
+## Requirements
+
+- Existing buffered generation must remain unchanged unless a user opts in.
+- Stream support must be configurable per operation.
+- Users must be able to map an opaque output wrapper to a concrete record type.
+- Record types must be resolvable from the current catalog or from a companion catalog.
+- Gateway output must be able to emit records before the full SOAP response has arrived.
+- Generated routes must respect Node and Fastify backpressure.
+- OpenAPI output must describe the wire media type without pretending that NDJSON is a single JSON object.
+- Error handling must distinguish errors before the first byte from errors after streaming has started.
+- The feature must be testable with a local chunked SOAP server, not only static XML fixtures.
+
+## Proposed Configuration Model
+
+Add a stream configuration file passed with `--stream-config`. The same option should be available on `compile`, `client`, `openapi`, `gateway`, and `pipeline` so each stage can be run independently.
+
+```json
+{
+  "shapeCatalogs": {
+    "evrn": {
+      "wsdlSource": "https://api.escapia.com/EVRNService.svc?singleWsdl"
+    }
+  },
+  "operations": {
+    "UnitDescriptiveInfoStream": {
+      "mode": "stream",
+      "format": "ndjson",
+      "mediaType": "application/x-ndjson",
+      "recordType": "UnitDescriptiveContentType",
+      "recordPath": [
+        "UnitDescriptiveInfoStream",
+        "EVRN_UnitDescriptiveInfoRS",
+        "UnitDescriptiveContents",
+        "UnitDescriptiveContent"
+      ],
+      "shapeCatalog": "evrn"
+    },
+    "UnitCalendarAvailBatch": {
+      "mode": "stream",
+      "format": "ndjson",
+      "mediaType": "application/x-ndjson",
+      "recordType": "UnitCalendarAvailType",
+      "recordPath": [
+        "EVRN_UnitCalendarAvailBatchRS",
+        "EVRN_UnitCalendarAvailBatchRS",
+        "UnitCalendarAvails",
+        "UnitCalendarAvail"
+      ],
+      "shapeCatalog": "evrn"
+    }
+  }
+}
+```
+
+`shapeCatalogs` names additional WSDL or catalog inputs used only to resolve stream record shapes.
+
+`operations` marks specific WSDL operations as streamed. Operations not listed keep the existing buffered behavior.
+
+`recordPath` is an ordered XML element path from the SOAP body payload to the repeated record element. Duplicate local names must be allowed because Escapia uses nested elements with the same name in at least one response.
+
+`recordType` is the TypeScript and schema model to emit for each streamed record.
+
+`format` should support `ndjson` first. `json-array` can be added later for clients that require a single JSON array response.
+
+## CLI and Programmatic API
+
+The CLI should add `--stream-config <file>` to all generation commands. The pipeline command should pass the parsed and normalized configuration to every stage.
+
+The programmatic API should add optional stream configuration fields to:
+
+```typescript
+export interface PipelineOptions {
+  streamConfigFile?: string;
+  streamConfig?: StreamConfig;
+}
+
+export interface GenerateOpenAPIOptions {
+  streamConfigFile?: string;
+  streamConfig?: StreamConfig;
+}
+
+export interface GenerateGatewayOptions {
+  streamConfigFile?: string;
+  streamConfig?: StreamConfig;
+}
+```
+
+The compiler options should accept normalized stream metadata only when compilation needs to persist it into the catalog.
+
+## Catalog Model
+
+The compiled catalog should carry normalized stream metadata beside operation metadata:
+
+```typescript
+export interface Operation {
+  name: string;
+  inputTypeName?: string;
+  outputTypeName?: string;
+  stream?: OperationStreamMetadata;
+}
+
+export interface OperationStreamMetadata {
+  mode: "stream";
+  format: "ndjson" | "json-array";
+  mediaType: string;
+  recordPath: string[];
+  recordTypeName: string;
+  shapeCatalogName?: string;
+  sourceOutputTypeName?: string;
+}
+```
+
+The compiler should also represent wildcard schema particles explicitly. Today Escapia stream wrappers compile into misleading `xs:schema` properties and drop the wildcard payload. A better model is to retain both the schema marker and a wildcard marker so diagnostics and stream candidate detection are honest.
+
+## Shape Resolution
+
+The first implementation should support companion catalogs in one of two forms:
+
+- A `catalogFile` path for a catalog already produced by `wsdl-tsc compile`.
+- A `wsdlSource` path or URL that the pipeline compiles before normalizing stream metadata.
+
+For generated types, the MVP should copy the reachable record type graph from the companion catalog into the current generated output when there is no name collision. If a collision occurs, generation should fail with a clear diagnostic instead of silently renaming public API types.
+
+A future version can support external type imports from another generated client directory.
+
+## Client Runtime
+
+Generated clients should keep the existing buffered method signatures for ordinary operations.
+
+Stream operations should return a separate response type:
+
+```typescript
+export type StreamOperationResponse<RecordType, HeadersType = Record<string, unknown>> = {
+  records: AsyncIterable<RecordType>;
+  headers: HeadersType;
+  requestRaw?: string;
+};
+```
+
+The operations interface should use the same stream response type so generated gateway tests and user mocks can implement streaming behavior without importing the concrete SOAP client.
+
+The transport layer should be proven by a chunked integration test. If `node-soap` with stream or SAX options can deliver records incrementally, it can be used for the MVP. If it buffers before yielding, the feature must use a dedicated SOAP HTTP transport for stream operations before release.
+
+> **Phase 0 research outcome (2026-04-20):** `node-soap` **buffers** the full response before invoking the operation callback. Measured with `test/research/node-soap-streaming.test.ts` against a chunked HTTP fixture: first chunk flushed at ~48 ms, server closed at ~701 ms, node-soap callback fired at ~659 ms (~40 ms before close — that is parse time, not streaming). Generated stream operations therefore use a dedicated streaming HTTP transport emitted into the client runtime; `node-soap` remains the transport for buffered operations only. SAX streaming was validated with `saxes` 6.0.0; `test/research/sax-record-path.test.ts` chunk-fuzzes the Escapia-shaped XML (duplicate `EVRN_UnitDescriptiveInfoRS` wrappers) across every single-byte split and every byte-pair split and produces identical records each time. See `scratches/plans/v017/streamable-responses.plan.yaml` for the full findings.
+
+## XML to JSON Streaming Conversion
+
+The runtime needs a streaming XML parser. `fast-xml-parser` is suitable for buffered documents but not for this use case. A SAX-style parser should track the configured `recordPath`, build a record object as the target element closes, and yield each record immediately.
+
+The converter must reuse catalog metadata for:
+
+- XML attributes and the configured attributes key
+- Child element type lookup
+- Repeated elements
+- Nillable elements
+- Text content and `$value`
+- Primitive mapping
+
+The converter should collect SOAP faults, response errors, and warnings when they appear before the first record. After streaming starts, terminal errors cannot be represented as a normal JSON error envelope for NDJSON. The runtime should either emit a final error record with a documented extension shape or abort the stream and log the classified error.
+
+## OpenAPI Output
+
+Stream operations should not use the standard success envelope for `200` responses. The response content should use the configured stream media type.
+
+```json
+{
+  "description": "Successful streamed SOAP operation response",
+  "content": {
+    "application/x-ndjson": {
+      "schema": { "type": "string" },
+      "x-wsdl-tsc-stream": {
+        "format": "ndjson",
+        "itemSchema": {
+          "$ref": "#/components/schemas/UnitDescriptiveContentType"
+        }
+      }
+    }
+  }
+}
+```
+
+OpenAPI 3.1 cannot fully describe an NDJSON sequence as a standard JSON Schema document. The `x-wsdl-tsc-stream` extension makes the item schema explicit for generated gateways, documentation tools, and future SDK generators.
+
+## Gateway Output
+
+Generated stream routes should call the stream operation and send a Node stream through Fastify.
+
+```typescript
+import { Readable } from "node:stream";
+
+handler: async (request, reply) => {
+  const client = fastify.escapiaContentClient;
+  const result = await client.UnitDescriptiveInfoStream(request.body);
+
+  reply.type("application/x-ndjson");
+  return reply.send(Readable.from(toNdjson(result.records)));
+}
+```
+
+The generated operation schema should keep request validation but omit the Fastify response serialization schema for streamed `200` responses. Fastify cannot serialize an unbounded stream with a normal JSON response schema.
+
+The gateway runtime should add `toNdjson()` and, later, `toJsonArrayStream()` helpers. These helpers should be deterministic, backpressure-aware, and safe for large payloads.
+
+## Test Strategy
+
+Add unit tests for stream config parsing, operation matching, catalog normalization, wildcard compiler metadata, and record path matching.
+
+Add converter tests that split XML chunks across element boundaries to prove the parser does not rely on convenient chunking.
+
+Add a local Escapia-like WSDL fixture with `xs:any` output wrappers and a companion WSDL fixture with the concrete record types.
+
+Add an integration test with a fake SOAP HTTP server that writes one record, waits, writes another record, and then closes the envelope. The test should assert that the gateway emits the first NDJSON line before the upstream response completes.
+
+Add snapshot tests for generated `client.ts`, `operations.ts`, OpenAPI output, gateway route files, and gateway runtime helpers.
+
+Run `npm run smoke:pipeline` after implementation to verify ordinary buffered generation is unchanged.
+
+## Implementation Plan
+
+1. Define `StreamConfig`, parser, validation errors, and normalized operation metadata.
+2. Add `--stream-config` to the CLI and thread it through the programmatic API.
+3. Update the compiler to preserve wildcard particles and emit stream candidate diagnostics.
+4. Implement companion catalog loading and record type graph copying.
+5. Generate stream method signatures in `client.ts` and `operations.ts`.
+6. Add a streaming XML converter with catalog-aware JSON shape conversion.
+7. Generate OpenAPI stream responses with `x-wsdl-tsc-stream` metadata.
+8. Generate Fastify streaming handlers and runtime helpers.
+9. Add unit, snapshot, and chunked integration tests.
+10. Update README, CLI reference, configuration docs, gateway guide, testing guide, and supported patterns.
+
+## Acceptance Criteria
+
+- Existing generated output is unchanged when no stream config is provided.
+- A stream-configured Escapia content WSDL generates typed stream client methods.
+- The generated gateway emits `application/x-ndjson` records incrementally.
+- The generated OpenAPI document identifies stream operations and record schemas.
+- The converter maps XML attributes, arrays, text values, and nillable values consistently with buffered responses.
+- The chunked integration test proves the first record is sent before the full SOAP response is available.
+- Stream route errors before the first byte use the normal gateway error envelope.
+- Stream route errors after the first byte follow a documented terminal error policy.
+
+## Consequences
+
+The generator gains a second response execution model. This increases complexity in the client, OpenAPI, gateway, and test generators, but keeps the complexity opt-in and operation-scoped.
+
+The catalog becomes more important as the shared source of truth because OpenAPI alone cannot carry enough stream conversion metadata.
+
+NDJSON becomes the recommended stream format because it is simple, broadly consumable, and does not require buffering a complete JSON array before sending data.
+
+Companion catalogs are required for vendors that split stream wrappers and concrete record shapes across separate WSDLs.
+
+## Implementation Notes
+
+Captured after the 0.17.0 ship for future maintainers:
+
+- `--stream-config` is wired onto the `compile`, `client`, and `pipeline` CLI commands. It is intentionally not accepted on `openapi`, `gateway`, or `app` because those commands consume a pre-compiled `catalog.json` that already carries the normalized `OperationStreamMetadata`. The original proposal text that listed the flag on every command reflected the design intent; the shipped surface is narrower for that reason.
+- `GenerateOpenAPIOptions` and `GenerateGatewayOptions` in the programmatic API do not carry stream-config fields for the same reason. `compileWsdlToProject` and `runGenerationPipeline` (PipelineOptions) do.
+- The client stream transport is emitted from two templates (`clientStreamMethods.tpl.txt`, `operationsStreamHelper.tpl.txt`). They embed the `StreamOperationResponse<T>` type and a `callStream()` method that POSTs a hand-built SOAP envelope via global `fetch`, bypassing `node-soap` as required by the phase-0 finding.
+- `saxes ^6.0.0` was promoted from devDependency to runtime dependency on the package, and added as a pinned dependency in the generated app scaffold so stream-enabled consumers install it automatically.
+- The `json-array` format is reserved in the config parser but not yet implemented by the emitters. Entries using `format: "json-array"` parse successfully and can be used to forward-declare intent; they do not currently generate routes or client methods.
+
+## References
+
+- Escapia EVRN API documentation: <https://eweb.escapia.com/distribution/api/evrn-api-documentation>
+- Escapia EVRN service WSDL: <https://api.escapia.com/EVRNService.svc?WSDL>
+- Escapia EVRN content service WSDL: <https://api.escapia.com/EVRNContentService.svc?WSDL>
+- Escapia batch API support article: <https://support.escapia.com/articles/en_US/Article/HASW-Batch-API-Methods-EVRN?category=Website_Services>

package/docs/gateway-guide.md

@@ -81,6 +81,43 @@ export async function registerRoute_v1_weather_getcityforecastbyzip(fastify: Fas
 }
 ```
 
+### Streaming Handlers
+
+Operations opted in via `--stream-config` emit an NDJSON response pipe
+instead of the standard envelope. The generated handler streams records as
+they arrive, and the Fastify response is flushed line-by-line with
+backpressure (ADR-002).
+
+```typescript
+import type { FastifyInstance } from "fastify";
+import type { GetWeatherInformation } from "../../client/types.js";
+import schema from "../schemas/operations/getweatherinformation.json" with { type: "json" };
+import { toNdjson } from "../runtime.js";
+
+// Response schema omitted: stream operations emit NDJSON, not a single JSON object
+const { response: _response, ...routeSchema } = schema as Record<string, unknown>;
+
+export async function registerRoute_v1_weather_getweatherinformation(fastify: FastifyInstance) {
+  fastify.route<{ Body: GetWeatherInformation }>({
+    method: "POST",
+    url: "/get-weather-information",
+    schema: routeSchema,
+    handler: async (request, reply) => {
+      const client = fastify.weatherClient;
+      const result = await client.GetWeatherInformation(request.body as GetWeatherInformation);
+      reply.type("application/x-ndjson");
+      return reply.send(toNdjson(result.records));
+    },
+  });
+}
+```
+
+The client method returns `StreamOperationResponse<RecordType>` with a
+`records: AsyncIterable<RecordType>`. Errors raised before the first record
+use the normal error envelope; errors raised mid-stream trip the chunked
+response's truncation — consumers detect these via the absence of a clean
+terminating zero-chunk.
+
 ## Error Handling
 
 The centralized error handler (runtime.ts) automatically classifies errors:

package/docs/generated-code.md

@@ -36,6 +36,23 @@ const info = await client.GetWeatherInformation({});
 console.log(info.GetWeatherInformationResult.WeatherDescriptions);
 ```
 
+## Calling Stream Operations
+
+Operations opted into streaming with `--stream-config` return `StreamOperationResponse<RecordType>` instead of the buffered shape. `records` is a single-pass `AsyncIterable<RecordType>` that pulls bytes from the upstream SOAP response on demand, so memory stays bounded regardless of payload size.
+
+```typescript
+const result = await client.UnitDescriptiveInfoStream({});
+for await (const record of result.records) {
+  console.log(record);
+}
+```
+
+Because `records` is single-pass, each response can be iterated once. Headers captured before the first record are available on `result.headers`, and the serialized SOAP envelope that was sent upstream is on `result.requestRaw` when populated.
+
+Streaming requires the `saxes` runtime dependency. The generated app scaffold pins `saxes ^6.0.0` automatically; consumers that integrate the generated client into their own project must install it explicitly.
+
+See [Stream Configuration](configuration.md#stream-configuration) for how to opt specific operations in, and [ADR-002](decisions/002-streamable-responses.md) for the rationale and terminal-error policy.
+
 ## Attributes and Text Content
 
 When an element has both attributes and text content, use the $value convention:
@@ -134,6 +151,8 @@ Key features of the generated handlers:
 - Envelope wrapping: `buildSuccessEnvelope()` wraps the raw SOAP response in the standard `{ status, message, data, error }` envelope
 - Route file header comments include propagated operation summary and description when present
 
+Stream-configured operations generate a different handler shape: the response serialization schema is omitted, `reply.type("application/x-ndjson")` is set, and `reply.send(toNdjson(result.records))` streams records with backpressure. See the [Gateway Guide Streaming Handlers section](gateway-guide.md#streaming-handlers) for the full example and terminal-error policy.
+
 See [Gateway Guide](gateway-guide.md) for the full architecture and [CLI Reference](cli-reference.md) for generation flags.
 
 ## Operations Interface
@@ -158,4 +177,6 @@ The gateway plugin accepts any `WeatherOperations` implementation, so you can pa
 app.register(weatherGateway, { client: mock });
 ```
 
+For stream operations, mock implementations return an async-iterable `records` field. See the [Testing Guide](testing.md) for the full pattern with async generators.
+
 See [Testing Guide](testing.md) for full integration test patterns.