@contractkit/plugin-csharp 0.1.3 → 0.1.4

package/.turbo/turbo-build$colon$ci.log

@@ -5,9 +5,9 @@ $ tsup src/index.ts --format esm --sourcemap --dts && tsc --emitDeclarationOnly
 CLI tsup v8.5.1
 CLI Target: esnext
 ESM Build start
-ESM dist/index.js     87.30 KB
-ESM dist/index.js.map 188.87 KB
-ESM ⚡️ Build success in 180ms
+ESM dist/index.js     88.63 KB
+ESM dist/index.js.map 193.78 KB
+ESM ⚡️ Build success in 154ms
 DTS Build start
-DTS ⚡️ Build success in 7420ms
+DTS ⚡️ Build success in 6453ms
 DTS dist/index.d.ts 1.50 KB

package/.turbo/turbo-test$colon$ci.log

@@ -3,34 +3,34 @@ $ vitest run --coverage
  RUN  v4.1.5 /home/runner/work/ContractKit/ContractKit/packages/plugin-csharp
       Coverage enabled with v8
 
- ✓ tests/codegen-client.test.ts (26 tests) 252ms
- ✓ tests/codegen-models.test.ts (65 tests) 282ms
- ✓ tests/index.test.ts (10 tests) 207ms
- ✓ tests/naming.test.ts (19 tests) 88ms
- ✓ tests/runtime.test.ts (14 tests) 51ms
- ✓ tests/scaffold.test.ts (5 tests) 14ms
- ✓ tests/hoist.test.ts (10 tests) 67ms
+ ✓ tests/naming.test.ts (23 tests) 110ms
+ ✓ tests/codegen-client.test.ts (40 tests) 305ms
+ ✓ tests/codegen-models.test.ts (65 tests) 306ms
+ ✓ tests/index.test.ts (10 tests) 199ms
+ ✓ tests/runtime.test.ts (14 tests) 65ms
+ ✓ tests/scaffold.test.ts (5 tests) 46ms
+ ✓ tests/hoist.test.ts (10 tests) 54ms
 
  Test Files  7 passed (7)
-      Tests  149 passed (149)
-   Start at  15:17:08
-   Duration  13.50s (transform 5.27s, setup 0ms, import 22.08s, tests 962ms, environment 10ms)
+      Tests  167 passed (167)
+   Start at  17:55:57
+   Duration  13.21s (transform 4.92s, setup 0ms, import 21.10s, tests 1.08s, environment 1ms)
 
  % Coverage report from v8
 -------------------|---------|----------|---------|---------|-------------------
 File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
 -------------------|---------|----------|---------|---------|-------------------
-All files          |   88.04 |    77.07 |   89.59 |   90.82 |                   
- src               |   88.08 |    77.15 |   89.79 |   90.86 |                   
-  ...gen-client.ts |   94.61 |    87.12 |   94.91 |   97.59 | ...94-496,513-514 
+All files          |   88.59 |    78.77 |   89.91 |   90.97 |                   
+ src               |   88.65 |    78.52 |   90.14 |   91.02 |                   
+  ...gen-client.ts |   95.91 |    90.87 |   95.38 |   97.67 | ...28-530,547-548 
   ...gen-models.ts |   91.29 |    75.25 |   96.61 |   93.02 | ...05,907,929-932 
   codegen-sdk.ts   |     100 |      100 |     100 |     100 |                   
   hoist.ts         |   78.66 |     61.9 |    93.1 |   79.06 | ...13-322,350-362 
   index.ts         |   70.74 |    71.21 |   58.06 |   75.59 | ...25-329,350-369 
-  naming.ts        |    86.2 |    72.72 |     100 |     100 | ...40,164-191,204 
+  naming.ts        |   88.05 |    72.72 |     100 |     100 | ...40,187-214,227 
   ...converters.ts |     100 |      100 |     100 |     100 |                   
   runtime.ts       |     100 |      100 |     100 |     100 |                   
   scaffold.ts      |     100 |      100 |     100 |     100 |                   
