@techspokes/typescript-wsdl-client 0.31.0 → 0.32.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,33 @@
1
+ # TypeScript WSDL Client v0.32.0
2
+
3
+ ## Gateway Conformance Evidence
4
+
5
+ This release extends the WSDL capability conformance framework through generated Fastify gateway artifacts and runtime request checks for the current supported and partial capability rows.
6
+
7
+ ## What This Improves
8
+
9
+ Maintainers can now verify that documented WSDL support survives the full downstream path from fixture compilation to generated client code, OpenAPI output, generated gateway code, and Fastify request handling. This makes the public support matrix more trustworthy before the project moves into the remaining generated-test and app evidence needed for 1.0.
10
+
11
+ Conformance mini-projects now run under `tmp/conformance/` inside the repository, which keeps TypeScript and Node module resolution aligned with a consumer-style project while avoiding machine-specific temporary-directory behavior.
12
+
13
+ ## Highlights
14
+
15
+ - Adds generated gateway type-check evidence for supported and partial WSDL conformance rows.
16
+ - Adds Fastify runtime injection checks for generated gateway routes.
17
+ - Documents `tmp/conformance/` as the architecture boundary for generated conformance projects.
18
+ - Updates the roadmap so the next 1.0 slice is generated-test and app conformance evidence.
19
+
20
+ ## Upgrade Notes
21
+
22
+ No special upgrade steps.
23
+
24
+ ## Validation
25
+
26
+ - CI passed.
27
+ - NPM package contents were validated.
28
+ - Agent skill artifact was validated and packaged.
29
+ - Release preflight passed against the target tag.
30
+
31
+ ## Notes
32
+
33
+ Release tag: `v0.32.0`.
@@ -18,8 +18,8 @@ The plan is optimized for preserving quality. The contract and compatibility bas
18
18
  | OpenAPI compatibility | [OpenAPI Fastify Compatibility](v1.0-openapi-fastify-compatibility.md) | baseline complete | Schema strategy is proven |
19
19
  | Choice union mode | [Choice Union Mode](v1.0-choice-union-mode.md) | complete | Implemented in `0.26.0` |
20
20
  | JSON array streaming | [JSON Array Streaming](v1.0-json-array-streaming.md) | complete | Implemented in `0.28.0` |
21
- | Conformance framework | [Capability Conformance Framework](v1.0-capability-conformance-framework.md) | phase 2 shipped | Pipeline claims are test-backed |
22
- | WSDL coverage matrix | [WSDL Coverage Matrix](v1.0-wsdl-coverage-matrix.md) | client and OpenAPI evidence shipped | Feature support is test-backed |
21
+ | Conformance framework | [Capability Conformance Framework](v1.0-capability-conformance-framework.md) | phase 3 shipped | Pipeline claims are test-backed |
22
+ | WSDL coverage matrix | [WSDL Coverage Matrix](v1.0-wsdl-coverage-matrix.md) | gateway evidence shipped | Feature support is test-backed |
23
23
  | Release candidate | [Release Candidate Gates](v1.0-release-candidate-gates.md) | remaining | 1.0 release is repeatable |
24
24
 
25
25
  ## Execution Order
@@ -42,11 +42,11 @@ JSON array streaming is complete in `0.28.0`. The default `ndjson` format remain
42
42
 
43
43
  ### Slice 5: Capability Conformance Framework
44
44
 
45
- The registry, fixture strategy, compile runner, client evidence, OpenAPI evidence, documentation drift check, and generated support matrix are shipped. The next work is to extend relevant rows into gateway runtime evidence without expanding public APIs.
45
+ The registry, fixture strategy, compile runner, client evidence, OpenAPI evidence, gateway runtime evidence, documentation drift check, and generated support matrix are shipped. The next work is to extend relevant rows into generated-test and app evidence without expanding public APIs.
46
46
 
47
47
  ### Slice 6: WSDL Coverage Matrix
48
48
 
