@inkeep/agents-ui 0.14.20 → 0.14.21

package/dist/primitives/utils/default-settings.d.ts

@@ -0,0 +1,167 @@
+import { InkeepSearchSettings } from '../../types/index.ts';
+export declare const defaultInkeepAIChatSettings: {
+    placeholder: string;
+    aiAssistantName: undefined;
+    shouldOpenLinksInNewTab: true;
+    disclaimerSettings: {
+        isEnabled: false;
+        label: string;
+    };
+    isShareButtonVisible: false;
+    isViewOnly: false;
+    exampleQuestionsLabel: string;
+    exampleQuestions: never[];
+    isFirstExampleQuestionHighlighted: true;
+    isCopyChatButtonVisible: false;
+    getHelpOptions: never[];
+    workflowsHeader: string;
+    workflows: never[];
+    toolbarButtonLabels: {
+        clear: string;
+        share: string;
+        getHelp: string;
+        stop: string;
+        copyChat: string;
+    };
+    context: {};
+};
+export declare const defaultInkeepBaseSettings: {
+    shouldBypassCaptcha: false;
+    tags: never[];
+    userProperties: {};
+    primaryBrandColor: string;
+    theme: {
+        colors: {
+            whiteAlpha: {
+                50: string;
+                100: string;
+                200: string;
+                300: string;
+                400: string;
+                500: string;
+                600: string;
+                700: string;
+                800: string;
+                900: string;
+                950: string;
+                1000: string;
+            };
+            blackAlpha: {
+                50: string;
+                100: string;
+                200: string;
+                300: string;
+                400: string;
+                500: string;
+                600: string;
+                700: string;
+                800: string;
+                900: string;
+                950: string;
+                1000: string;
+            };
+            gray: {
+                50: string;
+                100: string;
+                200: string;
+                300: string;
+                400: string;
+                500: string;
+                600: string;
+                700: string;
+                800: string;
+                900: string;
+                950: string;
+                1000: string;
+            };
+            grayDark: {
+                1000: string;
+                950: string;
+                900: string;
+                800: string;
+                700: string;
+                600: string;
+                500: string;
+                400: string;
+                300: string;
+                200: string;
+                100: string;
+                50: string;
+            };
+            overlay: {
+                light: string;
+                dark: string;
+            };
+            inkeepPrimary: {
+                textColorOnPrimary: string;
+            };
+            inkeepExpandedPrimary: {
+                "50": string;
+                "100": string;
+                "200": string;
+                "300": string;
+                "400": string;
+                "500": string;
+                "600": string;
+                "700": string;
+                "800": string;
+                "900": string;
+                "950": string;
+                "1000": string;
+            };
+        };
+        fontFamily: {
+            heading: string;
+            body: string;
+            mono: string;
+        };
+        fontSize: {
+            '3xs': string;
+            '2xs': string;
+            '1xs': string;
+            xs: string;
+            '1sm': string;
+            sm: string;
+            '2sm': string;
+            md: string;
+            lg: string;
+            xl: string;
+            '2xl': string;
+            '3xl': string;
+            '4xl': string;
+            '5xl': string;
+            '6xl': string;
+            '7xl': string;
+            '8xl': string;
+            '9xl': string;
+        };
+        zIndex: {
+            hide: number;
+            auto: string;
+            base: number;
+            start: number;
+            docked: number;
+            dropdown: number;
+            sticky: number;
+            banner: number;
+            overlay: number;
+            modal: number;
+            popover: number;
+            skipLink: number;
+            toast: number;
+            tooltip: number;
+        };
+        varsClassName: string;
+    };
+};
+export declare const defaultInkeepSearchSettings: {
+    shouldOpenLinksInNewTab: false;
+    defaultQuery: string;
+    debounceTimeMs: number;
+    tabs: string[];
+    placeholder: string;
+    view: InkeepSearchSettings["view"];
+};
+export type DefaultInkeepAIChatSettings = typeof defaultInkeepAIChatSettings;
+export type DefaultInkeepBaseSettings = typeof defaultInkeepBaseSettings;
+export type DefaultInkeepSearchSettings = typeof defaultInkeepSearchSettings;

