@lynx-js/types 0.0.1 → 3.2.0

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# CHANGELOG
+
+## 3.2.0
+
+### Major Changes
+
+- Rename @lynx-dev/types to @lynx-js/types
+
+## 1.0.15
+
+### Patch Changes
+
+- Refine the related type of event
+
+## 1.0.14
+
+### Patch Changes
+
+- Support nestedScrollOptions for hm
+
+## 1.0.10
+
+### Patch Changes
+
+- Support lynx.queueMicrotask
+
+## 1.0.5
+
+### Patch Changes
+
+- Format the error code of dynamic component with new ErrorCodeFormat
+
+## 1.0.4
+
+### Patch Changes
+
+- Export common scrollEvent in type-lynx.
+
+## 1.0.3
+
+### Patch Changes
+
+- Add new Trace API `lynx.performance.isProfileRecording` to minimizes the performance overhead.
+
+## 1.0.2
+
+### Patch Changes
+
+- Support `inline-truncation` element.
+
+## 1.0.1
+
+### Major Changes
+
+- Add all lynx public api on this packages.

package/README.md

@@ -0,0 +1,56 @@
+# Introduction
+
+@lynx-js/types is a type package of all public APIs officially provided by the Lynx team. Using this package can help you better use Lynx APIs to develop your applications.
+
+# Implementation
+
+There are three pieces of content in the entire package, namely:
+ 
+1. background-thread
+2. main-thread
+3. common
+
+These three sections contain all of Lynx's publicly available features:
+
+1. The **background-thread** contains all the APIs that can be used in the background-thread runtime, including animation functions, the lynx family of APIs, NativeModules, and so on.
+2. **main-thread** is the API that can only be called in the main thread, and contains worklet-related functions. Be careful when using this part of the API, as it is called in the main thread, and evaluate the performance impact carefully.
+3. **common** are all the APIs common to **background-thread** and **main-thread**, such as setting attributes for element, event listening, and so on.
+
+# Usage
+
+## For Framework Developers
+
+```json
+"peerDependencies": {
+  "@lynx-js/types": "latest"
+}
+```
+
+## For Product Developers
+
+```json
+"devDependencies": {
+  "@lynx-js/types": "latest"
+}
+```
+
+After installing the dependencies, you can use them directly, for example:
+
+```typescript
+import { ListProps } from '@lynx-js/types';
+let prop: ListProps;
+```
+
+If you need to extend the type, for example, GlobalProps, each business will be extended according to its own type, and can be extended like this:
+
+```typescript
+declare module '@lynx-js/types' {
+  interface GlobalProps {
+     foo: string;
+     bar: number;
+  }
+}
+```
+
+Once extended, it can be used anywhere in the package.
+

package/package.json

@@ -1,11 +1,58 @@
 {
   "name": "@lynx-js/types",
-  "version": "0.0.1",
-  "main": "index.js",
+  "version": "3.2.0",
+  "description": "",
+  "keywords": ["lynx" , "types"],
+  "license": "Apache-2.0",
+  "author": "Lynx Authors",
+  "types":"types/index.d.ts",
+  "main": "types/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": ""
   },
-  "author": "",
-  "license": "ISC",
-  "description": ""
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts"
+    },
+    "./background": {
+      "types": "./types/background-thread/index.d.ts"
+    },
+    "./main-thread": {
+      "types": "./types/main-thread/index.d.ts"
+    },
+    "./common": {
+      "types": "./types/common/index.d.ts"
+    },
+    "./element": {
+      "types": "./types/common/element/index.d.ts"
+    },
+    "./events": {
+      "types": "./types/common/events.d.ts"
+    },
+    "./props": {
+      "types": "./types/common/props.d.ts"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "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"]
+    }
+  },
+  "files": [
+    "types/",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "csstype": "3.1.3"
+  },
+  "devDependencies": {
+    "tsd": "0.30.4"
+  }
 }

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

