inline-chat-kit 0.54.3 → 0.55.0

package/dist/demo/ChatExperienceDemo.d.ts

@@ -0,0 +1,27 @@
+import { ReactNode } from 'react';
+import { InlineAnimConfig } from '../ChatInput/ChatInput';
+import { FoldMotion } from '../QuestionGroup/QuestionGroup';
+import { IntroMotion } from './IntroLanding';
+export interface ChatExperienceDemoProps {
+    /** The host's mark, on the landing page. */
+    logo?: ReactNode;
+    /** The way back out of the landing page — an `<a>`, or a framework `<Link>`,
+        which renders one. Styled by the kit; the destination is the host's. */
+    back?: ReactNode;
+    /** Where the header's back control goes, once you are in the chat. */
+    backHref?: string;
+    backLabel?: string;
+    /** Start in the chat rather than on the landing page. */
+    skipIntro?: boolean;
+    /** The theme, if the host keeps it. Left off, the header's own toggle does. */
+    theme?: "light" | "dark" | null;
+    onThemeChange?: (theme: "light" | "dark") => void;
+    /** Development chrome the playground turns on and nobody else does. */
+    cursor?: boolean;
+    /** Motion, opened up so a tuning panel can reach it. */
+    animationConfig?: InlineAnimConfig;
+    foldMotion?: FoldMotion;
+    feedDelay?: number;
+    introMotion?: IntroMotion;
+}
+export declare function ChatExperienceDemo({ logo, back, backHref, backLabel, skipIntro, theme, onThemeChange, cursor, animationConfig, foldMotion, feedDelay, introMotion, }: ChatExperienceDemoProps): import("react").JSX.Element;

package/dist/demo/InlineChatBanner.d.ts

@@ -0,0 +1,6 @@
+import { InlineChatFeatureStatus } from './featureStatus';
+interface InlineChatBannerProps {
+    status: InlineChatFeatureStatus;
+}
+export declare function InlineChatBanner({ status }: InlineChatBannerProps): import("react").JSX.Element;
+export {};

package/dist/demo/IntroLanding.d.ts

@@ -0,0 +1,43 @@
+import { ReactNode } from 'react';
+import { INLINE_CHAT_FEATURE_STATUS } from './featureStatus';
+/**
+ * The page in front of the demo: what this is, what works, and a way in.
+ *
+ * Two copies of it before this, in the playground and on the website, along
+ * with two copies of its stylesheet. The stylesheet is the reason it is worth
+ * moving rather than leaving: it reached for `--color-bg-page`,
+ * `--font-geist-sans` and `--font-jetbrains-mono`, none of which the kit
+ * defines — so it rendered correctly only in a host that happened to have
+ * them, and silently fell back to a serif on a white page in one that did
+ * not. It is on `--ick-` tokens now, which the kit ships.
+ *
+ * What a host still gives it: the logo, and where "back" goes. Its identity.
+ */
+/** How the intro arrives, and how it leaves for the chat. Exposed so a tuning
+    panel can reach it; every number has a default that works. */
+export interface IntroMotion {
+    staggerIn?: number;
+    stiffness?: number;
+    damping?: number;
+    offsetIn?: number;
+    blurIn?: number;
+    staggerOut?: number;
+    durationOut?: number;
+    offsetOut?: number;
+    blurOut?: number;
+}
+export interface IntroLandingProps {
+    /** The host's mark. Nothing is drawn in its place if it is left off. */
+    logo?: ReactNode;
+    /** The way back out, rendered as given — an `<a>`, a framework `<Link>`. */
+    back?: ReactNode;
+    onStart: () => void;
+    welcome?: string;
+    title?: string;
+    version?: string;
+    description?: string;
+    /** What the demo can actually do. Defaults to the kit's own list. */
+    status?: typeof INLINE_CHAT_FEATURE_STATUS;
+    motionConfig?: IntroMotion;
+}
+export declare function IntroLanding({ logo, back, onStart, welcome, title, version, description, status, motionConfig, }: IntroLandingProps): import("react").JSX.Element;

package/dist/demo/featureStatus.d.ts

@@ -0,0 +1,18 @@
+export interface InlineChatFeatureStatus {
+    works: string[];
+    notWorking: string[];
+    soon: string[];
+}
+/**
+ * What this demo can actually do, checked rather than remembered.
+ *
+ * It had drifted in both directions at once: threads sat under "Soon" while
+ * working, and copy sat under "Not working" while putting 434 characters on
+ * the clipboard. A list nobody trusts is worse than no list, because the one
+ * thing it is for is telling a visitor what to try.
+ *
+ * Everything under `works` was driven in a browser before it was written here.
+ * Everything under `notWorking` is simulated on purpose — this page has no
+ * model behind it and says so above. `soon` is tier I of the roadmap.
+ */
+export declare const INLINE_CHAT_FEATURE_STATUS: InlineChatFeatureStatus;

package/dist/demo/index.d.ts

