@scalar/workspace-store 0.16.0 → 0.17.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 (292) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/dist/client.d.ts +1 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +2 -2
  5. package/dist/client.js.map +2 -2
  6. package/dist/mutators/index.d.ts +6 -24
  7. package/dist/mutators/index.d.ts.map +1 -1
  8. package/dist/mutators/index.js +0 -2
  9. package/dist/mutators/index.js.map +2 -2
  10. package/dist/navigation/helpers/traverse-description.d.ts +1 -1
  11. package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
  12. package/dist/navigation/helpers/traverse-description.js.map +1 -1
  13. package/dist/navigation/helpers/traverse-document.d.ts +2 -182
  14. package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
  15. package/dist/navigation/helpers/traverse-document.js.map +2 -2
  16. package/dist/navigation/helpers/traverse-examples.d.ts +8 -0
  17. package/dist/navigation/helpers/traverse-examples.d.ts.map +1 -0
  18. package/dist/navigation/helpers/traverse-examples.js +46 -0
  19. package/dist/navigation/helpers/traverse-examples.js.map +7 -0
  20. package/dist/navigation/helpers/traverse-paths.d.ts.map +1 -1
  21. package/dist/navigation/helpers/traverse-paths.js +9 -1
  22. package/dist/navigation/helpers/traverse-paths.js.map +2 -2
  23. package/dist/navigation/helpers/traverse-schemas.d.ts +2 -1
  24. package/dist/navigation/helpers/traverse-schemas.d.ts.map +1 -1
  25. package/dist/navigation/helpers/traverse-schemas.js.map +2 -2
  26. package/dist/navigation/helpers/traverse-tags.d.ts +2 -1
  27. package/dist/navigation/helpers/traverse-tags.d.ts.map +1 -1
  28. package/dist/navigation/helpers/traverse-tags.js +1 -0
  29. package/dist/navigation/helpers/traverse-tags.js.map +2 -2
  30. package/dist/navigation/helpers/traverse-webhooks.d.ts +2 -1
  31. package/dist/navigation/helpers/traverse-webhooks.d.ts.map +1 -1
  32. package/dist/navigation/helpers/traverse-webhooks.js +1 -1
  33. package/dist/navigation/helpers/traverse-webhooks.js.map +2 -2
  34. package/dist/navigation/types.d.ts +2 -1
  35. package/dist/navigation/types.d.ts.map +1 -1
  36. package/dist/schemas/extensions/document/x-internal.d.ts +4 -0
  37. package/dist/schemas/extensions/document/x-internal.d.ts.map +1 -1
  38. package/dist/schemas/extensions/document/x-internal.js.map +1 -1
  39. package/dist/schemas/extensions/document/x-scalar-icon.d.ts +4 -0
  40. package/dist/schemas/extensions/document/x-scalar-icon.d.ts.map +1 -1
  41. package/dist/schemas/extensions/document/x-scalar-icon.js.map +1 -1
  42. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts +4 -0
  43. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts.map +1 -1
  44. package/dist/schemas/extensions/document/x-scalar-ignore.js.map +1 -1
  45. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +8 -2
  46. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
  47. package/dist/schemas/extensions/document/x-scalar-sdk-installation.js.map +2 -2
  48. package/dist/schemas/extensions/document/x-tags.d.ts +3 -0
  49. package/dist/schemas/extensions/document/x-tags.d.ts.map +1 -1
  50. package/dist/schemas/extensions/document/x-tags.js.map +1 -1
  51. package/dist/schemas/extensions/example/x-disabled.d.ts +18 -0
  52. package/dist/schemas/extensions/example/x-disabled.d.ts.map +1 -0
  53. package/dist/schemas/extensions/example/x-disabled.js +8 -0
  54. package/dist/schemas/extensions/example/x-disabled.js.map +7 -0
  55. package/dist/schemas/extensions/operation/x-badge.d.ts +62 -22
  56. package/dist/schemas/extensions/operation/x-badge.d.ts.map +1 -1
  57. package/dist/schemas/extensions/operation/x-badge.js +24 -3
  58. package/dist/schemas/extensions/operation/x-badge.js.map +2 -2
  59. package/dist/schemas/extensions/operation/x-code-samples.d.ts +10 -2
  60. package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
  61. package/dist/schemas/extensions/operation/x-code-samples.js.map +2 -2
  62. package/dist/schemas/extensions/operation/x-post-response.d.ts +18 -0
  63. package/dist/schemas/extensions/operation/x-post-response.d.ts.map +1 -1
  64. package/dist/schemas/extensions/operation/x-post-response.js.map +1 -1
  65. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts +11 -0
  66. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts.map +1 -1
  67. package/dist/schemas/extensions/operation/x-scalar-stability.js.map +1 -1
  68. package/dist/schemas/extensions/parameter/x-global.d.ts +13 -0
  69. package/dist/schemas/extensions/parameter/x-global.d.ts.map +1 -0
  70. package/dist/schemas/extensions/parameter/x-global.js +8 -0
  71. package/dist/schemas/extensions/parameter/x-global.js.map +7 -0
  72. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts +10 -0
  73. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts.map +1 -1
  74. package/dist/schemas/extensions/schema/x-additional-properties-name.js.map +1 -1
  75. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts +30 -0
  76. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts.map +1 -1
  77. package/dist/schemas/extensions/schema/x-enum-descriptions.js.map +1 -1
  78. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts +38 -0
  79. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts.map +1 -1
  80. package/dist/schemas/extensions/schema/x-enum-varnames.js.map +1 -1
  81. package/dist/schemas/extensions/schema/x-variable.d.ts +3 -0
  82. package/dist/schemas/extensions/schema/x-variable.d.ts.map +1 -1
  83. package/dist/schemas/extensions/schema/x-variable.js.map +1 -1
  84. package/dist/schemas/extensions/security/x-default-scopes.d.ts +16 -0
  85. package/dist/schemas/extensions/security/x-default-scopes.d.ts.map +1 -1
  86. package/dist/schemas/extensions/security/x-default-scopes.js.map +1 -1
  87. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts +16 -0
  88. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts.map +1 -1
  89. package/dist/schemas/extensions/security/x-scalar-credentials-location.js.map +1 -1
  90. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts +15 -1
  91. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts.map +1 -1
  92. package/dist/schemas/extensions/security/x-scalar-security-body.js +2 -2
  93. package/dist/schemas/extensions/security/x-scalar-security-body.js.map +2 -2
  94. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts +15 -1
  95. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts.map +1 -1
  96. package/dist/schemas/extensions/security/x-scalar-security-query.js +2 -2
  97. package/dist/schemas/extensions/security/x-scalar-security-query.js.map +2 -2
  98. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts +41 -0
  99. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts.map +1 -1
  100. package/dist/schemas/extensions/security/x-scalar-security-secrets.js.map +2 -2
  101. package/dist/schemas/extensions/security/x-tokenName.d.ts +12 -1
  102. package/dist/schemas/extensions/security/x-tokenName.d.ts.map +1 -1
  103. package/dist/schemas/extensions/security/x-tokenName.js +2 -2
  104. package/dist/schemas/extensions/security/x-tokenName.js.map +2 -2
  105. package/dist/schemas/extensions/security/x-use-pkce.d.ts +6 -0
  106. package/dist/schemas/extensions/security/x-use-pkce.d.ts.map +1 -1
  107. package/dist/schemas/extensions/security/x-use-pkce.js.map +1 -1
  108. package/dist/schemas/extensions/tag/x-display-name.d.ts +11 -0
  109. package/dist/schemas/extensions/tag/x-display-name.d.ts.map +1 -1
  110. package/dist/schemas/extensions/tag/x-display-name.js.map +1 -1
  111. package/dist/schemas/extensions/tag/x-tag-groups.d.ts +18 -0
  112. package/dist/schemas/extensions/tag/x-tag-groups.d.ts.map +1 -1
  113. package/dist/schemas/extensions/tag/x-tag-groups.js.map +2 -2
  114. package/dist/schemas/inmemory-workspace.d.ts +95 -64
  115. package/dist/schemas/inmemory-workspace.d.ts.map +1 -1
  116. package/dist/schemas/inmemory-workspace.js +4 -1
  117. package/dist/schemas/inmemory-workspace.js.map +2 -2
  118. package/dist/schemas/navigation.d.ts +70 -1
  119. package/dist/schemas/navigation.d.ts.map +1 -1
  120. package/dist/schemas/navigation.js +17 -11
  121. package/dist/schemas/navigation.js.map +2 -2
  122. package/dist/schemas/reference-config/appearance.d.ts +9 -2
  123. package/dist/schemas/reference-config/appearance.d.ts.map +1 -1
  124. package/dist/schemas/reference-config/appearance.js.map +2 -2
  125. package/dist/schemas/reference-config/features.d.ts +11 -2
  126. package/dist/schemas/reference-config/features.d.ts.map +1 -1
  127. package/dist/schemas/reference-config/features.js.map +2 -2
  128. package/dist/schemas/reference-config/index.d.ts +58 -34
  129. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  130. package/dist/schemas/reference-config/index.js +5 -5
  131. package/dist/schemas/reference-config/index.js.map +2 -2
  132. package/dist/schemas/reference-config/meta.d.ts +8 -2
  133. package/dist/schemas/reference-config/meta.d.ts.map +1 -1
  134. package/dist/schemas/reference-config/meta.js.map +2 -2
  135. package/dist/schemas/reference-config/routing.d.ts +4 -2
  136. package/dist/schemas/reference-config/routing.d.ts.map +1 -1
  137. package/dist/schemas/reference-config/routing.js.map +2 -2
  138. package/dist/schemas/reference-config/settings.d.ts +48 -33
  139. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  140. package/dist/schemas/reference-config/settings.js.map +2 -2
  141. package/dist/schemas/v3.1/strict/callback.d.ts +4 -0
  142. package/dist/schemas/v3.1/strict/callback.d.ts.map +1 -1
  143. package/dist/schemas/v3.1/strict/callback.js +2 -2
  144. package/dist/schemas/v3.1/strict/callback.js.map +2 -2
  145. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts +19 -3
  146. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +1 -1
  147. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js.map +2 -2
  148. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts +10 -4
  149. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts.map +1 -1
  150. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js.map +2 -2
  151. package/dist/schemas/v3.1/strict/components.d.ts +34 -0
  152. package/dist/schemas/v3.1/strict/components.d.ts.map +1 -1
  153. package/dist/schemas/v3.1/strict/components.js +1 -1
  154. package/dist/schemas/v3.1/strict/components.js.map +2 -2
  155. package/dist/schemas/v3.1/strict/contact.d.ts +9 -0
  156. package/dist/schemas/v3.1/strict/contact.d.ts.map +1 -1
  157. package/dist/schemas/v3.1/strict/contact.js.map +1 -1
  158. package/dist/schemas/v3.1/strict/discriminator.d.ts +11 -0
  159. package/dist/schemas/v3.1/strict/discriminator.d.ts.map +1 -1
  160. package/dist/schemas/v3.1/strict/discriminator.js.map +1 -1
  161. package/dist/schemas/v3.1/strict/encoding.d.ts +15 -0
  162. package/dist/schemas/v3.1/strict/encoding.d.ts.map +1 -1
  163. package/dist/schemas/v3.1/strict/encoding.js +1 -1
  164. package/dist/schemas/v3.1/strict/encoding.js.map +2 -2
  165. package/dist/schemas/v3.1/strict/example.d.ts +28 -2
  166. package/dist/schemas/v3.1/strict/example.d.ts.map +1 -1
  167. package/dist/schemas/v3.1/strict/example.js +15 -10
  168. package/dist/schemas/v3.1/strict/example.js.map +2 -2
  169. package/dist/schemas/v3.1/strict/external-documentation.d.ts +9 -2
  170. package/dist/schemas/v3.1/strict/external-documentation.d.ts.map +1 -1
  171. package/dist/schemas/v3.1/strict/external-documentation.js +3 -3
  172. package/dist/schemas/v3.1/strict/external-documentation.js.map +2 -2
  173. package/dist/schemas/v3.1/strict/header.d.ts +41 -0
  174. package/dist/schemas/v3.1/strict/header.d.ts.map +1 -1
  175. package/dist/schemas/v3.1/strict/header.js +2 -2
  176. package/dist/schemas/v3.1/strict/header.js.map +2 -2
  177. package/dist/schemas/v3.1/strict/info.d.ts +24 -2
  178. package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
  179. package/dist/schemas/v3.1/strict/info.js +7 -5
  180. package/dist/schemas/v3.1/strict/info.js.map +2 -2
  181. package/dist/schemas/v3.1/strict/license.d.ts +9 -0
  182. package/dist/schemas/v3.1/strict/license.d.ts.map +1 -1
  183. package/dist/schemas/v3.1/strict/license.js.map +1 -1
  184. package/dist/schemas/v3.1/strict/link.d.ts +22 -0
  185. package/dist/schemas/v3.1/strict/link.d.ts.map +1 -1
  186. package/dist/schemas/v3.1/strict/link.js.map +2 -2
  187. package/dist/schemas/v3.1/strict/media-type.d.ts +19 -0
  188. package/dist/schemas/v3.1/strict/media-type.d.ts.map +1 -1
  189. package/dist/schemas/v3.1/strict/media-type.js +2 -2
  190. package/dist/schemas/v3.1/strict/media-type.js.map +2 -2
  191. package/dist/schemas/v3.1/strict/oauth-flow.d.ts +36 -5
  192. package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
  193. package/dist/schemas/v3.1/strict/oauth-flow.js +13 -7
  194. package/dist/schemas/v3.1/strict/oauth-flow.js.map +2 -2
  195. package/dist/schemas/v3.1/strict/oauthflows.d.ts +11 -0
  196. package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
  197. package/dist/schemas/v3.1/strict/oauthflows.js.map +2 -2
  198. package/dist/schemas/v3.1/strict/openapi-document.d.ts +1431 -1068
  199. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  200. package/dist/schemas/v3.1/strict/openapi-document.js +45 -45
  201. package/dist/schemas/v3.1/strict/openapi-document.js.map +2 -2
  202. package/dist/schemas/v3.1/strict/operation.d.ts +43 -17
  203. package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
  204. package/dist/schemas/v3.1/strict/operation.js +1 -3
  205. package/dist/schemas/v3.1/strict/operation.js.map +2 -2
  206. package/dist/schemas/v3.1/strict/parameter.d.ts +66 -6
  207. package/dist/schemas/v3.1/strict/parameter.d.ts.map +1 -1
  208. package/dist/schemas/v3.1/strict/parameter.js +21 -17
  209. package/dist/schemas/v3.1/strict/parameter.js.map +2 -2
  210. package/dist/schemas/v3.1/strict/path-item.d.ts +38 -0
  211. package/dist/schemas/v3.1/strict/path-item.d.ts.map +1 -1
  212. package/dist/schemas/v3.1/strict/path-item.js +1 -1
  213. package/dist/schemas/v3.1/strict/path-item.js.map +2 -2
  214. package/dist/schemas/v3.1/strict/paths.d.ts +5 -0
  215. package/dist/schemas/v3.1/strict/paths.d.ts.map +1 -1
  216. package/dist/schemas/v3.1/strict/paths.js +1 -1
  217. package/dist/schemas/v3.1/strict/paths.js.map +2 -2
  218. package/dist/schemas/v3.1/strict/reference.d.ts +21 -4
  219. package/dist/schemas/v3.1/strict/reference.d.ts.map +1 -1
  220. package/dist/schemas/v3.1/strict/reference.js.map +2 -2
  221. package/dist/schemas/v3.1/strict/request-body.d.ts +10 -0
  222. package/dist/schemas/v3.1/strict/request-body.d.ts.map +1 -1
  223. package/dist/schemas/v3.1/strict/request-body.js +1 -1
  224. package/dist/schemas/v3.1/strict/request-body.js.map +2 -2
  225. package/dist/schemas/v3.1/strict/response.d.ts +17 -0
  226. package/dist/schemas/v3.1/strict/response.d.ts.map +1 -1
  227. package/dist/schemas/v3.1/strict/response.js +1 -1
  228. package/dist/schemas/v3.1/strict/response.js.map +2 -2
  229. package/dist/schemas/v3.1/strict/responses.d.ts +12 -0
  230. package/dist/schemas/v3.1/strict/responses.d.ts.map +1 -1
  231. package/dist/schemas/v3.1/strict/responses.js +1 -1
  232. package/dist/schemas/v3.1/strict/responses.js.map +2 -2
  233. package/dist/schemas/v3.1/strict/schema.d.ts +144 -1
  234. package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
  235. package/dist/schemas/v3.1/strict/schema.js +40 -60
  236. package/dist/schemas/v3.1/strict/schema.js.map +2 -2
  237. package/dist/schemas/v3.1/strict/security-requirement.d.ts +12 -0
  238. package/dist/schemas/v3.1/strict/security-requirement.d.ts.map +1 -1
  239. package/dist/schemas/v3.1/strict/security-requirement.js.map +1 -1
  240. package/dist/schemas/v3.1/strict/security-scheme.d.ts +37 -0
  241. package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
  242. package/dist/schemas/v3.1/strict/security-scheme.js.map +2 -2
  243. package/dist/schemas/v3.1/strict/server-variable.d.ts +9 -0
  244. package/dist/schemas/v3.1/strict/server-variable.d.ts.map +1 -1
  245. package/dist/schemas/v3.1/strict/server-variable.js.map +1 -1
  246. package/dist/schemas/v3.1/strict/server.d.ts +10 -0
  247. package/dist/schemas/v3.1/strict/server.d.ts.map +1 -1
  248. package/dist/schemas/v3.1/strict/server.js +1 -1
  249. package/dist/schemas/v3.1/strict/server.js.map +2 -2
  250. package/dist/schemas/v3.1/strict/tag.d.ts +13 -0
  251. package/dist/schemas/v3.1/strict/tag.d.ts.map +1 -1
  252. package/dist/schemas/v3.1/strict/tag.js +1 -1
  253. package/dist/schemas/v3.1/strict/tag.js.map +2 -2
  254. package/dist/schemas/v3.1/strict/type-guards.d.ts +1 -1
  255. package/dist/schemas/v3.1/strict/type-guards.d.ts.map +1 -1
  256. package/dist/schemas/v3.1/strict/type-guards.js.map +1 -1
  257. package/dist/schemas/v3.1/strict/xml.d.ts +17 -0
  258. package/dist/schemas/v3.1/strict/xml.d.ts.map +1 -1
  259. package/dist/schemas/v3.1/strict/xml.js.map +1 -1
  260. package/dist/schemas/workspace-specification/config.d.ts +45 -33
  261. package/dist/schemas/workspace-specification/config.d.ts.map +1 -1
  262. package/dist/schemas/workspace-specification/config.js.map +2 -2
  263. package/dist/schemas/workspace-specification/index.d.ts +55 -34
  264. package/dist/schemas/workspace-specification/index.d.ts.map +1 -1
  265. package/dist/schemas/workspace-specification/index.js.map +2 -2
  266. package/dist/schemas/workspace-specification/info.d.ts +4 -0
  267. package/dist/schemas/workspace-specification/info.d.ts.map +1 -1
  268. package/dist/schemas/workspace-specification/info.js.map +1 -1
  269. package/dist/schemas/workspace.d.ts +310 -218
  270. package/dist/schemas/workspace.d.ts.map +1 -1
  271. package/dist/schemas/workspace.js +11 -3
  272. package/dist/schemas/workspace.js.map +2 -2
  273. package/dist/server.d.ts +6 -5
  274. package/dist/server.d.ts.map +1 -1
  275. package/dist/server.js.map +2 -2
  276. package/package.json +5 -5
  277. package/dist/mutators/request-example.d.ts +0 -21
  278. package/dist/mutators/request-example.d.ts.map +0 -1
  279. package/dist/mutators/request-example.js +0 -55
  280. package/dist/mutators/request-example.js.map +0 -7
  281. package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts +0 -9
  282. package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts.map +0 -1
  283. package/dist/schemas/extensions/security/x-scalar-redirect-uri.js +0 -8
  284. package/dist/schemas/extensions/security/x-scalar-redirect-uri.js.map +0 -7
  285. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts +0 -38
  286. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts.map +0 -1
  287. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js +0 -45
  288. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js.map +0 -7
  289. package/dist/types.d.ts +0 -18
  290. package/dist/types.d.ts.map +0 -1
  291. package/dist/types.js +0 -1
  292. package/dist/types.js.map +0 -7
