@lynx-js/web-constants 0.9.1 → 0.10.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @lynx-js/web-constants
 
+## 0.10.0
+
+### Minor Changes
+
+- feat: rewrite the main thread Element PAPIs ([#343](https://github.com/lynx-family/lynx-stack/pull/343))
+
+  In this commit we've rewritten the main thread apis.
+
+  The most highlighted change is that
+
+  - Before this commit we send events directly to bts
+  - After this change, we send events to mts then send them to bts with some data combined.
+
+### Patch Changes
+
+- feat: The onNapiModulesCall function of lynx-view provides the fourth parameter: `lynxView`, which is the actual lynx-view DOM. ([#350](https://github.com/lynx-family/lynx-stack/pull/350))
+
+- fix: publicComponentEvent args order ([#401](https://github.com/lynx-family/lynx-stack/pull/401))
+
+- Updated dependencies [[`a521759`](https://github.com/lynx-family/lynx-stack/commit/a5217592f5aebea4b17860e729d523ecabb5f691)]:
+  - @lynx-js/web-worker-rpc@0.10.0
+
 ## 0.9.1
 
 ### Patch Changes

package/dist/constants.d.ts

@@ -1,9 +1,8 @@
 export declare const lynxUniqueIdAttribute: "lynx-unique-id";
 export declare const cssIdAttribute: "lynx-css-id";
 export declare const componentIdAttribute: "lynx-component-id";
-export declare const parentComponentUniqueIdAttribute: "lynx-parent-component-uid";
 export declare const lynxTagAttribute: "lynx-tag";
-export declare const lynxRuntimeValue: unique symbol;
 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"];

package/dist/constants.js

@@ -4,10 +4,9 @@
 export const lynxUniqueIdAttribute = 'lynx-unique-id';
 export const cssIdAttribute = 'lynx-css-id';
 export const componentIdAttribute = 'lynx-component-id';
-export const parentComponentUniqueIdAttribute = 'lynx-parent-component-uid';
 export const lynxTagAttribute = 'lynx-tag';
-export const lynxRuntimeValue = Symbol('lynx-runtime-value');
 export const lynxDefaultDisplayLinearAttribute = 'lynx-default-display-linear';
+export const lynxDefaultOverflowVisibleAttribute = 'lynx-default-overflow-visible';
 export const __lynx_timing_flag = '__lynx_timing_flag';
 export const globalMuteableVars = [
     'registerDataProcessor',

package/dist/endpoints.d.ts

@@ -2,31 +2,27 @@ import type { ExposureWorkerEvent, LynxCrossThreadEvent } from './types/EventTyp
 import type { Cloneable, CloneableObject } from './types/Cloneable.js';
 import type { MainThreadStartConfigs } from './types/MainThreadStartConfigs.js';
 import type { LynxLifecycleEvent } from './types/LynxLifecycleEvent.js';
-import type { ElementOperation, FlushElementTreeOptions } from './types/ElementOperation.js';
-import type { PageConfig } from './types/PageConfig.js';
 import type { IdentifierType, InvokeCallbackRes } from './types/NativeApp.js';
 import type { LynxTemplate } from './types/LynxModule.js';
 import type { NapiModulesMap } from './types/NapiModules.js';
 import type { NativeModulesMap } from './types/NativeModules.js';
+import type { ElementOperation } from '@lynx-js/offscreen-document';
 export declare const postExposureEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[{
     exposures: ExposureWorkerEvent[];
     disExposures: ExposureWorkerEvent[];
 }]>;
-export declare const publicComponentEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[string, string, LynxCrossThreadEvent<{
+export declare const publicComponentEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[componentId: string, hname: string, LynxCrossThreadEvent<{
     [key: string]: string | number | null | undefined;
 }>]>;
 export declare const publishEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[string, LynxCrossThreadEvent<{
     [key: string]: string | number | null | undefined;
 }>]>;
-export declare const postMainThreadEvent: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[LynxCrossThreadEvent<{
-    [key: string]: string | number | null | undefined;
-}>]>;
-export declare const switchExposureService: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[boolean, boolean]>;
+export declare const postOffscreenEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[eventType: string, targetUniqueId: number, bubbles: boolean, unknown]>;
+export declare const switchExposureServiceEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[boolean, boolean]>;
 export declare const mainThreadStartEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[MainThreadStartConfigs]>;
 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 postTimingResult: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[pipelineId: string | undefined, updateTimingStamps: Record<string, number>, timingFlags: string[], setupTimingStamps: Record<string, number> | undefined]>;
 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<[{
@@ -42,21 +38,20 @@ export declare const BackgroundThreadStartEndpoint: import("@lynx-js/web-worker-
  * Error message, info
  */
 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").RpcEndpointAsyncVoid<[operations: ElementOperation[], FlushElementTreeOptions, styleContent: string | undefined, timingFlags: string[]]>;
-export declare const mainThreadChunkReadyEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[{
-    pageConfig: PageConfig;
-}]>;
-export declare const postTimingInfoFromMainThread: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[timingKey: string, pipelineId: string | undefined, timeStamp: number]>;
+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>;
 export declare const nativeModulesCallEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[name: string, data: Cloneable, moduleName: string], any>;
 export declare const napiModulesCallEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncWithTransfer<[name: string, data: Cloneable, moduleName: string], any>;
 export declare const getCustomSectionsEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[string], Cloneable>;
-export declare const postTimingInfoFromBackgroundThread: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[timingKey: string, pipelineId: string | undefined, timeStamp: number]>;
+export declare const markTimingEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[timingKey: string, pipelineId: string | undefined, timeStamp: number]>;
+export declare const postTimingFlagsEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[timingFlags: string[], pipelineId: string | undefined]>;
 export declare const triggerComponentEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[id: string, params: {
     eventDetail: CloneableObject;
     eventOption: CloneableObject;
     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>;

package/dist/endpoints.js

@@ -5,13 +5,12 @@ import { createRpcEndpoint } from '@lynx-js/web-worker-rpc';
 export const postExposureEndpoint = createRpcEndpoint('__postExposure', false, false);
 export const publicComponentEventEndpoint = createRpcEndpoint('publicComponentEvent', false, false);
 export const publishEventEndpoint = createRpcEndpoint('publishEvent', false, false);
-export const postMainThreadEvent = createRpcEndpoint('postMainThreadEvent', false, false);
-export const switchExposureService = createRpcEndpoint('__switchExposureService', false, false);
+export const postOffscreenEventEndpoint = createRpcEndpoint('postOffscreenEventEndpoint', false, false);
+export const switchExposureServiceEndpoint = createRpcEndpoint('switchExposureServiceEndpoint', false, false);
 export const mainThreadStartEndpoint = createRpcEndpoint('mainThreadStart', false, false);
 export const updateDataEndpoint = createRpcEndpoint('updateData', false, true);
 export const sendGlobalEventEndpoint = createRpcEndpoint('sendGlobalEventEndpoint', false, false);
 export const disposeEndpoint = createRpcEndpoint('dispose', false, true);
-export const postTimingResult = createRpcEndpoint('postTimingResult', false, false);
 export const uiThreadFpReadyEndpoint = createRpcEndpoint('uiThreadFpReady', false, false);
 export const onLifecycleEventEndpoint = createRpcEndpoint('__OnLifecycleEvent', false, false);
 export const BackgroundThreadStartEndpoint = createRpcEndpoint('start', false, true);
@@ -19,16 +18,17 @@ export const BackgroundThreadStartEndpoint = createRpcEndpoint('start', false, t
  * Error message, info
  */
 export const reportErrorEndpoint = createRpcEndpoint('reportError', false, false);
-export const flushElementTreeEndpoint = createRpcEndpoint('flushElementTree', false, false);
+export const flushElementTreeEndpoint = createRpcEndpoint('flushElementTree', false, true);
 export const mainThreadChunkReadyEndpoint = createRpcEndpoint('mainThreadChunkReady', false, false);
-export const postTimingInfoFromMainThread = createRpcEndpoint('postTimingInfoFromMainThread', false, false);
 export const callLepusMethodEndpoint = createRpcEndpoint('callLepusMethod', false, true);
 export const invokeUIMethodEndpoint = createRpcEndpoint('__invokeUIMethod', false, true);
 export const setNativePropsEndpoint = createRpcEndpoint('__setNativeProps', false, true);
 export const nativeModulesCallEndpoint = createRpcEndpoint('nativeModulesCall', false, true);
 export const napiModulesCallEndpoint = createRpcEndpoint('napiModulesCall', false, true, true);
 export const getCustomSectionsEndpoint = createRpcEndpoint('getCustomSections', false, true);
-export const postTimingInfoFromBackgroundThread = createRpcEndpoint('postTimingInfoFromBackgroundThread', false, false);
+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);
 //# sourceMappingURL=endpoints.js.map

package/dist/index.d.ts

@@ -2,3 +2,4 @@ export * from './constants.js';
 export * from './eventName.js';
 export * from './endpoints.js';
 export * from './types/index.js';
+export type * from '@lynx-js/web-worker-rpc';

package/dist/types/EventType.d.ts

@@ -13,7 +13,7 @@ export interface LynxCrossThreadEvent<T = {
     type: string;
     timestamp: number;
     target: LynxCrossThreadEventTarget;
-    currentTarget: LynxCrossThreadEventTarget;
+    currentTarget: LynxCrossThreadEventTarget | null;
     detail: T;
     [key: string]: string | number | undefined | null | {};
 }

package/dist/types/FlushElementTreeOptions.d.ts

@@ -0,0 +1,4 @@
+import type { PerformancePipelineOptions } from './Performance.js';
+export interface FlushElementTreeOptions {
+    pipelineOptions?: PerformancePipelineOptions;
+}

package/dist/types/FlushElementTreeOptions.js

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

package/dist/types/NapiModules.d.ts

@@ -1,2 +1,8 @@
 export type NapiModulesMap = Record<string, string>;
-export type NapiModulesCall = (name: string, data: any, moduleName: string) => Promise<any> | any;
+export type NapiModulesCall = (name: string, data: any, moduleName: string) => Promise<{
+    data: unknown;
+    transfer?: unknown[];
+}> | {
+    data: unknown;
+    transfer?: unknown[];
+} | undefined;

package/dist/types/PageConfig.d.ts

@@ -2,6 +2,7 @@ export interface PageConfig {
     enableCSSSelector: boolean;
     enableRemoveCSSScope: boolean;
     defaultDisplayLinear: boolean;
+    defaultOverflowVisible: boolean;
 }
 export interface BrowserConfig {
 }

package/dist/types/index.d.ts

@@ -1,6 +1,5 @@
 export * from './StyleInfo.js';
 export * from './EventType.js';
-export * from './ElementOperation.js';
 export * from './PageConfig.js';
 export * from './Cloneable.js';
 export * from './LynxModule.js';
@@ -12,3 +11,4 @@ export * from './NativeApp.js';
 export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
 export * from './NapiModules.js';
+export * from './FlushElementTreeOptions.js';

package/dist/types/index.js

@@ -1,6 +1,5 @@
 export * from './StyleInfo.js';
 export * from './EventType.js';
-export * from './ElementOperation.js';
 export * from './PageConfig.js';
 export * from './Cloneable.js';
 export * from './LynxModule.js';
@@ -12,4 +11,5 @@ export * from './NativeApp.js';
 export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
 export * from './NapiModules.js';
+export * from './FlushElementTreeOptions.js';
 //# sourceMappingURL=index.js.map

package/package.json

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

package/dist/types/ElementOperation.d.ts

@@ -1,115 +0,0 @@
-import type { Cloneable } from './Cloneable.js';
-import type { LynxEventType } from './EventType.js';
-import type { PerformancePipelineOptions } from './Performance.js';
-export interface FlushElementTreeOptions {
-    pipelineOptions?: PerformancePipelineOptions;
-}
-export declare enum OperationType {
-    Create = 0,
-    SetAttribute = 1,
-    SetProperty = 2,
-    SwapElement = 3,
-    Append = 4,
-    Remove = 5,
-    Replace = 6,
-    SetDatasetProperty = 7,
-    InsertBefore = 8,
-    SetStyleProperty = 9,
-    UpdateCssInJs = 10,
-    RegisterEventHandler = 11
-}
-interface ElementOperationBase {
-    type: OperationType;
-    /**
-     * uniqueId
-     */
-    uid: number;
-}
-export interface CreateOperation extends ElementOperationBase {
-    type: OperationType.Create;
-    tag: string;
-    cssId?: number;
-}
-export interface SetAttributeOperation extends ElementOperationBase {
-    type: OperationType.SetAttribute;
-    key: string;
-    value: string | null;
-}
-export interface SetPropertyOperation extends ElementOperationBase {
-    type: OperationType.SetProperty;
-    /**
-     * property name
-     */
-    key: string;
-    value: Cloneable;
-}
-export interface SwapOperation extends ElementOperationBase {
-    type: OperationType.SwapElement;
-    /**
-     * target uniqueId
-     */
-    tid: number;
-}
-export interface AppendOperation extends ElementOperationBase {
-    type: OperationType.Append;
-    /**
-     * child uniqueId
-     */
-    cid: number[];
-}
-export interface RemoveOperation extends ElementOperationBase {
-    type: OperationType.Remove;
-    cid: number[];
-}
-export interface SetDatasetPropertyOperation extends ElementOperationBase {
-    type: OperationType.SetDatasetProperty;
-    /**
-     * propert name in dataset
-     */
-    key: string;
-    value: Cloneable;
-}
-export interface InsertBeforeOperation extends ElementOperationBase {
-    type: OperationType.InsertBefore;
-    /**
-     * child uniqueId
-     */
-    cid: number;
-    ref?: number;
-}
-export interface ReplaceOperation extends ElementOperationBase {
-    type: OperationType.Replace;
-    /**
-     * the new element's unique id.
-     */
-    nid: number[];
-}
-export interface UpdateCssInJsOperation extends ElementOperationBase {
-    type: OperationType.UpdateCssInJs;
-    classStyleStr: string;
-}
-export interface SetStylePropertyOperation extends ElementOperationBase {
-    type: OperationType.SetStyleProperty;
-    key: string;
-    value: string | null;
-    /**
-     * important
-     */
-    im?: boolean;
-}
-export interface RegisterEventHandlerOperation extends ElementOperationBase {
-    type: OperationType.RegisterEventHandler;
-    eventType: LynxEventType;
-    /**
-     * lynx event name
-     */
-    ename: string;
-    /**
-     * If it's a background thread hander, it will have a handler name.
-     * If it's a main-thread handler, it will be null
-     * If it's going to be removed, it will be undefined
-     */
-    hname: string | undefined | null;
-}
-export type ElementOperation = RegisterEventHandlerOperation | SetStylePropertyOperation | UpdateCssInJsOperation | ReplaceOperation | InsertBeforeOperation | SetDatasetPropertyOperation | CreateOperation | SetAttributeOperation | SetPropertyOperation | SwapOperation | AppendOperation | RemoveOperation;
-export {};

package/dist/types/ElementOperation.js

@@ -1,16 +0,0 @@
-export var OperationType;
-(function (OperationType) {
-    OperationType[OperationType["Create"] = 0] = "Create";
-    OperationType[OperationType["SetAttribute"] = 1] = "SetAttribute";
-    OperationType[OperationType["SetProperty"] = 2] = "SetProperty";
-    OperationType[OperationType["SwapElement"] = 3] = "SwapElement";
-    OperationType[OperationType["Append"] = 4] = "Append";
-    OperationType[OperationType["Remove"] = 5] = "Remove";
-    OperationType[OperationType["Replace"] = 6] = "Replace";
-    OperationType[OperationType["SetDatasetProperty"] = 7] = "SetDatasetProperty";
-    OperationType[OperationType["InsertBefore"] = 8] = "InsertBefore";
-    OperationType[OperationType["SetStyleProperty"] = 9] = "SetStyleProperty";
-    OperationType[OperationType["UpdateCssInJs"] = 10] = "UpdateCssInJs";
-    OperationType[OperationType["RegisterEventHandler"] = 11] = "RegisterEventHandler";
-})(OperationType || (OperationType = {}));
-//# sourceMappingURL=ElementOperation.js.map