49
- The first WSDL matrix rows now exist as conformance registry entries with compile, client, OpenAPI, and documentation evidence. The next work is to prove relevant rows through generated gateway runtime artifacts.
49
+ The first WSDL matrix rows now exist as conformance registry entries with compile, client, OpenAPI, gateway runtime, and documentation evidence. The next work is to prove relevant rows through generated-test and app artifacts where those stages apply.
50
50
 
51
51
  ### Slice 7: Release Candidate Gates
52
52
 
@@ -54,8 +54,8 @@ Run the release candidate gates after feature work and documentation have conver
54
54
 
55
55
  ## Remaining Before 1.0
56
56
 
57
- - Extend the capability registry beyond OpenAPI evidence into gateway runtime evidence.
58
- - Add generated gateway checks for supported and partial WSDL rows where HTTP behavior is part of the contract.
57
+ - Extend the capability registry beyond gateway runtime evidence into generated-test and app evidence.
58
+ - Add generated-test and app checks for supported and partial WSDL rows where those surfaces are part of the contract.
59
59
  - Turn remaining unsupported, diagnostic, or partial matrix rows into diagnostics, documentation, or scoped fixes.
60
60
  - Confirm `docs/supported-patterns.md` matches the matrix.
61
61
  - Run the release-candidate gates.
@@ -1,10 +1,10 @@
1
1
  # Version 1.0 Capability Conformance Framework
2
2
 
3
- Status: Phase 2 shipped; gateway runtime evidence remaining before `1.0.0`.
3
+ Status: Phase 3 shipped; generated-test and app evidence remaining before `1.0.0`.
4
4
 
5
5
  Plan for turning SOAP, WSDL, OpenAPI, gateway, app, generated-test, and documentation support claims into fixture-backed conformance evidence.
6
6
 
7
- Phase 1 shipped a TypeScript registry, reusable WSDL fixtures, compile-stage runner, documentation drift tests, and generated public support matrix. Phase 2 added generated client type-checking, OpenAPI validation, and executable diagnostics for terminal rows. The next slice should extend relevant rows into gateway runtime evidence before adding more feature rows.
7
+ Phase 1 shipped a TypeScript registry, reusable WSDL fixtures, compile-stage runner, documentation drift tests, and generated public support matrix. Phase 2 added generated client type-checking, OpenAPI validation, and executable diagnostics for terminal rows. Phase 3 added generated gateway type-checking and Fastify runtime evidence for current supported and partial rows.
8
8
 
9
9
  See the root [README.md](../../README.md) for project overview and [Version 1.0 Roadmap Plan](README.md) for the complete 1.0 route.
10
10
 
@@ -362,14 +362,169 @@ Skeptical review notes:
362
362
 
363
363
  ## Phase 3: Gateway Runtime Evidence
364
364
 
365
- Extend relevant rows to generate gateways and test Fastify runtime behavior through `fastify.inject`. Add mock operations clients and request/response fixtures as part of the registry.
365
+ Phase 3 is implemented for the current supported and partial WSDL rows. Keep this section as the baseline for future gateway conformance rows.
366
366
 
