@inkeep/agents-ui 0.0.0-dev-20260313222128

package/dist/types/config/open-settings.d.ts

@@ -0,0 +1,70 @@
+export interface BaseOpenSettings {
+    /**
+     * Controls whether the component is open.
+     */
+    isOpen?: boolean;
+    /**
+     * Handler called when the component opens or closes.
+     */
+    onOpenChange?: (isOpen: boolean) => void;
+    /**
+     * Whether the component is open by default.
+     * @default false
+     */
+    defaultOpen?: boolean;
+    /**
+     * The shortcut key.
+     *
+     * The key to trigger the component when pressed with Cmd (Mac) / Ctrl (Windows).
+     *
+     * Set to `null` to disable the shortcut.
+     *
+     * @default null
+     */
+    shortcutKey?: string | null;
+    /**
+     * The trigger selector.
+     *
+     * The selector to trigger the component when clicked.
+     *
+     * @default undefined
+     */
+    triggerSelector?: string;
+}
+export interface OpenSettingsModal extends BaseOpenSettings {
+    /**
+     * The trigger selector.
+     *
+     * The selector to trigger the modal when clicked.
+     *
+     * @default '[data-inkeep-modal-trigger]'
+     */
+    triggerSelector?: string;
+}
+export interface OpenSettingsChatButton extends BaseOpenSettings {
+}
+export interface OpenSettingsSearchBar extends BaseOpenSettings {
+    /**
+     * The shortcut key.
+     *
+     * The key to trigger the searchbar when pressed with Cmd (Mac) / Ctrl (Windows).
+     *
+     * Set to `null` to disable the shortcut.
+     *
+     * @default 'k'
+     */
+    shortcutKey?: string | null;
+}
+export interface OpenSettingsSidebar extends BaseOpenSettings {
+    /**
+     * The trigger selector for the sidebar chat.
+     * @default '[data-inkeep-sidebar-chat-trigger]'
+     */
+    triggerSelector?: string;
+    /**
+     * Threshold factor for auto-closing when resizing.
+     * When dragging below (minWidth * autoCloseThreshold), the sidebar will auto-close.
+     * @default 0.7 (70% of minimum width)
+     */
+    autoCloseThreshold?: number;
+}

package/dist/types/config/search.d.ts

@@ -0,0 +1,95 @@
+import { SourceItem } from '../sources';
+export interface InkeepSearchSettings {
+    /**
+     * The placeholder text to use.
+     * @default
+     * 'Search anything...' (desktop)
+     * 'Search' (mobile)
+     */
+    placeholder?: string;
+    /**
+     * The default query to use.
+     * @default ''
+     */
+    defaultQuery?: string;
+    /**
+     * Callback for when the search query changes.
+     */
+    onQueryChange?: (query: string) => void;
+    /**
+     * Search callback function that handles all search functionality.
+     * This callback handles the complete search implementation.
+     * If not provided, the widget will warn and show no results.
+     *
+  
+     * @param query - The search query string
+     * @param abortSignal - Signal to abort the search request
+     *
+     * @returns Promise that resolves with search results
+     */
+    onSearch?: (query: string, abortSignal: AbortSignal) => Promise<SourceItem[]>;
+    /**
+     * The time in milliseconds to wait triggering the search.
+     * @default 0
+     */
+    debounceTimeMs?: number;
+    /**
+     * Ref to the AIChat component's callable functions
+     */
+    searchFunctionsRef?: React.Ref<SearchFunctions>;
+    /**
+     * Controls whether links should open in a new tab.
+     * @default false
+     */
+    shouldOpenLinksInNewTab?: boolean;
+    /**
+     * Tabs to display in the search results, and in the **desired order**. Each tab can be either a string or a tuple of [string, options].
+     *
+     * Default tabs if none provided: All, Publications, PDFs, GitHub, Forums, Discord, Slack, StackOverflow
+     *
+     * Behavior:
+     * - Omit 'All' from tabs array to hide the All tab
+     * - Empty tabs array will show all results without tab UI
+     * - Tabs only appear when they have results, unless isAlwaysVisible is set
+     * ```ts
+     * // Basic tabs
+     * tabs: ['Publications', 'GitHub']
+     *
+     * // With isAlwaysVisible option
+     * tabs: [
+     *   'Publications',
+     *   ['GitHub', { isAlwaysVisible: true }] // Shows even with no results
+     * ]
+     * ```
+     */
+    tabs?: (string | SearchTab)[];
+    /**
+     * The key to use for the search query parameter.
+     *
+     * When a user selects a search result, the query is added to the URL as a query parameter.
+     * This is the key of that query parameter.
+     *
+     */
+    searchQueryParamKey?: string;
+    /**
+     * The view to use for the search.
+     * @default 'single-pane'
+     */
+    view?: 'single-pane' | 'dual-pane';
+}
+export interface SearchTab {
+    [0]: string;
+    [1]: {
+        isAlwaysVisible?: boolean;
+    };
+}
+export interface SearchFunctions {
+    /**
+     * Update the query.
+     */
+    updateQuery: (query: string) => void;
+    /**
+     * Focus the input.
+     */
+    focusInput: () => void;
+}

