@scalar/oas-utils 0.15.3 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,35 @@
 # @scalar/oas-utils
 
+## 0.17.0
+
+### Minor Changes
+
+- [#9211](https://github.com/scalar/scalar/pull/9211): feat: UID-based workspaces and local-team migration
+
+  IndexedDB v2 migrates existing data into the new shape, collapses all workspaces into the local team (aligned with a single team workspace on the client for now), resolves slug collisions deterministically, re-keys chunk stores by workspaceUid, and strips x-scalar-tabs and x-scalar-active-tab from meta chunks so routing does not follow stale paths after migration or slug changes.
+
+- [#9211](https://github.com/scalar/scalar/pull/9211): feat: make `WorkspaceDocument` an union of OpenApiDocument and AsyncApiDocument
+
+### Patch Changes
+
+- [#9211](https://github.com/scalar/scalar/pull/9211): refactor(oas-utils): drop local `migrations/semver` and use `isVersionLessThan` from `@scalar/helpers` in the workspace migrator. The previous `semverLessThan` export is removed from `@scalar/oas-utils/migrations`; import from `@scalar/helpers/general/compare-versions` instead.
+- [#9211](https://github.com/scalar/scalar/pull/9211): feat: add more analytics events
+
+## 0.16.0
+
+### Minor Changes
+
+- [#9195](https://github.com/scalar/scalar/pull/9195): feat: UID-based workspaces and local-team migration
+
+  IndexedDB v2 migrates existing data into the new shape, collapses all workspaces into the local team (aligned with a single team workspace on the client for now), resolves slug collisions deterministically, re-keys chunk stores by workspaceUid, and strips x-scalar-tabs and x-scalar-active-tab from meta chunks so routing does not follow stale paths after migration or slug changes.
+
+- [#9018](https://github.com/scalar/scalar/pull/9018): feat: make `WorkspaceDocument` an union of OpenApiDocument and AsyncApiDocument
+
+### Patch Changes
+
+- [#9063](https://github.com/scalar/scalar/pull/9063): refactor(oas-utils): drop local `migrations/semver` and use `isVersionLessThan` from `@scalar/helpers` in the workspace migrator. The previous `semverLessThan` export is removed from `@scalar/oas-utils/migrations`; import from `@scalar/helpers/general/compare-versions` instead.
+- [#9125](https://github.com/scalar/scalar/pull/9125): feat: add more analytics events
+
 ## 0.15.3
 
 ## 0.15.2

package/dist/helpers/client-plugins.d.ts

@@ -1,4 +1,4 @@
-import type { ApiReferenceEvents } from '@scalar/workspace-store/events';
+import type { AnyEventListener, ApiReferenceEvents, WorkspaceEventBus } from '@scalar/workspace-store/events';
 import type { RequestFactory, VariablesStore } from '@scalar/workspace-store/request-example';
 import type { OpenApiDocument } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
 import type { OperationObject } from '@scalar/workspace-store/schemas/v3.1/strict/operation';
@@ -113,13 +113,49 @@ export type ClientPlugin = {
     components?: Partial<ClientPluginComponents>;
     /** Lifecycle hooks for app-level concerns */
     lifecycle?: ClientPluginLifecycle;
-    /** Subscribe to event bus events. The framework handles subscribe/unsubscribe automatically. */
-    on?: Partial<{
-        [K in keyof ApiReferenceEvents]: (payload: ApiReferenceEvents[K]) => void;
-    }>;
+    /**
+     * Subscribe to every event on the bus. The framework wires this up to
+     * `bus.onAny` and handles subscribe/unsubscribe automatically.
+     *
+     * The listener receives a single tagged-union argument `{ event, payload }`
+     * where `event` is the discriminant. Narrowing on `event` automatically
+     * narrows `payload` to the exact type for that event — no casts, no `as`
+     * assertions, and no manual runtime type checks just to satisfy the
+     * compiler. Destructuring in the parameter list works too.
+     *
+     * @example
+     * on: ({ event, payload }) => {
+     *   if (event === 'log:user-login') {
+     *     // payload is narrowed to { uid: string; email?: string; teamUid: string }
+     *     posthog.identify(payload.uid, { email: payload.email })
+     *   }
+     *
+     *   if (event === 'operation:create:operation') {
+     *     // payload is narrowed to the operation-create payload
+     *     analytics.track('operation_created', payload)
+     *   }
+     * }
+     */
+    on?: AnyEventListener;
     /** Custom response body handlers for specific content types */
     responseBody?: ResponseBodyHandler[];
 };
+/**
+ * Subscribes a single plugin's `on` listener to the given event bus via `onAny`.
+ *
+ * The plugin's `on` is passed straight through to `bus.onAny`, so it will
+ * receive every event emitted on the bus as a `{ event, payload }` object.
+ * Plugins without an `on` listener get a no-op unsubscribe.
+ *
+ * Returns an unsubscribe function. Call it when the plugin is torn down or
+ * the bus is destroyed to remove the wildcard listener.
+ *
+ * @example
+ * const unsubscribe = subscribePluginEvents(eventBus, plugin)
+ * // later...
+ * unsubscribe()
+ */
+export declare const subscribePluginEvents: (eventBus: WorkspaceEventBus, plugin: ClientPlugin) => (() => void);
 /**
  * Maps hook names to their expected payload types.
  * This ensures type safety when executing hooks with their corresponding payloads.

package/dist/helpers/client-plugins.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AACnG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAErD,mEAAmE;AACnE,KAAK,uBAAuB,GAAG;IAC7B,4FAA4F;IAC5F,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,gEAAgE;IAChE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAC7F,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GACvD,CAAC;IAAE,YAAY,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAE/F,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACvB,aAAa,EAAE,CAAC,OAAO,EAAE;QACvB,sFAAsF;QACtF,cAAc,EAAE,cAAc,CAAA;QAC9B,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,QAAQ,CAAA;QAClB,0HAA0H;QAC1H,cAAc,EAAE,cAAc,CAAA;QAC9B,kDAAkD;QAClD,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B,CAAA;AAED,wDAAwD;AACxD,KAAK,qBAAqB,CACxB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,IACzD;IACF,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;IAChE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,qBAAqB,CAC5B;QACE,SAAS,CAAC,EAAE,eAAe,CAAA;KAG5B,EACD;QACE,4BAA4B,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,4BAA4B,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAAA;KAC7G,CACF,CAAA;IACD,QAAQ,EAAE,qBAAqB,CAAC;QAG9B,SAAS,CAAC,EAAE,eAAe,CAAA;KAC5B,CAAC,CAAA;CACH,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,+EAA+E;AAC/E,KAAK,qBAAqB,GAAG;IAC3B,gDAAgD;IAChD,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IAChE,uDAAuD;IACvD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IACvE,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC5C,6CAA6C;IAC7C,SAAS,CAAC,EAAE,qBAAqB,CAAA;IACjC,gGAAgG;IAChG,EAAE,CAAC,EAAE,OAAO,CAAC;SAAG,CAAC,IAAI,MAAM,kBAAkB,GAAG,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI;KAAE,CAAC,CAAA;IAC3F,+DAA+D;IAC/D,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACrC,CAAA;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;KACnB,CAAC,IAAI,MAAM,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,MAAM,cAAc,EAC9D,SAAS,cAAc,CAAC,CAAC,CAAC,EAC1B,UAAU,CAAC,EACX,SAAS,YAAY,EAAE,KACtB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAY3B,CAAA"}
+{"version":3,"file":"client-plugins.d.ts","sourceRoot":"","sources":["../../src/helpers/client-plugins.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAC7G,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAA;AAC7F,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8DAA8D,CAAA;AACnG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uDAAuD,CAAA;AAC5F,OAAO,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,KAAK,CAAA;AAErD,mEAAmE;AACnE,KAAK,uBAAuB,GAAG;IAC7B,4FAA4F;IAC5F,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,gEAAgE;IAChE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;IAC7F,4CAA4C;IAC5C,gBAAgB,CAAC,EAAE,SAAS,CAAA;CAC7B,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,mBAAmB,GAAG,uBAAuB,GACvD,CAAC;IAAE,YAAY,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,YAAY,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAE/F,oEAAoE;AACpE,KAAK,iBAAiB,GAAG;IACvB,aAAa,EAAE,CAAC,OAAO,EAAE;QACvB,sFAAsF;QACtF,cAAc,EAAE,cAAc,CAAA;QAC9B,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,gBAAgB,EAAE,CAAC,OAAO,EAAE;QAC1B,QAAQ,EAAE,QAAQ,CAAA;QAClB,0HAA0H;QAC1H,cAAc,EAAE,cAAc,CAAA;QAC9B,kDAAkD;QAClD,OAAO,EAAE,OAAO,CAAA;QAChB,QAAQ,EAAE,eAAe,CAAA;QACzB,SAAS,EAAE,eAAe,CAAA;QAC1B,cAAc,CAAC,EAAE,cAAc,CAAA;KAChC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3B,CAAA;AAED,wDAAwD;AACxD,KAAK,qBAAqB,CACxB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC,GAAG,EAAE,IACzD;IACF,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,CAAC,CAAA;IAChE,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,KAAK,sBAAsB,GAAG;IAC5B,OAAO,EAAE,qBAAqB,CAC5B;QACE,SAAS,CAAC,EAAE,eAAe,CAAA;KAG5B,EACD;QACE,4BAA4B,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,4BAA4B,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAAA;KAC7G,CACF,CAAA;IACD,QAAQ,EAAE,qBAAqB,CAAC;QAG9B,SAAS,CAAC,EAAE,eAAe,CAAA;KAC5B,CAAC,CAAA;CACH,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,+EAA+E;AAC/E,KAAK,qBAAqB,GAAG;IAC3B,gDAAgD;IAChD,MAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IAChE,uDAAuD;IACvD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAA;IACvE,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC,sBAAsB,CAAC,CAAA;IAC5C,6CAA6C;IAC7C,SAAS,CAAC,EAAE,qBAAqB,CAAA;IACjC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,EAAE,CAAC,EAAE,gBAAgB,CAAA;IACrB,+DAA+D;IAC/D,YAAY,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACrC,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,qBAAqB,GAAI,UAAU,iBAAiB,EAAE,QAAQ,YAAY,KAAG,CAAC,MAAM,IAAI,CAQpG,CAAA;AAED;;;;GAIG;AACH,KAAK,cAAc,GAAG;KACnB,CAAC,IAAI,MAAM,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,WAAW,GAAU,CAAC,SAAS,MAAM,cAAc,EAC9D,SAAS,cAAc,CAAC,CAAC,CAAC,EAC1B,UAAU,CAAC,EACX,SAAS,YAAY,EAAE,KACtB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAY3B,CAAA"}

package/dist/helpers/client-plugins.js

@@ -1,3 +1,26 @@
+/**
+ * Subscribes a single plugin's `on` listener to the given event bus via `onAny`.
+ *
+ * The plugin's `on` is passed straight through to `bus.onAny`, so it will
+ * receive every event emitted on the bus as a `{ event, payload }` object.
+ * Plugins without an `on` listener get a no-op unsubscribe.
+ *
+ * Returns an unsubscribe function. Call it when the plugin is torn down or
+ * the bus is destroyed to remove the wildcard listener.
+ *
+ * @example
+ * const unsubscribe = subscribePluginEvents(eventBus, plugin)
+ * // later...
+ * unsubscribe()
+ */
+export const subscribePluginEvents = (eventBus, plugin) => {
+    if (!plugin.on) {
+        return () => {
+            // no-op
+        };
+    }
+    return eventBus.onAny(plugin.on);
+};
 /**
  * Execute any hook with type-safe payload handling.
  * The payload type is inferred from the hook name to ensure correct usage.

package/dist/helpers/index.d.ts

@@ -1,3 +1,3 @@
-export { type ClientPlugin, type ResponseBodyHandler, executeHook } from './client-plugins.js';
+export { type ClientPlugin, type ResponseBodyHandler, executeHook, subscribePluginEvents } from './client-plugins.js';
 export { formatJsonOrYamlString, json, parseJsonOrYaml, transformToJson, yaml } from './parse.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC3F,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,eAAe,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,YAAY,EAAE,KAAK,mBAAmB,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAClH,OAAO,EAAE,sBAAsB,EAAE,IAAI,EAAE,eAAe,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA"}

package/dist/helpers/index.js

@@ -1,2 +1,2 @@
-export { executeHook } from './client-plugins.js';
+export { executeHook, subscribePluginEvents } from './client-plugins.js';
 export { formatJsonOrYamlString, json, parseJsonOrYaml, transformToJson, yaml } from './parse.js';

package/dist/migrations/index.d.ts

@@ -1,5 +1,4 @@
 export { DATA_VERSION, DATA_VERSION_LS_LEY } from './data-version.js';
 export { migrateLocalStorageToIndexDb, shouldMigrateToIndexDb, transformLegacyDataToWorkspace, } from './migrate-to-indexdb.js';
 export { migrator } from './migrator.js';
-export { semverLessThan } from './semver.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,GAC/B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/migrations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAClE,OAAO,EACL,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,GAC/B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA"}

package/dist/migrations/index.js

@@ -1,4 +1,3 @@
 export { DATA_VERSION, DATA_VERSION_LS_LEY } from './data-version.js';
 export { migrateLocalStorageToIndexDb, shouldMigrateToIndexDb, transformLegacyDataToWorkspace, } from './migrate-to-indexdb.js';
 export { migrator } from './migrator.js';
-export { semverLessThan } from './semver.js';

package/dist/migrations/migrate-to-indexdb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrate-to-indexdb.d.ts","sourceRoot":"","sources":["../../src/migrations/migrate-to-indexdb.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,+BAA+B,EAAE,MAAM,qCAAqC,CAAA;AAOrF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AAgB3F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAOnE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,4BAA4B,qBA6CxC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,GACjC,sBAAsB,OAAO,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,CAAC,WAAW,CAAC,KAC7F,OAAO,CAAC,OAAO,CAiBjB,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,8BAA8B,GAAU,YAAY;IAC/D,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC5B,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CAC/B;;;;IA8IA,CAAA"}
+{"version":3,"file":"migrate-to-indexdb.d.ts","sourceRoot":"","sources":["../../src/migrations/migrate-to-indexdb.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,+BAA+B,EAAwB,MAAM,qCAAqC,CAAA;AAO3G,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oDAAoD,CAAA;AAiB3F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAOnE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,4BAA4B,qBAuDxC,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,GACjC,sBAAsB,OAAO,CAAC,UAAU,CAAC,OAAO,+BAA+B,CAAC,CAAC,CAAC,WAAW,CAAC,KAC7F,OAAO,CAAC,OAAO,CAiBjB,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,8BAA8B,GAAU,YAAY;IAC/D,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAA;IAC5B,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CAC/B;;;;IAgJA,CAAA"}

package/dist/migrations/migrate-to-indexdb.js

@@ -8,9 +8,10 @@ import { extractServerFromPath } from '@scalar/helpers/url/extract-server-from-p
 import { presets } from '@scalar/themes';
 import { createWorkspaceStore } from '@scalar/workspace-store/client';
 import { AuthSchema } from '@scalar/workspace-store/entities/auth';
-import { createWorkspaceStorePersistence } from '@scalar/workspace-store/persistence';
+import { createWorkspaceStorePersistence, generateWorkspaceUid } from '@scalar/workspace-store/persistence';
 import { xScalarEnvironmentSchema, } from '@scalar/workspace-store/schemas/extensions/document/x-scalar-environments';
 import { xScalarCookieSchema } from '@scalar/workspace-store/schemas/extensions/general/x-scalar-cookies';
+import { isOpenApiDocument } from '@scalar/workspace-store/schemas/type-guards';
 import { coerceValue } from '@scalar/workspace-store/schemas/typebox-coerce';
 import { ColorModeSchema } from '@scalar/workspace-store/schemas/workspace';
 import { migrator } from '../migrations/migrator.js';
@@ -45,8 +46,18 @@ export const migrateLocalStorageToIndexDb = async () => {
         // Step 2: Transform to new workspace structure
         const workspaces = await transformLegacyDataToWorkspace(legacyData);
         const limit = createLimiter(MAX_CONCURRENT_DB_WRITES);
-        // Step 3: Save to IndexedDB
-        await Promise.all(workspaces.map((workspace) => limit(() => workspacePersistence.setItem({ teamSlug: 'local', slug: workspace.slug }, {
+        // Step 3: Save to IndexedDB. Every migrated workspace is keyed by a
+        // fresh `workspaceUid` and lands under the local team — legacy
+        // installs predate the team concept, so there is no team membership
+        // to preserve. The slug from legacy data becomes the URL-facing slug
+        // and is unique within the local team by construction (it derives
+        // from the legacy workspace UID).
+        await Promise.all(workspaces.map((workspace) => limit(() => workspacePersistence.setItem({
+            workspaceUid: generateWorkspaceUid(),
+            teamUid: 'local',
+            teamSlug: 'local',
+            slug: workspace.slug,
+        }, {
             name: workspace.name,
             workspace: workspace.workspace,
         }))));
@@ -183,7 +194,9 @@ export const transformLegacyDataToWorkspace = async (legacyData) => {
             });
         }
         const drafts = store.workspace.documents[DRAFTS_DOCUMENT_NAME];
-        if (drafts) {
+        // The drafts document is always OpenAPI-shaped (constructed above with `paths`); the
+        // guard narrows the WorkspaceDocument union so we can access `.paths` safely.
+        if (isOpenApiDocument(drafts)) {
             // Make sure the drafts document has a GET / route cuz that's the first route we navigate the user to
             drafts.paths ??= {};
             drafts.paths['/'] ??= {};

package/dist/migrations/migrator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"migrator.d.ts","sourceRoot":"","sources":["../../src/migrations/migrator.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,6CAA6C;AAC7C,eAAO,MAAM,QAAQ,QAAO;IAAE,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CAqDzF,CAAA"}
+{"version":3,"file":"migrator.d.ts","sourceRoot":"","sources":["../../src/migrations/migrator.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAEnE,6CAA6C;AAC7C,eAAO,MAAM,QAAQ,QAAO;IAAE,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IAAC,OAAO,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;CAqDzF,CAAA"}

package/dist/migrations/migrator.js

@@ -1,5 +1,5 @@
+import { isVersionLessThan } from '@scalar/helpers/general/compare-versions';
 import { getLocalStorageVersion, parseLocalStorage } from '../migrations/local-storage.js';
-import { semverLessThan } from '../migrations/semver.js';
 import { migrate_v_2_1_0 } from '../migrations/v-2.1.0/migration.js';
 import { migrate_v_2_2_0 } from '../migrations/v-2.2.0/migration.js';
 import { migrate_v_2_3_0 } from '../migrations/v-2.3.0/migration.js';
@@ -22,23 +22,23 @@ export const migrator = () => {
         workspaces: parseLocalStorage('workspace'),
     };
     // 0.0.0 -> 2.1.0 migration
-    if (semverLessThan(dataVersion, '2.1.0')) {
+    if (isVersionLessThan(dataVersion, '2.1.0')) {
         data = migrate_v_2_1_0(data);
     }
     // 2.1.0 -> 2.2.0 migration
-    if (semverLessThan(dataVersion, '2.2.0')) {
+    if (isVersionLessThan(dataVersion, '2.2.0')) {
         data = migrate_v_2_2_0(data);
     }
     // 2.2.0 -> 2.3.0 migration
-    if (semverLessThan(dataVersion, '2.3.0')) {
+    if (isVersionLessThan(dataVersion, '2.3.0')) {
         data = migrate_v_2_3_0(data);
     }
     // 2.3.0 -> 2.4.0 migration
-    if (semverLessThan(dataVersion, '2.4.0')) {
+    if (isVersionLessThan(dataVersion, '2.4.0')) {
         data = migrate_v_2_4_0(data);
     }
     // 2.4.0 -> 2.5.0 migration
-    if (semverLessThan(dataVersion, '2.5.0')) {
+    if (isVersionLessThan(dataVersion, '2.5.0')) {
         data = migrate_v_2_5_0(data);
     }
     // Convert to data array

package/package.json

@@ -16,7 +16,7 @@
     "specification",
     "yaml"
   ],
-  "version": "0.15.3",
+  "version": "0.17.0",
   "engines": {
     "node": ">=22"
   },
@@ -43,10 +43,10 @@
     "flatted": "^3.4.0",
     "vue": "^3.5.30",
     "yaml": "^2.8.3",
-    "@scalar/helpers": "0.6.0",
-    "@scalar/themes": "0.15.3",
-    "@scalar/workspace-store": "0.49.3",
-    "@scalar/types": "0.9.6"
+    "@scalar/helpers": "0.8.0",
+    "@scalar/workspace-store": "0.51.0",
+    "@scalar/types": "0.11.0",
+    "@scalar/themes": "0.15.5"
   },
   "devDependencies": {
     "@types/node": "^24.1.0",

package/dist/migrations/semver.d.ts

@@ -1,5 +0,0 @@
-/**
- * Compares semver versions and checks if the left one is less than the right
- */
-export declare const semverLessThan: (left: string, right: string) => boolean;
-//# sourceMappingURL=semver.d.ts.map

package/dist/migrations/semver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"semver.d.ts","sourceRoot":"","sources":["../../src/migrations/semver.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,OAAO,MAAM,KAAG,OAyB5D,CAAA"}

package/dist/migrations/semver.js

@@ -1,25 +0,0 @@
-/**
- * Compares semver versions and checks if the left one is less than the right
- */
-export const semverLessThan = (left, right) => {
-    // Parse the strings into numbers
-    const parseSemver = (version) => {
-        const [major = 0, minor = 0, patch = 0] = version.split('.').map((part) => Number.parseInt(part, 10));
-        return { major, minor, patch };
-    };
-    const { major: major1, minor: minor1, patch: patch1 } = parseSemver(left);
-    const { major: major2, minor: minor2, patch: patch2 } = parseSemver(right);
-    if (major1 < major2) {
-        return true;
-    }
-    if (major1 > major2) {
-        return false;
-    }
-    if (minor1 < minor2) {
-        return true;
-    }
-    if (minor1 > minor2) {
-        return false;
-    }
-    return patch1 < patch2;
-};