@lynx-js/types 0.0.1 → 3.2.1

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 FrameworkRenderingTiming {
+}
+
+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;
+    frameworkRenderingTiming: FrameworkRenderingTiming[keyof FrameworkRenderingTiming];
+}
+
+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;
+}

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

@@ -0,0 +1,157 @@
+// 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 { CommonLynx, GlobalProps } from '../common';
+import { AnimationElement } from './animation';
+import { BeforePublishEvent, GlobalEventEmitter, IntersectionObserver } from './event';
+import { SelectorQuery } from './nodes-ref';
+import { Performance } from './performance';
+import { Response } from './fetch';
+
+export * from './fetch';
+
+export interface LoadDynamicComponentSuccessResult {
+  code: 0;
+  detail?: {
+    schema: string;
+    errMsg: '';
+    cache: boolean;
+  };
+}
+
+export interface LoadDynamicComponentFailedResult {
+  // E_DYNAMIC_COMPONENT_LOAD_BAD_RESPONSE = 160102,
+  // E_DYNAMIC_COMPONENT_LOAD_EMPTY_FILE = 160102,
+  // E_DYNAMIC_COMPONENT_LOAD_DECODE_FAIL = 160103,
+  code: 160101 | 160102 | 160103;
+  detail?: {
+    url: string;
+    errMsg: string;
+  };
+}
+
+export type LoadDynamicComponentFunc = {
+  (url: string, options?: Record<string, any>): Promise<LoadDynamicComponentSuccessResult | LoadDynamicComponentFailedResult>;
+  (id: string | string[], url: string, options?: Record<string, any>): Promise<LoadDynamicComponentSuccessResult | LoadDynamicComponentFailedResult>;
+};
+
+//TODO(liyanbo.monster): migrate component type.
+export type CreateIntersectionObserverFunc = (
+  component: unknown,
+  options?: {
+    thresholds?: [];
+    initialRatio?: number;
+    observeAll?: boolean;
+  }
+) => IntersectionObserver;
+
+export interface ResourcePrefetchData {
+  data: {
+    uri: string;
+    type: 'image' | 'video';
+    param?: {
+      priority?: 'high' | 'medium' | 'low';
+      cacheTarget?: 'disk' | 'bitmap';
+      preloadKey?: string;
+      size: number;
+    };
+  }[];
+}
+
+export interface ResourcePrefetchResult {
+  code: number;
+  msg: string;
+  details: {
+    code: number;
+    msg: string;
+    uri: string;
+    type: 'image' | 'video';
+  }[];
+}
+
+export type GetElementByIdFunc = (id: string) => AnimationElement;
+
+/**
+ * Lynx provide `background-thread lynx` public api.
+ */
+export interface Lynx extends CommonLynx {
+  /**
+   * @description Properties inside `lynx.__globalProps` is NOT managed by Lynx, so you MUST extends this interface yourself
+   * @see https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+   */
+  __globalProps: GlobalProps;
+  __presetData: Record<string, unknown>; // readonly data injected by client via LynxBackgroundRuntimeOptions
+
+  performance: Performance;
+
+  beforePublishEvent: BeforePublishEvent;
+
+  getElementById: GetElementByIdFunc;
+
+  // cancelAnimationFrame(animationId: number): void;
+
+  // requestAnimationFrame(callback: () => void): number;
+
+  cancelResourcePrefetch(data: ResourcePrefetchData, callback: (res: ResourcePrefetchResult) => void): void;
+
+  createIntersectionObserver: CreateIntersectionObserverFunc;
+
+  createSelectorQuery(): SelectorQuery;
+
+  getJSModule<Module = unknown>(name: string): Module;
+
+  getJSModule(name: 'GlobalEventEmitter'): GlobalEventEmitter;
+
+  setSharedData<T>(dataKey: string, dataVal: T): void;
+  getSharedData<T = unknown>(dataKey: string): T;
+
+  loadDynamicComponent: LoadDynamicComponentFunc;
+
+  registerModule<Module extends object>(name: string, module: Module): void;
+
+  registerSharedDataObserver<T>(callback: (data: T) => void): void;
+
+  removeSharedDataObserver<T>(callback: (data: T) => void): void;
+
+  reload(value: object, callback: () => void): void;
+
+  requestResourcePrefetch(data: ResourcePrefetchData, callback: (res: ResourcePrefetchResult) => void): void;
+
+  requireModuleAsync<T>(path: string, callback: (error: Error | null, exports?: T) => void): void;
+
+  /**
+   * @description requireModule 
+   * @param path: the source's path
+   * @param entryName: the resource's entry's name
+   * @param options(@since 3.2): timeout is waiting time,the unit is seconds
+   * @since 1.0
+   */
+  requireModule<T>(path: string, entryName?: string, options?: {timeout: number }): T;
+
+  resumeExposure(): void;
+  stopExposure(options?: { sendEvent: boolean }): void;
+
+  setObserverFrameRate(options?: { forPageRect?: number; forExposureCheck?: number }): void;
+
+  /**
+   * @description subset of Fetch API
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+   * @since 2.18
+   */
+  fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+
+  /**
+   * @description queue microtask
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/queueMicrotask
+   * @since 3.1
+   */ 
+  queueMicrotask(callback: () => void): void;
+
+  /**
+   * @description Callback when an error occurs
+   * @since 1.0
+   */
+  onError?: (error: Error) => void;
+
+}

