@lynx-js/runtime-wrapper-webpack-plugin 0.0.9 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @lynx-js/runtime-wrapper-webpack-plugin
 
+## 0.1.0
+
+### Minor Changes
+
+- Add parameter forwarding for Browser Object Model (BOM) APIs. ([#787](https://github.com/lynx-family/lynx-stack/pull/787))
+
+  This allows direct access to APIs like `fetch`, `requestAnimationFrame`.
+
+## 0.0.10
+
+### Patch Changes
+
+- feat: add `experimental_isLazyBundle` option, it will disable lynxChunkEntries for standalone lazy bundle ([#653](https://github.com/lynx-family/lynx-stack/pull/653))
+
 ## 0.0.9
 
 ### Patch Changes

package/lib/RuntimeWrapperWebpackPlugin.d.ts

@@ -6,7 +6,7 @@ import type { BannerPlugin, Compiler } from 'webpack';
  */
 interface RuntimeWrapperWebpackPluginOptions {
     /**
-     * {@inheritdoc @lynx-js/template-webpack-plugin#LynxTemplatePluginOptions.targetSdkVersion}
+     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.targetSdkVersion}
      */
     targetSdkVersion: string;
     /**
@@ -29,6 +29,10 @@ interface RuntimeWrapperWebpackPluginOptions {
      * The variables to be injected into the chunk.
      */
     injectVars?: ((vars: string[]) => string[]) | string[];
+    /**
+     * {@inheritdoc @lynx-js/react-rsbuild-plugin#PluginReactLynxOptions.experimental_isLazyBundle}
+     */
+    experimental_isLazyBundle?: boolean;
 }
 /**
  * RuntimeWrapperWebpackPlugin adds runtime wrappers to JavaScript and allow to be loaded by Lynx.

package/lib/RuntimeWrapperWebpackPlugin.js

@@ -17,7 +17,31 @@ const defaultInjectVars = [
     'Behavior',
     'LynxJSBI',
     'lynx',
+    // BOM API
     'window',
+    'document',
+    'frames',
+    'self',
+    'location',
+    'navigator',
+    'localStorage',
+    'history',
+    'Caches',
+    'screen',
+    'alert',
+    'confirm',
+    'prompt',
+    'fetch',
+    'XMLHttpRequest',
+    '__WebSocket__', // We would provide `WebSocket` using `ProvidePlugin`
+    'webkit',
+    'Reporter',
+    'print',
+    '__Function__', // We should allow using `Function`
+    'global',
+    // Lynx API
+    'requestAnimationFrame',
+    'cancelAnimationFrame',
 ];
 /**
  * RuntimeWrapperWebpackPlugin adds runtime wrappers to JavaScript and allow to be loaded by Lynx.
@@ -39,6 +63,7 @@ class RuntimeWrapperWebpackPlugin {
         test: /\.js$/,
         bannerType: () => 'script',
         injectVars: defaultInjectVars,
+        experimental_isLazyBundle: false,
     });
     /**
      * The entry point of a webpack plugin.
@@ -57,7 +82,7 @@ class RuntimeWrapperWebpackPluginImpl {
     constructor(compiler, options) {
         this.compiler = compiler;
         this.options = options;
-        const { targetSdkVersion, test } = options;
+        const { targetSdkVersion, test, experimental_isLazyBundle } = options;
         const { BannerPlugin } = compiler.webpack;
         const isDev = process.env['NODE_ENV'] === 'development'
             || compiler.options.mode === 'development';
@@ -81,7 +106,12 @@ class RuntimeWrapperWebpackPluginImpl {
                         moduleId: '[name].js',
                         targetSdkVersion,
                     })
-                    + (isDev
+                    // In standalone lazy bundle mode, the lazy bundle will
+                    // also has chunk.id "main", it will be conflict with the
+                    // consumer project.
+                    // We disable it for standalone lazy bundle since we do not
+                    // support HMR for standalone lazy bundle now.
+                    + (isDev && !experimental_isLazyBundle
                         ? lynxChunkEntries(JSON.stringify(chunk.id))
                         : '');
             },
@@ -150,7 +180,9 @@ const amdBanner = ({ injectStr, moduleId, overrideRuntimePromise, targetSdkVersi
 lynx = lynx || {};
 lynx.targetSdkVersion=lynx.targetSdkVersion||${JSON.stringify(targetSdkVersion)};
 ${overrideRuntimePromise ? `var Promise = lynx.Promise;` : ''}
-var fetch = lynx.fetch;
+fetch = fetch || lynx.fetch;
+requestAnimationFrame = requestAnimationFrame || lynx.requestAnimationFrame;
+cancelAnimationFrame = cancelAnimationFrame || lynx.cancelAnimationFrame;
 `);
 };
 const amdFooter = (moduleId) => `

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/runtime-wrapper-webpack-plugin",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "Use runtime wrapper which allow JavaScript to be load by Lynx.",
   "keywords": [
     "webpack",
@@ -35,8 +35,8 @@
     "@lynx-js/webpack-runtime-globals": "0.0.5"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "7.51.1",
-    "webpack": "^5.98.0",
+    "@microsoft/api-extractor": "7.52.8",
+    "webpack": "^5.99.8",
     "@lynx-js/test-tools": "0.0.0"
   },
   "engines": {