@@ -1,3 +1,4 @@
1
+ import type { ServerObject } from './server.js';
1
2
  /**
2
3
  * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
3
4
  *
@@ -19,4 +20,25 @@ export declare const LinkObjectSchemaDefinition: import("@scalar/typebox").TObje
19
20
  /** A server object to be used by the target operation. */
20
21
  server: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRef<"ServerObject">>;
21
22
  }>;
23
+ /**
24
+ * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.
25
+ *
26
+ * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.
27
+ *
28
+ * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.
29
+ */
30
+ export type LinkObject = {
31
+ /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */
32
+ operationRef?: string;
33
+ /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */
34
+ operationId?: string;
35
+ /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */
36
+ parameters?: Record<string, any>;
37
+ /** A literal value or {expression} to use as a request body when calling the target operation. */
38
+ requestBody?: any;
39
+ /** A description of the link. CommonMark syntax MAY be used for rich text representation. */
40
+ description?: string;
41
+ /** A server object to be used by the target operation. */
42
+ server?: ServerObject;
43
+ };
22
44
  //# sourceMappingURL=link.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/link.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;IACrC,yPAAyP;;IAEzP,2JAA2J;;IAE3J,8WAA8W;;IAE9W,kGAAkG;;IAElG,6FAA6F;;IAE7F,0DAA0D;;EAE1D,CAAA"}
