@redocly/theme 0.4.14 → 0.4.16

package/src/hooks/__tests__/mocks/MockIntersectionObserver.ts

@@ -0,0 +1,48 @@
+export class MockIntersectionObserver {
+  public readonly root: Element | Document | null;
+  public readonly rootMargin: string;
+  public readonly thresholds: ReadonlyArray<number>;
+
+  private viewPort: any;
+  private entries: any[];
+  private readonly callback: IntersectionObserverCallback;
+
+  constructor(callback: IntersectionObserverCallback, options?: IntersectionObserverInit) {
+    this.viewPort = options?.root ? options.root : window;
+    this.entries = [];
+    this.root = null;
+    this.rootMargin = '0px';
+    this.thresholds = [1];
+    this.callback = callback;
+
+    this.viewPort.addEventListener('scroll', this.intersect);
+  }
+
+  private intersect = () => {
+    this.entries.map((entry) => {
+      entry.isIntersecting = this.isInViewPort(entry.target);
+    });
+    this.callback(this.entries, this);
+  };
+
+  isInViewPort(target: HTMLElement): boolean {
+    return target.id !== 'toc-0';
+  }
+
+  observe(target: HTMLElement): void {
+    this.entries.push({ isIntersecting: false, target });
+  }
+
+  unobserve(target: HTMLElement): void {
+    this.entries = this.entries.filter((ob) => ob.target !== target);
+  }
+
+  disconnect(): void {
+    this.viewPort.removeEventListener('scroll', this.intersect);
+    this.entries = [];
+  }
+
+  takeRecords(): any[] {
+    return this.entries;
+  }
+}

package/src/hooks/useActiveSectionId.ts

@@ -1,5 +1,6 @@
 import { useEffect, useState, useMemo } from 'react';
 import throttle from 'lodash.throttle';
+
 import type { Location } from 'history';
 
 import { useNavbarHeight } from '@theme/hooks/useNavbarHeight';

package/src/hooks/useDefaultThemeSettings.ts

@@ -1,7 +1,6 @@
-import type { RawTheme } from '@portal/types';
-
 import { useThemeSettings } from '@portal/hooks';
 import { DEFAULT_THEME_NAME } from '@portal/constants';