package/dist/primitives/utils/form.d.ts

@@ -0,0 +1,3 @@
+import { FormField, FormInputType } from '../../types/index.ts';
+export declare const defaultInputValues: Record<FormInputType, string | boolean | undefined>;
+export declare function getFormDefaultValues(fields: FormField[] | undefined): Record<string, any>;

package/dist/primitives/utils/generate-uid.d.ts

@@ -0,0 +1,2 @@
+export declare function generateUid(length?: number): string;
+export declare function generatePrefixedUniqueId(prefix?: string): string;

package/dist/primitives/utils/get-message-metadata.d.ts

@@ -0,0 +1,8 @@
+import { MessageAttachment, MessageAttributes, Workflow } from '../../types/index.ts';
+export declare function getMessageMetadata(workflow: Workflow | null, attachments: MessageAttachment[], isNewChat: boolean): {
+    context: string | undefined;
+    attributes: MessageAttributes;
+} | undefined;
+export declare function serializeWorkflow(workflow: Workflow): string | undefined;
+export declare function stringifyAttachments(attachments: MessageAttachment[] | undefined): string | undefined;
+export declare function serializeAttachments(_attachments: MessageAttachment[]): string | undefined;

package/dist/primitives/utils/get-source-icon.d.ts

@@ -0,0 +1,2 @@
+import { InkeepCustomIcon, SourceItem } from '../../types/index.ts';
+export declare const getIcon: (source: SourceItem) => InkeepCustomIcon;

package/dist/primitives/utils/highlight-emphasis.d.ts

@@ -0,0 +1,4 @@
+export declare const highlightEmphasis: (text: string) => (string | {
+    content: string;
+    highlighted: boolean;
+})[];

package/dist/primitives/utils/merge-props.d.ts

@@ -0,0 +1,7 @@
+interface Props {
+    [key: string]: any;
+}
+type TupleTypes<T extends any[]> = T[number];
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare function mergeProps<T extends Props>(...args: T[]): UnionToIntersection<TupleTypes<T[]>>;
+export {};

package/dist/primitives/utils/misc.d.ts

@@ -0,0 +1,12 @@
+import { Message } from '../../types/index.ts';
+export declare const callAll: <T extends (...a: any[]) => void>(...fns: (T | undefined)[]) => (...a: Parameters<T>) => void;
+export declare const isString: (v: any) => v is string;
+/**
+ * Converts camelCase or PascalCase strings to kebab-case.
+ */
+export declare function toKebabCase(input: string): string;
+export type Booleanish = boolean | 'true' | 'false';
+export declare const dataAttr: (guard: boolean | undefined) => Booleanish;
+export declare function getInitials(name: string): string;
+export declare function maybeRender<T>(children: ((param: T) => React.ReactNode) | React.ReactNode, param: T): React.ReactNode;
+export declare const getMessageContent: (message: Message) => string;

package/dist/primitives/utils/split-props.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generic utility to split props based on specified keys.
+ * Useful for separating component configuration props from DOM props.
+ *
+ * @param props - The props object to split
+ * @param keys - Array of keys to extract from props
+ * @returns Tuple of [extracted props, remaining props]
+ *
+ * @example
+ * ```tsx
+ * const CONFIG_KEYS = ['variant', 'size', 'disabled'] as const
+ * const [configProps, domProps] = splitProps(props, CONFIG_KEYS)
+ * ```
+ */
+export declare function splitProps<T extends Record<string, unknown>, K extends keyof T>(props: T, keys: readonly K[]): [Pick<T, K>, Omit<T, K>];

package/dist/react/chat-button.d.ts