1
+ {"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/link.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAE5C;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B;IACrC,yPAAyP;;IAEzP,2JAA2J;;IAE3J,8WAA8W;;IAE9W,kGAAkG;;IAElG,6FAA6F;;IAE7F,0DAA0D;;EAE1D,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,yPAAyP;IACzP,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,2JAA2J;IAC3J,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8WAA8W;IAC9W,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAChC,kGAAkG;IAClG,WAAW,CAAC,EAAE,GAAG,CAAA;IACjB,6FAA6F;IAC7F,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB,CAAA"}
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/link.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { ServerObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\n/**\n * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n *\n * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\n *\n * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.\n */\nexport const LinkObjectSchemaDefinition = Type.Object({\n /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */\n operationRef: Type.Optional(Type.String()),\n /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */\n operationId: Type.Optional(Type.String()),\n /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */\n parameters: Type.Optional(Type.Record(Type.String(), Type.Any())),\n /** A literal value or {expression} to use as a request body when calling the target operation. */\n requestBody: Type.Optional(Type.Any()),\n /** A description of the link. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** A server object to be used by the target operation. */\n server: Type.Optional(ServerObjectRef),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,uBAAuB;AASzB,MAAM,6BAA6B,KAAK,OAAO;AAAA;AAAA,EAEpD,cAAc,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEzC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,YAAY,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC;AAAA;AAAA,EAEhE,aAAa,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,EAErC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,QAAQ,KAAK,SAAS,eAAe;AACvC,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { ServerObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\nimport type { ServerObject } from './server'\n\n/**\n * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n *\n * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\n *\n * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.\n */\nexport const LinkObjectSchemaDefinition = Type.Object({\n /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */\n operationRef: Type.Optional(Type.String()),\n /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */\n operationId: Type.Optional(Type.String()),\n /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */\n parameters: Type.Optional(Type.Record(Type.String(), Type.Any())),\n /** A literal value or {expression} to use as a request body when calling the target operation. */\n requestBody: Type.Optional(Type.Any()),\n /** A description of the link. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** A server object to be used by the target operation. */\n server: Type.Optional(ServerObjectRef),\n})\n\n/**\n * The Link Object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n *\n * Unlike dynamic links (i.e. links provided in the response payload), the OAS linking mechanism does not require link information in the runtime response.\n *\n * For computing links and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.\n */\nexport type LinkObject = {\n /** A URI reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI Description. */\n operationRef?: string\n /** The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. */\n operationId?: string\n /** A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. path.id for an id parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. */\n parameters?: Record<string, any>\n /** A literal value or {expression} to use as a request body when calling the target operation. */\n requestBody?: any\n /** A description of the link. CommonMark syntax MAY be used for rich text representation. */\n description?: string\n /** A server object to be used by the target operation. */\n server?: ServerObject\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,uBAAuB;AAWzB,MAAM,6BAA6B,KAAK,OAAO;AAAA;AAAA,EAEpD,cAAc,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEzC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,YAAY,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,IAAI,CAAC,CAAC;AAAA;AAAA,EAEhE,aAAa,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,EAErC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,QAAQ,KAAK,SAAS,eAAe;AACvC,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,7 @@
1
+ import type { EncodingObject } from './encoding.js';
2
+ import type { ExampleObject } from './example.js';
3
+ import { type ReferenceType } from './reference.js';
4
+ import type { SchemaObject } from './schema.js';
1
5
  /**
2
6
  * Each Media Type Object provides schema and examples for the media type identified by its key.
3
7
  *
@@ -31,4 +35,19 @@ export declare const MediaTypeObjectSchemaDefinition: import("@scalar/typebox").
31
35
  /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
32
36
  encoding: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"EncodingObject">>>;
33
37
  }>;
38
+ /**
39
+ * Each Media Type Object provides schema and examples for the media type identified by its key.
40
+ *
41
+ * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.
42
+ */
43
+ export type MediaTypeObject = {
44
+ /** The schema defining the content of the request, response, parameter, or header. */
45
+ schema?: ReferenceType<SchemaObject>;
46
+ /** Example of the media type */
47
+ example?: any;
48
+ /** Examples of the media type */
49
+ examples?: Record<string, ReferenceType<ExampleObject>>;
50
+ /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */
51
+ encoding?: Record<string, EncodingObject>;
52
+ };
34
53
  //# sourceMappingURL=media-type.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"media-type.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/media-type.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,eAAO,MAAM,+BAA+B;IAC1C,sFAAsF;;;;;;;;;;;IAEtF,gCAAgC;;IAEhC,iCAAiC;;;;;;;;;;;IAEjC,gaAAga;;EAEha,CAAA"}
1
+ {"version":3,"file":"media-type.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/media-type.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAE9C,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAE5C;;;;GAIG;AACH,eAAO,MAAM,+BAA+B;IAC1C,sFAAsF;;;;;;;;;;;IAEtF,gCAAgC;;IAEhC,iCAAiC;;;;;;;;;;;IAEjC,gaAAga;;EAEha,CAAA;AAEF;;;;GAIG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sFAAsF;IACtF,MAAM,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACpC,gCAAgC;IAChC,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;IACvD,gaAAga;IACha,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;CAC1C,CAAA"}
@@ -1,6 +1,6 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
3
- import { reference } from "../../../schemas/v3.1/strict/reference.js";
2
+ import { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from "./ref-definitions.js";
3
+ import { reference } from "./reference.js";
4
4
  const MediaTypeObjectSchemaDefinition = Type.Object({
5
5
  /** The schema defining the content of the request, response, parameter, or header. */
6
6
  schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/media-type.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\nimport { reference } from '@/schemas/v3.1/strict/reference'\n\n/**\n * Each Media Type Object provides schema and examples for the media type identified by its key.\n *\n * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.\n */\nexport const MediaTypeObjectSchemaDefinition = Type.Object({\n /** The schema defining the content of the request, response, parameter, or header. */\n schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),\n /** Example of the media type */\n example: Type.Optional(Type.Any()),\n /** Examples of the media type */\n examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),\n /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */\n encoding: Type.Optional(Type.Record(Type.String(), EncodingObjectRef)),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,mBAAmB,kBAAkB,uBAAuB;AACrE,SAAS,iBAAiB;AAOnB,MAAM,kCAAkC,KAAK,OAAO;AAAA;AAAA,EAEzD,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC;AAAA;AAAA,EAE/E,SAAS,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,EAEjC,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,kBAAkB,UAAU,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,EAE/G,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,iBAAiB,CAAC;AACvE,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport type { EncodingObject } from './encoding'\nimport type { ExampleObject } from './example'\nimport { EncodingObjectRef, ExampleObjectRef, SchemaObjectRef } from './ref-definitions'\nimport { type ReferenceType, reference } from './reference'\nimport type { SchemaObject } from './schema'\n\n/**\n * Each Media Type Object provides schema and examples for the media type identified by its key.\n *\n * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.\n */\nexport const MediaTypeObjectSchemaDefinition = Type.Object({\n /** The schema defining the content of the request, response, parameter, or header. */\n schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),\n /** Example of the media type */\n example: Type.Optional(Type.Any()),\n /** Examples of the media type */\n examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),\n /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */\n encoding: Type.Optional(Type.Record(Type.String(), EncodingObjectRef)),\n})\n\n/**\n * Each Media Type Object provides schema and examples for the media type identified by its key.\n *\n * When example or examples are provided, the example SHOULD match the specified schema and be in the correct format as specified by the media type and its encoding. The example and examples fields are mutually exclusive, and if either is present it SHALL override any example in the schema. See Working With Examples for further guidance regarding the different ways of specifying examples, including non-JSON/YAML values.\n */\nexport type MediaTypeObject = {\n /** The schema defining the content of the request, response, parameter, or header. */\n schema?: ReferenceType<SchemaObject>\n /** Example of the media type */\n example?: any\n /** Examples of the media type */\n examples?: Record<string, ReferenceType<ExampleObject>>\n /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding field SHALL only apply to Request Body Objects, and only when the media type is multipart or application/x-www-form-urlencoded. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. */\n encoding?: Record<string, EncodingObject>\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAIrB,SAAS,mBAAmB,kBAAkB,uBAAuB;AACrE,SAA6B,iBAAiB;AAQvC,MAAM,kCAAkC,KAAK,OAAO;AAAA;AAAA,EAEzD,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC;AAAA;AAAA,EAE/E,SAAS,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,EAEjC,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,kBAAkB,UAAU,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,EAE/G,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,iBAAiB,CAAC;AACvE,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,4 +1,16 @@
1
- import { type Static } from '@scalar/typebox';
1
+ import { type XScalarCredentialsLocation } from '../../../schemas/extensions/security/x-scalar-credentials-location.js';
2
+ import { type XScalarSecurityBody } from '../../../schemas/extensions/security/x-scalar-security-body.js';
3
+ import { type XScalarSecurityQuery } from '../../../schemas/extensions/security/x-scalar-security-query.js';
4
+ import { type XScalarSecretClientId, type XScalarSecretClientSecret, type XScalarSecretHTTP, type XScalarSecretRedirectUri, type XScalarSecretToken } from '../../../schemas/extensions/security/x-scalar-security-secrets.js';
5
+ import { type XTokenName } from '../../../schemas/extensions/security/x-tokenName.js';
6
+ import { type XusePkce } from '../../../schemas/extensions/security/x-use-pkce.js';
7
+ /** Common properties used across all OAuth flows */
8
+ type OAuthFlowCommon = {
9
+ /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
10
+ refreshUrl: string;
11
+ /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */
12
+ scopes: Record<string, string>;
13
+ } & XScalarSecretClientId & XScalarSecretToken & XScalarSecurityQuery & XScalarSecurityBody & XTokenName & XScalarCredentialsLocation;
2
14
  /** Configuration for the OAuth Implicit flow */
3
15
  export declare const OAuthFlowImplicitSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
4
16
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
@@ -23,6 +35,11 @@ export declare const OAuthFlowImplicitSchema: import("@scalar/typebox").TInterse
23
35
  }>, import("@scalar/typebox").TObject<{
24
36
  'x-scalar-secret-redirect-uri': import("@scalar/typebox").TString;
25
37
  }>]>;
38
+ /** Configuration for the OAuth Implicit flow */
39
+ export type OAuthFlowImplicit = OAuthFlowCommon & {
40
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
41
+ authorizationUrl: string;
42
+ } & XScalarSecretRedirectUri;
26
43
  /** Configuration for the OAuth Resource Owner Password flow */
27
44
  export declare const OAuthFlowPasswordSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
28
45
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
@@ -50,6 +67,11 @@ export declare const OAuthFlowPasswordSchema: import("@scalar/typebox").TInterse
50
67
  }>, import("@scalar/typebox").TObject<{
51
68
  'x-scalar-secret-client-secret': import("@scalar/typebox").TString;
52
69
  }>]>;
70
+ /** Configuration for the OAuth Resource Owner Password flow */
71
+ export type OAuthFlowPassword = OAuthFlowCommon & {
72
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
73
+ tokenUrl: string;
74
+ } & XScalarSecretHTTP & XScalarSecretClientSecret;
53
75
  /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
54
76
  export declare const OAuthFlowClientCredentialsSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
55
77
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
@@ -74,6 +96,11 @@ export declare const OAuthFlowClientCredentialsSchema: import("@scalar/typebox")
74
96
  }>, import("@scalar/typebox").TObject<{
75
97
  'x-scalar-secret-client-secret': import("@scalar/typebox").TString;
76
98
  }>]>;
99
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
100
+ export type OAuthFlowClientCredentials = OAuthFlowCommon & {
101
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
102
+ tokenUrl: string;
103
+ } & XScalarSecretClientSecret;
77
104
  /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
78
105
  export declare const OAuthFlowAuthorizationCodeSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
79
106
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
@@ -104,6 +131,13 @@ export declare const OAuthFlowAuthorizationCodeSchema: import("@scalar/typebox")
104
131
  }>, import("@scalar/typebox").TObject<{
105
132
  'x-usePkce': import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"SHA-256">, import("@scalar/typebox").TLiteral<"plain">, import("@scalar/typebox").TLiteral<"no">]>;