+import type { RawTheme } from '@portal/types';
 
 export function useDefaultThemeSettings(): RawTheme['settings'] {
   return useThemeSettings(DEFAULT_THEME_NAME);

package/src/hooks/useFullHeight.ts

@@ -1,7 +1,8 @@
-import type { MutableRefObject } from 'react';
 import { useCallback, useEffect, useMemo } from 'react';
 import throttle from 'lodash.throttle';
 
+import type { MutableRefObject } from 'react';
+
 export function useFullHeight(element: MutableRefObject<HTMLElement | null>): void {
   const handler = useCallback(() => {
     if (!element.current) {

package/src/hooks/useMobileMenu.ts

@@ -1,7 +1,8 @@
-import type { Dispatch, SetStateAction } from 'react';
 import { useEffect, useState } from 'react';
 import { useHistory } from 'react-router-dom';
 
+import type { Dispatch, SetStateAction } from 'react';
+
 export function useMobileMenu(initialState = false): [boolean, Dispatch<SetStateAction<boolean>>] {
   const { location } = useHistory();
   const [isOpen, setIsOpen] = useState(initialState);

package/src/hooks/useNavbarHeight.ts

@@ -1,4 +1,5 @@
 import { useEffect, useState } from 'react';
+
 import type { Location } from 'history';
 
 import { getNavbarElement } from '@theme/utils/getNavbarElement';

package/src/hooks/useOutsideClick.ts

@@ -1,6 +1,7 @@
-import type { MutableRefObject } from 'react';
 import { useEffect } from 'react';
 
+import type { MutableRefObject } from 'react';
+
 export function useOutsideClick(
   ref: MutableRefObject<HTMLElement | null>,
   handler: (event: MouseEvent | TouchEvent) => void,

package/src/mocks/hooks/index.ts

@@ -11,10 +11,10 @@ interface PageLink {
 
 export function useThemeSettings(_: string): RawTheme['settings'] {
   return {
-    toc: { header: 'header', hide: false },
+    toc: { header: { label: 'header' }, hide: false },
     navigation: {
       nextPageLink: { label: 'next page theme settings label' },
-      previousPageLink: { label: 'prev page theme settings label' },
+      prevPageLink: { label: 'prev page theme settings label' },
     },
     colorMode: {
       modes: ['light', 'dark'],

package/src/mocks/types.ts

@@ -3,5 +3,12 @@ export type SearchDocument = any;
 export type OperationParameter = any;
 export interface RawTheme {
   name: string;
-  settings: any;
+  settings: {
+    lastUpdatedBlock?: {
+      hide?: boolean;
+      format?: 'timeago' | 'iso' | 'short' | 'long';
+      locale?: string;
+    };
+    [k: string]: any; // TODO: add missing settings
+  };
 }

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

@@ -1,43 +1,43 @@
-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 DEFAULT_THEME_NAME = "@redocly/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_ASSETS_FOLDER = "/assets";
-export declare const PUBLIC_STATIC_FOLDER = "/static";
-export declare const PERMISSION_PROP_NAME = "redocly::permission";
-export declare const DEFAULT_PLACEHOLDER_PERMISSION = "redocly:default-permission";
-export declare const DIRECTORY_PERMISSIONS_FILE_NAME = "permissions.rbac.yaml";
+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 DEFAULT_THEME_NAME = '@redocly/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_ASSETS_FOLDER = '/assets';
+export declare const PUBLIC_STATIC_FOLDER = '/static';
+export declare const PERMISSION_PROP_NAME = 'redocly::permission';
+export declare const DEFAULT_PLACEHOLDER_PERMISSION = 'redocly:default-permission';
+export declare const DIRECTORY_PERMISSIONS_FILE_NAME = 'permissions.rbac.yaml';
 export declare const REQUIRED_OIDC_SCOPES: string[];
 export declare const DEFAULT_COOKIE_EXPIRATION: number;
-export declare const DEFAULT_AUTHENTICATED_ROLE = "AuthenticatedUser";
-export declare const DEFAULT_AUTHENTICATED_PERMISSION = "redocly:authenticated-user";
+export declare const DEFAULT_AUTHENTICATED_ROLE = 'AuthenticatedUser';
+export declare const DEFAULT_AUTHENTICATED_PERMISSION = 'redocly:authenticated-user';
 export declare const SEARCH_LIMIT = 50;
 export declare enum ServerRoutes {
-    EJECT_COMPONENT = "/eject-component/:componentName",
-    SHARED_PAGE_DATA = "/page-data/shared/*",
-    PAGE_DATA = "/page-data/*",
-    APP_DATA = "/app-data.json",
-    SEARCH_DATA = "/search-data.json",
-    SEARCH_INDEX = "/search-index.json",
-    AUTHORIZATION = "/authorize",
-    OIDC_CALLBACK = "/_auth/oidc",
-    SAML_CALLBACK = "/_auth/saml2",
-    BASIC_AUTH = "/_auth/basic",
-    REDOCLY_CALLBACK = "/_auth/redocly",
-    REDOCLY_LOGIN_CALLBACK = "/_auth/redocly/redocly-login",
-    SEARCH = "/_search",
-    LOGOUT = "/logout",
-    LOGIN = "/login",
-    IDP_LOGIN = "/_auth/idp-login"
+  EJECT_COMPONENT = '/eject-component/:componentName',
+  SHARED_PAGE_DATA = '/page-data/shared/*',
+  PAGE_DATA = '/page-data/*',
+  APP_DATA = '/app-data.json',
+  SEARCH_DATA = '/search-data.json',
+  SEARCH_INDEX = '/search-index.json',
+  AUTHORIZATION = '/authorize',
+  OIDC_CALLBACK = '/_auth/oidc',
+  SAML_CALLBACK = '/_auth/saml2',
+  BASIC_AUTH = '/_auth/basic',
+  REDOCLY_CALLBACK = '/_auth/redocly',
+  REDOCLY_LOGIN_CALLBACK = '/_auth/redocly/redocly-login',
+  SEARCH = '/_search',
+  LOGOUT = '/logout',
+  LOGIN = '/login',
+  IDP_LOGIN = '/_auth/idp-login',
 }
-export declare const DEV_LOGIN_SLUG = "/login/";
+export declare const DEV_LOGIN_SLUG = '/login/';
 export declare enum ExternalRoutes {
-    AUTH0_PASS = "/auth/auth0-pass"
+  AUTH0_PASS = '/auth/auth0-pass',
 }
 export declare enum FsErrors {
-    NotExist = "ENOENT"
+  NotExist = 'ENOENT',
 }
 export declare const INTERNALLY_IGNORED_FILES: string[];

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

@@ -1,5 +1,5 @@
 export declare type MdHeading = {
-    id: string;
-    value: string;
-    depth: number;
+  id: string;
+  value: string;
+  depth: number;
 };

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

@@ -1,146 +1,156 @@
 /// <reference types="react" />
 import type { PERMISSION_PROP_NAME } from '../constants';
 export declare type ResolvedNavLinkItem = {
-    type: 'link';
-    link: string;
-    label: string;
-    items?: ResolvedNavItem[];
-    external?: boolean;
-    version?: string;
-    isDefault?: boolean;
-    versionFolderId?: string;
-    httpVerb?: string;
-    separatorLine?: boolean;
-    routeSlug?: string;
-    active?: boolean;
-    [PERMISSION_PROP_NAME]?: string;
+  type: 'link';
+  link: string;
+  label: string;
+  items?: ResolvedNavItem[];
+  external?: boolean;
+  version?: string;
+  isDefault?: boolean;
+  versionFolderId?: string;
+  httpVerb?: string;
+  separatorLine?: boolean;
+  routeSlug?: string;
+  active?: boolean;
+  [PERMISSION_PROP_NAME]?: string;
 };
 export declare type ResolvedNavGroupItem = {
-    type: 'group';
-    link?: string;
-    label?: string;
-    items?: ResolvedNavItem[];
-    expanded?: string;
-    version?: string;
-    isDefault?: boolean;
-    versionFolderId?: string;
-    menuStyle?: MenuStyle;
-    separatorLine?: boolean;
-    routeSlug?: string;
-    active?: boolean;
-    [PERMISSION_PROP_NAME]?: string;
-};
-export declare type ResolvedNavItem = ResolvedNavLinkItem | ResolvedNavGroupItem | {
-    type: 'separator';
-    label?: string;
-    version?: string;
-    isDefault?: boolean;
-    versionFolderId?: string;
-    separatorLine?: boolean;
-    link?: undefined;
-    items?: ResolvedNavItem[];
-    [PERMISSION_PROP_NAME]?: string;
-} | {
-    type: 'error';
-    version?: string;
-    isDefault?: boolean;
-    versionFolderId?: string;
-    label: string;
-    link?: undefined;
-    items?: ResolvedNavItem[];
-    [PERMISSION_PROP_NAME]?: string;
+  type: 'group';
+  link?: string;
+  label?: string;
+  items?: ResolvedNavItem[];
+  expanded?: string;
+  version?: string;
+  isDefault?: boolean;
+  versionFolderId?: string;
+  menuStyle?: MenuStyle;
+  separatorLine?: boolean;
+  routeSlug?: string;
+  active?: boolean;
+  [PERMISSION_PROP_NAME]?: string;
 };
+export declare type ResolvedNavItem =
+  | ResolvedNavLinkItem
+  | ResolvedNavGroupItem
+  | {
+      type: 'separator';
+      label?: string;
+      version?: string;
+      isDefault?: boolean;
+      versionFolderId?: string;
+      separatorLine?: boolean;
+      link?: undefined;
+      items?: ResolvedNavItem[];
+      [PERMISSION_PROP_NAME]?: string;
+    }
+  | {
+      type: 'error';
+      version?: string;
+      isDefault?: boolean;
+      versionFolderId?: string;
+      label: string;
+      link?: undefined;
+      items?: ResolvedNavItem[];
+      [PERMISSION_PROP_NAME]?: string;
+    };
 export declare type ResolvedNavItemWithLink = (ResolvedNavLinkItem | ResolvedNavGroupItem) & {
-    link: string;
+  link: string;
 };
 export declare type ResolvedSidebar = ResolvedNavItem[];
 export interface PageProps {
-    seo?: {
-        title: string;
-    };
-    frontmatter?: Omit<PageProps, 'frontmatter'> & {
-        settings?: any;
-    };
-    disableAutoScroll?: boolean;
-    lastModified?: string | null;
-    [k: string]: any;
+  seo?: {
+    title: string;
+  };
+  frontmatter?: Omit<PageProps, 'frontmatter'> & {
+    settings?: any;
+  };
+  disableAutoScroll?: boolean;
+  lastModified?: string | null;
+  [k: string]: any;
 }
 export interface PageStaticData {
-    props?: PageProps;
-    [k: string]: unknown;
+  props?: PageProps;
+  [k: string]: unknown;
 }
 export declare type UserData = {
-    isAuthorized: boolean;
-    name: string;
-    picture: string;
-    logoutDisabled?: boolean;
+  isAuthorized: boolean;
+  name: string;
+  picture: string;
+  logoutDisabled?: boolean;
 };
 export interface PageData {
-    templateId: string;
-    sharedDataIds: Record<string, string>;
-    props: PageProps;
-    versions?: Version[];
-    userData: UserData;
+  templateId: string;
+  sharedDataIds: Record<string, string>;
+  props: PageProps;
+  versions?: Version[];
+  userData: UserData;
 }
 export interface CachedPageData extends PageData {
-    Template: React.ComponentType<{
-        pageProps: PageProps;
-    }>;
+  Template: React.ComponentType<{
+    pageProps: PageProps;
+  }>;
 }
 export interface ResolvedPageData extends CachedPageData {
-    sharedData: Record<string, unknown>;
-    nextPage?: any;
-    prevPage?: any;
+  sharedData: Record<string, unknown>;
+  nextPage?: any;
+  prevPage?: any;
 }
 export declare enum MenuStyle {
-    Drilldown = "drilldown"
+  Drilldown = 'drilldown',
 }
 export declare type NavItem = {
-    page?: string;
-    directory?: string;
-    group?: string;
-    label?: string;
-    href?: never;
-    items?: NavItem[];
-    separator?: string;
-    separatorLine?: boolean;
-    version?: string;
-    menuStyle?: MenuStyle;
-    external?: boolean;
-    expanded?: boolean | 'always';
+  page?: string;
+  directory?: string;
+  group?: string;
+  label?: string;
+  href?: never;
+  items?: NavItem[];
+  separator?: string;
+  separatorLine?: boolean;
+  version?: string;
+  menuStyle?: MenuStyle;
+  external?: boolean;
+  expanded?: boolean | 'always';
 };
 export declare type RawNavItem = string | NavItem;
 export interface LogoConfig {
-    image?: string;
-    altText?: string;
-    link?: string;
-    favicon?: string;
+  image?: string;
+  altText?: string;
+  link?: string;
+  favicon?: string;
 }
 export declare type Version = {
-    version: string;
-    label: string;
-    link: string;
-    default: boolean;
-    active: boolean;
-    notExists?: boolean;
-    folderId: string;
+  version: string;
+  label: string;
+  link: string;
+  default: boolean;
+  active: boolean;
+  notExists?: boolean;
+  folderId: string;
 };
 export declare type VersionConfigItem = {
-    version: string;
-    name?: string;
+  version: string;
+  name?: string;
 };
 export declare type VersionsConfigType = {
-    versions: VersionConfigItem[];
-    default?: string;
+  versions: VersionConfigItem[];
+  default?: string;
 };
 export declare type VersionedFolderConfig = {
-    versionedFiles: Map<string, Set<string>>;
-    defaultVersion?: string;
-    versions: VersionConfigItem[];
-    hasVersionsConfig?: boolean;
+  versionedFiles: Map<string, Set<string>>;
+  defaultVersion?: string;
+  versions: VersionConfigItem[];
+  hasVersionsConfig?: boolean;
 };
 export declare type NavGroup = ResolvedNavItem[] | undefined | string | boolean | number;
 export declare type NavGroupRecord = Record<string, NavGroup>;
 export declare type ResolvedConfigLinks = NavGroup | NavGroupRecord;
-export declare type RawNavConfigItem = RawNavItem | RawNavItem[] | string | undefined | boolean | number;
+export declare type RawNavConfigItem =
+  | RawNavItem
+  | RawNavItem[]
+  | string
+  | undefined
+  | boolean
+  | number;
 export declare type RawNavConfig = RawNavConfigItem | Record<string, RawNavConfigItem>;

package/src/ui/Box.tsx

@@ -1,3 +1,6 @@
+import { space, position, flex, textAlign, color, border, layout } from 'styled-system';
+import styled from 'styled-components';
+
 import type {
   SpaceProps,
   LayoutProps,
@@ -7,8 +10,6 @@ import type {
   FlexProps,
   BordersProps,
 } from 'styled-system';
-import { space, position, flex, textAlign, color, border, layout } from 'styled-system';
-import styled from 'styled-components';
 
 export interface BoxProps
   extends SpaceProps,

package/src/ui/Burger.tsx

@@ -1,7 +1,8 @@
-import type { MouseEventHandler } from 'react';
 import React from 'react';
 import styled from 'styled-components';
 
+import type { MouseEventHandler } from 'react';
+
 export interface BurgerProps {
   onClick: MouseEventHandler;
   className?: string;

package/src/ui/Dropdown.tsx

@@ -1,9 +1,8 @@
 import React, { useState, useRef, useEffect } from 'react';
 import styled from 'styled-components';
 
-import type { Version } from '@theme/types/portal';
-
 import { Link } from '@portal/Link';
+import type { Version } from '@theme/types/portal';
 
 type DropdownProps = {
   items: Version[];

package/src/ui/Flex.tsx

@@ -1,8 +1,9 @@
 import React from 'react';
 import styled from 'styled-components';
-import type { FlexboxProps, WidthProps } from 'styled-system';
 import { flexbox, width } from 'styled-system';
 
+import type { FlexboxProps, WidthProps } from 'styled-system';
+
 import { Box } from '@theme/ui/Box';
 
 export interface FlexProps extends FlexboxProps, WidthProps {}

package/src/ui/Tiles/ThinTile.tsx

@@ -1,7 +1,8 @@
-import type { CSSProperties } from 'react';
 import React, { Component } from 'react';
 import styled from 'styled-components';
 
+import type { CSSProperties } from 'react';
+
 import { Link } from '@portal/Link';
 import { Flex } from '@theme/ui/Flex';
 import { TileText } from '@theme/ui/Tiles/TileText';

package/src/ui/Tiles/WideTile.tsx

@@ -1,11 +1,10 @@
 import React, { Component } from 'react';
 import styled from 'styled-components';
 
-import type { TileProps } from '@theme/ui';
-
 import { Link } from '@portal/Link';
 import { TileText } from '@theme/ui/Tiles/TileText';
 import { TileHeader } from '@theme/ui/Tiles/TileHeader';
+import type { TileProps } from '@theme/ui';
 
 // prettier-ignore
 const WideTileWrapper = styled(Link)<{

package/src/ui/UniversalLink.tsx

@@ -1,8 +1,9 @@
 import * as React from 'react';
-import type { LinkProps } from 'react-router-dom';
 import { useLocation } from 'react-router-dom';
 import styled from 'styled-components';
 
+import type { LinkProps } from 'react-router-dom';
+
 import { isUrl } from '@theme/utils/isUrl';
 import { Link } from '@portal/Link';
 

package/src/utils/theme-helpers.ts

@@ -1,4 +1,5 @@
 import { css } from 'styled-components';
+
 import type { FlattenSimpleInterpolation } from 'styled-components';
 
 enum Token {