package/dist/types/config/settings/actions.d.ts

@@ -0,0 +1,112 @@
+import { InkeepCustomIcon } from '../../icons';
+import { Message } from '../../message';
+import { AIChatFormSettings } from './form';
+export interface OpenFormAction {
+    type: 'open_form';
+    formSettings: AIChatFormSettings;
+}
+export interface OpenUrlAction {
+    type: 'open_link';
+    url: string;
+}
+export interface InvokeCallbackArgs {
+    conversation: {
+        id: string;
+        messages: Message[];
+    };
+}
+export interface InvokeMessageCallbackActionArgs extends InvokeCallbackArgs {
+    messageId?: string;
+}
+export interface InvokeCallbackAction {
+    type: 'invoke_callback';
+    callback: (args: InvokeCallbackArgs) => void;
+    shouldCloseModal?: boolean;
+}
+export interface InvokeMessageCallbackAction {
+    type: 'invoke_message_callback';
+    callback: (args: InvokeMessageCallbackActionArgs) => void;
+    shouldCloseModal?: boolean;
+}
+type Expand<T> = T extends infer O ? {
+    [K in keyof O]: O[K];
+} : never;
+type ExpandUnion<T> = T extends any ? Expand<T> : never;
+type ChatAction = ExpandUnion<InvokeCallbackAction | OpenFormAction | OpenUrlAction>;
+type MessageChatAction = ExpandUnion<InvokeMessageCallbackAction | OpenFormAction | OpenUrlAction>;
+export type ChatActionType = ChatAction['type'];
+export interface GetHelpOption {
+    icon?: InkeepCustomIcon;
+    name: string;
+    isPinnedToToolbar?: boolean;
+    /**
+     * Action to be performed when the option is clicked.
+     *
+     * ```ts
+     * action: {
+     *   type: 'open_form',
+     *   formSettings: {
+     *     title: 'Open Form',
+     *     description: 'Open a form',
+     *   },
+     * }
+     * ```
+     * ```ts
+     * action: {
+     *   type: 'open_link',
+     *   url: 'https://example.com',
+     * }
+     * ```
+     * ```ts
+     * action: {
+     *   type: 'invoke_callback',
+     *   callback: (args: InvokeCallbackArgs) => {
+     *     console.log(args)
+     *   },
+     * }
+     * ```
+     */
+    action: ChatAction;
+}
+export interface CustomMessageAction {
+    label?: string;
+    /**
+     * Icon to be displayed next to the label.
+     *
+     * ```ts
+     * icon: { builtIn: 'FaEnvelope' },
+     * icon: { custom: 'https://example.com/icon.svg' },
+     * ```
+     */
+    icon?: InkeepCustomIcon;
+    /**
+     * Action to be performed when the option is clicked.
+     *
+     * ```ts
+     * action: {
+     *   type: 'open_form',
+     *   formSettings: {
+     *     title: 'Open Form',
+     *     description: 'Open a form',
+     *   },
+     * },
+     * ```
+     * ```ts
+     * action: {
+     *   type: 'invoke_message_callback',
+     *   callback: (args: InvokeMessageCallbackActionArgs) => {
+     *     console.log(args)
+     *   },
+     * }
+     * ```
+     * ```ts
+     * action: {
+     *   type: 'open_link',
+     *   url: 'https://example.com',
+     * }
+     * ```
+     */
+    action: MessageChatAction;
+}
+export type IkpChatAction = GetHelpOption | CustomMessageAction;
+export {};

