From 9a30020ad1e01d41f9307978cb82f1d6bf02d0ce Mon Sep 17 00:00:00 2001 From: Pedro Vitor Date: Tue, 16 Jan 2024 17:33:31 -0300 Subject: [PATCH] fix: fix linttering --- dist/index.d.mts | 231 ++++++++++++++++++++--------------------------- 1 file changed, 96 insertions(+), 135 deletions(-) diff --git a/dist/index.d.mts b/dist/index.d.mts index a70193e..a9a1017 100644 --- a/dist/index.d.mts +++ b/dist/index.d.mts @@ -1,179 +1,140 @@ -import * as react_jsx_runtime from 'react/jsx-runtime' -import { MDXRemoteSerializeResult } from 'next-mdx-remote' -import * as react from 'react' -import { ReactNode, Dispatch, SetStateAction } from 'react' -import { IconProps } from '@vtex/brand-ui' -import { AlgoliaSearchOptions } from 'algoliasearch/lite' +import * as react_jsx_runtime from 'react/jsx-runtime'; +import { MDXRemoteSerializeResult } from 'next-mdx-remote'; +import * as react from 'react'; +import { ReactNode, Dispatch, SetStateAction } from 'react'; +import { IconProps } from '@vtex/brand-ui'; +import { AlgoliaSearchOptions } from 'algoliasearch/lite'; interface MarkdownRendererProps { - serialized: MDXRemoteSerializeResult - customComponents?: { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - [name: string]: any - } - scope?: { - // eslint-disable-next-line @typescript-eslint/no-explicit-any - [name: string]: any - } + serialized: MDXRemoteSerializeResult; + customComponents?: { + [name: string]: any; + }; + scope?: { + [name: string]: any; + }; } -declare const MarkdownRenderer: ({ - serialized, - customComponents, - scope, -}: MarkdownRendererProps) => react_jsx_runtime.JSX.Element +declare const MarkdownRenderer: ({ serialized, customComponents, scope, }: MarkdownRendererProps) => react_jsx_runtime.JSX.Element; interface SubItem { - title: string - slug: string + title: string; + slug: string; } interface Item extends SubItem { - children: SubItem[] + children: SubItem[]; } interface Props$2 { - /** List of headings in the current documentation page */ - headingList?: Item[] + /** List of headings in the current documentation page */ + headingList?: Item[]; } /** Table of contents for documentation pages. */ -declare const TableOfContents: ({ - headingList, -}: Props$2) => react_jsx_runtime.JSX.Element +declare const TableOfContents: ({ headingList }: Props$2) => react_jsx_runtime.JSX.Element; interface SideBarSectionState { - /** Array containing the name of the parents of the expanded page in the menu. */ - parentsArray?: string[] + /** Array containing the name of the parents of the expanded page in the menu. */ + parentsArray?: string[]; } /** * Sidebar component. */ -declare const Sidebar: ({ - parentsArray, -}: SideBarSectionState) => react_jsx_runtime.JSX.Element +declare const Sidebar: ({ parentsArray }: SideBarSectionState) => react_jsx_runtime.JSX.Element; interface HamburgerMenuProps { - /** Array that contains the name of the sections in the menu that should be expanded. */ - parentsArray?: string[] + /** Array that contains the name of the sections in the menu that should be expanded. */ + parentsArray?: string[]; } /** Hamburger Menu component, the menu uses the sidebar components internally, but it is only visible on the smaller breakpoints. */ -declare const HamburgerMenu: ({ - parentsArray, -}: HamburgerMenuProps) => react_jsx_runtime.JSX.Element +declare const HamburgerMenu: ({ parentsArray }: HamburgerMenuProps) => react_jsx_runtime.JSX.Element; interface DocPath { - /** Slug that corresponds to the current page. */ - slug?: string - /** Github edit URL to the correspoding documentation file. */ - urlToEdit?: string - /** Whether is possible for the user to suggest edits or not. */ - suggestEdits?: boolean - /** Function that executes when the user sends the feedback. The function receives the user comment and whether it was a positive (liked = true) or negative feedback. */ - sendFeedback: (comment: string, liked: boolean) => Promise + /** Slug that corresponds to the current page. */ + slug?: string; + /** Github edit URL to the correspoding documentation file. */ + urlToEdit?: string; + /** Whether is possible for the user to suggest edits or not. */ + suggestEdits?: boolean; + /** Function that executes when the user sends the feedback. The function receives the user comment and whether it was a positive (liked = true) or negative feedback. */ + sendFeedback: (comment: string, liked: boolean) => Promise; } /** Component that can be used on each documentation page, so the user can give feedback of whether or not it has helpful. When liked or disliked it opens a modal with a field to add a comment and send feedback. */ -declare const FeedbackSection: ({ - slug, - urlToEdit, - suggestEdits, - sendFeedback, -}: DocPath) => react_jsx_runtime.JSX.Element +declare const FeedbackSection: ({ slug, urlToEdit, suggestEdits, sendFeedback, }: DocPath) => react_jsx_runtime.JSX.Element; -declare const Search: () => react_jsx_runtime.JSX.Element +declare const Search: () => react_jsx_runtime.JSX.Element; -declare function SearchInput(): react_jsx_runtime.JSX.Element +declare function SearchInput(): react_jsx_runtime.JSX.Element; interface Props$1 { - onAccept: () => void + onAccept: () => void; } -declare const CookieBar: ({ - onAccept, -}: Props$1) => react_jsx_runtime.JSX.Element +declare const CookieBar: ({ onAccept }: Props$1) => react_jsx_runtime.JSX.Element; type Section = { - id: string - link: string - title: string - description: string - Icon: (props: IconProps) => JSX.Element -} + id: string; + link: string; + title: string; + description: string; + Icon: (props: IconProps) => JSX.Element; +}; interface Props extends Partial { - children: ReactNode - /** The navigation array containing the list of documentations shown in the sidebar. */ - // eslint-disable-next-line @typescript-eslint/no-explicit-any - fallback?: any - /** Documentation sections, the same sections that divide the fallback. */ - sections: Section[][] - /** Whether is a branch preview or not. */ - isPreview: boolean - /** The section currently selected. */ - sectionSelected: string - /** The sections to be used on the hamburguer menu */ - hamburguerMenuSections: Section[][] - /** The portal language. The default is english. */ - locale?: 'en' | 'pt' | 'es' + children: ReactNode; + /** The navigation array containing the list of documentations shown in the sidebar. */ + fallback?: any; + /** Documentation sections, the same sections that divide the fallback. */ + sections: Section[][]; + /** Whether is a branch preview or not. */ + isPreview: boolean; + /** The section currently selected. */ + sectionSelected: string; + /** The sections to be used on the hamburguer menu */ + hamburguerMenuSections: Section[][]; + /** The portal language. The default is english. */ + locale?: 'en' | 'pt' | 'es'; } type ContextType = { - headingItems: Item[] - setHeadingItems: Dispatch> - activeItem: ActiveItem - setActiveItem: Dispatch> - goToPreviousItem: () => void - goToPreviousSubItem: () => void - isEditorPreview: boolean - sidebarSectionHidden: boolean - activeSectionName: string - activeSidebarElement: string - // eslint-disable-next-line @typescript-eslint/no-explicit-any - sidebarDataMaster: any - sidebarElementStatus: Map - // eslint-disable-next-line @typescript-eslint/no-explicit-any - setSidebarDataMaster: Dispatch> - setIsEditorPreview: Dispatch> - setSidebarSectionHidden: Dispatch> - setActiveSectionName: Dispatch> - setActiveSidebarElement: Dispatch> - toggleSidebarElementStatus: (title: string) => void - openSidebarElement: (title: string) => void - closeSidebarElements: (parentsArray: string[]) => void - sidebarSections: Section[][] - setSidebarSections: Dispatch> - hamburguerSections: Section[][] - setHamburguerSections: Dispatch> - locale: 'en' | 'pt' | 'es' -} + headingItems: Item[]; + setHeadingItems: Dispatch>; + activeItem: ActiveItem; + setActiveItem: Dispatch>; + goToPreviousItem: () => void; + goToPreviousSubItem: () => void; + isEditorPreview: boolean; + sidebarSectionHidden: boolean; + activeSectionName: string; + activeSidebarElement: string; + sidebarDataMaster: any; + sidebarElementStatus: Map; + setSidebarDataMaster: Dispatch>; + setIsEditorPreview: Dispatch>; + setSidebarSectionHidden: Dispatch>; + setActiveSectionName: Dispatch>; + setActiveSidebarElement: Dispatch>; + toggleSidebarElementStatus: (title: string) => void; + openSidebarElement: (title: string) => void; + closeSidebarElements: (parentsArray: string[]) => void; + sidebarSections: Section[][]; + setSidebarSections: Dispatch>; + hamburguerSections: Section[][]; + setHamburguerSections: Dispatch>; + locale: 'en' | 'pt' | 'es'; +}; type ActiveItem = { - item: string - subItem: string -} -declare const LibraryContext: react.Context + item: string; + subItem: string; +}; +declare const LibraryContext: react.Context; /** Provider for the LibraryContext created with React.createContext. The context is used in the following components: feedback, search, sidebar, hamburger menu, markdown renderer and table of contents. */ -declare const LibraryContextProvider: ({ - children, - ...props -}: Props) => react_jsx_runtime.JSX.Element +declare const LibraryContextProvider: ({ children, ...props }: Props) => react_jsx_runtime.JSX.Element; interface AlgoliaConfig { - appId: string - apiKey: string - index: string - algoliaOptions?: AlgoliaSearchOptions - // eslint-disable-next-line @typescript-eslint/no-explicit-any - customOptions?: any + appId: string; + apiKey: string; + index: string; + algoliaOptions?: AlgoliaSearchOptions; + customOptions?: any; } -declare const createAlgoliaClient: (config: AlgoliaConfig) => void +declare const createAlgoliaClient: (config: AlgoliaConfig) => void; -export { - CookieBar, - FeedbackSection, - HamburgerMenu, - Item, - LibraryContext, - LibraryContextProvider, - MarkdownRenderer, - Search, - createAlgoliaClient as SearchConfig, - SearchInput, - Sidebar, - TableOfContents, -} +export { CookieBar, FeedbackSection, HamburgerMenu, Item, LibraryContext, LibraryContextProvider, MarkdownRenderer, Search, createAlgoliaClient as SearchConfig, SearchInput, Sidebar, TableOfContents };