@lynx-js/lynx-bundle-rslib-config-canary 0.0.1 → 0.0.2-canary-20251222-4d689a71

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @lynx-js/lynx-bundle-rslib-config
 
+## 0.0.2-canary-20251222035207-4d689a7194cc9b431e6055e87792c1961a44af4d
+
+### Patch Changes
+
+- Introduce `@lynx-js/externals-loading-webpack-plugin`. It will help you to load externals built by `@lynx-js/lynx-bundle-rslib-config`. ([#1924](https://github.com/lynx-family/lynx-stack/pull/1924))
+
+  ```js
+  // webpack.config.js
+  import { ExternalsLoadingPlugin } from "@lynx-js/externals-loading-webpack-plugin";
+
+  export default {
+    plugins: [
+      new ExternalsLoadingPlugin({
+        mainThreadLayer: "main-thread",
+        backgroundLayer: "background",
+        externals: {
+          lodash: {
+            url: "http://lodash.lynx.bundle",
+            background: { sectionPath: "background" },
+            mainThread: { sectionPath: "main-thread" },
+          },
+        },
+      }),
+    ],
+  };
+  ```
+
 ## 0.0.1
 
 ### Patch Changes
@@ -8,14 +35,14 @@
 
   ```js
   // rslib.config.js
-  import { defineExternalBundleRslibConfig } from '@lynx-js/lynx-bundle-rslib-config'
+  import { defineExternalBundleRslibConfig } from "@lynx-js/lynx-bundle-rslib-config";
 
   export default defineExternalBundleRslibConfig({
-    id: 'utils-lib',
+    id: "utils-lib",
     source: {
       entry: {
-        utils: './src/utils.ts',
+        utils: "./src/utils.ts",
       },
     },
-  })
+  });
   ```

package/lib/externalBundleRslibConfig.d.ts

@@ -27,6 +27,14 @@ export declare const LAYERS: {
  * @public
  */
 export declare const defaultExternalBundleLibConfig: LibConfig;
+export type Externals = Record<string, string | string[]>;
+export type LibOutputConfig = Required<LibConfig>['output'];
+export interface OutputConfig extends LibOutputConfig {
+    externals?: Externals;
+}
+export interface ExternalBundleLibConfig extends LibConfig {
+    output?: OutputConfig;
+}
 /**
  * Get the rslib config for building Lynx external bundles.
  *
@@ -97,4 +105,4 @@ export declare const defaultExternalBundleLibConfig: LibConfig;
  *
  * Then you can use `lynx.loadScript('utils', { bundleName: 'utils-lib-bundle-url' })` in background thread and `lynx.loadScript('utils__main-thread', { bundleName: 'utils-lib-bundle-url' })` in main-thread.
  */
-export declare function defineExternalBundleRslibConfig(userLibConfig: LibConfig, encodeOptions?: EncodeOptions): RslibConfig;
+export declare function defineExternalBundleRslibConfig(userLibConfig: ExternalBundleLibConfig, encodeOptions?: EncodeOptions): RslibConfig;

package/lib/externalBundleRslibConfig.js

@@ -54,6 +54,21 @@ export const defaultExternalBundleLibConfig = {
         include: [/node_modules/],
     },
 };
+function transformExternals(externals) {
+    if (!externals)
+        return {};
+    return function ({ request }, callback) {
+        if (!request)
+            return callback();
+        const libraryName = externals[request];
+        if (!libraryName)
+            return callback();
+        callback(undefined, [
+            'lynx[Symbol.for("__LYNX_EXTERNAL_GLOBAL__")]',
+            ...(Array.isArray(libraryName) ? libraryName : [libraryName]),
+        ], 'var');
+    };
+}
 /**
  * Get the rslib config for building Lynx external bundles.
  *
@@ -128,7 +143,13 @@ export function defineExternalBundleRslibConfig(userLibConfig, encodeOptions = {
     return {
         lib: [
             // eslint-disable-next-line import/namespace
-            rsbuild.mergeRsbuildConfig(defaultExternalBundleLibConfig, userLibConfig),
+            rsbuild.mergeRsbuildConfig(defaultExternalBundleLibConfig, {
+                ...userLibConfig,
+                output: {
+                    ...userLibConfig.output,
+                    externals: transformExternals(userLibConfig.output?.externals),
+                },
+            }),
         ],
         plugins: [
             externalBundleEntryRsbuildPlugin(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/lynx-bundle-rslib-config-canary",
-  "version": "0.0.1",
+  "version": "0.0.2-canary-20251222-4d689a71",
   "description": "The rsbuild config for building Lynx bundle",
   "keywords": [
     "Rsbuild",