package/dist/types/config/settings/form.d.ts

@@ -0,0 +1,83 @@
+import { InkeepCustomIcon } from '../../icons';
+import { Message } from '../../message';
+export type FieldValues = Record<string, any>;
+export interface AIChatFormSettings {
+    heading?: string;
+    description?: string;
+    buttons: AIChatFormButtons;
+    fields: FormField[];
+    successView?: AIChatFormSuccessView;
+}
+export interface SubmitCallbackArgs {
+    values: FieldValues;
+    conversation?: {
+        id: string;
+        messages: Message[];
+    };
+}
+export type SubmitCallback = (values: SubmitCallbackArgs) => Promise<void> | void;
+export type CloseFormAction = 'return_to_chat' | 'close_modal';
+export interface AIChatFormButtons {
+    submit: {
+        label?: string;
+        onSubmit: SubmitCallback;
+    };
+    close?: {
+        action: CloseFormAction;
+    };
+}
+interface AIChatFormDoneButton {
+    label: string;
+    icon?: InkeepCustomIcon;
+    action: CloseFormAction;
+}
+interface AIChatFormSuccessView {
+    heading: string;
+    message: string;
+    doneButton: AIChatFormDoneButton;
+}
+export type FormField = CheckboxField | ComboboxField | FileField | SelectField | TextField | IncludeChatSessionField;
+export type FormInputType = NonNullable<FormField['inputType']>;
+export interface BaseFormField {
+    name: string;
+    label: string;
+    isRequired?: boolean;
+    isHidden?: boolean;
+    description?: string;
+}
+interface CheckboxField extends BaseFormField {
+    inputType: 'checkbox';
+    defaultValue?: boolean;
+}
+interface FileField extends BaseFormField {
+    inputType: 'file';
+}
+export interface SelectItem {
+    label: string;
+    value: string;
+}
+interface SelectField extends BaseFormField {
+    inputType: 'select';
+    items: SelectItem[];
+    defaultValue?: string;
+    placeholder?: string;
+}
+interface ComboboxField extends BaseFormField {
+    inputType: 'combobox';
+    items: SelectItem[];
+    /** Value is always an array; single selection = array with one value. */
+    defaultValue?: string[];
+    placeholder?: string;
+    multiple?: boolean;
+}
+interface TextField extends BaseFormField {
+    inputType: 'email' | 'text' | 'textarea';
+    defaultValue?: string;
+    placeholder?: string;
+}
+export interface IncludeChatSessionField extends BaseFormField {
+    _type: 'include_chat_session';
+    inputType?: 'checkbox';
+    defaultValue?: boolean;
+}
+export {};

