@spotterjs/node 0.1.0 → 1.0.0

package/README.md

@@ -1,50 +1,28 @@
-# @spotterjs/node
-
-spotterjs
-
-Node.js native addon (napi-rs) for Spotter. TypeScript definitions are **auto-generated** (`index.d.ts` via `npm run build`).
-
-
-
-## Capabilities
-
-
-
-| Area | N-API examples |
-
-|------|----------------|
-
-| Screen | `getScreenSize`, `captureScreen`, `captureWindow` |
-
-| Match | spotterjsmplate(path, needleBuffer?, opts?)`, `findAllTemplates`, `waitForTemplate`, `findTemplateBuffers` |
-
-| Window match | `findTemplateInWindow`, `findAllTemplatesInWindow` (optional `needleBuffer`) |
-
-| Window | `listWindows`, `getActiveWindow`, `focusWindow`, `moveWindow`, `resizeWindow`, … |
-
-| Desktop apps | `listDesktopApps`, `findDesktopApps`, `findWindowsByTitle`, `waitForWindowByTitle` |
-
-| Input | `mouseMove`, `mouseClick`, `setMouseConfig`, `keyboardTypeText`, `clipboardGet`, … |
-
-| Accessibility | `accessibilityEnable`, `accessibilityFind`, `accessibilityInvoke`, … |
-
-
-
-Platforms (prebuilt on publish): `x86_64-pc-windows-msvc`, `x86_64-unknown-linux-gnu`.
-
-
-
-Prefer [`@spotterjs/core`](../../packages/core) (`screen`, `mouse`, `windowApi`, …) over calling this package directly.
-
-
-
-See [docs/MATCHING.md](../../docs/MATCHING.md) for template matching usage.
-
-
-
-## License
-
-
-
-See [LICENSE](../../LICENSE).
-
+# @spotterjs/node
+
+Node.js native addon (napi-rs) for spotterjs. TypeScript definitions are auto-generated (`index.d.ts` via `npm run build`).
+
+## Capabilities
+
+| Area | N-API examples |
+|------|----------------|
+| Screen | `getScreenSize`, `captureScreen`, `captureWindow` |
+| Match | `findTemplate(path, needleBuffer?, opts?)`, `findAllTemplates`, `waitForTemplate`, `findTemplateBuffers` |
+| Window match | `findTemplateInWindow`, `findAllTemplatesInWindow` (optional `needleBuffer`) |
+| Window | `listWindows`, `getActiveWindow`, `focusWindow`, `moveWindow`, `resizeWindow` |
+| Desktop apps | `listDesktopApps`, `findDesktopApps`, `findWindowsByTitle`, `waitForWindowByTitle` |
+| Input | `mouseMove`, `mouseClick`, `setMouseConfig`, `keyboardTypeText`, `clipboardGet` |
+| Accessibility | `accessibilityEnable`, `accessibilityFind`, `accessibilityInvoke` |
+
+Platform binaries are installed through optional npm packages:
+
+- `@spotterjs/node-win32-x64-msvc`
+- `@spotterjs/node-linux-x64-gnu`
+
+Prefer [`@spotterjs/core`](../../packages/core) (`screen`, `mouse`, `windowApi`) over calling this package directly.
+
+See [docs/MATCHING.md](../../docs/MATCHING.md) for template matching usage.
+
+## License
+
+See [LICENSE](../../LICENSE).

package/index.d.ts

@@ -9,6 +9,10 @@ export interface JsRegion {
   width: number
   height: number
 }
+export interface JsMatchResult {
+  region: JsRegion
+  score: number
+}
 export interface JsCaptureImage {
   data: Buffer
   width: number
@@ -66,6 +70,7 @@ export interface JsImageSize {
   height: number
 }
 export declare function loadImageFromPath(path: string): JsCaptureImage
+export declare function loadImageFromBuffer(bytes: Buffer): JsCaptureImage
 export declare function getImageSize(path: string): JsImageSize
 export declare function encodeCapturePng(capture: JsCaptureImage): Buffer
 export declare function encodeCapturePngBase64(capture: JsCaptureImage): string
@@ -84,14 +89,14 @@ export declare function findDesktopApps(substring: string): Array<JsDesktopApp>
 export declare function findWindowsByTitle(substring: string): Array<JsWindowInfo>
 export declare function waitForWindowByTitle(substring: string, timeoutMs: number, pollMs?: number | undefined | null): JsWindowInfo
 export declare function getForegroundApp(): JsDesktopApp
-export declare function findTemplate(path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): JsRegion
-export declare function findAllTemplates(path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): Array<JsRegion>
-export declare function findTemplateInWindow(id: string, path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): JsRegion
-export declare function findAllTemplatesInWindow(id: string, path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): Array<JsRegion>
-export declare function waitForTemplate(path: string, needleBuffer: Buffer | undefined | null, timeoutMs: number, opts?: JsMatchOptions | undefined | null, intervalMs?: number | undefined | null): JsRegion
-export declare function findTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, opts?: JsMatchOptions | undefined | null): JsRegion
-export declare function findAllTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, opts?: JsMatchOptions | undefined | null): Array<JsRegion>
-export declare function waitForTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, timeoutMs: number, opts?: JsMatchOptions | undefined | null, intervalMs?: number | undefined | null): JsRegion
+export declare function findTemplate(path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): JsMatchResult
+export declare function findAllTemplates(path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): Array<JsMatchResult>
+export declare function findTemplateInWindow(id: string, path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): JsMatchResult
+export declare function findAllTemplatesInWindow(id: string, path: string, needleBuffer?: Buffer | undefined | null, opts?: JsMatchOptions | undefined | null): Array<JsMatchResult>
+export declare function waitForTemplate(path: string, needleBuffer: Buffer | undefined | null, timeoutMs: number, opts?: JsMatchOptions | undefined | null, intervalMs?: number | undefined | null): JsMatchResult
+export declare function findTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, opts?: JsMatchOptions | undefined | null): JsMatchResult
+export declare function findAllTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, opts?: JsMatchOptions | undefined | null): Array<JsMatchResult>
+export declare function waitForTemplateBuffers(haystack: JsCaptureImage, needle: JsCaptureImage, timeoutMs: number, opts?: JsMatchOptions | undefined | null, intervalMs?: number | undefined | null): JsMatchResult
 export declare function setMouseConfig(config: JsMouseConfig): void
 export declare function getPosition(): JsPoint
 export declare function mouseMove(x: number, y: number): void

package/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { version, getScreenSize, getScreenWidth, getScreenHeight, captureScreen, captureWindow, loadImageFromPath, getImageSize, encodeCapturePng, encodeCapturePngBase64, listWindows, getActiveWindow, focusWindow, getWindowRegion, getWindowRegionClamped, getWindowClientOrigin, moveWindow, resizeWindow, minimizeWindow, restoreWindow, listDesktopApps, findDesktopApps, findWindowsByTitle, waitForWindowByTitle, getForegroundApp, findTemplate, findAllTemplates, findTemplateInWindow, findAllTemplatesInWindow, waitForTemplate, findTemplateBuffers, findAllTemplateBuffers, waitForTemplateBuffers, setMouseConfig, getPosition, mouseMove, mouseMovePath, mouseMoveStraight, mouseClick, mouseDoubleClick, mousePress, mouseRelease, mouseDrag, mouseScrollUp, mouseScrollDown, mouseScrollLeft, mouseScrollRight, tapAt, setKeyboardConfig, keyboardTypeText, keyboardPressKeys, keyboardReleaseKeys, keyboardTypeKey, keyboardShortcut, clipboardSet, clipboardGet, accessibilityEnable, accessibilityDisable, accessibilityIsEnabled, accessibilityAttachWindow, accessibilityAttachWindowReport, accessibilityAttachActive, accessibilityFind, accessibilityWaitFor, accessibilityGetBounds, accessibilityInvoke, accessibilitySetValue, accessibilityDumpTree, accessibilityDumpTreeObject, accessibilityGetElementInfo, accessibilityRefreshRoot, accessibilityTreeHealth, accessibilityCheckTreeHealth } = nativeBinding
+const { version, getScreenSize, getScreenWidth, getScreenHeight, captureScreen, captureWindow, loadImageFromPath, loadImageFromBuffer, getImageSize, encodeCapturePng, encodeCapturePngBase64, listWindows, getActiveWindow, focusWindow, getWindowRegion, getWindowRegionClamped, getWindowClientOrigin, moveWindow, resizeWindow, minimizeWindow, restoreWindow, listDesktopApps, findDesktopApps, findWindowsByTitle, waitForWindowByTitle, getForegroundApp, findTemplate, findAllTemplates, findTemplateInWindow, findAllTemplatesInWindow, waitForTemplate, findTemplateBuffers, findAllTemplateBuffers, waitForTemplateBuffers, setMouseConfig, getPosition, mouseMove, mouseMovePath, mouseMoveStraight, mouseClick, mouseDoubleClick, mousePress, mouseRelease, mouseDrag, mouseScrollUp, mouseScrollDown, mouseScrollLeft, mouseScrollRight, tapAt, setKeyboardConfig, keyboardTypeText, keyboardPressKeys, keyboardReleaseKeys, keyboardTypeKey, keyboardShortcut, clipboardSet, clipboardGet, accessibilityEnable, accessibilityDisable, accessibilityIsEnabled, accessibilityAttachWindow, accessibilityAttachWindowReport, accessibilityAttachActive, accessibilityFind, accessibilityWaitFor, accessibilityGetBounds, accessibilityInvoke, accessibilitySetValue, accessibilityDumpTree, accessibilityDumpTreeObject, accessibilityGetElementInfo, accessibilityRefreshRoot, accessibilityTreeHealth, accessibilityCheckTreeHealth } = nativeBinding
 
 module.exports.version = version
 module.exports.getScreenSize = getScreenSize
@@ -319,6 +319,7 @@ module.exports.getScreenHeight = getScreenHeight
 module.exports.captureScreen = captureScreen
 module.exports.captureWindow = captureWindow
 module.exports.loadImageFromPath = loadImageFromPath
+module.exports.loadImageFromBuffer = loadImageFromBuffer
 module.exports.getImageSize = getImageSize
 module.exports.encodeCapturePng = encodeCapturePng
 module.exports.encodeCapturePngBase64 = encodeCapturePngBase64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spotterjs/node",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "spotterjs desktop automation for Node.js",
   "main": "index.js",
   "types": "index.d.ts",
@@ -21,7 +21,6 @@
   "files": [
     "index.js",
     "index.d.ts",
-    "index.*.node",
     "LICENSE",
     "README.md"
   ],
@@ -43,5 +42,9 @@
   },
   "devDependencies": {
     "@napi-rs/cli": "^2.18.0"
+  },
+  "optionalDependencies": {
+    "@spotterjs/node-win32-x64-msvc": "1.0.0",
+    "@spotterjs/node-linux-x64-gnu": "1.0.0"
   }
 }