106
133
  }>]>;
134
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
135
+ export type OAuthFlowAuthorizationCode = OAuthFlowCommon & {
136
+ /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
137
+ authorizationUrl: string;
138
+ /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
139
+ tokenUrl: string;
140
+ } & XScalarSecretClientSecret & XScalarSecretRedirectUri & XusePkce;
107
141
  /** Union of all OAuth flow schemas */
108
142
  export declare const OAuthFlowObjectSchemaDefinition: import("@scalar/typebox").TUnion<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
109
143
  /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */
@@ -203,9 +237,6 @@ export declare const OAuthFlowObjectSchemaDefinition: import("@scalar/typebox").
203
237
  }>, import("@scalar/typebox").TObject<{
204
238
  'x-usePkce': import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"SHA-256">, import("@scalar/typebox").TLiteral<"plain">, import("@scalar/typebox").TLiteral<"no">]>;
205
239
  }>]>]>;
206
- export type OAuthFlowImplicit = Static<typeof OAuthFlowImplicitSchema>;
207
- export type OAuthFlowPassword = Static<typeof OAuthFlowPasswordSchema>;
208
- export type OAuthFlowClientCredentials = Static<typeof OAuthFlowClientCredentialsSchema>;
209
- export type OAuthFlowAuthorizationCode = Static<typeof OAuthFlowAuthorizationCodeSchema>;
210
240
  export type OAuthFlow = OAuthFlowImplicit | OAuthFlowPassword | OAuthFlowClientCredentials | OAuthFlowAuthorizationCode;
