@scalar/api-reference 1.25.127 → 1.25.130

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 (128) hide show
  1. package/CHANGELOG.md +67 -0
  2. package/dist/browser/standalone.js +13272 -13158
  3. package/dist/browser/webpack-stats.json +1 -1
  4. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  5. package/dist/components/ApiReference.vue.js +40 -64
  6. package/dist/components/ApiReferenceLayout.vue.d.ts +2 -2
  7. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  8. package/dist/components/ApiReferenceLayout.vue.js +2 -2
  9. package/dist/components/ApiReferenceLayout.vue2.js +158 -159
  10. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.d.ts.map +1 -1
  11. package/dist/components/Content/ClientLibraries/ClientLibraries.vue.js +1 -1
  12. package/dist/components/Content/ClientLibraries/ClientLibraries.vue2.js +69 -17
  13. package/dist/components/Content/ClientLibraries/ClientSelector.vue.d.ts +5 -1
  14. package/dist/components/Content/ClientLibraries/ClientSelector.vue.d.ts.map +1 -1
  15. package/dist/components/Content/ClientLibraries/ClientSelector.vue.js +2 -2
  16. package/dist/components/Content/ClientLibraries/ClientSelector.vue2.js +73 -94
  17. package/dist/components/Content/ClientLibraries/useFeaturedHttpClients.d.ts +16 -0
  18. package/dist/components/Content/ClientLibraries/useFeaturedHttpClients.d.ts.map +1 -0
  19. package/dist/components/Content/ClientLibraries/useFeaturedHttpClients.js +36 -0
  20. package/dist/components/Content/Lazy/Loading.vue.js +15 -15
  21. package/dist/components/Content/Schema/Schema.vue.d.ts.map +1 -1
  22. package/dist/components/Content/Schema/Schema.vue.js +2 -2
  23. package/dist/components/Content/Schema/Schema.vue2.js +4 -1
  24. package/dist/components/Content/Schema/SchemaProperty.vue.d.ts +1 -1
  25. package/dist/components/Content/Schema/SchemaProperty.vue.js +1 -1
  26. package/dist/components/Content/Schema/SchemaProperty.vue2.js +1 -1
  27. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.d.ts.map +1 -1
  28. package/dist/components/Content/Schema/SchemaPropertyHeading.vue.js +2 -2
  29. package/dist/components/Content/Schema/SchemaPropertyHeading.vue2.js +143 -124
  30. package/dist/components/Content/Tag/{Endpoints.vue.d.ts → OperationsList.vue.d.ts} +1 -3
  31. package/dist/components/Content/Tag/OperationsList.vue.d.ts.map +1 -0
  32. package/dist/components/Content/Tag/OperationsList.vue.js +7 -0
  33. package/dist/components/Content/Tag/OperationsList.vue2.js +62 -0
  34. package/dist/components/Content/Tag/OperationsListItem.vue.d.ts +9 -0
  35. package/dist/components/Content/Tag/OperationsListItem.vue.d.ts.map +1 -0
  36. package/dist/components/Content/Tag/OperationsListItem.vue.js +7 -0
  37. package/dist/components/Content/Tag/OperationsListItem.vue2.js +66 -0
  38. package/dist/components/Content/Tag/Tag.vue.d.ts +4 -64
  39. package/dist/components/Content/Tag/Tag.vue.d.ts.map +1 -1
  40. package/dist/components/Content/Tag/Tag.vue.js +87 -5
  41. package/dist/components/Content/Tag/Tag.vue2.js +2 -63
  42. package/dist/components/Content/Tag/TagList.vue.d.ts.map +1 -1
  43. package/dist/components/Content/Tag/TagList.vue.js +11 -11
  44. package/dist/components/Content/Tag/TagSection.vue.d.ts +70 -0
  45. package/dist/components/Content/Tag/TagSection.vue.d.ts.map +1 -0
  46. package/dist/components/Content/Tag/TagSection.vue.js +7 -0
  47. package/dist/components/Content/Tag/TagSection.vue2.js +65 -0
  48. package/dist/components/Content/Tag/index.d.ts +1 -2
  49. package/dist/components/Content/Tag/index.d.ts.map +1 -1
  50. package/dist/components/GettingStarted.vue.d.ts.map +1 -1
  51. package/dist/components/GettingStarted.vue.js +1 -1
  52. package/dist/components/GettingStarted.vue2.js +13 -13
  53. package/dist/components/Layouts/ClassicLayout.vue.d.ts +3 -3
  54. package/dist/components/Layouts/ClassicLayout.vue.d.ts.map +1 -1
  55. package/dist/components/Layouts/Layouts.vue.d.ts +3 -3
  56. package/dist/components/Layouts/Layouts.vue.d.ts.map +1 -1
  57. package/dist/components/Layouts/ModernLayout.vue.d.ts +3 -3
  58. package/dist/components/Layouts/ModernLayout.vue.d.ts.map +1 -1
  59. package/dist/components/Layouts/ModernLayout.vue.js +2 -2
  60. package/dist/components/Section/CompactSection.vue.d.ts.map +1 -1
  61. package/dist/components/Section/CompactSection.vue.js +2 -2
  62. package/dist/components/Section/CompactSection.vue2.js +30 -29
  63. package/dist/esm.d.ts +5 -3
  64. package/dist/esm.d.ts.map +1 -1
  65. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts +2 -2
  66. package/dist/features/ApiClientModal/ApiClientModal.vue.d.ts.map +1 -1
  67. package/dist/features/ApiClientModal/useApiClient.d.ts +386 -346
  68. package/dist/features/ApiClientModal/useApiClient.d.ts.map +1 -1
  69. package/dist/features/ExampleRequest/ExampleRequest.vue.d.ts.map +1 -1
  70. package/dist/features/ExampleRequest/ExampleRequest.vue.js +1 -1
  71. package/dist/features/ExampleRequest/ExampleRequest.vue2.js +82 -74
  72. package/dist/features/ExampleResponses/ExampleResponse.vue.d.ts.map +1 -1
  73. package/dist/features/ExampleResponses/ExampleResponse.vue.js +2 -2
  74. package/dist/features/ExampleResponses/ExampleResponse.vue2.js +11 -11
  75. package/dist/features/ExampleResponses/ExampleResponses.vue.d.ts.map +1 -1
  76. package/dist/features/ExampleResponses/ExampleResponses.vue.js +2 -2
  77. package/dist/features/ExampleResponses/ExampleResponses.vue2.js +90 -78
  78. package/dist/features/Operation/components/ContentTypeSelect.vue.d.ts +1 -1
  79. package/dist/features/Operation/components/ContentTypeSelect.vue.d.ts.map +1 -1
  80. package/dist/features/Operation/components/ContentTypeSelect.vue.js +1 -1
  81. package/dist/features/Operation/components/ContentTypeSelect.vue2.js +29 -25
  82. package/dist/features/Operation/components/ParameterListItem.vue.d.ts.map +1 -1
  83. package/dist/features/Operation/components/ParameterListItem.vue.js +1 -1
  84. package/dist/features/Operation/components/ParameterListItem.vue2.js +40 -47
  85. package/dist/features/Operation/components/RequestBody.vue.d.ts.map +1 -1
  86. package/dist/features/Operation/components/RequestBody.vue.js +2 -2
  87. package/dist/features/Operation/layouts/ClassicLayout.vue.d.ts.map +1 -1
  88. package/dist/features/Operation/layouts/ClassicLayout.vue.js +2 -2
  89. package/dist/features/Operation/layouts/ClassicLayout.vue2.js +54 -54
  90. package/dist/features/Operation/layouts/ModernLayout.vue.d.ts.map +1 -1
  91. package/dist/features/Operation/layouts/ModernLayout.vue.js +1 -1
  92. package/dist/features/Operation/layouts/ModernLayout.vue2.js +65 -67
  93. package/dist/helpers/get-request.d.ts +2 -1
  94. package/dist/helpers/get-request.d.ts.map +1 -1
  95. package/dist/helpers/index.d.ts +0 -1
  96. package/dist/helpers/index.d.ts.map +1 -1
  97. package/dist/hooks/index.d.ts +0 -1
  98. package/dist/hooks/index.d.ts.map +1 -1
  99. package/dist/hooks/useConfig.d.ts +3 -3
  100. package/dist/hooks/useConfig.d.ts.map +1 -1
  101. package/dist/hooks/useConfig.js +5 -4
  102. package/dist/hooks/useReactiveSpec.d.ts +8 -8
  103. package/dist/hooks/useSidebar.d.ts.map +1 -1
  104. package/dist/hooks/useSidebar.js +126 -116
  105. package/dist/index.js +56 -62
  106. package/dist/libs/operation.d.ts +15 -0
  107. package/dist/libs/operation.d.ts.map +1 -0
  108. package/dist/libs/operation.js +16 -0
  109. package/dist/standalone/lib/html-api.d.ts +3 -3
  110. package/dist/standalone/lib/html-api.d.ts.map +1 -1
  111. package/dist/stores/useHttpClientStore.d.ts +1 -1
  112. package/dist/stores/useHttpClientStore.d.ts.map +1 -1
  113. package/dist/style.css +1 -1
  114. package/dist/types.d.ts +20 -3
  115. package/dist/types.d.ts.map +1 -1
  116. package/package.json +13 -13
  117. package/dist/components/Content/Tag/Endpoints.vue.d.ts.map +0 -1
  118. package/dist/components/Content/Tag/Endpoints.vue.js +0 -7
  119. package/dist/components/Content/Tag/Endpoints.vue2.js +0 -161
  120. package/dist/helpers/operation.d.ts +0 -14
  121. package/dist/helpers/operation.d.ts.map +0 -1
  122. package/dist/helpers/operation.js +0 -18
  123. package/dist/hooks/useDeprecationWarnings.d.ts +0 -6
  124. package/dist/hooks/useDeprecationWarnings.d.ts.map +0 -1
  125. package/dist/hooks/useDeprecationWarnings.js +0 -20
  126. package/dist/standalone/lib/html-rendering.d.ts +0 -51
  127. package/dist/standalone/lib/html-rendering.d.ts.map +0 -1
  128. package/dist/standalone/lib/html-rendering.js +0 -54
