@scalar/api-reference 1.34.1 → 1.34.4

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 (113) hide show
  1. package/CHANGELOG.md +99 -0
  2. package/README.md +1 -1
  3. package/dist/browser/standalone.js +13121 -12730
  4. package/dist/browser/webpack-stats.json +1 -1
  5. package/dist/components/Badge/Badge.vue.d.ts +4 -1
  6. package/dist/components/Badge/Badge.vue.d.ts.map +1 -1
  7. package/dist/components/Badge/Badge.vue.js +5 -11
  8. package/dist/components/Badge/Badge.vue2.js +22 -2
  9. package/dist/components/Badge/Badge.vue3.js +4 -0
  10. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts +1 -1
  11. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
  12. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +1 -1
  13. package/dist/components/Content/Models/Models.vue.d.ts.map +1 -1
  14. package/dist/components/Content/Models/Models.vue.js +30 -31
  15. package/dist/components/Content/Models/ModernLayout.vue.d.ts +2 -0
  16. package/dist/components/Content/Models/ModernLayout.vue.d.ts.map +1 -1
  17. package/dist/components/Content/Models/ModernLayout.vue.js +2 -2
  18. package/dist/components/Content/Models/ModernLayout.vue2.js +39 -37
  19. package/dist/components/Content/Operations/TraversedEntry.vue.js +12 -12
  20. package/dist/components/Content/Tags/TagSection.vue.js +6 -6
  21. package/dist/components/GettingStarted.vue.js +3 -3
  22. package/dist/components/GettingStarted.vue2.js +21 -21
  23. package/dist/components/MobileHeader.vue.d.ts.map +1 -1
  24. package/dist/components/MobileHeader.vue.js +3 -3
  25. package/dist/components/Section/CompactSection.vue.d.ts +2 -0
  26. package/dist/components/Section/CompactSection.vue.d.ts.map +1 -1
  27. package/dist/components/Section/CompactSection.vue.js +1 -1
  28. package/dist/components/Section/CompactSection.vue2.js +30 -29
  29. package/dist/features/Operation/Operation.vue.d.ts +2 -1
  30. package/dist/features/Operation/Operation.vue.d.ts.map +1 -1
  31. package/dist/features/Operation/Operation.vue.js +53 -52
  32. package/dist/features/Operation/components/callbacks/Callback.vue.d.ts +1 -2
  33. package/dist/features/Operation/components/callbacks/Callback.vue.d.ts.map +1 -1
  34. package/dist/features/Operation/components/callbacks/Callback.vue.js +3 -3
  35. package/dist/features/Operation/components/callbacks/Callback.vue3.js +2 -2
  36. package/dist/features/Operation/components/callbacks/Callbacks.vue.d.ts.map +1 -1
  37. package/dist/features/Operation/components/callbacks/Callbacks.vue.js +16 -16
  38. package/dist/features/Operation/helpers/combine-params.d.ts +5 -0
  39. package/dist/features/Operation/helpers/combine-params.d.ts.map +1 -0
  40. package/dist/features/Operation/helpers/combine-params.js +13 -0
  41. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts +3 -4
  42. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
  43. package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
  44. package/dist/features/Operation/layouts/ClassicLayout.vue2.js +59 -50
  45. package/dist/features/Operation/layouts/ClassicLayout.vue3.js +2 -2
  46. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts +3 -4
  47. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
  48. package/dist/features/Operation/layouts/ModernLayout.vue.js +2 -2
  49. package/dist/features/Operation/layouts/ModernLayout.vue2.js +94 -78
  50. package/dist/features/Search/helpers/create-fuse-instance.d.ts.map +1 -1
  51. package/dist/features/Search/helpers/create-fuse-instance.js +0 -3
  52. package/dist/features/api-client-modal/ApiClientModal.vue.d.ts.map +1 -1
  53. package/dist/features/api-client-modal/ApiClientModal.vue.js +51 -48
  54. package/dist/features/api-client-modal/useApiClient.d.ts +100 -100
  55. package/dist/features/api-client-modal/useApiClient.d.ts.map +1 -1
  56. package/dist/features/document-source/hooks/useDocumentFetcher.d.ts.map +1 -1
  57. package/dist/features/document-source/hooks/useDocumentFetcher.js +16 -18
  58. package/dist/features/document-source/hooks/useDocumentSource.d.ts.map +1 -1
  59. package/dist/features/document-source/hooks/useDocumentSource.js +30 -33
  60. package/dist/features/example-responses/ExampleResponse.vue.d.ts +1 -1
  61. package/dist/features/example-responses/ExampleResponse.vue.d.ts.map +1 -1
  62. package/dist/features/example-responses/ExampleResponse.vue.js +2 -2
  63. package/dist/features/example-responses/ExampleResponse.vue2.js +15 -13
  64. package/dist/features/example-responses/ExampleResponses.vue.d.ts +2 -3
  65. package/dist/features/example-responses/ExampleResponses.vue.d.ts.map +1 -1
  66. package/dist/features/example-responses/ExampleResponses.vue.js +2 -2
  67. package/dist/features/example-responses/ExampleResponses.vue2.js +73 -69
  68. package/dist/features/example-responses/helpers/get-resolved-ref-deep.d.ts +26 -0
  69. package/dist/features/example-responses/helpers/get-resolved-ref-deep.d.ts.map +1 -0
  70. package/dist/features/example-responses/helpers/get-resolved-ref-deep.js +29 -0
  71. package/dist/features/sidebar/components/SidebarElement.vue.d.ts.map +1 -1
  72. package/dist/features/sidebar/components/SidebarElement.vue.js +1 -1
  73. package/dist/features/sidebar/components/SidebarElement.vue2.js +6 -6
  74. package/dist/features/sidebar/helpers/create-sidebar.d.ts.map +1 -1
  75. package/dist/features/sidebar/helpers/create-sidebar.js +13 -14
  76. package/dist/features/traverse-schema/helpers/traverse-paths.d.ts +1 -2
  77. package/dist/features/traverse-schema/helpers/traverse-paths.d.ts.map +1 -1
  78. package/dist/features/traverse-schema/helpers/traverse-schemas.d.ts.map +1 -1
  79. package/dist/features/traverse-schema/helpers/traverse-tags.d.ts.map +1 -1
  80. package/dist/features/traverse-schema/helpers/traverse-webhooks.d.ts.map +1 -1
  81. package/dist/features/traverse-schema/types.d.ts +11 -12
  82. package/dist/features/traverse-schema/types.d.ts.map +1 -1
  83. package/dist/features/x-badges/XBadges.vue.d.ts +8 -0
  84. package/dist/features/x-badges/XBadges.vue.d.ts.map +1 -0
  85. package/dist/features/x-badges/XBadges.vue.js +26 -0
  86. package/dist/features/x-badges/XBadges.vue2.js +4 -0
  87. package/dist/features/x-badges/index.d.ts +2 -0
  88. package/dist/features/x-badges/index.d.ts.map +1 -0
  89. package/dist/helpers/test-utils.d.ts +1 -1
  90. package/dist/helpers/test-utils.d.ts.map +1 -1
  91. package/dist/hooks/useNavState.d.ts +1 -2
  92. package/dist/hooks/useNavState.d.ts.map +1 -1
  93. package/dist/index.js +1 -1
  94. package/dist/libs/openapi.d.ts +4 -14
  95. package/dist/libs/openapi.d.ts.map +1 -1
  96. package/dist/libs/openapi.js +55 -36
  97. package/dist/style.css +1 -1
  98. package/dist/v2/ApiReferenceWorkspace.vue.d.ts.map +1 -1
  99. package/dist/v2/ApiReferenceWorkspace.vue.js +64 -64
  100. package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.d.ts +1 -2
  101. package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.d.ts.map +1 -1
  102. package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue.js +2 -2
  103. package/dist/v2/blocks/scalar-request-example-block/components/RequestExample.vue2.js +97 -100
  104. package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts +1 -2
  105. package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.d.ts.map +1 -1
  106. package/dist/v2/blocks/scalar-request-example-block/helpers/generate-code-snippet.js +17 -20
  107. package/dist/v2/blocks/scalar-request-example-block/helpers/get-secrets.d.ts.map +1 -1
  108. package/dist/v2/helpers/map-configuration.d.ts +66 -0
  109. package/dist/v2/helpers/map-configuration.d.ts.map +1 -0
  110. package/dist/v2/helpers/map-configuration.js +53 -0
  111. package/dist/vitest.setup.d.ts +2 -0
  112. package/dist/vitest.setup.d.ts.map +1 -0
  113. package/package.json +24 -20