- tests             |   86.95 |    75.67 |      88 |   89.74 |                   
-  helpers.ts       |   86.95 |    75.67 |      88 |   89.74 | 99,138,146,175    
+ tests             |   86.95 |    83.78 |      88 |   89.74 |                   
+  helpers.ts       |   86.95 |    83.78 |      88 |   89.74 | 99,138,146,175    
 -------------------|---------|----------|---------|---------|-------------------

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @contractkit/plugin-csharp
 
+## 0.1.4
+
+### Patch Changes
+
+- 6f8f55b: Fix two naming collisions that made the generated SDK fail to compile.
+
+    A path param named after one of the method's own arguments or locals was declared twice: `/notes/{body}` on an operation with a request body gave `PutNoteAsync(string body, Note body, ...)`, error CS0100. A path param now gets a trailing underscore when it lands on `body`, `query`, `customHeaders`, `pathParams`, `cancellationToken`, the `response` and `headers` locals, or the client's `http` field, so that method takes `string body_`. Keyword escaping is unchanged (`string @class`). The pattern variable an optional response header is read into is renamed the same way, so a header named like a parameter no longer redeclares it (CS0136).
+
+    An operation that declares both a request `headers:` block and response headers generated two records named `<Method>Headers` in one namespace, error CS0101. The request record keeps that name, since it is the one a caller constructs, and the response record becomes `<Method>ResponseHeaders`. Operations declaring only one of the two are unchanged.
+
 ## 0.1.3
 
 ### Patch Changes

package/README.md

@@ -143,7 +143,8 @@ that hold it.
 A method returns the response body directly. Three things change that:
 
 - A status declaring **response headers** returns `<Method>Result(Data, Headers)`, or
-  `<Method>Headers` when there is no body.
+  `<Method>Headers` when there is no body. When the operation also declares request `headers:`,
+  those keep `<Method>Headers` and the response side is `<Method>ResponseHeaders`.
 - An operation the client can observe at **several statuses** returns an abstract
   `<Method>Response` with a `Status<code>` leaf each.
 - A status declaring **several content types** returns one leaf per mime.

package/dist/codegen-client.d.ts