367
- Acceptance criteria:
367
+ Extend current supported and partial rows to generate gateways, type-check generated gateway artifacts, and test Fastify runtime behavior through `fastify.inject`. Add mock operations clients and request/response fixtures as part of each row's registry evidence.
368
+
369
+ ### Phase 3 Goal
370
+
371
+ A supported or partial row should no longer stop at compile, client, and OpenAPI evidence when gateway behavior is relevant. The row should prove that the generated Fastify plugin can be imported, registered with a mock operations client, and exercised through HTTP injection.
372
+
373
+ Diagnostic and unsupported rows must continue to stop at compile. They must not generate client, OpenAPI, or gateway artifacts after the expected diagnostic.
374
+
375
+ ### Phase 3 Source Files
376
+
377
+ - `test/conformance/types.ts`
378
+ - `test/conformance/registry.ts`
379
+ - `test/conformance/runner.ts`
380
+ - `test/conformance/conformance.test.ts`
381
+ - `src/gateway/generateGateway.ts`
382
+ - `test/integration/gateway-routes.test.ts`
383
+
384
+ Use `test/integration/gateway-routes.test.ts` as the runtime pattern for generated plugin imports, mock clients, Fastify registration, and `fastify.inject` assertions. Keep conformance-specific helpers in `test/conformance/runner.ts`.
385
+
386
+ ### Phase 3 Type Model
387
+
388
+ Add a small optional `gateway` expectation block to `CapabilityCase`. Keep it internal to `test/conformance/types.ts`; do not export it from `src/index.ts` and do not add a public CLI command.
389
+
390
+ The initial model should stay close to the current `client` and `openapi` expectations:
391
+
392
+ ```ts
393
+ export interface GatewayArtifacts {
394
+ clientDir: string;
395
+ gatewayDir: string;
396
+ openapiFile: string;
397
+ catalogFile: string;
398
+ compiled: CompiledCatalog;
399
+ doc: any;
400
+ routeFor: (operationId: string) => {method: string; path: string};
401
+ readGatewayFile: (relativePath: string) => string;
402
+ }
403
+
404
+ export interface GatewayRequestExpectation {
405
+ operationId: string;
406
+ payload: unknown;
407
+ mockClient: Record<string, (args: unknown) => Promise<{response: unknown; headers: unknown}>>;
408
+ expectedStatus: number;
409
+ assertBody?: (body: any) => void;
410
+ assertClientArgs?: (args: unknown) => void;
411
+ }
412
+
413
+ export interface GatewayExpectation {
414
+ outcome: "success";
415
+ requests?: GatewayRequestExpectation[];
416
+ sourceIncludes?: Array<{file: string; text: string}>;
417
+ assert?: (artifacts: GatewayArtifacts) => void | Promise<void>;
418
+ }
419
+ ```
420
+
421
+ This shape is a starting contract, not a generic assertion language. If implementation reveals a simpler local helper, prefer the simpler helper as long as a fresh agent can still understand how to add a new row.
422
+
423
+ ### Phase 3 Runner Flow
424
+
425
+ `runGatewayCase` should use one temporary output root per capability row and remove it after success. If a row fails, the thrown error should include the capability ID and the generated path involved.
426
+
427
+ Generated conformance projects should live under `tmp/conformance/`, not the OS temp directory. Gateway conformance generates a small TypeScript project that imports `soap`, `fastify`, `fastify-plugin`, generated JSON schemas, and generated sibling modules. Keeping that project under the repository lets normal Node and TypeScript ancestor lookup find `node_modules`, package metadata, and tool caches without brittle `paths` shims. OS temp directories remain acceptable for unit probes that do not type-check or import generated project graphs.
428
+
429
+ The runner should perform these steps:
430
+
431
+ 1. Compile the row fixture with `loadWsdl`, `resolveCompilerOptions`, and `compileCatalog`.
432
+ 2. Generate client artifacts into `<temp>/client`.
433
+ 3. Write `<temp>/client/catalog.json` with `generateCatalog`.
434
+ 4. Type-check generated client artifacts using the existing temporary `tsconfig.json` pattern.
435
+ 5. Generate OpenAPI into `<temp>/openapi.json` with validation enabled.
436
+ 6. Generate gateway artifacts into `<temp>/gateway` with `generateGateway`.
437
+ 7. Pass `clientDir`, `catalogFile`, `versionSlug`, and `serviceSlug` to `generateGateway`.
438
+ 8. Type-check generated client and gateway artifacts together.
439
+ 9. Dynamically import `<temp>/gateway/plugin.ts`.
440
+ 10. Register the plugin with `Fastify({logger: false})` and the row's mock operations client.
441
+ 11. Resolve each request path from the generated OpenAPI operation when possible.
442
+ 12. Execute `fastify.inject` and run row-specific status and body assertions.
443
+
444
+ Use stable gateway options unless a row declares a reason to override them:
445
+
446
+ ```ts
447
+ await generateGateway({
448
+ openapiFile,
449
+ outDir: gatewayDir,
450
+ clientDir,
451
+ catalogFile,
452
+ versionSlug: "v1",
453
+ serviceSlug: "conformance",
454
+ });
455
+ ```
456
+
457
+ Keep service and version slugs deterministic. Do not derive slugs from temporary paths.
458
+
459
+ ### Phase 3 Registry Scope
460
+
461
+ Add `gateway` expectations only to rows that already have successful compile, client, and OpenAPI expectations.
462
+
463
+ Rows expected to receive gateway evidence in this slice:
464
+
465
+ - `choice-union-simple`
466
+ - `xs-union-simple-type`
467
+ - `multi-binding-first-soap`
468
+ - `external-policy-reference`
469
+ - `deep-composition-sequence`
470
+ - `xs-anyattribute`
471
+
472
+ Rows that must not receive gateway evidence in this slice:
473
+
474
+ - `abstract-complex-type`
475
+ - `substitution-group-element`
476
+ - `mtom-xop-attachment`
477
+
478
+ ### Phase 3 Assertion Guidance
479
+
480
+ Every row with a `gateway` expectation should at least prove plugin import and registration. Add request assertions when HTTP behavior is part of the row's public contract.
481
+
482
+ For supported rows, prefer one accepted request with a SOAP-wrapper-shaped mock response and an assertion on the generated success envelope. Add one rejected request only when the generated OpenAPI schema can express a meaningful invalid payload for that capability.
483
+
484
+ For partial rows, prove the documented subset and avoid implying full support. For `xs-anyattribute`, gateway evidence should prove generation and runtime do not emit or require wildcard attribute bags. For external `PolicyReference`, gateway evidence should prove no generated inbound security requirement appears unless configured elsewhere.
485
+
486
+ For multi-binding rows, assert that the gateway route calls the operation selected by the deterministic first SOAP binding behavior. Do not implement explicit binding selection in this slice.
487
+
488
+ ### Phase 3 Non-Goals
489
+
490
+ - Do not add new WSDL feature rows.
491
+ - Do not add a public inspector command.
492
+ - Do not change generated gateway public APIs unless gateway evidence exposes a real bug.
493
+ - Do not snapshot whole generated files.
494
+ - Do not treat plugin generation alone as runtime support.
495
+ - Do not proceed past compile for diagnostic or unsupported rows.
496
+
497
+ ### Phase 3 Acceptance Criteria
498
+
499
+ - `CapabilityCase` supports optional gateway expectations.
500
+ - `test/conformance/conformance.test.ts` requires gateway expectations for supported and partial rows.
501
+ - `runGatewayCase` generates client, catalog, OpenAPI, and gateway artifacts in a row-local temp directory.
502
+ - Generated client and gateway artifacts type-check together.
503
+ - Generated plugins import and register successfully in Fastify.
504
+ - Gateway request expectations run through `fastify.inject`.
505
+ - Diagnostic and unsupported rows remain compile-terminal.
506
+ - `npm run test:conformance` passes.
507
+ - `npm run typecheck` passes.
508
+ - `npm run docs:validate` passes after any support matrix or roadmap updates.
509
+
510
+ ### Phase 3 Test-First Sequence
511
+
512
+ Start by adding the type fields, the downstream declaration guard, and the `runGatewayCase` test call. The first focused run of `npm run test:conformance` should fail because registry rows do not yet declare gateway expectations or because the runner is not implemented.
513
+
514
+ Then implement the runner helper and add the smallest gateway expectations per row. Keep failures local: if one row exposes a real gateway bug, either fix the bug with focused tests or downgrade the row's public contract only when the decision framework supports that change.
515
+
516
+ ### Phase 3 Verification Commands
517
+
518
+ Run these commands before concluding the slice:
519
+
520
+ ```bash
521
+ npm run test:conformance
522
+ npm run typecheck
523
+ npm run docs:validate
524
+ npm test
525
+ ```
368
526
 
