@lingxia/types 0.9.0 → 0.11.1

package/src/file/index.ts

@@ -1,171 +0,0 @@
-/**
- * File system APIs.
- */
-
-export interface OpenFileOptions {
-  /** Local file path or runtime-managed temp path. */
-  filePath: string;
-  /** Optional coarse file type hint such as `pdf`, `docx`, or `xlsx`. */
-  fileType?: string;
-  /**
-   * `auto`: prefer native review, then fall back to external open.
-   * `review`: require native review UI and reject when unsupported.
-   * `external`: hand off directly to the system / external app.
-   */
-  mode?: 'auto' | 'review' | 'external';
-  /** Hint for whether the native review UI should expose its action menu when supported. */
-  showMenu?: boolean;
-}
-
-export interface FileDialogFilter {
-  /** Optional label shown in the native dialog. */
-  name?: string;
-  /** Allowed extensions without dots, e.g. ['pdf', 'txt']. */
-  extensions: string[];
-}
-
-export interface ChooseFileOptions {
-  /** Allow selecting multiple files. Default: false */
-  multiple?: boolean;
-  /** Optional file filters. Empty or omitted means all file types. */
-  filters?: FileDialogFilter[];
-  /**
-   * Initial directory the dialog opens in.
-   *
-   * When this resolves to an app-local directory, LingXia may use its internal
-   * file picker. When omitted, the platform system file picker is used.
-   */
-  defaultPath?: string;
-}
-
-export interface ChooseFileResult {
-  /** True if the user dismissed the dialog without selecting. */
-  canceled: boolean;
-  /**
-   * File paths returned by LingXia. Values may be app-local paths, `lx://...`
-   * paths, or platform system-picker references. Treat them as opaque strings
-   * and pass them back to LingXia APIs such as `lx.share`.
-   */
-  paths: string[];
-}
-
-export interface ChooseDirectoryOptions {
-  /** Initial directory the dialog opens in. Platform default if omitted. */
-  defaultPath?: string;
-}
-
-export interface ChooseDirectoryResult {
-  /** True if the user dismissed the dialog without selecting. */
-  canceled: boolean;
-  /** Native-consumable directory reference (path or URI). Undefined when canceled. */
-  path?: string;
-}
-
-export interface ExistsOptions {
-  path: string;
-}
-
-export interface StatOptions {
-  path: string;
-}
-
-export interface FileStats {
-  isFile: boolean;
-  isDirectory: boolean;
-  isSymlink: boolean;
-  size: number;
-  lastModifiedTime?: number;
-  lastAccessedTime?: number;
-  createTime?: number;
-}
-
-export interface ReadDirOptions {
-  path: string;
-}
-
-export interface DirEntry {
-  name: string;
-  isFile: boolean;
-  isDirectory: boolean;
-  isSymlink: boolean;
-}
-
-export interface MkdirOptions {
-  path: string;
-  recursive?: boolean;
-}
-
-export interface ReadTextFileOptions {
-  filePath: string;
-  encoding: 'utf8' | 'base64';
-}
-
-export interface ReadBinaryFileOptions {
-  filePath: string;
-  encoding?: undefined;
-}
-
-export type ReadFileOptions = ReadTextFileOptions | ReadBinaryFileOptions;
-
-export interface ReadTextFileResult {
-  data: string;
-}
-
-export interface ReadBinaryFileResult {
-  data: ArrayBuffer;
-}
-
-export type ReadFileResult = ReadTextFileResult | ReadBinaryFileResult;
-
-export type BinaryFileData = ArrayBuffer | ArrayBufferView;
-
-export interface WriteTextFileOptions {
-  filePath: string;
-  data: string;
-  encoding?: 'utf8' | 'base64';
-  /** Defaults to false. */
-  overwrite?: boolean;
-}
-
-export interface WriteBinaryFileOptions {
-  filePath: string;
-  data: BinaryFileData;
-  encoding?: never;
-  /** Defaults to false. */
-  overwrite?: boolean;
-}
-
-export type WriteFileOptions = WriteTextFileOptions | WriteBinaryFileOptions;
-
-export interface CopyFileOptions {
-  srcPath: string;
-  destPath: string;
-  /** Defaults to false. */
-  overwrite?: boolean;
-}
-
-export interface RenameOptions {
-  oldPath: string;
-  newPath: string;
-  /** Defaults to false. */
-  overwrite?: boolean;
-}
-
-export interface RemoveOptions {
-  path: string;
-  recursive?: boolean;
-}
-
-export interface FileManager {
-  exists(options: ExistsOptions): Promise<boolean>;
-  stat(options: StatOptions): Promise<FileStats>;
-  readDir(options: ReadDirOptions): Promise<AsyncIterableIterator<DirEntry>>;
-  mkdir(options: MkdirOptions): Promise<void>;
-  readFile(options: ReadTextFileOptions): Promise<ReadTextFileResult>;
-  readFile(options: ReadBinaryFileOptions): Promise<ReadBinaryFileResult>;
-  readFile(options: ReadFileOptions): Promise<ReadFileResult>;
-  writeFile(options: WriteFileOptions): Promise<void>;
-  copyFile(options: CopyFileOptions): Promise<void>;
-  rename(options: RenameOptions): Promise<void>;
-  remove(options: RemoveOptions): Promise<void>;
-}

