@scalar/api-reference 1.25.52 → 1.25.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/CHANGELOG.md +32 -0
  2. package/README.md +3 -2
  3. package/dist/browser/standalone.js +12953 -12838
  4. package/dist/browser/webpack-stats.json +1 -1
  5. package/dist/components/Anchor/Anchor.vue.d.ts.map +1 -1
  6. package/dist/components/Anchor/Anchor.vue.js +1 -1
  7. package/dist/components/Anchor/Anchor.vue2.js +9 -9
  8. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  9. package/dist/components/ApiReferenceLayout.vue.js +2 -2
  10. package/dist/components/ApiReferenceLayout.vue2.js +26 -31
  11. package/dist/components/Card/CardTab.vue.d.ts.map +1 -1
  12. package/dist/components/Card/CardTab.vue.js +2 -2
  13. package/dist/components/Card/CardTab.vue2.js +3 -3
  14. package/dist/components/Content/Operation/ParameterItem.vue.d.ts.map +1 -1
  15. package/dist/components/Content/Operation/ParameterItem.vue.js +4 -4
  16. package/dist/components/Content/Operation/ParameterItem.vue2.js +72 -54
  17. package/dist/components/Content/Operation/TestRequestButton.vue.d.ts.map +1 -1
  18. package/dist/components/Content/Operation/TestRequestButton.vue.js +2 -2
  19. package/dist/components/Content/Operation/TestRequestButton.vue2.js +22 -15
  20. package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
  21. package/dist/components/Content/Schema/Schema.vue.js +3 -3
  22. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  23. package/dist/components/Content/Schema/SchemaProperty.vue.js +2 -2
  24. package/dist/components/Content/Schema/SchemaProperty.vue2.js +114 -88
  25. package/dist/components/Content/Tag/Endpoints.vue.d.ts.map +1 -1
  26. package/dist/components/Content/Tag/Endpoints.vue.js +2 -2
  27. package/dist/components/Content/Tag/Endpoints.vue2.js +79 -64
  28. package/dist/components/Content/Tag/Tag.vue.d.ts.map +1 -1
  29. package/dist/components/Content/Tag/Tag.vue.js +3 -3
  30. package/dist/components/Content/Tag/Tag.vue2.js +34 -21
  31. package/dist/components/Section/CompactSection.vue.d.ts.map +1 -1
  32. package/dist/components/Section/CompactSection.vue.js +1 -1
  33. package/dist/embeds/OpenApiDocument/OpenApiDocument.vue.d.ts.map +1 -1
  34. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts +3 -9
  35. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
  36. package/dist/features/ApiClientModal/ApiClientModal.vue.js +27 -33
  37. package/dist/features/ApiClientModal/useApiClient.d.ts +140 -12
  38. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  39. package/dist/features/BaseUrl/ServerUrlSelect.vue.d.ts.map +1 -1
  40. package/dist/features/BaseUrl/ServerUrlSelect.vue.js +4 -4
  41. package/dist/features/BaseUrl/ServerUrlSelect.vue2.js +11 -9
  42. package/dist/features/ExampleRequest/ExamplePicker.vue.d.ts.map +1 -1
  43. package/dist/features/ExampleRequest/ExamplePicker.vue.js +3 -3
  44. package/dist/features/ExampleRequest/ExamplePicker.vue2.js +28 -21
  45. package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts.map +1 -1
  46. package/dist/features/ExampleRequest/ExampleRequest.vue.js +1 -1
  47. package/dist/features/ExampleRequest/ExampleRequest.vue2.js +139 -119
  48. package/dist/features/ExampleRequest/TextSelect.vue.d.ts +2 -0
  49. package/dist/features/ExampleRequest/TextSelect.vue.d.ts.map +1 -1
  50. package/dist/features/ExampleRequest/TextSelect.vue.js +22 -19
  51. package/dist/features/ExampleResponses/ExampleResponse.vue.js +3 -3
  52. package/dist/features/ExampleResponses/ExampleResponses.vue.d.ts.map +1 -1
  53. package/dist/features/ExampleResponses/ExampleResponses.vue.js +1 -1
  54. package/dist/features/ExampleResponses/ExampleResponses.vue2.js +88 -81
  55. package/dist/index.js +1 -1
  56. package/dist/legacy/components/SecuritySchemeSelector.vue.d.ts.map +1 -1
  57. package/dist/legacy/components/SecuritySchemeSelector.vue.js +3 -3
  58. package/dist/legacy/components/SecuritySchemeSelector.vue2.js +30 -25
  59. package/dist/style.css +1 -1
  60. package/package.json +10 -9
