feat: support umdName of array and object type (#1020)

Author: Timeless0911

packages/core/src/config.ts

@@ -565,7 +565,7 @@ const composeFormatConfig = ({
   format: Format;
   pkgJson: PkgJson;
   bundle?: boolean;
-  umdName?: string;
+  umdName?: Rspack.LibraryName;
 }): EnvironmentConfig => {
   const jsParserOptions = {
     cjs: {

packages/core/src/types/config.ts

@@ -297,7 +297,7 @@ export interface LibConfig extends EnvironmentConfig {
    * @defaultValue `undefined`
    * @see {@link https://lib.rsbuild.dev/config/lib/umd-name}
    */
-  umdName?: string;
+  umdName?: Rspack.LibraryName;
   /**
    * The base directory of the output files.
    * @defaultValue `undefined`

tests/integration/umd-library-name/index.test.ts

@@ -13,12 +13,21 @@ test('correct read UMD name from CommonJS', async () => {
       version: '1.2.3',
     },
   };
-  const context = vm.createContext({
+  let context = vm.createContext({
     globalThis: mockGlobalThis,
   });
 
-  vm.runInContext(entries.umd, context);
+  vm.runInContext(entries.umd0!, context);
 
   // @ts-expect-error
   expect(await mockGlobalThis.MyLibrary.fn('ok')).toBe('DEBUG:1.2.3/ok');
+
+  context = vm.createContext({
+    globalThis: mockGlobalThis,
+  });
+
+  vm.runInContext(entries.umd1!, context);
+
+  // @ts-expect-error
+  expect(await mockGlobalThis.MyLibrary.Utils.fn('ok')).toBe('DEBUG:1.2.3/ok');
 });

tests/integration/umd-library-name/rslib.config.ts

@@ -5,6 +5,19 @@ export default defineConfig({
   lib: [
     generateBundleUmdConfig({
       umdName: 'MyLibrary',
+      output: {
+        distPath: {
+          root: './dist/string',
+        },
+      },
+    }),
+    generateBundleUmdConfig({
+      umdName: ['MyLibrary', 'Utils'],
+      output: {
+        distPath: {
+          root: './dist/array',
+        },
+      },
     }),
   ],
   source: {

website/docs/en/config/lib/index.mdx

@@ -15,7 +15,7 @@ interface LibConfig extends EnvironmentConfig {
   footer?: BannerAndFooter;
   shims?: Shims;
   dts?: Dts;
-  umdName?: string;
+  umdName?: Rspack.LibraryName;
 }
 
 interface RslibConfig extends RsbuildConfig {

website/docs/en/config/lib/umd-name.mdx

@@ -1,6 +1,6 @@
 # lib.umdName
 
-- **Type:** `string`
+- **Type:** `string | string[] | { amd?: string, commonjs?: string, root?: string | string[] }`
 - **Default:** `undefined`
 
 The export name of the [UMD](/guide/basic/output-format#umd) bundle.
@@ -13,7 +13,7 @@ The module name of the UMD bundle must not conflict with the global variable nam
 
 ## Example
 
-The UMD bundle will be mounted to `global.MyLibrary`.
+- Mount the UMD bundle to `global.MyLibrary`.
 
 ```ts title="rslib.config.ts"
 export default {
@@ -25,3 +25,16 @@ export default {
   ],
 };
 ```
+
+- Mount the UMD bundle to `global.MyLibrary.Utils`.
+
+```ts title="rslib.config.ts"
+export default {
+  lib: [
+    {
+      format: 'umd',
+      umdName: ['MyLibrary', 'Utils'], // [!code highlight]
+    },
+  ],
+};
+```

website/docs/zh/config/lib/index.mdx

@@ -15,7 +15,7 @@ interface LibConfig extends EnvironmentConfig {
   footer?: BannerAndFooter;
   shims?: Shims;
   dts?: Dts;
-  umdName?: string;
+  umdName?: Rspack.LibraryName;
 }
 
 interface RslibConfig extends RsbuildConfig {

website/docs/zh/config/lib/umd-name.mdx

@@ -1,6 +1,6 @@
 # lib.umdName
 
-- **类型：** `string`
+- **类型：** `string | string[] | { amd?: string, commonjs?: string, root?: string | string[] }`
 - **默认值：** `undefined`
 
 [UMD](/guide/basic/output-format#umd) 包的导出名称。
@@ -13,7 +13,7 @@ UMD 包的模块名称不能与全局变量名称冲突。
 
 ## 示例
 
-UMD 包将会挂载到 `global.MyLibrary`。
+- 将 UMD 包挂载到 `global.MyLibrary`。
 
 ```ts title="rslib.config.ts"
 export default {
@@ -25,3 +25,16 @@ export default {
   ],
 };
 ```
+
+- 将 UMD 包挂载到 `global.MyLibrary.Utils`。
+
+```ts title="rslib.config.ts"
+export default {
+  lib: [
+    {
+      format: 'umd',
+      umdName: ['MyLibrary', 'Utils'], // [!code highlight]
+    },
+  ],
+};
+```