@lynx-js/types 0.0.1 → 3.2.0

package/types/common/props.d.ts

@@ -0,0 +1,119 @@
+// 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 { CSSProperties } from './csstype';
+import { LynxEventProps } from './events';
+
+export interface StandardProps extends LynxEventProps {
+  /**  The unique identifier of the component, ensuring the uniqueness of the entire page. */
+  id?: string;
+  /** In React, similar to class, className is generally used as an alias for class.*/
+  className?: string;
+  class?: string;
+  /**  Component Display, All Components Display by Default. */
+  hidden?: boolean;
+  /** Animation Properties */
+  animation?: { actions: Record<string, unknown>[] };
+  /** "flatten" attribute only works for Lynx. */
+  flatten?: boolean;
+  name?: string;
+  overlap?: boolean;
+  enableLayoutOnly?: boolean;
+  cssAlignWithLegacyW3C?: boolean;
+  /**
+   * Accessibility reading content
+   * @Android
+   * @iOS
+   * @spec {@link https://developer.apple.com/documentation/objectivec/nsobject/1615181-accessibilitylabel?language=objc | iOS}
+   * @spec {@link https://developer.android.com/reference/android/view/View.html#setContentDescription(java.lang.CharSequence) | Android}
+   */
+  'accessibility-label'?: string;
+  /**
+   * The combination of accessibility traits that best characterizes the accessibility element.
+   * @defaultValue 'none'
+   * @iOS
+   * @spec {@link https://developer.apple.com/documentation/objectivec/nsobject/1615202-accessibilitytraits?language=objc | iOS}
+   */
+  'accessibility-traits'?:
+    | 'text'
+    | 'image'
+    | 'button'
+    | 'link'
+    | 'header'
+    | 'search'
+    | 'selected'
+    | 'playable'
+    | 'keyboard'
+    | 'summary'
+    | 'disabled'
+    | 'updating'
+    | 'adjustable'
+    | 'tabbar'
+    | 'none';
+  /**
+   * A Boolean value that indicates whether the element is an accessibility element that an assistive app can access.
+   * @iOS
+   * @Android
+   * @spec {@link https://developer.apple.com/documentation/objectivec/nsobject/1615141-isaccessibilityelement?language=objc | iOS}
+   * @spec {@link https://developer.android.com/reference/android/view/View.html#setImportantForAccessibility(int) | Android}
+   */
+  'accessibility-element'?: boolean;
+  /**
+   * A localized string that contains the value of the accessibility element.
+   * @iOS
+   * @Android
+   * @spec {@link https://developer.apple.com/documentation/objectivec/nsobject/1615117-accessibilityvalue?language=objc | iOS}
+   * @spec {@link https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat?hl=en#setStateDescription(java.lang.CharSequence) | Android}
+   */
+  'accessibility-value'?: string;
+  /**
+   * Sets whether the node represents a heading.
+   * @defaultValue false
+   * @Android
+   * @spec {@link https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat?hl=en#setHeading(boolean) | Android}
+   */
+  'accessibility-heading'?: boolean;
+  /**
+   * Sets the class this node comes from, or, sets the custom role description.
+   * @Android
+   * @spec {@link https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat?hl=en#setClassName(java.lang.CharSequence) | Android}
+   * @spec {@link https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat?hl=en#setRoleDescription(java.lang.CharSequence) | Android}
+   */
+  'accessibility-role-description'?: 'switch' | 'checkbox' | 'image' | 'progressbar' | string;
+  /**
+   * The custom actions of the current accessibility element.
+   * @Android
+   * @iOS
+   * @spec {@link https://developer.apple.com/documentation/appkit/nsaccessibility/2869551-accessibilitycustomactions/ | iOS}
+   * @spec {@link https://developer.android.com/reference/androidx/core/view/accessibility/AccessibilityNodeInfoCompat?hl=en#addAction(androidx.core.view.accessibility.AccessibilityNodeInfoCompat.AccessibilityActionCompat) | Android}
+   */
+  'accessibility-actions'?: string[];
+
+  /** Control whether the component can receive focus. Default is false */
+  focusable?: boolean;
+  /** Use two-dimensional coordinates such as "0, 0" to represent the focus priority of the x and y axes respectively. Nodes with the same priority will switch focus based on their position.  */
+  'focus-index'?: string;
+  /** Manually specify the node ID that will receive focus when the user presses the "up" arrow key.  */
+  'next-focus-up'?: string;
+  /** Manually specify the node ID that will receive focus when the user presses the "down" arrow key.  */
+  'next-focus-down'?: string;
+  /** Manually specify the node ID that will receive focus when the user presses the "left" arrow key.*/
+  'next-focus-left'?: string;
+  /**
+   * Manually specify the node id that receives focus when the user presses the "right" arrow key.
+   */
+  'next-focus-right'?: string;
+
+  /**
+   *  Custom Timing Flag
+   * @since Lynx 2.10
+   */
+  __lynx_timing_flag?: string;
+
+  style?: string | CSSProperties;
+}
+
+export interface NoProps {
+  // empty props
+}

package/types/common/system-info.d.ts

