@scalar/api-reference 1.30.0 → 1.31.1

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 (167) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/dist/browser/standalone.js +6690 -6569
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  5. package/dist/components/ApiReferenceLayout.vue.js +1 -1
  6. package/dist/components/ApiReferenceLayout.vue2.js +164 -181
  7. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
  8. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +2 -2
  9. package/dist/components/Content/ClientLibraries/ClientLibraries.vue2.js +56 -51
  10. package/dist/components/Content/Content.vue.d.ts.map +1 -1
  11. package/dist/components/Content/Content.vue.js +1 -1
  12. package/dist/components/Content/Content.vue2.js +5 -5
  13. package/dist/components/Content/Introduction/Introduction.vue.d.ts +2 -2
  14. package/dist/components/Content/Introduction/Introduction.vue.d.ts.map +1 -1
  15. package/dist/components/Content/Introduction/Introduction.vue.js +2 -2
  16. package/dist/components/Content/Introduction/Introduction.vue2.js +57 -63
  17. package/dist/components/Content/Lazy/Loading.vue.d.ts.map +1 -1
  18. package/dist/components/Content/Lazy/Loading.vue.js +46 -46
  19. package/dist/components/Content/Models/Models.vue.d.ts +2 -2
  20. package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
  21. package/dist/components/Content/Models/Models.vue.js +2 -2
  22. package/dist/components/Content/Models/Models.vue2.js +9 -7
  23. package/dist/components/Content/Models/ModelsAccordion.vue.d.ts +2 -2
  24. package/dist/components/Content/Models/ModelsAccordion.vue.d.ts.map +1 -1
  25. package/dist/components/Content/Models/ModelsAccordion.vue.js +2 -2
  26. package/dist/components/Content/Schema/Schema.preview.d.ts +294 -84
  27. package/dist/components/Content/Schema/Schema.preview.d.ts.map +1 -1
  28. package/dist/components/Content/Schema/Schema.vue.d.ts +21 -4
  29. package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
  30. package/dist/components/Content/Schema/Schema.vue.js +2 -2
  31. package/dist/components/Content/Schema/Schema.vue2.js +158 -131
  32. package/dist/components/Content/Schema/SchemaComposition.vue.d.ts +2 -2
  33. package/dist/components/Content/Schema/SchemaComposition.vue.d.ts.map +1 -1
  34. package/dist/components/Content/Schema/SchemaComposition.vue.js +57 -53
  35. package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts +2 -3
  36. package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts.map +1 -1
  37. package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +29 -29
  38. package/dist/components/Content/Schema/SchemaHeading.vue.d.ts +2 -2
  39. package/dist/components/Content/Schema/SchemaHeading.vue.d.ts.map +1 -1
  40. package/dist/components/Content/Schema/SchemaHeading.vue.js +1 -1
  41. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +12 -3
  42. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  43. package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
  44. package/dist/components/Content/Schema/SchemaProperty.vue2.js +133 -103
  45. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts +3 -2
  46. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
  47. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +2 -2
  48. package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +133 -126
  49. package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts +2 -2
  50. package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts.map +1 -1
  51. package/dist/components/Content/Tag/TagList.vue.d.ts +2 -2
  52. package/dist/components/Content/Tag/TagList.vue.d.ts.map +1 -1
  53. package/dist/components/DocumentSelector/DocumentSelector.vue.js +3 -3
  54. package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -1
  55. package/dist/components/Layouts/ClassicLayout.vue.js +19 -17
  56. package/dist/components/Layouts/Layouts.vue.js +11 -9
  57. package/dist/components/Layouts/ModernLayout.vue2.js +22 -20
  58. package/dist/components/Section/SectionAccordion.vue.d.ts.map +1 -1
  59. package/dist/components/Section/SectionAccordion.vue.js +2 -2
  60. package/dist/components/Section/SectionAccordion.vue2.js +1 -1
  61. package/dist/components/Section/SectionContainerAccordion.vue.d.ts.map +1 -1
  62. package/dist/components/Section/SectionContainerAccordion.vue.js +2 -2
  63. package/dist/components/Section/SectionContainerAccordion.vue2.js +4 -4
  64. package/dist/components/Section/SectionHeader.vue.d.ts.map +1 -1
  65. package/dist/components/Section/SectionHeader.vue.js +2 -2
  66. package/dist/components/Sidebar/Sidebar.vue.d.ts.map +1 -1
  67. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  68. package/dist/components/Sidebar/Sidebar.vue2.js +56 -56
  69. package/dist/components/SingleApiReference.vue.d.ts.map +1 -1
  70. package/dist/components/SingleApiReference.vue.js +27 -33
  71. package/dist/esm.d.ts.map +1 -1
  72. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts +2 -2
  73. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
  74. package/dist/features/ApiClientModal/ApiClientModal.vue.js +49 -50
  75. package/dist/features/ApiClientModal/useApiClient.d.ts +196 -196
  76. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  77. package/dist/features/DocumentSource/hooks/useDocumentFetcher.d.ts +11 -0
  78. package/dist/features/DocumentSource/hooks/useDocumentFetcher.d.ts.map +1 -0
  79. package/dist/features/DocumentSource/hooks/useDocumentFetcher.js +38 -0
  80. package/dist/features/DocumentSource/hooks/useDocumentSource.d.ts +21 -0
  81. package/dist/features/DocumentSource/hooks/useDocumentSource.d.ts.map +1 -0
  82. package/dist/features/DocumentSource/hooks/useDocumentSource.js +94 -0
  83. package/dist/features/DocumentSource/index.d.ts +2 -0
  84. package/dist/features/DocumentSource/index.d.ts.map +1 -0
  85. package/dist/features/DownloadLink/DownloadLink.vue.d.ts +1 -1
  86. package/dist/features/DownloadLink/DownloadLink.vue.d.ts.map +1 -1
  87. package/dist/features/DownloadLink/DownloadLink.vue.js +1 -1
  88. package/dist/features/DownloadLink/DownloadLink.vue2.js +18 -17
  89. package/dist/features/DownloadLink/index.d.ts +1 -0
  90. package/dist/features/DownloadLink/index.d.ts.map +1 -1
  91. package/dist/features/DownloadLink/openapi-version-symbol.d.ts +2 -0
  92. package/dist/features/DownloadLink/openapi-version-symbol.d.ts.map +1 -0
  93. package/dist/features/DownloadLink/openapi-version-symbol.js +4 -0
  94. package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts +2 -0
  95. package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts.map +1 -1
  96. package/dist/features/ExampleRequest/ExampleRequest.vue.js +2 -2
  97. package/dist/features/ExampleRequest/ExampleRequest.vue2.js +178 -127
  98. package/dist/features/Operation/Operation.vue.d.ts +2 -2
  99. package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
  100. package/dist/features/Operation/Operation.vue.js +29 -23
  101. package/dist/features/Operation/components/OperationParameters.vue.d.ts +7 -3
  102. package/dist/features/Operation/components/OperationParameters.vue.d.ts.map +1 -1
  103. package/dist/features/Operation/components/OperationParameters.vue.js +28 -24
  104. package/dist/features/Operation/components/OperationResponses.vue.d.ts +2 -2
  105. package/dist/features/Operation/components/OperationResponses.vue.d.ts.map +1 -1
  106. package/dist/features/Operation/components/ParameterHeaders.vue.d.ts +2 -2
  107. package/dist/features/Operation/components/ParameterHeaders.vue.d.ts.map +1 -1
  108. package/dist/features/Operation/components/ParameterHeaders.vue.js +2 -2
  109. package/dist/features/Operation/components/ParameterList.vue.d.ts +2 -2
  110. package/dist/features/Operation/components/ParameterList.vue.d.ts.map +1 -1
  111. package/dist/features/Operation/components/ParameterList.vue.js +2 -2
  112. package/dist/features/Operation/components/ParameterListItem.vue.d.ts +2 -2
  113. package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
  114. package/dist/features/Operation/components/ParameterListItem.vue.js +3 -3
  115. package/dist/features/Operation/components/ParameterListItem.vue2.js +6 -6
  116. package/dist/features/Operation/components/RequestBody.vue.d.ts +7 -3
  117. package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
  118. package/dist/features/Operation/components/RequestBody.vue.js +2 -2
  119. package/dist/features/Operation/components/RequestBody.vue2.js +41 -36
  120. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +7 -3
  121. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
  122. package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
  123. package/dist/features/Operation/layouts/ClassicLayout.vue2.js +84 -79
  124. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +5 -1
  125. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
  126. package/dist/features/Operation/layouts/ModernLayout.vue.js +2 -2
  127. package/dist/features/Operation/layouts/ModernLayout.vue2.js +66 -57
  128. package/dist/features/Operation/types/schemas.d.ts +2 -2
  129. package/dist/features/Operation/types/schemas.d.ts.map +1 -1
  130. package/dist/features/Search/SearchButton.vue.js +2 -2
  131. package/dist/helpers/local-storage.d.ts +8 -0
  132. package/dist/helpers/local-storage.d.ts.map +1 -0
  133. package/dist/helpers/local-storage.js +6 -0
  134. package/dist/helpers/measure.d.ts +21 -0
  135. package/dist/helpers/measure.d.ts.map +1 -0
  136. package/dist/helpers/measure.js +7 -0
  137. package/dist/helpers/parse.d.ts +3 -5
  138. package/dist/helpers/parse.d.ts.map +1 -1
  139. package/dist/helpers/parse.js +64 -86
  140. package/dist/helpers/scroll-to-id.d.ts.map +1 -1
  141. package/dist/helpers/scroll-to-id.js +18 -4
  142. package/dist/hooks/useDiscriminator.d.ts +53 -0
  143. package/dist/hooks/useDiscriminator.d.ts.map +1 -0
  144. package/dist/hooks/useDiscriminator.js +149 -0
  145. package/dist/hooks/useOperationDiscriminator.d.ts +8 -0
  146. package/dist/hooks/useOperationDiscriminator.d.ts.map +1 -0
  147. package/dist/hooks/useOperationDiscriminator.js +57 -0
  148. package/dist/index.d.ts +0 -1
  149. package/dist/index.d.ts.map +1 -1
  150. package/dist/index.js +33 -35
  151. package/dist/libs/openapi.d.ts +3 -3
  152. package/dist/libs/openapi.d.ts.map +1 -1
  153. package/dist/libs/openapi.js +35 -42
  154. package/dist/standalone/lib/html-api.d.ts.map +1 -1
  155. package/dist/standalone/lib/html-api.js +15 -15
  156. package/dist/stores/useHttpClientStore.d.ts.map +1 -1
  157. package/dist/stores/useHttpClientStore.js +19 -18
  158. package/dist/style.css +1 -1
  159. package/dist/types.d.ts +27 -3
  160. package/dist/types.d.ts.map +1 -1
  161. package/package.json +15 -16
  162. package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts +0 -12
  163. package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts.map +0 -1
  164. package/dist/components/Content/Schema/helpers/schema-discriminator.js +0 -45
  165. package/dist/hooks/useReactiveSpec.d.ts +0 -448
  166. package/dist/hooks/useReactiveSpec.d.ts.map +0 -1
  167. package/dist/hooks/useReactiveSpec.js +0 -59
