@scalar/workspace-store 0.48.0 → 0.49.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/workspace-store
 
+## 0.49.1
+
+### Patch Changes
+
+- [#9049](https://github.com/scalar/scalar/pull/9049): Flush pending debounced operation edits before executing API client requests.
+- [#9023](https://github.com/scalar/scalar/pull/9023): chore: use homemade slugger
+
+## 0.49.0
+
+### Minor Changes
+
+- [#9045](https://github.com/scalar/scalar/pull/9045): feat: extra metadata for registry documents
+- [#9045](https://github.com/scalar/scalar/pull/9045): chore: migrate api-client from namespaces to teamSlug and convert team workspaces
+
+### Patch Changes
+
+- [#9043](https://github.com/scalar/scalar/pull/9043): chore: move test documents to cdn
+- [#9045](https://github.com/scalar/scalar/pull/9045): feat: added once back to the event bus
+
 ## 0.48.0
 
 ### Minor Changes

package/dist/events/bus.d.ts

@@ -81,6 +81,10 @@ export type WorkspaceEventBus = {
      * bus.emit('scalar-update-sidebar', { value: true })
      */
     emit<E extends keyof ApiReferenceEvents>(...args: EmitParameters<E>): void;
+    /**
+     * Flush all queued debounced emits immediately.
+     */
+    flushDebouncedEmits?(): 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":"AAIA,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;;;;;;GAMG;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,EAAE,OAAO,CAAC,EAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GAC1G,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAE7G;;;;;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;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAA;IAE3F;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,GAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;CAC3E,CAAA;AAED;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAS,eAAoB,KAAG,iBAsKvE,CAAA"}
+{"version":3,"file":"bus.d.ts","sourceRoot":"","sources":["../../src/events/bus.ts"],"names":[],"mappings":"AAIA,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;;;;;;GAMG;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,EAAE,OAAO,CAAC,EAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GAC1G,CAAC,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE;IAAE,eAAe,CAAC,EAAE,OAAO,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAE7G;;;;;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;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,WAAW,CAAA;IAE3F;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,CAAC,SAAS,MAAM,kBAAkB,EAAE,GAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,IAAI,CAAA;IAE1E;;OAEG;IACH,mBAAmB,CAAC,IAAI,IAAI,CAAA;CAC7B,CAAA;AAED;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,uBAAuB,GAAI,UAAS,eAAoB,KAAG,iBA6KvE,CAAA"}

package/dist/events/bus.js

@@ -34,7 +34,9 @@ export const createWorkspaceEventBus = (options = {}) => {
      * Single debounce instance for all debounced emits
      * Uses keys to separate different event + debounceKey combinations
      */
-    const { execute: debouncedEmitter } = debounce({ delay: 328 });
+    const { execute: debouncedEmitter, flushAll: flushDebouncedEmitters } = debounce({
+        delay: 328,
+    });
     /**
      * Get or create a listener set for an event
      */
@@ -148,10 +150,14 @@ export const createWorkspaceEventBus = (options = {}) => {
         // Pass the closure directly - debounce will store the latest version
         debouncedEmitter(debounceMapKey, () => performEmit(event, payload, options));
     };
+    const flushDebouncedEmits = () => {
+        flushDebouncedEmitters();
+    };
     return {
         on,
         once,
         off,
         emit,
+        flushDebouncedEmits,
     };
 };

package/dist/navigation/get-navigation-options.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-navigation-options.d.ts","sourceRoot":"","sources":["../../src/navigation/get-navigation-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAG/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,MAAM,MAAM,iBAAiB,GACzB,OAAO,CACL,IAAI,CACF,4BAA4B,EAC1B,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,GACnB,kBAAkB,GAClB,YAAY,GACZ,YAAY,CACf,CACF,GACD,SAAS,CAAA;AAEb;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,MAAM,EAAE,UAAU,iBAAiB,KAAG,mBAiHxF,CAAA"}
+{"version":3,"file":"get-navigation-options.d.ts","sourceRoot":"","sources":["../../src/navigation/get-navigation-options.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAA;AAE/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AAG7D,MAAM,MAAM,iBAAiB,GACzB,OAAO,CACL,IAAI,CACF,4BAA4B,EAC1B,qBAAqB,GACrB,iBAAiB,GACjB,uBAAuB,GACvB,qBAAqB,GACrB,mBAAmB,GACnB,kBAAkB,GAClB,YAAY,GACZ,YAAY,CACf,CACF,GACD,SAAS,CAAA;AAEb;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,MAAM,EAAE,UAAU,iBAAiB,KAAG,mBAiHxF,CAAA"}

package/dist/navigation/get-navigation-options.js

@@ -1,4 +1,4 @@
-import { slug } from 'github-slugger';
+import { slugify } from '@scalar/helpers/string/slugify';
 /**
  * Returns options for traversing an OpenAPI document, allowing customization of
  * how IDs and slugs are generated for tags, headings, models, operations, and webhooks.
@@ -6,7 +6,7 @@ import { slug } from 'github-slugger';
  */
 export const getNavigationOptions = (documentName, options) => {
     const generateId = (props) => {
-        const documentId = `${slug(documentName)}`;
+        const documentId = slugify(documentName);
         // -------- Default text id generation logic --------
         if (props.type === 'text') {
             if (options?.generateHeadingSlug) {
@@ -25,7 +25,7 @@ export const getNavigationOptions = (documentName, options) => {
             if (options?.generateTagSlug) {
                 return `${documentId}/${tagPrefix}/${options.generateTagSlug(props.tag)}`;
             }
-            return `${documentId}/${tagPrefix}/${slug(props.tag.name ?? '')}`;
+            return `${documentId}/${tagPrefix}/${slugify(props.tag.name ?? '')}`;
         }
         // -------- Default operation id generation logic --------
         if (props.type === 'operation') {
@@ -61,7 +61,7 @@ export const getNavigationOptions = (documentName, options) => {
                     method: props.method?.toUpperCase(),
                 })}`;
             }
-            return `${prefixTag}webhook/${props.method?.toUpperCase()}/${slug(props.name)}`;
+            return `${prefixTag}webhook/${props.method?.toUpperCase()}/${slugify(props.name)}`;
         }
         // -------- Default model id generation logic --------
         if (props.type === 'model') {
@@ -80,10 +80,10 @@ export const getNavigationOptions = (documentName, options) => {
                     name: props.name,
                 })}`;
             }
-            return `${prefixTag}model/${slug(props.name, true)}`;
+            return `${prefixTag}model/${slugify(props.name, { preserveCase: true })}`;
         }
         if (props.type === 'example') {
-            return `${props.parentId}/example/${slug(props.name)}`;
+            return `${props.parentId}/example/${slugify(props.name)}`;
         }
         if (props.type === 'document') {
             // -------- Default document id generation logic --------

package/dist/navigation/helpers/utils.js

@@ -1,5 +1,5 @@
 import { getMarkdownHeadings } from '@scalar/helpers/markdown/get-markdown-headings';
-import GithubSlugger from 'github-slugger';
+import { slugger } from '@scalar/helpers/string/slugger';
 /**
  * Adds URL-friendly slugs to each heading in the array.
  * Uses GithubSlugger to generate consistent slugs that match GitHub's heading anchor format.
@@ -21,10 +21,10 @@ import GithubSlugger from 'github-slugger';
  * //   { value: 'Installation', depth: 2, slug: 'installation' }
  * // ]
  */
-const withSlugs = (headings, slugger) => headings.map((heading) => {
+const withSlugs = (headings, slug) => headings.map((heading) => {
     return {
         ...heading,
-        slug: slugger.slug(heading.value),
+        slug: slug(heading.value),
     };
 });
 /**
@@ -49,9 +49,9 @@ const withSlugs = (headings, slugger) => headings.map((heading) => {
  * // ]
  */
 export function getHeadingsFromMarkdown(input) {
-    const slugger = new GithubSlugger();
+    const { slug } = slugger();
     const headings = getMarkdownHeadings(input);
-    return withSlugs(headings, slugger);
+    return withSlugs(headings, slug);
 }
 /**
  * Returns the lowest heading level from a list of headings.

package/package.json

@@ -16,7 +16,7 @@
     "openapi",
     "scalar"
   ],
-  "version": "0.48.0",
+  "version": "0.49.1",
   "engines": {
     "node": ">=22"
   },
@@ -139,17 +139,16 @@
   ],
   "dependencies": {
     "@scalar/typebox": "0.1.3",
-    "github-slugger": "2.0.0",
     "js-base64": "^3.7.8",
     "type-fest": "^5.3.1",
     "vue": "^3.5.30",
     "yaml": "^2.8.3",
-    "@scalar/helpers": "0.5.3",
-    "@scalar/json-magic": "0.12.9",
-    "@scalar/openapi-upgrader": "0.2.6",
-    "@scalar/snippetz": "0.9.3",
-    "@scalar/types": "0.9.3",
-    "@scalar/validation": "0.3.1"
+    "@scalar/json-magic": "0.12.11",
+    "@scalar/helpers": "0.5.5",
+    "@scalar/openapi-upgrader": "0.2.7",
+    "@scalar/validation": "0.3.2",
+    "@scalar/types": "0.9.5",
+    "@scalar/snippetz": "0.9.5"
   },
   "devDependencies": {
     "@google-cloud/storage": "7.16.0",
@@ -163,6 +162,7 @@
     "generate-json-schemas": "tsx ./scripts/generate-json-schemas.ts",
     "generate-openapi-types": "tsx ./scripts/generate-openapi-types.ts",
     "test": "vitest --run",
+    "test:watch": "vitest",
     "types:check": "tsc --noEmit"
   }
 }