@crikket-io/capture 0.1.0

package/README.md

@@ -0,0 +1,203 @@
+# @crikket-io/capture
+
+Embeddable capture SDK for collecting bug reports from websites.
+
+## Install
+
+```bash
+npm install @crikket-io/capture
+```
+
+```bash
+bun add @crikket-io/capture
+```
+
+## Quick Start
+
+### 1. Create a public key
+
+In Crikket, go to `Settings` -> `Public Keys`.
+
+Create one public key per owned website or app surface, then add the exact
+origins where the widget is allowed to run, for example:
+
+- `https://example.com`
+- `https://www.example.com`
+- `http://localhost:3000`
+
+Copy the generated public key after saving. Public keys are safe to embed in
+client-side code.
+
+### 2. Initialize the widget on your site
+
+Call `init()` from a browser entrypoint in your app:
+
+```ts
+import { init } from "@crikket-io/capture"
+
+init({
+  key: "crk_your_public_key",
+  host: "https://api.crikket.io",
+})
+```
+
+If you are using Crikket Cloud, `host` defaults to `https://api.crikket.io`.
+If you are self-hosting Crikket, pass your own app origin:
+
+```ts
+import { init } from "@crikket-io/capture"
+
+init({
+  key: "crk_your_public_key",
+  host: "https://crikket.your-company.com",
+})
+```
+
+That mounts the floating launcher and lets users capture a screenshot or screen
+recording, fill out the report form, and submit directly from your site.
+
+## Usage
+
+### `init()` in any browser app
+
+Use `init()` when you want the smallest integration surface. Run it once in a
+browser-only entrypoint.
+
+```ts
+import { init } from "@crikket-io/capture"
+
+init({
+  key: "crk_your_public_key",
+  host: "https://api.crikket.io",
+})
+```
+
+Available options:
+
+- `key`: required public key from Crikket `Settings` -> `Public Keys`
+- `host`: optional Crikket API origin; defaults to `https://api.crikket.io`
+- `autoMount`: mount automatically on init; defaults to `true`
+- `mountTarget`: custom element to mount into; defaults to `document.body`
+- `submitPath`: custom bug report base path; defaults to `/api/embed/bug-reports`
+- `zIndex`: custom widget stacking order
+
+`submitPath` is used as the base path for the capture control-plane flow. By
+default the SDK derives these routes from `/api/embed/bug-reports`:
+
+- `/api/embed/capture-token`
+- `/api/embed/bug-report-upload-session`
+- `/api/embed/bug-report-finalize`
+
+The package also exports runtime controls if you need them:
+
+```ts
+import { close, init, open } from "@crikket-io/capture"
+
+init({
+  key: "crk_your_public_key",
+})
+
+open()
+close()
+```
+
+### Next.js 15.3+ with `instrumentation-client.ts`
+
+For Next.js 15.3 and newer, initialize the SDK once in
+`instrumentation-client.ts` so it runs globally in the browser.
+
+```ts
+import { init } from "@crikket-io/capture"
+
+const capturePublicKey = process.env.NEXT_PUBLIC_CRIKKET_KEY
+
+if (capturePublicKey) {
+  init({
+    key: capturePublicKey,
+    host: process.env.NEXT_PUBLIC_CRIKKET_HOST ?? "https://api.crikket.io",
+  })
+}
+```
+
+Example file:
+
+```ts
+// instrumentation-client.ts
+import { init } from "@crikket-io/capture"
+
+const capturePublicKey = process.env.NEXT_PUBLIC_CRIKKET_KEY
+
+if (capturePublicKey) {
+  init({
+    key: capturePublicKey,
+    host: process.env.NEXT_PUBLIC_CRIKKET_HOST ?? "https://api.crikket.io",
+  })
+}
+```
+
+Recommended environment variables:
+
+```bash
+NEXT_PUBLIC_CRIKKET_KEY=crk_your_public_key
+NEXT_PUBLIC_CRIKKET_HOST=https://api.crikket.io
+```
+
+If you are using Crikket Cloud, you can omit
+`NEXT_PUBLIC_CRIKKET_HOST` and just pass the public key.
+
+### React integration
+
+If you prefer a React-native integration point, use the plugin from
+`@crikket-io/capture/react` and mount it once near your app root.
+
+```tsx
+"use client"
+
+import { CapturePlugin } from "@crikket-io/capture/react"
+
+export function AppProviders(): React.JSX.Element {
+  return (
+    <>
+      <CapturePlugin
+        host="https://api.crikket.io"
+        publicKey="crk_your_public_key"
+      />
+      {/* rest of your app */}
+    </>
+  )
+}
+```
+
+With environment variables:
+
+```tsx
+"use client"
+
+import { CapturePlugin } from "@crikket-io/capture/react"
+
+export function CaptureProvider(): React.JSX.Element | null {
+  const publicKey = process.env.NEXT_PUBLIC_CRIKKET_KEY
+
+  if (!publicKey) {
+    return null
+  }
+
+  return (
+    <CapturePlugin
+      host={process.env.NEXT_PUBLIC_CRIKKET_HOST ?? "https://api.crikket.io"}
+      publicKey={publicKey}
+    />
+  )
+}
+```
+
+`CapturePlugin` accepts the same options as `init()`, except it uses
+`publicKey` instead of `key`.
+
+## Notes
+
+- Public keys should be scoped per website or app surface.
+- Allowed origins should be exact HTTP(S) origins, including local development
+  origins you want to permit.
+- The SDK must run in a browser environment.
+- Browser permission prompts for screen capture are expected platform behavior.

package/dist/browser.d.ts

@@ -0,0 +1,6 @@
+import type { CaptureGlobalApi } from "./types.js";
+declare global {
+    interface Window {
+        CrikketCapture?: CaptureGlobalApi;
+    }
+}

package/dist/browser.js

@@ -0,0 +1 @@
+import{a as e,b as i,c as o,d as r,e as a,f as n,g as p,h as s,i as u,j as l,k as d,l as f,m as c}from"./index.js";import"./index-shtqtrh3.js";import{G as t}from"./index-0avnsp70.js";import"./index-ehy0ec5e.js";import"./index-97c5xshv.js";import"./index-331vjad4.js";var m={close:a,defaultSubmitTransport:t,destroy:n,getConfig:c,init:e,isInitialized:f,mount:i,open:r,reset:d,startRecording:p,stopRecording:s,submit:l,takeScreenshot:u,unmount:o};if(typeof window<"u")window.CrikketCapture=m;

package/dist/capture-screenshot-b3snwyge.js

@@ -0,0 +1 @@
+import{n as c,o as s,p as d,q as h,s as l}from"./index-nd41xgv7.js";import"./index-331vjad4.js";async function m(){let t=await c(!1);s(t);let e=document.createElement("video");try{if(!t.getVideoTracks()[0])throw Error("No video track available for screenshot capture.");await d(e,t);let{videoWidth:a,videoHeight:o}=e;if(!(a>0&&o>0))throw Error("Captured screen dimensions were invalid.");let r=document.createElement("canvas");r.width=a,r.height=o;let i=r.getContext("2d");if(!i)throw Error("Failed to initialize screenshot canvas.");return i.drawImage(e,0,0,a,o),l(r,"image/png")}finally{h(e);for(let n of t.getTracks())n.stop()}}export{m as captureScreenshot};