@lynx-js/types 3.4.3 → 3.5.9

package/CHANGELOG.md

@@ -1,8 +1,68 @@
 # CHANGELOG
+## 3.5.10
+- Fix list-type to avoid incompatible type error.
+
+## 3.5.9
+- Update `list` and `list-item` typings.
+
+## 3.5.8
+- Update common typings on elements.
+
+## 3.5.6
+- The `flowIds` parameter in the Trace API supports passing an undefined value.
+
+## 3.5.5
+- Add the `pointer-events` CSS property.
+
+## 3.5.4
+- Add `event-through-active-regions`, `enable-exposure-ui-clip` properties.
+
+## 3.5.3
+- Add `harmony-scroll-edge-effect` property for scroll container.
+
+## 3.5.2
+- Add `EventSource` types.
+
+## 3.5.1
+- Add `frame` element types.
+
+## 3.5.0
+
+### Major Changes
+- Update into Lynx3.5.
+
+### Patch Changes
+
+- Add a new `flowIds` subfield to the TraceOption parameter in the Trace API to support one-to-many trace associations.
+- Add `pc`, `windows`, `macOS` and `Harmony` platforms to System info.
+- Refactor event definitions for improved IDE compatibility.
+
+## 3.4.11
+- Fix types of `selectAll()` of `SelectorQuery`.
+
+## 3.4.10
+- Add `animate` for `MainThread.Element`
+
+## 3.4.9
+- Add more interface for `scroll-view`.
+
+## 3.4.8
+- Introduce `disabled` for input and textarea.
+
+## 3.4.6
+- fix `TextCodecHelper` defines.
+- Update `fetch` defines for chunk streaming.
+
+## 3.4.5
+- Complete the documentation for image related APIs.
+- Add `recyclable` property for list-item.
+
+## 3.4.4
+- Complete the documentation for text related APIs.
 
 ## 3.4.3
 - Add `font-variation-settings`,`font-feature-settings` and `font-optical-sizing` CSS properties.
-- Add `experimental-recycle-available-item-before-layout` property for list.
+- Add `experimental-recycle-available-item-before-layout` and `enable-dynamic-span-count` property for list.
 
 ## 3.4.2
 - And `lynx.fetchBundle` api defines.
@@ -21,24 +81,19 @@
 
 - Introduce <input> and <textarea>
 
-## 3.3.4
-
+## 3.3.2
+- SelectorQuery FieldsParams adds query attribute
+- Revert automatically generated cssTypes
 - Add typing for the runtime interfaces.
-
-## 3.3.3
-
-- [Infra][Types] Codegen longhand and shorthand properties from css_defines
+- Codegen longhand and shorthand properties from css_defines
 - Add `experimental-recycle-sticky-item` and `sticky-buffer-count` for list
 - Add `experimental-update-sticky-for-diff` for list
 - Add ReloadBundleEntry to standardize the timing of reload behavior.
-
-## 3.3.2
-
 - Add typing for MessageEvent.
 
 ## 3.3.1
 
-- [Infra][Types] Codegen csstype.d.ts from css_defines
+- Codegen csstype.d.ts from css_defines
 - Rename `visibleCellsAfterUpdate` to `visibleItemAfterUpdate` for `list`
 - Rename `visibleCellsBeforeUpdate` to `visibleItemBeforeUpdate` for `list`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lynx-js/types",