@@ -0,0 +1,15 @@
1
+ import type { Operation } from '@scalar/oas-utils/entities/spec';
2
+ import { XScalarStability } from '@scalar/types/legacy';
3
+ /**
4
+ * Returns if an operation is considered deprecated.
5
+ */
6
+ export declare function isOperationDeprecated(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): boolean;
7
+ /**
8
+ * Get operation stability.
9
+ */
10
+ export declare function getOperationStability(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): XScalarStability | undefined;
11
+ /**
12
+ * Get Operation stability color
13
+ */
14
+ export declare function getOperationStabilityColor(operation: Pick<Operation, 'deprecated' | 'x-scalar-stability'>): string;
15
+ //# sourceMappingURL=operation.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"operation.d.ts","sourceRoot":"","sources":["../../src/libs/operation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAAG,OAAO,CAI9G;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAC9D,gBAAgB,GAAG,SAAS,CAG9B;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,GAAG,oBAAoB,CAAC,GAAG,MAAM,CAMlH"}
@@ -0,0 +1,16 @@
1
+ import { XScalarStability as e } from "@scalar/types/legacy";
2
+ function n(t) {
3
+ return t.deprecated !== void 0 ? t.deprecated : !!(t["x-scalar-stability"] && t["x-scalar-stability"] === e.Deprecated);
4
+ }
5
+ function i(t) {
6
+ return t.deprecated ? e.Deprecated : t["x-scalar-stability"];
7
+ }
8
+ function c(t) {
9
+ const r = i(t);
10
+ return r === e.Deprecated ? "text-red" : r === e.Experimental ? "text-orange" : r === e.Stable ? "text-green" : "";
11
+ }
12
+ export {
13
+ i as getOperationStability,
14
+ c as getOperationStabilityColor,
15
+ n as isOperationDeprecated
16
+ };
@@ -1,11 +1,11 @@
1
- import type { ReferenceConfiguration } from '@scalar/types/legacy';
1
+ import { type ApiReferenceConfiguration } from '@scalar/types/api-reference';
2
2
  /**
3
3
  * Reading the configuration from the data-attributes.
4
4
  */
