@scalar/api-reference 1.0.6 → 1.1.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/CHANGELOG.md +15 -0
- package/dist/browser/standalone.js +37310 -37184
- package/dist/components/ApiClientModal.vue.d.ts +0 -8
- package/dist/components/ApiClientModal.vue.d.ts.map +1 -1
- package/dist/components/ApiReference.vue.d.ts +5 -101
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceBase.vue.d.ts +34 -0
- package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -0
- package/dist/components/ApiReferenceLayout.vue.d.ts +8 -15
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/Content/ReferenceEndpoint/ExampleRequest.vue.d.ts.map +1 -1
- package/dist/components/Content/Schema.vue.d.ts +6 -6
- package/dist/components/Content/SchemaProperty.vue.d.ts +6 -6
- package/dist/components/DarkModeToggle.vue.d.ts +1 -15
- package/dist/components/DarkModeToggle.vue.d.ts.map +1 -1
- package/dist/components/FlowIconButton.vue.d.ts +8 -8
- package/dist/components/MobileHeader.vue.d.ts +1 -22
- package/dist/components/MobileHeader.vue.d.ts.map +1 -1
- package/dist/components/{FindAnythingButton.vue.d.ts → SearchButton.vue.d.ts} +1 -1
- package/dist/components/SearchButton.vue.d.ts.map +1 -0
- package/dist/components/Sidebar.vue.d.ts +11 -25
- package/dist/components/Sidebar.vue.d.ts.map +1 -1
- package/dist/helpers/getExampleFromSchema.d.ts +6 -1
- package/dist/helpers/getExampleFromSchema.d.ts.map +1 -1
- package/dist/helpers/getRequestFromOperation.d.ts.map +1 -1
- package/dist/helpers/index.d.ts +1 -0
- package/dist/helpers/index.d.ts.map +1 -1
- package/dist/helpers/json2xml.d.ts +5 -0
- package/dist/helpers/json2xml.d.ts.map +1 -0
- package/dist/hooks/useParser.d.ts +23 -31
- package/dist/hooks/useParser.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10526 -10432
- package/dist/types.d.ts +15 -27
- package/dist/types.d.ts.map +1 -1
- package/package.json +6 -6
- package/dist/components/FindAnythingButton.vue.d.ts.map +0 -1
package/dist/types.d.ts
CHANGED
|
@@ -2,30 +2,9 @@ import { type EditorHeaderTabs, type HocuspocusConfigurationProp } from '@scalar
|
|
|
2
2
|
import { type ThemeId } from '@scalar/themes';
|
|
3
3
|
import type { HarRequest } from 'httpsnippet-lite';
|
|
4
4
|
import { type OpenAPIV2, type OpenAPIV3, type OpenAPIV3_1 } from 'openapi-types';
|
|
5
|
+
import { type DeepReadonly } from 'vue';
|
|
5
6
|
export type ReferenceProps = {
|
|
6
7
|
configuration?: ReferenceConfiguration;
|
|
7
|
-
aiWriterMarkdown?: string;
|
|
8
|
-
} & {
|
|
9
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
10
|
-
spec?: string;
|
|
11
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
12
|
-
specUrl?: string;
|
|
13
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
14
|
-
specResult?: Record<any, any>;
|
|
15
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
16
|
-
proxyUrl?: string;
|
|
17
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
18
|
-
theme?: ThemeId;
|
|
19
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
20
|
-
initialTabState?: EditorHeaderTabs;
|
|
21
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
22
|
-
showSidebar?: boolean;
|
|
23
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
24
|
-
footerBelowSidebar?: boolean;
|
|
25
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
26
|
-
isEditable?: boolean;
|
|
27
|
-
/** @deprecated Use the `configuration` prop instead. */
|
|
28
|
-
hocuspocusConfiguration?: HocuspocusConfigurationProp;
|
|
29
8
|
};
|
|
30
9
|
export type SpecConfiguration = {
|
|
31
10
|
/** URL to a Swagger/OpenAPI file */
|
|
@@ -52,13 +31,15 @@ export type ReferenceConfiguration = {
|
|
|
52
31
|
};
|
|
53
32
|
/** Whether to show the sidebar */
|
|
54
33
|
showSidebar?: boolean;
|
|
55
|
-
/** Whether to make the footer full-width (include below the sidebar) */
|
|
56
|
-
footerBelowSidebar?: boolean;
|
|
57
34
|
/** Remove the Scalar branding :( */
|
|
58
35
|
hocuspocusConfiguration?: HocuspocusConfigurationProp;
|
|
59
36
|
/** Key used with CNTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
|
|
60
37
|
searchHotKey?: string;
|
|
38
|
+
/** ??? */
|
|
39
|
+
aiWriterMarkdown?: string;
|
|
61
40
|
};
|
|
41
|
+
/** Default reference configuration */
|
|
42
|
+
export declare const DEFAULT_CONFIG: DeepReadonly<ReferenceConfiguration>;
|
|
62
43
|
export type Schema = {
|
|
63
44
|
format: string;
|
|
64
45
|
type: string;
|
|
@@ -100,10 +81,17 @@ export type ExampleResponseHeaders = Record<string, {
|
|
|
100
81
|
example?: string;
|
|
101
82
|
};
|
|
102
83
|
}>;
|
|
84
|
+
export type RequestBodyMimeTypes = 'application/json' | 'application/octet-stream' | 'application/x-www-form-urlencoded' | 'application/xml' | 'multipart/form-data' | 'text/plain';
|
|
103
85
|
export type TransformedOperation = Operation & {
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
86
|
+
information: {
|
|
87
|
+
requestBody?: {
|
|
88
|
+
content?: Record<RequestBodyMimeTypes, {
|
|
89
|
+
schema?: any;
|
|
90
|
+
example?: any;
|
|
91
|
+
examples?: any;
|
|
92
|
+
}>;
|
|
93
|
+
};
|
|
94
|
+
};
|
|
107
95
|
};
|
|
108
96
|
export type Tag = {
|
|
109
97
|
name: string;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EACjC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,2BAA2B,EACjC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,KAAK,CAAA;AAEvC,MAAM,MAAM,cAAc,GAAG;IAC3B,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;IACpE,2CAA2C;IAC3C,gBAAgB,CAAC,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACpC,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,+CAA+C;IAC/C,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,oDAAoD;IACpD,IAAI,CAAC,EAAE;QACL,+BAA+B;QAE/B,8BAA8B;QAC9B,cAAc,CAAC,EAAE,gBAAgB,CAAA;KAClC,CAAA;IACD,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,oCAAoC;IAEpC,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU;IACV,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,sBAAsB,CAc/D,CAAA;AAED,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,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAC/C,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,GAC5B,kBAAkB,GAClB,0BAA0B,GAC1B,mCAAmC,GACnC,iBAAiB,GACjB,qBAAqB,GACrB,YAAY,CAAA;AAEhB,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG;IAC7C,WAAW,EAAE;QACX,WAAW,CAAC,EAAE;YACZ,OAAO,CAAC,EAAE,MAAM,CACd,oBAAoB,EACpB;gBACE,MAAM,CAAC,EAAE,GAAG,CAAA;gBACZ,OAAO,CAAC,EAAE,GAAG,CAAA;gBACb,QAAQ,CAAC,EAAE,GAAG,CAAA;aACf,CACF,CAAA;SACF,CAAA;KACF,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,eAAe,GAAG,MAAM,CAClC,MAAM,EACN;IACE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CAC3B,CACF,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,eAAe,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,UAAU,GAClB,SAAS,CAAC,gBAAgB,GAC1B,WAAW,CAAC,gBAAgB,CAAA;AAEhC,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,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;IACjB,UAAU,CAAC,EAAE,UAAU,CAAA;IACvB,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,eAAe,CAAC,EACZ,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,oBAAoB,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,oBAAoB,CAAC,CAAA;IACpD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,QAAQ,EAAE,MAAM,CAAA;YAChB,QAAQ,EAAE,MAAM,CAAA;SACjB,CAAA;QACD,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,cAAc,EAAE,IAAI,GAAG,MAAM,CAAA;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,EAAE,QAAQ,EAAE,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG;IAC5C,IAAI,EAAE,MAAM,CAAA;CACb,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scalar/api-reference",
|
|
3
3
|
"description": "generate beautiful API references from OpenAPI specs",
|
|
4
|
-
"version": "1.0
|
|
4
|
+
"version": "1.1.0",
|
|
5
5
|
"author": "Scalar (https://github.com/scalar)",
|
|
6
6
|
"browser": "./dist/browser/standalone.js",
|
|
7
7
|
"bugs": "https://github.com/scalar/scalar/issues/new",
|
|
@@ -29,15 +29,15 @@
|
|
|
29
29
|
"remark-stringify": "11.0.0",
|
|
30
30
|
"unified": "11.0.3",
|
|
31
31
|
"@scalar/api-client": "0.7.31",
|
|
32
|
-
"@scalar/swagger-editor": "0.7.3",
|
|
33
32
|
"@scalar/swagger-parser": "0.5.7",
|
|
33
|
+
"@scalar/swagger-editor": "0.7.4",
|
|
34
34
|
"@scalar/themes": "0.4.0",
|
|
35
35
|
"@scalar/use-clipboard": "0.5.6",
|
|
36
|
-
"@scalar/use-codemirror": "0.7.12",
|
|
37
36
|
"@scalar/use-keyboard-event": "0.5.3",
|
|
38
|
-
"@scalar/use-
|
|
37
|
+
"@scalar/use-codemirror": "0.7.12",
|
|
39
38
|
"@scalar/use-toasts": "0.5.6",
|
|
40
|
-
"@scalar/use-tooltip": "0.5.4"
|
|
39
|
+
"@scalar/use-tooltip": "0.5.4",
|
|
40
|
+
"@scalar/use-modal": "0.1.6"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@storybook/addon-essentials": "7.4.3",
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
"remark-stringify": "11.0.0",
|
|
101
101
|
"unified": "11.0.3",
|
|
102
102
|
"vue": "3.3.4",
|
|
103
|
-
"@scalar/swagger-editor": "0.7.
|
|
103
|
+
"@scalar/swagger-editor": "0.7.4"
|
|
104
104
|
},
|
|
105
105
|
"repository": {
|
|
106
106
|
"type": "git",
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"FindAnythingButton.vue.d.ts","sourceRoot":"","sources":["../../src/components/FindAnythingButton.vue.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAwIA,wBAAkD"}
|