remix-nlux/packages/shared/src/types/chatSegment/chatSegmentObservable.ts

Remix IDE NLUX integration. Remix IDE is the leading IDE for building and deploying smart contracts on Ethereum. NLUX is a JavaScript and React library for building conversational AI experiences.

import {ChatSegmentEvent} from './chatSegment';
import {ChatSegmentEventsMap} from './chatSegmentEvents';

/**
 * An interface for listening to events related to a chat segment.
 * When a new chat segment is created and still active, the observable can be used to listen to events.
 *
 * It's typically created by the module responsible for submitting a prompt or the module responsible for
 * communicating with the AI.
 */
export type ChatSegmentObservable<AiMsg> = {
    /**
     * The ID of the chat segment that the observable is listening to.
     */
    get segmentId(): string;

    /**
     * Enables listening to events related to the chat segment.
     *
     * @param {EventType extends ChatSegmentEvent} event
     * @param {ChatSegmentEventsMap<AiMsg>[EventType]} callback
     */
    on: <EventType extends ChatSegmentEvent>(
        event: EventType,
        callback: ChatSegmentEventsMap<AiMsg>[EventType],
    ) => void;

    /**
     * Removes a listener from the chat segment.
     *
     * @param {EventType} event
     * @param {ChatSegmentEventsMap<AiMsg>[EventType]} callback
     */
    removeListener: <EventType extends ChatSegmentEvent>(
        event: EventType,
        callback: ChatSegmentEventsMap<AiMsg>[EventType],
    ) => void;

    /**
     * Destroys the observer and removes all listeners.
     * After calling this function, the observer should not be used anymore.
     */
    destroy: () => void;
};