@redocly/theme 0.1.9 → 0.1.12

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

@@ -2,13 +2,9 @@ import type { MediaQueries } from './../app/media-css';
 import { defaultTheme } from './default.js';
 export declare const theme: AppTheme;
 declare type InferDeep<T extends object> = {
-  [k in keyof T]: T[k] extends (...args: any) => any
-    ? ReturnType<T[k]>
-    : T[k] extends object
-    ? InferDeep<T[k]>
-    : T[k];
+    [k in keyof T]: T[k] extends (...args: any) => any ? ReturnType<T[k]> : T[k] extends object ? InferDeep<T[k]> : T[k];
 };
 export declare type AppTheme = InferDeep<typeof defaultTheme> & {
-  mediaQueries: MediaQueries;
+    mediaQueries: MediaQueries;
 };
 export {};

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

@@ -1,11 +1,7 @@
 export declare enum cliCommandNames {
-  BUILD = 'build',
-  DEVELOP = 'develop',
-}
-export declare const VERSION_SEPARATOR = '@';
-export declare const DEFAULT_VERSION_NAME = 'default';
-export declare enum PageType {
-  MARKDOWN = 'Markdown',
-  REFERENCE_DOCS = 'ReferenceDocs',
-  REACT = 'React',
+    BUILD = "build",
+    DEVELOP = "develop"
 }
+export declare const VERSION_SEPARATOR = "@";
+export declare const DEFAULT_VERSION_NAME = "default";
+export declare const VERSIONED_FOLDER_REGEXP_MATCH: RegExp;

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

@@ -1,28 +1,23 @@
 import { Config, RenderNodes } from '@markdoc/markdoc/dist/src/types';
-import type { Page } from '../../store';
-import type { VersionsConfigType } from '../versions/types';
+import type { ContentProvider, ContentRecord } from '../../utils/content-provider.js';
+import type { RouteDetails } from '../types.js';
 export declare type MarkdownOptions = {
-  contentDir: string;
-  version?: string;
-  versionsConfig: Map<string, VersionsConfigType>;
-  pages: Map<string, Page>;
-  allPagesPaths: string[];
-  outdir: string;
+    contentDir: string;
+    outdir: string;
+    getRouteByFsPath: (relativePath: string) => RouteDetails;
+    getRouteBySlug: (slug: string) => RouteDetails;
+    contentProvider: ContentProvider;
 };
 export interface MdHeading {
-  id: string;
-  value: string;
-  depth: number;
+    id: string;
+    value: string;
+    depth: number;
 }
 export interface MdCompilationResult {
-  result: RenderNodes;
-  headings: MdHeading[];
+    result: RenderNodes;
+    headings: MdHeading[];
 }
-export declare type MdCompilationContext = {
-  absolutePath: string;
-  content: string;
-  contentHash: string;
-} & MarkdownOptions;
+export declare type MdCompilationContext = ContentRecord & MarkdownOptions;
 export interface ExtendedMarkdocConfig extends Config {
-  currentProcessedPage?: string;
+    currentProcessedPage?: string;
 }

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

@@ -1,23 +1,23 @@
 import { LogoConfig, RawNavItem, ResolvedNavItem } from '../../../shared/types.js';
 export interface PortalConfig extends Record<string, any> {
-  nav?: RawNavItem[];
-  logo?: LogoConfig;
-  themes?: CustomTheme[];
-  footer?: FooterConfig;
+    nav?: RawNavItem[];
+    logo?: LogoConfig;
+    themes?: CustomTheme[];
+    footer?: FooterConfig;
 }
 export interface CustomTheme {
-  name: string;
-  settings?: any;
-  themeStyles?: string;
+    name: string;
+    settings?: any;
+    themeStyles?: string;
 }
 export interface FooterConfig {
-  copyrightText?: string;
-  columns?: FooterColumn[];
+    copyrightText?: string;
+    columns?: FooterColumn[];
 }
 export interface FooterColumn {
-  group: string;
-  label?: string;
-  items: ResolvedNavItem[];
+    group: string;
+    label?: string;
+    items: ResolvedNavItem[];
 }
 export declare type CustomEntryPropertyType = Record<string, string | boolean>;
 export declare type ScriptOrStylesheetConfig = string | CustomEntryPropertyType;

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

