@inkeep/agents-ui 0.14.20 → 0.14.21

package/dist/types/js/index.d.ts

@@ -0,0 +1,54 @@
+import { InkeepAIChatSettings } from '../config/ai';
+import { InkeepBaseSettings } from '../config/base';
+import { InkeepModalSettings } from '../config/modal';
+import { InkeepSearchSettings } from '../config/search';
+/**
+ * Represents the available Inkeep component types that can be rendered
+ * via the global Inkeep object.
+ */
+export type InkeepJSComponent = 'EmbeddedChat' | 'EmbeddedSearch' | 'EmbeddedSearchAndChat' | 'ModalChat' | 'ModalSearch' | 'ModalSearchAndChat' | 'ChatButton' | 'SearchBar' | 'SidebarChat';
+export interface InkeepSettings {
+    baseSettings?: InkeepBaseSettings;
+    aiChatSettings?: InkeepAIChatSettings;
+    searchSettings?: InkeepSearchSettings;
+    modalSettings?: InkeepModalSettings;
+}
+export type InkeepComponentProps = InkeepSettings & {
+    [key: string]: any;
+};
+export type InkeepComponentInitializer = {
+    (props: InkeepComponentProps): InkeepComponentInstance | undefined;
+    (targetSelector: string, props: InkeepComponentProps): InkeepComponentInstance | undefined;
+};
+export type InkeepJS = Partial<Record<InkeepJSComponent, InkeepComponentInitializer>>;
+/**
+ * Represents an instance of any Inkeep component that is returned after initialization.
+ * These instances have methods that can be used to update the component's state.
+ */
+export interface InkeepComponentInstance {
+    /**
+     * Updates the component with new props
+     * @param newProps The new props to apply to the component
+     */
+    update: <T extends object>(newProps: T) => void;
+    /**
+     * Unmounts the component from the DOM but preserves its state
+     */
+    unmount: () => void;
+    /**
+     * Remounts a previously unmounted component
+     */
+    remount: () => void;
+    /**
+     * Access to chat-specific functionality (only available for components with chat capabilities)
+     */
+    chat?: {
+        [key: string]: (...args: any[]) => any;
+    };
+    /**
+     * Access to search-specific functionality (only available for components with search capabilities)
+     */
+    search?: {
+        [key: string]: (...args: any[]) => any;
+    };
+}

package/dist/types/message.d.ts

@@ -0,0 +1,43 @@
+import { UIMessage } from '@ai-sdk/react';
+export type ArtifactType = 'citation' | (string & {});
+export type ArtifactPart = Extract<Message['parts'][number], {
+    type: 'data-artifact';
+}>;
+export type OperationType = 'error' | 'agent_initializing' | 'completion' | 'agent_generate' | 'agent_reasoning' | 'tool_call' | 'tool_result' | 'transfer' | 'delegation_sent' | 'delegation_returned' | 'artifact_saved';
+export type DataParts = {
+    operation: {
+        type: OperationType;
+        ctx: Record<string, unknown>;
+        message?: string;
+        label?: string;
+    };
+    summary: {
+        type: string;
+        label?: string;
+        details?: Record<string, unknown>;
+    };
+    component: {
+        type: 'text';
+        text?: string;
+    } | {
+        type: 'component';
+        name: string;
+        props: Record<string, unknown>;
+    };
+    artifact: {
+        artifactId: string;
+        taskId: string;
+        name: string;
+        description: string;
+        artifactType: string;
+        type: ArtifactType;
+        artifactSummary: {
+            record_type: 'custom_question_answer' | 'site';
+            title: string;
+            url?: string;
+        };
+    };
+};
+export type Message = UIMessage<unknown, DataParts>;
+export type MessageAction = 'copy' | 'upvote' | 'downvote';
+export type AnswerConfidence = 'very_confident' | 'somewhat_confident' | 'not_confident' | 'no_sources' | 'other';

package/dist/types/shadow.d.ts

@@ -0,0 +1,15 @@
+import { ComponentType, HTMLProps, ReactNode } from 'react';
+interface ShadowRootProps {
+    mode?: 'closed' | 'open';
+    delegatesFocus?: boolean;
+    styleSheets?: CSSStyleSheet[];
+    ssr?: boolean;
+    children?: ReactNode;
+}
+type Root = Record<string, ComponentType<HTMLProps<HTMLElement> & ShadowRootProps>>;
+type RenderFn = ({ children, ssr, root, }: {
+    children: ReactNode;
+    ssr: boolean;
+    root: ShadowRoot | null;
+}) => ReactNode;
+export type { RenderFn, Root, ShadowRootProps };

package/dist/types/sources.d.ts

