@fixback/sdk 0.3.0 → 0.5.0

package/dist/screenshot.d.ts

@@ -1,73 +0,0 @@
-/**
- * Client-side masked screenshot capture (spec MVP §E; ticket #54; ADR-0014).
- *
- * The capture is **private-by-default**: input values are masked and the SDK's own
- * UI is excluded from a *clone* of the view **before** anything is rasterised, so no
- * unmasked text and none of Fixback's chrome ever reaches the image.
- *
- * The rasterisation itself is delegated to `modern-screenshot` (ADR-0014): it clones
- * the target, inlines the page's real styles **and** its fonts and images as data
- * URIs, then draws the result through an SVG `<foreignObject>` onto a `<canvas>`.
- * That closes the fidelity gap a hand-rolled `<foreignObject>` left open — external
- * stylesheets, web fonts, and same-origin images now render — so the shot matches
- * what the Reporter saw and lines up with the annotation's viewport-space marks.
- *
- * We keep the privacy guarantee by driving it through two of its hooks: `filter`
- * drops Fixback's own host elements, and `onCloneNode` masks the clone's inputs —
- * both run on the library's internal clone, before it embeds or serialises anything,
- * so the live page is never touched and no real value reaches the raster. The backend
- * is injectable so the pipeline (and the masking-before-capture guarantee) is testable
- * without a real canvas, and it fails quietly: any problem resolves to `null` and the
- * report is simply sent without a screenshot.
- */
-/** The character private input content is replaced with. */
-export declare const MASK_CHAR = "\u2022";
-/**
- * Mask the private, user-entered content in a subtree: text `input` values,
- * `textarea` content, and `contenteditable` text. Developer-authored text
- * (placeholders, button labels, non-text controls) is left untouched. Operates in
- * place — call it on a *clone* of the view, never the live page.
- */
-export declare function maskInputs(root: ParentNode): void;
-/** A captured screenshot: the image bytes plus its dimensions and content type. */
-export interface Capture {
-    readonly blob: Blob;
-    readonly width: number;
-    readonly height: number;
-    readonly type: string;
-}
-/** The screenshot filename extension for a {@link Capture}'s content type (defaults to `png`). */
-export declare function extensionFor(type: string): string;
-/** How the SDK prepares a capture: exclude Fixback's UI, mask the clone's inputs. */
-interface CaptureHooks {
-    /** Keep a node in the shot? Returns `false` for Fixback's own host elements. */
-    readonly filter: (node: Node) => boolean;
-    /** Mask private input content on the library's internal clone, pre-raster. */
-    readonly onCloneNode: (clone: Node) => void;
-}
-/** Turns a DOM subtree into image bytes at a given size (injectable for tests). */
-export type CaptureBackend = (target: Element, meta: {
-    width: number;
-    height: number;
-    type: string;
-} & CaptureHooks) => Promise<Blob | null>;
-/** Options for {@link captureView}. */
-export interface CaptureOptions {
-    /** The element to capture. Defaults to the document element (the full view). */
-    readonly target?: Element;
-    readonly doc?: Document;
-    readonly win?: Window;
-    /** Output content type. Defaults to `image/png`. */
-    readonly type?: string;
-    /** Override the raster backend (the default is `modern-screenshot`). */
-    readonly capture?: CaptureBackend;
-}
-/**
- * Capture the current view as a masked screenshot. Delegates the raster to the
- * backend ({@link captureViaModernScreenshot} by default), which excludes the SDK's
- * own UI and masks input values on its internal clone — **before** it embeds or
- * serialises anything — then returns the image bytes, or `null` if capture wasn't
- * possible.
- */
-export declare function captureView(options?: CaptureOptions): Promise<Capture | null>;
-export {};

package/dist/scrub.d.ts

@@ -1,61 +0,0 @@
-/**
- * The single client-side **scrub choke point** every report passes through
- * before transport (spec 0003 §C; research `sentry-error-capture-findings.md`
- * §7.4) — the SDK's `beforeSend` equivalent.
- *
- * Masking is the SDK's job, done in the browser before anything leaves the page.
- * The screenshot is masked at capture, and breadcrumbs never record a value or a
- * body at the source; `runBeforeSend` is the **last** gate over the assembled
- * report. Its default scrubbers are **on**: they strip credentials, query
- * strings, and bearer tokens from URLs, and redact obvious PII (emails, long
- * digit runs, bearer tokens) from crumb and error text. The result is then handed
- * to an optional per-project hook that can mutate it further or drop the whole
- * report by returning `null`.
- *
- * The hook is **synchronous and network-free** by contract, and both manual
- * (overlay) and automatic (error-capture) reports run through the very same
- * choke point. A project relaxes the defaults with `scrub: false`, or reshapes
- * the draft in its own hook — never a silent raw send.
- */
-import type { ReportContent } from "./report";
-/** The per-project client scrub hook. Return `null` to drop the whole report. */
-export type BeforeSend = (draft: ReportContent) => ReportContent | null;
-/** Options for {@link runBeforeSend}. */
-export interface BeforeSendOptions {
-    /** The per-project hook, run **after** the default scrubbers. */
-    readonly hook?: BeforeSend | null;
-    /** Run the built-in default scrubbers first. Defaults to `true`. */
-    readonly scrub?: boolean;
-}
-/**
- * Redact obvious PII from free text: email addresses, `Bearer <token>` /
- * `token <value>` pairs, and long digit runs. Conservative by design — it keeps
- * the shape of the message readable while removing the sensitive spans.
- */
-export declare function redactPii(text: string): string;
-/**
- * Strip the sensitive parts of a URL: userinfo credentials
- * (`scheme://user:pass@host`), the entire query string, a token-bearing
- * fragment (one that carries `key=value`), and PII (emails, long digit runs) in
- * the **path segments** (#139). Plain hash routes (`#/checkout`) are kept. Works
- * on absolute and relative URLs alike, with no dependency and no throw. The host
- * (authority) is never redacted — only the path and any surviving fragment route.
- */
-export declare function scrubUrl(url: string): string;
-/**
- * Apply the built-in default scrubbers to a report draft: strip the page URL,
- * and scrub every crumb's URLs and redact PII from its text. The Reporter's own
- * `comment` is intentionally left untouched — it is authored on purpose, not
- * scraped. The screenshot and input values are masked elsewhere (at capture and
- * at crumb creation); this is the final URL/PII sweep.
- */
-export declare function applyDefaultScrub(draft: ReportContent): ReportContent;
-/**
- * Run the report draft through the client scrub choke point: the default
- * scrubbers first (unless `scrub` is `false`), then the optional per-project
- * hook. Returns the scrubbed (and possibly hook-mutated) draft, or `null` when
- * the hook drops the report. A hook that throws is treated as a no-op — the
- * already-scrubbed draft is kept, so a buggy hook never breaks the report path
- * nor leaks unscrubbed data.
- */
-export declare function runBeforeSend(draft: ReportContent, options?: BeforeSendOptions): ReportContent | null;