@lingxia/types 0.3.0 → 0.4.3

package/src/generated/i18n.ts

@@ -0,0 +1,123 @@
+// Auto-generated by lingxia-gen. DO NOT EDIT.
+
+export const I18N_KEYS = [
+  "album_add_more_media",
+  "album_add_more_photos",
+  "album_add_more_videos",
+  "album_all_media",
+  "album_all_photos",
+  "album_all_videos",
+  "album_label",
+  "album_original_image",
+  "album_selected",
+  "camera_access_denied",
+  "camera_audio_init_failed",
+  "camera_cancelling",
+  "camera_init_failed",
+  "camera_label",
+  "camera_long_press_to_record",
+  "camera_max_duration_reached",
+  "camera_preparing",
+  "camera_record_video",
+  "camera_release_to_stop",
+  "camera_switch",
+  "camera_switch_failed",
+  "camera_switch_to_back",
+  "camera_switch_to_front",
+  "camera_switching",
+  "camera_tap_to_capture",
+  "camera_tap_to_record",
+  "camera_tap_to_stop",
+  "camera_video_input_failed",
+  "camera_video_output_failed",
+  "capsule_clean_cache",
+  "capsule_restart",
+  "capsule_uninstall",
+  "common_auto",
+  "common_back",
+  "common_cancel",
+  "common_close",
+  "common_confirm",
+  "common_delete",
+  "common_done",
+  "common_edit",
+  "common_home",
+  "common_loading",
+  "common_ok",
+  "common_retry",
+  "common_save",
+  "common_settings",
+  "common_share",
+  "common_success",
+  "common_warning",
+  "date_last_30_days",
+  "date_last_7_days",
+  "date_last_month",
+  "date_last_week",
+  "date_this_month",
+  "date_this_week",
+  "document_pdf_page_preview",
+  "err_code_1000",
+  "err_code_1001",
+  "err_code_1002",
+  "err_code_1003",
+  "err_code_1004",
+  "err_code_1005",
+  "err_code_12000",
+  "err_code_12001",
+  "err_code_12002",
+  "err_code_12003",
+  "err_code_12004",
+  "err_code_12005",
+  "err_code_12006",
+  "err_code_12007",
+  "err_code_12008",
+  "err_code_12009",
+  "err_code_12010",
+  "err_code_2000",
+  "err_code_2001",
+  "err_code_3000",
+  "err_code_3001",
+  "err_code_3002",
+  "err_code_3003",
+  "err_code_3004",
+  "err_code_3005",
+  "err_code_3006",
+  "err_code_3007",
+  "err_code_4000",
+  "err_code_4001",
+  "err_code_4002",
+  "err_code_4003",
+  "err_code_5000",
+  "err_code_5001",
+  "err_code_5002",
+  "err_code_5003",
+  "err_code_5004",
+  "err_code_6000",
+  "err_code_6001",
+  "err_code_6002",
+  "error_network_error",
+  "error_save_failed",
+  "error_server_error",
+  "error_timeout",
+  "error_unauthorized",
+  "error_unknown",
+  "error_video_too_short",
+  "permission_limited_access_add_more_media",
+  "permission_limited_access_add_more_photos",
+  "permission_limited_access_add_more_videos",
+  "permission_limited_access_warning",
+  "permission_location_reason",
+  "permission_media_reason",
+  "permission_network_reason",
+  "permission_wifi_reason",
+  "update_confirm",
+  "update_download_failed",
+  "update_downloading",
+  "update_message",
+  "update_title",
+  "video_quality",
+  "video_speed",
+] as const;
+
+export type I18nKey = (typeof I18N_KEYS)[number];

package/src/index.ts

@@ -9,17 +9,21 @@ export * from './device';
 export * from './display';
 export * from './input';
 export * from './storage';
-export * from './document';
+export * from './file';
 export * from './location';
 export * from './navigator';
 export * from './system';
 export * from './update';
 export * from './media';
 export * from './ui';
+export * from './error';
+export * from './generated/error';
+export * from './generated/i18n';
 
 import type {
   AppConfig,
   AppInstance,
+  LxAppInfo,
   PageConfig,
   PageInstance,
 } from './app';
@@ -42,11 +46,19 @@ import type {
   Storage,
 } from './storage';
 
