@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.
Files changed (18) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +12 -18
  3. package/dist/browser/standalone.js +7 -7
  4. package/dist/components/ApiReference.vue.d.ts +5 -1
  5. package/dist/components/ApiReference.vue.d.ts.map +1 -1
  6. package/dist/components/ApiReferenceBase.vue.d.ts +0 -2
  7. package/dist/components/ApiReferenceBase.vue.d.ts.map +1 -1
  8. package/dist/components/ApiReferenceLayout.vue.d.ts +304 -82
  9. package/dist/components/ApiReferenceLayout.vue.d.ts.map +1 -1
  10. package/dist/components/GettingStarted.vue.d.ts +27 -0
  11. package/dist/components/GettingStarted.vue.d.ts.map +1 -0
  12. package/dist/index-06c444c3.js +879 -0
  13. package/dist/{index-0f5b8a92.js → index-1820592b.js} +17517 -17596
  14. package/dist/index.js +8 -8
  15. package/dist/types.d.ts +4 -10
  16. package/dist/types.d.ts.map +1 -1
  17. package/package.json +7 -7
  18. package/dist/index-1eca3167.js +0 -1006
package/dist/components/ApiReference.vue.d.ts CHANGED
@@ -1,5 +1,9 @@
1
1
  import { type ReferenceProps } from '../types';
2
- declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<ReferenceProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ReferenceProps>>>, {}, {}>, {
2
+ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<ReferenceProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
3
+ updateContent: (value: string) => void;
4
+ }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ReferenceProps>>> & {
5
+ onUpdateContent?: ((value: string) => any) | undefined;
6
+ }, {}, {}>, {
3
7
  footer?(_: {}): any;
4
8
  }>;
5
9
  export default _default;
package/dist/components/ApiReference.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,cAAc,EAA0B,MAAM,UAAU,CAAA;;;;AAkGtE,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,cAAc,EAA0B,MAAM,UAAU,CAAA;;;;;;;;AA4GtE,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
package/dist/components/ApiReferenceBase.vue.d.ts CHANGED
@@ -3,11 +3,9 @@ import { type ReferenceProps, type ReferenceSlotProps } from '../types';
3
3
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<ReferenceProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
4
4
  changeTheme: (value: ThemeId) => void;
5
5
  updateContent: (value: string) => void;
