import { ClientOperation, Packet, ServerOperation } from '@revanced/bot-shared' import ClientGateway, { ClientGatewayEventHandlers } from './ClientGateway.js' /** * The client that connects to the API. */ export default class Client { ready = false gateway: ClientGateway #parseId = 0 constructor(options: ClientOptions) { this.gateway = new ClientGateway({ url: options.api.gatewayUrl, }) this.gateway.on('ready', () => { this.ready = true }) } /** * Connects to the WebSocket API * @returns A promise that resolves when the client is ready */ connect() { return this.gateway.connect() } /** * Checks whether the client is ready * @returns Whether the client is ready */ isReady(): this is ReadiedClient { return this.ready } /** * Requests the API to parse the given text * @param text The text to parse * @returns An object containing the ID of the request and the labels */ async parseText(text: string) { this.#throwIfNotReady() const currentId = (this.#parseId++).toString() this.gateway.send({ op: ClientOperation.ParseText, d: { text, id: currentId, }, }) type CorrectPacket = Packet const promise = new Promise((rs, rj) => { const parsedTextListener = (packet: CorrectPacket) => { if (packet.d.id !== currentId) return this.gateway.off('parsedText', parsedTextListener) rs(packet.d) } const parseTextFailedListener = ( packet: Packet, ) => { if (packet.d.id !== currentId) return this.gateway.off('parseTextFailed', parseTextFailedListener) rj() } this.gateway.on('parsedText', parsedTextListener) this.gateway.on('parseTextFailed', parseTextFailedListener) }) return await promise } /** * Requests the API to parse the given image and return the text * @param url The URL of the image * @returns An object containing the ID of the request and the parsed text */ async parseImage(url: string) { this.#throwIfNotReady() const currentId = (this.#parseId++).toString() this.gateway.send({ op: ClientOperation.ParseImage, d: { image_url: url, id: currentId, }, }) type CorrectPacket = Packet const promise = new Promise((rs, rj) => { const parsedImageListener = (packet: CorrectPacket) => { if (packet.d.id !== currentId) return this.gateway.off('parsedImage', parsedImageListener) rs(packet.d) } const parseImageFailedListener = ( packet: Packet, ) => { if (packet.d.id !== currentId) return this.gateway.off('parseImageFailed', parseImageFailedListener) rj() } this.gateway.on('parsedImage', parsedImageListener) this.gateway.on('parseImageFailed', parseImageFailedListener) }) return await promise } /** * Adds an event listener * @param name The event name to listen for * @param handler The event handler * @returns The event handler function */ on( name: TOpName, handler: ClientGatewayEventHandlers[TOpName], ) { this.gateway.on(name, handler) return handler } /** * Removes an event listener * @param name The event name to remove a listener from * @param handler The event handler to remove * @returns The removed event handler function */ off( name: TOpName, handler: ClientGatewayEventHandlers[TOpName], ) { this.gateway.off(name, handler) return handler } /** * Adds an event listener that will only be called once * @param name The event name to listen for * @param handler The event handler * @returns The event handler function */ once( name: TOpName, handler: ClientGatewayEventHandlers[TOpName], ) { this.gateway.once(name, handler) return handler } #throwIfNotReady() { if (!this.isReady()) throw new Error('Client is not ready') } } export type ReadiedClient = Client & { ready: true } export interface ClientOptions { api: ClientApiOptions } export interface ClientApiOptions { gatewayUrl: string }