@lynx-js/web-mainthread-apis 0.13.5 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # @lynx-js/web-mainthread-apis
 
+## 0.14.0
+
+### Patch Changes
+
+- feat: add `_SetSourceMapRelease(errInfo)` MTS API. ([#1118](https://github.com/lynx-family/lynx-stack/pull/1118))
+
+  You can get `errInfo.release` through `e.detail.release` in the error event callback of lynx-view.
+
+  The `_SetSourceMapRelease` function is not complete yet, because it is currently limited by the Web platform and some functions and some props such as `err.stack` do not need to be supported for the time being.
+
+- 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.
+
+- fix: `decodeCssInJs` will not throw error. ([#1120](https://github.com/lynx-family/lynx-stack/pull/1120))
+
+  Before this pr, decoding css will be strictly executed according to cssInfo, and an error will be thrown if data that does not meet the requirements is encountered. Now it is changed to console.warn, which will not block rendering.
+
+- 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), [`7e73450`](https://github.com/lynx-family/lynx-stack/commit/7e73450f8f5f1153f8a064036f5552c1335c23d7)]:
+  - @lynx-js/web-constants@0.14.0
+  - @lynx-js/web-style-transformer@0.3.1
+
 ## 0.13.5
 
 ### Patch Changes

package/dist/createMainThreadGlobalThis.d.ts

@@ -1,4 +1,4 @@
-import { type LynxTemplate, type PageConfig, type StyleInfo, type FlushElementTreeOptions, type Cloneable, type BrowserConfig, type publishEventEndpoint, type publicComponentEventEndpoint, type reportErrorEndpoint, type RpcCallType, type LynxContextEventTarget, type LynxJSModule, type MainThreadGlobalThis, type WebFiberElementImpl } from '@lynx-js/web-constants';
+import { type LynxTemplate, type PageConfig, type StyleInfo, type FlushElementTreeOptions, type Cloneable, type BrowserConfig, type publishEventEndpoint, type publicComponentEventEndpoint, type reportErrorEndpoint, type RpcCallType, type LynxContextEventTarget, type LynxJSModule, type MainThreadGlobalThis, type WebFiberElementImpl, type I18nResourceTranslationOptions } from '@lynx-js/web-constants';
 export interface MainThreadRuntimeCallbacks {
     mainChunkReady: () => void;
     flushElementTree: (options: FlushElementTreeOptions, timingFlags: string[]) => void;
@@ -8,6 +8,7 @@ export interface MainThreadRuntimeCallbacks {
     publishEvent: RpcCallType<typeof publishEventEndpoint>;
     publicComponentEvent: RpcCallType<typeof publicComponentEventEndpoint>;
     createElement: (tag: string) => WebFiberElementImpl;
+    _I18nResourceTranslation: (options: I18nResourceTranslationOptions) => unknown | undefined;
 }
 export interface MainThreadRuntimeConfig {
     pageConfig: PageConfig;

package/dist/createMainThreadGlobalThis.js

@@ -340,6 +340,7 @@ export function createMainThreadGlobalThis(config) {
     const __GetPageElement = () => {
         return pageElement;
     };
+    let release = '';
     const isCSSOG = !pageConfig.enableCSSSelector;
     const mtsGlobalThis = {
         __AddEvent,
@@ -400,10 +401,13 @@ export function createMainThreadGlobalThis(config) {
             ...config.browserConfig,
         },
         lynx: createMainThreadLynx(config),
-        _ReportError: callbacks._ReportError,
+        _ReportError: (err, _) => callbacks._ReportError(err, _, release),
+        _SetSourceMapRelease: (errInfo) => release = errInfo?.release,
         __OnLifecycleEvent: callbacks.__OnLifecycleEvent,
         __FlushElementTree,
         __lynxGlobalBindingValues: lynxGlobalBindingValues,
+        _I18nResourceTranslation: callbacks._I18nResourceTranslation,
+        _AddEventListener: () => { },
         set _updateVars(handler) {
             varsUpdateHandlers.push(handler);
         },

package/dist/prepareMainThreadAPIs.d.ts

@@ -1,4 +1,4 @@
-import { type Rpc, type StartMainThreadContextConfig, type RpcCallType, type reportErrorEndpoint, type MainThreadGlobalThis } from '@lynx-js/web-constants';
-export declare function prepareMainThreadAPIs(backgroundThreadRpc: Rpc, rootDom: Document | ShadowRoot, createElement: Document['createElement'], commitDocument: () => Promise<void> | void, markTimingInternal: (timingKey: string, pipelineId?: string) => void, reportError: RpcCallType<typeof reportErrorEndpoint>): {
+import { type Rpc, type StartMainThreadContextConfig, type RpcCallType, type reportErrorEndpoint, type MainThreadGlobalThis, type I18nResourceTranslationOptions, type InitI18nResources, type I18nResources } from '@lynx-js/web-constants';
+export declare function prepareMainThreadAPIs(backgroundThreadRpc: Rpc, rootDom: Document | ShadowRoot, createElement: Document['createElement'], commitDocument: () => Promise<void> | void, markTimingInternal: (timingKey: string, pipelineId?: string) => void, reportError: RpcCallType<typeof reportErrorEndpoint>, triggerI18nResourceFallback: (options: I18nResourceTranslationOptions) => void, initialI18nResources: (data: InitI18nResources) => I18nResources): {
     startMainThread: (config: StartMainThreadContextConfig) => Promise<MainThreadGlobalThis>;
 };

package/dist/prepareMainThreadAPIs.js

@@ -1,22 +1,23 @@
 // 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, publishEventEndpoint, publicComponentEventEndpoint, postExposureEndpoint, postTimingFlagsEndpoint, dispatchCoreContextOnBackgroundEndpoint, dispatchJSContextOnMainThreadEndpoint, LynxCrossThreadContext, switchExposureServiceEndpoint, } from '@lynx-js/web-constants';
+import { BackgroundThreadStartEndpoint, publishEventEndpoint, publicComponentEventEndpoint, postExposureEndpoint, postTimingFlagsEndpoint, dispatchCoreContextOnBackgroundEndpoint, dispatchJSContextOnMainThreadEndpoint, LynxCrossThreadContext, switchExposureServiceEndpoint, getCacheI18nResourcesKey, dispatchI18nResourceEndpoint, } from '@lynx-js/web-constants';
 import { registerCallLepusMethodHandler } from './crossThreadHandlers/registerCallLepusMethodHandler.js';
 import { registerGetCustomSectionHandler } from './crossThreadHandlers/registerGetCustomSectionHandler.js';
 import { createMainThreadGlobalThis } from './createMainThreadGlobalThis.js';
 import { createExposureService } from './utils/createExposureService.js';
 const moduleCache = {};
-export function prepareMainThreadAPIs(backgroundThreadRpc, rootDom, createElement, commitDocument, markTimingInternal, reportError) {
+export function prepareMainThreadAPIs(backgroundThreadRpc, rootDom, createElement, commitDocument, markTimingInternal, reportError, triggerI18nResourceFallback, initialI18nResources) {
     const postTimingFlags = backgroundThreadRpc.createCall(postTimingFlagsEndpoint);
     const backgroundStart = backgroundThreadRpc.createCall(BackgroundThreadStartEndpoint);
     const publishEvent = backgroundThreadRpc.createCall(publishEventEndpoint);
     const publicComponentEvent = backgroundThreadRpc.createCall(publicComponentEventEndpoint);
     const postExposure = backgroundThreadRpc.createCall(postExposureEndpoint);
+    const dispatchI18nResource = backgroundThreadRpc.createCall(dispatchI18nResourceEndpoint);
     markTimingInternal('lepus_execute_start');
     async function startMainThread(config) {
         let isFp = true;
-        const { globalProps, template, browserConfig, nativeModulesMap, napiModulesMap, tagMap, } = config;
+        const { globalProps, template, browserConfig, nativeModulesMap, napiModulesMap, tagMap, initI18nResources, } = config;
         const { styleInfo, pageConfig, customSections, cardType, lepusCode } = template;
         markTimingInternal('decode_start');
         const lepusCodeEntries = await Promise.all(Object.entries(lepusCode).map(async ([name, url]) => {
@@ -40,6 +41,7 @@ export function prepareMainThreadAPIs(backgroundThreadRpc, rootDom, createElemen
             receiveEventEndpoint: dispatchJSContextOnMainThreadEndpoint,
             sendEventEndpoint: dispatchCoreContextOnBackgroundEndpoint,
         });
+        const i18nResources = initialI18nResources(initI18nResources);
         const mtsGlobalThis = createMainThreadGlobalThis({
             jsContext,
             tagMap,
@@ -112,6 +114,15 @@ export function prepareMainThreadAPIs(backgroundThreadRpc, rootDom, createElemen
                 publishEvent,
                 publicComponentEvent,
                 createElement,
+                _I18nResourceTranslation: (options) => {
+                    const matchedInitI18nResources = i18nResources.data?.find(i => getCacheI18nResourcesKey(i.options)
+                        === getCacheI18nResourcesKey(options));
+                    dispatchI18nResource(matchedInitI18nResources?.resource);
+                    if (matchedInitI18nResources) {
+                        return matchedInitI18nResources.resource;
+                    }
+                    return triggerI18nResourceFallback(options);
+                },
             },
         });
         markTimingInternal('decode_end');

package/dist/utils/decodeCssInJs.js

@@ -16,7 +16,7 @@ export function decodeCssInJs(classes, styleInfo, cssId) {
         }
     }
     else {
-        throw new Error(`[lynx-web] cannot find styleinfo for cssid ${cssId}`);
+        console.warn(`[lynx-web] cannot find styleinfo for cssid ${cssId}`);
     }
     return declarations.map(([property, value]) => `${property}:${value};`).join('');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-mainthread-apis",
-  "version": "0.13.5",
+  "version": "0.14.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -25,7 +25,7 @@
   "dependencies": {
     "css-tree": "^3.1.0",
     "hyphenate-style-name": "^1.1.0",
-    "@lynx-js/web-constants": "0.13.5",
-    "@lynx-js/web-style-transformer": "0.3.0"
+    "@lynx-js/web-constants": "0.14.0",
+    "@lynx-js/web-style-transformer": "0.3.1"
   }
 }