241
+ export {};
211
242
  //# sourceMappingURL=oauth-flow.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"oauth-flow.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/oauth-flow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAQ,MAAM,iBAAiB,CAAA;AAgCnD,gDAAgD;AAChD,eAAO,MAAM,uBAAuB;IAdhC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAexJ,gJAAgJ;;;;IAInJ,CAAA;AAED,+DAA+D;AAC/D,eAAO,MAAM,uBAAuB;IAxBhC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAyBxJ,wIAAwI;;;;;;;IAK3I,CAAA;AAED,yGAAyG;AACzG,eAAO,MAAM,gCAAgC;IAnCzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAoCxJ,wIAAwI;;;;IAI3I,CAAA;AAED,wGAAwG;AACxG,eAAO,MAAM,gCAAgC;IA7CzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8CxJ,gJAAgJ;;IAEhJ,wIAAwI;;;;;;;;IAM3I,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,+BAA+B;IA3DxC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAexJ,gJAAgJ;;;;;IAjBhJ,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAyBxJ,wIAAwI;;;;;;;;IA3BxI,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IAoCxJ,wIAAwI;;;;;IAtCxI,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8CxJ,gJAAgJ;;IAEhJ,wIAAwI;;;;;;;;MAc1I,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACtE,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,uBAAuB,CAAC,CAAA;AACtE,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,OAAO,gCAAgC,CAAC,CAAA;AACxF,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAExF,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,0BAA0B,GAAG,0BAA0B,CAAA"}