@@ -0,0 +1,47 @@
+// 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.
+
+export interface AnimationElement {
+  // keyframes: see https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats
+  //  Either an array of keyframe objects, or a keyframe object whose property are arrays of values to iterate over. See Keyframe Formats for more details.
+  //
+  // timingOptions: see https://developer.mozilla.org/en-US/docs/Web/API/Element/animate
+  //  id Optional: A property unique to animate(): a DOMString with which to reference the animation.
+  //  delay Optional: The number of milliseconds to delay the start of the animation. Defaults to 0.
+  //  direction Optional: Whether the animation runs forwards (normal), backwards (reverse), switches direction after each iteration (alternate), or runs backwards and switches direction after each iteration (alternate-reverse). Defaults to "normal".
+  //  duration Optional: The number of milliseconds each iteration of the animation takes to complete. Defaults to 0. Although this is technically optional, keep in mind that your animation will not run if this value is 0.
+  //  easing Optional: The rate of the animation's change over time. Accepts the pre-defined values "linear", "ease", "ease-in", "ease-out", and "ease-in-out", or a custom "cubic-bezier" value like "cubic-bezier(0.42, 0, 0.58, 1)". Defaults to "linear".
+  //  endDelay Optional: The number of milliseconds to delay after the end of an animation. This is primarily of use when sequencing animations based on the end time of another animation. Defaults to 0.
+  //  fill Optional: Dictates whether the animation's effects should be reflected by the element(s) prior to playing ("backwards"), retained after the animation has completed playing ("forwards"), or both. Defaults to "none".
+  //  iterationStart Optional: Describes at what point in the iteration the animation should start. 0.5 would indicate starting halfway through the first iteration for example, and with this value set, an animation with 2 iterations would end halfway through a third iteration. Defaults to 0.0.
+  // iterations Optional: The number of times the animation should repeat. Defaults to 1, and can also take a value of Infinity to make it repeat for as long as the element exists.
+  animate(keyframes: Array<Record<string, any>>, timingOptions: Record<string, any>): Animation;
+
+  playAnimate(ani: Animation): void;
+
+  pauseAnimate(ani: Animation): void;
+
+  cancelAnimate(ani: Animation): void;
+
+  finishAnimate(ani: Animation): void;
+
+  setProperty(propsObj: string | Record<string, string>, propsVal?: string): void;
+}
+
+export interface KeyframeEffect {
+  readonly target: AnimationElement;
+  readonly keyframes: Array<Record<string, any>>;
+  readonly options: Record<string, any>;
+}
+
+export interface Animation {
+  readonly effect: KeyframeEffect;
+  readonly id: string;
+
+  cancel(): void;
+
+  pause(): void;
+
+  play(): void;
+}

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

@@ -0,0 +1,28 @@
+// 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 { LynxSetTimeout } from '../common';
+import { AnimationElement } from './animation';
+import { EventEmitter } from './event';
+import { NodesRef } from './nodes-ref';
+
+/**
+ * @description LynxRuntimeCommonMethod is the public interface that app context implements
+ */
+export interface LynxRuntimeCommonMethod {
+  setTimeout: LynxSetTimeout;
+  setInterval: LynxSetTimeout;
+  clearTimeout(timeoutId: number): void;
+  clearInterval(intervalId: number): void;
+  getNodeRef(id: string): NodesRef;
+  GlobalEventEmitter: EventEmitter;
+  getJSModule(name: string): EventEmitter;
+  getElementById(id: string): AnimationElement;
+  selectComponent(name: string, completeCb: (...args: any[]) => void): void;
+}
+
+export interface LynxComponentRuntimeMethod extends LynxRuntimeCommonMethod {
+  triggerEvent(evtName: string, ...evtPrams: any[]): void;
+  getNodeRefFromRoot(id: string): NodesRef;
+}

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

