@scalar/api-reference 1.4.0 → 1.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/CHANGELOG.md +16 -0
- package/README.md +12 -18
- package/dist/browser/standalone.js +7 -7
- package/dist/components/ApiReference.vue.d.ts +5 -1
- package/dist/components/ApiReference.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceBase.vue.d.ts +0 -2
- package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
- package/dist/components/ApiReferenceLayout.vue.d.ts +304 -82
- package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
- package/dist/components/GettingStarted.vue.d.ts +27 -0
- package/dist/components/GettingStarted.vue.d.ts.map +1 -0
- package/dist/index-06c444c3.js +879 -0
- package/dist/{index-0f5b8a92.js → index-1820592b.js} +17517 -17596
- package/dist/index.js +8 -8
- package/dist/types.d.ts +4 -10
- package/dist/types.d.ts.map +1 -1
- package/package.json +7 -7
- package/dist/index-1eca3167.js +0 -1006
package/dist/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type HocuspocusConfigurationProp } from '@scalar/swagger-editor';
|
|
2
2
|
import { type ThemeId } from '@scalar/themes';
|
|
3
3
|
import type { MetaFlatInput } from '@unhead/schema';
|
|
4
4
|
import type { HarRequest } from 'httpsnippet-lite';
|
|
@@ -26,28 +26,22 @@ export type ReferenceConfiguration = {
|
|
|
26
26
|
proxy?: string;
|
|
27
27
|
/** Whether the spec input should show */
|
|
28
28
|
isEditable?: boolean;
|
|
29
|
-
/** The tabs (only visible when isEditable: true) */
|
|
30
|
-
tabs?: {
|
|
31
|
-
/** Disabled tabs completely */
|
|
32
|
-
/** The initial tab to show */
|
|
33
|
-
initialContent?: EditorHeaderTabs;
|
|
34
|
-
available?: EditorHeaderTabs[];
|
|
35
|
-
};
|
|
36
29
|
/** Whether to show the sidebar */
|
|
37
30
|
showSidebar?: boolean;
|
|
38
31
|
/** Remove the Scalar branding :( */
|
|
39
32
|
hocuspocusConfiguration?: HocuspocusConfigurationProp;
|
|
40
33
|
/** Key used with CNTRL/CMD to open the search modal (defaults to 'k' e.g. CMD+k) */
|
|
41
34
|
searchHotKey?: string;
|
|
42
|
-
/** ??? */
|
|
43
|
-
aiWriterMarkdown?: string;
|
|
44
35
|
/** If used, passed data will be added to the HTML header. Read more: https://unhead.unjs.io/usage/composables/use-seo-meta */
|
|
45
36
|
metaData?: MetaFlatInput;
|
|
46
37
|
/** Custom CSS to be added to the page */
|
|
47
38
|
customCss?: string;
|
|
39
|
+
/** onSpecUpdate is fired on spec/swagger content change */
|
|
40
|
+
onSpecUpdate?: (spec: string) => void;
|
|
48
41
|
};
|
|
49
42
|
/** Default reference configuration */
|
|
50
43
|
export declare const DEFAULT_CONFIG: DeepReadonly<ReferenceConfiguration>;
|
|
44
|
+
export type GettingStartedExamples = 'Petstore' | 'CoinMarketCap';
|
|
51
45
|
export type Schema = {
|
|
52
46
|
format: string;
|
|
53
47
|
type: 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,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAA;AACzE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,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,KAAK,IAAI,EAAE,MAAM,KAAK,CAAA;AAElD,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,2CAA2C;IAC3C,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,yCAAyC;IACzC,IAAI,CAAC,EAAE,iBAAiB,CAAA;IACxB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,oCAAoC;IAEpC,uBAAuB,CAAC,EAAE,2BAA2B,CAAA;IACrD,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,8HAA8H;IAC9H,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,yCAAyC;IACzC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CACtC,CAAA;AAED,sCAAsC;AACtC,eAAO,MAAM,cAAc,EAAE,YAAY,CAAC,sBAAsB,CAW/D,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,GAAG,eAAe,CAAA;AAEjE,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,GAAG,CAAA;CACd,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,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC7B,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IACpC,QAAQ,CAAC,EAAE,SAAS,CAAC,yBAAyB,EAAE,CAAA;IAChD,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB,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,cAAc,CAAC,EAAE,UAAU,EAAE,CAAA;IAC7B,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,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,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,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,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,GAAG,IAAI,CAC3B,SAAS,CAAC,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,EACzD,iBAAiB,CAClB,GAAG;IACF,eAAe,CAAC,EAAE,MAAM,CACtB,MAAM,EACJ,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,SAAS,CAAC,oBAAoB,GAC9B,SAAS,CAAC,oBAAoB,CACjC,CAAA;CACF,CAAA;AAED,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,iBAAiB,CAAA;AAErD,MAAM,MAAM,IAAI,GAAG;IACjB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAA;IACZ,IAAI,EAAE,IAAI,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,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;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAA;AAEtD,yDAAyD;AACzD,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAA;AAEpC,MAAM,MAAM,cAAc,GAAG;KAE1B,CAAC,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAClD,CAAA;AAED,2DAA2D;AAC3D,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,eAAe,GACf,aAAa,GACb,eAAe,GACf,aAAa,CAAA;AAEjB,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,IAAI,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA"}
|
package/package.json
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"vue",
|
|
16
16
|
"vue3"
|
|
17
17
|
],
|
|
18
|
-
"version": "1.
|
|
18
|
+
"version": "1.5.0",
|
|
19
19
|
"engines": {
|
|
20
20
|
"node": ">=20"
|
|
21
21
|
},
|
|
@@ -61,16 +61,16 @@
|
|
|
61
61
|
"remark-stringify": "^11.0.0",
|
|
62
62
|
"unhead": "^1.8.3",
|
|
63
63
|
"unified": "^11.0.0",
|
|
64
|
-
"@scalar/api-client": "0.
|
|
65
|
-
"@scalar/swagger-editor": "0.
|
|
66
|
-
"@scalar/themes": "0.4.2",
|
|
64
|
+
"@scalar/api-client": "0.8.0",
|
|
65
|
+
"@scalar/swagger-editor": "0.8.0",
|
|
67
66
|
"@scalar/swagger-parser": "0.5.12",
|
|
67
|
+
"@scalar/themes": "0.5.0",
|
|
68
68
|
"@scalar/use-clipboard": "0.5.9",
|
|
69
69
|
"@scalar/use-codemirror": "0.7.15",
|
|
70
70
|
"@scalar/use-keyboard-event": "0.5.6",
|
|
71
|
-
"@scalar/use-modal": "0.
|
|
72
|
-
"@scalar/use-
|
|
73
|
-
"@scalar/use-
|
|
71
|
+
"@scalar/use-modal": "0.2.0",
|
|
72
|
+
"@scalar/use-tooltip": "0.5.7",
|
|
73
|
+
"@scalar/use-toasts": "0.5.9"
|
|
74
74
|
},
|
|
75
75
|
"devDependencies": {
|
|
76
76
|
"@etchteam/storybook-addon-css-variables-theme": "^1.5.1",
|