Skip to Content
Introduction

Hira SDK Documentation

Welcome to the Hira Automation SDK documentation — the toolkit for building browser automation flows.

📦 What’s inside

Getting Started

Install the SDK, create your first flow, and run it locally.

Core Concepts

Understand the flow lifecycle, config system, and type-safe inputs/outputs.

Browser Utils

Complete reference for all browser interaction methods — click, type, navigate, handle popups, write output, and more.

Excel Storage

Read profile input from Excel files and write automation output back to spreadsheets.

Script Context

Everything available inside your script() method — browser, page, profile, inputs, outputs, logger.

Anti-detect Providers

Configure and use GPM, Hidemium, and other anti-detect browser providers.

Advanced

Error handling, retry strategies, concurrency control, and window management.

📋 SDK Version

Current version: v1.0.16

Changelog

  • v1.0.16 — Cursor Rewrite, Excel Mutex & Platform Features

    • Flow Library & Marketplace: upload, versioning, search, purchase flows
    • Payment processing with transaction history
    • User review & rating system for published flows
    • Admin dashboard modules (users, flows, payments, analytics)
    • HiraCursor rewrite: inline IIFE string prevents obfuscator breakage
    • ExcelStorage per-file mutex: acquireLock() serializes concurrent writes
    • BrowserUtils cursor init guard: captures inject errors via _cursorInitPromise
    • Selector truncation limit increased from 60 → 200 characters
    • Bumped axios, typescript, @types/node, ghost-cursor

  • v1.0.8 — Stealth Scripts & Virtual Cursor Toggle

    • Auto-remove automation fingerprints (navigator.webdriver, empty plugins, CDP artifacts) via stealth scripts
    • New IExecutionConfig.virtualCursor toggle (default: true) — disable SVG cursor overlay from Execution Settings
    • Stealth scripts re-applied when switching tabs
    • All internal JSDoc translated to English

  • v1.0.7 — HiraCursor Rewrite & New Interactions

    • New Bézier curve mouse movement engine with realistic trajectory
    • Smooth 60fps scroll via requestAnimationFrame with ease-in-out curve
    • New: select(), getPosition(), click by { x, y } coordinates
    • Container scrolling: scrollContainerDelta(), moveToContainer()
    • Segment-based cursor movement with natural jitter

  • v1.0.6 — BrowserUtils API Overhaul

    • All methods now use options object instead of positional args
    • New methods: activeIframe(), activeMainFrame(), activeNewTab(), waitForNewTab(), waitForPopup()
    • Renamed: switchToDefault → activeDefault, switchToPopup → activePopup, switchToTabIndex → activeTab
    • Removed deprecated: switchToPopup, switchToTabIndex, switchToDefault
    • Default timeouts normalized to multiples of 4000ms
    • screenshot() changed to soft-fail (no longer throws)
    • Added comprehensive English JSDoc with @param, @returns, @example
    • Fixed Hidemium adapter: window scaling and connection reliability

  • v1.0.5 — Agent UX & Anti-detect Settings

    • Fixed Hidemium window scaling and connection reliability
    • Added anti-detect browser selector in Execution Settings
    • Settings sidebar, connection management

  • v1.0.4 — Output Slots & Execution Chain

    • Implemented output slot CRUD with per-key merge and PIN-safe flush
    • Slot-aware output persistence with merge strategy
    • Pass versionId through flow execution chain for output slot

  • v1.0.3 — Anti-detect provider selector, type-safe writeOutput() / writeProfileInput(), Excel storage

  • v1.0.2 — Published to npm, HMAC signing, gzip, module allow-list

  • v1.0.1 — Logger refactor (createBoundLogger), structured profile logging, fix closeAll()

  • v1.0.0 — Initial release

Last updated on
Getting Started