@coristen/widget 0.1.9 → 0.1.10

package/README.md

@@ -1,66 +1,20 @@
-# @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`. 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" />
-```
-
-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 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.
+# @coristen/widget
+
+Add Coristen to a 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_..." />
+}
+```
+
+Use `CoristenDock` for a side panel and `CoristenModal` for a modal. See the
+[Coristen documentation](https://github.com/brayanj4y/coristen/tree/master/apps/docs/content/docs)
+for installation, identity, security, and API details.

package/dist/display.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -1,6 +1,9 @@
+import { type MouseEventHandler, type ReactElement, type ReactNode } from "react";
 import type { WidgetSettings, WidgetWelcome } from "./api";
 type CoristenWidgetOptions = {
     apiUrl?: string;
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
     defaultOpen?: boolean;
     defaultEmail?: string;
     welcome?: WidgetWelcome;
@@ -9,6 +12,10 @@ type CoristenWidgetOptions = {
     onReady?: () => void;
     onError?: (error: Error) => void;
 };
+type WidgetTriggerElement = ReactElement<{
+    "aria-expanded"?: boolean;
+    onClick?: MouseEventHandler<HTMLElement>;
+}>;
 export type CoristenWidgetProps = CoristenWidgetOptions & ({
     apiKey: string;
     identity?: never;
@@ -16,8 +23,18 @@ export type CoristenWidgetProps = CoristenWidgetOptions & ({
     identity: string;
     apiKey?: never;
 });
+export type CoristenModalProps = CoristenWidgetProps & {
+    trigger: WidgetTriggerElement;
+};
+export type CoristenDockProps = CoristenWidgetProps & {
+    children: ReactNode;
+    side?: "left" | "right";
+    trigger: WidgetTriggerElement;
+};
 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 declare function CoristenWidget(props: CoristenWidgetProps): import("react").JSX.Element;
+export declare function CoristenModal({ trigger, ...props }: CoristenModalProps): import("react").JSX.Element;
+export declare function CoristenDock({ children, side, trigger, open: controlledOpen, onOpenChange, defaultOpen, appearance, ...props }: CoristenDockProps): import("react").JSX.Element;
 export type { WidgetSettings } from "./api";
 export type { WidgetWelcome, WidgetSuggestion } from "./api";
 export declare const coristenWidget: {