@lynx-js/web-worker-runtime 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,122 @@
 # @lynx-js/web-worker-runtime
 
+## 0.8.0
+
+### Minor Changes
+
+- refactor: remove web-elements/lazy and loadNewTag ([#123](https://github.com/lynx-family/lynx-stack/pull/123))
+
+  - remove @lynx-js/web-elements/lazy
+  - remove loadElement
+  - remove loadNewTag callback
+
+  **This is a breaking change**
+
+  Now we removed the default lazy loading preinstalled in web-core
+
+  Please add the following statement in your web project
+
+  ```
+  import "@lynx-js/web-elements/all";
+  ```
+
+### Patch Changes
+
+- feat: add pixelRatio of SystemInfo, now you can use `SystemInfo.pixelRatio`. ([#150](https://github.com/lynx-family/lynx-stack/pull/150))
+
+- feat: add two prop of lynx-view about `napiLoader`: ([#173](https://github.com/lynx-family/lynx-stack/pull/173))
+
+  - `napiModulesMap`: [optional] the napiModule which is called in lynx-core. key is module-name, value is esm url.
+
+  - `onNapiModulesCall`: [optional] the NapiModule value handler.
+
+  **Warning:** This is the internal implementation of `@lynx-js/lynx-core`. In most cases, this API is not required for projects.
+
+  1. The `napiModulesMap` value should be a esm url which export default a function with two parameters:
+
+  - `NapiModules`: oriented `napiModulesMap`, which you can use to call other Napi-Modules
+
+  - `NapiModulesCall`: trigger `onNapiModulesCall`
+
+  example:
+
+  ```js
+  const color_environment = URL.createObjectURL(
+    new Blob(
+      [
+        `export default function(NapiModules, NapiModulesCall) {
+    return {
+      getColor() {
+        NapiModules.color_methods.getColor({ color: 'green' }, color => {
+          console.log(color);
+        });
+      },
+      ColorEngine: class ColorEngine {
+        getColor(name) {
+          NapiModules.color_methods.getColor({ color: 'green' }, color => {
+            console.log(color);
+          });
+        }
+      },
+    };
+  };`,
+      ],
+      { type: 'text/javascript' },
+    ),
+  );
+
+  const color_methods = URL.createObjectURL(
+    new Blob(
+      [
+        `export default function(NapiModules, NapiModulesCall) {
+    return {
+      async getColor(data, callback) {
+        const color = await NapiModulesCall('getColor', data);
+        callback(color);
+      },
+    };
+  };`,
+      ],
+      { type: 'text/javascript' },
+    ),
+  );
+
+  lynxView.napiModuleMap = {
+    color_environment: color_environment,
+    color_methods: color_methods,
+  };
+  ```
+
+  2. The `onNapiModulesCall` function has three parameters:
+
+  - `name`: the first parameter of `NapiModulesCall`, the function name
+  - `data`: the second parameter of `NapiModulesCall`, data
+  - `moduleName`: the module-name of the called napi-module
+
+  ```js
+  lynxView.onNapiModulesCall = (name, data, moduleName) => {
+    if (name === 'getColor' && moduleName === 'color_methods') {
+      return data.color;
+    }
+  };
+  ```
+
+- Updated dependencies [[`e9e8370`](https://github.com/lynx-family/lynx-stack/commit/e9e8370e070a50cbf65a4ebc46c2e37ea1e0be40), [`ec4e1ce`](https://github.com/lynx-family/lynx-stack/commit/ec4e1ce0d7612d6c0701792a46c78cd52130bad4), [`f0a717c`](https://github.com/lynx-family/lynx-stack/commit/f0a717c630700e16ab0af7f1fe370fd60ac75b30), [`63fab7b`](https://github.com/lynx-family/lynx-stack/commit/63fab7b515b7456750b5f7e06844f244a20ca4f1)]:
+  - @lynx-js/web-mainthread-apis@0.8.0
+  - @lynx-js/web-constants@0.8.0
+  - @lynx-js/web-worker-rpc@0.8.0
+
+## 0.7.1
+
+### Patch Changes
+
+- Support NPM provenance. ([#30](https://github.com/lynx-family/lynx-stack/pull/30))
+
+- Updated dependencies [[`c617453`](https://github.com/lynx-family/lynx-stack/commit/c617453aea967aba702967deb2916b5c883f03bb), [`2044571`](https://github.com/lynx-family/lynx-stack/commit/204457166531dae6e9f653db56b14187553b7666), [`82285ce`](https://github.com/lynx-family/lynx-stack/commit/82285cefbc87a5b9b9f5b79b082b5030d1a7b772), [`7da7601`](https://github.com/lynx-family/lynx-stack/commit/7da7601f00407970c485046ad73eeb8534aaa4f6)]:
+  - @lynx-js/web-mainthread-apis@0.7.1
+  - @lynx-js/web-worker-rpc@0.7.1
+  - @lynx-js/web-constants@0.7.1
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/backgroundThread/background-apis/createNapiLoader.d.ts

@@ -0,0 +1,5 @@
+import { type NapiModulesMap } from '@lynx-js/web-constants';
+import type { Rpc } from '@lynx-js/web-worker-rpc';
+export declare const createNapiLoader: (rpc: Rpc, napiModulesMap: NapiModulesMap) => Promise<{
+    load(moduleName: string): Record<string, any> | undefined;
+}>;

package/dist/backgroundThread/background-apis/createNapiLoader.js

@@ -0,0 +1,15 @@
+// Copyright 2023 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.
+import { napiModulesCallEndpoint, } from '@lynx-js/web-constants';
+export const createNapiLoader = async (rpc, napiModulesMap) => {
+    const napiModulesCall = rpc.createCall(napiModulesCallEndpoint);
+    let napiModules = {};
+    await Promise.all(Object.entries(napiModulesMap).map(([moduleName, moduleStr]) => import(/* webpackIgnore: true */ moduleStr).then(module => napiModules[moduleName] = module?.default?.(napiModules, (name, data) => napiModulesCall(name, data, moduleName)))));
+    return {
+        load(moduleName) {
+            return napiModules[moduleName];
+        },
+    };
+};
+//# sourceMappingURL=createNapiLoader.js.map

package/dist/backgroundThread/background-apis/startBackgroundThread.js

@@ -7,6 +7,7 @@ import { createNativeApp } from './createNativeApp.js';
 import { registerDisposeHandler } from './crossThreadHandlers/registerDisposeHandler.js';
 import { createMarkTimingInternal } from './crossThreadHandlers/createBackgroundMarkTimingInternal.js';
 import { BackgroundThreadStartEndpoint } from '@lynx-js/web-constants';
+import { createNapiLoader } from './createNapiLoader.js';
 const lynxCore = import(
 /* webpackMode: "eager" */ '@lynx-js/lynx-core/web');
 export function startBackgroundThread(uiThreadPort, mainThreadPort) {
@@ -27,6 +28,8 @@ export function startBackgroundThread(uiThreadPort, mainThreadPort) {
             markTimingInternal,
             customNativeModules,
         });
+        globalThis['napiLoaderOnRT' + nativeApp.id] =
+            await createNapiLoader(uiThreadRpc, config.napiModulesMap);
         const nativeLynx = createBackgroundLynx(config, nativeApp, mainThreadRpc);
         lynxCore.then(({ loadCard, destroyCard, callDestroyLifetimeFun }) => {
             loadCard(nativeApp, config, nativeLynx);

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export interface WorkerStartMessage {
     mode: 'main' | 'background';
     toPeerThread: MessagePort;
     toUIThread: MessagePort;
+    pixelRatio: number;
 }

package/dist/index.js

@@ -4,7 +4,9 @@
 import { startBackgroundThread } from './backgroundThread/index.js';
 import { startMainThread } from './mainThread/startMainThread.js';
 self.onmessage = (ev) => {
-    const { mode, toPeerThread, toUIThread } = ev.data;
+    const { mode, toPeerThread, toUIThread, pixelRatio } = ev
+        .data;
+    globalThis.SystemInfo.pixelRatio = pixelRatio;
     if (mode === 'main') {
         startMainThread(toUIThread, toPeerThread);
     }

package/dist/mainThread/startMainThread.js

@@ -1,7 +1,7 @@
 // Copyright 2023 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.
-import { BackgroundThreadStartEndpoint, mainThreadChunkReadyEndpoint, mainThreadStartEndpoint, onLifecycleEventEndpoint, loadNewTagEndpoint, flushElementTreeEndpoint, } from '@lynx-js/web-constants';
+import { BackgroundThreadStartEndpoint, mainThreadChunkReadyEndpoint, mainThreadStartEndpoint, onLifecycleEventEndpoint, flushElementTreeEndpoint, } from '@lynx-js/web-constants';
 import { Rpc } from '@lynx-js/web-worker-rpc';
 import { MainThreadRuntime } from '@lynx-js/web-mainthread-apis';
 import { registerCallLepusMethodHandler } from './crossThreadHandlers/registerCallLepusMethodHandler.js';
@@ -16,11 +16,10 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
     const backgroundStart = backgroundThreadRpc.createCall(BackgroundThreadStartEndpoint);
     const __OnLifecycleEvent = backgroundThreadRpc.createCall(onLifecycleEventEndpoint);
     const mainThreadChunkReady = uiThreadRpc.createCall(mainThreadChunkReadyEndpoint);
-    const onNewTag = uiThreadRpc.createCall(loadNewTagEndpoint);
     const flushElementTree = uiThreadRpc.createCall(flushElementTreeEndpoint);
     markTimingInternal('lepus_excute_start');
     uiThreadRpc.registerHandler(mainThreadStartEndpoint, async (config) => {
-        const { globalProps, template, entryId, browserConfig, nativeModulesUrl, } = config;
+        const { globalProps, template, entryId, browserConfig, nativeModulesUrl, napiModulesMap, } = config;
         const { styleInfo, pageConfig, customSections, cardType, lepusCode } = template;
         markTimingInternal('decode_start');
         await import(
@@ -53,11 +52,11 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
                         cardType: cardType ?? 'react',
                         customSections: Object.fromEntries(Object.entries(customSections).filter(([, value]) => value.type !== 'lazy').map(([k, v]) => [k, v.content])),
                         nativeModulesUrl,
+                        napiModulesMap,
                     });
                     runtime.renderPage(initData);
                     runtime.__FlushElementTree(undefined, {});
                 },
-                onNewTag,
                 flushElementTree,
                 _ReportError: function (error, info) {
                     console.error('main-thread:', error, info);

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@lynx-js/web-worker-runtime",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "private": false,
   "description": "",
   "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lynx-family/lynx-stack.git",
+    "directory": "packages/web-platform/web-worker-runtime"
+  },
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/index.js",
@@ -17,9 +22,9 @@
     "README.md"
   ],
   "dependencies": {
-    "@lynx-js/web-constants": "0.7.0",
-    "@lynx-js/web-mainthread-apis": "0.7.0",
-    "@lynx-js/web-worker-rpc": "0.7.0"
+    "@lynx-js/web-constants": "0.8.0",
+    "@lynx-js/web-mainthread-apis": "0.8.0",
+    "@lynx-js/web-worker-rpc": "0.8.0"
   },
   "devDependencies": {
     "@lynx-js/lynx-core": "0.1.0"