@@ -1,73 +1,72 @@
1
- import { defineComponent as h, ref as S, onMounted as E, watch as b, onBeforeUnmount as x, createElementBlock as M, openBlock as g } from "vue";
2
- import { useActiveEntities as k, useWorkspace as A } from "@scalar/api-client/store";
3
- import { mutateSecuritySchemeDiff as C } from "@scalar/api-client/views/Request/libs";
4
- import { getServersFromOpenApiDocument as U } from "@scalar/oas-utils/transforms";
5
- import { watchDebounced as B } from "@vueuse/core";
6
- import D from "microdiff";
1
+ import { defineComponent as d, ref as h, onMounted as S, watch as E, onBeforeUnmount as b, createElementBlock as x, openBlock as D } from "vue";
2
+ import { useActiveEntities as M, useWorkspace as g } from "@scalar/api-client/store";
3
+ import { mutateSecuritySchemeDiff as k } from "@scalar/api-client/views/Request/libs";
4
+ import { getServersFromOpenApiDocument as A } from "@scalar/oas-utils/transforms";
5
+ import { watchDebounced as U } from "@vueuse/core";
6
+ import B from "microdiff";
7
7
  import { useNavState as _ } from "../../hooks/useNavState.js";
8
8
  import { useApiClient as y } from "./useApiClient.js";
