@redocly/theme 0.1.17 → 0.1.20

package/src/Navbar/NavbarDropdown.tsx

@@ -0,0 +1,44 @@
+import React from 'react';
+import styled from 'styled-components';
+
+import type { ResolvedNavLinkItem } from '@theme/types/portal';
+import { Link } from '@portal/Link';
+
+interface NavbarDropdownProps {
+  items: ResolvedNavLinkItem[];
+}
+
+export function NavbarDropdown({ items }: NavbarDropdownProps): JSX.Element {
+  return (
+    <DropdownWrapper data-component-name="Navbar/NavbarDropdown">
+      {items.map((item, index) => (
+        <div key={`${item.label}_${index}`}>
+          <Link to={item.link}>{item.label}</Link>
+        </div>
+      ))}
+    </DropdownWrapper>
+  );
+}
+
+export const DropdownWrapper = styled.div`
+  display: none;
+  position: absolute;
+  background: var(--navbar-item-active-background-color);
+  border-radius: var(--navbar-item-border-radius);
+  padding: 10px 15px;
+  width: max-content;
+  line-height: 1rem;
+  box-shadow: var(--navbar-dropdown-shadow);
+  & > div {
+    text-align: left;
+    padding: 10px 0px;
+    cursor: pointer;
+    a {
+      color: var(--navbar-text-color);
+      text-decoration: none;
+    }
+    :hover {
+      text-decoration: underline;
+    }
+  }
+`;

package/src/Navbar/NavbarItem.tsx

@@ -2,67 +2,60 @@ import React from 'react';
 import styled from 'styled-components';
 import { useLocation } from 'react-router-dom';
 
+import type {
+  ResolvedNavItem,
+  ResolvedNavLinkItem,
+  ResolvedNavGroupItem,
+} from '@theme/types/portal';
 import { Link } from '@portal/Link';
 import { withPathPrefix } from '@portal/utils';
+import { NavbarDropdown, DropdownWrapper } from '@theme/Navbar/NavbarDropdown';
 