-import type { OpenDocumentOptions } from './document';
+import type {
+  OpenDocumentOptions,
+  ChooseDirectoryOptions,
+  ChooseDirectoryResult,
+  ChooseFileOptions,
+  ChooseFileResult,
+  DownloadTask,
+  DownloadOptions,
+} from './file';
 
 import type {
-  AppOrientationInfo,
-  SetAppOrientationOptions,
+  DeviceOrientation,
+  DeviceOrientationChangeEvent,
 } from './display';
 
 import type {
@@ -78,6 +90,7 @@ import type {
   ChooseMediaOptions,
   ChosenMediaEntry,
   PreviewMediaOptions,
+  PreviewMediaResult,
   SaveMediaOptions,
   ScanCodeOptions,
   ScanCodeResult,
@@ -128,10 +141,12 @@ export interface Lx {
   onNetworkChange(callback: NetworkChangeCallback): void;
   offNetworkChange(callback?: NetworkChangeCallback): void;
 
-  getAppOrientation(): AppOrientationInfo;
-  setAppOrientation(options: SetAppOrientationOptions): boolean;
+  setDeviceOrientation(orientation: DeviceOrientation): boolean;
+  onDeviceOrientationChange(callback: (event: DeviceOrientationChangeEvent) => void): void;
+  offDeviceOrientationChange(callback?: (event: DeviceOrientationChangeEvent) => void): void;
 
   openDocument(options: OpenDocumentOptions): void;
+  downloadFile(options: DownloadOptions): DownloadTask;
 
   getStorage(): Storage;
 
@@ -141,6 +156,7 @@ export interface Lx {
   navigateBackLxApp(): Promise<void>;
 
   getAppBaseInfo(): AppBaseInfo;
+  getLxAppInfo(): LxAppInfo;
   getSystemSetting(): SystemSettingInfo;
   openURL(options: OpenURLOptions): void;
 
@@ -154,7 +170,19 @@ export interface Lx {
 
   chooseMedia(options?: ChooseMediaOptions): Promise<ChosenMediaEntry[]>;
 
-  previewMedia(options: PreviewMediaOptions): void;
+  /**
+   * Opens native media preview.
+   *
+   * Supports:
+   * - a single source path string for the simplest case
+   * - a single-item object for per-item options like `rotate`, `objectFit`, or `durationMs`
+   * - a sequence object for multi-item preview with `sources`, `startIndex`, and `advance`
+   *
+   * Resolves when preview session is closed (manual/auto/interrupted/error).
+   * Rejects with a cancellation error if `signal` is aborted, and abort also requests
+   * the active native preview session to close immediately.
+   */
+  previewMedia(options: PreviewMediaOptions): Promise<PreviewMediaResult>;
 
   saveImageToPhotosAlbum(options: SaveMediaOptions): Promise<void>;
   saveVideoToPhotosAlbum(options: SaveMediaOptions): Promise<void>;
@@ -197,6 +225,11 @@ export interface Lx {
 
   getCapsuleRect(): Promise<CapsuleRect>;
 
+  /** Desktop only. Currently supported on macOS. Windows is planned. */
+  chooseFile(options?: ChooseFileOptions): Promise<ChooseFileResult>;
+  /** Desktop only. Currently supported on macOS. Windows is planned. */
+  chooseDirectory(options?: ChooseDirectoryOptions): Promise<ChooseDirectoryResult>;
+
   onKeyDown(callback: KeyEventCallback): void;
   offKeyDown(callback?: KeyEventCallback): void;
   onKeyUp(callback: KeyEventCallback): void;

package/src/media/index.ts

@@ -179,14 +179,121 @@ export interface ChosenMediaEntry {
   isOriginal: boolean;
 }
 
-export interface PreviewMediaItem {
+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 poster image path for video preview.
+   * Uses the same path contract as `path`.
+   */
   coverPath?: string;
+  /**
+   * 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;
+  /**
+   * Image display duration in milliseconds.
+   * Effective only for image items and only when preview `advance` is not `manual`.
+   */
+  durationMs?: number;
 }
 
-export interface PreviewMediaOptions {
-  sources: PreviewMediaItem[];
+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;
 }
 
 export interface SaveMediaOptions {

package/src/system/index.ts

@@ -7,6 +7,7 @@ export interface AppBaseInfo {
   language: string;
   productName: string;
   version: string;
+  SDKVersion: string;
 }
 
 export interface SystemSettingInfo {
@@ -17,5 +18,5 @@ export interface SystemSettingInfo {
 
 export interface OpenURLOptions {
   url: string;
-  openIn?: 'external' | 'internal';
+  target?: 'self' | 'external';
 }

package/src/update/index.ts

@@ -5,6 +5,16 @@
 
 export interface UpdateManager {
   applyUpdate(): void;
-  onUpdateReady(callback: () => void): void;
-  onUpdateFailed(callback: () => void): void;
+  onUpdateReady(callback: (info: UpdateReadyInfo) => void): void;
+  onUpdateFailed(callback: (info: UpdateFailedInfo) => void): void;
+}
+
+export interface UpdateReadyInfo {
+  version?: string;
+  isForceUpdate?: boolean;
+  releaseType?: "release" | "preview" | "developer" | string;
+}
+
+export interface UpdateFailedInfo extends UpdateReadyInfo {
+  error?: string;
 }

package/dist/document/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * Document APIs
- * Corresponds to: lingxia-logic/src/fs.rs
- */
-export interface OpenDocumentOptions {
-    filePath: string;
-    fileType?: string;
-    showMenu?: boolean;
-}
-//# sourceMappingURL=index.d.ts.map

package/dist/document/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/document/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/src/document/index.ts

@@ -1,10 +0,0 @@
-/**
- * Document APIs
- * Corresponds to: lingxia-logic/src/fs.rs
- */
-
-export interface OpenDocumentOptions {
-  filePath: string;
-  fileType?: string;
-  showMenu?: boolean;
-}