@@ -0,0 +1,8 @@
+export { ChatExperienceDemo } from './ChatExperienceDemo';
+export type { ChatExperienceDemoProps } from './ChatExperienceDemo';
+export { IntroLanding } from './IntroLanding';
+export type { IntroLandingProps, IntroMotion } from './IntroLanding';
+export { InlineChatBanner } from './InlineChatBanner';
+export { INLINE_CHAT_FEATURE_STATUS } from './featureStatus';
+export type { InlineChatFeatureStatus } from './featureStatus';
+export { QUESTIONS, RUNNING_PLAN, scriptedApi, threadReply, scriptedTranscript, } from './scriptedApi';

package/dist/demo/scriptedApi.d.ts

@@ -0,0 +1,49 @@
+import { Attachment, Question, TurnPartUpdate } from '../index';
+/**
+ * Three questions, one of each type, about the experiment the rest of this
+ * demo is about.
+ *
+ * They used to be about arranging care for somebody — carried over from
+ * another product, and the one thing in a chat headed "ask me about particle
+ * physics" that had nothing to do with it. A demo that changes subject
+ * halfway is a demo somebody has to explain.
+ */
+export declare const QUESTIONS: Question[];
+/**
+ * A plan, written out. The demo's artifact.
+ *
+ * Long enough that pouring it into the answer would bury the answer, which is
+ * the whole argument for a pane: the card in the transcript is a window and
+ * this is what is behind it.
+ */
+export declare const RUNNING_PLAN = "Week 1 \u2014 base\nMon   rest\nTue   4 km easy, conversational pace\nWed   cross-train, 30 min\nThu   5 \u00D7 400 m at 5k effort, 90 s jog between\nFri   rest\nSat   6 km easy\nSun   20 min walk\n\nWeek 2 \u2014 base\nMon   rest\nTue   5 km easy\nWed   cross-train, 35 min\nThu   6 \u00D7 400 m, 90 s jog between\nFri   rest\nSat   7 km easy, last kilometre at pace\nSun   20 min walk\n\nWeek 3 \u2014 build\nMon   rest\nTue   5 km easy\nWed   cross-train, 35 min\nThu   4 \u00D7 800 m at 5k effort, 2 min jog between\nFri   rest\nSat   8 km easy\nSun   20 min walk\n\nWeek 4 \u2014 cut back\nMon   rest\nTue   4 km easy\nWed   cross-train, 30 min\nThu   5 \u00D7 400 m, 90 s jog between\nFri   rest\nSat   5 km easy\nSun   rest\n\nWeek 5 \u2014 build\nMon   rest\nTue   6 km easy\nWed   cross-train, 40 min\nThu   5 \u00D7 800 m, 2 min jog between\nFri   rest\nSat   9 km easy\nSun   20 min walk\n\nWeek 6 \u2014 sharpen\nMon   rest\nTue   6 km with 3 km at target pace\nWed   cross-train, 30 min\nThu   8 \u00D7 400 m, 60 s jog between\nFri   rest\nSat   8 km easy\nSun   20 min walk\n\nWeek 7 \u2014 sharpen\nMon   rest\nTue   5 km with 4 km at target pace\nWed   cross-train, 30 min\nThu   6 \u00D7 400 m, 60 s jog between\nFri   rest\nSat   6 km easy\nSun   rest\n\nWeek 8 \u2014 taper and race\nMon   rest\nTue   4 km easy with 4 \u00D7 100 m strides\nWed   rest\nThu   3 km easy\nFri   rest\nSat   race, 5 km\nSun   20 min walk\n\nNotes\nEasy means you can hold a conversation. If you cannot, it is not easy.\nEvery hard day is followed by a rest day; that is where the fitness is made.\nMiss a week and repeat it rather than skipping ahead to catch up.";
+export declare function scriptedApi(message: string, { attachments, turnId }: {
+    attachments: Attachment[];
+    turnId: string;
+}): AsyncGenerator<string | TurnPartUpdate>;
+/**
+ * A reply inside a thread on a passage.
+ *
+ * Prose only. A thread is a follow-up on something already said, and a tool
+ * call inside a popover over the answer would be absurd.
+ */
+export declare function threadReply(): AsyncGenerator<string>;
+/**
+ * A transcript, without a transcriber.
+ *
+ * The kit records for real — permission, `MediaRecorder`, the level ring all
+ * come from the microphone — and then hands the audio here, where there is
+ * nowhere to send it. This demo has no backend and the browser's own
+ * `SpeechRecognition` cannot be reached through `onTranscribe`, because it
+ * insists on holding the microphone itself rather than taking a recording.
+ *
+ * So the words are scripted, like every other answer in this demo, and the
+ * feature list says so. Everything around them is not: refuse the permission
+ * prompt and the refusal is real, talk louder and the ring is reading your
+ * room, press stop halfway and the abort signal fires.
+ *
+ * A real handler is this shape with a `fetch` in it.
+ */
+export declare function scriptedTranscript(audio: Blob, { signal }: {
+    signal: AbortSignal;
+}): AsyncGenerator<string>;