@scalar/workspace-store 0.20.0 → 0.22.0

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

@@ -1,11 +1,16 @@
 import type { EnvironmentEvents } from '../../events/definitions/environment.js';
+import type { TabEvents } from '../../events/definitions/tabs.js';
+import type { TagEvents } from '../../events/definitions/tag.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 = AuthEvents & AnalyticsEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents & UIEvents;
+export type ApiReferenceEvents = AuthEvents & AnalyticsEvents & CookieEvents & WorkspaceEvents & DocumentEvents & EnvironmentEvents & MetaEvents & OperationEvents & ServerEvents & TabEvents & UIEvents & TagEvents;
 export type { CollectionType } from './common.js';
+export type { CommandPaletteAction } from './ui.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;AAEzE,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,GAAG,UAAU,GACzC,eAAe,GACf,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,YAAY,GACZ,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,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,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,GACR,SAAS,CAAA;AAEX,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAC9C,YAAY,EAAE,oBAAoB,EAAE,MAAM,MAAM,CAAA"}

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

@@ -1,17 +1,8 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
 import type { OperationExampleMeta, OperationMeta } from '../../mutators/index.js';
+import type { OperationObject } from '../../schemas/v3.1/strict/operation.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 +10,24 @@ export type OperationEvents = {
     'operation:send:request': {
         meta: OperationExampleMeta;
     };
-    /** ------------------------------------------------------------------------------------------------
-     * Operation Draft Mutators
-     * ------------------------------------------------------------------------------------------------ */
+    /**
+     * Create a new operation at a specific path and method in the document.
+     * Triggers when the user creates a new endpoint via the command palette or other UI.
+     */
+    'operation:create:operation': {
+        /** The document name where the operation should be created */
+        documentName: string;
+        /** The example key for the new operation */
+        exampleKey?: string;
+        /** The path for the new operation (will be normalized to start with /) */
+        path: string;
+        /** The HTTP method for the operation */
+        method: HttpMethod;
+        /** The operation object to create */
+        operation: OperationObject;
+        /** The callback to call when the operation is created */
+        callback?: (success: boolean) => void;
+    };
     /**
      * Update the summary for the operation.
      * Triggers when the user edits the summary/description for an endpoint.
@@ -45,7 +51,7 @@ export type OperationEvents = {
             method: HttpMethod;
         };
         /** Identifies the target operation by original method and path */
