@feedvalue/core 0.1.8 → 0.1.10

package/dist/index.d.cts

@@ -66,7 +66,8 @@ interface WidgetConfig {
     widgetId: string;
     widgetKey: string;
     appId: string;
-    config: WidgetUIConfig;
+    type: WidgetType;
+    config: WidgetUIConfig & Partial<ReactionConfig>;
     styling: WidgetStyling;
 }
 /**
@@ -146,6 +147,108 @@ interface FeedbackMetadata {
     /** User agent string */
     user_agent?: string | undefined;
 }
+/**
+ * Widget type - feedback (modal form) or reaction (inline buttons)
+ */
+type WidgetType = 'feedback' | 'reaction';
+/**
+ * Reaction template presets
+ */
+type ReactionTemplate = 'thumbs' | 'helpful' | 'emoji' | 'rating';
+/**
+ * Button size options
+ */
+type ButtonSize = 'sm' | 'md' | 'lg';
+/**
+ * Follow-up trigger options
+ */
+type FollowUpTrigger = 'negative' | 'all' | 'none';
+/**
+ * Map of negative reaction options for each template.
+ * Used to determine when to show follow-up input when followUpTrigger is 'negative'.
+ *
+ * @example
+ * ```ts
+ * import { NEGATIVE_OPTIONS_MAP, ReactionTemplate } from '@feedvalue/core';
+ *
+ * const template: ReactionTemplate = 'thumbs';
+ * const isNegative = NEGATIVE_OPTIONS_MAP[template].includes('not_helpful'); // true
+ * ```
+ */
+declare const NEGATIVE_OPTIONS_MAP: Record<ReactionTemplate, string[]>;
+/**
+ * Single reaction option
+ */
+interface ReactionOption {
+    /** Display label for the option */
+    label: string;
+    /** Value submitted when selected (lowercase alphanumeric with underscores/hyphens) */
+    value: string;
+    /** Icon name (Lucide icon) or emoji character */
+    icon: string;
+    /** Whether to show follow-up text input after selection */
+    showFollowUp: boolean;
+    /** Placeholder text for follow-up input (if showFollowUp is true) */
+    followUpPlaceholder?: string;
+}
+/**
+ * Reaction widget configuration
+ */
+interface ReactionConfig {
+    /** Prebuilt template (if set, options are ignored) */
+    template?: ReactionTemplate;
+    /** Custom reaction options (required if template is null) */
+    options?: ReactionOption[];
+    /** Label for follow-up text input */
+    followUpLabel: string;
+    /** Submit button text for follow-up */
+    submitText: string;
+    /** Message shown after submission */
+    thankYouMessage: string;
+    /** Whether to show text labels next to icons */
+    showLabels?: boolean;
+    /** Button size: 'sm', 'md', or 'lg' */
+    buttonSize?: ButtonSize;
+    /** When to show follow-up input: 'negative' (default), 'all', or 'none' */
+    followUpTrigger?: FollowUpTrigger;
+}
+/**
+ * Reaction submission data
+ */
+interface ReactionData {
+    /** Selected reaction option value */
+    value: string;
+    /** Optional follow-up text */
+    followUp?: string;
+    /** Page metadata */
+    metadata?: ReactionMetadata;
+}
+/**
+ * Reaction metadata (auto-collected)
+ */
+interface ReactionMetadata {
+    /** Current page URL */
+    page_url: string;
+    /** Session ID for tracking */
+    session_id?: string;
+    /** User agent string */
+    user_agent?: string;
+}
+/**
+ * Reaction submission state (for hooks/components)
+ */
+interface ReactionState {
+    /** Available reaction options */
+    options: ReactionOption[] | null;
+    /** Currently submitting */
+    isSubmitting: boolean;
+    /** Successfully submitted value (null if not yet submitted) */
+    submitted: string | null;
+    /** Error if submission failed */
+    error: Error | null;
+    /** Option value requiring follow-up input (null if none) */
+    showFollowUp: string | null;
+}
 /**
  * Event types emitted by FeedValue
  */