-export enum MenuStyle {
-  Drilldown = 'drilldown',
+interface NavbarItemProps {
+  navItem: ResolvedNavItem;
 }
 
-export type ResolvedNavLinkItem = {
-  type: 'link';
-  link: string;
-  label: string;
-  items?: ResolvedNavItem[];
-  external?: boolean;
-  version?: string;
-  default?: string;
-  httpVerb?: string; // TODO: make a separate type of item
-  separatorLine?: boolean;
-  active?: boolean;
-};
+export function NavbarItem({ navItem }: NavbarItemProps): JSX.Element | null {
+  const { pathname } = useLocation();
 
-export type ResolvedNavGroupItem = {
-  type: 'group';
-  link?: string;
-  label: string;
-  items: ResolvedNavItem[];
-  version?: string;
-  default?: string;
-  menuStyle?: MenuStyle;
-  separatorLine?: boolean;
-  active?: boolean;
-};
+  if ((navItem as ResolvedNavLinkItem).link) {
+    const item = navItem as ResolvedNavLinkItem;
+    const isActive = pathname === withPathPrefix(item.link);
+    return (
+      <NavMenuItem active={isActive} data-component-name="Navbar/NavbarItem">
+        <NavLink to={item.link} active={isActive}>
+          <NavLabel>{item.label}</NavLabel>
+        </NavLink>
+      </NavMenuItem>
+    );
+  }
 
-export type ResolvedNavItem =
-  | ResolvedNavLinkItem
-  | ResolvedNavGroupItem
-  | {
-      type: 'separator';
-      label?: string;
-      separatorLine?: boolean;
-    }
-  | {
-      type: 'error';
-      label: string;
-    };
+  if ((navItem as ResolvedNavGroupItem).items) {
+    const item = navItem as ResolvedNavGroupItem;
+    return (
+      <NavMenuItemWithDropdownWrapper>
+        <NavMenuItem active={false} data-component-name="Navbar/NavbarItem">
+          <NavLabel>{item.label}</NavLabel>
+        </NavMenuItem>
+        <NavbarDropdown items={item.items as ResolvedNavLinkItem[]} />
+      </NavMenuItemWithDropdownWrapper>
+    );
+  }
 
-interface NavbarItemProps {
-  navItem: ResolvedNavLinkItem;
+  return null;
 }
 
-export function NavbarItem({ navItem }: NavbarItemProps): JSX.Element {
-  const { pathname } = useLocation();
-  const isActive = pathname === withPathPrefix(navItem.link);
-
-  return (
-    <NavMenuItem active={isActive} data-component-name="Navbar/NavbarItem">
-      <NavLink to={navItem.link} active={isActive}>
-        <NavLabel>{navItem.label}</NavLabel>
-      </NavLink>
-    </NavMenuItem>
-  );
-}
+const NavMenuItemWithDropdownWrapper = styled.div`
+  display: inline-block;
+  position: relative;
+  border-radius: var(--navbar-item-border-radius);
+  &:hover {
+    background: var(--navbar-item-active-background-color);
+    ${DropdownWrapper} {
+      display: block;
+    }
+  }
+`;
 
 const NavMenuItem = styled.li<{ active?: boolean }>`
   display: inline-block;

package/src/Navbar/NavbarMenu.tsx

@@ -2,16 +2,19 @@ import React from 'react';
 import styled from 'styled-components';
 
 import { NavbarItem } from '@theme/Navbar/NavbarItem';
+import type { ResolvedConfigLinks, ResolvedNavItem } from '@theme/types/portal';
 
-export function NavbarMenu({ menuItems }: { menuItems: any[] }): JSX.Element | null {
+export function NavbarMenu({ menuItems }: { menuItems: ResolvedConfigLinks }): JSX.Element | null {
   if (!menuItems?.length) {
     return null;
   }
 
   return (
     <NavItemsContainer data-component-name="Navbar/NavbarMenu">
-      {menuItems.map((navItem, index) => {
-        return <NavbarItem key={index} data-cy={navItem.label} navItem={navItem} />;
+      {(menuItems as ResolvedNavItem[]).map((navItem, index) => {
+        return (
+          <NavbarItem key={`${navItem.label}_${index}`} data-cy={navItem.label} navItem={navItem} />
+        );
       })}
     </NavItemsContainer>
   );

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/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;

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

@@ -1,9 +1,12 @@
-import type { RouteDetails } from './plugins/types.js';
+import { Plugin } from 'esbuild';
+import { JSONIndex, SearchDocument, SearchData } from '../shared/models';
+import type { RouteDetails, Redirect } from './plugins/types.js';
+import type { GlobalData, GlobalConfig, RbacConfig } from './plugins/portal-config/types';
 export declare class Template {
-    absolutePath: string;
+    pathOrThemePath: string;
     id: string;
     hash: string;
-    constructor(absolutePath: string, id: string);
+    constructor(pathOrThemePath: string, id: string);
 }
 export declare class Store {
     contentDir: string;
@@ -12,42 +15,38 @@ export declare class Store {
     routesBySlug: Map<string, RouteDetails>;
     routesByFsPath: Map<string, RouteDetails>;
     routesSharedData: Map<string, Record<string, string>>;
-    sharedData: Map<string, any>;
+    searchDocuments: SearchDocument[];
+    searchIndex: JSONIndex;
+    sharedData: Map<string, unknown>;
     templates: Map<string, Template>;
-    esbuildPlugins: any[];
+    esbuildPlugins: Plugin[];
     listeners: Map<string, Set<Function>>;
-    globalData: Record<string, unknown>;
-    cliOptions: Record<string, unknown>;
-    globalConfig: {
-        scripts: string;
-        stylesheets: string;
-        redirects: Record<string, {
-            to: string;
-            type: number;
-        }>;
-        [k: string]: unknown;
-    };
+    rbacConfig: RbacConfig;
+    globalData: GlobalData;
+    cliOptions: Record<string, string>;
+    globalConfig: GlobalConfig;
     constructor(contentDir: string, outdir?: string, renderMode?: 'thread_worker' | 'main');
-    on(type: 'routes-updated', cb: () => void | any): void;
-    on(type: 'template-updated', cb: (template: Template) => void | any): void;
-    on(type: 'shared-data-updated', cb: (id: string, data: any) => void): any;
-    on(type: 'global-data-updated', cb: (pathname: string, data: Record<string, unknown>) => void | any): void;
-    runListeners<T extends Array<unknown>>(type: 'template-updated' | 'global-data-updated' | 'shared-data-updated' | 'routes-updated', ...args: T): void;
-    addEsbuildPlugin(plugin: any): void;
-    setGlobalData(data: Record<string, unknown>): void;
-    setCliOptions(data: Record<string, unknown>): void;
-    setGlobalConfig(data: Record<string, unknown>): void;
-    addRedirect(from: string, to: {
-        to: string;
-        type: number;
-    }): void;
-    createSharedData: (id: string, data: any) => string;
+    on(type: 'routes-updated', cb: () => void): void;
+    on(type: 'template-updated', cb: () => void): void;
+    on(type: 'build-updated', cb: () => void): void;
+    on(type: 'shared-data-updated', cb: (id: string, data: unknown) => void): void;
+    on(type: 'search-data-updated', cb: (data: SearchData) => void): void;
+    on(type: 'global-data-updated', cb: (pathname: string, data: Record<string, unknown>) => void): void;
+    runListeners<T extends Array<unknown>>(type: 'template-updated' | 'global-data-updated' | 'shared-data-updated' | 'search-data-updated' | 'routes-updated' | 'build-updated', ...args: T): void;
+    addEsbuildPlugin(plugin: Plugin): void;
+    setGlobalData(data: GlobalData): void;
+    setSearchData(data: SearchData): void;
+    setCliOptions(data: Record<string, string>): void;
+    setGlobalConfig(data: Partial<GlobalConfig>): void;
+    setRbacConfig(rbacConfig: RbacConfig): void;
+    addRedirect(from: string, to: Redirect): void;
+    createSharedData: (id: string, data: unknown) => string;
     addRouteSharedData: (routeSlug: string, dataKey: string, dataId: string) => void;
     addRoute: (route: RouteDetails) => void;
-    getRouteByFsPath: (relativePath: string) => RouteDetails;
-    getRouteBySlug: (slug: string) => RouteDetails;
+    getRouteByFsPath: (relativePath: string) => RouteDetails | undefined;
+    getRouteBySlug: (slug: string) => RouteDetails | undefined;
     getAllRoutes: () => RouteDetails[];
-    getTemplate: (id: string) => Template;
+    getTemplate: (id: string) => Template | undefined;
     createTemplate: (template: Template) => Template;
     clear: () => void;
 }

package/src/types/portal/src/server/utils/fs.d.ts

@@ -1,3 +1,4 @@
-export declare function readFileAsStringSync(filePath: string): string;
+export declare function readFileAsStringSync(filePath: string): string | null | undefined;
 export declare function readFileNames(dir: string): string[];
 export declare function copyStaticFile(absolutePath: string, outdir: string): string;
+export declare function ensureDir(path: string): string;

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

@@ -2,5 +2,4 @@ export * from './async.js';
 export * from './crypto.js';
 export * from './fs.js';
 export * from './reporter/reporter.js';
-export * from './content-provider.js';
 export * from './paths.js';

package/src/types/portal/src/server/utils/paths.d.ts

@@ -1,6 +1,6 @@
-import { ContentProvider } from './index.js';
+import type { ContentProvider } from '../content/content-provider.js';
 export declare function getDataFromRelativePath(relativePath: string): {
-    pathVersion: string;
+    pathVersion: string | null;
     basePath: string;
 };
 export declare function generatePagePathname(currentVersion?: string | null, defaultVersion?: string | null, ...combineParts: string[]): string;
@@ -10,4 +10,4 @@ export declare function fromCurrentDir(moduleUrl: string, path: string): string;
 export declare function excludeVersion<T extends string[] | string>(arg: T): {
     version?: string;
     data: T;
-} | undefined;
+};

package/src/types/portal/src/server/utils/reporter/formatter.d.ts

@@ -1,3 +1,4 @@
+import { Reporter } from './reporter';
 declare const formatter: {
     success(message: string, ...args: any[]): string;
     info(message: string, ...args: any[]): string;
@@ -5,7 +6,7 @@ declare const formatter: {
     error(message: string, ...args: any[]): string;
     verbose(message: string, ...args: any[]): string;
     formatMs(ms: number): string;
-    withTime(message: any, reporter: any): string;
+    withTime(message: string, reporter: Reporter): string;
     format(pattern: string, ...args: any[]): string;
 };
 export default formatter;

package/src/types/portal/src/server/utils/reporter/reporter.d.ts

@@ -1,7 +1,7 @@
 export declare const reporter: {
     now(): number;
     startTiming(): void;
-    getTimeSpan(): number;
+    getTimeSpan(): number | undefined;
     success(message: string, ...args: any[]): void;
     successTime(message: string, ...args: any[]): void;
     info(message: string, ...args: any[]): void;
@@ -15,3 +15,4 @@ export declare const reporter: {
     panicOnBuild(message: string, ...args: any[]): void;
     flushErrors(): void;
 };
+export declare type Reporter = typeof reporter;

package/src/types/portal/src/shared/constants.d.ts

@@ -1,6 +1,8 @@
 export declare const RUNTIME_RESOURCES_DIR = "runtime";
 export declare const REDOC_OVERVIEW_ITEM_ID = "overview";
 export declare const PORTAL_CUSTOM_THEMES_FOLDER = "@theme";
+export declare const CUSTOM_MARKDOC_OPTIONS_PATH = "markdoc";
+export declare const CUSTOM_MARKDOC_TAGS_PATH = "tags";
 export declare const USER_THEME_ALIAS = "@theme";
 export declare const PUBLIC_STATIC_FOLDER = "/static";
 export declare enum FsErrors {

package/src/types/portal/src/shared/models/active-item.d.ts

@@ -0,0 +1,3 @@
+export declare type ActiveItem<T> = T & {
+    active: boolean;
+};

package/src/types/portal/src/shared/models/config.d.ts

@@ -0,0 +1,28 @@
+import { RawNavItem, LogoConfig, ResolvedNavItem } from '../types';
+export interface PortalConfig extends Record<string, any> {
+    nav?: RawNavItem[];
+    logo?: LogoConfig;
+    themes?: RawTheme[];
+    footer?: FooterConfig;
+}
+export interface RawTheme {
+    name: string;
+    settings?: any;
+}
+export interface ResolvedTheme extends RawTheme {
+    stylesFile?: string;
+    markdoc: {
+        nodesFiles: string[];
+        tagsFiles: string[];
+        componentsFile?: string;
+    };
+}
+export interface FooterConfig {
+    copyrightText?: string;
+    columns?: FooterColumn[];
+}
+export interface FooterColumn {
+    group: string;
+    label?: string;
+    items: ResolvedNavItem[];
+}

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

@@ -0,0 +1,6 @@
+export * from './search-document';
+export * from './active-item';
+export * from './search-data';
+export * from './json-index';
+export * from './operation-parameter';
+export * from './config';

package/src/types/portal/src/shared/models/json-index.d.ts

@@ -0,0 +1,5 @@
+import Fuse from 'fuse.js';
+export interface JSONIndex {
+    keys: ReadonlyArray<string>;
+    records: Fuse.FuseIndexRecords;
+}

package/src/types/portal/src/shared/models/operation-parameter.d.ts

@@ -0,0 +1,6 @@
+export interface OperationParameter {
+    name: string | string[];
+    description: string | string[];
+    place: string;
+    path?: string[];
+}