@lingxia/types 0.10.0 → 0.11.1

package/src/transfer/index.ts

@@ -1,194 +0,0 @@
-/**
- * Transfer task APIs.
- */
-
-declare const appDownloadPathBrand: unique symbol;
-declare const systemDownloadsPathBrand: unique symbol;
-
-export type DownloadDestination = 'app' | 'downloads';
-
-/** Runtime-managed app download path, usually under `lx://userdata`. */
-export type AppDownloadFilePath = string & {
-  readonly [appDownloadPathBrand]: 'app-download-file-path';
-};
-
-/** Native system Downloads path. Do not pass this to `FileManager`. */
-export type SystemDownloadsPath = string & {
-  readonly [systemDownloadsPathBrand]: 'system-downloads-path';
-};
-
-export interface DownloadOptionsBase {
-  /** HTTP(S) source URL. */
-  url: string;
-  /**
-   * Optional request headers.
-   * Restricted headers such as `Referer` are ignored by the runtime.
-   */
-  headers?: Record<string, string>;
-  /** Request timeout in milliseconds. */
-  timeout?: number;
-  /** Optional abort signal. */
-  signal?: AbortSignal;
-}
-
-export interface AppDownloadOptions extends DownloadOptionsBase {
-  /**
-   * Optional app-owned durable output path.
-   *
-   * Omit `filePath` to receive a temporary result in `tempFilePath`. Relative
-   * paths resolve under user data. `lx://` paths must target `lx://userdata`;
-   * `lx://usercache` is not accepted here.
-   */
-  filePath?: string;
-  /**
-   * App-owned output. Omit to use a temporary output unless `filePath` is set.
-   */
-  destination?: 'app';
-}
-
-export interface DownloadsDownloadOptions extends DownloadOptionsBase {
-  /**
-   * Optional filename hint for the system Downloads destination.
-   * This is not an app-owned FileManager path.
-   */
-  filePath?: string;
-  /** Save into the user's system Downloads directory. */
-  destination: 'downloads';
-}
-
-/**
- * Download options.
- *
- * - `app`: app-owned temporary output, or durable `lx://userdata` output when
- *   `filePath` is set
- * - `downloads`: user-visible system Downloads output, requiring
- *   `security.privileges: ["downloads"]` in `lxapp.json`
- *
- * Default: `app`.
- */
-export type DownloadOptions<TDestination extends DownloadDestination = DownloadDestination> =
-  TDestination extends 'downloads' ? DownloadsDownloadOptions : AppDownloadOptions;
-
-export type DownloadResultForDestination<TDestination extends DownloadDestination> =
-  TDestination extends 'downloads' ? DownloadsDownloadResult : AppDownloadResult;
-
-export interface DownloadProgressEvent<TResult extends DownloadResult = DownloadResult> {
-  kind: 'progress' | 'paused' | 'resumed' | 'canceled' | 'completed';
-  downloadedBytes?: number;
-  totalBytes?: number;
-  /** Present only when the total size is known. */
-  progress?: number;
-  result?: TResult;
-}
-
-export interface DownloadIteratorResult<TResult extends DownloadResult = DownloadResult> {
-  done: boolean;
-  value?: DownloadProgressEvent<TResult>;
-}
-
-export type AppDownloadResult =
-  | {
-      /**
-       * Temporary result.
-       *
-       * Not durable; move or copy it to `lx://userdata` if you need to keep it.
-       *
-       * When `filePath` is omitted, the runtime must be able to infer a file
-       * type from the URL or the server's `Content-Type` header.
-       */
-      tempFilePath: string;
-      filePath?: never;
-      mimeType?: string;
-      size: number;
-    }
-  | {
-      /** Durable destination under `lx://userdata`. */
-      filePath: AppDownloadFilePath;
-      tempFilePath?: never;
-      mimeType?: string;
-      size: number;
-    };
-
-export interface DownloadsDownloadResult {
-  /** Native system Downloads path. Do not pass this to `FileManager`. */
-  filePath: SystemDownloadsPath;
-  tempFilePath?: never;
-  mimeType?: string;
-  size: number;
-}
-
-export type DownloadResult = AppDownloadResult | DownloadsDownloadResult;
-
-export interface DownloadTask<TDownloadResult extends DownloadResult = DownloadResult>
-  extends PromiseLike<TDownloadResult>,
-    AsyncIterable<DownloadProgressEvent<TDownloadResult>> {
-  next(): Promise<DownloadIteratorResult<TDownloadResult>>;
-  /** Stops iteration only. Does not cancel the underlying download task. */
-  return(): Promise<DownloadIteratorResult<TDownloadResult>>;
-  catch<TRejected = never>(
-    onrejected?: ((reason: unknown) => TRejected | PromiseLike<TRejected>) | null,
-  ): Promise<TDownloadResult | TRejected>;
-  finally(onfinally?: (() => void) | null): Promise<TDownloadResult>;
-  pause(): Promise<void>;
-  resume(): Promise<void>;
-  cancel(): Promise<void>;
-  /** Alias for cancel(), matching browser/mini-program abort naming. */
-  abort(): Promise<void>;
-  wait(): Promise<TDownloadResult>;
-}
-
-export interface UploadOptions {
-  /** HTTP(S) destination URL. */
-  url: string;
-  /** Local file path or runtime-managed URI to upload. */
-  filePath: string;
-  /** Multipart field name. Default: `file`. */
-  name?: string;
-  /**
-   * Optional request headers.
-   * Restricted headers such as `Referer` are ignored by the runtime.
-   */
-  headers?: Record<string, string>;
-  /** Optional extra `multipart/form-data` text fields. */
-  formData?: Record<string, string>;
-  /** Request timeout in milliseconds. */
-  timeout?: number;
-  /** Override multipart filename. */
-  fileName?: string;
-  /** Override file MIME type. */
-  mimeType?: string;
-  /** Optional abort signal. */
-  signal?: AbortSignal;
-}
-
-export interface UploadProgressEvent {
-  kind: 'progress' | 'canceled' | 'completed';
-  uploadedBytes?: number;
-  totalBytes?: number;
-  progress?: number;
-  result?: UploadResult;
-}
-
-export interface UploadIteratorResult {
-  done: boolean;
-  value?: UploadProgressEvent;
-}
-
-export interface UploadResult {
-  /** HTTP status code returned by the server. */
-  statusCode: number;
-  /** Response body decoded as UTF-8 text. */
-  data: string;
-}
-
-export interface UploadTask extends PromiseLike<UploadResult>, AsyncIterable<UploadProgressEvent> {
-  next(): Promise<UploadIteratorResult>;
-  /** Stops iteration only. Does not cancel the underlying upload task. */
-  return(): Promise<UploadIteratorResult>;
-  catch<TResult = never>(
-    onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null,
-  ): Promise<UploadResult | TResult>;
-  finally(onfinally?: (() => void) | null): Promise<UploadResult>;
-  cancel(): Promise<void>;
-  wait(): Promise<UploadResult>;
-}

