@scalar/workspace-store 0.41.2 → 0.43.0

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 (261) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/dist/client.d.ts.map +1 -1
  3. package/dist/client.js +5 -1
  4. package/dist/events/definitions/operation.d.ts +6 -1
  5. package/dist/events/definitions/operation.d.ts.map +1 -1
  6. package/dist/events/definitions/server.d.ts +5 -1
  7. package/dist/events/definitions/server.d.ts.map +1 -1
  8. package/dist/events/definitions/ui.d.ts +5 -3
  9. package/dist/events/definitions/ui.d.ts.map +1 -1
  10. package/dist/helpers/get-resolved-ref-deep.d.ts +27 -0
  11. package/dist/helpers/get-resolved-ref-deep.d.ts.map +1 -0
  12. package/dist/helpers/get-resolved-ref-deep.js +49 -0
  13. package/dist/mutators/operation/operation.d.ts +1 -1
  14. package/dist/mutators/operation/operation.d.ts.map +1 -1
  15. package/dist/mutators/operation/operation.js +4 -4
  16. package/dist/mutators/server.d.ts +1 -1
  17. package/dist/mutators/server.d.ts.map +1 -1
  18. package/dist/mutators/server.js +5 -2
  19. package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
  20. package/dist/navigation/helpers/traverse-description.js +19 -21
  21. package/dist/navigation/helpers/utils.js +2 -2
  22. package/dist/request-example/builder/body/build-request-body.d.ts +42 -0
  23. package/dist/request-example/builder/body/build-request-body.d.ts.map +1 -0
  24. package/dist/request-example/builder/body/build-request-body.js +134 -0
  25. package/dist/request-example/builder/body/get-request-body-example.d.ts +6 -0
  26. package/dist/request-example/builder/body/get-request-body-example.d.ts.map +1 -0
  27. package/dist/request-example/builder/body/get-request-body-example.js +31 -0
  28. package/dist/request-example/builder/body/get-selected-body-content-type.d.ts +10 -0
  29. package/dist/request-example/builder/body/get-selected-body-content-type.d.ts.map +1 -0
  30. package/dist/request-example/builder/body/get-selected-body-content-type.js +10 -0
  31. package/dist/request-example/builder/build-request.d.ts +9 -0
  32. package/dist/request-example/builder/build-request.d.ts.map +1 -0
  33. package/dist/request-example/builder/build-request.js +135 -0
  34. package/dist/request-example/builder/header/build-request-cookie-header.d.ts +25 -0
  35. package/dist/request-example/builder/header/build-request-cookie-header.d.ts.map +1 -0
  36. package/dist/request-example/builder/header/build-request-cookie-header.js +39 -0
  37. package/dist/request-example/builder/header/build-request-parameters.d.ts +24 -0
  38. package/dist/request-example/builder/header/build-request-parameters.d.ts.map +1 -0
  39. package/dist/request-example/builder/header/build-request-parameters.js +215 -0
  40. package/dist/request-example/builder/header/de-serialize-parameter.d.ts +4 -0
  41. package/dist/request-example/builder/header/de-serialize-parameter.d.ts.map +1 -0
  42. package/dist/request-example/builder/header/de-serialize-parameter.js +49 -0
  43. package/dist/request-example/builder/header/filter-global-cookies.d.ts +14 -0
  44. package/dist/request-example/builder/header/filter-global-cookies.d.ts.map +1 -0
  45. package/dist/request-example/builder/header/filter-global-cookies.js +26 -0
  46. package/dist/request-example/builder/header/is-param-disabled.d.ts +13 -0
  47. package/dist/request-example/builder/header/is-param-disabled.d.ts.map +1 -0
  48. package/dist/request-example/builder/header/is-param-disabled.js +19 -0
  49. package/dist/request-example/builder/header/matches-domain.d.ts +9 -0
  50. package/dist/request-example/builder/header/matches-domain.d.ts.map +1 -0
  51. package/dist/request-example/builder/header/matches-domain.js +27 -0
  52. package/dist/request-example/builder/header/serialize-parameter.d.ts +96 -0
  53. package/dist/request-example/builder/header/serialize-parameter.d.ts.map +1 -0
  54. package/dist/request-example/builder/header/serialize-parameter.js +222 -0
  55. package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.d.ts +6 -0
  56. package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.d.ts.map +1 -0
  57. package/dist/request-example/builder/helpers/apply-allow-reserved-to-url.js +69 -0
  58. package/dist/request-example/builder/helpers/get-environment-variables.d.ts +9 -0
  59. package/dist/request-example/builder/helpers/get-environment-variables.d.ts.map +1 -0
  60. package/dist/request-example/builder/helpers/get-environment-variables.js +12 -0
  61. package/dist/request-example/builder/helpers/get-example-from-schema.d.ts +40 -0
  62. package/dist/request-example/builder/helpers/get-example-from-schema.d.ts.map +1 -0
  63. package/dist/request-example/builder/helpers/get-example-from-schema.js +568 -0
  64. package/dist/request-example/builder/helpers/get-example.d.ts +10 -0
  65. package/dist/request-example/builder/helpers/get-example.d.ts.map +1 -0
  66. package/dist/request-example/builder/helpers/get-example.js +66 -0
  67. package/dist/request-example/builder/helpers/get-resolved-url.d.ts +20 -0
  68. package/dist/request-example/builder/helpers/get-resolved-url.d.ts.map +1 -0
  69. package/dist/request-example/builder/helpers/get-resolved-url.js +19 -0
  70. package/dist/request-example/builder/helpers/get-server-variables.d.ts +10 -0
  71. package/dist/request-example/builder/helpers/get-server-variables.d.ts.map +1 -0
  72. package/dist/request-example/builder/helpers/get-server-variables.js +19 -0
  73. package/dist/request-example/builder/index.d.ts +15 -0
  74. package/dist/request-example/builder/index.d.ts.map +1 -0
  75. package/dist/request-example/builder/index.js +13 -0
  76. package/dist/request-example/builder/request-factory.d.ts +60 -0
  77. package/dist/request-example/builder/request-factory.d.ts.map +1 -0
  78. package/dist/request-example/builder/request-factory.js +78 -0
  79. package/dist/request-example/builder/security/build-request-security.d.ts +24 -0
  80. package/dist/request-example/builder/security/build-request-security.d.ts.map +1 -0
  81. package/dist/request-example/builder/security/build-request-security.js +79 -0
  82. package/dist/request-example/builder/security/secret-types.d.ts +25 -0
  83. package/dist/request-example/builder/security/secret-types.d.ts.map +1 -0
  84. package/dist/request-example/builder/security/secret-types.js +1 -0
  85. package/dist/request-example/context/environment.d.ts +21 -0
  86. package/dist/request-example/context/environment.d.ts.map +1 -0
  87. package/dist/request-example/context/environment.js +49 -0
  88. package/dist/request-example/context/get-request-example-context.d.ts +57 -0
  89. package/dist/request-example/context/get-request-example-context.d.ts.map +1 -0
  90. package/dist/request-example/context/get-request-example-context.js +115 -0
  91. package/dist/request-example/context/headers.d.ts +33 -0
  92. package/dist/request-example/context/headers.d.ts.map +1 -0
  93. package/dist/request-example/context/headers.js +54 -0
  94. package/dist/request-example/context/helpers/combine-params.d.ts +4 -0
  95. package/dist/request-example/context/helpers/combine-params.d.ts.map +1 -0
  96. package/dist/request-example/context/helpers/combine-params.js +21 -0
  97. package/dist/request-example/context/index.d.ts +12 -0
  98. package/dist/request-example/context/index.d.ts.map +1 -0
  99. package/dist/request-example/context/index.js +10 -0
  100. package/dist/request-example/context/proxy.d.ts +18 -0
  101. package/dist/request-example/context/proxy.d.ts.map +1 -0
  102. package/dist/request-example/context/proxy.js +26 -0
  103. package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts +10 -0
  104. package/dist/request-example/context/security/extract-security-scheme-secrets.d.ts.map +1 -0
  105. package/dist/request-example/context/security/extract-security-scheme-secrets.js +167 -0
  106. package/dist/request-example/context/security/get-security-requirements.d.ts +12 -0
  107. package/dist/request-example/context/security/get-security-requirements.d.ts.map +1 -0
  108. package/dist/request-example/context/security/get-security-requirements.js +16 -0
  109. package/dist/request-example/context/security/get-security-schemes.d.ts +9 -0
  110. package/dist/request-example/context/security/get-security-schemes.d.ts.map +1 -0
  111. package/dist/request-example/context/security/get-security-schemes.js +13 -0
  112. package/dist/request-example/context/security/get-selected-security.d.ts +15 -0
  113. package/dist/request-example/context/security/get-selected-security.d.ts.map +1 -0
  114. package/dist/request-example/context/security/get-selected-security.js +49 -0
  115. package/dist/request-example/context/security/is-auth-optional.d.ts +4 -0
  116. package/dist/request-example/context/security/is-auth-optional.d.ts.map +1 -0
  117. package/dist/request-example/context/security/is-auth-optional.js +6 -0
  118. package/dist/request-example/context/security/merge-security.d.ts +9 -0
  119. package/dist/request-example/context/security/merge-security.d.ts.map +1 -0
  120. package/dist/request-example/context/security/merge-security.js +29 -0
  121. package/dist/request-example/context/servers.d.ts +26 -0
  122. package/dist/request-example/context/servers.d.ts.map +1 -0
  123. package/dist/request-example/context/servers.js +89 -0
  124. package/dist/request-example/index.d.ts +5 -0
  125. package/dist/request-example/index.d.ts.map +1 -0
  126. package/dist/request-example/index.js +2 -0
  127. package/dist/request-example/types.d.ts +14 -0
  128. package/dist/request-example/types.d.ts.map +1 -0
  129. package/dist/request-example/types.js +1 -0
  130. package/dist/schemas/extensions/document/x-internal.d.ts +3 -0
  131. package/dist/schemas/extensions/document/x-internal.d.ts.map +1 -1
  132. package/dist/schemas/extensions/document/x-internal.js +7 -0
  133. package/dist/schemas/extensions/document/x-scalar-environments.d.ts +31 -0
  134. package/dist/schemas/extensions/document/x-scalar-environments.d.ts.map +1 -1
  135. package/dist/schemas/extensions/document/x-scalar-environments.js +25 -0
  136. package/dist/schemas/extensions/document/x-scalar-icon.d.ts +3 -0
  137. package/dist/schemas/extensions/document/x-scalar-icon.d.ts.map +1 -1
  138. package/dist/schemas/extensions/document/x-scalar-icon.js +7 -0
  139. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts +4 -1
  140. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts.map +1 -1
  141. package/dist/schemas/extensions/document/x-scalar-ignore.js +7 -0
  142. package/dist/schemas/extensions/document/x-scalar-is-dirty.d.ts +3 -0
  143. package/dist/schemas/extensions/document/x-scalar-is-dirty.d.ts.map +1 -1
  144. package/dist/schemas/extensions/document/x-scalar-is-dirty.js +9 -0
  145. package/dist/schemas/extensions/document/x-scalar-original-document-hash.d.ts +3 -0
  146. package/dist/schemas/extensions/document/x-scalar-original-document-hash.d.ts.map +1 -1
  147. package/dist/schemas/extensions/document/x-scalar-original-document-hash.js +7 -0
  148. package/dist/schemas/extensions/document/x-scalar-registry-meta.d.ts +6 -0
  149. package/dist/schemas/extensions/document/x-scalar-registry-meta.d.ts.map +1 -1
  150. package/dist/schemas/extensions/document/x-scalar-registry-meta.js +25 -10
  151. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +7 -0
  152. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
  153. package/dist/schemas/extensions/document/x-scalar-sdk-installation.js +23 -5
  154. package/dist/schemas/extensions/document/x-scalar-watch-mode.d.ts +3 -0
  155. package/dist/schemas/extensions/document/x-scalar-watch-mode.d.ts.map +1 -1
  156. package/dist/schemas/extensions/document/x-scalar-watch-mode.js +7 -0
  157. package/dist/schemas/extensions/document/x-tags.d.ts +4 -1
  158. package/dist/schemas/extensions/document/x-tags.d.ts.map +1 -1
  159. package/dist/schemas/extensions/document/x-tags.js +8 -1
  160. package/dist/schemas/extensions/example/x-disabled.d.ts +7 -1
  161. package/dist/schemas/extensions/example/x-disabled.d.ts.map +1 -1
  162. package/dist/schemas/extensions/example/x-disabled.js +8 -1
  163. package/dist/schemas/extensions/general/x-scalar-active-environment.d.ts +3 -0
  164. package/dist/schemas/extensions/general/x-scalar-active-environment.d.ts.map +1 -1
  165. package/dist/schemas/extensions/general/x-scalar-active-environment.js +7 -0
  166. package/dist/schemas/extensions/general/x-scalar-cookies.d.ts +16 -0
  167. package/dist/schemas/extensions/general/x-scalar-cookies.d.ts.map +1 -1
  168. package/dist/schemas/extensions/general/x-scalar-cookies.js +19 -0
  169. package/dist/schemas/extensions/general/x-scalar-order.d.ts +3 -0
  170. package/dist/schemas/extensions/general/x-scalar-order.d.ts.map +1 -1
  171. package/dist/schemas/extensions/general/x-scalar-order.js +7 -0
  172. package/dist/schemas/extensions/operation/index.d.ts +2 -1
  173. package/dist/schemas/extensions/operation/index.d.ts.map +1 -1
  174. package/dist/schemas/extensions/operation/index.js +1 -0
  175. package/dist/schemas/extensions/operation/x-badge.d.ts +12 -0
  176. package/dist/schemas/extensions/operation/x-badge.d.ts.map +1 -1
  177. package/dist/schemas/extensions/operation/x-badge.js +23 -0
  178. package/dist/schemas/extensions/operation/x-code-samples.d.ts +22 -0
  179. package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
  180. package/dist/schemas/extensions/operation/x-code-samples.js +17 -0
  181. package/dist/schemas/extensions/operation/x-draft-examples.d.ts +3 -0
  182. package/dist/schemas/extensions/operation/x-draft-examples.d.ts.map +1 -1
  183. package/dist/schemas/extensions/operation/x-draft-examples.js +7 -0
  184. package/dist/schemas/extensions/operation/x-post-response.d.ts +3 -0
  185. package/dist/schemas/extensions/operation/x-post-response.d.ts.map +1 -1
  186. package/dist/schemas/extensions/operation/x-post-response.js +9 -0
  187. package/dist/schemas/extensions/operation/x-scalar-disable-parameters.d.ts +9 -0
  188. package/dist/schemas/extensions/operation/x-scalar-disable-parameters.d.ts.map +1 -1
  189. package/dist/schemas/extensions/operation/x-scalar-disable-parameters.js +17 -0
  190. package/dist/schemas/extensions/operation/x-scalar-selected-content-type.d.ts +3 -0
  191. package/dist/schemas/extensions/operation/x-scalar-selected-content-type.d.ts.map +1 -1
  192. package/dist/schemas/extensions/operation/x-scalar-selected-content-type.js +9 -0
  193. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts +3 -0
  194. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts.map +1 -1
  195. package/dist/schemas/extensions/operation/x-scalar-stability.js +9 -0
  196. package/dist/schemas/extensions/parameter/x-global.d.ts +7 -1
  197. package/dist/schemas/extensions/parameter/x-global.d.ts.map +1 -1
  198. package/dist/schemas/extensions/parameter/x-global.js +8 -1
  199. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts +3 -0
  200. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts.map +1 -1
  201. package/dist/schemas/extensions/schema/x-additional-properties-name.js +7 -0
  202. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts +4 -0
  203. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts.map +1 -1
  204. package/dist/schemas/extensions/schema/x-enum-descriptions.js +9 -0
  205. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts +4 -0
  206. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts.map +1 -1
  207. package/dist/schemas/extensions/schema/x-enum-varnames.js +8 -0
  208. package/dist/schemas/extensions/schema/x-examples.d.ts +3 -0
  209. package/dist/schemas/extensions/schema/x-examples.d.ts.map +1 -1
  210. package/dist/schemas/extensions/schema/x-examples.js +7 -0
  211. package/dist/schemas/extensions/schema/x-variable.d.ts +3 -0
  212. package/dist/schemas/extensions/schema/x-variable.d.ts.map +1 -1
  213. package/dist/schemas/extensions/schema/x-variable.js +7 -0
  214. package/dist/schemas/extensions/security/x-default-scopes.d.ts +3 -0
  215. package/dist/schemas/extensions/security/x-default-scopes.d.ts.map +1 -1
  216. package/dist/schemas/extensions/security/x-default-scopes.js +7 -0
  217. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts +3 -0
  218. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts.map +1 -1
  219. package/dist/schemas/extensions/security/x-scalar-credentials-location.js +7 -0
  220. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts +3 -0
  221. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts.map +1 -1
  222. package/dist/schemas/extensions/security/x-scalar-security-body.js +7 -0
  223. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts +3 -0
  224. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts.map +1 -1
  225. package/dist/schemas/extensions/security/x-scalar-security-query.js +7 -0
  226. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts +25 -0
  227. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts.map +1 -1
  228. package/dist/schemas/extensions/security/x-scalar-security-secrets.js +50 -0
  229. package/dist/schemas/extensions/security/x-tokenName.d.ts +3 -0
  230. package/dist/schemas/extensions/security/x-tokenName.d.ts.map +1 -1
  231. package/dist/schemas/extensions/security/x-tokenName.js +7 -0
  232. package/dist/schemas/extensions/security/x-use-pkce.d.ts +3 -0
  233. package/dist/schemas/extensions/security/x-use-pkce.d.ts.map +1 -1
  234. package/dist/schemas/extensions/security/x-use-pkce.js +9 -0
  235. package/dist/schemas/extensions/server/x-scalar-selected-server.d.ts +3 -0
  236. package/dist/schemas/extensions/server/x-scalar-selected-server.d.ts.map +1 -1
  237. package/dist/schemas/extensions/server/x-scalar-selected-server.js +7 -0
  238. package/dist/schemas/extensions/tag/x-display-name.d.ts +3 -0
  239. package/dist/schemas/extensions/tag/x-display-name.d.ts.map +1 -1
  240. package/dist/schemas/extensions/tag/x-display-name.js +7 -0
  241. package/dist/schemas/extensions/tag/x-tag-groups.d.ts +14 -0
  242. package/dist/schemas/extensions/tag/x-tag-groups.d.ts.map +1 -1
  243. package/dist/schemas/extensions/tag/x-tag-groups.js +22 -1
  244. package/dist/schemas/extensions/workspace/x-scalar-active-proxy.d.ts +3 -0
  245. package/dist/schemas/extensions/workspace/x-scalar-active-proxy.d.ts.map +1 -1
  246. package/dist/schemas/extensions/workspace/x-scalar-active-proxy.js +7 -0
  247. package/dist/schemas/extensions/workspace/x-scalar-tabs.d.ts +13 -0
  248. package/dist/schemas/extensions/workspace/x-scalar-tabs.d.ts.map +1 -1
  249. package/dist/schemas/extensions/workspace/x-scalar-tabs.js +20 -0
  250. package/dist/schemas/v3.1/openapi/index.d.ts +112 -0
  251. package/dist/schemas/v3.1/openapi/index.d.ts.map +1 -0
  252. package/dist/schemas/v3.1/openapi/index.js +645 -0
  253. package/dist/schemas/v3.1/openapi/reference.d.ts +4 -0
  254. package/dist/schemas/v3.1/openapi/reference.d.ts.map +1 -0
  255. package/dist/schemas/v3.1/openapi/reference.js +29 -0
  256. package/dist/schemas/v3.1/strict/example.js +2 -2
  257. package/dist/schemas/v3.1/strict/parameter.js +2 -2
  258. package/dist/schemas/v3.1/strict/schema.d.ts +1 -1
  259. package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
  260. package/dist/schemas/v3.1/strict/schema.js +2 -2
  261. package/package.json +16 -9
