AddonPort SDK

Experimental protocol and frontend integration package for website-to-adapter handoffs.

Important

This is an early GitHub beta and is not published to npm. The hosted Connect service is live at https://connect.addonport.dev, while direct addonport:// links remain the simplest FACEIT integration and do not require this SDK.

Install

npm install github:AddonPort/sdk#v0.1.0-beta.1

This installs the current GitHub beta. The public npm package is not live yet.

Entry points

Import	Purpose
@addonport/sdk	Framework-neutral session client
@addonport/sdk/protocol	Versioned intents, validation, states, and deep links
@addonport/sdk/elements	Drop-in custom element
@addonport/sdk/react	React wrapper
@addonport/sdk/vue	Vue 3 wrapper

Framework bindings are optional subpath exports. Importing the core client does not load React or Vue.

Core client

Against the public beta AddonPort Connect service:

import { AddonPortClient } from "@addonport/sdk";

const client = new AddonPortClient({
  apiBaseUrl: "https://connect.addonport.dev",
  client: { name: "extension-site", version: "1.0.0" },
});

const result = await client.run({
  action: "install",
  target: "abcdefghijklmnopabcdefghijklmnop",
});

The result confirms that an AddonPort adapter claimed and completed the short-lived session. It is a user-experience signal, not device attestation, and must not be used for authentication or authorization.

Development

pnpm install
pnpm check

For the integration that works with the current public FACEIT beta, use the addonport:// contract. Framework examples for the generic flow currently live in the website source.