@lynx-js/web-core-server 0.13.4 → 0.14.0

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @lynx-js/web-core-server
 
+## 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: '',
+  });
+  ```
+
+## 0.13.5
+
+### Patch Changes
+
+- refactor: move some internal status to dom's attribute ([#945](https://github.com/lynx-family/lynx-stack/pull/945))
+
+  It's essential for SSR
+
+- refactor: move component config info to attribute ([#984](https://github.com/lynx-family/lynx-stack/pull/984))
+
+- refactor: save dataset on an attribute ([#981](https://github.com/lynx-family/lynx-stack/pull/981))
+
+  On lynx, the `data-*` attributes have different behaviors than the HTMLElement has.
+
+  The dataset will be treated as properties, the key will not be applied the camel-case <-> hyphenate name transformation.
+
+  Before this commit we use it as a runtime data, but after this commit we will use encodeURI(JSON.stringify(dataset)) to encode it as a string.
+
+- fix: dump encode data in comment ([#989](https://github.com/lynx-family/lynx-stack/pull/989))
+
 ## 0.13.4
 
 ### Patch Changes

package/dist/createLynxView.d.ts

@@ -1,11 +1,12 @@
 import { type StartMainThreadContextConfig } from '@lynx-js/web-constants';
-interface LynxViewConfig extends Pick<StartMainThreadContextConfig, 'browserConfig' | 'tagMap' | 'initData' | 'globalProps' | 'template'> {
+interface LynxViewConfig extends Pick<StartMainThreadContextConfig, 'browserConfig' | 'tagMap' | 'initData' | 'globalProps' | 'template' | 'initI18nResources'> {
     templateName?: string;
     hydrateUrl: string;
     injectStyles: string;
     overrideElementTemplates?: Record<string, ((attributes: Record<string, string>) => string) | string>;
     autoSize?: boolean;
     lynxViewStyle?: string;
+    threadStrategy?: 'all-on-ui';
 }
 export declare function createLynxView(config: LynxViewConfig): Promise<{
     renderToString: () => Promise<string>;

package/dist/createLynxView.js

@@ -1,4 +1,4 @@
-import { inShadowRootStyles, lynxUniqueIdAttribute, } from '@lynx-js/web-constants';
+import { I18nResources, inShadowRootStyles, lynxUniqueIdAttribute, } from '@lynx-js/web-constants';
 import { Rpc } from '@lynx-js/web-worker-rpc';
 import { prepareMainThreadAPIs } from '@lynx-js/web-mainthread-apis';
 import { loadTemplate } from './utils/loadTemplate.js';
@@ -35,7 +35,7 @@ OffscreenElement.prototype.toJSON = function toJSON() {
     };
 };
 export async function createLynxView(config) {
-    const { template: rawTemplate, browserConfig, tagMap, initData, globalProps, overrideElementTemplates = {}, hydrateUrl, autoSize, injectStyles, lynxViewStyle, } = config;
+    const { template: rawTemplate, browserConfig, tagMap, initData, globalProps, overrideElementTemplates = {}, hydrateUrl, autoSize, injectStyles, lynxViewStyle, threadStrategy = 'all-on-ui', initI18nResources, } = config;
     const template = await loadTemplate(rawTemplate, config.templateName);
     const { promise: firstPaintReadyPromise, resolve: firstPaintReady } = Promise
         .withResolvers();
@@ -45,12 +45,18 @@ export async function createLynxView(config) {
         onCommit: () => {
         },
     });
+    const i18nResources = new I18nResources();
     const { startMainThread } = prepareMainThreadAPIs(backgroundThreadRpc, offscreenDocument, offscreenDocument.createElement.bind(offscreenDocument), () => {
         firstPaintReady();
     }, () => {
         // mark timing
     }, () => {
         // report error
+    }, () => {
+        // trigger i18n resource fallback
+    }, (initI18nResources) => {
+        i18nResources.setData(initI18nResources);
+        return i18nResources;
     });
     const runtime = await startMainThread({
         template,
@@ -63,6 +69,7 @@ export async function createLynxView(config) {
             ...builtinTagTransformMap,
             ...tagMap,
         },
+        initI18nResources,
     });
     const elementTemplates = {
         ...builtinElementTemplates,
@@ -72,20 +79,21 @@ export async function createLynxView(config) {
         await firstPaintReadyPromise;
         const ssrEncodeData = runtime?.ssrEncode?.();
         const buffer = [];
-        buffer.push('<lynx-view url="', hydrateUrl, '" ssr');
+        buffer.push('<lynx-view url="', hydrateUrl, '" ssr ', 'thread-strategy="', threadStrategy, '"');
         if (autoSize) {
             buffer.push(' height="auto" width="auto"');
         }
         if (lynxViewStyle) {
             buffer.push(' style="', lynxViewStyle, '"');
         }
+        buffer.push('><template shadowrootmode="open">', '<style>', injectStyles, '\n', inShadowRootStyles.join('\n'), '</style>');
+        dumpHTMLString(buffer, offscreenDocument, elementTemplates);
+        buffer.push('</template>');
         if (ssrEncodeData) {
             const encodeDataEncoded = ssrEncodeData ? encodeURI(ssrEncodeData) : ''; // to avoid XSS
-            buffer.push(' ssr-encode-data="', encodeDataEncoded, '"');
+            buffer.push('<!--', encodeDataEncoded, '-->');
         }
-        buffer.push('><template shadowrootmode="open">', '<style>', injectStyles, '\n', inShadowRootStyles.join('\n'), '</style>');
-        dumpHTMLString(buffer, offscreenDocument, elementTemplates);
-        buffer.push('</template>', '</lynx-view>');
+        buffer.push('</lynx-view>');
         return buffer.join('');
     }
     return {

package/dist/dumpHTMLString.js

@@ -1,4 +1,5 @@
 import { _attributes, _children, innerHTML, } from '@lynx-js/offscreen-document/webworker';
+import { escapeHtml } from './utils/escapeHtml.js';
 function getInnerHTMLImpl(buffer, element, shadowrootTemplates) {
     const localName = element.localName;
     buffer.push('<');
@@ -7,7 +8,7 @@ function getInnerHTMLImpl(buffer, element, shadowrootTemplates) {
         buffer.push(' ');
         buffer.push(key);
         buffer.push('="');
-        buffer.push(value);
+        buffer.push(escapeHtml(value));
         buffer.push('"');
     }
     buffer.push('>');

package/dist/utils/escapeHtml.d.ts

@@ -0,0 +1 @@
+export declare function escapeHtml(string: string): string;

package/dist/utils/escapeHtml.js

@@ -0,0 +1,67 @@
+/**
+ *
+ * MIT License
+
+Copyright (c) Facebook, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ *
+ *
+ * forked from facebook/react
+ */
+const matchHtmlRegExp = /["'&<>]/;
+export function escapeHtml(string) {
+    const str = '' + string;
+    const match = matchHtmlRegExp.exec(str);
+    if (!match) {
+        return str;
+    }
+    let escape;
+    let html = '';
+    let index;
+    let lastIndex = 0;
+    for (index = match.index; index < str.length; index++) {
+        switch (str.charCodeAt(index)) {
+            case 34: // "
+                escape = '&quot;';
+                break;
+            case 38: // &
+                escape = '&amp;';
+                break;
+            case 39: // '
+                escape = '&#x27;'; // modified from escape-html; used to be '&#39'
+                break;
+            case 60: // <
+                escape = '&lt;';
+                break;
+            case 62: // >
+                escape = '&gt;';
+                break;
+            default:
+                continue;
+        }
+        if (lastIndex !== index) {
+            html += str.substring(lastIndex, index);
+        }
+        lastIndex = index + 1;
+        html += escape;
+    }
+    return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
+}
+//# sourceMappingURL=escapeHtml.js.map

package/dist/utils/loadTemplate.js

@@ -40,6 +40,7 @@ const mainThreadInjectVars = [
     'lynx',
     'globalThis',
     '_ReportError',
+    '_SetSourceMapRelease',
     '__AddConfig',
     '__AddDataset',
     '__GetAttributes',
@@ -93,6 +94,8 @@ const mainThreadInjectVars = [
     '__FlushElementTree',
     '__LoadLepusChunk',
     'SystemInfo',
+    '_I18nResourceTranslation',
+    '_AddEventListener',
 ];
 const backgroundInjectVars = [
     'NativeModules',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-core-server",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -22,10 +22,10 @@
     "README.md"
   ],
   "devDependencies": {
-    "@lynx-js/offscreen-document": "0.1.0",
-    "@lynx-js/web-constants": "0.13.4",
-    "@lynx-js/web-elements-template": "0.7.4",
-    "@lynx-js/web-mainthread-apis": "0.13.4",
-    "@lynx-js/web-worker-rpc": "0.13.4"
+    "@lynx-js/offscreen-document": "0.1.2",
+    "@lynx-js/web-constants": "0.14.0",
+    "@lynx-js/web-elements-template": "0.7.6",
+    "@lynx-js/web-mainthread-apis": "0.14.0",
+    "@lynx-js/web-worker-rpc": "0.14.0"
   }
 }