@merkur/cli/types.d.ts

Merkur is tiny and extensible library for creating front-end microservices.

import type { BuildOptions } from 'esbuild';
import type { Request, Response } from '@types/express';
import type { CorsOptions } from '@types/cors';

export interface CLIConfig {
  environment: string;
  isProduction: boolean;
  watch: boolean;
  writeToDisk: boolean;
  outFile: string;
  port: number;
  runTask: string[];
  devServerPort: number;
  projectFolder: string;
  cliFolder: string;
  buildFolder: string;
  staticFolder: string;
  staticPath: string;
  hasRunDevServer: boolean;
  hasRunWidgetServer: boolean;
  inspect: boolean;
  verbose: boolean;
}

export type Extend =
  | '@merkur/preact/cli'
  | '@merkur/svelte/cli'
  | '@merkur/uhtml/cli'
  | string
  | undefined;

export interface Task {
  name: 'es13' | 'es9' | 'node' | string;
  folder: 'es13' | 'es9' | string;
  build: BuildOptions;
  [key: string]: any;
}

export interface DevServer {
  protocol: string;
  host: string;
  port: number;
  origin: string;
  staticPath: string;
  staticFolder: string;
}

export interface Playground {
  template: string;
  /**
   * @deprecated Use templateFolders instead.
   */
  templateFolder: string;
  /**
   * @deprecated Use templateFolders instead.
   */
  serverTemplateFolder: string;
  templateFolders: string[];
  path: string;
  widgetHandler(req: Request, res: Response): Record<string, unknown>;
  widgetParams(req: Request): URLSearchParams;
}

export interface SocketServer {
  protocol: string;
  host: string;
  port: number;
}

export interface WidgetServer {
  protocol: string;
  host: string;
  port: number;
  origin: string;
  staticFolder: string;
  staticPath: string;
  buildFolder: string;
  clusters: number;
  cors: {
    options: CorsOptions;
  };
}

export interface Constant {
  HOST: string;
}

export interface MerkurConfig {
  HMR: boolean;
  constant: Constant;
  cliConfig: CLIConfig;
  extends: Extend[];
  task: {
    [key: string]: Task;
  };
  devServer: DevServer;
  defaultEntries: {
    client: string;
    server: string;
    [key: string]: string;
  };
  playground: Playground;
  socketServer: SocketServer;
  widgetServer: WidgetServer;
  onMerkurConfig: ({
    merkurConfig: MerkurConfig,
    cliConfig: CLIConfig,
  }) => Partial<MerkurConfig>;
  onCliConfig: ({ cliConfig: CLIConfig }) => Partial<CLIConfig>;
  onTaskBuild: ({
    definition: Task,
    build: BuildOptions,
    cliConfig: CLIConfig,
    merkurConfig: MerkurConfig,
  }) => Partial<BuildOptions>;
}

export function defineConfig({ cliConfig: CLIConfig }): Partial<MerkurConfig>;