@lynx-js/types 3.3.0 → 3.3.2

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # CHANGELOG
 
+## 3.5.0
+- Add a new `flowIds` subfield to the TraceOption parameter in the Trace API to support one-to-many trace associations.
+- Refactor event definitions for improved IDE compatibility.
+
+## 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.
+
+## 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` and `enable-dynamic-span-count` property for list.
+
+## 3.4.2
+- And `lynx.fetchBundle` api defines.
+- And `ResponseHandler` defines.
+
+## 3.4.1
+
+- Add the following properties: `custom-context-menu`, `custom-text-selection`, `text-selection`.
+- Add the following methods: `setTextSelection`, `getTextBoundingRect`, `getSelectedText`.
+- Add `bindselectionchange` event.
+- Add `addFont` method.
+
+## 3.4.0
+
+### Major Changes
+
+- Introduce <input> and <textarea>
+
+## 3.3.2
+- SelectorQuery FieldsParams adds query attribute
+- Revert automatically generated cssTypes
+- Add typing for the runtime interfaces.
+- 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.
+- Add typing for MessageEvent.
+
+## 3.3.1
+
+- Codegen csstype.d.ts from css_defines
+- Rename `visibleCellsAfterUpdate` to `visibleItemAfterUpdate` for `list`
+- Rename `visibleCellsBeforeUpdate` to `visibleItemBeforeUpdate` for `list`
+
 ## 3.3.0
 
 ### Major Changes
@@ -12,6 +69,7 @@
 - Add some missing types of built-in element `list`
 - Add some missing types of built-in element `image`
 - Add more events like `LayoutChangeEvent` into `MainThread` namespace
+- Add animate operate function in selectorQuery
 
 In this commit, we add `AnimationEvent`, `TransitionEvent`, `LayoutChangeEvent`, `UIAppearanceEvent` into `MainThread` namespace.
 Now you can use like this:

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@lynx-js/types",
-  "version": "3.3.0",
+  "version": "3.3.2",
   "description": "",
-  "keywords": ["lynx" , "types"],
+  "keywords": [
+    "lynx",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lynx-family/lynx.git"
+  },
   "license": "Apache-2.0",
   "author": "Lynx Authors",
