@elevenlabs/convai-widget-core 0.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 ElevenLabs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/components/Avatar.d.ts

@@ -0,0 +1,10 @@
+declare const SIZE_CLASSES: {
+    sm: string;
+    lg: string;
+};
+interface AvatarProps {
+    size?: keyof typeof SIZE_CLASSES;
+    className?: string;
+}
+export declare function Avatar({ size, className }: AvatarProps): import("preact/compat").JSX.Element;
+export {};

package/dist/components/Button.d.ts

@@ -0,0 +1,26 @@
+import { ButtonHTMLAttributes } from "preact/compat";
+import { IconName } from "./Icon";
+import { ComponentChildren } from "preact";
+import { Signalish } from "../utils/signalish";
+declare const VARIANT_CLASSES: {
+    primary: string;
+    secondary: string;
+};
+export interface BaseButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
+    iconClassName?: string;
+    variant?: keyof typeof VARIANT_CLASSES;
+    disabledStyle?: boolean;
+    truncate?: boolean;
+    icon?: IconName;
+}
+interface TextButtonProps extends BaseButtonProps {
+    children: ComponentChildren;
+}
+interface IconButtonProps extends BaseButtonProps {
+    "aria-label": Signalish<string | undefined>;
+}
+export type ButtonProps = TextButtonProps | IconButtonProps;
+export declare const Button: import("preact").FunctionalComponent<import("preact/compat").PropsWithoutRef<ButtonProps> & {
+    ref?: import("preact").Ref<HTMLButtonElement> | undefined;
+}>;
+export {};

package/dist/components/CopyButton.d.ts

@@ -0,0 +1,7 @@
+import { BaseButtonProps } from "./Button";
+import { Signalish } from "../utils/signalish";
+interface CopyButtonProps extends BaseButtonProps {
+    copyText: Signalish<string | null>;
+}
+export declare function CopyButton({ copyText, children }: CopyButtonProps): import("preact/compat").JSX.Element;
+export {};

package/dist/components/Flag.d.ts

@@ -0,0 +1,11 @@
+import { ImgHTMLAttributes } from "preact/compat";
+declare const SIZE_CLASSES: {
+    sm: string;
+    md: string;
+};
+interface FlagProps extends ImgHTMLAttributes<HTMLImageElement> {
+    size?: keyof typeof SIZE_CLASSES;
+    flagCode: string;
+}
+export declare function Flag({ size, flagCode, className, ...props }: FlagProps): import("preact/compat").JSX.Element;
+export {};

package/dist/components/Icon.d.ts

@@ -0,0 +1,31 @@
+import { JSX } from "preact";
+declare const ICON_MAP: {
+    phone: typeof PhoneIcon;
+    "phone-off": typeof PhoneSlashIcon;
+    chat: typeof ChatIcon;
+    mic: typeof MicIcon;
+    "mic-off": typeof MicOffIcon;
+    check: typeof CheckIcon;
+    "chevron-down": typeof ChevronDownIcon;
+    "chevron-up": typeof ChevronUpIcon;
+};
+declare const SIZE_CLASSES: {
+    sm: string;
+    md: string;
+};
+export type IconName = keyof typeof ICON_MAP;
+interface IconProps {
+    name: IconName;
+    size?: keyof typeof SIZE_CLASSES;
+    className?: string;
+}
+export declare function Icon({ name, size, className }: IconProps): JSX.Element;
+declare function PhoneIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function PhoneSlashIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function ChatIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function MicIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function MicOffIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function ChevronDownIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function ChevronUpIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+declare function CheckIcon(props: JSX.HTMLAttributes<SVGSVGElement>): JSX.Element;
+export {};

package/dist/components/InOutTransition.d.ts

@@ -0,0 +1,37 @@
+import { HTMLAttributes } from "preact/compat";
+import { Signalish } from "../utils/signalish";
+interface InOutTransitionProps extends HTMLAttributes<HTMLElement> {
+    /**
+     * Whether the child should be shown or not.
+     */
+    active: Signalish<boolean>;
+    /**
+     * The initial state of the child.
+     *
+     * @remarks
+     * Defaults to the value of `active` at the time of mounting.
+     */
+    initial?: Signalish<boolean>;
+}
+/**
+ * A wrapper component that retains its children during CSS transitions.
+ *
+ * @remarks
+ * The component expects a single child element. The child will be mounted only
+ * when the `active` property is set. When inactive, the component will wait
+ * for all ongoing CSS transitions to end and unmount the child afterward.
+ *
+ * `data-hidden:*` and `data-shown:*` tailwind modifiers can be used to animate
+ * the child in and out.
+ *
+ * @example
+ * ```tsx
+ * <InOutTransition enabled={enabled}>
+ *   <div className="transition-opacity duration-200 data-hidden:opacity-0">
+ *     Example
+ *   </div>
+ * </InOutTransition>
+ * ```
+ */
+export declare function InOutTransition(props: InOutTransitionProps): import("preact/compat").JSX.Element;
+export {};