@@ -162,6 +265,18 @@ interface FeedValueEvents {
     error: (error: Error) => void;
     /** State changed (for generic listeners) */
     stateChange: (state: FeedValueState) => void;
+    /** Reaction clicked (before submission) */
+    react: (data: {
+        value: string;
+        hasFollowUp: boolean;
+    }) => void;
+    /** Reaction submitted successfully */
+    reactSubmit: (data: {
+        value: string;
+        followUp?: string;
+    }) => void;
+    /** Reaction submission error */
+    reactError: (error: Error) => void;
 }
 /**
  * Event handler type
@@ -215,7 +330,8 @@ interface SubmissionUserData {
 interface ConfigResponse {
     widget_id: string;
     widget_key: string;
-    config: Partial<WidgetUIConfig>;
+    type: WidgetType;
+    config: Partial<WidgetUIConfig & ReactionConfig>;
     styling: Partial<WidgetStyling>;
     submission_token?: string;
     token_expires_at?: number;
@@ -229,6 +345,16 @@ interface FeedbackResponse {
     message?: string;
     blocked?: boolean;
 }
+/**
+ * API response for reaction submission
+ */
+interface ReactionResponse {
+    success: boolean;
+    submission_id: string | null;
+    message: string;
+    blocked: boolean;
+    block_reason?: string;
+}
 /**
  * FeedValue instance interface
  * This is the public API for the widget
@@ -264,6 +390,27 @@ interface FeedValueInstance {
     reset(): void;
     /** Programmatically submit feedback */
     submit(feedback: Partial<FeedbackData>): Promise<void>;
+    /**
+     * Get reaction options from widget config.
+     * Returns null if widget is not a reaction type.
+     */
+    getReactionOptions(): ReactionOption[] | null;
+    /**
+     * Submit a reaction.
+     * @param value - Selected reaction option value
+     * @param options - Optional follow-up text
+     */
+    react(value: string, options?: {
+        followUp?: string;
+    }): Promise<void>;
+    /**
+     * Check if widget is a reaction type
+     */
+    isReaction(): boolean;
+    /**
+     * Get widget type ('feedback' or 'reaction')
+     */
+    getWidgetType(): WidgetType;
     /** Subscribe to an event */
     on<K extends keyof FeedValueEvents>(event: K, callback: EventHandler<K>): void;
     /** Subscribe to an event for a single emission */
@@ -381,6 +528,31 @@ declare class FeedValue implements FeedValueInstance {
      * Combines data from identify() and setData() calls
      */
     private buildSubmissionUserData;
+    /**
+     * Get reaction options from widget config.
+     * Returns null if widget is not a reaction type.
+     */
+    getReactionOptions(): ReactionOption[] | null;
+    /**
+     * Get predefined options for a reaction template
+     */
+    private getTemplateOptions;
+    /**
+     * Submit a reaction.
+     * @param value - Selected reaction option value
+     * @param options - Optional follow-up text
+     */
+    react(value: string, options?: {
+        followUp?: string;
+    }): Promise<void>;
+    /**
+     * Check if widget is a reaction type
+     */
+    isReaction(): boolean;
+    /**
+     * Get widget type ('feedback' or 'reaction')
+     */
+    getWidgetType(): WidgetType;
     /**
      * Validate feedback data before submission
      * @throws Error if validation fails
@@ -604,6 +776,10 @@ declare class ApiClient {
      * Submit feedback with optional user data
      */
     submitFeedback(widgetId: string, feedback: FeedbackData, userData?: SubmissionUserData): Promise<FeedbackResponse>;
+    /**
+     * Submit reaction
+     */
+    submitReaction(widgetId: string, reaction: ReactionData): Promise<ReactionResponse>;
     /**
      * Parse error from response
      */
@@ -645,4 +821,4 @@ declare function generateFingerprint(): string;
  */
 declare function clearFingerprint(): void;
 
-export { ApiClient, type ConfigResponse, type CustomField, type CustomFieldType, DEFAULT_API_BASE_URL, type EmojiSentiment, type EventHandler, FeedValue, type FeedValueConfig, type FeedValueEvents, type FeedValueInstance, type FeedValueOptions, type FeedValueState, type FeedbackData, type FeedbackMetadata, type FeedbackResponse, type SubmissionUserData, type TriggerIconType, TypedEventEmitter, type UserData, type UserTraits, type WidgetConfig, type WidgetPosition, type WidgetStyling, type WidgetTheme, type WidgetUIConfig, clearFingerprint, generateFingerprint };
+export { ApiClient, type ButtonSize, type ConfigResponse, type CustomField, type CustomFieldType, DEFAULT_API_BASE_URL, type EmojiSentiment, type EventHandler, FeedValue, type FeedValueConfig, type FeedValueEvents, type FeedValueInstance, type FeedValueOptions, type FeedValueState, type FeedbackData, type FeedbackMetadata, type FeedbackResponse, type FollowUpTrigger, NEGATIVE_OPTIONS_MAP, type ReactionConfig, type ReactionData, type ReactionMetadata, type ReactionOption, type ReactionResponse, type ReactionState, type ReactionTemplate, type SubmissionUserData, type TriggerIconType, TypedEventEmitter, type UserData, type UserTraits, type WidgetConfig, type WidgetPosition, type WidgetStyling, type WidgetTheme, type WidgetType, type WidgetUIConfig, clearFingerprint, generateFingerprint };

package/dist/index.d.ts

@@ -66,7 +66,8 @@ interface WidgetConfig {
     widgetId: string;
     widgetKey: string;
     appId: string;
-    config: WidgetUIConfig;
+    type: WidgetType;
+    config: WidgetUIConfig & Partial<ReactionConfig>;
     styling: WidgetStyling;
 }
 /**
@@ -146,6 +147,108 @@ interface FeedbackMetadata {
     /** User agent string */
     user_agent?: string | undefined;
 }
