@rslib/core 0.18.5 → 0.19.0

package/dist-types/cli/commands.d.ts

@@ -1,13 +1,14 @@
 import type { LogLevel, RsbuildMode } from '@rsbuild/core';
-import type { ConfigLoader } from '../config';
-import type { Format, Syntax } from '../types/config';
+import type { ConfigLoader } from '../loadConfig';
+import type { Format, Syntax } from '../types';
 export type CommonOptions = {
     root?: string;
     config?: string;
+    configLoader?: ConfigLoader;
+    env?: boolean;
     envDir?: string;
     envMode?: string;
     lib?: string[];
-    configLoader?: ConfigLoader;
     logLevel?: LogLevel;
 };
 export type BuildOptions = CommonOptions & {
@@ -32,4 +33,4 @@ export type InspectOptions = CommonOptions & {
     verbose?: boolean;
 };
 export type MfDevOptions = CommonOptions;
-export declare function runCli(): void;
+export declare function setupCommands(): void;

package/dist-types/cli/index.d.ts

@@ -0,0 +1 @@
+export declare function runCLI(): void;

package/dist-types/cli/{initConfig.d.ts → init.d.ts}

@@ -1,9 +1,5 @@
-import type { RslibConfig } from '../types';
+import type { RslibConfig, RslibInstance } from '../types';
 import type { BuildOptions, CommonOptions } from './commands';
 export declare const parseEntryOption: (entries?: string[]) => Record<string, string> | undefined;
 export declare const applyCliOptions: (config: RslibConfig, options: BuildOptions, root: string) => void;
-export declare function initConfig(options: CommonOptions): Promise<{
-    config: RslibConfig;
-    configFilePath?: string;
-    watchFiles: string[];
-}>;
+export declare function init(options: CommonOptions): Promise<RslibInstance>;

package/dist-types/config.d.ts

@@ -1,23 +1,5 @@
 import { type EnvironmentConfig, type RsbuildEntry } from '@rsbuild/core';
-import type { AutoExternal, BannerAndFooter, Format, LibConfig, PkgJson, RequireKey, RsbuildConfigEntry, RsbuildConfigOutputTarget, RsbuildConfigWithLibInfo, RslibConfig, RslibConfigAsyncFn, RslibConfigExport, RslibConfigSyncFn } from './types';
-/**
- * This function helps you to autocomplete configuration types.
- * It accepts a Rslib config object, or a function that returns a config.
- */
-export declare function defineConfig(config: RslibConfig): RslibConfig;
-export declare function defineConfig(config: RslibConfigSyncFn): RslibConfigSyncFn;
-export declare function defineConfig(config: RslibConfigAsyncFn): RslibConfigAsyncFn;
-export declare function defineConfig(config: RslibConfigExport): RslibConfigExport;
-export type ConfigLoader = 'auto' | 'jiti' | 'native';
-export declare function loadConfig({ cwd, path, envMode, loader, }: {
-    cwd?: string;
-    path?: string;
-    envMode?: string;
-    loader?: ConfigLoader;
-}): Promise<{
-    content: RslibConfig;
-    filePath?: string;
-}>;
+import type { AutoExternal, BannerAndFooter, Format, LibConfig, PkgJson, RequireKey, RsbuildConfigEntry, RsbuildConfigOutputTarget, RsbuildConfigWithLibInfo, RslibConfig } from './types';
 export declare const composeAutoExternalConfig: (options: {
     bundle: boolean;
     format: Format;

package/dist-types/constant.d.ts

@@ -1,5 +1,3 @@
-export declare const DEFAULT_CONFIG_NAME = "rslib.config";
-export declare const DEFAULT_CONFIG_EXTENSIONS: readonly [".js", ".ts", ".mjs", ".mts", ".cjs", ".cts"];
 export declare const SWC_HELPERS = "@swc/helpers";
 export declare const JS_EXTENSIONS_PATTERN: RegExp;
 export declare const CSS_EXTENSIONS_PATTERN: RegExp;

package/dist-types/createRslib.d.ts

@@ -0,0 +1,5 @@
+import type { CreateRslibOptions, RslibInstance } from './types/rslib';
+/**
+ * Create an Rslib instance.
+ */
+export declare function createRslib(options?: CreateRslibOptions): Promise<RslibInstance>;

package/dist-types/index.d.ts

@@ -1,12 +1,13 @@
-export { build } from './cli/build';
-export { runCli } from './cli/commands';
-export { inspect } from './cli/inspect';
-export { startMFDevServer } from './cli/mf';
-export { prepareCli } from './cli/prepare';
-export { composeCreateRsbuildConfig as unstable_composeCreateRsbuildConfig, defineConfig, loadConfig, } from './config';
-export type * from './types';
-export { logger } from './utils/logger';
+/**
+ * The methods and types exported from this file are considered as
+ * the public API of @rslib/core.
+ */
+export { runCLI } from './cli';
+export { createRslib } from './createRslib';
+export { type ConfigParams, defineConfig, type LoadConfigOptions, type LoadConfigResult, type LoadEnvOptions, type LoadEnvResult, loadConfig, loadEnv, } from './loadConfig';
+export { mergeRslibConfig } from './mergeConfig';
+export type { AutoExternal, BannerAndFooter, BuildOptions, BuildResult, CreateRslibOptions, Dts, Format, InspectConfigOptions, InspectConfigResult, LibConfig, LibExperiments, OnAfterCreateRsbuildFn, Redirect, RslibConfig, RslibInstance, Shims, StartMFDevServerOptions, StartServerResult, Syntax, } from './types';
 export declare const version: string;
 export type * as Rsbuild from '@rsbuild/core';
 export * as rsbuild from '@rsbuild/core';
-export { type RsbuildPlugin, type Rspack, rspack } from '@rsbuild/core';
+export { type RsbuildPlugin, type Rspack, rspack, } from '@rsbuild/core';

package/dist-types/loadConfig.d.ts

@@ -0,0 +1,34 @@
+import { type LoadConfigOptions as RsbuildLoadConfigOptions } from '@rsbuild/core';
+import type { RslibConfig } from './types';
+export type ConfigParams = {
+    env: string;
+    command: string;
+    envMode?: string;
+    meta?: Record<string, unknown>;
+};
+export type RslibConfigSyncFn = (env: ConfigParams) => RslibConfig;
+export type RslibConfigAsyncFn = (env: ConfigParams) => Promise<RslibConfig>;
+export type RslibConfigExport = RslibConfig | RslibConfigSyncFn | RslibConfigAsyncFn;
+export type LoadConfigOptions = Pick<RsbuildLoadConfigOptions, 'cwd' | 'path' | 'envMode' | 'meta' | 'loader'>;
+export type ConfigLoader = RsbuildLoadConfigOptions['loader'];
+export type LoadConfigResult = {
+    /**
+     * The loaded configuration object.
+     */
+    content: RslibConfig;
+    /**
+     * The path to the loaded configuration file.
+     * Return `null` if the configuration file is not found.
+     */
+    filePath: string | null;
+};
+/**
+ * This function helps you to autocomplete configuration types.
+ * It accepts a Rslib config object, or a function that returns a config.
+ */
+export declare function defineConfig(config: RslibConfig): RslibConfig;
+export declare function defineConfig(config: RslibConfigSyncFn): RslibConfigSyncFn;
+export declare function defineConfig(config: RslibConfigAsyncFn): RslibConfigAsyncFn;
+export declare function defineConfig(config: RslibConfigExport): RslibConfigExport;
+export declare function loadConfig({ cwd, path, envMode, meta, loader, }: LoadConfigOptions): Promise<LoadConfigResult>;
+export { type LoadEnvOptions, type LoadEnvResult, loadEnv, } from '@rsbuild/core';

package/dist-types/mergeConfig.d.ts

@@ -0,0 +1,15 @@
+import type { RslibConfig } from './types';
+export type RslibConfigWithOptionalLib = Omit<RslibConfig, 'lib'> & {
+    lib?: RslibConfig['lib'];
+};
+/**
+ * Merge multiple Rslib configurations into a single configuration.
+ *
+ * For the `lib` array, items are merged based on their `id` field:
+ * - Items with the same `id` are deep merged together using `mergeRsbuildConfig`
+ * - Items without `id` are appended to the result array
+ * - The order of items with `id` is preserved based on their first occurrence
+ *
+ * Other configuration fields are merged using `mergeRsbuildConfig`.
+ */
+export declare function mergeRslibConfig(...originalConfigs: (RslibConfigWithOptionalLib | undefined)[]): RslibConfigWithOptionalLib;

package/dist-types/restart.d.ts

@@ -0,0 +1,9 @@
+import type { RslibInstance } from './types';
+export declare function getWatchFilesForRestart(rslib: RslibInstance): string[] | undefined;
+export declare function watchFilesForRestart(files: string[] | undefined, restart: () => Promise<void>): Promise<void>;
+type Cleaner = () => Promise<unknown> | unknown;
+/**
+ * Add a cleaner to handle side effects
+ */
+export declare const onBeforeRestart: (cleaner: Cleaner) => void;
+export {};

package/dist-types/types/config.d.ts

@@ -196,7 +196,7 @@ export type Redirect = {
 export type LibExperiments = {
     /**
      * Whether to enable Rspack advanced ESM output.
-     * @defaultValue `false`
+     * @defaultValue `true`
      * @see {@link https://rslib.rs/config/lib/experiments#experimentsadvancedesm}
      */
     advancedEsm?: boolean;
@@ -337,13 +337,12 @@ export interface RslibConfig extends RsbuildConfig {
      * @inheritdoc
      */
     output?: RslibOutputConfig;
+    /**
+     * @private
+     */
+    _privateMeta?: {
+        configFilePath: string;
+        envFilePaths?: string[];
+    };
 }
-export type ConfigParams = {
-    env: string;
-    command: string;
-    envMode?: string;
-};
-export type RslibConfigSyncFn = (env: ConfigParams) => RslibConfig;
-export type RslibConfigAsyncFn = (env: ConfigParams) => Promise<RslibConfig>;
-export type RslibConfigExport = RslibConfig | RslibConfigSyncFn | RslibConfigAsyncFn;
 export {};

package/dist-types/types/index.d.ts

@@ -1,2 +1,3 @@
 export type * from './config';
+export type * from './rslib';
 export type * from './utils';

package/dist-types/types/rslib.d.ts

@@ -0,0 +1,102 @@
+import type { BuildResult, LoadEnvOptions, InspectConfigResult as RsbuildInspectConfigResult, RsbuildInstance, RsbuildMode, StartServerResult } from '@rsbuild/core';
+import type { RslibConfig } from './config';
+export type CommonOptions = {
+    /**
+     * Specify the library id to run the action on.
+     */
+    lib?: string[];
+};
+export type BuildOptions = CommonOptions & {
+    /**
+     * Whether to watch for file changes and rebuild.
+     * @default false
+     */
+    watch?: boolean;
+};
+export type InspectConfigOptions = CommonOptions & {
+    /**
+     * Inspect the config in the specified mode.
+     * Available options: 'development' or 'production'.
+     * @default 'production'
+     */
+    mode?: RsbuildMode;
+    /**
+     * Enables verbose mode to display the complete function
+     * content in the configuration.
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Specify the output path for inspection results.
+     * @default 'output.distPath.root'
+     */
+    outputPath?: string;
+    /**
+     * Whether to write the inspection results to disk.
+     * @default false
+     */
+    writeToDisk?: boolean;
+};
+export type StartMFDevServerOptions = CommonOptions;
+export type { BuildResult, StartServerResult };
+export type InspectConfigResult = {
+    rslibConfig: string;
+} & RsbuildInspectConfigResult;
+export type RslibInstance = {
+    /**
+     * Get the resolved Rslib configuration.
+     */
+    getRslibConfig(): Readonly<RslibConfig>;
+    /**
+     * Register a callback that will be called after creating the internal Rsbuild instance.
+     * You can use this to access or call the properties and methods of the Rsbuild instance.
+     */
+    onAfterCreateRsbuild(callback: OnAfterCreateRsbuildFn): void;
+    /**
+     * Perform a production mode build. This method will generate the outputs
+     * for production and emit them to the output directory.
+     */
+    build(options?: BuildOptions): Promise<BuildResult>;
+    /**
+     * Inspect and debug Rslib configurations and the internal Rsbuild and Rspack configurations of the Rslib project. It provides access to:
+     * - The resolved Rslib configuration
+     * - The resolved Rsbuild configuration
+     * - The environment-specific Rsbuild configurations
+     * - The generated Rspack configurations
+     *
+     * The method serializes these configurations to strings and optionally writes
+     * them to disk for inspection.
+     */
+    inspectConfig(options?: InspectConfigOptions): Promise<InspectConfigResult>;
+    /**
+     * Start the local dev server for the Module Federation format. This method will:
+     *
+     * 1. Start a development server that serves your mf format module.
+     * 2. Watch for file changes and trigger recompilation.
+     */
+    startMFDevServer(options?: StartMFDevServerOptions): Promise<StartServerResult>;
+};
+export type OnAfterCreateRsbuildFn = (params: {
+    /**
+     * The Rsbuild instance.
+     */
+    rsbuild: RsbuildInstance;
+}) => void | Promise<void>;
+export type CreateRslibOptions = {
+    /**
+     * The root path of current project.
+     * @default process.cwd()
+     */
+    cwd?: string;
+    /**
+     * Rslib configurations.
+     * Passing a function to load the config asynchronously with custom logic.
+     */
+    config?: RslibConfig | (() => Promise<RslibConfig>);
+    /**
+     * Whether to call `loadEnv` to load environment variables and define them
+     * as global variables via `source.define`.
+     * @default false
+     */
+    loadEnv?: boolean | LoadEnvOptions;
+};

package/dist-types/utils/helper.d.ts

@@ -6,7 +6,7 @@ import type { Format, LibConfig, PkgJson } from '../types';
  */
 export declare const nodeBuiltInModules: (string | RegExp)[];
 export declare function calcLongestCommonPath(absPaths: string[]): Promise<string | null>;
-export declare function getAbsolutePath(base: string, filepath: string): string;
+export declare function ensureAbsolutePath(base: string, filepath: string): string;
 export declare const readPackageJson: (rootPath: string) => undefined | PkgJson;
 export declare const isObject: (obj: unknown) => obj is Record<string, any>;
 export declare const isEmptyObject: (obj: object) => boolean;
@@ -22,3 +22,6 @@ export declare const isTTY: (type?: "stdin" | "stdout") => boolean;
 export declare const isIntermediateOutputFormat: (format: Format) => boolean;
 export declare function normalizeSlash(p: string): string;
 export declare function isDirectory(filePath: string): Promise<boolean>;
+export declare const isFunction: (func: unknown) => func is (...args: any[]) => any;
+export declare const getNodeEnv: () => string;
+export declare const setNodeEnv: (env: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rslib/core",
-  "version": "0.18.5",
+  "version": "0.19.0",
   "description": "The Rsbuild-based library development tool.",
   "homepage": "https://rslib.rs",
   "bugs": {
@@ -36,21 +36,21 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@rsbuild/core": "~1.7.0-beta.0",
-    "rsbuild-plugin-dts": "0.18.5"
+    "@rsbuild/core": "~1.7.0-beta.2",
+    "rsbuild-plugin-dts": "0.19.0"
   },
   "devDependencies": {
-    "@module-federation/rsbuild-plugin": "^0.21.6",
+    "@module-federation/rsbuild-plugin": "^0.22.0",
     "@types/fs-extra": "^11.0.4",
     "cac": "^6.7.14",
     "chokidar": "^4.0.3",
-    "fs-extra": "^11.3.2",
+    "fs-extra": "^11.3.3",
     "memfs": "^4.51.1",
     "path-serializer": "0.5.1",
     "picocolors": "1.1.1",
     "prebundle": "1.6.0",
     "rsbuild-plugin-publint": "^0.3.3",
-    "rslib": "npm:@rslib/core@0.18.4",
+    "rslib": "npm:@rslib/core@0.18.6",
     "rslog": "^1.3.2",
     "tinyglobby": "0.2.14",
     "tsconfck": "3.1.6",

package/dist-types/cli/build.d.ts

@@ -1,4 +0,0 @@
-import { type RsbuildInstance } from '@rsbuild/core';
-import type { RslibConfig } from '../types/config';
-import type { BuildOptions } from './commands';
-export declare function build(config: RslibConfig, options?: Pick<BuildOptions, 'lib' | 'watch' | 'root'>): Promise<RsbuildInstance>;

package/dist-types/cli/inspect.d.ts

@@ -1,4 +0,0 @@
-import { type RsbuildInstance } from '@rsbuild/core';
-import type { RslibConfig } from '../types/config';
-import type { InspectOptions } from './commands';
-export declare function inspect(config: RslibConfig, options?: Pick<InspectOptions, 'lib' | 'mode' | 'output' | 'verbose'>): Promise<RsbuildInstance>;

package/dist-types/cli/mf.d.ts

@@ -1,4 +0,0 @@
-import type { RsbuildInstance } from '@rsbuild/core';
-import type { RslibConfig } from '../types';
-import type { CommonOptions } from './commands';
-export declare function startMFDevServer(config: RslibConfig, options?: Pick<CommonOptions, 'lib'>): Promise<RsbuildInstance | undefined>;

package/dist-types/cli/prepare.d.ts

@@ -1 +0,0 @@
-export declare function prepareCli(): void;

package/dist-types/cli/restart.d.ts

@@ -1,7 +0,0 @@
-export declare function watchFilesForRestart(files: string[], restart: () => Promise<void>): Promise<void>;
-type Cleaner = () => Promise<unknown> | unknown;
-/**
- * Add a cleaner to handle side effects
- */
-export declare const onBeforeRestart: (cleaner: Cleaner) => void;
-export {};