@scalar/api-client 2.2.54 → 2.2.56

package/dist/libs/create-client.js

@@ -1,60 +1,61 @@
-import { LAYOUT_SYMBOL as Y } from "../hooks/useLayout.js";
-import { createSidebarState as F, SIDEBAR_SYMBOL as W } from "../hooks/useSidebar.js";
-import { loadAllResources as K } from "./local-storage.js";
-import { createActiveEntitiesStore as D, ACTIVE_ENTITIES_SYMBOL as N } from "../store/active-entities.js";
-import { createWorkspaceStore as V, WORKSPACE_SYMBOL as z } from "../store/store.js";
-import { workspaceSchema as H } from "@scalar/oas-utils/entities/workspace";
-import { LS_KEYS as J, objectMerge as G, prettyPrintJson as Q } from "@scalar/oas-utils/helpers";
-import { DATA_VERSION_LS_LEY as X, DATA_VERSION as Z } from "@scalar/oas-utils/migrations";
-import { createApp as $, watch as ee } from "vue";
-const de = ({
-  el: M,
-  appComponent: q,
+import { LAYOUT_SYMBOL as F } from "../hooks/useLayout.js";
+import { createSidebarState as W, SIDEBAR_SYMBOL as K } from "../hooks/useSidebar.js";
+import { getRequestUidByPathMethod as D } from "./get-request-uid-by-path-method.js";
+import { loadAllResources as N } from "./local-storage.js";
+import { createActiveEntitiesStore as V, ACTIVE_ENTITIES_SYMBOL as z } from "../store/active-entities.js";
+import { createWorkspaceStore as H, WORKSPACE_SYMBOL as J } from "../store/store.js";
+import { workspaceSchema as G } from "@scalar/oas-utils/entities/workspace";
+import { LS_KEYS as Q, objectMerge as X, prettyPrintJson as Z } from "@scalar/oas-utils/helpers";
+import { DATA_VERSION_LS_LEY as $, DATA_VERSION as ee } from "@scalar/oas-utils/migrations";
+import { createApp as te, watch as re } from "vue";
+const pe = ({
+  el: k,
+  appComponent: x,
   configuration: s = {},
-  isReadOnly: h = !1,
-  store: k,
-  persistData: _ = !0,
-  mountOnInitialize: x = !0,
-  layout: v = "desktop",
-  router: n
+  isReadOnly: m = !1,
+  store: q,
+  persistData: E = !0,
+  mountOnInitialize: U = !0,
+  layout: p = "desktop",
+  router: u
 }) => {
-  const a = k || V({
+  const a = q || H({
     proxyUrl: s.proxyUrl,
     themeId: s.themeId,
     showSidebar: s.showSidebar ?? !0,
     hideClientButton: s.hideClientButton ?? !1,
     integration: s._integration,
-    useLocalStorage: _
-  }), f = D({ ...a, router: n }), E = F({ layout: v }), y = () => {
+    useLocalStorage: E
+  }), S = V({ ...a, router: u }), I = W({ layout: p }), h = () => {
     try {
       return typeof window < "u" && window.localStorage !== void 0;
     } catch {
       return !1;
     }
   };
-  if (y() && localStorage.getItem(J.WORKSPACE) && !h)
+  if (h() && localStorage.getItem(Q.WORKSPACE) && !m)
     try {
       const e = {};
-      let r = 0, t = 0, o = "";
+      let t = 0, r = 0, o = "";
       for (o in localStorage)
-        Object.prototype.hasOwnProperty.call(localStorage, o) && (t = (localStorage[o].length + o.length) * 2, r += t, e[o] = (t / 1024).toFixed(2) + " KB");
-      e.Total = (r / 1024).toFixed(2) + " KB", console.table(e), K(a);
+        Object.prototype.hasOwnProperty.call(localStorage, o) && (r = (localStorage[o].length + o.length) * 2, t += r, e[o] = (r / 1024).toFixed(2) + " KB");
+      e.Total = (t / 1024).toFixed(2) + " KB", console.table(e), N(a);
     } catch (e) {
       console.warn("Failed to load from localStorage:", e);
     }
-  else if (!h || !s.spec) {
+  else if (!m || !s.spec) {
     if (a.workspaceMutators.add({
       uid: "default",
       name: "Workspace",
       proxyUrl: s.proxyUrl
-    }), y())
+    }), h())
       try {
-        localStorage.setItem(X, Z);
+        localStorage.setItem($, ee);
       } catch (e) {
         console.warn("Failed to set localStorage version:", e);
       }
   } else {
-    const e = H.parse({
+    const e = G.parse({
       uid: "default",
       name: "Workspace",
       isReadOnly: !0,
@@ -62,20 +63,20 @@ const de = ({
     });
     a.workspaceMutators.rawAdd(e);
   }
-  const d = $(q);
-  d.use(n), d.provide(z, a), d.provide(Y, v), d.provide(N, f), d.provide(W, E);
+  const l = te(x);
+  l.use(u), l.provide(J, a), l.provide(F, p), l.provide(z, S), l.provide(K, I);
   const {
-    collectionMutators: C,
-    importSpecFile: I,
-    importSpecFromUrl: L,
-    modalState: O,
-    requests: p,
-    securitySchemes: B,
-    securitySchemeMutators: j,
-    servers: U,
-    workspaceMutators: R,
-    requestExampleMutators: T
-  } = a, { activeCollection: m, activeWorkspace: S } = f, b = (e = M) => {
+    collectionMutators: B,
+    importSpecFile: L,
+    importSpecFromUrl: C,
+    modalState: v,
+    requests: f,
+    securitySchemes: R,
+    securitySchemeMutators: T,
+    servers: M,
+    workspaceMutators: g,
+    requestExampleMutators: P
+  } = a, { activeCollection: n, activeWorkspace: d } = S, w = (e = k) => {
     if (!e) {
       console.error(
         "[@scalar/api-client-modal] Could not create the API client.",
@@ -84,15 +85,15 @@ const de = ({
       );
       return;
     }
-    d.mount(e);
+    l.mount(e);
   };
-  x && b();
-  const w = async (e) => {
-    var r, t;
-    e != null && e.url ? await L(e.url, ((r = S.value) == null ? void 0 : r.uid) ?? "", {
+  U && w();
+  const y = async (e) => {
+    var t, r;
+    e != null && e.url ? await C(e.url, ((t = d.value) == null ? void 0 : t.uid) ?? "", {
       ...s,
       setCollectionSecurity: !0
-    }) : e != null && e.content ? await I(e == null ? void 0 : e.content, ((t = S.value) == null ? void 0 : t.uid) ?? "", {
+    }) : e != null && e.content ? await L(e == null ? void 0 : e.content, ((r = d.value) == null ? void 0 : r.uid) ?? "", {
       ...s,
       setCollectionSecurity: !0
     }) : console.error(
@@ -100,36 +101,46 @@ const de = ({
       "Please provide an OpenAPI document: { spec: { url: '…' } }",
       "Read more: https://github.com/scalar/scalar/tree/main/packages/api-client"
     );
+  }, A = (e) => {
+    const t = D(f, e);
+    t ? u.push({
+      name: "request",
+      query: e != null && e._source ? { source: e._source } : {},
+      params: {
+        workspace: "default",
+        request: t
+      }
+    }) : console.warn("[@scalar/api-client] Could not find request for path and method", e);
   };
   return {
     /** The vue app instance for the modal, be careful with this */
-    app: d,
-    updateSpec: w,
+    app: l,
+    updateSpec: y,
     /**
      * Update the API client config
      *
      * Deletes the current store before importing again for now, in the future will Diff
      */
-    updateConfig(e, r = !0) {
-      var t;
-      r ? Object.assign(s ?? {}, e) : G(s ?? {}, e), e.spec && (a.collectionMutators.reset(), a.requestMutators.reset(), a.requestExampleMutators.reset(), a.securitySchemeMutators.reset(), a.serverMutators.reset(), a.tagMutators.reset(), R.edit((t = S.value) == null ? void 0 : t.uid, "collections", []), w(e.spec));
+    updateConfig(e, t = !0) {
+      var r;
+      t ? Object.assign(s ?? {}, e) : X(s ?? {}, e), e.spec && (a.collectionMutators.reset(), a.requestMutators.reset(), a.requestExampleMutators.reset(), a.securitySchemeMutators.reset(), a.serverMutators.reset(), a.tagMutators.reset(), g.edit((r = d.value) == null ? void 0 : r.uid, "collections", []), y(e.spec));
     },
     /** Update the currently selected server via URL */
     updateServer: (e) => {
-      var t;
-      const r = Object.values(U).find((o) => o.url === e);
-      r && m.value && C.edit((t = m.value) == null ? void 0 : t.uid, "selectedServerUid", r.uid);
+      var r;
+      const t = Object.values(M).find((o) => o.url === e);
+      t && n.value && B.edit((r = n.value) == null ? void 0 : r.uid, "selectedServerUid", t.uid);
     },
     /** Update the currently selected server via URL */
     onUpdateServer: (e) => {
-      ee(
+      re(
         () => {
-          var r;
-          return (r = m.value) == null ? void 0 : r.selectedServerUid;
+          var t;
+          return (t = n.value) == null ? void 0 : t.selectedServerUid;
         },
-        (r) => {
-          const t = Object.values(U).find((o) => o.uid === r);
-          t != null && t.url && e(t.url);
+        (t) => {
+          const r = Object.values(M).find((o) => o.uid === t);
+          r != null && r.url && e(r.url);
         }
       );
     },
@@ -138,73 +149,38 @@ const de = ({
      */
     updateAuth: ({
       nameKey: e,
-      propertyKey: r,
-      value: t
+      propertyKey: t,
+      value: r
     }) => {
-      const c = Object.values(B).find((u) => u.nameKey === e);
-      c && j.edit(c.uid, r, t);
+      const c = Object.values(R).find((i) => i.nameKey === e);
+      c && T.edit(c.uid, t, r);
     },
     /** Route to a method + path */
-    route: (e) => {
-      var i;
-      const { requestUid: r, method: t, path: o, _source: c } = e ?? {}, u = r || ((i = Object.values(p).find(
-        (l) => o && t && l.path && l.method ? (
-          // The given operation
-          l.path === o && l.method.toUpperCase() === t.toUpperCase()
-        ) : (
-          // Or the first request
-          !0
-        )
-      )) == null ? void 0 : i.uid);
-      u && n.push({
-        name: "request",
-        query: c ? { source: c } : {},
-        params: {
-          workspace: "default",
-          request: u
-        }
-      });
-    },
+    route: A,
     /** Open the API client modal and optionally route to a request */
     open: (e) => {
-      var i;
-      const { path: r, method: t, requestUid: o, _source: c } = e ?? {}, u = o || ((i = Object.values(p).find(
-        (l) => r && t && l.path && l.method ? (
-          // The given operation
-          l.path === r && l.method.toUpperCase() === t.toUpperCase()
-        ) : (
-          // Or the first request
-          !0
-        )
-      )) == null ? void 0 : i.uid);
-      u && n.push({
-        name: "request",
-        query: c ? { source: c } : {},
-        params: {
-          workspace: "default",
-          request: u
-        }
-      }), O.open = !0;
+      const { method: t, path: r, requestUid: o } = e ?? {};
+      (t && r || o) && A(e), v.open = !0;
     },
     /** Mount the references to a given element */
-    mount: b,
+    mount: w,
     /** State for controlling the modal */
-    modalState: O,
+    modalState: v,
     /* The workspace store */
     store: a,
     /** Update the currently selected example */
-    updateExample: (e, r) => {
-      var u, i, l, A;
-      if (!e || !r) return;
-      const t = Object.values(p).find(
-        ({ operationId: g, path: P }) => g === r || P === r
+    updateExample: (e, t) => {
+      var i, O, b, _;
+      if (!e || !t) return;
+      const r = Object.values(f).find(
+        ({ operationId: j, path: Y }) => j === t || Y === t
       );
-      if (!t) return;
-      const o = Object.keys(((u = t.requestBody) == null ? void 0 : u.content) || {})[0] || "", c = (A = (l = (i = t.requestBody) == null ? void 0 : i.content) == null ? void 0 : l[o]) == null ? void 0 : A.examples[e];
-      c && T.edit(t.examples[0], "body.raw.value", Q(c.value));
+      if (!r) return;
+      const o = Object.keys(((i = r.requestBody) == null ? void 0 : i.content) || {})[0] || "", c = (_ = (b = (O = r.requestBody) == null ? void 0 : O.content) == null ? void 0 : b[o]) == null ? void 0 : _.examples[e];
+      c && P.edit(r.examples[0], "body.raw.value", Z(c.value));
     }
   };
 };
 export {
-  de as createApiClient
+  pe as createApiClient
 };

package/dist/libs/get-request-uid-by-path-method.d.ts

@@ -0,0 +1,7 @@
+import type { OpenClientPayload } from '../libs/create-client';
+import type { Operation } from '@scalar/oas-utils/entities/spec';
+/**
+ * Get the request uid by path and method
+ */
+export declare const getRequestUidByPathMethod: (requests: Record<string, Operation>, payload?: Omit<OpenClientPayload, "_source">) => string | undefined;
+//# sourceMappingURL=get-request-uid-by-path-method.d.ts.map

package/dist/libs/get-request-uid-by-path-method.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-request-uid-by-path-method.d.ts","sourceRoot":"","sources":["../../src/libs/get-request-uid-by-path-method.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,yBAAyB,aAC1B,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,YACzB,IAAI,CAAC,iBAAiB,EAAE,SAAS,CAAC,uBAY7C,CAAA"}

package/dist/libs/get-request-uid-by-path-method.js

@@ -0,0 +1,10 @@
+const c = (o, r) => {
+  var s;
+  const { requestUid: a, method: e, path: t } = r ?? {};
+  return a || ((s = Object.values(o).find(
+    (d) => d.path.toLowerCase() === (t == null ? void 0 : t.toLowerCase()) && d.method.toLowerCase() === (e == null ? void 0 : e.toLowerCase())
+  )) == null ? void 0 : s.uid) || Object.keys(o)[0];
+};
+export {
+  c as getRequestUidByPathMethod
+};

package/dist/libs/get-request-uid-by-path-method.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-request-uid-by-path-method.test.d.ts.map

package/dist/libs/get-request-uid-by-path-method.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-request-uid-by-path-method.test.d.ts","sourceRoot":"","sources":["../../src/libs/get-request-uid-by-path-method.test.ts"],"names":[],"mappings":""}

package/dist/libs/send-request/create-fetch-body.d.ts

@@ -6,7 +6,7 @@ import type { RequestExample, RequestMethod } from '@scalar/oas-utils/entities/s
  * If so we must allow the user to override the content type header
  */
 export declare function createFetchBody(method: RequestMethod, example: RequestExample, env: object): {
-    body: FormData | URLSearchParams;
+    body: URLSearchParams | FormData;
     contentType: string;
 } | {
     body: string;

package/dist/libs/validate-parameters.d.ts

@@ -0,0 +1,6 @@
+import type { RequestExample } from '@scalar/oas-utils/entities/spec';
+/**
+ * Validate required parameters from an example
+ */
+export declare const validateParameters: (example: Partial<RequestExample> | null) => Set<string>;
+//# sourceMappingURL=validate-parameters.d.ts.map

package/dist/libs/validate-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-parameters.d.ts","sourceRoot":"","sources":["../../src/libs/validate-parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAErE;;GAEG;AACH,eAAO,MAAM,kBAAkB,YAAa,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI,gBAezE,CAAA"}

package/dist/libs/validate-parameters.js

@@ -0,0 +1,12 @@
+const i = (a) => {
+  const e = /* @__PURE__ */ new Set();
+  return a && ["path", "query", "headers", "cookies"].some((n) => {
+    var s, t;
+    return (t = (s = a.parameters) == null ? void 0 : s[n]) == null ? void 0 : t.some((r) => {
+      r.required && r.value === "" && e.add(r.key);
+    });
+  }), e;
+};
+export {
+  i as validateParameters
+};

package/dist/libs/validate-parameters.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validate-parameters.test.d.ts.map

package/dist/libs/validate-parameters.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-parameters.test.d.ts","sourceRoot":"","sources":["../../src/libs/validate-parameters.test.ts"],"names":[],"mappings":""}

package/dist/store/cookies.d.ts

@@ -23,13 +23,13 @@ export declare function createStoreCookies(useLocalStorage: boolean): {
             path?: string | undefined;
             domain?: string | undefined;
         }) => void;
-        edit: <P extends "value" | "name" | "uid" | "domain" | "path">(uid: (string & import("zod").BRAND<"cookie">) | null | undefined, path: P, value: P extends "value" | "name" | "uid" | "domain" | "path" ? {
+        edit: <P extends "value" | "path" | "name" | "uid" | "domain">(uid: (string & import("zod").BRAND<"cookie">) | null | undefined, path: P, value: P extends "value" | "path" | "name" | "uid" | "domain" ? {
             value: string;
             uid: string & import("zod").BRAND<"cookie">;
             name: string;
             path?: string | undefined;
             domain?: string | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "name" | "uid" | "domain" | "path" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "path" | "name" | "uid" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
             value: string;
             uid: string & import("zod").BRAND<"cookie">;
             name: string;
@@ -42,13 +42,13 @@ export declare function createStoreCookies(useLocalStorage: boolean): {
             path?: string | undefined;
             domain?: string | undefined;
         }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-        untrackedEdit: <P extends "value" | "name" | "uid" | "domain" | "path">(uid: string & import("zod").BRAND<"cookie">, path: P, value: P extends "value" | "name" | "uid" | "domain" | "path" ? {
+        untrackedEdit: <P extends "value" | "path" | "name" | "uid" | "domain">(uid: string & import("zod").BRAND<"cookie">, path: P, value: P extends "value" | "path" | "name" | "uid" | "domain" ? {
             value: string;
             uid: string & import("zod").BRAND<"cookie">;
             name: string;
             path?: string | undefined;
             domain?: string | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "name" | "uid" | "domain" | "path" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "value" | "path" | "name" | "uid" | "domain" ? R extends import("@scalar/object-utils/nested").Path<{
             value: string;
             uid: string & import("zod").BRAND<"cookie">;
             name: string;

package/dist/store/request-example.d.ts

@@ -304,7 +304,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
             requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
             serverVariables?: Record<string, string[]> | undefined;
         }) => void;
-        edit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | "parameters.query" | "parameters.path" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.key` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.key` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.key` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.binary.text" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.key` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
+        edit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.binary.text" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | `serverVariables.${string}`>(uid: (string & import("zod").BRAND<"example">) | null | undefined, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
             type: "requestExample";
             uid: string & import("zod").BRAND<"example">;
             name: string;
@@ -403,7 +403,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
             };
             requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
             serverVariables?: Record<string, string[]> | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
             type: "requestExample";
             uid: string & import("zod").BRAND<"example">;
             name: string;
@@ -602,7 +602,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
             requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
             serverVariables?: Record<string, string[]> | undefined;
         }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-        untrackedEdit: <P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | "parameters.query" | "parameters.path" | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.key` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.key` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.key` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.binary.text" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.key` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? {
+        untrackedEdit: <P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" | "parameters.path" | "parameters.query" | "parameters.cookies" | `parameters.cookies.${number}` | "parameters.headers" | `parameters.path.${number}` | `parameters.path.${number}.description` | `parameters.path.${number}.required` | `parameters.path.${number}.examples` | `parameters.path.${number}.value` | `parameters.path.${number}.type` | `parameters.path.${number}.default` | `parameters.path.${number}.key` | `parameters.path.${number}.file` | `parameters.path.${number}.enum` | `parameters.path.${number}.nullable` | `parameters.path.${number}.format` | `parameters.path.${number}.maximum` | `parameters.path.${number}.minimum` | `parameters.path.${number}.examples.${number}` | `parameters.path.${number}.enum.${number}` | `parameters.path.${number}.enabled` | `parameters.path.${number}.type.${number}` | `parameters.path.${number}.default.${string}` | `parameters.path.${number}.file.${string}` | `parameters.query.${number}` | `parameters.query.${number}.description` | `parameters.query.${number}.required` | `parameters.query.${number}.examples` | `parameters.query.${number}.value` | `parameters.query.${number}.type` | `parameters.query.${number}.default` | `parameters.query.${number}.key` | `parameters.query.${number}.file` | `parameters.query.${number}.enum` | `parameters.query.${number}.nullable` | `parameters.query.${number}.format` | `parameters.query.${number}.maximum` | `parameters.query.${number}.minimum` | `parameters.query.${number}.examples.${number}` | `parameters.query.${number}.enum.${number}` | `parameters.query.${number}.enabled` | `parameters.query.${number}.type.${number}` | `parameters.query.${number}.default.${string}` | `parameters.query.${number}.file.${string}` | `parameters.cookies.${number}.description` | `parameters.cookies.${number}.required` | `parameters.cookies.${number}.examples` | `parameters.cookies.${number}.value` | `parameters.cookies.${number}.type` | `parameters.cookies.${number}.default` | `parameters.cookies.${number}.key` | `parameters.cookies.${number}.file` | `parameters.cookies.${number}.enum` | `parameters.cookies.${number}.nullable` | `parameters.cookies.${number}.format` | `parameters.cookies.${number}.maximum` | `parameters.cookies.${number}.minimum` | `parameters.cookies.${number}.examples.${number}` | `parameters.cookies.${number}.enum.${number}` | `parameters.cookies.${number}.enabled` | `parameters.cookies.${number}.type.${number}` | `parameters.cookies.${number}.default.${string}` | `parameters.cookies.${number}.file.${string}` | `parameters.headers.${number}` | `parameters.headers.${number}.description` | `parameters.headers.${number}.required` | `parameters.headers.${number}.examples` | `parameters.headers.${number}.value` | `parameters.headers.${number}.type` | `parameters.headers.${number}.default` | `parameters.headers.${number}.key` | `parameters.headers.${number}.file` | `parameters.headers.${number}.enum` | `parameters.headers.${number}.nullable` | `parameters.headers.${number}.format` | `parameters.headers.${number}.maximum` | `parameters.headers.${number}.minimum` | `parameters.headers.${number}.examples.${number}` | `parameters.headers.${number}.enum.${number}` | `parameters.headers.${number}.enabled` | `parameters.headers.${number}.type.${number}` | `parameters.headers.${number}.default.${string}` | `parameters.headers.${number}.file.${string}` | "body.binary" | "body.formData" | "body.raw" | "body.activeBody" | "body.binary.size" | "body.binary.type" | "body.binary.slice" | "body.binary.arrayBuffer" | "body.binary.stream" | "body.binary.text" | "body.formData.value" | "body.formData.encoding" | `body.formData.value.${number}` | `body.formData.value.${number}.description` | `body.formData.value.${number}.required` | `body.formData.value.${number}.examples` | `body.formData.value.${number}.value` | `body.formData.value.${number}.type` | `body.formData.value.${number}.default` | `body.formData.value.${number}.key` | `body.formData.value.${number}.file` | `body.formData.value.${number}.enum` | `body.formData.value.${number}.nullable` | `body.formData.value.${number}.format` | `body.formData.value.${number}.maximum` | `body.formData.value.${number}.minimum` | `body.formData.value.${number}.examples.${number}` | `body.formData.value.${number}.enum.${number}` | `body.formData.value.${number}.enabled` | `body.formData.value.${number}.type.${number}` | `body.formData.value.${number}.default.${string}` | `body.formData.value.${number}.file.${string}` | "body.raw.value" | "body.raw.encoding" | `serverVariables.${string}`>(uid: string & import("zod").BRAND<"example">, path: P, value: P extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? {
             type: "requestExample";
             uid: string & import("zod").BRAND<"example">;
             name: string;
@@ -701,7 +701,7 @@ export declare function createStoreRequestExamples(useLocalStorage: boolean): {
             };
             requestUid?: (string & import("zod").BRAND<"operation">) | undefined;
             serverVariables?: Record<string, string[]> | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "type" | "name" | "uid" | "body" | "requestUid" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "parameters" | "requestUid" | "type" | "name" | "uid" | "body" | "serverVariables" ? R extends import("@scalar/object-utils/nested").Path<{
             type: "requestExample";
             uid: string & import("zod").BRAND<"example">;
             name: string;

package/dist/store/requests.d.ts

@@ -122,7 +122,7 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
             requestBody?: any;
             responses?: Record<string, any> | undefined;
         }) => void;
-        edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "path" | "method" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "path" | "method" | "examples" ? {
+        edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
             path: string;
             type: "request";
             uid: string & import("zod").BRAND<"operation">;
@@ -160,7 +160,7 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "path" | "method" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
             path: string;
             type: "request";
             uid: string & import("zod").BRAND<"operation">;
@@ -237,7 +237,7 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
             requestBody?: any;
             responses?: Record<string, any> | undefined;
         }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-        untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "path" | "method" | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "path" | "method" | "examples" ? {
+        untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.required` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `responses.${string}` | `examples.${number}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
             path: string;
             type: "request";
             uid: string & import("zod").BRAND<"operation">;
@@ -275,7 +275,7 @@ export declare function createStoreRequests(useLocalStorage: boolean): {
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
-        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "path" | "method" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
+        }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
             path: string;
             type: "request";
             uid: string & import("zod").BRAND<"operation">;