@lingxia/types 0.1.0

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@lingxia/types",
+  "version": "0.1.0",
+  "description": "TypeScript type definitions for the LingXia JS API",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LingXia-Dev/LingXia.git",
+    "directory": "lingxia-types"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./app": {
+      "types": "./dist/app/index.d.ts",
+      "import": "./dist/app/index.js",
+      "require": "./dist/app/index.js"
+    },
+    "./device": {
+      "types": "./dist/device/index.d.ts",
+      "import": "./dist/device/index.js",
+      "require": "./dist/device/index.js"
+    },
+    "./input": {
+      "types": "./dist/input/index.d.ts",
+      "import": "./dist/input/index.js",
+      "require": "./dist/input/index.js"
+    },
+    "./storage": {
+      "types": "./dist/storage/index.d.ts",
+      "import": "./dist/storage/index.js",
+      "require": "./dist/storage/index.js"
+    },
+    "./location": {
+      "types": "./dist/location/index.d.ts",
+      "import": "./dist/location/index.js",
+      "require": "./dist/location/index.js"
+    },
+    "./system": {
+      "types": "./dist/system/index.d.ts",
+      "import": "./dist/system/index.js",
+      "require": "./dist/system/index.js"
+    },
+    "./media": {
+      "types": "./dist/media/index.d.ts",
+      "import": "./dist/media/index.js",
+      "require": "./dist/media/index.js"
+    },
+    "./ui": {
+      "types": "./dist/ui/index.d.ts",
+      "import": "./dist/ui/index.js",
+      "require": "./dist/ui/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "keywords": [
+    "lingxia",
+    "lxapp",
+    "miniapp",
+    "types",
+    "typescript",
+    "definitions"
+  ],
+  "author": "LingXia Team",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "sideEffects": false
+}

package/src/app/index.ts

@@ -0,0 +1,68 @@
+/**
+ * App & Page APIs
+ * Corresponds to: lingxia-lxapp/src/appservice/
+ */
+
+export interface AppLifecycleEventArgs {
+  source: 'host' | 'lxapp';
+  reason:
+    | 'foreground'
+    | 'background'
+    | 'screenshot'
+    | 'open'
+    | 'close'
+    | 'switch_back'
+    | 'switch_away';
+}
+
+export interface AppLaunchOptions {
+  path?: string;
+  query?: Record<string, string>;
+  scene?: number;
+  referrerInfo?: {
+    appId?: string;
+    extraData?: Record<string, unknown>;
+  };
+}
+
+export interface AppConfig {
+  globalData?: Record<string, unknown>;
+  onLaunch?: (options?: AppLaunchOptions) => void;
+  onShow?: (args?: AppLifecycleEventArgs) => void;
+  onHide?: (args?: AppLifecycleEventArgs) => void;
+  onUserCaptureScreen?: () => void;
+  [key: string]: unknown;
+}
+
+export interface AppInstance extends AppConfig {
+  globalData: Record<string, unknown>;
+}
+
+export interface PageLoadOptions {
+  [key: string]: string | undefined;
+}
+
+export interface PageConfig<TData extends Record<string, unknown> = Record<string, unknown>> {
+  data?: TData;
+  onLoad?: (options?: PageLoadOptions) => void;
+  onShow?: () => void;
+  onReady?: () => void;
+  onHide?: () => void;
+  onUnload?: () => void;
+  onPullDownRefresh?: () => void;
+  [key: string]: unknown;
+}
+
+export interface PageInstance<TData extends Record<string, unknown> = Record<string, unknown>> {
+  data: TData;
+  route: string;
+  setData(data: Partial<TData> | Record<string, unknown>, callback?: () => void): void;
+  getEventEmitter(): EventEmitter;
+}
+
+export interface EventEmitter {
+  on(event: string, handler: (...args: unknown[]) => void): void;
+  off(event: string, handler: (...args: unknown[]) => void): void;
+  emit(event: string, ...args: unknown[]): void;
+  once(event: string, handler: (...args: unknown[]) => void): void;
+}

package/src/device/index.ts

@@ -0,0 +1,46 @@
+/**
+ * Device APIs
+ * Corresponds to: lingxia-logic/src/device/
+ */
+
+export interface DeviceInfo {
+  brand: string;
+  model: string;
+  marketName: string;
+  system: string;
+}
+
+export interface ScreenInfo {
+  width: number;
+  height: number;
+  scale: number;
+}
+
+export interface MakePhoneCallOptions {
+  phoneNumber: string;
+}
+
+export interface WifiInfo {
+  SSID: string;
+  BSSID?: string;
+  secure: boolean;
+  signalStrength: number;
+  frequency?: number;
+}
+
+export interface ConnectWifiOptions {
+  SSID: string;
+  password?: string;
+}
+
+export type WifiConnectedCallback = (info: WifiInfo) => void;
+
+export interface AppOrientationInfo {
+  orientation: string;
+}
+
+export interface SetAppOrientationOptions {
+  orientation: string;
+}
+
+export type { KeyEvent, KeyEventCallback } from '../input';