369
- - Supported gateway rows register generated plugins successfully.
370
- - Valid request fixtures return expected envelopes or streams.
371
- - Invalid request fixtures fail with expected status codes.
372
- - Stream rows prove NDJSON and JSON array behavior separately.
527
+ Run `npm run smoke:pipeline` as a final end-to-end guard if gateway generator behavior changes outside the conformance runner.
373
528
 
374
529
  ## Phase 4: Generated Test And App Evidence
375
530
 
@@ -1,10 +1,10 @@
1
1
  # Version 1.0 WSDL Coverage Matrix
2
2
 
3
- Status: client and OpenAPI evidence shipped; gateway runtime evidence remaining before `1.0.0`.
3
+ Status: gateway runtime evidence shipped; generated-test and app evidence remaining before `1.0.0`.
4
4
 
5
5
  Plan for turning WSDL and XSD support claims into automated, fixture-backed evidence before 1.0. This is the first domain under the [Capability Conformance Framework](v1.0-capability-conformance-framework.md).
6
6
 
7
- The initial fixture-backed compile matrix shipped in `0.30.2` and `0.30.3`. Client and OpenAPI evidence now prove the current supported and partial rows, and terminal rows have executable diagnostics. The remaining work is to prove generated gateway runtime artifacts and keep public support claims tied to registry rows.
7
+ The initial fixture-backed compile matrix shipped in `0.30.2` and `0.30.3`. Client, OpenAPI, and gateway runtime evidence now prove the current supported and partial rows, and terminal rows have executable diagnostics. The remaining work is to prove generated-test and app artifacts where those surfaces are part of the contract.
8
8
 
