@bootstrapware/answers 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,78 @@
+import * as react from 'react';
+
+declare const QUESTION_MAX = 1000;
+declare const WIDGET_ROOT_CLASS = "bsw-an";
+type AnswersPageContext = {
+    url?: string;
+    title?: string;
+};
+type AnswersCitation = {
+    id: string;
+    title: string;
+    url?: string;
+    excerpt?: string;
+};
+type AnswersOutcome = "answered" | "unanswered";
+type AnswersAskInput = {
+    sessionId: string;
+    question: string;
+    pageContext?: AnswersPageContext;
+};
+type AnswersResult = {
+    sessionId: string;
+    answerId: string;
+    outcome: AnswersOutcome;
+    answer?: string;
+    citations?: AnswersCitation[];
+    fallback?: string;
+};
+type AnswersFeedbackInput = {
+    sessionId: string;
+    answerId: string;
+    helpful: boolean;
+    /** Optional note. Webhook payloads omit this text. */
+    reason?: string;
+};
+type AnswersAdapter = {
+    ask: (input: AnswersAskInput) => Promise<AnswersResult>;
+    feedback?: (input: AnswersFeedbackInput) => Promise<void> | void;
+};
+type AnswersPresentation = "launcher" | "section" | "modal" | "window";
+type AnswersTheme = "light" | "dark";
+type AnswersProps = {
+    appId?: string;
+    publishableKey?: string;
+    adapter?: AnswersAdapter;
+    presentation?: AnswersPresentation;
+    defaultOpen?: boolean;
+    theme?: AnswersTheme;
+    pageContext?: AnswersPageContext;
+    onFallback?: (result: AnswersResult) => void;
+    /** Layout hook only. Skin the widget with the `--bsw-an-*` tokens. */
+    className?: string;
+};
+
+declare function Answers(props: AnswersProps): react.JSX.Element;
+
+declare const LOCAL_FALLBACK = "We could not find that in the Northwind Outfitters sample. Ask about hours, returns, or shipping.";
+declare const LOCAL_PROMPTS: {
+    readonly returns: "What is your return window?";
+    readonly returnsFollowUp: "How long do I have?";
+    readonly hours: "What are your hours?";
+    readonly shipping: "Is shipping free?";
+    readonly unsupported: "Do you price match?";
+};
+type Topic = "hours" | "returns" | "shipping";
+declare const LOCAL_CITATIONS: Record<Topic, AnswersCitation>;
+/**
+ * Deterministic sample company. Supported facts, a follow-up that needs the
+ * previous topic, and an explicit unanswered fallback. No network.
+ */
+declare function createLocalAdapter(): AnswersAdapter;
+/** Returns the caller adapter. Question text stays on the customer backend. */
+declare function createByoAdapter(impl: AnswersAdapter): AnswersAdapter;
+
+declare function mount(el: Element, props?: AnswersProps): () => void;
+declare function unmount(el: Element): void;
+
+export { Answers, type AnswersAdapter, type AnswersAskInput, type AnswersCitation, type AnswersFeedbackInput, type AnswersOutcome, type AnswersPageContext, type AnswersPresentation, type AnswersProps, type AnswersResult, type AnswersTheme, LOCAL_CITATIONS, LOCAL_FALLBACK, LOCAL_PROMPTS, QUESTION_MAX, WIDGET_ROOT_CLASS, createByoAdapter, createLocalAdapter, mount, unmount };