feedbackkit-web 1.0.37

package/LICENSE

@@ -0,0 +1,73 @@
+Required Notice: Copyright (c) 2024-2026 Tianhao Zhao (https://github.com/tianhaoz95/feedback-kit)
+
+# PolyForm Perimeter License 1.0.1
+
+<https://polyformproject.org/licenses/perimeter/1.0.1>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing to others any product that competes with the software.
+
+## Competition
+
+If you use this software to market a product as a substitute for the functionality or value of the software, it competes with the software. A product may compete regardless how it is designed or deployed. For example, a product may compete even if it provides its functionality via any kind of interface (including services, libraries or plug-ins), even if it is ported to a different platform or programming language, and even if it is provided free of charge.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+A **product** can be a good or service, or a combination of them.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,125 @@
+# feedbackkit-web
+
+In-app feedback for websites: capture what the user is looking at, let them
+mark it up and describe the problem, and get a structured report — plus the
+page URL and the console errors and failed requests that led up to it.
+
+The browser counterpart of [FeedbackKit](https://github.com/tianhaoz95/feedback-kit)'s
+iOS/macOS/watchOS SDK: same flow, same report shape, same optional delivery
+to the FeedbackKit dashboard (where reports become ready-to-paste prompts for
+a coding agent). Framework-agnostic — the UI is plain DOM in a Shadow DOM, so
+it works with React, Vue, Svelte, server-rendered pages, or none of them.
+
+## Install
+
+```bash
+npm install feedbackkit-web
+```
+
+Or with no build step:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/feedbackkit-web/dist/feedbackkit.iife.js"></script>
+<script>
+  FeedbackKit.configure({ projectKey: "pk_..." });
+  FeedbackKit.showFloatingTriggerButton();
+</script>
+```
+
+### From GitHub Packages
+
+Also published as `@tianhaoz95/feedbackkit-web` on the GitHub npm registry
+(which requires a token with `read:packages`, even for public packages):
+
+```ini
+# ~/.npmrc
+@tianhaoz95:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT
+```
+
+```bash
+npm install @tianhaoz95/feedbackkit-web
+```
+
+## Usage
+
+### Keep the report yourself
+
+```ts
+import { FeedbackKit } from "feedbackkit-web";
+
+const report = await FeedbackKit.present(); // null if the user cancels
+if (report) {
+  // report.text, report.screenshotAnnotated (PNG Blob), report.annotations,
+  // report.environment, report.logs … — send it wherever you like.
+}
+```
+
+### Send it to the FeedbackKit dashboard
+
+```ts
+FeedbackKit.configure({
+  projectKey: "pk_...",   // from your project's SDK setup tab
+  // endpoint: "https://<ref>.supabase.co/functions/v1/ingest-feedback", // when self-hosting
+  appVersion: "2.4.0",    // optional
+});
+
+FeedbackKit.showFloatingTriggerButton();   // a "Feedback" pill, bottom-right
+FeedbackKit.enableKeyboardShortcut();      // ⌘⇧F / Ctrl+Shift+F
+// …or from your own button:
+await FeedbackKit.presentAndSubmit();
+```
+
+Configure from client-only code — the SDK uses `window` and `document`. In
+Next.js, call it from a `"use client"` component's `useEffect`.
+
+### Options
+
+| API | What it does |
+|---|---|
+| `FeedbackKit.currentScreen = "Checkout"` | Screen name for reports (set on route changes). Defaults to `location.pathname`. |
+| `FeedbackKit.theme = { primaryColorHex, secondaryColorHex }` | Brand the trigger and dialog. |
+| `FeedbackKit.captureOptions = { mode, maxPixelRatio }` | `mode: "display"` uses the Screen Capture API (pixel-exact, asks every time) instead of DOM rendering. |
+| `configure({ captureLogs })` | Console/network log capture — on by default; pass options (`maxEntries`, `includeVerbose`, `network`) or `false`. |
+| `configure({ products, defaultProductKey })` | The "affected product" chips. Fetched from the dashboard when omitted. |
+| `FeedbackKit.submit(report)` | Send a report you got from `present()`. |
+| `FeedbackKit.captureScreenshot()` | Just the viewport PNG, no UI. |
+| `FeedbackKit.destroy()` | Remove the trigger, dialog host, listeners and log hooks. |
+| `drawAnnotations(ctx, annotations, size)` | The annotation renderer (a port of the Swift `AnnotationRenderer`), for redrawing stored markup. |
+
+## What's captured
+
+- **Screenshot** — the visible viewport at the current scroll position, including
+  sticky/fixed elements, rendered from the DOM (no permission prompt). The
+  user can turn it off per report. Cross-origin iframes, images without CORS
+  headers and WebGL canvases without `preserveDrawingBuffer` render blank —
+  use `mode: "display"` if that matters.
+- **Annotations** — freehand, rectangle, arrow and text, movable, resizable
+  (scroll / pinch) and rotatable (Shift+scroll / twist), stored as normalized
+  `[x, y]` points exactly like the native SDKs'.
+- **Environment** — OS, browser, viewport, pixel ratio, locale, page URL (with
+  sensitive query parameters redacted), your app version, screen name.
+- **Logs** — recent `console.warn`/`console.error`, uncaught errors, unhandled
+  rejections, and failed or 4xx/5xx fetch/XHR requests (method, URL, status —
+  never bodies). Tokens and secrets are redacted, and the user can untick logs
+  for any report.
+
+The project key only allows *creating* feedback. Since it's visible in your
+page source, restrict it to your own sites in the dashboard under
+**Settings → Allowed web origins**.
+
+## Development
+
+This package lives in the FeedbackKit monorepo at `web-sdk/`; the dashboard
+(`web/`) dogfoods it straight from source.
+
+```bash
+npm install
+npm test            # unit tests (vitest)
+npm run build       # dist/feedbackkit.js (ESM) + dist/feedbackkit.iife.js + types
+npm run test:e2e    # full flow in real Chromium, Firefox and WebKit (Playwright)
+```
+
+## License
+
+See [LICENSE](./LICENSE).