@lynx-js/react 0.105.0

package/transform/index.d.ts

@@ -0,0 +1,187 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface TransformNodiffBundleOptions {
+  filename: string
+  pluginName: string
+  sourceFileName?: string
+  sourcemap: boolean | string
+  extractStr: boolean | ExtractStrConfig
+  minify?: boolean
+}
+export interface TransformNodiffBundleOutput {
+  code: string
+  map?: string
+  selectStrVec?: Array<string>
+  useWorklet?: boolean
+  errors: Array<PartialMessage>
+  warnings: Array<PartialMessage>
+}
+/**
+ * This is esbuild's PartialMessage definition.
+ * https://github.com/evanw/esbuild/blob/043ab306c490f692c68e8d254bbf00b6468be87d/lib/shared/types.ts#L421
+ */
+export interface PartialMessage {
+  id?: string
+  pluginName?: string
+  text?: string
+  location?: PartialLocation
+  notes?: Array<PartialNote>
+  detail?: string
+}
+export interface PartialNote {
+  text?: string
+  location?: PartialLocation
+}
+export interface PartialLocation {
+  file?: string
+  namespace?: string
+  line?: number
+  column?: number
+  length?: number
+  lineText?: string
+  suggestion?: string
+}
+export interface DarkModeConfig {
+  /** @public */
+  themeExpr: string
+}
+export interface CompatVisitorConfig {
+  /** @internal */
+  target: 'LEPUS' | 'JS' | 'MIXED'
+  /** @public */
+  componentsPkg: Array<string>
+  /** @public */
+  oldRuntimePkg: Array<string>
+  /** @public */
+  newRuntimePkg: string
+  /** @public */
+  additionalComponentAttributes: Array<string>
+  /** @public */
+  addComponentElement: boolean
+  /**
+   * @public
+   * @deprecated
+   */
+  simplifyCtorLikeReactLynx2: boolean
+  /**
+   * @public
+   * @deprecated
+   */
+  removeComponentAttrRegex?: string
+  /** @public */
+  disableDeprecatedWarning: boolean
+  /**
+   * @public
+   * @deprecated
+   */
+  darkMode?: boolean | DarkModeConfig
+}
+export interface CssScopeVisitorConfig {
+  /** @public */
+  mode: 'all' | 'none' | 'modules'
+  /** @public */
+  filename: string
+}
+export interface DefineDceVisitorConfig {
+  /** @public */
+  define: Record<string, string>
+}
+export interface DirectiveDceVisitorConfig {
+  /** @internal */
+  target: 'LEPUS' | 'JS' | 'MIXED'
+}
+export interface DynamicImportVisitorConfig {
+  /** @internal */
+  runtimePkg: string
+  /** @internal */
+  layer: string
+}
+export interface ExtractStrConfig {
+  /** @public */
+  strLength: number
+  /** @internal */
+  extractedStrArr?: Array<string>
+}
+export interface InjectVisitorConfig {
+  inject: Record<string, ['expr', string] | ['importDefault', string] | ['importStarAs', string] | ['importNamed', string, string]>
+}
+export interface RefreshVisitorConfig {
+  library?: Array<string>
+}
+export interface ShakeVisitorConfig {
+  /** @public */
+  pkgName: Array<string>
+  /** @public */
+  retainProp: Array<string>
+  /** @public */
+  removeCallParams: Array<string>
+}
+export interface JsxTransformerConfig {
+  preserveJsx: boolean
+  runtimePkg: string
+  jsxImportSource?: string
+  filename: string
+  /** @internal */
+  target: 'LEPUS' | 'JS' | 'MIXED'
+  /** @internal */
+  isDynamicComponent?: boolean
+}
+export interface WorkletVisitorConfig {
+  /**
+   * @public
+   * During the compilation of worklet, when extracting external variable identifiers,
+   * global identifiers available in lepus context need to be ignored.
+   * In addition to the default lepus global identifier list provided by the compiler,
+   * users can customize the global identifier list through this option.
+   * This configuration will take effect together with the default lepus global identifier list.
+   */
+  customGlobalIdentNames?: Array<string>
+  /** @internal */
+  filename: string
+  /** @internal */
+  target: 'LEPUS' | 'JS' | 'MIXED'
+  runtimePkg: string
+}
+export interface TransformNodiffOptions {
+  /**
+   * @internal
+   * This is used internally to make sure the test output is consistent.
+   */
+  mode?: 'production' | 'development' | 'test'
+  pluginName: string
+  filename: string
+  sourceFileName?: string
+  sourcemap: boolean | string
+  sourceMapColumns?: boolean
+  inlineSourcesContent?: boolean
+  /**
+   * @public
+   * This is swc syntax config in JSON format
+   */
+  syntaxConfig?: string
+  isModule?: boolean | 'unknown'
+  cssScope: boolean | CssScopeVisitorConfig
+  snapshot?: boolean | JsxTransformerConfig
+  shake: boolean | ShakeVisitorConfig
+  compat: boolean | CompatVisitorConfig
+  refresh: boolean | RefreshVisitorConfig
+  defineDCE: boolean | DefineDceVisitorConfig
+  directiveDCE: boolean | DirectiveDceVisitorConfig
+  worklet: boolean | WorkletVisitorConfig
+  dynamicImport?: boolean | DynamicImportVisitorConfig
+  /** @internal */
+  inject?: boolean | InjectVisitorConfig
+}
+export interface TransformNodiffOutput {
+  code: string
+  map?: string
+  errors: Array<PartialMessage>
+  warnings: Array<PartialMessage>
+}
+export function transformReactLynxSync(code: string, options?: TransformNodiffOptions | undefined | null): TransformNodiffOutput
+export function transformReactLynx(code: string, options?: TransformNodiffOptions | undefined | null): Promise<TransformNodiffOutput>
+export function transformBundleResultSync(code: string, options?: TransformNodiffBundleOptions | undefined | null): TransformNodiffBundleOutput
+export function transformBundleResult(code: string, options?: TransformNodiffBundleOptions | undefined | null): Promise<TransformNodiffBundleOutput>

