@redocly/theme 0.1.16 → 0.1.21

package/src/PageNavigation/NextPageLink.tsx

@@ -2,7 +2,9 @@ import React from 'react';
 
 import type { ResolvedNavLinkItem } from '@theme/types/portal';
 import { usePageData } from '@portal/hooks/usePageData';
-import { Button } from '@theme/ui';
+import { useThemeSettings } from '@portal/hooks/';
+import { DEFAULT_THEME_NAME } from '@portal/constants/';
+import { Button } from '@theme/Button/Button';
 
 interface NextPageType {
   nextPage?: ResolvedNavLinkItem | null;
@@ -10,13 +12,17 @@ interface NextPageType {
 
 export function NextPageLink(): JSX.Element {
   const { nextPage }: NextPageType = usePageData() || {};
-  if (!nextPage) {
+  const { themeSettings } = useThemeSettings(DEFAULT_THEME_NAME);
+
+  if (!nextPage || themeSettings?.navigation?.hide) {
     return <div>&nbsp;</div>;
   }
 
+  const label = themeSettings?.navigation?.nextPageLink?.label || `Next to ${nextPage.label}`;
+
   return (
     <Button variant="outlined" size="large" to={nextPage.link}>
-      Next to {nextPage.label}
+      {label}
     </Button>
   );
 }

package/src/PageNavigation/PreviousPageLink.tsx

@@ -2,7 +2,9 @@ import React from 'react';
 
 import type { ResolvedNavLinkItem } from '@theme/types/portal';
 import { usePageData } from '@portal/hooks/usePageData';
-import { Button } from '@theme/ui';
+import { useThemeSettings } from '@portal/hooks';
+import { DEFAULT_THEME_NAME } from '@portal/constants';
+import { Button } from '@theme/Button/Button';
 
 interface PreviousPageType {
   prevPage?: ResolvedNavLinkItem | null;
@@ -10,13 +12,17 @@ interface PreviousPageType {
 
 export function PreviousPageLink(): JSX.Element {
   const { prevPage }: PreviousPageType = usePageData() || {};
-  if (!prevPage) {
+  const { themeSettings } = useThemeSettings(DEFAULT_THEME_NAME);
+
+  if (!prevPage || themeSettings?.navigation?.hide) {
     return <div>&nbsp;</div>;
   }
 
+  const label = themeSettings?.navigation?.nextPageLink?.label || `Back to ${prevPage.label}`;
+
   return (
     <Button variant="outlined" size="large" to={prevPage.link}>
-      Back to {prevPage.label}
+      {label}
     </Button>
   );
 }

package/src/Search/SidebarSearch.tsx

@@ -0,0 +1,13 @@
+import styled from 'styled-components';
+
+import { Search } from '@theme/Search/Search';
+import { Popover } from '@theme/Search/Popover';
+
+export const SidebarSearch = styled(Search)`
+  --search-input-text-color: var(--sidebar-item-active-color);
+
+  ${Popover} {
+    right: unset;
+    top: 100%;
+  }
+`;

package/src/Sidebar/MenuGroup.tsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import styled from 'styled-components';
 
-import { Arrow } from '@theme/ui/Arrow';
+import { ArrowIcon } from '@theme/icons/ArrowIcon/ArrowIcon';
 import { ItemState } from '@theme/Sidebar/types/ItemState';
 import { MenuLinkItem } from '@theme/Sidebar/MenuLinkItem';
 import { MenuItemLabel } from '@theme/Sidebar/MenuItemLabel';
@@ -50,6 +50,6 @@ const MenuGroupLabel = styled(MenuItemLabel)<{ isAlwaysExpanded?: boolean }>`
   cursor: ${(props) => (props.isAlwaysExpanded ? 'default' : 'pointer')};
 `;
 
-const MenuGroupArrow = styled(Arrow)`
+const MenuGroupArrow = styled(ArrowIcon)`
   margin-right: calc(var(--sidebar-spacing-unit) / 2);
 `;

package/src/Sidebar/SidebarLayout.tsx

@@ -5,6 +5,9 @@ import { Sidebar } from '@theme/Sidebar/Sidebar';
 import { useMobileMenu } from '@theme/hooks/useMobileMenu';
 import { MobileSidebarButton } from '@theme/Sidebar/MobileSidebarButton';
 import { MenuContainer } from '@theme/Sidebar/MenuContainer';
+import { useThemeSettings } from '@portal/hooks/';
+import { DEFAULT_THEME_NAME } from '@portal/constants/';
+import { SidebarSearch } from '@theme/Search/SidebarSearch';
 
 interface SidebarLayoutProps {
   versions: React.ReactNode;
@@ -14,11 +17,13 @@ interface SidebarLayoutProps {
 export function SidebarLayout({ versions, menu }: SidebarLayoutProps): JSX.Element {
   const [isOpen, setIsOpen] = useMobileMenu();
   const toggleMenu = () => setIsOpen(!isOpen);
+  const { hide, placement } = useThemeSettings(DEFAULT_THEME_NAME).search || {};
 
   return (
     <Wrapper data-component-name="Sidebar/SidebarLayout">
       <MobileSidebarButton opened={isOpen} onClick={toggleMenu} />
 
+      {!hide && placement === 'sidebar' ? <SidebarSearch /> : null}
       <Sidebar animate={true} opened={isOpen}>
         {versions}
         <MenuContainer>{menu}</MenuContainer>

package/src/TableOfContent/TableOfContent.tsx

@@ -2,8 +2,10 @@ import React, { useRef } from 'react';
 import styled from 'styled-components';
 
 import { useFullHeight } from '@theme/hooks/useFullHeight';
+import { useThemeSettings } from '@portal/hooks';
 import { useActiveHeading } from '@theme/hooks/useActiveHeading';
 import { MdHeading } from '@theme/types/portal';
+import { DEFAULT_THEME_NAME } from '@portal/constants';
 
 interface TableOfContentProps {
   headings?: Array<MdHeading | null> | null | undefined;
@@ -17,7 +19,11 @@ export function TableOfContent(props: TableOfContentProps): JSX.Element | null {
   const sidebar = useRef<HTMLDivElement | null>(null);
   useFullHeight(sidebar);
   const activeHeadingId = useActiveHeading(contentWrapper);
+  const { themeSettings } = useThemeSettings(DEFAULT_THEME_NAME);
 
+  if (themeSettings?.toc?.hide) {
+    return null;
+  }
   if (headings && headings.length === 1 && (!headings[0] || headings[0].depth === 1)) {
     return null;
   }
@@ -30,7 +36,7 @@ export function TableOfContent(props: TableOfContentProps): JSX.Element | null {
       {headings && (
         <TableOfContentMenu data-component-name="TableOfContent/TableOfContent">
           <TableOfContentItems ref={sidebar}>
-            <TocHeader>On this page</TocHeader>
+            <TocHeader>{themeSettings?.toc?.header?.label || 'On this page'}</TocHeader>
             {headings.map((heading: MdHeading | null, idx: number) => {
               // TODO: not sure about !heading
               if (!heading) {

package/src/Typography/CompactTypography.ts

@@ -0,0 +1,9 @@
+import styled from 'styled-components';
+
+import { Typography } from '@theme/Typography/Typography';
+
+export const CompactTypography = styled(Typography).attrs(() => ({
+  mt: '0em',
+  mb: '0em',
+  'data-component-name': 'Typography/CompactTypography',
+}))``;

package/src/Typography/Emphasis.ts

@@ -0,0 +1,7 @@
+import styled from 'styled-components';
+
+export const Emphasis = styled.strong.attrs(() => ({
+  'data-component-name': 'Typography/Emphasis',
+}))`
+  font-weight: var(--font-weight-bold);
+`;

package/src/Typography/H1.ts

@@ -0,0 +1,12 @@
+import styled from 'styled-components';
+
+import { typography } from '@theme/utils';
+
+export const H1 = styled.h1.attrs(() => ({
+  'data-component-name': 'Headings/H1',
+}))`
+  color: var(--color-content);
+  margin: 0 0 25px;
+
+  ${typography('h1', 'h')};
+`;

package/src/Typography/H2.ts

@@ -0,0 +1,12 @@
+import styled from 'styled-components';
+
+import { typography } from '@theme/utils';
+
+export const H2 = styled.h2.attrs(() => ({
+  'data-component-name': 'Headings/H2',
+}))`
+  color: var(--color-content);
+  margin: 0 0 20px;
+
+  ${typography('h2', 'h')};
+`;

package/src/Typography/H3.ts

@@ -0,0 +1,11 @@
+import styled from 'styled-components';
+
+import { typography } from '@theme/utils';
+
+export const H3 = styled.h3.attrs(() => ({
+  'data-component-name': 'Headings/H3',
+}))`
+  color: var(--color-content);
+
+  ${typography('h3', 'h')};
+`;

package/src/Typography/SectionHeader.ts

@@ -0,0 +1,11 @@
+import styled from 'styled-components';
+
+export const SectionHeader = styled.h2`
+  color: var(--h-color);
+  font-size: 1.75em;
+  font-weight: var(--font-weight-regular);
+  text-align: center;
+  margin: 2.65em 0;
+  padding: 0 20px;
+  font-family: var(--h-font-family);
+`;

package/src/Typography/Typography.ts

@@ -0,0 +1,21 @@
+import styled from 'styled-components';
+import { color, typography as typographySystem, TypographyProps } from 'styled-system';
+
+export const Typography = styled.p.attrs(() => ({
+  'data-component-name': 'Typography/Typography',
+}))<
+  TypographyProps & {
+    color?: string;
+    mt?: string;
+    mb?: string;
+  }
+>`
+  font-size: var(--font-size-base);
+  font-family: var(--font-family-base);
+  line-height: var(--line-height-base);
+  color: var(--color-content);
+  ${color};
+  margin-top: ${({ mt }) => mt || '1em'};
+  margin-bottom: ${({ mb }) => mb || '1em'};
+  ${typographySystem}
+`;

package/src/Typography/index.ts

@@ -0,0 +1,7 @@
+export * from '@theme/Typography/H1';
+export * from '@theme/Typography/H2';
+export * from '@theme/Typography/H3';
+export * from '@theme/Typography/Emphasis';
+export * from '@theme/Typography/SectionHeader';
+export * from '@theme/Typography/Typography';
+export * from '@theme/Typography/CompactTypography';

package/src/globalStyle.ts

@@ -735,6 +735,7 @@ const navbar = css`
   --navbar-height: 60px; // @presenter Spacing
   --navbar-text-color: #fff; // @presenter Color
   --navbar-background-color: var(--color-primary-500); // @presenter Color
+  --navbar-drowpdown-shadow: 4px 4px 15px -2px rgba(0, 0, 0, 0.5);
 
   /**
     * @tokens Navbar Item

package/src/{ui → icons/AlertIcon}/AlertIcon.tsx

@@ -1,12 +1,12 @@
 import React from 'react';
 import styled from 'styled-components';
 
-interface IconProps {
+export interface AlertIconProps {
   type: 'warning' | 'success' | 'danger' | 'attention' | 'info';
   className?: string;
 }
 
-function Icon({ type, className }: IconProps) {
+function Icon({ type, className }: AlertIconProps) {
   switch (type) {
     case 'warning':
       return (
@@ -96,7 +96,7 @@ function Icon({ type, className }: IconProps) {
 }
 
 export const AlertIcon = styled(Icon).attrs(() => ({
-  'data-component-name': 'ui/AlertIcon',
+  'data-component-name': 'icons/AlertIcon/AlertIcon',
 }))`
   position: absolute;
   left: var(--admonition-padding-horizontal);

package/src/icons/AlertIcon/index.ts

@@ -0,0 +1,2 @@
+export { AlertIcon } from '@theme/icons/AlertIcon/AlertIcon';
+export type { AlertIconProps } from '@theme/icons/AlertIcon/AlertIcon';

package/src/{ui/Arrow.tsx → icons/ArrowIcon/ArrowIcon.tsx}

@@ -1,11 +1,11 @@
 import React from 'react';
 import styled from 'styled-components';
 
-export interface ArrowProps {
-  direction?: string;
+export interface ArrowIconProps {
+  direction?: 'up' | 'right' | 'left' | 'down';
 }
 
-function directionToTransform({ direction }: ArrowProps) {
+function directionToTransform({ direction }: ArrowIconProps) {
   switch (direction) {
     case 'up':
       return 180;
@@ -19,14 +19,14 @@ function directionToTransform({ direction }: ArrowProps) {
 }
 
 const Icon = ({ className }: { className?: string }) => (
-  <span data-component-name="ui/Arrow/Arrow">
+  <span data-component-name="icons/ArrowIcon/ArrowIcon">
     <svg fill="none" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 7 5" className={className}>
       <path d="M3.5 2.51L5.806.205a.7.7 0 01.99.99l-2.8 2.8a.698.698 0 01-.99 0l-2.8-2.8a.7.7 0 11.99-.99L3.5 2.51z" />
     </svg>
   </span>
 );
 
-export const Arrow = styled(Icon)`
+export const ArrowIcon = styled(Icon)`
   width: var(--sidebar-chevron-size);
   height: var(--sidebar-chevron-size);
   fill: var(--sidebar-chevron-color);

package/src/icons/ArrowIcon/index.ts

@@ -0,0 +1,2 @@
+export { ArrowIcon } from '@theme/icons/ArrowIcon/ArrowIcon';
+export type { ArrowIconProps } from '@theme/icons/ArrowIcon/ArrowIcon';

package/src/icons/index.ts

@@ -1 +1,3 @@
 export * from '@theme/icons/ShelfIcon';
+export * from '@theme/icons/AlertIcon';
+export * from '@theme/icons/ArrowIcon';

package/src/index.ts

@@ -1,7 +1,7 @@
 export * from './Button';
 export * from './CopyButton';
 export * from './JsonViewer';
-export * from './Headings';
+export * from './Typography';
 export * from './SidebarLogo';
 export * from './CodeBlock';
 export * from './SamplesPanelControls';

package/src/mocks/constants/index.ts

@@ -0,0 +1,2 @@
+export const DEFAULT_THEME_NAME = '@redocly/theme';
+export const USER_THEME_ALIAS = '@theme';

package/src/mocks/hooks/index.ts

@@ -0,0 +1,17 @@
+interface RawTheme {
+  name: string;
+  settings?: any;
+}
+
+export function useThemeSettings(name: string): RawTheme['settings'] {
+  return {
+    name,
+    settings: {
+      toc: { header: 'header', hide: false },
+      navigation: {
+        nextPageLink: { label: 'next page' },
+        previousPageLink: { label: 'prev page' },
+      },
+    },
+  };
+}

package/src/types/portal/index.d.ts

@@ -1,4 +1,3 @@
-export * from './src/client/styling';
 export * from './src/client/app/Sidebar/types';
 export * from './src/server/plugins/portal-config/types';
 export * from './src/shared/types';

package/src/types/portal/src/client/app/Sidebar/types.d.ts

@@ -27,7 +27,7 @@ export interface ItemState extends SidebarNavItem {
     items: ItemState[];
     active: boolean;
     hasActiveSubItem: boolean;
-    menuStyle?: MenuStyle | null;
+    menuStyle?: MenuStyle;
 }
 export declare enum MenuType {
     Separator = "separator",

package/src/types/portal/src/server/{utils → content}/content-provider.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 import * as chokidar from 'chokidar';
 import * as fs from 'fs';
-import { VersionStore } from '../version-store.js';
 import { PathVersionInfo } from '../plugins/types.js';
+import { VersionsConfig } from './versions-config.js';
 declare type WatchCb = (event: 'add' | 'change' | 'unlink', path: string, stats?: fs.Stats) => Promise<void>;
 export interface ContentRecord {
     content: string;
@@ -16,15 +16,15 @@ export interface ParsedContentRecord<T = unknown> extends ContentRecord {
 export interface ContentProvider {
     cwd: string;
     filesList: Set<string>;
-    versions: VersionStore;
+    versions: VersionsConfig;
     loadContent(relativePath: string, parse?: undefined): ContentRecord;
     loadContent<T = unknown>(relativePath: string, parse: 'yaml'): ParsedContentRecord<T>;
     loadContent(relativePath: string, parse: 'frontmatter'): ParsedContentRecord<{
         content: string;
-        data: unknown;
+        data: Record<string, any>;
     }>;
     loadContent(relativePath: string, parse: 'yaml' | 'frontmatter' | undefined): ParsedContentRecord;
-    getVersionInfoByFsPath: (relativePath: string) => PathVersionInfo;
+    getVersionInfoByFsPath: (relativePath: string) => PathVersionInfo | undefined;
     has(relativePath: string): boolean;
 }
 export declare class FsContentProvider implements ContentProvider {
@@ -32,20 +32,20 @@ export declare class FsContentProvider implements ContentProvider {
     cwd: string;
     private initialContentLoaded;
     filesList: Set<string>;
-    versions: VersionStore;
+    versions: VersionsConfig;
     constructor(cwd: string, initialCache?: Map<string, ContentRecord>);
     private emit;
     has(relativePath: string): boolean;
-    getVersionInfoByFsPath(relativePath: string): PathVersionInfo;
+    getVersionInfoByFsPath(relativePath: string): PathVersionInfo | undefined;
     loadContent(relativePath: string, parse?: undefined): ContentRecord;
-    loadContent(relativePath: string, parse: 'yaml'): ParsedContentRecord<unknown>;
+    loadContent<T = unknown>(relativePath: string, parse: 'yaml'): ParsedContentRecord<T>;
     loadContent(relativePath: string, parse: 'frontmatter'): ParsedContentRecord<{
         content: string;
-        data: unknown;
+        data: Record<string, any>;
     }>;
     watch(test: RegExp, cb: WatchCb): void;
     stop(): Promise<void>;
     start(): void;
-    ready(): Promise<chokidar.FSWatcher>;
+    ready(): Promise<chokidar.FSWatcher | undefined>;
 }
 export {};

package/src/types/portal/src/server/{version-store.d.ts → content/versions-config.d.ts}

@@ -1,7 +1,7 @@
-import type { Version } from '../shared/types';
-import { ContentProvider } from './utils/index.js';
-import { PathVersionInfo } from './plugins/types';
-export declare class VersionStore {
+import type { Version } from '../../shared/types';
+import { PathVersionInfo } from '../plugins/types';
+import type { ContentProvider } from './content-provider';
+export declare class VersionsConfig {
     contentProvider: ContentProvider;
     private config;
     constructor(contentProvider: ContentProvider);
@@ -29,7 +29,7 @@ export declare class VersionStore {
      * @param allFilePaths
      */
     resolveConfig(allFilePaths: Set<string>): void;
-    getPageVersions(pagePath: string, suffix?: string): Version[];
-    getDefaultByPath(path: string): string;
-    getVersionInfoByFsPath(path: string): PathVersionInfo | null;
+    getPageVersions(pagePath: string, suffix?: string): Version[] | undefined;
+    getDefaultByPath(path: string): string | null | undefined;
+    getVersionInfoByFsPath(path: string): PathVersionInfo | undefined;
 }

package/src/types/portal/src/server/plugins/markdown/types.d.ts

@@ -1,23 +1,26 @@
-import { Config, RenderNodes } from '@markdoc/markdoc/dist/src/types';
-import type { ContentProvider, ContentRecord } from '../../utils/content-provider.js';
+import { Config, Node, RenderableTreeNode } from '@markdoc/markdoc/dist/src/types';
+import type { ContentProvider, ContentRecord } from '../../content/content-provider.js';
+import { PluginDefaultOptions } from '../types.js';
 import type { RouteDetails } from '../types.js';
-export declare type MarkdownOptions = {
-    contentDir: string;
-    outdir: string;
-    getRouteByFsPath: (relativePath: string) => RouteDetails;
-    getRouteBySlug: (slug: string) => RouteDetails;
-    contentProvider: ContentProvider;
-};
 export interface MdHeading {
     id: string;
     value: string;
     depth: number;
 }
+export declare type MarkdownOptions = {
+    getRouteByFsPath: (relativePath: string) => RouteDetails | undefined;
+    getRouteBySlug?: (slug: string) => RouteDetails | undefined;
+    contentProvider: ContentProvider;
+};
+export interface MdPartialsContext {
+    partials: Record<string, Node>;
+}
+export declare type MdRenderContext = ContentRecord & PluginDefaultOptions & MdPartialsContext;
+export declare type MdCompilationContext = MdRenderContext & MarkdownOptions;
 export interface MdCompilationResult {
-    result: RenderNodes;
+    result: RenderableTreeNode;
     headings: MdHeading[];
 }
-export declare type MdCompilationContext = ContentRecord & MarkdownOptions;
 export interface ExtendedMarkdocConfig extends Config {
     currentProcessedPage?: string;
 }

package/src/types/portal/src/server/plugins/portal-config/types.d.ts

@@ -1,23 +1,20 @@
-import { LogoConfig, RawNavItem, ResolvedNavItem } from '../../../shared/types.js';
-export interface PortalConfig extends Record<string, any> {
-    nav?: RawNavItem[];
-    logo?: LogoConfig;
-    themes?: CustomTheme[];
-    footer?: FooterConfig;
+import { ResolvedConfigLinks } from '../../../shared/types.js';
+import { PortalConfig, RawTheme } from '../../../shared/models/config.js';
+import { Redirect } from '../types';
+export interface GlobalData {
+    nav?: ResolvedConfigLinks;
+    logo?: PortalConfig['logo'];
+    footer?: ResolvedConfigLinks;
+    themeSettings?: PortalConfig['themes'];
 }
-export interface CustomTheme {
-    name: string;
-    settings?: any;
-    themeStyles?: string;
-}
-export interface FooterConfig {
-    copyrightText?: string;
-    columns?: FooterColumn[];
-}
-export interface FooterColumn {
-    group: string;
-    label?: string;
-    items: ResolvedNavItem[];
+export interface GlobalConfig {
+    themes: RawTheme[];
+    scripts?: string;
+    stylesheets?: string;
+    redirects: Record<string, Redirect>;
+    fileName: string;
+    [k: string]: unknown;
 }
+export declare type RbacConfig = Record<string, string[]>;
 export declare type CustomEntryPropertyType = Record<string, string | boolean>;
 export declare type ScriptOrStylesheetConfig = string | CustomEntryPropertyType;

package/src/types/portal/src/server/plugins/types.d.ts

@@ -1,9 +1,11 @@
 import type { PageProps, ResolvedNavItem } from '../../shared/types.js';
 import type { Template } from '../store';
-import type { ContentProvider } from '../utils/content-provider.js';
+import type { ContentProvider } from '../content/content-provider.js';
+import { SearchData, SearchDocument } from '../../shared/models';
+import type { GlobalData, GlobalConfig, RbacConfig } from './portal-config/types.js';
 export declare type DataLoaderContext = {
-    getRouteByFsPath: (relativePath: string) => RouteDetails;
-    getRouteBySlug: (relativePath: string) => RouteDetails;
+    getRouteByFsPath: (relativePath: string) => RouteDetails | undefined;
+    getRouteBySlug: (relativePath: string) => RouteDetails | undefined;
 };
 export declare type DataLoader<T = any> = (contentProvider: ContentProvider, context: DataLoaderContext) => Promise<T>;
 export interface RouteDetails {
@@ -16,6 +18,11 @@ export interface RouteDetails {
     };
     getNavText?: () => Promise<string>;
     getSidebar?(): ResolvedNavItem[];
+    getSearchDocuments?(): Promise<SearchDocument[]>;
+}
+export interface Redirect {
+    to: string;
+    type: number;
 }
 export interface PathVersionInfo {
     version: string;
@@ -23,23 +30,22 @@ export interface PathVersionInfo {
     versionFolderId: string;
 }
 export interface ProcessContentActions {
+    createSharedData(id: string, data: unknown): string;
+    addRouteSharedData(slug: string, dataKey: string, dataId: string): void;
     addRoute: (route: RouteDetails) => void;
     createTemplate: (template: Template) => Template;
-    createSharedData(id: string, data: any): string;
-    addRouteSharedData(slug: string, dataKey: string, dataId: string): void;
+    setRbacConfig: (rbacConfig: RbacConfig) => void;
 }
 export interface AfterRoutesCreatedActions {
-    createSharedData(id: string, data: any): string;
+    createSharedData(id: string, data: unknown): string;
     addRouteSharedData(routeSlug: string, dataKey: string, dataId: string): void;
-    getRouteByFsPath: (relativePath: string) => RouteDetails;
-    getRouteBySlug: (relativePath: string) => RouteDetails;
+    getRouteByFsPath: (relativePath: string) => RouteDetails | undefined;
+    getRouteBySlug: (relativePath: string) => RouteDetails | undefined;
     getAllRoutes: () => RouteDetails[];
-    setGlobalData: (data: Record<string, unknown>) => void;
-    setGlobalConfig: (data: Record<string, unknown>) => void;
-    addRedirect: (from: string, to: {
-        to: string;
-        type: number;
-    }) => void;
+    setGlobalData: (data: GlobalData) => void;
+    setGlobalConfig: (data: Partial<GlobalConfig>) => void;
+    setSearchData: (data: SearchData) => void;
+    addRedirect: (from: string, to: Redirect) => void;
     contentDir: string;
 }
 export interface PluginInstance {
@@ -47,9 +53,11 @@ export interface PluginInstance {
     processContent?: (content: ContentProvider, actions: ProcessContentActions) => Promise<void>;
     afterRoutesCreated?: (content: ContentProvider, actions: AfterRoutesCreatedActions) => Promise<void>;
 }
-export interface PluginOptions {
+export interface PluginDefaultOptions {
     contentDir: string;
     outdir: string;
+}
+export interface PluginOptions extends PluginDefaultOptions {
     [k: string]: unknown;
 }
 export declare type Plugin = (opts: PluginOptions) => PluginInstance;