feat: add mm properties to AnalyzeResult

Author: tahmarrrr23

README.md

@@ -53,7 +53,9 @@ console.log(result.elements);
 //     height: 18,             // Element height in CSS pixels
 //     left: 32,               // X position from left edge
 //     top: 200.875,           // Y position from top edge
-//     tapSuccessRate: 0.8497559260608007  // Success rate (0-1, where 1 is 100%)
+//     widthMm: 22.69...,      // Element width in millimeters
+//     heightMm: 2.98...,      // Element height in millimeters
+//     tapSuccessRate: 0.84... // Success rate (0-1, where 1 is 100%)
 //   }
 // ]
 

src/tappy.ts

@@ -17,16 +17,22 @@ export class Tappy {
     const html = await this.adapter.getHtml();
 
     const resultElements = elements.map((element) => {
-      const mmWidth = pixelToMm(element.width, device.ppi, device.scaleFactor);
-      const mmHeight = pixelToMm(element.height, device.ppi, device.scaleFactor);
-      const sigmaX = Math.sqrt(0.0091 * mmWidth ** 2 + 1.0949);
-      const sigmaY = Math.sqrt(0.0149 * mmHeight ** 2 + 0.9414);
+      const widthMm = pixelToMm(element.width, device.ppi, device.scaleFactor);
+      const heightMm = pixelToMm(
+        element.height,
+        device.ppi,
+        device.scaleFactor,
+      );
+      const sigmaX = Math.sqrt(0.0091 * widthMm ** 2 + 1.0949);
+      const sigmaY = Math.sqrt(0.0149 * heightMm ** 2 + 0.9414);
       const tapSuccessRate =
-        erf(mmWidth / (2 * Math.sqrt(2) * sigmaX)) *
-        erf(mmHeight / (2 * Math.sqrt(2) * sigmaY));
+        erf(widthMm / (2 * Math.sqrt(2) * sigmaX)) *
+        erf(heightMm / (2 * Math.sqrt(2) * sigmaY));
 
       return {
         ...element,
+        widthMm: widthMm,
+        heightMm: heightMm,
         tapSuccessRate: tapSuccessRate,
       };
     });

src/types.ts

@@ -83,7 +83,11 @@ export interface Adapter {
  */
 export type AnalyzeResult = {
   device: Device;
-  elements: (TappableElement & { tapSuccessRate: number })[];
+  elements: (TappableElement & {
+    widthMm: number;
+    heightMm: number;
+    tapSuccessRate: number;
+  })[];
   screenshot: string;
   html: string;
 };

test/tappy.test.ts

@@ -46,6 +46,10 @@ describe("Tappy", () => {
 
     expect(result.elements[0]).toBeDefined();
     expect(result.elements[1]).toBeDefined();
+    expect(result.elements[0]).toHaveProperty("widthMm");
+    expect(result.elements[1]).toHaveProperty("widthMm");
+    expect(result.elements[0]).toHaveProperty("heightMm");
+    expect(result.elements[1]).toHaveProperty("heightMm");
     expect(result.elements[0]).toHaveProperty("tapSuccessRate");
     expect(result.elements[1]).toHaveProperty("tapSuccessRate");