@tekma/sdk
v0.1.0
Published
Consented browser recording for your website
Readme
Tekma SDK
Install once in your website, regardless of framework or coding agent:
npm install @tekma/sdkimport { install } from "@tekma/sdk";
const recorder = install({
workspaceId: "YOUR_WORKSPACE_ID",
domainId: "YOUR_VERIFIED_DOMAIN_ID",
});
// When your application unmounts:
// recorder.stop();Call install in the browser after mount (for React, inside an effect that returns
recorder.stop). Imports are safe during server rendering. Get the workspace and
domain IDs from Tekma's recording-domain settings after verifying your website.
These IDs are public configuration; never put account tokens in the SDK.
Installation is passive. Recording controls appear only after a trusted Tekma handoff, and recording and submission require the guest's consent. Connected recording requires a supported desktop Chrome/Edge browser and self-tab capture. Automatic sensitive-element masking, preview and explicit submission remain active.
Optional metadata provides synchronous JSON-safe recording context. Optional
blurSelectors accepts a CSS selector, an array or a synchronous callback.
For self-hosting, pass verifierOrigin and apiOrigin explicitly. Defaults are
https://tekma.dev and https://api.tekma.dev.
The SDK includes ESM, CommonJS and TypeScript declarations with bundled dependencies.
A script-tag installation remains available at https://tekma.dev/sdk/recorder-v1.js.
Proprietary software. No open-source license is granted.
