@lynx-js/web-worker-runtime 0.13.5 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,61 @@
 # @lynx-js/web-worker-runtime
 
+## 0.14.0
+
+### Patch Changes
+
+- fix: The parameter config of loadCard needs to add updateData, otherwise some event binding will fail when enableJSDataProcessor is turned on. ([#1077](https://github.com/lynx-family/lynx-stack/pull/1077))
+
+- feat: add `_I18nResourceTranslation` api in mts && `init-i18n-resources` attr, `i18nResourceMissed` event of lynx-view. ([#1065](https://github.com/lynx-family/lynx-stack/pull/1065))
+
+  `init-i18n-resource` is the complete set of i18nResources that need to be maintained on the container side. Note: You need to pass this value when lynx-view is initialized.
+
+  You can use `_I18nResourceTranslation` in MTS to get the corresponding i18nResource from `init-i18n-resources`. If it is undefined, the `i18nResourceMissed` event will be dispatched.
+
+  ```js
+  // ui thread
+  lynxView.initI18nResources = [
+    {
+      options: {
+        locale: 'en',
+        channel: '1',
+        fallback_url: '',
+      },
+      resource: {
+        hello: 'hello',
+        lynx: 'lynx web platform1',
+      },
+    },
+  ];
+  lynxView.addEventListener('i18nResourceMissed', (e) => {
+    console.log(e);
+  });
+
+  // mts
+  _I18nResourceTranslation({
+    locale: 'en',
+    channel: '1',
+    fallback_url: '',
+  });
+  ```
+
+- feat: supports `lynx.getI18nResource()` and `onI18nResourceReady` event in bts. ([#1088](https://github.com/lynx-family/lynx-stack/pull/1088))
+
+  - `lynx.getI18nResource()` can be used to get i18nResource in bts, it has two data sources:
+    - the result of `_I18nResourceTranslation()`
+    - lynx-view `updateI18nResources(data: InitI18nResources, options: I18nResourceTranslationOptions)`, it will be matched to the correct i8nResource as a result of `lynx.getI18nResource()`
+  - `onI18nResourceReady` event can be used to listen `_I18nResourceTranslation` and lynx-view `updateI18nResources` execution.
+
+- feat: add `updateI18nResources` method of lynx-view. ([#1085](https://github.com/lynx-family/lynx-stack/pull/1085))
+
+  Now you can use `updateI18nResources` to update i18nResources, and then use \_I18nResourceTranslation() to get the updated result.
+
+- Updated dependencies [[`25a04c9`](https://github.com/lynx-family/lynx-stack/commit/25a04c9e59f4b893227bdead74f2de69f6615cdb), [`0dbb8b1`](https://github.com/lynx-family/lynx-stack/commit/0dbb8b1f580d0700e2b67b92018a7a00d1494837), [`f99de1e`](https://github.com/lynx-family/lynx-stack/commit/f99de1ef60cc5a11eae4fd0acc70a490787d36c9), [`873a285`](https://github.com/lynx-family/lynx-stack/commit/873a2852fa3df9e32c48a6504160bb243540c7b9), [`afacb2c`](https://github.com/lynx-family/lynx-stack/commit/afacb2cbea7feca46c553651000625d0845b2b00), [`1861cbe`](https://github.com/lynx-family/lynx-stack/commit/1861cbead4b373e0511214999b0e100b6285fa9a)]:
+  - @lynx-js/web-mainthread-apis@0.14.0
+  - @lynx-js/web-constants@0.14.0
+  - @lynx-js/offscreen-document@0.1.2
+  - @lynx-js/web-worker-rpc@0.14.0
+
 ## 0.13.5
 
 ### Patch Changes

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

@@ -1,18 +1,15 @@
-import { LynxCrossThreadContext, type Cloneable, type NativeApp } from '@lynx-js/web-constants';
+import { LynxCrossThreadContext, type BackMainThreadContextConfig, type NativeApp } from '@lynx-js/web-constants';
 import type { Rpc } from '@lynx-js/web-worker-rpc';
-export interface CreateLynxConfig {
-    globalProps: unknown;
-    customSections: Record<string, Cloneable>;
-}
-export declare function createBackgroundLynx(config: CreateLynxConfig, nativeApp: NativeApp, mainThreadRpc: Rpc, uiThreadRpc: Rpc): {
+export declare function createBackgroundLynx(config: BackMainThreadContextConfig, nativeApp: NativeApp, mainThreadRpc: Rpc, uiThreadRpc: Rpc): {
     __globalProps: unknown;
     getJSModule(_moduleName: string): any;
     getNativeApp(): NativeApp;
     getCoreContext(): LynxCrossThreadContext;
-    getCustomSectionSync(key: string): Cloneable;
-    getCustomSection: (key: string, callback: (object: Cloneable) => void) => void;
+    getCustomSectionSync(key: string): import("@lynx-js/web-constants").Cloneable;
+    getCustomSection: (key: string, callback: (object: import("@lynx-js/web-constants").Cloneable) => void) => void;
     queueMicrotask: (callback: () => void) => void;
     createElement(_: string, id: string): {
         animate(operation: import("@lynx-js/web-constants").AnimationOperation, id: string, keyframes?: Record<string, any>[], timingOptions?: Record<string, any>): void;
     };
+    getI18nResource: () => import("@lynx-js/web-constants").Cloneable;
 };

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

@@ -30,6 +30,7 @@ export function createBackgroundLynx(config, nativeApp, mainThreadRpc, uiThreadR
         createElement(_, id) {
             return createElement(id, uiThreadRpc);
         },
+        getI18nResource: () => nativeApp.i18nResource.data,
     };
 }
 //# sourceMappingURL=createBackgroundLynx.js.map

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

@@ -1,11 +1,8 @@
 import type { Rpc } from '@lynx-js/web-worker-rpc';
-import { type LynxTemplate, type NativeApp, type NativeModulesMap, type BrowserConfig } from '@lynx-js/web-constants';
+import { type NativeApp, type BackMainThreadContextConfig } from '@lynx-js/web-constants';
 import type { TimingSystem } from './createTimingSystem.js';
 export declare function createNativeApp(config: {
-    template: LynxTemplate;
     uiThreadRpc: Rpc;
     mainThreadRpc: Rpc;
-    nativeModulesMap: NativeModulesMap;
     timingSystem: TimingSystem;
-    browserConfig: BrowserConfig;
-}): Promise<NativeApp>;
+} & BackMainThreadContextConfig): Promise<NativeApp>;

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

@@ -1,4 +1,4 @@
-import { callLepusMethodEndpoint, setNativePropsEndpoint, triggerComponentEventEndpoint, selectComponentEndpoint, systemInfo, } from '@lynx-js/web-constants';
+import { callLepusMethodEndpoint, setNativePropsEndpoint, triggerComponentEventEndpoint, selectComponentEndpoint, systemInfo, I18nResource, } from '@lynx-js/web-constants';
 import { createInvokeUIMethod } from './crossThreadHandlers/createInvokeUIMethod.js';
 import { registerPublicComponentEventHandler } from './crossThreadHandlers/registerPublicComponentEventHandler.js';
 import { registerGlobalExposureEventHandler } from './crossThreadHandlers/registerGlobalExposureEventHandler.js';
@@ -9,6 +9,7 @@ import { createPerformanceApis } from './createPerformanceApis.js';
 import { registerSendGlobalEventHandler } from './crossThreadHandlers/registerSendGlobalEvent.js';
 import { createJSObjectDestructionObserver } from './crossThreadHandlers/createJSObjectDestructionObserver.js';
 import { registerUpdateGlobalPropsHandler } from './crossThreadHandlers/registerUpdateGlobalPropsHandler.js';
+import { registerUpdateI18nResource } from './crossThreadHandlers/registerUpdateI18nResource.js';
 let nativeAppCount = 0;
 const sharedData = {};
 export async function createNativeApp(config) {
@@ -45,6 +46,7 @@ export async function createNativeApp(config) {
             },
         };
     };
+    const i18nResource = new I18nResource();
     const nativeApp = {
         id: (nativeAppCount++).toString(),
         ...performanceApis,
@@ -86,6 +88,7 @@ export async function createNativeApp(config) {
             registerUpdateDataHandler(uiThreadRpc, tt);
             registerSendGlobalEventHandler(uiThreadRpc, tt);
             registerUpdateGlobalPropsHandler(uiThreadRpc, tt);
+            registerUpdateI18nResource(uiThreadRpc, mainThreadRpc, i18nResource, tt);
             timingSystem.registerGlobalEmitter(tt.GlobalEventEmitter);
             tt.lynx.getCoreContext().__start();
         },
@@ -98,6 +101,7 @@ export async function createNativeApp(config) {
         getSharedData(dataKey) {
             return sharedData[dataKey];
         },
+        i18nResource,
     };
     return nativeApp;
 }

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

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

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

@@ -0,0 +1,18 @@
+// 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 { dispatchI18nResourceEndpoint, updateI18nResourceEndpoint, } from '@lynx-js/web-constants';
+import { I18nResource } from '@lynx-js/web-constants';
+export function registerUpdateI18nResource(uiThreadRpc, mainThreadRpc, i18nResource, tt) {
+    // updateI18nResourceEndpoint from ui thread
+    uiThreadRpc.registerHandler(updateI18nResourceEndpoint, (data) => {
+        i18nResource.setData(data);
+        tt.GlobalEventEmitter.emit('onI18nResourceReady', []);
+    });
+    // dispatchI18nResource from mts
+    mainThreadRpc.registerHandler(dispatchI18nResourceEndpoint, (data) => {
+        i18nResource.setData(data);
+        tt.GlobalEventEmitter.emit('onI18nResourceReady', []);
+    });
+}
+//# sourceMappingURL=registerUpdateI18nResource.js.map

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

@@ -27,7 +27,11 @@ export function startBackgroundThread(uiThreadPort, mainThreadPort) {
             await createNapiLoader(uiThreadRpc, config.napiModulesMap);
         const nativeLynx = createBackgroundLynx(config, nativeApp, mainThreadRpc, uiThreadRpc);
         lynxCore.then(({ loadCard, destroyCard, callDestroyLifetimeFun }) => {
-            loadCard(nativeApp, config, nativeLynx);
+            loadCard(nativeApp, {
+                ...config,
+                // @ts-ignore
+                updateData: config.initData,
+            }, nativeLynx);
             registerDisposeHandler(uiThreadRpc, nativeApp, destroyCard, callDestroyLifetimeFun);
         });
     });

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 { flushElementTreeEndpoint, mainThreadStartEndpoint, postOffscreenEventEndpoint, reportErrorEndpoint, } from '@lynx-js/web-constants';
+import { flushElementTreeEndpoint, mainThreadStartEndpoint, postOffscreenEventEndpoint, reportErrorEndpoint, dispatchLynxViewEventEndpoint, i18nResourceMissedEventName, I18nResources, updateI18nResourcesEndpoint, } from '@lynx-js/web-constants';
 import { Rpc } from '@lynx-js/web-worker-rpc';
 import { createMarkTimingInternal } from './crossThreadHandlers/createMainthreadMarkTimingInternal.js';
 import { OffscreenDocument } from '@lynx-js/offscreen-document/webworker';
@@ -14,15 +14,28 @@ export function startMainThreadWorker(uiThreadPort, backgroundThreadPort) {
     const markTimingInternal = createMarkTimingInternal(backgroundThreadRpc);
     const uiFlush = uiThreadRpc.createCall(flushElementTreeEndpoint);
     const reportError = uiThreadRpc.createCall(reportErrorEndpoint);
+    const triggerI18nResourceFallback = (options) => {
+        uiThreadRpc.invoke(dispatchLynxViewEventEndpoint, [
+            i18nResourceMissedEventName,
+            options,
+        ]);
+    };
     const docu = new OffscreenDocument({
         onCommit: uiFlush,
     });
+    const i18nResources = new I18nResources();
     uiThreadRpc.registerHandler(postOffscreenEventEndpoint, docu[_onEvent]);
-    const { startMainThread } = prepareMainThreadAPIs(backgroundThreadRpc, docu, docu.createElement.bind(docu), docu.commit.bind(docu), markTimingInternal, reportError);
+    const { startMainThread } = prepareMainThreadAPIs(backgroundThreadRpc, docu, docu.createElement.bind(docu), docu.commit.bind(docu), markTimingInternal, reportError, triggerI18nResourceFallback, (initI18nResources) => {
+        i18nResources.setData(initI18nResources);
+        return i18nResources;
+    });
     uiThreadRpc.registerHandler(mainThreadStartEndpoint, (config) => {
         startMainThread(config).then((runtime) => {
             registerUpdateDataHandler(uiThreadRpc, runtime);
         });
     });
+    uiThreadRpc?.registerHandler(updateI18nResourcesEndpoint, data => {
+        i18nResources.setData(data);
+    });
 }
 //# sourceMappingURL=startMainThread.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-worker-runtime",
-  "version": "0.13.5",
+  "version": "0.14.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -22,10 +22,10 @@
     "README.md"
   ],
   "dependencies": {
-    "@lynx-js/offscreen-document": "0.1.1",
-    "@lynx-js/web-constants": "0.13.5",
-    "@lynx-js/web-mainthread-apis": "0.13.5",
-    "@lynx-js/web-worker-rpc": "0.13.5"
+    "@lynx-js/offscreen-document": "0.1.2",
+    "@lynx-js/web-constants": "0.14.0",
+    "@lynx-js/web-mainthread-apis": "0.14.0",
+    "@lynx-js/web-worker-rpc": "0.14.0"
   },
   "devDependencies": {
     "@lynx-js/lynx-core": "0.1.2"