@telnyx/ai-chat-widget 4.0.1 → 4.0.2

package/dist/index.d.ts

@@ -0,0 +1,182 @@
+import { JSX } from 'react/jsx-runtime';
+import * as React_2 from 'react';
+import { SVGProps } from 'react';
+import * as TooltipPrimitive from '@radix-ui/react-tooltip';
+
+declare type BaseProps = {
+    /**
+     * The default endpoint to use for the chat widget (user can toggle between modes)
+     * @default `aida`
+     * @deprecated
+     */
+    endpoint?: 'flow' | 'aida';
+    /**
+     * The base URL for AIDA (Heavy thinking mode)
+     * @required
+     */
+    chatAPIUrl: string;
+    /**
+     * The base URL for Flow (Instant mode). If not provided, uses chatAPIUrl.
+     */
+    flowAPIUrl?: string;
+    /**
+     * API key for Flow (Instant mode). If not provided, uses user.api_v2_token.
+     * This allows using a separate API key for the Flow chatbot.
+     */
+    flowApiKey?: string;
+    /**
+     * The base URL of the feedback to send
+     * @required
+     */
+    feedbackAPIUrl: string;
+    /**
+     * The user info to send with the feedback
+     * @required
+     * The user info contains the user ID, token, api access key, api v2 token, two factor authentication, role, and expires at
+     * @example
+     * {
+     *   id: '123',
+     *   token: '123',
+     *   apiAccessKey: '123',
+     *   api_v2_token: '123',
+     *   twoFactorAuth: '123',
+     *   role: 'admin',
+     *   expiresAt: '2025-01-01',
+     * }
+     * We use the api_v2_token to authenticate the user with the flow API.
+     * @info If you include in api_v2_token, it'll be sent as an authentication header in both EventSource and Feedback API.
+     */
+    user: UserInfo;
+    /**
+     * The placeholders to be used in the chat widget
+     * @default ["Type your message here..."]
+     */
+    placeholders?: string[];
+    /**
+     * The action to be performed when the user clicks the help button
+     */
+    onHelpAction?: () => void;
+};
+
+export declare const ChatWidget: ({ chatAPIUrl, flowAPIUrl, flowApiKey, feedbackAPIUrl, user, onHelpAction, open, setOpen, placeholders, mountPosition, mountDirection, offsetX, offsetY, icon, }: ChatWidgetProps) => JSX.Element;
+
+declare interface ChatWidgetNoMounting extends BaseProps {
+    open?: never;
+    setOpen?: never;
+    mountPosition?: never;
+    mountDirection?: never;
+    offsetX?: never;
+    offsetY?: never;
+    /**
+     * The icon to be used in the chat widget
+     * @default `RCSIcon`
+     */
+    icon?: typeof RCSIcon;
+}
+
+declare type ChatWidgetProps = ChatWidgetNoMounting | ChatWidgetWithMounting;
+
+declare interface ChatWidgetWithMounting extends BaseProps, MountingProps {
+}
+
+declare type MountingProps = {
+    open: boolean;
+    setOpen: (open: boolean) => void;
+    /**
+     * The offset of the widget on the x axis
+     * @default 0
+     */
+    offsetX?: number;
+    /**
+     * The offset of the widget on the y axis
+     * @default 0
+     */
+    offsetY?: number;
+    /**
+     * The position of the widget
+     * Values: `top-left`, `top`, `top-right`, `right`, `bottom-right`, `bottom`, `bottom-left`, `left`
+     * @default `bottom-right`
+     */
+    mountPosition: WidgetMountPosition;
+    /**
+     * The direction, inside or outside the container
+     * Values: `inside`, `outside`
+     * @default `inside`
+     */
+    mountDirection: WidgetMountDirection;
+    icon?: never;
+};
+
+declare type Props = {
+    ref?: React.RefObject<SVGSVGElement>;
+} & SVGProps<SVGSVGElement>;
+
+declare const RCSIcon: (props: Props) => JSX.Element;
+
+export declare const Tooltip: React_2.FC<TooltipPrimitive.TooltipProps>;
+
+export declare const TooltipContent: {
+    ({ className, sideOffset, ...props }: React_2.ComponentPropsWithoutRef<typeof TooltipPrimitive.Content>): JSX.Element;
+    displayName: string;
+};
+
+export declare const TooltipProvider: React_2.FC<TooltipPrimitive.TooltipProviderProps>;
+
+export declare const TooltipTrigger: React_2.ForwardRefExoticComponent<TooltipPrimitive.TooltipTriggerProps & React_2.RefAttributes<HTMLButtonElement>>;
+
+declare type UserInfo = {
+    /**
+     * The user ID
+     * @required
+     */
+    id: string | null;
+    /**
+     * The user token
+     * @required
+     */
+    token: string | null;
+    /**
+     * The user API access key
+     * @required
+     */
+    apiAccessKey: string | null;
+    /**
+     * The user API v2 token
+     * @required
+     */
+    api_v2_token: string | null;
+    /**
+     * The user two factor authentication
+     */
+    twoFactorAuth?: boolean | null;
+    /**
+     * The user role
+     */
+    role?: string | null;
+    /**
+     * The user expires at
+     */
+    expiresAt?: number | null;
+};
+
+declare const WIDGET_MOUNT_DIRECTION: {
+    readonly INSIDE: "inside";
+    readonly OUTSIDE: "outside";
+};
+
+declare const WIDGET_MOUNT_POSITIONS: {
+    readonly TOP_LEFT: "top-left";
+    readonly TOP: "top";
+    readonly TOP_RIGHT: "top-right";
+    readonly RIGHT: "right";
+    readonly BOTTOM_RIGHT: "bottom-right";
+    readonly BOTTOM: "bottom";
+    readonly BOTTOM_LEFT: "bottom-left";
+    readonly LEFT: "left";
+};
+
+declare type WidgetMountDirection = (typeof WIDGET_MOUNT_DIRECTION)[keyof typeof WIDGET_MOUNT_DIRECTION];
+
+declare type WidgetMountPosition = (typeof WIDGET_MOUNT_POSITIONS)[keyof typeof WIDGET_MOUNT_POSITIONS];
+
+export { }