@scalar/api-reference 0.3.4 → 0.5.0
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.
- package/README.md +44 -0
- package/dist/components/ApiReference.vue.d.ts +0 -24
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ExampleResponses.vue.d.ts.map +1 -1
- package/dist/index.js +24067 -24011
- package/dist/types.d.ts +0 -4
- package/dist/types.d.ts.map +1 -1
- package/package.json +31 -11
- package/src/components/ApiReference.vue +0 -4
- package/src/components/Content/ReferenceEndpoint/ExampleRequest.vue +4 -3
- package/src/components/Content/ReferenceEndpoint/ExampleResponses.vue +2 -1
- package/src/types.ts +0 -4
package/dist/types.d.ts
CHANGED
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,27 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scalar/api-reference",
|
|
3
|
-
"
|
|
4
|
-
"
|
|
3
|
+
"description": "generate beautiful API references from OpenAPI specs",
|
|
4
|
+
"keywords": [
|
|
5
|
+
"vue",
|
|
6
|
+
"vue3",
|
|
7
|
+
"swagger",
|
|
8
|
+
"openapi",
|
|
9
|
+
"spec",
|
|
10
|
+
"reference",
|
|
11
|
+
"documentation",
|
|
12
|
+
"component"
|
|
13
|
+
],
|
|
14
|
+
"version": "0.5.0",
|
|
15
|
+
"author": "Scalar (https://github.com/scalar)",
|
|
16
|
+
"homepage": "https://github.com/scalar/scalar",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "https://github.com/scalar/scalar.git",
|
|
20
|
+
"directory": "packages/api-reference"
|
|
21
|
+
},
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/scalar/scalar/issues/new"
|
|
24
|
+
},
|
|
5
25
|
"license": "MIT",
|
|
6
26
|
"engines": {
|
|
7
27
|
"node": ">=18"
|
|
@@ -21,7 +41,6 @@
|
|
|
21
41
|
"dependencies": {
|
|
22
42
|
"@headlessui/vue": "1.7.14",
|
|
23
43
|
"@vueuse/core": "10.1.2",
|
|
24
|
-
"codemirror": "6.0.1",
|
|
25
44
|
"fuse.js": "^6.6.2",
|
|
26
45
|
"httpsnippet-lite": "3.0.5",
|
|
27
46
|
"js-yaml": "4.1.0",
|
|
@@ -39,14 +58,15 @@
|
|
|
39
58
|
"typographic-base": "1.0.4",
|
|
40
59
|
"unified": "10.1.2",
|
|
41
60
|
"xmldom": "0.6.0",
|
|
42
|
-
"@scalar/api-client": "0.
|
|
43
|
-
"@scalar/default-theme": "0.
|
|
44
|
-
"@scalar/swagger-editor": "0.
|
|
45
|
-
"@scalar/swagger-parser": "0.
|
|
46
|
-
"@scalar/use-clipboard": "0.
|
|
47
|
-
"@scalar/use-
|
|
48
|
-
"@scalar/use-
|
|
49
|
-
"@scalar/use-
|
|
61
|
+
"@scalar/api-client": "0.5.0",
|
|
62
|
+
"@scalar/default-theme": "0.2.1",
|
|
63
|
+
"@scalar/swagger-editor": "0.5.0",
|
|
64
|
+
"@scalar/swagger-parser": "0.4.1",
|
|
65
|
+
"@scalar/use-clipboard": "0.4.1",
|
|
66
|
+
"@scalar/use-codemirror": "0.5.0",
|
|
67
|
+
"@scalar/use-keyboard-event": "0.4.1",
|
|
68
|
+
"@scalar/use-toasts": "0.4.1",
|
|
69
|
+
"@scalar/use-tooltip": "0.4.1"
|
|
50
70
|
},
|
|
51
71
|
"devDependencies": {
|
|
52
72
|
"@vitejs/plugin-vue": "4.2.3",
|
|
@@ -180,10 +180,6 @@ const breadCrumbs = computed(() => {
|
|
|
180
180
|
v-show="showCodeEditor"
|
|
181
181
|
class="layout-content">
|
|
182
182
|
<LazyLoadedSwaggerEditor
|
|
183
|
-
:documentName="documentName"
|
|
184
|
-
:hocusPocusUrl="hocusPocusUrl"
|
|
185
|
-
:token="token"
|
|
186
|
-
:username="username"
|
|
187
183
|
:value="specRef"
|
|
188
184
|
@specUpdate="handleSpecUpdate" />
|
|
189
185
|
</div>
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
<script setup lang="ts">
|
|
2
2
|
import {
|
|
3
|
-
CodeMirror,
|
|
4
3
|
generateRequest,
|
|
5
4
|
useApiClientRequestStore,
|
|
6
5
|
useApiClientStore,
|
|
7
6
|
useOperation,
|
|
8
7
|
} from '@scalar/api-client'
|
|
9
8
|
import { useClipboard } from '@scalar/use-clipboard'
|
|
9
|
+
import { CodeMirror } from '@scalar/use-codemirror'
|
|
10
10
|
import {
|
|
11
11
|
HTTPSnippet,
|
|
12
12
|
type HarRequest,
|
|
@@ -176,9 +176,10 @@ const availableLanguages = computed(() => {
|
|
|
176
176
|
<!-- @vue-ignore -->
|
|
177
177
|
<CodeMirror
|
|
178
178
|
:content="CodeMirrorValue"
|
|
179
|
+
:forceDarkMode="true"
|
|
179
180
|
:languages="CodeMirrorLanguages"
|
|
180
|
-
|
|
181
|
-
|
|
181
|
+
lineNumbers
|
|
182
|
+
readOnly />
|
|
182
183
|
</CardContent>
|
|
183
184
|
<CardFooter muted>
|
|
184
185
|
<button
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
<script lang="ts" setup>
|
|
2
|
-
import {
|
|
2
|
+
import { type HttpHeader, httpHeaders } from '@scalar/api-client'
|
|
3
3
|
import { useClipboard } from '@scalar/use-clipboard'
|
|
4
|
+
import { CodeMirror } from '@scalar/use-codemirror'
|
|
4
5
|
import { computed, ref } from 'vue'
|
|
5
6
|
|
|
6
7
|
import type { TransformedOperation } from '../../../types'
|