9
- import { useExampleStore as I } from "../../legacy/stores/useExampleStore.js";
10
- const G = /* @__PURE__ */ h({
9
+ import { useExampleStore as C } from "../../legacy/stores/useExampleStore.js";
10
+ const q = /* @__PURE__ */ d({
11
11
  __name: "ApiClientModal",
12
12
  props: {
13
13
  configuration: {},
14
- parsedSpec: {}
14
+ dereferencedDocument: {}
15
15
  },
16
- setup(i) {
17
- const c = S(null), { client: o, init: v } = y(), { selectedExampleKey: d, operationId: l } = I(), s = k(), r = A(), { isIntersectionEnabled: m } = _();
18
- return E(() => {
19
- c.value && v({
16
+ setup(a) {
17
+ const c = h(null), { client: i, init: p } = y(), { selectedExampleKey: v, operationId: l } = C(), u = M(), r = g(), { isIntersectionEnabled: m } = _();
18
+ return S(() => {
19
+ c.value && p({
20
20
  el: c.value,
21
- configuration: i.configuration,
21
+ configuration: a.configuration,
22
22
  store: r
23
23
  });
24
- }), B(
25
- () => i.configuration,
26
- (e, a) => {
27
- var f;
28
- if (!a || !s.activeCollection.value)
24
+ }), U(
25
+ () => a.configuration,
26
+ (t, o) => {
27
+ if (!o || !u.activeCollection.value)
29
28
  return;
30
- const n = s.activeCollection.value, p = D(a, e);
31
- if (p.some(
32
- (t) => t.path[0] === "url" || t.path[0] === "content" || t.path[1] === "url" || t.path[1] === "content"
33
- ))
34
- (f = o.value) == null || f.updateConfig(e);
35
- else if (p.forEach((t) => {
36
- t.path[0] === "authentication" && C(t, s, r);
37
- }), e.servers || a.servers) {
38
- n.servers.forEach((u) => {
39
- r.serverMutators.delete(u, n.uid);
40
- });
41
- const t = U(
42
- e.servers ?? i.parsedSpec.servers,
43
- {
44
- baseServerURL: e.baseServerURL
45
- }
46
- );
47
- t.forEach((u) => {
48
- r.serverMutators.add(u, n.uid);
49
- }), t.length && r.collectionMutators.edit(
50
- n.uid,
51
- "selectedServerUid",
52
- t[t.length - 1].uid
53
- );
29
+ const n = u.activeCollection.value, f = B(o, t);
30
+ if (!f.some(
31
+ (e) => e.path[0] === "url" || e.path[0] === "content" || e.path[1] === "url" || e.path[1] === "content"
32
+ )) {
33
+ if (f.forEach((e) => {
34
+ e.path[0] === "authentication" && k(e, u, r);
35
+ }), t.servers || o.servers) {
36
+ n.servers.forEach((s) => {
37
+ r.serverMutators.delete(s, n.uid);
38
+ });
39
+ const e = A(
40
+ t.servers ?? a.dereferencedDocument.servers,
41
+ {
42
+ baseServerURL: t.baseServerURL
43
+ }
44
+ );
45
+ e.forEach((s) => {
46
+ r.serverMutators.add(s, n.uid);
47
+ }), e.length && r.collectionMutators.edit(
48
+ n.uid,
49
+ "selectedServerUid",
50
+ e[e.length - 1].uid
51
+ );
52
+ }
54
53
  }
55
54
  m.value = !1, setTimeout(() => {
56
55
  m.value = !0;
57
56
  }, 1e3);
58
57
  },
59
58
  { deep: !0, debounce: 300 }
60
- ), b(d, (e) => {
61
- o.value && e && l.value && o.value.updateExample(e, l.value);
62
- }), x(() => {
63
- var e;
64
- return (e = o.value) == null ? void 0 : e.app.unmount();
65
- }), (e, a) => (g(), M("div", {
59
+ ), E(v, (t) => {
60
+ i.value && t && l.value && i.value.updateExample(t, l.value);
61
+ }), b(() => {
62
+ var t;
63
+ return (t = i.value) == null ? void 0 : t.app.unmount();
64
+ }), (t, o) => (D(), x("div", {
66
65
  ref_key: "el",
67
66
  ref: c
68
67
  }, null, 512));
69
68
  }
70
69
  });
71
70
  export {
72
- G as default
71
+ q as default
73
72
  };
@@ -36,88 +36,6 @@ declare const client: import("vue").Ref<{
36
36
  enum?: string[] | undefined;
37
37
  }> | undefined;
38
38
  }>;
39
- securitySchemes: Record<string, {
40
- type: "apiKey";
41
- value: string;
42
- name: string;
43
- uid: string & import("zod").BRAND<"securityScheme">;
44
- nameKey: string;
45
- in: "cookie" | "query" | "header";
46
- description?: string | undefined;
47
- } | {
48
- type: "http";
49
- uid: string & import("zod").BRAND<"securityScheme">;
50
- nameKey: string;
51
- scheme: "basic" | "bearer";
52
- bearerFormat: string;
53
- username: string;
54
- password: string;
55
- token: string;
56
- description?: string | undefined;
57
- } | {
58
- type: "openIdConnect";
59
- uid: string & import("zod").BRAND<"securityScheme">;
60
- nameKey: string;
61
- openIdConnectUrl: string;
62
- description?: string | undefined;
63
- } | {
64
- type: "oauth2";
65
- uid: string & import("zod").BRAND<"securityScheme">;
66
- nameKey: string;
67
- flows: {
68
- password?: {
69
- type: "password";
70
- username: string;
71
- password: string;
72
- token: string;
73
- refreshUrl: string;
74
- scopes: Record<string, string>;
75
- selectedScopes: string[];
76
- "x-scalar-client-id": string;
77
- tokenUrl: string;
78
- clientSecret: string;
79
- "x-scalar-security-query"?: Record<string, string> | undefined;
80
- } | undefined;
81
- implicit?: {
82
- type: "implicit";
83
- token: string;
84
- refreshUrl: string;
85
- scopes: Record<string, string>;
86
- selectedScopes: string[];
87
- "x-scalar-client-id": string;
88
- authorizationUrl: string;
89
- "x-scalar-redirect-uri": string;
90
- "x-scalar-security-query"?: Record<string, string> | undefined;
91
- } | undefined;
92
- clientCredentials?: {
93
- type: "clientCredentials";
94
- token: string;
95
- refreshUrl: string;
96
- scopes: Record<string, string>;
97
- selectedScopes: string[];
98
- "x-scalar-client-id": string;
99
- tokenUrl: string;
100
- clientSecret: string;
101
- "x-scalar-security-query"?: Record<string, string> | undefined;
102
- } | undefined;
103
- authorizationCode?: {
104
- type: "authorizationCode";
105
- token: string;
106
- refreshUrl: string;
107
- scopes: Record<string, string>;
108
- selectedScopes: string[];
109
- "x-scalar-client-id": string;
110
- authorizationUrl: string;
111
- "x-scalar-redirect-uri": string;
112
- tokenUrl: string;
113
- clientSecret: string;
114
- "x-usePkce": "SHA-256" | "plain" | "no";
115
- "x-scalar-security-query"?: Record<string, string> | undefined;
116
- } | undefined;
117
- };
118
- description?: string | undefined;
119
- "x-default-scopes"?: string | string[] | undefined;
120
- }>;
121
39
  tags: Record<string, {
122
40
  uid: string & import("zod").BRAND<"tag">;
123
41
  name: string;
@@ -235,6 +153,88 @@ declare const client: import("vue").Ref<{
235
153
  redo: (uid: string & import("zod").BRAND<"server">) => void;
236
154
  reset: () => void;
237
155
  };
156
+ securitySchemes: Record<string, {
157
+ type: "apiKey";
158
+ value: string;
159
+ name: string;
160
+ uid: string & import("zod").BRAND<"securityScheme">;
161
+ nameKey: string;
162
+ in: "cookie" | "query" | "header";
163
+ description?: string | undefined;
164
+ } | {
165
+ type: "http";
166
+ uid: string & import("zod").BRAND<"securityScheme">;
167
+ nameKey: string;
168
+ scheme: "basic" | "bearer";
169
+ bearerFormat: string;
170
+ username: string;
171
+ password: string;
172
+ token: string;
173
+ description?: string | undefined;
174
+ } | {
175
+ type: "openIdConnect";
176
+ uid: string & import("zod").BRAND<"securityScheme">;
177
+ nameKey: string;
178
+ openIdConnectUrl: string;
179
+ description?: string | undefined;
180
+ } | {
181
+ type: "oauth2";
182
+ uid: string & import("zod").BRAND<"securityScheme">;
183
+ nameKey: string;
184
+ flows: {
185
+ password?: {
186
+ type: "password";
187
+ username: string;
188
+ password: string;
189
+ token: string;
190
+ refreshUrl: string;
191
+ scopes: Record<string, string>;
192
+ selectedScopes: string[];
193
+ "x-scalar-client-id": string;
194
+ tokenUrl: string;
195
+ clientSecret: string;
196
+ "x-scalar-security-query"?: Record<string, string> | undefined;
197
+ } | undefined;
198
+ implicit?: {
199
+ type: "implicit";
200
+ token: string;
201
+ refreshUrl: string;
202
+ scopes: Record<string, string>;
203
+ selectedScopes: string[];
204
+ "x-scalar-client-id": string;
205
+ authorizationUrl: string;
206
+ "x-scalar-redirect-uri": string;
207
+ "x-scalar-security-query"?: Record<string, string> | undefined;
208
+ } | undefined;
209
+ clientCredentials?: {
210
+ type: "clientCredentials";
211
+ token: string;
212
+ refreshUrl: string;
213
+ scopes: Record<string, string>;
214
+ selectedScopes: string[];
215
+ "x-scalar-client-id": string;
216
+ tokenUrl: string;
217
+ clientSecret: string;
218
+ "x-scalar-security-query"?: Record<string, string> | undefined;
219
+ } | undefined;
220
+ authorizationCode?: {
221
+ type: "authorizationCode";
222
+ token: string;
223
+ refreshUrl: string;
224
+ scopes: Record<string, string>;
225
+ selectedScopes: string[];
226
+ "x-scalar-client-id": string;
227
+ authorizationUrl: string;
228
+ "x-scalar-redirect-uri": string;
229
+ tokenUrl: string;
230
+ clientSecret: string;
231
+ "x-usePkce": "SHA-256" | "plain" | "no";
232
+ "x-scalar-security-query"?: Record<string, string> | undefined;
233
+ } | undefined;
234
+ };
235
+ description?: string | undefined;
236
+ "x-default-scopes"?: string | string[] | undefined;
237
+ }>;
238
238
  requests: Record<string, {
239
239
  uid: string & import("zod").BRAND<"operation">;
240
240
  path: string;
@@ -1410,13 +1410,10 @@ declare const client: import("vue").Ref<{
1410
1410
  }>;
1411
1411
  setSidebarWidth: (width: string) => void;
1412
1412
  integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
1413
- importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
1413
+ importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
1414
1414
  uid?: string | undefined;
1415
1415
  type?: "collection" | undefined;
1416
- externalDocs?: {
1417
- url: string;
1418
- description?: unknown;
1419
- } | undefined;
1416
+ externalDocs?: unknown;
1420
1417
  children?: string[] | undefined;
1421
1418
  openapi?: string | undefined;
1422
1419
  jsonSchemaDialect?: string | undefined;
@@ -1450,9 +1447,12 @@ declare const client: import("vue").Ref<{
1450
1447
  useCollectionSecurity?: boolean | undefined;
1451
1448
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
1452
1449
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
1450
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1453
1451
  useCollectionSecurity?: boolean;
1454
1452
  shouldLoad?: boolean;
1455
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
1453
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
1454
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1455
+ }) => Promise<{
1456
1456
  error: false;
1457
1457
  collection: import("@scalar/oas-utils/entities/spec").Collection;
1458
1458
  requests: import("@scalar/oas-utils/entities/spec").Request[];
@@ -1465,10 +1465,7 @@ declare const client: import("vue").Ref<{
1465
1465
  importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
1466
1466
  uid?: string | undefined;
1467
1467
  type?: "collection" | undefined;
1468
- externalDocs?: {
1469
- url: string;
1470
- description?: unknown;
1471
- } | undefined;
1468
+ externalDocs?: unknown;
1472
1469
  children?: string[] | undefined;
1473
1470
  openapi?: string | undefined;
1474
1471
  jsonSchemaDialect?: string | undefined;
@@ -1502,15 +1499,15 @@ declare const client: import("vue").Ref<{
1502
1499
  useCollectionSecurity?: boolean | undefined;
1503
1500
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
1504
1501
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
1502
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1505
1503
  useCollectionSecurity?: boolean;
1506
1504
  shouldLoad?: boolean;
1507
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
1505
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
1506
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1507
+ }, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
1508
1508
  uid?: string | undefined;
1509
1509
  type?: "collection" | undefined;
1510
- externalDocs?: {
1511
- url: string;
1512
- description?: unknown;
1513
- } | undefined;
1510
+ externalDocs?: unknown;
1514
1511
  children?: string[] | undefined;
1515
1512
  openapi?: string | undefined;
1516
1513
  jsonSchemaDialect?: string | undefined;
@@ -1544,9 +1541,12 @@ declare const client: import("vue").Ref<{
1544
1541
  useCollectionSecurity?: boolean | undefined;
1545
1542
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
1546
1543
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
1544
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1547
1545
  useCollectionSecurity?: boolean;
1548
1546
  shouldLoad?: boolean;
1549
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
1547
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
1548
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
1549
+ }) => Promise<{
1550
1550
  error: false;
1551
1551
  collection: import("@scalar/oas-utils/entities/spec").Collection;
1552
1552
  requests: import("@scalar/oas-utils/entities/spec").Request[];
@@ -3883,88 +3883,6 @@ declare const client: import("vue").Ref<{
3883
3883
  enum?: string[] | undefined;
3884
3884
  }> | undefined;
3885
3885
  }>;
3886
- securitySchemes: Record<string, {
3887
- type: "apiKey";
3888
- value: string;
3889
- name: string;
3890
- uid: string & import("zod").BRAND<"securityScheme">;
3891
- nameKey: string;
3892
- in: "cookie" | "query" | "header";
3893
- description?: string | undefined;
3894
- } | {
3895
- type: "http";
3896
- uid: string & import("zod").BRAND<"securityScheme">;
3897
- nameKey: string;
3898
- scheme: "basic" | "bearer";
3899
- bearerFormat: string;
3900
- username: string;
3901
- password: string;
3902
- token: string;
3903
- description?: string | undefined;
3904
- } | {
3905
- type: "openIdConnect";
3906
- uid: string & import("zod").BRAND<"securityScheme">;
3907
- nameKey: string;
3908
- openIdConnectUrl: string;
3909
- description?: string | undefined;
3910
- } | {
3911
- type: "oauth2";
3912
- uid: string & import("zod").BRAND<"securityScheme">;
3913
- nameKey: string;
3914
- flows: {
3915
- password?: {
3916
- type: "password";
3917
- username: string;
3918
- password: string;
3919
- token: string;
3920
- refreshUrl: string;
3921
- scopes: Record<string, string>;
3922
- selectedScopes: string[];
3923
- "x-scalar-client-id": string;
3924
- tokenUrl: string;
3925
- clientSecret: string;
3926
- "x-scalar-security-query"?: Record<string, string> | undefined;
3927
- } | undefined;
3928
- implicit?: {
3929
- type: "implicit";
3930
- token: string;
3931
- refreshUrl: string;
3932
- scopes: Record<string, string>;
3933
- selectedScopes: string[];
3934
- "x-scalar-client-id": string;
3935
- authorizationUrl: string;
3936
- "x-scalar-redirect-uri": string;
3937
- "x-scalar-security-query"?: Record<string, string> | undefined;
3938
- } | undefined;
3939
- clientCredentials?: {
3940
- type: "clientCredentials";
3941
- token: string;
3942
- refreshUrl: string;
3943
- scopes: Record<string, string>;
3944
- selectedScopes: string[];
3945
- "x-scalar-client-id": string;
3946
- tokenUrl: string;
3947
- clientSecret: string;
3948
- "x-scalar-security-query"?: Record<string, string> | undefined;
3949
- } | undefined;
3950
- authorizationCode?: {
3951
- type: "authorizationCode";
3952
- token: string;
3953
- refreshUrl: string;
3954
- scopes: Record<string, string>;
3955
- selectedScopes: string[];
3956
- "x-scalar-client-id": string;
3957
- authorizationUrl: string;
3958
- "x-scalar-redirect-uri": string;
3959
- tokenUrl: string;
3960
- clientSecret: string;
3961
- "x-usePkce": "SHA-256" | "plain" | "no";
3962
- "x-scalar-security-query"?: Record<string, string> | undefined;
3963
- } | undefined;
3964
- };
3965
- description?: string | undefined;
3966
- "x-default-scopes"?: string | string[] | undefined;
3967
- }>;
3968
3886
  tags: Record<string, {
3969
3887
  uid: string & import("zod").BRAND<"tag">;
3970
3888
  name: string;
@@ -4082,6 +4000,88 @@ declare const client: import("vue").Ref<{
4082
4000
  redo: (uid: string & import("zod").BRAND<"server">) => void;
4083
4001
  reset: () => void;
4084
4002
  };
4003
+ securitySchemes: Record<string, {
4004
+ type: "apiKey";
4005
+ value: string;
4006
+ name: string;
4007
+ uid: string & import("zod").BRAND<"securityScheme">;
4008
+ nameKey: string;
4009
+ in: "cookie" | "query" | "header";
4010
+ description?: string | undefined;
4011
+ } | {
4012
+ type: "http";
4013
+ uid: string & import("zod").BRAND<"securityScheme">;
4014
+ nameKey: string;
4015
+ scheme: "basic" | "bearer";
4016
+ bearerFormat: string;
4017
+ username: string;
4018
+ password: string;
4019
+ token: string;
4020
+ description?: string | undefined;
4021
+ } | {
4022
+ type: "openIdConnect";
4023
+ uid: string & import("zod").BRAND<"securityScheme">;
4024
+ nameKey: string;
4025
+ openIdConnectUrl: string;
4026
+ description?: string | undefined;
4027
+ } | {
4028
+ type: "oauth2";
4029
+ uid: string & import("zod").BRAND<"securityScheme">;
4030
+ nameKey: string;
4031
+ flows: {
4032
+ password?: {
4033
+ type: "password";
4034
+ username: string;
4035
+ password: string;
4036
+ token: string;
4037
+ refreshUrl: string;
4038
+ scopes: Record<string, string>;
4039
+ selectedScopes: string[];
4040
+ "x-scalar-client-id": string;
4041
+ tokenUrl: string;
4042
+ clientSecret: string;
4043
+ "x-scalar-security-query"?: Record<string, string> | undefined;
4044
+ } | undefined;
4045
+ implicit?: {
4046
+ type: "implicit";
4047
+ token: string;
4048
+ refreshUrl: string;
4049
+ scopes: Record<string, string>;
4050
+ selectedScopes: string[];
4051
+ "x-scalar-client-id": string;
4052
+ authorizationUrl: string;
4053
+ "x-scalar-redirect-uri": string;
4054
+ "x-scalar-security-query"?: Record<string, string> | undefined;
4055
+ } | undefined;
4056
+ clientCredentials?: {
4057
+ type: "clientCredentials";
4058
+ token: string;
4059
+ refreshUrl: string;
4060
+ scopes: Record<string, string>;
4061
+ selectedScopes: string[];
4062
+ "x-scalar-client-id": string;
4063
+ tokenUrl: string;
4064
+ clientSecret: string;
4065
+ "x-scalar-security-query"?: Record<string, string> | undefined;
4066
+ } | undefined;
4067
+ authorizationCode?: {
4068
+ type: "authorizationCode";
4069
+ token: string;
4070
+ refreshUrl: string;
4071
+ scopes: Record<string, string>;
4072
+ selectedScopes: string[];
4073
+ "x-scalar-client-id": string;
4074
+ authorizationUrl: string;
4075
+ "x-scalar-redirect-uri": string;
4076
+ tokenUrl: string;
4077
+ clientSecret: string;
4078
+ "x-usePkce": "SHA-256" | "plain" | "no";
4079
+ "x-scalar-security-query"?: Record<string, string> | undefined;
4080
+ } | undefined;
4081
+ };
4082
+ description?: string | undefined;
4083
+ "x-default-scopes"?: string | string[] | undefined;
4084
+ }>;
4085
4085
  requests: Record<string, {
4086
4086
  uid: string & import("zod").BRAND<"operation">;
4087
4087
  path: string;
@@ -5257,13 +5257,10 @@ declare const client: import("vue").Ref<{
5257
5257
  }>;
5258
5258
  setSidebarWidth: (width: string) => void;
5259
5259
  integration: "elysiajs" | "fastify" | "go" | "adonisjs" | "docusaurus" | "dotnet" | "express" | "fastapi" | "hono" | "html" | "laravel" | "litestar" | "nestjs" | "nextjs" | "nitro" | "nuxt" | "platformatic" | "react" | "rust" | "svelte" | "vue" | null | undefined;
5260
- importSpecFile: (_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
5260
+ importSpecFile: (_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
5261
5261
  uid?: string | undefined;
5262
5262
  type?: "collection" | undefined;
5263
- externalDocs?: {
5264
- url: string;
5265
- description?: unknown;
5266
- } | undefined;
5263
+ externalDocs?: unknown;
5267
5264
  children?: string[] | undefined;
5268
5265
  openapi?: string | undefined;
5269
5266
  jsonSchemaDialect?: string | undefined;
@@ -5297,9 +5294,12 @@ declare const client: import("vue").Ref<{
5297
5294
  useCollectionSecurity?: boolean | undefined;
5298
5295
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
5299
5296
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
5297
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5300
5298
  useCollectionSecurity?: boolean;
5301
5299
  shouldLoad?: boolean;
5302
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
5300
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
5301
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5302
+ }) => Promise<{
5303
5303
  error: false;
5304
5304
  collection: import("@scalar/oas-utils/entities/spec").Collection;
5305
5305
  requests: import("@scalar/oas-utils/entities/spec").Request[];
@@ -5312,10 +5312,7 @@ declare const client: import("vue").Ref<{
5312
5312
  importSpecFromUrl: (url: string, workspaceUid: string, { proxyUrl, ...options }?: Omit<Pick<{
5313
5313
  uid?: string | undefined;
5314
5314
  type?: "collection" | undefined;
5315
- externalDocs?: {
5316
- url: string;
5317
- description?: unknown;
5318
- } | undefined;
5315
+ externalDocs?: unknown;
5319
5316
  children?: string[] | undefined;
5320
5317
  openapi?: string | undefined;
5321
5318
  jsonSchemaDialect?: string | undefined;
@@ -5349,15 +5346,15 @@ declare const client: import("vue").Ref<{
5349
5346
  useCollectionSecurity?: boolean | undefined;
5350
5347
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
5351
5348
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
5349
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5352
5350
  useCollectionSecurity?: boolean;
5353
5351
  shouldLoad?: boolean;
5354
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any>, workspaceUid: string, options?: Pick<{
5352
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
5353
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5354
+ }, "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "proxyUrl">) => Promise<import("@scalar/api-client/libs").ErrorResponse<Awaited<ReturnType<(_spec: string | Record<string, any> | undefined, workspaceUid: string, options?: Pick<{
5355
5355
  uid?: string | undefined;
5356
5356
  type?: "collection" | undefined;
5357
- externalDocs?: {
5358
- url: string;
5359
- description?: unknown;
5360
- } | undefined;
5357
+ externalDocs?: unknown;
5361
5358
  children?: string[] | undefined;
5362
5359
  openapi?: string | undefined;
5363
5360
  jsonSchemaDialect?: string | undefined;
@@ -5391,9 +5388,12 @@ declare const client: import("vue").Ref<{
5391
5388
  useCollectionSecurity?: boolean | undefined;
5392
5389
  watchModeStatus?: "IDLE" | "WATCHING" | "ERROR" | undefined;
5393
5390
  }, "watchMode" | "documentUrl"> & Pick<import("@scalar/types").ApiReferenceConfiguration, "slug" | "authentication" | "baseServerURL" | "servers"> & {
5391
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5394
5392
  useCollectionSecurity?: boolean;
5395
5393
  shouldLoad?: boolean;
5396
- } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers">) => Promise<{
5394
+ } & Pick<import("@scalar/types").ApiReferenceConfiguration, "servers"> & {
5395
+ dereferencedDocument?: import("@scalar/openapi-types").OpenAPIV3_1.Document;
5396
+ }) => Promise<{
5397
5397
  error: false;
5398
5398
  collection: import("@scalar/oas-utils/entities/spec").Collection;
5399
5399
  requests: import("@scalar/oas-utils/entities/spec").Request[];