@@ -0,0 +1,89 @@
1
+ import { combineUrlAndPath } from '@scalar/helpers/url/merge-urls';
2
+ /**
3
+ * Retrieves and processes servers from an OpenAPI document.
4
+ *
5
+ * This function handles several scenarios:
6
+ * 1. No servers provided - creates a default server from document URL or fallback
7
+ * 2. Invalid server configurations - filters them out with warnings
8
+ * 3. Relative URLs - resolves them to absolute URLs using available base URLs
9
+ *
10
+ * @param servers - Array of OpenAPI server objects from the document
11
+ * @param options - Configuration options for server processing
12
+ * @returns Array of validated Server entities
13
+ */
14
+ export function getServers(servers, options = {}) {
15
+ // Handle invalid server array
16
+ if (!Array.isArray(servers)) {
17
+ return [];
18
+ }
19
+ // Process each server and filter out invalid ones
20
+ const validServers = servers.map((server) => processServerObject(server, options));
21
+ return validServers;
22
+ }
23
+ /**
24
+ * Extracts the base URL (protocol + hostname) from a document URL.
25
+ * Returns undefined if the URL is invalid.
26
+ */
27
+ function extractBaseUrlFromDocumentUrl(documentUrl) {
28
+ try {
29
+ const url = new URL(documentUrl);
30
+ const port = url.port ? `:${url.port}` : '';
31
+ return `${url.protocol}//${url.hostname}${port}`;
32
+ }
33
+ catch {
34
+ return undefined;
35
+ }
36
+ }
37
+ /**
38
+ * Gets the fallback URL from window.location.origin if available.
39
+ */
40
+ function getFallbackUrl() {
41
+ if (typeof window === 'undefined' || typeof window?.location?.origin !== 'string') {
42
+ return undefined;
43
+ }
44
+ return window.location.origin;
45
+ }
46
+ /**
47
+ * Resolves a relative server URL to an absolute URL using available base URLs.
48
+ * Uses a priority system: baseServerURL > documentUrl > fallbackUrl.
49
+ */
50
+ function resolveRelativeServerUrl(serverUrl, options) {
51
+ const { baseServerUrl: baseServerURL, documentUrl } = options;
52
+ // Priority 1: Use provided base server URL
53
+ if (baseServerURL) {
54
+ return combineUrlAndPath(baseServerURL, serverUrl);
55
+ }
56
+ // Priority 2: Extract base URL from document URL
57
+ if (documentUrl) {
58
+ const baseUrl = extractBaseUrlFromDocumentUrl(documentUrl);
59
+ if (baseUrl) {
60
+ return combineUrlAndPath(baseUrl, serverUrl);
61
+ }
62
+ }
63
+ // Priority 3: Use fallback URL (window.location.origin)
64
+ const fallbackUrl = getFallbackUrl();
65
+ if (fallbackUrl) {
66
+ return combineUrlAndPath(fallbackUrl, serverUrl);
67
+ }
68
+ // If no base URL is available, return the original URL
69
+ return serverUrl;
70
+ }
71
+ /**
72
+ * Processes a single server object, handling validation and URL resolution.
73
+ */
74
+ function processServerObject(server, options) {
75
+ // Resolve relative URLs to absolute URLs
76
+ if (server.url?.startsWith('/')) {
77
+ server.url = resolveRelativeServerUrl(server.url, options);
78
+ }
79
+ return server;
80
+ }
81
+ export const getSelectedServer = (document, operation, configServers, servers) => {
82
+ const selectedServerUrl = configServers != null
83
+ ? document?.['x-scalar-selected-server']
84
+ : (operation?.['x-scalar-selected-server'] ?? document?.['x-scalar-selected-server']);
85
+ if (selectedServerUrl == null) {
86
+ return servers[0] ?? null;
87
+ }
88
+ return servers.find(({ url }) => url === selectedServerUrl) ?? null;
89
+ };
@@ -0,0 +1,5 @@
1
+ export { buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
2
+ export type { ApiKeyObjectSecret, HttpObjectSecret, OAuth2ObjectSecret, OAuthFlowAuthorizationCodeSecret, OAuthFlowClientCredentialsSecret, OAuthFlowImplicitSecret, OAuthFlowPasswordSecret, OAuthFlowsObjectSecret, OpenIdConnectObjectSecret, SecuritySchemeObjectSecret, } from './builder/index.js';
3
+ export { combineParams, getActiveEnvironment, getActiveProxyUrl, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, } from './context/index.js';
4
+ export type { MergedSecuritySchemes } from './context/index.js';
5
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/request-example/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,uBAAuB,EACvB,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,cAAc,EACd,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,wBAAwB,EACxB,kBAAkB,EAClB,4BAA4B,EAC5B,2BAA2B,EAC3B,oBAAoB,EACpB,4BAA4B,GAC7B,MAAM,WAAW,CAAA;AAClB,YAAY,EACV,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,gCAAgC,EAChC,gCAAgC,EAChC,uBAAuB,EACvB,uBAAuB,EACvB,sBAAsB,EACtB,yBAAyB,EACzB,0BAA0B,GAC3B,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,aAAa,GACd,MAAM,WAAW,CAAA;AAClB,YAAY,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA"}
@@ -0,0 +1,2 @@
1
+ export { buildRequest, buildRequestSecurity, deSerializeParameter, filterGlobalCookie, getEnvironmentVariables, getExample, getExampleFromBody, getExampleFromSchema, getResolvedUrl, getSelectedBodyContentType, getServerVariables, requestFactory, serializeContentValue, serializeDeepObjectStyle, serializeFormStyle, serializeFormStyleForCookies, serializePipeDelimitedStyle, serializeSimpleStyle, serializeSpaceDelimitedStyle, } from './builder/index.js';
2
+ export { combineParams, getActiveEnvironment, getActiveProxyUrl, getRequestExampleContext, getSecurityRequirements, getSecuritySchemes, getSelectedSecurity, getSelectedServer, getServers, isAuthOptional, mergeSecurity, } from './context/index.js';
@@ -0,0 +1,14 @@
1
+ import type { HttpMethod } from '@scalar/helpers/http/http-methods';
2
+ export type Result<T> = {
3
+ ok: true;
4
+ data: T;
5
+ } | {
6
+ ok: false;
7
+ error: string;
8
+ };
9
+ export type RequestExampleMeta = {
10
+ path: string;
11
+ method: HttpMethod;
12
+ exampleName: string;
13
+ };
14
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/request-example/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAA;AAEnE,MAAM,MAAM,MAAM,CAAC,CAAC,IAChB;IACE,EAAE,EAAE,IAAI,CAAA;IACR,IAAI,EAAE,CAAC,CAAA;CACR,GACD;IACE,EAAE,EAAE,KAAK,CAAA;IACT,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAEL,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA"}
@@ -0,0 +1 @@
1
+ export {};
@@ -5,4 +5,7 @@ export type XInternal = {
5
5
  /** Extension to mark an entity as internal */
6
6
  'x-internal'?: boolean;
7
7
  };
8
+ export declare const XInternal: import("@scalar/validation").ObjectSchema<{
9
+ 'x-internal': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
10
+ }>;
8
11
  //# sourceMappingURL=x-internal.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-internal.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-internal.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;EAE1B,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA"}
1
+ {"version":3,"file":"x-internal.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-internal.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,eAAe;;EAE1B,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,eAAO,MAAM,SAAS;;EAQrB,CAAA"}
@@ -1,4 +1,11 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { boolean, object, optional } from '@scalar/validation';
2
3
  export const XInternalSchema = Type.Object({
3
4
  'x-internal': Type.Optional(Type.Boolean()),
4
5
  });
6
+ export const XInternal = object({
7
+ 'x-internal': optional(boolean({ typeComment: 'Extension to mark an entity as internal' })),
8
+ }, {
9
+ typeName: 'XInternal',
10
+ typeComment: 'Extension to mark an entity as internal',
11
+ });
@@ -5,6 +5,13 @@ export declare const xScalarEnvVarSchema: import("@scalar/typebox").TObject<{
5
5
  default: import("@scalar/typebox").TString;
6
6
  }>, import("@scalar/typebox").TString]>;
