Class StarCommsClient

Star Comms Shard Owner API Client.

A framework-agnostic TypeScript client for interacting with a Star Comms shard. Uses the native fetch API (Node 18+, Bun, Deno, or browser).

Supports event-emitter style event handling with Type Safety:

Example

import { StarCommsClient } from "@30k/starcomm-client";

const client = new StarCommsClient({
  baseUrl: "http://your-shard:1234",
  ownerApiKey: "scok_your_key_here",
});

client.on("user.joined", (event) => {
  console.log(`${event.data.displayName} connected`);
});

client.on("ptt.start", (event) => {
  console.log(`${event.data.userId} transmitting on net ${event.data.netId}`);
});

// Lifecycle events
client.onLifecycle("stream.disconnected", ({ reason }) => {
  console.warn("Stream lost:", reason);
});
client.onLifecycle("stream.reconnected", ({ attempt }) => {
  console.log("Reconnected after", attempt, "attempts");
});

await client.connect(); // opens SSE stream and starts dispatching events

// Resource calls
const status = await client.status.get();
await client.assignments.set("discord_user_id", 1);

// Later: disconnect
client.disconnect();

Index

Constructors

constructor

new StarCommsClient(config: StarCommsClientConfig): StarCommsClient
Parameters
- config: StarCommsClientConfig
Returns StarCommsClient
- Defined in src/client.ts:121

Properties

`Readonly`archive

archive: ArchiveResource

Net archive CRUD and sync status.

`Readonly`assignments

assignments: AssignmentsResource

Net assignment operations (assign, unassign, bulk, temporary).

`Readonly`comms

comms: CommsResource

Communication operations (ACARS alerts, client disconnect).

`Readonly`metrics

metrics: MetricsResource

Shard metrics, Prometheus export, audit log, and debug.

`Readonly`nets

nets: NetsResource

Voice net management (create, rename, remove).

`Readonly`operations

operations: OperationsResource

Operation lifecycle, feature flags, and auto-assignment rules.

`Readonly`presets

presets: PresetsResource

Operation preset management (save, apply, remove).

`Readonly`publicNet

publicNet: PublicNetResource

Public net feature management (show, hide, remove, restore).

`Readonly`status

status: StatusResource

Shard health, status, roster, and embed endpoints.

`Readonly`stream

stream: StreamResource

Event streaming (SSE) and public token management.

`Readonly`webhooks

webhooks: WebhooksResource

Webhook registration and management.

Accessors

connected

get connected(): boolean
Whether the event stream is currently connected.

Returns boolean
- Defined in src/client.ts:235

Methods

connect

connect(reconnect?: ReconnectOptions): Promise<void>
Opens the SSE event stream and begins dispatching events to registered handlers. Call this after registering your .on() handlers.
Parameters
- Optionalreconnect: ReconnectOptions
  Options controlling auto-reconnection behavior.
Returns Promise<void>
Throws
If the initial connection fails.
- Defined in src/client.ts:217

disconnect

disconnect(): void
Closes the SSE event stream. REST methods remain usable. Will not trigger automatic reconnection.

Returns void
- Defined in src/client.ts:243

off

off<K extends OwnerEventType>(
event: K,
handler: (event: OwnerEventMap[K]) => void,
): this
Remove a previously registered handler.
Type Parameters
- K extends OwnerEventType
Parameters
- event: K
- handler: (event: OwnerEventMap[K]) => void
Returns this
- Defined in src/client.ts:173
off(event: "*", handler: WildcardHandler): this
Remove a previously registered handler.
Parameters
- event: "*"
- handler: WildcardHandler
Returns this
- Defined in src/client.ts:174

offLifecycle

offLifecycle(event: LifecycleEventType, handler: LifecycleHandler): this
Remove a lifecycle event handler.
Parameters
- event: LifecycleEventType
- handler: LifecycleHandler
Returns this
- Defined in src/client.ts:205

on

on<K extends OwnerEventType>(
event: K,
handler: (event: OwnerEventMap[K]) => void,
): this
Register a type-safe handler for a specific event type.
Type Parameters
- K extends OwnerEventType
Parameters
- event: K
- handler: (event: OwnerEventMap[K]) => void
Returns this
Example
```
client.on("user.joined", (event) => {
  event.data.userId;  // string
  event.data.nets;    // number[]
});
```
- Defined in src/client.ts:155
on(event: "*", handler: WildcardHandler): this
Register a handler for all events.
Parameters
- event: "*"
- handler: WildcardHandler
Returns this
- Defined in src/client.ts:157

onLifecycle

onLifecycle(event: LifecycleEventType, handler: LifecycleHandler): this
Register a handler for stream lifecycle events.
Parameters
- event: LifecycleEventType
- handler: LifecycleHandler
Returns this
Example
```
client.onLifecycle("stream.disconnected", ({ reason }) => {
  console.warn("Lost connection:", reason);
});
```
- Defined in src/client.ts:194

Class StarCommsClient

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns StarCommsClient

Properties

Readonlyarchive

Readonlyassignments

Readonlycomms

Readonlymetrics

Readonlynets

Readonlyoperations

Readonlypresets

ReadonlypublicNet

Readonlystatus

Readonlystream

Readonlywebhooks

Accessors

connected

Returns boolean

Methods

connect

Parameters

Returns Promise<void>

Throws

disconnect

Returns void

off

Type Parameters

Parameters

Returns this

Parameters

Returns this

offLifecycle

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

Example

Parameters

Returns this

onLifecycle

Parameters

Returns this

Example

Settings

On This Page

`Readonly`archive

`Readonly`assignments

`Readonly`comms

`Readonly`metrics

`Readonly`nets

`Readonly`operations

`Readonly`presets

`Readonly`publicNet

`Readonly`status

`Readonly`stream

`Readonly`webhooks