1
+ {"version":3,"file":"oauth-flow.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/oauth-flow.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,0BAA0B,EAEhC,MAAM,6DAA6D,CAAA;AACpE,OAAO,EACL,KAAK,mBAAmB,EAEzB,MAAM,sDAAsD,CAAA;AAC7D,OAAO,EACL,KAAK,oBAAoB,EAE1B,MAAM,uDAAuD,CAAA;AAC9D,OAAO,EACL,KAAK,qBAAqB,EAE1B,KAAK,yBAAyB,EAE9B,KAAK,iBAAiB,EAEtB,KAAK,wBAAwB,EAE7B,KAAK,kBAAkB,EAExB,MAAM,yDAAyD,CAAA;AAChE,OAAO,EAAE,KAAK,UAAU,EAAoB,MAAM,2CAA2C,CAAA;AAC7F,OAAO,EAAE,KAAK,QAAQ,EAAkB,MAAM,0CAA0C,CAAA;AAkBxF,oDAAoD;AACpD,KAAK,eAAe,GAAG;IACrB,uIAAuI;IACvI,UAAU,EAAE,MAAM,CAAA;IAClB,wJAAwJ;IACxJ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B,GAAG,qBAAqB,GACvB,kBAAkB,GAClB,oBAAoB,GACpB,mBAAmB,GACnB,UAAU,GACV,0BAA0B,CAAA;AAE5B,gDAAgD;AAChD,eAAO,MAAM,uBAAuB;IA3BhC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA4BxJ,gJAAgJ;;;;IAInJ,CAAA;AAED,gDAAgD;AAChD,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG;IAChD,gJAAgJ;IAChJ,gBAAgB,EAAE,MAAM,CAAA;CACzB,GAAG,wBAAwB,CAAA;AAE5B,+DAA+D;AAC/D,eAAO,MAAM,uBAAuB;IA3ChC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA4CxJ,wIAAwI;;;;;;;IAK3I,CAAA;AAED,+DAA+D;AAC/D,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG;IAChD,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,iBAAiB,GACnB,yBAAyB,CAAA;AAE3B,yGAAyG;AACzG,eAAO,MAAM,gCAAgC;IA7DzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8DxJ,wIAAwI;;;;IAI3I,CAAA;AAED,yGAAyG;AACzG,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG;IACzD,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,yBAAyB,CAAA;AAE7B,wGAAwG;AACxG,eAAO,MAAM,gCAAgC;IA7EzC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8ExJ,gJAAgJ;;IAEhJ,wIAAwI;;;;;;;;IAM3I,CAAA;AAED,wGAAwG;AACxG,MAAM,MAAM,0BAA0B,GAAG,eAAe,GAAG;IACzD,gJAAgJ;IAChJ,gBAAgB,EAAE,MAAM,CAAA;IACxB,wIAAwI;IACxI,QAAQ,EAAE,MAAM,CAAA;CACjB,GAAG,yBAAyB,GAC3B,wBAAwB,GACxB,QAAQ,CAAA;AAEV,sCAAsC;AACtC,eAAO,MAAM,+BAA+B;IArGxC,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA4BxJ,gJAAgJ;;;;;IA9BhJ,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA4CxJ,wIAAwI;;;;;;;;IA9CxI,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8DxJ,wIAAwI;;;;;IAhExI,uIAAuI;;IAEvI,wJAAwJ;;;;;;;;;;;;;;;IA8ExJ,gJAAgJ;;IAEhJ,wIAAwI;;;;;;;;MAwB1I,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,0BAA0B,GAAG,0BAA0B,CAAA"}
@@ -1,8 +1,14 @@
1
1
  import { Type } from "@scalar/typebox";
2
2
  import { compose } from "../../../schemas/compose.js";