package/types/background-thread/native-modules.d.ts

@@ -0,0 +1,21 @@
+// 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 { AnyObject } from '../common';
+import { NODE_REF_INVOKE_ERROR_CODE } from './nodes-ref';
+
+export interface NativeModules {
+  LynxUIMethodModule?: {
+    invokeUIMethod?(componentId: string, ancestors: string[], method: string, params: AnyObject, callback: (res: { code: NODE_REF_INVOKE_ERROR_CODE }) => void): void;
+  };
+  NetworkingModule?: any;
+  LynxTestModule?: any;
+
+  [key: string]: any;
+
+  bridge: {
+    call: (name: string, params: Record<string, unknown>, cb: (...args: unknown[]) => void) => void;
+    on: (name: string, cb: (...args: unknown[]) => void) => void;
+  };
+}

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

@@ -0,0 +1,110 @@
+// 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 { AnyObject } from '../common';
+
+export enum NODE_REF_INVOKE_ERROR_CODE {
+  SUCCESS = 0,
+  UNKNOWN = 1,
+  NODE_NOT_FOUND = 2,
+  METHOD_NOT_FOUND = 3,
+  PARAM_INVALID = 4, // Determined by the implementer of the component.
+  SELECTOR_NOT_SUPPORTED = 5, // Currently only supports ID selectors.
+}
+
+export interface uiMethodOptions {
+  method: string;
+  params?: AnyObject;
+  success?(res: any): void;
+  fail?(res: { code: NODE_REF_INVOKE_ERROR_CODE; data?: any }): void;
+}
+
+export interface uiFieldsOptions {
+  id?: boolean;
+  dataset?: boolean;
+  tag?: boolean;
+  query?: boolean;
+  unique_id?: boolean;
+}
+
+export interface PathData {
+  data: Array<{
+    tag: string;
+    id: string;
+    class: string[];
+    dataSet: Record<string, unknown>;
+    // index of parent's children
+    index: number;
+  }>;
+}
+
+export interface FieldsParams {
+  id?: boolean;
+  dataset?: boolean;
+  tag?: boolean;
+  index?: boolean;
+  class?: boolean;
+  attribute?: boolean;
+}
+
+export interface FieldsData {
+  id: string;
+  tag: string;
+  dataset: Record<string, unknown>;
+  index: number;
+  class: Array<string>;
+  attribute: Record<string, unknown>;
+}
+
+export type PathCallback = (data: PathData, status: { data: string; code: number }) => void;
+
+export interface NodesRef {
+  invoke(options: uiMethodOptions): SelectorQuery;
+
+  path(callback: PathCallback): 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;
+
+  setNativeProps(nativeProps: Record<string, any>): SelectorQuery;
+}
+
+export interface SelectorQuery {
+  /**
+   * Selects a single node by CSS selector.
+   * @param selector CSS selector
+   */
+  select(selector: string): NodesRef;
+
+  /**
+   * Selects all nodes satisfying CSS selector.
+   * @param selector CSS selector
+   */
+  selectAll(selector: string): NodesRef;
+
+  /**
+   * Select root node of the component.
+   */
+  selectRoot(): NodesRef;
+
+  // /**
+  //  * Selects a single node by element id.
+  //  * When a touch event is triggered, the element id of the node is passed to the event handler as 'uid',
+  //  * by which can a node be selected in its event handler.
+  //  */
+  // selectUniqueID(uniqueId: string | number): NodesRef;
+
+  /**
+   * Execute all tasks in the task queue.
+   * When `this._fire_immediately` is set to true, this method is called automatically.
+   */
+  exec(): void;
+}

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

