RainbowBird
ba3d66de86
- Added package.json for @proj-airi/server-protocol with necessary configurations. - Implemented chat event types including WireMessage, SendMessagesRequest, and PullMessagesRequest. - Defined WebSocket event types and structures for better integration with AIRI components. - Updated server-runtime and server-sdk to utilize the new server-protocol package. - Refactored imports across various packages to replace server-shared types with server-protocol types. - Enhanced type definitions and added TypeScript configurations for better development experience.
@proj-airi/server-sdk
The SDK for cliet-side code to connect to the server-side components.
Usage
ni @proj-airi/server-sdk -D # from @antfu/ni, can be installed via `npm i -g @antfu/ni`
pnpm i @proj-airi/server-sdk -D
yarn i @proj-airi/server-sdk -D
npm i @proj-airi/server-sdk -D
import { Client } from '@proj-airi/server-sdk'
const client = new Client({
name: 'your airi plugin',
autoConnect: false,
})
await client.connect()
client.onEvent('input:text', async (event) => {
console.info(event.data.text)
})
connect() now resolves when the client is fully ready for use, not just when the websocket transport has opened. In practice that means:
- the socket is open
- authentication succeeded when a token is configured
- the module has announced itself successfully
Useful runtime helpers:
client.connectionStatusexposes the current lifecycle stateclient.isReadytells you whether the client has completed authentication + announceclient.send()returnsfalseinstead of silently dropping messages when the socket is unavailableclient.sendOrThrow()is available when you want strict delivery semanticsclient.onEvent()returns an unsubscribe function