@scalar/workspace-store 0.19.0 → 0.21.0

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

@@ -1,12 +1,14 @@
 import type { EnvironmentEvents } from '../../events/definitions/environment.js';
-import type { ServerObject } from '../../schemas/v3.1/strict/openapi-document.js';
+import type { TabEvents } from '../../events/definitions/tabs.js';
+import type { WorkspaceEvents } from '../../events/definitions/workspace.js';
 import type { AnalyticsEvents } from './analytics.js';
 import type { AuthEvents } from './auth.js';
+import type { CookieEvents } from './cookie.js';
 import type { DocumentEvents } from './document.js';
 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 & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents<T> & UIEvents;
+export type ApiReferenceEvents = AuthEvents & AnalyticsEvents & CookieEvents & WorkspaceEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents & TabEvents & 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,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"}
+{"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,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAC1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAErE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AACxC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,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,GAAG,UAAU,GACzC,eAAe,GACf,YAAY,GACZ,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,YAAY,GACZ,SAAS,GACT,QAAQ,CAAA;AAEV,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA"}

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

@@ -2,16 +2,6 @@ import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 import type { OperationExampleMeta, OperationMeta } from '../../mutators/index.js';
 /** Event definitions for the operation */
 export type OperationEvents = {
-    /**
-     * Update the selected example for the operation
-     */
-    'update:selected-example': {
-        /** The name of the example to select */
-        name: string;
-    };
-    /** ------------------------------------------------------------------------------------------------
-     * Operation Actions
-     * ------------------------------------------------------------------------------------------------ */
     /**
      * Fires when the user requests to send the operation (e.g., triggers "Try It" or sends a request).
      * Contains the OperationExampleMeta, which identifies the operation and the example variant to use.
@@ -19,9 +9,6 @@ export type OperationEvents = {
     'operation:send:request': {
         meta: OperationExampleMeta;
     };
-    /** ------------------------------------------------------------------------------------------------
-     * Operation Draft Mutators
-     * ------------------------------------------------------------------------------------------------ */
     /**
      * Update the summary for the operation.
      * Triggers when the user edits the summary/description for an endpoint.

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

@@ -1 +1 @@
-{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAErE,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,yBAAyB,EAAE;QACzB,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IAED;;0GAEsG;IACtG;;;OAGG;IACH,wBAAwB,EAAE;QACxB,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;0GAEsG;IACtG;;;;OAIG;IACH,0BAA0B,EAAE;QAC1B,uDAAuD;QACvD,OAAO,EAAE;YACP,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;QACD,kFAAkF;QAClF,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;;OAGG;IACH,yBAAyB,EAAE;QACzB,OAAO,EAAE;YACP,uCAAuC;YACvC,MAAM,EAAE,UAAU,CAAA;SACnB,CAAA;QACD,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;;;;OAKG;IACH,uBAAuB,EAAE;QACvB,OAAO,EAAE;YACP,qCAAqC;YACrC,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;QACD,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;0GAEsG;IACtG;;OAEG;IACH,yBAAyB,EAAE;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C;;WAEG;QACH,OAAO,EAAE;YACP,uCAAuC;YACvC,GAAG,EAAE,MAAM,CAAA;YACX,iDAAiD;YACjD,KAAK,EAAE,MAAM,CAAA;YACb,uCAAuC;YACvC,SAAS,EAAE,OAAO,CAAA;SACnB,CAAA;QACD,kFAAkF;QAClF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,4BAA4B,EAAE;QAC5B;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;;;;WAKG;QACH,OAAO,EAAE,OAAO,CAAC;YACf,GAAG,EAAE,MAAM,CAAA;YACX,KAAK,EAAE,MAAM,CAAA;YACb,SAAS,EAAE,OAAO,CAAA;SACnB,CAAC,CAAA;QACF;;WAEG;QACH,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,4BAA4B,EAAE;QAC5B,0FAA0F;QAC1F,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C,kGAAkG;QAClG,KAAK,EAAE,MAAM,CAAA;QACb,qFAAqF;QACrF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,iCAAiC,EAAE;QACjC,2FAA2F;QAC3F,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAKD;;;OAGG;IACH,0CAA0C,EAAE;QAC1C,OAAO,EAAE;YACP,gDAAgD;YAChD,WAAW,EAAE,MAAM,CAAA;SACpB,CAAA;QACD,uFAAuF;QACvF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,oCAAoC,EAAE;QACpC,OAAO,EAAE;YACP,iDAAiD;YACjD,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;SACjC,CAAA;QACD,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,6FAA6F;QAC7F,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,mCAAmC,EAAE;QACnC,qEAAqE;QACrE,OAAO,EAAE,OAAO,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAA;QACvD,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,sFAAsF;QACtF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,sCAAsC,EAAE;QACtC,gFAAgF;QAChF,KAAK,EAAE,MAAM,CAAA;QACb,wEAAwE;QACxE,OAAO,EAAE,OAAO,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;SAAE,CAAC,CAAA;QAC/D,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,wFAAwF;QACxF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,sCAAsC,EAAE;QACtC,gFAAgF;QAChF,KAAK,EAAE,MAAM,CAAA;QACb,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,wFAAwF;QACxF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;CACF,CAAA"}
+{"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAErE,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAK5B;;;OAGG;IACH,wBAAwB,EAAE;QACxB,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAMD;;;;OAIG;IACH,0BAA0B,EAAE;QAC1B,uDAAuD;QACvD,OAAO,EAAE;YACP,OAAO,EAAE,MAAM,CAAA;SAChB,CAAA;QACD,kFAAkF;QAClF,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;;OAGG;IACH,yBAAyB,EAAE;QACzB,OAAO,EAAE;YACP,uCAAuC;YACvC,MAAM,EAAE,UAAU,CAAA;SACnB,CAAA;QACD,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;;;;OAKG;IACH,uBAAuB,EAAE;QACvB,OAAO,EAAE;YACP,qCAAqC;YACrC,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;QACD,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAED;;0GAEsG;IACtG;;OAEG;IACH,yBAAyB,EAAE;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C;;WAEG;QACH,OAAO,EAAE;YACP,uCAAuC;YACvC,GAAG,EAAE,MAAM,CAAA;YACX,iDAAiD;YACjD,KAAK,EAAE,MAAM,CAAA;YACb,uCAAuC;YACvC,SAAS,EAAE,OAAO,CAAA;SACnB,CAAA;QACD,kFAAkF;QAClF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,4BAA4B,EAAE;QAC5B;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;;;;WAKG;QACH,OAAO,EAAE,OAAO,CAAC;YACf,GAAG,EAAE,MAAM,CAAA;YACX,KAAK,EAAE,MAAM,CAAA;YACb,SAAS,EAAE,OAAO,CAAA;SACnB,CAAC,CAAA;QACF;;WAEG;QACH,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,4BAA4B,EAAE;QAC5B,0FAA0F;QAC1F,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C,kGAAkG;QAClG,KAAK,EAAE,MAAM,CAAA;QACb,qFAAqF;QACrF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,iCAAiC,EAAE;QACjC,2FAA2F;QAC3F,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;QAC5C,kEAAkE;QAClE,IAAI,EAAE,aAAa,CAAA;KACpB,CAAA;IAKD;;;OAGG;IACH,0CAA0C,EAAE;QAC1C,OAAO,EAAE;YACP,gDAAgD;YAChD,WAAW,EAAE,MAAM,CAAA;SACpB,CAAA;QACD,uFAAuF;QACvF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,oCAAoC,EAAE;QACpC,OAAO,EAAE;YACP,iDAAiD;YACjD,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;SACjC,CAAA;QACD,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,6FAA6F;QAC7F,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,mCAAmC,EAAE;QACnC,qEAAqE;QACrE,OAAO,EAAE,OAAO,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;SAAE,CAAC,CAAA;QACvD,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,sFAAsF;QACtF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,sCAAsC,EAAE;QACtC,gFAAgF;QAChF,KAAK,EAAE,MAAM,CAAA;QACb,wEAAwE;QACxE,OAAO,EAAE,OAAO,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;SAAE,CAAC,CAAA;QAC/D,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,wFAAwF;QACxF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAED;;;OAGG;IACH,sCAAsC,EAAE;QACtC,gFAAgF;QAChF,KAAK,EAAE,MAAM,CAAA;QACb,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAA;QACnB,wFAAwF;QACxF,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;CACF,CAAA"}

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

@@ -1,50 +1,42 @@
 import type { ServerObject } from '../../schemas/v3.1/strict/openapi-document.js';
-export type ServerEvents<T extends keyof ServerObject = keyof ServerObject> = {
+export type ServerEvents = {
     /**
-     * Add a new server to the document
+     * Add a new blank server to the document
      */
-    'add:server': {
-        /** The new server payload to add */
-        server: ServerObject;
-    };
+    'server:add:server': undefined;
     /**
-     * Delete a server from the document
+     * Update the entire server object
      */
-    'delete:server': {
-        /** The URL of the server to delete */
-        url: string;
+    'server:update:server': {
+        /** The index of the server to update */
+        index: number;
+        /** The new server payload to update */
+        server: Partial<ServerObject>;
     };
     /**
-     * Update the selected server via URL
+     * Delete a server from the document
      */
-    'update:selected-server': {
-        /** The new selected server URL */
-        url: string;
+    'server:delete:server': {
+        /** The index of the server to delete */
+        index: number;
     };
     /**
      * Update the selected server variable for the document
      */
-    'update:selected-server-variables': {
+    'server:update:variables': {
+        /** The index of the server to update */
+        index: number;
         /** The key of the variable to update */
         key: string;
         /** The new value of the variable */
         value: string;
     };
     /**
-     * Update the selected server properties for the document
+     * Update the selected server for the document
      */
-    'update:selected-server-properties': {
-        /** The key of the property to update */
-        key: T;
-        /** The new value of the property */
-        value: ServerObject[T];
-    };
-    /**
-     * Replace all servers in the document
-     */
-    'update:all-servers': {
-        /** The new servers to replace the current servers with */
-        servers: ServerObject[];
+    'server:update:selected': {
+        /** The URL of the server to select */
+        url: string;
     };
 };
 //# sourceMappingURL=server.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,YAAY,GAAG,MAAM,YAAY,IAAI;IAC5E;;OAEG;IACH,YAAY,EAAE;QACZ,oCAAoC;QACpC,MAAM,EAAE,YAAY,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,eAAe,EAAE;QACf,sCAAsC;QACtC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,kCAAkC;QAClC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;IACD;;OAEG;IACH,kCAAkC,EAAE;QAClC,wCAAwC;QACxC,GAAG,EAAE,MAAM,CAAA;QACX,oCAAoC;QACpC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,mCAAmC,EAAE;QACnC,wCAAwC;QACxC,GAAG,EAAE,CAAC,CAAA;QACN,oCAAoC;QACpC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,CAAA;KACvB,CAAA;IACD;;OAEG;IACH,oBAAoB,EAAE;QACpB,0DAA0D;QAC1D,OAAO,EAAE,YAAY,EAAE,CAAA;KACxB,CAAA;CACF,CAAA"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AAE1E,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,mBAAmB,EAAE,SAAS,CAAA;IAC9B;;OAEG;IACH,sBAAsB,EAAE;QACtB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;QACb,uCAAuC;QACvC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,CAAA;KAC9B,CAAA;IACD;;OAEG;IACH,sBAAsB,EAAE;QACtB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,yBAAyB,EAAE;QACzB,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;QACb,wCAAwC;QACxC,GAAG,EAAE,MAAM,CAAA;QACX,oCAAoC;QACpC,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,sCAAsC;QACtC,GAAG,EAAE,MAAM,CAAA;KACZ,CAAA;CACF,CAAA"}

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

@@ -0,0 +1,40 @@
+/** Event definitions to control the tabs */
+export type TabEvents = {
+    /**
+     * Add a new tab
+     */
+    'tabs:add:tab': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Closes the current tab
+     */
+    'tabs:close:tab': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Navigates to the previous tab
+     */
+    'tabs:navigate:previous': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Navigates to the next tab
+     */
+    'tabs:navigate:next': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Jumps to a specific tab, we can grab the number from the keyboard event
+     */
+    'tabs:focus:tab': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Focuses the last tab
+     */
+    'tabs:focus:tab-last': {
+        event: KeyboardEvent;
+    };
+};
+//# sourceMappingURL=tabs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tabs.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/tabs.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,cAAc,EAAE;QACd,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,gBAAgB,EAAE;QAChB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,wBAAwB,EAAE;QACxB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,oBAAoB,EAAE;QACpB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,gBAAgB,EAAE;QAChB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,qBAAqB,EAAE;QACrB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;CACF,CAAA"}

package/dist/events/definitions/tabs.js

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

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

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

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

@@ -4,23 +4,58 @@ export type UIEvents = {
     /**
      * Download the document from the store
      */
-    'download:document': {
+    'ui:download:document': {
         /** Format to download the document in */
         format: 'json' | 'yaml' | 'direct';
     };
+    /**
+     * Focus the address bar
+     */
+    'ui:focus:address-bar': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Focus the send button
+     */
+    'ui:focus:send-button': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Focus the search
+     */
+    'ui:focus:search': {
+        event: KeyboardEvent;
+    };
+    /**
+     * Toggle the sidebar
+     */
+    'ui:toggle:sidebar': {
+        event: KeyboardEvent;
+    };
     /**
      * Open the Api Client modal to a specific operation
      */
-    'open:client': {
+    'ui:open:client-modal': {
         /** The HTTP method of the operation to load */
         method: HttpMethod;
         /** The path of the operation to load */
         path: string;
+        /** The example name to load */
+        exampleName?: string;
+    };
+    /**
+     * Close the client modal
+     */
+    'ui:close:client-modal': {
+        event: KeyboardEvent;
     };
     /**
-     * Open our command palette
+     * Open the command palette
      */
-    'open:command-palette': 'import' | 'addServer' | 'addCollection' | 'addTag' | 'addExample' | 'addOperation' | undefined;
+    'ui:open:command-palette': {
+        action?: 'import' | 'addServer' | 'addCollection' | 'addTag' | 'addExample' | 'addOperation' | undefined;
+        event?: KeyboardEvent;
+    } | undefined;
     /** Set a navigation item's (such as a tag or operation) expanded state */
     'toggle:nav-item': {
         /** The name of the nav item to toggle */

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

@@ -1 +1 @@
-{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/ui.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,0CAA0C;AAC1C,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,mBAAmB,EAAE;QACnB,yCAAyC;QACzC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;KACnC,CAAA;IACD;;OAEG;IACH,aAAa,EAAE;QACb,+CAA+C;QAC/C,MAAM,EAAE,UAAU,CAAA;QAClB,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD;;OAEG;IACH,sBAAsB,EAClB,QAAQ,GACR,WAAW,GACX,eAAe,GACf,QAAQ,GACR,YAAY,GACZ,cAAc,GACd,SAAS,CAAA;IAEb,0EAA0E;IAC1E,iBAAiB,EAAE;QACjB,yCAAyC;QACzC,EAAE,EAAE,MAAM,CAAA;QACV,+CAA+C;QAC/C,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IAED,yGAAyG;IACzG,iBAAiB,EAAE;QACjB,uCAAuC;QACvC,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,gEAAgE;IAChE,uBAAuB,EAAE;QACvB,kDAAkD;QAClD,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,4CAA4C;IAC5C,oBAAoB,EAAE;QACpB,0CAA0C;QAC1C,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,kEAAkE;IAClE,mBAAmB,EAAE;QACnB,wDAAwD;QACxD,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,mCAAmC;IACnC,YAAY,EAAE,SAAS,CAAA;IAEvB,aAAa,EAAE;QACb,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA"}
+{"version":3,"file":"ui.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/ui.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,0CAA0C;AAC1C,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,sBAAsB,EAAE;QACtB,yCAAyC;QACzC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;KACnC,CAAA;IACD;;OAEG;IACH,sBAAsB,EAAE;QACtB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,sBAAsB,EAAE;QACtB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,iBAAiB,EAAE;QACjB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,mBAAmB,EAAE;QACnB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,sBAAsB,EAAE;QACtB,+CAA+C;QAC/C,MAAM,EAAE,UAAU,CAAA;QAClB,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAA;QACZ,+BAA+B;QAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,uBAAuB,EAAE;QACvB,KAAK,EAAE,aAAa,CAAA;KACrB,CAAA;IACD;;OAEG;IACH,yBAAyB,EACrB;QACE,MAAM,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,eAAe,GAAG,QAAQ,GAAG,YAAY,GAAG,cAAc,GAAG,SAAS,CAAA;QACxG,KAAK,CAAC,EAAE,aAAa,CAAA;KACtB,GACD,SAAS,CAAA;IAEb,0EAA0E;IAC1E,iBAAiB,EAAE;QACjB,yCAAyC;QACzC,EAAE,EAAE,MAAM,CAAA;QACV,+CAA+C;QAC/C,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IAED,yGAAyG;IACzG,iBAAiB,EAAE;QACjB,uCAAuC;QACvC,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,gEAAgE;IAChE,uBAAuB,EAAE;QACvB,kDAAkD;QAClD,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,4CAA4C;IAC5C,oBAAoB,EAAE;QACpB,0CAA0C;QAC1C,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,kEAAkE;IAClE,mBAAmB,EAAE;QACnB,wDAAwD;QACxD,EAAE,EAAE,MAAM,CAAA;KACX,CAAA;IAED,mCAAmC;IACnC,YAAY,EAAE,SAAS,CAAA;IAEvB,aAAa,EAAE;QACb,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA"}

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

@@ -0,0 +1,18 @@
+import type { ThemeId } from '@scalar/themes';
+import type { ColorMode } from '../../schemas/workspace.js';
+/** Event definitions for the openapi document */
+export type WorkspaceEvents = {
+    /**
+     * Update the active proxy
+     */
+    'workspace:update:active-proxy': string | null;
+    /**
+     * Update the color mode of the workspace
+     */
+    'workspace:update:color-mode': ColorMode;
+    /**
+     * Update the theme of the workspace
+     */
+    'workspace:update:theme': ThemeId;
+};
+//# sourceMappingURL=workspace.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"workspace.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/workspace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEpD,iDAAiD;AACjD,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,+BAA+B,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9C;;OAEG;IACH,6BAA6B,EAAE,SAAS,CAAA;IACxC;;OAEG;IACH,wBAAwB,EAAE,OAAO,CAAA;CAClC,CAAA"}

package/dist/events/definitions/workspace.js

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

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

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

package/dist/events/index.d.ts

@@ -1,5 +1,5 @@
 export { type WorkspaceEventBus, createWorkspaceEventBus } from './bus.js';
-export type { CollectionType } from './definitions/index.js';
+export type { ApiReferenceEvents, CollectionType } from './definitions/index.js';
 export { onCustomEvent } from './listeners.js';
-export { type ApiReferenceEvent, type ApiReferenceEvents, emitCustomEvent } from './old-definitions.js';
+export { 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,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"}
+{"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,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,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 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;",
+  "sourcesContent": ["// biome-ignore lint/performance/noBarrelFile: Entry point for /events\nexport { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport type { ApiReferenceEvents, CollectionType } from './definitions'\nexport { onCustomEvent } from './listeners'\nexport { emitCustomEvent } from './old-definitions'\n"],
+  "mappings": "AACA,SAAiC,+BAA+B;AAEhE,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;",
   "names": []
 }

package/dist/helpers/generate-unique-value.d.ts

@@ -25,16 +25,29 @@ export declare function generateUniqueValue({ defaultValue,
 /** Check function to verify the uniqueness of the value */
 validation, 
 /** Transformation function to transform the default value (such as into a slug) */
-transformation, maxRetries, }: {
+transformation, 
+/** The maximum number of attempts to create a unique value by incrementing. */
+maxRetries, }: {
     /**
-     * Value which will be used to derive a new unique value.
+     * The original value to base the unique generation upon.
+     * Example: "workspace", which may end up producing "workspace 2", "workspace 3", etc.
      */
     defaultValue: string;
-    /** Validate if the new generated value is unique */
+    /**
+     * Validation function that determines if a generated value is unique.
+     * Should return true if the value is unique; false if not.
+     * Can be asynchronous or synchronous.
+     */
     validation: (value: string) => Promise<boolean> | boolean;
-    /** Transform the default value to get a new value which will match the schema of the value we need to derive */
+    /**
+     * Optional function to transform the default value before attempting uniqueness.
+     * Example: Transform "Workspace A" into "workspace-a" to follow a slug schema.
+     */
     transformation?: (value: string) => string;
-    /** The maximum number of retry attempts to generate a unique value. */
+    /**
+     * The maximum number of attempts to create a unique value by incrementing.
+     * For example, if set to 5: "foo", "foo 1", "foo 2", "foo 3", "foo 4" will be attempted.
+     */
     maxRetries: number;
-}): string | undefined;
+}): Promise<string | undefined>;
 //# sourceMappingURL=generate-unique-value.d.ts.map

package/dist/helpers/generate-unique-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-unique-value.d.ts","sourceRoot":"","sources":["../../src/helpers/generate-unique-value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,mBAAmB,CAAC,EAClC,YAAY;AACZ,2DAA2D;AAC3D,UAAU;AACV,mFAAmF;AACnF,cAAc,EACd,UAAc,GACf,EAAE;IACD;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB,oDAAoD;IACpD,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IACzD,gHAAgH;IAChH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAC1C,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAA;CACnB,sBAYA"}
+{"version":3,"file":"generate-unique-value.d.ts","sourceRoot":"","sources":["../../src/helpers/generate-unique-value.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,YAAY;AACZ,2DAA2D;AAC3D,UAAU;AACV,mFAAmF;AACnF,cAAc;AACd,+EAA+E;AAC/E,UAAc,GACf,EAAE;IACD;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,UAAU,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IAEzD;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAE1C;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB,+BAaA"}

package/dist/helpers/generate-unique-value.js

@@ -1,38 +1,43 @@
-function generateUniqueValue({
+async function generateUniqueValue({
   defaultValue,
   /** Check function to verify the uniqueness of the value */
   validation,
   /** Transformation function to transform the default value (such as into a slug) */
   transformation,
+  /** The maximum number of attempts to create a unique value by incrementing. */
   maxRetries = 5
 }) {
   const transformed = transformation?.(defaultValue) ?? defaultValue;
-  if (validation(transformed)) {
+  if (await validation(transformed)) {
     return transformed;
   }
   return incrementValue({
     value: [transformed, 1],
     validation,
-    maxRetries
+    maxRetries,
+    transformation
   });
 }
-function incrementValue({
+async function incrementValue({
   value,
   validation,
   maxRetries,
-  attempts = 0
+  attempts = 0,
+  transformation
 }) {
   if (attempts >= maxRetries) {
     return;
   }
   const incremented = value.join(" ");
-  if (validation(incremented)) {
-    return incremented;
+  const transformed = transformation?.(incremented) ?? incremented;
+  if (await validation(transformed)) {
+    return transformed;
   }
   return incrementValue({
     value: [value[0], value[1] + 1],
     validation,
     maxRetries,
+    transformation,
     attempts: attempts + 1
   });
 }

package/dist/helpers/generate-unique-value.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/helpers/generate-unique-value.ts"],
-  "sourcesContent": ["/**\n * Generates a unique value based on a given default value and a validation function.\n *\n * The process works as follows:\n * 1. Optionally transform (e.g., slugify) the default value using a transformation function.\n * 2. Check if this value is unique by executing the provided validation function.\n * 3. If not unique, repeatedly append an incrementing integer (e.g., \"my-name 1\", \"my-name 2\", ...) and re-check uniqueness,\n *    up to a maximum number of attempts (maxRetries).\n * 4. Returns the first unique value found or undefined if a unique value cannot be generated within the maximum retries.\n *\n * Example:\n * ```ts\n * // Existing names in use\n * const existing = new Set(['foo', 'foo 1', 'foo 2']);\n * const uniqueName = generateUniqueValue({\n *   defaultValue: 'foo',\n *   validation: (value) => !existing.has(value),\n *   // transformation is optional, e.g. (val) => val.toLowerCase().replace(/[^\\w]+/g, '-'),\n *   maxRetries: 10,\n * });\n * // uniqueName === 'foo 3'\n * ```\n */\nexport function generateUniqueValue({\n  defaultValue,\n  /** Check function to verify the uniqueness of the value */\n  validation,\n  /** Transformation function to transform the default value (such as into a slug) */\n  transformation,\n  maxRetries = 5,\n}: {\n  /**\n   * Value which will be used to derive a new unique value.\n   */\n  defaultValue: string\n  /** Validate if the new generated value is unique */\n  validation: (value: string) => Promise<boolean> | boolean\n  /** Transform the default value to get a new value which will match the schema of the value we need to derive */\n  transformation?: (value: string) => string\n  /** The maximum number of retry attempts to generate a unique value. */\n  maxRetries: number\n}) {\n  const transformed = transformation?.(defaultValue) ?? defaultValue\n\n  if (validation(transformed)) {\n    return transformed\n  }\n\n  return incrementValue({\n    value: [transformed, 1],\n    validation,\n    maxRetries,\n  })\n}\n\n/**\n * Attempts to generate a unique value by appending and incrementing a counter to a base string.\n *\n * On each attempt, appends the next incrementing integer (e.g. \"foo 1\", \"foo 2\", etc.) to the original value,\n * and checks with the validation function whether the candidate value is unique.\n *\n * Continues until a unique value is found, or the maximum number of attempts is reached.\n *\n * Returns the first unique value found, or undefined if a unique value cannot be generated within maxRetries.\n *\n * Example:\n * ```ts\n * const existing = new Set(['bar', 'bar 1']);\n * const result = incrementValue({\n *   value: ['bar', 1],\n *   validation: (val) => !existing.has(val),\n *   maxRetries: 5,\n * });\n * // result === \"bar 2\"\n * ```\n */\nfunction incrementValue({\n  value,\n  validation,\n  maxRetries,\n  attempts = 0,\n}: {\n  value: [string, number] // [base value, next increment]\n  validation: (value: string) => Promise<boolean> | boolean\n  maxRetries: number\n  attempts?: number\n}) {\n  if (attempts >= maxRetries) {\n    return\n  }\n\n  const incremented = value.join(' ')\n\n  if (validation(incremented)) {\n    return incremented\n  }\n\n  return incrementValue({\n    value: [value[0], value[1] + 1],\n    validation,\n    maxRetries,\n    attempts: attempts + 1,\n  })\n}\n"],
-  "mappings": "AAuBO,SAAS,oBAAoB;AAAA,EAClC;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA,EACA,aAAa;AACf,GAWG;AACD,QAAM,cAAc,iBAAiB,YAAY,KAAK;AAEtD,MAAI,WAAW,WAAW,GAAG;AAC3B,WAAO;AAAA,EACT;AAEA,SAAO,eAAe;AAAA,IACpB,OAAO,CAAC,aAAa,CAAC;AAAA,IACtB;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAuBA,SAAS,eAAe;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA,WAAW;AACb,GAKG;AACD,MAAI,YAAY,YAAY;AAC1B;AAAA,EACF;AAEA,QAAM,cAAc,MAAM,KAAK,GAAG;AAElC,MAAI,WAAW,WAAW,GAAG;AAC3B,WAAO;AAAA,EACT;AAEA,SAAO,eAAe;AAAA,IACpB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;AAAA,IAC9B;AAAA,IACA;AAAA,IACA,UAAU,WAAW;AAAA,EACvB,CAAC;AACH;",
+  "sourcesContent": ["/**\n * Generates a unique value based on a given default value and a validation function.\n *\n * The process works as follows:\n * 1. Optionally transform (e.g., slugify) the default value using a transformation function.\n * 2. Check if this value is unique by executing the provided validation function.\n * 3. If not unique, repeatedly append an incrementing integer (e.g., \"my-name 1\", \"my-name 2\", ...) and re-check uniqueness,\n *    up to a maximum number of attempts (maxRetries).\n * 4. Returns the first unique value found or undefined if a unique value cannot be generated within the maximum retries.\n *\n * Example:\n * ```ts\n * // Existing names in use\n * const existing = new Set(['foo', 'foo 1', 'foo 2']);\n * const uniqueName = generateUniqueValue({\n *   defaultValue: 'foo',\n *   validation: (value) => !existing.has(value),\n *   // transformation is optional, e.g. (val) => val.toLowerCase().replace(/[^\\w]+/g, '-'),\n *   maxRetries: 10,\n * });\n * // uniqueName === 'foo 3'\n * ```\n */\nexport async function generateUniqueValue({\n  defaultValue,\n  /** Check function to verify the uniqueness of the value */\n  validation,\n  /** Transformation function to transform the default value (such as into a slug) */\n  transformation,\n  /** The maximum number of attempts to create a unique value by incrementing. */\n  maxRetries = 5,\n}: {\n  /**\n   * The original value to base the unique generation upon.\n   * Example: \"workspace\", which may end up producing \"workspace 2\", \"workspace 3\", etc.\n   */\n  defaultValue: string\n\n  /**\n   * Validation function that determines if a generated value is unique.\n   * Should return true if the value is unique; false if not.\n   * Can be asynchronous or synchronous.\n   */\n  validation: (value: string) => Promise<boolean> | boolean\n\n  /**\n   * Optional function to transform the default value before attempting uniqueness.\n   * Example: Transform \"Workspace A\" into \"workspace-a\" to follow a slug schema.\n   */\n  transformation?: (value: string) => string\n\n  /**\n   * The maximum number of attempts to create a unique value by incrementing.\n   * For example, if set to 5: \"foo\", \"foo 1\", \"foo 2\", \"foo 3\", \"foo 4\" will be attempted.\n   */\n  maxRetries: number\n}) {\n  const transformed = transformation?.(defaultValue) ?? defaultValue\n\n  if (await validation(transformed)) {\n    return transformed\n  }\n\n  return incrementValue({\n    value: [transformed, 1],\n    validation,\n    maxRetries,\n    transformation,\n  })\n}\n\n/**\n * Attempts to generate a unique value by appending and incrementing a counter to a base string.\n *\n * On each attempt, appends the next incrementing integer (e.g. \"foo 1\", \"foo 2\", etc.) to the original value,\n * and checks with the validation function whether the candidate value is unique.\n *\n * Continues until a unique value is found, or the maximum number of attempts is reached.\n *\n * Returns the first unique value found, or undefined if a unique value cannot be generated within maxRetries.\n *\n * Example:\n * ```ts\n * const existing = new Set(['bar', 'bar 1']);\n * const result = incrementValue({\n *   value: ['bar', 1],\n *   validation: (val) => !existing.has(val),\n *   maxRetries: 5,\n * });\n * // result === \"bar 2\"\n * ```\n */\nasync function incrementValue({\n  value,\n  validation,\n  maxRetries,\n  attempts = 0,\n  transformation,\n}: {\n  /**\n   * Tuple containing the base value and the starting increment number.\n   * Example: [\"workspace\", 1] will try \"workspace 1\", \"workspace 2\", etc.\n   */\n  value: [string, number] // [base value, next increment]\n\n  /**\n   * Function to validate if the generated value is unique.\n   * Should return true if the value is unique, otherwise false.\n   * Supports both synchronous and asynchronous operation.\n   */\n  validation: (value: string) => Promise<boolean> | boolean\n\n  /**\n   * The maximum number of retry attempts to generate a unique value.\n   * Generation will stop and return undefined if this number is exceeded.\n   */\n  maxRetries: number\n\n  /**\n   * The current attempt count.\n   * Used internally for recursion; users should generally omit this field.\n   */\n  attempts?: number\n\n  /**\n   * Optional function to transform the value before passing it to validation.\n   * E.g., for slugifying a value for URLs.\n   */\n  transformation?: (value: string) => string\n}) {\n  if (attempts >= maxRetries) {\n    return\n  }\n\n  const incremented = value.join(' ')\n  const transformed = transformation?.(incremented) ?? incremented\n\n  if (await validation(transformed)) {\n    return transformed\n  }\n\n  return incrementValue({\n    value: [value[0], value[1] + 1],\n    validation,\n    maxRetries,\n    transformation,\n    attempts: attempts + 1,\n  })\n}\n"],
+  "mappings": "AAuBA,eAAsB,oBAAoB;AAAA,EACxC;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA,aAAa;AACf,GAyBG;AACD,QAAM,cAAc,iBAAiB,YAAY,KAAK;AAEtD,MAAI,MAAM,WAAW,WAAW,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,eAAe;AAAA,IACpB,OAAO,CAAC,aAAa,CAAC;AAAA,IACtB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AACH;AAuBA,eAAe,eAAe;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA,WAAW;AAAA,EACX;AACF,GA+BG;AACD,MAAI,YAAY,YAAY;AAC1B;AAAA,EACF;AAEA,QAAM,cAAc,MAAM,KAAK,GAAG;AAClC,QAAM,cAAc,iBAAiB,WAAW,KAAK;AAErD,MAAI,MAAM,WAAW,WAAW,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,eAAe;AAAA,IACpB,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;AAAA,IAC9B;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU,WAAW;AAAA,EACvB,CAAC;AACH;",
   "names": []
 }

package/dist/helpers/unpack-proxy.d.ts

@@ -1,6 +1,19 @@
 /**
  * Unpacks special vue reactivity & override & detect-changes & magic proxy from an input object or array,
  * returning the "raw" plain object or array.
+ *
+ * This function recursively traverses the input object or array, removing any proxies
+ * (e.g. Vue reactivity proxies, magic proxies, override proxies, detect-changes proxies)
+ * to obtain and return the underlying "raw" plain object or array.
+ *
+ * The recursion is controlled by the `depth` parameter. If `depth` is `null`, unlimited depth is allowed.
+ * If a proxied object is detected and unwrapped at non-root level, a warning is logged.
+ *
+ * @param input - The object or array (possibly deeply nested or proxied) to recursively unwrap.
+ * @param depth - Optional, limits recursion depth. `null` means unlimited depth (default is 1).
+ * @returns - A plain object or array with all proxies removed up to the specified depth.
  */
-export declare const unpackProxyObject: <T>(input: T) => T;
+export declare const unpackProxyObject: <T>(input: T, { depth }?: {
+    depth?: number | null;
+}) => T;
 //# sourceMappingURL=unpack-proxy.d.ts.map

package/dist/helpers/unpack-proxy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unpack-proxy.d.ts","sourceRoot":"","sources":["../../src/helpers/unpack-proxy.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,CACsB,CAAA"}
+{"version":3,"file":"unpack-proxy.d.ts","sourceRoot":"","sources":["../../src/helpers/unpack-proxy.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,EAAE,OAAO,CAAC,EAAE,YAAe;IAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAO,KAAG,CAsE9F,CAAA"}

package/dist/helpers/unpack-proxy.js

@@ -2,7 +2,57 @@ import { getRaw } from "@scalar/json-magic/magic-proxy";
 import { toRaw } from "vue";
 import { unpackDetectChangesProxy } from "../helpers/detect-changes-proxy.js";
 import { unpackOverridesProxy } from "../helpers/overrides-proxy.js";
-const unpackProxyObject = (input) => unpackDetectChangesProxy(toRaw(getRaw(unpackOverridesProxy(input))));
+const unpackProxyObject = (input, { depth = 0 } = {}) => {
+  const dfs = (value, currentDepth = 0) => {
+    if (typeof value !== "object" || value === null) {
+      return value;
+    }
+    const raw = unpackDetectChangesProxy(toRaw(getRaw(unpackOverridesProxy(value))));
+    if (depth !== null && currentDepth >= depth) {
+      return raw;
+    }
+    if (currentDepth !== 0 && raw !== value) {
+      console.warn(
+        "%c\u26A0 Warning:%c You tried to assign a proxied object (depth: %d).\n%c\u{1F4A1} Tip:%c Pass a plain object instead \u2014 wrapping a proxy inside another proxy may cause weird bugs.\n%c\u{1F50D} Debug Info:%c The problematic value is shown below:",
+        // styles
+        "background: #fdd835; color: #000; font-weight: bold; padding: 2px 4px; border-radius: 3px;",
+        "color: inherit;",
+        currentDepth,
+        "color: #00bfa5; font-weight: bold;",
+        "color: inherit;",
+        "color: #03a9f4; font-weight: bold;",
+        "color: inherit;",
+        value,
+        input
+      );
+      console.groupCollapsed("%c\u{1F4DC} Proxy assignment trace", "color: #9c27b0; font-weight: bold;");
+      console.trace({ value, raw });
+      console.groupEnd();
+    }
+    Object.entries(raw).forEach(([key, value2]) => {
+      const propertyResult = dfs(value2, currentDepth + 1);
+      const result = Reflect.set(raw, key, propertyResult);
+      if (!result) {
+        console.warn(
+          '%c\u{1F6AB} Readonly Property Error:%c Failed to set property "%s" on object.\n%c\u{1F4A1} Tip:%c This property is readonly or non-configurable. You cannot unpack a readonly property \u2014 the value was not updated.\n%c\u{1F50D} Debug Info:%c Property: %s | Value: %o | Object: %o',
+          // styles
+          "background: #f44336; color: #fff; font-weight: bold; padding: 2px 4px; border-radius: 3px;",
+          "color: inherit;",
+          key,
+          "color: #00bfa5; font-weight: bold;",
+          "color: inherit;",
+          "color: #03a9f4; font-weight: bold;",
+          "color: inherit;",
+          key,
+          propertyResult,
+          raw
+        );
+      }
+    });
+    return raw;
+  };
+  return dfs(input);
+};
 export {
   unpackProxyObject
 };

package/dist/helpers/unpack-proxy.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/helpers/unpack-proxy.ts"],
-  "sourcesContent": ["import { getRaw } from '@scalar/json-magic/magic-proxy'\nimport { toRaw } from 'vue'\n\nimport { unpackDetectChangesProxy } from '@/helpers/detect-changes-proxy'\nimport { unpackOverridesProxy } from '@/helpers/overrides-proxy'\n\n/**\n * Unpacks special vue reactivity & override & detect-changes & magic proxy from an input object or array,\n * returning the \"raw\" plain object or array.\n */\nexport const unpackProxyObject = <T>(input: T): T =>\n  unpackDetectChangesProxy(toRaw(getRaw(unpackOverridesProxy(input))))\n"],
-  "mappings": "AAAA,SAAS,cAAc;AACvB,SAAS,aAAa;AAEtB,SAAS,gCAAgC;AACzC,SAAS,4BAA4B;AAM9B,MAAM,oBAAoB,CAAI,UACnC,yBAAyB,MAAM,OAAO,qBAAqB,KAAK,CAAC,CAAC,CAAC;",
-  "names": []
+  "sourcesContent": ["import { getRaw } from '@scalar/json-magic/magic-proxy'\nimport { toRaw } from 'vue'\n\nimport { unpackDetectChangesProxy } from '@/helpers/detect-changes-proxy'\nimport { unpackOverridesProxy } from '@/helpers/overrides-proxy'\n\n/**\n * Unpacks special vue reactivity & override & detect-changes & magic proxy from an input object or array,\n * returning the \"raw\" plain object or array.\n *\n * This function recursively traverses the input object or array, removing any proxies\n * (e.g. Vue reactivity proxies, magic proxies, override proxies, detect-changes proxies)\n * to obtain and return the underlying \"raw\" plain object or array.\n *\n * The recursion is controlled by the `depth` parameter. If `depth` is `null`, unlimited depth is allowed.\n * If a proxied object is detected and unwrapped at non-root level, a warning is logged.\n *\n * @param input - The object or array (possibly deeply nested or proxied) to recursively unwrap.\n * @param depth - Optional, limits recursion depth. `null` means unlimited depth (default is 1).\n * @returns - A plain object or array with all proxies removed up to the specified depth.\n */\nexport const unpackProxyObject = <T>(input: T, { depth = 0 }: { depth?: number | null } = {}): T => {\n  // Internal DFS helper to recursively strip all known proxies (Vue, overrides, detect-changes, magic proxies)\n  const dfs = (value: any, currentDepth: number = 0): any => {\n    // Base case: non-objects (primitives, null) are returned as-is\n    if (typeof value !== 'object' || value === null) {\n      return value\n    }\n\n    // Compose all the proxy unwraps in order\n    const raw = unpackDetectChangesProxy(toRaw(getRaw(unpackOverridesProxy(value))))\n\n    // If we have reached the maximum depth, return the value (potentially still partially proxied)\n    if (depth !== null && currentDepth >= depth) {\n      return raw\n    }\n\n    // Show a warning if a nested value was a proxy (usually undesired, can cause subtle bugs)\n    if (currentDepth !== 0 && raw !== value) {\n      console.warn(\n        '%c\u26A0 Warning:%c You tried to assign a proxied object (depth: %d).\\n' +\n          '%c\uD83D\uDCA1 Tip:%c Pass a plain object instead \u2014 wrapping a proxy inside another proxy may cause weird bugs.\\n' +\n          '%c\uD83D\uDD0D Debug Info:%c The problematic value is shown below:',\n        // styles\n        'background: #fdd835; color: #000; font-weight: bold; padding: 2px 4px; border-radius: 3px;',\n        'color: inherit;',\n        currentDepth,\n        'color: #00bfa5; font-weight: bold;',\n        'color: inherit;',\n        'color: #03a9f4; font-weight: bold;',\n        'color: inherit;',\n        value,\n        input,\n      )\n\n      // Collapsed trace group for cleaner output\n      console.groupCollapsed('%c\uD83D\uDCDC Proxy assignment trace', 'color: #9c27b0; font-weight: bold;')\n      console.trace({ value, raw })\n      console.groupEnd()\n    }\n\n    // Recursively process all properties/entries to make sure we are not assigning proxies directly,\n    // but are always assigning plain objects at any level.\n    Object.entries(raw).forEach(([key, value]) => {\n      const propertyResult = dfs(value, currentDepth + 1)\n      const result = Reflect.set(raw, key, propertyResult)\n\n      if (!result) {\n        console.warn(\n          '%c\uD83D\uDEAB Readonly Property Error:%c Failed to set property \"%s\" on object.\\n' +\n            '%c\uD83D\uDCA1 Tip:%c This property is readonly or non-configurable. You cannot unpack a readonly property \u2014 the value was not updated.\\n' +\n            '%c\uD83D\uDD0D Debug Info:%c Property: %s | Value: %o | Object: %o',\n          // styles\n          'background: #f44336; color: #fff; font-weight: bold; padding: 2px 4px; border-radius: 3px;',\n          'color: inherit;',\n          key,\n          'color: #00bfa5; font-weight: bold;',\n          'color: inherit;',\n          'color: #03a9f4; font-weight: bold;',\n          'color: inherit;',\n          key,\n          propertyResult,\n          raw,\n        )\n      }\n    })\n\n    return raw\n  }\n\n  return dfs(input)\n}\n"],
+  "mappings": "AAAA,SAAS,cAAc;AACvB,SAAS,aAAa;AAEtB,SAAS,gCAAgC;AACzC,SAAS,4BAA4B;AAiB9B,MAAM,oBAAoB,CAAI,OAAU,EAAE,QAAQ,EAAE,IAA+B,CAAC,MAAS;AAElG,QAAM,MAAM,CAAC,OAAY,eAAuB,MAAW;AAEzD,QAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,aAAO;AAAA,IACT;AAGA,UAAM,MAAM,yBAAyB,MAAM,OAAO,qBAAqB,KAAK,CAAC,CAAC,CAAC;AAG/E,QAAI,UAAU,QAAQ,gBAAgB,OAAO;AAC3C,aAAO;AAAA,IACT;AAGA,QAAI,iBAAiB,KAAK,QAAQ,OAAO;AACvC,cAAQ;AAAA,QACN;AAAA;AAAA,QAIA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAGA,cAAQ,eAAe,sCAA+B,oCAAoC;AAC1F,cAAQ,MAAM,EAAE,OAAO,IAAI,CAAC;AAC5B,cAAQ,SAAS;AAAA,IACnB;AAIA,WAAO,QAAQ,GAAG,EAAE,QAAQ,CAAC,CAAC,KAAKA,MAAK,MAAM;AAC5C,YAAM,iBAAiB,IAAIA,QAAO,eAAe,CAAC;AAClD,YAAM,SAAS,QAAQ,IAAI,KAAK,KAAK,cAAc;AAEnD,UAAI,CAAC,QAAQ;AACX,gBAAQ;AAAA,UACN;AAAA;AAAA,UAIA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO;AAAA,EACT;AAEA,SAAO,IAAI,KAAK;AAClB;",
+  "names": ["value"]
 }