@lynx-js/externals-loading-webpack-plugin-canary 0.0.2 → 0.0.3-canary-20260126-c691f87a

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lynx-js/externals-loading-webpack-plugin
 
+## 0.0.3-canary-20260126040139-c691f87a04693fedfdd15d2f7841e2b61339112b
+
+### Patch Changes
+
+- Add [`globalObject`](https://webpack.js.org/configuration/output/#outputglobalobject) config for external bundle loading, user can configure it to `globalThis` for BTS external bundle sharing. ([#2123](https://github.com/lynx-family/lynx-stack/pull/2123))
+
 ## 0.0.2
 
 ### Patch Changes
@@ -14,18 +20,18 @@
 
   ```js
   // webpack.config.js
-  import { ExternalsLoadingPlugin } from '@lynx-js/externals-loading-webpack-plugin';
+  import { ExternalsLoadingPlugin } from "@lynx-js/externals-loading-webpack-plugin";
 
   export default {
     plugins: [
       new ExternalsLoadingPlugin({
-        mainThreadLayer: 'main-thread',
-        backgroundLayer: 'background',
+        mainThreadLayer: "main-thread",
+        backgroundLayer: "background",
         externals: {
           lodash: {
-            url: 'http://lodash.lynx.bundle',
-            background: { sectionPath: 'background' },
-            mainThread: { sectionPath: 'main-thread' },
+            url: "http://lodash.lynx.bundle",
+            background: { sectionPath: "background" },
+            mainThread: { sectionPath: "main-thread" },
           },
         },
       }),

package/lib/index.d.ts

@@ -64,6 +64,16 @@ export interface ExternalsLoadingPluginOptions {
      * ```
      */
     externals: Record<string, ExternalValue>;
+    /**
+     * This option indicates what global object will be used to mount the library.
+     *
+     * In Lynx, the library will be mounted to `lynx[Symbol.for("__LYNX_EXTERNAL_GLOBAL__")]` by default.
+     *
+     * If you have enabled share js context and want to reuse the library by mounting to the global object, you can set this option to `'globalThis'`.
+     *
+     * @default 'lynx'
+     */
+    globalObject?: 'lynx' | 'globalThis' | undefined;
 }
 /**
  * The value item of the externals.

package/lib/index.js

@@ -1,8 +1,8 @@
 // Copyright 2025 The Lynx Authors. All rights reserved.
 // Licensed under the Apache License Version 2.0 that can be found in the
 // LICENSE file in the root directory of this source tree.
-function getLynxExternalGlobal() {
-    return `lynx[Symbol.for('__LYNX_EXTERNAL_GLOBAL__')]`;
+function getLynxExternalGlobal(globalObject) {
+    return `${globalObject ?? 'lynx'}[Symbol.for('__LYNX_EXTERNAL_GLOBAL__')]`;
 }
 /**
  * The webpack plugin to load lynx external bundles.
@@ -80,7 +80,8 @@ export class ExternalsLoadingPlugin {
                 if (externals.length === 0) {
                     return '';
                 }
-                const runtimeGlobalsInit = `${getLynxExternalGlobal()} = {};`;
+                const lynxExternalGlobal = getLynxExternalGlobal(externalsLoadingPluginOptions.globalObject);
+                const runtimeGlobalsInit = `${lynxExternalGlobal} = ${lynxExternalGlobal} === undefined ? {} : ${lynxExternalGlobal};`;
                 const loadExternalFunc = `
 function createLoadExternalAsync(handler, sectionPath) {
   return new Promise((resolve, reject) => {
@@ -132,11 +133,12 @@ function createLoadExternalSync(handler, sectionPath, timeout) {
                     }
                     hasUrlLibraryNamePairInjected.add(hash);
                     fetchCode.push(`const handler${i} = lynx.fetchBundle(${JSON.stringify(url)}, {});`);
+                    const mountVar = `${getLynxExternalGlobal(externalsLoadingPluginOptions.globalObject)}[${JSON.stringify(libraryNameStr)}]`;
                     if (async) {
-                        loadCode.push(`${getLynxExternalGlobal()}[${JSON.stringify(libraryNameStr)}] = createLoadExternalAsync(handler${i}, ${JSON.stringify(layerOptions.sectionPath)});`);
+                        loadCode.push(`${mountVar} = ${mountVar} === undefined ? createLoadExternalAsync(handler${i}, ${JSON.stringify(layerOptions.sectionPath)}) : ${mountVar};`);
                         continue;
                     }
-                    loadCode.push(`${getLynxExternalGlobal()}[${JSON.stringify(libraryNameStr)}] = createLoadExternalSync(handler${i}, ${JSON.stringify(layerOptions.sectionPath)}, ${timeout});`);
+                    loadCode.push(`${mountVar} = ${mountVar} === undefined ? createLoadExternalSync(handler${i}, ${JSON.stringify(layerOptions.sectionPath)}, ${timeout}) : ${mountVar};`);
                 }
                 return [
                     runtimeGlobalsInit,
@@ -153,7 +155,7 @@ function createLoadExternalSync(handler, sectionPath, timeout) {
                     : (typeof compiler.options.externals === 'undefined'
                         ? []
                         : [compiler.options.externals])),
-                this.#genExternalsConfig(),
+                this.#genExternalsConfig(externalsLoadingPluginOptions.globalObject),
             ];
         });
         compiler.hooks.compilation.tap(ExternalsLoadingRuntimeModule.name, compilation => {
@@ -178,7 +180,7 @@ function createLoadExternalSync(handler, sectionPath, timeout) {
     /**
      * If the external is async, use `promise` external type; otherwise, use `var` external type.
      */
-    #genExternalsConfig() {
+    #genExternalsConfig(globalObject) {
         const { externals, backgroundLayer, mainThreadLayer } = this.options;
         const externalDeps = new Set(Object.keys(externals));
         return ({ request, contextInfo }, callback) => {
@@ -194,7 +196,7 @@ function createLoadExternalSync(handler, sectionPath, timeout) {
                 const isAsync = externals[request]?.async ?? true;
                 const libraryName = externals[request]?.libraryName ?? request;
                 return callback(undefined, [
-                    getLynxExternalGlobal(),
+                    getLynxExternalGlobal(globalObject),
                     ...(Array.isArray(libraryName) ? libraryName : [libraryName]),
                 ], isAsync ? 'promise' : undefined);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/externals-loading-webpack-plugin-canary",
-  "version": "0.0.2",
+  "version": "0.0.3-canary-20260126-c691f87a",
   "description": "A webpack plugin to load lynx external bundles.",
   "keywords": [
     "webpack",
@@ -32,7 +32,7 @@
     "README.md"
   ],
   "devDependencies": {
-    "@rspack/core": "1.6.6",
+    "@rspack/core": "1.7.3",
     "foo": "./test/foo",
     "@lynx-js/test-tools": "0.0.0"
   },