@coristen/widget 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,29 @@
-# Temporary Holding Version
+# @coristen/widget
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+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.

package/dist/api.d.ts

@@ -0,0 +1,120 @@
+export type ChatMessage = {
+    _id: string;
+    _creationTime: number;
+    sender: "customer" | "merchant";
+    body: string;
+    inReplyTo?: string;
+    generationStatus?: "generating" | "complete" | "failed";
+    generationError?: string;
+    model?: string;
+    citations?: Array<{
+        sourceId: string;
+        title: string;
+        url?: string;
+    }>;
+    attachments: Array<{
+        storageId: string;
+        name: string;
+        type: string;
+        size: number;
+        url: string | null;
+    }>;
+};
+export type ChatAttachment = {
+    storageId: string;
+    name: string;
+    type: string;
+    size: number;
+};
+export type WidgetSettings = {
+    name: string;
+    brandColor: string;
+    welcomeMessage: string;
+    privacyPolicyUrl: string;
+    position: "left" | "right";
+    enabled: boolean;
+    theme: "light" | "dark";
+    tintedGrayscale: boolean;
+    accentEnabled: boolean;
+    accentHeader: boolean;
+    accentSendIcon: boolean;
+    radius: "none" | "sm" | "md" | "lg";
+    bubbleIcon: string;
+    bubbleColor: string;
+    bubbleShowText: boolean;
+    bubbleText: string;
+    bubbleIconPosition: "left" | "right";
+    showPoweredBy: boolean;
+    maxAttachmentSizeMb: number;
+    allowedAttachmentTypes: string[];
+};
+export declare const widgetApi: {
+    workspace: import("convex/server").FunctionReference<"query", "public", {
+        workspaceId: string;
+    }, WidgetSettings | null, string | undefined>;
+    visitorProfile: import("convex/server").FunctionReference<"query", "public", {
+        workspaceId: string;
+        visitorId: string;
+        sessionToken: string;
+    }, {
+        name: string;
+        email: string;
+    } | null, string | undefined>;
+    openWebsite: import("convex/server").FunctionReference<"mutation", "public", {
+        workspaceId: string;
+        visitorId: string;
+        name: string;
+        email: string;
+        currentPage: string;
+        referrer: string;
+        browser: string;
+        device: string;
+        newConversation?: boolean;
+        sessionToken: string;
+    }, string | null, string | undefined>;
+    visitorConversations: import("convex/server").FunctionReference<"query", "public", {
+        workspaceId: string;
+        visitorId: string;
+        sessionToken: string;
+    }, {
+        _id: string;
+        lastMessageAt: number;
+        lastMessagePreview?: string;
+        customerUnreadCount?: number;
+    }[], string | undefined>;
+    customerMessages: import("convex/server").FunctionReference<"query", "public", {
+        conversationId: string;
+        visitorId: string;
+        sessionToken: string;
+    }, ChatMessage[], string | undefined>;
+    startCustomer: import("convex/server").FunctionReference<"mutation", "public", {
+        workspaceId: string;
+        visitorId: string;
+        body: string;
+        attachments?: ChatAttachment[];
+        sessionToken: string;
+    }, string, string | undefined>;
+    sendCustomer: import("convex/server").FunctionReference<"mutation", "public", {
+        conversationId: string;
+        visitorId: string;
+        body: string;
+        attachments?: ChatAttachment[];
+        sessionToken: string;
+    }, string, string | undefined>;
+    retryAgentResponse: import("convex/server").FunctionReference<"mutation", "public", {
+        conversationId: string;
+        visitorId: string;
+        customerMessageId: string;
+        sessionToken: string;
+    }, null, string | undefined>;
+    generateAttachmentUploadUrl: import("convex/server").FunctionReference<"mutation", "public", {
+        workspaceId: string;
+        visitorId: string;
+        sessionToken: string;
+    }, string, string | undefined>;
+    markCustomerRead: import("convex/server").FunctionReference<"mutation", "public", {
+        conversationId: string;
+        visitorId: string;
+        sessionToken: string;
+    }, null, string | undefined>;
+};

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import type { WidgetSettings } from "./api";
+export type CoristenWidgetProps = {
+    identity: string;
+    apiUrl?: string;
+    defaultOpen?: boolean;
+    fontSize?: string;
+    appearance?: WidgetAppearance;
+};
+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 { WidgetSettings } from "./api";
+export declare const coristenWidget: {
+    reset(): void;
+};