@todesktop/plugin-recall 1.0.2 → 1.0.4

package/src/preload.ts

@@ -1,11 +1,13 @@
 /**
  * ToDesktop Recall Desktop SDK Plugin - Preload Script
  * 
- * This file runs in the renderer process with Node.js access and exposes
- * safe APIs to the web application through the contextBridge.
- */
+ * This file runs in the renderer process with Node.js access.
+ *
+ * ToDesktop plugins should export functions; the ToDesktop runtime will
+ * attach them under `window.todesktop.recallDesktop` automatically.
+*/
 
-import { contextBridge, ipcRenderer } from 'electron';
+import { ipcRenderer } from 'electron';
 import { 
   IPC_CHANNELS, 
   ApiResponse, 
@@ -22,216 +24,223 @@ import {
 } from './shared';
 
 /**
- * Recall Desktop SDK API exposed to the renderer process
- */
-const recallDesktopApi = {
-  /**
-   * Initialize the Recall SDK
-   * @returns Promise resolving to initialization result
-   */
-  async initSdk(): Promise<ApiResponse> {
-    return ipcRenderer.invoke(IPC_CHANNELS.INIT_SDK);
-  },
-
-  /**
-   * Shutdown the Recall SDK
-   * @returns Promise resolving to shutdown result
-   */
-  async shutdownSdk(): Promise<ApiResponse> {
-    return ipcRenderer.invoke(IPC_CHANNELS.SHUTDOWN_SDK);
-  },
-
-  /**
-   * Get current plugin and SDK status
-   * @returns Promise resolving to plugin status
-   */
-  async getStatus(): Promise<PluginStatus> {
-    return ipcRenderer.invoke(IPC_CHANNELS.GET_STATUS);
-  },
-
-  /**
-   * Start recording a meeting
-   * @param windowId The meeting window ID
-   * @param uploadToken Upload token from your backend
-   * @returns Promise resolving to recording start result
-   */
-  async startRecording(windowId: string, uploadToken: string): Promise<ApiResponse> {
-    const request: StartRecordingRequest = { windowId, uploadToken };
-    return ipcRenderer.invoke(IPC_CHANNELS.START_RECORDING, request);
-  },
-
-  /**
-   * Stop recording a meeting
-   * @param windowId The meeting window ID
-   * @returns Promise resolving to recording stop result
-   */
-  async stopRecording(windowId: string): Promise<ApiResponse> {
-    const request: StopRecordingRequest = { windowId };
-    return ipcRenderer.invoke(IPC_CHANNELS.STOP_RECORDING, request);
-  },
-
-  /**
-   * Pause recording a meeting
-   * @param windowId The meeting window ID
-   * @returns Promise resolving to recording pause result
-   */
-  async pauseRecording(windowId: string): Promise<ApiResponse> {
-    const request: PauseRecordingRequest = { windowId };
-    return ipcRenderer.invoke(IPC_CHANNELS.PAUSE_RECORDING, request);
-  },
-
-  /**
-   * Resume recording a meeting
-   * @param windowId The meeting window ID
-   * @returns Promise resolving to recording resume result
-   */
-  async resumeRecording(windowId: string): Promise<ApiResponse> {
-    const request: ResumeRecordingRequest = { windowId };
-    return ipcRenderer.invoke(IPC_CHANNELS.RESUME_RECORDING, request);
-  },
-
-  /**
-   * Upload a completed recording
-   * @param windowId The meeting window ID
-   * @returns Promise resolving to upload start result
-   */
-  async uploadRecording(windowId: string): Promise<ApiResponse> {
-    const request: UploadRecordingRequest = { windowId };
-    return ipcRenderer.invoke(IPC_CHANNELS.UPLOAD_RECORDING, request);
-  },
-
-  /**
-   * Prepare desktop audio recording for non-meeting audio capture
-   * @returns Promise resolving to desktop audio preparation result
-   */
-  async prepareDesktopAudioRecording(): Promise<ApiResponse<PrepareDesktopAudioResponse>> {
-    return ipcRenderer.invoke(IPC_CHANNELS.PREPARE_DESKTOP_AUDIO);
-  },
-
-  /**
-   * Request a specific permission from the user
-   * @param permission The permission to request
-   * @returns Promise resolving to permission request result
-   */
-  async requestPermission(permission: PermissionType): Promise<ApiResponse> {
-    return ipcRenderer.invoke(IPC_CHANNELS.REQUEST_PERMISSION, permission);
-  },
-
-  /**
-   * Update plugin configuration
-   * @param config Configuration updates
-   * @returns Promise resolving to update result
-   */
-  async setConfig(config: Partial<RecallSdkConfig>): Promise<ApiResponse> {
-    return ipcRenderer.invoke(IPC_CHANNELS.SET_CONFIG, config);
-  },
-
-  /**
-   * Get current plugin configuration
-   * @returns Promise resolving to current configuration
-   */
-  async getConfig(): Promise<ApiResponse<RecallSdkConfig>> {
-    return ipcRenderer.invoke(IPC_CHANNELS.GET_CONFIG);
-  },
-
-  /**
-   * Subscribe to SDK events
-   * @param eventType The type of event to listen for
-   * @param callback Function to call when event occurs
-   * @returns Function to unsubscribe from the event
-   */
-  addEventListener(eventType: RecallSdkEventType, callback: (data: any) => void): () => void {
-    const channel = `recall-desktop:event:${eventType}`;
-
-    // Fire-and-forget subscribe to main
-    ipcRenderer.invoke(IPC_CHANNELS.SUBSCRIBE_EVENTS, eventType).catch(console.error);
-
-    const listener = (_event: any, data: any) => {
-      callback(data);
-    };
-    ipcRenderer.on(channel, listener);
-
-    // Return unsubscribe function
-    return () => {
-      ipcRenderer.removeListener(channel, listener);
-      ipcRenderer.invoke(IPC_CHANNELS.UNSUBSCRIBE_EVENTS, eventType).catch(console.error);
-    };
-  },
-
-  /**
-   * Get plugin version
-   * @returns Plugin version string
-   */
-  getVersion(): string {
-    return '1.0.0';
-  },
-
-  /**
-   * Convenience method for handling meeting detection events
-   * @param callback Function to call when a meeting is detected
-   * @returns Function to unsubscribe from the event
-   */
-  onMeetingDetected(callback: (meetingData: any) => void): () => void {
-    return this.addEventListener('meeting-detected', callback);
-  },
-
-  /**
-   * Convenience method for handling recording state changes
-   * @param callback Function to call when recording state changes
-   * @returns Function to unsubscribe from the event
-   */
-  onRecordingStateChange(callback: (stateData: any) => void): () => void {
-    return this.addEventListener('sdk-state-change', callback);
-  },
-
-  /**
-   * Convenience method for handling upload progress updates
-   * @param callback Function to call when upload progress updates
-   * @returns Function to unsubscribe from the event
-   */
-  onUploadProgress(callback: (progressData: any) => void): () => void {
-    return this.addEventListener('upload-progress', callback);
-  },
-
-  /**
-   * Convenience method for handling permission status updates
-   * @param callback Function to call when permission status changes
-   * @returns Function to unsubscribe from the event
-   */
-  onPermissionStatusChange(callback: (permissionData: any) => void): () => void {
-    return this.addEventListener('permission-status', callback);
-  },
-
-  /**
-   * Convenience method for handling SDK errors
-   * @param callback Function to call when SDK errors occur
-   * @returns Function to unsubscribe from the event
-   */
-  onError(callback: (errorData: any) => void): () => void {
-    return this.addEventListener('error', callback);
-  },
-
-  /**
-   * Convenience method for handling real-time events (transcription, participants, etc.)
-   * @param callback Function to call when real-time events occur
-   * @returns Function to unsubscribe from the event
-   */
-  onRealtimeEvent(callback: (realtimeData: any) => void): () => void {
-    return this.addEventListener('realtime-event', callback);
-  }
-};
+ * Initialize the Recall SDK
+ * @returns Promise resolving to initialization result
+ */
+export async function initSdk(): Promise<ApiResponse> {
+  return ipcRenderer.invoke(IPC_CHANNELS.INIT_SDK);
+}
+
+/**
+ * Shutdown the Recall SDK
+ * @returns Promise resolving to shutdown result
+ */
+export async function shutdownSdk(): Promise<ApiResponse> {
+  return ipcRenderer.invoke(IPC_CHANNELS.SHUTDOWN_SDK);
+}
+
+/**
+ * Get current plugin and SDK status
+ * @returns Promise resolving to plugin status
+ */
+export async function getStatus(): Promise<PluginStatus> {
+  return ipcRenderer.invoke(IPC_CHANNELS.GET_STATUS);
+}
+
+/**
+ * Start recording a meeting
+ * @param windowId The meeting window ID
+ * @param uploadToken Upload token from your backend
+ * @returns Promise resolving to recording start result
+ */
+export async function startRecording(windowId: string, uploadToken: string): Promise<ApiResponse> {
+  const request: StartRecordingRequest = { windowId, uploadToken };
+  return ipcRenderer.invoke(IPC_CHANNELS.START_RECORDING, request);
+}
+
+/**
+ * Stop recording a meeting
+ * @param windowId The meeting window ID
+ * @returns Promise resolving to recording stop result
+ */
+export async function stopRecording(windowId: string): Promise<ApiResponse> {
+  const request: StopRecordingRequest = { windowId };
+  return ipcRenderer.invoke(IPC_CHANNELS.STOP_RECORDING, request);
+}
+
+/**
+ * Pause recording a meeting
+ * @param windowId The meeting window ID
+ * @returns Promise resolving to recording pause result
+ */
+export async function pauseRecording(windowId: string): Promise<ApiResponse> {
+  const request: PauseRecordingRequest = { windowId };
+  return ipcRenderer.invoke(IPC_CHANNELS.PAUSE_RECORDING, request);
+}
+
+/**
+ * Resume recording a meeting
+ * @param windowId The meeting window ID
+ * @returns Promise resolving to recording resume result
+ */
+export async function resumeRecording(windowId: string): Promise<ApiResponse> {
+  const request: ResumeRecordingRequest = { windowId };
+  return ipcRenderer.invoke(IPC_CHANNELS.RESUME_RECORDING, request);
+}
+
+/**
+ * Upload a completed recording
+ * @param windowId The meeting window ID
+ * @returns Promise resolving to upload start result
+ */
+export async function uploadRecording(windowId: string): Promise<ApiResponse> {
+  const request: UploadRecordingRequest = { windowId };
+  return ipcRenderer.invoke(IPC_CHANNELS.UPLOAD_RECORDING, request);
+}
+
+/**
+ * Prepare desktop audio recording for non-meeting audio capture
+ * @returns Promise resolving to desktop audio preparation result
+ */
+export async function prepareDesktopAudioRecording(): Promise<ApiResponse<PrepareDesktopAudioResponse>> {
+  return ipcRenderer.invoke(IPC_CHANNELS.PREPARE_DESKTOP_AUDIO);
+}
+
+/**
+ * Request a specific permission from the user
+ * @param permission The permission to request
+ * @returns Promise resolving to permission request result
+ */
+export async function requestPermission(permission: PermissionType): Promise<ApiResponse> {
+  return ipcRenderer.invoke(IPC_CHANNELS.REQUEST_PERMISSION, permission);
+}
+
+/**
+ * Update plugin configuration
+ * @param config Configuration updates
+ * @returns Promise resolving to update result
+ */
+export async function setConfig(config: Partial<RecallSdkConfig>): Promise<ApiResponse> {
+  return ipcRenderer.invoke(IPC_CHANNELS.SET_CONFIG, config);
+}
 
-// Export the API type for TypeScript support
-export type RecallDesktopApi = typeof recallDesktopApi;
+/**
+ * Get current plugin configuration
+ * @returns Promise resolving to current configuration
+ */
+export async function getConfig(): Promise<ApiResponse<RecallSdkConfig>> {
+  return ipcRenderer.invoke(IPC_CHANNELS.GET_CONFIG);
+}
+
+/**
+ * Subscribe to SDK events
+ * @param eventType The type of event to listen for
+ * @param callback Function to call when event occurs
+ * @returns Function to unsubscribe from the event
+ */
+export function addEventListener(eventType: RecallSdkEventType, callback: (data: any) => void): () => void {
+  const channel = `recall-desktop:event:${eventType}`;
+
+  // Fire-and-forget subscribe to main
+  ipcRenderer.invoke(IPC_CHANNELS.SUBSCRIBE_EVENTS, eventType).catch(console.error);
+
+  const listener = (_event: any, data: any) => {
+    callback(data);
+  };
+  ipcRenderer.on(channel, listener);
+
+  // Return unsubscribe function
+  return () => {
+    ipcRenderer.removeListener(channel, listener);
+    ipcRenderer.invoke(IPC_CHANNELS.UNSUBSCRIBE_EVENTS, eventType).catch(console.error);
+  };
+}
 
-// Expose the API to the renderer process
-contextBridge.exposeInMainWorld('recallDesktop', recallDesktopApi);
+/**
+ * Get plugin version
+ * @returns Plugin version string
+ */
+export function getVersion(): string {
+  return '1.0.0';
+}
 
-// Extend the global Window interface for TypeScript
-declare global {
-  interface Window {
-    recallDesktop: RecallDesktopApi;
-  }
+/**
+ * Convenience method for handling meeting detection events
+ * @param callback Function to call when a meeting is detected
+ * @returns Function to unsubscribe from the event
+ */
+export function onMeetingDetected(callback: (meetingData: any) => void): () => void {
+  return addEventListener('meeting-detected', callback);
 }
 
+/**
+ * Convenience method for handling recording state changes
+ * @param callback Function to call when recording state changes
+ * @returns Function to unsubscribe from the event
+ */
+export function onRecordingStateChange(callback: (stateData: any) => void): () => void {
+  return addEventListener('sdk-state-change', callback);
+}
+
+/**
+ * Convenience method for handling upload progress updates
+ * @param callback Function to call when upload progress updates
+ * @returns Function to unsubscribe from the event
+ */
+export function onUploadProgress(callback: (progressData: any) => void): () => void {
+  return addEventListener('upload-progress', callback);
+}
+
+/**
+ * Convenience method for handling permission status updates
+ * @param callback Function to call when permission status changes
+ * @returns Function to unsubscribe from the event
+ */
+export function onPermissionStatusChange(callback: (permissionData: any) => void): () => void {
+  return addEventListener('permission-status', callback);
+}
+
+/**
+ * Convenience method for handling SDK errors
+ * @param callback Function to call when SDK errors occur
+ * @returns Function to unsubscribe from the event
+ */
+export function onError(callback: (errorData: any) => void): () => void {
+  return addEventListener('error', callback);
+}
+
+/**
+ * Convenience method for handling real-time events (transcription, participants, etc.)
+ * @param callback Function to call when real-time events occur
+ * @returns Function to unsubscribe from the event
+ */
+export function onRealtimeEvent(callback: (realtimeData: any) => void): () => void {
+  return addEventListener('realtime-event', callback);
+}
+
+// Export the API type for TypeScript support (shape of the exported functions)
+type ExportedApi = {
+  initSdk: typeof initSdk;
+  shutdownSdk: typeof shutdownSdk;
+  getStatus: typeof getStatus;
+  startRecording: typeof startRecording;
+  stopRecording: typeof stopRecording;
+  pauseRecording: typeof pauseRecording;
+  resumeRecording: typeof resumeRecording;
+  uploadRecording: typeof uploadRecording;
+  prepareDesktopAudioRecording: typeof prepareDesktopAudioRecording;
+  requestPermission: typeof requestPermission;
+  setConfig: typeof setConfig;
+  getConfig: typeof getConfig;
+  addEventListener: typeof addEventListener;
+  getVersion: typeof getVersion;
+  onMeetingDetected: typeof onMeetingDetected;
+  onRecordingStateChange: typeof onRecordingStateChange;
+  onUploadProgress: typeof onUploadProgress;
+  onPermissionStatusChange: typeof onPermissionStatusChange;
+  onError: typeof onError;
+  onRealtimeEvent: typeof onRealtimeEvent;
+};
+export type RecallDesktopApi = ExportedApi;
+
 console.log('RecallDesktop: Preload script loaded successfully');

package/src/shared.ts

@@ -5,30 +5,30 @@
 // IPC channel names - use unique namespace to avoid conflicts
 export const IPC_CHANNELS = {
   // SDK lifecycle
-  INIT_SDK: 'recall-desktop:init-sdk',
-  SHUTDOWN_SDK: 'recall-desktop:shutdown-sdk',
-  GET_STATUS: 'recall-desktop:get-status',
-  
+  INIT_SDK: "recall-desktop:init-sdk",
+  SHUTDOWN_SDK: "recall-desktop:shutdown-sdk",
+  GET_STATUS: "recall-desktop:get-status",
+
   // Recording management
-  START_RECORDING: 'recall-desktop:start-recording',
-  STOP_RECORDING: 'recall-desktop:stop-recording',
-  PAUSE_RECORDING: 'recall-desktop:pause-recording',
-  RESUME_RECORDING: 'recall-desktop:resume-recording',
-  UPLOAD_RECORDING: 'recall-desktop:upload-recording',
-  
+  START_RECORDING: "recall-desktop:start-recording",
+  STOP_RECORDING: "recall-desktop:stop-recording",
+  PAUSE_RECORDING: "recall-desktop:pause-recording",
+  RESUME_RECORDING: "recall-desktop:resume-recording",
+  UPLOAD_RECORDING: "recall-desktop:upload-recording",
+
   // Desktop audio recording
-  PREPARE_DESKTOP_AUDIO: 'recall-desktop:prepare-desktop-audio',
-  
+  PREPARE_DESKTOP_AUDIO: "recall-desktop:prepare-desktop-audio",
+
   // Permission management
-  REQUEST_PERMISSION: 'recall-desktop:request-permission',
-  
+  REQUEST_PERMISSION: "recall-desktop:request-permission",
+
   // Configuration
-  SET_CONFIG: 'recall-desktop:set-config',
-  GET_CONFIG: 'recall-desktop:get-config',
-  
+  SET_CONFIG: "recall-desktop:set-config",
+  GET_CONFIG: "recall-desktop:get-config",
+
   // Event subscription
-  SUBSCRIBE_EVENTS: 'recall-desktop:subscribe-events',
-  UNSUBSCRIBE_EVENTS: 'recall-desktop:unsubscribe-events',
+  SUBSCRIBE_EVENTS: "recall-desktop:subscribe-events",
+  UNSUBSCRIBE_EVENTS: "recall-desktop:unsubscribe-events",
 } as const;
 
 // Recall SDK Configuration (mirrors RecallAiSdkConfig where applicable)
@@ -38,6 +38,37 @@ export interface RecallSdkConfig {
   requestPermissionsOnStartup: boolean;
 }
 
+// ToDesktop plugin context (subset relevant to this plugin)
+export interface PluginContext {
+  plugin: {
+    todesktop: {
+      preferences: [
+        {
+          id: "enabled";
+          name: string;
+          description: string;
+          type: "checkbox";
+          spec: { value?: boolean };
+        },
+        {
+          id: "apiUrl";
+          name: string;
+          description: string;
+          type: "text";
+          spec: { value?: string };
+        },
+        {
+          id: "requestPermissionsOnStartup";
+          name: string;
+          description: string;
+          type: "checkbox";
+          spec: { value?: boolean };
+        }
+      ];
+    };
+  };
+}
+
 // Meeting window information from SDK
 export interface MeetingWindow {
   id: string;
@@ -70,20 +101,20 @@ export interface UploadRecordingRequest {
 
 // SDK Events from Recall SDK (mirror upstream)
 export type RecallSdkEventType =
-  | 'recording-started'
-  | 'recording-ended'
-  | 'upload-progress'
-  | 'meeting-detected'
-  | 'meeting-updated'
-  | 'meeting-closed'
-  | 'sdk-state-change'
-  | 'error'
-  | 'media-capture-status'
-  | 'participant-capture-status'
-  | 'permissions-granted'
-  | 'permission-status'
-  | 'realtime-event'
-  | 'shutdown';
+  | "recording-started"
+  | "recording-ended"
+  | "upload-progress"
+  | "meeting-detected"
+  | "meeting-updated"
+  | "meeting-closed"
+  | "sdk-state-change"
+  | "error"
+  | "media-capture-status"
+  | "participant-capture-status"
+  | "permissions-granted"
+  | "permission-status"
+  | "realtime-event"
+  | "shutdown";
 
 export interface RecallSdkEvent {
   type: RecallSdkEventType;
@@ -98,7 +129,7 @@ export interface MeetingDetectedEvent {
 export interface SdkStateChangeEvent {
   sdk: {
     state: {
-      code: 'recording' | 'idle' | 'paused';
+      code: "recording" | "idle" | "paused";
     };
   };
 }
@@ -126,13 +157,13 @@ export interface MeetingUpdatedEvent {
 
 export interface MediaCaptureStatusEvent {
   window: MeetingWindow;
-  type: 'video' | 'audio';
+  type: "video" | "audio";
   capturing: boolean;
 }
 
 export interface ParticipantCaptureStatusEvent {
   window: MeetingWindow;
-  type: 'video' | 'audio' | 'screenshare';
+  type: "video" | "audio" | "screenshare";
   capturing: boolean;
 }
 
@@ -159,7 +190,11 @@ export interface ShutdownEvent {
 }
 
 // Permission types (mirror upstream)
-export type PermissionType = 'accessibility' | 'screen-capture' | 'microphone' | 'system-audio';
+export type PermissionType =
+  | "accessibility"
+  | "screen-capture"
+  | "microphone"
+  | "system-audio";
 
 // API Response types
 export interface ApiResponse<T = any> {
@@ -174,7 +209,7 @@ export interface PluginStatus {
   sdkInitialized: boolean;
   version: string;
   config: RecallSdkConfig;
-  sdkState?: 'recording' | 'idle' | 'paused';
+  sdkState?: "recording" | "idle" | "paused";
   permissions?: {
     accessibility: boolean;
     screenCapture: boolean;
@@ -187,7 +222,7 @@ export interface PluginStatus {
 export class RecallSdkError extends Error {
   constructor(message: string, public code?: string) {
     super(message);
-    this.name = 'RecallSdkError';
+    this.name = "RecallSdkError";
   }
 }