@simular-ai/simulib-js 5.4.3

package/examples/log-window.mjs

@@ -0,0 +1,57 @@
+// Run: node examples/log-window.mjs
+// You can configure logging via RUST_LOG:
+//   RUST_LOG=simulib_rs=debug,info node examples/log-window.mjs
+//
+// Pipes every Rust-side `log::*!` record from simulib-rs into a floating,
+// always-on-top log window. The window comes from the sibling package
+// `@simular-ai/simulib-log-viewer`, which is an optional peer dependency
+// — install it explicitly to run this example:
+//   npm install @simular-ai/simulib-log-viewer
+//
+// The window is **click-through by default**, so it never interferes with
+// the app you're driving — every mouse click passes straight through. To
+// move it or pause execution, press the global grab hotkey shown inside
+// the window (Ctrl+Shift+Option+L on macOS, Ctrl+Shift+Alt+L elsewhere).
+// Press it once to enter "grab mode" (click-through off, paused, draggable);
+// press it again to resume.
+//
+// Inside an automation loop, `await win.waitIfPaused()` yields cleanly
+// while the user has paused; it returns immediately otherwise.
+
+import { Clipboard, screenshotFull, Screen, initLogger } from '@simular-ai/simulib-js'
+import { LogWindow } from '@simular-ai/simulib-log-viewer'
+
+const win = new LogWindow()
+win.spawn()
+
+// `'info'` mirrors `RUST_LOG=info`. Use e.g. `'simulib_rs=debug,warn'` to
+// scope per-module. Omit the second argument to fall back to `RUST_LOG`.
+initLogger((rec) => {
+  const line = `[${rec.level}] [${rec.target}] ${rec.message}`
+  console.log(line)
+  win.log(line)
+}, 'info')
+
+// Run a few simulib-js calls so there's actually something to look at.
+win.log('--- starting clipboard demo ---')
+try {
+  const cb = new Clipboard()
+  const previous = cb.setString('hello from simulib-js')
+  win.log(`clipboard now contains: ${cb.getString()}`)
+  if (previous !== null) cb.setString(previous)
+
+  win.log('--- starting screenshot demo ---')
+  const shot = screenshotFull(true, Screen.mainScreen())
+  shot.shrink(640, 480)
+  win.log(`captured ${shot.base64().length} bytes (base64)`)
+} catch (err) {
+  win.log(`demo failed: ${err instanceof Error ? err.message : String(err)}`)
+}
+
+win.log('done. Holding window open for 30s — press the grab hotkey to pause.')
+await new Promise((resolve) => setTimeout(resolve, 30_000))
+// In real automation, scatter `await win.waitIfPaused()` between actions
+// so the script yields whenever the user has grabbed the window.
+await win.waitIfPaused()
+
+win.close()

package/examples/logger.mjs

@@ -0,0 +1,33 @@
+// Run: node examples/logger.mjs
+// Or with a per-module spec:
+//   RUST_LOG=simulib_rs::windows=debug,warn node examples/logger.mjs
+//
+// `initLogger()` accepts an optional JS callback. Without one, records go to
+// stderr (analogous to the env_logger crate's default). With a callback, each record is forwarded
+// from any Rust thread to your sink — useful for routing logs into a GUI
+// panel, a file appender, pino/winston, or an Electron renderer over IPC.
+//
+// This example shows the callback form. For the env_logger-style default
+// sink, just call `initLogger()` with no arguments.
+
+import { initLogger, readFile } from '@simular-ai/simulib-js'
+
+initLogger((record) => {
+  // Records carry { level, target, message, file?, line?, modulePath? }.
+  // Route however you like — here we just prefix and forward to console.
+  console.log(`[${record.level}] [${record.target}] ${record.message}`)
+})
+
+// Trigger something so we have at least one record to look at.
+try {
+  readFile('/tmp/this/file/probably/does/not/exist')
+} catch {
+  // expected — we just want to exercise the code paths that may log.
+}
+
+// The JS callback dispatch is unref'd (so the logger never keeps Node alive
+// on its own). For a short-lived script that does its work and exits
+// immediately, that means pending records may be dropped. A long-running
+// app like an Electron GUI or a server doesn't need this; here we yield to
+// libuv once so the dispatch queue can drain before exit.
+await new Promise((resolve) => setImmediate(resolve))

package/examples/loopback.mjs

@@ -0,0 +1,41 @@
+// Run: node examples/loopback.mjs <audio-file>
+//
+// Plays an audio file through the speakers while capturing system audio
+// via loopback, then transcribes the captured audio using Whisper.
+//
+// Requires screen-recording permission on macOS (for loopback capture).
+
+import { AudioOutput, LoopbackSource, SttModel } from '@simular-ai/simulib-js'
+
+const audioFile = process.argv[2]
+if (!audioFile) {
+  console.error('Usage: node examples/loopback.mjs <audio-file>')
+  process.exit(1)
+}
+
+try {
+  const loopback = new LoopbackSource(2, 48000)
+  loopback.start()
+
+  const output = AudioOutput.openDefault()
+  const player = output.createPlayer()
+
+  console.log(`Playing ${audioFile} to speakers ...`)
+  player.appendFile(audioFile)
+  player.sleepUntilEnd()
+
+  // Give loopback a moment to flush any trailing samples.
+  Atomics.wait(new Int32Array(new SharedArrayBuffer(4)), 0, 0, 500)
+  loopback.stop()
+
+  console.log('Captured loopback audio, draining ...')
+  const audio = loopback.drain()
+  console.log(`  ${audio.durationMs.toFixed(0)} ms, ${audio.channels} ch, ${audio.sampleRate} Hz`)
+
+  console.log('Transcribing ...')
+  const model = SttModel.whisperLargeV3Turbo()
+  const text = model.transcribe(audio)
+  console.log(`Transcription: "${text}"`)
+} catch (error) {
+  console.error('Loopback failed:', error instanceof Error ? error.message : error)
+}

