glitchgrab 1.58.3 → 1.59.1

package/README.md

@@ -371,6 +371,42 @@ function MyReports() {
 }
 ```
 
+### Show the conversation on a report
+
+Let your user see what the team said on their report and reply — no GitHub account needed. Replies land on the GitHub issue as the Glitchgrab app, with "Commented by: <name>" underneath.
+
+```tsx
+import { useGlitchgrabReportThread } from "glitchgrab";
+
+function ReportThread({ reportId }: { reportId: string }) {
+  const { report, comments, addComment, isPosting, error } = useGlitchgrabReportThread({
+    token: process.env.NEXT_PUBLIC_GLITCHGRAB_TOKEN!,
+    reportId,                          // from useGlitchgrabReports
+    reporterName: session.user.name,   // optional, defaults to the name it was filed under
+  });
+  const [text, setText] = useState("");
+
+  return (
+    <div>
+      <h3>{report?.issue?.title} — {report?.issue?.githubState ?? "open"}</h3>
+      {comments.map((c, i) => (
+        <p key={i}><b>{c.author}</b>: {c.body}</p>
+      ))}
+      <textarea value={text} onChange={(e) => setText(e.target.value)} />
+      <button
+        disabled={isPosting || !text.trim()}
+        onClick={async () => { if (await addComment(text)) setText(""); }}
+      >
+        {isPosting ? "Sending…" : "Reply"}
+      </button>
+      {error && <p>{error}</p>}
+    </div>
+  );
+}
+```
+
+`addComment` never throws: it resolves `true` once the reply is posted and the thread reloaded, `false` with `error` set otherwise. Without the hook, use `fetchGlitchgrabReportThread` / `postGlitchgrabReportComment` (both throw) with your own data layer.
+
 ### With TanStack Query
 
 ```tsx