6
- startAIWriter: (value: string[], swaggerData: string, swaggerType: "json" | "yaml") => void;
7
6
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ReferenceProps>>> & {
8
7
  onChangeTheme?: ((value: ThemeId) => any) | undefined;
9
8
  onUpdateContent?: ((value: string) => any) | undefined;
10
- onStartAIWriter?: ((value: string[], swaggerData: string, swaggerType: "json" | "yaml") => any) | undefined;
11
9
  }, {}, {}>, Readonly<{
12
10
  footer: (props: ReferenceSlotProps) => any;
13
11
  header: (props: ReferenceSlotProps) => any;
package/dist/components/ApiReferenceBase.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReferenceBase.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReferenceBase.vue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAe,MAAM,gBAAgB,CAAA;AAO1D,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,kBAAkB,EAExB,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;AA4QjB,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"ApiReferenceBase.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReferenceBase.vue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAe,MAAM,gBAAgB,CAAA;AAQ1D,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,kBAAkB,EAExB,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;AA6VjB,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
package/dist/components/ApiReferenceLayout.vue.d.ts CHANGED
@@ -4,10 +4,150 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
4
4
  configuration: ReferenceConfiguration;
5
5
  parsedSpec: Spec;
6
6
  rawSpec: string;
7
- swaggerEditorRef?: import("vue").DefineComponent<{
8
- aiWriterMarkdown: {
9
- type: import("vue").PropType<string>;
10
- };
7
+ swaggerEditorRef?: ({
8
+ new (...args: any[]): {
9
+ $: import("vue").ComponentInternalInstance;
10
+ $data: {};
11
+ $props: {
12
+ readonly theme?: ThemeId | undefined;
13
+ readonly hocuspocusConfiguration?: import("@scalar/swagger-editor").HocuspocusConfigurationProp | undefined;
14
+ key?: string | number | symbol | undefined;
15
+ readonly value?: string | undefined;
16
+ style?: unknown;
17
+ class?: unknown;
18
+ readonly error?: string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null | undefined;
19
+ ref?: import("vue").VNodeRef | undefined;
20
+ ref_for?: boolean | undefined;
21
+ ref_key?: string | undefined;
22
+ onVnodeBeforeMount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
23
+ [key: string]: any;
24
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
25
+ [key: string]: any;
26
+ }>) => void)[] | undefined;
27
+ onVnodeMounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
28
+ [key: string]: any;
29
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
30
+ [key: string]: any;
31
+ }>) => void)[] | undefined;
32
+ onVnodeBeforeUpdate?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
33
+ [key: string]: any;
34
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
35
+ [key: string]: any;
36
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
37
+ [key: string]: any;
38
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
39
+ [key: string]: any;
40
+ }>) => void)[] | undefined;
41
+ onVnodeUpdated?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
42
+ [key: string]: any;
43
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
44
+ [key: string]: any;
45
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
46
+ [key: string]: any;
47
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
48
+ [key: string]: any;
49
+ }>) => void)[] | undefined;
50
+ onVnodeBeforeUnmount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
51
+ [key: string]: any;
52
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
53
+ [key: string]: any;
54
+ }>) => void)[] | undefined;
55
+ onVnodeUnmounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
56
+ [key: string]: any;
57
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
58
+ [key: string]: any;
59
+ }>) => void)[] | undefined;
60
+ readonly proxyUrl?: string | undefined;
61
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
62
+ onImport?: ((value: string) => any) | undefined;
63
+ onContentUpdate?: ((value: string) => any) | undefined;
64
+ };
65
+ $attrs: {
66
+ [x: string]: unknown;
67
+ };
68
+ $refs: {
69
+ [x: string]: unknown;
70
+ };
71
+ $slots: Readonly<{
72
+ [name: string]: import("vue").Slot<any> | undefined;
73
+ }>;
74
+ $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
75
+ $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
76
+ $emit: ((event: "changeTheme", value: ThemeId) => void) & ((event: "contentUpdate", value: string) => void) & ((event: "import", value: string) => void);
77
+ $el: any;
78
+ $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
79
+ value: {
80
+ type: import("vue").PropType<string>;
81
+ };
82
+ hocuspocusConfiguration: {
83
+ type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
84
+ };
85
+ theme: {
86
+ type: import("vue").PropType<ThemeId>;
87
+ };
88
+ proxyUrl: {
89
+ type: import("vue").PropType<string>;
90
+ };
91
+ error: {
92
+ type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
93
+ };
94
+ }>> & {
95
+ onImport?: ((value: string) => any) | undefined;
96
+ onContentUpdate?: ((value: string) => any) | undefined;
97
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
98
+ }, {
99
+ handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
100
+ }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
101
+ contentUpdate: (value: string) => void;
102
+ import: (value: string) => void;
103
+ changeTheme: (value: ThemeId) => void;
104
+ }, string, {}, {}, string, {}> & {
105
+ beforeCreate?: ((() => void) | (() => void)[]) | undefined;
106
+ created?: ((() => void) | (() => void)[]) | undefined;
107
+ beforeMount?: ((() => void) | (() => void)[]) | undefined;
108
+ mounted?: ((() => void) | (() => void)[]) | undefined;
109
+ beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
110
+ updated?: ((() => void) | (() => void)[]) | undefined;
111
+ activated?: ((() => void) | (() => void)[]) | undefined;
112
+ deactivated?: ((() => void) | (() => void)[]) | undefined;
113
+ beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
114
+ beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
115
+ destroyed?: ((() => void) | (() => void)[]) | undefined;
116
+ unmounted?: ((() => void) | (() => void)[]) | undefined;
117
+ renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
118
+ renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
119
+ errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
120
+ };
121
+ $forceUpdate: () => void;
122
+ $nextTick: typeof import("vue").nextTick;
123
+ $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
124
+ } & Readonly<import("vue").ExtractPropTypes<{
125
+ value: {
126
+ type: import("vue").PropType<string>;
127
+ };
128
+ hocuspocusConfiguration: {
129
+ type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
130
+ };
131
+ theme: {
132
+ type: import("vue").PropType<ThemeId>;
133
+ };
134
+ proxyUrl: {
135
+ type: import("vue").PropType<string>;
136
+ };
137
+ error: {
138
+ type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
139
+ };
140
+ }>> & {
141
+ onImport?: ((value: string) => any) | undefined;
142
+ onContentUpdate?: ((value: string) => any) | undefined;
143
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
144
+ } & import("vue").ShallowUnwrapRef<{
145
+ handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
146
+ }> & {} & import("vue").ComponentCustomProperties & {};
147
+ __isFragment?: undefined;
148
+ __isTeleport?: undefined;
149
+ __isSuspense?: undefined;
150
+ } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
11
151
  value: {
12
152
  type: import("vue").PropType<string>;
13
153
  };
