@offscript/sdk 0.1.0 → 0.1.2

package/dist/types/config.d.ts

@@ -55,6 +55,11 @@ export interface PrivacyConfig {
     redactHeaders: string[];
     /** Chaves adicionais (query/body/json) a redigir. */
     redactKeys: string[];
+    /**
+     * Guarda os valores sensíveis por completo: senha, token, cookie, CPF, cartão.
+     * Padrão: false. Quando true, nada vira [REDACTED].
+     */
+    captureSensitiveValues: boolean;
     /** Tamanho máximo (bytes) de cada body capturado. */
     maxBodyBytes: number;
     /** Content-types capturáveis como texto. */
@@ -96,6 +101,11 @@ export interface OffscriptConfig {
     /** Prefixo de chaves de storage. */
     storagePrefix?: string;
     debug?: boolean;
+    /**
+     * Mostra a barra de pausar, retomar, retornar, finalizar e nova sessão durante a gravação.
+     * Padrão: true. O overlay não entra no filme nem nas ações.
+     */
+    controls?: boolean;
 }
 export interface ResolvedConfig {
     apiUrl: string;
@@ -109,6 +119,7 @@ export interface ResolvedConfig {
     heartbeatIntervalMs: number;
     storagePrefix: string;
     debug: boolean;
+    controls: boolean;
 }
 export declare const DEFAULT_RECORDING: RecordingConfig;
 export declare const DEFAULT_PRIVACY: PrivacyConfig;

package/dist/types/events.d.ts

@@ -163,6 +163,8 @@ export interface ContextEventData {
     executionId: string;
     sdkVersion: string;
     appVersion?: string;
+    /** A gravação guardou senhas, tokens e demais valores sem máscara. */
+    captureSensitiveValues?: boolean;
 }
 export interface IframeEventData {
     phase: "present" | "removed" | "focus" | "blur" | "resized";

package/dist/types/session.d.ts

@@ -2,8 +2,8 @@ export type RecordingStatus = "idle" | "initializing" | "recording" | "paused" |
 export interface StartRecordingOptions {
     testCaseId: string;
     executionId: string;
-    /** Token de curta duração emitido pelo backend da Offscript. */
-    sessionToken: string;
+    /** Token de curta duração emitido pelo backend da Offscript. Quando omitido, é lido de `?offscript_token=`. */
+    sessionToken?: string;
 }
 /** Estado persistido em sessionStorage (escopo: aba). */
 export interface PersistedSessionState {

package/dist/ui/RecordingControls.d.ts

@@ -0,0 +1,60 @@
+import type { OffscriptState, RecordingStatus, SessionInfo, StopSummary } from "../types/session";
+/**
+ * Alvo mínimo para o overlay não importar a classe do SDK.
+ */
+export interface RecordingControlTarget {
+    getState(): OffscriptState;
+    on(type: "statusChange", fn: (payload: {
+        from: RecordingStatus;
+        to: RecordingStatus;
+    }) => void): () => void;
+    pauseRecording(): Promise<void>;
+    resumeRecording(): Promise<void>;
+    stopRecording(): Promise<StopSummary>;
+    startArmedRecording(): Promise<SessionInfo>;
+    startNewSession(): Promise<void>;
+    capturesSensitiveValues(): boolean;
+}
+/**
+ * Controles da gravação. Fechado, só a marca; aberto, a logo e os ícones.
+ * O host fica com tamanho zero e a interface mora num shadow fechado.
+ */
+export declare class RecordingControls {
+    private readonly sdk;
+    private host?;
+    private shadow?;
+    private note?;
+    private observer?;
+    private dockWatch?;
+    private unsubscribe?;
+    private eyeTimer;
+    private placeFrame;
+    private eyeIndex;
+    private busy;
+    private expanded;
+    private privacyOpen;
+    private failure;
+    private readonly onVisibility;
+    private readonly onViewport;
+    constructor(sdk: RecordingControlTarget);
+    mount(): void;
+    unmount(): void;
+    private place;
+    private watchDom;
+    private watchDock;
+    private bind;
+    private openConfirm;
+    private placeConfirm;
+    private closeConfirm;
+    private run;
+    private render;
+    private paintPrivacy;
+    private schedulePlacePrivacy;
+    private clearPrivacyPlace;
+    private placePrivacy;
+    private setEnabled;
+    private setHidden;
+    private startEyes;
+    private scheduleEye;
+    private applyPose;
+}

package/docs/api-contract.md

@@ -1,6 +1,6 @@
 # Contrato da API Offscript (SDK ↔ backend)
 
-Todos os endpoints exigem `Authorization: Bearer <sessionToken>` (token de curta duração, escopo: plataforma + execução + sessão). Respostas em JSON. CORS: o backend deve permitir os headers `Authorization, Content-Type, Content-Encoding, Idempotency-Key, X-Offscript-Sdk` (um `*` **não** cobre `Authorization`).
+Todos os endpoints exigem `Authorization: Bearer <sessionToken>` (token de curta duração, escopo: plataforma + execução + sessão). A aplicação pode entregar esse token ao SDK em `?offscript_token=` na URL inicial; o SDK o captura, remove o parâmetro da barra de endereço e o reutiliza em todas as chamadas, inclusive `/complete`. Respostas em JSON. CORS: o backend deve permitir os headers `Authorization, Content-Type, Content-Encoding, Idempotency-Key, X-Offscript-Sdk` (um `*` **não** cobre `Authorization`).
 
 | Método | Caminho | Finalidade |
 |---|---|---|

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@offscript/sdk",
-  "version": "0.1.0",
-  "description": "Offscript SDK - grava\u00e7\u00e3o de sess\u00f5es de teste QA (rrweb, a\u00e7\u00f5es, rede, erros)",
-  "license": "UNLICENSED",
+  "version": "0.1.2",
+  "description": "Offscript SDK - gravação de sessões de teste QA (rrweb, ações, rede, erros)",
+  "license": "MIT",
   "type": "module",
   "sideEffects": false,
   "main": "./dist/index.cjs",
@@ -36,6 +36,7 @@
     }
   },
   "files": [
+    "LICENSE",
     "dist",
     "README.md",
     "docs"
@@ -78,4 +79,4 @@
     "url": "https://github.com/soffact/offscript-sdk/issues"
   },
   "homepage": "https://github.com/soffact/offscript-sdk#readme"
-}
+}