7
7
  }>;
8
+ export declare const XScalarEnvVar: import("@scalar/validation").ObjectSchema<{
9
+ name: import("@scalar/validation").StringSchema;
10
+ value: import("@scalar/validation").UnionSchema<(import("@scalar/validation").StringSchema | import("@scalar/validation").ObjectSchema<{
11
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
12
+ default: import("@scalar/validation").StringSchema;
13
+ }>)[]>;
14
+ }>;
8
15
  /** A scalar environment variable */
9
16
  export type XScalarEnvVar = {
10
17
  name: string;
@@ -24,6 +31,17 @@ export declare const xScalarEnvironmentSchema: import("@scalar/typebox").TObject
24
31
  }>, import("@scalar/typebox").TString]>;
25
32
  }>>;
26
33
  }>;
34
+ export declare const XScalarEnvironment: import("@scalar/validation").ObjectSchema<{
35
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
36
+ color: import("@scalar/validation").StringSchema;
37
+ variables: import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
38
+ name: import("@scalar/validation").StringSchema;
39
+ value: import("@scalar/validation").UnionSchema<(import("@scalar/validation").StringSchema | import("@scalar/validation").ObjectSchema<{
40
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
41
+ default: import("@scalar/validation").StringSchema;
42
+ }>)[]>;
43
+ }>>;
44
+ }>;
27
45
  /** An environment definition */
