@coristen/widget 0.1.8 → 0.1.9

package/README.md

@@ -15,9 +15,9 @@ export default function App() {
 }
 ```
 
-Public websites use `apiKey`; visitors are remembered in that browser. For an
-authenticated app, use an identity route instead so conversations follow the
-signed-in customer:
+Public websites use `apiKey`. The widget remembers visitors in that browser. For
+an authenticated app, use an identity route. This keeps conversations connected
+to the signed-in customer.
 
 ```tsx
 <CoristenWidget identity="/api/coristen/identity" />
@@ -34,6 +34,33 @@ export const { GET } = coristenIdentity(async (request) => {
 })
 ```
 
-Set `CORISTEN_KEY` on the server when using identity mode. Identity mode renders
-only for a verified signed-in customer; it never falls back to anonymous access.
-Use `apiUrl="http://localhost:3000"` while developing Coristen locally.
+Set `CORISTEN_KEY` on the server when you use identity mode. Identity mode renders
+only for a verified signed-in customer. It does not permit anonymous access.
+
+## Welcome screen
+
+After a visitor enters an email address, a new chat shows the agent avatar, workspace
+welcome message, and a maximum of three questions. Coristen generates these questions
+when it indexes or refreshes knowledge documents. Refresh existing sources to generate
+questions. If document questions are not available, the widget shows general questions.
+When a visitor selects a question, the widget sends its message immediately.
+
+Override the message and suggestion list for your installation:
+
+```tsx
+<CoristenWidget
+  apiKey="coristen_pk_..."
+  welcome={{
+    message: "How can I help you today?",
+    suggestions: [
+      { title: "Shipping", message: "What shipping options do you offer?" },
+      { title: "Returns", message: "How do I return or exchange an item?" },
+    ],
+  }}
+/>
+```
+
+Omit `suggestions` to use the automatic list. Pass `[]` to hide the suggestions.
+The exported `WidgetWelcome` and `WidgetSuggestion` types describe this API. The
+props update with your application state. A suggestion message can contain a maximum
+of 2,000 characters.

package/dist/api.d.ts

@@ -1,3 +1,11 @@
+export type WidgetSuggestion = {
+    title: string;
+    message: string;
+};
+export type WidgetWelcome = {
+    message?: string;
+    suggestions?: WidgetSuggestion[];
+};
 export type ChatMessage = {
     _id: string;
     _creationTime: number;
@@ -27,6 +35,7 @@ export type ChatAttachment = {
 };
 export type WidgetSettings = {
     name: string;
+    logoUrl?: string | null;
     agentName: string;
     agentImageUrl: string | null;
     brandColor: string;
@@ -47,6 +56,10 @@ export type WidgetSettings = {
     allowedAttachmentTypes: string[];
 };
 export declare const widgetApi: {
+    welcomeSuggestions: import("convex/server").FunctionReference<"query", "public", {
+        workspaceId: string;
+        sessionToken: string;
+    }, WidgetSuggestion[], string | undefined>;
     workspace: import("convex/server").FunctionReference<"query", "public", {
         workspaceId: string;
     }, WidgetSettings | null, string | undefined>;

package/dist/index.d.ts

@@ -1,7 +1,9 @@
-import type { WidgetSettings } from "./api";
+import type { WidgetSettings, WidgetWelcome } from "./api";
 type CoristenWidgetOptions = {
     apiUrl?: string;
     defaultOpen?: boolean;
+    defaultEmail?: string;
+    welcome?: WidgetWelcome;
     fontSize?: string;
     appearance?: WidgetAppearance;
     onReady?: () => void;
@@ -14,9 +16,10 @@ export type CoristenWidgetProps = CoristenWidgetOptions & ({
     identity: string;
     apiKey?: never;
 });
-export type WidgetAppearance = Partial<Pick<WidgetSettings, "brandColor" | "position" | "theme" | "tintedGrayscale" | "accentEnabled" | "accentHeader" | "accentSendIcon" | "radius" | "bubbleIcon" | "bubbleColor" | "showPoweredBy">>;
-export declare function CoristenWidget({ identity, apiKey, apiUrl, defaultOpen, fontSize, appearance, onReady, onError, }: CoristenWidgetProps): import("react").JSX.Element | null;
+export type WidgetAppearance = Partial<Pick<WidgetSettings, "brandColor" | "logoUrl" | "position" | "theme" | "tintedGrayscale" | "accentEnabled" | "accentHeader" | "accentSendIcon" | "radius" | "bubbleIcon" | "bubbleColor" | "showPoweredBy">>;
+export declare function CoristenWidget({ identity, apiKey, apiUrl, defaultOpen, defaultEmail, welcome, fontSize, appearance, onReady, onError, }: CoristenWidgetProps): import("react").JSX.Element | null;
 export type { WidgetSettings } from "./api";
+export type { WidgetWelcome, WidgetSuggestion } from "./api";
 export declare const coristenWidget: {
     open(): void;
     close(): void;