@rose42/t3-feedback 0.1.0

package/dist/client/mount.d.ts

@@ -0,0 +1,210 @@
+import { type FeedbackCapturePlugin, type FeedbackTransport, type ResolveElementSource } from "@rose42/feedback-capture";
+import { type T3BuiltinPluginId, type T3FeedbackBuiltinPluginOptions, type T3FeedbackClientConfig, type T3FeedbackFabOptions, type T3FeedbackPickOptions, type T3FeedbackRecordOptions, type T3FeedbackReportTypeGlyph, type T3FeedbackScreenshotOptions, type T3FeedbackShortcutOptions, type T3FeedbackThreadReuse } from "../types.js";
+import { buildReportTypeHint, gatePluginByReportType, pageContextForReportType, pluginAppliesToReportType, type FeedbackReportType } from "./reportType.js";
+import { type FeedbackCapturePluginWithUi } from "./ui/slots.js";
+export type { FeedbackReportType };
+export type { FeedbackDraft } from "./draft.js";
+export { buildReportTypeHint, gatePluginByReportType, pageContextForReportType, pluginAppliesToReportType, };
+export { readFeedbackDraft } from "./draft.js";
+export type T3FeedbackMountCopy = {
+    fabTitle: string;
+    fabAriaLabel: string;
+    panelTitle: string;
+    commentPlaceholder: string;
+    captureLabel: string;
+    pickLabel: string;
+    clearPickLabel: string;
+    /** Tooltip on a resolved component file path (open in IDE). */
+    openInEditorLabel: string;
+    clearScreenshotLabel: string;
+    recordLabel: string;
+    stopRecordLabel: string;
+    recordingStatus: string;
+    recordFailedStatus: string;
+    burstAttachedStatus: string;
+    galleryFullStatus: string;
+    /** Tooltip when Capture is disabled because the image limit is reached. */
+    galleryFullTooltip: string;
+    pickBurstHint: string;
+    pickBurstConfirmLabel: string;
+    removeImageLabel: string;
+    /** Discard the screenshot from the crop dialog (same X as thumb remove). */
+    discardScreenshotLabel: string;
+    pickingStatus: string;
+    pickCancelledStatus: string;
+    cancelLabel: string;
+    /** Tooltip on the panel × — clarifies discard vs Esc / outside. */
+    cancelTitle: string;
+    sendLabel: string;
+    capturingStatus: string;
+    captureFailedStatus: string;
+    screenshotAttachedStatus: string;
+    pastedAttachedStatus: string;
+    commentRequiredStatus: string;
+    sendingStatus: string;
+    sentStatus: string;
+    openInT3Label: string;
+    /** Toast title after a successful send. */
+    toastSentLabel: string;
+    /** Activity popover heading. */
+    activityTitle: string;
+    activityEmptyLabel: string;
+    activityNewLabel: string;
+    activityOpenLabel: string;
+    activityContinueLabel: string;
+    activitySettleLabel: string;
+    activityDismissLabel: string;
+    activityClearLabel: string;
+    activityFabTitle: string;
+    activityFabAriaLabel: string;
+    cropHint: string;
+    cropHintSeeded: string;
+    cropLabel: string;
+    useFullLabel: string;
+    changeRegionLabel: string;
+    /** Short visible label on the clipboard-insert button. */
+    insertClipboardLabel: string;
+    /** Full tooltip / accessible name for clipboard insert. */
+    insertClipboardTitle: string;
+    dismissClipboardLabel: string;
+    autoCapturingStatus: string;
+    autoCroppedStatus: string;
+    autoCapturedStatus: string;
+    /** Label for the include-innerHTML checkbox. */
+    includeInnerHTMLLabel: string;
+    /** Label prefix for the styles select. */
+    stylesLabel: string;
+    stylesNoneLabel: string;
+    stylesLayoutLabel: string;
+    stylesComputedLabel: string;
+    /** Section label above the picked-element card. */
+    elementSectionLabel: string;
+    /** Section label above the screenshot card. */
+    screenshotSectionLabel: string;
+    reportTypeBugLabel: string;
+    reportTypeFeedbackLabel: string;
+    reportTypeSuggestionLabel: string;
+    /**
+     * Optional hint overrides. When omitted, hints are derived from active
+     * plugins + report-type field filtering ({@link buildReportTypeHint}).
+     */
+    reportTypeBugHint?: string;
+    reportTypeFeedbackHint?: string;
+    reportTypeSuggestionHint?: string;
+    /** Emoji used when `reportTypeGlyph` is `"emoji"` (ignored when a custom map is set). */
+    reportTypeBugEmoji: string;
+    reportTypeFeedbackEmoji: string;
+    reportTypeSuggestionEmoji: string;
+    /** Section label / aria for New vs Continue. */
+    threadDestinationLabel: string;
+    threadNewLabel: string;
+    /** Accessible name prefix for the Continue control (icon + title). */
+    threadContinueLabel: string;
+    /** Visible + accessible label when the prior thread has no title. */
+    threadContinueUntitledLabel: string;
+    /** Opens the searchable continue-thread picker. */
+    threadPickLabel: string;
+    /** Search field placeholder in the thread picker. */
+    threadSearchPlaceholder: string;
+    /** Empty state when the search matches nothing. */
+    threadSearchEmptyLabel: string;
+    /** Status chip when a listed thread is still open / working. */
+    threadStateWorkingLabel: string;
+    /** Status chip when a listed thread is settled. */
+    threadStateSettledLabel: string;
+    /**
+     * Footer under truncated results. `{shown}` / `{total}` are replaced.
+     * Example: "Showing 48 of 46".
+     */
+    threadSearchTruncatedLabel: string;
+};
+export type MountT3FeedbackOptions = {
+    /** POST path for the Vite middleware (default: /__t3-feedback). */
+    endpoint?: string;
+    /** Override transport (default: wrapped HTTP POST supporting session-route reuse). */
+    transport?: FeedbackTransport;
+    /** DOM id for the mount root (default: t3-feedback-root). */
+    rootId?: string;
+    /**
+     * Full keyboard chord (key + modifiers). Default when omitted: Ctrl/⌘+Shift+F.
+     * When set, omitted modifiers are false — e.g. `{ key: "f" }` is bare F.
+     * Bare keys are ignored while focus is in an editable field; Ctrl/⌘+Shift+key
+     * still opens as a global override. Escape still closes.
+     */
+    shortcut?: T3FeedbackShortcutOptions;
+    /**
+     * @deprecated Use `shortcut: { key }` instead. Letter only; modifiers stay Ctrl/⌘+Shift.
+     */
+    shortcutKey?: string;
+    /** Floating ✎ button visibility, position, and size (default: mobile-only). */
+    fab?: T3FeedbackFabOptions;
+    /** Element pick shortcut + after-pick capture/crop behavior. */
+    pick?: T3FeedbackPickOptions & {
+        /**
+         * Custom DOM → source resolver (programmatic mount only).
+         * Wins over `pick.sourceFramework`. Not available via the Vite plugin JSON config.
+         */
+        resolveSource?: ResolveElementSource;
+    };
+    /** Capture / Change-region crop behavior. */
+    screenshot?: T3FeedbackScreenshotOptions;
+    /** Frame-burst record shortcut. */
+    record?: T3FeedbackRecordOptions;
+    /**
+     * Thread reuse across sends. Default: `"ask"`.
+     * With the default HTTP transport, `"ask"` / `"session-route"` persist a
+     * per-pathname thread id; `"never"` always creates. Custom `transport`
+     * still shows the ask UI when a prior record exists, but must handle reuse
+     * itself if it needs the thread id on the wire.
+     */
+    threadReuse?: T3FeedbackThreadReuse;
+    /**
+     * Report-type glyphs in the overlay and on new thread titles: SVG `"icon"`
+     * (default), `"emoji"`, or a custom map (`{ Bug: "🐛", Feedback: "💬", Suggestion: "💡" }`).
+     * `"emoji"` / map replace `Bug` / `Feedback` / `Suggestion` in new chat names.
+     */
+    reportTypeGlyph?: T3FeedbackReportTypeGlyph;
+    /** Optional UI string overrides. */
+    copy?: Partial<T3FeedbackMountCopy>;
+    /**
+     * Extra capture plugins (setup via session on mount, collect on send).
+     * Built-ins are selected via {@link MountT3FeedbackOptions.activePlugins}.
+     * Comment, reportType, and screenshot (when active) collect from their panel
+     * plugins on `session.build()` — no submit-time extra plugins.
+     */
+    plugins?: FeedbackCapturePluginWithUi[];
+    /**
+     * Which built-in plugins to enable. Omit = all four.
+     * See {@link T3BuiltinPluginId}.
+     */
+    activePlugins?: T3BuiltinPluginId[];
+    /** Options for selected built-ins (e.g. console ring size). */
+    pluginOptions?: T3FeedbackBuiltinPluginOptions;
+    /**
+     * @deprecated Prefer `activePlugins` without `"consoleLogs"`.
+     * When `false`, strips `consoleLogs` from the resolved set.
+     */
+    includeConsoleLogs?: boolean;
+    /**
+     * App version for `envelope.version`. When set, installs the version
+     * plugin; in DEV also tracks HMR generation (`#n`).
+     */
+    version?: string;
+};
+/** Imperative controls returned from {@link mountT3Feedback}. */
+export type T3FeedbackHandle = {
+    open: () => void;
+    close: () => void;
+    /** Start element picking (opens the panel afterward). */
+    pick: () => void;
+    /** Start Capture screenshot (opens the panel afterward). */
+    capture: () => void;
+    /** Start frame-burst recording (opens the panel afterward). */
+    record: () => void;
+    unmount: () => void;
+};
+export { buildOpenInEditorUrl, buildTargetChipHtml, componentHierarchy, formatComponentLocation, formatElementChip, formatSelectorBreadcrumb, openSourceInEditor, selectorAtAncestorDepth, splitCssSelectorParts, } from "./ui/elementTargetChip.js";
+/** Mount the floating feedback control and keyboard shortcut; returns a handle. */
+export declare function mountT3Feedback(options?: MountT3FeedbackOptions): T3FeedbackHandle;
+/** Convenience for the injected virtual module (config + optional custom plugins). */
+export declare function mountT3FeedbackFromConfig(config: T3FeedbackClientConfig, customPlugins?: FeedbackCapturePlugin[]): T3FeedbackHandle;