9
9
  See the root [README.md](../../README.md) for project overview and [Version 1.0 Roadmap Plan](README.md) for the complete 1.0 route.
10
10
 
@@ -23,14 +23,15 @@ Each matrix row should have a minimal fixture, an expected support status, and a
23
23
  - `test/conformance/conformance.test.ts` runs compile-stage expectations for runnable rows.
24
24
  - Supported and partial rows generate client artifacts that type-check.
25
25
  - Supported and partial rows generate validated OpenAPI specs with targeted contract assertions.
26
+ - Supported and partial rows generate gateway artifacts that type-check and run through Fastify injection.
26
27
  - Diagnostic and unsupported rows have executable compiler error expectations.
27
28
  - `docs/supported-patterns.md` includes a generated capability evidence matrix.
28
29
  - `npm run docs:support-matrix:check` prevents support matrix drift.
29
30
 
30
31
  ## Remaining Scope
31
32
 
32
- - Add stage expectations for generated gateway output and runtime behavior.
33
- - Add generated request and response fixtures where HTTP behavior is part of a capability contract.
33
+ - Add stage expectations for generated tests and app scaffolds where those surfaces are part of a capability contract.
34
+ - Add generated request and response fixtures for generated-test coverage where HTTP behavior is part of a capability contract.
34
35
  - Keep diagnostics executable as more unsupported rows are added.
35
36
  - Keep fixture metadata useful for a future public conformance fixture corpus.
36
37
  - Preserve the weather smoke fixture as the canonical end-to-end happy path.
@@ -104,20 +105,46 @@ Ensure every documented unsupported or partial feature has a corresponding matri
104
105
  - No known feature silently miscompiles in matrix coverage.
105
106
  - The matrix can run in CI or release preflight without network access.
106
107
 
107
- ## Next Slice
108
+ ## Gateway Runtime Evidence
108
109
 
109
- The next slice should implement Phase 3 gateway runtime evidence for the current registry rows before adding more feature rows. This keeps the matrix honest: support claims become pipeline evidence, while diagnostic and unsupported claims remain stopped before downstream generation.
110
+ Phase 3 gateway runtime evidence is shipped for the current supported and partial rows. The current matrix now proves the WSDL to client to OpenAPI to Fastify path for rows that claim support or partial support.
110
111
 
