@scalar/workspace-store 0.40.2 → 0.40.4

package/dist/mutators/cookie.js

@@ -1,46 +1,63 @@
-import { xScalarCookieSchema } from "../schemas/extensions/general/x-scalar-cookies.js";
-import { coerceValue } from "../schemas/typebox-coerce.js";
-const upsertCookie = (collection, { payload, index }) => {
-  if (!collection) {
-    return;
-  }
-  if (!collection["x-scalar-cookies"]) {
-    collection["x-scalar-cookies"] = [];
-  }
-  if (index !== void 0) {
-    if (index < 0 || index >= collection["x-scalar-cookies"].length) {
-      return;
+import { xScalarCookieSchema } from '../schemas/extensions/general/x-scalar-cookies.js';
+import { coerceValue } from '../schemas/typebox-coerce.js';
+/**
+ * Adds OR updates a cookie to the document or workspace.
+ *
+ * @param document - current document if available
+ * @param workspace - current workspace if available
+ * @param payload - The cookie configuration to add or update
+ * @param index - Optional index for updating an existing cookie
+ * @param collectionType - Whether this is for a document or workspace
+ * @returns the parsed cookie that was added or updated or undefined if the collection is not found
+ */
+export const upsertCookie = (collection, { payload, index }) => {
+    if (!collection) {
+        return;
     }
-    const parsed2 = coerceValue(xScalarCookieSchema, {
-      ...collection["x-scalar-cookies"][index],
-      ...payload
-    });
-    collection["x-scalar-cookies"][index] = parsed2;
-    return parsed2;
-  }
-  const parsed = coerceValue(xScalarCookieSchema, payload);
-  collection["x-scalar-cookies"].push(parsed);
-  return parsed;
-};
-const deleteCookie = (collection, { index }) => {
-  if (!collection || !collection["x-scalar-cookies"]) {
-    return false;
-  }
-  if (index < 0 || index >= collection["x-scalar-cookies"].length) {
-    return false;
-  }
-  collection["x-scalar-cookies"].splice(index, 1);
-  return true;
+    if (!collection['x-scalar-cookies']) {
+        collection['x-scalar-cookies'] = [];
+    }
+    if (index !== undefined) {
+        // Update existing cookie at index
+        if (index < 0 || index >= collection['x-scalar-cookies'].length) {
+            return;
+        }
+        // Ensure we parse the payload but keep the existing cookie data
+        const parsed = coerceValue(xScalarCookieSchema, {
+            ...collection['x-scalar-cookies'][index],
+            ...payload,
+        });
+        // Update
+        collection['x-scalar-cookies'][index] = parsed;
+        return parsed;
+    }
+    // Add new cookie
+    const parsed = coerceValue(xScalarCookieSchema, payload);
+    collection['x-scalar-cookies'].push(parsed);
+    return parsed;
 };
-const cookieMutatorsFactory = ({ collection }) => {
-  return {
-    upsertCookie: (payload) => upsertCookie(collection, payload),
-    deleteCookie: (payload) => deleteCookie(collection, payload)
-  };
+/**
+ * Deletes a cookie from the document or workspace by index.
+ *
+ * @param document - current document if available
+ * @param workspace - current workspace if available
+ * @param index - Index of the cookie to delete
+ * @param collectionType - Whether this is for a document or workspace
+ * @returns true if the cookie was deleted, false otherwise
+ */
+export const deleteCookie = (collection, { index }) => {
+    if (!collection || !collection['x-scalar-cookies']) {
+        return false;
+    }
+    if (index < 0 || index >= collection['x-scalar-cookies'].length) {
+        return false;
+    }
+    collection['x-scalar-cookies'].splice(index, 1);
+    return true;
 };
-export {
-  cookieMutatorsFactory,
-  deleteCookie,
-  upsertCookie
+export const cookieMutatorsFactory = ({ collection }) => {
+    return {
+        upsertCookie: (payload) => upsertCookie(collection, payload),
+        deleteCookie: (payload) => deleteCookie(collection, payload),
+    };
 };
-//# sourceMappingURL=cookie.js.map

package/dist/mutators/document.js

@@ -1,73 +1,111 @@
-import { mergeObjects } from "../helpers/merge-object.js";
-const updateWatchMode = (document, watchMode) => {
-  if (!document) {
-    return;
-  }
-  document["x-scalar-watch-mode"] = watchMode;
-};
-const updateDocumentInfo = (document, payload) => {
-  if (!document) {
-    return;
-  }
-  mergeObjects(document.info, payload);
-  if (document["x-scalar-navigation"] && payload.title !== void 0) {
-    document["x-scalar-navigation"].title = payload.title?.trim() || "Untitled Document";
-  }
+import { mergeObjects } from '../helpers/merge-object.js';
+/**
+ * Updates the "watch mode" state of the given document.
+ *
+ * @param document WorkspaceDocument or null – The document to modify.
+ * @param watchMode boolean – True enables watch mode, false disables it.
+ *
+ * If document is null, does nothing.
+ */
+export const updateWatchMode = (document, watchMode) => {
+    if (!document) {
+        return;
+    }
+    // Set (or unset) the x-scalar-watch-mode property on the document
+    document['x-scalar-watch-mode'] = watchMode;
 };
-const updateDocumentIcon = (document, icon) => {
-  if (!document || !document["x-scalar-navigation"]) {
-    return;
-  }
-  document["x-scalar-icon"] = icon;
-  document["x-scalar-navigation"].icon = icon;
+/**
+ * Updates the document's info object (typically, title, description, version, etc.).
+ *
+ * Uses a shallow merge: only properties present in payload will be overwritten or added.
+ *
+ * @param document WorkspaceDocument | null – The document whose info should be updated.
+ * @param payload DocumentEvents['document:update:info'] – Partial info fields to update/merge.
+ *
+ * If document is null, does nothing.
+ */
+export const updateDocumentInfo = (document, payload) => {
+    if (!document) {
+        return;
+    }
+    // Merge the given payload into the document's info object
+    mergeObjects(document.info, payload);
+    // Update the document title if it is present and the navigation object is present
+    // We do this because we don't want to rebuild the entire navigation object if only the title is changed
+    // Normalize like traverseDocument: trim and treat whitespace-only as empty so we show "Untitled Document"
+    if (document['x-scalar-navigation'] && payload.title !== undefined) {
+        document['x-scalar-navigation'].title = payload.title?.trim() || 'Untitled Document';
+    }
 };
-const createEmptyDocument = async (store, payload) => {
-  if (!store) {
-    return;
-  }
-  if (store.workspace.documents[payload.name]) {
-    payload.callback?.(false);
-    return;
-  }
-  await store.addDocument({
-    name: payload.name,
-    document: {
-      openapi: "3.1.0",
-      info: { title: payload.name, version: "1.0.0" },
-      paths: {
-        "/": {
-          get: {}
-        }
-      },
-      "x-scalar-icon": payload.icon
+/**
+ * Update the document icon and also update the corresponding sidebar entry
+ *
+ * Does not perform a sidebar rebuild for performance benefit
+ */
+export const updateDocumentIcon = (document, icon) => {
+    if (!document || !document['x-scalar-navigation']) {
+        return;
     }
-  });
-  payload.callback?.(true);
+    // Update the document icon
+    document['x-scalar-icon'] = icon;
+    // Update the sidebar document icon
+    document['x-scalar-navigation'].icon = icon;
 };
-const deleteDocument = (store, payload) => {
-  if (!store) {
-    return;
-  }
-  store.deleteDocument(payload.name);
+/**
+ * Creates an empty OpenAPI document and adds it to the workspace.
+ *
+ * - If the store is null, this is a no-op.
+ * - The document name must be unique; if already present, callback is called with `false`.
+ * - On success, a new OpenAPI 3.1.0 document is added with a basic path and info.
+ * - Callback is called with `true` if document is created.
+ *
+ * @param store WorkspaceStore | null – The workspace store to add the document to.
+ * @param payload DocumentEvents['document:create:empty-document'] – Contains name, icon, and callback.
+ */
+export const createEmptyDocument = async (store, payload) => {
+    if (!store) {
+        return;
+    }
+    // Check if the document already exists by name for uniqueness
+    if (store.workspace.documents[payload.name]) {
+        // Document name already exists, call callback with false
+        payload.callback?.(false);
+        return;
+    }
+    // Add a new empty OpenAPI 3.1.0 document with minimal info and icon
+    await store.addDocument({
+        name: payload.name,
+        document: {
+            openapi: '3.1.0',
+            info: { title: payload.name, version: '1.0.0' },
+            paths: {
+                '/': {
+                    get: {},
+                },
+            },
+            'x-scalar-icon': payload.icon,
+        },
+    });
+    // Notify success via callback
+    payload.callback?.(true);
 };
-const documentMutatorsFactory = ({
-  document,
-  store
-}) => {
-  return {
-    updateDocumentInfo: (payload) => updateDocumentInfo(document, payload),
-    updateWatchMode: (payload) => updateWatchMode(document, payload),
-    updateDocumentIcon: (payload) => updateDocumentIcon(document, payload),
-    createEmptyDocument: (payload) => createEmptyDocument(store, payload),
-    deleteDocument: (payload) => deleteDocument(store, payload)
-  };
+/**
+ * Deletes a document from the workspace by its name.
+ *
+ * Safely no-ops if the store is null.
+ */
+export const deleteDocument = (store, payload) => {
+    if (!store) {
+        return;
+    }
+    store.deleteDocument(payload.name);
 };
-export {
-  createEmptyDocument,
-  deleteDocument,
-  documentMutatorsFactory,
-  updateDocumentIcon,
-  updateDocumentInfo,
-  updateWatchMode
+export const documentMutatorsFactory = ({ document, store, }) => {
+    return {
+        updateDocumentInfo: (payload) => updateDocumentInfo(document, payload),
+        updateWatchMode: (payload) => updateWatchMode(document, payload),
+        updateDocumentIcon: (payload) => updateDocumentIcon(document, payload),
+        createEmptyDocument: (payload) => createEmptyDocument(store, payload),
+        deleteDocument: (payload) => deleteDocument(store, payload),
+    };
 };
-//# sourceMappingURL=document.js.map

package/dist/mutators/environment.js

@@ -1,79 +1,104 @@
-import { unpackProxyObject } from "../helpers/unpack-proxy.js";
-import {
-  xScalarEnvVarSchema,
-  xScalarEnvironmentSchema
-} from "../schemas/extensions/document/x-scalar-environments.js";
-import { coerceValue } from "../schemas/typebox-coerce.js";
-const upsertEnvironment = (workspace, collection, { environmentName, payload, oldEnvironmentName }) => {
-  if (!collection || !workspace) {
-    return;
-  }
-  if (!collection["x-scalar-environments"]) {
-    collection["x-scalar-environments"] = {};
-  }
-  const isNewEnvironment = !collection["x-scalar-environments"][oldEnvironmentName ?? environmentName];
-  const parsed = coerceValue(xScalarEnvironmentSchema, {
-    ...unpackProxyObject(collection["x-scalar-environments"][oldEnvironmentName ?? environmentName], { depth: 1 }),
-    ...payload
-  });
-  collection["x-scalar-environments"][environmentName] = parsed;
-  if (oldEnvironmentName && oldEnvironmentName !== environmentName) {
-    delete collection["x-scalar-environments"][oldEnvironmentName];
-    if (workspace["x-scalar-active-environment"] === oldEnvironmentName) {
-      workspace["x-scalar-active-environment"] = environmentName;
+import { unpackProxyObject } from '../helpers/unpack-proxy.js';
+import { xScalarEnvVarSchema, xScalarEnvironmentSchema, } from '../schemas/extensions/document/x-scalar-environments.js';
+import { coerceValue } from '../schemas/typebox-coerce.js';
+/**
+ * Adds OR updates an environment to the document or workspace.
+ *
+ * @param document - current document if available
+ * @param workspace - current workspace if available
+ * @param environmentName - Name of the environment to add
+ * @param payload - The environment configuration to add
+ * @param oldEnvironmentName - Only needed when renaming the environment
+ * @returns the parsed environment that was added or updated or undefined if the collection is not found
+ */
+export const upsertEnvironment = (workspace, collection, { environmentName, payload, oldEnvironmentName }) => {
+    /** Discriminating between document and workspace */
+    if (!collection || !workspace) {
+        return;
     }
-  }
-  if (isNewEnvironment) {
-    workspace["x-scalar-active-environment"] = environmentName;
-  }
-  return parsed;
-};
-const deleteEnvironment = (workspace, collection, { environmentName }) => {
-  if (!collection || !workspace) {
-    return;
-  }
-  delete collection["x-scalar-environments"]?.[environmentName];
+    if (!collection['x-scalar-environments']) {
+        collection['x-scalar-environments'] = {};
+    }
+    // Check if this is a new environment before we create it
+    const isNewEnvironment = !collection['x-scalar-environments'][oldEnvironmentName ?? environmentName];
+    // Ensure we parse the payload but keep the old variables
+    const parsed = coerceValue(xScalarEnvironmentSchema, {
+        ...unpackProxyObject(collection['x-scalar-environments'][oldEnvironmentName ?? environmentName], { depth: 1 }),
+        ...payload,
+    });
+    collection['x-scalar-environments'][environmentName] = parsed;
+    // If we are renaming the environment, we need to delete the old one
+    if (oldEnvironmentName && oldEnvironmentName !== environmentName) {
+        delete collection['x-scalar-environments'][oldEnvironmentName];
+        // If the old environment was active, we need to set the new environment as active
+        if (workspace['x-scalar-active-environment'] === oldEnvironmentName) {
+            workspace['x-scalar-active-environment'] = environmentName;
+        }
+    }
+    // Set the newly created workspace environment as active
+    if (isNewEnvironment) {
+        workspace['x-scalar-active-environment'] = environmentName;
+    }
+    return parsed;
 };
-const upsertEnvironmentVariable = (collection, { environmentName, variable, index }) => {
-  if (!collection?.["x-scalar-environments"]?.[environmentName]) {
-    console.error("Environment not found", environmentName);
-    return;
-  }
-  const parsed = coerceValue(xScalarEnvVarSchema, variable);
-  if (index !== void 0) {
-    if (parsed.name === "") {
-      collection["x-scalar-environments"][environmentName].variables.splice(index, 1);
-      return;
+/**
+ * Deletes an environment from the given collection and handles active environment state.
+ *
+ * @param workspace - The workspace object, or null if unavailable.
+ * @param collection - The workspace document or workspace object, or null if unavailable.
+ * @param environmentName - The name of the environment to delete.
+ */
+export const deleteEnvironment = (workspace, collection, { environmentName }) => {
+    if (!collection || !workspace) {
+        return;
     }
-    collection["x-scalar-environments"][environmentName].variables[index] = parsed;
-  } else {
-    collection["x-scalar-environments"][environmentName].variables.push(parsed);
-  }
-  return parsed;
+    // Trigegr the change event for the active environment
+    delete collection['x-scalar-environments']?.[environmentName];
 };
-const deleteEnvironmentVariable = (collection, { environmentName, index }) => {
-  if (!collection?.["x-scalar-environments"]?.[environmentName]) {
-    console.error("Environment not found", environmentName);
-    return;
-  }
-  collection["x-scalar-environments"]?.[environmentName]?.variables?.splice(index, 1);
+/**
+ * Adds OR updates an environment variable to the document or workspace.
+ *
+ * @param collection - Workspace OR document
+ * @param environmentName - Name of the environment to add the variable to
+ * @param variableName - Name of the variable to add
+ * @param value - Value of the variable to add
+ * @returns the parsed variable that was added or updated or undefined if the collection is not found
+ */
+export const upsertEnvironmentVariable = (collection, { environmentName, variable, index }) => {
+    // The environment should exist by now if we are upserting a variable
+    if (!collection?.['x-scalar-environments']?.[environmentName]) {
+        console.error('Environment not found', environmentName);
+        return;
+    }
+    // Ensure we parse the variable for type safety
+    const parsed = coerceValue(xScalarEnvVarSchema, variable);
+    if (index !== undefined) {
+        // Delete the row if the name is empty
+        if (parsed.name === '') {
+            collection['x-scalar-environments'][environmentName].variables.splice(index, 1);
+            return;
+        }
+        // Update
+        collection['x-scalar-environments'][environmentName].variables[index] = parsed;
+    }
+    // Add
+    else {
+        collection['x-scalar-environments'][environmentName].variables.push(parsed);
+    }
+    return parsed;
 };
-const environmentMutatorsFactory = ({
-  workspace,
-  collection
-}) => {
-  return {
-    upsertEnvironment: (payload) => upsertEnvironment(workspace, collection, payload),
-    deleteEnvironment: (payload) => deleteEnvironment(workspace, collection, payload),
-    upsertEnvironmentVariable: (payload) => upsertEnvironmentVariable(collection, payload),
-    deleteEnvironmentVariable: (payload) => deleteEnvironmentVariable(collection, payload)
-  };
+export const deleteEnvironmentVariable = (collection, { environmentName, index }) => {
+    if (!collection?.['x-scalar-environments']?.[environmentName]) {
+        console.error('Environment not found', environmentName);
+        return;
+    }
+    collection['x-scalar-environments']?.[environmentName]?.variables?.splice(index, 1);
 };
-export {
-  deleteEnvironment,
-  deleteEnvironmentVariable,
-  environmentMutatorsFactory,
-  upsertEnvironment,
-  upsertEnvironmentVariable
+export const environmentMutatorsFactory = ({ workspace, collection, }) => {
+    return {
+        upsertEnvironment: (payload) => upsertEnvironment(workspace, collection, payload),
+        deleteEnvironment: (payload) => deleteEnvironment(workspace, collection, payload),
+        upsertEnvironmentVariable: (payload) => upsertEnvironmentVariable(collection, payload),
+        deleteEnvironmentVariable: (payload) => deleteEnvironmentVariable(collection, payload),
+    };
 };
-//# sourceMappingURL=environment.js.map

package/dist/mutators/helpers.js

@@ -1,14 +1,10 @@
-const getDocument = (store, documentName) => {
-  if (!store) {
-    return null;
-  }
-  const document = store.workspace.documents[documentName];
-  if (!document) {
-    return null;
-  }
-  return document;
+export const getDocument = (store, documentName) => {
+    if (!store) {
+        return null;
+    }
+    const document = store.workspace.documents[documentName];
+    if (!document) {
+        return null;
+    }
+    return document;
 };
-export {
-  getDocument
-};
-//# sourceMappingURL=helpers.js.map

package/dist/mutators/index.js

@@ -1,55 +1,68 @@
-import { authMutatorsFactory } from "../mutators/auth.js";
-import { cookieMutatorsFactory } from "../mutators/cookie.js";
-import { documentMutatorsFactory } from "../mutators/document.js";
-import { environmentMutatorsFactory } from "../mutators/environment.js";
-import { getDocument } from "../mutators/helpers.js";
-import { operationMutatorsFactory } from "../mutators/operation/index.js";
-import { serverMutatorsFactory } from "../mutators/server.js";
-import { tabsMutatorsFactory } from "../mutators/tabs.js";
-import { tagMutatorsFactory } from "../mutators/tag.js";
-import { workspaceMutatorsFactory } from "../mutators/workspace.js";
-function generateClientMutators(store) {
-  const documentMutators = (document) => {
-    return {
-      auth: authMutatorsFactory({ store, document }),
-      cookie: cookieMutatorsFactory({ collection: document }),
-      document: documentMutatorsFactory({ document, store }),
-      operation: operationMutatorsFactory({ document, store }),
-      server: serverMutatorsFactory({ document }),
-      tag: tagMutatorsFactory({ store }),
-      environment: environmentMutatorsFactory({ workspace: store?.workspace ?? null, collection: document })
-    };
-  };
-  const workspaceMutators = () => {
-    return {
-      cookie: cookieMutatorsFactory({ collection: store?.workspace ?? null }),
-      tabs: tabsMutatorsFactory({ workspace: store?.workspace ?? null }),
-      workspace: workspaceMutatorsFactory({ workspace: store?.workspace ?? null }),
-      environment: environmentMutatorsFactory({
-        workspace: store?.workspace ?? null,
-        collection: store?.workspace ?? null
-      })
-    };
-  };
-  return {
+import { authMutatorsFactory } from '../mutators/auth.js';
+import { cookieMutatorsFactory } from '../mutators/cookie.js';
+import { documentMutatorsFactory } from '../mutators/document.js';
+import { environmentMutatorsFactory } from '../mutators/environment.js';
+import { getDocument } from '../mutators/helpers.js';
+import { operationMutatorsFactory } from '../mutators/operation/index.js';
+import { serverMutatorsFactory } from '../mutators/server.js';
+import { tabsMutatorsFactory } from '../mutators/tabs.js';
+import { tagMutatorsFactory } from '../mutators/tag.js';
+import { workspaceMutatorsFactory } from '../mutators/workspace.js';
+/**
+ * Generates a set of mutators for managing OpenAPI document and workspace state.
+ *
+ * @param store - The workspace store containing all documents and workspace-level data
+ * @returns An object with mutators for the workspace, the active document, and any named document
+ */
+export function generateClientMutators(store) {
     /**
-     * Returns mutators for the workspace-level configuration.
-     */
-    workspace: () => workspaceMutators(),
-    /**
-     * Returns mutators for the currently active document.
-     * Falls back to the first document if no active document is set.
+     * Returns mutators for a specific document by name.
+     *
+     * @param documentName - The name of the document to get mutators for
+     * @returns An object containing mutators for requests, request examples, security schemes, environments, and cookies
      */
-    active: () => documentMutators(store?.workspace.activeDocument ?? null),
+    const documentMutators = (document) => {
+        return {
+            auth: authMutatorsFactory({ store, document }),
+            cookie: cookieMutatorsFactory({ collection: document }),
+            document: documentMutatorsFactory({ document, store }),
+            operation: operationMutatorsFactory({ document, store }),
+            server: serverMutatorsFactory({ document }),
+            tag: tagMutatorsFactory({ store }),
+            environment: environmentMutatorsFactory({ workspace: store?.workspace ?? null, collection: document }),
+        };
+    };
     /**
-     * Returns mutators for a specific document by name.
+     * Returns mutators for the workspace-level configuration.
      *
-     * @param name - The name of the document
+     * @returns An object containing mutators for environments and cookies at the workspace level
      */
-    doc: (name) => documentMutators(getDocument(store, name))
-  };
+    const workspaceMutators = () => {
+        return {
+            cookie: cookieMutatorsFactory({ collection: store?.workspace ?? null }),
+            tabs: tabsMutatorsFactory({ workspace: store?.workspace ?? null }),
+            workspace: workspaceMutatorsFactory({ workspace: store?.workspace ?? null }),
+            environment: environmentMutatorsFactory({
+                workspace: store?.workspace ?? null,
+                collection: store?.workspace ?? null,
+            }),
+        };
+    };
+    return {
+        /**
+         * Returns mutators for the workspace-level configuration.
+         */
+        workspace: () => workspaceMutators(),
+        /**
+         * Returns mutators for the currently active document.
+         * Falls back to the first document if no active document is set.
+         */
+        active: () => documentMutators(store?.workspace.activeDocument ?? null),
+        /**
+         * Returns mutators for a specific document by name.
+         *
+         * @param name - The name of the document
+         */
+        doc: (name) => documentMutators(getDocument(store, name)),
+    };
 }
-export {
-  generateClientMutators
-};
-//# sourceMappingURL=index.js.map