@scalar/workspace-store 0.40.2 → 0.40.4

package/dist/mutators/operation/helpers/sync-path-parameters.js

@@ -1,64 +1,113 @@
-import { findVariables } from "@scalar/helpers/regex/find-variables";
-import { unpackProxyObject } from "../../../helpers/unpack-proxy.js";
-import { getParameterPositions } from "../../../mutators/operation/helpers/get-parameter-position.js";
-const syncParametersForPathChange = (newPath, oldPath, existingParameters, resolve) => {
-  const oldPathParams = findVariables(oldPath, { includePath: true, includeEnv: false }).filter(
-    (v) => v !== void 0
-  );
-  const newPathParams = findVariables(newPath, { includePath: true, includeEnv: false }).filter(
-    (v) => v !== void 0
-  );
-  const oldPositions = getParameterPositions(oldPath, oldPathParams);
-  const newPositions = getParameterPositions(newPath, newPathParams);
-  const pathParameters = /* @__PURE__ */ Object.create(null);
-  for (const param of existingParameters) {
-    const resolved = resolve(param);
-    if (resolved?.in === "path") {
-      pathParameters[resolved.name] = param;
+import { findVariables } from '@scalar/helpers/regex/find-variables';
+import { unpackProxyObject } from '../../../helpers/unpack-proxy.js';
+import { getParameterPositions } from '../../../mutators/operation/helpers/get-parameter-position.js';
+/**
+ * Synchronizes path parameters when a path string changes.
+ *
+ * Behavior:
+ * - Preserves as much of the existing parameter configuration as possible when the set of path variables
+ *   changes due to a path update.
+ * - If a parameter with the same name exists in the new path, its configuration is preserved.
+ * - If a parameter appears at the same position as an old parameter (name changed), the old parameter's
+ *   configuration is kept and its name is updated in place via the resolved object.
+ * - Any newly required parameters (variables present in the new path but not in the old path) are added
+ *   as new minimal parameter objects.
+ * - Parameters that are no longer present in the new path are dropped.
+ * - Non-path parameters (query, header, etc.) from `existingParameters` are included unchanged in the result.
+ *
+ * ⚠️ This function mutates parameter objects in the `existingParameters` array in place when a path
+ *     parameter is renamed (i.e., reused objects may have their `name` updated via `resolve`).
+ *
+ * Returns the full new parameters array. Use the return value directly as the new operation.parameters.
+ *
+ * @param newPath - The path string after the change (e.g. '/users/{id}/posts/{postId}').
+ * @param oldPath - The path string before the change (e.g. '/users/{userId}').
+ * @param existingParameters - Current operation parameters (may be refs); path params are synced, others passed through.
+ * @param resolve - Callback to resolve a reference to a minimal parameter object (used for reading and mutating).
+ *
+ * @example
+ * ```ts
+ * // Given:
+ * // - oldPath: '/users/{userId}'
+ * // - newPath: '/users/{id}/posts/{postId}'
+ * // - existingParameters: [ { name: 'userId', in: 'path' } ]
+ *
+ * const newParams = syncParametersForPathChange(
+ *   '/users/{id}/posts/{postId}',
+ *   '/users/{userId}',
+ *   existingParameters,
+ *   (node) => resolveRef(node) // or unwrap $ref to get { name, in }
+ * )
+ *
+ * // existingParameters[0] was mutated in place (name -> 'id' via resolve).
+ * // newParams is the full array: [ renamed path param 'id', new path param 'postId' ]
+ *
+ * operation.parameters = newParams
+ * ```
+ */
+export const syncParametersForPathChange = (newPath, oldPath, existingParameters, resolve) => {
+    // Extract path parameter names from both paths
+    const oldPathParams = findVariables(oldPath, { includePath: true, includeEnv: false }).filter((v) => v !== undefined);
+    const newPathParams = findVariables(newPath, { includePath: true, includeEnv: false }).filter((v) => v !== undefined);
+    const oldPositions = getParameterPositions(oldPath, oldPathParams);
+    const newPositions = getParameterPositions(newPath, newPathParams);
+    // Keep a map of path parameters by name for quick lookup (references unchanged objects)
+    const pathParameters = Object.create(null);
+    // Populate the map with the existing path parameters
+    for (const param of existingParameters) {
+        const resolved = resolve(param);
+        if (resolved?.in === 'path') {
+            pathParameters[resolved.name] = param;
+        }
     }
-  }
-  const usedOldParams = /* @__PURE__ */ new Set();
-  const usedPathParameters = /* @__PURE__ */ new Set();
-  const newPathParameters = [];
-  for (const newParamName of newPathParams) {
-    if (pathParameters[newParamName]) {
-      usedOldParams.add(newParamName);
-      usedPathParameters.add(pathParameters[newParamName]);
-      continue;
+    // Keep track of old parameters that we have already used
+    const usedOldParams = new Set();
+    // Keep track of path parameter objects we keep after sync
+    const usedPathParameters = new Set();
+    // These are only truly new parameters created in this run
+    const newPathParameters = [];
+    for (const newParamName of newPathParams) {
+        // Case 1: Parameter with same name exists - preserve its config, and mark as used
+        if (pathParameters[newParamName]) {
+            usedOldParams.add(newParamName);
+            usedPathParameters.add(pathParameters[newParamName]);
+            continue;
+        }
+        // Case 2: Check for parameter at same position (likely a rename)
+        const newParamPosition = newPositions[newParamName];
+        const oldParamAtPosition = oldPathParams.find((oldParam) => oldPositions[oldParam] === newParamPosition && !usedOldParams.has(oldParam));
+        // If found, mutate old parameter's name and mark as used
+        if (oldParamAtPosition && pathParameters[oldParamAtPosition] !== undefined) {
+            const oldParam = pathParameters[oldParamAtPosition];
+            if (oldParam) {
+                // Change its name in-place
+                resolve(oldParam).name = newParamName;
+                usedPathParameters.add(oldParam);
+            }
+            usedOldParams.add(oldParamAtPosition);
+            continue;
+        }
+        // Case 3: New parameter - create a new minimal parameter object
+        newPathParameters.push({
+            in: 'path',
+            name: newParamName,
+        });
     }
-    const newParamPosition = newPositions[newParamName];
-    const oldParamAtPosition = oldPathParams.find(
-      (oldParam) => oldPositions[oldParam] === newParamPosition && !usedOldParams.has(oldParam)
-    );
-    if (oldParamAtPosition && pathParameters[oldParamAtPosition] !== void 0) {
-      const oldParam = pathParameters[oldParamAtPosition];
-      if (oldParam) {
-        resolve(oldParam).name = newParamName;
-        usedPathParameters.add(oldParam);
-      }
-      usedOldParams.add(oldParamAtPosition);
-      continue;
+    const result = [];
+    // Push the raw parameters to enure we are not pushing proxies
+    for (const param of existingParameters) {
+        const resolved = resolve(param);
+        const rawParam = unpackProxyObject(param, { depth: 1 });
+        if (resolved?.in !== 'path') {
+            result.push(rawParam);
+            continue;
+        }
+        // Only adda the parameter if HAS not been used in the old path
+        // This we we ensure to drop parameters that are no longer present in the new path
+        if (usedPathParameters.has(param)) {
+            result.push(rawParam);
+        }
     }
-    newPathParameters.push({
-      in: "path",
-      name: newParamName
-    });
-  }
-  const result = [];
-  for (const param of existingParameters) {
-    const resolved = resolve(param);
-    const rawParam = unpackProxyObject(param, { depth: 1 });
-    if (resolved?.in !== "path") {
-      result.push(rawParam);
-      continue;
-    }
-    if (usedPathParameters.has(param)) {
-      result.push(rawParam);
-    }
-  }
-  return result.concat(newPathParameters);
-};
-export {
-  syncParametersForPathChange
+    // Only return newly created parameter objects—call site should combine with possibly-mutated originals
+    return result.concat(newPathParameters);
 };
-//# sourceMappingURL=sync-path-parameters.js.map

package/dist/mutators/operation/history.js

@@ -1,68 +1,64 @@
-import { getResolvedRef } from "../../helpers/get-resolved-ref.js";
-import { isContentTypeParameterObject } from "../../schemas/v3.1/strict/type-guards.js";
-import { fetchRequestToHar } from "./helpers/fetch-request-to-har.js";
-import { fetchResponseToHar } from "./helpers/fetch-response-to-har.js";
-import { harToOperation } from "./helpers/har-to-operation.js";
-const addResponseToHistory = async (store, document, { payload, meta }) => {
-  const documentName = document?.["x-scalar-navigation"]?.name;
-  if (!document || !documentName || !payload) {
-    return;
-  }
-  const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
-  if (!operation) {
-    return;
-  }
-  const operationParameters = operation.parameters ?? [];
-  const variables = operationParameters.reduce((acc, param) => {
-    const resolvedParam = getResolvedRef(param);
-    if (isContentTypeParameterObject(resolvedParam)) {
-      return acc;
+import { getResolvedRef } from '../../helpers/get-resolved-ref.js';
+import { isContentTypeParameterObject } from '../../schemas/v3.1/strict/type-guards.js';
+import { fetchRequestToHar } from './helpers/fetch-request-to-har.js';
+import { fetchResponseToHar } from './helpers/fetch-response-to-har.js';
+import { harToOperation } from './helpers/har-to-operation.js';
+export const addResponseToHistory = async (store, document, { payload, meta }) => {
+    const documentName = document?.['x-scalar-navigation']?.name;
+    if (!document || !documentName || !payload) {
+        return;
     }
-    if (resolvedParam.in === "path") {
-      acc[resolvedParam.name] = getResolvedRef(resolvedParam.examples?.[meta.exampleKey])?.value ?? "";
+    const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
+    if (!operation) {
+        return;
     }
-    return acc;
-  }, {});
-  const requestHar = await fetchRequestToHar({ request: payload.request });
-  const responseHar = await fetchResponseToHar({ response: payload.response });
-  store?.history.addHistory(documentName, meta.path, meta.method, {
-    response: responseHar,
-    request: requestHar,
-    meta: {
-      example: meta.exampleKey
-    },
-    time: payload.duration,
-    timestamp: payload.timestamp,
-    requestMetadata: {
-      variables
-    }
-  });
-};
-const reloadOperationHistory = (store, document, { meta, index, callback }) => {
-  if (!document) {
-    console.error("Document not found", meta.path, meta.method);
-    return;
-  }
-  const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
-  if (!operation) {
-    console.error("Operation not found", meta.path, meta.method);
-    return;
-  }
-  const historyItem = store?.history.getHistory(document["x-scalar-navigation"]?.name ?? "", meta.path, meta.method)?.[index];
-  if (!historyItem) {
-    console.error("History item not found", index);
-    return;
-  }
-  harToOperation({
-    harRequest: historyItem.request,
-    exampleKey: "draft",
-    baseOperation: operation,
-    pathVariables: historyItem.requestMetadata.variables
-  });
-  callback("success");
+    const operationParameters = operation.parameters ?? [];
+    // Get all the variables from the operation parameters
+    const variables = operationParameters.reduce((acc, param) => {
+        const resolvedParam = getResolvedRef(param);
+        if (isContentTypeParameterObject(resolvedParam)) {
+            return acc;
+        }
+        if (resolvedParam.in === 'path') {
+            acc[resolvedParam.name] = getResolvedRef(resolvedParam.examples?.[meta.exampleKey])?.value ?? '';
+        }
+        return acc;
+    }, {});
+    const requestHar = await fetchRequestToHar({ request: payload.request });
+    const responseHar = await fetchResponseToHar({ response: payload.response });
+    store?.history.addHistory(documentName, meta.path, meta.method, {
+        response: responseHar,
+        request: requestHar,
+        meta: {
+            example: meta.exampleKey,
+        },
+        time: payload.duration,
+        timestamp: payload.timestamp,
+        requestMetadata: {
+            variables,
+        },
+    });
 };
-export {
-  addResponseToHistory,
-  reloadOperationHistory
+export const reloadOperationHistory = (store, document, { meta, index, callback }) => {
+    if (!document) {
+        console.error('Document not found', meta.path, meta.method);
+        return;
+    }
+    const operation = getResolvedRef(document.paths?.[meta.path]?.[meta.method]);
+    if (!operation) {
+        console.error('Operation not found', meta.path, meta.method);
+        return;
+    }
+    const historyItem = store?.history.getHistory(document['x-scalar-navigation']?.name ?? '', meta.path, meta.method)?.[index];
+    if (!historyItem) {
+        console.error('History item not found', index);
+        return;
+    }
+    harToOperation({
+        harRequest: historyItem.request,
+        exampleKey: 'draft',
+        baseOperation: operation,
+        pathVariables: historyItem.requestMetadata.variables,
+    });
+    callback('success');
 };
-//# sourceMappingURL=history.js.map

package/dist/mutators/operation/index.js

@@ -1,50 +1,26 @@
-import {
-  updateOperationRequestBodyContentType,
-  updateOperationRequestBodyExample,
-  updateOperationRequestBodyFormValue
-} from "../../mutators/operation/body.js";
-import { updateOperationExtension } from "../../mutators/operation/extensions.js";
-import { addResponseToHistory, reloadOperationHistory } from "../../mutators/operation/history.js";
-import {
-  createOperation,
-  createOperationDraftExample,
-  deleteOperation,
-  deleteOperationExample,
-  renameOperationExample,
-  updateOperationMeta,
-  updateOperationPathMethod
-} from "../../mutators/operation/operation.js";
-import {
-  deleteAllOperationParameters,
-  deleteOperationParameter,
-  updateOperationExtraParameters,
-  upsertOperationParameter
-} from "../../mutators/operation/parameters.js";
-const operationMutatorsFactory = ({
-  document,
-  store
-}) => {
-  return {
-    createOperation: (payload) => createOperation(store, payload),
-    updateOperationMeta: (payload) => updateOperationMeta(store, document, payload),
-    updateOperationPathMethod: (payload) => updateOperationPathMethod(document, store, payload),
-    deleteOperation: (payload) => deleteOperation(store, payload),
-    createOperationDraftExample: (payload) => createOperationDraftExample(store, payload),
-    deleteOperationExample: (payload) => deleteOperationExample(store, payload),
-    renameOperationExample: (payload) => renameOperationExample(store, payload),
-    updateOperationExtension: (payload) => updateOperationExtension(document, payload),
-    updateOperationExtraParameters: (payload) => updateOperationExtraParameters(document, payload),
-    upsertOperationParameter: (payload) => upsertOperationParameter(document, payload),
-    deleteOperationParameter: (payload) => deleteOperationParameter(document, payload),
-    deleteAllOperationParameters: (payload) => deleteAllOperationParameters(document, payload),
-    updateOperationRequestBodyContentType: (payload) => updateOperationRequestBodyContentType(document, payload),
-    updateOperationRequestBodyExample: (payload) => updateOperationRequestBodyExample(document, payload),
-    updateOperationRequestBodyFormValue: (payload) => updateOperationRequestBodyFormValue(document, payload),
-    addResponseToHistory: (payload) => addResponseToHistory(store, document, payload),
-    reloadOperationHistory: (payload) => reloadOperationHistory(store, document, payload)
-  };
+import { updateOperationRequestBodyContentType, updateOperationRequestBodyExample, updateOperationRequestBodyFormValue, } from '../../mutators/operation/body.js';
+import { updateOperationExtension } from '../../mutators/operation/extensions.js';
+import { addResponseToHistory, reloadOperationHistory } from '../../mutators/operation/history.js';
+import { createOperation, createOperationDraftExample, deleteOperation, deleteOperationExample, renameOperationExample, updateOperationMeta, updateOperationPathMethod, } from '../../mutators/operation/operation.js';
+import { deleteAllOperationParameters, deleteOperationParameter, updateOperationExtraParameters, upsertOperationParameter, } from '../../mutators/operation/parameters.js';
+export const operationMutatorsFactory = ({ document, store, }) => {
+    return {
+        createOperation: (payload) => createOperation(store, payload),
+        updateOperationMeta: (payload) => updateOperationMeta(store, document, payload),
+        updateOperationPathMethod: (payload) => updateOperationPathMethod(document, store, payload),
+        deleteOperation: (payload) => deleteOperation(store, payload),
+        createOperationDraftExample: (payload) => createOperationDraftExample(store, payload),
+        deleteOperationExample: (payload) => deleteOperationExample(store, payload),
+        renameOperationExample: (payload) => renameOperationExample(store, payload),
+        updateOperationExtension: (payload) => updateOperationExtension(document, payload),
+        updateOperationExtraParameters: (payload) => updateOperationExtraParameters(document, payload),
+        upsertOperationParameter: (payload) => upsertOperationParameter(document, payload),
+        deleteOperationParameter: (payload) => deleteOperationParameter(document, payload),
+        deleteAllOperationParameters: (payload) => deleteAllOperationParameters(document, payload),
+        updateOperationRequestBodyContentType: (payload) => updateOperationRequestBodyContentType(document, payload),
+        updateOperationRequestBodyExample: (payload) => updateOperationRequestBodyExample(document, payload),
+        updateOperationRequestBodyFormValue: (payload) => updateOperationRequestBodyFormValue(document, payload),
+        addResponseToHistory: (payload) => addResponseToHistory(store, document, payload),
+        reloadOperationHistory: (payload) => reloadOperationHistory(store, document, payload),
+    };
 };
-export {
-  operationMutatorsFactory
-};
-//# sourceMappingURL=index.js.map