@scalar/api-reference 0.5.0 → 0.5.2

package/dist/types.d.ts

@@ -42,15 +42,17 @@ export type Operation = {
     description: string;
     information: Information;
 };
+export type ExampleResponseHeaders = Record<string, {
+    description: string;
+    schema: {
+        type: string;
+        format?: string;
+        example?: string;
+    };
+}>;
 export type TransformedOperation = Operation & {
     responses: Record<string, Response & {
-        headers: Record<string, {
-            description: string;
-            schema: {
-                type: string;
-                format?: string;
-            };
-        }>;
+        headers: ExampleResponseHeaders;
     }>;
 };
 export type Tag = {

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AACD,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,EAAE,CAAA;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,QAAQ,EAAE,CAAA;IACpB,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,WAAW,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,SAAS,EAAE,MAAM,CACf,MAAM,EACN,QAAQ,GAAG;QACT,OAAO,EAAE,MAAM,CACb,MAAM,EACN;YACE,WAAW,EAAE,MAAM,CAAA;YACnB,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAA;gBACZ,MAAM,CAAC,EAAE,MAAM,CAAA;aAChB,CAAA;SACF,CACF,CAAA;KACF,CACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,oBAAoB,EAAE,CAAA;CACnC,CAAA;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,YAAY,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,CAAC,EAAE,GAAG,EAAE,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;CACzB,CAAA;AACD,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,GAAG,CAAA;CACb,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,UAAU,EAAE,CAAA;IACxB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,QAAQ,EAAE,CAAA;IACpB,WAAW,EAAE,WAAW,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,EAAE,CAAA;CACf,CAAA;AAED,MAAM,MAAM,SAAS,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,WAAW,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,MAAM,CACzC,MAAM,EACN;IACE,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;CACF,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,SAAS,EAAE,MAAM,CACf,MAAM,EACN,QAAQ,GAAG;QACT,OAAO,EAAE,sBAAsB,CAAA;KAChC,CACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,GAAG,GAAG;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,oBAAoB,EAAE,CAAA;CACnC,CAAA;AACD,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,UAAU,CAAC,EAAE,iBAAiB,CAAA;KAC/B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE;QACN,IAAI,EAAE,MAAM,CAAA;QACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;QAClB,UAAU,EAAE,iBAAiB,CAAA;KAC9B,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GACnB,kBAAkB,GAClB,iBAAiB,GACjB,YAAY,GACZ,WAAW,GACX,mCAAmC,GACnC,qBAAqB,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;KACnB,GAAG,IAAI,WAAW,GAAG,aAAa;CACpC,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,cAAc,EAAE,MAAM,CAAA;IACtB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,EAAE,GAAG,EAAE,CAAA;IACX,IAAI,EAAE,IAAI,CAAA;IACV,YAAY,EAAE,YAAY,CAAA;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA"}

package/package.json

@@ -11,7 +11,7 @@
     "documentation",
     "component"
   ],
-  "version": "0.5.0",
+  "version": "0.5.2",
   "author": "Scalar (https://github.com/scalar)",
   "homepage": "https://github.com/scalar/scalar",
   "repository": {
@@ -28,13 +28,11 @@
   },
   "type": "module",
   "files": [
-    "src",
     "dist"
   ],
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "exports": {
-    "development": "./src/index.ts",
     "import": "./dist/index.js"
   },
   "types": "dist/index.d.ts",
@@ -51,6 +49,7 @@
     "rehype-format": "4.0.1",
     "rehype-sanitize": "5.0.1",
     "rehype-stringify": "9.0.3",
+    "remark-breaks": "^3.0.3",
     "remark-gfm": "3.0.1",
     "remark-parse": "10.0.2",
     "remark-rehype": "10.1.0",
@@ -58,15 +57,15 @@
     "typographic-base": "1.0.4",
     "unified": "10.1.2",
     "xmldom": "0.6.0",
-    "@scalar/api-client": "0.5.0",
+    "@scalar/api-client": "0.5.2",
     "@scalar/default-theme": "0.2.1",
-    "@scalar/swagger-editor": "0.5.0",
-    "@scalar/swagger-parser": "0.4.1",
-    "@scalar/use-clipboard": "0.4.1",
-    "@scalar/use-codemirror": "0.5.0",
-    "@scalar/use-keyboard-event": "0.4.1",
+    "@scalar/swagger-editor": "0.5.2",
+    "@scalar/swagger-parser": "0.4.3",
+    "@scalar/use-clipboard": "0.4.2",
+    "@scalar/use-codemirror": "0.5.1",
+    "@scalar/use-keyboard-event": "0.4.2",
     "@scalar/use-toasts": "0.4.1",
-    "@scalar/use-tooltip": "0.4.1"
+    "@scalar/use-tooltip": "0.4.2"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "4.2.3",
@@ -77,6 +76,7 @@
     "vite-plugin-css-injected-by-js": "^3.3.0",
     "vite-plugin-node-polyfills": "^0.11.2",
     "vitest": "0.34.1",