@@ -17,56 +157,27 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
17
157
  theme: {
18
158
  type: import("vue").PropType<ThemeId>;
19
159
  };
20
- initialTabState: {
21
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs>;
22
- };
23
- availableTabs: {
24
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs[]>;
25
- };
26
160
  proxyUrl: {
27
161
  type: import("vue").PropType<string>;
28
162
  };
29
163
  error: {
30
164
  type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
31
165
  };
166
+ }>> & {
167
+ onImport?: ((value: string) => any) | undefined;
168
+ onContentUpdate?: ((value: string) => any) | undefined;
169
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
32
170
  }, {
33
171
  handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
34
172
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
35
173
  contentUpdate: (value: string) => void;
36
174
  import: (value: string) => void;
37
175
  changeTheme: (value: ThemeId) => void;
38
- startAIWriter: (value: string[], swaggerData: string, swaggerType: "json" | "yaml") => void;
39
- }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
40
- aiWriterMarkdown: {
41
- type: import("vue").PropType<string>;
42
- };
43
- value: {
44
- type: import("vue").PropType<string>;
45
- };
46
- hocuspocusConfiguration: {
47
- type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
176
+ }, string, {}, {}, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
177
+ $slots: {
178
+ "tab-items"?(_: {}): any;
48
179
  };
49
- theme: {
50
- type: import("vue").PropType<ThemeId>;
51
- };
52
- initialTabState: {
53
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs>;
54
- };
55
- availableTabs: {
56
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs[]>;
57
- };
58
- proxyUrl: {
59
- type: import("vue").PropType<string>;
60
- };
61
- error: {
62
- type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
63
- };
64
- }>> & {
65
- onStartAIWriter?: ((value: string[], swaggerData: string, swaggerType: "json" | "yaml") => any) | undefined;
66
- onChangeTheme?: ((value: ThemeId) => any) | undefined;
67
- onImport?: ((value: string) => any) | undefined;
68
- onContentUpdate?: ((value: string) => any) | undefined;
69
- }, {}, {}> | null | undefined;
180
+ })) | null | undefined;
70
181
  }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
71
182
  changeTheme: (value: ThemeId) => void;
72
183
  updateContent: (value: string) => void;
@@ -75,10 +186,150 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
75
186
  configuration: ReferenceConfiguration;
76
187
  parsedSpec: Spec;
77
188
  rawSpec: string;