package/transform/main.js

@@ -0,0 +1,15 @@
+// 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 { createRequire } from 'node:module';
+
+import exports from './cjs/main.cjs';
+
+const require = createRequire(import.meta.url);
+
+export const {
+  transformReactLynxSync,
+  transformBundleResultSync,
+  transformReactLynx,
+  transformBundleResult,
+} = process.env['USE_NAPI'] ? require('./index.cjs') : exports;

package/types/react.d.ts

@@ -0,0 +1,147 @@
+// Import to apply global declarations and then re-export documentable members.
+import './react.docs.js';
+export * from './react.docs.js';
+
+// Types
+export type {
+  Attributes,
+  CElement,
+  CFactory,
+  ChildContextProvider,
+  ClassAttributes,
+  ClassType,
+  ClassicComponent,
+  ClassicComponentClass,
+  ClassicElement,
+  ClassicFactory,
+  ComponentClass,
+  ComponentElement,
+  ComponentFactory,
+  ComponentLifecycle,
+  ComponentProps,
+  ComponentPropsWithRef,
+  ComponentPropsWithoutRef,
+  ComponentRef,
+  ComponentSpec,
+  ComponentState,
+  ComponentType,
+  Consumer,
+  ConsumerProps,
+  Context,
+  ContextType,
+  CustomComponentPropsWithRef,
+  DependencyList,
+  DeprecatedLifecycle,
+  Dispatch,
+  DispatchWithoutAction,
+  EffectCallback,
+  ElementRef,
+  ElementType,
+  ExoticComponent,
+  FC,
+  Factory,
+  ForwardRefExoticComponent,
+  ForwardRefRenderFunction,
+  ForwardedRef,
+  FunctionComponent,
+  FunctionComponentElement,
+  FunctionComponentFactory,
+  GetDerivedStateFromError,
+  GetDerivedStateFromProps,
+  JSXElementConstructor,
+  Key,
+  LazyExoticComponent,
+  LegacyRef,
+  MemoExoticComponent,
+  Mixin,
+  MutableRefObject,
+  NamedExoticComponent,
+  NewLifecycle,
+  PropsWithChildren,
+  PropsWithRef,
+  PropsWithoutRef,
+  Provider,
+  ProviderExoticComponent,
+  ProviderProps,
+  ReactComponentElement,
+  ReactElement,
+  ReactInstance,
+  ReactNode,
+  Reducer,
+  ReducerAction,
+  ReducerState,
+  ReducerStateWithoutAction,
+  ReducerWithoutAction,
+  Ref,
+  RefAttributes,
+  RefCallback,
+  RefObject,
+  SFCFactory,
+  SVGFactory,
+  SetStateAction,
+  StaticLifecycle,
+  TransitionFunction,
+  TransitionStartFunction,
+  VFC,
+  VoidFunctionComponent,
+} from 'react';
+
+import type { MainThread, NodesRef } from '@lynx-js/types';
+import type { Key, ReactNode, Ref } from 'react';
+
+import type { Lynx as LynxExtended } from './react.docs.js';
+
+declare module '@lynx-js/types' {
+  interface StandardProps {
+    children?: ReactNode;
+    ref?: Ref<NodesRef>;
+    key?: Key;
+    'main-thread:ref'?: Ref<MainThread.Element>;
+  }
+
+  interface Lynx extends LynxExtended {
+    /**
+     * Select the first element matching the given CSS selector in the page.
+     * @param selector - CSS Selector string.
+     * @public
+     */
+    querySelector: (selector: string) => MainThread.Element | null;
+
+    /**
+     * Select all the elements matching the given CSS selector in the page.
+     * @param selector - CSS Selector string.
+     * @public
+     */
+    querySelectorAll: (selector: string) => MainThread.Element[];
+  }
+
+  export interface ListItemProps {
+    /**
+     * Control (mainly reduce) the reuse behavior of `<list-item />`
+     *
+     * @example
+     *
+     * Avoid unexpected reuse.
+     *
+     * ```tsx
+     * {[1, "2", 3].map((item) => {
+     *  return (
+     *    <list-item key={item} item-key={item} reuse-identifier={typeof item}>
+     *      <text>{item}</text>
+     *    </list-item>
+     *  );
+     * })}
+     * ```
+     *
+     * When `<list-item />` is returned from the array `.map()`,
+     * since they have the same form and position at the compile stage,
+     * we will generate the same reuse-identifier for them,
+     * and we will think that this group of `<list-item />` can be reused with each other.
+     * Explicitly specifying the reuse-identifier can avoid some unexpected reuse.
+     * For example, in the above code, if we do not want numbers and strings to be reused with each other,
+     * we can use typeof item as the reuse-identifier.
+     * By default, the developer does not provide a reuse-identifier, which is determined by the framework at the compile stage.
+     */
+    'reuse-identifier'?: Key;
+  }
+}