package/src/ui/index.ts

@@ -1,165 +0,0 @@
-/**
- * UI feedback, navigation, and surface control APIs.
- */
-
-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 type PageQueryValue = string | number | boolean | null | undefined;
-export type PageQuery = Record<string, PageQueryValue>;
-
-/**
- * Target page for `navigateTo` / `redirectTo` / `switchTab` / `reLaunch`.
- *
- * Pass **exactly one** of `page` or `path` — there is **no `url` field**:
- * - `page` — a configured page **name** from `lingxia.yaml` / `lxapp.json`
- *   (e.g. `"pullToRefresh"`), resolved to its route by the page registry.
- * - `path` — the full page **route**, e.g. `"/pages/pulltorefresh/index"`.
- *
- * Both are discoverable with `lxdev lxapp pages`, which lists every page's
- * `name` and `path`; `lxdev lxapp nav to|relaunch|redirect|switch-tab <name>`
- * drives navigation by name when automating.
- */
-export type PageTargetOptions =
-  | {
-      /**
-       * Configured page **name** from `lingxia.yaml` / `lxapp.json`
-       * (e.g. `"pullToRefresh"`). Mutually exclusive with `path`.
-       */
-      page: string;
-      path?: never;
-      query?: PageQuery;
-    }
-  | {
-      /**
-       * Full page **route**, e.g. `"/pages/pulltorefresh/index"`.
-       * Mutually exclusive with `page`.
-       */
-      path: string;
-      page?: never;
-      query?: PageQuery;
-    };
-
-export type NavigateToOptions = PageTargetOptions;
-
-export interface NavigateBackOptions {
-  delta: number;
-}
-
-export type RedirectToOptions = PageTargetOptions;
-
-export type SwitchTabOptions = PageTargetOptions;
-
-export type ReLaunchOptions = PageTargetOptions;
-
-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;
-}
-
-// ── Adaptive Surface Layout ─────────────────────────────────────────────────
-// The form is expressed by the `as` field on `lx.openSurface({ page, as })`; the
-// Host arbitrates the realized platform form (split pane on larger screens,
-// full-screen drill-in on compact screens).
-
-/**
- * Size hint for an overlay surface (aside / float).
- *
- * - number: absolute px, must be > 0
- * - `${number}%`: percentage of the container, 0 < N ≤ 100
- */
-export type OverlaySurfaceSizeValue = number | `${number}%`;
-
-export interface OverlaySurfaceSize {
-  /** Width hint. */
-  width?: OverlaySurfaceSizeValue;
-  /** Height hint. */
-  height?: OverlaySurfaceSizeValue;
-}
-
-/** Edge an aside docks to; the Host decides the realized form by screen size. */
-export type SurfaceEdge = 'left' | 'right' | 'top' | 'bottom';
-
-/** Where a float popup anchors (default `center`). */
-export type SurfaceFloatPosition = 'center' | 'top' | 'bottom' | 'left' | 'right';
-
-/**
- * The window's adaptive context, delivered to `lx.onSurfaceContext()` so an
- * lxapp can self-adapt (e.g. switch column count by `sizeClass`).
- */
-export interface SurfaceContext {
-  /** compact (<600) / medium (600–840) / expanded (>840), with hysteresis. */
-  sizeClass: 'compact' | 'medium' | 'expanded';
-  /** In compact, the bottom region belongs to the app content. */
-  bottomOwner: 'app';
-}
-
-export interface CapsuleRect {
-  width?: number;
-  height?: number;
-  top?: number;
-  right?: number;
-  bottom?: number;
-  left?: number;
-}

package/src/update/index.ts

@@ -1,19 +0,0 @@
-/**
- * Runtime update APIs.
- */
-
-export interface UpdateManager {
-  applyUpdate(): void;
-  onUpdateReady(callback: (info: UpdateReadyInfo) => void): void;
-  onUpdateFailed(callback: (info: UpdateFailedInfo) => void): void;
-}
-
-export interface UpdateReadyInfo {
-  version?: string;
-  isForceUpdate?: boolean;
-  channel?: "release" | "preview" | "developer" | string;
-}
-
-export interface UpdateFailedInfo extends UpdateReadyInfo {
-  error?: string;
-}