package/CHANGELOG.md CHANGED
@@ -1,5 +1,104 @@
1
1
  # @scalar/api-reference
2
2
 
3
+ ## 1.34.4
4
+
5
+ ### Patch Changes
6
+
7
+ - bbef120: fix: remove extra coerces and cleanUp plugin from bundler
8
+ - 24883ab: feat(api-reference): map reference configuration to the new store configuration
9
+ - a1429ca: chore: move to new extensions system for better type safety
10
+ - e499aee: fix: typo in model opening
11
+ - 845e850: fix: deep resolve response examples
12
+ - 66b18fc: feat: update the references to handle $refs from the magic proxy
13
+ - 6eb7c4f: fix: search does not match when the query has a single character word
14
+ - 4e06829: fix: horizontal scrollbars in a VS Code webview
15
+ - 5f022b5: feat: use registry.scalar.com URLs as example
16
+ - 2b89e6f: feat: x-badges
17
+ - 6a88108: feat: add option to expandAllResponses and expandAllModelSections
18
+ - c838a3f: chore: added measurements to workspace store
19
+ - 75d84ed: fix: does not load document when the url/content stays the same
20
+ - 929df42: fix: sidebar links are prefixed with the path
21
+ - 0804cfc: eat(components): Add ScalarMarkdown summary component
22
+ - Updated dependencies [bbef120]
23
+ - Updated dependencies [b93e1fe]
24
+ - Updated dependencies [a1429ca]
25
+ - Updated dependencies [d4adeba]
26
+ - Updated dependencies [5208f06]
27
+ - Updated dependencies [172e397]
28
+ - Updated dependencies [4d509fb]
29
+ - Updated dependencies [66b18fc]
30
+ - Updated dependencies [5f022b5]
31
+ - Updated dependencies [0fcd446]
32
+ - Updated dependencies [d8b8a5b]
33
+ - Updated dependencies [6c24be9]
34
+ - Updated dependencies [6a88108]
35
+ - Updated dependencies [c838a3f]
36
+ - Updated dependencies [c418e92]
37
+ - Updated dependencies [9be6eec]
38
+ - Updated dependencies [c4bf497]
39
+ - Updated dependencies [638120c]
40
+ - Updated dependencies [d8adbed]
41
+ - Updated dependencies [0804cfc]
42
+ - Updated dependencies [0c80ef0]
43
+ - @scalar/workspace-store@0.14.0
44
+ - @scalar/oas-utils@0.4.20
45
+ - @scalar/json-magic@0.3.0
46
+ - @scalar/openapi-parser@0.20.0
47
+ - @scalar/api-client@2.5.24
48
+ - @scalar/components@0.14.25
49
+ - @scalar/helpers@0.0.8
50
+ - @scalar/themes@0.13.13
51
+ - @scalar/types@0.2.12
52
+ - @scalar/code-highlight@0.1.9
53
+ - @scalar/icons@0.4.7
54
+ - @scalar/object-utils@1.2.4
55
+ - @scalar/openapi-types@0.3.7
56
+ - @scalar/snippetz@0.4.5
57
+ - @scalar/use-hooks@0.2.4
58
+ - @scalar/use-toasts@0.8.0
59
+
60
+ ## 1.34.3
61
+
62
+ ### Patch Changes
63
+
64
+ - 97f199a: fix(api-reference): path parameters not showing in request example code
65
+ - 0d502cb: chore(workspace-store): clean up client store
66
+ - 3de82ac: fix: uses document url even if it's relative
67
+ - 58b9321: feat: adds scalar code block copy component
68
+ - 2c74892: fix: x-scalar-ignore models schema displayed
69
+ - Updated dependencies [b235392]
70
+ - Updated dependencies [0d502cb]
71
+ - Updated dependencies [e203e90]
72
+ - Updated dependencies [3de82ac]
73
+ - Updated dependencies [58b9321]
74
+ - Updated dependencies [68e4631]
75
+ - Updated dependencies [b1ceaab]
76
+ - Updated dependencies [fbafeab]
77
+ - Updated dependencies [0afc40c]
78
+ - Updated dependencies [128af48]
79
+ - Updated dependencies [376739d]
80
+ - @scalar/api-client@2.5.23
81
+ - @scalar/workspace-store@0.13.0
82
+ - @scalar/openapi-parser@0.19.1
83
+ - @scalar/oas-utils@0.4.19
84
+ - @scalar/components@0.14.24
85
+ - @scalar/icons@0.4.7
86
+ - @scalar/code-highlight@0.1.9
87
+ - @scalar/helpers@0.0.7
88
+ - @scalar/object-utils@1.2.3
89
+ - @scalar/openapi-types@0.3.7
90
+ - @scalar/snippetz@0.4.4
91
+ - @scalar/themes@0.13.12
92
+ - @scalar/types@0.2.11
93
+ - @scalar/use-hooks@0.2.4
94
+ - @scalar/use-toasts@0.8.0
95
+
96
+ ## 1.34.2
97
+
98
+ ### Patch Changes
99
+
100
+ - 83625c6: fix: cyclic error in client store watcher
101
+
3
102
  ## 1.34.1
4
103
 
5
104
  ### Patch Changes
package/README.md CHANGED
@@ -33,7 +33,7 @@ Interactive API Reference from OpenAPI/Swagger Documents [Try our Demo](https://
33
33
  <script>
34
34
  Scalar.createApiReference('#app', {
35
35
  // The URL of the OpenAPI/Swagger document
36
- url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
36
+ url: 'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=json',
37
37
  // Avoid CORS issues
38
38
  proxyUrl: 'https://proxy.scalar.com',
39
39
  })