package/types/react.docs.d.ts

@@ -0,0 +1,74 @@
+// 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.
+declare global {
+  /**
+   * Determines if code should be placed in the background thread, used as a compile-time define macro
+   *
+   * @deprecated use `__BACKGROUND__` instead
+   */
+  let __JS__: boolean;
+  /**
+   * Determines if code should be placed in the background thread, used as a compile-time define macro
+   */
+  let __BACKGROUND__: boolean;
+  /**
+   * Determines if code should be placed in the main thread, used as a compile-time define macro
+   *
+   * @deprecated use `__MAIN_THREAD__` instead
+   */
+  let __LEPUS__: boolean;
+  /**
+   * Determines if code should be placed in the main thread, used as a compile-time define macro
+   */
+  let __MAIN_THREAD__: boolean;
+  /**
+   * Determines if running in dev mode
+   */
+  let __DEV__: boolean;
+  /**
+   * Determines if running in profile mode
+   */
+  let __PROFILE__: boolean;
+}
+
+/**
+ * Built-in React Hooks
+ * @see https://react.dev/reference/react/hooks
+ */
+export {
+  useCallback,
+  useContext,
+  useDebugValue,
+  useImperativeHandle,
+  useMemo,
+  useReducer,
+  useRef,
+  useState,
+  useSyncExternalStore,
+} from 'react';
+
+export { useEffect, useLayoutEffect } from '../runtime/lib/hooks/react.js';
+
+/**
+ * Built-in React APIs
+ * @see https://react.dev/reference/react/apis
+ */
+export { createContext, forwardRef, lazy, memo } from 'react';
+
+/**
+ * Built-in React Components
+ * @see https://react.dev/reference/react/components
+ */
+export { Fragment, Suspense } from 'react';
+
+/**
+ * Legacy React APIs
+ * @see https://react.dev/reference/react/legacy
+ */
+export { Component, PureComponent, createElement, createRef, isValidElement } from 'react';
+
+/**
+ * RL-defined Lynx APIs
+ */
+export * from '../runtime/lib/lynx-api.js';