@swipt/api 0.1.0-nightly.37 → 0.1.0-nightly.38

package/accessibility.d.ts

@@ -1,5 +1,4 @@
 import type { CallOptions, Point, Rect } from "./index";
-import type { TapOptions } from "./input";
 
 export type AccessibilityTrait = "button" | "link" | "image" | "playsSound" | "keyboardKey" | "staticText" | "summaryElement"
   | "updatesFrequently" | "searchField" | "startsMediaSession" | "adjustable" | "allowsDirectInteraction"
@@ -49,10 +48,6 @@ export interface AccessibilitySnapshot {
 type TextField = "role" | "class" | "label" | "value" | "identifier" | "placeholder" | "hint" | "url" | "app";
 type Flag = "disabled" | "focused" | "selected" | "expanded" | "secure" | "partial" | "offScreen" | "inert" | "remote";
 
-export type AccessibilityQuery = { traits?: AccessibilityTrait[]; within?: AccessibilityQuery; parent?: AccessibilityQuery; has?: AccessibilityQuery; not?: AccessibilityQuery; index?: number }
-  & { [field in TextField]?: string | RegExp }
-  & { [field in Flag]?: boolean };
-
 export type AccessibilitySelector =
   | ({ traits?: AccessibilityTrait[]; within?: AccessibilitySelector | AccessibilityElement; parent?: AccessibilitySelector | AccessibilityElement; has?: AccessibilitySelector | AccessibilityElement; not?: AccessibilitySelector | AccessibilityElement; index?: number }
     & { [field in TextField]?: string | RegExp }
@@ -64,20 +59,15 @@ export interface SnapshotOptions extends CallOptions {
   readonly full?: boolean;
 }
 
-export interface LocatorOptions extends CallOptions {
-  /** 10000 when omitted; Infinity waits without a limit. */
+export interface FindOptions extends CallOptions {
+  /** Omitted or 0 reads once; a positive number or Infinity reads until a match, and answers null at the limit. */
   readonly timeoutMs?: number;
+  /** Reads again as soon as a read ends. Without it, a read waits for the device's next screen push, which comes 0.75 s after a change at the soonest and not at all for a change that adds or removes no element. */
+  readonly poll?: boolean;
+  readonly pollTimeoutMs?: number;
 }
 
-export interface AccessibilityLocator {
-  tap(options?: LocatorOptions & TapOptions): Promise<void>;
-  /** Taps each element as it comes to match, once while it stays matched, and resolves when the app in front at the call leaves the front, at once if the query names only other apps. */
-  tapEach(options?: TapOptions): Promise<void>;
-  setText(text: string, options?: LocatorOptions): Promise<void>;
-  perform(action: AccessibilityAction | (string & {}), options?: LocatorOptions): Promise<void>;
-}
-
-export declare function locator(query: AccessibilityQuery | readonly AccessibilityQuery[]): AccessibilityLocator;
 export declare function snapshot(options?: SnapshotOptions): Promise<AccessibilitySnapshot>;
-export declare function find(selector: AccessibilitySelector, options?: CallOptions): Promise<AccessibilityElement | null>;
-export declare function tap(element: AccessibilityElement, options?: TapOptions): Promise<void>;
+export declare function find(selector: AccessibilitySelector | readonly AccessibilitySelector[], options?: FindOptions): Promise<AccessibilityElement | null>;
+export declare function setText(element: AccessibilityElement, text: string, options?: CallOptions): Promise<void>;
+export declare function perform(element: AccessibilityElement, action: AccessibilityAction | (string & {}), options?: CallOptions): Promise<void>;

package/accessibility.mjs

@@ -2,7 +2,7 @@ const outside = () => {
   throw new Error("@swipt/api/accessibility runs inside Swipt; build the swiplet with `swipt build`");
 };
 
-export const locator = outside;
 export const snapshot = outside;
 export const find = outside;
-export const tap = outside;
+export const setText = outside;
+export const perform = outside;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@swipt/api",
-  "version": "0.1.0-nightly.37",
+  "version": "0.1.0-nightly.38",
   "license": "GPL-3.0-or-later",
   "repository": {
     "type": "git",

package/screen.d.ts

@@ -1,4 +1,4 @@
-import type { CallOptions, ObservableState, Rect } from "./index";
+import type { CallOptions, ObservableState, Point, Rect } from "./index";
 import type { FileHandle } from "./file-system";
 import type { ImageDifference, RasterImage } from "./image";
 
@@ -18,10 +18,11 @@ export interface ScreenChange {
 }
 
 export type TimelineEvent =
-  | { readonly time: number; readonly type: "operation"; readonly name: string; readonly arguments?: readonly unknown[]; readonly durationMs?: number; readonly error?: string }
+  | { readonly time: number; readonly type: "operation"; readonly name: string; readonly arguments?: readonly unknown[]; readonly durationMs?: number; readonly error?: string; readonly message?: string; readonly swiplet?: string }
   | { readonly time: number; readonly type: "action"; readonly swiplet: string; readonly action: string; readonly caller: "app" | "shortcuts" | "api" }
   | { readonly time: number; readonly type: "foreground"; readonly app: string }
-  | { readonly time: number; readonly type: "log"; readonly swiplet: string; readonly level: "error" | "warn" | "info" | "debug"; readonly message: string };
+  | { readonly time: number; readonly type: "log"; readonly swiplet: string; readonly level: "error" | "warn" | "info" | "debug"; readonly message: string }
+  | { readonly time: number; readonly type: "feed"; readonly frames: number; readonly decodedMs: number };
 
 export interface ScreenRecording {
   readonly file: FileHandle;
@@ -37,6 +38,7 @@ export interface ScreenRecording {
   frames(times: readonly number[] | { readonly everyMs: number; readonly from?: number; readonly to?: number }): RasterImage[];
   grid(options?: CallOptions & { readonly times?: readonly number[]; readonly columns?: number; readonly width?: number }): Promise<RasterImage>;
   diff(from: number, to: number, options?: CallOptions & { readonly threshold?: number }): Promise<ImageDifference>;
+  find(target: ScreenTarget | readonly ScreenTarget[], options?: Omit<ScreenFindOptions, "timeoutMs"> & { readonly from?: number; readonly to?: number }): Promise<(ScreenMatch & { readonly time: number }) | null>;
   export(options?: CallOptions & {
     readonly file?: FileHandle | string;
     readonly from?: number;
@@ -54,7 +56,31 @@ export interface RecordingSession {
   stop(options?: CallOptions): Promise<ScreenRecording>;
 }
 
+export type ScreenTarget = RasterImage | RegExp | string;
+
+export interface ScreenFindOptions extends CallOptions {
+  readonly region?: Rect;
+  /** Omitted or 0 reads the latest frame once; a positive number or Infinity keeps reading frames until a match, and answers null at the limit. */
+  readonly timeoutMs?: number;
+  readonly threshold?: number;
+  readonly scales?: readonly number[];
+  readonly languages?: readonly string[];
+  readonly minimumHeight?: number;
+  /** Compares templates and the screen as black and white, split at this gray level, so a mark keeps matching over changing backgrounds. */
+  readonly binarize?: number;
+}
+
+export interface ScreenMatch {
+  readonly frame: Rect;
+  readonly center: Point;
+  readonly score: number;
+  readonly text: string | null;
+  readonly target: number;
+  readonly image: RasterImage;
+}
+
 export declare function screenshot(options?: CallOptions): Promise<RasterImage>;
+export declare function find(target: ScreenTarget | readonly ScreenTarget[], options?: ScreenFindOptions): Promise<ScreenMatch | null>;
 export declare const frames: ObservableState<RasterImage>;
 export declare function waitFor(predicate: (frame: RasterImage) => boolean | Promise<boolean>, options?: CallOptions & { readonly timeoutMs?: number }): Promise<RasterImage>;
 export declare function waitForChange(options?: WaitOptions & { readonly from?: RasterImage }): Promise<RasterImage>;

package/screen.mjs

@@ -3,6 +3,7 @@ const outside = () => {
 };
 
 export const screenshot = outside;
+export const find = outside;
 export const frames = undefined;
 export const waitFor = outside;
 export const waitForChange = outside;

package/swiplet.d.ts

@@ -106,3 +106,5 @@ export declare function actions<E extends Extension<any, any>>(): ActionCalls<E>
 export declare function useService<E extends Extension<any, true>>(): ServiceHandle;
 
 export declare function exit(): void;
+
+export declare function preferredLocalizations(localizations: readonly string[]): string[];

package/swiplet.mjs

@@ -7,3 +7,4 @@ export const defineAction = outside;
 export const actions = outside;
 export const useService = outside;
 export const exit = outside;
+export const preferredLocalizations = outside;