@@ -0,0 +1,46 @@
+// 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 type PlatformType = 'Android' | 'iOS';
+
+export interface SystemInfo {
+  /**
+   * The version of the Lynx SDK.
+   * @example '2.4', '2.10'
+   */
+  readonly lynxSdkVersion: string;
+
+  /**
+   * The current operating system version.
+   */
+  readonly osVersion: string;
+
+  /**
+   * The physical pixel height of the real device.
+   */
+  readonly pixelHeight: number;
+
+  /**
+   * The physical pixel width of the real device.
+   */
+  readonly pixelWidth: number;
+
+  /**
+   * The physical pixel ratio of the real device.
+   */
+  readonly pixelRatio: number;
+
+  /**
+   * The platform of the current device.
+   */
+  readonly platform: PlatformType;
+
+  /**
+   * The JavaScript engine currently used.
+   * @note Not available in lepus
+   */
+  readonly runtimeType: 'v8' | 'jsc' | 'quickjs';
+
+  readonly theme?: object;
+}

package/types/index.d.ts

@@ -0,0 +1,8 @@
+// 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 './background-thread';
+export * from './common';
+export * as MainThread from './main-thread';
+export * as Background from './background-thread';

package/types/main-thread/element.d.ts

@@ -0,0 +1,85 @@
+// 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 { CSSProperties } from '../common';
+
+export interface Element {
+  styles: CSSProperties;
+  attributes: Record<string, any>;
+  scrollBy: (
+    width: number,
+    height: number
+  ) => {
+    consumedX: number;
+    consumedY: number;
+    unconsumedX: number;
+    unconsumedY: number;
+  };
+  getBoundingClientRect: () => {
+    width: number;
+    height: number;
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+  };
+
+  /**
+   * Set an attribute.
+   * @param attributeName The name of the attribute.
+   * @since Lynx 2.14
+   */
+  getAttribute(attributeName: string): any;
+
+  /**
+   * Get all attribute names as an array.
+   * @since Lynx 2.14
+   */
+  getAttributeNames(): string[];
+
+  /**
+   * Set an attribute.
+   * @param name The name of the attribute to set.
+   * @param value The value to set.
+   * @since Lynx 2.14
+   */
+  setAttribute(name: string, value: any): void;
+
+  /**
+   * Set a style property.
+   * @param name The name of the style property, in kebab-case.
+   * @param value The value of the property.
+   * @since Lynx 2.14
+   */
+  setStyleProperty(name: string, value: string): void;
+
+  /**
+   * Set a list of style properties.
+   * @param styles The object containing key-value pair of the style properties to set, name of the property in kebab-case.
+   * @since Lynx 2.14
+   */
+  setStyleProperties(styles: Record<string, string>): void;
+
+  /**
+   * Select the first element matching the given CSS selector in this element's children.
+   * @param selector CSS Selector string.
+   * @since Lynx 2.14
+   */
+  querySelector(selector: string): Element | null;
+
+  /**
+   * Select all the elements matching the given CSS selector in this element's children.
+   * @param selector CSS Selector string.
+   * @since Lynx 2.14
+   */
+  querySelectorAll(selector: string): Element[];
+
+  /**
+   * Invoke a UI method.
+   * @param methodName The UI method to invoke.
+   * @param params Params of the UI method.
+   * @since Lynx 2.14
+   */
+  invoke(methodName: string, params?: Record<string, any>): Promise<any>;
+}

package/types/main-thread/events.d.ts

@@ -0,0 +1,20 @@
+// 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 { LynxEventPropsBase, BaseTouchEvent, BaseMouseEvent, BaseWheelEvent, BaseKeyEvent } from '../common/events';
+import { Element } from './element';
+
+// worklet event
+export interface TouchEvent extends BaseTouchEvent<Element> {}
+export interface MouseEvent extends BaseMouseEvent<Element> {}
+export interface WheelEvent extends BaseWheelEvent<Element> {}
+export interface KeyEvent extends BaseKeyEvent<Element> {}
+type LynxWorkletEventPropsImpl = {
+  [K in keyof LynxEventPropsBase<Element> as Lowercase<`main-thread:${K}`>]: LynxEventPropsBase<Element>[K];
+};
+export interface LynxWorkletEventProps extends LynxWorkletEventPropsImpl {}
+
+declare module '../common/props.d.ts' {
+  interface StandardProps extends LynxWorkletEventProps {}
+}

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

@@ -0,0 +1,7 @@
+// 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 './lynx';
+export * from './element';
+export * from './events';

package/types/main-thread/lynx.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 { LynxClearTimeout, LynxSetTimeout, CommonLynx } from '../common';
+import { CommonPerformance } from '../common/performance';
+
+/**
+ * @description Lynx provide `main-thread lynx` public api.
+ */
+export interface Lynx extends CommonLynx {
+  // Currently is internal.
+  // setTimeout: LynxSetTimeout;
+
+  // setInterval: LynxSetTimeout;
+
+  // clearTimeout: LynxClearTimeout;
+
+  // clearInterval: LynxClearTimeout;
+
+  // triggerLepusBridge: <Params = Record<string, unknown>>(methodName: string, methodDetail: Params, cb: (...args: unknown[]) => void) => void;
+  // triggerLepusBridgeSync: <Ret = unknown, Params = Record<string, unknown>>(methodName: string, methodDetail: Params) => Ret;
+
+  /**
+   * Support from Lynx 3.0
+   */
+  performance: CommonPerformance;
+}