@thewhatmatters/wmds 0.3.0 → 0.4.1

package/dist/components/organisms/ChatDock/ChatDock.d.ts

@@ -0,0 +1,203 @@
+import { type ReactElement, type ReactNode } from "react";
+import { type ChatDockPlacement } from "./chatDockStyles";
+export { chatDockPlacements, type ChatDockPlacement } from "./chatDockStyles";
+export { ChatDockGate, chatDockGateDefaultLabels, type ChatDockGateLabels, type ChatDockGateProps, } from "./ChatDockGate";
+/** Layout-only — margin and placement. Not for colors or type. */
+export type ChatDockLayoutClassName = string;
+export interface ChatDockSuggestion {
+    id: string;
+    label: string;
+    /** Leading Lucide icon element, for example `<DollarSign />`. */
+    icon?: ReactElement;
+    /**
+     * Sent as the visitor's message when chosen. Suggestions with a prompt also show as pills
+     * above the resting composer. Omit it for an action such as **Get started** — then only
+     * `onSuggestionSelect` runs.
+     */
+    prompt?: string;
+}
+/** The visitor's vote on a reply. `null` is no vote. */
+export type ChatDockFeedback = "up" | "down" | null;
+/** A short note under a reply — for example how sure the assistant was of its match. */
+export interface ChatDockMessageMeta {
+    /** The note itself, short — for example "Match 99%". */
+    label: string;
+    /** What the note means, for screen readers — for example "How sure the assistant is that it matched your question." */
+    description?: string;
+}
+export interface ChatDockMessage {
+    id: string;
+    role: "user" | "assistant";
+    /** Text, or Markdown the app has already rendered. ChatDock does not parse Markdown. */
+    content: ReactNode;
+    /** Replies only: the text **Copy** writes to the clipboard. Shows Copy under the reply. */
+    copyText?: string;
+    /** Replies only: a short muted note under the reply, such as the match score. */
+    meta?: ChatDockMessageMeta;
+    /**
+     * Replies only: the visitor's vote — `null` until they vote. The thumbs show on replies that carry
+     * it, when `onMessageFeedback` is passed. Leave it out on replies that take no vote, such as a
+     * summary of a form.
+     */
+    feedback?: ChatDockFeedback;
+}
+export interface ChatDockLabels {
+    /** Close control. Default: "Close chat". */
+    close: string;
+    /** Shown while `thinking`. Default: "Thinking…". */
+    thinking: string;
+    /** Accessible name for the message list. Default: "Conversation". */
+    conversation: string;
+    /** Accessible name for the suggestion groups. Default: "Suggested questions". */
+    suggestions: string;
+    /** Accessible name for the follow-ups under the latest reply. Default: "Suggested follow-ups". */
+    followUps: string;
+    /** Accessible name for the field. Default: "Ask anything". */
+    field: string;
+    /** Send control. Default: "Send". */
+    send: string;
+    /** Copy under a reply. Default: "Copy reply". */
+    copy: string;
+    /** Copy, once the reply is on the clipboard; also announced. Default: "Copied". */
+    copied: string;
+    /** Thumbs up under a reply. Default: "Mark this reply helpful". */
+    helpful: string;
+    /** Thumbs down under a reply. Default: "Mark this reply not helpful". */
+    notHelpful: string;
+}
+export declare const chatDockDefaultLabels: ChatDockLabels;
+export declare const chatDockFollowUpsPlacements: readonly ["inline", "composer"];
+/**
+ * `inline` — rows in the conversation, directly under the reply they belong to.
+ * `composer` — pills pinned between the conversation and the composer.
+ */
+export type ChatDockFollowUpsPlacement = (typeof chatDockFollowUpsPlacements)[number];
+export interface ChatDockProps {
+    /** Window title — usually the product or brand name. */
+    title: string;
+    /** Line under the title. */
+    subtitle?: string;
+    /**
+     * Brand mark — **Avatar** `size="md"` (2.25rem). Shown at the start of the composer and in
+     * the window header.
+     */
+    mark?: ReactNode;
+    /** First assistant message, always at the top of the window. */
+    greeting?: ReactNode;
+    /** The conversation, oldest first. The app owns it and appends replies as they stream. */
+    messages?: ChatDockMessage[];
+    /** Shows the thinking row after the last message while a reply is on its way. */
+    thinking?: boolean;
+    /** Pills above the resting composer (those with a `prompt`) and rows in the window. */
+    suggestions?: ChatDockSuggestion[];
+    /** Receives the visitor's message — typed, or a suggestion's `prompt`. */
+    onSend: (prompt: string) => void;
+    /** Every suggestion and follow-up choice, including actions without a `prompt`. */
+    onSuggestionSelect?: (suggestion: ChatDockSuggestion) => void;
+    /**
+     * Follow-ups for the latest reply — one to three short items, the same shape and handlers as
+     * `suggestions`. Their `icon` is not shown: inline rows all lead with a corner-down-right arrow,
+     * and pills above the composer are text only. They show while the last message is an assistant
+     * reply and `thinking` is off, and disappear the moment the visitor sends. The app decides which
+     * replies get follow-ups and replaces or clears them with each reply.
+     */
+    followUps?: ChatDockSuggestion[];
+    /** Where follow-ups sit. Default: `inline`. */
+    followUpsPlacement?: ChatDockFollowUpsPlacement;
+    /**
+     * The visitor voted on a reply, or cleared their vote (`null`). Pass it to show thumbs up and down
+     * under finished replies that carry `feedback`; the app stores the vote and passes it back there.
+     */
+    onMessageFeedback?: (message: ChatDockMessage, value: ChatDockFeedback) => void;
+    /**
+     * A form in the composer's place — usually **ChatDock.Gate** with the steps of Start a project.
+     * While it is set and the window is open, it replaces the composer, and the suggestion rows,
+     * follow-ups, and disclaimer step aside; the conversation stays above it. Setting it opens the
+     * window and moves focus into it; clearing it brings the composer back with focus. Escape belongs
+     * to the gate (**ChatDock.Gate** closes on Escape); the window's close still folds the window, and
+     * the gate is there again when it reopens.
+     */
+    gate?: ReactNode;
+    /** Controlled open state. */
+    open?: boolean;
+    defaultOpen?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    /** Field placeholder. Default: "Ask anything…". */
+    placeholder?: string;
+    /** One line under the window's composer — for example what the assistant can't do. */
+    disclaimer?: ReactNode;
+    labels?: Partial<ChatDockLabels>;
+    /** `fixed` (default) pins the dock to the viewport; `inline` keeps it in flow for specimens. */
+    placement?: ChatDockPlacement;
+    className?: ChatDockLayoutClassName;
+}
+/** Pills above the resting composer: suggestions that send a prompt. */
+export declare function chatDockPillSuggestions(suggestions: readonly ChatDockSuggestion[]): ChatDockSuggestion[];
+/** Suggestion rows show until the conversation starts. */
+export declare function chatDockShowsSuggestionRows(suggestions: readonly ChatDockSuggestion[], messages: readonly ChatDockMessage[]): boolean;
+/**
+ * Follow-ups belong to the latest reply: it is the last message, no reply is pending, and the
+ * visitor has not sent anything since it arrived (`sentAfterId` is the last message id at send).
+ */
+export declare function chatDockShowsFollowUps({ followUps, messages, thinking, sentAfterId, }: {
+    followUps: readonly ChatDockSuggestion[];
+    messages: readonly ChatDockMessage[];
+    thinking: boolean;
+    sentAfterId: string | null;
+}): boolean;
+/** What shows under a reply. `ready` is false while the reply is still arriving. */
+export interface ChatDockReplyRow {
+    copy: boolean;
+    vote: boolean;
+    meta: boolean;
+    ready: boolean;
+}
+/**
+ * The row under a reply: Copy with `copyText`, the score with `meta`, and the thumbs when the app
+ * takes votes and the reply carries `feedback`. `null` for the visitor's turns and for replies with none of these. The latest reply
+ * is still arriving while `thinking` is on, so its row keeps its place but shows nothing yet.
+ */
+export declare function chatDockReplyRow({ message, isLatest, thinking, takesVotes, }: {
+    message: ChatDockMessage;
+    isLatest: boolean;
+    thinking: boolean;
+    takesVotes: boolean;
+}): ChatDockReplyRow | null;
+/**
+ * Height of the open window where it grows out of the composer, in px: 40rem, or the viewport less
+ * 7rem when that is shorter. Inline specimens are 32rem.
+ */
+export declare function chatDockOpenHeight(placement: ChatDockPlacement, viewportHeight: number, remPx: number): number;
+/**
+ * The tallest a gate may be, in px: the window less its top padding, the header, the conversation
+ * kept in view above the gate (7rem), the gaps between them, and the space under the gate. Never
+ * below 12rem, so a gate stays usable when a phone keyboard leaves little room.
+ */
+export declare function chatDockGateMaxHeight({ windowHeight, headerHeight, bottomInset, remPx, }: {
+    windowHeight: number;
+    headerHeight: number;
+    bottomInset: number;
+    remPx: number;
+}): number;
+/**
+ * How the window moves. `grow` (from `md`, and inline): it sits on the composer's bottom edge and
+ * grows up and out of it. `rise`: on phones it fills the screen and rises from the bottom edge.
+ */
+export type ChatDockWindowMotion = "grow" | "rise";
+/**
+ * Pinned prompt that opens into a chat window. At rest it is a **PromptBar** with the brand
+ * mark; hovering shows suggestion pills above it. Focusing or typing opens a non-modal window
+ * around the same composer — header, conversation, suggestion rows, and an optional disclaimer.
+ * Escape or Close folds it back into the bar. The page behind stays usable.
+ */
+declare function ChatDockRoot({ title, subtitle, mark, greeting, messages, thinking, suggestions, onSend, onSuggestionSelect, followUps, followUpsPlacement, onMessageFeedback, gate, open: openProp, defaultOpen, onOpenChange, placeholder, disclaimer, labels: labelsProp, placement, className, }: ChatDockProps): import("react").JSX.Element;
+/**
+ * Pinned prompt that opens into a chat window. At rest it is a **PromptBar** with the brand
+ * mark; hovering shows suggestion pills above it. Focusing or typing opens a non-modal window
+ * around the same composer. **ChatDock.Gate** is the multi-step form a `gate` puts in the
+ * composer's place.
+ */
+export declare const ChatDock: typeof ChatDockRoot & {
+    Gate: import("react").ForwardRefExoticComponent<import("./ChatDockGate").ChatDockGateProps & import("react").RefAttributes<HTMLDivElement>>;
+};
+//# sourceMappingURL=ChatDock.d.ts.map

