glitchgrab 1.11.0 → 1.13.0

package/dist/index.d.mts

@@ -14,6 +14,7 @@ interface GlitchgrabConfig {
     maxBreadcrumbs?: number;
 }
 type ReportType = "BUG" | "FEATURE_REQUEST" | "QUESTION" | "OTHER";
+type ReportSeverity = "low" | "medium" | "high";
 interface ReportPayload {
     token: string;
     source: "SDK_AUTO" | "SDK_USER_REPORT";
@@ -86,13 +87,15 @@ interface GlitchgrabProviderProps {
     maxBreadcrumbs?: number;
     children: ReactNode;
     fallback?: ReactNode;
+    /** Which report types to show in the dialog (default: all four) */
+    types?: ReportType[];
+    /** Show severity picker for BUG type (default: true) */
+    showSeverity?: boolean;
 }
 interface ReportButtonProps {
     position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
     label?: string;
     className?: string;
-    /** Allow reporting feature requests, questions, not just bugs */
-    types?: ReportType[];
 }
 interface UseGlitchgrabReturn {
     /** Report a bug programmatically */
@@ -104,6 +107,7 @@ interface UseGlitchgrabReturn {
     /** Open the ReportButton modal programmatically (captures screenshot + shows dialog) */
     openReportDialog: (options?: {
         description?: string;
+        type?: ReportType;
     }) => void;
     /** The token being used */
     token: string;
@@ -131,8 +135,29 @@ interface UseGlitchgrabReturn {
 declare function useGlitchgrab(): UseGlitchgrabReturn;
 declare function GlitchgrabProvider(props: GlitchgrabProviderProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Optional trigger button for opening the report dialog.
+ *
+ * The dialog itself lives inside `GlitchgrabProvider` — you don't need this component
+ * unless you want a visible trigger button. You can also open the dialog programmatically
+ * via `useGlitchgrab().openReportDialog()`.
+ *
+ * @example
+ * ```tsx
+ * // Use the default floating button
+ * <ReportButton />
+ *
+ * // Use your own trigger
+ * <ReportButton>
+ *   {({ onClick }) => <button onClick={onClick}>Report</button>}
+ * </ReportButton>
+ *
+ * // Or skip ReportButton entirely and use the hook
+ * const { openReportDialog } = useGlitchgrab();
+ * <button onClick={() => openReportDialog()}>Report</button>
+ * ```
+ */
 declare function ReportButton({ position, label, className, children, }: ReportButtonProps & {
-    /** Render prop — receives { onClick, capturing } so you can use your own trigger button */
     children?: (props: {
         onClick: () => void;
         capturing: boolean;
@@ -168,6 +193,8 @@ interface GlitchgrabReport {
     reporterPhone: string | null;
     pageUrl: string | null;
     createdAt: string;
+    /** Number of comments on the linked GitHub issue (0 if no issue) */
+    commentCount: number;
     issue: {
         githubNumber: number;
         githubUrl: string;
@@ -261,4 +288,4 @@ declare function captureContext(visitedPages: string[]): CapturedContext;
  */
 declare function sendReport(payload: ReportPayload, baseUrl?: string): Promise<ReportResult | null>;
 
-export { type Breadcrumb, type BreadcrumbType, type CapturedContext, type DeviceInfo, type GlitchgrabConfig, GlitchgrabErrorBoundary, GlitchgrabProvider, type GlitchgrabProviderProps, type GlitchgrabSession, ReportButton, type ReportButtonProps, type ReportPayload, type ReportResult, type ReportType, type UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, clearBreadcrumbs, fetchGlitchgrabReports, getBreadcrumbs, initBreadcrumbs, sanitizeUrl, sendReport, useGlitchgrab, useGlitchgrabActions, useGlitchgrabReports };
+export { type Breadcrumb, type BreadcrumbType, type CapturedContext, type DeviceInfo, type GlitchgrabConfig, GlitchgrabErrorBoundary, GlitchgrabProvider, type GlitchgrabProviderProps, type GlitchgrabReport, type GlitchgrabSession, ReportButton, type ReportButtonProps, type ReportPayload, type ReportResult, type ReportSeverity, type ReportType, type UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, clearBreadcrumbs, fetchGlitchgrabReports, getBreadcrumbs, initBreadcrumbs, sanitizeUrl, sendReport, useGlitchgrab, useGlitchgrabActions, useGlitchgrabReports };

package/dist/index.d.ts

@@ -14,6 +14,7 @@ interface GlitchgrabConfig {
     maxBreadcrumbs?: number;
 }
 type ReportType = "BUG" | "FEATURE_REQUEST" | "QUESTION" | "OTHER";
+type ReportSeverity = "low" | "medium" | "high";
 interface ReportPayload {
     token: string;
     source: "SDK_AUTO" | "SDK_USER_REPORT";
@@ -86,13 +87,15 @@ interface GlitchgrabProviderProps {
     maxBreadcrumbs?: number;
     children: ReactNode;
     fallback?: ReactNode;
+    /** Which report types to show in the dialog (default: all four) */
+    types?: ReportType[];
+    /** Show severity picker for BUG type (default: true) */
+    showSeverity?: boolean;
 }
 interface ReportButtonProps {
     position?: "bottom-right" | "bottom-left" | "top-right" | "top-left";
     label?: string;
     className?: string;
-    /** Allow reporting feature requests, questions, not just bugs */
-    types?: ReportType[];
 }
 interface UseGlitchgrabReturn {
     /** Report a bug programmatically */
@@ -104,6 +107,7 @@ interface UseGlitchgrabReturn {
     /** Open the ReportButton modal programmatically (captures screenshot + shows dialog) */
     openReportDialog: (options?: {
         description?: string;
+        type?: ReportType;
     }) => void;
     /** The token being used */
     token: string;
@@ -131,8 +135,29 @@ interface UseGlitchgrabReturn {
 declare function useGlitchgrab(): UseGlitchgrabReturn;
 declare function GlitchgrabProvider(props: GlitchgrabProviderProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Optional trigger button for opening the report dialog.
+ *
+ * The dialog itself lives inside `GlitchgrabProvider` — you don't need this component
+ * unless you want a visible trigger button. You can also open the dialog programmatically
+ * via `useGlitchgrab().openReportDialog()`.
+ *
+ * @example
+ * ```tsx
+ * // Use the default floating button
+ * <ReportButton />
+ *
+ * // Use your own trigger
+ * <ReportButton>
+ *   {({ onClick }) => <button onClick={onClick}>Report</button>}
+ * </ReportButton>
+ *
+ * // Or skip ReportButton entirely and use the hook
+ * const { openReportDialog } = useGlitchgrab();
+ * <button onClick={() => openReportDialog()}>Report</button>
+ * ```
+ */
 declare function ReportButton({ position, label, className, children, }: ReportButtonProps & {
-    /** Render prop — receives { onClick, capturing } so you can use your own trigger button */
     children?: (props: {
         onClick: () => void;
         capturing: boolean;
@@ -168,6 +193,8 @@ interface GlitchgrabReport {
     reporterPhone: string | null;
     pageUrl: string | null;
     createdAt: string;
+    /** Number of comments on the linked GitHub issue (0 if no issue) */
+    commentCount: number;
     issue: {
         githubNumber: number;
         githubUrl: string;
@@ -261,4 +288,4 @@ declare function captureContext(visitedPages: string[]): CapturedContext;
  */
 declare function sendReport(payload: ReportPayload, baseUrl?: string): Promise<ReportResult | null>;
 
-export { type Breadcrumb, type BreadcrumbType, type CapturedContext, type DeviceInfo, type GlitchgrabConfig, GlitchgrabErrorBoundary, GlitchgrabProvider, type GlitchgrabProviderProps, type GlitchgrabSession, ReportButton, type ReportButtonProps, type ReportPayload, type ReportResult, type ReportType, type UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, clearBreadcrumbs, fetchGlitchgrabReports, getBreadcrumbs, initBreadcrumbs, sanitizeUrl, sendReport, useGlitchgrab, useGlitchgrabActions, useGlitchgrabReports };
+export { type Breadcrumb, type BreadcrumbType, type CapturedContext, type DeviceInfo, type GlitchgrabConfig, GlitchgrabErrorBoundary, GlitchgrabProvider, type GlitchgrabProviderProps, type GlitchgrabReport, type GlitchgrabSession, ReportButton, type ReportButtonProps, type ReportPayload, type ReportResult, type ReportSeverity, type ReportType, type UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, clearBreadcrumbs, fetchGlitchgrabReports, getBreadcrumbs, initBreadcrumbs, sanitizeUrl, sendReport, useGlitchgrab, useGlitchgrabActions, useGlitchgrabReports };