@sailfish-ai/recorder 1.0.0-alpha-1

package/dist/types/eventCache.d.ts

@@ -0,0 +1,4 @@
+import ReconnectingWebSocket from "reconnecting-websocket";
+export declare function cacheEvents(event: any): void;
+export declare function sendCachedEvents(webSocket: ReconnectingWebSocket): void;
+export declare function sendRecordingEvents(webSocket: ReconnectingWebSocket, sessionId: string): void;

package/dist/types/graphql.d.ts

@@ -0,0 +1,4 @@
+import { CaptureSettingsResponse, GraphQLResponse, StartSessionResponse } from "./types";
+export declare function sendGraphQLRequest<T>(operationName: string, query: string, variables: object): Promise<GraphQLResponse<T>>;
+export declare function fetchCaptureSettings(apiKey: string, backendApi: string): Promise<GraphQLResponse<CaptureSettingsResponse>>;
+export declare function startRecordingSession(apiKey: string, recordingId: string, backendApi: string): Promise<GraphQLResponse<StartSessionResponse>>;

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+import { LogRecordOptions } from "@sailfish-rrweb/rrweb-plugin-console-record";
+import { NetworkRecordOptions } from "@sailfish-rrweb/rrweb-plugin-network-record";
+import { CaptureSettings } from "./types";
+export declare const DEFAULT_DOMAINS_TO_IGNORE: string[];
+export declare const DEFAULT_CAPTURE_SETTINGS: CaptureSettings;
+export declare const DEFAULT_CONSOLE_RECORDING_SETTINGS: LogRecordOptions;
+export declare const DEFAULT_NETWORK_CAPTURE_SETTINGS: NetworkRecordOptions;
+export declare function startRecording({ apiKey, backendApi, }: {
+    apiKey: string;
+    backendApi: string;
+}): Promise<void>;
+export * from "./eventCache";
+export * from "./graphql";
+export * from "./recording";
+export * from "./types";
+export * from "./websocket";

package/dist/types/recording.d.ts

@@ -0,0 +1,4 @@
+import { LogRecordOptions } from "@sailfish-rrweb/rrweb-plugin-console-record";
+import { NetworkRecordOptions } from "@sailfish-rrweb/rrweb-plugin-network-record";
+export declare function initializeRecording(captureSettings: any, // TODO - Sibyl launch - replace type
+consoleRecordSettings: LogRecordOptions, networkRecordSettings: NetworkRecordOptions, backendApi: string, apiKey: string, sessionId: string): Promise<void>;

package/dist/types/types.d.ts

@@ -0,0 +1,53 @@
+export interface CaptureSettings {
+    recordCanvas: boolean;
+    recordCrossOriginIframes: boolean;
+    collectFonts: boolean;
+    inlineImages: boolean;
+    recordPassword: boolean;
+    recordRealName: boolean;
+    recordCreditCardInfo: boolean;
+    recordSsn: boolean;
+    recordDob: boolean;
+    sampling: object;
+}
+export interface ConsoleRecordSettings {
+    level: string[];
+    lengthThreshold: number;
+    stringifyOptions: {
+        stringLengthLimit: number;
+        numOfKeysLimit: number;
+        depthOfLimit: number;
+    };
+    logger: Console;
+}
+export interface NetworkRecordSettings {
+    initiatorTypes: string[];
+    ignoreRequestFn: (request: Request) => boolean;
+    recordHeaders: boolean;
+    ignoreHeaders: {
+        request: string[];
+        response: string[];
+    };
+    ignoreBodyParts: {
+        request: string[];
+        response: string[];
+    };
+    recordBody: boolean;
+    recordInitialRequests: boolean;
+}
+export interface StartRecordingOptions {
+    apiKey: string;
+    backendApi: string;
+}
+export interface GraphQLResponse<T> {
+    data?: T;
+    errors?: any;
+}
+export interface CaptureSettingsResponse {
+    captureSettingsFromApiKey: CaptureSettings;
+}
+export interface StartSessionResponse {
+    startRecordingSession: {
+        id: string;
+    };
+}

package/dist/types/websocket.d.ts

@@ -0,0 +1,2 @@
+import ReconnectingWebSocket from "reconnecting-websocket";
+export declare function initializeWebSocket(backendApi: string, apiKey: string, sessionId: string): ReconnectingWebSocket;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/websocket.js

@@ -0,0 +1,33 @@
+import ReconnectingWebSocket from "reconnecting-websocket";
+import { sendCachedEvents } from "./eventCache";
+export function initializeWebSocket(backendApi, apiKey, sessionId) {
+    const wsHost = getWebSocketHost(backendApi);
+    const wsScheme = window.location.protocol === "https:" ? "wss" : "ws";
+    const wsUrl = `${wsScheme}://${wsHost}/ws/notify/?apiKey=${apiKey}&sessionId=${sessionId}`;
+    const options = {
+        connectionTimeout: 5000,
+        maxRetries: 10,
+    };
+    const webSocket = new ReconnectingWebSocket(wsUrl, [], options);
+    webSocket.addEventListener("open", () => {
+        sendCachedEvents(webSocket);
+    });
+    webSocket.addEventListener("close", (event) => {
+        console.log("WebSocket closed:", event);
+        if (event.wasClean) {
+            console.log(`Closed cleanly, code=${event.code}, reason=${event.reason}`);
+        }
+        else {
+            console.log("Connection died");
+        }
+    });
+    webSocket.addEventListener("error", (error) => {
+        console.error("WebSocket error:", error);
+    });
+    return webSocket;
+}
+function getWebSocketHost(url) {
+    const parser = document.createElement("a");
+    parser.href = url;
+    return `${parser.hostname}${parser.port ? `:${parser.port}` : ""}`;
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@sailfish-ai/recorder",
+  "version": "1.0.0-alpha-1",
+  "publishPublicly": true,
+  "main": "dist/sailfish-recorder.umd.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && tsc --project tsconfig.json",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "check-types": "tsc --noEmit",
+    "prepublish": "npm run check-types && npm run build",
+    "artifactregistry-login": "npx google-artifactregistry-auth"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@sailfish-rrweb/record": "^0.1.1-sailfish",
+    "@sailfish-rrweb/rrweb": "^0.1.1-sailfish",
+    "@sailfish-rrweb/rrweb-plugin-console-record": "^0.1.1-sailfish",
+    "@sailfish-rrweb/rrweb-plugin-network-record": "^0.1.1-sailfish",
+    "@sailfish-rrweb/rrweb-snapshot": "^0.1.1-sailfish",
+    "@sailfish-rrweb/types": "^0.1.1-sailfish",
+    "@vitejs/plugin-react": "^4.3.1",
+    "@vitejs/plugin-vue": "^5.0.5",
+    "reconnecting-websocket": "^4.4.0",
+    "uuid": "^10.0.0",
+    "vite": "^5.3.4",
+    "vite-tsconfig-paths": "^4.3.2"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^18.0.0",
+    "@types/uuid": "^10.0.0",
+    "jest": "^29.7.0",
+    "jest-transform-stub": "^2.0.0",
+    "ts-jest": "^29.2.3",
+    "typescript": "^5.0.0",
+    "vue": "^3.4.33"
+  }
+}