-        meta: OperationMeta;
+        meta: OperationExampleMeta;
     };
     /**
      * Update the path for the operation.

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;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAK5B;;;OAGG;IACH,wBAAwB,EAAE;QACxB,IAAI,EAAE,oBAAoB,CAAA;KAC3B,CAAA;IAMD;;;OAGG;IACH,4BAA4B,EAAE;QAC5B,8DAA8D;QAC9D,YAAY,EAAE,MAAM,CAAA;QACpB,4CAA4C;QAC5C,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,0EAA0E;QAC1E,IAAI,EAAE,MAAM,CAAA;QACZ,wCAAwC;QACxC,MAAM,EAAE,UAAU,CAAA;QAClB,qCAAqC;QACrC,SAAS,EAAE,eAAe,CAAA;QAC1B,yDAAyD;QACzD,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;KACtC,CAAA;IAED;;;;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,oBAAoB,CAAA;KAC3B,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

@@ -35,8 +35,8 @@ export type ServerEvents = {
      * Update the selected server for the document
      */
     'server:update:selected': {
-        /** The index of the server to update */
-        index: number;
+        /** 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,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,wCAAwC;QACxC,KAAK,EAAE,MAAM,CAAA;KACd,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,55 @@
+import type { XScalarTabs } from '../../schemas/extensions/workspace/x-scalar-tabs.js';
+/** Event definitions to control the tabs */
+export type TabEvents = {
+    /**
+     * Update the tabs of the workspace
+     */
+    'tabs:update:tabs': XScalarTabs;
+    /**
+     * Add a new tab
+     */
+    'tabs:add:tab': {
+        event: KeyboardEvent;
+    } | undefined;
+    /**
+     * Closes the current tab
+     */
+    'tabs:close:tab': {
+        event: KeyboardEvent;
+    } | {
+        index: number;
+    };
+    /**
+     * Closes all other tabs except the one at the given index
+     */
+    'tabs:close:other-tabs': {
+        index: number;
+    };
+    /**
+     * 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;
+    } | {
+        index: number;
+    };
+    /**
+     * 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,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8CAA8C,CAAA;AAE/E,4CAA4C;AAC5C,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,kBAAkB,EAAE,WAAW,CAAA;IAC/B;;OAEG;IACH,cAAc,EACV;QACE,KAAK,EAAE,aAAa,CAAA;KACrB,GACD,SAAS,CAAA;IACb;;OAEG;IACH,gBAAgB,EAAE;QAAE,KAAK,EAAE,aAAa,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D;;OAEG;IACH,uBAAuB,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC1C;;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;QAAE,KAAK,EAAE,aAAa,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC9D;;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/tag.d.ts

@@ -0,0 +1,15 @@
+/** Event definitions for all things tag related */
+export type TagEvents = {
+    /**
+     * Create a tag
+     */
+    'tag:create:tag': {
+        /** The name of the tag to create */
+        name: string;
+        /** The name of the document to add the tag to */
+        documentName: string;
+        /** The callback to call when the tag is created */
+        callback?: (success: boolean) => void;
+    };
+};
+//# sourceMappingURL=tag.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../../src/events/definitions/tag.ts"],"names":[],"mappings":"AAAA,mDAAmD;AACnD,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,gBAAgB,EAAE;QAChB,oCAAoC;QACpC,IAAI,EAAE,MAAM,CAAA;QACZ,iDAAiD;QACjD,YAAY,EAAE,MAAM,CAAA;QACpB,mDAAmD;QACnD,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;KACtC,CAAA;CACF,CAAA"}

package/dist/events/definitions/tag.js

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

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

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

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

@@ -1,57 +1,149 @@
 import type { HttpMethod } from '@scalar/helpers/http/http-methods';
-/** Event definitions to control the ui */
+/**
+ * Available actions that can be triggered from the command palette.
+ * Each action may have an associated payload type.
+ */
+type CommandPalettePayload = {
+    /** Trigger the import flow for OpenAPI, Swagger, Postman, or cURL */
+    'import-from-openapi-swagger-postman-curl': undefined;
+    /** Create a new document in the workspace */
+    'create-document': undefined;
+    /** Add a new tag to organize requests */
+    'add-tag': undefined;
+    /** Create a new HTTP request */
+    'create-request': undefined;
+    /** Add a new example to an existing request */
+    'add-example': undefined;
+    /** Import a request from a cURL command string */
+    'import-curl-command': {
+        /** The cURL command string to parse and import */
+        curl: string;
+    };
+};
+/**
+ * Type-safe command palette action with correlated action and payload.
+ * This ensures that when an action is dispatched, it must include the correct payload type.
+ *
+ * Example:
+ * - { action: 'create-document', payload: undefined }
+ * - { action: 'import-curl-command', payload: { curl: 'curl ...' } }
+ */
+export type CommandPaletteAction<K extends keyof CommandPalettePayload = keyof CommandPalettePayload> = {
+    /** The action to perform */
+    action: K;
+    /** The payload for this action, typed based on the action */
+    payload: CommandPalettePayload[K];
+    /** Optional keyboard event that triggered this action */
+    event?: KeyboardEvent;
+};
+/**
+ * Common payload for keyboard-triggered events.
+ * Used when we need to track the original keyboard event for things like
+ * preventing default behavior or stopping propagation.
+ */
+type KeyboardEventPayload = {
+    /** The keyboard event that triggered this action */
+    event: KeyboardEvent;
+};
+/**
+ * Common payload for navigation item operations.
+ * Navigation items include tags, operations, folders, etc. in the sidebar.
+ */
+type NavigationItemPayload = {
+    /** The unique identifier of the navigation item */
+    id: string;
+};
+/**
+ * Event definitions for controlling the UI.
+ * These events are dispatched through the event bus to trigger UI actions
+ * across different components without tight coupling.
+ */
 export type UIEvents = {
     /**
-     * Download the document from the store
+     * Download the OpenAPI document from the store.
+     * Supports multiple export formats for different use cases.
      */
-    'download:document': {
+    'ui:download:document': {
         /** Format to download the document in */
         format: 'json' | 'yaml' | 'direct';
     };
     /**
-     * Open the Api Client modal to a specific operation
+     * Focus the address bar input field.
+     * Typically triggered by keyboard shortcuts for quick navigation.
+     */
+    'ui:focus:address-bar': KeyboardEventPayload;
+    /**
+     * Focus the send button to execute a request.
+     * Useful for keyboard-driven workflows.
+     */
+    'ui:focus:send-button': KeyboardEventPayload;
+    /**
+     * Focus the search input in the sidebar.
+     * Allows quick filtering of requests and tags.
      */
-    'open:client': {
-        /** The HTTP method of the operation to load */
+    'ui:focus:search': KeyboardEventPayload;
+    /**
+     * Toggle the sidebar visibility.
+     * Useful for maximizing content area on smaller screens.
+     */
+    'ui:toggle:sidebar': KeyboardEventPayload;
+    /**
+     * Open the API Client modal to a specific operation.
+     * This allows deep linking into specific endpoints from external sources.
+     */
+    'ui:open:client-modal': {
+        /** The HTTP method of the operation to load (e.g., GET, POST) */
         method: HttpMethod;
-        /** The path of the operation to load */
+        /** The path of the operation to load (e.g., /users/{id}) */
         path: string;
+        /** Optional example name to load for this operation */
+        exampleName?: string;
     };
     /**
-     * Open our command palette
+     * Close the API Client modal.
+     * Typically triggered by escape key or clicking outside the modal.
+     */
+    'ui:close:client-modal': KeyboardEventPayload;
+    /**
+     * Hide the modal in modal mode.
+     * Generic close action for modal display contexts.
      */
-    'open:command-palette': 'import' | 'addServer' | 'addCollection' | 'addTag' | 'addExample' | 'addOperation' | 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 */
-        id: string;
-        /** Optional defined state for the nav item. */
-        open?: boolean;
-    };
-    /** Select a navigation item. Run on sidebar clicks where a scroll handler would typically be expected */
-    'select:nav-item': {
-        /** The id of the nav item to select */
-        id: string;
-    };
-    /** Fired when a navigation item intersects with the viewport */
-    'intersecting:nav-item': {
-        /** The id of the nav item that is intersecting */
-        id: string;
-    };
-    /** Explicity scroll to a navigation item */
-    'scroll-to:nav-item': {
-        /** The id of the nav item to scroll to */
-        id: string;
-    };
-    /** Copy the url including anchor details for a navigation item */
-    'copy-url:nav-item': {
-        /** The id of the nav item to copy the anchor url for */
-        id: string;
-    };
-    /** On modal mode hide the modal */
     'hide:modal': undefined;
-    'import:curl': {
-        value: string;
+    /**
+     * Open the command palette.
+     * Can optionally pre-fill with a specific action to execute.
+     * If undefined is passed, opens the palette without a pre-selected action.
+     */
+    'ui:open:command-palette': CommandPaletteAction | undefined;
+    /**
+     * Toggle a navigation item's expanded state.
+     * Used for collapsible items like tags, folders, or operation groups.
+     */
+    'toggle:nav-item': NavigationItemPayload & {
+        /** If provided, sets the state explicitly instead of toggling */
+        open?: boolean;
     };
+    /**
+     * Select a navigation item.
+     * Fired when clicking on a sidebar item where a scroll handler would typically be expected.
+     * This does not automatically scroll to the item.
+     */
+    'select:nav-item': NavigationItemPayload;
+    /**
+     * Fired when a navigation item intersects with the viewport.
+     * Used for highlighting active sections in the sidebar during scrolling.
+     */
+    'intersecting:nav-item': NavigationItemPayload;
+    /**
+     * Explicitly scroll to a navigation item in the content area.
+     * This will move the viewport to show the corresponding content.
+     */
+    'scroll-to:nav-item': NavigationItemPayload;
+    /**
+     * Copy the URL with anchor details for a navigation item.
+     * Useful for sharing direct links to specific sections.
+     */
+    'copy-url:nav-item': NavigationItemPayload;
 };
+export {};
 //# sourceMappingURL=ui.d.ts.map

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;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IAC3B,qEAAqE;IACrE,0CAA0C,EAAE,SAAS,CAAA;IACrD,6CAA6C;IAC7C,iBAAiB,EAAE,SAAS,CAAA;IAC5B,yCAAyC;IACzC,SAAS,EAAE,SAAS,CAAA;IACpB,gCAAgC;IAChC,gBAAgB,EAAE,SAAS,CAAA;IAC3B,+CAA+C;IAC/C,aAAa,EAAE,SAAS,CAAA;IACxB,kDAAkD;IAClD,qBAAqB,EAAE;QACrB,kDAAkD;QAClD,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,qBAAqB,GAAG,MAAM,qBAAqB,IAAI;IACtG,4BAA4B;IAC5B,MAAM,EAAE,CAAC,CAAA;IACT,6DAA6D;IAC7D,OAAO,EAAE,qBAAqB,CAAC,CAAC,CAAC,CAAA;IACjC,yDAAyD;IACzD,KAAK,CAAC,EAAE,aAAa,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,KAAK,oBAAoB,GAAG;IAC1B,oDAAoD;IACpD,KAAK,EAAE,aAAa,CAAA;CACrB,CAAA;AAED;;;GAGG;AACH,KAAK,qBAAqB,GAAG;IAC3B,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG;IAKrB;;;OAGG;IACH,sBAAsB,EAAE;QACtB,yCAAyC;QACzC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAA;KACnC,CAAA;IAMD;;;OAGG;IACH,sBAAsB,EAAE,oBAAoB,CAAA;IAE5C;;;OAGG;IACH,sBAAsB,EAAE,oBAAoB,CAAA;IAE5C;;;OAGG;IACH,iBAAiB,EAAE,oBAAoB,CAAA;IAMvC;;;OAGG;IACH,mBAAmB,EAAE,oBAAoB,CAAA;IAMzC;;;OAGG;IACH,sBAAsB,EAAE;QACtB,iEAAiE;QACjE,MAAM,EAAE,UAAU,CAAA;QAClB,4DAA4D;QAC5D,IAAI,EAAE,MAAM,CAAA;QACZ,uDAAuD;QACvD,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAA;IAED;;;OAGG;IACH,uBAAuB,EAAE,oBAAoB,CAAA;IAE7C;;;OAGG;IACH,YAAY,EAAE,SAAS,CAAA;IAMvB;;;;OAIG;IACH,yBAAyB,EAAE,oBAAoB,GAAG,SAAS,CAAA;IAM3D;;;OAGG;IACH,iBAAiB,EAAE,qBAAqB,GAAG;QACzC,iEAAiE;QACjE,IAAI,CAAC,EAAE,OAAO,CAAA;KACf,CAAA;IAED;;;;OAIG;IACH,iBAAiB,EAAE,qBAAqB,CAAA;IAExC;;;OAGG;IACH,uBAAuB,EAAE,qBAAqB,CAAA;IAE9C;;;OAGG;IACH,oBAAoB,EAAE,qBAAqB,CAAA;IAE3C;;;OAGG;IACH,mBAAmB,EAAE,qBAAqB,CAAA;CAC3C,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 { ApiReferenceEvents, CollectionType } from './definitions/index.js';
+export type { ApiReferenceEvents, CollectionType, CommandPaletteAction } from './definitions/index.js';
 export { onCustomEvent } from './listeners.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,kBAAkB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,iBAAiB,EAAE,uBAAuB,EAAE,MAAM,OAAO,CAAA;AACvE,YAAY,EAAE,kBAAkB,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAC7F,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 { 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;",
+  "sourcesContent": ["export { type WorkspaceEventBus, createWorkspaceEventBus } from './bus'\nexport type { ApiReferenceEvents, CollectionType, CommandPaletteAction } from './definitions'\nexport { onCustomEvent } from './listeners'\nexport { emitCustomEvent } from './old-definitions'\n"],
+  "mappings": "AAAA,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