@capturly/capture-sdk 2.10.2

package/dist/transport.d.ts

@@ -0,0 +1,40 @@
+import { type CaptureAccess } from './types.js';
+export interface UploadTarget {
+    objectName: string;
+    url: string;
+    method: string;
+    /** Covered by the URL signature. Storage rejects a PUT that omits them. */
+    headers: Record<string, string>;
+}
+/** Request an upload target. The size is signed in, so it must be the real
+ *  byte count of what gets uploaded. */
+export declare function requestUpload(args: {
+    baseUrl: string;
+    access: CaptureAccess;
+    sizeBytes: number;
+}): Promise<UploadTarget>;
+/**
+ * Send the bytes. XHR rather than fetch only for `upload.onprogress`; fetch
+ * still has no upload progress in browsers.
+ */
+export declare function uploadBlob(args: {
+    target: UploadTarget;
+    blob: Blob;
+    onProgress?: (fraction: number) => void;
+}): Promise<void>;
+/**
+ * Confirm the upload and record the submission. Idempotent on the object
+ * name, so a retry after a lost response resolves to the same submission.
+ */
+export declare function finalizeSubmission(args: {
+    baseUrl: string;
+    access: CaptureAccess;
+    objectName: string;
+    durationSec: number;
+    displayName?: string | undefined;
+    releaseAccepted: boolean;
+}): Promise<{
+    submissionId: string;
+    submittedAt: string;
+    replaced: boolean;
+}>;

package/dist/types.d.ts

@@ -0,0 +1,76 @@
+/**
+ * The capability this browser records under.
+ *
+ * Not an API key — a secret key grants your whole organization and must stay
+ * on your server. Your backend mints one of these per person from
+ * `POST /v1/capture-requests/{id}/contacts` (the id and `k` from the returned
+ * URL), or uses the request's `openLink.url` for a link anyone can use.
+ */
+export type CaptureAccess = {
+    mode: 'contact';
+    contactId: string;
+    key: string;
+} | {
+    mode: 'open';
+    campaignId: string;
+    key: string;
+};
+export interface CaptureClientOptions {
+    access: CaptureAccess;
+    /** Defaults to the production API. Set it for staging or self-hosted. */
+    baseUrl?: string;
+    /** Non-fatal problems, such as a preview that could not be read. Failures
+     *  that stop something are thrown. */
+    onWarning?: (message: string, cause?: unknown) => void;
+}
+export type CaptureState = 'idle' | 'starting' | 'recording' | 'stopping' | 'stopped';
+export interface CaptureDevice {
+    deviceId: string;
+    label: string;
+    kind: 'audioinput' | 'videoinput';
+}
+export interface PreviewOptions {
+    audioDeviceId?: string;
+    videoDeviceId?: string;
+    /** Skip the camera and record audio only. */
+    audioOnly?: boolean;
+}
+export interface CaptureTake {
+    durationSec: number;
+    /** For local playback before submitting. `discard()` revokes it, or call
+     *  `URL.revokeObjectURL` yourself. */
+    previewUrl: string | null;
+    sizeBytes: number;
+}
+export interface SubmitOptions {
+    /** Required for an open link. Ignored for a contact link, which already has
+     *  the roster name. */
+    displayName?: string;
+    /** Whether the person accepted the request's release text. Read that text
+     *  from the API and show it — this writes a consent record either way. */
+    releaseAccepted: boolean;
+    /** 0–1, as the bytes move. */
+    onProgress?: (fraction: number) => void;
+}
+export interface SubmitResult {
+    submissionId: string;
+    submittedAt: string;
+    /** This take replaced an earlier one from the same person, and the previous
+     *  recording is gone. Key your own records on the request and the person,
+     *  not on a submission id. */
+    replaced: boolean;
+}
+/**
+ * Why something failed.
+ *
+ * `unsupported_browser`, `permission_denied` and `no_devices` are the person's
+ * to fix. `link_expired`, `request_closed` and `quota_exceeded` are yours, so
+ * a retry for those loops forever. `network` and `upload_failed` are worth
+ * retrying as-is.
+ */
+export type CaptureErrorCode = 'unsupported_browser' | 'permission_denied' | 'no_devices' | 'not_recording' | 'nothing_to_submit' | 'link_expired' | 'request_closed' | 'quota_exceeded' | 'upload_failed' | 'network' | 'unknown';
+export declare class CaptureError extends Error {
+    readonly code: CaptureErrorCode;
+    readonly cause?: unknown;
+    constructor(code: CaptureErrorCode, message: string, cause?: unknown);
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@capturly/capture-sdk",
+  "version": "2.10.2",
+  "description": "Record full-quality audio and video on your user's own device, from your own product.",
+  "keywords": [
+    "recording",
+    "video",
+    "capture",
+    "testimonials",
+    "capturly"
+  ],
+  "license": "SEE LICENSE IN LICENSE",
+  "author": {
+    "name": "Corey Alan LLC",
+    "url": "https://capturly.app"
+  },
+  "homepage": "https://capturly.app/platform",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Corey-Alan-Consulting/capturly.app.git",
+    "directory": "packages/capture-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/Corey-Alan-Consulting/capturly.app/issues"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node build.mjs && tsc -p tsconfig.build.json --emitDeclarationOnly",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src --ext .ts",
+    "type-check": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "pnpm clean && pnpm type-check && pnpm test && pnpm build"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@capturly/eslint-config": "workspace:*",
+    "@capturly/recording-engine": "workspace:*",
+    "@capturly/tsconfig": "workspace:*",
+    "esbuild": "^0.25.0",
+    "typescript": "^5.4.0",
+    "vitest": "^4.1.7"
+  }
+}