@scalar/api-reference 1.28.33 → 1.29.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. package/CHANGELOG.md +83 -0
  2. package/dist/browser/standalone.js +12818 -13331
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/components/Anchor/Anchor.vue.d.ts.map +1 -1
  5. package/dist/components/Anchor/Anchor.vue.js +2 -2
  6. package/dist/components/Anchor/Anchor.vue2.js +24 -22
  7. package/dist/components/ApiReferenceLayout.vue.d.ts +2 -2
  8. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  9. package/dist/components/ApiReferenceLayout.vue.js +2 -2
  10. package/dist/components/ApiReferenceLayout.vue2.js +50 -50
  11. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
  12. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +2 -2
  13. package/dist/components/Content/ClientLibraries/ClientLibraries.vue2.js +5 -5
  14. package/dist/components/Content/ClientLibraries/useFeaturedHttpClients.d.ts +1 -1
  15. package/dist/components/Content/ClientLibraries/useFeaturedHttpClients.d.ts.map +1 -1
  16. package/dist/components/Content/Content.vue.js +2 -2
  17. package/dist/components/Content/Content.vue2.js +31 -32
  18. package/dist/components/Content/Introduction/Introduction.vue.js +1 -1
  19. package/dist/components/Content/Introduction/Introduction.vue2.js +21 -21
  20. package/dist/components/Content/Lazy/Loading.vue.js +22 -22
  21. package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
  22. package/dist/components/Content/Models/Models.vue.js +2 -2
  23. package/dist/components/Content/Models/Models.vue2.js +17 -17
  24. package/dist/components/Content/Models/ModelsAccordion.vue.d.ts.map +1 -1
  25. package/dist/components/Content/Models/ModelsAccordion.vue.js +2 -2
  26. package/dist/components/Content/Models/ModelsAccordion.vue2.js +14 -14
  27. package/dist/components/Content/Schema/Schema.preview.d.ts +98 -15
  28. package/dist/components/Content/Schema/Schema.preview.d.ts.map +1 -1
  29. package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
  30. package/dist/components/Content/Schema/Schema.vue.js +2 -2
  31. package/dist/components/Content/Schema/Schema.vue2.js +2 -1
  32. package/dist/components/Content/Schema/{SchemaDiscriminator.vue.d.ts → SchemaComposition.vue.d.ts} +3 -2
  33. package/dist/components/Content/Schema/SchemaComposition.vue.d.ts.map +1 -0
  34. package/dist/components/Content/Schema/SchemaComposition.vue.js +187 -0
  35. package/dist/components/Content/Schema/SchemaComposition.vue2.js +4 -0
  36. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +1 -1
  37. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts.map +1 -1
  38. package/dist/components/Content/Schema/SchemaProperty.vue.js +2 -2
  39. package/dist/components/Content/Schema/SchemaProperty.vue2.js +31 -30
  40. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts +0 -1
  41. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.d.ts.map +1 -1
  42. package/dist/components/Content/Schema/SchemaPropertyExamples.vue.js +3 -3
  43. package/dist/components/Content/Schema/SchemaPropertyExamples.vue2.js +8 -9
  44. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
  45. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +1 -1
  46. package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +165 -146
  47. package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts +1 -1
  48. package/dist/components/Content/Schema/helpers/merge-all-of-schemas.d.ts.map +1 -1
  49. package/dist/components/Content/Schema/helpers/merge-all-of-schemas.js +50 -40
  50. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts +3 -2
  51. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.d.ts.map +1 -1
  52. package/dist/components/Content/Schema/helpers/optimizeValueForDisplay.js +13 -13
  53. package/dist/components/Content/Schema/helpers/schema-composition.d.ts +12 -0
  54. package/dist/components/Content/Schema/helpers/schema-composition.d.ts.map +1 -0
  55. package/dist/components/Content/Schema/helpers/schema-composition.js +8 -0
  56. package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts +4 -0
  57. package/dist/components/Content/Schema/helpers/schema-discriminator.d.ts.map +1 -0
  58. package/dist/components/Content/Tag/OperationsListItem.vue.js +1 -1
  59. package/dist/components/Content/Tag/OperationsListItem.vue2.js +1 -1
  60. package/dist/components/Content/Tag/TagAccordion.vue.js +2 -2
  61. package/dist/components/Content/Tag/TagAccordion.vue2.js +10 -10
  62. package/dist/components/Content/Tag/TagList.vue.d.ts.map +1 -1
  63. package/dist/components/Content/Tag/TagList.vue.js +8 -8
  64. package/dist/components/Content/Tag/TagSection.vue.d.ts.map +1 -1
  65. package/dist/components/Content/Tag/TagSection.vue.js +2 -2
  66. package/dist/components/Content/Tag/TagSection.vue2.js +8 -8
  67. package/dist/components/GettingStarted.vue.d.ts +2 -2
  68. package/dist/components/Layouts/Layouts.vue.d.ts +3 -0
  69. package/dist/components/Layouts/Layouts.vue.d.ts.map +1 -1
  70. package/dist/components/Layouts/Layouts.vue.js +14 -23
  71. package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
  72. package/dist/components/Layouts/ModernLayout.vue.js +2 -2
  73. package/dist/components/Layouts/ModernLayout.vue2.js +51 -45
  74. package/dist/components/MobileHeader.vue.js +3 -3
  75. package/dist/components/Section/CompactSection.vue.js +2 -2
  76. package/dist/components/Section/CompactSection.vue2.js +4 -4
  77. package/dist/components/Section/Section.vue.d.ts.map +1 -1
  78. package/dist/components/Section/Section.vue.js +1 -1
  79. package/dist/components/ShowMoreButton.vue.d.ts.map +1 -1
  80. package/dist/components/ShowMoreButton.vue.js +2 -2
  81. package/dist/components/Sidebar/Sidebar.vue.d.ts +1 -1
  82. package/dist/components/Sidebar/Sidebar.vue.d.ts.map +1 -1
  83. package/dist/components/Sidebar/Sidebar.vue.js +2 -2
  84. package/dist/components/Sidebar/Sidebar.vue2.js +1 -1
  85. package/dist/components/Sidebar/SidebarElement.vue.d.ts.map +1 -1
  86. package/dist/components/Sidebar/SidebarElement.vue.js +1 -1
  87. package/dist/components/Sidebar/SidebarElement.vue2.js +6 -6
  88. package/dist/components/SingleApiReference.vue.d.ts +1 -0
  89. package/dist/components/SingleApiReference.vue.d.ts.map +1 -1
  90. package/dist/components/SingleApiReference.vue.js +25 -22
  91. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts +1 -1
  92. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
  93. package/dist/features/ApiClientModal/ApiClientModal.vue.js +3 -3
  94. package/dist/features/ApiClientModal/index.d.ts +1 -1
  95. package/dist/features/ApiClientModal/index.d.ts.map +1 -1
  96. package/dist/features/ApiClientModal/useApiClient.d.ts +186 -146
  97. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  98. package/dist/features/BaseUrl/BaseUrl.vue.d.ts.map +1 -1
  99. package/dist/features/BaseUrl/BaseUrl.vue.js +11 -10
  100. package/dist/features/DownloadLink/DownloadLink.vue.d.ts +1 -1
  101. package/dist/features/DownloadLink/DownloadLink.vue.d.ts.map +1 -1
  102. package/dist/features/DownloadLink/DownloadLink.vue.js +1 -1
  103. package/dist/features/DownloadLink/DownloadLink.vue2.js +17 -17
  104. package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts.map +1 -1
  105. package/dist/features/ExampleRequest/ExampleRequest.vue.js +1 -1
  106. package/dist/features/ExampleRequest/ExampleRequest.vue2.js +12 -12
  107. package/dist/features/Operation/Webhooks.vue.d.ts.map +1 -1
  108. package/dist/features/Operation/Webhooks.vue.js +2 -2
  109. package/dist/features/Operation/Webhooks.vue2.js +13 -13
  110. package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
  111. package/dist/features/Operation/components/ParameterListItem.vue.js +2 -2
  112. package/dist/features/Operation/components/ParameterListItem.vue2.js +18 -18
  113. package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
  114. package/dist/features/Operation/components/RequestBody.vue.js +2 -2
  115. package/dist/features/Operation/components/RequestBody.vue2.js +38 -32
  116. package/dist/features/Operation/hooks/useResponses.d.ts +1 -0
  117. package/dist/features/Operation/hooks/useResponses.d.ts.map +1 -1
  118. package/dist/features/Operation/hooks/useResponses.js +13 -12
  119. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
  120. package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
  121. package/dist/features/Operation/layouts/ClassicLayout.vue2.js +1 -1
  122. package/dist/features/Operation/layouts/ModernLayout.vue.js +1 -1
  123. package/dist/features/Operation/layouts/ModernLayout.vue2.js +1 -1
  124. package/dist/features/Search/SearchButton.vue.js +2 -2
  125. package/dist/features/Search/SearchButton.vue2.js +1 -1
  126. package/dist/features/Search/SearchModal.vue.d.ts.map +1 -1
  127. package/dist/features/Search/SearchModal.vue.js +2 -2
  128. package/dist/features/Search/SearchModal.vue2.js +1 -1
  129. package/dist/features/Search/useSearchIndex.d.ts +1 -1
  130. package/dist/features/Search/useSearchIndex.d.ts.map +1 -1
  131. package/dist/features/Search/useSearchIndex.js +20 -21
  132. package/dist/helpers/{isMacOs.d.ts → is-mac-os.d.ts} +1 -1
  133. package/dist/helpers/is-mac-os.d.ts.map +1 -0
  134. package/dist/helpers/parse.d.ts.map +1 -1
  135. package/dist/helpers/parse.js +1 -1
  136. package/dist/helpers/{scrollToId.d.ts → scroll-to-id.d.ts} +1 -1
  137. package/dist/helpers/scroll-to-id.d.ts.map +1 -0
  138. package/dist/helpers/sleep.d.ts +0 -2
  139. package/dist/helpers/sleep.d.ts.map +1 -1
  140. package/dist/hooks/useNavState.d.ts.map +1 -1
  141. package/dist/hooks/useNavState.js +28 -28
  142. package/dist/hooks/useReactiveSpec.js +1 -1
  143. package/dist/hooks/useSidebar.d.ts.map +1 -1
  144. package/dist/hooks/useSidebar.js +45 -49
  145. package/dist/index.d.ts +3 -3
  146. package/dist/index.d.ts.map +1 -1
  147. package/dist/index.js +44 -43
  148. package/dist/legacy/fixtures/index.d.ts +1 -1
  149. package/dist/legacy/fixtures/index.d.ts.map +1 -1
  150. package/dist/legacy/helpers/index.d.ts +1 -1
  151. package/dist/legacy/helpers/index.d.ts.map +1 -1
  152. package/dist/libs/download.d.ts +9 -0
  153. package/dist/libs/download.d.ts.map +1 -0
  154. package/dist/libs/download.js +19 -0
  155. package/dist/{helpers/getLowestHeadingLevel.d.ts → libs/markdown.d.ts} +5 -1
  156. package/dist/libs/markdown.d.ts.map +1 -0
  157. package/dist/libs/markdown.js +18 -0
  158. package/dist/libs/openapi.d.ts +56 -0
  159. package/dist/libs/openapi.d.ts.map +1 -0
  160. package/dist/libs/openapi.js +102 -0
  161. package/dist/style.css +1 -1
  162. package/dist/types.d.ts +1 -45
  163. package/dist/types.d.ts.map +1 -1
  164. package/package.json +22 -27
  165. package/dist/components/Content/Schema/SchemaDiscriminator.vue.d.ts.map +0 -1
  166. package/dist/components/Content/Schema/SchemaDiscriminator.vue.js +0 -7
  167. package/dist/components/Content/Schema/SchemaDiscriminator.vue2.js +0 -167
  168. package/dist/esm.js +0 -34
  169. package/dist/helpers/createEmptySpecification.d.ts +0 -8
  170. package/dist/helpers/createEmptySpecification.d.ts.map +0 -1
  171. package/dist/helpers/createEmptySpecification.js +0 -27
  172. package/dist/helpers/deepMerge.d.ts +0 -5
  173. package/dist/helpers/deepMerge.d.ts.map +0 -1
  174. package/dist/helpers/deepMerge.js +0 -8
  175. package/dist/helpers/generateParameters.d.ts +0 -6
  176. package/dist/helpers/generateParameters.d.ts.map +0 -1
  177. package/dist/helpers/get-request.d.ts +0 -59
  178. package/dist/helpers/get-request.d.ts.map +0 -1
  179. package/dist/helpers/getHeadingsFromMarkdown.d.ts +0 -6
  180. package/dist/helpers/getHeadingsFromMarkdown.d.ts.map +0 -1
  181. package/dist/helpers/getHeadingsFromMarkdown.js +0 -13
  182. package/dist/helpers/getLowestHeadingLevel.d.ts.map +0 -1
  183. package/dist/helpers/getLowestHeadingLevel.js +0 -7
  184. package/dist/helpers/getModels.d.ts +0 -7
  185. package/dist/helpers/getModels.d.ts.map +0 -1
  186. package/dist/helpers/getModels.js +0 -22
  187. package/dist/helpers/getVariableNames.d.ts +0 -5
  188. package/dist/helpers/getVariableNames.d.ts.map +0 -1
  189. package/dist/helpers/hasModels.d.ts +0 -3
  190. package/dist/helpers/hasModels.d.ts.map +0 -1
  191. package/dist/helpers/hasModels.js +0 -5
  192. package/dist/helpers/hasSecuritySchemes.d.ts +0 -3
  193. package/dist/helpers/hasSecuritySchemes.d.ts.map +0 -1
  194. package/dist/helpers/hasWebhooks.d.ts +0 -3
  195. package/dist/helpers/hasWebhooks.d.ts.map +0 -1
  196. package/dist/helpers/hasWebhooks.js +0 -4
  197. package/dist/helpers/index.d.ts +0 -17
  198. package/dist/helpers/index.d.ts.map +0 -1
  199. package/dist/helpers/isMacOs.d.ts.map +0 -1
  200. package/dist/helpers/mapFromObject.d.ts +0 -8
  201. package/dist/helpers/mapFromObject.d.ts.map +0 -1
  202. package/dist/helpers/mergeAllObjects.d.ts +0 -5
  203. package/dist/helpers/mergeAllObjects.d.ts.map +0 -1
  204. package/dist/helpers/scrollToId.d.ts.map +0 -1
  205. package/dist/helpers/specDownloads.d.ts +0 -7
  206. package/dist/helpers/specDownloads.d.ts.map +0 -1
  207. package/dist/helpers/specDownloads.js +0 -19
  208. package/dist/helpers/specHelpers.d.ts +0 -16
  209. package/dist/helpers/specHelpers.d.ts.map +0 -1
  210. package/dist/helpers/specHelpers.js +0 -36
  211. package/dist/helpers/waitFor.d.ts +0 -5
  212. package/dist/helpers/waitFor.d.ts.map +0 -1
  213. package/dist/hooks/index.d.ts +0 -5
  214. package/dist/hooks/index.d.ts.map +0 -1
  215. package/dist/legacy/helpers/encodeStringAsBase64.d.ts +0 -5
  216. package/dist/legacy/helpers/encodeStringAsBase64.d.ts.map +0 -1
  217. package/dist/legacy/index.d.ts +0 -5
  218. package/dist/legacy/index.d.ts.map +0 -1
  219. package/dist/legacy/types.d.ts +0 -94
  220. package/dist/legacy/types.d.ts.map +0 -1
  221. package/dist/libs/operation.d.ts +0 -15
  222. package/dist/libs/operation.d.ts.map +0 -1
  223. package/dist/libs/operation.js +0 -16
  224. package/dist/stores/index.d.ts +0 -2
  225. package/dist/stores/index.d.ts.map +0 -1
  226. /package/dist/helpers/{isMacOs.js → is-mac-os.js} +0 -0
  227. /package/dist/helpers/{scrollToId.js → scroll-to-id.js} +0 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,88 @@