package/src/input/index.ts

@@ -1,19 +0,0 @@
-/**
- * Input event APIs.
- *
- * Platform support: Android only
- */
-
-export interface KeyEvent {
-  /** Key value following W3C naming (e.g. "Enter", "ArrowLeft", "a") */
-  key: string;
-  /** Physical key code (e.g. "ENTER", "DPAD_LEFT") */
-  code: string;
-  altKey?: boolean;
-  ctrlKey?: boolean;
-  shiftKey?: boolean;
-  metaKey?: boolean;
-  repeat?: boolean;
-}
-
-export type KeyEventCallback = (event: KeyEvent) => void;

package/src/location/index.ts

@@ -1,20 +0,0 @@
-/**
- * Location APIs.
- */
-
-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/lxapp/index.ts

@@ -1,12 +0,0 @@
-/**
- * LxApp metadata APIs.
- */
-
-export type LxAppReleaseType = 'release' | 'preview' | 'developer';
-
-export interface LxAppInfo {
-  appId: string;
-  appName: string;
-  version: string;
-  releaseType: LxAppReleaseType;
-}

package/src/media/index.ts

@@ -1,343 +0,0 @@
-/**
- * Media picker, preview, scan, and file processing APIs.
- */
-
-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 type VideoCompressQuality = 'low' | 'medium' | 'high';
-
-export interface CompressVideoOptions {
-  /**
-   * Source video path or `lx://` URI.
-   */
-  path: string;
-  /**
-   * Cross-platform note: video compression parameters are best-effort and may map to
-   * native presets instead of exact encoder settings.
-   *
-   * Compression quality preset.
-   * When provided, `bitrate`, `fps`, and `resolution` are ignored.
-   */
-  quality?: VideoCompressQuality;
-  /**
-   * Preferred target video bitrate in kbps.
-   * May be adjusted or ignored by platform codec/runtime limitations.
-   */
-  bitrate?: number;
-  /**
-   * Preferred target frame rate in fps.
-   * Some platforms may ignore this option.
-   */
-  fps?: number;
-  /**
-   * Target resolution scale ratio relative to source size, in range `(0, 1]`.
-   * May be approximated or ignored by platform transcoder capabilities.
-   */
-  resolution?: number;
-  /**
-   * Optional output path for compressed file.
-   */
-  outputPath?: string;
-}
-
-export interface CompressVideoResult {
-  tempFilePath: string;
-  width: number;
-  height: number;
-  durationMs: number;
-  /**
-   * Output file size in bytes.
-   * Could be close to source size when platform falls back to source content.
-   */
-  size: number;
-  type: string;
-}
-
-export interface GetVideoInfoOptions {
-  /**
-   * Video file path or `lx://` URI.
-   */
-  path: string;
-}
-
-export interface VideoInfo {
-  /**
-   * Encoded display width in pixels.
-   */
-  width: number;
-  /**
-   * Encoded display height in pixels.
-   */
-  height: number;
-  /**
-   * Video duration in milliseconds.
-   */
-  durationMs: number;
-  /**
-   * Clockwise rotation in degrees (usually `0 | 90 | 180 | 270`).
-   */
-  rotation?: number;
-  /**
-   * Average bitrate in bits per second (bps).
-   */
-  bitrate?: number;
-  /**
-   * Frame rate in frames per second (fps).
-   */
-  fps?: number;
-  /**
-   * MIME type, e.g. `video/mp4`.
-   */
-  type?: string;
-  /**
-   * Resolved path used by runtime (typically `lx://...`).
-   */
-  path: string;
-}
-
-export interface ExtractVideoThumbnailOptions {
-  /**
-   * Source video path or `lx://` URI.
-   */
-  path: string;
-  /**
-   * Optional output image path. If omitted, runtime chooses a temporary path.
-   */
-  outputPath?: string;
-  /**
-   * Max output width in pixels.
-   * Optional; when set with/without `maxHeight`, output keeps aspect ratio (no cropping).
-   */
-  maxWidth?: number;
-  /**
-   * Max output height in pixels.
-   * Optional; when set with/without `maxWidth`, output keeps aspect ratio (no cropping).
-   */
-  maxHeight?: number;
-  /**
-   * Target frame time in milliseconds from video start.
-   * `0` means first frame.
-   */
-  timeMs?: number;
-  /**
-   * JPEG quality in range `0-100`.
-   */
-  quality?: number;
-}
-
-export interface ExtractVideoThumbnailResult {
-  /**
-   * Generated thumbnail file path.
-   */
-  tempFilePath: string;
-  /**
-   * Output image width in pixels.
-   */
-  width: number;
-  /**
-   * Output image height in pixels.
-   */
-  height: number;
-  /**
-   * Output MIME type, usually `image/jpeg`.
-   */
-  type: 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 type MediaRotation = 0 | 90 | 180 | 270;
-
-export type MediaObjectFit = 'cover' | 'contain' | 'fill' | 'fit';
-
-export interface PreviewMediaSource {
-  /**
-   * Media source path.
-   * Recommended: `lx://` path (for example `lx://usercache/...`) or a sandbox-local path
-   * that can be resolved by runtime access rules.
-  */
-  path: string;
-  type?: 'image' | 'video';
-  /**
-   * Optional clockwise rotation in degrees (`0 | 90 | 180 | 270`).
-   * Default: when omitted, runtime resolves orientation from media metadata.
-   */
-  rotate?: MediaRotation;
-  /**
-   * Optional display fit mode for video preview.
-   * Default: `contain`.
-   */
-  objectFit?: MediaObjectFit;
-  /**
-   * Display duration in milliseconds.
-   * Effective when preview `advance` is not `manual`.
-   */
-  durationMs?: number;
-}
-
-export type PreviewMediaAdvance = 'manual' | 'next' | 'loop';
-
-export interface PreviewMediaSingleOptions extends PreviewMediaSource {
-  /**
-   * Auto behavior for the preview session.
-   *
-   * - `manual`: never auto-advance
-   * - `next`: advance to the next item; if already on the last item, close the session
-   * - `loop`: advance to the next item; if already on the last item, wrap to the first item
-   *
-   * Default: `manual`
-   */
-  advance?: PreviewMediaAdvance;
-  /**
-   * Optional cancellation signal for the preview request.
-   *
-   * Aborting rejects the returned promise with a cancellation error and requests the active
-   * native preview session to close immediately.
-   */
-  signal?: AbortSignal;
-  /**
-   * Whether to show the top `current/total` indicator.
-   *
-   * Default: `true` when previewing multiple items, otherwise `false`.
-   */
-  showIndexIndicator?: boolean;
-}
-
-export interface PreviewMediaSequenceOptions {
-  /**
-   * Preview list. Supports images, videos, or a mixed queue.
-   */
-  sources: PreviewMediaSource[];
-  /**
-   * Initial item index in `sources`.
-   * Must be an integer.
-   * Out-of-range values are clamped by runtime.
-   * Default: `0`.
-   */
-  startIndex?: number;
-  /**
-   * Auto behavior for the preview session.
-   *
-   * - `manual`: never auto-advance
-   * - `next`: advance to the next item; if already on the last item, close the session
-   * - `loop`: advance to the next item; if already on the last item, wrap to the first item
-   *
-   * Default: `manual`
-   */
-  advance?: PreviewMediaAdvance;
-  /**
-   * Optional cancellation signal for the preview request.
-   *
-   * Aborting rejects the returned promise with a cancellation error and requests the active
-   * native preview session to close immediately.
-   */
-  signal?: AbortSignal;
-  /**
-   * Whether to show the top `current/total` indicator.
-   *
-   * Default: `true` when previewing multiple items, otherwise `false`.
-   */
-  showIndexIndicator?: boolean;
-}
-
-export type PreviewMediaOptions =
-  | string
-  | PreviewMediaSingleOptions
-  | PreviewMediaSequenceOptions;
-
-export type PreviewMediaCloseReason = 'manual' | 'completed' | 'interrupted' | 'error';
-
-export interface PreviewMediaResult {
-  /**
-   * Why the preview session finished.
-   */
-  reason: PreviewMediaCloseReason;
-  /**
-   * Last active item index before close.
-   */
-  lastIndex: number;
-}
-
-/**
- * Handle returned synchronously from `lx.previewMedia(...)`. Exposes two
- * independent Promises so callers can coordinate transitions:
- *
- * - `presented` resolves once the first pixel of the underlying media has
- *   been composited to screen. Use this to time the hide of an overlay
- *   surface above the preview so the swap is seamless. Never rejects;
- *   resolves with no value when the first frame is up. Safe to ignore.
- * - `completed` resolves when the preview session ends (manual / auto /
- *   interrupted / error). Replaces the previous `Promise<PreviewMediaResult>`
- *   that `previewMedia` used to return directly.
- *
- * If the call was aborted before any frame was presented, `presented` still
- * resolves (with no value) once the abort takes effect — it never rejects,
- * to keep fire-and-forget usage safe.
- */
-export interface PreviewMediaHandle {
-  readonly presented: Promise<void>;
-  readonly completed: Promise<PreviewMediaResult>;
-}
-
-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/navigator/index.ts

@@ -1,16 +0,0 @@
-/**
- * LxApp navigator APIs.
- */
-
-import type { PageQuery } from '../ui';
-
-export type LxAppEnvVersion = 'release' | 'preview' | 'develop';
-
-export interface NavigateToLxAppOptions {
-  appId: string;
-  page?: string;
-  path?: string;
-  query?: PageQuery;
-  envVersion?: LxAppEnvVersion;
-  targetVersion?: string;
-}

package/src/share/index.ts

@@ -1,97 +0,0 @@
-/**
- * Share APIs.
- */
-
-export type ShareQuery = Record<string, string | number | boolean>;
-
-export type SharePage =
-  /**
-   * Share the current page.
-   */
-  | true
-  /**
-   * Share the current page with query.
-   */
-  | {
-      /**
-       * Query appended to the current page. Query belongs to the page target and is
-       * encoded into the AppLink URL.
-       */
-      query?: ShareQuery;
-    };
-
-interface ShareTitleOptions {
-  /**
-   * Share title.
-   */
-  title?: string;
-}
-
-interface ShareTextBaseOptions extends ShareTitleOptions {
-  /**
-   * Share text body.
-   */
-  text?: string;
-}
-
-/**
- * Share title/text only. Receiver support is platform/app dependent; some
- * share extensions may reject text-only shares.
- */
-export interface ShareTextOptions extends ShareTextBaseOptions {
-  page?: never;
-  files?: never;
-}
-
-/**
- * Share the current page as an AppLink.
- */
-export interface SharePageOptions extends ShareTextBaseOptions {
-  /**
-   * Share the current page. The runtime uses the current appId and page path
-   * implicitly and shares it through the host AppLink configuration.
-   *
-   * Rejects when the host app has no `appLinks.hosts` configuration because
-   * receivers would not be able to open the shared page.
-   *
-   * `title` and `text` are presentation hints. Platforms and receivers may
-   * ignore them; on iOS the URL is shared by itself so receivers can render it
-   * as a webpage card when they support that.
-   *
-   * `page` and `files` are mutually exclusive.
-   */
-  page: SharePage;
-  files?: never;
-}
-
-/**
- * Share images, PDFs, or other files.
- */
-export interface ShareFilesOptions extends ShareTitleOptions {
-  /**
-   * File paths returned by LingXia APIs to share. Images, PDFs, and other
-   * documents are all represented as file paths.
-   *
-   * Use `lx.chooseFile` for system files and `lx.chooseMedia` for picked media;
-   * pass the returned path here without parsing it.
-   * Some platforms or receivers may limit multi-file shares. Share files one
-   * at a time when targeting those receivers.
-   *
-   * `files` and `page` are mutually exclusive.
-   * `text` is intentionally not supported for file shares because system
-   * receivers handle text+attachment inconsistently.
-   */
-  files: string[];
-  page?: never;
-  text?: never;
-}
-
-export type ShareOptions = ShareTextOptions | SharePageOptions | ShareFilesOptions;
-
-export interface ShareResult {
-  /**
-   * Best-effort completion flag. Some platforms can only confirm that the
-   * system share UI was opened or closed.
-   */
-  completed?: boolean;
-}

package/src/storage/index.ts

@@ -1,13 +0,0 @@
-/**
- * Key-value storage APIs.
- */
-
-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;
-}

package/src/system/index.ts

@@ -1,14 +0,0 @@
-/**
- * System settings and URL APIs.
- */
-
-export interface SystemSettingInfo {
-  bluetoothEnabled: boolean;
-  locationEnabled: boolean;
-  wifiEnabled: boolean;
-}
-
-export interface OpenURLOptions {
-  url: string;
-  target?: 'self' | 'external';
-}