package/examples/open-app.mjs

@@ -0,0 +1,68 @@
+// Run: node examples/open-app.mjs [appName]
+// Tests the full pipeline: find app -> open -> get PID -> bind tree -> snapshot.
+
+import {
+  System,
+  AccessibilityTree,
+  FocusPolicy,
+  Visibility,
+  TraversalOrder,
+  AriaRole,
+  Window,
+} from '@simular-ai/simulib-js'
+
+const appName = process.argv[2] || 'Chrome'
+
+// 1. List installed apps
+console.log('=== Installed apps (first 20) ===')
+const apps = System.listApps()
+apps.slice(0, 20).forEach((a) => console.log(`  ${a.canonicalName} -> ${a.launchTarget}`))
+console.log(`  ... (${apps.length} total)\n`)
+
+// 2. Fuzzy search
+console.log(`=== Searching for: ${appName} ===`)
+const app = System.fuzzySearch(appName)
+console.log(`Found: ${app.canonicalName} -> ${app.launchTarget}\n`)
+
+// 3. Open the app
+console.log(`=== Opening ${appName} ===`)
+const instance = app.open('https://www.google.com', FocusPolicy.Steal, Visibility.Show, true)
+console.log('PID:', instance.pid)
+console.log()
+
+if (instance.pid === 0) {
+  console.log('WARNING: PID is 0 - ShellExecuteEx did not return a process handle')
+  process.exit(1)
+}
+
+// 4. List windows for this PID
+console.log(`=== Windows for PID ${instance.pid} ===`)
+const windows = Window.allForPid(instance.pid)
+windows.forEach((w) => console.log(`  pid=${w.pid} "${w.title}"`))
+console.log()
+
+// 5. Bind and snapshot
+if (windows.length > 0) {
+  console.log(`=== Snapshot of ${appName} ===`)
+  const tree = AccessibilityTree.fromPid(instance.pid)
+  console.log(`Bound to: "${tree.windowTitle}"`)
+
+  const root = tree.snapshot(true)
+  console.log('Role:', root.role)
+  console.log('Children:', root.children.length)
+  console.log('First 10 children:')
+  root.children.slice(0, 10).forEach((c) => {
+    const name = c.name ? `"${c.name}"` : ''
+    console.log(`  - ${c.role} ${name} [ref=${c.refId}]`)
+  })
+
+  // 6. Find the first button using depth-first search
+  const [firstButton] = tree.find(TraversalOrder.DepthFirst, AriaRole.Button, undefined, true, 1)
+  if (firstButton && firstButton.refId != null) {
+    console.log(`\nFirst button: "${firstButton.name}" [ref=${firstButton.refId}]`)
+    console.log('Actions:', tree.getSupportedActions(firstButton.refId))
+    await new Promise((resolve) => setTimeout(resolve, 2000))
+    console.log(`Activating: "${firstButton.name}"`)
+    tree.activate(firstButton.refId)
+  }
+}

package/examples/screenshot.mjs

@@ -0,0 +1,15 @@
+// Run: node examples/screenshot.mjs
+// This example takes a screenshot, shrinks it, compresses it, and saves it.
+
+import { Screen, screenshotFull } from '@simular-ai/simulib-js'
+
+try {
+  const screenshot = screenshotFull(true, Screen.mainScreen())
+  screenshot.shrink(1920, 1080)
+  screenshot.compress(80)
+  screenshot.save('simulib-js-screenshot.png')
+  console.log('Saved simulib-js-screenshot.png')
+  console.log('Base64 length:', screenshot.base64().length)
+} catch (error) {
+  console.error('Screenshot failed:', error instanceof Error ? error.message : error)
+}

package/examples/simular.mjs

@@ -0,0 +1,15 @@
+import { App, FocusPolicy, Visibility, AccessibilityTree, AriaRole, TraversalOrder } from '@simular-ai/simulib-js'
+
+// Open simular.ai in the default browser and wait for it to load
+App.defaultBrowser().open('https://simular.ai', FocusPolicy.Steal, Visibility.Show, true)
+
+// Bind to the browser window and find the "About" link by role and name
+const tree = AccessibilityTree.fromForeground()
+const [link] = tree.find(TraversalOrder.BreadthFirst, AriaRole.Link, 'About', true, 1)
+
+// Click it
+if (link && link.refId != null) {
+  tree.activate(link.refId)
+} else {
+  console.error('Could not find the "About" link')
+}

package/examples/system.mjs

@@ -0,0 +1,10 @@
+// Run: node examples/system.mjs
+// This example opens a URL in the default browser.
+
+import { App, FocusPolicy, Visibility } from '@simular-ai/simulib-js'
+
+// Open a URL in the default browser.
+App.defaultBrowser().open('https://example.com', FocusPolicy.Steal, Visibility.Show, true)
+
+// Open a specific app (macOS example).
+// App.exactName('Safari').open(null, FocusPolicy.Steal, Visibility.Show, false)