@coristen/widget 0.1.0 → 0.1.2

package/README.md

@@ -1,29 +1,39 @@
-# @coristen/widget
-
-Install the Coristen customer-experience widget in any React application.
-
-```bash
-npm install @coristen/widget
-```
-
-```tsx
-import { CoristenWidget } from "@coristen/widget"
-import "@coristen/widget/styles.css"
-
-export default function App() {
-  return <CoristenWidget identity="/api/coristen/identity" />
-}
-```
-
-Create the route with the server-only helper:
-
-```ts
-import { coristenIdentity } from "@coristen/widget/server"
-
-export const { GET } = coristenIdentity(async (request) => {
-  const user = await getSignedInUser(request)
-  return user ? { id: user.id, name: user.name, email: user.email } : null
-})
-```
-
-Set `CORISTEN_KEY` on the server. The widget renders only for a verified signed-in customer; there is no anonymous fallback. Use `apiUrl="http://localhost:3000"` while developing Coristen locally.
+# @coristen/widget
+
+Install the Coristen customer-experience widget in any React application.
+
+```bash
+npm install @coristen/widget
+```
+
+```tsx
+import { CoristenWidget } from "@coristen/widget"
+import "@coristen/widget/styles.css"
+
+export default function App() {
+  return <CoristenWidget apiKey="coristen_pk_..." />
+}
+```
+
+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:
+
+```tsx
+<CoristenWidget identity="/api/coristen/identity" />
+```
+
+Create the route with the server-only helper:
+
+```ts
+import { coristenIdentity } from "@coristen/widget/server"
+
+export const { GET } = coristenIdentity(async (request) => {
+  const user = await getSignedInUser(request)
+  return user ? { id: user.id, name: user.name, email: user.email } : null
+})
+```
+
+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.

package/dist/api.d.ts

@@ -6,7 +6,6 @@ export type ChatMessage = {
     inReplyTo?: string;
     generationStatus?: "generating" | "complete" | "failed";
     generationError?: string;
-    model?: string;
     citations?: Array<{
         sourceId: string;
         title: string;
@@ -28,6 +27,8 @@ export type ChatAttachment = {
 };
 export type WidgetSettings = {
     name: string;
+    agentName: string;
+    agentImageUrl: string | null;
     brandColor: string;
     welcomeMessage: string;
     privacyPolicyUrl: string;
@@ -41,9 +42,6 @@ export type WidgetSettings = {
     radius: "none" | "sm" | "md" | "lg";
     bubbleIcon: string;
     bubbleColor: string;
-    bubbleShowText: boolean;
-    bubbleText: string;
-    bubbleIconPosition: "left" | "right";
     showPoweredBy: boolean;
     maxAttachmentSizeMb: number;
     allowedAttachmentTypes: string[];

package/dist/index.d.ts

@@ -1,14 +1,24 @@
 import type { WidgetSettings } from "./api";
-export type CoristenWidgetProps = {
-    identity: string;
+type CoristenWidgetOptions = {
     apiUrl?: string;
     defaultOpen?: boolean;
     fontSize?: string;
     appearance?: WidgetAppearance;
+    onReady?: () => void;
+    onError?: (error: Error) => void;
 };
-export type WidgetAppearance = Partial<Pick<WidgetSettings, "brandColor" | "position" | "theme" | "tintedGrayscale" | "accentEnabled" | "accentHeader" | "accentSendIcon" | "radius" | "bubbleIcon" | "bubbleColor" | "bubbleShowText" | "bubbleText" | "bubbleIconPosition" | "showPoweredBy">>;
-export declare function CoristenWidget({ identity, apiUrl, defaultOpen, fontSize, appearance, }: CoristenWidgetProps): import("react").JSX.Element | null;
+export type CoristenWidgetProps = CoristenWidgetOptions & ({
+    apiKey: string;
+    identity?: never;
+} | {
+    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 { WidgetSettings } from "./api";
 export declare const coristenWidget: {
+    open(): void;
+    close(): void;
     reset(): void;
 };