@@ -0,0 +1,108 @@
+import { InkeepSearchSettings } from './config/search';
+import { UrlQueryParam } from './widget';
+import { InkeepCustomIcon } from './icons';
+export interface Heading {
+    anchor?: string | null;
+    url?: string | null;
+    content: string;
+    isMatch?: boolean;
+}
+export interface SourceItem {
+    id?: string;
+    title: string | undefined;
+    url: string;
+    description: string | undefined;
+    breadcrumbs: string[];
+    type: string;
+    contentType?: string;
+    tag?: string;
+    tabs?: (SourceTab | string)[];
+    headings?: Heading[];
+    preview?: string;
+}
+export type TransformSourceType = 'chatSourceItem' | 'searchResultItem';
+export interface TransformSourceOptions {
+    organizationDisplayName?: string;
+    tabs?: InkeepSearchSettings['tabs'];
+}
+export type TransformSource = (source: SourceItem, type: TransformSourceType, opts?: TransformSourceOptions) => Partial<TransformedSource>;
+export interface SourceTab {
+    [0]: string;
+    [1]: {
+        breadcrumbs: string[];
+    };
+}
+export interface TransformedSource {
+    /**
+     * ID of the source.
+     */
+    id?: string;
+    /**
+     * Title of the source.
+     */
+    title: string;
+    /**
+     * URL of the source.
+     */
+    url: string;
+    /**
+     * Description of the source.
+     */
+    description?: string;
+    /**
+     * Breadcrumbs for the source.
+     *
+     * @example
+     * ```ts
+     * breadcrumbs: ['Subpath', 'Page']
+     * ```
+     */
+    breadcrumbs?: string[];
+    /**
+     * Tabs where this source shows up. (Only for searchResultsItem)
+     *
+     * @example
+     * ```ts
+     * tabs: ['Docs']
+     * tabs: ['Docs', 'API']
+     * ```
+     * You can also specify different breadcrumbs for specific tab.
+     * @example
+     * ```ts
+     * tabs: ['Docs', ['API', { breadcrumbs: ['Guides', 'API'] }]]
+     * ```
+     */
+    tabs?: (SourceTab | string)[];
+    /**
+     * Icon of the source.
+     *
+     * @example
+     * ```ts
+     * icon: { builtIn: 'LuBookOpen' }
+     * icon: { custom: 'https://example.com/icon.svg' }
+     * ```
+     */
+    icon: InkeepCustomIcon;
+    /**
+     * Whether to open the source in a new tab.
+     */
+    shouldOpenInNewTab?: boolean;
+    /**
+     * Search query params to append to the URL.
+     *
+     * @example
+     * If you want to know if the source is from chat or search, you can append the source type to the URL.
+     * ```ts
+     * appendToUrl: { from: 'chatSourceItem' }
+     * ```
+     */
+    appendToUrl?: UrlQueryParam;
+    /**
+     * Type of the source.
+     */
+    type: string;
+    /**
+     * Tag to append to the source.
+     */
+    tag?: string;
+}

package/dist/types/theme.d.ts

@@ -0,0 +1,25 @@
+export interface StrictIkpTheme {
+    colors: Record<string, any>;
+    fontFamily: Record<string, string>;
+    fontSize: Record<string, string>;
+    zIndex: Record<string, string | number>;
+}
+export interface UserProvidedColorScheme {
+    textBold?: string;
+    textSubtle?: string;
+    lighter?: string;
+    light?: string;
+    lightSubtle?: string;
+    medium?: string;
+    mediumSubtle?: string;
+    strongerLight?: string;
+    strong?: string;
+    stronger?: string;
+    textColorOnPrimary?: string;
+}
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends Record<string, unknown> ? DeepPartial<T[P]> : T[P];
+};
+export type IkpThemeCategory = keyof StrictIkpTheme;
+export type IkpTheme = DeepPartial<StrictIkpTheme>;
+export type IkpThemeEntry = [keyof IkpTheme, Record<string, unknown>][];

package/dist/types/widget.d.ts

@@ -0,0 +1,28 @@
+export type UrlQueryParam = Record<string, string>;
+export type ModalViewTypes = 'chat' | 'search';
+export type OnToggleView = (opts: {
+    view: ModalViewTypes;
+    query?: string;
+    autoSubmit?: boolean;
+}) => void;
+export interface WidgetView {
+    /**
+     * Callback fired when the user toggles between chat and search views.
+     *
+     * The parent component can use this
+     * to coordinate showing/hiding the appropriate view.
+     */
+    onToggleView?: OnToggleView;
+    /**
+     * The label for the Ask AI button.
+     */
+    askAILabel?: string;
+    /**
+     * The label for the Search button.
+     */
+    searchLabel?: string;
+    /**
+     * The label for the Ask AI card.
+     */
+    askAICardLabel?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inkeep/agents-ui",
-  "version": "0.14.20",
+  "version": "0.14.21",
   "description": "",
   "homepage": "",
   "repository": {
@@ -27,7 +27,6 @@
       }
     },
     "./types": {
-      "source": "./src/types/index.ts",
       "types": "./dist/types/types.d.ts",
       "default": "./dist/types/types.d.ts"
     },
@@ -130,8 +129,7 @@
   "scripts": {
     "css:gen": "postcss ./src/styled/index.css -o ./src/styled/inkeep.css",
     "ui:gen": "vite build",
-    "types:gen": "vite build --config vite.types.config.mts",
-    "build": "pnpm css:gen && pnpm ui:gen && pnpm types:gen",
+    "build": "pnpm css:gen && pnpm ui:gen",
     "watch": "vite build --watch",
     "dev": "pnpm storybook",
     "lint": "biome lint ./src",