@lynx-js/web-constants 0.10.1 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @lynx-js/web-constants
 
+## 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 []:
+  - @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 []:
+  - @lynx-js/web-worker-rpc@0.11.0
+
 ## 0.10.1
 
 ### Patch Changes

package/dist/constants.d.ts

@@ -5,4 +5,4 @@ export declare const lynxTagAttribute: "lynx-tag";
 export declare const lynxDefaultDisplayLinearAttribute: "lynx-default-display-linear";
 export declare const lynxDefaultOverflowVisibleAttribute: "lynx-default-overflow-visible";
 export declare const __lynx_timing_flag: "__lynx_timing_flag";
-export declare const globalMuteableVars: readonly ["registerDataProcessor"];
+export declare const globalMuteableVars: readonly ["registerDataProcessor", "registerWorkletInternal", "lynxWorkletImpl", "runWorklet"];

package/dist/constants.js

@@ -10,5 +10,8 @@ export const lynxDefaultOverflowVisibleAttribute = 'lynx-default-overflow-visibl
 export const __lynx_timing_flag = '__lynx_timing_flag';
 export const globalMuteableVars = [
     'registerDataProcessor',
+    'registerWorkletInternal',
+    'lynxWorkletImpl',
+    'runWorklet',
 ];
 //# sourceMappingURL=constants.js.map

package/dist/endpoints.d.ts

@@ -1,7 +1,6 @@
 import type { ExposureWorkerEvent, LynxCrossThreadEvent } from './types/EventType.js';
 import type { Cloneable, CloneableObject } from './types/Cloneable.js';
 import type { MainThreadStartConfigs } from './types/MainThreadStartConfigs.js';
-import type { LynxLifecycleEvent } from './types/LynxLifecycleEvent.js';
 import type { IdentifierType, InvokeCallbackRes } from './types/NativeApp.js';
 import type { LynxTemplate } from './types/LynxModule.js';
 import type { NapiModulesMap } from './types/NapiModules.js';