1
1
  # @scalar/api-reference
2
2
 
3
+ ## 1.29.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies [4440949]
8
+ - @scalar/components@0.14.1
9
+ - @scalar/oas-utils@0.3.1
10
+ - @scalar/openapi-types@0.3.1
11
+ - @scalar/types@0.2.1
12
+ - @scalar/api-client@2.4.1
13
+ - @scalar/openapi-parser@0.11.0
14
+ - @scalar/snippetz@0.3.0
15
+ - @scalar/themes@0.12.1
16
+ - @scalar/code-highlight@0.1.0
17
+ - @scalar/use-hooks@0.2.1
18
+ - @scalar/icons@0.4.1
19
+
20
+ ## 1.29.0
21
+
22
+ ### Minor Changes
23
+
24
+ - 483ca93: chore: require Node 20 (or above)
25
+
26
+ ### Patch Changes
27
+
28
+ - fce282f: fix: updates schema property heading logic
29
+ - ca403fe: feat(api-reference): reorder getModelNameFromSchema to prefer schema.title over name; extract displayType helper for type rendering; update tests accordingly
30
+ - 3af1364: feat: separates composition from discriminator
31
+ - b899177: fix: displays array item const in property
32
+ - cf922d4: feat: adds nested discriminator schema support
33
+ - 0efcab4: fix: layout slot propogation
34
+ - fe696ab: fix: adds server variable form border for api reference
35
+ - Updated dependencies [26476ed]
36
+ - Updated dependencies [bd602d3]
37
+ - Updated dependencies [b77f67a]
38
+ - Updated dependencies [30bab1d]
39
+ - Updated dependencies [5613e40]
40
+ - Updated dependencies [483ca93]
41
+ - Updated dependencies [fe696ab]
42
+ - Updated dependencies [1d1470c]
43
+ - Updated dependencies [0efcab4]
44
+ - Updated dependencies [20cf550]
45
+ - @scalar/api-client@2.4.0
46
+ - @scalar/openapi-parser@0.11.0
47
+ - @scalar/snippetz@0.3.0
48
+ - @scalar/oas-utils@0.3.0
49
+ - @scalar/components@0.14.0
50
+ - @scalar/themes@0.12.0
51
+ - @scalar/code-highlight@0.1.0
52
+ - @scalar/openapi-types@0.3.0
53
+ - @scalar/use-toasts@0.8.0
54
+ - @scalar/use-hooks@0.2.0
55
+ - @scalar/icons@0.4.0
56
+ - @scalar/types@0.2.0
57
+
58
+ ## 1.28.34
59
+
60
+ ### Patch Changes
61
+
62
+ - 73ecfb0: fix: adds missing schemas to schema property
63
+ - 2056005: fix(api-reference): improve handling of schema discriminators
64
+ - 9946289: feat: show response schema in the response list
65
+ - 40bad87: fix: copy correct path when pathRouting enabled
66
+ - 3a88c94: fix(api-reference): restrict mobile header width
67
+ - 96be9bd: fix(api-reference): handle really long property titles
68
+ - ab0d3a3: fix(api-reference): render required for request body
69
+ - 5129cdc: fix: adds max depth to merge all of schemas
70
+ - be8a6ec: refactor: clean up helpers, remove barrel files
71
+ - Updated dependencies [6b4a3c3]
72
+ - Updated dependencies [be8a6ec]
73
+ - Updated dependencies [1843cfe]
74
+ - Updated dependencies [cd0722d]
75
+ - @scalar/api-client@2.3.34
76
+ - @scalar/types@0.1.16
77
+ - @scalar/components@0.13.59
78
+ - @scalar/oas-utils@0.2.144
79
+ - @scalar/openapi-parser@0.10.17
80
+ - @scalar/snippetz@0.2.20
81
+ - @scalar/themes@0.11.3
82
+ - @scalar/code-highlight@0.0.29
83
+ - @scalar/use-hooks@0.1.50
84
+ - @scalar/icons@0.3.7
85
+
3
86
  ## 1.28.33
4
87
 
5
88
  ### Patch Changes