package/dist/components/SizeTransition.d.ts

@@ -0,0 +1,28 @@
+import { HTMLAttributes, PropsWithoutRef } from "preact/compat";
+interface SizeTransitionProps extends PropsWithoutRef<HTMLAttributes<HTMLSpanElement>> {
+    /**
+     * Whether the children should be shown.
+     *
+     * @remarks
+     * When set to `false`, the children will fade out and the size will
+     * transition towards `0` to make the element disappear.
+     */
+    visible?: boolean;
+    /**
+     * Whether the component should grow to fill the available space in a flex
+     * layout.
+     */
+    grow?: boolean;
+    /**
+     * A dependency used to detect when the size of the children changes.
+     */
+    dep?: any;
+}
+/**
+ * A component whose size animates to match its content.
+ *
+ * @param props
+ * @constructor
+ */
+export declare function SizeTransition(props: SizeTransitionProps): import("preact/compat").JSX.Element;
+export {};

package/dist/components/TextArea.d.ts

@@ -0,0 +1,2 @@
+import { TextareaHTMLAttributes } from "preact/compat";
+export declare function TextArea({ className, ...props }: TextareaHTMLAttributes<HTMLTextAreaElement>): import("preact/compat").JSX.Element;

package/dist/contexts/attributes.d.ts

@@ -0,0 +1,17 @@
+import { ReadonlySignal, Signal } from "@preact/signals";
+import { CustomAttributeList, CustomAttributes } from "../types/attributes";
+import type { JSX } from "preact";
+export type AttributeSignals = {
+    [key in (typeof CustomAttributeList)[number]]: Signal<string | undefined>;
+};
+export type AttributeReadonlySignals = {
+    [key in (typeof CustomAttributeList)[number]]: ReadonlySignal<string | undefined>;
+};
+interface AttributesProviderProps {
+    value: CustomAttributes;
+    children: JSX.Element;
+}
+export declare function AttributesProvider({ value, children, }: AttributesProviderProps): JSX.Element;
+export declare function useAttributes(): AttributeReadonlySignals;
+export declare function useAttribute(name: (typeof CustomAttributeList)[number]): ReadonlySignal<string | undefined>;
+export {};

package/dist/contexts/avatar-config.d.ts

