@scalar/workspace-store 0.18.0 → 0.18.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/workspace-store
 
+## 0.18.1
+
+### Patch Changes
+
+- [#7226](https://github.com/scalar/scalar/pull/7226) [`bffef40`](https://github.com/scalar/scalar/commit/bffef4092e40d12052f8538267af71bc99b7172f) Thanks [@amritk](https://github.com/amritk)! - feat: added overview page for client v2
+
 ## 0.18.0
 
 ### Minor Changes

package/dist/events/bus.d.ts

@@ -1,5 +1,15 @@
 import type { ApiReferenceEvents } from './definitions/index.js';
 type Unsubscribe = () => void;
+/**
+ * Helper type for event listeners that makes the payload optional
+ * if the event allows undefined, otherwise requires it.
+ */
+type EventListener<E extends keyof ApiReferenceEvents> = undefined extends ApiReferenceEvents[E] ? (payload?: ApiReferenceEvents[E]) => void : (payload: ApiReferenceEvents[E]) => void;
+/**
+ * Helper type for emit parameters that uses rest parameters
+ * for a cleaner API surface.
+ */
+type EmitParameters<E extends keyof ApiReferenceEvents> = undefined extends ApiReferenceEvents[E] ? [event: E, payload?: ApiReferenceEvents[E]] : [event: E, payload: ApiReferenceEvents[E]];
 /**
  * Type-safe event bus for workspace events
  *
@@ -22,7 +32,7 @@ export type WorkspaceEventBus = {
      * // Later, clean up
      * unsubscribe()
      */
-    on<E extends keyof ApiReferenceEvents>(event: E, listener: (payload: ApiReferenceEvents[E]) => void): Unsubscribe;
+    on<E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): Unsubscribe;
     /**
      * Remove a specific event listener
      *
@@ -34,17 +44,17 @@ export type WorkspaceEventBus = {
      * bus.on('scalar-update-sidebar', handler)
      * bus.off('scalar-update-sidebar', handler)
      */
-    off<E extends keyof ApiReferenceEvents>(event: E, listener: (payload: ApiReferenceEvents[E]) => void): void;
+    off<E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): void;
     /**
      * Emit an event with its payload
      *
      * @param event - The event name to emit
-     * @param detail - The event detail payload
+     * @param payload - The event detail payload (optional if event allows undefined)
      *
      * @example
      * bus.emit('scalar-update-sidebar', { value: true })
      */
