@scalar/api-reference 0.4.0 → 0.5.1

package/README.md

@@ -0,0 +1,44 @@
+# Scalar API Reference
+
+![Version](https://img.shields.io/npm/v/%40scalar/api-reference)
+![Downloads](https://img.shields.io/npm/dm/%40scalar/api-reference)
+![License](https://img.shields.io/npm/l/%40scalar%2Fapi-reference)
+[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/mw6FQRPh)
+
+## Installation
+
+```bash
+npm install @scalar/api-reference
+```
+
+## Usage
+
+```vue
+<script setup>
+import { ApiReference } from '@scalar/api-reference'
+</script>
+
+<template>
+  <ApiReference />
+</template>
+```
+
+## Props
+
+### isEditable?: boolean
+
+```vue
+<ApiReference :isEditable="true" />
+```
+
+### spec?: string
+
+```vue
+<ApiReference spec="{ … }" />
+```
+
+### specUrl?: string
+
+```vue
+<ApiReference specUrl="/swagger.json" />
+```

package/dist/components/ApiReference.vue.d.ts

@@ -4,18 +4,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     spec: {
         type: import("vue").PropType<string>;
     };
-    documentName: {
-        type: import("vue").PropType<string>;
-    };
-    token: {
-        type: import("vue").PropType<string>;
-    };
-    username: {
-        type: import("vue").PropType<string>;
-    };
-    hocusPocusUrl: {
-        type: import("vue").PropType<string>;
-    };
     isEditable: {
         type: import("vue").PropType<boolean>;
         default: boolean;
@@ -34,18 +22,6 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     spec: {
         type: import("vue").PropType<string>;
     };
-    documentName: {
-        type: import("vue").PropType<string>;
-    };
-    token: {
-        type: import("vue").PropType<string>;
-    };
-    username: {
-        type: import("vue").PropType<string>;
-    };
-    hocusPocusUrl: {
-        type: import("vue").PropType<string>;
-    };
     isEditable: {
         type: import("vue").PropType<boolean>;
         default: boolean;

package/dist/components/ApiReference.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAGA,OAAO,qCAAqC,CAAA;AAC5C,OAAO,iCAAiC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkYxC,wBAA8G;AAU9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
+{"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAGA,OAAO,qCAAqC,CAAA;AAC5C,OAAO,iCAAiC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkYxC,wBAA8G;AAU9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}

package/dist/components/Content/Introduction/BaseUrl.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BaseUrl.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/BaseUrl.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAiFA,wBAAkD"}
+{"version":3,"file":"BaseUrl.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/BaseUrl.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AA6FA,wBAAkD"}

package/dist/components/Content/MarkdownRenderer.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MarkdownRenderer.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/MarkdownRenderer.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AA8HA,wBAAkD"}
+{"version":3,"file":"MarkdownRenderer.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/MarkdownRenderer.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AAgIA,wBAAkD"}

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

@@ -1 +1 @@
-{"version":3,"file":"Copy.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/Copy.vue.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,SAAS,EAGf,MAAM,oBAAoB,CAAA;AAK3B,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAoMzC,wBAAkD"}
+{"version":3,"file":"Copy.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/Copy.vue.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,SAAS,EAGf,MAAM,oBAAoB,CAAA;AAK3B,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAgNzC,wBAAkD"}

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

@@ -1 +1 @@
-{"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleRequest.vue.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAqXvD,wBAAkD"}
+{"version":3,"file":"ExampleRequest.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/ReferenceEndpoint/ExampleRequest.vue.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;AAkYvD,wBAAkD"}

package/dist/components/Content/ReferenceEndpoint/{ExampleResponses.vue.d.ts → ExampleResponses/ExampleResponses.vue.d.ts}

@@ -1,4 +1,4 @@
-import type { TransformedOperation } from '../../../types';
+import type { TransformedOperation } from '../../../../types';
 declare const _default: import("vue").DefineComponent<{
     operation: {
         type: import("vue").PropType<TransformedOperation>;

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

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

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

@@ -0,0 +1,14 @@
+import type { ExampleResponseHeaders } from '../../../../types';
+declare const _default: import("vue").DefineComponent<{
+    headers: {
+        type: import("vue").PropType<ExampleResponseHeaders>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    headers: {
+        type: import("vue").PropType<ExampleResponseHeaders>;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;
+//# sourceMappingURL=Headers.vue.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Headers.vue.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/ReferenceEndpoint/ExampleResponses/Headers.vue.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;;;;;;;;;;;;AAqP/D,wBAAkD"}

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

@@ -0,0 +1,13 @@
+declare const _default: import("vue").DefineComponent<{
+    examples: {
+        type: import("vue").PropType<Record<string, any>>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    examples: {
+        type: import("vue").PropType<Record<string, any>>;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;
+//# sourceMappingURL=SelectExample.vue.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SelectExample.vue.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/ReferenceEndpoint/ExampleResponses/SelectExample.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AA4MA,wBAAkD"}

package/dist/components/Content/ReferenceEndpoint/ExampleResponses/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ExampleResponses } from './ExampleResponses.vue';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/Content/ReferenceEndpoint/ExampleResponses/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,gBAAgB,EAAE,MAAM,wBAAwB,CAAA"}

package/dist/components/Sidebar.vue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,UAAU,CAAA;;;;;;;;;;;;AAqN/C,wBAAkD"}
+{"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,UAAU,CAAA;;;;;;;;;;;;AAqN/C,wBAAkD"}

package/dist/helpers/index.d.ts

@@ -1,5 +1,6 @@
 export { generateAxiosCodeFromRequest } from './generateAxiosCodeFromRequest';
 export { generateLaravelCodeFromRequest } from './generateLaravelCodeFromRequest';
+export { mapFromObject } from './mapFromObject';
 export { objectMerge } from './objectMerge';
 export { transformToJson } from './transformToJson';
 //# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAA;AACjF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,EAAE,8BAA8B,EAAE,MAAM,kCAAkC,CAAA;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA"}

package/dist/helpers/mapFromObject.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Map an object to an array of key-value pairs.
+ */
+export declare const mapFromObject: (object: Record<string, any>) => {
+    key: string;
+    value: any;
+}[];
+//# sourceMappingURL=mapFromObject.d.ts.map

package/dist/helpers/mapFromObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mapFromObject.d.ts","sourceRoot":"","sources":["../../src/helpers/mapFromObject.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,aAAa,WAAY,OAAO,MAAM,EAAE,GAAG,CAAC;;;GAOxD,CAAA"}