everything-dev/dist/config.d.mts

A consolidated product package for building Module Federation apps with oRPC APIs.

import { BosConfig, BosConfigInput, BosConfigSchema, BosPluginRef, RuntimeConfig, RuntimePluginConfig } from "./types.mjs";
import { BOS_CONFIG_ORDER, BosEnv, mergeBosConfigWithExtends, rebuildOrderedConfig, resolveExtendsRef } from "./merge.mjs";

//#region src/config.d.ts
declare const LOCAL_PREFIX = "local:";
type RuntimeOverrideTarget = "ui" | "api" | "plugins" | `plugins.${string}`;
declare function clearConfigCache(): void;
declare function suppressWarnings(): void;
declare function resumeWarnings(): void;
declare function drainConfigWarnings(): string[];
declare function findConfigPath(cwd?: string): string | null;
declare function getConfig(): BosConfig | null;
declare function getProjectRoot(): string;
interface ConfigResult {
  config: BosConfig;
  runtime: RuntimeConfig;
  source: {
    path: string;
    extended?: string[];
    remote?: boolean;
  };
  warnings?: string[];
}
interface LocalConfigResult {
  config: BosConfigInput;
  source: {
    path: string;
  };
}
interface RemoteConfigResult {
  rawConfig: BosConfigInput;
  config: BosConfig;
  source: string;
  extendsChain: string[];
}
interface ResolvedComposableReference {
  entry: BosPluginRef;
  providerBaseDir: string;
  targetPath: string;
  associatedUi?: Record<string, unknown>;
}
declare function loadLocalConfig(options?: {
  cwd?: string;
  path?: string;
}): Promise<LocalConfigResult | null>;
declare function loadResolvedConfig(options?: {
  cwd?: string;
  path?: string;
  env?: BosEnv;
}): Promise<ConfigResult | null>;
declare function loadBosConfig(options?: {
  cwd?: string;
  path?: string;
  env?: BosEnv;
}): Promise<RuntimeConfig>;
declare function loadRemoteConfig(bosUrl: string, env?: BosEnv): Promise<RemoteConfigResult>;
declare function parseRuntimeOverrideTargets(value?: string | null): RuntimeOverrideTarget[];
declare function isRuntimeOverrideAllowed(allowedTargets: ReadonlyArray<RuntimeOverrideTarget>, target: "ui" | "api" | "plugins" | `plugins.${string}`): boolean;
declare function buildRuntimePluginsForConfig(config: BosConfig, baseDir: string, env: BosEnv): Promise<Record<string, RuntimePluginConfig> | undefined>;
declare function getResolvedConfigPath(configDir: string): string;
declare function loadGeneratedResolvedConfig(configDir: string): BosConfig | null;
declare function writeResolvedConfig(configDir: string, config: BosConfig, env: BosEnv, extendsChain?: string[], source?: string): void;
declare function resolveBosConfigPath(configDir: string): string;
declare function readBosConfigForBuild(configDir: string): Record<string, unknown>;
declare function resolveComposableReference(source: BosPluginRef, baseDir: string, env: BosEnv, defaultTargetPath: string): Promise<ResolvedComposableReference>;
interface BuildRuntimeConfigOptions {
  plugins?: Record<string, RuntimePluginConfig>;
  hostSource?: "local" | "remote";
  uiSource?: "local" | "remote";
  apiSource?: "local" | "remote";
  authSource?: "local" | "remote";
  proxy?: string;
}
declare function buildRuntimeConfig(config: BosConfig, baseDir: string, env: BosEnv, options?: BuildRuntimeConfigOptions): RuntimeConfig;
declare function resolvePluginRuntimeName(explicitName: string | undefined, localPath: string | undefined, fallback: string): string;
declare function isLocalDevelopmentTarget(value: string | undefined): value is `${typeof LOCAL_PREFIX}${string}`;
declare function resolveLocalDevelopmentPath(value: string | undefined, baseDir: string): string | null;
declare function resolveDevelopmentHostUrl(value: string | undefined): string;
declare function getHostDevelopmentPort(value: string | undefined): number;
declare function parsePort(url: string): number;
//#endregion
export { BOS_CONFIG_ORDER, type BosConfig, BosConfigSchema, BuildRuntimeConfigOptions, ConfigResult, LocalConfigResult, RemoteConfigResult, ResolvedComposableReference, type RuntimeConfig, buildRuntimeConfig, buildRuntimePluginsForConfig, clearConfigCache, drainConfigWarnings, findConfigPath, getConfig, getHostDevelopmentPort, getProjectRoot, getResolvedConfigPath, isLocalDevelopmentTarget, isRuntimeOverrideAllowed, loadBosConfig, loadGeneratedResolvedConfig, loadLocalConfig, loadRemoteConfig, loadResolvedConfig, mergeBosConfigWithExtends, parsePort, parseRuntimeOverrideTargets, readBosConfigForBuild, rebuildOrderedConfig, resolveBosConfigPath, resolveComposableReference, resolveDevelopmentHostUrl, resolveExtendsRef, resolveLocalDevelopmentPath, resolvePluginRuntimeName, resumeWarnings, suppressWarnings, writeResolvedConfig };
//# sourceMappingURL=config.d.mts.map