-  "version": "3.4.3",
+  "version": "3.5.9",
   "description": "",
   "keywords": [
     "lynx",

package/types/background-thread/fetch.d.ts

@@ -1,6 +1,32 @@
 // Copyright 2024 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 { MessageEvent } from '../common/lynx';
+
+/**
+* @description EventSource to support SSE protocol
+* @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource
+* @since 3.5
+*/
+export interface EventSource {
+  new(url: string | URL, options?: RequestInit): EventSource;
+
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/error_event) */
+  onerror: ((this: EventSource, ev: Event) => any) | null;
+  /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/message_event) */
+  onmessage: ((this: EventSource, ev: MessageEvent) => any) | null;
+  /**
+   * The **`close()`** method of the EventSource interface closes the connection, if one is made, and sets the ```js-nolint close() ``` None.
+   *
+   * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventSource/close)
+   */
+  close(): void;
+  addEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: EventSource, ev: EventSourceEventMap[K]) => any): void;
+  addEventListener(type: string, listener: (event: MessageEvent) => void): void;
+  removeEventListener<K extends keyof EventSourceEventMap>(type: K, listener: (this: EventSource, ev: EventSourceEventMap[K]) => any): void;
+  removeEventListener(type: string, listener: (event: MessageEvent) => void): void;
+}
+
 /**
  * @description Http Body
  * @since 2.18
@@ -71,9 +97,13 @@ export interface Request extends Body {
  */
 export declare var Request: {
   prototype: Request;
-  new (input: RequestInfo | URL, init?: RequestInit): Request;
+  new(input: RequestInfo | URL, init?: RequestInit): Request;
 };
 
+export interface LynxExtension {
+  useStreaming?: boolean;
+}
+
 /**
  * @description This Fetch API interface represents the response to a request.
  * @see https://developer.mozilla.org/docs/Web/API/Response
@@ -95,6 +125,11 @@ export interface RequestInit {
    * @since 2.18
    */
   method?: string;
+  /**
+   * @description Lynx extension, currently used for requesting chunk streaming
+   * @since 3.4
+   */
+  lynxExtension?: LynxExtension;
 }
 
 /**
@@ -133,6 +168,12 @@ export interface Response extends Body {
    * @since 2.18
    */
   readonly url: string;
+  /**
+   * @description body of ReadableStream
+   * @see https://developer.mozilla.org/docs/Web/API/Response/body
+   * @since 3.4
+   */
+  readonly body: ReadableStream;
   /**
    * @description clone()
    * @see https://developer.mozilla.org/docs/Web/API/Response/clone
@@ -148,5 +189,5 @@ export interface Response extends Body {
  */
 export declare var Response: {
   prototype: Response;
-  new (body?: BodyInit | null, init?: ResponseInit): Response;
+  new(body?: BodyInit | null, init?: ResponseInit): Response;
 };

package/types/background-thread/index.d.ts

@@ -9,3 +9,4 @@ export * from './nodes-ref';
 export * from './performance';
 export * from './native-modules';
 export * from './lynx-performance-entry';
+export * from './text-encoder-decoder';

package/types/background-thread/lynx-performance-entry.d.ts

@@ -84,12 +84,29 @@ export interface MetricFcpEntry extends PerformanceEntry {
     totalFcp: PerformanceMetric;
 }
 
+export interface MetricFspEntry extends PerformanceEntry {
+    fsp: PerformanceMetric;
+    lynxFsp: PerformanceMetric;
+    totalFsp: PerformanceMetric;
+}
+
 export interface MetricActualFmpEntry extends PerformanceEntry {
     actualFmp: PerformanceMetric;
     lynxActualFmp: PerformanceMetric;
     totalActualFmp: PerformanceMetric;
 }
 
