reflet-sdk 0.1.5 → 0.3.0

package/dist/feedback.d.ts

@@ -0,0 +1,130 @@
+import { c as ElementSelection, u as FeedbackContext, w as RefletUser } from "./types-UKPPJGrA.js";
+//#region src/feedback/types.d.ts
+declare const FEEDBACK_WIDGET_CATEGORIES: readonly ["bug", "idea", "question"];
+type FeedbackWidgetCategory = (typeof FEEDBACK_WIDGET_CATEGORIES)[number];
+declare const ANNOTATION_TOOLS: readonly ["pen", "arrow", "rectangle", "highlight", "blur"];
+type AnnotationTool = (typeof ANNOTATION_TOOLS)[number];
+interface Point {
+  x: number;
+  y: number;
+}
+interface Annotation {
+  color: string;
+  end: Point;
+  id: string;
+  /** Freehand path, in image pixels. Only set for the pen tool. */
+  points?: Point[];
+  start: Point;
+  tool: AnnotationTool;
+}
+interface CapturedImage {
+  blob: Blob;
+  height: number;
+  mimeType: string;
+  /** Object URL owned by the caller — revoke it when the capture is dropped. */
+  objectUrl: string;
+  width: number;
+}
+interface FeedbackWidgetLabels {
+  annotateHint: string;
+  attachScreenshot: string;
+  back: string;
+  cancel: string;
+  categoryBug: string;
+  categoryIdea: string;
+  categoryQuestion: string;
+  clearAnnotations: string;
+  descriptionPlaceholder: string;
+  dismissForDays: string;
+  done: string;
+  emailLabel: string;
+  emailPlaceholder: string;
+  errorGeneric: string;
+  errorTitleRequired: string;
+  pickElement: string;
+  pickElementHint: string;
+  recapture: string;
+  removeScreenshot: string;
+  retakeHint: string;
+  submit: string;
+  successMessage: string;
+  successTitle: string;
+  title: string;
+  titlePlaceholder: string;
+  trigger: string;
+  undo: string;
+}
+interface RefletFeedbackProps {
+  /** API base URL override. Falls back to the RefletProvider value. */
+  baseUrl?: string;
+  /** Record console errors and warnings to attach to bug reports. */
+  captureConsole?: boolean;
+  /** Take a screenshot of the viewport as soon as the panel opens. */
+  captureOnOpen?: boolean;
+  categories?: FeedbackWidgetCategory[];
+  defaultCategory?: FeedbackWidgetCategory;
+  /** Let reporters hide the launcher for this many days. */
+  dismissForDays?: number;
+  /** Render nothing when false — lets an app gate the widget per user. */
+  enabled?: boolean;
+  /** Keyboard shortcut opening the panel. Set to null to disable. */
+  hotkey?: string | null;
+  labels?: Partial<FeedbackWidgetLabels>;
+  /** Extra fields merged into the reported context. */
+  metadata?: Record<string, string>;
+  /** Distance in px from the viewport edges. */
+  offset?: number;
+  onClose?: () => void;
+  onDismiss?: (result: {
+    until: number;
+  }) => void;
+  onOpen?: () => void;
+  onSubmit?: (result: {
+    feedbackId: string;
+  }) => void;
+  position?: "bottom-left" | "bottom-right" | "top-left" | "top-right";
+  primaryColor?: string;
+  publicKey?: string;
+  theme?: "auto" | "dark" | "light";
+  user?: RefletUser;
+  userToken?: string;
+}
+//#endregion
+//#region src/feedback/core/capture.d.ts
+interface CaptureOptions {
+  /** Capture this element instead of the visible viewport. */
+  element?: Element;
+  excludeSelectors?: string[];
+  maxWidth?: number;
+}
+/**
+ * Renders what the user is looking at right now.
+ *
+ * Runs off the DOM rather than `getDisplayMedia` on purpose: a screen-share
+ * permission prompt on every report would cost more reports than it captures.
+ * Returns null instead of throwing — a screenshot is never worth losing the
+ * written feedback.
+ */
+declare function captureViewport(options?: CaptureOptions): Promise<CapturedImage | null>;
+declare function releaseCapture(image: CapturedImage | null | undefined): void;
+//#endregion
+//#region src/feedback/core/element-selector.d.ts
+/** Everything an agent needs to find the picked element back in the codebase. */
+declare function buildElementSelection(element: Element): ElementSelection;
+//#endregion
+//#region src/feedback/core/page-context.d.ts
+/** Everything about the page that a bug report needs and the DOM already knows. */
+declare function collectPageContext(options?: {
+  sdkVersion?: string;
+}): FeedbackContext;
+//#endregion
+//#region src/feedback/widget.d.ts
+/**
+ * Floating feedback button with a screenshot, annotation and element picker
+ * flow. Mount it once, anywhere below `RefletProvider` or with its own
+ * `publicKey`.
+ */
+declare function RefletFeedback(props: RefletFeedbackProps): import("react").JSX.Element | null;
+//#endregion
+export { type Annotation, type AnnotationTool, type CapturedImage, type FeedbackWidgetCategory, type FeedbackWidgetLabels, RefletFeedback, type RefletFeedbackProps, buildElementSelection, captureViewport, collectPageContext, releaseCapture };
+//# sourceMappingURL=feedback.d.ts.map

package/dist/feedback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.d.ts","names":[],"sources":["../src/feedback/types.ts","../src/feedback/core/capture.ts","../src/feedback/core/element-selector.ts","../src/feedback/core/page-context.ts","../src/feedback/widget.tsx"],"mappings":";;cAKM;KAEM,iCACF;cAEJ;KAQM,yBAAyB;UAEpB;EACf;EACA;;UAGe;EACf;EACA,KAAK;EACL;;EAEA,SAAS;EACT,OAAO;EACP,MAAM;;UAGS;EACf,MAAM;EACN;EACA;;EAEA;EACA;;UAGe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;UAiCe;;EAEf;;EAEA;;EAEA;EACA,aAAa;EACb,kBAAkB;;EAElB;;EAEA;;EAEA;EACA,SAAS,QAAQ;;EAEjB,WAAW;;EAEX;EACA;EACA,aAAa;IAAU;;EACvB;EACA,YAAY;IAAU;;EACtB;EACA;EACA;EACA;EACA,OAAO;EACP;;;;UC7He;;EAEf,UAAU;EACV;EACA;;;;;;;;;;iBA6EoB,gBACpB,UAAS,iBACR,QAAQ;iBAqCK,eAAe,OAAO;;;;iBCoGtB,sBAAsB,SAAS,UAAU;;;;iBCxIzC,mBAAmB;EACjC;IACE;;;;;;;;iBCrEY,eAAe,OAAO,sCAAmB,IAAA"}