@scalar/api-reference 1.20.10 → 1.20.12

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 (65) hide show
  1. package/CHANGELOG.md +22 -1
  2. package/README.md +5 -5
  3. package/dist/browser/standalone.js +10 -10
  4. package/dist/browser/webpack-stats.json +1 -1
  5. package/dist/components/ApiClientModal.vue.d.ts +0 -1
  6. package/dist/components/ApiClientModal.vue.d.ts.map +1 -1
  7. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  8. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  9. package/dist/components/Content/Authentication/Authentication.vue.d.ts.map +1 -1
  10. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
  11. package/dist/components/Content/ClientLibraries/ClientSelector.vue.d.ts.map +1 -1
  12. package/dist/components/Content/Operation/ExampleRequest.vue.d.ts.map +1 -1
  13. package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
  14. package/dist/components/Layouts/index.d.ts +2 -2
  15. package/dist/components/Layouts/index.d.ts.map +1 -1
  16. package/dist/components/MobileHeader.vue.d.ts.map +1 -1
  17. package/dist/helpers/getApiClientRequest.d.ts +5 -5
  18. package/dist/helpers/getApiClientRequest.d.ts.map +1 -1
  19. package/dist/helpers/index.d.ts +0 -1
  20. package/dist/helpers/index.d.ts.map +1 -1
  21. package/dist/helpers/openClientFor.d.ts +1 -1
  22. package/dist/helpers/openClientFor.d.ts.map +1 -1
  23. package/dist/hooks/index.d.ts +2 -2
  24. package/dist/hooks/index.d.ts.map +1 -1
  25. package/dist/hooks/{useSnippetTargets.d.ts → useHttpClients.d.ts} +2 -2
  26. package/dist/hooks/useHttpClients.d.ts.map +1 -0
  27. package/dist/hooks/useSidebar.d.ts +1 -0
  28. package/dist/hooks/useSidebar.d.ts.map +1 -1
  29. package/dist/index.cjs +153 -153
  30. package/dist/index.css +1 -1
  31. package/dist/index.d.ts +2 -1
  32. package/dist/index.d.ts.map +1 -1
  33. package/dist/index.js +11461 -10699
  34. package/dist/stores/index.d.ts +2 -1
  35. package/dist/stores/index.d.ts.map +1 -1
  36. package/dist/stores/useHttpClientStore.d.ts +22 -0
  37. package/dist/stores/useHttpClientStore.d.ts.map +1 -0
  38. package/dist/stores/useServerStore.d.ts +16 -0
  39. package/dist/stores/useServerStore.d.ts.map +1 -0
  40. package/dist/types.d.ts +5 -26
  41. package/dist/types.d.ts.map +1 -1
  42. package/package.json +12 -6
  43. package/dist/components/Content/Authentication/CardForm.vue.d.ts +0 -10
  44. package/dist/components/Content/Authentication/CardForm.vue.d.ts.map +0 -1
  45. package/dist/components/Content/Authentication/CardFormButton.vue.d.ts +0 -12
  46. package/dist/components/Content/Authentication/CardFormButton.vue.d.ts.map +0 -1
  47. package/dist/components/Content/Authentication/CardFormGroup.vue.d.ts +0 -10
  48. package/dist/components/Content/Authentication/CardFormGroup.vue.d.ts.map +0 -1
  49. package/dist/components/Content/Authentication/CardFormTextInput.vue.d.ts +0 -25
  50. package/dist/components/Content/Authentication/CardFormTextInput.vue.d.ts.map +0 -1
  51. package/dist/components/Content/Authentication/SecurityScheme.vue.d.ts +0 -17
  52. package/dist/components/Content/Authentication/SecurityScheme.vue.d.ts.map +0 -1
  53. package/dist/components/Content/Authentication/SecuritySchemeScopes.vue.d.ts +0 -26
  54. package/dist/components/Content/Authentication/SecuritySchemeScopes.vue.d.ts.map +0 -1
  55. package/dist/components/Content/Authentication/SecuritySchemeSelector.vue.d.ts +0 -25
  56. package/dist/components/Content/Authentication/SecuritySchemeSelector.vue.d.ts.map +0 -1
  57. package/dist/helpers/getRequestFromAuthentication.d.ts +0 -10
  58. package/dist/helpers/getRequestFromAuthentication.d.ts.map +0 -1
  59. package/dist/hooks/useSnippetTargets.d.ts.map +0 -1
  60. package/dist/stores/globalStore.d.ts +0 -43
  61. package/dist/stores/globalStore.d.ts.map +0 -1
  62. package/dist/stores/template.d.ts +0 -44
  63. package/dist/stores/template.d.ts.map +0 -1
  64. package/dist/stores/utility.d.ts +0 -10
  65. package/dist/stores/utility.d.ts.map +0 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,26 @@
