fdbck-react 0.2.0

package/dist/index.d.ts

@@ -0,0 +1,115 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/** Error codes produced by the React SDK */
+type FdbckErrorCode = 'invalid_token' | 'already_responded' | 'question_expired' | 'network_error' | 'dismissed' | 'unknown';
+/** Typed error for fdbck React SDK */
+declare class FdbckError extends Error {
+    readonly code: FdbckErrorCode;
+    constructor(code: FdbckErrorCode, message: string);
+}
+
+/** Question type */
+type QuestionType = 'yes_no' | 'single_choice' | 'multiple_choice' | 'rating';
+/** Rating scale options as returned by the API */
+interface RatingOptions {
+    min: number;
+    max: number;
+    min_label?: string;
+    max_label?: string;
+}
+/** Question data from GET /v1/f/:token */
+interface QuestionData {
+    id: string;
+    question: string;
+    type: QuestionType;
+    options: string[] | RatingOptions;
+    theme_color: string | null;
+    theme_mode: 'light' | 'dark';
+    hide_branding: boolean;
+    welcome_message: string | null;
+    thank_you_message: string | null;
+}
+/** Response value submitted by the respondent */
+type ResponseValue = string | string[] | number;
+/** Display mode for the widget */
+type FdbckMode = 'inline' | 'modal' | 'popover';
+/** Result returned when a response is submitted or dismissed */
+interface FdbckResult {
+    status: 'submitted' | 'dismissed';
+    value?: ResponseValue;
+}
+/** Custom locale strings */
+interface FdbckLocale {
+    submit?: string;
+    poweredBy?: string;
+    loading?: string;
+    errorTitle?: string;
+    errorMessage?: string;
+    retry?: string;
+    close?: string;
+}
+/** Style overrides for the widget */
+interface FdbckStyle {
+    width?: string;
+    maxWidth?: string;
+    borderRadius?: string;
+    fontFamily?: string;
+    fontSize?: string;
+}
+/** Props for the low-level FdbckWidget component (takes a pre-resolved token) */
+interface FdbckWidgetProps {
+    token: string;
+    mode?: FdbckMode;
+    open?: boolean;
+    baseUrl?: string;
+    delay?: number;
+    autoCloseAfter?: number;
+    closeOnOverlayClick?: boolean;
+    closeOnEscape?: boolean;
+    locale?: FdbckLocale;
+    style?: FdbckStyle;
+    onSubmit?: (value: ResponseValue) => void;
+    onDismiss?: () => void;
+    onError?: (error: FdbckError) => void;
+    onLoad?: (question: QuestionData) => void;
+    children?: ReactNode;
+}
+/** Props for the FdbckProvider context */
+interface FdbckProviderProps {
+    baseUrl?: string;
+    locale?: FdbckLocale;
+    style?: FdbckStyle;
+    children: ReactNode;
+}
+/** Return type from useFdbck hook */
+interface UseFdbckReturn {
+    show: (options: UseFdbckOptions) => Promise<FdbckResult>;
+    dismiss: () => void;
+    isActive: boolean;
+}
+/** Options passed to useFdbck().show() */
+type UseFdbckOptions = {
+    token: string;
+} & Omit<FdbckWidgetProps, 'token' | 'onSubmit' | 'onDismiss'>;
+/** Token page response from GET /v1/f/:token */
+interface TokenPageResponse {
+    status: 'valid' | 'invalid' | 'already_responded' | 'token_expired' | 'question_ended';
+    question?: QuestionData;
+    token?: string;
+    expires_at?: string;
+}
+
+/**
+ * Low-level public component. Takes a pre-resolved token and renders the
+ * feedback widget in inline, modal, or popover mode.
+ */
+declare function FdbckWidget({ token, mode, open, baseUrl, delay, autoCloseAfter, closeOnOverlayClick, closeOnEscape, locale: localeProp, style: styleProp, onSubmit, onDismiss, onError, onLoad, }: FdbckWidgetProps): react_jsx_runtime.JSX.Element | null;
+
+/** Context provider for the imperative useFdbck() hook */
+declare function FdbckProvider({ baseUrl, locale, style, children }: FdbckProviderProps): react_jsx_runtime.JSX.Element;
+
+/** Imperative API for showing/dismissing feedback widgets. Must be used within FdbckProvider. */
+declare function useFdbck(): UseFdbckReturn;
+
+export { FdbckError, type FdbckErrorCode, type FdbckLocale, type FdbckMode, FdbckProvider, type FdbckProviderProps, type FdbckResult, type FdbckStyle, FdbckWidget, type FdbckWidgetProps, type QuestionData, type QuestionType, type RatingOptions, type ResponseValue, type TokenPageResponse, type UseFdbckOptions, type UseFdbckReturn, useFdbck };