@coristen/widget 0.1.0 → 0.1.1

package/README.md

@@ -11,10 +11,18 @@ import { CoristenWidget } from "@coristen/widget"
 import "@coristen/widget/styles.css"
 
 export default function App() {
-  return <CoristenWidget identity="/api/coristen/identity" />
+  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
@@ -26,4 +34,6 @@ export const { GET } = coristenIdentity(async (request) => {
 })
 ```
 
-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.
+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/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 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" | "bubbleShowText" | "bubbleText" | "bubbleIconPosition" | "showPoweredBy">>;
-export declare function CoristenWidget({ identity, apiUrl, defaultOpen, fontSize, appearance, }: CoristenWidgetProps): import("react").JSX.Element | null;
+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;
 };