package/dist/components/organisms/ChatDock/ChatDock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatDock.d.ts","sourceRoot":"","sources":["../../../../src/components/organisms/ChatDock/ChatDock.tsx"],"names":[],"mappings":"AAAA,OAAO,EAUL,KAAK,YAAY,EACjB,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAyBf,OAAO,EA+BL,KAAK,iBAAiB,EACvB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,kBAAkB,EAAE,KAAK,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC9E,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,GACvB,MAAM,gBAAgB,CAAC;AAExB,kEAAkE;AAClE,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAE7C,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wDAAwD;AACxD,MAAM,MAAM,gBAAgB,GAAG,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;AAEpD,wFAAwF;AACxF,MAAM,WAAW,mBAAmB;IAClC,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,uHAAuH;IACvH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,wFAAwF;IACxF,OAAO,EAAE,SAAS,CAAC;IACnB,2FAA2F;IAC3F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iFAAiF;IACjF,IAAI,CAAC,EAAE,mBAAmB,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,YAAY,EAAE,MAAM,CAAC;IACrB,iFAAiF;IACjF,WAAW,EAAE,MAAM,CAAC;IACpB,kGAAkG;IAClG,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,KAAK,EAAE,MAAM,CAAC;IACd,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,EAAE,MAAM,CAAC;IACb,mFAAmF;IACnF,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,qBAAqB,EAAE,cAYnC,CAAC;AAEF,eAAO,MAAM,2BAA2B,iCAAkC,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,2BAA2B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtF,MAAM,WAAW,aAAa;IAC5B,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,eAAe,EAAE,CAAC;IAC7B,iFAAiF;IACjF,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uFAAuF;IACvF,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACnC,0EAA0E;IAC1E,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,mFAAmF;IACnF,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC9D;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACjC,+CAA+C;IAC/C,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAChD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAChF;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,6BAA6B;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,CAAC;IACvC,mDAAmD;IACnD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sFAAsF;IACtF,UAAU,CAAC,EAAE,SAAS,CAAC;IACvB,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IACjC,gGAAgG;IAChG,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED,wEAAwE;AACxE,wBAAgB,uBAAuB,CAAC,WAAW,EAAE,SAAS,kBAAkB,EAAE,GAAG,kBAAkB,EAAE,CAExG;AAED,0DAA0D;AAC1D,wBAAgB,2BAA2B,CACzC,WAAW,EAAE,SAAS,kBAAkB,EAAE,EAC1C,QAAQ,EAAE,SAAS,eAAe,EAAE,GACnC,OAAO,CAET;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,EACrC,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,WAAW,GACZ,EAAE;IACD,SAAS,EAAE,SAAS,kBAAkB,EAAE,CAAC;IACzC,QAAQ,EAAE,SAAS,eAAe,EAAE,CAAC;IACrC,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,GAAG,OAAO,CAGV;AAED,oFAAoF;AACpF,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,UAAU,GACX,EAAE;IACD,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;CACrB,GAAG,gBAAgB,GAAG,IAAI,CAS1B;AAgBD;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAG9G;AAOD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,EACpC,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,KAAK,GACN,EAAE;IACD,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;CACf,GAAG,MAAM,CAGT;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,CAAC;AAEnD;;;;;GAKG;AACH,iBAAS,YAAY,CAAC,EACpB,KAAK,EACL,QAAQ,EACR,IAAI,EACJ,QAAQ,EACR,QAAa,EACb,QAAgB,EAChB,WAAgB,EAChB,MAAM,EACN,kBAAkB,EAClB,SAAc,EACd,kBAA6B,EAC7B,iBAAiB,EACjB,IAAI,EACJ,IAAI,EAAE,QAAQ,EACd,WAAmB,EACnB,YAAY,EACZ,WAAW,EACX,UAAU,EACV,MAAM,EAAE,UAAU,EAClB,SAAmB,EACnB,SAAS,GACV,EAAE,aAAa,+BAmsBf;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;;CAEnB,CAAC"}