@diplodoc/components 4.28.5 → 4.29.0

package/build/esm/models/index.d.ts

@@ -79,6 +79,7 @@ export interface DocPageData extends DocBasePageData {
     meta: DocMeta;
     vcsUrl?: string;
     vcsType?: VcsType;
+    mdxArtifacts?: Record<string, unknown>;
 }
 export interface DocHeadingItem {
     title: string;

package/build/esm/models/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/models/index.ts"],
-  "sourcesContent": ["import type {UseTranslationResponse} from 'react-i18next';\nimport type {Loc} from '../config/i18n';\nimport type {SuggestItemType} from '../components/SearchSuggest/types';\n\nimport {LabelProps} from '@gravity-ui/uikit';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type TFunction = UseTranslationResponse<any, undefined>['t'];\n\nexport type OnChangeValue = (value: ControlTypes) => void;\nexport type ControlTypes =\n    | string\n    | boolean\n    | Theme\n    | Lang\n    | TextSizes\n    | FeedbackSendData\n    | SubscribeData;\n\nexport enum Theme {\n    Light = 'light',\n    Dark = 'dark',\n}\n\nexport enum TextSizes {\n    S = 's', // 13px\n    M = 'm', // 15px\n    L = 'l', // 17px\n}\n\nexport enum ControlSizes {\n    M = 'm',\n    L = 'l',\n    XL = 'xl',\n}\n\nexport interface Config {\n    lang?: string;\n    loc?: Loc;\n    localeCode?: string;\n}\n\nexport interface DocSettings {\n    fullScreen?: boolean;\n    singlePage?: boolean;\n    wideFormat?: boolean;\n    showMiniToc?: boolean;\n    bookmarkedPage?: boolean;\n    theme?: Theme;\n    textSize?: TextSizes;\n    isLiked?: boolean;\n    isDisliked?: boolean;\n    dislikeVariants?: string[];\n}\n\nexport interface DocBasePageData<T extends {} = {}> {\n    toc: T & TocData;\n    leading?: boolean;\n    footer?: React.ReactNode;\n}\n\nexport interface DocLeadingPageData extends DocBasePageData {\n    leading: true;\n    data: DocLeadingData;\n}\n\nexport interface DocContentPageData<T extends {} = {}> extends DocBasePageData {\n    leading: true;\n    data: T & {\n        fullScreen?: boolean;\n    };\n    children?: React.ReactNode;\n}\n\nexport interface DocLeadingData {\n    title: string;\n    description: string | string[];\n    links: DocLeadingLinks[];\n    meta: DocMeta;\n}\n\nexport interface DocLeadingLinks {\n    title: string;\n    description?: string;\n    href?: string;\n    imgSrc?: string;\n    links?: DocLeadingLinks[];\n}\n\nexport enum VcsType {\n    Github = 'github',\n    Arcanum = 'arcanum',\n}\n\nexport interface DocPageData extends DocBasePageData {\n    leading?: false;\n    breadcrumbs?: BreadcrumbItem[];\n    viewerInterface?: Record<string, boolean>;\n    html: string;\n    title?: string;\n    headings: DocHeadingItem[];\n    meta: DocMeta;\n    vcsUrl?: string;\n    vcsType?: VcsType;\n}\n\nexport interface DocHeadingItem {\n    title: string;\n    href: string;\n    level: number;\n    items?: DocHeadingItem[];\n}\n\nexport interface DocMeta {\n    title?: string;\n    description?: string;\n    keywords?: string[];\n    stage?: string;\n    editable?: boolean;\n    contributors?: Contributor[];\n    author?: unknown | Contributor;\n    __system?: Record<string, unknown>;\n    updatedAt?: string;\n}\n\nexport interface TocLabel {\n    title: string;\n    description?: string;\n    theme?: LabelProps['theme'];\n}\n\nexport interface TocData {\n    title?: string;\n    href?: string;\n    items?: TocItem[];\n    stage?: string;\n    editable?: boolean;\n    singlePage?: boolean;\n    label?: TocLabel;\n}\n\nexport interface TocItem {\n    id: string;\n    name: string;\n    href?: string;\n    items?: TocItem[];\n    expanded?: boolean;\n    labeled?: boolean;\n}\n\nexport interface BreadcrumbItem {\n    name: string;\n    url?: string;\n}\n\nexport interface Router {\n    hostname?: string;\n    pathname: string;\n    hash?: string;\n}\n\nexport enum Lang {\n    Ru = 'ru',\n    En = 'en',\n    He = 'he',\n    Es = 'es',\n    Fr = 'fr',\n    Cs = 'cs',\n    Ar = 'ar',\n}\n\nexport interface Contributor {\n    avatar: string;\n    login: string;\n    url: string;\n    name: string | null;\n    email: string | null;\n}\n\nexport interface DislikeData {\n    answers: string[];\n    comment: string;\n}\n\nexport enum FeedbackType {\n    like = 'like',\n    dislike = 'dislike',\n    indeterminate = 'indeterminate',\n}\n\nexport interface FeedbackSendData {\n    type: FeedbackType;\n    answers?: string[];\n    comment?: string;\n}\n\nexport enum SubscribeType {\n    documentation = 'documentation',\n    page = 'page',\n}\n\nexport interface SubscribeData {\n    email: string;\n    type: SubscribeType;\n}\n\nexport enum DocumentType {\n    Base = 'BASE',\n    Leading = 'LEADING',\n    PageConstructor = 'PAGE_CONSTRUCTOR',\n}\n\nexport interface ListItem {\n    value: string;\n    text: string;\n}\n\nexport interface ClassNameProps {\n    className?: string;\n}\n\nexport interface ISearchProvider {\n    init(): void | (() => void);\n    suggest(query: string): Promise<ISearchResult[]>;\n    search(\n        query: string,\n    ): Promise<ISearchResult[]> | Promise<{items: ISearchResult[]; total: number}>;\n    link(query: string): string | null;\n}\n\nexport interface ISearchResult {\n    type: SuggestItemType;\n    title: string;\n    link: string;\n    description?: string;\n    breadcrumbs?: BreadcrumbItem[];\n}\n\nexport type Query = Record<string, number | string | null>;\n"],
-  "mappings": ";AAmBO,IAAK,QAAL,kBAAKA,WAAL;AACH,EAAAA,OAAA,WAAQ;AACR,EAAAA,OAAA,UAAO;AAFC,SAAAA;AAAA,GAAA;AAKL,IAAK,YAAL,kBAAKC,eAAL;AACH,EAAAA,WAAA,OAAI;AACJ,EAAAA,WAAA,OAAI;AACJ,EAAAA,WAAA,OAAI;AAHI,SAAAA;AAAA,GAAA;AAML,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,OAAI;AACJ,EAAAA,cAAA,OAAI;AACJ,EAAAA,cAAA,QAAK;AAHG,SAAAA;AAAA,GAAA;AA2DL,IAAK,UAAL,kBAAKC,aAAL;AACH,EAAAA,SAAA,YAAS;AACT,EAAAA,SAAA,aAAU;AAFF,SAAAA;AAAA,GAAA;AAwEL,IAAK,OAAL,kBAAKC,UAAL;AACH,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AAPG,SAAAA;AAAA,GAAA;AAuBL,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,UAAO;AACP,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,mBAAgB;AAHR,SAAAA;AAAA,GAAA;AAYL,IAAK,gBAAL,kBAAKC,mBAAL;AACH,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,UAAO;AAFC,SAAAA;AAAA,GAAA;AAUL,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,UAAO;AACP,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,qBAAkB;AAHV,SAAAA;AAAA,GAAA;",
+  "sourcesContent": ["import type {UseTranslationResponse} from 'react-i18next';\nimport type {Loc} from '../config/i18n';\nimport type {SuggestItemType} from '../components/SearchSuggest/types';\n\nimport {LabelProps} from '@gravity-ui/uikit';\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport type TFunction = UseTranslationResponse<any, undefined>['t'];\n\nexport type OnChangeValue = (value: ControlTypes) => void;\nexport type ControlTypes =\n    | string\n    | boolean\n    | Theme\n    | Lang\n    | TextSizes\n    | FeedbackSendData\n    | SubscribeData;\n\nexport enum Theme {\n    Light = 'light',\n    Dark = 'dark',\n}\n\nexport enum TextSizes {\n    S = 's', // 13px\n    M = 'm', // 15px\n    L = 'l', // 17px\n}\n\nexport enum ControlSizes {\n    M = 'm',\n    L = 'l',\n    XL = 'xl',\n}\n\nexport interface Config {\n    lang?: string;\n    loc?: Loc;\n    localeCode?: string;\n}\n\nexport interface DocSettings {\n    fullScreen?: boolean;\n    singlePage?: boolean;\n    wideFormat?: boolean;\n    showMiniToc?: boolean;\n    bookmarkedPage?: boolean;\n    theme?: Theme;\n    textSize?: TextSizes;\n    isLiked?: boolean;\n    isDisliked?: boolean;\n    dislikeVariants?: string[];\n}\n\nexport interface DocBasePageData<T extends {} = {}> {\n    toc: T & TocData;\n    leading?: boolean;\n    footer?: React.ReactNode;\n}\n\nexport interface DocLeadingPageData extends DocBasePageData {\n    leading: true;\n    data: DocLeadingData;\n}\n\nexport interface DocContentPageData<T extends {} = {}> extends DocBasePageData {\n    leading: true;\n    data: T & {\n        fullScreen?: boolean;\n    };\n    children?: React.ReactNode;\n}\n\nexport interface DocLeadingData {\n    title: string;\n    description: string | string[];\n    links: DocLeadingLinks[];\n    meta: DocMeta;\n}\n\nexport interface DocLeadingLinks {\n    title: string;\n    description?: string;\n    href?: string;\n    imgSrc?: string;\n    links?: DocLeadingLinks[];\n}\n\nexport enum VcsType {\n    Github = 'github',\n    Arcanum = 'arcanum',\n}\n\nexport interface DocPageData extends DocBasePageData {\n    leading?: false;\n    breadcrumbs?: BreadcrumbItem[];\n    viewerInterface?: Record<string, boolean>;\n    html: string;\n    title?: string;\n    headings: DocHeadingItem[];\n    meta: DocMeta;\n    vcsUrl?: string;\n    vcsType?: VcsType;\n    mdxArtifacts?: Record<string, unknown>;\n}\n\nexport interface DocHeadingItem {\n    title: string;\n    href: string;\n    level: number;\n    items?: DocHeadingItem[];\n}\n\nexport interface DocMeta {\n    title?: string;\n    description?: string;\n    keywords?: string[];\n    stage?: string;\n    editable?: boolean;\n    contributors?: Contributor[];\n    author?: unknown | Contributor;\n    __system?: Record<string, unknown>;\n    updatedAt?: string;\n}\n\nexport interface TocLabel {\n    title: string;\n    description?: string;\n    theme?: LabelProps['theme'];\n}\n\nexport interface TocData {\n    title?: string;\n    href?: string;\n    items?: TocItem[];\n    stage?: string;\n    editable?: boolean;\n    singlePage?: boolean;\n    label?: TocLabel;\n}\n\nexport interface TocItem {\n    id: string;\n    name: string;\n    href?: string;\n    items?: TocItem[];\n    expanded?: boolean;\n    labeled?: boolean;\n}\n\nexport interface BreadcrumbItem {\n    name: string;\n    url?: string;\n}\n\nexport interface Router {\n    hostname?: string;\n    pathname: string;\n    hash?: string;\n}\n\nexport enum Lang {\n    Ru = 'ru',\n    En = 'en',\n    He = 'he',\n    Es = 'es',\n    Fr = 'fr',\n    Cs = 'cs',\n    Ar = 'ar',\n}\n\nexport interface Contributor {\n    avatar: string;\n    login: string;\n    url: string;\n    name: string | null;\n    email: string | null;\n}\n\nexport interface DislikeData {\n    answers: string[];\n    comment: string;\n}\n\nexport enum FeedbackType {\n    like = 'like',\n    dislike = 'dislike',\n    indeterminate = 'indeterminate',\n}\n\nexport interface FeedbackSendData {\n    type: FeedbackType;\n    answers?: string[];\n    comment?: string;\n}\n\nexport enum SubscribeType {\n    documentation = 'documentation',\n    page = 'page',\n}\n\nexport interface SubscribeData {\n    email: string;\n    type: SubscribeType;\n}\n\nexport enum DocumentType {\n    Base = 'BASE',\n    Leading = 'LEADING',\n    PageConstructor = 'PAGE_CONSTRUCTOR',\n}\n\nexport interface ListItem {\n    value: string;\n    text: string;\n}\n\nexport interface ClassNameProps {\n    className?: string;\n}\n\nexport interface ISearchProvider {\n    init(): void | (() => void);\n    suggest(query: string): Promise<ISearchResult[]>;\n    search(\n        query: string,\n    ): Promise<ISearchResult[]> | Promise<{items: ISearchResult[]; total: number}>;\n    link(query: string): string | null;\n}\n\nexport interface ISearchResult {\n    type: SuggestItemType;\n    title: string;\n    link: string;\n    description?: string;\n    breadcrumbs?: BreadcrumbItem[];\n}\n\nexport type Query = Record<string, number | string | null>;\n"],
+  "mappings": ";AAmBO,IAAK,QAAL,kBAAKA,WAAL;AACH,EAAAA,OAAA,WAAQ;AACR,EAAAA,OAAA,UAAO;AAFC,SAAAA;AAAA,GAAA;AAKL,IAAK,YAAL,kBAAKC,eAAL;AACH,EAAAA,WAAA,OAAI;AACJ,EAAAA,WAAA,OAAI;AACJ,EAAAA,WAAA,OAAI;AAHI,SAAAA;AAAA,GAAA;AAML,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,OAAI;AACJ,EAAAA,cAAA,OAAI;AACJ,EAAAA,cAAA,QAAK;AAHG,SAAAA;AAAA,GAAA;AA2DL,IAAK,UAAL,kBAAKC,aAAL;AACH,EAAAA,SAAA,YAAS;AACT,EAAAA,SAAA,aAAU;AAFF,SAAAA;AAAA,GAAA;AAyEL,IAAK,OAAL,kBAAKC,UAAL;AACH,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AACL,EAAAA,MAAA,QAAK;AAPG,SAAAA;AAAA,GAAA;AAuBL,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,UAAO;AACP,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,mBAAgB;AAHR,SAAAA;AAAA,GAAA;AAYL,IAAK,gBAAL,kBAAKC,mBAAL;AACH,EAAAA,eAAA,mBAAgB;AAChB,EAAAA,eAAA,UAAO;AAFC,SAAAA;AAAA,GAAA;AAUL,IAAK,eAAL,kBAAKC,kBAAL;AACH,EAAAA,cAAA,UAAO;AACP,EAAAA,cAAA,aAAU;AACV,EAAAA,cAAA,qBAAkB;AAHV,SAAAA;AAAA,GAAA;",
   "names": ["Theme", "TextSizes", "ControlSizes", "VcsType", "Lang", "FeedbackType", "SubscribeType", "DocumentType"]
 }