@scalar/workspace-store 0.40.2 → 0.40.3

package/dist/mutators/operation/body.js

@@ -1,62 +1,93 @@
-import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
-import { unpackProxyObject } from "../../helpers/unpack-proxy.js";
+import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { unpackProxyObject } from '../../helpers/unpack-proxy.js';
+/** Ensure the json that we need exists up to the example object in the request body */
 const findOrCreateRequestBodyExample = (document, contentType, meta) => {
-  const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
-  if (!operation) {
-    return null;
-  }
-  let requestBody = getResolvedRef(operation.requestBody);
-  if (!requestBody) {
-    operation.requestBody = {
-      content: {}
-    };
-    requestBody = getResolvedRef(operation.requestBody);
-  }
-  requestBody.content[contentType] ||= {};
-  requestBody.content[contentType].examples ||= {};
-  requestBody.content[contentType].examples[meta.exampleKey] ||= {};
-  const example = getResolvedRef(requestBody.content[contentType].examples?.[meta.exampleKey]);
-  return example ?? null;
+    const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
+    if (!operation) {
+        return null;
+    }
+    // Ensure that the request body exists
+    let requestBody = getResolvedRef(operation.requestBody);
+    if (!requestBody) {
+        operation.requestBody = {
+            content: {},
+        };
+        requestBody = getResolvedRef(operation.requestBody);
+    }
+    // Ensure that the example exists
+    requestBody.content[contentType] ||= {};
+    requestBody.content[contentType].examples ||= {};
+    requestBody.content[contentType].examples[meta.exampleKey] ||= {};
+    const example = getResolvedRef(requestBody.content[contentType].examples?.[meta.exampleKey]);
+    return example ?? null;
 };