@@ -0,0 +1,13 @@
+import { ReadonlySignal, Signal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+import { AvatarConfig } from "../types/config";
+interface AvatarConfigProviderProps {
+    children: ComponentChildren;
+}
+export declare function AvatarConfigProvider({ children }: AvatarConfigProviderProps): import("preact").JSX.Element;
+export declare function useAvatarConfig(): {
+    config: ReadonlySignal<AvatarConfig>;
+    previewUrl: ReadonlySignal<string>;
+    canvasUrl: Signal<string>;
+};
+export {};

package/dist/contexts/conversation.d.ts

@@ -0,0 +1,42 @@
+import { Mode, Role, Status } from "@elevenlabs/client";
+import { ComponentChildren } from "preact";
+interface ConversationProviderProps {
+    children: ComponentChildren;
+}
+export type TranscriptEntry = {
+    type: "message";
+    role: Role;
+    message: string;
+    isText: boolean;
+    conversationIndex: number;
+} | {
+    type: "disconnection";
+    role: Role;
+    message?: undefined;
+    conversationIndex: number;
+} | {
+    type: "error";
+    message: string;
+    conversationIndex: number;
+};
+export declare function ConversationProvider({ children }: ConversationProviderProps): import("preact").JSX.Element;
+export declare function useConversation(): {
+    status: import("@preact/signals").Signal<Status>;
+    isSpeaking: import("@preact/signals").ReadonlySignal<boolean>;
+    mode: import("@preact/signals").Signal<Mode>;
+    isDisconnected: import("@preact/signals").ReadonlySignal<boolean>;
+    lastId: import("@preact/signals").Signal<string | null>;
+    error: import("@preact/signals").Signal<string | null>;
+    canSendFeedback: import("@preact/signals").Signal<boolean>;
+    conversationIndex: import("@preact/signals").Signal<number>;
+    conversationTextOnly: import("@preact/signals").Signal<boolean | null>;
+    transcript: import("@preact/signals").Signal<TranscriptEntry[]>;
+    startSession: (element: HTMLElement, initialMessage?: string) => Promise<string | undefined>;
+    endSession: () => Promise<void>;
+    getInputVolume: () => number;
+    getOutputVolume: () => number;
+    sendFeedback: (like: boolean) => void;
+    sendUserMessage: (text: string) => void;
+    sendUserActivity: () => void;
+};
+export {};

package/dist/contexts/language-config.d.ts

@@ -0,0 +1,16 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+import { Language } from "@elevenlabs/client";
+import { LanguageInfo } from "../types/languages";
+interface LanguageConfig {
+    language: ReadonlySignal<LanguageInfo>;
+    setLanguage: (value: Language) => void;
+    options: ReadonlySignal<LanguageInfo[]>;
+    showPicker: ReadonlySignal<boolean>;
+}
+interface LanguageConfigProviderProps {
+    children: ComponentChildren;
+}
+export declare function LanguageConfigProvider({ children, }: LanguageConfigProviderProps): import("preact").JSX.Element;
+export declare function useLanguageConfig(): LanguageConfig;
+export {};

package/dist/contexts/mic-config.d.ts

@@ -0,0 +1,13 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+interface MicConfig {
+    isMutingEnabled: ReadonlySignal<boolean>;
+    isMuted: ReadonlySignal<boolean>;
+    setIsMuted: (value: boolean) => void;
+}
+interface MicConfigProviderProps {
+    children: ComponentChildren;
+}
+export declare function MicConfigProvider({ children }: MicConfigProviderProps): import("preact").JSX.Element;
+export declare function useMicConfig(): MicConfig;
+export {};

package/dist/contexts/root-portal.d.ts

@@ -0,0 +1,6 @@
+import { HTMLAttributes } from "preact/compat";
+interface RootPortalProviderProps extends HTMLAttributes<HTMLDivElement> {
+}
+export declare function Root({ children, ...rest }: RootPortalProviderProps): import("preact/compat").JSX.Element;
+export declare function useRootPortal(): HTMLDivElement;
+export {};

package/dist/contexts/server-location.d.ts

@@ -0,0 +1,14 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+export type Location = "us" | "global";
+interface ServerLocationProviderProps {
+    children: ComponentChildren;
+}
+export declare function ServerLocationProvider({ children, }: ServerLocationProviderProps): import("preact").JSX.Element;
+export declare function useServerLocation(): {
+    location: ReadonlySignal<Location>;
+    serverUrl: ReadonlySignal<string>;
+    webSocketUrl: ReadonlySignal<string>;
+};
+export declare function parseLocation(location?: string): Location;
+export {};

package/dist/contexts/session-config.d.ts

@@ -0,0 +1,9 @@
+import { SessionConfig } from "@elevenlabs/client";
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+interface SessionConfigProviderProps {
+    children: ComponentChildren;
+}
+export declare function SessionConfigProvider({ children, }: SessionConfigProviderProps): import("preact").JSX.Element | null;
+export declare function useSessionConfig(): ReadonlySignal<SessionConfig>;
+export {};

package/dist/contexts/terms.d.ts

@@ -0,0 +1,14 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+interface TermsProviderProps {
+    children: ComponentChildren;
+}
+export declare function TermsProvider({ children }: TermsProviderProps): import("preact").JSX.Element;
+export declare function useTerms(): {
+    termsAccepted: ReadonlySignal<boolean>;
+    termsShown: ReadonlySignal<boolean>;
+    requestTerms: () => Promise<void>;
+    dismissTerms: () => void;
+    acceptTerms: () => void;
+};
+export {};

package/dist/contexts/text-contents.d.ts

@@ -0,0 +1,12 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+import { TextContents } from "../types/config";
+type TextContentsType = {
+    [key in keyof TextContents]: ReadonlySignal<string>;
+};
+interface TextContentsProviderProps {
+    children: ComponentChildren;
+}
+export declare function TextContentsProvider({ children }: TextContentsProviderProps): import("preact").JSX.Element;
+export declare function useTextContents(): TextContentsType;
+export {};

package/dist/contexts/widget-config.d.ts

@@ -0,0 +1,12 @@
+import { ReadonlySignal } from "@preact/signals";
+import { ComponentChildren } from "preact";
+import { WidgetConfig } from "../types/config";
+interface WidgetConfigProviderProps {
+    children: ComponentChildren;
+}
+export declare function WidgetConfigProvider({ children }: WidgetConfigProviderProps): import("preact").JSX.Element | null;
+export declare function useWidgetConfig(): ReadonlySignal<WidgetConfig>;
+export declare function useTextOnly(): ReadonlySignal<boolean>;
+export declare function useIsConversationTextOnly(): ReadonlySignal<boolean>;
+export declare function useFirstMessage(): ReadonlySignal<string | null>;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export type { CustomAttributes } from "./types/attributes";
+export declare function registerWidget(tagName?: string): void;

package/dist/index.dev.d.ts

@@ -0,0 +1 @@
+export {};