+/**
+ * @deprecated Due to the influence of long tasks on this metric, the statistical results are 
+ * inaccurate, so this type has been deprecated. 
+ * Since version 3.3, you will no longer receive this event.
+ **/
+export interface MetricTtiEntry extends PerformanceEntry {
+    tti: PerformanceMetric;
+    lynxTti: PerformanceMetric;
+    totalTti: PerformanceMetric;
+}
+
 export interface ReloadBundleEntry extends PipelineEntry {
     reloadBundleStart: number;
     reloadBundleEnd: number;

package/types/background-thread/lynx.d.ts

@@ -7,7 +7,7 @@ import { AnimationElement } from './animation';
 import { BeforePublishEvent, GlobalEventEmitter, IntersectionObserver } from './event';
 import { SelectorQuery } from './nodes-ref';
 import { Performance } from './performance';
-import { Response } from './fetch';
+import { Response, RequestInit, EventSource } from './fetch';
 
 export * from './fetch';
 
@@ -135,6 +135,13 @@ export interface Lynx extends CommonLynx {
 
   setObserverFrameRate(options?: { forPageRect?: number; forExposureCheck?: number }): void;
 
+  /**
+   * @description EventSource to support SSE protocol
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/EventSource
+   * @since 3.5
+   */
+  EventSource: EventSource;
+
   /**
    * @description subset of Fetch API
    * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

package/types/background-thread/nodes-ref.d.ts

@@ -47,6 +47,7 @@ export interface FieldsParams {
   index?: boolean;
   class?: boolean;
   attribute?: boolean;
+  query?:boolean;
 }
 
 export interface FieldsData {
@@ -56,11 +57,24 @@ export interface FieldsData {
   index: number;
   class: Array<string>;
   attribute: Record<string, unknown>;
+  query:SelectorQuery;
 }
 
-export type PathCallback = (data: PathData, status: { data: string; code: number }) => void;
+export type PathCallback = (data: PathData | null, status: { data: string; code: number }) => void;
 
-export interface NodesRef {
+interface BaseNodesRef {
+  animate(animations: AnimationV2[] | AnimationV2): SelectorQuery;
+
+  playAnimation(ids: string[] | string): SelectorQuery;
+
+  pauseAnimation(ids: string[] | string): SelectorQuery;
+
+  cancelAnimation(ids: string[] | string): SelectorQuery;
+
+  setNativeProps(nativeProps: Record<string, any>): SelectorQuery;
+}
+
+export interface NodesRef extends BaseNodesRef {
   invoke(options: uiMethodOptions): SelectorQuery;
 
   path(callback: PathCallback): SelectorQuery;
@@ -70,20 +84,24 @@ export interface NodesRef {
     callback: (
       data: {
         [K in keyof Required<FieldsParams> as T[K] extends true ? K : never]: FieldsData[K];
-      },
+      } | null,
       status: { data: string; code: number }
     ) => void
   ): SelectorQuery;
+}
 
-  animate(animations: AnimationV2[] | AnimationV2): SelectorQuery;
-
-  playAnimation(ids: string[] | string): SelectorQuery;
-
-  pauseAnimation(ids: string[] | string): SelectorQuery;
+export interface MultiNodesRef extends BaseNodesRef {
+  path(callback: (data: PathData[], status: { data: string; code: number }) => void): SelectorQuery;
 
-  cancelAnimation(ids: string[] | string): SelectorQuery;
-
-  setNativeProps(nativeProps: Record<string, any>): SelectorQuery;
+  fields<T extends FieldsParams>(
+    fields: Required<FieldsParams> extends Record<keyof T, boolean> ? T : FieldsParams,
+    callback: (
+      data: {
+        [K in keyof Required<FieldsParams> as T[K] extends true ? K : never]: FieldsData[K];
+      }[],
+      status: { data: string; code: number }
+    ) => void
+  ): SelectorQuery;
 }
 
 export interface SelectorQuery {
@@ -97,7 +115,7 @@ export interface SelectorQuery {
    * Selects all nodes satisfying CSS selector.
    * @param selector CSS selector
    */
-  selectAll(selector: string): NodesRef;
+  selectAll(selector: string): MultiNodesRef;
 
   /**
    * Select root node of the component.

package/types/background-thread/text-encoder-decoder.d.ts

@@ -1,22 +1,16 @@
-export interface TextEncoder {
-    encode(str: string): ArrayBuffer;
-    encoding: 'utf-8';
-}
-
-type TypedArray =
-  | Int8Array
-  | Uint8Array
-  | Uint8ClampedArray
-  | Int16Array
-  | Uint16Array
-  | Int32Array
-  | Uint32Array
-  | Float32Array
-  | Float64Array;
+// Copyright 2025 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 interface TextDecoder {
-    decode(buffer: ArrayBuffer | TypedArray | DataView): string;
-    encoding: 'utf-8';
-    fatal: false;
-    ignoreBOM: true;
-}
+export interface ITextCodecHelper {
+  /**
+   * @description decode array buffer to string
+   * @since 3.4
+   */
+  decode(input: ArrayBuffer): string;
+  /**
+   * @description encode string to array buffer
+   * @since 3.4
+   */
+  encode(input: string): ArrayBuffer;
+}