78
- swaggerEditorRef?: import("vue").DefineComponent<{
79
- aiWriterMarkdown: {
80
- type: import("vue").PropType<string>;
81
- };
189
+ swaggerEditorRef?: ({
190
+ new (...args: any[]): {
191
+ $: import("vue").ComponentInternalInstance;
192
+ $data: {};
193
+ $props: {
194
+ readonly theme?: ThemeId | undefined;
195
+ readonly hocuspocusConfiguration?: import("@scalar/swagger-editor").HocuspocusConfigurationProp | undefined;
196
+ key?: string | number | symbol | undefined;
197
+ readonly value?: string | undefined;
198
+ style?: unknown;
199
+ class?: unknown;
200
+ readonly error?: string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null | undefined;
201
+ ref?: import("vue").VNodeRef | undefined;
202
+ ref_for?: boolean | undefined;
203
+ ref_key?: string | undefined;
204
+ onVnodeBeforeMount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
205
+ [key: string]: any;
206
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
207
+ [key: string]: any;
208
+ }>) => void)[] | undefined;
209
+ onVnodeMounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
210
+ [key: string]: any;
211
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
212
+ [key: string]: any;
213
+ }>) => void)[] | undefined;
214
+ onVnodeBeforeUpdate?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
215
+ [key: string]: any;
216
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
217
+ [key: string]: any;
218
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
219
+ [key: string]: any;
220
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
221
+ [key: string]: any;
222
+ }>) => void)[] | undefined;
223
+ onVnodeUpdated?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
224
+ [key: string]: any;
225
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
226
+ [key: string]: any;
227
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
228
+ [key: string]: any;
229
+ }>, oldVNode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
230
+ [key: string]: any;
231
+ }>) => void)[] | undefined;
232
+ onVnodeBeforeUnmount?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
233
+ [key: string]: any;
234
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
235
+ [key: string]: any;
236
+ }>) => void)[] | undefined;
237
+ onVnodeUnmounted?: ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
238
+ [key: string]: any;
239
+ }>) => void) | ((vnode: import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
240
+ [key: string]: any;
241
+ }>) => void)[] | undefined;
242
+ readonly proxyUrl?: string | undefined;
243
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
244
+ onImport?: ((value: string) => any) | undefined;
245
+ onContentUpdate?: ((value: string) => any) | undefined;
246
+ };
247
+ $attrs: {
248
+ [x: string]: unknown;
249
+ };
250
+ $refs: {
251
+ [x: string]: unknown;
252
+ };
253
+ $slots: Readonly<{
254
+ [name: string]: import("vue").Slot<any> | undefined;
255
+ }>;
256
+ $root: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
257
+ $parent: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null;
258
+ $emit: ((event: "changeTheme", value: ThemeId) => void) & ((event: "contentUpdate", value: string) => void) & ((event: "import", value: string) => void);
259
+ $el: any;
260
+ $options: import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
261
+ value: {
262
+ type: import("vue").PropType<string>;
263
+ };
264
+ hocuspocusConfiguration: {
265
+ type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
266
+ };
267
+ theme: {
268
+ type: import("vue").PropType<ThemeId>;
269
+ };
270
+ proxyUrl: {
271
+ type: import("vue").PropType<string>;
272
+ };
273
+ error: {
274
+ type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
275
+ };
276
+ }>> & {
277
+ onImport?: ((value: string) => any) | undefined;
278
+ onContentUpdate?: ((value: string) => any) | undefined;
279
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
280
+ }, {
281
+ handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
282
+ }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
283
+ contentUpdate: (value: string) => void;
284
+ import: (value: string) => void;
285
+ changeTheme: (value: ThemeId) => void;
286
+ }, string, {}, {}, string, {}> & {
287
+ beforeCreate?: ((() => void) | (() => void)[]) | undefined;
288
+ created?: ((() => void) | (() => void)[]) | undefined;
289
+ beforeMount?: ((() => void) | (() => void)[]) | undefined;
290
+ mounted?: ((() => void) | (() => void)[]) | undefined;
291
+ beforeUpdate?: ((() => void) | (() => void)[]) | undefined;
292
+ updated?: ((() => void) | (() => void)[]) | undefined;
293
+ activated?: ((() => void) | (() => void)[]) | undefined;
294
+ deactivated?: ((() => void) | (() => void)[]) | undefined;
295
+ beforeDestroy?: ((() => void) | (() => void)[]) | undefined;
296
+ beforeUnmount?: ((() => void) | (() => void)[]) | undefined;
297
+ destroyed?: ((() => void) | (() => void)[]) | undefined;
298
+ unmounted?: ((() => void) | (() => void)[]) | undefined;
299
+ renderTracked?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
300
+ renderTriggered?: (((e: import("vue").DebuggerEvent) => void) | ((e: import("vue").DebuggerEvent) => void)[]) | undefined;
301
+ errorCaptured?: (((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void)[]) | undefined;
302
+ };
303
+ $forceUpdate: () => void;
304
+ $nextTick: typeof import("vue").nextTick;
305
+ $watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (args_0: R, args_1: R) => any : (...args: any) => any, options?: import("vue").WatchOptions<boolean> | undefined): import("vue").WatchStopHandle;
306
+ } & Readonly<import("vue").ExtractPropTypes<{
307
+ value: {
308
+ type: import("vue").PropType<string>;
309
+ };
310
+ hocuspocusConfiguration: {
311
+ type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
312
+ };
313
+ theme: {
314
+ type: import("vue").PropType<ThemeId>;
315
+ };
316
+ proxyUrl: {
317
+ type: import("vue").PropType<string>;
318
+ };
319
+ error: {
320
+ type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
321
+ };
322
+ }>> & {
323
+ onImport?: ((value: string) => any) | undefined;
324
+ onContentUpdate?: ((value: string) => any) | undefined;
325
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
326
+ } & import("vue").ShallowUnwrapRef<{
327
+ handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
328
+ }> & {} & import("vue").ComponentCustomProperties & {};
329
+ __isFragment?: undefined;
330
+ __isTeleport?: undefined;
331
+ __isSuspense?: undefined;
332
+ } & import("vue").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{
82
333
  value: {
83
334
  type: import("vue").PropType<string>;
84
335
  };
@@ -88,56 +339,27 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
88
339
  theme: {
89
340
  type: import("vue").PropType<ThemeId>;
90
341
  };
91
- initialTabState: {
92
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs>;
93
- };
94
- availableTabs: {
95
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs[]>;
96
- };
97
342
  proxyUrl: {
98
343
  type: import("vue").PropType<string>;
99
344
  };
100
345
  error: {
101
346
  type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
102
347
  };
348
+ }>> & {
349
+ onImport?: ((value: string) => any) | undefined;
350
+ onContentUpdate?: ((value: string) => any) | undefined;
351
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
103
352
  }, {
104
353
  handleOpenSwaggerEditor: (action?: import("@scalar/swagger-editor").OpenSwaggerEditorActions | undefined) => void;
105
354
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
106
355
  contentUpdate: (value: string) => void;
107
356
  import: (value: string) => void;
108
357
  changeTheme: (value: ThemeId) => void;
109
- startAIWriter: (value: string[], swaggerData: string, swaggerType: "json" | "yaml") => void;
110
- }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
111
- aiWriterMarkdown: {
112
- type: import("vue").PropType<string>;
113
- };
114
- value: {
115
- type: import("vue").PropType<string>;
116
- };
117
- hocuspocusConfiguration: {
118
- type: import("vue").PropType<import("@scalar/swagger-editor").HocuspocusConfigurationProp>;
358
+ }, string, {}, {}, string, {}> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
359
+ $slots: {
360
+ "tab-items"?(_: {}): any;
119
361
  };