@@ -0,0 +1,55 @@
+import type { PageProps, ResolvedNavItem } from '../../shared/types.js';
+import type { Template } from '../store';
+import type { ContentProvider } from '../utils/content-provider.js';
+export declare type DataLoaderContext = {
+    getRouteByFsPath: (relativePath: string) => RouteDetails;
+    getRouteBySlug: (relativePath: string) => RouteDetails;
+};
+export declare type DataLoader<T = any> = (contentProvider: ContentProvider, context: DataLoaderContext) => Promise<T>;
+export interface RouteDetails {
+    slug: string;
+    fsPath: string;
+    templateId: string;
+    dataLoaders: {
+        props: DataLoader<PageProps>;
+        [k: string]: DataLoader;
+    };
+    getNavText?: () => Promise<string>;
+    getSidebar?(): ResolvedNavItem[];
+}
+export interface PathVersionInfo {
+    version: string;
+    isDefault: boolean;
+    versionFolderId: string;
+}
+export interface ProcessContentActions {
+    addRoute: (route: RouteDetails) => void;
+    createTemplate: (template: Template) => Template;
+    createSharedData(id: string, data: any): string;
+    addRouteSharedData(slug: string, dataKey: string, dataId: string): void;
+}
+export interface AfterRoutesCreatedActions {
+    createSharedData(id: string, data: any): string;
+    addRouteSharedData(routeSlug: string, dataKey: string, dataId: string): void;
+    getRouteByFsPath: (relativePath: string) => RouteDetails;
+    getRouteBySlug: (relativePath: string) => RouteDetails;
+    getAllRoutes: () => RouteDetails[];
+    setGlobalData: (data: Record<string, unknown>) => void;
+    setGlobalConfig: (data: Record<string, unknown>) => void;
+    addRedirect: (from: string, to: {
+        to: string;
+        type: number;
+    }) => void;
+    contentDir: string;
+}
+export interface PluginInstance {
+    watch?: RegExp;
+    processContent?: (content: ContentProvider, actions: ProcessContentActions) => Promise<void>;
+    afterRoutesCreated?: (content: ContentProvider, actions: AfterRoutesCreatedActions) => Promise<void>;
+}
+export interface PluginOptions {
+    contentDir: string;
+    outdir: string;
+    [k: string]: unknown;
+}
+export declare type Plugin = (opts: PluginOptions) => PluginInstance;

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

@@ -1,101 +1,53 @@
-import { Sidebar } from './plugins/sidebars/index.js';
-import { PageType } from './constants.js';
-import type { Version, VersionsConfigType } from './plugins/versions/types.js';
-import type { ResolvedNavItem } from '../shared/types.js';
-export interface PageProps {
-  id: string;
-  seo: {
-    title: string;
-  };
-  versions?: Version[];
-  [k: string]: unknown;
-}
-export interface Page {
-  type: PageType;
-  basePath: string;
-  relativePath: string;
-  id: string;
-  pathname: string;
-  absolutePath: string;
-  hash: string;
-  sidebarId: string | null;
-  version: string;
-  versions: Version[] | null;
-  dataDependencies?: string[];
-  getPageProps(): Promise<PageProps>;
-  getSidebarLabel(): Promise<string>;
-  getTemplateId(): string;
-  getSidebar?(): ResolvedNavItem[];
-  getSidebarPages?(): Page[];
-  clone(version: string, versionsConfig: Map<string, VersionsConfigType>): Page;
-}
+import type { RouteDetails } from './plugins/types.js';
 export declare class Template {
-  absolutePath: string;
-  id: string;
-  hash: string;
-  constructor(absolutePath: string, id: string);
+    absolutePath: string;
+    id: string;
+    hash: string;
+    constructor(absolutePath: string, id: string);
 }
 export declare class Store {
-  contentDir: string;
-  outdir: string;
-  renderMode: 'thread_worker' | 'main';
-  isReady: boolean;
-  allAbsolutePaths: string[];
-  pages: Map<string, Page>;
-  sidebars: Map<string, Sidebar>;
-  sharedData: Map<string, any>;
-  templates: Map<string, Template>;
-  esbuildPlugins: any[];
-  listeners: Map<string, Set<Function>>;
-  globalData: Record<string, unknown>;
-  cliOptions: Record<string, unknown>;
-  globalConfig: Record<string, unknown>;
-  readyPromise: Promise<void>;
-  versionsConfig: Map<string, VersionsConfigType>;
-  private _resolveReady;
-  sidebarUpdatesFrozen: boolean;
-  ignoredContentPaths: string[];
-  currentProcessedPage: string;
-  constructor(contentDir: string, outdir?: string, renderMode?: 'thread_worker' | 'main');
-  on(type: 'page-updated', cb: (page: Page) => void | any): void;
-  on(type: 'sidebar-updated', cb: (sidebar: Sidebar) => void | any): void;
-  on(type: 'template-updated', cb: (template: Template) => void | any): void;
-  on(type: 'ready', cb: (pathname: string) => 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;
-  on(type: 'versions-config-updated', cb: any): void;
-  runListeners<T extends Array<unknown>>(
-    type:
-      | 'ready'
-      | 'page-updated'
-      | 'template-updated'
-      | 'sidebar-updated'
-      | 'global-data-updated'
-      | 'shared-data-updated'
-      | 'versions-config-updated',
-    ...args: T
-  ): void;
-  ready(): void;
-  addEsbuildPlugin(plugin: any): void;
-  setVersionsConfig(id: string, data: VersionsConfigType): void;
-  setGlobalData(data: Record<string, unknown>): void;
-  setCliOptions(data: Record<string, unknown>): void;
-  setGlobalConfig(data: Record<string, unknown>): void;
-  setAllAbsolutePaths(paths: any): void;
-  setVersionConfigUpdated(): void;
-  getPageByPathname(pathname: string): Page;
-  getSidebarById(id: string): Sidebar;
-  getPageByFsPath(absolutePath: string): Page;
-  createSidebar(sidebar: Sidebar): void;
-  removeSidebar(id: string): void;
-  createSharedData(id: string, data: any): string;
-  createPage(page: Page): Promise<void>;
-  deletePage(pathname: string): void;
-  getTemplate(id: string): Template;
-  createTemplate(template: Template): void;
-  private verifyVersionsLink;
-  private assignPagesSidebars;
+    contentDir: string;
+    outdir: string;
+    renderMode: 'thread_worker' | 'main';
+    routesBySlug: Map<string, RouteDetails>;
+    routesByFsPath: Map<string, RouteDetails>;
+    routesSharedData: Map<string, Record<string, string>>;
+    sharedData: Map<string, any>;
+    templates: Map<string, Template>;
+    esbuildPlugins: any[];
+    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;
+    };
+    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;
+    addRouteSharedData: (routeSlug: string, dataKey: string, dataId: string) => void;
+    addRoute: (route: RouteDetails) => void;
+    getRouteByFsPath: (relativePath: string) => RouteDetails;
+    getRouteBySlug: (slug: string) => RouteDetails;
+    getAllRoutes: () => RouteDetails[];
+    getTemplate: (id: string) => Template;
+    createTemplate: (template: Template) => Template;
+    clear: () => void;
 }

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

