@lynx-js/web-constants 0.7.1 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,175 @@
 # @lynx-js/web-constants
 
+## 0.9.0
+
+### Minor Changes
+
+- refractor: remove entryId concept ([#217](https://github.com/lynx-family/lynx-stack/pull/217))
+
+  After the PR #198
+  All contents are isolated by a shadowroot.
+  Therefore we don't need to add the entryId selector to avoid the lynx-view's style taking effect on the whole page.
+
+### Patch Changes
+
+- feat: `nativeModulesUrl` of lynx-view is changed to `nativeModulesMap`, and the usage is completely aligned with `napiModulesMap`. ([#220](https://github.com/lynx-family/lynx-stack/pull/220))
+
+  "warning: This is a breaking change."
+
+  `nativeModulesMap` will be a map: key is module-name, value should be a esm url which export default a
+  function with two parameters(you never need to use `this`):
+
+  - `NativeModules`: oriented `NativeModules`, which you can use to call
+    other Native-Modules.
+
+  - `NativeModulesCall`: trigger `onNativeModulesCall`, same as the deprecated `this.nativeModulesCall`.
+
+  example:
+
+  ```js
+  const nativeModulesMap = {
+    CustomModule: URL.createObjectURL(
+      new Blob(
+        [
+          `export default function(NativeModules, NativeModulesCall) {
+      return {
+        async getColor(data, callback) {
+          const color = await NativeModulesCall('getColor', data);
+          callback(color);
+        },
+      }
+    };`,
+        ],
+        { type: 'text/javascript' },
+      ),
+    ),
+  };
+  lynxView.nativeModulesMap = nativeModulesMap;
+  ```
+
+  In addition, we will use Promise.all to load `nativeModules`, which will optimize performance in the case of multiple modules.
+
+- refactor: clean the decodeOperations implementation ([#261](https://github.com/lynx-family/lynx-stack/pull/261))
+
+- refactor: remove customelement defined detecting logic ([#247](https://github.com/lynx-family/lynx-stack/pull/247))
+
+  Before this commit, for those element with tag without `-`, we always try to detect if the `x-${tagName}` is defined.
+
+  After this commit, we pre-define a map(could be override by the `overrideLynxTagToHTMLTagMap`) to make that transformation for tag name.
+
+  This change is a path to SSR and the MTS support.
+
+- Updated dependencies [[`53230f0`](https://github.com/lynx-family/lynx-stack/commit/53230f012216f3a627853e11d544e4be175c5b9b)]:
+  - @lynx-js/web-worker-rpc@0.9.0
+
+## 0.8.0
+
+### Minor Changes
+
+- refactor: remove web-elements/lazy and loadNewTag ([#123](https://github.com/lynx-family/lynx-stack/pull/123))
+
+  - remove @lynx-js/web-elements/lazy
+  - remove loadElement
+  - remove loadNewTag callback
+
+  **This is a breaking change**
+
+  Now we removed the default lazy loading preinstalled in web-core
+
+  Please add the following statement in your web project
+
+  ```
+  import "@lynx-js/web-elements/all";
+  ```
+
+### Patch Changes
+
+- feat: `createRpcEndpoint` adds a new parameter: `hasReturnTransfer`. ([#194](https://github.com/lynx-family/lynx-stack/pull/194))
+
+  When `isSync`: false, `hasReturn`: true, you can add `transfer` to the callback postMessage created.
+
+  At this time, the return value structure of register-handler is changed: `{ data: unknown; transfer: Transferable[]; } | Promise<{ data: unknown; transfer: Transferable[];}>`.
+
+- feat: add two prop of lynx-view about `napiLoader`: ([#173](https://github.com/lynx-family/lynx-stack/pull/173))
+
+  - `napiModulesMap`: [optional] the napiModule which is called in lynx-core. key is module-name, value is esm url.
+
+  - `onNapiModulesCall`: [optional] the NapiModule value handler.
+
+  **Warning:** This is the internal implementation of `@lynx-js/lynx-core`. In most cases, this API is not required for projects.
+
+  1. The `napiModulesMap` value should be a esm url which export default a function with two parameters:
+
+  - `NapiModules`: oriented `napiModulesMap`, which you can use to call other Napi-Modules
+
+  - `NapiModulesCall`: trigger `onNapiModulesCall`
+
+  example:
+
+  ```js
+  const color_environment = URL.createObjectURL(
+    new Blob(
+      [
+        `export default function(NapiModules, NapiModulesCall) {
+    return {
+      getColor() {
+        NapiModules.color_methods.getColor({ color: 'green' }, color => {
+          console.log(color);
+        });
+      },
+      ColorEngine: class ColorEngine {
+        getColor(name) {
+          NapiModules.color_methods.getColor({ color: 'green' }, color => {
+            console.log(color);
+          });
+        }
+      },
+    };
+  };`,
+      ],
+      { type: 'text/javascript' },
+    ),
+  );
+
+  const color_methods = URL.createObjectURL(
+    new Blob(
+      [
+        `export default function(NapiModules, NapiModulesCall) {
+    return {
+      async getColor(data, callback) {
+        const color = await NapiModulesCall('getColor', data);
+        callback(color);
+      },
+    };
+  };`,
+      ],
+      { type: 'text/javascript' },
+    ),
+  );
+
+  lynxView.napiModuleMap = {
+    color_environment: color_environment,
+    color_methods: color_methods,
+  };
+  ```
+
+  2. The `onNapiModulesCall` function has three parameters:
+
+  - `name`: the first parameter of `NapiModulesCall`, the function name
+  - `data`: the second parameter of `NapiModulesCall`, data
+  - `moduleName`: the module-name of the called napi-module
+
+  ```js
+  lynxView.onNapiModulesCall = (name, data, moduleName) => {
+    if (name === 'getColor' && moduleName === 'color_methods') {
+      return data.color;
+    }
+  };
+  ```
+
+- Updated dependencies [[`ec4e1ce`](https://github.com/lynx-family/lynx-stack/commit/ec4e1ce0d7612d6c0701792a46c78cd52130bad4)]:
+  - @lynx-js/web-worker-rpc@0.8.0
+
 ## 0.7.1
 
 ### Patch Changes

package/dist/constants.d.ts

@@ -2,11 +2,9 @@ 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 cardIdAttribute: "lynx-card-id";
 export declare const lynxTagAttribute: "lynx-tag";
 export declare const lynxRuntimeValue: unique symbol;
 export declare const lynxDefaultDisplayLinearAttribute: "lynx-default-display-linear";
 export declare const lynxViewRootDomId: "lynx-view-root";
 export declare const __lynx_timing_flag: "__lynx_timing_flag";
-export declare const lynxViewEntryIdPrefix: "lynx-view-id";
 export declare const globalMuteableVars: readonly ["registerDataProcessor"];

package/dist/constants.js

@@ -5,13 +5,11 @@ 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 cardIdAttribute = 'lynx-card-id';
 export const lynxTagAttribute = 'lynx-tag';
 export const lynxRuntimeValue = Symbol('lynx-runtime-value');
 export const lynxDefaultDisplayLinearAttribute = 'lynx-default-display-linear';
 export const lynxViewRootDomId = 'lynx-view-root';
 export const __lynx_timing_flag = '__lynx_timing_flag';
-export const lynxViewEntryIdPrefix = 'lynx-view-id';
 export const globalMuteableVars = [
     'registerDataProcessor',
 ];

package/dist/endpoints.d.ts

@@ -6,6 +6,8 @@ import type { ElementOperation, FlushElementTreeOptions } from './types/ElementO
 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';
 export declare const postExposureEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[{
     exposures: ExposureWorkerEvent[];
     disExposures: ExposureWorkerEvent[];
@@ -33,14 +35,14 @@ export declare const BackgroundThreadStartEndpoint: import("@lynx-js/web-worker-
     template: LynxTemplate;
     cardType: string;
     customSections: Record<string, Cloneable>;
-    nativeModulesUrl?: string;
+    nativeModulesMap: NativeModulesMap;
+    napiModulesMap: NapiModulesMap;
 }], void>;
-export declare const loadNewTagEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[tag: string], void>;
 /**
- * threadLabel, Error message, info
+ * Error message, info
  */
-export declare const reportErrorEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[string, string, unknown], void>;
-export declare const flushElementTreeEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsync<[operations: ElementOperation[], FlushElementTreeOptions, styleContent: string | undefined], void>;
+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;
 }]>;
@@ -49,6 +51,7 @@ export declare const callLepusMethodEndpoint: import("@lynx-js/web-worker-rpc/di
 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 triggerComponentEventEndpoint: import("@lynx-js/web-worker-rpc/dist/RpcEndpoint.js").RpcEndpointAsyncVoid<[id: string, params: {

package/dist/endpoints.js

@@ -15,18 +15,18 @@ export const postTimingResult = createRpcEndpoint('postTimingResult', false, fal
 export const uiThreadFpReadyEndpoint = createRpcEndpoint('uiThreadFpReady', false, false);
 export const onLifecycleEventEndpoint = createRpcEndpoint('__OnLifecycleEvent', false, false);
 export const BackgroundThreadStartEndpoint = createRpcEndpoint('start', false, true);
-export const loadNewTagEndpoint = createRpcEndpoint('loadNewTag', false, true);
 /**
- * threadLabel, Error message, info
+ * Error message, info
  */
-export const reportErrorEndpoint = createRpcEndpoint('reportError', false, true);
-export const flushElementTreeEndpoint = createRpcEndpoint('flushElementTree', false, true);
+export const reportErrorEndpoint = createRpcEndpoint('reportError', false, false);
+export const flushElementTreeEndpoint = createRpcEndpoint('flushElementTree', false, false);
 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 triggerComponentEventEndpoint = createRpcEndpoint('__triggerComponentEvent', false, false);

package/dist/types/MainThreadStartConfigs.d.ts

@@ -1,11 +1,14 @@
 import type { Cloneable } from './Cloneable.js';
 import type { LynxTemplate } from './LynxModule.js';
+import type { NapiModulesMap } from './NapiModules.js';
+import type { NativeModulesMap } from './NativeModules.js';
 import type { BrowserConfig } from './PageConfig.js';
 export interface MainThreadStartConfigs {
     template: LynxTemplate;
     initData: Cloneable;
     globalProps: Cloneable;
-    entryId: string;
     browserConfig: BrowserConfig;
-    nativeModulesUrl?: string;
+    nativeModulesMap: NativeModulesMap;
+    napiModulesMap: NapiModulesMap;
+    tagMap: Record<string, string>;
 }

package/dist/types/NapiModules.d.ts

@@ -0,0 +1,2 @@
+export type NapiModulesMap = Record<string, string>;
+export type NapiModulesCall = (name: string, data: any, moduleName: string) => Promise<any> | any;

package/dist/types/NapiModules.js

@@ -0,0 +1,5 @@
+// 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.
+export {};
+//# sourceMappingURL=NapiModules.js.map

package/dist/types/NativeModules.d.ts

@@ -1,11 +1,2 @@
-import type { Cloneable } from './Cloneable.js';
+export type NativeModulesMap = Record<string, string>;
 export type NativeModulesCall = (name: string, data: any, moduleName: string) => Promise<any> | any;
-export type OneNativeModule = {
-    [k: string]: (this: NativeModuleHandlerContext, ...args: Cloneable[]) => Promise<Cloneable>;
-};
-export type NativeModuleHandlerContext = {
-    nativeModulesCall: (name: string, data: Cloneable) => Promise<Cloneable>;
-};
-export type customNativeModules = {
-    [k: string]: OneNativeModule;
-};

package/dist/types/PageConfig.d.ts

@@ -4,5 +4,4 @@ export interface PageConfig {
     defaultDisplayLinear: boolean;
 }
 export interface BrowserConfig {
-    supportAtScope: boolean;
 }

package/dist/types/index.d.ts

@@ -11,3 +11,4 @@ export * from './MainThreadStartConfigs.js';
 export * from './NativeApp.js';
 export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
+export * from './NapiModules.js';

package/dist/types/index.js

@@ -11,4 +11,5 @@ export * from './MainThreadStartConfigs.js';
 export * from './NativeApp.js';
 export * from './UpdateDataOptions.js';
 export * from './NativeModules.js';
+export * from './NapiModules.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/web-constants",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "private": false,
   "description": "",
   "keywords": [],
@@ -23,6 +23,6 @@
     "**/*.css"
   ],
   "dependencies": {
-    "@lynx-js/web-worker-rpc": "0.7.1"
+    "@lynx-js/web-worker-rpc": "0.9.0"
   }
 }