@@ -0,0 +1,97 @@
+// 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.
+
+export interface EventEmitter {
+  addListener(eventName: string, listener: (...args: unknown[]) => void, context?: object): void;
+
+  removeListener(eventName: string, listener: (...args: unknown[]) => void): void;
+
+  emit(eventName: string, data: unknown): void;
+
+  removeAllListeners(eventName?: string): void;
+
+  trigger(eventName: string, params: string | Record<any, any>): void;
+
+  toggle(eventName: string, ...data: unknown[]): void;
+}
+
+export type GlobalEventEmitter = EventEmitter;
+
+export interface BeforePublishEvent extends EventEmitter {
+  add(eventName: string, callback: (...args: unknown[]) => void, context?: object): BeforePublishEvent;
+
+  remove(eventName: string, callback: (...args: unknown[]) => void): BeforePublishEvent;
+}
+
+export interface RelativeToMargins {
+  bottom?: number;
+  left?: number;
+  right?: number;
+  top?: number;
+}
+
+export interface BoundingClientRectResult {
+  bottom: number;
+  height: number;
+  left: number;
+  right: number;
+  top: number;
+  width: number;
+}
+
+export interface IntersectionRectResult {
+  bottom: number;
+  height: number;
+  left: number;
+  right: number;
+  top: number;
+  width: number;
+}
+
+export interface RelativeRectResult {
+  bottom: number;
+  left: number;
+  right: number;
+  top: number;
+}
+
+export interface RectResult {  
+  top: number;
+  right: number;
+  bottom: number;
+  left: number;
+}
+
+export interface ObserveCallbackResult {
+  isIntersecting: boolean;
+  intersectionRatio: number;
+  intersectionRect: RectResult;
+  boundingClientRect: RectResult;
+  relativeRect: RectResult;
+  observerId: string;
+  time: number;
+}
+
+export type ObserveCallback = (result: ObserveCallbackResult) => void;
+
+export interface RelativeToViewportMargins {
+  top?: number;
+  right?: number;
+  bottom?: number;
+  left?: number;
+}
+
+export interface IntersectionObserver {
+  relativeTo(selector: string, margins?: RelativeToMargins): IntersectionObserver;
+
+  relativeToViewport(margins?: RelativeToViewportMargins): IntersectionObserver;
+
+  relativeToScreen(margins?: RelativeToViewportMargins): IntersectionObserver;
+
+  observe(selector: string, callback: ObserveCallback): void;
+
+  disconnect(): void;
+
+  invokeCallback(callbackId: number, data: Record<string, any>): void;
+}

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

@@ -0,0 +1,152 @@
+// 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.
+/**
+ * @description Http Body
+ * @since 2.18
+ */
+export interface Body {
+  /**
+   * @description body used
+   * @see https://developer.mozilla.org/docs/Web/API/Request/bodyUsed
+   * @since 2.18
+   */
+  readonly bodyUsed: boolean;
+  /**
+   * @description arrayBuffer()
+   * @see https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer
+   * @since 2.18
+   */
+  arrayBuffer(): Promise<ArrayBuffer>;
+  /**
+   * @description json()
+   * @see https://developer.mozilla.org/docs/Web/API/Request/json
+   * @since 2.18
+   */
+  json(): Promise<any>;
+  /**
+   * @description text()
+   * @see https://developer.mozilla.org/docs/Web/API/Request/text
+   * @since 2.18
+   */
+  text(): Promise<string>;
+}
+
+/**
+ * @description This Fetch API interface represents a resource request.
+ * @see https://developer.mozilla.org/docs/Web/API/Request
+ * @since 2.18
+ */
+export interface Request extends Body {
+  /**
+   * @description Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.
+   * @see https://developer.mozilla.org/docs/Web/API/Request/headers
+   * @since 2.18
+   */
+  readonly headers: Headers;
+  /**
+   * @description Returns request's HTTP method, which is "GET" by default.
+   * @see https://developer.mozilla.org/docs/Web/API/Request/method
+   * @since 2.18
+   */
+  readonly method: string;
+  /**
+   * @description Returns the URL of request as a string.
+   * @see https://developer.mozilla.org/docs/Web/API/Request/url
+   * @since 2.18
+   */
+  readonly url: string;
+  /**
+   * @description clone()
+   * @see https://developer.mozilla.org/docs/Web/API/Request/clone
+   * @since 2.18
+   */
+  clone(): Request;
+}
+
+/**
+ * @description This Fetch API interface represents a resource request.
+ * @see https://developer.mozilla.org/docs/Web/API/Request
+ * @since 2.18
+ */
+export declare var Request: {
+  prototype: Request;
+  new (input: RequestInfo | URL, init?: RequestInit): Request;
+};
+
+/**
+ * @description This Fetch API interface represents the response to a request.
+ * @see https://developer.mozilla.org/docs/Web/API/Response
+ * @since 2.18
+ */
+export interface RequestInit {
+  /**
+   * @description A BodyInit object or null to set request's body.
+   * @since 2.18
+   */
+  body?: BodyInit | null;
+  /**
+   * @description A Headers object, an object literal, or an array of two-item arrays to set request's headers.
+   * @since 2.18
+   */
+  headers?: HeadersInit;
+  /**
+   * @description A string to set request's method.
+   * @since 2.18
+   */
+  method?: string;
+}
+
+/**
+ * @description This Fetch API interface represents the response to a request.
+ * @see https://developer.mozilla.org/docs/Web/API/Response
+ * @since 2.18
+ */
+export interface Response extends Body {
+  /**
+   * @description headers
+   * @see https://developer.mozilla.org/docs/Web/API/Response/headers
+   * @since 2.18
+   */
+  readonly headers: Headers;
+  /**
+   * @description ok
+   * @see https://developer.mozilla.org/docs/Web/API/Response/ok
+   * @since 2.18
+   */
+  readonly ok: boolean;
+  /**
+   * @description status
+   * @see https://developer.mozilla.org/docs/Web/API/Response/status
+   * @since 2.18
+   */
+  readonly status: number;
+  /**
+   * @description statusText
+   * @see https://developer.mozilla.org/docs/Web/API/Response/statusText
+   * @since 2.18
+   */
+  readonly statusText: string;
+  /**
+   * @description url
+   * @see https://developer.mozilla.org/docs/Web/API/Response/url
+   * @since 2.18
+   */
+  readonly url: string;
+  /**
+   * @description clone()
+   * @see https://developer.mozilla.org/docs/Web/API/Response/clone
+   * @since 2.18
+   */
+  clone(): Response;
+}
+
+/**
+ * @description This Fetch API interface represents the response to a request.
+ * @see https://developer.mozilla.org/docs/Web/API/Response
+ * @since 2.18
+ */
+export declare var Response: {
+  prototype: Response;
+  new (body?: BodyInit | null, init?: ResponseInit): Response;
+};

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

