@modern-js/types/cli/index.d.ts

A Progressive React Framework for modern web development.

import type { Config as JestConfigTypes } from '@jest/types';

export type JestConfig = JestConfigTypes.Config;

export interface TestConfig {
  /**
   * Decide which transformer will be used to compile file
   * @default 'babel-jest'
   */
  transformer?: 'babel-jest' | 'ts-jest';

  /**
   * Original jest config
   * Doc: https://jestjs.io/docs/configuration
   */
  jest?: JestConfig | ((jestConfig: JestConfig) => JestConfig);
}

/**
 * Bundle entrypoint
 */
export interface Entrypoint {
  entryName: string;
  isMainEntry: boolean;
  entry: string;
  internalEntry?: string;
  nestedRoutesEntry?: string;
  pageRoutesEntry?: string;
  isAutoMount?: boolean;
  /**
   * use src/{entryName}/entry.tsx to custom entry
   */
  customEntry?: boolean;

  customServerEntry?: string | false;

  fileSystemRoutes?: {
    globalApp?: string | false;
    routes?: any[];
  };
  absoluteEntryDir?: string;
  /**
   * use source.entries to custom entry
   */
  isCustomSourceEntry?: boolean;
}

/**
 * file system routes.
 */
export type RouteLegacy = {
  path: string;
  exact: boolean;
  component: string;
  _component: string;
  routes?: RouteLegacy[];
  parent?: RouteLegacy;
};

export interface Route {
  caseSensitive?: boolean;
  path?: string;
  id?: string;
  loader?: any;
  action?: any;
  hasErrorBoundary?: boolean;
  shouldRevalidate?: any;
  handle?: any;
  index?: boolean;
  children?: Route[] | undefined;
  element?: React.ReactNode | null;
  errorElement?: React.ReactNode | null;
  type: string;
}

export type NestedRouteForCli = NestedRoute<string>;

export interface NestedRoute<T = string | (() => JSX.Element)> extends Route {
  type: 'nested';
  origin: 'file-system' | 'config';
  // Route type to distinguish between page and layout routes
  routeType?: 'page' | 'layout';
  parentId?: string;
  data?: string;
  clientData?: string;
  children?: NestedRoute<T>[];
  filename?: string;
  _component?: string;
  component?: T;
  lazyImport?: () => Promise<any>;
  loading?: T;
  error?: T;
  isRoot?: boolean;
  config?: string | Record<string, any>;
  inValidSSRRoute?: boolean;
  params?: string[];
}

export interface PageRoute extends Route {
  type: 'page';
  parent?: PageRoute;
  _component: string;
  component: string;
  children?: PageRoute[];
}

/**
 * custom html partials.
 */
export interface HtmlPartials {
  top: string[];
  head: string[];
  body: string[];
}

export interface HtmlTemplates {
  [name: string]: string;
}

export type SSGRouteOptions =
  | string
  | {
      url: string;
      output?: string;
      headers?: Record<string, any>;
    };

export type SSGSingleEntryOptions =
  | boolean
  | {
      headers?: Record<string, any>;
      routes?: SSGRouteOptions[];
    };

export type SSGSingleEntryOptionsFactory = (
  entryName: string,
  ctx: { baseUrl?: string | string[] },
) => SSGSingleEntryOptions;

export type SSGMultiEntryOptions = Record<
  string,
  SSGSingleEntryOptions | SSGSingleEntryOptionsFactory
>;

export type SSGConfig =
  | boolean
  | SSGSingleEntryOptions
  | SSGSingleEntryOptionsFactory;

export type { Merge } from 'type-fest';