@lynx-js/types 3.4.11 → 3.5.10-alpha.0

package/CHANGELOG.md

@@ -1,4 +1,38 @@
 # CHANGELOG
+## 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`.
@@ -18,13 +52,14 @@
 
 ## 3.4.5
 - Complete the documentation for image related APIs.
+- Add `recyclable` property for list-item.
 
 ## 3.4.4
-- Revert automatically generated cssTypes
+- 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.
@@ -43,24 +78,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.11",
+  "version": "3.5.10-alpha.0",
   "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,7 +97,7 @@ 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 {
@@ -163,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/lynx-performance-entry.d.ts

@@ -84,6 +84,12 @@ 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;

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, RequestInit } 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,6 +57,7 @@ export interface FieldsData {
   index: number;
   class: Array<string>;
   attribute: Record<string, unknown>;
+  query:SelectorQuery;
 }
 
 export type PathCallback = (data: PathData | null, status: { data: string; code: number }) => void;

package/types/common/csstype.d.ts

@@ -100,6 +100,7 @@ export type CSSProperties = Modify<
     fontVariationSettings?: string;
     fontFeatureSettings?: string;
     fontOpticalSizing?: 'none' | 'auto';
+    pointerEvents?: 'auto' | 'none';
   }
 >;
 
@@ -124,7 +125,7 @@ export type Longhands =
   // animation
   "transitionProperty" | "transitionDuration" | "transitionDelay" | "transitionTimingFunction" | "implicitAnimation" | "enterTransitionName" | "exitTransitionName" | "pauseTransitionName" | "resumeTransitionName" | "animationName" | "animationDuration" | "animationTimingFunction" | "animationDelay" | "animationIterationCount" | "animationDirection" | "animationFillMode" | "animationPlayState" | "layoutAnimationCreateDuration" | "layoutAnimationCreateTimingFunction" | "layoutAnimationCreateDelay" | "layoutAnimationCreateProperty" | "layoutAnimationDeleteDuration" | "layoutAnimationDeleteTimingFunction" | "layoutAnimationDeleteDelay" | "layoutAnimationDeleteProperty" | "layoutAnimationUpdateDuration" | "layoutAnimationUpdateTimingFunction" | "layoutAnimationUpdateDelay" |
   // other
-  "top" | "visibility" | "content" | "overflowX" | "overflowY" | "wordBreak" | "verticalAlign" | "direction" | "relativeId" | "relativeAlignTop" | "relativeAlignRight" | "relativeAlignBottom" | "relativeAlignLeft" | "relativeTopOf" | "relativeRightOf" | "relativeBottomOf" | "relativeLeftOf" | "relativeLayoutOnce" | "relativeCenter" | "zIndex" | "maskImage" | "justifyItems" | "justifySelf" | "filter" | "listMainAxisGap" | "listCrossAxisGap" | "perspective" | "cursor" | "clipPath" | "left" | "maskRepeat" | "maskClip" | "maskOrigin" | "maskSize" | "columnGap" | "rowGap" | "imageRendering" | "hyphens" | "XAppRegion" | "XHandleSize" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "height" | "width" | "maxWidth" | "minWidth" | "right" | "maxHeight" | "minHeight" | "bottom" | "letterSpacing" | "alignItems" | "alignSelf" | "alignContent" | "justifyContent" | "boxSizing" | "transform" | "order" | "boxShadow" | "transformOrigin" | "aspectRatio";
+  "top" | "visibility" | "content" | "overflowX" | "overflowY" | "wordBreak" | "verticalAlign" | "direction" | "relativeId" | "relativeAlignTop" | "relativeAlignRight" | "relativeAlignBottom" | "relativeAlignLeft" | "relativeTopOf" | "relativeRightOf" | "relativeBottomOf" | "relativeLeftOf" | "relativeLayoutOnce" | "relativeCenter" | "zIndex" | "maskImage" | "justifyItems" | "justifySelf" | "filter" | "listMainAxisGap" | "listCrossAxisGap" | "perspective" | "cursor" | "clipPath" | "left" | "maskRepeat" | "maskClip" | "maskOrigin" | "maskSize" | "columnGap" | "rowGap" | "imageRendering" | "hyphens" | "XAppRegion" | "XHandleSize" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "height" | "width" | "maxWidth" | "minWidth" | "right" | "maxHeight" | "minHeight" | "bottom" | "letterSpacing" | "alignItems" | "alignSelf" | "alignContent" | "justifyContent" | "boxSizing" | "transform" | "order" | "boxShadow" | "transformOrigin" | "aspectRatio" | "pointerEvents";
 
 // Since `Shorthands` and `Longhands` are auto generated, there may be properties
 // such as `gridColumnSpan` is not manually defined in `CSSProperties` yet.

