Skip to content

TypeScript SDK: typed local client and lifecycle API #164

Description

@SarthakWade

Scope

Publish a TypeScript SDK generated from or validated against the canonical SDK schema.

The initial API should cover host lifecycle, session lifecycle, navigation, semantic inspection, interactions, waits, capture, diagnostics, capabilities, typed errors, cancellation, and timeouts. It should work in Node.js without requiring a network service.

Constraints

  • Use the existing local transport and preserve private socket permissions.
  • Do not duplicate protocol validators by hand.
  • Keep page-derived strings typed or wrapped as untrusted content.
  • Credential operations use aliases and challenge IDs only.
  • Child processes are terminated and awaited on cancellation or parent exit.
  • Unsupported capabilities return typed failures rather than partial behavior.

Acceptance criteria

  • Package build, type checks, lint, unit tests, and integration tests pass.
  • Golden fixtures prove request and response parity with the Swift protocol.
  • Tests cover missing binary, startup failure, timeout, cancellation, malformed response, protocol mismatch, and host termination.
  • API documentation includes minimal CLI-to-SDK migration examples.
  • Package contents, license, provenance, and version compatibility are verified before publication.

Blocked by #163.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:core-protocolHeadlessProtocol: wire protocol, validation, transportarea:mcpstdio MCP server and harness integrationpriority:mediumScheduled, not blockingstatus:blockedWaiting on another item or an owner decisiontype:featureNew capability or command

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions