@scalar/api-reference 0.4.0 → 0.5.1

package/src/components/Content/ReferenceEndpoint/ExampleResponses/index.ts

@@ -0,0 +1 @@
+export { default as ExampleResponses } from './ExampleResponses.vue'

package/src/components/Content/ReferenceEndpoint/ReferenceEndpoint.vue

@@ -2,7 +2,7 @@
 import type { Server, Tag, TransformedOperation } from '../../../types'
 import Copy from './Copy.vue'
 import ExampleRequest from './ExampleRequest.vue'
-import ExampleResponses from './ExampleResponses.vue'
+import { ExampleResponses } from './ExampleResponses'
 
 defineProps<{
   operation: TransformedOperation

package/src/components/Sidebar.vue

@@ -1,6 +1,10 @@
 <script setup lang="ts">
-import { generateRequest, useApiClientRequestStore } from '@scalar/api-client'
-import { useApiClientStore, useOperation } from '@scalar/api-client'
+import {
+  generateRequest,
+  useApiClientRequestStore,
+  useApiClientStore,
+  useOperation,
+} from '@scalar/api-client'
 import { useKeyboardEvent } from '@scalar/use-keyboard-event'
 import { useMediaQuery } from '@vueuse/core'
 

package/src/components/SimpleTable/SimpleCell.vue

@@ -30,6 +30,7 @@ withDefaults(
   padding: 0.25em 0.5em;
   color: var(--theme-color-1);
   white-space: nowrap;
+  vertical-align: top;
 }
 
 .simple-cell:last-of-type {

package/src/helpers/index.ts

@@ -1,4 +1,5 @@
 export { generateAxiosCodeFromRequest } from './generateAxiosCodeFromRequest'
 export { generateLaravelCodeFromRequest } from './generateLaravelCodeFromRequest'
+export { mapFromObject } from './mapFromObject'
 export { objectMerge } from './objectMerge'
 export { transformToJson } from './transformToJson'

package/src/helpers/mapFromObject.ts

@@ -0,0 +1,11 @@
+/**
+ * Map an object to an array of key-value pairs.
+ */
+export const mapFromObject = (object: Record<string, any>) => {
+  return Object.keys(object).map((key) => {
+    return {
+      key,
+      value: object[key],
+    }
+  })
+}

package/src/types.ts

@@ -1,8 +1,4 @@
 export type ReferenceProps = {
-  documentName?: string
-  token?: string
-  username?: string
-  hocusPocusUrl?: string
   isEditable?: boolean
   showSidebar?: boolean
   footerBelowSidebar?: boolean
@@ -52,20 +48,23 @@ export type Operation = {
   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
     }
   >
 }

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":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;AA8W1D,wBAAkD"}