3
- import { XScalarCredentialsLocationSchema } from "../../../schemas/extensions/security/x-scalar-credentials-location.js";
4
- import { XScalarSecurityBody } from "../../../schemas/extensions/security/x-scalar-security-body.js";
5
- import { XScalarSecurityQuery } from "../../../schemas/extensions/security/x-scalar-security-query.js";
3
+ import {
4
+ XScalarCredentialsLocationSchema
5
+ } from "../../../schemas/extensions/security/x-scalar-credentials-location.js";
6
+ import {
7
+ XScalarSecurityBodySchema
8
+ } from "../../../schemas/extensions/security/x-scalar-security-body.js";
9
+ import {
10
+ XScalarSecurityQuerySchema
11
+ } from "../../../schemas/extensions/security/x-scalar-security-query.js";
6
12
  import {
7
13
  XScalarSecretClientIdSchema,
8
14
  XScalarSecretClientSecretSchema,
@@ -10,7 +16,7 @@ import {
10
16
  XScalarSecretRedirectUriSchema,
11
17
  XScalarSecretTokenSchema
12
18
  } from "../../../schemas/extensions/security/x-scalar-security-secrets.js";
13
- import { XTokenName } from "../../../schemas/extensions/security/x-tokenName.js";
19
+ import { XTokenNameSchema } from "../../../schemas/extensions/security/x-tokenName.js";
14
20
  import { XusePkceSchema } from "../../../schemas/extensions/security/x-use-pkce.js";
15
21
  const OAuthFlowCommonSchema = compose(
16
22
  Type.Object({
@@ -21,9 +27,9 @@ const OAuthFlowCommonSchema = compose(
21
27
  }),
22
28
  XScalarSecretClientIdSchema,
23
29
  XScalarSecretTokenSchema,
24
- XScalarSecurityQuery,
25
- XScalarSecurityBody,
26
- XTokenName,
30
+ XScalarSecurityQuerySchema,
31
+ XScalarSecurityBodySchema,
32
+ XTokenNameSchema,
27
33
  XScalarCredentialsLocationSchema
28
34
  );
29
35
  const OAuthFlowImplicitSchema = compose(
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/oauth-flow.ts"],
4
- "sourcesContent": ["import { type Static, Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport { XScalarCredentialsLocationSchema } from '@/schemas/extensions/security/x-scalar-credentials-location'\nimport { XScalarSecurityBody } from '@/schemas/extensions/security/x-scalar-security-body'\nimport { XScalarSecurityQuery } from '@/schemas/extensions/security/x-scalar-security-query'\nimport {\n XScalarSecretClientIdSchema,\n XScalarSecretClientSecretSchema,\n XScalarSecretHTTPSchema,\n XScalarSecretRedirectUriSchema,\n XScalarSecretTokenSchema,\n} from '@/schemas/extensions/security/x-scalar-security-secrets'\nimport { XTokenName } from '@/schemas/extensions/security/x-tokenName'\nimport { XusePkceSchema } from '@/schemas/extensions/security/x-use-pkce'\n\n/** Common properties used across all OAuth flows */\nconst OAuthFlowCommonSchema = compose(\n Type.Object({\n /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n refreshUrl: Type.String(),\n /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */\n scopes: Type.Record(Type.String(), Type.String()),\n }),\n XScalarSecretClientIdSchema,\n XScalarSecretTokenSchema,\n XScalarSecurityQuery,\n XScalarSecurityBody,\n XTokenName,\n XScalarCredentialsLocationSchema,\n)\n\n/** Configuration for the OAuth Implicit flow */\nexport const OAuthFlowImplicitSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: Type.String(),\n }),\n XScalarSecretRedirectUriSchema,\n)\n\n/** Configuration for the OAuth Resource Owner Password flow */\nexport const OAuthFlowPasswordSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretHTTPSchema,\n XScalarSecretClientSecretSchema,\n)\n\n/** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\nexport const OAuthFlowClientCredentialsSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretClientSecretSchema,\n)\n\n/** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\nexport const OAuthFlowAuthorizationCodeSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: Type.String(),\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretClientSecretSchema,\n XScalarSecretRedirectUriSchema,\n XusePkceSchema,\n)\n\n/** Union of all OAuth flow schemas */\nexport const OAuthFlowObjectSchemaDefinition = Type.Union([\n OAuthFlowImplicitSchema,\n OAuthFlowPasswordSchema,\n OAuthFlowClientCredentialsSchema,\n OAuthFlowAuthorizationCodeSchema,\n])\n\nexport type OAuthFlowImplicit = Static<typeof OAuthFlowImplicitSchema>\nexport type OAuthFlowPassword = Static<typeof OAuthFlowPasswordSchema>\nexport type OAuthFlowClientCredentials = Static<typeof OAuthFlowClientCredentialsSchema>\nexport type OAuthFlowAuthorizationCode = Static<typeof OAuthFlowAuthorizationCodeSchema>\n\nexport type OAuthFlow = OAuthFlowImplicit | OAuthFlowPassword | OAuthFlowClientCredentials | OAuthFlowAuthorizationCode\n"],
5
- "mappings": "AAAA,SAAsB,YAAY;AAElC,SAAS,eAAe;AACxB,SAAS,wCAAwC;AACjD,SAAS,2BAA2B;AACpC,SAAS,4BAA4B;AACrC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAS,kBAAkB;AAC3B,SAAS,sBAAsB;AAG/B,MAAM,wBAAwB;AAAA,EAC5B,KAAK,OAAO;AAAA;AAAA,IAEV,YAAY,KAAK,OAAO;AAAA;AAAA,IAExB,QAAQ,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,OAAO,CAAC;AAAA,EAClD,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAGO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,kBAAkB,KAAK,OAAO;AAAA,EAChC,CAAC;AAAA,EACD;AACF;AAGO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AAAA,EACA;AACF;AAGO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AACF;AAGO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,kBAAkB,KAAK,OAAO;AAAA;AAAA,IAE9B,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AACF;AAGO,MAAM,kCAAkC,KAAK,MAAM;AAAA,EACxD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport {\n type XScalarCredentialsLocation,\n XScalarCredentialsLocationSchema,\n} from '@/schemas/extensions/security/x-scalar-credentials-location'\nimport {\n type XScalarSecurityBody,\n XScalarSecurityBodySchema,\n} from '@/schemas/extensions/security/x-scalar-security-body'\nimport {\n type XScalarSecurityQuery,\n XScalarSecurityQuerySchema,\n} from '@/schemas/extensions/security/x-scalar-security-query'\nimport {\n type XScalarSecretClientId,\n XScalarSecretClientIdSchema,\n type XScalarSecretClientSecret,\n XScalarSecretClientSecretSchema,\n type XScalarSecretHTTP,\n XScalarSecretHTTPSchema,\n type XScalarSecretRedirectUri,\n XScalarSecretRedirectUriSchema,\n type XScalarSecretToken,\n XScalarSecretTokenSchema,\n} from '@/schemas/extensions/security/x-scalar-security-secrets'\nimport { type XTokenName, XTokenNameSchema } from '@/schemas/extensions/security/x-tokenName'\nimport { type XusePkce, XusePkceSchema } from '@/schemas/extensions/security/x-use-pkce'\n\n/** Common properties used across all OAuth flows */\nconst OAuthFlowCommonSchema = compose(\n Type.Object({\n /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n refreshUrl: Type.String(),\n /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */\n scopes: Type.Record(Type.String(), Type.String()),\n }),\n XScalarSecretClientIdSchema,\n XScalarSecretTokenSchema,\n XScalarSecurityQuerySchema,\n XScalarSecurityBodySchema,\n XTokenNameSchema,\n XScalarCredentialsLocationSchema,\n)\n\n/** Common properties used across all OAuth flows */\ntype OAuthFlowCommon = {\n /** The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n refreshUrl: string\n /** REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. */\n scopes: Record<string, string>\n} & XScalarSecretClientId &\n XScalarSecretToken &\n XScalarSecurityQuery &\n XScalarSecurityBody &\n XTokenName &\n XScalarCredentialsLocation\n\n/** Configuration for the OAuth Implicit flow */\nexport const OAuthFlowImplicitSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: Type.String(),\n }),\n XScalarSecretRedirectUriSchema,\n)\n\n/** Configuration for the OAuth Implicit flow */\nexport type OAuthFlowImplicit = OAuthFlowCommon & {\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: string\n} & XScalarSecretRedirectUri\n\n/** Configuration for the OAuth Resource Owner Password flow */\nexport const OAuthFlowPasswordSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretHTTPSchema,\n XScalarSecretClientSecretSchema,\n)\n\n/** Configuration for the OAuth Resource Owner Password flow */\nexport type OAuthFlowPassword = OAuthFlowCommon & {\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: string\n} & XScalarSecretHTTP &\n XScalarSecretClientSecret\n\n/** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\nexport const OAuthFlowClientCredentialsSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretClientSecretSchema,\n)\n\n/** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\nexport type OAuthFlowClientCredentials = OAuthFlowCommon & {\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: string\n} & XScalarSecretClientSecret\n\n/** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\nexport const OAuthFlowAuthorizationCodeSchema = compose(\n OAuthFlowCommonSchema,\n Type.Object({\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: Type.String(),\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: Type.String(),\n }),\n XScalarSecretClientSecretSchema,\n XScalarSecretRedirectUriSchema,\n XusePkceSchema,\n)\n\n/** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\nexport type OAuthFlowAuthorizationCode = OAuthFlowCommon & {\n /** REQUIRED. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n authorizationUrl: string\n /** REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. */\n tokenUrl: string\n} & XScalarSecretClientSecret &\n XScalarSecretRedirectUri &\n XusePkce\n\n/** Union of all OAuth flow schemas */\nexport const OAuthFlowObjectSchemaDefinition = Type.Union([\n OAuthFlowImplicitSchema,\n OAuthFlowPasswordSchema,\n OAuthFlowClientCredentialsSchema,\n OAuthFlowAuthorizationCodeSchema,\n])\n\nexport type OAuthFlow = OAuthFlowImplicit | OAuthFlowPassword | OAuthFlowClientCredentials | OAuthFlowAuthorizationCode\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,eAAe;AACxB;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EAEE;AAAA,OACK;AACP;AAAA,EAEE;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,OACK;AACP,SAA0B,wBAAwB;AAClD,SAAwB,sBAAsB;AAG9C,MAAM,wBAAwB;AAAA,EAC5B,KAAK,OAAO;AAAA;AAAA,IAEV,YAAY,KAAK,OAAO;AAAA;AAAA,IAExB,QAAQ,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,OAAO,CAAC;AAAA,EAClD,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAgBO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,kBAAkB,KAAK,OAAO;AAAA,EAChC,CAAC;AAAA,EACD;AACF;AASO,MAAM,0BAA0B;AAAA,EACrC;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AAAA,EACA;AACF;AAUO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AACF;AASO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,kBAAkB,KAAK,OAAO;AAAA;AAAA,IAE9B,UAAU,KAAK,OAAO;AAAA,EACxB,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AACF;AAaO,MAAM,kCAAkC,KAAK,MAAM;AAAA,EACxD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,4 @@
1
+ import { type OAuthFlowAuthorizationCode, type OAuthFlowClientCredentials, type OAuthFlowImplicit, type OAuthFlowPassword } from './oauth-flow.js';
1
2
  /**
2
3
  * Allows configuration of the supported OAuth Flows.
3
4
  */
@@ -95,4 +96,14 @@ export declare const OAuthFlowsObjectSchemaDefinition: import("@scalar/typebox")
95
96
  'x-usePkce': import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"SHA-256">, import("@scalar/typebox").TLiteral<"plain">, import("@scalar/typebox").TLiteral<"no">]>;
96
97
  }>]>>;
