@lynx-js/web-core 0.13.2 → 0.13.4

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @lynx-js/web-core
 
+## 0.13.4
+
+### Patch Changes
+
+- feat: lynx-view supports `updateGlobalProps` method, which can be used to update lynx.\_\_globalProps ([#918](https://github.com/lynx-family/lynx-stack/pull/918))
+
+- feat: supports `lynx.getElementById()` && `animate()`. ([#912](https://github.com/lynx-family/lynx-stack/pull/912))
+
+  After this commit, you can use `lynx.getElementById()` to get the element by id, and use `element.animate()` to animate the element.
+
+- Updated dependencies [[`96d3133`](https://github.com/lynx-family/lynx-stack/commit/96d3133b149b61af01c5478f4dc7b0a071137d98), [`75e5b2f`](https://github.com/lynx-family/lynx-stack/commit/75e5b2ff16ecf5f7072a45cd130e653dee747461), [`569618d`](https://github.com/lynx-family/lynx-stack/commit/569618d8e2665f5c9e1672f7ee5900ec2a5179a2), [`f9f88d6`](https://github.com/lynx-family/lynx-stack/commit/f9f88d6fb9c42d3370a6622d9d799d671ffcf1a7)]:
+  - @lynx-js/web-mainthread-apis@0.13.4
+  - @lynx-js/offscreen-document@0.1.0
+  - @lynx-js/web-worker-runtime@0.13.4
+  - @lynx-js/web-constants@0.13.4
+  - @lynx-js/web-worker-rpc@0.13.4
+
+## 0.13.3
+
+### Patch Changes
+
+- refactor: code clean ([#897](https://github.com/lynx-family/lynx-stack/pull/897))
+
+  rename many internal apis to make logic be clear:
+
+  multi-thread: startMainWorker -> prepareMainThreadAPIs -> startMainThread -> createMainThreadContext(new MainThreadRuntime)
+  all-on-ui: prepareMainThreadAPIs -> startMainThread -> createMainThreadContext(new MainThreadRuntime)
+
+- perf: improve dom operation performance ([#881](https://github.com/lynx-family/lynx-stack/pull/881))
+
+  - code clean for offscreen-document, cut down inheritance levels
+  - add `appendChild` method for OffscreenElement, improve performance for append one node
+  - bypass some JS getter for dumping SSR string
+
+- fix: worker not released when backgroundWorkerContextCount != 1 ([#845](https://github.com/lynx-family/lynx-stack/pull/845))
+
+- Updated dependencies [[`bb1f9d8`](https://github.com/lynx-family/lynx-stack/commit/bb1f9d845ef2395a0508666701409972e159389d), [`b6e27da`](https://github.com/lynx-family/lynx-stack/commit/b6e27daf865b0627b1c3238228a4fdf65ad87ee3), [`3d716d7`](https://github.com/lynx-family/lynx-stack/commit/3d716d79ae053b225e9bac2bbb036c968f5261e7)]:
+  - @lynx-js/offscreen-document@0.0.4
+  - @lynx-js/web-mainthread-apis@0.13.3
+  - @lynx-js/web-worker-runtime@0.13.3
+  - @lynx-js/web-constants@0.13.3
+  - @lynx-js/web-worker-rpc@0.13.3
+
 ## 0.13.2
 
 ### Patch Changes

package/dist/apis/LynxView.d.ts

@@ -29,7 +29,7 @@ export type INapiModulesCall = (name: string, data: any, moduleName: string, lyn
  * @event error lynx card fired an error
  *
  * @example
- * HTML Exmaple
+ * HTML Example
  *
  * Note that you should declarae the size of lynx-view
  *
@@ -41,7 +41,7 @@ export type INapiModulesCall = (name: string, data: any, moduleName: string, lyn
  * React 19 Example
  * ```jsx
  * <lynx-view url={myLynxCardUrl} rawData={{}} globalProps={{}} style={{height:'300px', width:'300px'}}>
- * </lynx-vew>
+ * </lynx-view>
  * ```
  */
 export declare class LynxView extends HTMLElement {
@@ -118,6 +118,12 @@ export declare class LynxView extends HTMLElement {
      * update the `__initData` and trigger essential flow
      */
     updateData(data: Cloneable, updateDataType: UpdateDataType, callback?: () => void): void;
+    /**
+     * @public
+     * @method
+     * update the `__globalProps`
+     */
+    updateGlobalProps(data: Cloneable): void;
     /**
      * @public
      * @method

package/dist/apis/LynxView.js

@@ -26,7 +26,7 @@ import { inShadowRootStyles, } from '@lynx-js/web-constants';
  * @event error lynx card fired an error
  *
  * @example
- * HTML Exmaple
+ * HTML Example
  *
  * Note that you should declarae the size of lynx-view
  *
@@ -38,7 +38,7 @@ import { inShadowRootStyles, } from '@lynx-js/web-constants';
  * React 19 Example
  * ```jsx
  * <lynx-view url={myLynxCardUrl} rawData={{}} globalProps={{}} style={{height:'300px', width:'300px'}}>
- * </lynx-vew>
+ * </lynx-view>
  * ```
  */
 export class LynxView extends HTMLElement {
@@ -196,6 +196,14 @@ export class LynxView extends HTMLElement {
     updateData(data, updateDataType, callback) {
         this.#instance?.updateData(data, updateDataType, callback);
     }
+    /**
+     * @public
+     * @method
+     * update the `__globalProps`
+     */
+    updateGlobalProps(data) {
+        this.#instance?.updateGlobalProps(data);
+    }
     /**
      * @public
      * @method

package/dist/apis/createLynxView.d.ts

@@ -17,5 +17,6 @@ export interface LynxView {
     updateData(data: Cloneable, updateDataType: UpdateDataType, callback?: () => void): void;
     dispose(): Promise<void>;
     sendGlobalEvent: RpcCallType<typeof sendGlobalEventEndpoint>;
+    updateGlobalProps: (data: Cloneable) => void;
 }
 export declare function createLynxView(configs: LynxViewConfigs): LynxView;

package/dist/uiThread/bootWorkers.js

@@ -36,6 +36,10 @@ export function bootWorkers(lynxGroupId, allOnUI) {
                 backgroundWorkerContextCount[lynxGroupId] = 0;
                 contextIdToBackgroundWorker[lynxGroupId] = undefined;
             }
+            else if (typeof backgroundWorkerContextCount[lynxGroupId] === 'number'
+                && backgroundWorkerContextCount[lynxGroupId] > 1) {
+                backgroundWorkerContextCount[lynxGroupId]--;
+            }
         },
     };
 }

package/dist/uiThread/createRenderAllOnUI.d.ts

@@ -1,8 +1,8 @@
-import type { MainThreadStartConfigs } from '@lynx-js/web-constants';
+import type { StartMainThreadContextConfig } from '@lynx-js/web-constants';
 import { Rpc } from '@lynx-js/web-worker-rpc';
 export declare function createRenderAllOnUI(mainToBackgroundRpc: Rpc, shadowRoot: ShadowRoot, markTimingInternal: (timingKey: string, pipelineId?: string, timeStamp?: number) => void, callbacks: {
     onError?: () => void;
 }): {
-    start: (configs: MainThreadStartConfigs) => Promise<void>;
+    start: (configs: StartMainThreadContextConfig) => Promise<void>;
     updateDataMainThread: (args_0: import("@lynx-js/web-constants").Cloneable, args_1: Record<string, string>) => Promise<void>;
 };

package/dist/uiThread/createRenderAllOnUI.js

@@ -1,13 +1,10 @@
 import { Rpc } from '@lynx-js/web-worker-rpc';
-const { loadMainThread, } = await import('@lynx-js/web-mainthread-apis');
+const { prepareMainThreadAPIs, } = await import('@lynx-js/web-mainthread-apis');
 export function createRenderAllOnUI(mainToBackgroundRpc, shadowRoot, markTimingInternal, callbacks) {
     if (!globalThis.module) {
         Object.assign(globalThis, { module: {} });
     }
-    const docu = Object.assign(shadowRoot, {
-        createElement: document.createElement.bind(document),
-    });
-    const { startMainThread } = loadMainThread(mainToBackgroundRpc, docu, () => { }, markTimingInternal, () => {
+    const { startMainThread } = prepareMainThreadAPIs(mainToBackgroundRpc, shadowRoot, document.createElement.bind(document), () => { }, markTimingInternal, () => {
         callbacks.onError?.();
     });
     let runtime;

package/dist/uiThread/createRenderMultiThread.d.ts

@@ -2,6 +2,6 @@ import type { Rpc } from '@lynx-js/web-worker-rpc';
 export declare function createRenderMultiThread(mainThreadRpc: Rpc, shadowRoot: ShadowRoot, callbacks: {
     onError?: () => void;
 }): {
-    start: (args_0: import("@lynx-js/web-constants").MainThreadStartConfigs) => void;
+    start: (args_0: import("@lynx-js/web-constants").StartMainThreadContextConfig) => void;
     updateDataMainThread: (args_0: import("@lynx-js/web-constants").Cloneable, args_1: Record<string, string>) => Promise<void>;
 };

package/dist/uiThread/crossThreadHandlers/registerInvokeUIMethodHandler.js

@@ -40,7 +40,7 @@ export function registerInvokeUIMethodHandler(rpc, shadowRoot) {
                 }
             }
             catch (e) {
-                console.error(`[lynx-web] invokeUIMethod: apply method faild with`, e, element);
+                console.error(`[lynx-web] invokeUIMethod: apply method failed with`, e, element);
                 code = ErrorCode.PARAM_INVALID;
             }
         }, (error) => {

package/dist/uiThread/crossThreadHandlers/registerTriggerElementMethodEndpointHandler.d.ts

@@ -0,0 +1,2 @@
+import type { Rpc } from '@lynx-js/web-worker-rpc';
+export declare function registerTriggerElementMethodEndpointHandler(rpc: Rpc, shadowRoot: ShadowRoot): void;

package/dist/uiThread/crossThreadHandlers/registerTriggerElementMethodEndpointHandler.js

@@ -0,0 +1,32 @@
+// 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 { 
+// componentIdAttribute,
+triggerElementMethodEndpoint, } from '@lynx-js/web-constants';
+import { AnimationOperation, } from '@lynx-js/web-constants';
+export function registerTriggerElementMethodEndpointHandler(rpc, shadowRoot) {
+    const animationMap = new Map();
+    rpc.registerHandler(triggerElementMethodEndpoint, (method, id, options) => {
+        if (method === 'animate') {
+            switch (options.operation) {
+                case AnimationOperation.START:
+                    animationMap.set(options.id, shadowRoot.querySelector(id)?.animate(options.keyframes, options.timingOptions));
+                    break;
+                case AnimationOperation.PLAY:
+                    animationMap.get(options.id)?.play();
+                    break;
+                case AnimationOperation.PAUSE:
+                    animationMap.get(options.id)?.pause();
+                    break;
+                case AnimationOperation.CANCEL:
+                    animationMap.get(options.id)?.cancel();
+                    break;
+                case AnimationOperation.FINISH:
+                    animationMap.get(options.id)?.finish();
+                    break;
+            }
+        }
+    });
+}
+//# sourceMappingURL=registerTriggerElementMethodEndpointHandler.js.map

package/dist/uiThread/startBackground.js

@@ -6,6 +6,7 @@ import { registerTriggerComponentEventHandler } from './crossThreadHandlers/regi
 import { registerSelectComponentHandler } from './crossThreadHandlers/registerSelectComponentHandler.js';
 import { registerNapiModulesCallHandler } from './crossThreadHandlers/registerNapiModulesCallHandler.js';
 import { registerDispatchLynxViewEventHandler } from './crossThreadHandlers/registerDispatchLynxViewEventHandler.js';
+import { registerTriggerElementMethodEndpointHandler } from './crossThreadHandlers/registerTriggerElementMethodEndpointHandler.js';
 export function startBackground(backgroundRpc, shadowRoot, callbacks) {
     registerInvokeUIMethodHandler(backgroundRpc, shadowRoot);
     registerNativePropsHandler(backgroundRpc, shadowRoot);
@@ -14,6 +15,7 @@ export function startBackground(backgroundRpc, shadowRoot, callbacks) {
     registerNativeModulesCallHandler(backgroundRpc, callbacks.nativeModulesCall);
     registerNapiModulesCallHandler(backgroundRpc, callbacks.napiModulesCall);
     registerDispatchLynxViewEventHandler(backgroundRpc, shadowRoot);
+    registerTriggerElementMethodEndpointHandler(backgroundRpc, shadowRoot);
     const sendGlobalEvent = backgroundRpc.createCall(sendGlobalEventEndpoint);
     const markTiming = backgroundRpc.createCall(markTimingEndpoint);
     const updateDataBackground = backgroundRpc.createCall(updateDataEndpoint);

package/dist/uiThread/startUIThread.d.ts

@@ -1,9 +1,9 @@
 import type { LynxView } from '../apis/createLynxView.js';
-import { type LynxTemplate, type MainThreadStartConfigs, type NapiModulesCall, type NativeModulesCall } from '@lynx-js/web-constants';
+import { type LynxTemplate, type StartMainThreadContextConfig, type NapiModulesCall, type NativeModulesCall } from '@lynx-js/web-constants';
 export type StartUIThreadCallbacks = {
     nativeModulesCall: NativeModulesCall;
     napiModulesCall: NapiModulesCall;
     onError?: () => void;
     customTemplateLoader?: (url: string) => Promise<LynxTemplate>;
 };
-export declare function startUIThread(templateUrl: string, configs: Omit<MainThreadStartConfigs, 'template'>, shadowRoot: ShadowRoot, lynxGroupId: number | undefined, threadStrategy: 'all-on-ui' | 'multi-thread', callbacks: StartUIThreadCallbacks): LynxView;
+export declare function startUIThread(templateUrl: string, configs: Omit<StartMainThreadContextConfig, 'template'>, shadowRoot: ShadowRoot, lynxGroupId: number | undefined, threadStrategy: 'all-on-ui' | 'multi-thread', callbacks: StartUIThreadCallbacks): LynxView;

package/dist/uiThread/startUIThread.js

@@ -3,7 +3,7 @@
 // LICENSE file in the root directory of this source tree.
 import { bootWorkers } from './bootWorkers.js';
 import { createDispose } from './crossThreadHandlers/createDispose.js';
-import {} from '@lynx-js/web-constants';
+import { updateGlobalPropsEndpoint, } from '@lynx-js/web-constants';
 import { loadTemplate } from '../utils/loadTemplate.js';
 import { createUpdateData } from './crossThreadHandlers/createUpdateData.js';
 import { startBackground } from './startBackground.js';
@@ -37,6 +37,7 @@ export function startUIThread(templateUrl, configs, shadowRoot, lynxGroupId, thr
         updateData: createUpdateData(updateDataMainThread, updateDataBackground),
         dispose: createDispose(backgroundRpc, terminateWorkers),
         sendGlobalEvent,
+        updateGlobalProps: backgroundRpc.createCall(updateGlobalPropsEndpoint),
     };
 }
 //# sourceMappingURL=startUIThread.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-core",
-  "version": "0.13.2",
+  "version": "0.13.4",
   "private": false,
   "description": "",
   "keywords": [],
@@ -24,15 +24,15 @@
     "**/*.css"
   ],
   "dependencies": {
-    "@lynx-js/offscreen-document": "0.0.3",
-    "@lynx-js/web-constants": "0.13.2",
-    "@lynx-js/web-mainthread-apis": "0.13.2",
-    "@lynx-js/web-worker-rpc": "0.13.2",
-    "@lynx-js/web-worker-runtime": "0.13.2"
+    "@lynx-js/offscreen-document": "0.1.0",
+    "@lynx-js/web-constants": "0.13.4",
+    "@lynx-js/web-mainthread-apis": "0.13.4",
+    "@lynx-js/web-worker-rpc": "0.13.4",
+    "@lynx-js/web-worker-runtime": "0.13.4"
   },
   "devDependencies": {
     "@lynx-js/lynx-core": "0.1.2",
-    "@lynx-js/web-elements": "0.7.2"
+    "@lynx-js/web-elements": "0.7.4"
   },
   "peerDependencies": {
     "@lynx-js/lynx-core": "0.1.2",