@@ -1,14 +1,8 @@
1
- import type { ReferenceConfiguration, Spec, SpecConfiguration } from '@scalar/types/legacy';
1
+ import type { ClientConfiguration } from '@scalar/api-client/libs';
2
2
  declare const _default: import("vue").DefineComponent<{
3
- proxyUrl?: string;
4
- authentication?: ReferenceConfiguration["authentication"];
5
- spec?: SpecConfiguration;
6
- servers?: Spec["servers"];
3
+ configuration: ClientConfiguration;
7
4
  }, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
8
- proxyUrl?: string;
9
- authentication?: ReferenceConfiguration["authentication"];
10
- spec?: SpecConfiguration;
11
- servers?: Spec["servers"];
5
+ configuration: ClientConfiguration;
12
6
  }> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
13
7
  export default _default;
14
8
  //# sourceMappingURL=ApiClientModal.vue.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ApiClientModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/ApiClientModal/ApiClientModal.vue"],"names":[],"mappings":"AAiEA,OAAO,KAAK,EACV,sBAAsB,EACtB,IAAI,EACJ,iBAAiB,EAClB,MAAM,sBAAsB,CAAA;;eAQhB,MAAM;qBACA,sBAAsB,CAAC,gBAAgB,CAAC;WAClD,iBAAiB;cACd,IAAI,CAAC,SAAS,CAAC;;eAHd,MAAM;qBACA,sBAAsB,CAAC,gBAAgB,CAAC;WAClD,iBAAiB;cACd,IAAI,CAAC,SAAS,CAAC;;AAmF3B,wBAMG"}