97
98
  }>;
99
+ export type OAuthFlowsObject = {
100
+ /** Configuration for the OAuth Implicit flow */
101
+ implicit?: OAuthFlowImplicit;
102
+ /** Configuration for the OAuth Resource Owner Password flow */
103
+ password?: OAuthFlowPassword;
104
+ /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */
105
+ clientCredentials?: OAuthFlowClientCredentials;
106
+ /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */
107
+ authorizationCode?: OAuthFlowAuthorizationCode;
108
+ };
98
109
  //# sourceMappingURL=oauthflows.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"oauthflows.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/oauthflows.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,eAAO,MAAM,gCAAgC;IAC3C,gDAAgD;;;;;;;;;;;;;;;;;;;;;IAEhD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;IAE/D,yGAAyG;;;;;;;;;;;;;;;;;;;;;IAEzG,wGAAwG;;;;;;;;;;;;;;;;;;;;;;;;;;EAExG,CAAA"}
1
+ {"version":3,"file":"oauthflows.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/oauthflows.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,0BAA0B,EAE/B,KAAK,0BAA0B,EAE/B,KAAK,iBAAiB,EAEtB,KAAK,iBAAiB,EAEvB,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,eAAO,MAAM,gCAAgC;IAC3C,gDAAgD;;;;;;;;;;;;;;;;;;;;;IAEhD,+DAA+D;;;;;;;;;;;;;;;;;;;;;;;;IAE/D,yGAAyG;;;;;;;;;;;;;;;;;;;;;IAEzG,wGAAwG;;;;;;;;;;;;;;;;;;;;;;;;;;EAExG,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,yGAAyG;IACzG,iBAAiB,CAAC,EAAE,0BAA0B,CAAA;IAC9C,wGAAwG;IACxG,iBAAiB,CAAC,EAAE,0BAA0B,CAAA;CAC/C,CAAA"}
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/oauthflows.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport {\n OAuthFlowAuthorizationCodeSchema,\n OAuthFlowClientCredentialsSchema,\n OAuthFlowImplicitSchema,\n OAuthFlowPasswordSchema,\n} from './oauth-flow'\n\n/**\n * Allows configuration of the supported OAuth Flows.\n */\nexport const OAuthFlowsObjectSchemaDefinition = Type.Object({\n /** Configuration for the OAuth Implicit flow */\n implicit: Type.Optional(OAuthFlowImplicitSchema),\n /** Configuration for the OAuth Resource Owner Password flow */\n password: Type.Optional(OAuthFlowPasswordSchema),\n /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\n clientCredentials: Type.Optional(OAuthFlowClientCredentialsSchema),\n /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\n authorizationCode: Type.Optional(OAuthFlowAuthorizationCodeSchema),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAKA,MAAM,mCAAmC,KAAK,OAAO;AAAA;AAAA,EAE1D,UAAU,KAAK,SAAS,uBAAuB;AAAA;AAAA,EAE/C,UAAU,KAAK,SAAS,uBAAuB;AAAA;AAAA,EAE/C,mBAAmB,KAAK,SAAS,gCAAgC;AAAA;AAAA,EAEjE,mBAAmB,KAAK,SAAS,gCAAgC;AACnE,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport {\n type OAuthFlowAuthorizationCode,\n OAuthFlowAuthorizationCodeSchema,\n type OAuthFlowClientCredentials,\n OAuthFlowClientCredentialsSchema,\n type OAuthFlowImplicit,\n OAuthFlowImplicitSchema,\n type OAuthFlowPassword,\n OAuthFlowPasswordSchema,\n} from './oauth-flow'\n\n/**\n * Allows configuration of the supported OAuth Flows.\n */\nexport const OAuthFlowsObjectSchemaDefinition = Type.Object({\n /** Configuration for the OAuth Implicit flow */\n implicit: Type.Optional(OAuthFlowImplicitSchema),\n /** Configuration for the OAuth Resource Owner Password flow */\n password: Type.Optional(OAuthFlowPasswordSchema),\n /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\n clientCredentials: Type.Optional(OAuthFlowClientCredentialsSchema),\n /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\n authorizationCode: Type.Optional(OAuthFlowAuthorizationCodeSchema),\n})\n\nexport type OAuthFlowsObject = {\n /** Configuration for the OAuth Implicit flow */\n implicit?: OAuthFlowImplicit\n /** Configuration for the OAuth Resource Owner Password flow */\n password?: OAuthFlowPassword\n /** Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0. */\n clientCredentials?: OAuthFlowClientCredentials\n /** Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0. */\n authorizationCode?: OAuthFlowAuthorizationCode\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB;AAAA,EAEE;AAAA,EAEA;AAAA,EAEA;AAAA,EAEA;AAAA,OACK;AAKA,MAAM,mCAAmC,KAAK,OAAO;AAAA;AAAA,EAE1D,UAAU,KAAK,SAAS,uBAAuB;AAAA;AAAA,EAE/C,UAAU,KAAK,SAAS,uBAAuB;AAAA;AAAA,EAE/C,mBAAmB,KAAK,SAAS,gCAAgC;AAAA;AAAA,EAEjE,mBAAmB,KAAK,SAAS,gCAAgC;AACnE,CAAC;",
6
6
  "names": []
7
7
  }