@lynx-js/web-worker-runtime 0.10.1 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @lynx-js/web-worker-runtime
 
+## 0.12.0
+
+### Patch Changes
+
+- feat: fully support MTS ([#569](https://github.com/lynx-family/lynx-stack/pull/569))
+
+  Now use support the following usage
+
+  - mainthread event
+  - mainthread ref
+  - runOnMainThread/runOnBackground
+  - ref.current.xx
+
+- Updated dependencies [[`f1ca29b`](https://github.com/lynx-family/lynx-stack/commit/f1ca29bd766377dd46583f15e1e75bca447699cd), [`8ca9fcb`](https://github.com/lynx-family/lynx-stack/commit/8ca9fcbbc86b0f0ac05ee4319876cdd5dd08d668), [`efe6fd7`](https://github.com/lynx-family/lynx-stack/commit/efe6fd7de8a3d8119ea550f4d4e939d1fbfee4f0)]:
+  - @lynx-js/web-mainthread-apis@0.12.0
+  - @lynx-js/web-constants@0.12.0
+  - @lynx-js/web-worker-rpc@0.12.0
+
+## 0.11.0
+
+### Patch Changes
+
+- feat: support mts event handler (1/n) ([#495](https://github.com/lynx-family/lynx-stack/pull/495))
+
+  now the main-thread:bind handler could be invoked. The params of the handler will be implemented later.
+
+- feat: allow multi lynx-view to share bts worker ([#520](https://github.com/lynx-family/lynx-stack/pull/520))
+
+  Now we allow users to enable so-called "shared-context" feature on the Web Platform.
+
+  Similar to the same feature for Lynx iOS/Android, this feature let multi lynx cards to share one js context.
+
+  The `lynx.getSharedData` and `lynx.setSharedData` are also supported in this commit.
+
+  To enable this feature, set property `lynxGroupId` or attribute `lynx-group-id` before a lynx-view starts rendering. Those card with same context id will share one web worker for the bts scripts.
+
+- Updated dependencies [[`ea42e62`](https://github.com/lynx-family/lynx-stack/commit/ea42e62fbcd5c743132c3e6e7c4851770742d544), [`a0f5ca4`](https://github.com/lynx-family/lynx-stack/commit/a0f5ca4ea0895ccbaa6aa63f449f53a677a1cf73)]:
+  - @lynx-js/web-mainthread-apis@0.11.0
+  - @lynx-js/web-constants@0.11.0
+  - @lynx-js/web-worker-rpc@0.11.0
+
 ## 0.10.1
 
 ### Patch Changes

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

@@ -1,5 +1,6 @@
-import type { Cloneable, NativeApp } from '@lynx-js/web-constants';
+import { type Cloneable, type NativeApp } from '@lynx-js/web-constants';
 import type { Rpc } from '@lynx-js/web-worker-rpc';
+import { LynxCrossThreadContext } from '../../common/LynxCrossThreadContext.js';
 export interface CreateLynxConfig {
     globalProps: unknown;
     customSections: Record<string, Cloneable>;
@@ -8,7 +9,7 @@ export declare function createBackgroundLynx(config: CreateLynxConfig, nativeApp
     __globalProps: unknown;
     getJSModule(_moduleName: string): any;
     getNativeApp(): NativeApp;
-    getCoreContext(): any;
+    getCoreContext(): LynxCrossThreadContext;
     getCustomSectionSync(key: string): Cloneable;
     getCustomSection: (key: string, callback: (object: Cloneable) => void) => void;
 };

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

@@ -1,8 +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 { dispatchCoreContextOnBackgroundEndpoint, dispatchJSContextOnMainThreadEndpoint, } from '@lynx-js/web-constants';
 import { createGetCustomSection } from './crossThreadHandlers/createGetCustomSection.js';
+import { LynxCrossThreadContext } from '../../common/LynxCrossThreadContext.js';
 export function createBackgroundLynx(config, nativeApp, mainThreadRpc) {
+    const coreContext = new LynxCrossThreadContext({
+        rpc: mainThreadRpc,
+        receiveEventEndpoint: dispatchCoreContextOnBackgroundEndpoint,
+        sendEventEndpoint: dispatchJSContextOnMainThreadEndpoint,
+    });
     return {
         __globalProps: config.globalProps,
         getJSModule(_moduleName) {
@@ -11,10 +18,7 @@ export function createBackgroundLynx(config, nativeApp, mainThreadRpc) {
             return nativeApp;
         },
         getCoreContext() {
-            return {
-                addInternalEventListener() { },
-                addEventListener() { },
-            };
+            return coreContext;
         },
         getCustomSectionSync(key) {
             return config.customSections[key];

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

@@ -1,16 +1,15 @@
 import { callLepusMethodEndpoint, setNativePropsEndpoint, triggerComponentEventEndpoint, selectComponentEndpoint, } from '@lynx-js/web-constants';
 import { createInvokeUIMethod } from './crossThreadHandlers/createInvokeUIMethod.js';
-import { registerOnLifecycleEventHandler } from './crossThreadHandlers/registerOnLifecycleEventHandler.js';
 import { registerPublicComponentEventHandler } from './crossThreadHandlers/registerPublicComponentEventHandler.js';
 import { registerGlobalExposureEventHandler } from './crossThreadHandlers/registerGlobalExposureEventHandler.js';
 import { createNativeModules } from './createNativeModules.js';
 import { registerUpdateDataHandler } from './crossThreadHandlers/registerUpdateDataHandler.js';
 import { registerPublishEventHandler } from './crossThreadHandlers/registerPublishEventHandler.js';
 import { createPerformanceApis } from './createPerformanceApis.js';
-import { registerOnNativeAppReadyHandler } from './crossThreadHandlers/registerOnNativeAppReadyHandler.js';
 import { registerSendGlobalEventHandler } from './crossThreadHandlers/registerSendGlobalEvent.js';
 import { createJSObjectDestructionObserver } from './crossThreadHandlers/createJSObjectDestructionObserver.js';
 let nativeAppCount = 0;
+const sharedData = {};
 export async function createNativeApp(config) {
     const { mainThreadRpc, uiThreadRpc, template, nativeModulesMap, timingSystem, } = config;
     const performanceApis = createPerformanceApis(timingSystem);
@@ -52,6 +51,8 @@ export async function createNativeApp(config) {
             const entry = globalThis.module.exports;
             return {
                 init: (lynxCoreInject) => {
+                    lynxCoreInject.tt.lynxCoreInject = lynxCoreInject;
+                    lynxCoreInject.tt.globalThis ??= lynxCoreInject;
                     return entry?.(lynxCoreInject.tt);
                 },
             };
@@ -66,18 +67,23 @@ export async function createNativeApp(config) {
         setNativeProps,
         invokeUIMethod: createInvokeUIMethod(uiThreadRpc),
         setCard(tt) {
-            registerOnLifecycleEventHandler(mainThreadRpc, tt);
             registerPublicComponentEventHandler(mainThreadRpc, tt);
             registerPublishEventHandler(mainThreadRpc, tt);
             registerGlobalExposureEventHandler(mainThreadRpc, tt);
             registerUpdateDataHandler(uiThreadRpc, tt);
-            registerOnNativeAppReadyHandler(uiThreadRpc, tt);
             registerSendGlobalEventHandler(uiThreadRpc, tt);
             timingSystem.registerGlobalEmitter(tt.GlobalEventEmitter);
+            tt.lynx.getCoreContext().__start();
         },
         triggerComponentEvent,
         selectComponent,
         createJSObjectDestructionObserver: createJSObjectDestructionObserver(),
+        setSharedData(dataKey, dataVal) {
+            sharedData[dataKey] = dataVal;
+        },
+        getSharedData(dataKey) {
+            return sharedData[dataKey];
+        },
     };
     return nativeApp;
 }

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

@@ -1,3 +1,3 @@
 import type { NativeApp } from '@lynx-js/web-constants';
 import type { TimingSystem } from './createTimingSystem.js';
-export declare function createPerformanceApis(timingSystem: TimingSystem): Pick<NativeApp, 'generatePipelineOptions' | 'onPipelineStart' | 'markPipelineTiming' | 'bindPipelineIdWithTimingFlag'>;
+export declare function createPerformanceApis(timingSystem: TimingSystem): Pick<NativeApp, 'generatePipelineOptions' | 'onPipelineStart' | 'markPipelineTiming' | 'bindPipelineIdWithTimingFlag' | 'profileStart' | 'profileEnd'>;

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

@@ -24,6 +24,12 @@ export function createPerformanceApis(timingSystem) {
             const timingFlags = timingSystem.pipelineIdToTimingFlags.get(pipelineId);
             timingFlags.push(timingFlag);
         },
+        profileStart: () => {
+            console.error('NYI: profileStart. This is an issue of lynx-core.');
+        },
+        profileEnd: () => {
+            console.error('NYI: profileEnd. This is an issue of lynx-core.');
+        },
     };
     return performanceApis;
 }

package/dist/common/LynxCrossThreadContext.d.ts

@@ -0,0 +1,12 @@
+import { type dispatchCoreContextOnBackgroundEndpoint, type LynxContextEventTarget, type Rpc } from '@lynx-js/web-constants';
+export declare class LynxCrossThreadContext extends EventTarget implements LynxContextEventTarget {
+    private _config;
+    constructor(_config: {
+        rpc: Rpc;
+        receiveEventEndpoint: typeof dispatchCoreContextOnBackgroundEndpoint;
+        sendEventEndpoint: typeof dispatchCoreContextOnBackgroundEndpoint;
+    });
+    postMessage(...args: any[]): void;
+    dispatchEvent(event: ContextCrossThreadEvent): 3;
+    __start(): void;
+}

package/dist/common/LynxCrossThreadContext.js

@@ -0,0 +1,24 @@
+import { DispatchEventResult, } from '@lynx-js/web-constants';
+export class LynxCrossThreadContext extends EventTarget {
+    _config;
+    constructor(_config) {
+        super();
+        this._config = _config;
+    }
+    postMessage(...args) {
+        console.error('[lynx-web] postMessage not implemented, args:', ...args);
+    }
+    // @ts-expect-error
+    dispatchEvent(event) {
+        const { rpc, sendEventEndpoint } = this._config;
+        rpc.invoke(sendEventEndpoint, [event]);
+        return DispatchEventResult.CanceledBeforeDispatch;
+    }
+    __start() {
+        const { rpc, receiveEventEndpoint } = this._config;
+        rpc.registerHandler(receiveEventEndpoint, ({ type, data }) => {
+            super.dispatchEvent(new MessageEvent(type, { data: data ?? {} }));
+        });
+    }
+}
+//# sourceMappingURL=LynxCrossThreadContext.js.map

package/dist/index.js

@@ -15,7 +15,7 @@ self.onmessage = (ev) => {
     }
 };
 Object.assign(globalThis, {
-    SystemInfo: { platform: 'web' },
+    SystemInfo: { platform: 'web', lynxSdkVersion: '3.0' },
     module: { exports: null },
 });
 //# sourceMappingURL=index.js.map

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, flushElementTreeEndpoint, reportErrorEndpoint, publishEventEndpoint, publicComponentEventEndpoint, postExposureEndpoint, postOffscreenEventEndpoint, switchExposureServiceEndpoint, postTimingFlagsEndpoint, } from '@lynx-js/web-constants';
+import { BackgroundThreadStartEndpoint, mainThreadStartEndpoint, flushElementTreeEndpoint, reportErrorEndpoint, publishEventEndpoint, publicComponentEventEndpoint, postExposureEndpoint, postOffscreenEventEndpoint, switchExposureServiceEndpoint, postTimingFlagsEndpoint, dispatchCoreContextOnBackgroundEndpoint, dispatchJSContextOnMainThreadEndpoint, } from '@lynx-js/web-constants';
 import { Rpc } from '@lynx-js/web-worker-rpc';
 import { MainThreadRuntime, switchExposureService, } from '@lynx-js/web-mainthread-apis';
 import { registerCallLepusMethodHandler } from './crossThreadHandlers/registerCallLepusMethodHandler.js';
@@ -10,22 +10,22 @@ import { createMarkTimingInternal } from './crossThreadHandlers/createMainthread
 import { registerUpdateDataHandler } from './crossThreadHandlers/registerUpdateDataHandler.js';
 import { OffscreenDocument } from '@lynx-js/offscreen-document/webworker';
 import { _onEvent, } from '@lynx-js/offscreen-document/webworker';
+import { LynxCrossThreadContext } from '../common/LynxCrossThreadContext.js';
 export function startMainThread(uiThreadPort, backgroundThreadPort) {
     const uiThreadRpc = new Rpc(uiThreadPort, 'main-to-ui');
     const backgroundThreadRpc = new Rpc(backgroundThreadPort, 'main-to-bg');
     const markTimingInternal = createMarkTimingInternal(backgroundThreadRpc);
     const postTimingFlags = backgroundThreadRpc.createCall(postTimingFlagsEndpoint);
     const backgroundStart = backgroundThreadRpc.createCall(BackgroundThreadStartEndpoint);
-    const __OnLifecycleEvent = backgroundThreadRpc.createCall(onLifecycleEventEndpoint);
     const publishEvent = backgroundThreadRpc.createCall(publishEventEndpoint);
     const publicComponentEvent = backgroundThreadRpc.createCall(publicComponentEventEndpoint);
     const postExposure = backgroundThreadRpc.createCall(postExposureEndpoint);
-    const mainThreadChunkReady = uiThreadRpc.createCall(mainThreadChunkReadyEndpoint);
     let operations = [];
     const flushElementTree = uiThreadRpc.createCall(flushElementTreeEndpoint);
     const reportError = uiThreadRpc.createCall(reportErrorEndpoint);
     markTimingInternal('lepus_excute_start');
     uiThreadRpc.registerHandler(mainThreadStartEndpoint, async (config) => {
+        let isFp = true;
         const { globalProps, template, browserConfig, nativeModulesMap, napiModulesMap, tagMap, } = config;
         const { styleInfo, pageConfig, customSections, cardType, lepusCode } = template;
         markTimingInternal('decode_start');
@@ -38,7 +38,13 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
             },
         });
         uiThreadRpc.registerHandler(postOffscreenEventEndpoint, docu[_onEvent]);
+        const jsContext = new LynxCrossThreadContext({
+            rpc: backgroundThreadRpc,
+            receiveEventEndpoint: dispatchJSContextOnMainThreadEndpoint,
+            sendEventEndpoint: dispatchCoreContextOnBackgroundEndpoint,
+        });
         const runtime = new MainThreadRuntime({
+            jsContext,
             tagMap,
             browserConfig,
             customSections,
@@ -48,8 +54,7 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
             lepusCode,
             docu,
             callbacks: {
-                mainChunkReady: function () {
-                    mainThreadChunkReady();
+                mainChunkReady: () => {
                     markTimingInternal('data_processor_start');
                     const initData = runtime.processData
                         ? runtime.processData(config.initData)
@@ -75,6 +80,13 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
                     const pipelineId = options?.pipelineOptions?.pipelineID;
                     markTimingInternal('dispatch_start', pipelineId);
                     docu.commit();
+                    if (isFp) {
+                        isFp = false;
+                        jsContext.dispatchEvent({
+                            type: '__OnNativeAppReady',
+                            data: undefined,
+                        });
+                    }
                     markTimingInternal('layout_start', pipelineId);
                     markTimingInternal('ui_operation_flush_start', pipelineId);
                     await flushElementTree(operations);
@@ -84,7 +96,12 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
                     postTimingFlags(timingFlags, pipelineId);
                 },
                 _ReportError: reportError,
-                __OnLifecycleEvent,
+                __OnLifecycleEvent: (data) => {
+                    jsContext.dispatchEvent({
+                        type: '__OnLifecycleEvent',
+                        data,
+                    });
+                },
                 /**
                  * Note :
                  * The parameter of lynx.performance.markTiming is (pipelineId:string, timingFlag:string)=>void
@@ -98,6 +115,7 @@ export function startMainThread(uiThreadPort, backgroundThreadPort) {
         }).globalThis;
         markTimingInternal('decode_end');
         entry(runtime);
+        jsContext.__start(); // start the jsContext after the runtime is created
     });
 }
 //# sourceMappingURL=startMainThread.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-worker-runtime",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -23,14 +23,14 @@
   ],
   "dependencies": {
     "@lynx-js/offscreen-document": "0.0.0",
-    "@lynx-js/web-constants": "0.10.1",
-    "@lynx-js/web-mainthread-apis": "0.10.1",
-    "@lynx-js/web-worker-rpc": "0.10.1"
+    "@lynx-js/web-constants": "0.12.0",
+    "@lynx-js/web-mainthread-apis": "0.12.0",
+    "@lynx-js/web-worker-rpc": "0.12.0"
   },
   "devDependencies": {
-    "@lynx-js/lynx-core": "0.1.0"
+    "@lynx-js/lynx-core": "0.1.2"
   },
   "peerDependencies": {
-    "@lynx-js/lynx-core": "0.1.0"
+    "@lynx-js/lynx-core": "0.1.2"
   }
 }

package/dist/backgroundThread/background-apis/crossThreadHandlers/registerOnLifecycleEventHandler.d.ts

@@ -1,3 +0,0 @@
-import { type NativeTTObject } from '@lynx-js/web-constants';
-import type { Rpc } from '@lynx-js/web-worker-rpc';
-export declare function registerOnLifecycleEventHandler(rpc: Rpc, tt: NativeTTObject): void;

package/dist/backgroundThread/background-apis/crossThreadHandlers/registerOnLifecycleEventHandler.js

@@ -1,8 +0,0 @@
-// 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 { onLifecycleEventEndpoint, } from '@lynx-js/web-constants';
-export function registerOnLifecycleEventHandler(rpc, tt) {
-    rpc.registerHandlerLazy(onLifecycleEventEndpoint, tt, 'OnLifecycleEvent');
-}
-//# sourceMappingURL=registerOnLifecycleEventHandler.js.map

package/dist/backgroundThread/background-apis/crossThreadHandlers/registerOnNativeAppReadyHandler.d.ts

@@ -1,3 +0,0 @@
-import { type NativeTTObject } from '@lynx-js/web-constants';
-import type { Rpc } from '@lynx-js/web-worker-rpc';
-export declare function registerOnNativeAppReadyHandler(uiThreadRpc: Rpc, tt: NativeTTObject): void;

package/dist/backgroundThread/background-apis/crossThreadHandlers/registerOnNativeAppReadyHandler.js

@@ -1,8 +0,0 @@
-// 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 { uiThreadFpReadyEndpoint, } from '@lynx-js/web-constants';
-export function registerOnNativeAppReadyHandler(uiThreadRpc, tt) {
-    uiThreadRpc.registerHandlerLazy(uiThreadFpReadyEndpoint, tt, 'onNativeAppReady');
-}
-//# sourceMappingURL=registerOnNativeAppReadyHandler.js.map