@scalar/api-reference 1.0.1 → 1.0.3

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.
@@ -42,6 +42,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
42
42
  };
43
43
  }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
44
44
  changeTheme: (value: ThemeId) => void;
45
+ updateContent: (value: string) => void;
45
46
  startAIWriter: (value: string[], swaggerData: string, swaggerType: "json" | "yaml") => void;
46
47
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
47
48
  proxyUrl: {
@@ -86,6 +87,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
86
87
  }>> & {
87
88
  onChangeTheme?: ((value: ThemeId) => any) | undefined;
88
89
  onStartAIWriter?: ((value: string[], swaggerData: string, swaggerType: "json" | "yaml") => any) | undefined;
90
+ onUpdateContent?: ((value: string) => any) | undefined;
89
91
  }, {
90
92
  showSidebar: boolean;
91
93
  footerBelowSidebar: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReference.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReference.vue.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAe,MAAM,gBAAgB,CAAA;AAQ1D,OAAO,KAAK,EAAE,sBAAsB,EAAwB,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0V5E,wBAA8G;AAyB9G,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":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAe,MAAM,gBAAgB,CAAA;AAQ1D,OAAO,KAAK,EAAE,sBAAsB,EAAwB,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgW5E,wBAA8G;AA2B9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"ApiReferenceLayout.vue.d.ts","sourceRoot":"","sources":["../../src/components/ApiReferenceLayout.vue.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAK7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkc5D,wBAA8G;AAmB9G,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":"AAOA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAK7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4c5D,wBAA8G;AAmB9G,KAAK,uBAAuB,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,QAAO;QAClD,MAAM,EAAE,CAAC,CAAC;KACT,CAAA;CAAE,CAAC"}
@@ -0,0 +1,13 @@
1
+ declare const _default: import("vue").DefineComponent<{
2
+ value: {
3
+ type: import("vue").PropType<string>;
4
+ required: true;
5
+ };
6
+ }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
7
+ value: {
8
+ type: import("vue").PropType<string>;
9
+ required: true;
10
+ };
11
+ }>>, {}, {}>;
12
+ export default _default;
13
+ //# sourceMappingURL=Description.vue.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"Description.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/Description.vue.ts"],"names":[],"mappings":";;;;;;;;;;;AA2IA,wBAAkD"}
@@ -1 +1 @@
1
- {"version":3,"file":"Introduction.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/Introduction.vue.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyWxD,wBAAkD"}
1
+ {"version":3,"file":"Introduction.vue.d.ts","sourceRoot":"","sources":["../../../../src/components/Content/Introduction/Introduction.vue.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6WxD,wBAAkD"}
@@ -1 +1 @@
1
- {"version":3,"file":"MarkdownRenderer.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/MarkdownRenderer.vue.ts"],"names":[],"mappings":";;;;;;;;;AAkJA,wBAAkD"}
1
+ {"version":3,"file":"MarkdownRenderer.vue.d.ts","sourceRoot":"","sources":["../../../src/components/Content/MarkdownRenderer.vue.ts"],"names":[],"mappings":";;;;;;;;;AA0IA,wBAAkD"}
@@ -1,3 +1,3 @@
1
1
  export declare const getIcon: (name: string) => string;
