@cohiva/support-widget 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,199 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type FeedbackType = 'bug' | 'feature' | 'feedback' | 'improvement';
+type FeedbackPriority = 'low' | 'medium' | 'high' | 'critical';
+type FeedbackFrequency = '' | 'once' | 'sometimes' | 'often' | 'every_time';
+type FeedbackImpactLevel = '' | 'minor' | 'moderate' | 'major' | 'critical';
+interface FeedbackFormData {
+    type: FeedbackType | '';
+    title: string;
+    priority: FeedbackPriority;
+    satisfaction_rating: number | null;
+    experience_summary: string;
+    what_were_you_doing: string;
+    what_happened: string;
+    expected_outcome: string;
+    steps_to_reproduce: string;
+    desired_solution: string;
+    impact_details: string;
+    additional_context: string;
+    frequency: FeedbackFrequency;
+    impact_level: FeedbackImpactLevel;
+}
+interface DiagnosticItem {
+    timestamp?: string;
+    type?: string;
+    message?: string;
+}
+interface DiagnosticsSnapshot {
+    page_title?: string;
+    page_url?: string;
+    current_route?: string;
+    referrer?: string;
+    language?: string;
+    languages?: string[];
+    timezone?: string;
+    submitted_at_client?: string;
+    browser_info?: string;
+    online?: boolean;
+    device_pixel_ratio?: number;
+    viewport?: {
+        width?: number;
+        height?: number;
+    };
+    screen?: {
+        width?: number;
+        height?: number;
+    };
+    network_info?: {
+        type?: string;
+        effective_type?: string;
+        downlink_mbps?: number;
+        rtt_ms?: number;
+        save_data?: boolean;
+    };
+    performance_timing?: {
+        page_load_ms?: number;
+        dom_interactive_ms?: number;
+        dom_content_loaded_ms?: number;
+        ttfb_ms?: number;
+    };
+    memory_info?: {
+        used_js_heap_mb?: number;
+        total_js_heap_mb?: number;
+        limit_mb?: number;
+    };
+    recent_actions?: DiagnosticItem[];
+    recent_console_errors?: DiagnosticItem[];
+}
+interface SubmitFeedbackRequest {
+    type: FeedbackType;
+    title: string;
+    description: string;
+    priority: FeedbackPriority;
+    satisfaction_rating?: number | null;
+    page_url?: string;
+    browser_info?: string;
+    experience_details?: Record<string, unknown>;
+    technical_context?: DiagnosticsSnapshot;
+    app_name?: string;
+    environment?: string;
+    repo_slug?: string;
+    route_path?: string;
+    context?: Record<string, unknown>;
+    custom_fields?: Record<string, unknown>;
+}
+interface ValidationResult {
+    valid: boolean;
+    title?: string;
+    description?: string;
+}
+interface RouteMeta {
+    pathname?: string;
+    href?: string;
+    title?: string;
+}
+interface DiagnosticsEntry {
+    type: string;
+    message: string;
+}
+interface DiagnosticsConfig {
+    enabled?: boolean;
+    captureClicks?: boolean;
+    captureFormSubmits?: boolean;
+    captureConsoleWarnings?: boolean;
+    captureConsoleErrors?: boolean;
+    captureUnhandledRejections?: boolean;
+    captureWindowErrors?: boolean;
+    redact?: (entry: DiagnosticsEntry) => DiagnosticsEntry | null;
+    clearPolicy?: 'on_success' | 'on_close' | 'manual';
+}
+interface FeedbackTypeFieldConfig {
+    key: keyof FeedbackFormData;
+    label: string;
+    placeholder?: string;
+    helpText?: string;
+    required?: boolean;
+    inputType?: 'text' | 'textarea' | 'rating';
+}
+interface FeedbackTypeConfig {
+    value: FeedbackType;
+    label: string;
+    description: string;
+    icon?: string;
+    fields: FeedbackTypeFieldConfig[];
+}
+interface SupportWidgetTheme {
+    classNames?: Partial<Record<string, string>>;
+    launcherLabel?: string;
+}
+type SubmissionMode = 'central_api' | 'github_issue_proxy';
+interface SubmissionConfig {
+    mode?: SubmissionMode;
+    endpointPath?: string;
+}
+interface SupportWidgetConfig {
+    appName: string;
+    environment: string;
+    repoSlug: string;
+    apiBaseUrl: string;
+    getCurrentRoute: () => RouteMeta;
+    getCurrentUserContext?: () => Record<string, unknown>;
+    getAuthToken?: () => string | null;
+    customFields?: Record<string, unknown>;
+    diagnostics?: DiagnosticsConfig;
+    theme?: SupportWidgetTheme;
+    submission?: SubmissionConfig;
+}
+interface SubmitResult {
+    message?: string;
+    feedback_id?: string;
+    type?: FeedbackType;
+    issue_number?: number;
+    issue_url?: string;
+    repo_slug?: string;
+    assigned_to?: string[];
+    warnings?: string[];
+    [key: string]: unknown;
+}
+interface SupportWidgetProps {
+    config: SupportWidgetConfig;
+    isVisible?: boolean;
+    onSuccess?: (result: SubmitResult) => void;
+    onError?: (error: unknown) => void;
+    onSubmit?: (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+}
+
+declare function SupportWidget({ config, isVisible, onSuccess, onError, onSubmit }: SupportWidgetProps): react_jsx_runtime.JSX.Element | null;
+
+declare const feedbackFieldLabels: Record<keyof FeedbackFormData, string>;
+declare const feedbackTypes: FeedbackTypeConfig[];
+declare function createEmptyFeedbackForm(): FeedbackFormData;
+declare function getRequiredFeedbackFields(type: FeedbackType): Array<keyof FeedbackFormData>;
+declare function validateFeedbackForm(formData: FeedbackFormData): ValidationResult;
+declare function buildExperienceDetailsPayload(formData: FeedbackFormData): Record<string, unknown>;
+
+declare function buildFeedbackDescription(formData: FeedbackFormData, diagnostics?: DiagnosticsSnapshot): string;
+
+declare function installFeedbackDiagnostics(config?: DiagnosticsConfig): () => void;
+declare function clearFeedbackDiagnostics(): void;
+declare function recordFeedbackRouteVisit(route: RouteMeta): void;
+declare function getFeedbackDiagnosticsSnapshot(route?: RouteMeta): DiagnosticsSnapshot;
+
+interface CentralApiClientOptions {
+    apiBaseUrl: string;
+    getAuthToken?: () => string | null;
+    endpointPath?: string;
+    fetchImpl?: typeof fetch;
+}
+declare function createCentralFeedbackClient(options: CentralApiClientOptions): (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+
+interface GitHubIssueProxyClientOptions {
+    apiBaseUrl: string;
+    getAuthToken?: () => string | null;
+    endpointPath?: string;
+    fetchImpl?: typeof fetch;
+}
+declare function createGitHubIssueProxyClient(options: GitHubIssueProxyClientOptions): (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+
+export { type DiagnosticsConfig, type DiagnosticsSnapshot, type FeedbackFormData, type FeedbackType, type SubmissionConfig, type SubmissionMode, type SubmitFeedbackRequest, type SubmitResult, SupportWidget, type SupportWidgetConfig, type SupportWidgetProps, buildExperienceDetailsPayload, buildFeedbackDescription, clearFeedbackDiagnostics, createCentralFeedbackClient, createEmptyFeedbackForm, createGitHubIssueProxyClient, feedbackFieldLabels, feedbackTypes, getFeedbackDiagnosticsSnapshot, getRequiredFeedbackFields, installFeedbackDiagnostics, recordFeedbackRouteVisit, validateFeedbackForm };

package/dist/index.d.ts

@@ -0,0 +1,199 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type FeedbackType = 'bug' | 'feature' | 'feedback' | 'improvement';
+type FeedbackPriority = 'low' | 'medium' | 'high' | 'critical';
+type FeedbackFrequency = '' | 'once' | 'sometimes' | 'often' | 'every_time';
+type FeedbackImpactLevel = '' | 'minor' | 'moderate' | 'major' | 'critical';
+interface FeedbackFormData {
+    type: FeedbackType | '';
+    title: string;
+    priority: FeedbackPriority;
+    satisfaction_rating: number | null;
+    experience_summary: string;
+    what_were_you_doing: string;
+    what_happened: string;
+    expected_outcome: string;
+    steps_to_reproduce: string;
+    desired_solution: string;
+    impact_details: string;
+    additional_context: string;
+    frequency: FeedbackFrequency;
+    impact_level: FeedbackImpactLevel;
+}
+interface DiagnosticItem {
+    timestamp?: string;
+    type?: string;
+    message?: string;
+}
+interface DiagnosticsSnapshot {
+    page_title?: string;
+    page_url?: string;
+    current_route?: string;
+    referrer?: string;
+    language?: string;
+    languages?: string[];
+    timezone?: string;
+    submitted_at_client?: string;
+    browser_info?: string;
+    online?: boolean;
+    device_pixel_ratio?: number;
+    viewport?: {
+        width?: number;
+        height?: number;
+    };
+    screen?: {
+        width?: number;
+        height?: number;
+    };
+    network_info?: {
+        type?: string;
+        effective_type?: string;
+        downlink_mbps?: number;
+        rtt_ms?: number;
+        save_data?: boolean;
+    };
+    performance_timing?: {
+        page_load_ms?: number;
+        dom_interactive_ms?: number;
+        dom_content_loaded_ms?: number;
+        ttfb_ms?: number;
+    };
+    memory_info?: {
+        used_js_heap_mb?: number;
+        total_js_heap_mb?: number;
+        limit_mb?: number;
+    };
+    recent_actions?: DiagnosticItem[];
+    recent_console_errors?: DiagnosticItem[];
+}
+interface SubmitFeedbackRequest {
+    type: FeedbackType;
+    title: string;
+    description: string;
+    priority: FeedbackPriority;
+    satisfaction_rating?: number | null;
+    page_url?: string;
+    browser_info?: string;
+    experience_details?: Record<string, unknown>;
+    technical_context?: DiagnosticsSnapshot;
+    app_name?: string;
+    environment?: string;
+    repo_slug?: string;
+    route_path?: string;
+    context?: Record<string, unknown>;
+    custom_fields?: Record<string, unknown>;
+}
+interface ValidationResult {
+    valid: boolean;
+    title?: string;
+    description?: string;
+}
+interface RouteMeta {
+    pathname?: string;
+    href?: string;
+    title?: string;
+}
+interface DiagnosticsEntry {
+    type: string;
+    message: string;
+}
+interface DiagnosticsConfig {
+    enabled?: boolean;
+    captureClicks?: boolean;
+    captureFormSubmits?: boolean;
+    captureConsoleWarnings?: boolean;
+    captureConsoleErrors?: boolean;
+    captureUnhandledRejections?: boolean;
+    captureWindowErrors?: boolean;
+    redact?: (entry: DiagnosticsEntry) => DiagnosticsEntry | null;
+    clearPolicy?: 'on_success' | 'on_close' | 'manual';
+}
+interface FeedbackTypeFieldConfig {
+    key: keyof FeedbackFormData;
+    label: string;
+    placeholder?: string;
+    helpText?: string;
+    required?: boolean;
+    inputType?: 'text' | 'textarea' | 'rating';
+}
+interface FeedbackTypeConfig {
+    value: FeedbackType;
+    label: string;
+    description: string;
+    icon?: string;
+    fields: FeedbackTypeFieldConfig[];
+}
+interface SupportWidgetTheme {
+    classNames?: Partial<Record<string, string>>;
+    launcherLabel?: string;
+}
+type SubmissionMode = 'central_api' | 'github_issue_proxy';
+interface SubmissionConfig {
+    mode?: SubmissionMode;
+    endpointPath?: string;
+}
+interface SupportWidgetConfig {
+    appName: string;
+    environment: string;
+    repoSlug: string;
+    apiBaseUrl: string;
+    getCurrentRoute: () => RouteMeta;
+    getCurrentUserContext?: () => Record<string, unknown>;
+    getAuthToken?: () => string | null;
+    customFields?: Record<string, unknown>;
+    diagnostics?: DiagnosticsConfig;
+    theme?: SupportWidgetTheme;
+    submission?: SubmissionConfig;
+}
+interface SubmitResult {
+    message?: string;
+    feedback_id?: string;
+    type?: FeedbackType;
+    issue_number?: number;
+    issue_url?: string;
+    repo_slug?: string;
+    assigned_to?: string[];
+    warnings?: string[];
+    [key: string]: unknown;
+}
+interface SupportWidgetProps {
+    config: SupportWidgetConfig;
+    isVisible?: boolean;
+    onSuccess?: (result: SubmitResult) => void;
+    onError?: (error: unknown) => void;
+    onSubmit?: (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+}
+
+declare function SupportWidget({ config, isVisible, onSuccess, onError, onSubmit }: SupportWidgetProps): react_jsx_runtime.JSX.Element | null;
+
+declare const feedbackFieldLabels: Record<keyof FeedbackFormData, string>;
+declare const feedbackTypes: FeedbackTypeConfig[];
+declare function createEmptyFeedbackForm(): FeedbackFormData;
+declare function getRequiredFeedbackFields(type: FeedbackType): Array<keyof FeedbackFormData>;
+declare function validateFeedbackForm(formData: FeedbackFormData): ValidationResult;
+declare function buildExperienceDetailsPayload(formData: FeedbackFormData): Record<string, unknown>;
+
+declare function buildFeedbackDescription(formData: FeedbackFormData, diagnostics?: DiagnosticsSnapshot): string;
+
+declare function installFeedbackDiagnostics(config?: DiagnosticsConfig): () => void;
+declare function clearFeedbackDiagnostics(): void;
+declare function recordFeedbackRouteVisit(route: RouteMeta): void;
+declare function getFeedbackDiagnosticsSnapshot(route?: RouteMeta): DiagnosticsSnapshot;
+
+interface CentralApiClientOptions {
+    apiBaseUrl: string;
+    getAuthToken?: () => string | null;
+    endpointPath?: string;
+    fetchImpl?: typeof fetch;
+}
+declare function createCentralFeedbackClient(options: CentralApiClientOptions): (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+
+interface GitHubIssueProxyClientOptions {
+    apiBaseUrl: string;
+    getAuthToken?: () => string | null;
+    endpointPath?: string;
+    fetchImpl?: typeof fetch;
+}
+declare function createGitHubIssueProxyClient(options: GitHubIssueProxyClientOptions): (payload: SubmitFeedbackRequest) => Promise<SubmitResult>;
+
+export { type DiagnosticsConfig, type DiagnosticsSnapshot, type FeedbackFormData, type FeedbackType, type SubmissionConfig, type SubmissionMode, type SubmitFeedbackRequest, type SubmitResult, SupportWidget, type SupportWidgetConfig, type SupportWidgetProps, buildExperienceDetailsPayload, buildFeedbackDescription, clearFeedbackDiagnostics, createCentralFeedbackClient, createEmptyFeedbackForm, createGitHubIssueProxyClient, feedbackFieldLabels, feedbackTypes, getFeedbackDiagnosticsSnapshot, getRequiredFeedbackFields, installFeedbackDiagnostics, recordFeedbackRouteVisit, validateFeedbackForm };