@scalar/workspace-store 0.18.1 → 0.19.0

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

@@ -1,3 +1,5 @@
+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 = {
     /**
@@ -7,5 +9,203 @@ export type OperationEvents = {
         /** 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.
+     */
+    '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.
+     * The new summary is provided in the payload, and meta identifies the operation by HTTP method and path.
+     */
+    'operation:update:summary': {
+        /** The new summary string to set for the operation. */
+        payload: {
+            summary: string;
+        };
+        /** Operation identity for which the summary is being updated (method and path) */
+        meta: OperationMeta;
+    };
+    /**
+     * Update the HTTP method for the operation.
+     * Triggers when the user changes the HTTP verb (e.g., from GET to POST) in the UI for a given operation.
+     */
+    'operation:update:method': {
+        payload: {
+            /** The new method for the operation */
+            method: HttpMethod;
+        };
+        /** Identifies the target operation by original method and path */
+        meta: OperationMeta;
+    };
+    /**
+     * Update the path for the operation.
+     * Triggers when the user changes the endpoint path for a given operation in the UI.
+     * - `payload.path` is the new path for the operation.
+     * - `meta` identifies the operation by its original method and path.
+     */
+    'operation:update:path': {
+        payload: {
+            /** The new path for the operation */
+            path: string;
+        };
+        /** Identifies the target operation by original method and path */
+        meta: OperationMeta;
+    };
+    /** ------------------------------------------------------------------------------------------------
+     * Operation Parameters Mutators
+     * ------------------------------------------------------------------------------------------------ */
+    /**
+     * Add a parameter to the operation.
+     */
+    'operation:add:parameter': {
+        /**
+         * The type of the parameter to add. Can be 'path', 'query', 'header', or 'cookie'.
+         */
+        type: 'path' | 'query' | 'header' | 'cookie';
+        /**
+         * The payload containing the details of the parameter to add.
+         */
+        payload: {
+            /** The name of the parameter to add */
+            key: string;
+            /** The example value for the parameter to add */
+            value: string;
+            /** Whether the parameter is enabled */
+            isEnabled: boolean;
+        };
+        /** Identifies the target operation and example variant for the added parameter */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Update a parameter of the operation.
+     * Triggers when the user updates an existing parameter (name, value, or enabled/disabled) in the UI for a given operation.
+     */
+    'operation:update:parameter': {
+        /**
+         * The type of the parameter to update. Can be 'path', 'query', 'header', or 'cookie'.
+         */
+        type: 'path' | 'query' | 'header' | 'cookie';
+        /**
+         * The zero-based index of the parameter of the given type being updated within the operation.
+         */
+        index: number;
+        /**
+         * Partial payload with new properties for the parameter (optional).
+         * - key: The new name of the parameter (if being renamed).
+         * - value: The new example value for the parameter.
+         * - isEnabled: Whether the parameter is marked as enabled.
+         */
+        payload: Partial<{
+            key: string;
+            value: string;
+            isEnabled: boolean;
+        }>;
+        /**
+         * Identifies the target operation and example variant for the updated parameter.
+         */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Delete a parameter from an operation at the specified index and type.
+     * Fires when the user removes a parameter (by type and index) from an operation.
+     */
+    'operation:delete:parameter': {
+        /** The type of the parameter to delete. Can be 'path', 'query', 'header', or 'cookie'. */
+        type: 'path' | 'query' | 'header' | 'cookie';
+        /** The zero-based index of the parameter of the given type to be deleted within the operation. */
+        index: number;
+        /** Identifies the target operation and example variant for the deleted parameter. */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Delete all parameters of a given type from the operation.
+     * Fires when the user removes all parameters of a specific type from an operation.
+     */
+    'operation:delete-all:parameters': {
+        /** The type of the parameters to delete. Can be 'path', 'query', 'header', or 'cookie'. */
+        type: 'path' | 'query' | 'header' | 'cookie';
+        /** Identifies the target operation for the parameter deletion. */
+        meta: OperationMeta;
+    };
+    /**
+     * Update the selected request-body content type for the current example key.
+     * Triggers when the user selects a new content type for the request body in the UI.
+     */
+    'operation:update:requestBody:contentType': {
+        payload: {
+            /** The new content type for the request body */
+            contentType: string;
+        };
+        /** Identifies the target operation and example variant for the updated content type */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Update the value for the request body example.
+     * Triggers when the user updates the example value for a specific request body content type.
+     */
+    'operation:update:requestBody:value': {
+        payload: {
+            /** The new value for the request body example */
+            value: string | File | undefined;
+        };
+        /** The content type of the request body */
+        contentType: string;
+        /** Identifies the target operation and example variant for the updated request body value */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Add a form-data row to the request body example.
+     * Triggers when the user adds a new form-data row to the request body in the UI.
+     */
+    'operation:add:requestBody:formRow': {
+        /** The payload containing the details of the form-data row to add */
+        payload: Partial<{
+            key: string;
+            value: string | File;
+        }>;
+        /** The content type of the request body */
+        contentType: string;
+        /** Identifies the target operation and example variant for the added form-data row */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Update a form-data row at the specified index for the request body example.
+     * Triggers when the user updates an existing form-data row (name, value) in the UI for a given operation.
+     */
+    'operation:update:requestBody:formRow': {
+        /** The zero-based index of the form-data row to update within the operation. */
+        index: number;
+        /** The payload containing the details of the form-data row to update */
+        payload: Partial<{
+            key: string;
+            value?: string | File | null;
+        }>;
+        /** The content type of the request body */
+        contentType: string;
+        /** Identifies the target operation and example variant for the updated form-data row */
+        meta: OperationExampleMeta;
+    };
+    /**
+     * Delete a form-data row from the request body example.
+     * Triggers when the user removes a form-data row (by type and index) from the request body in the UI.
+     */
+    'operation:delete:requestBody:formRow': {
+        /** The zero-based index of the form-data row to delete within the operation. */
+        index: number;
+        /** The content type of the request body */
+        contentType: string;
+        /** Identifies the target operation and example variant for the deleted form-data row */
+        meta: OperationExampleMeta;
+    };
 };
 //# sourceMappingURL=operation.d.ts.map

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,0CAA0C;AAC1C,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,yBAAyB,EAAE;QACzB,wCAAwC;QACxC,IAAI,EAAE,MAAM,CAAA;KACb,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;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"}

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

@@ -48,5 +48,10 @@ export type UIEvents = {
         /** 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;
+    };
 };
 //# 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;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,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"}

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

@@ -0,0 +1,40 @@
+/**
+ * Generates a unique value based on a given default value and a validation function.
+ *
+ * The process works as follows:
+ * 1. Optionally transform (e.g., slugify) the default value using a transformation function.
+ * 2. Check if this value is unique by executing the provided validation function.
+ * 3. If not unique, repeatedly append an incrementing integer (e.g., "my-name 1", "my-name 2", ...) and re-check uniqueness,
+ *    up to a maximum number of attempts (maxRetries).
+ * 4. Returns the first unique value found or undefined if a unique value cannot be generated within the maximum retries.
+ *
+ * Example:
+ * ```ts
+ * // Existing names in use
+ * const existing = new Set(['foo', 'foo 1', 'foo 2']);
+ * const uniqueName = generateUniqueValue({
+ *   defaultValue: 'foo',
+ *   validation: (value) => !existing.has(value),
+ *   // transformation is optional, e.g. (val) => val.toLowerCase().replace(/[^\w]+/g, '-'),
+ *   maxRetries: 10,
+ * });
+ * // uniqueName === 'foo 3'
+ * ```
+ */
+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, }: {
+    /**
+     * Value which will be used to derive a new unique value.
+     */
+    defaultValue: string;
+    /** Validate if the new generated value is unique */
+    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 */
+    transformation?: (value: string) => string;
+    /** The maximum number of retry attempts to generate a unique value. */
+    maxRetries: number;
+}): string | undefined;
+//# sourceMappingURL=generate-unique-value.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,42 @@
+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 = 5
+}) {
+  const transformed = transformation?.(defaultValue) ?? defaultValue;
+  if (validation(transformed)) {
+    return transformed;
+  }
+  return incrementValue({
+    value: [transformed, 1],
+    validation,
+    maxRetries
+  });
+}
+function incrementValue({
+  value,
+  validation,
+  maxRetries,
+  attempts = 0
+}) {
+  if (attempts >= maxRetries) {
+    return;
+  }
+  const incremented = value.join(" ");
+  if (validation(incremented)) {
+    return incremented;
+  }
+  return incrementValue({
+    value: [value[0], value[1] + 1],
+    validation,
+    maxRetries,
+    attempts: attempts + 1
+  });
+}
+export {
+  generateUniqueValue
+};
+//# sourceMappingURL=generate-unique-value.js.map

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

@@ -0,0 +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;",
+  "names": []
+}

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

@@ -1 +1 @@
-{"version":3,"file":"overrides-proxy.d.ts","sourceRoot":"","sources":["../../src/helpers/overrides-proxy.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,kBAAkB,eAA+B,CAAA;AAE9D;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,CAAC,CAAA;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpE,QAAQ,CAAC,EACT,UAAU;IACR,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAC3B,EACD,OAAM;IACJ,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAG5B,KACA,CAgEF,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,KAAK,OAAO,KAAG,OAErD,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAMnD"}
+{"version":3,"file":"overrides-proxy.d.ts","sourceRoot":"","sources":["../../src/helpers/overrides-proxy.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,kBAAkB,eAA+B,CAAA;AAE9D;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,CAAC,CAAA;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpE,QAAQ,CAAC,EACT,UAAU;IACR,SAAS,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,CAAA;CAC3B,EACD,OAAM;IACJ,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAG5B,KACA,CAgEF,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,KAAK,OAAO,KAAG,OAErD,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAUnD"}

package/dist/helpers/overrides-proxy.js

@@ -49,7 +49,7 @@ const isOverridesProxyObject = (obj) => {
   return typeof obj === "object" && obj !== null && obj[isOverridesProxy] === true;
 };
 function unpackOverridesProxy(input) {
-  if (input[isOverridesProxy]) {
+  if (typeof input === "object" && input !== null && input[isOverridesProxy]) {
     return input[getOverridesTarget];
   }
   return input;

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

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/helpers/overrides-proxy.ts"],
-  "sourcesContent": ["import { isObject } from '@/helpers/general'\n\nconst isOverridesProxy = Symbol('isOverridesProxy')\nexport const getOverridesTarget = Symbol('getOverridesTarget')\n\n/**\n * Recursively makes all properties of a type optional.\n *\n * - If T is an object, recursively applies DeepPartial to each property, making them optional.\n * - Otherwise, T is returned as-is.\n *\n * @template T - The type to make deeply partial (optional).\n * @example\n * type Example = { a: { b: number } }\n * type PartialExample = DeepPartial<Example>\n * // Result: { a?: { b?: number } }\n */\nexport type DeepPartial<T> = T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T\n\n/**\n * Creates a proxy object that overlays \"overrides\" on top of a target object.\n *\n * - When reading a property, if an override exists, it is returned; otherwise, the original value is returned.\n * - When writing to a property, if an override exists, it is updated; otherwise, the original object is updated.\n * - This works recursively for nested objects, so overrides can be deeply partial.\n * - Special symbols are used to identify the proxy and to access the original target.\n *\n * @template T - The type of the target object.\n * @param target - The original object to proxy.\n * @param overrides - An optional object containing override values (deeply partial).\n * @returns A proxy object that reflects overrides on top of the target.\n *\n * @example\n * const original = { a: 1, b: { c: 2 } }\n * const overrides = { b: { c: 42 } }\n * const proxy = createOverridesProxy(original, { overrides })\n *\n * console.log(proxy.a) // 1 (from original)\n * console.log(proxy.b.c) // 42 (from overrides)\n *\n * proxy.a = 100\n * console.log(original.a) // 100\n *\n * proxy.b.c = 99\n * console.log(overrides.b.c) // 99\n */\nexport const createOverridesProxy = <T extends Record<string, unknown>>(\n  target: T,\n  options?: {\n    overrides?: DeepPartial<T>\n  },\n  args: {\n    cache: WeakMap<object, any>\n  } = {\n    cache: new WeakMap(),\n  },\n): T => {\n  if (!target || typeof target !== 'object') {\n    return target\n  }\n\n  // Return existing proxy for the same target to ensure referential stability\n  if (args.cache.has(target)) {\n    return args.cache.get(target)!\n  }\n\n  const { overrides } = options ?? {}\n\n  // Proxy handler to intercept get/set operations\n  const handler: ProxyHandler<T> = {\n    get(target, prop, receiver) {\n      // Special symbol to identify this as an overrides proxy\n      if (prop === isOverridesProxy) {\n        return true\n      }\n\n      // Special symbol to access the original target object\n      if (prop === getOverridesTarget) {\n        return target\n      }\n\n      const value = Reflect.get(target, prop, receiver)\n\n      // Return early if the value is already an overrides proxy\n      if (isOverridesProxyObject(value)) {\n        return value\n      }\n\n      // If the value is not an object, return the override if it exists, else the original value\n      if (!isObject(value)) {\n        return Reflect.get(overrides ?? {}, prop) ?? value\n      }\n\n      // For nested objects, recursively create a proxy with the corresponding overrides\n      return createOverridesProxy(value, { overrides: Reflect.get(overrides ?? {}, prop) }, args)\n    },\n\n    set(target, prop, value, receiver) {\n      // Prevent setting special symbols\n      if (prop === isOverridesProxy || prop === getOverridesTarget) {\n        return false\n      }\n\n      // If an override exists for this property, update it\n      const hasOverride = overrides && Reflect.has(overrides, prop)\n\n      if (hasOverride && overrides && typeof overrides === 'object') {\n        ;(overrides as any)[prop] = value\n        return true\n      }\n\n      // Otherwise, update the original target\n      return Reflect.set(target, prop, value, receiver)\n    },\n  }\n\n  // Return the proxy object\n  const proxy = new Proxy<T>(target, handler)\n  args.cache.set(target, proxy)\n  return proxy\n}\n\nexport const isOverridesProxyObject = (obj: unknown): boolean => {\n  return typeof obj === 'object' && obj !== null && (obj as { [isOverridesProxy]: boolean })[isOverridesProxy] === true\n}\n\n/**\n * Unpacks an object from the overrides proxy, returning the original (unproxied) target object.\n * If the input is not an overrides proxy, returns the object as-is.\n *\n * @param input - The potentially proxied object\n * @returns The original unproxied target object or the input object\n */\nexport function unpackOverridesProxy<T>(input: T): T {\n  if ((input as T & { [isOverridesProxy]: boolean | undefined })[isOverridesProxy]) {\n    return (input as T & { [getOverridesTarget]: T })[getOverridesTarget]\n  }\n\n  return input\n}\n"],
-  "mappings": "AAAA,SAAS,gBAAgB;AAEzB,MAAM,mBAAmB,OAAO,kBAAkB;AAC3C,MAAM,qBAAqB,OAAO,oBAAoB;AA2CtD,MAAM,uBAAuB,CAClC,QACA,SAGA,OAEI;AAAA,EACF,OAAO,oBAAI,QAAQ;AACrB,MACM;AACN,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,WAAO;AAAA,EACT;AAGA,MAAI,KAAK,MAAM,IAAI,MAAM,GAAG;AAC1B,WAAO,KAAK,MAAM,IAAI,MAAM;AAAA,EAC9B;AAEA,QAAM,EAAE,UAAU,IAAI,WAAW,CAAC;AAGlC,QAAM,UAA2B;AAAA,IAC/B,IAAIA,SAAQ,MAAM,UAAU;AAE1B,UAAI,SAAS,kBAAkB;AAC7B,eAAO;AAAA,MACT;AAGA,UAAI,SAAS,oBAAoB;AAC/B,eAAOA;AAAA,MACT;AAEA,YAAM,QAAQ,QAAQ,IAAIA,SAAQ,MAAM,QAAQ;AAGhD,UAAI,uBAAuB,KAAK,GAAG;AACjC,eAAO;AAAA,MACT;AAGA,UAAI,CAAC,SAAS,KAAK,GAAG;AACpB,eAAO,QAAQ,IAAI,aAAa,CAAC,GAAG,IAAI,KAAK;AAAA,MAC/C;AAGA,aAAO,qBAAqB,OAAO,EAAE,WAAW,QAAQ,IAAI,aAAa,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI;AAAA,IAC5F;AAAA,IAEA,IAAIA,SAAQ,MAAM,OAAO,UAAU;AAEjC,UAAI,SAAS,oBAAoB,SAAS,oBAAoB;AAC5D,eAAO;AAAA,MACT;AAGA,YAAM,cAAc,aAAa,QAAQ,IAAI,WAAW,IAAI;AAE5D,UAAI,eAAe,aAAa,OAAO,cAAc,UAAU;AAC7D;AAAC,QAAC,UAAkB,IAAI,IAAI;AAC5B,eAAO;AAAA,MACT;AAGA,aAAO,QAAQ,IAAIA,SAAQ,MAAM,OAAO,QAAQ;AAAA,IAClD;AAAA,EACF;AAGA,QAAM,QAAQ,IAAI,MAAS,QAAQ,OAAO;AAC1C,OAAK,MAAM,IAAI,QAAQ,KAAK;AAC5B,SAAO;AACT;AAEO,MAAM,yBAAyB,CAAC,QAA0B;AAC/D,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAS,IAAwC,gBAAgB,MAAM;AACnH;AASO,SAAS,qBAAwB,OAAa;AACnD,MAAK,MAA0D,gBAAgB,GAAG;AAChF,WAAQ,MAA0C,kBAAkB;AAAA,EACtE;AAEA,SAAO;AACT;",
+  "sourcesContent": ["import { isObject } from '@/helpers/general'\n\nconst isOverridesProxy = Symbol('isOverridesProxy')\nexport const getOverridesTarget = Symbol('getOverridesTarget')\n\n/**\n * Recursively makes all properties of a type optional.\n *\n * - If T is an object, recursively applies DeepPartial to each property, making them optional.\n * - Otherwise, T is returned as-is.\n *\n * @template T - The type to make deeply partial (optional).\n * @example\n * type Example = { a: { b: number } }\n * type PartialExample = DeepPartial<Example>\n * // Result: { a?: { b?: number } }\n */\nexport type DeepPartial<T> = T extends object ? { [K in keyof T]?: DeepPartial<T[K]> } : T\n\n/**\n * Creates a proxy object that overlays \"overrides\" on top of a target object.\n *\n * - When reading a property, if an override exists, it is returned; otherwise, the original value is returned.\n * - When writing to a property, if an override exists, it is updated; otherwise, the original object is updated.\n * - This works recursively for nested objects, so overrides can be deeply partial.\n * - Special symbols are used to identify the proxy and to access the original target.\n *\n * @template T - The type of the target object.\n * @param target - The original object to proxy.\n * @param overrides - An optional object containing override values (deeply partial).\n * @returns A proxy object that reflects overrides on top of the target.\n *\n * @example\n * const original = { a: 1, b: { c: 2 } }\n * const overrides = { b: { c: 42 } }\n * const proxy = createOverridesProxy(original, { overrides })\n *\n * console.log(proxy.a) // 1 (from original)\n * console.log(proxy.b.c) // 42 (from overrides)\n *\n * proxy.a = 100\n * console.log(original.a) // 100\n *\n * proxy.b.c = 99\n * console.log(overrides.b.c) // 99\n */\nexport const createOverridesProxy = <T extends Record<string, unknown>>(\n  target: T,\n  options?: {\n    overrides?: DeepPartial<T>\n  },\n  args: {\n    cache: WeakMap<object, any>\n  } = {\n    cache: new WeakMap(),\n  },\n): T => {\n  if (!target || typeof target !== 'object') {\n    return target\n  }\n\n  // Return existing proxy for the same target to ensure referential stability\n  if (args.cache.has(target)) {\n    return args.cache.get(target)!\n  }\n\n  const { overrides } = options ?? {}\n\n  // Proxy handler to intercept get/set operations\n  const handler: ProxyHandler<T> = {\n    get(target, prop, receiver) {\n      // Special symbol to identify this as an overrides proxy\n      if (prop === isOverridesProxy) {\n        return true\n      }\n\n      // Special symbol to access the original target object\n      if (prop === getOverridesTarget) {\n        return target\n      }\n\n      const value = Reflect.get(target, prop, receiver)\n\n      // Return early if the value is already an overrides proxy\n      if (isOverridesProxyObject(value)) {\n        return value\n      }\n\n      // If the value is not an object, return the override if it exists, else the original value\n      if (!isObject(value)) {\n        return Reflect.get(overrides ?? {}, prop) ?? value\n      }\n\n      // For nested objects, recursively create a proxy with the corresponding overrides\n      return createOverridesProxy(value, { overrides: Reflect.get(overrides ?? {}, prop) }, args)\n    },\n\n    set(target, prop, value, receiver) {\n      // Prevent setting special symbols\n      if (prop === isOverridesProxy || prop === getOverridesTarget) {\n        return false\n      }\n\n      // If an override exists for this property, update it\n      const hasOverride = overrides && Reflect.has(overrides, prop)\n\n      if (hasOverride && overrides && typeof overrides === 'object') {\n        ;(overrides as any)[prop] = value\n        return true\n      }\n\n      // Otherwise, update the original target\n      return Reflect.set(target, prop, value, receiver)\n    },\n  }\n\n  // Return the proxy object\n  const proxy = new Proxy<T>(target, handler)\n  args.cache.set(target, proxy)\n  return proxy\n}\n\nexport const isOverridesProxyObject = (obj: unknown): boolean => {\n  return typeof obj === 'object' && obj !== null && (obj as { [isOverridesProxy]: boolean })[isOverridesProxy] === true\n}\n\n/**\n * Unpacks an object from the overrides proxy, returning the original (unproxied) target object.\n * If the input is not an overrides proxy, returns the object as-is.\n *\n * @param input - The potentially proxied object\n * @returns The original unproxied target object or the input object\n */\nexport function unpackOverridesProxy<T>(input: T): T {\n  if (\n    typeof input === 'object' &&\n    input !== null &&\n    (input as T & { [isOverridesProxy]: boolean | undefined })[isOverridesProxy]\n  ) {\n    return (input as T & { [getOverridesTarget]: T })[getOverridesTarget]\n  }\n\n  return input\n}\n"],
+  "mappings": "AAAA,SAAS,gBAAgB;AAEzB,MAAM,mBAAmB,OAAO,kBAAkB;AAC3C,MAAM,qBAAqB,OAAO,oBAAoB;AA2CtD,MAAM,uBAAuB,CAClC,QACA,SAGA,OAEI;AAAA,EACF,OAAO,oBAAI,QAAQ;AACrB,MACM;AACN,MAAI,CAAC,UAAU,OAAO,WAAW,UAAU;AACzC,WAAO;AAAA,EACT;AAGA,MAAI,KAAK,MAAM,IAAI,MAAM,GAAG;AAC1B,WAAO,KAAK,MAAM,IAAI,MAAM;AAAA,EAC9B;AAEA,QAAM,EAAE,UAAU,IAAI,WAAW,CAAC;AAGlC,QAAM,UAA2B;AAAA,IAC/B,IAAIA,SAAQ,MAAM,UAAU;AAE1B,UAAI,SAAS,kBAAkB;AAC7B,eAAO;AAAA,MACT;AAGA,UAAI,SAAS,oBAAoB;AAC/B,eAAOA;AAAA,MACT;AAEA,YAAM,QAAQ,QAAQ,IAAIA,SAAQ,MAAM,QAAQ;AAGhD,UAAI,uBAAuB,KAAK,GAAG;AACjC,eAAO;AAAA,MACT;AAGA,UAAI,CAAC,SAAS,KAAK,GAAG;AACpB,eAAO,QAAQ,IAAI,aAAa,CAAC,GAAG,IAAI,KAAK;AAAA,MAC/C;AAGA,aAAO,qBAAqB,OAAO,EAAE,WAAW,QAAQ,IAAI,aAAa,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI;AAAA,IAC5F;AAAA,IAEA,IAAIA,SAAQ,MAAM,OAAO,UAAU;AAEjC,UAAI,SAAS,oBAAoB,SAAS,oBAAoB;AAC5D,eAAO;AAAA,MACT;AAGA,YAAM,cAAc,aAAa,QAAQ,IAAI,WAAW,IAAI;AAE5D,UAAI,eAAe,aAAa,OAAO,cAAc,UAAU;AAC7D;AAAC,QAAC,UAAkB,IAAI,IAAI;AAC5B,eAAO;AAAA,MACT;AAGA,aAAO,QAAQ,IAAIA,SAAQ,MAAM,OAAO,QAAQ;AAAA,IAClD;AAAA,EACF;AAGA,QAAM,QAAQ,IAAI,MAAS,QAAQ,OAAO;AAC1C,OAAK,MAAM,IAAI,QAAQ,KAAK;AAC5B,SAAO;AACT;AAEO,MAAM,yBAAyB,CAAC,QAA0B;AAC/D,SAAO,OAAO,QAAQ,YAAY,QAAQ,QAAS,IAAwC,gBAAgB,MAAM;AACnH;AASO,SAAS,qBAAwB,OAAa;AACnD,MACE,OAAO,UAAU,YACjB,UAAU,QACT,MAA0D,gBAAgB,GAC3E;AACA,WAAQ,MAA0C,kBAAkB;AAAA,EACtE;AAEA,SAAO;AACT;",
   "names": ["target"]
 }

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

@@ -2,5 +2,5 @@
  * Unpacks special vue reactivity & override & detect-changes & magic proxy from an input object or array,
  * returning the "raw" plain object or array.
  */
-export declare const unpackProxyObject: <T extends object | Array<unknown>>(input: T) => T;
+export declare const unpackProxyObject: <T>(input: T) => 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,SAAS,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,KAAG,CACV,CAAA"}
+{"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"}

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 extends object | Array<unknown>>(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,CAAoC,UACnE,yBAAyB,MAAM,OAAO,qBAAqB,KAAK,CAAC,CAAC,CAAC;",
+  "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": []
 }

package/dist/mutators/auth.d.ts

@@ -0,0 +1,210 @@
+import type { HttpMethod } from '@scalar/helpers/http/http-methods';
+import type { WorkspaceDocument } from '../schemas.js';
+import type { SecurityRequirementObject } from '../schemas/v3.1/strict/security-requirement.js';
+import type { SecuritySchemeObject } from '../schemas/v3.1/strict/security-scheme.js';
+/**
+ * AuthMeta defines the meta information needed to specify whether the authentication operation
+ * is being performed at the document level (entire API), or for a specific operation (specific path and method).
+ *
+ * - If type is 'document', the operation applies to the whole OpenAPI document.
+ * - If type is 'operation', it targets a specific operation, identified by its path and method.
+ */
+export type AuthMeta = {
+    type: 'document';
+} | {
+    type: 'operation';
+    path: string;
+    method: HttpMethod;
+};
+/**
+ * Updates the selected security schemes for either the entire document or a specific operation.
+ * - Adds newly created security schemes (if any) to the workspace document's components.
+ * - Ensures that each new scheme name is unique within the document by using `generateUniqueValue`.
+ * - Updates the `x-scalar-selected-security` property on the target (document or operation) to reflect the new set of selected security schemes.
+ * - Corrects and maintains the selected index so it points to a valid security scheme.
+ *
+ * @param document - The workspace OpenAPI document to mutate (can be null, in which case nothing happens)
+ * @param selectedSecuritySchemes - The current list of selected security scheme objects
+ * @param create - Array of new schemes to create, each with a name and a scheme definition
+ * @param meta - Location to update: whole document or a specific operation (`{ type: 'document' }` or `{ type: 'operation', path, method }`)
+ *
+ * Example usage:
+ * ```
+ * updateSelectedSecuritySchemes({
+ *   document,
+ *   selectedSecuritySchemes: [{ bearerAuth: [] }],
+ *   create: [
+ *     { name: 'ApiKeyAuth', scheme: { type: 'apiKey', in: 'header', name: 'X-API-Key' } }
+ *   ],
+ *   meta: { type: 'document' }
+ * })
+ * ```
+ */
+export declare const updateSelectedSecuritySchemes: ({ document, selectedRequirements, newSchemes, meta, }: {
+    document: WorkspaceDocument | null;
+    selectedRequirements: SecurityRequirementObject[];
+    newSchemes: {
+        name: string;
+        scheme: SecuritySchemeObject;
+    }[];
+    meta: AuthMeta;
+}) => void;
+/**
+ * SecuritySchemeUpdate represents the possible updates that can be made
+ * to an OpenAPI security scheme object via UI interactions.
+ *
+ * - `http`: Updates to HTTP type schemes (e.g. basic, bearer), allowing token, username, and password changes.
+ * - `apiKey`: Updates to API Key type schemes, allowing the key name and its value to be updated.
+ * - `oauth2`: Updates to OAuth2 type schemes for each supported OAuth2 flow.
+ *    - Can set various properties such as auth/token URLs, tokens, PKCE method, client credentials, etc.
+ */
+export type SecuritySchemeUpdate = {
+    type: 'http';
+    payload: Partial<{
+        token: string;
+        username: string;
+        password: string;
+    }>;
+} | {
+    type: 'apiKey';
+    payload: Partial<{
+        name: string;
+        value: string;
+    }>;
+} | {
+    type: 'oauth2';
+    flow: 'implicit' | 'password' | 'clientCredentials' | 'authorizationCode';
+    payload: Partial<{
+        authUrl: string;
+        tokenUrl: string;
+        token: string;
+        redirectUrl: string;
+        clientId: string;
+        clientSecret: string;
+        usePkce: 'no' | 'SHA-256' | 'plain';
+        username: string;
+        password: string;
+    }>;
+};
+/**
+ * Updates a security scheme in the OpenAPI document's components object.
+ * Handles updates for HTTP, API Key, and OAuth2 types, saving secret information and configuration for UI-auth flows.
+ *
+ * @param document - The OpenAPI workspace document (can be null)
+ * @param data - The update information, including type and payload
+ * @param name - The name of the security scheme in document.components.securitySchemes
+ *
+ * Example usage:
+ *
+ * updateSecurityScheme({
+ *   document,
+ *   data: {
+ *     type: 'http',
+ *     payload: {
+ *       username: 'user123',
+ *       password: 'pw123',
+ *       token: 'tokenval'
+ *     }
+ *   },
+ *   name: 'MyHttpAuth',
+ * })
+ */
+export declare const updateSecurityScheme: ({ document, data, name, }: {
+    document: WorkspaceDocument | null;
+    data: SecuritySchemeUpdate;
+    name: string;
+}) => void;
+/**
+ * Sets the selected authentication tab (scheme) index for the given OpenAPI document or operation.
+ * - When on the document level, updates the 'x-selected-index' on the document's x-scalar-selected-security extension.
+ * - When on an operation (endpoint) level, updates the 'x-selected-index' for that operation's x-scalar-selected-security.
+ *
+ * Also initializes the x-scalar-selected-security extension if it does not exist.
+ *
+ * @param document The OpenAPI document object (may be null)
+ * @param index The index to set as selected
+ * @param meta Context where the selection applies ('document' or specific operation)
+ *
+ * @example
+ * // Document-level tab selection
+ * updateSelectedAuthTab({
+ *   document,
+ *   index: 1,
+ *   meta: { type: 'document' }
+ * });
+ *
+ * // Operation-level tab selection (e.g., GET /pets)
+ * updateSelectedAuthTab({
+ *   document,
+ *   index: 0,
+ *   meta: { type: 'operation', path: '/pets', method: 'get' }
+ * });
+ */
+export declare const updateSelectedAuthTab: ({ document, index, meta, }: {
+    document: WorkspaceDocument | null;
+    index: number;
+    meta: AuthMeta;
+}) => void;
+/**
+ * Updates the scopes for a specific security requirement in the selected security schemes of
+ * a document or operation.
+ *
+ * @param document - The OpenAPI WorkspaceDocument to update.
+ * @param id - An array of scheme names that uniquely identifies the target security requirement.
+ *             For example: ['OAuth', 'ApiKeyAuth']
+ * @param name - The security scheme name to update scopes for (e.g., 'OAuth').
+ * @param scopes - The new list of scopes to set. For example: ['read:pets', 'write:pets']
+ * @param meta - The context specifying whether the update is at the document-level or operation-level.
+ *
+ * Example usage:
+ * ```ts
+ * // Suppose your document (or operation) x-scalar-selected-security looks like:
+ * // "x-scalar-selected-security": {
+ * //   "x-selected-index": 0,
+ * //   "x-schemes": [
+ * //     { "OAuth": ["read:pets"] },
+ * //     { "ApiKeyAuth": [] }
+ * //   ]
+ * // }
+ *
+ * updateSelectedScopes({
+ *   document,
+ *   id: ["OAuth"],     // identifies the scheme object: { "OAuth": [...] }
+ *   name: "OAuth",     // scheme name to update within this security requirement
+ *   scopes: ["write:pets"], // new scopes array
+ *   meta: { type: "document" }
+ * })
+ * // After, the first scheme becomes: { "OAuth": ["write:pets"] }
+ * ```
+ */
+export declare const updateSelectedScopes: ({ document, id, name, scopes, meta, }: {
+    document: WorkspaceDocument | null;
+    id: string[];
+    name: string;
+    scopes: string[];
+    meta: AuthMeta;
+}) => void;
+/**
+ * Deletes one or more security schemes from an OpenAPI WorkspaceDocument,
+ * and removes all references to those schemes from selected security, document-level security,
+ * and operation-level security/selected security (e.g., on paths).
+ *
+ * Example usage:
+ *
+ * ```ts
+ * deleteSecurityScheme({
+ *   document,                                // The OpenAPI document to update
+ *   names: ['ApiKeyAuth', 'BearerAuth'],     // The names of security schemes you want to delete
+ * });
+ * ```
+ *
+ * After running this function:
+ * - The named security schemes are removed from the components.securitySchemes section.
+ * - All document-level and operation-level security entries referencing those schemes are removed.
+ * - Any extended x-scalar-selected-security references to those schemes are also removed.
+ */
+export declare const deleteSecurityScheme: ({ document, names }: {
+    document: WorkspaceDocument | null;
+    names: string[];
+}) => void;
+//# sourceMappingURL=auth.d.ts.map

package/dist/mutators/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/mutators/auth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAInE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAClD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,4CAA4C,CAAA;AAC3F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAEjF;;;;;;GAMG;AACH,MAAM,MAAM,QAAQ,GAChB;IACE,IAAI,EAAE,UAAU,CAAA;CACjB,GACD;IACE,IAAI,EAAE,WAAW,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;CACnB,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,6BAA6B,GAAI,uDAK3C;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,oBAAoB,EAAE,yBAAyB,EAAE,CAAA;IACjD,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,oBAAoB,CAAA;KAAE,EAAE,CAAA;IAC5D,IAAI,EAAE,QAAQ,CAAA;CACf,SA4EA,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IACE,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,OAAO,CAAC;QACf,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAC,CAAA;CACH,GACD;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,OAAO,CAAC;QACf,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;CACH,GACD;IACE,IAAI,EAAE,QAAQ,CAAA;IACd,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,mBAAmB,GAAG,mBAAmB,CAAA;IACzE,OAAO,EAAE,OAAO,CAAC;QACf,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;QAChB,YAAY,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,IAAI,GAAG,SAAS,GAAG,OAAO,CAAA;QACnC,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAC,CAAA;CACH,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,oBAAoB,GAAI,2BAIlC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,IAAI,EAAE,oBAAoB,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb,SAwEA,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,qBAAqB,GAAI,4BAInC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,QAAQ,CAAA;CACf,SA8BA,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,eAAO,MAAM,oBAAoB,GAAI,uCAMlC;IACD,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAClC,EAAE,EAAE,MAAM,EAAE,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,IAAI,EAAE,QAAQ,CAAA;CACf,SAoCA,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB,GAAI,qBAAqB;IAAE,QAAQ,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAA;CAAE,SA4DhH,CAAA"}