Function createWorkspaceStore

packages/workspace-store/src/client.ts:643–1685

(workspaceProps?: WorkspaceProps)

 * @returns An object containing methods and getters for managing the workspace
 */
export const createWorkspaceStore = (workspaceProps?: WorkspaceProps): WorkspaceStore => {
  const { verbose = false } = workspaceProps ?? {}

  const withMeasurementSync = <F extends () => unknown>(
    name: string,
    fn: ReturnType<F> extends Promise<unknown> ? never : F,
  ): ReturnType<F> => (verbose ? measureSync(name, fn) : fn()) as ReturnType<F>
  const withMeasurementAsync = <T>(name: string, fn: () => Promise<T>): Promise<T> =>
    verbose ? measureAsync(name, fn) : fn()

  /**
   * Holds additional configuration options for each document in the workspace.
   *
   * This can include settings that can not be persisted between sessions (not JSON serializable)
   */
  const extraDocumentConfigurations: ExtraDocumentConfigurations = {}

  /**
   * Notifies all workspace plugins of a workspace state change event.
   *
   * This function iterates through all registered plugins (if any) and invokes
   * their onWorkspaceStateChanges hook with the given event object.
   *
   * @param event - The workspace state change event to broadcast to plugins
   */
  const fireWorkspaceChange = (event: WorkspaceStateChangeEvent) => {
    workspaceProps?.plugins?.forEach((plugin) => plugin.hooks?.onWorkspaceStateChanges?.(event))
  }

  /**
   * An object containing the reactive workspace state.
   *
   * Every change to the workspace, is tracked and broadcast to all registered plugins.
   * allowing for change tracking.
   *
   * NOTE:
   * The detect changes proxy is applied separately beacause the vue reactitvity proxy have to be the outer most proxy.
   * If the order is reversed, Vue cannot properly track mutations, leading to lost reactivity and bugs.
   * By wrapping the contents with the detect changes proxy first, and then passing the result to Vue's `reactive`,
   * we ensure that Vue manages its reactivity as expected and our change detection hooks
   * are also triggered reliably.
   * Do not reverse this order‼️
   */
  const workspace = reactive<Workspace>(
    createDetectChangesProxy(
      {
        ...workspaceProps?.meta,
        documents: {},
        /**
         * Returns the currently active document from the workspace.
         * The active document is determined by the 'x-scalar-active-document' metadata field,
         * falling back to the first document in the workspace if no active document is specified.
         *
         * @returns The active document or undefined if no document is found
         */
        get activeDocument(): NonNullable<Workspace['activeDocument']> | undefined {
          return workspace.documents[getActiveDocumentName()]
        },