@apia/ai 4.0.43 → 4.0.44

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as react from 'react';
-import { FC, ReactElement } from 'react';
-import { FilterDTO, ChatMessage } from '@apia/components';
+import react__default, { PropsWithChildren, ReactNode, ReactElement, FC } from 'react';
+import { TMenuItem, FilterDTO } from '@apia/components';
 import { TActionDispatcher } from '@apia/dashboard-controller';
+import * as _apia_util from '@apia/util';
 import { EventEmitter, AudioRecorder } from '@apia/util';
 
 type TSearchResultState = {
@@ -34,6 +35,14 @@ declare class SearchController {
     protected setReferences(results: SemanticSearchReference[]): void;
 }
 
+interface AutoscrollContainerProps {
+    /** How close (in px) to the bottom you have to be *when scrolling down*
+     * for auto-scroll to kick back in. */
+    threshold?: number;
+    className?: string;
+}
+declare const AutoscrollContainer: react__default.FC<PropsWithChildren<AutoscrollContainerProps>>;
+
 type TReference = {
     title: string;
     body: string;
@@ -42,6 +51,254 @@ type TReference = {
     score: number;
     startIndex: number;
 };
+type TMessageType = 'user' | 'system' | 'warning' | 'error' | 'information' | 'response' | 'multipleChoice' | 'customMessage';
+interface IAttachment {
+    name: string;
+    id: string;
+    base64: string;
+    description?: string;
+}
+type TChatControllerState = {
+    isLoading: boolean;
+    canRecord: boolean;
+    canAttach: boolean;
+    canAddUserMessage: boolean;
+    canAddSystemMessage: boolean;
+    maxAttachmentsSize: number;
+    messages: ChatMessage[];
+    currentMessage: ChatMessage;
+};
+interface MessageCallbackProps {
+    message: ChatMessage;
+}
+type MessageSubmitCallback = (props: MessageCallbackProps) => unknown;
+type ClearHistoryCallback = () => unknown;
+type TComponentRender = {
+    path: string;
+    args: Record<any, any>;
+};
+
+declare class ChatMessage {
+    id: number;
+    state: {
+        message: ReactNode;
+        messageType: TMessageType;
+        attachments: IAttachment[];
+        reference: ReactNode;
+    };
+    get message(): ReactNode;
+    get messageType(): TMessageType;
+    get attachments(): IAttachment[];
+    get reference(): ReactNode;
+    set message(value: ReactNode);
+    set messageType(value: TMessageType);
+    set attachments(value: IAttachment[]);
+    set reference(value: ReactNode);
+    constructor(message?: ReactNode, messageType?: TMessageType, attachments?: IAttachment[], reference?: ReactNode);
+    clone: () => ChatMessage;
+    removeAttachment(attachment: IAttachment): void;
+    addAttachmentDescription(attachment: IAttachment, description: string): void;
+    setMessageType(type: TMessageType): void;
+}
+
+declare class ChatController<T extends Record<string, unknown> = Record<string, unknown>> {
+    private onMessageSubmit;
+    private onClearHistory;
+    private additionalOptions?;
+    private classNames?;
+    currentIndex: number;
+    state: TChatControllerState & T;
+    private internalAudioRecorder;
+    private internalCameraRecorder;
+    private maxId;
+    audioRecorder: {
+        cancelOnStop: boolean;
+        start: () => void;
+        stop: () => Promise<void>;
+        record: number;
+        state: _apia_util.AudioRecorderState;
+    };
+    constructor(props: Partial<TChatControllerState & T>, onMessageSubmit: MessageSubmitCallback, onClearHistory: ClearHistoryCallback, additionalOptions?: TMenuItem[] | undefined, classNames?: {
+        history?: string;
+        textarea?: string;
+        attachments?: string;
+    } | undefined);
+    removeMessage(idx: number): void;
+    addMessage(message: ChatMessage): void;
+    clearHistory(): void;
+    clearMessage(): void;
+    removeAttachment(attachment: IAttachment): void;
+    private handleSubmit;
+    private isForHistory;
+    private canGoNext;
+    private canGoPrev;
+    nextMessage(): void;
+    prevMessage(): void;
+    protected getAdditionalProps(): Partial<MessageCallbackProps>;
+    History: (() => react.JSX.Element) & {
+        displayName: string;
+    };
+    Attachments: (() => react.JSX.Element) & {
+        displayName: string;
+    };
+    TextArea: (() => react.JSX.Element) & {
+        displayName: string;
+    };
+    Renderer: () => react.JSX.Element;
+}
+
+declare class FloatingChatController extends ChatController<{
+    isWindowOpen: boolean;
+}> {
+    private modalTitle;
+    constructor(props: {
+        props: Partial<TChatControllerState & {
+            isWindowOpen: boolean;
+        }>;
+        onMessageSubmit: MessageSubmitCallback;
+        onClearHistory: ClearHistoryCallback;
+        modalTitle?: string;
+        additionalOptions?: TMenuItem[];
+        classNames?: {
+            history?: string;
+            textarea?: string;
+            attachments?: string;
+        };
+    });
+    getModalTitle(): string | undefined;
+    setModalTitle(title: string): void;
+    open(): void;
+    Window: (() => react.JSX.Element | null) & {
+        displayName: string;
+    };
+}
+
+declare const Attachments: (({ attachments, onRemove, onAddDescription, className, }: {
+    attachments: IAttachment[];
+    onRemove?: (a: IAttachment) => unknown;
+    onAddDescription?: (a: IAttachment, d: string) => unknown;
+    className?: string;
+}) => react.JSX.Element | null) & {
+    displayName: string;
+};
+
+declare const Ellipsis: () => react.JSX.Element;
+
+declare const Header: (({ childComponent }: {
+    childComponent: ReactNode;
+}) => react.JSX.Element) & {
+    displayName: string;
+};
+
+declare const History: (({ messages, className, }: {
+    messages: ChatMessage[];
+    className?: string;
+}) => react.JSX.Element) & {
+    displayName: string;
+};
+
+declare const Message: (({ className, type, id, message, attachments, reference, }: {
+    className?: string;
+    type: TMessageType;
+    id: string;
+    message: ReactNode;
+    attachments: IAttachment[];
+    reference: ReactNode;
+}) => react.JSX.Element) & {
+    displayName: string;
+};
+
+declare const MessageBlock: react.MemoExoticComponent<({ componentData }: {
+    componentData: TComponentRender;
+}) => react.JSX.Element>;
+
+declare function rate(el: HTMLElement, how: 'up' | 'down', query: string): Promise<boolean>;
+
+declare const TextArea: (({ additionalOptions, isLoading, isRecording, disablePrevButton, disableNextButton, onSubmit, onChange, onClearHistory, onAttach, onRecord, onRecordCancel, onVideoRecord, onPrev, onNext, value, attachments, className, }: {
+    additionalOptions?: TMenuItem[];
+    className?: string;
+    isLoading: boolean;
+    isRecording: boolean;
+    disablePrevButton: boolean;
+    disableNextButton: boolean;
+    onClearHistory: () => unknown;
+    onSubmit: () => unknown;
+    onChange: (v: string) => unknown;
+    onAttach: (ev: IAttachment) => unknown;
+    onRecord: (event: React.MouseEvent<HTMLButtonElement>) => void;
+    onRecordCancel: (event: React.MouseEvent<HTMLButtonElement>) => void;
+    onVideoRecord: () => unknown;
+    onPrev: () => unknown;
+    onNext: () => unknown;
+    value: string;
+    attachments: IAttachment[];
+}) => react.JSX.Element) & {
+    displayName: string;
+};
+
+declare const MessageBody: (({ onRate, store, }: {
+    onRate?: (target: HTMLElement, how: "up" | "down") => Promise<boolean>;
+    store: StreamMessage;
+}) => react.JSX.Element) & {
+    displayName: string;
+};
+
+type TBlockType = 'text' | 'describer';
+type TBaseStreamBlock<T extends TBlockType = TBlockType> = {
+    blockType: T;
+};
+type TTextStreamBlock = TBaseStreamBlock<'text'> & {
+    str: string;
+};
+type TDescriberStreamBlock = TBaseStreamBlock<'describer'> & {
+    describer: TDescriberBlock;
+};
+type TStreamBlock = TTextStreamBlock | TDescriberStreamBlock;
+declare const MessageBlocks: (({ streamParts }: {
+    streamParts: TStreamBlock[];
+}) => (react.JSX.Element | react.JSX.Element[] | undefined)[]) & {
+    displayName: string;
+};
+
+type TDescriberBlock = {
+    type: string;
+    content: string;
+};
+declare class StreamMessage {
+    blocks: TStreamBlock[];
+    references: TReference[];
+    tables: Record<string, string>;
+    charts: Record<string, string>;
+    constructor();
+    addPart<T extends TStreamBlock>(part: T, afterAddPart?: (added: T) => void): void;
+    getLastBlock(): TStreamBlock;
+}
+
+declare class CameraController {
+    state: {
+        videoStream: MediaStream | null;
+        isOpen: boolean;
+    };
+    private currentCapture;
+    private videoElement;
+    constructor();
+    openCamera(): Promise<void>;
+    closeCamera(): Promise<void>;
+    pop(): File | null;
+    Component: () => react.JSX.Element;
+}
+
+type TMultipleChoiceMessageOption<OptionProps> = {
+    label: string;
+    url: string;
+    additionalProps?: OptionProps;
+};
+declare class MultipleChoiceMessage<OptionProps> extends ChatMessage {
+    constructor(question: string, options: TMultipleChoiceMessageOption<OptionProps>[], Renderer?: (props: {
+        item: TMultipleChoiceMessageOption<OptionProps>;
+    }) => ReactElement);
+}
+
 type TSearchListItem = {
     content: string;
     isExternal: boolean;
@@ -95,14 +352,20 @@ interface ISearchResultsController<P extends ProcessingUnit> {
     Component: FC;
 }
 
+type StreamBlock = {
+    type: string;
+    description: string;
+};
 type ResponseStreamEvents = {
+    block: StreamBlock;
     part: string;
-    block: {
-        type: string;
-        description: string;
-    };
 };
-declare class ResponseStream extends EventEmitter<ResponseStreamEvents> {
+type ResponseStreamBlock = {
+    type: string;
+    content: string;
+    id: string;
+};
+declare class ResponseStream<T extends ResponseStreamEvents = ResponseStreamEvents> extends EventEmitter<T> {
     private buffer;
     private isRunning;
     private locked;
@@ -112,7 +375,7 @@ declare class ResponseStream extends EventEmitter<ResponseStreamEvents> {
     private timing;
     private waiting;
     private calculatePartSize;
-    emit<K extends keyof ResponseStreamEvents>(ev: K, data: ResponseStreamEvents[K]): void;
+    emit<K extends keyof T>(ev: K, data: T[K]): void;
     run(): void;
 }
 
@@ -202,16 +465,15 @@ declare function getImagesWithDescription({ multiple, }: {
     multiple?: boolean;
 }): Promise<TGenerateFromImage[]>;
 
-type TMultipleChoiceMessageOption<OptionProps> = {
-    label: string;
-    url: string;
-    additionalProps?: OptionProps;
+type PollerEvents = ResponseStreamEvents & {
+    close: null;
 };
-declare class MultipleChoiceMessage<OptionProps> extends ChatMessage {
-    constructor(question: string, options: TMultipleChoiceMessageOption<OptionProps>[], Renderer?: (props: {
-        item: TMultipleChoiceMessageOption<OptionProps>;
-    }) => ReactElement);
+declare class StreamServicePoller {
+    closed: boolean;
+    stream: ResponseStream<PollerEvents>;
+    on<K extends keyof PollerEvents>(ev: K, cb: (ev: PollerEvents[K]) => unknown): _apia_util.UnSubscriber;
+    start(token: string): Promise<void>;
 }
 
-export { type ChatProcessingUnit, DashboardsRoutinesGeneration, type ISearchResultsController, type ISemanticSearchViewController, type ListingProcessingUnit, MultipleChoiceMessage, type ProcessingUnit, ResponseStream, RoutinesGeneration, SearchController, SemanticSearchReference as SemanticSearchResult, type TGenerateFromImage$1 as TGenerateFromImage, type TMultipleChoiceMessageOption, type TPollRoutineResult, type TReference, type TResponseData, type TRoutineCompletion, type TSearchListItem, type TSearchMode, type ISemanticSearchViewController as ViewController, ViewRendererContext, getImageFromDisk, getImagesFromDisk, getImagesWithDescription };
+export { Attachments, AutoscrollContainer, CameraController, ChatController, ChatMessage, type ChatProcessingUnit, type ClearHistoryCallback, DashboardsRoutinesGeneration, Ellipsis, FloatingChatController, Header, History, type IAttachment, type ISearchResultsController, type ISemanticSearchViewController, type ListingProcessingUnit, Message, MessageBlock, MessageBlocks, MessageBody, type MessageCallbackProps, type MessageSubmitCallback, MultipleChoiceMessage, type ProcessingUnit, ResponseStream, type ResponseStreamBlock, type ResponseStreamEvents, RoutinesGeneration, SearchController, SemanticSearchReference as SemanticSearchResult, type StreamBlock, StreamMessage, StreamServicePoller, type TBaseStreamBlock, type TBlockType, type TChatControllerState, type TComponentRender, type TDescriberBlock, type TDescriberStreamBlock, type TGenerateFromImage$1 as TGenerateFromImage, type TMessageType, type TMultipleChoiceMessageOption, type TPollRoutineResult, type TReference, type TResponseData, type TRoutineCompletion, type TSearchListItem, type TSearchMode, type TStreamBlock, type TTextStreamBlock, TextArea, type ISemanticSearchViewController as ViewController, ViewRendererContext, getImageFromDisk, getImagesFromDisk, getImagesWithDescription, rate };
 //# sourceMappingURL=index.d.ts.map