typespec-http-zod 0.8.0 → 0.10.0

package/dist/src/api.d.ts

@@ -109,6 +109,32 @@ export interface EmittedRoute {
     readonly operationId: string;
     readonly verb: string;
     readonly path: string;
+    /**
+     * The WIRE names of path parameters that use RFC 6570 reserved expansion, and so match across `/`.
+     *
+     * **`path` alone cannot carry this, and that is not an oversight in the spelling.** A note path is
+     * `areas/health.md`, so a vault route has to be `GET /vault/:path{.+}`; `@typespec/http` resolves
+     * `@route("/vault/{+path}")` to `path` = `/vault/{path}` with the operator already stripped, and
+     * `@typespec/openapi3` publishes the same. **Measured at 3.0.0, 3.1.0 and 3.2.0**: OpenAPI cannot
+     * express reserved expansion at any version, so the document says `/vault/{path}` and openapi3
+     * raises `path-reserved-expansion` as a warning. The fact exists in the program and reaches no
+     * artefact, so a server emitter mounts a route that answers 404 to every request it was written
+     * for. This is the one place the IR deliberately carries more than the document - see
+     * `docs/reference.md`.
+     *
+     * **Read from the parameter, never by parsing `path` or `uriTemplate` for `{+`.** Two forms reach
+     * `allowReserved`, and only the parameter entry answers for both: the operator in the template
+     * (`@route("/vault/{+path}")`), and `@path(#{allowReserved: true})` on a required parameter the
+     * template does not already name, which is what `@typespec/http-specs` itself uses and which
+     * `@typespec/http` resolves by APPENDING `{+param}` to the template. Deciding this by matching
+     * emitted text would also be the defect class that produced six others here.
+     *
+     * Wire names, so `@path("note-path") notePath` appears as `note-path` - the name a router has to
+     * match, and the same one `pathSchema` keys on. Empty when the operation has none, never
+     * `undefined`, so a consumer does not branch. Reserved-ness is per PARAMETER: `/repo/{owner}/{+ref}`
+     * carries one of each.
+     */
+    readonly reservedPathParameters: readonly string[];
     readonly statusCode: number;
     readonly statusCodes: readonly number[];
     /** Media types the success body can be served as - the basis for `Accept` negotiation. */

package/dist/src/api.js

@@ -892,6 +892,14 @@ export function collectRoutes(program, registry, service) {
                  * particular router can express the path.
                  */
                 path: operation.path,
+                /**
+                 * Asked of the resolved parameter, which is the only place both marker forms agree -
+                 * see {@link EmittedRoute.reservedPathParameters}. `allowReserved` is a required
+                 * boolean on every path parameter entry, so this reads a fact rather than an absence.
+                 */
+                reservedPathParameters: operation.parameters.parameters
+                    .filter((parameter) => parameter.type === "path" && parameter.allowReserved)
+                    .map((parameter) => parameter.name),
                 statusCode,
                 statusCodes,
                 responseContentTypes: responseContentTypesOf(operation, statusCode),
@@ -1050,15 +1058,19 @@ function renderSchemas(registry, externals, routeDeclarations, runtimeModule) {
      * **Written only when something in the file names it**, like the `ResponseArm` import below and for
      * the same reason: an unused import fails the lint a generated file has to pass like any other.
      *
-     * `z` is reached through a declaration's source or a route's arms, so a service whose every
-     * operation takes nothing and returns `void` declares neither and named it never:
+     * `z` is reached through a declaration's source or a route arm's schema, and a service whose every
+     * operation takes nothing and returns `void` has neither: its arms are
+     * `{ status: 204, schema: undefined }`, which names nothing.
      * `TS6133: 'z' is declared but its value is never read`, from a compile that reported success. Two
      * bare `GET`s is where a health check starts, so it is where a new consumer starts.
      *
-     * Decided from the declarations rather than by searching the rendered text, which is the mistake
-     * this file has made four times.
+     * **Counting declarations is not sufficient and was the first attempt.** A void-only service HAS
+     * route declarations; they simply do not use Zod. The content decides, and it is TOKENISED on the
+     * language's own identifier rule rather than searched for a substring, so `z` cannot be found
+     * inside `zValidator` or missed beside a bracket. `renderExternalImports` below reads the same
+     * rendered content for the same reason.
      */
-    const usesZod = declarations.length > 0 || routeDeclarations.length > 0;
+    const usesZod = new Set([...declarations, ...routeDeclarations].join("").match(/[A-Za-z_$][\w$]*/g) ?? []).has("z");
     const parts = [GENERATED_BANNER];
     if (usesZod)
         parts.push('\nimport { z } from "zod";\n');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typespec-http-zod",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "TypeSpec emitter and library: turn an HTTP service definition into Zod validators and framework-free contract types that agree, keyword for keyword, with the OpenAPI document @typespec/openapi3 publishes from the same source.",
   "keywords": [
     "codegen",