@@ -0,0 +1,11 @@
+// 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.
+export * from './animation';
+export * from './app';
+export * from './event';
+export * from './lynx';
+export * from './nodes-ref';
+export * from './performance';
+export * from './native-modules';
+export * from './lynx-performance-entry';

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

@@ -0,0 +1,83 @@
+// 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.
+export interface PerformanceEntry {
+    name: string;
+    entryType: string;
+}
+
+export interface FrameworkPipelineTiming {
+}
+
+export interface PipelineEntry extends PerformanceEntry {
+    identifier: string;
+    pipelineStart: number;
+    pipelineEnd: number;
+    mtsRenderStart: number;
+    mtsRenderEnd: number;
+    resolveStart: number;
+    resolveEnd: number;
+    layoutStart: number;
+    layoutEnd: number;
+    paintingUiOperationExecuteStart: number;
+    paintingUiOperationExecuteEnd: number;
+    layoutUiOperationExecuteStart: number;
+    layoutUiOperationExecuteEnd: number;
+    paintEnd: number;
+    frameworkPipelineTiming: FrameworkPipelineTiming[keyof FrameworkPipelineTiming];
+}
+
+export interface LoadBundleEntry extends PipelineEntry {
+    loadBundleStart: number;
+    loadBundleEnd: number;
+    parseStart: number;
+    parseEnd: number;
+    loadBackgroundStart: number;
+    loadBackgroundEnd: number;
+}
+
+export interface InitContainerEntry extends PerformanceEntry {
+    openTime: number;
+    containerInitStart: number;
+    containerInitEnd: number;
+    prepareTemplateStart: number;
+    prepareTemplateEnd: number;
+    extraTiming: Record<string, number>;
+}
+
+export interface InitLynxviewEntry extends PerformanceEntry {
+    createLynxStart: number;
+    createLynxEnd: number;
+}
+
+export interface InitBackgroundRuntimeEntry extends PerformanceEntry {
+    loadCoreStart: number;
+    loadCoreEnd: number;
+}
+
+export interface PerformanceMetric {
+    name: string;
+    duration: number;
+    startTimestampName: string;
+    startTimestamp: number;
+    endTimestampName: string;
+    endTimestamp: number;
+}
+
+export interface MetricFcpEntry extends PerformanceEntry {
+    fcp: PerformanceMetric;
+    lynxFcp: PerformanceMetric;
+    totalFcp: PerformanceMetric;
+}
+
+export interface MetricTtiEntry extends PerformanceEntry {
+    tti: PerformanceMetric;
+    lynxTti: PerformanceMetric;
+    totalTti: PerformanceMetric;
+}
+
+export interface MetricActualFmpEntry extends PerformanceEntry {
+    actualFmp: PerformanceMetric;
+    lynxActualFmp: PerformanceMetric;
+    totalActualFmp: PerformanceMetric;
+}