fix(parameter): pathパラメータを優先しつつ入力順を保持するよう同名パラメータの解決ロジックを修正

Author: Himenon

src/internal/OpenApiTools/components/Parameter.ts

@@ -100,6 +100,28 @@ export const generatePropertySignatureObject = (
   };
 };
 
+/**
+ * パラメータの `in` プロパティを返す。
+ *
+ * inline パラメータはそのまま `in` を返す。
+ * `$ref` 参照の場合はローカル参照を解決して store から実体を取得する。
+ * store に存在しない場合（リモート参照など）は `undefined` を返す。
+ */
+const resolveParameterIn = (store: Walker.Store, parameter: OpenApi.Parameter | OpenApi.Reference): string | undefined => {
+  if (!Guard.isReference(parameter)) {
+    return parameter.in;
+  }
+  const localRef = Reference.generateLocalReference(parameter);
+  if (!localRef) {
+    return undefined;
+  }
+  try {
+    return store.getParameter(localRef.path).in;
+  } catch {
+    return undefined;
+  }
+};
+
 export const generatePropertySignatures = (
   entryPoint: string,
   currentPoint: string,
@@ -109,16 +131,11 @@ export const generatePropertySignatures = (
   context: ToTypeNode.Context,
   converterContext: ConverterContext.Types,
 ): string[] => {
-  // Path parameters must be processed last so they win over same-named query/header
-  // parameters when building the TypeScript interface (path params are always required).
-  const sorted = [...parameters].sort((a, b): number => {
-    const aIsPath = !Guard.isReference(a) && a.in === "path";
-    const bIsPath = !Guard.isReference(b) && b.in === "path";
-    if (aIsPath && !bIsPath) return 1;
-    if (!aIsPath && bIsPath) return -1;
-    return 0;
-  });
-  const typeElementMap = sorted.reduce<Record<string, string>>((all, parameter) => {
+  // 入力順を維持しながら、同名パラメータが存在する場合は path パラメータを優先する。
+  // Map はキーの挿入順を保持するため、既存キーへの set() は値のみ更新し順序は変わらない。
+  // これにより OpenAPI spec の記述順を崩さず、path パラメータの required が保たれる。
+  const typeElementMap = new Map<string, string>();
+  for (const parameter of parameters) {
     const { name, typeElement } = generatePropertySignatureObject(
       entryPoint,
       currentPoint,
@@ -128,9 +145,12 @@ export const generatePropertySignatures = (
       context,
       converterContext,
     );
-    return { ...all, [name]: typeElement };
-  }, {});
-  return Object.values(typeElementMap);
+    const isPath = resolveParameterIn(store, parameter) === "path";
+    if (!typeElementMap.has(name) || isPath) {
+      typeElementMap.set(name, typeElement);
+    }
+  }
+  return [...typeElementMap.values()];
 };
 
 export const generateInterface = (

test/__tests__/class/__snapshots__/argo-rollout/client.ts

@@ -1,5 +1,5 @@
 // 
-// Generated by @himenon/openapi-typescript-code-generator v2.0.4
+// Generated by @himenon/openapi-typescript-code-generator
 // 
 // OpenApi : 3.0.0
 // 

test/__tests__/class/__snapshots__/cloudflare/client.ts

@@ -1,5 +1,5 @@
 // 
-// Generated by @himenon/openapi-typescript-code-generator v2.0.4
+// Generated by @himenon/openapi-typescript-code-generator
 // 
 // OpenApi : 3.1.0
 // 

test/__tests__/class/__snapshots__/format.domain/code.ts

@@ -1,5 +1,5 @@
 // 
-// Generated by @himenon/openapi-typescript-code-generator v2.0.4
+// Generated by @himenon/openapi-typescript-code-generator
 // 
 // OpenApi : 3.0.1
 // 

test/__tests__/class/__snapshots__/kubernetes/client-v1.18.5.ts

@@ -1,5 +1,5 @@
 // 
-// Generated by @himenon/openapi-typescript-code-generator v2.0.4
+// Generated by @himenon/openapi-typescript-code-generator
 // 
 // OpenApi : 3.0.1
 // 

test/__tests__/class/__snapshots__/kubernetes/client-v1.28.6.ts

@@ -224,6 +224,94 @@
       }
     }
   },
+  {
+    "operationId": "getPodProxyWithPath",
+    "convertedParams": {
+      "escapedOperationId": "getPodProxyWithPath",
+      "argumentParamsTypeDeclaration": "Params$getPodProxyWithPath",
+      "functionName": "getPodProxyWithPath",
+      "requestContentTypeName": "RequestContentType$getPodProxyWithPath",
+      "responseContentTypeName": "ResponseContentType$getPodProxyWithPath",
+      "parameterName": "Parameter$getPodProxyWithPath",
+      "requestBodyName": "RequestBody$getPodProxyWithPath",
+      "hasRequestBody": false,
+      "hasParameter": true,
+      "pickedParameters": [
+        {
+          "name": "name",
+          "in": "path"
+        },
+        {
+          "name": "path",
+          "in": "path",
+          "required": true
+        },
+        {
+          "name": "path",
+          "in": "query"
+        }
+      ],
+      "requestContentTypes": [],
+      "responseSuccessNames": [
+        "Response$getPodProxyWithPath$Status$200"
+      ],
+      "responseFirstSuccessName": "Response$getPodProxyWithPath$Status$200",
+      "has2OrMoreSuccessNames": false,
+      "responseErrorNames": [],
+      "has2OrMoreRequestContentTypes": false,
+      "successResponseContentTypes": [
+        "application/json"
+      ],
+      "successResponseFirstContentType": "application/json",
+      "has2OrMoreSuccessResponseContentTypes": false,
+      "hasAdditionalHeaders": false,
+      "hasQueryParameters": true
+    },
+    "operationParams": {
+      "httpMethod": "get",
+      "requestUri": "/pods/{name}/proxy/{path}",
+      "comment": "$ref パラメータで同名の pathパラメータと queryパラメータが競合するケース",
+      "deprecated": false,
+      "parameters": [
+        {
+          "in": "path",
+          "name": "name",
+          "schema": {
+            "type": "string"
+          }
+        },
+        {
+          "in": "path",
+          "name": "path",
+          "required": true,
+          "description": "URL パスの一部として使用されるパスパラメータ",
+          "schema": {
+            "type": "string"
+          }
+        },
+        {
+          "in": "query",
+          "name": "path",
+          "description": "クエリパラメータとして使用される path（省略可能）",
+          "schema": {
+            "type": "string"
+          }
+        }
+      ],
+      "responses": {
+        "200": {
+          "description": "OK",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
   {
     "operationId": "getUserPost",
     "convertedParams": {

test/__tests__/class/__snapshots__/mulit-type-test.domain/apiClient.ts

@@ -1,5 +1,5 @@
 // 
-// Generated by @himenon/openapi-typescript-code-generator v2.0.4
+// Generated by @himenon/openapi-typescript-code-generator
 // 
 // OpenApi : 3.1.0
 // 
@@ -45,8 +45,8 @@ export interface Response$getReferenceItems$Status$200 {
     };
 }
 export interface Parameter$searchBook {
-    "from.publishedAt"?: number;
     "book.name": string;
+    "from.publishedAt"?: number;
 }
 export interface Response$searchBook$Status$200 {
     "application/json": {