-const updateOperationRequestBodyContentType = (document, { meta, payload }) => {
-  if (!document) {
-    return;
-  }
-  const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
-  if (!operation) {
-    return;
-  }
-  let requestBody = getResolvedRef(operation.requestBody);
-  if (!requestBody) {
-    operation.requestBody = {
-      content: {}
-    };
-    requestBody = getResolvedRef(operation.requestBody);
-  }
-  if (!requestBody["x-scalar-selected-content-type"]) {
-    requestBody["x-scalar-selected-content-type"] = {};
-  }
-  requestBody["x-scalar-selected-content-type"][meta.exampleKey] = payload.contentType;
+/**
+ * Sets the selected request-body content type for the current `exampleKey`.
+ * This stores the selection under `x-scalar-selected-content-type` on the
+ * resolved requestBody. Safely no-ops if the document or operation does not exist.
+ *
+ * Example:
+ * ```ts
+ * updateOperationRequestBodyContentType({
+ *   document,
+ *   meta: { method: 'post', path: '/upload', exampleKey: 'default' },
+ *   payload: { contentType: 'multipart/form-data' },
+ * })
+ * ```
+ */
+export const updateOperationRequestBodyContentType = (document, { meta, payload }) => {
+    if (!document) {
+        return;
+    }
+    const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
+    if (!operation) {
+        return;
+    }
+    let requestBody = getResolvedRef(operation.requestBody);
+    if (!requestBody) {
+        operation.requestBody = {
+            content: {},
+        };
+        requestBody = getResolvedRef(operation.requestBody);
+    }
+    if (!requestBody['x-scalar-selected-content-type']) {
+        requestBody['x-scalar-selected-content-type'] = {};
+    }
+    requestBody['x-scalar-selected-content-type'][meta.exampleKey] = payload.contentType;
 };
-const updateOperationRequestBodyExample = (document, { meta, payload, contentType }) => {
-  const example = findOrCreateRequestBodyExample(document, contentType, meta);
-  if (!example) {
-    console.error("Example not found", meta.exampleKey);
-    return;
-  }
-  example.value = payload;
+/**
+ * Creates or updates a concrete example value for a specific request-body
+ * `contentType` and `exampleKey`. Safely no-ops if the document or operation
+ * does not exist.
+ *
+ * Example:
+ * ```ts
+ * updateOperationRequestBodyExample({
+ *   document,
+ *   contentType: 'application/json',
+ *   meta: { method: 'post', path: '/users', exampleKey: 'default' },
+ *   payload: { value: JSON.stringify({ name: 'Ada' }) },
+ * })
+ * ```
+ */
+export const updateOperationRequestBodyExample = (document, { meta, payload, contentType }) => {
+    const example = findOrCreateRequestBodyExample(document, contentType, meta);
+    if (!example) {
+        console.error('Example not found', meta.exampleKey);
+        return;
+    }
+    example.value = payload;
 };
-const updateOperationRequestBodyFormValue = (document, { meta, payload, contentType }) => {
-  const example = findOrCreateRequestBodyExample(document, contentType, meta);
-  if (!example) {
-    console.error("Example not found", meta.exampleKey);
-    return;
-  }
-  example.value = unpackProxyObject(payload, { depth: 3 });
+/**
+ * Stores the form data for the request body example
+ *
+ * This needs special handling as we store it as an array of objects with a schema type of object
+ */
+export const updateOperationRequestBodyFormValue = (document, { meta, payload, contentType }) => {
+    const example = findOrCreateRequestBodyExample(document, contentType, meta);
+    if (!example) {
+        console.error('Example not found', meta.exampleKey);
+        return;
+    }
+    example.value = unpackProxyObject(payload, { depth: 3 });
 };
-export {
-  updateOperationRequestBodyContentType,
-  updateOperationRequestBodyExample,
-  updateOperationRequestBodyFormValue
-};
-//# sourceMappingURL=body.js.map

package/dist/mutators/operation/extensions.js

@@ -1,13 +1,21 @@
-import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
-import { mergeObjects } from "../../helpers/merge-object.js";
-const updateOperationExtension = (document, { meta, payload }) => {
-  const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
-  if (!operation) {
-    return;
-  }
-  mergeObjects(operation, payload);
+import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { mergeObjects } from '../../helpers/merge-object.js';
+/**
+ * Updates an extension of the operation
+ *
+ * @example
+ * ```ts
+ * updateOperationExtension({
+ *   document,
+ *   meta: { method: 'get', path: '/users' },
+ *   payload: { 'x-post-response': 'console.log(response)' },
+ * })
+ * ```
+ */
+export const updateOperationExtension = (document, { meta, payload }) => {
+    const operation = getResolvedRef(document?.paths?.[meta.path]?.[meta.method]);
+    if (!operation) {
+        return;
+    }
+    mergeObjects(operation, payload);
 };
-export {
-  updateOperationExtension
-};
-//# sourceMappingURL=extensions.js.map

package/dist/mutators/operation/helpers/fetch-request-to-har.js

@@ -1,117 +1,154 @@
-const fetchRequestToHar = async ({
-  request,
-  includeBody = true,
-  httpVersion = "HTTP/1.1",
-  // Default to 1MB
-  bodySizeLimit = 1048576
-}) => {
-  const url = new URL(request.url);
-  const queryString = Array.from(url.searchParams.entries()).map(([name, value]) => ({ name, value }));
-  const { headers, headersSize, cookies } = processRequestHeaders(request);
-  const mimeType = request.headers.get("content-type")?.split(";")[0]?.trim() ?? "text/plain";
-  const bodyDetails = await (async () => {
-    if (includeBody && request.body) {
-      const details = await processRequestBody(request.clone());
-      if (details.size <= bodySizeLimit) {
-        return details;
-      }
-    }
-    return { text: "", size: -1 };
-  })();
-  const harRequest = {
-    method: request.method,
-    url: request.url,
-    httpVersion,
-    headers,
-    cookies,
-    queryString,
-    headersSize,
-    bodySize: bodyDetails.size,
-    postData: "params" in bodyDetails ? {
-      mimeType,
-      params: bodyDetails.params
-    } : {
-      mimeType,
-      text: bodyDetails.text
-    }
-  };
-  return harRequest;
+/**
+ * Converts a Fetch API Request object to HAR (HTTP Archive) Request format.
+ *
+ * This function transforms a standard JavaScript Fetch API Request into the
+ * HAR format, which is useful for:
+ * - Recording HTTP requests for replay or analysis
+ * - Creating request fixtures from real API calls
+ * - Debugging and monitoring HTTP traffic
+ * - Storing request history in a standard format
+ * - Generating API documentation from real requests
+ *
+ * The conversion handles:
+ * - Request method and URL
+ * - Headers extraction (excluding sensitive headers if needed)
+ * - Query parameters extraction from URL
+ * - Cookie extraction from headers
+ * - Request body reading (with automatic cloning to preserve the original)
+ * - Content-Type detection and MIME type extraction
+ * - Size calculations for headers and body
+ * - Form data bodies are converted to params array
+ * - Other body types are read as text
+ *
+ * Note: The Fetch API does not expose the HTTP version, so it defaults to HTTP/1.1
+ * unless specified otherwise.
+ *
+ * @see https://w3c.github.io/web-performance/specs/HAR/Overview.html
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Request
+ *
+ * @example
+ * const request = new Request('https://api.example.com/users', {
+ *   method: 'POST',
+ *   headers: { 'Content-Type': 'application/json' },
+ *   body: JSON.stringify({ name: 'John' })
+ * })
+ * const harRequest = await fetchRequestToHar({ request })
+ * console.log(harRequest.method) // 'POST'
+ * console.log(harRequest.postData?.text) // '{"name":"John"}'
+ */
+export const fetchRequestToHar = async ({ request, includeBody = true, httpVersion = 'HTTP/1.1', 
+// Default to 1MB
+bodySizeLimit = 1048576, }) => {
+    // Extract query string from URL
+    const url = new URL(request.url);
+    // Extract the query strings from the URL
+    const queryString = Array.from(url.searchParams.entries()).map(([name, value]) => ({ name, value }));
+    // Extract the headers from the request
+    const { headers, headersSize, cookies } = processRequestHeaders(request);
+    // Extract the MIME type from the request headers
+    const mimeType = request.headers.get('content-type')?.split(';')[0]?.trim() ?? 'text/plain';
+    // Read the request body if requested
+    const bodyDetails = await (async () => {
+        if (includeBody && request.body) {
+            const details = await processRequestBody(request.clone());
+            if (details.size <= bodySizeLimit) {
+                return details;
+            }
+        }
+        return { text: '', size: -1 };
+    })();
+    // Create the HAR request object
+    const harRequest = {
+        method: request.method,
+        url: request.url,
+        httpVersion,
+        headers,
+        cookies,
+        queryString,
+        headersSize,
+        bodySize: bodyDetails.size,
+        postData: 'params' in bodyDetails
+            ? {
+                mimeType,
+                params: bodyDetails.params,
+            }
+            : {
+                mimeType,
+                text: bodyDetails.text,
+            },
+    };
+    return harRequest;
 };
 const processRequestBody = async (request) => {
-  const formData = await tryGetRequestFormData(request.clone());
-  if (formData) {
-    return Array.from(formData.entries()).reduce(
-      (acc, [name, value]) => {
-        if (value instanceof File) {
-          const fileName = `@${value.name}`;
-          acc.params.push({ name, value: fileName });
-          acc.size += fileName.length;
-          return acc;
-        }
-        acc.params.push({ name, value });
-        acc.size += value.length;
-        return acc;
-      },
-      { params: [], size: 0 }
-    );
-  }
-  if (request.headers.get("content-type")?.includes("application/octet-stream")) {
-    return { text: "", size: -1 };
-  }
-  const arrayBuffer = await request.arrayBuffer();
-  const size = arrayBuffer.byteLength;
-  return { size, text: new TextDecoder().decode(arrayBuffer) };
+    const formData = await tryGetRequestFormData(request.clone());
+    if (formData) {
+        return Array.from(formData.entries()).reduce((acc, [name, value]) => {
+            if (value instanceof File) {
+                const fileName = `@${value.name}`;
+                acc.params.push({ name, value: fileName });
+                acc.size += fileName.length;
+                return acc;
+            }
+            acc.params.push({ name, value });
+            acc.size += value.length;
+            return acc;
+        }, { params: [], size: 0 });
+    }
+    // Skip binary bodies
+    if (request.headers.get('content-type')?.includes('application/octet-stream')) {
+        return { text: '', size: -1 };
+    }
+    // Read the request body as text
+    const arrayBuffer = await request.arrayBuffer();
+    const size = arrayBuffer.byteLength;
+    return { size, text: new TextDecoder().decode(arrayBuffer) };
 };
 async function tryGetRequestFormData(request) {
-  if (typeof request.formData !== "function") {
-    return null;
-  }
-  if (request.bodyUsed) {
-    return null;
-  }
-  const contentType = request.headers.get("content-type") ?? "";
-  if (!contentType.includes("multipart/form-data") && !contentType.includes("application/x-www-form-urlencoded")) {
-    return null;
-  }
-  try {
-    return await request.formData();
-  } catch {
-    return null;
-  }
+    if (typeof request.formData !== 'function') {
+        return null;
+    }
+    if (request.bodyUsed) {
+        return null;
+    }
+    const contentType = request.headers.get('content-type') ?? '';
+    if (!contentType.includes('multipart/form-data') && !contentType.includes('application/x-www-form-urlencoded')) {
+        return null;
+    }
+    try {
+        return await request.formData();
+    }
+    catch {
+        return null;
+    }
 }
 const processRequestHeaders = (request) => {
-  return Array.from(request.headers.entries()).reduce(
-    (acc, [name, value]) => {
-      if (name.toLowerCase() === "cookie") {
-        const parsedCookies = parseCookieHeader(value);
-        acc.cookies.push(...parsedCookies.cookies);
-      } else {
-        acc.headers.push({ name, value });
-        acc.headersSize += name.length + 2 + value.length + 2;
-      }
-      return acc;
-    },
-    { headers: [], headersSize: 0, cookies: [] }
-  );
+    return Array.from(request.headers.entries()).reduce((acc, [name, value]) => {
+        if (name.toLowerCase() === 'cookie') {
+            const parsedCookies = parseCookieHeader(value);
+            acc.cookies.push(...parsedCookies.cookies);
+        }
+        else {
+            acc.headers.push({ name, value });
+            acc.headersSize += name.length + 2 + value.length + 2;
+        }
+        return acc;
+    }, { headers: [], headersSize: 0, cookies: [] });
 };
+/**
+ * Parses a Cookie header value into an array of cookie objects.
+ * Cookie format: name1=value1; name2=value2
+ */
 const parseCookieHeader = (cookieValue) => {
-  return cookieValue.split(";").reduce(
-    (acc, part) => {
-      const trimmedPart = part.trim();
-      const equalIndex = trimmedPart.indexOf("=");
-      if (equalIndex === -1) {
+    return cookieValue.split(';').reduce((acc, part) => {
+        const trimmedPart = part.trim();
+        const equalIndex = trimmedPart.indexOf('=');
+        if (equalIndex === -1) {
+            return acc;
+        }
+        const name = trimmedPart.substring(0, equalIndex).trim();
+        const value = trimmedPart.substring(equalIndex + 1).trim();
+        acc.cookies.push({ name, value });
+        acc.size += name.length + 2 + value.length + 2;
         return acc;
-      }
-      const name = trimmedPart.substring(0, equalIndex).trim();
-      const value = trimmedPart.substring(equalIndex + 1).trim();
-      acc.cookies.push({ name, value });
-      acc.size += name.length + 2 + value.length + 2;
-      return acc;
-    },
-    { cookies: [], size: 0 }
-  );
-};
-export {
-  fetchRequestToHar
+    }, { cookies: [], size: 0 });
 };
-//# sourceMappingURL=fetch-request-to-har.js.map