package/types/common/element/element.d.ts

@@ -7,13 +7,16 @@ import { NoProps } from '../props';
 import { ComponentProps } from './component';
 import { FilterImageProps } from './filter-image';
 import { ImageProps, ImageUIMethods } from './image';
-import { ListItemProps, ListProps, ListRowProps, ListUIMethods } from './list';
+import { ListProps, ListUIMethods } from './list';
+import { ListItemProps } from './list-item';
 import { PageProps } from './page';
 import { ScrollViewProps, ScrollViewUIMethods } from './scroll-view';
-import { TextProps } from './text';
+import { TextProps, TextUIMethods } from './text';
 import { ViewProps } from './view';
 import { InputProps, InputUIMethods } from './input';
 import { TextAreaProps, TextAreaUIMethods } from './textarea';
+import { FrameProps } from './frame';
+
 
 export interface UIMethods {
   'list': ListUIMethods;
@@ -21,6 +24,7 @@ export interface UIMethods {
   'image': ImageUIMethods;
   'input': InputUIMethods;
   'textarea': TextAreaUIMethods;
+  'text': TextUIMethods;
 }
 
 type LynxComponentProps = ComponentProps;
@@ -35,7 +39,7 @@ export interface IntrinsicElements {
   'inline-truncation': NoProps;
   'list': ListProps;
   'list-item': ListItemProps;
-  'list-row': ListRowProps;
+  'list-row': StandardProps;
   'page': PageProps;
   'scroll-view': ScrollViewProps;
   'text': TextProps;
@@ -43,6 +47,7 @@ export interface IntrinsicElements {
   'raw-text': StandardProps & { text: number | string };
   'input': InputProps;
   'textarea': TextAreaProps;
+  'frame': FrameProps;
 }
 
 declare module 'react' {
@@ -57,7 +62,7 @@ declare module 'react' {
       'inline-truncation': NoProps;
       'list': ListProps;
       'list-item': ListItemProps;
-      'list-row': ListRowProps;
+      'list-row': StandardProps;
       'page': PageProps;
       'scroll-view': ScrollViewProps;
       'text': TextProps;
@@ -65,6 +70,7 @@ declare module 'react' {
       'raw-text': StandardProps & { text: number | string };
       'input': InputProps;
       'textarea': TextAreaProps;
+      'frame': FrameProps;
     }
   }
 }

package/types/common/element/frame.d.ts

@@ -0,0 +1,25 @@
+// 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.
+
+import { StandardProps } from '../props';
+
+export interface FrameProps extends StandardProps {
+  /**
+   * Sets the loading path for the frame resource.
+   * @defaultValue undefined
+   * @iOS
+   * @Android
+   * @since 3.4
+   */
+  src: string;
+
+  /**
+   * Passes data to the nested Lynx page within the frame.
+   * @defaultValue undefined
+   * @iOS
+   * @Android
+   * @since 3.4
+   */
+  data?: Record<string, unknown> | undefined;
+}

package/types/common/element/image.d.ts

@@ -11,7 +11,11 @@ import { StandardProps } from '../props';
 export interface ImageProps extends StandardProps {
   /**
    * Supports http/https/base64
-   * @defaultValue ""
+   * @defaultValue undefined
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   src?: string;
@@ -22,81 +26,108 @@ export interface ImageProps extends StandardProps {
    * aspectFit: Scales the image while preserving aspect ratio so that the long side is fully visible
    * aspectFill: Scales the image while preserving aspect ratio, ensuring the short side fills the element
    * center: Does not scale the image; image is centered
-   * @defaultValue "scaleToFill"
+   * @defaultValue 'scaleToFill'
    * @since 0.2
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    */
   mode?: 'scaleToFill' | 'aspectFit' | 'aspectFill' | 'center';
 
   /**
    * ARGB_8888: 32-bit memory per pixel, supports semi-transparent images
    * RGB_565: 16-bit memory per pixel, reduces memory usage but loses transparency
+   * Support PC platform since 3.5
    * @defaultValue "ARGB_8888"
+   * @Android
+   * @PC
    * @since 1.4
    */
   'image-config'?: 'ARGB_8888' | 'RGB_565';
 
   /**
    * Placeholder image, used same as src
-   * @defaultValue ""
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 1.4
    */
   placeholder?: string;
 
   /**
    * Image blur radius
-   * @defaultValue "3px"
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   'blur-radius'?: string;
 
   /**
    * Stretchable area for 9patch images, in percentage or decimal, four values for top, right, bottom, left
-   * @defaultValue "0.2 10% 0.3 20%"
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 1.4
    */
   'cap-insets'?: string;
 
   /**
-   * Number of times an animated image plays
+   * Adjust the scale of stretchable area for 9patch images
    * @defaultValue 1
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
+   * @since 1.4
+   */
+  'cap-insets-scale'?: number;
+
+  /**
+   * Number of times an animated image plays, 0 stands for infinite 
+   * @defaultValue 0
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 1.4
    */
   'loop-count'?: number;
 
   /**
    * Image won't load if its size is 0, but will load if prefetch-width is set
-   * @defaultValue "100px"
+   * @defaultValue "0px"
+   * @deprecated
+   * @iOS
+   * @Android
    * @since 1.4
    */
   'prefetch-width'?: string;
 
   /**
    * Image won't load if its size is 0, but will load if prefetch-height is set
-   * @defaultValue "100px"
+   * @defaultValue "0px"
+   * @deprecated
+   * @iOS
+   * @Android
    * @since 1.4
    */
   'prefetch-height'?: string;
 
-  /**
-   * If true, URL mapping is skipped. LynxView's custom ImageInterceptor won't work
-   * @defaultValue false
-   * @since 1.5
-   */
-  'skip-redirection'?: boolean;
-
-  /**
-   * Reduces the chance of OOM by downsampling large images, requires container support
-   * @defaultValue false
-   * @since iOS 2.0
-   */
-  downsampling?: boolean;
-
   /**
    * When set to true and the <image> element has no width or height,
    * the size of the <image> will be automatically adjusted
    * to match the image's original dimensions after the image is successfully loaded,
    * ensuring that the aspect ratio is maintained.
    * @defaultValue false
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 2.6
    */
   'auto-size'?: boolean;
@@ -106,6 +137,10 @@ export interface ImageProps extends StandardProps {
    * The default behavior is to clear the image resource before starting a new load.
    * This can resolve flickering issues when the image src is switched and reloaded. It is not recommended to enable this in scenarios where there is node reuse in views like lists.
    * @defaultValue false
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 2.7
    */
   'defer-src-invalidation'?: boolean;
@@ -113,75 +148,42 @@ export interface ImageProps extends StandardProps {
   /**
    * Specifies whether the animated image should start playing automatically once it is loaded.
    * @defaultValue true
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 2.11
    */
   'autoplay'?: boolean;
 
-  /**
-   * Image animation property. If set to false, images will not be cached. Each image will be discarded by default after use,
-   * which is suitable for scenarios where the animation needs to play only once.
-   * @defaultValue true
-   * @iOS
-   * @since 3.4
-   */
-  'ios-frame-cache-automatically'?: boolean;
-
   /**
    * Changes the color of all non-transparent pixels to the tint-color specified. The value is a <color>.
-   * @defaultValue ""
+   * @iOS
+   * @Android
+   * @Harmony
    * @since 2.12
    */
   'tint-color'?: string;
 
-  /**
-   * Support outputting image monitoring information in bindload
-   * @defaultValue false
-   * @since 2.12
-   */
-  'extra-load-info'?: boolean;
-
-  /**
-   * Disables unexpected iOS built-in animations
-   * @defaultValue true
-   * @since iOS 2.0
-   */
-  'implicit-animation'?: boolean;
-
-  /**
-   * Add custom parameters to image
-   * @since 2.17
-   */
-  'additional-custom-info'?: { [key: string]: string };
-
   /**
    * Image load success event
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   bindload?: (e: LoadEvent) => void;
 
   /**
    * Image load error event
+   * @iOS
+   * @Android
+   * @Harmony
+   * @PC
    * @since 0.2
    */
   binderror?: (e: ErrorEvent) => void;
-
-  /**
-   * The animation will call back when it starts playing.
-   * @since 2.11
-   */
-  bindstartplay?: (e: BaseEvent) => void;
-
-  /**
-   * Call back after one loop time of the animation is played.
-   * @since 2.11
-   */
-  bindcurrentloopcomplete?: (e: BaseEvent) => void;
-
-  /**
-   * It will be called after the animation has been played for all loop-count times. If the loop-count is not set, it will not be called back.
-   * @since 2.11
-   */
-  bindfinalloopcomplete?: (e: BaseEvent) => void;
 }
 
 export type LoadEvent = BaseEvent<'load', ImageLoadEvent>;
@@ -189,8 +191,10 @@ export type ErrorEvent = BaseEvent<'error', ImageErrorEvent>;
 
 /**
  * Restart the animation playback method controlled by the front end, and the animation playback progress and loop count will be reset.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @deprecated Deprecated. Some scenarios may not call back the call result. It is recommended to use resumeAnimation instead.
  */
 export interface ImageStartAnimMethod extends BaseMethod {
@@ -199,8 +203,10 @@ export interface ImageStartAnimMethod extends BaseMethod {
 
 /**
  * Resumes the animation, without resetting the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImageResumeAnimMethod extends BaseMethod {
@@ -209,8 +215,10 @@ export interface ImageResumeAnimMethod extends BaseMethod {
 
 /**
  * Pauses the animation, without resetting the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImagePauseAnimMethod extends BaseMethod {
@@ -219,8 +227,10 @@ export interface ImagePauseAnimMethod extends BaseMethod {
 
 /**
  * Stops the animation, and it will reset the loop-count.
- * @Android
  * @iOS
+ * @Android
+ * @Harmony
+ * @PC
  * @since 2.11
  */
 export interface ImageStopAnimMethod extends BaseMethod {

package/types/common/element/index.d.ts

@@ -6,6 +6,7 @@ export * from './component';
 export * from './filter-image';
 export * from './image';
 export * from './list';
+export * from './list-item';
 export * from './page';
 export * from './scroll-view';
 export * from './text';
@@ -16,3 +17,4 @@ export * from './element';
 export * from './methods';
 export * from './attributes';
 export * from './common';
+export * from './frame';

package/types/common/element/input.d.ts

@@ -128,7 +128,7 @@ export interface InputProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'
    */
   maxlength?: number;
   /**
-   * Interaction enabled
+   * Readonly
    * @defaultValue false
    * @Android
    * @iOS
@@ -137,7 +137,15 @@ export interface InputProps extends Omit<StandardProps, 'bindfocus' | 'bindblur'
    * @since 3.4
    */
   readonly?: boolean;
-
+  /**
+   * Interaction enabled
+   * @defaultValue false
+   * @Android
+   * @iOS
+   * @Harmony
+   * @since 3.5
+   */
+  disabled?: boolean;
   /**
    * Show soft input keyboard while focused
    * @defaultValue true