package/src/index.ts

@@ -0,0 +1,193 @@
+/**
+ * LingXia TypeScript Definitions
+ *
+ * Type declarations for the LingXia JS API, driven by Rust implementation.
+ */
+
+export * from './app';
+export * from './device';
+export * from './input';
+export * from './storage';
+export * from './location';
+export * from './system';
+export * from './media';
+export * from './ui';
+
+import type {
+  AppConfig,
+  AppInstance,
+  PageConfig,
+  PageInstance,
+} from './app';
+
+import type {
+  DeviceInfo,
+  ScreenInfo,
+  MakePhoneCallOptions,
+  WifiInfo,
+  ConnectWifiOptions,
+  WifiConnectedCallback,
+  AppOrientationInfo,
+  SetAppOrientationOptions,
+} from './device';
+
+import type { KeyEventCallback } from './input';
+
+import type {
+  LxEnv,
+  Storage,
+  OpenDocumentOptions,
+} from './storage';
+
+import type {
+  GetLocationOptions,
+  LocationInfo,
+} from './location';
+
+import type {
+  AppBaseInfo,
+  SystemSettingInfo,
+  OpenURLOptions,
+  NavigateToLxAppOptions,
+  UpdateManager,
+} from './system';
+
+import type {
+  GetImageInfoOptions,
+  ImageInfo,
+  CompressImageOptions,
+  CompressImageResult,
+  ChooseMediaOptions,
+  ChosenMediaEntry,
+  PreviewMediaOptions,
+  SaveMediaOptions,
+  ScanCodeOptions,
+  ScanCodeResult,
+  VideoContext,
+} from './media';
+
+import type {
+  ShowToastOptions,
+  ShowModalOptions,
+  ModalResult,
+  ShowActionSheetOptions,
+  ActionSheetResult,
+  NavigateToOptions,
+  NavigateToResult,
+  NavigateBackOptions,
+  RedirectToOptions,
+  SwitchTabOptions,
+  ReLaunchOptions,
+  SetNavigationBarTitleOptions,
+  SetNavigationBarColorOptions,
+  TabBarRedDotOptions,
+  SetTabBarBadgeOptions,
+  RemoveTabBarBadgeOptions,
+  SetTabBarStyleOptions,
+  SetTabBarItemOptions,
+  ShowPopupOptions,
+  ShowPopupResult,
+  CapsuleRect,
+} from './ui';
+
+export interface Lx {
+  env: LxEnv;
+
+  getDeviceInfo(): DeviceInfo;
+  getScreenInfo(): ScreenInfo;
+  vibrateShort(): boolean;
+  vibrateLong(): boolean;
+  makePhoneCall(options: MakePhoneCallOptions): boolean;
+
+  startWifi(): Promise<void>;
+  stopWifi(): Promise<void>;
+  connectWifi(options: ConnectWifiOptions): Promise<void>;
+  getWifiList(): Promise<WifiInfo[]>;
+  getConnectedWifi(): Promise<WifiInfo>;
+  onWifiConnected(callback: WifiConnectedCallback): void;
+  offWifiConnected(callback?: WifiConnectedCallback): void;
+
+  getAppOrientation(): AppOrientationInfo;
+  setAppOrientation(options: SetAppOrientationOptions): boolean;
+
+  openDocument(options: OpenDocumentOptions): void;
+
+  getStorage(): Storage;
+
+  getLocation(options?: GetLocationOptions): Promise<LocationInfo>;
+
+  navigateToLxApp(options: NavigateToLxAppOptions): Promise<void>;
+  navigateBackLxApp(): Promise<void>;
+
+  getAppBaseInfo(): AppBaseInfo;
+  getSystemSetting(): SystemSettingInfo;
+  openURL(options: OpenURLOptions): void;
+
+  getUpdateManager(): UpdateManager;
+
+  getImageInfo(options: GetImageInfoOptions): Promise<ImageInfo>;
+  compressImage(options: CompressImageOptions): Promise<CompressImageResult>;
+
+  chooseMedia(options?: ChooseMediaOptions): Promise<ChosenMediaEntry[]>;
+
+  previewMedia(options: PreviewMediaOptions): void;
+
+  saveImageToPhotosAlbum(options: SaveMediaOptions): Promise<void>;
+  saveVideoToPhotosAlbum(options: SaveMediaOptions): Promise<void>;
+
+  scanCode(options?: ScanCodeOptions): Promise<ScanCodeResult>;
+
+  createVideoContext(componentId: string): VideoContext;
+
+  showToast(options: ShowToastOptions): void;
+  hideToast(): void;
+
+  showModal(options: ShowModalOptions): Promise<ModalResult>;
+
+  showActionSheet(options: ShowActionSheetOptions): Promise<ActionSheetResult>;
+
+  navigateTo(options: NavigateToOptions): Promise<NavigateToResult>;
+  navigateBack(options: NavigateBackOptions): void;
+  redirectTo(options: RedirectToOptions): Promise<void>;
+  switchTab(options: SwitchTabOptions): Promise<void>;
+  reLaunch(options: ReLaunchOptions): Promise<void>;
+
+  setNavigationBarTitle(options: SetNavigationBarTitleOptions): boolean;
+  setNavigationBarColor(options: SetNavigationBarColorOptions): boolean;
+  hideHomeButton(): boolean;
+
+  showTabBarRedDot(options: TabBarRedDotOptions): boolean;
+  hideTabBarRedDot(options: TabBarRedDotOptions): boolean;
+  setTabBarBadge(options: SetTabBarBadgeOptions): boolean;
+  removeTabBarBadge(options: RemoveTabBarBadgeOptions): boolean;
+  showTabBar(): boolean;
+  hideTabBar(): boolean;
+  setTabBarStyle(options: SetTabBarStyleOptions): boolean;
+  setTabBarItem(options: SetTabBarItemOptions): boolean;
+
+  showPopup(options: ShowPopupOptions): Promise<ShowPopupResult>;
+  hidePopup(): void;
+
+  startPullDownRefresh(): void;
+  stopPullDownRefresh(): void;
+
+  getCapsuleRect(): Promise<CapsuleRect>;
+
+  onKeyDown(callback: KeyEventCallback): void;
+  offKeyDown(callback?: KeyEventCallback): void;
+  onKeyUp(callback: KeyEventCallback): void;
+  offKeyUp(callback?: KeyEventCallback): void;
+}
+
+declare global {
+  const lx: Lx;
+
+  function App(config: AppConfig): AppInstance;
+  function getApp<T extends AppInstance = AppInstance>(): T | null;
+  function Page<TData extends Record<string, unknown> = Record<string, unknown>>(
+    config: PageConfig<TData> & ThisType<PageInstance<TData> & PageConfig<TData>>
+  ): void;
+  function getCurrentPages<T extends PageInstance = PageInstance>(): T[];
+}
+
+export {};