-  "types":"types/index.d.ts",
+  "types": "types/index.d.ts",
   "main": "types/index.d.ts",
   "scripts": {
-    "test": "vitest --typecheck --run & tsc --noEmit"
+    "test": "vitest --typecheck --run && tsc --noEmit"
   },
   "exports": {
     ".": {
@@ -38,11 +45,21 @@
       "background": [
         "./types/background-thread/index.d.ts"
       ],
-      "common": ["./types/common/index.d.ts"],
-      "element": ["./types/common/element/index.d.ts"],
-      "events": ["./types/common/events.d.ts"],
-      "props": ["./types/common/props.d.ts"],
-      "main-thread": ["./types/main-thread/index.d.ts"]
+      "common": [
+        "./types/common/index.d.ts"
+      ],
+      "element": [
+        "./types/common/element/index.d.ts"
+      ],
+      "events": [
+        "./types/common/events.d.ts"
+      ],
+      "props": [
+        "./types/common/props.d.ts"
+      ],
+      "main-thread": [
+        "./types/main-thread/index.d.ts"
+      ]
     }
   },
   "files": [

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

@@ -45,3 +45,13 @@ export interface Animation {
 
   play(): void;
 }
+
+export interface KeyframeEffectV2 {
+  readonly keyframes: Array<Record<string, any>>;
+  readonly options: Record<string, any>;
+}
+
+export interface AnimationV2 {
+  readonly effect: KeyframeEffectV2;
+  readonly id: string;
+}

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

@@ -74,6 +74,10 @@ export declare var 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 +99,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 +142,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

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

@@ -7,12 +7,12 @@ export interface PerformanceEntry {
 }
 
 export interface FrameworkRenderingTiming {
-    vmExecuteStart?: number;
-    vmExecuteEnd?: number;
-    dataProcessorStart?: number;
-    dataProcessorEnd?: number;
-    setInitDataStart?: number;
-    setInitDataEnd?: number;
+    vmExecuteStart: number;
+    vmExecuteEnd: number;
+    dataProcessorStart: number;
+    dataProcessorEnd: number;
+    setInitDataStart: number;
+    setInitDataEnd: number;
 }
 
 export interface FrameworkRenderingTimings {
@@ -34,6 +34,7 @@ export interface PipelineEntry extends PerformanceEntry {
     layoutUiOperationExecuteEnd: number;
     paintEnd: number;
     frameworkRenderingTiming: FrameworkRenderingTimings[keyof FrameworkRenderingTimings] & FrameworkRenderingTiming;
+    hostPlatformTiming: HostPlatformTiming;
 }
 
 export interface LoadBundleEntry extends PipelineEntry {
@@ -43,6 +44,10 @@ export interface LoadBundleEntry extends PipelineEntry {
     parseEnd: number;
     loadBackgroundStart: number;
     loadBackgroundEnd: number;
+    verifyTasmStart: number;
+    verifyTasmEnd: number;
+    ffiStart: number;
+    ffiEnd: number;
 }
 
 export interface InitContainerEntry extends PerformanceEntry {
@@ -79,14 +84,60 @@ export interface MetricFcpEntry extends PerformanceEntry {
     totalFcp: PerformanceMetric;
 }
 
-export interface MetricTtiEntry extends PerformanceEntry {
-    tti: PerformanceMetric;
-    lynxTti: PerformanceMetric;
-    totalTti: PerformanceMetric;
-}
-
 export interface MetricActualFmpEntry extends PerformanceEntry {
     actualFmp: PerformanceMetric;
     lynxActualFmp: PerformanceMetric;
     totalActualFmp: PerformanceMetric;
 }
+
+export interface ReloadBundleEntry extends PipelineEntry {
+    reloadBundleStart: number;
+    reloadBundleEnd: number;
+    reloadBackgroundStart: number;
+    reloadBackgroundEnd: number;
+    ffiStart: number;
+    ffiEnd: number;
+}
+
+export interface MemoryUsageEntry extends PerformanceEntry {
+    sizeBytes: any;
+    detail: Record<string, MemoryUsageItem>;
+}
+
+export interface MemoryUsageItem {
+    category: string;
+    sizeBytes: any;
+    detail: Record<string, string>;
+}
+
+export interface LazyBundleEntry extends PerformanceEntry {
+    componentUrl: string;
+    mode: string;
+    size: number;
+    sync: boolean;
+    loadSuccess: boolean;
+    requireStart: number;
+    requireEnd: number;
+    decodeStart: number;
+    decodeEnd: number;
+}
+
+export interface AndroidHostPlatformTiming {
+    hostPlatformType: 'Android';
+    measureStart: number;
+    measureEnd: number;
+    layoutStart: number;
+    layoutEnd: number;
+    drawStart: number;
+    drawEnd: number;
+}
+
+export interface IOSHostPlatformTiming {
+    hostPlatformType: 'iOS';
+}
+
+export interface HarmonyHostPlatformTiming {
+    hostPlatformType: 'Harmony';
+}
+
+export type HostPlatformTiming = AndroidHostPlatformTiming | IOSHostPlatformTiming | HarmonyHostPlatformTiming

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 } from './fetch';
 
 export * from './fetch';
 
@@ -70,6 +70,11 @@ export interface ResourcePrefetchResult {
   }[];
 }
 
+export interface FontFace {
+  'font-family': string;
+  'src': string;
+}
+
 export type GetElementByIdFunc = (id: string) => AnimationElement;
 
 /**
@@ -150,4 +155,9 @@ export interface Lynx extends CommonLynx {
    */
   onError?: (error: Error) => void;
 
+  /**
+   * @description Dynamic add font
+   * @since 2.12
+   */
+  addFont(fontFace: FontFace, callback?: () => void): void;
 }

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

@@ -3,6 +3,7 @@
 // LICENSE file in the root directory of this source tree.
 
 import { AnyObject } from '../common';
+import { AnimationV2 } from './animation';
 
 export enum NODE_REF_INVOKE_ERROR_CODE {
   SUCCESS = 0,
@@ -46,6 +47,7 @@ export interface FieldsParams {
   index?: boolean;
   class?: boolean;
   attribute?: boolean;
+  query?:boolean;
 }
 
 export interface FieldsData {
@@ -55,6 +57,7 @@ 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;
@@ -74,6 +77,14 @@ export interface NodesRef {
     ) => void
   ): SelectorQuery;
 
+  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;
 }
 

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;
+}

package/types/common/csstype.d.ts

@@ -97,5 +97,37 @@ export type CSSProperties = Modify<
     relativeCenter?: 'none' | 'vertical' | 'horizontal' | 'both';
     linearCrossGravity?: 'none' | 'start' | 'end' | 'center' | 'stretch';
     listMainAxisGap?: 'grayscale' | (string & {});
+    fontVariationSettings?: string;
+    fontFeatureSettings?: string;
+    fontOpticalSizing?: 'none' | 'auto';
   }
 >;