@@ -0,0 +1,100 @@
+// 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 { CommonPerformance } from "../common/performance";
+import { PerformanceEntry } from "./lynx-performance-entry";
+
+export interface SetupTimingInfo {
+  create_lynx_start: number;
+  create_lynx_end: number;
+  load_core_start: number;
+  load_core_end: number;
+  load_app_start: number;
+  load_app_end: number;
+  load_template_start: number;
+  load_template_end: number;
+  decode_start: number;
+  decode_end: number;
+  lepus_excute_start: number;
+  lepus_excute_end: number;
+  set_init_data_start: number;
+  set_init_data_end: number;
+  data_processor_start: number;
+  data_processor_end: number;
+  create_vdom_start: number;
+  create_vdom_end: number;
+  dispatch_start: number;
+  dispatch_end: number;
+  layout_start: number;
+  layout_end: number;
+  ui_operation_flush_start: number;
+  ui_operation_flush_end: number;
+  draw_end: number;
+  [key: string]: unknown;
+}
+export interface UpdateTimingInfo {
+  set_state_trigger?: number;
+  create_vdom_start?: number;
+  create_vdom_end?: number;
+  dispatch_start?: number;
+  dispatch_end?: number;
+  layout_start?: number;
+  layout_end?: number;
+  ui_operation_flush_start?: number;
+  ui_operation_flush_end?: number;
+  draw_end: number;
+  [key: string]: unknown;
+}
+export interface ExtraTimingInfo {
+  prepare_template_start?: number;
+  prepare_template_end?: number;
+  container_init_start?: number;
+  container_init_end?: number;
+  open_time?: number;
+  [key: string]: unknown;
+}
+
+export interface MetricsTimingInfo {
+  tti?: number;
+  lynx_tti?: number;
+  total_tti?: number;
+  fcp?: number;
+  lynx_fcp?: number;
+  total_fcp?: number;
+  actual_fmp?: number;
+  lynx_actual_fmp?: number;
+  total_actual_fmp?: number;
+  [key: string]: unknown;
+}
+export interface TimingInfo {
+  extra_timing: ExtraTimingInfo;
+  setup_timing: SetupTimingInfo;
+  update_timings: {
+    [key: string]: UpdateTimingInfo;
+  };
+  metrics: MetricsTimingInfo;
+  has_reload: boolean;
+  thread_strategy: number;
+  url: string;
+  [key: string]: unknown;
+}
+export interface TimingListener {
+  onSetup: (info: TimingInfo) => void;
+  onUpdate: (info: TimingInfo) => void;
+}
+
+export interface Performance extends CommonPerformance {
+  addTimingListener(listener: TimingListener): void;
+  removeTimingListener(listener: TimingListener): void;
+  removeAllTimingListener(): void;
+  createObserver(callback: PerformanceCallback): PerformanceObserver;
+}
+
+
+export type PerformanceCallback = (entry: PerformanceEntry) => void;
+export interface PerformanceObserver {
+  observe(name: string[]): void;
+  disconnect(): void;
+  onPerformanceEvent(entry: PerformanceEntry): void
+}

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

@@ -0,0 +1,22 @@
+export interface TextEncoder {
+    encode(str: string): ArrayBuffer;
+    encoding: 'utf-8';
+}
+
+type TypedArray =
+  | Int8Array
+  | Uint8Array
+  | Uint8ClampedArray
+  | Int16Array
+  | Uint16Array
+  | Int32Array
+  | Uint32Array
+  | Float32Array
+  | Float64Array;
+
+export interface TextDecoder {
+    decode(buffer: ArrayBuffer | TypedArray | DataView): string;
+    encoding: 'utf-8';
+    fatal: false;
+    ignoreBOM: true;
+}

package/types/common/console.d.ts

@@ -0,0 +1,14 @@
+// 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 Console {
+  debug(...args: any[]): void;
+  error(...args: any[]): void;
+  group(label?: string): void;
+  groupEnd(): void;
+  info(...args: any[]): void;
+  log(...args: any[]): void;
+  alog(...args: any[]): void;
+  warn(...args: any[]): void;
+}