webmarker-js 0.0.4 → 0.0.5

package/README.md

@@ -17,7 +17,7 @@ Mark web pages for use with vision-language models.
 
 ## Usage
 
-The `mark()` function will add markings for all interactive elements on a web page, and return a Map of the marked elements. The returned Map's keys are the mark labels, and the values are an object with the element (`element`), mark element (`markElement`), and mask element (`markElement`).
+The `mark()` function will add markings for all interactive elements on a web page, and return an object containing the marked elements. The returned objects's keys are the mark labels, and the values are an object with the element (`element`), mark element (`markElement`), and mask element (`maskElement`).
 
 ```javascript
 import { mark, unmark } from "webmarker-js";
@@ -26,7 +26,7 @@ import { mark, unmark } from "webmarker-js";
 let elements = await mark();
 
 // Reference an element by label
-console.log(elements.get("0").element);
+console.log(elements["0"].element);
 
 // Remove markings
 unmark();

package/dist/{types.d.ts → index.d.ts}

@@ -1,5 +1,5 @@
-export type Placement = "top" | "top-start" | "top-end" | "right" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end";
-export interface MarkOptions {
+type Placement = "top" | "top-start" | "top-end" | "right" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end";
+interface MarkOptions {
     /**
      * A CSS selector to specify the elements to be marked.
      */
@@ -44,13 +44,13 @@ export interface MarkOptions {
      */
     viewPortOnly?: boolean;
 }
-export interface MarkedElement {
+interface MarkedElement {
     element: Element;
     markElement: HTMLElement;
     maskElement?: HTMLElement;
 }
-export function mark(options?: MarkOptions): Promise<Map<string, MarkedElement>>;
-export function unmark(): void;
-export function isMarked(): boolean;
-
-//# sourceMappingURL=types.d.ts.map
+declare function mark(options?: MarkOptions): Promise<Record<string, MarkedElement>>;
+declare function unmark(): void;
+declare function isMarked(): boolean;
+export { mark, unmark, isMarked };
+export type { MarkOptions, MarkedElement, Placement };