111
- Work items:
112
+ Use [Capability Conformance Framework](v1.0-capability-conformance-framework.md) as the detailed implementation baseline. This section defines the WSDL-matrix-specific shipped scope.
113
+
114
+ ### Phase 3 Shipped Scope
115
+
116
+ - Optional `gateway` expectations exist in the conformance type model.
117
+ - Gateway artifacts are generated from each relevant row's OpenAPI document.
118
+ - The generated `catalog.json` is written before gateway generation.
119
+ - Generated gateway artifacts type-check with the generated client artifacts.
120
+ - Mock operations clients and `fastify.inject` assertions cover HTTP behavior.
121
+ - Diagnostic and unsupported rows stop at compile.
122
+ - The generated public support matrix remains status-focused.
123
+
124
+ ### Phase 3 Row Scope
125
+
126
+ Rows that should gain gateway evidence:
127
+
128
+ - `choice-union-simple`
129
+ - `xs-union-simple-type`
130
+ - `multi-binding-first-soap`
131
+ - `external-policy-reference`
132
+ - `deep-composition-sequence`
133
+ - `xs-anyattribute`
134
+
135
+ Rows that should stay compile-terminal:
136
+
137
+ - `abstract-complex-type`
138
+ - `substitution-group-element`
139
+ - `mtom-xop-attachment`
140
+
141
+ ### Phase 3 Runtime Expectations
142
+
143
+ Each gateway-enabled row should prove plugin import, plugin registration, and at least one `fastify.inject` request when route behavior is relevant. Assertions should inspect the generated success or error envelope, not just the existence of generated files.
112
144
 
113
- - Add optional `gateway` expectations to the conformance type model.
114
- - Generate gateway artifacts from each relevant row's OpenAPI document.
115
- - Type-check generated gateway artifacts with the generated client artifacts.
116
- - Add mock operations clients and `fastify.inject` assertions where request or response behavior is part of the contract.
117
- - Leave diagnostic and unsupported rows stopped at compile.
118
- - Update the generated public support matrix only when a row status or public contract changes.
145
+ Partial rows must prove only the documented subset. `xs:anyAttribute` should not imply generated wildcard attribute bags. External `PolicyReference` should not imply fetched or enforced external policy.
119
146
 
120
- Gotchas:
147
+ ### Phase 3 Gotchas
121
148
 
122
149
  - Do not overclaim `supported` when gateway behavior is relevant but unproven.
123
150
  - Do not snapshot whole generated files for conformance rows; assert stable contract surfaces instead.
@@ -125,6 +152,32 @@ Gotchas:
125
152
  - Do not let diagnostic or unsupported rows proceed to client, OpenAPI, or gateway generation.
126
153
  - Do not add a public inspector command in this slice.
127
154
 
155
+ ### Next Slice
156
+
157
+ The next slice is Phase 4 generated-test and app evidence. Implement it before adding more feature rows unless a production bug requires a focused diagnostic or support decision.
158
+
159
+ Work items:
160
+
161
+ - Add optional generated-test expectations for rows where `--test-dir` behavior is part of the contract.
162
+ - Generate app scaffolds for rows where app wiring is affected by the capability.
163
+ - Type-check generated app artifacts when an app expectation is present.
164
+ - Run generated tests only for rows that request generated-test evidence.
165
+ - Keep diagnostic and unsupported rows stopped at compile.
166
+ - Update public docs only when a row status or public contract changes.
167
+
168
+ ### Verification
169
+
170
+ Run these commands before the slice is considered ready:
171
+
172
+ ```bash
173
+ npm run test:conformance
174
+ npm run typecheck
175
+ npm run docs:validate
176
+ npm test
177
+ ```
178
+
179
+ Run `npm run smoke:pipeline` if the gateway generator or pipeline behavior changes.
180
+
128
181
  ## Release Implications
129
182
 
130
183
  This slice may reveal features that should be implemented before 1.0. It may also justify explicit post-1.0 deferrals if diagnostics and documentation are strong enough.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@techspokes/typescript-wsdl-client",
3
- "version": "0.31.0",
3
+ "version": "0.32.0",
4
4
  "description": "Turn legacy WSDL/SOAP services into typed TypeScript clients, OpenAPI 3.1 specs, and production-ready Fastify REST gateways. Built for enterprise SOAP modernization.",
5
5
  "keywords": [
6
6
  "wsdl",