28
46
  export type XScalarEnvironment = {
29
47
  /** Optional description for the environment */
@@ -46,6 +64,19 @@ export declare const xScalarEnvironmentsSchema: import("@scalar/typebox").TObjec
46
64
  }>>;
47
65
  }>>>;
48
66
  }>;
67
+ export declare const XScalarEnvironments: import("@scalar/validation").ObjectSchema<{
68
+ 'x-scalar-environments': import("@scalar/validation").OptionalSchema<import("@scalar/validation").RecordSchema<import("@scalar/validation").StringSchema, import("@scalar/validation").ObjectSchema<{
69
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
70
+ color: import("@scalar/validation").StringSchema;
71
+ variables: import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
72
+ name: import("@scalar/validation").StringSchema;
73
+ value: import("@scalar/validation").UnionSchema<(import("@scalar/validation").StringSchema | import("@scalar/validation").ObjectSchema<{
74
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
75
+ default: import("@scalar/validation").StringSchema;
76
+ }>)[]>;
77
+ }>>;
78
+ }>>>;
79
+ }>;
49
80
  export type XScalarEnvironments = {
50
81
  /** A record of environments by name */
51
82
  'x-scalar-environments'?: Record<string, XScalarEnvironment>;
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-environments.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-environments.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mBAAmB;;;;;;EAS9B,CAAA;AAEF,oCAAoC;AACpC,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EACD;QACE,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,MAAM,CAAA;KAChB,GACD,MAAM,CAAA;CACX,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;;EAInC,CAAA;AAEF,gCAAgC;AAChC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,4BAA4B;IAC5B,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;EAEpC,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,uCAAuC;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;CAC7D,CAAA"}
1
+ {"version":3,"file":"x-scalar-environments.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-environments.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB;;;;;;EAS9B,CAAA;AAEF,eAAO,MAAM,aAAa;;;;;;EAQzB,CAAA;AAED,oCAAoC;AACpC,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EACD;QACE,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,MAAM,CAAA;KAChB,GACD,MAAM,CAAA;CACX,CAAA;AAED,eAAO,MAAM,wBAAwB;;;;;;;;;;EAInC,CAAA;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;EAc9B,CAAA;AAED,gCAAgC;AAChC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,+CAA+C;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,4BAA4B;IAC5B,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAA;AAED,eAAO,MAAM,yBAAyB;;;;;;;;;;;;EAEpC,CAAA;AAEF,eAAO,MAAM,mBAAmB;;;;;;;;;;;;EAQ/B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,uCAAuC;IACvC,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAA;CAC7D,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { array, object, optional, record, string, union } from '@scalar/validation';
2
3
  export const xScalarEnvVarSchema = Type.Object({
3
4
  name: Type.String(),
4
5
  value: Type.Union([
@@ -9,11 +10,35 @@ export const xScalarEnvVarSchema = Type.Object({
9
10
  Type.String(),
10
11
  ]),
11
12
  });
13
+ export const XScalarEnvVar = object({
14
+ name: string(),
15
+ value: union([object({ description: optional(string()), default: string() }), string()]),
16
+ }, {
17
+ typeName: 'XScalarEnvVar',
18
+ });
12
19
  export const xScalarEnvironmentSchema = Type.Object({
13
20
  description: Type.Optional(Type.String()),
14
21
  color: Type.String({ default: '#FFFFFF' }),
15
22
  variables: Type.Array(xScalarEnvVarSchema),
16
23
  });
24
+ export const XScalarEnvironment = object({
25
+ description: optional(string()),
26
+ color: string({
27
+ typeComment: 'Color for the environment',
28
+ }),
29
+ variables: array(XScalarEnvVar, {
30
+ typeComment: 'An array of variables',
31
+ }),
32
+ }, {
33
+ typeName: 'XScalarEnvironment',
34
+ typeComment: 'A map of environments by name',
35
+ });
17
36
  export const xScalarEnvironmentsSchema = Type.Object({
18
37
  'x-scalar-environments': Type.Optional(Type.Record(Type.String(), xScalarEnvironmentSchema)),
19
38
  });
39
+ export const XScalarEnvironments = object({
40
+ 'x-scalar-environments': optional(record(string(), XScalarEnvironment)),
41
+ }, {
42
+ typeName: 'XScalarEnvironments',
43
+ typeComment: 'A record of environments by name',
44
+ });
@@ -5,4 +5,7 @@ export type XScalarIcon = {
5
5
  /** A custom icon representing the collection */
6
6
  'x-scalar-icon'?: string;
7
7
  };
8
+ export declare const XScalarIcon: import("@scalar/validation").ObjectSchema<{
9
+ 'x-scalar-icon': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
10
+ }>;
8
11
  //# sourceMappingURL=x-scalar-icon.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-icon.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-icon.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB;;EAE5B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,gDAAgD;IAChD,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA"}
1
+ {"version":3,"file":"x-scalar-icon.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-icon.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,iBAAiB;;EAE5B,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,gDAAgD;IAChD,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,WAAW;;EAQvB,CAAA"}
@@ -1,4 +1,11 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { object, optional, string } from '@scalar/validation';
2
3
  export const XScalarIconSchema = Type.Object({
3
4
  'x-scalar-icon': Type.Optional(Type.String()),
4
5
  });
6
+ export const XScalarIcon = object({
7
+ 'x-scalar-icon': optional(string()),
8
+ }, {
9
+ typeName: 'XScalarIcon',
10
+ typeComment: 'A custom icon representing the collection',
11
+ });
@@ -2,7 +2,10 @@ export declare const XScalarIgnoreSchema: import("@scalar/typebox").TObject<{
2
2
  'x-scalar-ignore': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
3
3
  }>;
4
4
  export type XScalarIgnore = {
5
- /** Interal extension to mark an entity as ignored */
5
+ /** Internal extension to mark an entity as ignored */
6
6
  'x-scalar-ignore'?: boolean;
7
7
  };
8
+ export declare const XScalarIgnore: import("@scalar/validation").ObjectSchema<{
9
+ 'x-scalar-ignore': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
10
+ }>;
8
11
  //# sourceMappingURL=x-scalar-ignore.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-ignore.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-ignore.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA"}
1
+ {"version":3,"file":"x-scalar-ignore.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-ignore.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB;;EAE9B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,sDAAsD;IACtD,iBAAiB,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED,eAAO,MAAM,aAAa;;EAQzB,CAAA"}
@@ -1,4 +1,11 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { boolean, object, optional } from '@scalar/validation';
2
3
  export const XScalarIgnoreSchema = Type.Object({
3
4
  'x-scalar-ignore': Type.Optional(Type.Boolean()),
4
5
  });
6
+ export const XScalarIgnore = object({
7
+ 'x-scalar-ignore': optional(boolean()),
8
+ }, {
9
+ typeName: 'XScalarIgnore',
10
+ typeComment: 'Internal extension to mark an entity as ignored',
11
+ });
@@ -40,4 +40,7 @@ export type XScalarIsDirty = {
40
40
  /** Whether the document state is dirty, this is used to track if the document has been modified since it was last saved */
41
41
  'x-scalar-is-dirty'?: boolean;
42
42
  };
43
+ export declare const XScalarIsDirty: import("@scalar/validation").ObjectSchema<{
44
+ 'x-scalar-is-dirty': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
45
+ }>;
43
46
  //# sourceMappingURL=x-scalar-is-dirty.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-is-dirty.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-is-dirty.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB;IAC/B,2HAA2H;;EAE3H,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2HAA2H;IAC3H,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,CAAA"}
1
+ {"version":3,"file":"x-scalar-is-dirty.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-is-dirty.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,oBAAoB;IAC/B,2HAA2H;;EAE3H,CAAA;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2HAA2H;IAC3H,mBAAmB,CAAC,EAAE,OAAO,CAAA;CAC9B,CAAA;AAED,eAAO,MAAM,cAAc;;EAa1B,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { boolean, object, optional } from '@scalar/validation';
2
3
  /**
3
4
  * Schema for the "x-scalar-is-dirty" OpenAPI extension.
4
5
  * This extension allows specifying an optional boolean value,
@@ -20,3 +21,11 @@ export const XScalarIsDirtySchema = Type.Object({
20
21
  /** Whether the document state is dirty, this is used to track if the document has been modified since it was last saved */
21
22
  'x-scalar-is-dirty': Type.Optional(Type.Boolean()),
22
23
  });
24
+ export const XScalarIsDirty = object({
25
+ 'x-scalar-is-dirty': optional(boolean({
26
+ typeComment: 'Whether the document state is dirty, this is used to track if the document has been modified since it was last saved',
27
+ })),
28
+ }, {
29
+ typeName: 'XScalarIsDirty',
30
+ typeComment: 'Tracks whether the document has been modified since it was last saved',
31
+ });
@@ -19,4 +19,7 @@ export type XScalarOriginalDocumentHash = {
19
19
  /** Original input document hash */
20
20
  'x-scalar-original-document-hash': string;
21
21
  };
22
+ export declare const XScalarOriginalDocumentHash: import("@scalar/validation").ObjectSchema<{
23
+ 'x-scalar-original-document-hash': import("@scalar/validation").StringSchema;
24
+ }>;
22
25
  //# sourceMappingURL=x-scalar-original-document-hash.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-original-document-hash.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-original-document-hash.ts"],"names":[],"mappings":"AACA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iCAAiC;IAC5C,mCAAmC;;EAEnC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,mCAAmC;IACnC,iCAAiC,EAAE,MAAM,CAAA;CAC1C,CAAA"}
1
+ {"version":3,"file":"x-scalar-original-document-hash.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-original-document-hash.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iCAAiC;IAC5C,mCAAmC;;EAEnC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG;IACxC,mCAAmC;IACnC,iCAAiC,EAAE,MAAM,CAAA;CAC1C,CAAA;AAED,eAAO,MAAM,2BAA2B;;EAQvC,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { object, string } from '@scalar/validation';
2
3
  /**
3
4
  * Schema for the "x-scalar-original-document-hash" OpenAPI extension.
4
5
  * This extension allows specifying an optional string value,
@@ -16,3 +17,9 @@ export const XScalarOriginalDocumentHashSchema = Type.Object({
16
17
  /** Original input document hash */
17
18
  'x-scalar-original-document-hash': Type.String(),
18
19
  });
20
+ export const XScalarOriginalDocumentHash = object({
21
+ 'x-scalar-original-document-hash': string({ typeComment: 'Original input document hash' }),
22
+ }, {
23
+ typeName: 'XScalarOriginalDocumentHash',
24
+ typeComment: 'Original input document hash',
25
+ });
@@ -28,4 +28,10 @@ export type XScalarRegistryMeta = {
28
28
  slug: string;
29
29
  };
30
30
  };
31
+ export declare const XScalarRegistryMeta: import("@scalar/validation").ObjectSchema<{
32
+ 'x-scalar-registry-meta': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ObjectSchema<{
33
+ namespace: import("@scalar/validation").StringSchema;
34
+ slug: import("@scalar/validation").StringSchema;
35
+ }>>;
36
+ }>;
31
37
  //# sourceMappingURL=x-scalar-registry-meta.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-registry-meta.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-registry-meta.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,yBAAyB;IACpC;;OAEG;;QAGC;;WAEG;;QAEH;;WAEG;;;EAIP,CAAA;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,wBAAwB,CAAC,EAAE;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;QACjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA"}
1
+ {"version":3,"file":"x-scalar-registry-meta.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-registry-meta.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,yBAAyB;IACpC;;OAEG;;QAbH;;WAEG;;QAEH;;WAEG;;;EASH,CAAA;AAaF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,wBAAwB,CAAC,EAAE;QACzB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAA;QACjB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA;AAED,eAAO,MAAM,mBAAmB;;;;;EAQ/B,CAAA"}
@@ -1,16 +1,31 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { object, optional, string } from '@scalar/validation';
3
+ const XScalarRegistryMetaInnerSchema = Type.Object({
4
+ /**
5
+ * The namespace under which this registry meta is scoped.
6
+ */
7
+ 'namespace': Type.String(),
8
+ /**
9
+ * A unique slug identifier for this registry meta within the namespace.
10
+ */
11
+ 'slug': Type.String(),
12
+ });
2
13
  export const XScalarRegistryMetaSchema = Type.Object({
3
14
  /**
4
15
  * The registry meta for the document.
5
16
  */
6
- 'x-scalar-registry-meta': Type.Optional(Type.Object({
7
- /**
8
- * The namespace under which this registry meta is scoped.
9
- */
10
- 'namespace': Type.String(),
11
- /**
12
- * A unique slug identifier for this registry meta within the namespace.
13
- */
14
- 'slug': Type.String(),
15
- })),
17
+ 'x-scalar-registry-meta': Type.Optional(XScalarRegistryMetaInnerSchema),
18
+ });
19
+ const XScalarRegistryMetaInner = object({
20
+ namespace: string({ typeComment: 'The namespace under which this registry meta is scoped.' }),
21
+ slug: string({ typeComment: 'A unique slug identifier for this registry meta within the namespace.' }),
22
+ }, {
23
+ typeName: 'XScalarRegistryMetaInner',
24
+ typeComment: 'Registry meta namespace and slug',
25
+ });
26
+ export const XScalarRegistryMeta = object({
27
+ 'x-scalar-registry-meta': optional(XScalarRegistryMetaInner),
28
+ }, {
29
+ typeName: 'XScalarRegistryMeta',
30
+ typeComment: 'The registry meta for the document',
16
31
  });
@@ -13,4 +13,11 @@ export type XScalarSdkInstallation = {
13
13
  description?: string;
14
14
  }[];
15
15
  };
