starred/yaak-mountain-loop
1
0
Fork 0
mirror of https://github.com/mountain-loop/yaak.git synced 2026-08-24 04:13:59 +02:00
Code Issues 8 Packages Projects Releases 10 Wiki Activity

fix(openapi): preserve serialized parameter behavior

Browse Source
This commit is contained in:
Gregory Schier
2026-08-19 12:56:44 -07:00
parent 615751ffd1
commit 3fa4eb1591
4 changed files with 191 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/importer-openapi/src/index.ts
+116 -34
View File
@@ -302,7 +302,7 @@ function importOperation({
useDynamicServerUrls,
});
const urlParameters = [
...importUrlParameters({ importState, parameters }),
...importUrlParameters({ importState, parameters, path }),
...authentication.urlParameters,
];
const headers = mergeHeaders(
@@ -336,6 +336,8 @@ function importOperation({
url: buildOperationUrl(
operationBaseUrl({ operation, pathItem, requestBaseUrl, serverOverrides }),
path,
parameters,
importState,
),
urlParameters,
headers,
@@ -645,8 +647,56 @@ function findOrCreateFolderId({
return folder.id;
}
function buildOperationUrl(baseUrl: string, path: string): string {
return joinUrlParts(baseUrl, path.replaceAll(/{([^}/]+)}/g, ":$1"));
function buildOperationUrl(
baseUrl: string,
path: string,
parameters: unknown[],
importState: ImportState,
): string {
let serializedPath = path;
for (const rawParameter of parameters) {
const parameter = importState.resolve(rawParameter);
if (!isRecord(parameter) || !shouldInlinePathParameter(parameter, importState, path)) continue;
const name = stringAt(parameter, "name") ?? "";
if (name.length === 0) continue;
const value = parameterExampleValue(parameter, importState);
serializedPath = serializedPath.replaceAll(
`{${name}}`,
isRecord(parameter.content)
? encodePathComponent(serializeContentParameter(parameter, importState))
: serializePathParameter(name, value, parameter, encodePathComponent),
);
}
return joinUrlParts(baseUrl, serializedPath.replaceAll(/{([^}/]+)}/g, ":$1"));
}
function shouldInlinePathParameter(
parameter: UnknownRecord,
importState: ImportState,
path: string,
): boolean {
if (stringAt(parameter, "in") !== "path") return false;
const name = stringAt(parameter, "name") ?? "";
const template = `{${name}}`;
const matchingSegments = path.split("/").filter((segment) => segment.includes(template));
if (matchingSegments.length === 0 || matchingSegments.some((segment) => segment !== template)) {
return true;
}
if (isRecord(parameter.content)) return false;
const value = parameterExampleValue(parameter, importState);
return (
stringAt(parameter, "style") === "matrix" ||
Array.isArray(value) ||
isRecord(value)
);
}
function encodePathComponent(value: unknown): string {
return encodeURIComponent(stringifyExampleValue(value)).replace(
/[!'()*]/g,
(character) => `%${character.charCodeAt(0).toString(16).toUpperCase()}`,
);
}
function importBaseUrl(spec: UnknownRecord): string {
@@ -733,21 +783,24 @@ function trimTrailingSlashes(value: string): string {
function importUrlParameters({
importState,
parameters,
path,
}: {
importState: ImportState;
parameters: unknown[];
path: string;
}): HttpUrlParameter[] {
return parameters
.map((p) => importState.resolve(p))
.filter(isRecord)
.filter((p) => stringAt(p, "in") === "query" || stringAt(p, "in") === "path")
.flatMap((p) => serializeUrlParameter(p, importState))
.flatMap((p) => serializeUrlParameter(p, importState, path))
.filter(({ name }) => name.length > 0);
}
function serializeUrlParameter(
parameter: UnknownRecord,
importState: ImportState,
path: string,
): HttpUrlParameter[] {
const name = stringAt(parameter, "name") ?? "";
const location = stringAt(parameter, "in");
@@ -763,6 +816,7 @@ function serializeUrlParameter(
];
}
if (location === "path") {
if (shouldInlinePathParameter(parameter, importState, path)) return [];
return [{ enabled, name: `:${name}`, value: serializePathParameter(name, value, parameter) }];
}
@@ -832,24 +886,39 @@ function importHeaderParameters({
}
function importCookieHeader(parameters: unknown[], importState: ImportState): HttpRequestHeader[] {
const cookies = parameters
return parameters
.map((p) => importState.resolve(p))
.filter(isRecord)
.filter((p) => stringAt(p, "in") === "cookie")
.map((p) => ({
enabled: p.required === true,
name: stringAt(p, "name") ?? "",
value: serializeParameterValue(p, importState),
}))
.filter(({ name }) => name.length > 0);
if (cookies.length === 0) return [];
return [
{
enabled: cookies.some(({ enabled }) => enabled),
name: "Cookie",
value: cookies.map(({ name, value }) => `${name}=${value}`).join("; "),
},
];
value: serializeCookieParameter(p, importState),
}))
.filter(({ value }) => value.length > 0);
}
function serializeCookieParameter(parameter: UnknownRecord, importState: ImportState): string {
const name = stringAt(parameter, "name") ?? "";
if (name.length === 0) return "";
if (isRecord(parameter.content)) {
return `${name}=${serializeContentParameter(parameter, importState)}`;
}
const value = parameterExampleValue(parameter, importState);
const explode = parameter.explode !== false;
if (Array.isArray(value)) {
return explode
? value.map((entryValue) => `${name}=${stringifyExampleValue(entryValue)}`).join("&")
: `${name}=${value.map(stringifyExampleValue).join(",")}`;
}
if (isRecord(value)) {
const entries = Object.entries(value);
return explode
? entries.map(([key, entryValue]) => `${key}=${stringifyExampleValue(entryValue)}`).join("&")
: `${name}=${entries.flat().map(stringifyExampleValue).join(",")}`;
}
return `${name}=${stringifyExampleValue(value)}`;
}
function serializeParameterValue(parameter: UnknownRecord, importState: ImportState): string {
@@ -865,49 +934,60 @@ function serializeContentParameter(parameter: UnknownRecord, importState: Import
: stringifyExampleValue(value);
}
function serializePathParameter(name: string, value: unknown, parameter: UnknownRecord): string {
function serializePathParameter(
name: string,
value: unknown,
parameter: UnknownRecord,
serializeValue: (value: unknown) => string = stringifyExampleValue,
): string {
const style = stringAt(parameter, "style") ?? "simple";
const explode = parameter.explode === true;
const values = Array.isArray(value)
? value.map(stringifyExampleValue)
? value.map(serializeValue)
: isRecord(value)
? Object.entries(value).flatMap(([key, entryValue]) => [
key,
stringifyExampleValue(entryValue),
serializeValue(key),
serializeValue(entryValue),
])
: [stringifyExampleValue(value)];
: [serializeValue(value)];
if (style === "label") {
if (explode && isRecord(value)) {
return `.${Object.entries(value)
.map(([key, entryValue]) => `${key}=${stringifyExampleValue(entryValue)}`)
.map(([key, entryValue]) => `${serializeValue(key)}=${serializeValue(entryValue)}`)
.join(".")}`;
}
return `.${values.join(explode ? "." : ",")}`;
}
if (style === "matrix") {
if (explode && Array.isArray(value)) {
return value.map((entryValue) => `;${name}=${stringifyExampleValue(entryValue)}`).join("");
return value.map((entryValue) => `;${name}=${serializeValue(entryValue)}`).join("");
}
if (explode && isRecord(value)) {
return Object.entries(value)
.map(([key, entryValue]) => `;${key}=${stringifyExampleValue(entryValue)}`)
.map(([key, entryValue]) => `;${serializeValue(key)}=${serializeValue(entryValue)}`)
.join("");
}
return `;${name}=${values.join(",")}`;
}
return serializeSimpleParameter(value, parameter);
return serializeSimpleParameter(value, parameter, serializeValue);
}
function serializeSimpleParameter(value: unknown, parameter: UnknownRecord): string {
if (Array.isArray(value)) return value.map(stringifyExampleValue).join(",");
function serializeSimpleParameter(
value: unknown,
parameter: UnknownRecord,
serializeValue: (value: unknown) => string = stringifyExampleValue,
): string {
if (Array.isArray(value)) return value.map(serializeValue).join(",");
if (isRecord(value)) {
const entries = Object.entries(value);
return parameter.explode === true
? entries.map(([key, entryValue]) => `${key}=${stringifyExampleValue(entryValue)}`).join(",")
: entries.flat().map(stringifyExampleValue).join(",");
? entries
.map(([key, entryValue]) => `${serializeValue(key)}=${serializeValue(entryValue)}`)
.join(",")
: entries.flat().map(serializeValue).join(",");
}
return stringifyExampleValue(value);
return serializeValue(value);
}
function parameterExample(parameter: UnknownRecord, importState: ImportState): string {
@@ -1521,10 +1601,12 @@ function buildOAuthVariablesByScheme(
function mergeHeaders(...headerGroups: HttpRequestHeader[][]): HttpRequestHeader[] {
const headers: HttpRequestHeader[] = [];
for (const header of headerGroups.flat()) {
const existing = headers.find((h) => h.name.toLowerCase() === header.name.toLowerCase());
if (existing == null) {
headers.push(header);
for (const group of headerGroups) {
const namesFromEarlierGroups = new Set(headers.map((header) => header.name.toLowerCase()));
for (const header of group) {
if (!namesFromEarlierGroups.has(header.name.toLowerCase())) {
headers.push(header);
}
}
}
return headers;