@coristen/widget 0.1.8 → 0.1.10

package/README.md

@@ -1,39 +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`; 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.
+# @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/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/display.test.d.ts

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

package/dist/index.d.ts

@@ -1,12 +1,21 @@
-import type { WidgetSettings } from "./api";
+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;
     fontSize?: string;
     appearance?: WidgetAppearance;
     onReady?: () => void;
     onError?: (error: Error) => void;
 };
+type WidgetTriggerElement = ReactElement<{
+    "aria-expanded"?: boolean;
+    onClick?: MouseEventHandler<HTMLElement>;
+}>;
 export type CoristenWidgetProps = CoristenWidgetOptions & ({
     apiKey: string;
     identity?: never;
@@ -14,9 +23,20 @@ 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 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(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: {
     open(): void;
     close(): void;