@@ -1001,6 +1037,25 @@ interface CallsOptions {
 }
 ```
 
+## How do I do something once a visitor books a demo?
+
+Open the dialog yourself and pass `onBooked`. `intro` puts one line of your own
+above the dialog's title, so the visitor knows why you are asking.
+
+```tsx
+const { openBookingDialog } = useGlitchgrab();
+
+openBookingDialog({
+  intro: "Book a short call — the live demo opens the moment you're booked.",
+  onBooked: ({ bookingId }) => {
+    // Runs once, after the phone code when one is asked. The details come from
+    // the browser: look `bookingId` up with listBookings() on your server
+    // before you trust it.
+    startDemo(bookingId);
+  },
+});
+```
+
 ## How do I change demo booking settings from my admin panel?
 
 The same server key reads and writes the project's demo booking settings —

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { f as GlitchgrabProviderProps, U as UseGlitchgrabReturn, R as ReportButtonProps, F as FeedbackButtonProps, g as GlitchgrabSession, C as CaptureErrorOptions, e as GlitchgrabFeedback, a as BreadcrumbType, B as Breadcrumb, b as CapturedContext, D as DeviceInfo, c as FeedbackPayload, d as FeedbackResult, L as LeadInput, h as LeadResult, i as ReportPayload, j as ReportResult } from './types-BpTLWJ1y.mjs';
-export { G as GlitchgrabConfig, k as ReportSeverity, l as ReportType, m as RuntimeInfo } from './types-BpTLWJ1y.mjs';
+import { h as GlitchgrabProviderProps, U as UseGlitchgrabReturn, R as ReportButtonProps, B as BookedDemo, F as FeedbackButtonProps, i as GlitchgrabSession, C as CaptureErrorOptions, g as GlitchgrabFeedback, c as BreadcrumbType, b as Breadcrumb, d as CapturedContext, D as DeviceInfo, e as FeedbackPayload, f as FeedbackResult, L as LeadInput, j as LeadResult, k as ReportPayload, l as ReportResult } from './types-BlMF6wzX.mjs';
+export { a as BookingDialogOptions, G as GlitchgrabConfig, m as ReportSeverity, n as ReportType, o as RuntimeInfo } from './types-BlMF6wzX.mjs';
 import * as React from 'react';
 import { ReactNode } from 'react';
 
@@ -81,7 +81,7 @@ declare function BookDemoButton({ label, className, children, }: {
     }) => ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
-declare function BookingDialog({ token, baseUrl, open, onClose, preview, availabilityUrl, }: {
+declare function BookingDialog({ token, baseUrl, open, onClose, preview, availabilityUrl, intro, onBooked, }: {
     token: string;
     baseUrl: string;
     open: boolean;
@@ -97,6 +97,10 @@ declare function BookingDialog({ token, baseUrl, open, onClose, preview, availab
      * holds no `gg_` token for the project. Same response shape.
      */
     availabilityUrl?: string;
+    /** The host's one line above the title — see `BookingDialogOptions.intro`. */
+    intro?: string;
+    /** Fired once when a booking is confirmed — see `BookingDialogOptions.onBooked`. */
+    onBooked?: (booking: BookedDemo) => void;
 }): react_jsx_runtime.JSX.Element | null;
 
 /**
@@ -280,6 +284,82 @@ declare function useGlitchgrabActions({ token, onSuccess, onError, }: {
     isPending: boolean;
     error: string | null;
 };
+interface GlitchgrabComment {
+    /** GitHub login. Replies from your users post as the Glitchgrab app, with their name in the body. */
+    author: string;
+    body: string;
+    createdAt: string;
+}
+interface GlitchgrabReportThread {
+    id: string;
+    status: string;
+    rawInput: string | null;
+    createdAt: string;
+    issue: {
+        githubNumber: number;
+        githubUrl: string;
+        title: string;
+        body: string;
+        labels: string[];
+        severity: string | null;
+        /** "open" | "closed", or null when GitHub did not answer. */
+        githubState: string | null;
+    } | null;
+    /** Oldest first. Empty when no issue is linked yet. */
+    comments: GlitchgrabComment[];
+}
+/**
+ * Fetch one report with its GitHub issue and every comment on it — the team's
+ * replies and your user's. Throws on failure; pair it with your own data layer.
+ */
+declare function fetchGlitchgrabReportThread({ token, reportId, }: {
+    token: string;
+    reportId: string;
+}): Promise<GlitchgrabReportThread>;
+/**
+ * Post a reply on the report's GitHub issue. It lands as the Glitchgrab app
+ * with "Commented by: <name>" underneath, so the team knows who said it.
+ * Throws on failure.
+ */
+declare function postGlitchgrabReportComment({ token, reportId, message, reporterName, reporterEmail, }: {
+    token: string;
+    reportId: string;
+    message: string;
+    /** Defaults to the name the report was filed under. */
+    reporterName?: string;
+    reporterEmail?: string;
+}): Promise<GlitchgrabComment>;
+/**
+ * The conversation on one report: where it stands, what the team said, and a
+ * way for your user to reply — without a GitHub account.
+ *
+ * ```tsx
+ * const { report, comments, addComment, isPosting } = useGlitchgrabReportThread({
+ *   token: process.env.NEXT_PUBLIC_GLITCHGRAB_TOKEN!,
+ *   reportId,
+ *   reporterName: session.user.name,
+ * });
+ * ```
+ *
+ * Never throws. `addComment` resolves `true` once the reply is on the issue
+ * (and the thread has reloaded), `false` with `error` set otherwise.
+ */
+declare function useGlitchgrabReportThread({ token, reportId, reporterName, reporterEmail, }: {
+    token: string;
+    /** `reportId` from `useGlitchgrabReports` or the report submit result. Null waits. */
+    reportId: string | null;
+    reporterName?: string;
+    reporterEmail?: string;
+}): {
+    report: GlitchgrabReportThread | null;
+    comments: GlitchgrabComment[];
+    isLoading: boolean;
+    isFetching: boolean;
+    isPosting: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+    addComment: (message: string) => Promise<boolean>;
+};
 
 interface FeedbackQuery {
     token: string;
@@ -422,4 +502,4 @@ declare function computeSignature(params: {
 declare function shouldSkipDuplicate(signature: string, windowMs?: number, now?: number): boolean;
 declare function clearDedupCache(): void;
 
-export { BookDemoButton, BookingDialog, Breadcrumb, BreadcrumbType, CaptureErrorOptions, CapturedContext, DeviceInfo, FeedbackButton, FeedbackButtonProps, FeedbackPayload, type FeedbackQuery, FeedbackResult, GLITCHGRAB_SHORTCUT, GLITCHGRAB_SHORTCUT_MAC, GlitchgrabErrorBoundary, GlitchgrabFeedback, GlitchgrabProvider, GlitchgrabProviderProps, type GlitchgrabReport, GlitchgrabSession, LeadInput, LeadResult, ReportButton, ReportButtonProps, ReportPayload, ReportResult, UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, captureError, clearAppContext, clearBreadcrumbs, clearDedupCache, computeSignature, enhanceText, fetchGlitchgrabFeedback, fetchGlitchgrabReports, getAppContext, getBreadcrumbs, getShortcutLabel, initBreadcrumbs, matchesShortcut, sanitizeUrl, sendFeedback, sendLead, sendReport, setContext, setContexts, shouldSkipDuplicate, useGlitchgrab, useGlitchgrabActions, useGlitchgrabFeedback, useGlitchgrabReports };
+export { BookDemoButton, BookedDemo, BookingDialog, Breadcrumb, BreadcrumbType, CaptureErrorOptions, CapturedContext, DeviceInfo, FeedbackButton, FeedbackButtonProps, FeedbackPayload, type FeedbackQuery, FeedbackResult, GLITCHGRAB_SHORTCUT, GLITCHGRAB_SHORTCUT_MAC, type GlitchgrabComment, GlitchgrabErrorBoundary, GlitchgrabFeedback, GlitchgrabProvider, GlitchgrabProviderProps, type GlitchgrabReport, type GlitchgrabReportThread, GlitchgrabSession, LeadInput, LeadResult, ReportButton, ReportButtonProps, ReportPayload, ReportResult, UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, captureError, clearAppContext, clearBreadcrumbs, clearDedupCache, computeSignature, enhanceText, fetchGlitchgrabFeedback, fetchGlitchgrabReportThread, fetchGlitchgrabReports, getAppContext, getBreadcrumbs, getShortcutLabel, initBreadcrumbs, matchesShortcut, postGlitchgrabReportComment, sanitizeUrl, sendFeedback, sendLead, sendReport, setContext, setContexts, shouldSkipDuplicate, useGlitchgrab, useGlitchgrabActions, useGlitchgrabFeedback, useGlitchgrabReportThread, useGlitchgrabReports };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { f as GlitchgrabProviderProps, U as UseGlitchgrabReturn, R as ReportButtonProps, F as FeedbackButtonProps, g as GlitchgrabSession, C as CaptureErrorOptions, e as GlitchgrabFeedback, a as BreadcrumbType, B as Breadcrumb, b as CapturedContext, D as DeviceInfo, c as FeedbackPayload, d as FeedbackResult, L as LeadInput, h as LeadResult, i as ReportPayload, j as ReportResult } from './types-BpTLWJ1y.js';
-export { G as GlitchgrabConfig, k as ReportSeverity, l as ReportType, m as RuntimeInfo } from './types-BpTLWJ1y.js';
+import { h as GlitchgrabProviderProps, U as UseGlitchgrabReturn, R as ReportButtonProps, B as BookedDemo, F as FeedbackButtonProps, i as GlitchgrabSession, C as CaptureErrorOptions, g as GlitchgrabFeedback, c as BreadcrumbType, b as Breadcrumb, d as CapturedContext, D as DeviceInfo, e as FeedbackPayload, f as FeedbackResult, L as LeadInput, j as LeadResult, k as ReportPayload, l as ReportResult } from './types-BlMF6wzX.js';
+export { a as BookingDialogOptions, G as GlitchgrabConfig, m as ReportSeverity, n as ReportType, o as RuntimeInfo } from './types-BlMF6wzX.js';
 import * as React from 'react';
 import { ReactNode } from 'react';
 
@@ -81,7 +81,7 @@ declare function BookDemoButton({ label, className, children, }: {
     }) => ReactNode;
 }): react_jsx_runtime.JSX.Element;
 
-declare function BookingDialog({ token, baseUrl, open, onClose, preview, availabilityUrl, }: {
+declare function BookingDialog({ token, baseUrl, open, onClose, preview, availabilityUrl, intro, onBooked, }: {
     token: string;
     baseUrl: string;
     open: boolean;
@@ -97,6 +97,10 @@ declare function BookingDialog({ token, baseUrl, open, onClose, preview, availab
      * holds no `gg_` token for the project. Same response shape.
      */
     availabilityUrl?: string;
+    /** The host's one line above the title — see `BookingDialogOptions.intro`. */
+    intro?: string;
+    /** Fired once when a booking is confirmed — see `BookingDialogOptions.onBooked`. */
+    onBooked?: (booking: BookedDemo) => void;
 }): react_jsx_runtime.JSX.Element | null;
 
 /**
@@ -280,6 +284,82 @@ declare function useGlitchgrabActions({ token, onSuccess, onError, }: {
     isPending: boolean;
     error: string | null;
 };
+interface GlitchgrabComment {
+    /** GitHub login. Replies from your users post as the Glitchgrab app, with their name in the body. */
+    author: string;
+    body: string;
+    createdAt: string;
+}
+interface GlitchgrabReportThread {
+    id: string;
+    status: string;
+    rawInput: string | null;
+    createdAt: string;
+    issue: {
+        githubNumber: number;
+        githubUrl: string;
+        title: string;
+        body: string;
+        labels: string[];
+        severity: string | null;
+        /** "open" | "closed", or null when GitHub did not answer. */
+        githubState: string | null;
+    } | null;
+    /** Oldest first. Empty when no issue is linked yet. */
+    comments: GlitchgrabComment[];
+}
+/**
+ * Fetch one report with its GitHub issue and every comment on it — the team's
+ * replies and your user's. Throws on failure; pair it with your own data layer.
+ */
+declare function fetchGlitchgrabReportThread({ token, reportId, }: {
+    token: string;
+    reportId: string;
+}): Promise<GlitchgrabReportThread>;
+/**
+ * Post a reply on the report's GitHub issue. It lands as the Glitchgrab app
+ * with "Commented by: <name>" underneath, so the team knows who said it.
+ * Throws on failure.
+ */
+declare function postGlitchgrabReportComment({ token, reportId, message, reporterName, reporterEmail, }: {
+    token: string;
+    reportId: string;
+    message: string;
+    /** Defaults to the name the report was filed under. */
+    reporterName?: string;
+    reporterEmail?: string;
+}): Promise<GlitchgrabComment>;
+/**
+ * The conversation on one report: where it stands, what the team said, and a
+ * way for your user to reply — without a GitHub account.
+ *
+ * ```tsx
+ * const { report, comments, addComment, isPosting } = useGlitchgrabReportThread({
+ *   token: process.env.NEXT_PUBLIC_GLITCHGRAB_TOKEN!,
+ *   reportId,
+ *   reporterName: session.user.name,
+ * });
+ * ```
+ *
+ * Never throws. `addComment` resolves `true` once the reply is on the issue
+ * (and the thread has reloaded), `false` with `error` set otherwise.
+ */
+declare function useGlitchgrabReportThread({ token, reportId, reporterName, reporterEmail, }: {
+    token: string;
+    /** `reportId` from `useGlitchgrabReports` or the report submit result. Null waits. */
+    reportId: string | null;
+    reporterName?: string;
+    reporterEmail?: string;
+}): {
+    report: GlitchgrabReportThread | null;
+    comments: GlitchgrabComment[];
+    isLoading: boolean;
+    isFetching: boolean;
+    isPosting: boolean;
+    error: string | null;
+    refetch: () => Promise<void>;
+    addComment: (message: string) => Promise<boolean>;
+};
 
 interface FeedbackQuery {
     token: string;
@@ -422,4 +502,4 @@ declare function computeSignature(params: {
 declare function shouldSkipDuplicate(signature: string, windowMs?: number, now?: number): boolean;
 declare function clearDedupCache(): void;
 
-export { BookDemoButton, BookingDialog, Breadcrumb, BreadcrumbType, CaptureErrorOptions, CapturedContext, DeviceInfo, FeedbackButton, FeedbackButtonProps, FeedbackPayload, type FeedbackQuery, FeedbackResult, GLITCHGRAB_SHORTCUT, GLITCHGRAB_SHORTCUT_MAC, GlitchgrabErrorBoundary, GlitchgrabFeedback, GlitchgrabProvider, GlitchgrabProviderProps, type GlitchgrabReport, GlitchgrabSession, LeadInput, LeadResult, ReportButton, ReportButtonProps, ReportPayload, ReportResult, UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, captureError, clearAppContext, clearBreadcrumbs, clearDedupCache, computeSignature, enhanceText, fetchGlitchgrabFeedback, fetchGlitchgrabReports, getAppContext, getBreadcrumbs, getShortcutLabel, initBreadcrumbs, matchesShortcut, sanitizeUrl, sendFeedback, sendLead, sendReport, setContext, setContexts, shouldSkipDuplicate, useGlitchgrab, useGlitchgrabActions, useGlitchgrabFeedback, useGlitchgrabReports };
+export { BookDemoButton, BookedDemo, BookingDialog, Breadcrumb, BreadcrumbType, CaptureErrorOptions, CapturedContext, DeviceInfo, FeedbackButton, FeedbackButtonProps, FeedbackPayload, type FeedbackQuery, FeedbackResult, GLITCHGRAB_SHORTCUT, GLITCHGRAB_SHORTCUT_MAC, type GlitchgrabComment, GlitchgrabErrorBoundary, GlitchgrabFeedback, GlitchgrabProvider, GlitchgrabProviderProps, type GlitchgrabReport, type GlitchgrabReportThread, GlitchgrabSession, LeadInput, LeadResult, ReportButton, ReportButtonProps, ReportPayload, ReportResult, UseGlitchgrabReturn, addBreadcrumb, captureContext, captureDeviceInfo, captureError, clearAppContext, clearBreadcrumbs, clearDedupCache, computeSignature, enhanceText, fetchGlitchgrabFeedback, fetchGlitchgrabReportThread, fetchGlitchgrabReports, getAppContext, getBreadcrumbs, getShortcutLabel, initBreadcrumbs, matchesShortcut, postGlitchgrabReportComment, sanitizeUrl, sendFeedback, sendLead, sendReport, setContext, setContexts, shouldSkipDuplicate, useGlitchgrab, useGlitchgrabActions, useGlitchgrabFeedback, useGlitchgrabReportThread, useGlitchgrabReports };