@@ -23,8 +22,6 @@ export declare const mainThreadStartEndpoint: import("@lynx-js/web-worker-rpc/di
 export declare const updateDataEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[Cloneable, Record<string, string>], void>;
 export declare const sendGlobalEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[string, Cloneable[] | undefined]>;
 export declare const disposeEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[], void>;
-export declare const uiThreadFpReadyEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[]>;
-export declare const onLifecycleEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[LynxLifecycleEvent]>;
 export declare const BackgroundThreadStartEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[{
     initData: unknown;
     globalProps: unknown;
@@ -39,7 +36,6 @@ export declare const BackgroundThreadStartEndpoint: import("@lynx-js/web-worker-
  */
 export declare const reportErrorEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[string, unknown]>;
 export declare const flushElementTreeEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[operations: ElementOperation[]], void>;
-export declare const mainThreadChunkReadyEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[]>;
 export declare const callLepusMethodEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[name: string, data: unknown], void>;
 export declare const invokeUIMethodEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[type: IdentifierType, identifier: string, component_id: string, method: string, params: object, root_unique_id: number | undefined], InvokeCallbackRes>;
 export declare const setNativePropsEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[type: IdentifierType, identifier: string, component_id: string, first_only: boolean, native_props: object, root_unique_id: number | undefined], void>;
@@ -54,5 +50,13 @@ export declare const triggerComponentEventEndpoint: import("@lynx-js/web-worker-
     componentId: string;
 }]>;
 export declare const selectComponentEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[componentId: string, idSelector: string, single: boolean], void>;
-export declare const dispatchLynxViewEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[eventType: string, detail: CloneableObject], void>;
+export declare const dispatchLynxViewEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[eventType: string, detail: CloneableObject]>;
 export declare const dispatchNapiModuleEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[data: Cloneable]>;
+export declare const dispatchCoreContextOnBackgroundEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[{
+    type: string;
+    data: Cloneable;
+}]>;
+export declare const dispatchJSContextOnMainThreadEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[{
+    type: string;
+    data: Cloneable;
+}]>;

package/dist/endpoints.js

@@ -11,15 +11,12 @@ export const mainThreadStartEndpoint = createRpcEndpoint('mainThreadStart', fals
 export const updateDataEndpoint = createRpcEndpoint('updateData', false, true);
 export const sendGlobalEventEndpoint = createRpcEndpoint('sendGlobalEventEndpoint', false, false);
 export const disposeEndpoint = createRpcEndpoint('dispose', false, true);
-export const uiThreadFpReadyEndpoint = createRpcEndpoint('uiThreadFpReady', false, false);
-export const onLifecycleEventEndpoint = createRpcEndpoint('__OnLifecycleEvent', false, false);
 export const BackgroundThreadStartEndpoint = createRpcEndpoint('start', false, true);
 /**
  * Error message, info
  */
 export const reportErrorEndpoint = createRpcEndpoint('reportError', false, false);
 export const flushElementTreeEndpoint = createRpcEndpoint('flushElementTree', false, true);
-export const mainThreadChunkReadyEndpoint = createRpcEndpoint('mainThreadChunkReady', false, false);
 export const callLepusMethodEndpoint = createRpcEndpoint('callLepusMethod', false, true);
 export const invokeUIMethodEndpoint = createRpcEndpoint('__invokeUIMethod', false, true);
 export const setNativePropsEndpoint = createRpcEndpoint('__setNativeProps', false, true);
@@ -30,6 +27,8 @@ export const markTimingEndpoint = createRpcEndpoint('markTiming', false, false);
 export const postTimingFlagsEndpoint = createRpcEndpoint('postTimingFlags', false, false);
 export const triggerComponentEventEndpoint = createRpcEndpoint('__triggerComponentEvent', false, false);
 export const selectComponentEndpoint = createRpcEndpoint('__selectComponent', false, true);
-export const dispatchLynxViewEventEndpoint = createRpcEndpoint('dispatchLynxViewEvent', false, true);
+export const dispatchLynxViewEventEndpoint = createRpcEndpoint('dispatchLynxViewEvent', false, false);
 export const dispatchNapiModuleEndpoint = createRpcEndpoint('dispatchNapiModule', false, false);
+export const dispatchCoreContextOnBackgroundEndpoint = createRpcEndpoint('dispatchCoreContextOnBackground', false, false);
+export const dispatchJSContextOnMainThreadEndpoint = createRpcEndpoint('dispatchJSContextOnMainThread', false, false);
 //# sourceMappingURL=endpoints.js.map

package/dist/types/Cloneable.d.ts

@@ -1,2 +1,2 @@
-export type Cloneable<T = string | number | null | undefined> = T | Record<string, T>;
+export type Cloneable<T = string | number | null | undefined> = T | Record<string, T> | T[];
 export type CloneableObject<T = string | number | null | undefined> = Record<string, T>;

package/dist/types/EventType.d.ts

@@ -17,6 +17,16 @@ export interface LynxCrossThreadEvent<T = {
     detail: T;
     [key: string]: string | number | undefined | null | {};
 }
+export interface MainThreadScriptEvent<T = {
+    [key: string]: string | number | undefined | null;
+}> extends LynxCrossThreadEvent<T> {
+    target: LynxCrossThreadEventTarget & {
+        elementRefptr: unknown;
+    };
+    currentTarget: (LynxCrossThreadEventTarget & {
+        elementRefptr: unknown;
+    }) | null;
+}
 export type ExposureEventDetail = {
     'exposure-id': string;
     'exposure-scene': string;

package/dist/types/LynxContextEventTarget.d.ts

@@ -0,0 +1,18 @@
+import type { Cloneable } from './Cloneable.js';
+export declare const DispatchEventResult: {
+    readonly NotCanceled: 0;
+    readonly CanceledByEventHandler: 1;
+    readonly CanceledByDefaultEventHandler: 2;
+    readonly CanceledBeforeDispatch: 3;
+};
+export type ContextCrossThreadEvent = {
+    type: string;
+    data: Cloneable;
+};
+export interface LynxContextEventTarget {
+    onTriggerEvent?: (event: ContextCrossThreadEvent) => void;
+    postMessage(message: any): void;
+    dispatchEvent(event: ContextCrossThreadEvent): typeof DispatchEventResult[keyof typeof DispatchEventResult];
+    addEventListener(type: string, listener: (event: Event) => void): void;
+    removeEventListener(type: string, listener: (event: Event) => void): void;
+}

package/dist/types/LynxContextEventTarget.js

@@ -0,0 +1,19 @@
+export const DispatchEventResult = {
+    // Event was not canceled by event handler or default event handler.
+    NotCanceled: 0,
+    // Event was canceled by event handler; i.e. a script handler calling
+    // preventDefault.
+    CanceledByEventHandler: 1,
+    // Event was canceled by the default event handler; i.e. executing the default
+    // action.  This result should be used sparingly as it deviates from the DOM
+    // Event Dispatch model. Default event handlers really shouldn't be invoked
+    // inside of dispatch.
+    CanceledByDefaultEventHandler: 2,
+    // Event was canceled but suppressed before dispatched to event handler.  This
+    // result should be used sparingly; and its usage likely indicates there is
+    // potential for a bug. Trusted events may return this code; but untrusted
+    // events likely should always execute the event handler the developer intends
+    // to execute.
+    CanceledBeforeDispatch: 3,
+};
+//# sourceMappingURL=LynxContextEventTarget.js.map

package/dist/types/NativeApp.d.ts

@@ -1,4 +1,5 @@
 import type { CloneableObject } from './Cloneable.js';
+import type { LynxContextEventTarget } from './LynxContextEventTarget.js';
 import type { PerformancePipelineOptions } from './Performance.js';
 export declare const enum IdentifierType {
     ID_SELECTOR = 0,// css selector
@@ -22,8 +23,16 @@ export interface EventEmitter {
     trigger(eventName: string, params: string | Record<any, any>): void;
     toggle(eventName: string, ...data: unknown[]): void;
 }
+export type NativeLynx = {
+    __globalProps: CloneableObject;
+    getJSModule(_moduleName: string): unknown;
+    getNativeApp(): NativeApp;
+    getCoreContext(): LynxContextEventTarget;
+    getCustomSectionSync(key: string): CloneableObject;
+    getCustomSection(key: string): Promise<CloneableObject>;
+};
 export type NativeTTObject = {
-    lynx: unknown;
+    lynx: NativeLynx;
     OnLifecycleEvent: (...args: unknown[]) => void;
     publicComponentEvent(componentId: string, handlerName: string, eventData?: unknown): void;
     publishEvent(handlerName: string, data?: unknown): void;
@@ -62,19 +71,6 @@ export interface InvokeCallbackRes {
     code: ErrorCode;
     data?: string;
 }
-export declare enum DispatchEventResult {
-    NotCanceled = 0,
-    CanceledByEventHandler = 1,
-    CanceledByDefaultEventHandler = 2,
-    CanceledBeforeDispatch = 3
-}
-export interface ContextProxy {
-    onTriggerEvent?: (event: MessageEvent) => void;
-    postMessage(message: any): void;
-    dispatchEvent(event: MessageEvent): DispatchEventResult;
-    addEventListener(type: string, listener: (event: MessageEvent) => void): void;
-    removeEventListener(type: string, listener: (event: MessageEvent) => void): void;
-}
 export interface NativeApp {
     id: string;
     callLepusMethod(name: string, data: unknown, callback: (ret: unknown) => void): void;
@@ -94,6 +90,14 @@ export interface NativeApp {
     onPipelineStart: (pipeline_id: string) => void;
     markPipelineTiming: (pipeline_id: string, timing_key: string) => void;
     bindPipelineIdWithTimingFlag: (pipeline_id: string, timing_flag: string) => void;
+    /**
+     * Support from Lynx 3.0
+     */
+    profileStart: (traceName: string, option?: unknown) => void;
+    /**
+     * Support from Lynx 3.0
+     */
+    profileEnd: () => void;
     triggerComponentEvent(id: string, params: {
         eventDetail: CloneableObject;
         eventOption: CloneableObject;
@@ -101,4 +105,6 @@ export interface NativeApp {
     }): void;
     selectComponent(componentId: string, idSelector: string, single: boolean, callback?: () => void): void;
     createJSObjectDestructionObserver(callback: (...args: unknown[]) => unknown): {};
+    setSharedData<T>(dataKey: string, dataVal: T): void;
+    getSharedData<T = unknown>(dataKey: string): T | undefined;
 }

package/dist/types/NativeApp.js

@@ -23,23 +23,4 @@ export var ErrorCode;
     ErrorCode[ErrorCode["SELECTOR_NOT_SUPPORTED"] = 5] = "SELECTOR_NOT_SUPPORTED";
     ErrorCode[ErrorCode["NO_UI_FOR_NODE"] = 6] = "NO_UI_FOR_NODE";
 })(ErrorCode || (ErrorCode = {}));
-export var DispatchEventResult;
-(function (DispatchEventResult) {
-    // Event was not canceled by event handler or default event handler.
-    DispatchEventResult[DispatchEventResult["NotCanceled"] = 0] = "NotCanceled";
-    // Event was canceled by event handler; i.e. a script handler calling
-    // preventDefault.
-    DispatchEventResult[DispatchEventResult["CanceledByEventHandler"] = 1] = "CanceledByEventHandler";
-    // Event was canceled by the default event handler; i.e. executing the default
-    // action.  This result should be used sparingly as it deviates from the DOM
-    // Event Dispatch model. Default event handlers really shouldn't be invoked
-    // inside of dispatch.
-    DispatchEventResult[DispatchEventResult["CanceledByDefaultEventHandler"] = 2] = "CanceledByDefaultEventHandler";
-    // Event was canceled but suppressed before dispatched to event handler.  This
-    // result should be used sparingly; and its usage likely indicates there is
-    // potential for a bug. Trusted events may return this code; but untrusted
-    // events likely should always execute the event handler the developer intends
-    // to execute.
-    DispatchEventResult[DispatchEventResult["CanceledBeforeDispatch"] = 3] = "CanceledBeforeDispatch";
-})(DispatchEventResult || (DispatchEventResult = {}));
 //# sourceMappingURL=NativeApp.js.map

package/dist/types/index.d.ts

@@ -3,7 +3,6 @@ export * from './EventType.js';
 export * from './PageConfig.js';
 export * from './Cloneable.js';
 export * from './LynxModule.js';
-export * from './LynxLifecycleEvent.js';
 export * from './ProcessDataCallback.js';
 export * from './Performance.js';
 export * from './MainThreadStartConfigs.js';
@@ -12,3 +11,4 @@ export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
 export * from './NapiModules.js';
 export * from './FlushElementTreeOptions.js';
+export * from './LynxContextEventTarget.js';

package/dist/types/index.js

@@ -3,7 +3,6 @@ export * from './EventType.js';
 export * from './PageConfig.js';
 export * from './Cloneable.js';
 export * from './LynxModule.js';
-export * from './LynxLifecycleEvent.js';
 export * from './ProcessDataCallback.js';
 export * from './Performance.js';
 export * from './MainThreadStartConfigs.js';
@@ -12,4 +11,5 @@ export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
 export * from './NapiModules.js';
 export * from './FlushElementTreeOptions.js';
+export * from './LynxContextEventTarget.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-constants",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -23,7 +23,7 @@
     "**/*.css"
   ],
   "dependencies": {
-    "@lynx-js/web-worker-rpc": "0.10.1"
+    "@lynx-js/web-worker-rpc": "0.12.0"
   },
   "devDependencies": {
     "@lynx-js/offscreen-document": "0.0.0"

package/dist/types/LynxLifecycleEvent.d.ts

@@ -1 +0,0 @@
-export type LynxLifecycleEvent = [eventName: string, params: unknown];

package/dist/types/LynxLifecycleEvent.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=LynxLifecycleEvent.js.map