1
+ {"version":3,"file":"ApiClientModal.vue.d.ts","sourceRoot":"","sources":["../../../src/features/ApiClientModal/ApiClientModal.vue"],"names":[],"mappings":"AAuDA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;;mBAQjD,mBAAmB;;mBAAnB,mBAAmB;;AAgFpC,wBAMG"}
@@ -1,49 +1,43 @@
1
- import { defineComponent as v, ref as f, onMounted as m, watch as i, onBeforeUnmount as d, openBlock as _, createElementBlock as S } from "vue";
2
- import { useApiClient as x } from "./useApiClient.js";
3
- import { useServerStore as U } from "../../legacy/stores/useServerStore.js";
4
- import { getUrlFromServerState as h } from "../../legacy/helpers/getUrlFromServerState.js";
5
- const A = /* @__PURE__ */ v({
1
+ import { defineComponent as f, ref as v, onMounted as p, watch as u, onBeforeUnmount as m, openBlock as d, createElementBlock as S } from "vue";
2
+ import { useApiClient as _ } from "./useApiClient.js";
3
+ import { useServerStore as g } from "../../legacy/stores/useServerStore.js";
4
+ import { getUrlFromServerState as x } from "../../legacy/helpers/getUrlFromServerState.js";
5
+ const h = /* @__PURE__ */ f({
6
6
  __name: "ApiClientModal",
7
7
  props: {
8
- proxyUrl: {},
9
- authentication: {},
10
- spec: {},
11
- servers: {}
8
+ configuration: {}
12
9
  },
13
- setup(a) {
14
- const t = a, o = f(null), { server: s, setServer: c } = U(), { client: n, init: p } = x();
15
- return m(async () => {
16
- if (!o.value) return;
17
- (await p({
18
- el: o.value,
19
- spec: t.spec ?? {},
20
- authentication: t.authentication,
21
- proxyUrl: t.proxyUrl,
22
- servers: t.servers
10
+ setup(i) {
11
+ const n = v(null), { server: o, setServer: a } = g(), { client: t, init: c } = _();
12
+ return p(async () => {
13
+ if (!n.value) return;
14
+ (await c({
15
+ el: n.value,
16
+ ...i.configuration
23
17
  })).onUpdateServer((r) => {
24
- if (!s.servers) return;
25
- const l = s.servers.findIndex((u) => u.url === r);
26
- l >= 0 && c({ selectedServer: l });
18
+ if (!o.servers) return;
19
+ const l = o.servers.findIndex((s) => s.url === r);
20
+ l >= 0 && a({ selectedServer: l });
27
21
  });
28
- }), i(s, (e) => {
29
- const r = h(e);
30
- r && n.value && n.value.updateServer(r);
31
- }), i(
32
- () => t.spec,
22
+ }), u(o, (e) => {
23
+ const r = x(e);
24
+ r && t.value && t.value.updateServer(r);
25
+ }), u(
26
+ () => i.configuration,
33
27
  (e) => {
34
28
  var r;
35
- return e && ((r = n.value) == null ? void 0 : r.updateSpec(e));
29
+ return e && ((r = t.value) == null ? void 0 : r.updateConfig(e));
36
30
  },
37
31
  { deep: !0 }
38
- ), d(() => {
32
+ ), m(() => {
39
33
  var e;
40
- return (e = n.value) == null ? void 0 : e.app.unmount();
41
- }), (e, r) => (_(), S("div", {
34
+ return (e = t.value) == null ? void 0 : e.app.unmount();
35
+ }), (e, r) => (d(), S("div", {
42
36
  ref_key: "el",
43
- ref: o
37
+ ref: n
44
38
  }, null, 512));
45
39
  }
46
40
  });
47
41
  export {
48
- A as default
42
+ h as default
49
43
  };
@@ -9,6 +9,7 @@ type InitArgs = {
9
9
  };
10
10
  /** API Client instance */
11
11
  declare const client: import("vue").Ref<{
12
+ updateSpec: (spec: SpecConfiguration) => Promise<void>;
12
13
  updateConfig: (newConfig: import("@scalar/api-client/libs").ClientConfiguration, mergeConfigs?: boolean) => void;
13
14
  updateServer: (serverUrl: string) => void;
14
15
  onUpdateServer: (callback: (url: string) => void) => void;
@@ -17,7 +18,6 @@ declare const client: import("vue").Ref<{
17
18
  propertyKey: P;
18
19
  value: import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").Collection["auth"][string], P>;
19
20
  }) => void;
20
- updateSpec: (spec: SpecConfiguration) => Promise<void>;
21
21
  route: (params: import("@scalar/api-client/libs").OpenClientPayload) => void;
22
22
  open: (payload?: import("@scalar/api-client/libs").OpenClientPayload) => void;
23
23
  mount: (mountingEl?: HTMLElement | null) => void;
@@ -348,6 +348,11 @@ declare const client: import("vue").Ref<{
348
348
  schema?: unknown;
349
349
  content?: unknown;
350
350
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
351
+ example?: unknown;
352
+ examples?: Record<string, {
353
+ value?: unknown;
354
+ summary?: string | undefined;
355
+ }> | undefined;
351
356
  }[] | undefined;
352
357
  requestBody?: any;
353
358
  responses?: Record<string, any> | undefined;
@@ -550,6 +555,11 @@ declare const client: import("vue").Ref<{
550
555
  schema?: unknown;
551
556
  content?: unknown;
552
557
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
558
+ example?: unknown;
559
+ examples?: Record<string, {
560
+ value?: unknown;
561
+ summary?: string | undefined;
562
+ }> | undefined;
553
563
  }[] | undefined;
554
564
  requestBody?: any;
555
565
  responses?: Record<string, any> | undefined;
@@ -1142,6 +1152,7 @@ declare const client: import("vue").Ref<{
1142
1152
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1143
1153
  undo: (uid: string) => void;
1144
1154
  redo: (uid: string) => void;
1155
+ reset: () => void;
1145
1156
  };
1146
1157
  collectionMutators: {
1147
1158
  rawAdd: (item: {
@@ -1764,6 +1775,7 @@ declare const client: import("vue").Ref<{
1764
1775
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1765
1776
  undo: (uid: string) => void;
1766
1777
  redo: (uid: string) => void;
1778
+ reset: () => void;
1767
1779
  };
1768
1780
  environmentMutators: {
1769
1781
  delete: (uid: string) => void;
@@ -1821,6 +1833,7 @@ declare const client: import("vue").Ref<{
1821
1833
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1822
1834
  undo: (uid: string) => void;
1823
1835
  redo: (uid: string) => void;
1836
+ reset: () => void;
1824
1837
  };
1825
1838
  requestMutators: {
1826
1839
  rawAdd: (item: {
@@ -1851,6 +1864,11 @@ declare const client: import("vue").Ref<{
1851
1864
  schema?: unknown;
1852
1865
  content?: unknown;
1853
1866
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1867
+ example?: unknown;
1868
+ examples?: Record<string, {
1869
+ value?: unknown;
1870
+ summary?: string | undefined;
1871
+ }> | undefined;
1854
1872
  }[] | undefined;
1855
1873
  requestBody?: any;
1856
1874
  responses?: Record<string, any> | undefined;
@@ -1883,6 +1901,11 @@ declare const client: import("vue").Ref<{
1883
1901
  schema?: unknown;
1884
1902
  content?: unknown;
1885
1903
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1904
+ example?: unknown;
1905
+ examples?: Record<string, {
1906
+ value?: unknown;
1907
+ summary?: string | undefined;
1908
+ }> | undefined;
1886
1909
  }[] | undefined;
1887
1910
  requestBody?: any;
1888
1911
  responses?: Record<string, any> | undefined;
@@ -1916,11 +1939,16 @@ declare const client: import("vue").Ref<{
1916
1939
  schema?: unknown;
1917
1940
  content?: unknown;
1918
1941
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1942
+ example?: unknown;
1943
+ examples?: Record<string, {
1944
+ value?: unknown;
1945
+ summary?: string | undefined;
1946
+ }> | undefined;
1919
1947
  }[] | undefined;
1920
1948
  requestBody?: any;
1921
1949
  responses?: Record<string, any> | undefined;
1922
1950
  }) => void;
1923
- edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
1951
+ edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
1924
1952
  path: string;
1925
1953
  type: "request";
1926
1954
  uid: string;
@@ -1948,10 +1976,15 @@ declare const client: import("vue").Ref<{
1948
1976
  schema?: unknown;
1949
1977
  content?: unknown;
1950
1978
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
1979
+ example?: unknown;
1980
+ examples?: Record<string, {
1981
+ value?: unknown;
1982
+ summary?: string | undefined;
1983
+ }> | undefined;
1951
1984
  }[] | undefined;
1952
1985
  requestBody?: any;
1953
1986
  responses?: Record<string, any> | undefined;
1954
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
1987
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
1955
1988
  path: string;
1956
1989
  type: "request";
1957
1990
  uid: string;
@@ -1979,6 +2012,11 @@ declare const client: import("vue").Ref<{
1979
2012
  schema?: unknown;
1980
2013
  content?: unknown;
1981
2014
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
2015
+ example?: unknown;
2016
+ examples?: Record<string, {
2017
+ value?: unknown;
2018
+ summary?: string | undefined;
2019
+ }> | undefined;
1982
2020
  }[] | undefined;
1983
2021
  requestBody?: any;
1984
2022
  responses?: Record<string, any> | undefined;
@@ -2010,11 +2048,16 @@ declare const client: import("vue").Ref<{
2010
2048
  schema?: unknown;
2011
2049
  content?: unknown;
2012
2050
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
2051
+ example?: unknown;
2052
+ examples?: Record<string, {
2053
+ value?: unknown;
2054
+ summary?: string | undefined;
2055
+ }> | undefined;
2013
2056
  }[] | undefined;
2014
2057
  requestBody?: any;
2015
2058
  responses?: Record<string, any> | undefined;
2016
2059
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2017
- untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
2060
+ untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
2018
2061
  path: string;
2019
2062
  type: "request";
2020
2063
  uid: string;
@@ -2042,10 +2085,15 @@ declare const client: import("vue").Ref<{
2042
2085
  schema?: unknown;
2043
2086
  content?: unknown;
2044
2087
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
2088
+ example?: unknown;
2089
+ examples?: Record<string, {
2090
+ value?: unknown;
2091
+ summary?: string | undefined;
2092
+ }> | undefined;
2045
2093
  }[] | undefined;
2046
2094
  requestBody?: any;
2047
2095
  responses?: Record<string, any> | undefined;
2048
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
2096
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
2049
2097
  path: string;
2050
2098
  type: "request";
2051
2099
  uid: string;
@@ -2073,6 +2121,11 @@ declare const client: import("vue").Ref<{
2073
2121
  schema?: unknown;
2074
2122
  content?: unknown;
2075
2123
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
2124
+ example?: unknown;
2125
+ examples?: Record<string, {
2126
+ value?: unknown;
2127
+ summary?: string | undefined;
2128
+ }> | undefined;
2076
2129
  }[] | undefined;
2077
2130
  requestBody?: any;
2078
2131
  responses?: Record<string, any> | undefined;
@@ -2104,12 +2157,18 @@ declare const client: import("vue").Ref<{
2104
2157
  schema?: unknown;
2105
2158
  content?: unknown;
2106
2159
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
2160
+ example?: unknown;
2161
+ examples?: Record<string, {
2162
+ value?: unknown;
2163
+ summary?: string | undefined;
2164
+ }> | undefined;
2107
2165
  }[] | undefined;
2108
2166
  requestBody?: any;
2109
2167
  responses?: Record<string, any> | undefined;
2110
2168
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
2111
2169
  undo: (uid: string) => void;
2112
2170
  redo: (uid: string) => void;
2171
+ reset: () => void;
2113
2172
  };
2114
2173
  findRequestParents: (r: import("@scalar/oas-utils/entities/spec").Request) => string[];
2115
2174
  requestExampleMutators: {
@@ -3012,6 +3071,7 @@ declare const client: import("vue").Ref<{
3012
3071
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3013
3072
  undo: (uid: string) => void;
3014
3073
  redo: (uid: string) => void;
3074
+ reset: () => void;
3015
3075
  };
3016
3076
  securitySchemeMutators: {
3017
3077
  rawAdd: (item: {
@@ -3123,7 +3183,7 @@ declare const client: import("vue").Ref<{
3123
3183
  };
3124
3184
  "x-scalar-client-id": string;
3125
3185
  description?: string | undefined;
3126
- };
3186
+ } | null;
3127
3187
  delete: (schemeUid: string) => void;
3128
3188
  set: (item: {
3129
3189
  type: "apiKey";
@@ -3508,6 +3568,7 @@ declare const client: import("vue").Ref<{
3508
3568
  }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
3509
3569
  undo: (uid: string) => void;
3510
3570
  redo: (uid: string) => void;
3571
+ reset: () => void;
3511
3572
  };
3512
3573
  serverMutators: {
3513
3574
  rawAdd: (item: {
@@ -3581,6 +3642,7 @@ declare const client: import("vue").Ref<{
3581
3642
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3582
3643
  undo: (uid: string) => void;
3583
3644
  redo: (uid: string) => void;
3645
+ reset: () => void;
3584
3646
  };
3585
3647
  tagMutators: {
3586
3648
  rawAdd: (item: {
@@ -3708,6 +3770,7 @@ declare const client: import("vue").Ref<{
3708
3770
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3709
3771
  undo: (uid: string) => void;
3710
3772
  redo: (uid: string) => void;
3773
+ reset: () => void;
3711
3774
  };
3712
3775
  workspaceMutators: {
3713
3776
  rawAdd: (item: {
@@ -3880,9 +3943,11 @@ declare const client: import("vue").Ref<{
3880
3943
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
3881
3944
  undo: (uid: string) => void;
3882
3945
  redo: (uid: string) => void;
3946
+ reset: () => void;
3883
3947
  };
3884
3948
  };
3885
3949
  } | null, ApiClient | {
3950
+ updateSpec: (spec: SpecConfiguration) => Promise<void>;
3886
3951
  updateConfig: (newConfig: import("@scalar/api-client/libs").ClientConfiguration, mergeConfigs?: boolean) => void;
3887
3952
  updateServer: (serverUrl: string) => void;
3888
3953
  onUpdateServer: (callback: (url: string) => void) => void;
@@ -3891,7 +3956,6 @@ declare const client: import("vue").Ref<{
3891
3956
  propertyKey: P;
3892
3957
  value: import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").Collection["auth"][string], P>;
3893
3958
  }) => void;
3894
- updateSpec: (spec: SpecConfiguration) => Promise<void>;
3895
3959
  route: (params: import("@scalar/api-client/libs").OpenClientPayload) => void;
3896
3960
  open: (payload?: import("@scalar/api-client/libs").OpenClientPayload) => void;
3897
3961
  mount: (mountingEl?: HTMLElement | null) => void;
@@ -4222,6 +4286,11 @@ declare const client: import("vue").Ref<{
4222
4286
  schema?: unknown;
4223
4287
  content?: unknown;
4224
4288
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
4289
+ example?: unknown;
4290
+ examples?: Record<string, {
4291
+ value?: unknown;
4292
+ summary?: string | undefined;
4293
+ }> | undefined;
4225
4294
  }[] | undefined;
4226
4295
  requestBody?: any;
4227
4296
  responses?: Record<string, any> | undefined;
@@ -4424,6 +4493,11 @@ declare const client: import("vue").Ref<{
4424
4493
  schema?: unknown;
4425
4494
  content?: unknown;
4426
4495
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
4496
+ example?: unknown;
4497
+ examples?: Record<string, {
4498
+ value?: unknown;
4499
+ summary?: string | undefined;
4500
+ }> | undefined;
4427
4501
  }[] | undefined;
4428
4502
  requestBody?: any;
4429
4503
  responses?: Record<string, any> | undefined;
@@ -5016,6 +5090,7 @@ declare const client: import("vue").Ref<{
5016
5090
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5017
5091
  undo: (uid: string) => void;
5018
5092
  redo: (uid: string) => void;
5093
+ reset: () => void;
5019
5094
  };
5020
5095
  collectionMutators: {
5021
5096
  rawAdd: (item: {
@@ -5638,6 +5713,7 @@ declare const client: import("vue").Ref<{
5638
5713
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5639
5714
  undo: (uid: string) => void;
5640
5715
  redo: (uid: string) => void;
5716
+ reset: () => void;
5641
5717
  };
5642
5718
  environmentMutators: {
5643
5719
  delete: (uid: string) => void;
@@ -5695,6 +5771,7 @@ declare const client: import("vue").Ref<{
5695
5771
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5696
5772
  undo: (uid: string) => void;
5697
5773
  redo: (uid: string) => void;
5774
+ reset: () => void;
5698
5775
  };
5699
5776
  requestMutators: {
5700
5777
  rawAdd: (item: {
@@ -5725,6 +5802,11 @@ declare const client: import("vue").Ref<{
5725
5802
  schema?: unknown;
5726
5803
  content?: unknown;
5727
5804
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5805
+ example?: unknown;
5806
+ examples?: Record<string, {
5807
+ value?: unknown;
5808
+ summary?: string | undefined;
5809
+ }> | undefined;
5728
5810
  }[] | undefined;
5729
5811
  requestBody?: any;
5730
5812
  responses?: Record<string, any> | undefined;
@@ -5757,6 +5839,11 @@ declare const client: import("vue").Ref<{
5757
5839
  schema?: unknown;
5758
5840
  content?: unknown;
5759
5841
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5842
+ example?: unknown;
5843
+ examples?: Record<string, {
5844
+ value?: unknown;
5845
+ summary?: string | undefined;
5846
+ }> | undefined;
5760
5847
  }[] | undefined;
5761
5848
  requestBody?: any;
5762
5849
  responses?: Record<string, any> | undefined;
@@ -5790,11 +5877,16 @@ declare const client: import("vue").Ref<{
5790
5877
  schema?: unknown;
5791
5878
  content?: unknown;
5792
5879
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5880
+ example?: unknown;
5881
+ examples?: Record<string, {
5882
+ value?: unknown;
5883
+ summary?: string | undefined;
5884
+ }> | undefined;
5793
5885
  }[] | undefined;
5794
5886
  requestBody?: any;
5795
5887
  responses?: Record<string, any> | undefined;
5796
5888
  }) => void;
5797
- edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
5889
+ edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
5798
5890
  path: string;
5799
5891
  type: "request";
5800
5892
  uid: string;
@@ -5822,10 +5914,15 @@ declare const client: import("vue").Ref<{
5822
5914
  schema?: unknown;
5823
5915
  content?: unknown;
5824
5916
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5917
+ example?: unknown;
5918
+ examples?: Record<string, {
5919
+ value?: unknown;
5920
+ summary?: string | undefined;
5921
+ }> | undefined;
5825
5922
  }[] | undefined;
5826
5923
  requestBody?: any;
5827
5924
  responses?: Record<string, any> | undefined;
5828
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
5925
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
5829
5926
  path: string;
5830
5927
  type: "request";
5831
5928
  uid: string;
@@ -5853,6 +5950,11 @@ declare const client: import("vue").Ref<{
5853
5950
  schema?: unknown;
5854
5951
  content?: unknown;
5855
5952
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5953
+ example?: unknown;
5954
+ examples?: Record<string, {
5955
+ value?: unknown;
5956
+ summary?: string | undefined;
5957
+ }> | undefined;
5856
5958
  }[] | undefined;
5857
5959
  requestBody?: any;
5858
5960
  responses?: Record<string, any> | undefined;
@@ -5884,11 +5986,16 @@ declare const client: import("vue").Ref<{
5884
5986
  schema?: unknown;
5885
5987
  content?: unknown;
5886
5988
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
5989
+ example?: unknown;
5990
+ examples?: Record<string, {
5991
+ value?: unknown;
5992
+ summary?: string | undefined;
5993
+ }> | undefined;
5887
5994
  }[] | undefined;
5888
5995
  requestBody?: any;
5889
5996
  responses?: Record<string, any> | undefined;
5890
5997
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5891
- untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
5998
+ untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
5892
5999
  path: string;
5893
6000
  type: "request";
5894
6001
  uid: string;
@@ -5916,10 +6023,15 @@ declare const client: import("vue").Ref<{
5916
6023
  schema?: unknown;
5917
6024
  content?: unknown;
5918
6025
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
6026
+ example?: unknown;
6027
+ examples?: Record<string, {
6028
+ value?: unknown;
6029
+ summary?: string | undefined;
6030
+ }> | undefined;
5919
6031
  }[] | undefined;
5920
6032
  requestBody?: any;
5921
6033
  responses?: Record<string, any> | undefined;
5922
- }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
6034
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
5923
6035
  path: string;
5924
6036
  type: "request";
5925
6037
  uid: string;
@@ -5947,6 +6059,11 @@ declare const client: import("vue").Ref<{
5947
6059
  schema?: unknown;
5948
6060
  content?: unknown;
5949
6061
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
6062
+ example?: unknown;
6063
+ examples?: Record<string, {
6064
+ value?: unknown;
6065
+ summary?: string | undefined;
6066
+ }> | undefined;
5950
6067
  }[] | undefined;
5951
6068
  requestBody?: any;
5952
6069
  responses?: Record<string, any> | undefined;
@@ -5978,12 +6095,18 @@ declare const client: import("vue").Ref<{
5978
6095
  schema?: unknown;
5979
6096
  content?: unknown;
5980
6097
  style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
6098
+ example?: unknown;
6099
+ examples?: Record<string, {
6100
+ value?: unknown;
6101
+ summary?: string | undefined;
6102
+ }> | undefined;
5981
6103
  }[] | undefined;
5982
6104
  requestBody?: any;
5983
6105
  responses?: Record<string, any> | undefined;
5984
6106
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5985
6107
  undo: (uid: string) => void;
5986
6108
  redo: (uid: string) => void;
6109
+ reset: () => void;
5987
6110
  };
5988
6111
  findRequestParents: (r: import("@scalar/oas-utils/entities/spec").Request) => string[];
5989
6112
  requestExampleMutators: {
@@ -6886,6 +7009,7 @@ declare const client: import("vue").Ref<{
6886
7009
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
6887
7010
  undo: (uid: string) => void;
6888
7011
  redo: (uid: string) => void;
7012
+ reset: () => void;
6889
7013
  };
6890
7014
  securitySchemeMutators: {
6891
7015
  rawAdd: (item: {
@@ -6997,7 +7121,7 @@ declare const client: import("vue").Ref<{
6997
7121
  };
6998
7122
  "x-scalar-client-id": string;
6999
7123
  description?: string | undefined;
7000
- };
7124
+ } | null;
7001
7125
  delete: (schemeUid: string) => void;
7002
7126
  set: (item: {
7003
7127
  type: "apiKey";
@@ -7382,6 +7506,7 @@ declare const client: import("vue").Ref<{
7382
7506
  }[K], R_3> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
7383
7507
  undo: (uid: string) => void;
7384
7508
  redo: (uid: string) => void;
7509
+ reset: () => void;
7385
7510
  };
7386
7511
  serverMutators: {
7387
7512
  rawAdd: (item: {
@@ -7455,6 +7580,7 @@ declare const client: import("vue").Ref<{
7455
7580
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
7456
7581
  undo: (uid: string) => void;
7457
7582
  redo: (uid: string) => void;
7583
+ reset: () => void;
7458
7584
  };
7459
7585
  tagMutators: {
7460
7586
  rawAdd: (item: {
@@ -7582,6 +7708,7 @@ declare const client: import("vue").Ref<{
7582
7708
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
7583
7709
  undo: (uid: string) => void;
7584
7710
  redo: (uid: string) => void;
7711
+ reset: () => void;
7585
7712
  };
7586
7713
  workspaceMutators: {
7587
7714
  rawAdd: (item: {
@@ -7754,6 +7881,7 @@ declare const client: import("vue").Ref<{
7754
7881
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
7755
7882
  undo: (uid: string) => void;
7756
7883
  redo: (uid: string) => void;
7884
+ reset: () => void;
7757
7885
  };
7758
7886
  };
7759
7887
  } | null>;