@@ -0,0 +1,14 @@
+import { InkeepAIChatSettings, InkeepModalSettings } from '../types/index.ts';
+import { InkeepEmbeddedSearchAndChatProps } from './embedded-search-and-chat';
+export interface InkeepChatButtonProps extends Omit<InkeepEmbeddedSearchAndChatProps, 'onToggleView'> {
+    modalSettings?: InkeepModalSettings;
+    label?: string;
+    avatar?: InkeepAIChatSettings['aiAssistantAvatar'];
+    canToggleView?: boolean;
+}
+export declare function InkeepChatButton(props: InkeepChatButtonProps): import("react/jsx-runtime").JSX.Element;
+interface ChatButtonImplProps extends Pick<InkeepChatButtonProps, 'label' | 'avatar'> {
+    onOpenChange?: React.Dispatch<React.SetStateAction<boolean>>;
+}
+export declare function ChatButtonImpl({ label, avatar, onOpenChange }: ChatButtonImplProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/embedded-chat.d.ts

@@ -0,0 +1,14 @@
+import { WidgetView, InkeepConfig } from '../types/index.ts';
+import { default as React, PropsWithChildren } from 'react';
+import { EmbeddedChatProviderProps } from '../styled';
+type ChatConfig = Pick<InkeepConfig, 'baseSettings' | 'aiChatSettings'>;
+type InkeepEmbeddedChatImplProps = EmbeddedChatProviderProps & WidgetView & {
+    variant?: 'no-shadow' | 'container-with-shadow';
+    header?: React.ComponentType<InkeepEmbeddedChatProps>;
+};
+export type InkeepEmbeddedChatProps = InkeepEmbeddedChatImplProps & Partial<ChatConfig>;
+export declare function InkeepEmbeddedChat(props: InkeepEmbeddedChatProps): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedChatProvider(props: PropsWithChildren<InkeepEmbeddedChatImplProps>): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedChatImpl(props: InkeepEmbeddedChatImplProps): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedChatImplContent(props: InkeepEmbeddedChatImplProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/embedded-search-and-chat.d.ts

@@ -0,0 +1,40 @@
+import { useWidgetImpl } from './embedded-search-and-chat.impl';
+import { ModalViewTypes, InkeepConfig, WidgetView } from '../types/index.ts';
+import { RefObject } from 'react';
+export interface InkeepEmbeddedSearchAndChatFunctions {
+    setView: (view: ModalViewTypes) => void;
+}
+export interface InkeepEmbeddedSearchAndChatProps extends Partial<Omit<InkeepConfig, 'componentType'>>, WidgetView {
+    /**
+     * The default view to show when the widget is loaded.
+     * @default 'search'
+     */
+    defaultView?: ModalViewTypes;
+    /**
+     * Whether to always open the widget in the default view. (Modal only)
+     *
+     * By default, subsequent opens will remember the last view.
+     * This prop will force the widget to always open in the default view.
+     *
+     * @default false
+     */
+    forceDefaultView?: boolean;
+    /**
+     * Whether to show the Ask AI card.
+     * @default false
+     */
+    shouldShowAskAICard?: boolean;
+    /**
+     * Whether to auto focus the input.
+     * @default false
+     */
+    shouldAutoFocusInput?: boolean;
+    /**
+     * A ref to the component functions.
+     */
+    ref?: RefObject<InkeepEmbeddedSearchAndChatFunctions>;
+}
+export declare function InkeepEmbeddedSearchAndChat(props: InkeepEmbeddedSearchAndChatProps): import("react/jsx-runtime").JSX.Element;
+type InkeepEmbeddedSearchAndChatImplProps = Omit<ReturnType<typeof useWidgetImpl>, 'config'>;
+export declare function InkeepEmbeddedSearchAndChatImpl(props: InkeepEmbeddedSearchAndChatImplProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/embedded-search-and-chat.impl.d.ts

@@ -0,0 +1,9 @@
+import { InkeepEmbeddedSearchAndChatProps } from './embedded-search-and-chat';
+import { ModalViewTypes, InkeepConfig } from '../types/index.ts';
+interface UseWidgetImpReturn extends InkeepEmbeddedSearchAndChatProps {
+    config: InkeepConfig;
+    view: ModalViewTypes;
+    setView: (view: ModalViewTypes) => void;
+}
+export declare function useWidgetImpl<T extends InkeepEmbeddedSearchAndChatProps>(props: T): UseWidgetImpReturn;
+export {};

package/dist/react/embedded-search.d.ts

@@ -0,0 +1,17 @@
+import { WidgetView, InkeepConfig } from '../types/index.ts';
+import { PropsWithChildren } from 'react';
+import { EmbeddedSearchProviderProps } from '../styled';
+type SearchConfig = Pick<InkeepConfig, 'baseSettings' | 'searchSettings'>;
+type InkeepEmbeddedSearchImplProps = EmbeddedSearchProviderProps & WidgetView & {
+    /**
+     * Whether to show the Ask AI card.
+     * @default false
+     */
+    shouldShowAskAICard?: boolean;
+};
+export type InkeepEmbeddedSearchProps = InkeepEmbeddedSearchImplProps & Partial<SearchConfig>;
+export declare function InkeepEmbeddedSearch(props: InkeepEmbeddedSearchProps): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedSearchProvider(props: PropsWithChildren<InkeepEmbeddedSearchImplProps>): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedSearchImpl(props: InkeepEmbeddedSearchImplProps): import("react/jsx-runtime").JSX.Element;
+export declare function InkeepEmbeddedSearchImplContent(props: InkeepEmbeddedSearchImplProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/index.d.ts

@@ -0,0 +1,12 @@
+export * from './embedded-chat';
+export * from './sidebar-chat';
+export * from './embedded-search-and-chat';
+export * from './embedded-search';
+export * from './modal.chat';
+export * from './modal.search-and-chat';
+export * from './modal.search';
+export * from './modal';
+export * from './chat-button';
+export * from './searchbar';
+export * from '../styled';
+export * from '../color-mode';

package/dist/react/modal.chat.d.ts

@@ -0,0 +1,6 @@
+import { InkeepModalSettings } from '../types/index.ts';
+import { InkeepEmbeddedChatProps } from './embedded-chat';
+export interface InkeepModalChatProps extends Omit<InkeepEmbeddedChatProps, 'onToggleView'> {
+    modalSettings?: InkeepModalSettings;
+}
+export declare function InkeepModalChat(props: InkeepModalChatProps): import("react/jsx-runtime").JSX.Element;

package/dist/react/modal.d.ts

@@ -0,0 +1,23 @@
+import { InkeepModalSettings } from '../types/index.ts';
+import { WebWidgetInteractionType, RootProviderProps } from '../styled';
+import { PropsWithChildren } from 'react';
+type RootConfig = RootProviderProps['config'];
+interface ModalConfig extends RootConfig {
+    /**
+     * The configuration for the modal.
+     */
+    modalSettings?: InkeepModalSettings;
+}
+export interface InkeepModalProps extends ModalConfig {
+    /**
+     * The content of the modal.
+     */
+    children: React.ReactNode;
+    /**
+     * The interaction type for the modal widget.
+     */
+    componentType: (typeof WebWidgetInteractionType)[keyof typeof WebWidgetInteractionType];
+}
+export declare function InkeepModal(props: InkeepModalProps): import("react/jsx-runtime").JSX.Element;
+export declare function ModalContent(props: PropsWithChildren): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/modal.search-and-chat.d.ts

@@ -0,0 +1,6 @@
+import { InkeepModalSettings } from '../types/index.ts';
+import { InkeepEmbeddedSearchAndChatProps } from './embedded-search-and-chat';
+export interface InkeepModalSearchAndChatProps extends InkeepEmbeddedSearchAndChatProps {
+    modalSettings?: InkeepModalSettings;
+}
+export declare function InkeepModalSearchAndChat(props: InkeepModalSearchAndChatProps): import("react/jsx-runtime").JSX.Element;

package/dist/react/modal.search.d.ts

@@ -0,0 +1,6 @@
+import { InkeepModalSettings } from '../types/index.ts';
+import { InkeepEmbeddedSearchProps } from './embedded-search';
+export interface InkeepModalSearchProps extends Omit<InkeepEmbeddedSearchProps, 'onToggleView'> {
+    modalSettings?: InkeepModalSettings;
+}
+export declare function InkeepModalSearch(props: InkeepModalSearchProps): import("react/jsx-runtime").JSX.Element;

package/dist/react/searchbar.d.ts

@@ -0,0 +1,13 @@
+import { InkeepModalSettings } from '../types/index.ts';
+import { InkeepEmbeddedSearchAndChatProps } from './embedded-search-and-chat';
+export interface InkeepSearchBarProps extends Omit<InkeepEmbeddedSearchAndChatProps, 'onToggleView'> {
+    modalSettings?: InkeepModalSettings;
+    canToggleView?: boolean;
+}
+export declare function InkeepSearchBar(props: InkeepSearchBarProps): import("react/jsx-runtime").JSX.Element;
+interface SearchBarImplProps {
+    onOpenChange?: React.Dispatch<React.SetStateAction<boolean>>;
+    modalSettings: InkeepSearchBarProps['modalSettings'];
+}
+export declare function SearchBarImpl({ onOpenChange, modalSettings }: SearchBarImplProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/sidebar-chat.d.ts

@@ -0,0 +1,6 @@
+import { InkeepConfig } from '../types/index.ts';
+import { EmbeddedChatProviderProps, SidebarChatProps } from '../styled';
+type ChatConfig = Pick<InkeepConfig, 'baseSettings' | 'aiChatSettings'>;
+export type InkeepSidebarChatProps = Omit<EmbeddedChatProviderProps, 'isHidden'> & Partial<ChatConfig> & SidebarChatProps;
+export declare function InkeepSidebarChat(props: InkeepSidebarChatProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react/utils.d.ts

@@ -0,0 +1,6 @@
+type PossibleRef<T> = React.Ref<T | null> | undefined;
+export declare function composeRefs<T>(...refs: PossibleRef<T>[]): (node: T | null) => void;
+export declare function composeEventHandlers<E>(originalEventHandler?: (event: E) => void, ourEventHandler?: (event: E) => void, { checkForDefaultPrevented }?: {
+    checkForDefaultPrevented?: boolean | undefined;
+}): (event: E) => void;
+export {};

package/dist/react/widget-toggle.d.ts

@@ -0,0 +1,14 @@
+import { ModalViewTypes, OnToggleView } from '../types/index.ts';
+export declare function WidgetToggle(props: {
+    onToggleView: OnToggleView;
+    query?: string;
+    askAILabel?: string;
+    searchLabel?: string;
+    view: ModalViewTypes;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useToggleView(props: {
+    onToggleView?: OnToggleView;
+    query?: string;
+}): {
+    handleToggle: (view: ModalViewTypes, autoSubmit?: boolean) => void;
+};

package/dist/styled/components/chat-button.d.ts

@@ -0,0 +1,8 @@
+import { ChatButtonPrimitive } from '../../primitives';
+import { ComponentPropsWithRef } from 'react';
+declare const ChatButtonContainer: ({ className, ...props }: ComponentPropsWithRef<typeof ChatButtonPrimitive.ChatButtonContainer>) => import("react/jsx-runtime").JSX.Element;
+declare const ChatButton: ({ className, ...props }: ComponentPropsWithRef<typeof ChatButtonPrimitive.ChatButton>) => import("react/jsx-runtime").JSX.Element;
+declare const ChatButtonText: ({ className, ...props }: ComponentPropsWithRef<typeof ChatButtonPrimitive.ChatButtonText>) => import("react/jsx-runtime").JSX.Element;
+declare const ChatButtonAvatarImage: ({ className, ...props }: React.ComponentPropsWithRef<typeof ChatButtonPrimitive.ChatButtonAvatarImage>) => import("react/jsx-runtime").JSX.Element;
+declare const ChatButtonAvatarContent: ({ className, ...props }: React.ComponentPropsWithRef<typeof ChatButtonPrimitive.ChatButtonAvatarContent>) => import("react/jsx-runtime").JSX.Element;
+export { ChatButtonContainer as Container, ChatButton, ChatButtonText, ChatButtonAvatarImage, ChatButtonAvatarContent, };

package/dist/styled/components/data-summary-group.d.ts

@@ -0,0 +1,11 @@
+import { FC } from 'react';
+interface DataSummary {
+    type: string;
+    label?: string;
+    details?: Record<string, unknown>;
+}
+export declare const DataSummaryGroup: FC<{
+    summaries: DataSummary[];
+    isCompleted: boolean;
+}>;
+export {};