feat: options for moveTo (#133)

README.md

@@ -82,7 +82,7 @@ Creates the ghost cursor. Returns cursor action functions.
 - **page:** Puppeteer `page`.
 - **start (optional):** Cursor start position. Default is `{ x: 0, y: 0 }`.
 - **performRandomMoves (optional):** Initially perform random movements. Default is `false`.
-- **defaultOptions (optional):** Set custom default options for `click`, `move`, and `randomMove` functions. Default values are described below.
+- **defaultOptions (optional):** Set custom default options for `click`, `move`, `moveTo`, and `randomMove` functions. Default values are described below.
 
 #### `toggleRandomMove(random: boolean): void`
 
@@ -111,11 +111,13 @@ Moves the mouse to the specified selector or element.
   - `moveSpeed (number):` Speed of mouse movement. Default is random.
   - `overshootThreshold (number):` Distance from current location to destination that triggers overshoot to occur. (Below this distance, no overshoot will occur). Default is `500`.
 
-#### `moveTo(destination: Vector): Promise<void>`
+#### `moveTo(destination: Vector, options?: MoveToOptions): Promise<void>`
 
 Moves the mouse to the specified destination point.
 
 - **destination:** An object with `x` and `y` coordinates representing the target position. For example, `{ x: 500, y: 300 }`.
+- **options (optional):** Additional options for moving.
+  - `moveSpeed (number):` Speed of mouse movement. Default is random.
 
 #### `getLocation(): Vector`
 

src/spoof.ts

@@ -74,14 +74,16 @@ export interface PathOptions {
   readonly moveSpeed?: number
 }
 
-interface RandomMoveOptions extends Pick<MoveOptions, 'moveDelay' | 'moveSpeed'> {
+export interface RandomMoveOptions extends Pick<MoveOptions, 'moveDelay' | 'moveSpeed'> {
   /**
    * @extends moveDelay
    * @default 2000
    */
   readonly moveDelay?: number
 }
 
+export interface MoveToOptions extends PathOptions {}
+
 export interface GhostCursor {
   toggleRandomMove: (random: boolean) => void
   click: (
@@ -92,7 +94,7 @@ export interface GhostCursor {
     selector: string | ElementHandle,
     options?: MoveOptions
   ) => Promise<void>
-  moveTo: (destination: Vector) => Promise<void>
+  moveTo: (destination: Vector, options?: MoveToOptions) => Promise<void>
   getLocation: () => Vector
 }
 
@@ -283,6 +285,11 @@ export const createCursor = (
      * @default MoveOptions
      */
     move?: MoveOptions
+    /**
+     * Default options for the `moveTo` function
+     * @default MoveToOptions
+     */
+    moveTo?: MoveToOptions
     /**
      * Default options for the `click` function
      * @default ClickOptions
@@ -494,10 +501,15 @@ export const createCursor = (
 
       await delay(Math.random() * optionsResolved.moveDelay)
     },
-    async moveTo (destination: Vector): Promise<void> {
+    async moveTo (destination: Vector, options?: MoveToOptions): Promise<void> {
+      const optionsResolved = {
+        ...defaultOptions?.moveTo,
+        ...options
+      } satisfies MoveToOptions
+
       const wasRandom = !moving
       actions.toggleRandomMove(false)
-      await tracePath(path(previous, destination))
+      await tracePath(path(previous, destination, optionsResolved))
       actions.toggleRandomMove(wasRandom)
     }
   }