+    "@vitest/coverage-v8": "^0.34.4",
     "vue-tsc": "1.8.8"
   },
   "peerDependencies": {

package/dist/components/Content/ReferenceEndpoint/ExampleResponses.vue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExampleResponses.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleResponses.vue.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AA8W1D,wBAAkD"}

package/src/components/ApiClientModal.vue

@@ -1,205 +0,0 @@
-<script setup lang="ts">
-import { ApiClient, useApiClientStore } from '@scalar/api-client'
-import { useMediaQuery } from '@vueuse/core'
-
-import { type Spec } from '../types'
-import { default as Sidebar } from './Sidebar.vue'
-
-defineProps<{
-  spec: Spec
-  overloadShow?: boolean
-  tabMode?: boolean
-  activeTab?: string
-}>()
-
-const { hideApiClient, state } = useApiClientStore()
-
-const isMobile = useMediaQuery('(max-width: 1000px)')
-
-const proxyUrl = import.meta.env.VITE_CLIENT_PROXY
-</script>
-<script lang="ts">
-export { useApiClientStore } from '@scalar/api-client'
-</script>
-<template>
-  <div
-    v-if="state.showApiClient || overloadShow"
-    class="api-client-drawer">
-    <div class="scalar-api-client__overlay">
-      <div class="scalar-api-client__container">
-        <slot name="header" />
-        <!-- <div class="scalar-api-client__navigation">
-          <button
-            class="scalar-api-client__close"
-            type="button"
-            @click="hideApiClient">
-            <span>Back to Reference</span>
-          </button>
-        </div> -->
-        <div class="scalar-api-client-height flex flex-row">
-          <template v-if="tabMode">
-            <template v-if="activeTab === 'sidebar'">
-              <Sidebar
-                v-show="!isMobile"
-                :spec="spec" />
-            </template>
-            <template v-else>
-              <slot name="active-tab"></slot>
-            </template>
-          </template>
-          <template v-else>
-            <Sidebar
-              v-show="!isMobile"
-              :spec="spec" />
-          </template>
-          <ApiClient
-            :proxyUrl="proxyUrl"
-            @escapeKeyPress="hideApiClient" />
-        </div>
-      </div>
-    </div>
-  </div>
-  <div
-    v-if="state.showApiClient"
-    class="api-client-drawer-exit"
-    @click="hideApiClient"></div>
-</template>
-
-<style scoped>
-.scalar-api-client__container .scalar-api-client {
-  width: calc(100% - var(--scalar-api-reference-theme-sidebar-width));
-}
-
-.scalar-api-client__container {
-  position: absolute;
-  right: 0;
-  left: 0;
-  bottom: 0;
-  top: 0;
-  z-index: 9;
-  border-radius: 0;
-  box-shadow: none;
-  opacity: 1;
-  overflow: hidden;
-  pointer-events: all;
-  background: var(--theme-background-1) !important;
-  border-radius: var(--theme-radius-lg);
-  box-shadow: var(--theme-shadow-1);
-  height: 100%;
-  overflow: hidden;
-  display: flex;
-  flex-direction: column;
-}
-
-@media screen and (max-width: 1265px) {
-  .scalar-api-client__container {
-    width: 100vw !important;
-  }
-}
-
-.scalar-api-client__navigation {
-  width: 100%;
-  display: flex;
-  align-items: center;
-  padding: 11px 12px;
-  height: var(--scalar-api-reference-theme-header-height);
-  background-color: var(--theme-background-1);
-  z-index: 10;
-  position: sticky;
-  border-bottom: 1px solid var(--theme-border-color);
-  top: 0;
-}
-
-.scalar-api-client__close {
-  appearance: none;
-  border: none;
-  outline: none;
-  display: flex;
-  align-items: center;
-  background: transparent;
-  font-size: 14px;
-  color: var(--theme-color-1);
-  font-weight: var(--theme-semibold);
-}
-.scalar-api-client__close:hover {
-  cursor: pointer;
-}
-/*
-TODO: Markup is missing
-.scalar-api-client__close__icon {
-  width: 28px;
-  height: 28px;
-  border-radius: var(--theme-radius-lg);
-  margin-right: 12px;
-  display: flex;
-  justify-content: center;
-  align-items: center;
-  color: var(--theme-color-2);
-}
-.scalar-api-client__close__icon:hover {
-  background: var(--theme-background-2);
-}
-.scalar-api-client__close__icon svg {
-  width: 12px;
-  height: 12px;
-  transform: rotate(180deg);
-} */
-.api-client-drawer {
-  background: var(--theme-background-1);
-  height: calc(100vh - 58px);
-  width: calc(100vw - 8px);
-  border-radius: 12px;
-  overflow: hidden;
-  visibility: visible;
-  position: fixed;
-  bottom: 4px;
-  left: 4px;
-  z-index: 9999;
-  opacity: 0;
-  animation: apiclientfadein 0.35s forwards;
-}
-@keyframes apiclientfadein {
-  from {
-    transform: translate3d(0, 20px, 0) scale(0.985);
-    opacity: 0;
-  }
-  to {
-    transform: translate3d(0, 0, 0) scale(1);
-    opacity: 1;
-  }
-}
-.api-client-drawer-exit {
-  position: fixed;
-  top: 0;
-  left: 0;
-  width: 100vw;
-  height: 100vh;
-  background: rgba(0, 0, 0, 0.44);
-  transition: all 0.3s ease-in-out;
-  z-index: 9998;
-  cursor: pointer;
-  animation: drawerexitfadein 0.35s forwards;
-}
-@keyframes drawerexitfadein {
-  from {
-    opacity: 0;
-  }
-  to {
-    opacity: 1;
-  }
-}
-.scalar-api-client-height {
-  height: 100%;
-}
-.scalar-api-client-height .sidebar {
-  flex: 1 1 0%;
-  flex-grow: 1;
-  flex-shrink: 1;
-  flex-basis: 0%;
-  height: 100%;
-  display: flex;
-  flex-direction: column;
-  width: var(--scalar-api-reference-theme-sidebar-width);
-  border-right: 1px solid var(--theme-border-color);
-}
-</style>