Skip to main content
New protocol version released: This page may contain outdated information.

​
Installation

The HAIP SDK is available as a TypeScript package with comprehensive type definitions and extensive test coverage.

​
NPM Package

Package Status: The HAIP SDK package is now available on npm and ready for production use.
npm version npm downloads License: MIT 
# Install from npm
npm install @haip/sdk

​
TypeScript Support

The SDK is written in TypeScript and includes comprehensive type definitions: 
import { createHAIPClient, HAIPConnectionConfig } from "haip-sdk";

const config: HAIPConnectionConfig = {
  url: "ws://localhost:8080",
  token: "your-jwt-token",
};

const client = createHAIPClient(config);

​
Browser Usage

Browser Distribution: UMD/ESM builds are planned but not yet available. For browser usage, you’ll need to bundle the SDK with your application.
For browser applications, you can use a bundler like Webpack, Rollup, or Vite: 
# Install with bundler
npm install @haip/sdk
Then import in your browser code: 
import { createHAIPClient } from "haip-sdk";

​
Development Setup

​
Requirements

Node.js

Version 20.0.0 or higher
Windows, macOS, Linux

Browser Support

Chrome 88+, Firefox 85+
Safari 14+, Edge 88+

Dependencies

ws, uuid, TypeScript 5.2.2+

​
Implementation Status

Core SDK

Complete TypeScript implementation with full protocol support

Type Definitions

Comprehensive TypeScript types for all protocol features

Test Coverage

85% test coverage with comprehensive test suite

NPM Package

Package published and available on npm

Browser Builds

UMD/ESM builds planned

Documentation

Comprehensive documentation with examples