@lynx-js/lynx-bundle-rslib-config-canary 0.0.2 → 0.1.0-canary-20251225-491c5efa

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lynx-js/lynx-bundle-rslib-config
 
+## 0.1.0-canary-20251225015612-491c5efac23e3c99914fb9270d0476aa5c0207f9
+
+### Minor Changes
+
+- Update external bundle minimum SDK version to 3.5. ([#2037](https://github.com/lynx-family/lynx-stack/pull/2037))
+
 ## 0.0.2
 
 ### Patch Changes
@@ -8,23 +14,23 @@
 
   ```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" },
           },
         },
       }),
     ],
-  }
+  };
   ```
 
 ## 0.0.1
@@ -35,14 +41,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

@@ -6,11 +6,11 @@ import type { LibConfig, RslibConfig } from '@rslib/core';
  */
 export interface EncodeOptions {
     /**
-     * The target SDK version of the external bundle.
+     * The engine version of the external bundle.
      *
-     * @defaultValue '3.4'
+     * @defaultValue '3.5'
      */
-    targetSdkVersion?: string;
+    engineVersion?: string;
 }
 /**
  * The Layer name of background and main-thread.

package/lib/externalBundleRslibConfig.js

@@ -153,7 +153,7 @@ export function defineExternalBundleRslibConfig(userLibConfig, encodeOptions = {
         ],
         plugins: [
             externalBundleEntryRsbuildPlugin(),
-            externalBundleRsbuildPlugin(encodeOptions.targetSdkVersion),
+            externalBundleRsbuildPlugin(encodeOptions.engineVersion),
         ],
     };
 }
@@ -237,7 +237,7 @@ const externalBundleEntryRsbuildPlugin = () => ({
         });
     },
 });
-const externalBundleRsbuildPlugin = (targetSdkVersion) => ({
+const externalBundleRsbuildPlugin = (engineVersion) => ({
     name: 'lynx:gen-external-bundle',
     async setup(api) {
         const { getEncodeMode } = await import('@lynx-js/tasm');
@@ -249,7 +249,7 @@ const externalBundleRsbuildPlugin = (targetSdkVersion) => ({
                 {
                     bundleFileName: `${libName}.lynx.bundle`,
                     encode: getEncodeMode(),
-                    targetSdkVersion,
+                    engineVersion,
                 },
             ])
                 .end();

package/lib/index.d.ts

@@ -2,44 +2,6 @@
  * @packageDocumentation
  *
  * `@lynx-js/lynx-bundle-rslib-config` is the package that provides the configurations for bundling Lynx bundle with {@link https://rslib.rs/ | Rslib}.
- *
- * 1. Install the package:
- *
- * ```bash
- * pnpm add @lynx-js/lynx-bundle-rslib-config @rslib/core -D
- * ```
- *
- * 2. Add the following code to `rslib.config.ts`:
- *
- * ```ts
- * import { defineExternalBundleRslibConfig } from '@lynx-js/lynx-bundle-rslib-config'
- *
- * export default defineExternalBundleRslibConfig({
- *   id: 'my-utils',
- *   source: {
- *     entry: {
- *       utils: './src/utils.ts'
- *     }
- *   }
- * })
- * ```
- *
- * 3. Run the command `pnpm rslib build` and you will get the `my-utils.lynx.bundle` in the `dist` directory. You can upload the bundle to CDN or server.
- *
- * 4. Finally, you can fetch and load the external bundle through:
- *
- * ```js
- * const bundleUrl = 'http://cdn.com/my-utils.lynx.bundle'
- * lynx.fetchBundle(bundleUrl).wait(3) // timeout is 3s
- *
- * if (__BACKGROUND__) {
- *   const utils = lynx.loadScript('utils', { bundleName: bundleUrl })
- * } else {
- *   const utils = lynx.loadScript('utils__main-thread', { bundleName: bundleUrl })
- * }
- * ```
- *
- * For more detail, please refer to the {@link defineExternalBundleRslibConfig}.
  */
 export { defineExternalBundleRslibConfig, defaultExternalBundleLibConfig, LAYERS, } from './externalBundleRslibConfig.js';
 export type { EncodeOptions } from './externalBundleRslibConfig.js';

package/lib/index.js

@@ -5,44 +5,6 @@
  * @packageDocumentation
  *
  * `@lynx-js/lynx-bundle-rslib-config` is the package that provides the configurations for bundling Lynx bundle with {@link https://rslib.rs/ | Rslib}.
- *
- * 1. Install the package:
- *
- * ```bash
- * pnpm add @lynx-js/lynx-bundle-rslib-config @rslib/core -D
- * ```
- *
- * 2. Add the following code to `rslib.config.ts`:
- *
- * ```ts
- * import { defineExternalBundleRslibConfig } from '@lynx-js/lynx-bundle-rslib-config'
- *
- * export default defineExternalBundleRslibConfig({
- *   id: 'my-utils',
- *   source: {
- *     entry: {
- *       utils: './src/utils.ts'
- *     }
- *   }
- * })
- * ```
- *
- * 3. Run the command `pnpm rslib build` and you will get the `my-utils.lynx.bundle` in the `dist` directory. You can upload the bundle to CDN or server.
- *
- * 4. Finally, you can fetch and load the external bundle through:
- *
- * ```js
- * const bundleUrl = 'http://cdn.com/my-utils.lynx.bundle'
- * lynx.fetchBundle(bundleUrl).wait(3) // timeout is 3s
- *
- * if (__BACKGROUND__) {
- *   const utils = lynx.loadScript('utils', { bundleName: bundleUrl })
- * } else {
- *   const utils = lynx.loadScript('utils__main-thread', { bundleName: bundleUrl })
- * }
- * ```
- *
- * For more detail, please refer to the {@link defineExternalBundleRslibConfig}.
  */
 export { defineExternalBundleRslibConfig, defaultExternalBundleLibConfig, LAYERS, } from './externalBundleRslibConfig.js';
 export { ExternalBundleWebpackPlugin } from './webpack/ExternalBundleWebpackPlugin.js';

package/lib/webpack/ExternalBundleWebpackPlugin.d.ts

@@ -32,11 +32,11 @@ export interface ExternalBundleWebpackPluginOptions {
         buffer: Buffer;
     }>;
     /**
-     * The target SDK version of the external bundle.
+     * The engine version of the external bundle.
      *
-     * @defaultValue '3.4'
+     * @defaultValue '3.5'
      */
-    targetSdkVersion?: string | undefined;
+    engineVersion?: string | undefined;
 }
 /**
  * The webpack plugin to build and emit the external bundle.

package/lib/webpack/ExternalBundleWebpackPlugin.js

@@ -56,8 +56,8 @@ export class ExternalBundleWebpackPlugin {
         }), {});
         const compilerOptions = {
             enableFiberArch: true,
-            // lynx.fetchBundle requires targetSdkVersion >= 3.4
-            targetSdkVersion: this.options.targetSdkVersion ?? '3.4',
+            // `lynx.fetchBundle` and `lynx.loadScript` require engineVersion >= 3.5
+            targetSdkVersion: this.options.engineVersion ?? '3.5',
         };
         const encodeOptions = {
             compilerOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/lynx-bundle-rslib-config-canary",
-  "version": "0.0.2",
+  "version": "0.1.0-canary-20251225-491c5efa",
   "description": "The rsbuild config for building Lynx bundle",
   "keywords": [
     "Rsbuild",