2
- export type Icon = 'Add' | 'ArrowDown' | 'ArrowLeft' | 'ArrowRight' | 'ArrowUp' | 'Background' | 'CallToAction' | 'Checkmark' | 'ChevronDown' | 'ChevronLeft' | 'ChevronRight' | 'ChevronUp' | 'Close' | 'DarkMode' | 'Discord' | 'Delete' | 'Duplicate' | 'Edit' | 'EditorBold' | 'EditorCode' | 'EditorHighlight' | 'EditorItalic' | 'EditorLink' | 'EditorStrike' | 'EditorUnderline' | 'Ellipses' | 'Error' | 'ExternalLink' | 'Folder' | 'GitHub' | 'Google' | 'Hide' | 'Key' | 'Leave' | 'LightDarkModeToggle' | 'LightMode' | 'Link' | 'Lock' | 'Logo' | 'LogoAPI' | 'LogoClient' | 'LogoMarket' | 'LogoSwagger' | 'Magic' | 'Menu' | 'Page' | 'Payment' | 'Refresh' | 'Search' | 'Show' | 'Sigma' | 'Trash';
2
+ export type Icon = 'Add' | 'CheckMark' | 'ChevronDown' | 'ChevronLeft' | 'ChevronRight' | 'ChevronUp' | 'Close' | 'Ellipses' | 'ExternalLink' | 'GitHub' | 'LightDarkModeToggle' | 'Logo' | 'LogoAPI' | 'LogoClient' | 'LogoMarket' | 'LogoSwagger' | 'Menu' | 'Search';
3
3
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/Icon/icons/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,SAAU,MAAM,WASnC,CAAA;AAED,MAAM,MAAM,IAAI,GACZ,KAAK,GACL,WAAW,GACX,WAAW,GACX,YAAY,GACZ,SAAS,GACT,YAAY,GACZ,cAAc,GACd,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,WAAW,GACX,OAAO,GACP,UAAU,GACV,SAAS,GACT,QAAQ,GACR,WAAW,GACX,MAAM,GACN,YAAY,GACZ,YAAY,GACZ,iBAAiB,GACjB,cAAc,GACd,YAAY,GACZ,cAAc,GACd,iBAAiB,GACjB,UAAU,GACV,OAAO,GACP,cAAc,GACd,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,KAAK,GACL,OAAO,GACP,qBAAqB,GACrB,WAAW,GACX,MAAM,GACN,MAAM,GACN,MAAM,GACN,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,OAAO,GACP,MAAM,GACN,MAAM,GACN,SAAS,GACT,SAAS,GACT,QAAQ,GACR,MAAM,GACN,OAAO,GACP,OAAO,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/components/Icon/icons/index.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,SAAU,MAAM,WASnC,CAAA;AAED,MAAM,MAAM,IAAI,GACZ,KAAK,GACL,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,WAAW,GACX,OAAO,GACP,UAAU,GACV,cAAc,GACd,QAAQ,GACR,qBAAqB,GACrB,MAAM,GACN,SAAS,GACT,YAAY,GACZ,YAAY,GACZ,aAAa,GACb,MAAM,GACN,QAAQ,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"AAmBA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqd/D,wBAAkD"}
1
+ {"version":3,"file":"Sidebar.vue.d.ts","sourceRoot":"","sources":["../../src/components/Sidebar.vue.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,IAAI,EAA6B,MAAM,UAAU,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAod/D,wBAAkD"}
@@ -3,7 +3,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
3
3
  type: import("vue").PropType<{
4
4
  uid: string;
5
5
  title: string;
6
- type: "Folder" | "Link" | "Page";
6
+ type: "Page" | "Folder" | "Link";
7
7
  link?: string | undefined;
8
8
  icon?: {
9
9
  src: string;
@@ -31,7 +31,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
31
31
  type: import("vue").PropType<{
32
32
  uid: string;
33
33
  title: string;
34
- type: "Folder" | "Link" | "Page";
34
+ type: "Page" | "Folder" | "Link";
35
35
  link?: string | undefined;
36
36
  icon?: {
37
37
  src: string;
@@ -1 +1 @@
1
- {"version":3,"file":"getHeadingsFromMarkdown.d.ts","sourceRoot":"","sources":["../../src/helpers/getHeadingsFromMarkdown.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAA;AAOhC,eAAO,MAAM,uBAAuB,UAC3B,MAAM,KACZ,QAAQ,QAAQ,CAIlB,CAAA"}
1
+ {"version":3,"file":"getHeadingsFromMarkdown.d.ts","sourceRoot":"","sources":["../../src/helpers/getHeadingsFromMarkdown.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAA;AAOhC,eAAO,MAAM,uBAAuB,UAC3B,MAAM,KACZ,QAAQ,QAAQ,CAMlB,CAAA"}
@@ -0,0 +1,9 @@
1
+ import { type Headings } from './getHeadingsFromMarkdown';
2
+ export type HeadingLevels = 1 | 2 | 3 | 4 | 5 | 6;
3
+ /**
4
+ * Returns the lowest heading level from a list of headings.
5
+ *
6
+ * If there are h1, h2, h3 … h1 is the lowest heading level.
7
+ */
8
+ export declare const getLowestHeadingLevel: (headings: Headings) => HeadingLevels;
9
+ //# sourceMappingURL=getLowestHeadingLevel.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getLowestHeadingLevel.d.ts","sourceRoot":"","sources":["../../src/helpers/getLowestHeadingLevel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,2BAA2B,CAAA;AAEzD,MAAM,MAAM,aAAa,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;AAEjD;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,0BAAyB,aAQ1D,CAAA"}
@@ -4,6 +4,7 @@ export * from './getExampleFromSchema';
4
4
  export * from './getHarRequest';
5
5
  export * from './getHeadingId';
6
6
  export * from './getHeadingsFromMarkdown';
7
+ export * from './getLowestHeadingLevel';
7
8
  export * from './getModelSectionId';
8
9
  export * from './getOperationSectionId';
9
10
  export * from './getRequestFromAuthentication';
@@ -19,5 +20,6 @@ export * from './objectMerge';
19
20
  export * from './prettyPrintJson';
20
21
  export * from './replaceVariables';
21
22
  export * from './scrollToId';
23
+ export * from './splitMarkdownInSections';
22
24
  export * from './transformToJson';
23
25
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,mBAAmB,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,uBAAuB,CAAA;AACrC,cAAc,wBAAwB,CAAA;AACtC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,yBAAyB,CAAA;AACvC,cAAc,qBAAqB,CAAA;AACnC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,yBAAyB,CAAA;AACvC,cAAc,oBAAoB,CAAA;AAClC,cAAc,aAAa,CAAA;AAC3B,cAAc,sBAAsB,CAAA;AACpC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA;AAClC,cAAc,cAAc,CAAA;AAC5B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Takes Markdown and splits it into sections based on the level of the headers.
3
+ */
4
+ export declare function splitMarkdownInSections(content: string, level?: 1 | 2 | 3 | 4 | 5 | 6): string[];
5
+ //# sourceMappingURL=splitMarkdownInSections.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"splitMarkdownInSections.d.ts","sourceRoot":"","sources":["../../src/helpers/splitMarkdownInSections.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAK,YASjC"}