@@ -1,5 +1 @@
-export declare function promiseMapLimit<T, P>(
-  array: T[],
-  poolLimit: number,
-  iteratorFn: (arg: T, array: T[]) => Promise<P>,
-): Promise<P[]>;
+export declare function promiseMapLimit<T, P>(array: T[], poolLimit: number, iteratorFn: (arg: T, array: T[]) => Promise<P>): Promise<P[]>;

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

@@ -0,0 +1,51 @@
+/// <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';
+declare type WatchCb = (event: 'add' | 'change' | 'unlink', path: string, stats?: fs.Stats) => Promise<void>;
+export interface ContentRecord {
+    content: string;
+    contentHash: string;
+    relativePath: string;
+    parsed?: any;
+}
+export interface ParsedContentRecord<T = unknown> extends ContentRecord {
+    parsed: T;
+}
+export interface ContentProvider {
+    cwd: string;
+    filesList: Set<string>;
+    versions: VersionStore;
+    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;
+    }>;
+    loadContent(relativePath: string, parse: 'yaml' | 'frontmatter' | undefined): ParsedContentRecord;
+    getVersionInfoByFsPath: (relativePath: string) => PathVersionInfo;
+    has(relativePath: string): boolean;
+}
+export declare class FsContentProvider implements ContentProvider {
+    #private;
+    cwd: string;
+    private initialContentLoaded;
+    filesList: Set<string>;
+    versions: VersionStore;
+    constructor(cwd: string, initialCache?: Map<string, ContentRecord>);
+    private emit;
+    has(relativePath: string): boolean;
+    getVersionInfoByFsPath(relativePath: string): PathVersionInfo;
+    loadContent(relativePath: string, parse?: undefined): ContentRecord;
+    loadContent(relativePath: string, parse: 'yaml'): ParsedContentRecord<unknown>;
+    loadContent(relativePath: string, parse: 'frontmatter'): ParsedContentRecord<{
+        content: string;
+        data: unknown;
+    }>;
+    watch(test: RegExp, cb: WatchCb): void;
+    stop(): Promise<void>;
+    start(): void;
+    ready(): Promise<chokidar.FSWatcher>;
+}
+export {};

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

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

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

@@ -1,16 +1,13 @@
+import { ContentProvider } from './index.js';
 export declare function getDataFromRelativePath(relativePath: string): {
-  pathVersion: string;
-  basePath: string;
+    pathVersion: string;
+    basePath: string;
 };
