@scalar/workspace-store 0.20.0 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,63 @@
 # @scalar/workspace-store
 
+## 0.22.0
+
+### Minor Changes
+
+- [#7431](https://github.com/scalar/scalar/pull/7431) [`61c980c`](https://github.com/scalar/scalar/commit/61c980cebef219685a05f3a4cb1e379984922cd4) Thanks [@DemonHa](https://github.com/DemonHa)! - feat: implememnt command palette
+
+- [#7455](https://github.com/scalar/scalar/pull/7455) [`1bc2b45`](https://github.com/scalar/scalar/commit/1bc2b45b6eabd5c5045e77d67f59d202ab04d3fb) Thanks [@DemonHa](https://github.com/DemonHa)! - feat: tabs support on the store
+
+### Patch Changes
+
+- [#7465](https://github.com/scalar/scalar/pull/7465) [`9342adc`](https://github.com/scalar/scalar/commit/9342adcd76e26a8e5eff75c1a2abee2c207b1487) Thanks [@marcalexiei](https://github.com/marcalexiei)! - fix: ensure `@scalar/workspace-store` consumers rely only on public exports
+
+- [#7387](https://github.com/scalar/scalar/pull/7387) [`bfd814a`](https://github.com/scalar/scalar/commit/bfd814a4219660face190041cc4845182b56ab03) Thanks [@geoffgscott](https://github.com/geoffgscott)! - hotfix: patch exports from build tooling bug
+
+- [#7416](https://github.com/scalar/scalar/pull/7416) [`86f028d`](https://github.com/scalar/scalar/commit/86f028deb0b456f923edd261f5f4b0fa9b616b7d) Thanks [@amritk](https://github.com/amritk)! - feat: add update method to client v2
+
+- [#7414](https://github.com/scalar/scalar/pull/7414) [`294f9fc`](https://github.com/scalar/scalar/commit/294f9fc6cfd43cdab110deb1c851883509bc2b84) Thanks [@hanspagel](https://github.com/hanspagel)! - feat: show tags without operations
+
+- Updated dependencies [[`781f264`](https://github.com/scalar/scalar/commit/781f2648bc758a251435c3a1e2b126a37f20e44f), [`fa361d2`](https://github.com/scalar/scalar/commit/fa361d2799e358d582fbb224a7b93d5b6e832c0e), [`e04879c`](https://github.com/scalar/scalar/commit/e04879c65602dfb65393876754f5344751b8953d), [`dd8e9dc`](https://github.com/scalar/scalar/commit/dd8e9dc118d3ae98180e2a93bd6ba11e982abbf8), [`bfd814a`](https://github.com/scalar/scalar/commit/bfd814a4219660face190041cc4845182b56ab03), [`781f264`](https://github.com/scalar/scalar/commit/781f2648bc758a251435c3a1e2b126a37f20e44f), [`35af6bf`](https://github.com/scalar/scalar/commit/35af6bfce4bc4ae3d0fc5783ea36e0165e964361), [`86f028d`](https://github.com/scalar/scalar/commit/86f028deb0b456f923edd261f5f4b0fa9b616b7d), [`af54a80`](https://github.com/scalar/scalar/commit/af54a80349269a4269a68f6a372f837177a3537c)]:
+  - @scalar/code-highlight@0.2.1
+  - @scalar/snippetz@0.5.4
+  - @scalar/json-magic@0.8.3
+  - @scalar/helpers@0.1.3
+  - @scalar/types@0.5.1
+  - @scalar/themes@0.13.25
+  - @scalar/object-utils@1.2.13
+  - @scalar/openapi-upgrader@0.1.5
+
+## 0.21.0
+
+### Minor Changes
+
+- [#7310](https://github.com/scalar/scalar/pull/7310) [`6e1cb89`](https://github.com/scalar/scalar/commit/6e1cb89f71770601a5059449d68b409ffc87d332) Thanks [@DemonHa](https://github.com/DemonHa)! - feat: workspace selector
+
+- [#7366](https://github.com/scalar/scalar/pull/7366) [`1fbd809`](https://github.com/scalar/scalar/commit/1fbd809197bfaef77d7d3cb8cf7b657f397232a7) Thanks [@DemonHa](https://github.com/DemonHa)! - feat: support sidebar rebuild and remove the 'default' tag concept
+
+- [#7384](https://github.com/scalar/scalar/pull/7384) [`3ebff92`](https://github.com/scalar/scalar/commit/3ebff92f29d8d03d626d4000e8323528e794e755) Thanks [@DemonHa](https://github.com/DemonHa)! - feat: collection and document settings and cookies page
+
+### Patch Changes
+
+- [#7392](https://github.com/scalar/scalar/pull/7392) [`d86f1d6`](https://github.com/scalar/scalar/commit/d86f1d6911ecbca70b011a2a0efb6d6e0eca59bb) Thanks [@amritk](https://github.com/amritk)! - fix: move away from wasm hashing algo
+
+- [#7287](https://github.com/scalar/scalar/pull/7287) [`dd5c518`](https://github.com/scalar/scalar/commit/dd5c518a422dddc7948c0253861101cf741b6af0) Thanks [@DemonHa](https://github.com/DemonHa)! - fix: correctly update the parameter examples
+
+- [#7329](https://github.com/scalar/scalar/pull/7329) [`4cda566`](https://github.com/scalar/scalar/commit/4cda566c2dc2cf306e4e3597e292ae1c2dadd78c) Thanks [@DemonHa](https://github.com/DemonHa)! - fix: setting nested proxies directly cases problems
+
+- [#7365](https://github.com/scalar/scalar/pull/7365) [`4059e68`](https://github.com/scalar/scalar/commit/4059e68375d31ec0142a8019b385bc3ac82055fc) Thanks [@amritk](https://github.com/amritk)! - feat: added hot keys to client v2
+
+- Updated dependencies [[`d86f1d6`](https://github.com/scalar/scalar/commit/d86f1d6911ecbca70b011a2a0efb6d6e0eca59bb), [`44aeef0`](https://github.com/scalar/scalar/commit/44aeef01073801165e339163462378b7b62ff68d), [`a68b1af`](https://github.com/scalar/scalar/commit/a68b1afc54b2aa95a224fee89c3266bffed57215), [`cbedfab`](https://github.com/scalar/scalar/commit/cbedfab576502069be27ceacbea145a917214e47), [`a68b1af`](https://github.com/scalar/scalar/commit/a68b1afc54b2aa95a224fee89c3266bffed57215), [`5a108fc`](https://github.com/scalar/scalar/commit/5a108fcbc52ae7957731c23689896ba353b83d3b), [`cded2d6`](https://github.com/scalar/scalar/commit/cded2d6c087418c3c44731d344d0827a87b78b74), [`cbedfab`](https://github.com/scalar/scalar/commit/cbedfab576502069be27ceacbea145a917214e47)]:
+  - @scalar/json-magic@0.8.2
+  - @scalar/helpers@0.1.2
+  - @scalar/types@0.5.0
+  - @scalar/object-utils@1.2.12
+  - @scalar/themes@0.13.24
+  - @scalar/openapi-upgrader@0.1.4
+  - @scalar/snippetz@0.5.3
+  - @scalar/code-highlight@0.2.0
+
 ## 0.20.0
 
 ### Minor Changes

package/README.md

@@ -213,7 +213,7 @@ store.workspace.activeDocument
 store.workspace.documents['document']
 
 // Update global workspace settings
-store.update('x-scalar-dark-mode', true)
+store.update('x-scalar-color-mode', true)
 
 // Update settings for the active document
 store.updateDocument('active', "x-scalar-active-auth", '<value>')
@@ -431,7 +431,7 @@ await store.importWorkspaceFromSpecification({
       ],
     },
   },
-  'x-scalar-dark-mode': true,
+  'x-scalar-color-mode': true,
 })
 ```
 

package/dist/client.d.ts

@@ -1,8 +1,8 @@
 import { type Difference, merge } from '@scalar/json-magic/diff';
 import type { PartialDeep, RequiredDeep } from 'type-fest';
-import { type InMemoryWorkspace } from './schemas/inmemory-workspace.js';
+import type { InMemoryWorkspace } from './schemas/inmemory-workspace.js';
 import { type OpenApiDocument } from './schemas/v3.1/strict/openapi-document.js';
-import type { Workspace, WorkspaceDocumentMeta, WorkspaceMeta } from './schemas/workspace.js';
+import type { Workspace, WorkspaceDocumentMeta, WorkspaceExtensions, WorkspaceMeta } from './schemas/workspace.js';
 import type { WorkspaceSpecification } from './schemas/workspace-specification/index.js';
 import type { Config, DocumentConfiguration } from './schemas/workspace-specification/config.js';
 import type { WorkspacePlugin } from './workspace-plugin.js';
@@ -75,7 +75,7 @@ export type WorkspaceStore = {
      * // Update the workspace title
      * update('x-scalar-active-document', 'document-name')
      */
-    update<K extends keyof WorkspaceMeta>(key: K, value: WorkspaceMeta[K]): void;
+    update<K extends keyof WorkspaceMeta | keyof WorkspaceExtensions>(key: K, value: (WorkspaceMeta & WorkspaceExtensions)[K]): void;
     /**
      * Updates a specific metadata field in a document
      * @param name - The name of the document to update ('active' or a specific document name)
@@ -136,7 +136,36 @@ export type WorkspaceStore = {
      *   }
      * })
      */
-    addDocument(input: WorkspaceDocumentInput): Promise<void>;
+    addDocument(input: WorkspaceDocumentInput): Promise<boolean>;
+    /**
+     * Deletes a document from the workspace and all associated data.
+     *
+     * This method removes the document from the workspace along with all related data including:
+     * - The document itself from the workspace documents map
+     * - Original document data
+     * - Intermediate document data (saved local versions)
+     * - Document-specific configuration
+     * - Document overrides
+     * - Extra document configurations
+     *
+     * If the deleted document was the active document, the active document is automatically
+     * reset to the first remaining document in the workspace, or undefined if no documents remain.
+     *
+     * The deletion is automatically tracked by the workspace change detection system,
+     * and appropriate events will be fired to notify registered plugins.
+     *
+     * @param documentName - The name of the document to delete
+     * @returns void
+     *
+     * @example
+     * // Delete the document named 'api'
+     * store.deleteDocument('api')
+     *
+     * @example
+     * // Delete multiple documents
+     * ['api', 'petstore'].forEach(name => store.deleteDocument(name))
+     */
+    deleteDocument(documentName: string): void;
     /**
      * Returns the merged configuration for the active document.
      *
@@ -149,6 +178,18 @@ export type WorkspaceStore = {
      * falling back to the first document if none is specified.
      */
     readonly config: typeof defaultConfig;
+    /**
+     * Returns the merged configuration for a specific document.
+     *
+     * This method merges configurations in the following order of precedence:
+     * 1. Document-specific configuration (highest priority)
+     * 2. Workspace-level configuration
+     * 3. Default configuration (lowest priority)
+     *
+     * @param documentName - The name of the document to get the configuration for
+     * @returns The merged configuration for the specified document
+     */
+    getDocumentConfiguration(documentName: string): typeof defaultConfig;
     /**
      * Exports the specified document in the requested format.
      *
@@ -208,6 +249,13 @@ export type WorkspaceStore = {
      * const excludedDiffs = store.saveDocument('api')
      */
     saveDocument(documentName: string): Promise<unknown[] | undefined>;
+    /**
+     * Builds the sidebar for the specified document.
+     *
+     * @param documentName - The name of the document to build the sidebar for
+     * @returns boolean indicating if the sidebar was built successfully
+     */
+    buildSidebar: (documentName: string) => boolean;
     /**
      * Restores the specified document to its last locally saved state.
      *
@@ -277,13 +325,13 @@ export type WorkspaceStore = {
      *   },
      *   info: { title: 'My Workspace' },
      *   workspace: 'v1',
-     *   "x-scalar-dark-mode": true
+     *   "x-scalar-color-mode": true
      * })
      * ```
      *
      * @param specification - The workspace specification to import.
      */
-    importWorkspaceFromSpecification(specification: WorkspaceSpecification): Promise<void[]>;
+    importWorkspaceFromSpecification(specification: WorkspaceSpecification): Promise<boolean[]>;
     /**
      * Rebases a document in the workspace by refetching its origin and merging with local edits.
      *

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,UAAU,EAAe,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAM7E,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAgB1D,OAAO,EAAE,KAAK,iBAAiB,EAA2B,MAAM,8BAA8B,CAAA;AAG9F,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC1F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAA6B,MAAM,oBAAoB,CAAA;AASpF,QAAA,MAAM,aAAa,EAAE,YAAY,CAAC,MAAM,CAEvC,CAAA;AAED;;;GAGG;AACH,KAAK,0BAA0B,GAAG;IAChC,wEAAwE;IACxE,IAAI,CAAC,EAAE,qBAAqB,CAAA;IAC5B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,iCAAiC;IACjC,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAA;IACxC,wIAAwI;IACxI,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC5F,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,0BAA0B,CAAA;AAE9B,iGAAiG;AACjG,MAAM,MAAM,SAAS,GAAG;IACtB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,GAAG,0BAA0B,CAAA;AAE9B;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,SAAS,CAAA;AAiDvD;;;GAGG;AACH,KAAK,cAAc,GAAG;IACpB,gFAAgF;IAChF,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC5B,8CAA8C;IAC9C,KAAK,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAA;IACvC,iEAAiE;IACjE,OAAO,CAAC,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,aAAa,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAC5E;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAClD,IAAI,EAAE,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAC9B,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAA;IACP;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,aAAa,CAAA;IACrC;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IACnG;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IACnF;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAAA;IAClE;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D;;;;;;;;;OASG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C;;;;;;;;;;OAUG;IACH,eAAe,IAAI,iBAAiB,CAAA;IACpC;;;;;;;;OAQG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gCAAgC,CAAC,aAAa,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;IACxF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,OAAO,CACtD;QAAE,EAAE,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,iBAAiB,GAAG,cAAc,GAAG,qBAAqB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAChG;QACE,EAAE,EAAE,IAAI,CAAA;QACR,SAAS,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,WAAW,CAAC,CAAA;QAChD,YAAY,EAAE,CAAC,iBAAiB,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC1E,CACJ,CAAA;CACF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,iBAAiB,cAAc,KAAG,cAotBtE,CAAA;AAGD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,UAAU,EAAe,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAK7E,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAgB1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAGrE,OAAO,EAEL,KAAK,eAAe,EACrB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAC/G,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAA;AAC/E,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAA6B,MAAM,oBAAoB,CAAA;AASpF,QAAA,MAAM,aAAa,EAAE,YAAY,CAAC,MAAM,CAEvC,CAAA;AAED;;;GAGG;AACH,KAAK,0BAA0B,GAAG;IAChC,wEAAwE;IACxE,IAAI,CAAC,EAAE,qBAAqB,CAAA;IAC5B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,qCAAqC;IACrC,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,iCAAiC;IACjC,SAAS,CAAC,EAAE,WAAW,CAAC,eAAe,CAAC,CAAA;IACxC,wIAAwI;IACxI,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC5F,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ,GAAG,0BAA0B,CAAA;AAE9B,iGAAiG;AACjG,MAAM,MAAM,SAAS,GAAG;IACtB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,GAAG,0BAA0B,CAAA;AAE9B;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,SAAS,CAAA;AAiDvD;;;GAGG;AACH,KAAK,cAAc,GAAG;IACpB,gFAAgF;IAChF,IAAI,CAAC,EAAE,aAAa,CAAA;IACpB,8BAA8B;IAC9B,MAAM,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC5B,8CAA8C;IAC9C,KAAK,CAAC,EAAE,sBAAsB,CAAC,OAAO,CAAC,CAAA;IACvC,iEAAiE;IACjE,OAAO,CAAC,EAAE,eAAe,EAAE,CAAA;CAC5B,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B;;;;;;;OAOG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,aAAa,GAAG,MAAM,mBAAmB,EAC9D,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC,GAC9C,IAAI,CAAA;IACP;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,CAAC,SAAS,MAAM,qBAAqB,EAClD,IAAI,EAAE,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,EAC9B,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAC9B,IAAI,CAAA;IACP;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpF;;;;;;;;;;OAUG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IACzC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC5D;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,MAAM,EAAE,OAAO,aAAa,CAAA;IACrC;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,aAAa,CAAA;IACpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IACnG;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IACnF;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,CAAA;IAClE;;;;;OAKG;IACH,YAAY,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,CAAA;IAC/C;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1D;;;;;;;;;OASG;IACH,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1C;;;;;;;;;;OAUG;IACH,eAAe,IAAI,iBAAiB,CAAA;IACpC;;;;;;;;OAQG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAC7C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,gCAAgC,CAAC,aAAa,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;IAC3F;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,OAAO,CACtD;QAAE,EAAE,EAAE,KAAK,CAAC;QAAC,IAAI,EAAE,iBAAiB,GAAG,cAAc,GAAG,qBAAqB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAChG;QACE,EAAE,EAAE,IAAI,CAAA;QACR,SAAS,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,WAAW,CAAC,CAAA;QAChD,YAAY,EAAE,CAAC,iBAAiB,EAAE,UAAU,CAAC,OAAO,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;KAC1E,CACJ,CAAA;CACF,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,GAAI,iBAAiB,cAAc,KAAG,cAuxBtE,CAAA;AAGD,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA"}

package/dist/client.js

@@ -1,8 +1,9 @@
+import { preventPollution } from "@scalar/helpers/object/prevent-pollution";
+import { generateHash } from "@scalar/helpers/string/generate-hash";
 import { measureAsync, measureSync } from "@scalar/helpers/testing/measure";
 import { bundle } from "@scalar/json-magic/bundle";
 import { fetchUrls } from "@scalar/json-magic/bundle/plugins/browser";
 import { apply, diff, merge } from "@scalar/json-magic/diff";
-import { generateHash } from "@scalar/json-magic/helpers/generate-hash";
 import { createMagicProxy, getRaw } from "@scalar/json-magic/magic-proxy";
 import { upgrade } from "@scalar/openapi-upgrader";
 import { Value } from "@scalar/typebox/value";
@@ -20,7 +21,6 @@ import { createNavigation } from "./navigation/index.js";
 import { externalValueResolver, loadingStatus, refsEverywhere, restoreOriginalRefs } from "./plugins/bundler/index.js";
 import { getServersFromDocument } from "./preprocessing/server.js";
 import { extensions } from "./schemas/extensions.js";
-import { InMemoryWorkspaceSchema } from "./schemas/inmemory-workspace.js";
 import { defaultReferenceConfig } from "./schemas/reference-config/index.js";
 import { coerceValue } from "./schemas/typebox-coerce.js";
 import {
@@ -110,7 +110,7 @@ const createWorkspaceStore = (workspaceProps) => {
             const { activeDocument: _a, documents: _d, ...meta } = workspace;
             const event = {
               type: "meta",
-              value: unpackProxyObject(meta)
+              value: unpackProxyObject(meta, { depth: 1 })
             };
             fireWorkspaceChange(event);
             return;
@@ -325,7 +325,7 @@ const createWorkspaceStore = (workspaceProps) => {
       "loadDocument",
       async () => await loadDocument({ ...input, fetch: input.fetch ?? workspaceProps?.fetch })
     );
-    await measureAsync("addDocument", async () => {
+    return await measureAsync("addDocument", async () => {
       if (!resolve.ok) {
         console.error(`Failed to fetch document '${name}': request was not successful`);
         workspace.documents[name] = {
@@ -337,7 +337,7 @@ const createWorkspaceStore = (workspaceProps) => {
           },
           "x-scalar-original-document-hash": "not-a-hash"
         };
-        return;
+        return false;
       }
       if (!isObject(resolve.data)) {
         console.error(`Failed to load document '${name}': response data is not a valid object`);
@@ -350,16 +350,27 @@ const createWorkspaceStore = (workspaceProps) => {
           },
           "x-scalar-original-document-hash": "not-a-hash"
         };
-        return;
+        return false;
       }
       await addInMemoryDocument({
         ...input,
         document: resolve.data,
         documentSource: getDocumentSource(input),
-        documentHash: await generateHash(resolve.raw)
+        documentHash: generateHash(resolve.raw)
       });
+      return true;
     });
   }
+  const buildSidebar = (documentName) => {
+    const document = workspace.documents[documentName];
+    if (!document) {
+      console.error(`Document '${documentName}' does not exist in the workspace.`);
+      return false;
+    }
+    const navigation = createNavigation(documentName, document, getDocumentConfiguration(documentName));
+    document[extensions.document.navigation] = navigation;
+    return true;
+  };
   const getDocumentConfiguration = (name) => {
     return mergeObjects(
       mergeObjects(deepClone(defaultConfig), workspaceProps?.config ?? {}),
@@ -372,9 +383,7 @@ const createWorkspaceStore = (workspaceProps) => {
       return workspace;
     },
     update(key, value) {
-      if (key === "__proto__" || key === "constructor" || key === "prototype") {
-        throw new Error("Invalid key: cannot modify prototype");
-      }
+      preventPollution(key);
       Object.assign(workspace, { [key]: value });
     },
     updateDocument(name, key, value) {
@@ -382,6 +391,7 @@ const createWorkspaceStore = (workspaceProps) => {
       if (!currentDocument) {
         throw "Please select a valid document";
       }
+      preventPollution(key);
       Object.assign(currentDocument, { [key]: value });
     },
     async replaceDocument(documentName, input) {
@@ -420,11 +430,39 @@ const createWorkspaceStore = (workspaceProps) => {
       });
     },
     addDocument,
+    /**
+     * Deletes a document from the workspace and all associated data.
+     *
+     * This function removes the document and all related data structures.
+     * If the deleted document was active, it automatically selects the first remaining document.
+     */
+    deleteDocument: (documentName) => {
+      if (!workspace.documents[documentName]) {
+        return;
+      }
+      delete workspace.documents[documentName];
+      delete originalDocuments[documentName];
+      delete intermediateDocuments[documentName];
+      delete documentConfigs[documentName];
+      delete overrides[documentName];
+      delete extraDocumentConfigurations[documentName];
+      const remainingDocuments = Object.keys(workspace.documents);
+      const wasActiveDocument = workspace["x-scalar-active-document"] === documentName;
+      if (wasActiveDocument) {
+        workspace["x-scalar-active-document"] = remainingDocuments[0] ?? void 0;
+      }
+      fireWorkspaceChange({
+        type: "deleteDocument",
+        documentName
+      });
+    },
     get config() {
       return getDocumentConfiguration(getActiveDocumentName());
     },
+    getDocumentConfiguration,
     exportDocument,
     exportActiveDocument: (format, minify) => exportDocument(getActiveDocumentName(), format, minify),
+    buildSidebar,
     saveDocument,
     async revertDocumentChanges(documentName) {
       const workspaceDocument = workspace.documents[documentName];
@@ -444,42 +482,41 @@ const createWorkspaceStore = (workspaceProps) => {
       console.warn(`Commit operation for document '${documentName}' is not implemented yet.`);
     },
     exportWorkspace() {
+      const { activeDocument: _, documents, ...meta } = unpackProxyObject(workspace);
       return {
         documents: {
           ...Object.fromEntries(
-            Object.entries(workspace.documents).map(([name, doc]) => [
+            Object.entries(documents).map(([name, doc]) => [
               name,
-              // Extract the raw document data for export, removing any Vue reactivity wrappers.
-              // When importing, the document can be wrapped again in a magic proxy.
-              toRaw(getRaw(unpackOverridesProxy(doc)))
+              // Get the raw document without any proxies
+              unpackProxyObject(doc)
             ])
           )
         },
-        meta: workspaceProps?.meta ?? {},
-        documentConfigs,
-        originalDocuments,
-        intermediateDocuments,
-        overrides
+        meta: unpackProxyObject(meta) ?? {},
+        documentConfigs: unpackProxyObject(documentConfigs),
+        originalDocuments: unpackProxyObject(originalDocuments),
+        intermediateDocuments: unpackProxyObject(intermediateDocuments),
+        overrides: unpackProxyObject(overrides)
       };
     },
     loadWorkspace(input) {
-      const result = coerceValue(InMemoryWorkspaceSchema, input);
       safeAssign(
         workspace.documents,
         Object.fromEntries(
-          Object.entries(result.documents).map(([name, doc]) => [
+          Object.entries(input.documents).map(([name, doc]) => [
             name,
             createOverridesProxy(createMagicProxy(doc), {
-              overrides: result.overrides[name]
+              overrides: input.overrides[name]
             })
           ])
         )
       );
-      safeAssign(originalDocuments, result.originalDocuments);
-      safeAssign(intermediateDocuments, result.intermediateDocuments);
-      safeAssign(documentConfigs, result.documentConfigs);
-      safeAssign(overrides, result.overrides);
-      safeAssign(workspace, result.meta);
+      safeAssign(originalDocuments, input.originalDocuments);
+      safeAssign(intermediateDocuments, input.intermediateDocuments);
+      safeAssign(documentConfigs, input.documentConfigs);
+      safeAssign(overrides, input.overrides);
+      safeAssign(workspace, input.meta);
     },
     importWorkspaceFromSpecification: (specification) => {
       const { documents, overrides: overrides2, info: _info, workspace: _workspaceVersion, ...meta } = specification;
@@ -513,7 +550,7 @@ const createWorkspaceStore = (workspaceProps) => {
           message: `Failed to fetch document '${name}': request was not successful or returned invalid data`
         };
       }
-      const newHash = await generateHash(resolve.raw);
+      const newHash = generateHash(resolve.raw);
       if (activeDocument["x-scalar-original-document-hash"] === newHash) {
         return {
           ok: false,
@@ -561,7 +598,7 @@ const createWorkspaceStore = (workspaceProps) => {
             },
             documentSource: getDocumentSource(input),
             // Update the original document hash
-            documentHash: await generateHash(resolve.raw),
+            documentHash: generateHash(resolve.raw),
             initialize: false
           });
         }