@gram-ai/elements 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { ElementsProvider as GramElementsProvider } from './contexts/ElementsProvider';
 export { useElements as useGramElements } from './contexts/ElementsProvider';
 export { Chat as GramChat } from './components/Chat';
+export type { ElementsConfig, ComposerConfig, ModalConfig, ToolsConfig, ModelConfig, WelcomeConfig, Suggestion, GramRuntimeApi, CustomRuntimeApi, } from './types';

package/dist/types/index.d.ts

@@ -1,14 +1,139 @@
 import { ChatModelAdapter } from '@assistant-ui/react';
-import { ReactNode } from 'react';
+import { ComponentType, ReactNode } from 'react';
 export interface ElementsProviderProps {
+    /**
+     * The children to render.
+     */
     children: ReactNode;
+    /**
+     * The API to use for the elements.
+     * Can be a GramRuntimeApi or a CustomRuntimeApi.
+     */
     api: GramRuntimeApi | CustomRuntimeApi;
+    /**
+     * Configuration object for the Elements library.
+     */
+    config: ElementsConfig;
+}
+export interface ElementsConfig {
+    /**
+     * Whether to render the chat window inside of an expandable modal or a standalone chat window.
+     */
+    variant?: 'modal' | 'standalone';
+    /**
+     * LLM model configuration.
+     *
+     * @example
+     * const config: ElementsConfig = {
+     *   model: {
+     *     availableModels: ['gpt-4o-mini', 'gpt-4o'],
+     *     showModelPicker: true,
+     *   },
+     * }
+     */
+    model?: ModelConfig;
+    /**
+     * The theme to use for the Elements library.
+     */
+    theme?: 'light' | 'dark' | 'system';
+    /**
+     * The configuration for the welcome message and initial suggestions.
+     */
+    welcome: WelcomeConfig;
+    /**
+     * The configuration for the composer.
+     */
+    composer?: ComposerConfig;
+    /**
+     * The configuration for the modal window.
+     * Does not apply if variant is 'standalone'.
+     */
+    modal?: ModalConfig;
+    /**
+     * The configuration for the tools.
+     */
+    tools?: ToolsConfig;
+}
+export interface ModelConfig {
+    /**
+     * The models available to the user.
+     * TODO: Update type
+     */
+    availableModels: string[];
+    /**
+     * Whether to show the model picker in the composer.
+     */
+    showModelPicker?: boolean;
+}
+export interface ToolsConfig {
+    /**
+     * `components` can be used to override the default components used by the
+     * Elements library for a given tool result.
+     *
+     * Please ensure that the tool name directly matches the tool name in your Gram toolset.
+     *
+     * @example
+     * const config: ElementsConfig = {
+     *   tools: {
+     *     components: {
+     *       "get_current_weather": WeatherComponent,
+     *     },
+     *   },
+     * }
+     */
+    components?: Record<string, ComponentType>;
+}
+export interface WelcomeConfig {
+    /**
+     * The welcome message to display when the thread is empty.
+     */
+    title: string;
+    /**
+     * The subtitle to display when the thread is empty.
+     */
+    subtitle: string;
+    /**
+     * The suggestions to display when the thread is empty.
+     */
+    suggestions: Suggestion[];
+}
+export interface Suggestion {
+    title: string;
+    label: string;
+    action: string;
+}
+export interface ModalConfig {
+    /**
+     * Whether to open the modal window by default.
+     */
+    defaultOpen?: boolean;
+    /**
+     * The icon to use for the modal window.
+     * Receives the current state of the modal window.
+     */
+    icon?: (state: 'open' | 'closed' | undefined) => ReactNode;
+    /**
+     * A class name to apply to the modal window.
+     */
+    className?: string;
+}
+export interface ComposerConfig {
+    /**
+     * The placeholder text for the composer input.
+     */
+    placeholder: string;
+    /**
+     * Whether to enable attachments in the composer.
+     */
+    attachments: boolean;
 }
 export interface GramRuntimeApi {
     getSessionToken: () => Promise<string>;
     projectToken: string;
 }
 export type CustomRuntimeApi = ChatModelAdapter;
-export type ElementsContextType = object;
-export declare function isGramRuntimeApi(api: GramRuntimeApi | CustomRuntimeApi): api is GramRuntimeApi;
-export declare function isCustomRuntimeApi(api: GramRuntimeApi | CustomRuntimeApi): api is CustomRuntimeApi;
+export type ElementsContextType = {
+    config: ElementsConfig;
+};
+export declare function isGramRuntimeApi(api: GramRuntimeApi | CustomRuntimeApi | undefined): api is GramRuntimeApi;
+export declare function isCustomRuntimeApi(api: GramRuntimeApi | CustomRuntimeApi | undefined): api is CustomRuntimeApi;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@gram-ai/elements",
   "description": "Gram Elements is a library of UI primitives for building chat-like experiences for MCP Servers.",
   "type": "module",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "dist/index.js",
   "exports": {
     ".": {
@@ -23,7 +23,7 @@
   },
   "scripts": {
     "build": "vite build",
-    "lint": "eslint . && tsc -b --noEmit",
+    "lint": "eslint .",
     "analyze": "pnpm dlx vite-bundle-visualizer",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
@@ -61,7 +61,6 @@
     "@eslint/compat": "^2.0.0",
     "@eslint/js": "^9.39.1",
     "@storybook/addon-docs": "^10.0.8",
-    "@storybook/addon-onboarding": "^10.0.8",
     "@storybook/react-vite": "^10.0.8",
     "@tailwindcss/vite": "^4.1.13",
     "@types/node": "^24.10.1",