+/**
+ * Widget type - feedback (modal form) or reaction (inline buttons)
+ */
+type WidgetType = 'feedback' | 'reaction';
+/**
+ * Reaction template presets
+ */
+type ReactionTemplate = 'thumbs' | 'helpful' | 'emoji' | 'rating';
+/**
+ * Button size options
+ */
+type ButtonSize = 'sm' | 'md' | 'lg';
+/**
+ * Follow-up trigger options
+ */
+type FollowUpTrigger = 'negative' | 'all' | 'none';
+/**
+ * Map of negative reaction options for each template.
+ * Used to determine when to show follow-up input when followUpTrigger is 'negative'.
+ *
+ * @example
+ * ```ts
+ * import { NEGATIVE_OPTIONS_MAP, ReactionTemplate } from '@feedvalue/core';
+ *
+ * const template: ReactionTemplate = 'thumbs';
+ * const isNegative = NEGATIVE_OPTIONS_MAP[template].includes('not_helpful'); // true
+ * ```
+ */
+declare const NEGATIVE_OPTIONS_MAP: Record<ReactionTemplate, string[]>;
+/**
+ * Single reaction option
+ */
+interface ReactionOption {
+    /** Display label for the option */
+    label: string;
+    /** Value submitted when selected (lowercase alphanumeric with underscores/hyphens) */
+    value: string;
+    /** Icon name (Lucide icon) or emoji character */
+    icon: string;
+    /** Whether to show follow-up text input after selection */
+    showFollowUp: boolean;
+    /** Placeholder text for follow-up input (if showFollowUp is true) */
+    followUpPlaceholder?: string;
+}
+/**
+ * Reaction widget configuration
+ */
+interface ReactionConfig {
+    /** Prebuilt template (if set, options are ignored) */
+    template?: ReactionTemplate;
+    /** Custom reaction options (required if template is null) */
+    options?: ReactionOption[];
+    /** Label for follow-up text input */
+    followUpLabel: string;
+    /** Submit button text for follow-up */
+    submitText: string;
+    /** Message shown after submission */
+    thankYouMessage: string;
+    /** Whether to show text labels next to icons */
+    showLabels?: boolean;
+    /** Button size: 'sm', 'md', or 'lg' */
+    buttonSize?: ButtonSize;
+    /** When to show follow-up input: 'negative' (default), 'all', or 'none' */
+    followUpTrigger?: FollowUpTrigger;
+}
+/**
+ * Reaction submission data
+ */
+interface ReactionData {
+    /** Selected reaction option value */
+    value: string;
+    /** Optional follow-up text */
+    followUp?: string;
+    /** Page metadata */
+    metadata?: ReactionMetadata;
+}
+/**
+ * Reaction metadata (auto-collected)
+ */
+interface ReactionMetadata {
+    /** Current page URL */
+    page_url: string;
+    /** Session ID for tracking */
+    session_id?: string;
+    /** User agent string */
+    user_agent?: string;
+}
+/**
+ * Reaction submission state (for hooks/components)
+ */
+interface ReactionState {
+    /** Available reaction options */
+    options: ReactionOption[] | null;
+    /** Currently submitting */
+    isSubmitting: boolean;
+    /** Successfully submitted value (null if not yet submitted) */
+    submitted: string | null;
+    /** Error if submission failed */
+    error: Error | null;
+    /** Option value requiring follow-up input (null if none) */
+    showFollowUp: string | null;
+}
 /**
  * Event types emitted by FeedValue
  */