package/src/input/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Input APIs
+ * Corresponds to: lingxia-logic/src/input.rs
+ */
+
+export interface KeyEvent {
+  key: string;
+  code: string;
+  altKey?: boolean;
+  ctrlKey?: boolean;
+  shiftKey?: boolean;
+  metaKey?: boolean;
+  repeat?: boolean;
+}
+
+export type KeyEventCallback = (event: KeyEvent) => void;

package/src/location/index.ts

@@ -0,0 +1,21 @@
+/**
+ * Location APIs
+ * Corresponds to: lingxia-logic/src/location.rs
+ */
+
+export interface GetLocationOptions {
+  type?: 'wgs84' | 'gcj02';
+  altitude?: boolean;
+  isHighAccuracy?: boolean;
+  highAccuracyExpireTime?: number;
+}
+
+export interface LocationInfo {
+  latitude: number;
+  longitude: number;
+  speed?: number;
+  accuracy?: number;
+  altitude?: number;
+  verticalAccuracy?: number;
+  horizontalAccuracy?: number;
+}

package/src/media/index.ts

@@ -0,0 +1,81 @@
+/**
+ * Media APIs
+ * Corresponds to: lingxia-logic/src/media/
+ */
+
+export interface GetImageInfoOptions {
+  path: string;
+}
+
+export interface ImageInfo {
+  width: number;
+  height: number;
+  type: string;
+  path: string;
+}
+
+export interface CompressImageOptions {
+  path: string;
+  quality?: number;
+  compressedWidth?: number;
+  compressedHeight?: number;
+}
+
+export interface CompressImageResult {
+  tempFilePath: string;
+}
+
+export interface ChooseMediaOptions {
+  count?: number;
+  mediaType?: ('image' | 'video')[];
+  sourceType?: ('album' | 'camera')[];
+  camera?: 'back' | 'front';
+  maxDuration?: number;
+}
+
+export interface ChosenMediaEntry {
+  tempFilePath: string;
+  fileType: 'image' | 'video';
+  isOriginal: boolean;
+}
+
+export interface PreviewMediaItem {
+  path: string;
+  type?: 'image' | 'video';
+  coverPath?: string;
+}
+
+export interface PreviewMediaOptions {
+  sources: PreviewMediaItem[];
+}
+
+export interface SaveMediaOptions {
+  filePath: string;
+}
+
+export interface ScanCodeOptions {
+  onlyFromCamera?: boolean;
+  scanType?: ('barCode' | 'qrCode' | 'datamatrix' | 'pdf417')[];
+}
+
+export interface ScanCodeResult {
+  scanResult: string;
+  scanType: string;
+}
+
+export interface StreamSourceOptions {
+  provider: string;
+  isLive: boolean;
+  duration?: number;
+  params?: Record<string, unknown>;
+}
+
+export interface VideoContext {
+  play(): void;
+  pause(): void;
+  stop(): void;
+  seek(position: number): void;
+  requestFullScreen(): void;
+  exitFullScreen(): void;
+  setStreamSource(options: StreamSourceOptions): void;
+}