@@ -24,7 +24,7 @@ export declare function generateCSharpClient(root: OpRootNode, opts: CSharpClien
  * values that came from the caller are percent-encoded. `params` says where a value lives: spread
  * across the signature, or behind one `pathParams` argument when the route declares a model.
  */
-export declare function buildPathExpression(path: string, params?: ParamSource): string;
+export declare function buildPathExpression(path: string, params?: ParamSource, bindings?: ReadonlyMap<string, string>): string;
 /**
  * The SDK method name, in the same priority order every ContractKit SDK uses: an explicit `sdk:`,
  * then the operation's `name:`, then a name inferred from the verb and path. C# spells it

package/dist/codegen-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codegen-client.d.ts","sourceRoot":"","sources":["../src/codegen-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,SAAS,EACT,eAAe,EAIf,UAAU,EACV,WAAW,EACX,WAAW,EACd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAY9C,MAAM,WAAW,0BAA0B;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACpC;AAwBD,gFAAgF;AAChF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,UAAQ,GAAG,OAAO,CAOtF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,0BAA0B,GAAG,MAAM,CA2E/F;AAwZD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,MAAM,CAY9E;AAkFD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAIhF"}
+{"version":3,"file":"codegen-client.d.ts","sourceRoot":"","sources":["../src/codegen-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,SAAS,EACT,eAAe,EAIf,UAAU,EACV,WAAW,EACX,WAAW,EACd,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAa9C,MAAM,WAAW,0BAA0B;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IACrC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACpC;AAwBD,gFAAgF;AAChF,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,EAAE,eAAe,UAAQ,GAAG,OAAO,CAOtF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE1D;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,0BAA0B,GAAG,MAAM,CA2E/F;AAscD;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAetH;AAuGD;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM,CAIhF"}

package/dist/index.js

@@ -115,6 +115,17 @@ function toCSharpParameterName(name) {
   if (/^\d/.test(result)) result = `_${result}`;
   return escapeCSharpIdentifier(result);
 }
+function bindCSharpParameterNames(names, taken) {
+  const unavailable = new Set(taken);
+  const bindings = /* @__PURE__ */ new Map();
+  for (const name of names) {
+    let local = toCSharpParameterName(name).replace(/^@/, "");
+    while (unavailable.has(local)) local += "_";
+    unavailable.add(local);
+    bindings.set(name, escapeCSharpIdentifier(local));
+  }
+  return bindings;
+}
 function safeMemberName(propertyName, ownerTypeName) {
   if (propertyName === ownerTypeName || RESERVED_MEMBER_NAMES.has(propertyName)) return `${propertyName}Value`;
   return propertyName;
@@ -897,10 +908,12 @@ function observableOf(shape) {
 function generateMethod(route, op, ctx, methodName) {
   const base = methodBase(methodName);
   const shape = responseShape(op);
-  const returnType = returnTypeFor(shape, base, ctx);
+  const returnType = returnTypeFor(shape, op, base, ctx);
   const observable = observableOf(shape);
   const expectStatuses = observable.filter((r) => r.statusCode < 200 || r.statusCode >= 300).map((r) => r.statusCode);
-  const params = buildMethodParams(route, op, ctx);
+  const pathBindings = bindPathParams(route);
+  const params = buildMethodParams(route, op, ctx, pathBindings);
+  const bound = [...METHOD_LOCALS, ...params.map((p) => p.name.replace(/^@/, ""))];
   const signature = [...params.map((p) => `${p.type} ${p.name}${p.optional ? " = null" : ""}`), "CancellationToken cancellationToken = default"].join(
     ", "
   );
@@ -909,7 +922,7 @@ function generateMethod(route, op, ctx, methodName) {
   if (resolveModifiers(route, op).includes("deprecated")) lines.push('[Obsolete("Deprecated in the contract")]');
   lines.push(`public async ${returnType === "void" ? "Task" : `Task<${returnType}>`} ${methodName}(${signature})`);
   lines.push("{");
-  const callArgs = [`HttpMethod.${httpMethodConstant(op.method)}`, buildPathExpression(route.path, route.params)];
+  const callArgs = [`HttpMethod.${httpMethodConstant(op.method)}`, buildPathExpression(route.path, route.params, pathBindings)];
   if (op.query) callArgs.push("query: http.Params(query)");
   if (op.headers) callArgs.push("headers: http.Params(customHeaders)");
   const content = bodyArgument(op);
@@ -921,16 +934,16 @@ function generateMethod(route, op, ctx, methodName) {
   callArgs.forEach((arg, index) => {
     lines.push(`        ${arg}${index === callArgs.length - 1 ? ").ConfigureAwait(false);" : ","}`);
   });
-  lines.push(...returnStatements(shape, base, ctx, where(route, op)));
+  lines.push(...returnStatements(shape, op, base, ctx, where(route, op), bound));
   lines.push("}");
   return lines;
 }
-function returnTypeFor(shape, base, ctx) {
+function returnTypeFor(shape, op, base, ctx) {
   if (shape.kind !== "simple") return `${base}Response`;
   const response = shape.response;
   const body = response?.bodies[0];
   const headers = response?.headers ?? [];
-  if (!body) return headers.length > 0 ? `${base}Headers` : "void";
+  if (!body) return headers.length > 0 ? headersRecordName(op, base) : "void";
   const dataType = bodyCSharpType(body, ctx);
   return headers.length > 0 ? `${base}Result` : dataType;
 }
@@ -954,18 +967,18 @@ function bodyReadExpr(body, ctx) {
       return `http.ReadJson<${renderCSharpType(body.bodyType, ctx, false)}>(response)`;
   }
 }
-function returnStatements(shape, base, ctx, place) {
+function returnStatements(shape, op, base, ctx, place, bound) {
   if (shape.kind === "simple") {
     const response = shape.response;
     const body = response?.bodies[0];
     const headers = response?.headers ?? [];
     if (headers.length === 0) return body ? [`    return ${bodyReadExpr(body, ctx)};`] : [];
-    const lines2 = readHeaderLines(headers, `${base}Headers`, ctx, place, "    ");
+    const lines2 = readHeaderLines(headers, headersRecordName(op, base), ctx, place, "    ", bound);
     return body ? [...lines2, `    return new ${base}Result(${bodyReadExpr(body, ctx)}, headers);`] : [...lines2, "    return headers;"];
   }
   if (shape.kind === "multiMime") {
     const headers = shape.response.headers ?? [];
-    const lines2 = headers.length > 0 ? readHeaderLines(headers, `${base}Headers`, ctx, place, "    ") : [];
+    const lines2 = headers.length > 0 ? readHeaderLines(headers, headersRecordName(op, base), ctx, place, "    ", bound) : [];
     lines2.push(...mimeSwitch(shape.response, base, void 0, ctx, "    ", headers.length > 0));
     return lines2;
   }
@@ -974,21 +987,21 @@ function returnStatements(shape, base, ctx, place) {
   for (const response of rest) {
     lines.push(`        case ${response.statusCode}:`);
     lines.push("        {");
-    lines.push(...statusBranch(response, base, response.statusCode, ctx, place, "            "));
+    lines.push(...statusBranch(response, op, base, response.statusCode, ctx, place, "            ", bound));
     lines.push("        }");
     lines.push("");
   }
   lines.push("        default:");
   lines.push("        {");
-  lines.push(...statusBranch(fallback, base, fallback.statusCode, ctx, place, "            "));
+  lines.push(...statusBranch(fallback, op, base, fallback.statusCode, ctx, place, "            ", bound));
   lines.push("        }");
   lines.push("    }");
   return lines;
 }
-function statusBranch(response, base, statusCode, ctx, place, indent) {
+function statusBranch(response, op, base, statusCode, ctx, place, indent, bound) {
   const lines = [];
   const headers = response.headers ?? [];
-  if (headers.length > 0) lines.push(...readHeaderLines(headers, headersRecordName(base, statusCode), ctx, place, indent));
+  if (headers.length > 0) lines.push(...readHeaderLines(headers, headersRecordName(op, base, statusCode), ctx, place, indent, bound));
   lines.push(...mimeSwitch(response, base, statusCode, ctx, indent, headers.length > 0));
   return lines;
 }
@@ -1029,8 +1042,12 @@ function bodyArgument(op) {
       return `content: http.JsonContent(body, ${mime})`;
   }
 }
-function headersRecordName(base, statusCode) {
-  return statusCode === void 0 ? `${base}Headers` : `${base}${statusCode}Headers`;
+function headersRecordName(op, base, statusCode) {
+  if (statusCode !== void 0) return `${base}${statusCode}Headers`;
+  return declaresRequestHeadersRecord(op) ? `${base}ResponseHeaders` : `${base}Headers`;
+}
+function declaresRequestHeadersRecord(op) {
+  return op.headers?.kind === "params" && op.headers.nodes.length > 0;
 }
 function leafRecordName(response, body, statusCode) {
   const statusPart = statusCode === void 0 ? "" : `Status${statusCode}`;
@@ -1056,12 +1073,12 @@ function responseDeclarations(route, op, ctx) {
     const response = shape.response;
     const headers = response?.headers ?? [];
     if (headers.length === 0) return lines;
-    headerRecord(headers, headersRecordName(base));
+    headerRecord(headers, headersRecordName(op, base));
     const body = response?.bodies[0];
     if (body) {
       lines.push("");
       lines.push(...xmlDocLines(`The body of ${place}, with the response headers the contract declares.`, ""));
-      lines.push(`public sealed record ${base}Result(${bodyCSharpType(body, ctx)} Data, ${headersRecordName(base)} Headers);`);
+      lines.push(`public sealed record ${base}Result(${bodyCSharpType(body, ctx)} Data, ${headersRecordName(op, base)} Headers);`);
     }
     return lines;
   }
@@ -1069,7 +1086,7 @@ function responseDeclarations(route, op, ctx) {
   const withStatus = shape.kind === "multiStatus";
   for (const response of responses) {
     const headers = response.headers ?? [];
-    if (headers.length > 0) headerRecord(headers, headersRecordName(base, withStatus ? response.statusCode : void 0));
+    if (headers.length > 0) headerRecord(headers, headersRecordName(op, base, withStatus ? response.statusCode : void 0));
   }
   lines.push("");
   lines.push(
@@ -1091,7 +1108,7 @@ function responseDeclarations(route, op, ctx) {
       const name = leafRecordName(response, body, statusCode);
       const parameters = [];
       if (body) parameters.push(`${bodyCSharpType(body, ctx)} Data`);
-      if (headers.length > 0) parameters.push(`${headersRecordName(base, statusCode)} Headers`);
+      if (headers.length > 0) parameters.push(`${headersRecordName(op, base, statusCode)} Headers`);
       lines.push("");
       lines.push(`    public sealed record ${name}(${parameters.join(", ")}) : ${base}Response;`);
     }
@@ -1137,12 +1154,16 @@ function describeHeaderType(type) {
   if (type.kind === "ref") return `the contract '${type.name}'`;
   return `${type.kind === "array" || type.kind === "inlineObject" ? "an" : "a"} ${type.kind}`;
 }
-function readHeaderLines(headers, typeName, ctx, place, indent) {
+function readHeaderLines(headers, typeName, ctx, place, indent, bound) {
+  const locals = bindCSharpParameterNames(
+    headers.filter((h) => h.optional).map((h) => h.name),
+    bound
+  );
   const args = headers.map((header) => {
     const reader = headerReader(header, place);
     const name = quoteCSharpString(header.name);
     if (!header.optional) return reader.read(`http.RequireHeader(response, ${name})`);
-    const local = toCSharpParameterName(header.name);
+    const local = locals.get(header.name);
     return `response.Header(${name}) is { } ${local} ? ${reader.read(local)} : null`;
   });
   const lines = [`${indent}var headers = new ${typeName}(`];
@@ -1165,22 +1186,30 @@ function httpMethodConstant(method) {
   return lower.charAt(0).toUpperCase() + lower.slice(1);
 }
 var PATH_PLACEHOLDER = /\{([a-zA-Z_$][a-zA-Z0-9_$.-]*)\}/g;
-function buildPathExpression(path, params) {
+function buildPathExpression(path, params, bindings) {
   const args = path.split("/").filter(Boolean).map((raw) => {
     PATH_PLACEHOLDER.lastIndex = 0;
     const match = PATH_PLACEHOLDER.exec(raw);
     if (!match || match[0] !== raw) return quoteCSharpString(raw);
-    const value = params && params.kind !== "params" ? `pathParams.${toCSharpPropertyName(match[1])}` : toCSharpParameterName(match[1]);
+    const value = params && params.kind !== "params" ? `pathParams.${toCSharpPropertyName(match[1])}` : bindings?.get(match[1]) ?? toCSharpParameterName(match[1]);
     return `http.Segment(${value})`;
   });
   return `http.Path(${args.join(", ")})`;
 }
-function buildMethodParams(route, op, ctx) {
+var METHOD_LOCALS = ["body", "query", "customHeaders", "pathParams", "cancellationToken", "response", "headers", "http"];
+function bindPathParams(route) {
+  if (route.params?.kind !== "params") return /* @__PURE__ */ new Map();
+  return bindCSharpParameterNames(
+    route.params.nodes.map((n) => n.name),
+    METHOD_LOCALS
+  );
+}
+function buildMethodParams(route, op, ctx, pathBindings) {
   const params = [];
   if (route.params) {
     if (route.params.kind === "params") {
       for (const node of route.params.nodes) {
-        params.push({ name: toCSharpParameterName(node.name), type: renderCSharpType(node.type, ctx, true), optional: false });
+        params.push({ name: pathBindings.get(node.name), type: renderCSharpType(node.type, ctx, true), optional: false });
       }
     } else {
       params.push({ name: "pathParams", type: renderParamSourceType(route.params, ctx, ""), optional: false });