+
+export type Shorthands = 
+  // layout
+  "flexFlow" | "padding" | "margin" | "flex" | "backgroundPosition" |
+  // typography
+  "outline" | "textDecoration" |
+  // visual
+  "border" | "borderRight" | "borderLeft" | "borderTop" | "borderBottom" | "borderRadius" | "borderWidth" | "background" | "borderColor" | "borderStyle" |
+  // animation
+  "transition" | "animation" |
+  // other
+  "mask" | "gap" | "overflow" | "whiteSpace";
+export type Longhands = 
+  // layout
+  "marginInlineStart" | "marginInlineEnd" | "paddingInlineStart" | "paddingInlineEnd" | "gridTemplateColumns" | "gridTemplateRows" | "gridAutoColumns" | "gridAutoRows" | "gridColumnSpan" | "gridRowSpan" | "gridColumnStart" | "gridColumnEnd" | "gridRowStart" | "gridRowEnd" | "gridColumnGap" | "gridRowGap" | "gridAutoFlow" | "maskPosition" | "display" | "paddingLeft" | "paddingRight" | "paddingTop" | "paddingBottom" | "marginLeft" | "marginRight" | "marginTop" | "marginBottom" | "position" | "flexGrow" | "flexShrink" | "flexBasis" | "flexDirection" | "flexWrap" |
+  // typography
+  "outlineColor" | "outlineStyle" | "outlineWidth" | "textDecorationColor" | "linearCrossGravity" | "borderInlineStartColor" | "borderInlineEndColor" | "borderInlineStartWidth" | "borderInlineEndWidth" | "borderInlineStartStyle" | "borderInlineEndStyle" | "relativeAlignInlineStart" | "relativeAlignInlineEnd" | "relativeInlineStartOf" | "relativeInlineEndOf" | "insetInlineStart" | "insetInlineEnd" | "linearDirection" | "textIndent" | "textStroke" | "textStrokeWidth" | "textStrokeColor" | "XAutoFontSize" | "XAutoFontSizePresetSizes" | "fontVariationSettings" | "fontFeatureSettings" | "fontOpticalSizing" | "textAlign" | "lineHeight" | "textOverflow" | "fontSize" | "fontWeight" | "fontFamily" | "fontStyle" | "lineSpacing" | "linearOrientation" | "linearWeightSum" | "linearWeight" | "linearGravity" | "linearLayoutGravity" | "adaptFontSize" | "textShadow" |
+  // visual
+  "borderTopColor" | "backgroundOrigin" | "backgroundRepeat" | "backgroundSize" | "borderBottomColor" | "borderLeftStyle" | "borderRightStyle" | "borderTopStyle" | "borderBottomStyle" | "backgroundClip" | "caretColor" | "borderTopLeftRadius" | "borderBottomLeftRadius" | "borderTopRightRadius" | "borderBottomRightRadius" | "borderStartStartRadius" | "borderEndStartRadius" | "borderStartEndRadius" | "borderEndEndRadius" | "borderLeftWidth" | "borderRightWidth" | "borderTopWidth" | "borderBottomWidth" | "XAnimationColorInterpolation" | "XHandleColor" | "color" | "backgroundColor" | "borderLeftColor" | "borderRightColor" | "backgroundImage" |
+  // 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";
+
+// Since `Shorthands` and `Longhands` are auto generated, there may be properties
+// such as `gridColumnSpan` is not manually defined in `CSSProperties` yet.
+// Use `& keyof CSSProperties` to ensure only the defined keys are included to avoid type error.
+export type CSSPropertiesWithShorthands = Pick<CSSProperties, Shorthands & keyof CSSProperties>;
+export type CSSPropertiesWithLonghands = Pick<CSSProperties, Longhands & keyof CSSProperties>;

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

@@ -10,13 +10,19 @@ import { ImageProps, ImageUIMethods } from './image';
 import { ListItemProps, ListProps, ListRowProps, ListUIMethods } from './list';
 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';
+
 
 export interface UIMethods {
   'list': ListUIMethods;
   'scroll-view': ScrollViewUIMethods;
   'image': ImageUIMethods;
+  'input': InputUIMethods;
+  'textarea': TextAreaUIMethods;
+  'text': TextUIMethods;
 }
 
 type LynxComponentProps = ComponentProps;
@@ -37,6 +43,8 @@ export interface IntrinsicElements {
   'text': TextProps;
   'view': ViewProps;
   'raw-text': StandardProps & { text: number | string };
+  'input': InputProps;
+  'textarea': TextAreaProps;
 }
 
 declare module 'react' {
@@ -57,6 +65,8 @@ declare module 'react' {
       'text': TextProps;
       'view': ViewProps;
       'raw-text': StandardProps & { text: number | string };
+      'input': InputProps;
+      'textarea': TextAreaProps;
     }
   }
 }