-export declare function generatePagePathname(
-  currentVersion?: string | null,
-  defaultVersion?: string | null,
-  ...combineParts: string[]
-): string;
+export declare function generatePagePathname(currentVersion?: string | null, defaultVersion?: string | null, ...combineParts: string[]): string;
+export declare function slugFromRelativePath(relativePath: string, contentProvider: ContentProvider): string;
+export declare function slug(str: string): string;
 export declare function fromCurrentDir(moduleUrl: string, path: string): string;
-export declare function excludeVersion<T extends string[] | string>(
-  arg: T,
-): {
-  version?: string;
-  data: T;
-};
+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,11 +1,11 @@
 declare const formatter: {
-  success(message: string, ...args: any[]): string;
-  info(message: string, ...args: any[]): string;
-  warn(message: string, ...args: any[]): string;
-  error(message: string, ...args: any[]): string;
-  verbose(message: string, ...args: any[]): string;
-  formatMs(ms: number): string;
-  withTime(message: any, reporter: any): string;
-  format(pattern: string, ...args: any[]): string;
+    success(message: string, ...args: any[]): string;
+    info(message: string, ...args: any[]): string;
+    warn(message: string, ...args: any[]): string;
+    error(message: string, ...args: any[]): string;
+    verbose(message: string, ...args: any[]): string;
+    formatMs(ms: number): string;
+    withTime(message: any, reporter: any): string;
+    format(pattern: string, ...args: any[]): string;
 };
 export default formatter;

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

@@ -1,17 +1,17 @@
 export declare const reporter: {
-  now(): number;
-  startTiming(): void;
-  getTimeSpan(): number;
-  success(message: string, ...args: any[]): void;
-  successTime(message: string, ...args: any[]): void;
-  info(message: string, ...args: any[]): void;
-  infoTime(message: string, ...args: any[]): void;
-  warn(message: string, ...args: any[]): void;
-  warnTime(message: string, ...args: any[]): void;
-  error(message: string, ...args: any[]): void;
-  verbose(message: string, ...args: any[]): void;
-  verboseTime(message: string, ...args: any[]): void;
-  panic(message: string, ...args: any[]): never;
-  panicOnBuild(message: string, ...args: any[]): void;
-  flushErrors(): void;
+    now(): number;
+    startTiming(): void;
+    getTimeSpan(): number;
+    success(message: string, ...args: any[]): void;
+    successTime(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    infoTime(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    warnTime(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    verbose(message: string, ...args: any[]): void;
+    verboseTime(message: string, ...args: any[]): void;
+    panic(message: string, ...args: any[]): never;
+    panicOnBuild(message: string, ...args: any[]): void;
+    flushErrors(): void;
 };

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

@@ -0,0 +1,35 @@
+import type { Version } from '../shared/types';
+import { ContentProvider } from './utils/index.js';
+import { PathVersionInfo } from './plugins/types';
+export declare class VersionStore {
+    contentProvider: ContentProvider;
+    private config;
+    constructor(contentProvider: ContentProvider);
+    private parsePath;
+    /**
+     * Goes through config and makes sure each folder has a default version set
+     * By default, versions are sorted alphabetically and last one becomes default
+     */
+    private setDefaultVersions;
+    /**
+     * Checks for nested versions and files in the root of versioned folder
+     * @param allFiles relative paths of all files
+     */
+    private validateVersionsStructure;
+    /**
+     * Read config and store it in the state and mark folder with hasVersionsConfig = true
+     * to prevent versions list from being deducted automatically.
+     * This means that if file strucutre has 3 versions, but config only specifies 2, the list will only have 2
+     * @param versionsFilePath path to versions.yaml
+     */
+    private parseVersionsFile;
+    /**
+     * Reads and validates versions config.
+     * TODO: takes ~200-400ms on tests/starter. Consider partial updates instead of rebuilding if this is becoming a bottleneck
+     * @param allFilePaths
+     */
+    resolveConfig(allFilePaths: Set<string>): void;
+    getPageVersions(pagePath: string, suffix?: string): Version[];
+    getDefaultByPath(path: string): string;
+    getVersionInfoByFsPath(path: string): PathVersionInfo | null;
+}

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

@@ -1,8 +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 USER_THEME_ALIAS = '@theme';
-export declare const PUBLIC_STATIC_FOLDER = '/static';
+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 USER_THEME_ALIAS = "@theme";
+export declare const PUBLIC_STATIC_FOLDER = "/static";
 export declare enum FsErrors {
-  NotExist = 'ENOENT',
+    NotExist = "ENOENT"
 }