package/src/storage/index.ts

@@ -0,0 +1,25 @@
+/**
+ * Storage & File System APIs
+ * Corresponds to: lingxia-logic/src/storage.rs, fs.rs, env.rs
+ */
+
+export interface LxEnv {
+  USER_DATA_PATH: string;
+  USER_CACHE_PATH: string;
+}
+
+export interface Storage {
+  get(key: string): unknown;
+  set(key: string, value: unknown): void;
+  remove(key: string): void;
+  clear(): void;
+  keys(): string[];
+  has(key: string): boolean;
+  size(): number;
+}
+
+export interface OpenDocumentOptions {
+  filePath: string;
+  fileType?: string;
+  showMenu?: boolean;
+}

package/src/system/index.ts

@@ -0,0 +1,33 @@
+/**
+ * System APIs
+ * Corresponds to: lingxia-logic/src/system.rs, navigator.rs, update.rs
+ */
+
+export interface AppBaseInfo {
+  language: string;
+  productName: string;
+  version: string;
+}
+
+export interface SystemSettingInfo {
+  bluetoothEnabled: boolean;
+  locationEnabled: boolean;
+  wifiEnabled: boolean;
+}
+
+export interface OpenURLOptions {
+  url: string;
+  openIn?: 'external' | 'internal';
+}
+
+export interface NavigateToLxAppOptions {
+  appId: string;
+  path?: string;
+  envVersion?: 'develop' | 'trial' | 'release';
+}
+
+export interface UpdateManager {
+  applyUpdate(): void;
+  onUpdateReady(callback: () => void): void;
+  onUpdateFailed(callback: () => void): void;
+}

package/src/ui/index.ts

@@ -0,0 +1,119 @@
+/**
+ * UI APIs
+ * Corresponds to: lingxia-logic/src/ui/
+ */
+
+import type { EventEmitter } from '../app';
+
+export interface ShowToastOptions {
+  title: string;
+  icon?: 'success' | 'error' | 'loading' | 'none';
+  image?: string;
+  duration?: number;
+  mask?: boolean;
+  position?: 'top' | 'center' | 'bottom';
+}
+
+export interface ShowModalOptions {
+  title?: string;
+  content?: string;
+  showCancel?: boolean;
+  cancelText?: string;
+  cancelColor?: string;
+  confirmText?: string;
+  confirmColor?: string;
+}
+
+export interface ModalResult {
+  confirm: boolean;
+  cancel: boolean;
+}
+
+export interface ShowActionSheetOptions {
+  itemList: string[];
+  itemColor?: string;
+}
+
+export interface ActionSheetResult {
+  tapIndex: number;
+}
+
+export interface NavigateToOptions {
+  url: string;
+}
+
+export interface NavigateToResult {
+  eventEmitter: EventEmitter;
+}
+
+export interface NavigateBackOptions {
+  delta: number;
+}
+
+export interface RedirectToOptions {
+  url: string;
+}
+
+export interface SwitchTabOptions {
+  url: string;
+}
+
+export interface ReLaunchOptions {
+  url: string;
+}
+
+export interface SetNavigationBarTitleOptions {
+  title: string;
+}
+
+export interface SetNavigationBarColorOptions {
+  frontColor: string;
+  backgroundColor: string;
+}
+
+export interface TabBarRedDotOptions {
+  index: number;
+}
+
+export interface SetTabBarBadgeOptions {
+  index: number;
+  text: string;
+}
+
+export interface RemoveTabBarBadgeOptions {
+  index: number;
+}
+
+export interface SetTabBarStyleOptions {
+  color?: string;
+  selectedColor?: string;
+  backgroundColor?: string;
+  borderStyle?: string;
+}
+
+export interface SetTabBarItemOptions {
+  index: number;
+  text?: string;
+  iconPath?: string;
+  selectedIconPath?: string;
+}
+
+export interface ShowPopupOptions {
+  url: string;
+  widthRatio?: number;
+  heightRatio?: number;
+  position?: 'center' | 'bottom' | 'left' | 'right';
+}
+
+export interface ShowPopupResult {
+  eventEmitter: EventEmitter;
+}
+
+export interface CapsuleRect {
+  width?: number;
+  height?: number;
+  top?: number;
+  right?: number;
+  bottom?: number;
+  left?: number;
+}