16
+ export declare const XScalarSdkInstallation: import("@scalar/validation").ObjectSchema<{
17
+ 'x-scalar-sdk-installation': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").ObjectSchema<{
18
+ lang: import("@scalar/validation").StringSchema;
19
+ source: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
20
+ description: import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
21
+ }>>>;
22
+ }>;
16
23
  //# sourceMappingURL=x-scalar-sdk-installation.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,4BAA4B;;;;;;EAUvC,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA"}
1
+ {"version":3,"file":"x-scalar-sdk-installation.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-sdk-installation.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,4BAA4B;;;;;;EAEvC,CAAA;AAcF,MAAM,MAAM,sBAAsB,GAAG;IACnC,2CAA2C;IAC3C,2BAA2B,CAAC,EAAE;QAC5B,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,EAAE,CAAA;CACJ,CAAA;AAED,eAAO,MAAM,sBAAsB;;;;;;EAYlC,CAAA"}
@@ -1,8 +1,26 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { array, object, optional, string } from '@scalar/validation';
3
+ const XScalarSdkInstallationItemSchema = Type.Object({
4
+ lang: Type.String(),
5
+ source: Type.Optional(Type.String()),
6
+ description: Type.Optional(Type.String()),
7
+ });
2
8
  export const XScalarSdkInstallationSchema = Type.Object({
3
- 'x-scalar-sdk-installation': Type.Optional(Type.Array(Type.Object({
4
- lang: Type.String(),
5
- source: Type.Optional(Type.String()),
6
- description: Type.Optional(Type.String()),
7
- }))),
9
+ 'x-scalar-sdk-installation': Type.Optional(Type.Array(XScalarSdkInstallationItemSchema)),
10
+ });
11
+ const XScalarSdkInstallationItem = object({
12
+ lang: string(),
13
+ source: optional(string()),
14
+ description: optional(string()),
15
+ }, {
16
+ typeName: 'XScalarSdkInstallationItem',
17
+ typeComment: 'Scalar SDK installation entry',
18
+ });
19
+ export const XScalarSdkInstallation = object({
20
+ 'x-scalar-sdk-installation': optional(array(XScalarSdkInstallationItem, {
21
+ typeComment: 'Scalar SDK installation information',
22
+ })),
23
+ }, {
24
+ typeName: 'XScalarSdkInstallation',
25
+ typeComment: 'Scalar SDK installation information',
8
26
  });