120
- theme: {
121
- type: import("vue").PropType<ThemeId>;
122
- };
123
- initialTabState: {
124
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs>;
125
- };
126
- availableTabs: {
127
- type: import("vue").PropType<import("@scalar/swagger-editor").EditorHeaderTabs[]>;
128
- };
129
- proxyUrl: {
130
- type: import("vue").PropType<string>;
131
- };
132
- error: {
133
- type: import("vue").PropType<string | import("vue").Ref<string> | import("vue").ComputedRef<string> | null>;
134
- };
135
- }>> & {
136
- onStartAIWriter?: ((value: string[], swaggerData: string, swaggerType: "json" | "yaml") => any) | undefined;
137
- onChangeTheme?: ((value: ThemeId) => any) | undefined;
138
- onImport?: ((value: string) => any) | undefined;
139
- onContentUpdate?: ((value: string) => any) | undefined;
140
- }, {}, {}> | null | undefined;
362
+ })) | null | undefined;
141
363
  }>>> & {
142
364
  onToggleDarkMode?: (() => any) | undefined;
143
365
  onChangeTheme?: ((value: ThemeId) => any) | undefined;
package/dist/components/ApiReferenceLayout.vue.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReferenceLayout.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReferenceLayout.vue.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAK7C,OAAO,KAAK,EACV,sBAAsB,EAEtB,kBAAkB,EAClB,IAAI,EACL,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAudjB,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
1
+ {"version":3,"file":"ApiReferenceLayout.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReferenceLayout.vue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAK7C,OAAO,KAAK,EACV,sBAAsB,EAEtB,kBAAkB,EAClB,IAAI,EACL,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwdjB,wBAAwG;AAGxG,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC;AAC9M,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
package/dist/components/GettingStarted.vue.d.ts ADDED
@@ -0,0 +1,27 @@
1
+ import { type ThemeId } from '@scalar/themes';
2
+ declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<{
3
+ theme: ThemeId;
4
+ value?: string | undefined;
5
+ }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
6
+ changeTheme: (value: ThemeId) => void;
7
+ openSwaggerEditor: (action?: "uploadFile" | "importUrl" | undefined) => void;
8
+ updateContent: (value: string) => void;
9
+ }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<{
10
+ theme: ThemeId;
11
+ value?: string | undefined;
12
+ }>>> & {
13
+ onChangeTheme?: ((value: ThemeId) => any) | undefined;
14
+ onOpenSwaggerEditor?: ((action?: "uploadFile" | "importUrl" | undefined) => any) | undefined;
15
+ onUpdateContent?: ((value: string) => any) | undefined;
16
+ }, {}, {}>;
17
+ export default _default;
18
+ type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
19
+ type __VLS_TypePropsToRuntimeProps<T> = {
20
+ [K in keyof T]-?: {} extends Pick<T, K> ? {
21
+ type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
22
+ } : {
23
+ type: import('vue').PropType<T[K]>;
24
+ required: true;
25
+ };
26
+ };
27
+ //# sourceMappingURL=GettingStarted.vue.d.ts.map
package/dist/components/GettingStarted.vue.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"GettingStarted.vue.d.ts","sourceRoot":"","sources":["../../src/components/GettingStarted.vue.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;;WAw0BpC,OAAO;;;;;;;WAAP,OAAO;;;;;;;AAFhB,wBAUG;AAGH,KAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GAAG,KAAK,GAAG,CAAC,CAAC;AACjE,KAAK,6BAA6B,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,OAAO,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE;CAAE,CAAC"}