5
- export declare function getConfigurationFromDataAttributes(doc: Document): ReferenceConfiguration;
5
+ export declare function getConfigurationFromDataAttributes(doc: Document): ApiReferenceConfiguration;
6
6
  /**
7
7
  * Mount the Scalar API Reference on a given document.
8
8
  * Read the HTML data-attributes for configuration.
9
9
  */
10
- export declare function mountScalarApiReference(doc: Document, configuration: ReferenceConfiguration): void;
10
+ export declare function mountScalarApiReference(doc: Document, configuration: ApiReferenceConfiguration): void;
11
11
  //# sourceMappingURL=html-api.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAQlE;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,sBAAsB,CA8GxF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,sBAAsB,QAsF3F"}
1
+ {"version":3,"file":"html-api.d.ts","sourceRoot":"","sources":["../../../src/standalone/lib/html-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,KAAK,yBAAyB,EAAE,MAAM,6BAA6B,CAAA;AAQ7G;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,QAAQ,GAAG,yBAAyB,CA8G3F;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,QAAQ,EAAE,aAAa,EAAE,yBAAyB,QAsF9F"}
@@ -1,5 +1,5 @@
1
- import type { Target, TargetId } from '@scalar/snippetz/types';
2
1
  import type { HiddenClients } from '@scalar/types/legacy';
2
+ import type { Target, TargetId } from '@scalar/types/snippetz';
3
3
  import { type Ref } from 'vue';
4
4
  /**
5
5
  * Gets the client title from the availableTargets
@@ -1 +1 @@
1
- {"version":3,"file":"useHttpClientStore.d.ts","sourceRoot":"","sources":["../../src/stores/useHttpClientStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,KAAK,GAAG,EAAqC,MAAM,KAAK,CAAA;AASjE;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAE9C;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAM9C;AAYD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAkD5F;AASD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAMxE,iBAAS,oBAAoB,CAAC,UAAU,CAAC,EAAE,eAAe,QAQzD;AAkCD,iBAAS,UAAU,SAElB;AAYD,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;;4BA/DY,QAAQ;4BAAa,MAAM;;;8BAuDrC,OAAO,CAAC,eAAe,CAAC;;qBAcP,GAAG,CAAC,aAAa,CAAC;4BACxC,aAAa;;;;;;CAaxC,CAAA"}
1
+ {"version":3,"file":"useHttpClientStore.d.ts","sourceRoot":"","sources":["../../src/stores/useHttpClientStore.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAC9D,OAAO,EAAE,KAAK,GAAG,EAAqC,MAAM,KAAK,CAAA;AASjE;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAE9C;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,MAAM,EAAE,eAAe,UAM9C;AAYD;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,EAAE,CAkD5F;AASD,+BAA+B;AAC/B,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAAA;AAMxE,iBAAS,oBAAoB,CAAC,UAAU,CAAC,EAAE,eAAe,QAKzD;AAiCD,iBAAS,UAAU,SAElB;AAYD,kEAAkE;AAClE,eAAO,MAAM,kBAAkB;;4BA3DY,QAAQ;4BAAa,MAAM;;;8BAmDrC,OAAO,CAAC,eAAe,CAAC;;qBAcP,GAAG,CAAC,aAAa,CAAC;4BACxC,aAAa;;;;;;CAaxC,CAAA"}