@@ -162,6 +265,18 @@ interface FeedValueEvents {
     error: (error: Error) => void;
     /** State changed (for generic listeners) */
     stateChange: (state: FeedValueState) => void;
+    /** Reaction clicked (before submission) */
+    react: (data: {
+        value: string;
+        hasFollowUp: boolean;
+    }) => void;
+    /** Reaction submitted successfully */
+    reactSubmit: (data: {
+        value: string;
+        followUp?: string;
+    }) => void;
+    /** Reaction submission error */
+    reactError: (error: Error) => void;
 }
 /**
  * Event handler type
@@ -215,7 +330,8 @@ interface SubmissionUserData {
 interface ConfigResponse {
     widget_id: string;
     widget_key: string;
-    config: Partial<WidgetUIConfig>;
+    type: WidgetType;
+    config: Partial<WidgetUIConfig & ReactionConfig>;
     styling: Partial<WidgetStyling>;
     submission_token?: string;
     token_expires_at?: number;
@@ -229,6 +345,16 @@ interface FeedbackResponse {
     message?: string;
     blocked?: boolean;
 }
+/**
+ * API response for reaction submission
+ */
+interface ReactionResponse {
+    success: boolean;
+    submission_id: string | null;
+    message: string;
+    blocked: boolean;
+    block_reason?: string;
+}
 /**
  * FeedValue instance interface
  * This is the public API for the widget
@@ -264,6 +390,27 @@ interface FeedValueInstance {
     reset(): void;
     /** Programmatically submit feedback */
     submit(feedback: Partial<FeedbackData>): Promise<void>;
+    /**
+     * Get reaction options from widget config.
+     * Returns null if widget is not a reaction type.
+     */
+    getReactionOptions(): ReactionOption[] | null;
+    /**
+     * Submit a reaction.
+     * @param value - Selected reaction option value
+     * @param options - Optional follow-up text
+     */
+    react(value: string, options?: {
+        followUp?: string;
+    }): Promise<void>;
+    /**
+     * Check if widget is a reaction type
+     */
+    isReaction(): boolean;
+    /**
+     * Get widget type ('feedback' or 'reaction')
+     */
+    getWidgetType(): WidgetType;
     /** Subscribe to an event */
     on<K extends keyof FeedValueEvents>(event: K, callback: EventHandler<K>): void;
     /** Subscribe to an event for a single emission */
@@ -381,6 +528,31 @@ declare class FeedValue implements FeedValueInstance {
      * Combines data from identify() and setData() calls
      */
     private buildSubmissionUserData;
+    /**
+     * Get reaction options from widget config.
+     * Returns null if widget is not a reaction type.
+     */
+    getReactionOptions(): ReactionOption[] | null;
+    /**
+     * Get predefined options for a reaction template
+     */
+    private getTemplateOptions;
+    /**
+     * Submit a reaction.
+     * @param value - Selected reaction option value
+     * @param options - Optional follow-up text
+     */
+    react(value: string, options?: {
+        followUp?: string;
+    }): Promise<void>;
+    /**
+     * Check if widget is a reaction type
+     */
+    isReaction(): boolean;
+    /**
+     * Get widget type ('feedback' or 'reaction')
+     */
+    getWidgetType(): WidgetType;
     /**
      * Validate feedback data before submission
      * @throws Error if validation fails
@@ -604,6 +776,10 @@ declare class ApiClient {
      * Submit feedback with optional user data
      */
     submitFeedback(widgetId: string, feedback: FeedbackData, userData?: SubmissionUserData): Promise<FeedbackResponse>;
+    /**
+     * Submit reaction
+     */
+    submitReaction(widgetId: string, reaction: ReactionData): Promise<ReactionResponse>;
     /**
      * Parse error from response
      */
@@ -645,4 +821,4 @@ declare function generateFingerprint(): string;
  */
 declare function clearFingerprint(): void;
 
-export { ApiClient, type ConfigResponse, type CustomField, type CustomFieldType, DEFAULT_API_BASE_URL, type EmojiSentiment, type EventHandler, FeedValue, type FeedValueConfig, type FeedValueEvents, type FeedValueInstance, type FeedValueOptions, type FeedValueState, type FeedbackData, type FeedbackMetadata, type FeedbackResponse, type SubmissionUserData, type TriggerIconType, TypedEventEmitter, type UserData, type UserTraits, type WidgetConfig, type WidgetPosition, type WidgetStyling, type WidgetTheme, type WidgetUIConfig, clearFingerprint, generateFingerprint };
+export { ApiClient, type ButtonSize, type ConfigResponse, type CustomField, type CustomFieldType, DEFAULT_API_BASE_URL, type EmojiSentiment, type EventHandler, FeedValue, type FeedValueConfig, type FeedValueEvents, type FeedValueInstance, type FeedValueOptions, type FeedValueState, type FeedbackData, type FeedbackMetadata, type FeedbackResponse, type FollowUpTrigger, NEGATIVE_OPTIONS_MAP, type ReactionConfig, type ReactionData, type ReactionMetadata, type ReactionOption, type ReactionResponse, type ReactionState, type ReactionTemplate, type SubmissionUserData, type TriggerIconType, TypedEventEmitter, type UserData, type UserTraits, type WidgetConfig, type WidgetPosition, type WidgetStyling, type WidgetTheme, type WidgetType, type WidgetUIConfig, clearFingerprint, generateFingerprint };