@@ -6,4 +6,7 @@ export type XScalarWatchMode = {
6
6
  /** Whether the document is in watch mode */
7
7
  'x-scalar-watch-mode'?: boolean;
8
8
  };
9
+ export declare const XScalarWatchMode: import("@scalar/validation").ObjectSchema<{
10
+ 'x-scalar-watch-mode': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
11
+ }>;
9
12
  //# sourceMappingURL=x-scalar-watch-mode.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-watch-mode.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-watch-mode.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB;IACjC,4CAA4C;;EAE5C,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4CAA4C;IAC5C,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA"}
1
+ {"version":3,"file":"x-scalar-watch-mode.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-scalar-watch-mode.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,sBAAsB;IACjC,4CAA4C;;EAE5C,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,4CAA4C;IAC5C,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC,CAAA;AAED,eAAO,MAAM,gBAAgB;;EAQ5B,CAAA"}
@@ -1,5 +1,12 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { boolean, object, optional } from '@scalar/validation';
2
3
  export const XScalarWatchModeSchema = Type.Object({
3
4
  /** Whether the document is in watch mode */
4
5
  'x-scalar-watch-mode': Type.Optional(Type.Boolean()),
5
6
  });
7
+ export const XScalarWatchMode = object({
8
+ 'x-scalar-watch-mode': optional(boolean({ typeComment: 'Whether the document is in watch mode' })),
9
+ }, {
10
+ typeName: 'XScalarWatchMode',
11
+ typeComment: 'Whether the document is in watch mode',
12
+ });
@@ -1,7 +1,10 @@
1
- export declare const XTags: import("@scalar/typebox").TObject<{
1
+ export declare const XTagsSchema: import("@scalar/typebox").TObject<{
2
2
  'x-tags': import("@scalar/typebox").TOptional<import("@scalar/typebox").TArray<import("@scalar/typebox").TString>>;
3
3
  }>;
4
4
  export type XTags = {
5
5
  'x-tags'?: string[];
6
6
  };
7
+ export declare const XTags: import("@scalar/validation").ObjectSchema<{
8
+ 'x-tags': import("@scalar/validation").OptionalSchema<import("@scalar/validation").ArraySchema<import("@scalar/validation").StringSchema>>;
9
+ }>;
7
10
  //# sourceMappingURL=x-tags.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-tags.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-tags.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK;;EAEhB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA"}
1
+ {"version":3,"file":"x-tags.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/document/x-tags.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,WAAW;;EAEtB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,KAAK;;EAQjB,CAAA"}
@@ -1,4 +1,11 @@
1
1
  import { Type } from '@scalar/typebox';
2
- export const XTags = Type.Object({
2
+ import { array, object, optional, string } from '@scalar/validation';
3
+ export const XTagsSchema = Type.Object({
3
4
  'x-tags': Type.Optional(Type.Array(Type.String())),
4
5
  });
6
+ export const XTags = object({
7
+ 'x-tags': optional(array(string())),
8
+ }, {
9
+ typeName: 'XTags',
10
+ typeComment: 'Custom tag ordering or grouping hints for schema objects',
11
+ });
@@ -12,7 +12,13 @@
12
12
  * x-disabled: false # Send this parameter example in the request
13
13
  * ```
14
14
  */
15
- export declare const XDisabled: import("@scalar/typebox").TObject<{
15
+ export declare const XDisabledSchema: import("@scalar/typebox").TObject<{
16
16
  'x-disabled': import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
17
17
  }>;
18
+ export type XDisabled = {
19
+ 'x-disabled'?: boolean;
20
+ };
21
+ export declare const XDisabled: import("@scalar/validation").ObjectSchema<{
22
+ 'x-disabled': import("@scalar/validation").OptionalSchema<import("@scalar/validation").BooleanSchema>;
23
+ }>;
18
24
  //# sourceMappingURL=x-disabled.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-disabled.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/example/x-disabled.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS;;EAEpB,CAAA"}
1
+ {"version":3,"file":"x-disabled.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/example/x-disabled.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe;;EAE1B,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,eAAO,MAAM,SAAS;;EAQrB,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { Type } from '@scalar/typebox';
2
+ import { boolean, object, optional } from '@scalar/validation';
2
3
  /**
3
4
  * OpenAPI extension to control whether a parameter example is enabled (checkbox on) or disabled (checkbox off).
4
5
  *
@@ -13,6 +14,12 @@ import { Type } from '@scalar/typebox';
13
14
  * x-disabled: false # Send this parameter example in the request
14
15
  * ```
15
16
  */
16
- export const XDisabled = Type.Object({
17
+ export const XDisabledSchema = Type.Object({
17
18
  'x-disabled': Type.Optional(Type.Boolean()),
18
19
  });
20
+ export const XDisabled = object({
21
+ 'x-disabled': optional(boolean()),
22
+ }, {
23
+ typeName: 'XDisabled',
24
+ typeComment: 'Whether a parameter example is disabled in the API client',
25
+ });
@@ -5,4 +5,7 @@ export type XScalarActiveEnvironment = {
5
5
  /** The currently selected environment */
6
6
  'x-scalar-active-environment'?: string;
7
7
  };
8
+ export declare const XScalarActiveEnvironment: import("@scalar/validation").ObjectSchema<{
9
+ 'x-scalar-active-environment': import("@scalar/validation").OptionalSchema<import("@scalar/validation").StringSchema>;
10
+ }>;
8
11
  //# sourceMappingURL=x-scalar-active-environment.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"x-scalar-active-environment.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/general/x-scalar-active-environment.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,8BAA8B;;EAEzC,CAAA;AAGF,MAAM,MAAM,wBAAwB,GAAG;IACrC,yCAAyC;IACzC,6BAA6B,CAAC,EAAE,MAAM,CAAA;CACvC,CAAA"}
1
+ {"version":3,"file":"x-scalar-active-environment.d.ts","sourceRoot":"","sources":["../../../../src/schemas/extensions/general/x-scalar-active-environment.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,8BAA8B;;EAEzC,CAAA;AAGF,MAAM,MAAM,wBAAwB,GAAG;IACrC,yCAAyC;IACzC,6BAA6B,CAAC,EAAE,MAAM,CAAA;CACvC,CAAA;AAED,eAAO,MAAM,wBAAwB;;EAQpC,CAAA"}