@aiscene/shared 1.6.0

package/src/types/index.ts

@@ -0,0 +1,52 @@
+import type { NodeType } from '../constants';
+import type { ElementInfo } from '../extractor';
+
+export interface Point {
+  left: number;
+  top: number;
+}
+
+export interface Size {
+  width: number; // The image sent to AI model will be resized to this width, also the coordinates in the action space will be scaled to the range [0, width]. Usually you should set it to the logical pixel size
+  height: number; // The image sent to AI model will be resized to this height, also the coordinates in the action space will be scaled to the range [0, height]. Usually you should set it to the logical pixel size
+}
+
+export type Rect = Point & Size;
+
+export abstract class BaseElement {
+  abstract id: string;
+
+  // abstract indexId?: number; // markerId for web
+
+  abstract attributes: {
+    nodeType: NodeType;
+    [key: string]: string;
+  };
+
+  abstract content: string;
+
+  abstract rect: Rect;
+
+  abstract center: [number, number];
+
+  // abstract xpaths?: string[];
+
+  abstract isVisible: boolean;
+}
+
+export interface ElementTreeNode<
+  ElementType extends BaseElement = BaseElement,
+> {
+  node: ElementType | null;
+  children: ElementTreeNode<ElementType>[];
+}
+
+export interface WebElementInfo extends ElementInfo {
+  zoom: number;
+}
+
+export type LocateResultElement = {
+  description: string; // the description of the element
+  center: [number, number];
+  rect: Rect;
+};