package/dist/types/config/settings/jsonschema.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export type JSONSchemaTypeName = ({} & string) | 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export type JSONSchemaType = string | number | boolean | JSONSchemaObject | JSONSchemaArray | null;
+export interface JSONSchemaObject {
+    [key: string]: JSONSchemaType;
+}
+export interface JSONSchemaArray extends Array<JSONSchemaType> {
+}
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-07/schema#'
+ * - 'http://json-schema.org/draft-07/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+export type JSONSchemaVersion = string;
+/**
+ * JSON Schema v7
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+ */
+export type JSONSchemaDefinition = JSONSchema | boolean;
+export interface JSONSchema {
+    $id?: string | undefined;
+    $comment?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
+     */
+    type?: JSONSchemaTypeName | JSONSchemaTypeName[] | undefined;
+    enum?: JSONSchemaType[] | undefined;
+    const?: JSONSchemaType | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
+     */
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
+     */
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
+     */
+    items?: JSONSchemaDefinition | JSONSchemaDefinition[] | undefined;
+    additionalItems?: JSONSchemaDefinition | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    contains?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
+     */
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    required?: string[] | undefined;
+    properties?: {
+        [key: string]: JSONSchemaDefinition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: JSONSchemaDefinition;
+    } | undefined;
+    additionalProperties?: JSONSchemaDefinition | undefined;
+    propertyNames?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    if?: JSONSchemaDefinition | undefined;
+    then?: JSONSchemaDefinition | undefined;
+    else?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
+     */
+    allOf?: JSONSchemaDefinition[] | undefined;
+    anyOf?: JSONSchemaDefinition[] | undefined;
+    oneOf?: JSONSchemaDefinition[] | undefined;
+    not?: JSONSchemaDefinition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
+     */
+    format?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: JSONSchemaType | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    examples?: JSONSchemaType | undefined;
+}

package/dist/types/config/settings/workflow.d.ts

@@ -0,0 +1,86 @@
+import { InkeepCustomIcon } from '../../icons';
+/**
+ * Workflow defines the interaction steps for the AI bot.
+ */
+export interface Workflow {
+    id: string;
+    displayName: string;
+    goals: string[];
+    informationToCollect: WorkflowInformationToCollect[];
+    botPersona?: string;
+    context?: string[];
+    guidance?: string[];
+    initialReplyMessage: string;
+    supportedInputs?: WorkflowInputTypes[];
+}
+export interface WorkflowInformationToCollect {
+    description: string;
+    required: boolean;
+}
+/**
+ * WorkflowInputTypes represents possible ways of collecting attachments in a Workflow.
+ */
+export type WorkflowInputTypes = WorkflowFunctionalMultiInput | WorkflowModalSingleInput;
+/**
+ * WorkflowFunctionalMultiInput represents a function to be called when the attachment is invoked.
+ */
+export interface WorkflowFunctionalMultiInput extends WorkflowBaseInputTypes {
+    type: 'FUNCTIONAL_MULTI_ATTACHMENT';
+    onInvoke: (workflow: Workflow, selectedInputType: WorkflowInputTypes, callback: (messageAttachments: MessageAttachment[]) => void, currentMessageAttachments: MessageAttachment[]) => void;
+}
+/**
+ * BaseType is a base interface for data types.
+ */
+interface WorkflowBaseContentType {
+    type: string;
+    contentInputLabel: string;
+    attachmentIcon?: InkeepCustomIcon;
+}
+/**
+ * MessageAttachmentContentType represents possible type of information that can be attached to a Workflow.
+ */
+export type MessageAttachmentContentType = WorkflowCodeContentType | WorkflowTextContentType;
+/**
+ * WorkflowModalSingleInput represents a modal input type.
+ */
+export interface WorkflowModalSingleInput extends WorkflowBaseInputTypes {
+    type: 'MODAL';
+    contentType: MessageAttachmentContentType;
+    workflowModalProps?: WorkflowModalProps;
+}
+/**
+ * WorkflowInputType defines the type of attachments in a Workflow.
+ */
+export interface WorkflowBaseInputTypes {
+    id: string;
+    type: string;
+    displayName: string;
+}
+export interface WorkflowModalProps {
+    titleInputLabel?: string;
+    modalHelpText?: string;
+    modalHelpElement?: React.ReactElement;
+}
+export interface WorkflowCodeContentType extends WorkflowBaseContentType {
+    type: 'CODE';
+    language: string;
+}
+export interface WorkflowTextContentType extends WorkflowBaseContentType {
+    type: 'text';
+}
+export interface MessageAttachment {
+    contentType: MessageAttachmentContentType;
+    title: string;
+    content: string;
+    id: string;
+    context?: string[];
+}
+export interface MessageAttributes {
+    attachments?: MessageAttachment[];
+    workflow?: Workflow;
+}
+export interface MessageMetadata {
+    attributes?: MessageAttributes;
+    context?: string;
+}
+export {};