interview-widget 1.0.3 → 1.0.4

package/README.md

@@ -17,7 +17,34 @@ A modern React interview experience widget with built‑in timer flow, STT (spee
 
 ## Quick Start
 
-### 1) Install (React apps)
+### 1) Environment Setup
+
+The Interview Widget uses encryption for session storage integrity. Set up your encryption secret based on your environment:
+
+#### Vite React
+
+```env
+# .env
+VITE_IW_SECRET=your-secure-encryption-seed-here
+```
+
+#### Next.js
+
+```env
+# .env.local
+NEXT_PUBLIC_IW_SECRET=your-secure-encryption-seed-here
+```
+
+#### Vanilla JS / Custom Framework
+
+```html
+<script>
+  // Define the secret before loading your widget
+  window.__IW_SECRET__ = "your-secure-encryption-seed-here";
+</script>
+```
+
+### 2) Install (React apps)
 
 ```bash
 npm install interview-widget

package/dist/utils/constants.d.ts

@@ -1,2 +1,9 @@
 import { InterviewWidgetConfig } from '../types';
 export declare const defaultConfig: Required<InterviewWidgetConfig>;
+export declare const STORAGE_KEY = "iw-storage";
+/**
+ * Get encryption seed from various sources depending on the environment
+ * Works with: Vite React, Next.js, Vanilla JS
+ */
+export declare function getEncryptionSeed(): string;
+export declare const ENCRYPTION_SEED: string;

package/dist/utils/crypto.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Encrypt data with AES-GCM
+ * @param data - The data to encrypt (will be JSON stringified if not a string)
+ * @param seed - A seed string to derive the encryption key (e.g., session ID, user ID)
+ * @returns Base64 encoded encrypted data (IV + ciphertext + tag)
+ */
+export declare function encrypt(data: unknown, seed?: string): Promise<string>;
+/**
+ * Encrypt and serialize data for storage
+ * @param data - Data to encrypt
+ * @param seed - Seed for key derivation
+ * @returns Promise resolving to encrypted base64 string
+ */
+export declare function encryptForStorage(data: unknown, seed?: string): Promise<string>;
+/**
+ * Decrypt and parse stored data
+ * @param encryptedData - Encrypted base64 string from storage
+ * @param seed - Seed for key derivation
+ * @returns Promise resolving to decrypted data (parsed as JSON if possible)
+ */
+export declare function decryptFromStorage<T = unknown>(encryptedData: string, seed?: string): Promise<T>;