1
1
  # @scalar/api-reference
2
2
 
3
+ ## 1.20.12
4
+
5
+ ### Patch Changes
6
+
7
+ - 999dfc9: chore: moved sidemenu control to css
8
+ - fd5c714: feat: add authentication UI to the API client
9
+ - 5c1b385: fix: improper variables name + remove importants
10
+ - 5f5395f: fix: toast notification doesn't show up
11
+ - Updated dependencies [999dfc9]
12
+ - @scalar/api-client@1.1.10
13
+
14
+ ## 1.20.11
15
+
16
+ ### Patch Changes
17
+
18
+ - d70bda7: fix: text decoration targetting in themes + unused css in themes
19
+ - Updated dependencies [d70bda7]
20
+ - @scalar/themes@0.6.7
21
+ - @scalar/api-client@1.1.9
22
+ - @scalar/components@0.4.8
23
+
3
24
  ## 1.20.10
4
25
 
5
26
  ### Patch Changes
@@ -456,7 +477,7 @@
456
477
 
457
478
  - 92a8b9f: chore: update dependencies
458
479
  - 230f9fb: feat: prefill the authentication data
459
- - 77c62d3: fix: path isn’t prefixed (https://github.com/scalar/scalar/issues/937)
480
+ - 77c62d3: fix: path isn’t prefixed (<https://github.com/scalar/scalar/issues/937>)
460
481
  - Updated dependencies [e0faebb]
461
482
  - Updated dependencies [92a8b9f]
462
483
  - Updated dependencies [abfb086]
package/README.md CHANGED
@@ -154,10 +154,10 @@ To make authentication easier you can prefill the credentials for your users:
154
154
  ````vue
155
155
  <ApiReference :configuration="{
156
156
  authentication: {
157
- // The OpenAPI file has keys for all security schemes
157
+ // The OpenAPI file has keys for all security schemes:
158
158
  // Which one should be used by default?
159
- securitySchemeKey: 'api_key',
160
- // Okay, the `api_key` security scheme is of type `apiKey`, so prefill the token:
159
+ preferredSecurityScheme: 'my_custom_security_scheme',
160
+ // The `my_custom_security_scheme` security scheme is of type `apiKey`, so prefill the token:
161
161
  apiKey: {
162
162
  token: 'super-secret-token',
163
163
  },
@@ -172,8 +172,8 @@ For OpenAuth2 it’s more looking like this:
172
172
  authentication: {
173
173
  // The OpenAPI file has keys for all security schemes
174
174
  // Which one should be used by default?
175
- securitySchemeKey: 'petstore_auth',
176
- // Okay, the `api_key` security scheme is of type `oAuth2`, so prefill the client id and the scopes:
175
+ preferredSecurityScheme: 'petstore_auth',
176
+ // The `petstore_auth` security scheme is of type `oAuth2`, so prefill the client id and the scopes:
177
177
  oAuth2: {
178
178
  clientId: 'foobar123',
179
179
  // optional: