@diegotsi/flint-react 0.6.0 → 1.0.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
+export { flint } from '@flint/core';
 
 type Severity = "P1" | "P2" | "P3" | "P4";
 interface EnvironmentInfo {
@@ -33,6 +34,7 @@ interface ThemeOverride {
 interface FlintUser {
     id: string;
     name: string;
+    email?: string;
 }
 interface FlintExtraFields {
     /** Session replay URL from Datadog RUM, FullStory, LogRocket, etc. Pass a function for lazy evaluation. */
@@ -58,6 +60,8 @@ interface FlintWidgetProps {
     theme?: Theme;
     /** Custom z-index for the widget. Default: 9999 */
     zIndex?: number;
+    /** URL of the admin/status page for reporters to track their bugs */
+    statusPageUrl?: string;
     /**
      * Datadog site hostname for auto-generating RUM Session Replay deep links.
      * When set, the widget auto-detects `window.DD_RUM` and generates a direct
@@ -65,10 +69,29 @@ interface FlintWidgetProps {
      * Examples: "app.datadoghq.com", "app.datadoghq.eu", "app.us5.datadoghq.com"
      */
     datadogSite?: string;
+    /** Enable session replay recording. Default: true */
+    enableReplay?: boolean;
+    /** Enable screenshot capture. Default: true */
+    enableScreenshot?: boolean;
+    /** Enable console log collection. Default: true */
+    enableConsole?: boolean;
+    /** Enable network error collection. Default: true */
+    enableNetwork?: boolean;
+    /** Called before report submission. Return false to cancel. */
+    onBeforeSubmit?: (payload: ReportPayload) => boolean | Promise<boolean>;
+    /** Called after successful submission */
+    onSuccess?: (result: ReportResult) => void;
+    /** Called when submission fails */
+    onError?: (error: Error) => void;
+    /** Called when the modal opens */
+    onOpen?: () => void;
+    /** Called when the modal closes */
+    onClose?: () => void;
 }
 interface ReportPayload {
     reporterId: string;
     reporterName: string;
+    reporterEmail?: string;
     description: string;
     expectedBehavior?: string;
     stepsToReproduce?: {
@@ -91,8 +114,6 @@ interface ReportResult {
     duplicateOfId?: string | null;
 }
 
-declare function FlintWidget(props: FlintWidgetProps): react_jsx_runtime.JSX.Element;
-
 declare type addedNodeMutation = {
     parentId: number;
     previousId?: number | null;
@@ -524,12 +545,14 @@ interface Props {
     getReplayEvents: () => eventWithTime[];
     getExternalReplayUrl: () => string | undefined;
     initialSelection?: string;
+    enableScreenshot?: boolean;
+    statusPageUrl?: string;
+    onBeforeSubmit?: (payload: ReportPayload) => boolean | Promise<boolean>;
+    onSuccess?: (result: ReportResult) => void;
+    onError?: (error: Error) => void;
 }
-declare function FlintModal({ projectKey, serverUrl, user, meta, theme, zIndex, onClose, getEnvironment, getConsoleLogs, getNetworkErrors, getReplayEvents, getExternalReplayUrl, initialSelection, }: Props): react_jsx_runtime.JSX.Element;
+declare function FlintModal({ projectKey, serverUrl, user, meta, theme, zIndex, onClose, getEnvironment, getConsoleLogs, getNetworkErrors, getReplayEvents, getExternalReplayUrl, initialSelection, enableScreenshot, statusPageUrl, onBeforeSubmit, onSuccess, onError, }: Props): react_jsx_runtime.JSX.Element;
 
-declare const flint: {
-    setUser(user: FlintUser | null): void;
-    setSessionReplay(url: string | (() => string)): void;
-};
+declare function FlintWidget(props: FlintWidgetProps): react_jsx_runtime.JSX.Element;
 
-export { FlintModal, type FlintUser, FlintWidget, type FlintWidgetProps, type Locale, type ReportPayload, type ReportResult, type Severity, type Theme, type ThemeOverride, flint };
+export { FlintModal, type FlintUser, FlintWidget, type FlintWidgetProps, type Locale, type ReportPayload, type ReportResult, type Severity, type Theme, type ThemeOverride };