-    emit<E extends keyof ApiReferenceEvents>(event: E, ...args: undefined extends ApiReferenceEvents[E] ? [payload?: ApiReferenceEvents[E]] : [payload: ApiReferenceEvents[E]]): void;
+    emit<E extends keyof ApiReferenceEvents>(...args: EmitParameters<E>): void;
 };
 /**
  * Options for creating an event bus

package/dist/events/bus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bus.d.ts","sourceRoot":"","sources":["../../src/events/bus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEvD,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA;AAE7B;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,WAAW,CAAA;IAEjH;;;;;;;;;;OAUG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,IAAI,CAAA;IAE3G;;;;;;;;OAQG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EACrC,KAAK,EAAE,CAAC,EACR,GAAG,IAAI,EAAE,SAAS,SAAS,kBAAkB,CAAC,CAAC,CAAC,GAC5C,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,GACjC,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,GACnC,IAAI,CAAA;CACR,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAS,eAAoB,KAAG,iBAiGvE,CAAA"}
+{"version":3,"file":"bus.d.ts","sourceRoot":"","sources":["../../src/events/bus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEvD,KAAK,WAAW,GAAG,MAAM,IAAI,CAAA;AAE7B;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,SAAS,MAAM,kBAAkB,IAAI,SAAS,SAAS,kBAAkB,CAAC,CAAC,CAAC,GAC5F,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,GACzC,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAA;AAE5C;;;GAGG;AACH,KAAK,cAAc,CAAC,CAAC,SAAS,MAAM,kBAAkB,IAAI,SAAS,SAAS,kBAAkB,CAAC,CAAC,CAAC,GAC7F,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAC3C,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;;;;;;;;;;;;OAcG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAA;IAEzF;;;;;;;;;;OAUG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAEnF;;;;;;;;OAQG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,GAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CAC3E,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAS,eAAoB,KAAG,iBAoFvE,CAAA"}

package/dist/events/bus.js

@@ -2,8 +2,11 @@ const createWorkspaceEventBus = (options = {}) => {
   const { debug = false } = options;
   const events = /* @__PURE__ */ new Map();
   const getListeners = (event) => {
-    const listeners = events.get(event) ?? /* @__PURE__ */ new Set();
-    events.set(event, listeners);
+    let listeners = events.get(event);
+    if (!listeners) {
+      listeners = /* @__PURE__ */ new Set();
+      events.set(event, listeners);
+    }
     return listeners;
   };
   const log = (message, ...args) => {
@@ -14,7 +17,7 @@ const createWorkspaceEventBus = (options = {}) => {
   const on = (event, listener) => {
     const listeners = getListeners(event);
     listeners.add(listener);
-    log(`Added listener for "${event}" (${listeners.size} total)`);
+    log(`Added listener for "${String(event)}" (${listeners.size} total)`);
     return () => off(event, listener);
   };
   const off = (event, listener) => {
@@ -23,28 +26,27 @@ const createWorkspaceEventBus = (options = {}) => {
       return;
     }
     listeners.delete(listener);
+    log(`Removed listener for "${String(event)}" (${listeners.size} remaining)`);
     if (listeners.size === 0) {
       events.delete(event);
     }
   };
-  const emit = (event, payload) => {
+  const emit = (...args) => {
+    const [event, payload] = args;
     const listeners = events.get(event);
     if (!listeners || listeners.size === 0) {
-      log(`No listeners for "${event}"`);
+      log(`No listeners for "${String(event)}"`);
       return;
     }
-    log(`Emitting "${event}" to ${listeners.size} listener(s)`, payload);
+    log(`Emitting "${String(event)}" to ${listeners.size} listener(s)`, payload);
     const listenersArray = Array.from(listeners);
     for (const listener of listenersArray) {
       try {
         listener(payload);
       } catch (error) {
-        console.error(`[EventBus] Error in listener for "${event}":`, error);
+        console.error(`[EventBus] Error in listener for "${String(event)}":`, error);
       }
     }
-    if (listeners.size === 0) {
-      events.delete(event);
-    }
   };
   return {
     on,

package/dist/events/bus.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/events/bus.ts"],
-  "sourcesContent": ["import type { ApiReferenceEvents } from './definitions'\n\ntype Unsubscribe = () => void\n\n/**\n * Type-safe event bus for workspace events\n *\n * - Full type safety for event names and payloads\n * - Debug mode for development\n */\nexport type WorkspaceEventBus = {\n  /**\n   * Subscribe to an event\n   *\n   * @param event - The event name to listen for\n   * @param listener - Callback function that receives the event detail\n   * @returns Unsubscribe function to remove the listener\n   *\n   * @example\n   * const unsubscribe = bus.on('scalar-update-sidebar', (detail) => {\n   *   console.log('Sidebar state:', detail.value)\n   * })\n   *\n   * // Later, clean up\n   * unsubscribe()\n   */\n  on<E extends keyof ApiReferenceEvents>(event: E, listener: (payload: ApiReferenceEvents[E]) => void): Unsubscribe\n\n  /**\n   * Remove a specific event listener\n   *\n   * @param event - The event name\n   * @param listener - The listener function to remove\n   *\n   * @example\n   * const handler = (detail) => console.log(detail)\n   * bus.on('scalar-update-sidebar', handler)\n   * bus.off('scalar-update-sidebar', handler)\n   */\n  off<E extends keyof ApiReferenceEvents>(event: E, listener: (payload: ApiReferenceEvents[E]) => void): void\n\n  /**\n   * Emit an event with its payload\n   *\n   * @param event - The event name to emit\n   * @param detail - The event detail payload\n   *\n   * @example\n   * bus.emit('scalar-update-sidebar', { value: true })\n   */\n  emit<E extends keyof ApiReferenceEvents>(\n    event: E,\n    ...args: undefined extends ApiReferenceEvents[E]\n      ? [payload?: ApiReferenceEvents[E]]\n      : [payload: ApiReferenceEvents[E]]\n  ): void\n}\n\n/**\n * Options for creating an event bus\n */\nexport type EventBusOptions = {\n  /**\n   * Enable debug mode to log all events and listener operations\n   * Useful for development and troubleshooting\n   */\n  debug?: boolean\n}\n\n/**\n * Creates a type-safe event bus for workspace events\n *\n * This implementation uses a Map for O(1) lookups and maintains\n * a separate Set for each event type to efficiently manage listeners.\n *\n * Create this once per application instance.\n *\n * @param options - Configuration options\n * @returns A fully type-safe event bus instance\n *\n * @example\n * const bus = createWorkspaceEventBus()\n *\n * // Subscribe to events\n * const unsubscribe = bus.on('scalar-update-sidebar', (detail) => {\n *   console.log('Sidebar:', detail.value)\n * })\n *\n * // Emit events\n * bus.emit('scalar-update-sidebar', { value: true })\n *\n * // Clean up\n * unsubscribe()\n */\nexport const createWorkspaceEventBus = (options: EventBusOptions = {}): WorkspaceEventBus => {\n  const { debug = false } = options\n\n  /**\n   * Map of event names to their listener sets\n   * Using Map for O(1) lookups and Set for O(1) add/remove operations\n   */\n  const events = new Map<\n    keyof ApiReferenceEvents,\n    Set<(payload: ApiReferenceEvents[keyof ApiReferenceEvents]) => void>\n  >()\n\n  /**\n   * Get or create a listener set for an event\n   */\n  const getListeners = <T extends keyof ApiReferenceEvents>(\n    event: T,\n  ): Set<(payload: ApiReferenceEvents[T]) => void> => {\n    const listeners = events.get(event) ?? new Set<(payload: ApiReferenceEvents[keyof ApiReferenceEvents]) => void>()\n    events.set(event, listeners)\n    return listeners\n  }\n\n  /**\n   * Log debug information if debug mode is enabled\n   */\n  const log = (message: string, ...args: any[]): void => {\n    if (debug) {\n      console.log(`[EventBus] ${message}`, ...args)\n    }\n  }\n\n  const on = <E extends keyof ApiReferenceEvents>(\n    event: E,\n    listener: (payload: ApiReferenceEvents[E]) => void,\n  ): Unsubscribe => {\n    const listeners = getListeners(event)\n\n    listeners.add(listener)\n    log(`Added listener for \"${event}\" (${listeners.size} total)`)\n\n    return () => off(event, listener)\n  }\n\n  const off = <E extends keyof ApiReferenceEvents>(\n    event: E,\n    listener: (payload: ApiReferenceEvents[E]) => void,\n  ): void => {\n    const listeners = events.get(event) as Set<(payload: ApiReferenceEvents[E]) => void> | undefined\n\n    if (!listeners) {\n      return\n    }\n\n    // Find and remove this specific listener\n    listeners.delete(listener)\n\n    // Clean up empty listener sets to avoid memory leaks\n    if (listeners.size === 0) {\n      events.delete(event)\n    }\n  }\n\n  const emit = <E extends keyof ApiReferenceEvents>(event: E, payload: ApiReferenceEvents[E]): void => {\n    const listeners = events.get(event)\n\n    if (!listeners || listeners.size === 0) {\n      log(`No listeners for \"${event}\"`)\n      return\n    }\n\n    log(`Emitting \"${event}\" to ${listeners.size} listener(s)`, payload)\n\n    // Convert to array to avoid issues if listeners modify the set during iteration\n    const listenersArray = Array.from(listeners)\n\n    // Execute all listeners\n    for (const listener of listenersArray) {\n      try {\n        listener(payload)\n      } catch (error) {\n        // Do not let one listener error break other listeners\n        console.error(`[EventBus] Error in listener for \"${event}\":`, error)\n      }\n    }\n\n    // Clean up if no listeners remain\n    if (listeners.size === 0) {\n      events.delete(event)\n    }\n  }\n\n  return {\n    on,\n    off,\n    emit,\n  }\n}\n"],
-  "mappings": "AA8FO,MAAM,0BAA0B,CAAC,UAA2B,CAAC,MAAyB;AAC3F,QAAM,EAAE,QAAQ,MAAM,IAAI;AAM1B,QAAM,SAAS,oBAAI,IAGjB;AAKF,QAAM,eAAe,CACnB,UACkD;AAClD,UAAM,YAAY,OAAO,IAAI,KAAK,KAAK,oBAAI,IAAqE;AAChH,WAAO,IAAI,OAAO,SAAS;AAC3B,WAAO;AAAA,EACT;AAKA,QAAM,MAAM,CAAC,YAAoB,SAAsB;AACrD,QAAI,OAAO;AACT,cAAQ,IAAI,cAAc,OAAO,IAAI,GAAG,IAAI;AAAA,IAC9C;AAAA,EACF;AAEA,QAAM,KAAK,CACT,OACA,aACgB;AAChB,UAAM,YAAY,aAAa,KAAK;AAEpC,cAAU,IAAI,QAAQ;AACtB,QAAI,uBAAuB,KAAK,MAAM,UAAU,IAAI,SAAS;AAE7D,WAAO,MAAM,IAAI,OAAO,QAAQ;AAAA,EAClC;AAEA,QAAM,MAAM,CACV,OACA,aACS;AACT,UAAM,YAAY,OAAO,IAAI,KAAK;AAElC,QAAI,CAAC,WAAW;AACd;AAAA,IACF;AAGA,cAAU,OAAO,QAAQ;AAGzB,QAAI,UAAU,SAAS,GAAG;AACxB,aAAO,OAAO,KAAK;AAAA,IACrB;AAAA,EACF;AAEA,QAAM,OAAO,CAAqC,OAAU,YAAyC;AACnG,UAAM,YAAY,OAAO,IAAI,KAAK;AAElC,QAAI,CAAC,aAAa,UAAU,SAAS,GAAG;AACtC,UAAI,qBAAqB,KAAK,GAAG;AACjC;AAAA,IACF;AAEA,QAAI,aAAa,KAAK,QAAQ,UAAU,IAAI,gBAAgB,OAAO;AAGnE,UAAM,iBAAiB,MAAM,KAAK,SAAS;AAG3C,eAAW,YAAY,gBAAgB;AACrC,UAAI;AACF,iBAAS,OAAO;AAAA,MAClB,SAAS,OAAO;AAEd,gBAAQ,MAAM,qCAAqC,KAAK,MAAM,KAAK;AAAA,MACrE;AAAA,IACF;AAGA,QAAI,UAAU,SAAS,GAAG;AACxB,aAAO,OAAO,KAAK;AAAA,IACrB;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
+  "sourcesContent": ["import type { ApiReferenceEvents } from './definitions'\n\ntype Unsubscribe = () => void\n\n/**\n * Helper type for event listeners that makes the payload optional\n * if the event allows undefined, otherwise requires it.\n */\ntype EventListener<E extends keyof ApiReferenceEvents> = undefined extends ApiReferenceEvents[E]\n  ? (payload?: ApiReferenceEvents[E]) => void\n  : (payload: ApiReferenceEvents[E]) => void\n\n/**\n * Helper type for emit parameters that uses rest parameters\n * for a cleaner API surface.\n */\ntype EmitParameters<E extends keyof ApiReferenceEvents> = undefined extends ApiReferenceEvents[E]\n  ? [event: E, payload?: ApiReferenceEvents[E]]\n  : [event: E, payload: ApiReferenceEvents[E]]\n\n/**\n * Type-safe event bus for workspace events\n *\n * - Full type safety for event names and payloads\n * - Debug mode for development\n */\nexport type WorkspaceEventBus = {\n  /**\n   * Subscribe to an event\n   *\n   * @param event - The event name to listen for\n   * @param listener - Callback function that receives the event detail\n   * @returns Unsubscribe function to remove the listener\n   *\n   * @example\n   * const unsubscribe = bus.on('scalar-update-sidebar', (detail) => {\n   *   console.log('Sidebar state:', detail.value)\n   * })\n   *\n   * // Later, clean up\n   * unsubscribe()\n   */\n  on<E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): Unsubscribe\n\n  /**\n   * Remove a specific event listener\n   *\n   * @param event - The event name\n   * @param listener - The listener function to remove\n   *\n   * @example\n   * const handler = (detail) => console.log(detail)\n   * bus.on('scalar-update-sidebar', handler)\n   * bus.off('scalar-update-sidebar', handler)\n   */\n  off<E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): void\n\n  /**\n   * Emit an event with its payload\n   *\n   * @param event - The event name to emit\n   * @param payload - The event detail payload (optional if event allows undefined)\n   *\n   * @example\n   * bus.emit('scalar-update-sidebar', { value: true })\n   */\n  emit<E extends keyof ApiReferenceEvents>(...args: EmitParameters<E>): void\n}\n\n/**\n * Options for creating an event bus\n */\nexport type EventBusOptions = {\n  /**\n   * Enable debug mode to log all events and listener operations\n   * Useful for development and troubleshooting\n   */\n  debug?: boolean\n}\n\n/**\n * Creates a type-safe event bus for workspace events\n *\n * This implementation uses a Map for O(1) lookups and maintains\n * a separate Set for each event type to efficiently manage listeners.\n *\n * Create this once per application instance.\n *\n * @param options - Configuration options\n * @returns A fully type-safe event bus instance\n *\n * @example\n * const bus = createWorkspaceEventBus()\n *\n * // Subscribe to events\n * const unsubscribe = bus.on('scalar-update-sidebar', (detail) => {\n *   console.log('Sidebar:', detail.value)\n * })\n *\n * // Emit events\n * bus.emit('scalar-update-sidebar', { value: true })\n *\n * // Clean up\n * unsubscribe()\n */\nexport const createWorkspaceEventBus = (options: EventBusOptions = {}): WorkspaceEventBus => {\n  const { debug = false } = options\n\n  /**\n   * Map of event names to their listener sets\n   * Using Map for O(1) lookups and Set for O(1) add/remove operations\n   */\n  type ListenerSet = Set<EventListener<keyof ApiReferenceEvents>>\n  const events = new Map<keyof ApiReferenceEvents, ListenerSet>()\n\n  /**\n   * Get or create a listener set for an event\n   */\n  const getListeners = <E extends keyof ApiReferenceEvents>(event: E): ListenerSet => {\n    let listeners = events.get(event)\n    if (!listeners) {\n      listeners = new Set()\n      events.set(event, listeners)\n    }\n    return listeners\n  }\n\n  /**\n   * Log debug information if debug mode is enabled\n   */\n  const log = (message: string, ...args: unknown[]): void => {\n    if (debug) {\n      console.log(`[EventBus] ${message}`, ...args)\n    }\n  }\n\n  const on = <E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): Unsubscribe => {\n    const listeners = getListeners(event)\n    listeners.add(listener as EventListener<keyof ApiReferenceEvents>)\n    log(`Added listener for \"${String(event)}\" (${listeners.size} total)`)\n\n    return () => off(event, listener)\n  }\n\n  const off = <E extends keyof ApiReferenceEvents>(event: E, listener: EventListener<E>): void => {\n    const listeners = events.get(event)\n    if (!listeners) {\n      return\n    }\n\n    listeners.delete(listener as EventListener<keyof ApiReferenceEvents>)\n    log(`Removed listener for \"${String(event)}\" (${listeners.size} remaining)`)\n\n    // Clean up empty listener sets to avoid memory leaks\n    if (listeners.size === 0) {\n      events.delete(event)\n    }\n  }\n\n  const emit = <E extends keyof ApiReferenceEvents>(...args: EmitParameters<E>): void => {\n    const [event, payload] = args\n    const listeners = events.get(event)\n\n    if (!listeners || listeners.size === 0) {\n      log(`No listeners for \"${String(event)}\"`)\n      return\n    }\n\n    log(`Emitting \"${String(event)}\" to ${listeners.size} listener(s)`, payload)\n\n    // Convert to array to avoid issues if listeners modify the set during iteration\n    const listenersArray = Array.from(listeners)\n\n    // Execute all listeners\n    for (const listener of listenersArray) {\n      try {\n        listener(payload)\n      } catch (error) {\n        // Do not let one listener error break other listeners\n        console.error(`[EventBus] Error in listener for \"${String(event)}\":`, error)\n      }\n    }\n  }\n\n  return {\n    on,\n    off,\n    emit,\n  }\n}\n"],
+  "mappings": "AAyGO,MAAM,0BAA0B,CAAC,UAA2B,CAAC,MAAyB;AAC3F,QAAM,EAAE,QAAQ,MAAM,IAAI;AAO1B,QAAM,SAAS,oBAAI,IAA2C;AAK9D,QAAM,eAAe,CAAqC,UAA0B;AAClF,QAAI,YAAY,OAAO,IAAI,KAAK;AAChC,QAAI,CAAC,WAAW;AACd,kBAAY,oBAAI,IAAI;AACpB,aAAO,IAAI,OAAO,SAAS;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAKA,QAAM,MAAM,CAAC,YAAoB,SAA0B;AACzD,QAAI,OAAO;AACT,cAAQ,IAAI,cAAc,OAAO,IAAI,GAAG,IAAI;AAAA,IAC9C;AAAA,EACF;AAEA,QAAM,KAAK,CAAqC,OAAU,aAA4C;AACpG,UAAM,YAAY,aAAa,KAAK;AACpC,cAAU,IAAI,QAAmD;AACjE,QAAI,uBAAuB,OAAO,KAAK,CAAC,MAAM,UAAU,IAAI,SAAS;AAErE,WAAO,MAAM,IAAI,OAAO,QAAQ;AAAA,EAClC;AAEA,QAAM,MAAM,CAAqC,OAAU,aAAqC;AAC9F,UAAM,YAAY,OAAO,IAAI,KAAK;AAClC,QAAI,CAAC,WAAW;AACd;AAAA,IACF;AAEA,cAAU,OAAO,QAAmD;AACpE,QAAI,yBAAyB,OAAO,KAAK,CAAC,MAAM,UAAU,IAAI,aAAa;AAG3E,QAAI,UAAU,SAAS,GAAG;AACxB,aAAO,OAAO,KAAK;AAAA,IACrB;AAAA,EACF;AAEA,QAAM,OAAO,IAAwC,SAAkC;AACrF,UAAM,CAAC,OAAO,OAAO,IAAI;AACzB,UAAM,YAAY,OAAO,IAAI,KAAK;AAElC,QAAI,CAAC,aAAa,UAAU,SAAS,GAAG;AACtC,UAAI,qBAAqB,OAAO,KAAK,CAAC,GAAG;AACzC;AAAA,IACF;AAEA,QAAI,aAAa,OAAO,KAAK,CAAC,QAAQ,UAAU,IAAI,gBAAgB,OAAO;AAG3E,UAAM,iBAAiB,MAAM,KAAK,SAAS;AAG3C,eAAW,YAAY,gBAAgB;AACrC,UAAI;AACF,iBAAS,OAAO;AAAA,MAClB,SAAS,OAAO;AAEd,gBAAQ,MAAM,qCAAqC,OAAO,KAAK,CAAC,MAAM,KAAK;AAAA,MAC7E;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;",
   "names": []
 }

package/dist/events/definitions/analytics.d.ts

@@ -4,7 +4,7 @@ export type AnalyticsEvents = {
     /**
      * Fired when a request is sent through the API client
      */
-    'on:send-request': {
+    'analytics:on:send-request': {
         /** The HTTP method of the request */
         method: HttpMethod;
         /** The path of the request */
@@ -15,13 +15,13 @@ export type AnalyticsEvents = {
     /**
      * Fired when the user clicks the "Show more" button on the references
      */
-    'on:show-more': {
+    'analytics:on:show-more': {
         /** The id of the tag that was opened */
         id: string;
     };
     /**
      * Fired when the references are loaded
      */
-    'on:loaded': undefined;
+    'analytics:on:loaded': undefined;
 };
 //# sourceMappingURL=analytics.d.ts.map

package/dist/events/definitions/analytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,iBAAiB,EAAE;QACjB,qCAAqC;QACrC,MAAM,EAAE,UAAU,CAAA;QAClB,8BAA8B;QAC9B,IAAI,EAAE,MAAM,CAAA;QACZ,8BAA8B;QAC9B,IAAI,EAAE,GAAG,CAAA;KACV,CAAA;IACD;;OAEG;IACH,cAAc,EAAE;QACd,wCAAwC;QACxC,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IACD;;OAEG;IACH,WAAW,EAAE,SAAS,CAAA;CACvB,CAAA"}
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,2BAA2B,EAAE;QAC3B,qCAAqC;QACrC,MAAM,EAAE,UAAU,CAAA;QAClB,8BAA8B;QAC9B,IAAI,EAAE,MAAM,CAAA;QACZ,8BAA8B;QAC9B,IAAI,EAAE,GAAG,CAAA;KACV,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,wCAAwC;QACxC,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IACD;;OAEG;IACH,qBAAqB,EAAE,SAAS,CAAA;CACjC,CAAA"}

package/dist/events/definitions/common.d.ts

@@ -0,0 +1,5 @@
+/** Event discriminator between document and workspace */
+export type CollectionType = {
+    collectionType: 'document' | 'workspace';
+};
+//# sourceMappingURL=common.d.ts.map

package/dist/events/definitions/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/common.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,MAAM,MAAM,cAAc,GAAG;IAAE,cAAc,EAAE,UAAU,GAAG,WAAW,CAAA;CAAE,CAAA"}

package/dist/events/definitions/common.js

@@ -0,0 +1 @@
+//# sourceMappingURL=common.js.map

package/dist/events/definitions/common.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/events/definitions/document.d.ts

@@ -5,10 +5,10 @@ export type DocumentEvents = {
     /**
      * Update any property in the document info object
      */
-    'update:document-info': PartialDeep<InfoObject>;
+    'document:update:info': PartialDeep<InfoObject>;
     /**
      * Update the icon of the active document/workspace
      */
-    'update:document-icon': string;
+    'document:update:icon': string;
 };
 //# sourceMappingURL=document.d.ts.map

package/dist/events/definitions/environment.d.ts

@@ -0,0 +1,37 @@
+import type { CollectionType } from '../../events/definitions/common.js';
+import type { XScalarEnvVar, XScalarEnvironment } from '../../schemas/extensions/document/x-scalar-environments.js';
+/** Event definitions for all things environment related */
+export type EnvironmentEvents = {
+    /**
+     * Add OR update an environment
+     */
+    'environment:upsert:environment': {
+        environmentName: string;
+        payload: Partial<XScalarEnvironment>;
+        /** Only needed when renaming the environment */
+        oldEnvironmentName?: string;
+    } & CollectionType;
+    /**
+     * Add or update an environment variable
+     */
+    'environment:upsert:environment-variable': {
+        environmentName: string;
+        variable: XScalarEnvVar;
+        /** Only needed for update, omit it for add */
+        index?: number;
+    } & CollectionType;
+    /**
+     * Delete an environment
+     */
+    'environment:delete:environment': {
+        environmentName: string;
+    } & CollectionType;
+    /**
+     * Delete an environment variable by index
+     */
+    'environment:delete:environment-variable': {
+        environmentName: string;
+        index: number;
+    } & CollectionType;
+};
+//# sourceMappingURL=environment.d.ts.map

package/dist/events/definitions/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,qDAAqD,CAAA;AAE5G,2DAA2D;AAC3D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,gCAAgC,EAAE;QAChC,eAAe,EAAE,MAAM,CAAA;QACvB,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;QACpC,gDAAgD;QAChD,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAC5B,GAAG,cAAc,CAAA;IAClB;;OAEG;IACH,yCAAyC,EAAE;QACzC,eAAe,EAAE,MAAM,CAAA;QACvB,QAAQ,EAAE,aAAa,CAAA;QACvB,8CAA8C;QAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;KACf,GAAG,cAAc,CAAA;IAClB;;OAEG;IACH,gCAAgC,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc,CAAA;IAC9E;;OAEG;IACH,yCAAyC,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,cAAc,CAAA;CACvG,CAAA"}

package/dist/events/definitions/environment.js

@@ -0,0 +1 @@
+//# sourceMappingURL=environment.js.map

package/dist/events/definitions/environment.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/events/definitions/index.d.ts

@@ -1,3 +1,4 @@
+import type { EnvironmentEvents } from '../../events/definitions/environment.js';
 import type { ServerObject } from '../../schemas/v3.1/strict/openapi-document.js';
 import type { AnalyticsEvents } from './analytics.js';
 import type { AuthEvents } from './auth.js';
@@ -6,5 +7,6 @@ import type { MetaEvents } from './meta.js';
 import type { OperationEvents } from './operation.js';
 import type { ServerEvents } from './server.js';
 import type { UIEvents } from './ui.js';
-export type ApiReferenceEvents<T extends keyof ServerObject = keyof ServerObject> = AuthEvents & AnalyticsEvents & DocumentEvents & MetaEvents & OperationEvents & ServerEvents<T> & UIEvents;
+export type ApiReferenceEvents<T extends keyof ServerObject = keyof ServerObject> = AuthEvents & AnalyticsEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents<T> & UIEvents;
+export type { CollectionType } from './common.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/events/definitions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,IAAI,UAAU,GAC5F,eAAe,GACf,cAAc,GACd,UAAU,GACV,eAAe,GACf,YAAY,CAAC,CAAC,CAAC,GACf,QAAQ,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAA;AAEpC,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,IAAI,UAAU,GAC5F,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,YAAY,CAAC,CAAC,CAAC,GACf,QAAQ,CAAA;AAEV,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA"}

package/dist/events/definitions/meta.d.ts

@@ -1,11 +1,17 @@
 import type { AvailableClients } from '@scalar/types/snippetz';
 /** Event definitions for the workspace/document meta */
 export type MetaEvents = {
-    /** Update the dark mode theme setting */
+    /**
+     * Update the dark mode theme setting
+     */
     'update:dark-mode': boolean;
-    /** Update the active document on the workspace */
+    /**
+     * Update the active document on the workspace
+     */
     'update:active-document': string;
-    /** Update the selected client on the workspace */
+    /**
+     * Update the selected client on the workspace
+     */
     'update:selected-client': AvailableClients[number];
 };
 //# sourceMappingURL=meta.d.ts.map

package/dist/events/definitions/meta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAE9D,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG;IACvB,yCAAyC;IACzC,kBAAkB,EAAE,OAAO,CAAA;IAC3B,kDAAkD;IAClD,wBAAwB,EAAE,MAAM,CAAA;IAChC,kDAAkD;IAClD,wBAAwB,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACnD,CAAA"}
+{"version":3,"file":"meta.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/meta.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAE9D,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,wBAAwB,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAA;CACnD,CAAA"}

package/dist/events/index.d.ts

@@ -1,4 +1,5 @@
 export { type WorkspaceEventBus, createWorkspaceEventBus } from './bus.js';
+export type { CollectionType } from './definitions/index.js';
 export { onCustomEvent } from './listeners.js';
 export { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,OAAO,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,kBAAkB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,OAAO,CAAA;AACvE,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,KAAK,iBAAiB,EAAE,KAAK,kBAAkB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/events/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/events/index.ts"],
-  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /events\nexport { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport { onCustomEvent } from './listeners'\nexport { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions'\n"],
-  "mappings": "AACA,SAAiC,+BAA+B;AAChE,SAAS,qBAAqB;AAC9B,SAA0D,uBAAuB;",
+  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /events\nexport { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport type { CollectionType } from './definitions'\nexport { onCustomEvent } from './listeners'\nexport { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions'\n"],
+  "mappings": "AACA,SAAiC,+BAA+B;AAEhE,SAAS,qBAAqB;AAC9B,SAA0D,uBAAuB;",
   "names": []
 }

package/dist/mutators/environment.d.ts

@@ -1,17 +1,25 @@
-import type { UnknownObject } from '../helpers/general.js';
-import type { XScalarClientConfigEnvironments, xScalarClientConfigEnvironment } from '../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js';
+import type { EnvironmentEvents } from '../events/definitions/environment.js';
+import type { Workspace, WorkspaceDocument } from '../schemas.js';
+import { type XScalarEnvVar, type XScalarEnvironment } from '../schemas/extensions/document/x-scalar-environments.js';
 /**
- * Environment mutators for managing client configuration environments in OpenAPI documents.
- * Provides functions to add and delete environments from the document's x-scalar-client-config-environments extension.
+ * Adds OR updates an environment to the document or workspace.
  *
- * @param store - The workspace store containing the documents
- * @param documentName - The name of the document to operate on
- * @returns Object containing addEnvironment and deleteEnvironment functions
+ * @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 declare const environmentMutators: (document?: UnknownObject & {
-    "x-scalar-client-config-environments"?: XScalarClientConfigEnvironments;
-}) => {
-    addEnvironment: (name: string, environment: xScalarClientConfigEnvironment) => boolean;
-    deleteEnvironment: (environmentName: string) => boolean;
-};
+export declare const upsertEnvironment: (document: WorkspaceDocument | null, workspace: Workspace, { environmentName, payload, collectionType, oldEnvironmentName }: EnvironmentEvents["environment:upsert:environment"]) => XScalarEnvironment | undefined;
+/**
+ * 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 declare const upsertEnvironmentVariable: (collection: WorkspaceDocument | Workspace | null, { environmentName, variable, index }: EnvironmentEvents["environment:upsert:environment-variable"]) => XScalarEnvVar | undefined;
 //# sourceMappingURL=environment.d.ts.map

package/dist/mutators/environment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/mutators/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EACV,+BAA+B,EAC/B,8BAA8B,EAC/B,MAAM,oFAAoF,CAAA;AAE3F;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,WAAW,aAAa,GAAG;IAAE,qCAAqC,CAAC,EAAE,+BAA+B,CAAA;CAAE;2BAsBxE,MAAM,eAAe,8BAA8B;yCA6BrC,MAAM;CAanD,CAAA"}
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/mutators/environment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAC7D,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EAGxB,MAAM,qDAAqD,CAAA;AAG5D;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAU,iBAAiB,GAAG,IAAI,EAClC,WAAW,SAAS,EACpB,kEAAkE,iBAAiB,CAAC,gCAAgC,CAAC,KACpH,kBAAkB,GAAG,SAqCvB,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,yBAAyB,GACpC,YAAY,iBAAiB,GAAG,SAAS,GAAG,IAAI,EAChD,sCAAsC,iBAAiB,CAAC,yCAAyC,CAAC,KACjG,aAAa,GAAG,SA0BlB,CAAA"}

package/dist/mutators/environment.js

@@ -1,31 +1,52 @@
-const environmentMutators = (document) => {
-  const addEnvironment = (name, environment) => {
-    if (!document) {
-      return false;
+import {
+  xScalarEnvVarSchema,
+  xScalarEnvironmentSchema
+} from "../schemas/extensions/document/x-scalar-environments.js";
+import { coerceValue } from "../schemas/typebox-coerce.js";
+const upsertEnvironment = (document, workspace, { environmentName, payload, collectionType, oldEnvironmentName }) => {
+  const collection = collectionType === "document" ? document : workspace;
+  if (!collection) {
+    return;
+  }
+  if (!collection["x-scalar-environments"]) {
+    collection["x-scalar-environments"] = {};
+  }
+  const isNewEnvironment = !collection["x-scalar-environments"][oldEnvironmentName ?? environmentName];
+  const parsed = coerceValue(xScalarEnvironmentSchema, {
+    ...collection["x-scalar-environments"][oldEnvironmentName ?? environmentName],
+    ...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;
     }
-    if (!document["x-scalar-client-config-environments"]) {
-      document["x-scalar-client-config-environments"] = {};
-    }
-    if (document["x-scalar-client-config-environments"][name]) {
-      console.warn(`Environment with name "${name}" already exists in the document.`);
-      return false;
-    }
-    document["x-scalar-client-config-environments"][name] = environment;
-    return true;
-  };
-  const deleteEnvironment = (environmentName) => {
-    if (!document || !document["x-scalar-client-config-environments"]) {
-      return false;
+  }
+  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;
     }
-    delete document["x-scalar-client-config-environments"][environmentName];
-    return true;
-  };
-  return {
-    addEnvironment,
-    deleteEnvironment
-  };
+    collection["x-scalar-environments"][environmentName].variables[index] = parsed;
+  } else {
+    collection["x-scalar-environments"][environmentName].variables.push(parsed);
+  }
+  return parsed;
 };
 export {
-  environmentMutators
+  upsertEnvironment,
+  upsertEnvironmentVariable
 };
 //# sourceMappingURL=environment.js.map

package/dist/mutators/environment.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/mutators/environment.ts"],
-  "sourcesContent": ["import type { UnknownObject } from '@/helpers/general'\nimport type {\n  XScalarClientConfigEnvironments,\n  xScalarClientConfigEnvironment,\n} from '@/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments'\n\n/**\n * Environment mutators for managing client configuration environments in OpenAPI documents.\n * Provides functions to add and delete environments from the document's x-scalar-client-config-environments extension.\n *\n * @param store - The workspace store containing the documents\n * @param documentName - The name of the document to operate on\n * @returns Object containing addEnvironment and deleteEnvironment functions\n */\nexport const environmentMutators = (\n  document?: UnknownObject & { 'x-scalar-client-config-environments'?: XScalarClientConfigEnvironments },\n) => {\n  /**\n   * Adds a new environment to the document's client configuration.\n   * If an environment with the same name already exists, it will log a warning and return false.\n   *\n   * @param name - The name of the environment to add\n   * @param environment - The environment configuration to add\n   * @returns true if the environment was added successfully, false if it already exists or document is missing\n   *\n   * @example\n   * // Add a new development environment\n   * const success = addEnvironment('development', {\n   *   variables: { apiUrl: 'https://dev.example.com/api' }\n   * })\n   *\n   * if (success) {\n   *   console.log('Environment added successfully')\n   * } else {\n   *   console.log('Environment already exists')\n   * }\n   */\n  const addEnvironment = (name: string, environment: xScalarClientConfigEnvironment) => {\n    if (!document) {\n      return false\n    }\n\n    if (!document['x-scalar-client-config-environments']) {\n      document['x-scalar-client-config-environments'] = {}\n    }\n\n    if (document['x-scalar-client-config-environments'][name]) {\n      console.warn(`Environment with name \"${name}\" already exists in the document.`)\n      return false\n    }\n\n    document['x-scalar-client-config-environments'][name] = environment\n    return true\n  }\n\n  /**\n   * Removes an environment from the document's x-scalar-client-config-environments extension by its name.\n   * Returns false if the document or environments object does not exist, otherwise deletes the environment and returns true.\n   *\n   * @param environmentName - The name of the environment to remove\n   * @returns true if the environment was deleted, false otherwise\n   *\n   * @example\n   * // Remove a development environment\n   * deleteEnvironment('development')\n   */\n  const deleteEnvironment = (environmentName: string) => {\n    if (!document || !document['x-scalar-client-config-environments']) {\n      return false\n    }\n\n    delete document['x-scalar-client-config-environments'][environmentName]\n    return true\n  }\n\n  return {\n    addEnvironment,\n    deleteEnvironment,\n  }\n}\n"],
-  "mappings": "AAcO,MAAM,sBAAsB,CACjC,aACG;AAqBH,QAAM,iBAAiB,CAAC,MAAc,gBAAgD;AACpF,QAAI,CAAC,UAAU;AACb,aAAO;AAAA,IACT;AAEA,QAAI,CAAC,SAAS,qCAAqC,GAAG;AACpD,eAAS,qCAAqC,IAAI,CAAC;AAAA,IACrD;AAEA,QAAI,SAAS,qCAAqC,EAAE,IAAI,GAAG;AACzD,cAAQ,KAAK,0BAA0B,IAAI,mCAAmC;AAC9E,aAAO;AAAA,IACT;AAEA,aAAS,qCAAqC,EAAE,IAAI,IAAI;AACxD,WAAO;AAAA,EACT;AAaA,QAAM,oBAAoB,CAAC,oBAA4B;AACrD,QAAI,CAAC,YAAY,CAAC,SAAS,qCAAqC,GAAG;AACjE,aAAO;AAAA,IACT;AAEA,WAAO,SAAS,qCAAqC,EAAE,eAAe;AACtE,WAAO;AAAA,EACT;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;",
+  "sourcesContent": ["import type { EnvironmentEvents } from '@/events/definitions/environment'\nimport type { Workspace, WorkspaceDocument } from '@/schemas'\nimport {\n  type XScalarEnvVar,\n  type XScalarEnvironment,\n  xScalarEnvVarSchema,\n  xScalarEnvironmentSchema,\n} from '@/schemas/extensions/document/x-scalar-environments'\nimport { coerceValue } from '@/schemas/typebox-coerce'\n\n/**\n * Adds OR updates an environment to the document or workspace.\n *\n * @param document - current document if available\n * @param workspace - current workspace if available\n * @param environmentName - Name of the environment to add\n * @param payload - The environment configuration to add\n * @param oldEnvironmentName - Only needed when renaming the environment\n * @returns the parsed environment that was added or updated or undefined if the collection is not found\n */\nexport const upsertEnvironment = (\n  document: WorkspaceDocument | null,\n  workspace: Workspace,\n  { environmentName, payload, collectionType, oldEnvironmentName }: EnvironmentEvents['environment:upsert:environment'],\n): XScalarEnvironment | undefined => {\n  /** Discriminating between document and workspace */\n  const collection = collectionType === 'document' ? document : workspace\n  if (!collection) {\n    return\n  }\n\n  if (!collection['x-scalar-environments']) {\n    collection['x-scalar-environments'] = {}\n  }\n\n  // Check if this is a new environment before we create it\n  const isNewEnvironment = !collection['x-scalar-environments'][oldEnvironmentName ?? environmentName]\n\n  // Ensure we parse the payload but keep the old variables\n  const parsed = coerceValue(xScalarEnvironmentSchema, {\n    ...collection['x-scalar-environments'][oldEnvironmentName ?? environmentName],\n    ...payload,\n  })\n  collection['x-scalar-environments'][environmentName] = parsed\n\n  // If we are renaming the environment, we need to delete the old one\n  if (oldEnvironmentName && oldEnvironmentName !== environmentName) {\n    delete collection['x-scalar-environments'][oldEnvironmentName]\n\n    // If the old environment was active, we need to set the new environment as active\n    if (workspace['x-scalar-active-environment'] === oldEnvironmentName) {\n      workspace['x-scalar-active-environment'] = environmentName\n    }\n  }\n\n  // Set the newly created workspace environment as active\n  if (isNewEnvironment) {\n    workspace['x-scalar-active-environment'] = environmentName\n  }\n\n  return parsed\n}\n\n/**\n * Adds OR updates an environment variable to the document or workspace.\n *\n * @param collection - Workspace OR document\n * @param environmentName - Name of the environment to add the variable to\n * @param variableName - Name of the variable to add\n * @param value - Value of the variable to add\n * @returns the parsed variable that was added or updated or undefined if the collection is not found\n */\nexport const upsertEnvironmentVariable = (\n  collection: WorkspaceDocument | Workspace | null,\n  { environmentName, variable, index }: EnvironmentEvents['environment:upsert:environment-variable'],\n): XScalarEnvVar | undefined => {\n  // The environment should exist by now if we are upserting a variable\n  if (!collection?.['x-scalar-environments']?.[environmentName]) {\n    console.error('Environment not found', environmentName)\n    return\n  }\n\n  // Ensure we parse the variable for type safety\n  const parsed = coerceValue(xScalarEnvVarSchema, variable)\n\n  if (index !== undefined) {\n    // Delete the row if the name is empty\n    if (parsed.name === '') {\n      collection['x-scalar-environments'][environmentName].variables.splice(index, 1)\n      return\n    }\n\n    // Update\n    collection['x-scalar-environments'][environmentName].variables[index] = parsed\n  }\n  // Add\n  else {\n    collection['x-scalar-environments'][environmentName].variables.push(parsed)\n  }\n\n  return parsed\n}\n"],
+  "mappings": "AAEA;AAAA,EAGE;AAAA,EACA;AAAA,OACK;AACP,SAAS,mBAAmB;AAYrB,MAAM,oBAAoB,CAC/B,UACA,WACA,EAAE,iBAAiB,SAAS,gBAAgB,mBAAmB,MAC5B;AAEnC,QAAM,aAAa,mBAAmB,aAAa,WAAW;AAC9D,MAAI,CAAC,YAAY;AACf;AAAA,EACF;AAEA,MAAI,CAAC,WAAW,uBAAuB,GAAG;AACxC,eAAW,uBAAuB,IAAI,CAAC;AAAA,EACzC;AAGA,QAAM,mBAAmB,CAAC,WAAW,uBAAuB,EAAE,sBAAsB,eAAe;AAGnG,QAAM,SAAS,YAAY,0BAA0B;AAAA,IACnD,GAAG,WAAW,uBAAuB,EAAE,sBAAsB,eAAe;AAAA,IAC5E,GAAG;AAAA,EACL,CAAC;AACD,aAAW,uBAAuB,EAAE,eAAe,IAAI;AAGvD,MAAI,sBAAsB,uBAAuB,iBAAiB;AAChE,WAAO,WAAW,uBAAuB,EAAE,kBAAkB;AAG7D,QAAI,UAAU,6BAA6B,MAAM,oBAAoB;AACnE,gBAAU,6BAA6B,IAAI;AAAA,IAC7C;AAAA,EACF;AAGA,MAAI,kBAAkB;AACpB,cAAU,6BAA6B,IAAI;AAAA,EAC7C;AAEA,SAAO;AACT;AAWO,MAAM,4BAA4B,CACvC,YACA,EAAE,iBAAiB,UAAU,MAAM,MACL;AAE9B,MAAI,CAAC,aAAa,uBAAuB,IAAI,eAAe,GAAG;AAC7D,YAAQ,MAAM,yBAAyB,eAAe;AACtD;AAAA,EACF;AAGA,QAAM,SAAS,YAAY,qBAAqB,QAAQ;AAExD,MAAI,UAAU,QAAW;AAEvB,QAAI,OAAO,SAAS,IAAI;AACtB,iBAAW,uBAAuB,EAAE,eAAe,EAAE,UAAU,OAAO,OAAO,CAAC;AAC9E;AAAA,IACF;AAGA,eAAW,uBAAuB,EAAE,eAAe,EAAE,UAAU,KAAK,IAAI;AAAA,EAC1E,OAEK;AACH,eAAW,uBAAuB,EAAE,eAAe,EAAE,UAAU,KAAK,MAAM;AAAA,EAC5E;AAEA,SAAO;AACT;",
   "names": []
 }

package/dist/mutators/index.d.ts

@@ -1,7 +1,10 @@
+/** biome-ignore-all lint/performance/noBarrelFile: this will probably get deleted later */
 import type { WorkspaceStore } from '../client.js';
 /**
  * Generates a set of mutators for managing OpenAPI document and workspace state.
  *
+ * @deprecated use the individual mutators instead, this will be removed after we move fully to the new store
+ *
  * @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
  */
@@ -10,10 +13,6 @@ export declare function generateClientMutators(store: WorkspaceStore): {
      * Returns mutators for the workspace-level configuration.
      */
     workspace: () => {
-        environmentMutators: {
-            addEnvironment: (name: string, environment: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js").xScalarClientConfigEnvironment) => boolean;
-            deleteEnvironment: (environmentName: string) => boolean;
-        };
         cookieMutators: {
             addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
             deleteCookie: (cookieName: string) => boolean;
@@ -43,10 +42,6 @@ export declare function generateClientMutators(store: WorkspaceStore): {
             addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/security-scheme.js").SecuritySchemeObject) => boolean;
             deleteSecurityScheme: (name: string) => boolean;
         };
-        environmentMutators: {
-            addEnvironment: (name: string, environment: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js").xScalarClientConfigEnvironment) => boolean;
-            deleteEnvironment: (environmentName: string) => boolean;
-        };
         cookieMutators: {
             addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
             deleteCookie: (cookieName: string) => boolean;
@@ -73,10 +68,6 @@ export declare function generateClientMutators(store: WorkspaceStore): {
             addSecurityScheme: (name: string, securityScheme: import("../schemas/v3.1/strict/security-scheme.js").SecuritySchemeObject) => boolean;
             deleteSecurityScheme: (name: string) => boolean;
         };
-        environmentMutators: {
-            addEnvironment: (name: string, environment: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js").xScalarClientConfigEnvironment) => boolean;
-            deleteEnvironment: (environmentName: string) => boolean;
-        };
         cookieMutators: {
             addCookie: (cookie: import("../schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js").XScalarClientConfigCookie) => boolean;
             deleteCookie: (cookieName: string) => boolean;
@@ -87,4 +78,5 @@ export declare function generateClientMutators(store: WorkspaceStore): {
         };
     };
 };
+export { upsertEnvironment, upsertEnvironmentVariable, } from './environment.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/mutators/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mutators/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAQ9C;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc;IA8DxD;;OAEG;;;;;;;;;;;;;;;;;;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;;;;IAGH;;;;OAIG;gBACS,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;EAErB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mutators/index.ts"],"names":[],"mappings":"AAAA,2FAA2F;AAC3F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAO9C;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc;IA4DxD;;OAEG;;;;;;;;;;;;;;;IAEH;;;OAGG;;;;;;;;;;;;;;;;;;;;;;IAGH;;;;OAIG;gBACS,MAAM;;;;;;;;;;;;;;;;;;;;;EAErB;AAED,OAAO,EACL,iBAAiB,EACjB,yBAAyB,GAC1B,MAAM,eAAe,CAAA"}