@todesktop/plugin-recall 1.0.4 → 1.2.0

package/README.md

@@ -14,7 +14,11 @@ This plugin provides a complete integration between ToDesktop and the Recall.ai
 - **Upload progress tracking** and webhook integration
 - **Type-safe client library** for web applications
 
-## Installation &s Setup
+## Want a tutorial?
+
+Check out the [tutorial](https://todesktop.com/docs/tutorials/recall-transcripts) for a step-by-step guide on how to use the Recall desktop plugin and client SDK.
+
+## Installation & Setup
 
 ### Prerequisites
 
@@ -52,35 +56,53 @@ import { recallDesktop } from "@todesktop/client-recall";
 await recallDesktop.initSdk();
 
 // Listen for meeting detection
-recallDesktop.onMeetingDetected(async ({ window }) => {
-  console.log("Meeting detected:", window);
-
-  // Get upload token from your backend
-  const uploadToken = await getUploadTokenFromBackend();
-
-  // Start recording
-  const result = await recallDesktop.startRecording(window.id, uploadToken);
-  if (result.success) {
-    console.log("Recording started successfully");
+const stopMeetingListener = recallDesktop.addEventListener(
+  "meeting-detected",
+  async ({ window }) => {
+    console.log("Meeting detected:", window);
+
+    // Get upload token from your backend
+    const uploadToken = await getUploadTokenFromBackend();
+
+    // Start recording
+    const result = await recallDesktop.startRecording(window.id, uploadToken);
+    if (result.success) {
+      console.log("Recording started successfully");
+    }
   }
-});
+);
 
 // Listen for recording events
-recallDesktop.onRecordingStateChange(({ sdk }) => {
-  console.log("Recording state:", sdk.state.code);
-});
+const stopStateListener = recallDesktop.addEventListener(
+  "sdk-state-change",
+  ({ sdk }) => {
+    console.log("Recording state:", sdk.state.code);
+  }
+);
 
-recallDesktop.onUploadProgress(({ progress }) => {
-  console.log(`Upload progress: ${progress}%`);
-});
+const stopUploadListener = recallDesktop.addEventListener(
+  "upload-progress",
+  ({ progress }) => {
+    console.log(`Upload progress: ${progress}%`);
+  }
+);
 
 // Handle recording completion
-recallDesktop.onRecordingEnded(async ({ window }) => {
-  console.log("Recording ended for window:", window.id);
+const stopRecordingListener = recallDesktop.addEventListener(
+  "recording-ended",
+  async ({ window }) => {
+    console.log("Recording ended for window:", window.id);
 
-  // Upload the recording
-  await recallDesktop.uploadRecording(window.id);
-});
+    // Upload the recording
+    await recallDesktop.uploadRecording(window.id);
+  }
+);
+
+// Later, remove listeners when no longer needed
+stopMeetingListener();
+stopStateListener();
+stopUploadListener();
+stopRecordingListener();
 ```
 
 ### Desktop Audio Recording
@@ -112,13 +134,36 @@ console.log("Permissions:", status.permissions);
 await recallDesktop.requestPermission("screen-capture");
 
 // Listen for permission changes
-recallDesktop.onPermissionStatusChange(({ permission, status }) => {
-  console.log(`Permission ${permission}: ${status}`);
-});
+const removePermissionListener = recallDesktop.addEventListener(
+  "permission-status",
+  ({ permission, status }) => {
+    console.log(`Permission ${permission}: ${status}`);
+  }
+);
+
+// Remove the listener when you no longer need updates
+removePermissionListener();
 ```
 
 ## Backend Integration
 
+### Demo Backend Service
+
+A minimal Express backend lives in `packages/backend` for demos. It exposes:
+
+- `POST /api/create-sdk-upload` – calls the Recall API and returns `{ id, upload_token, recording_id }`
+- `POST /webhooks/recall` – logs Recall webhook payloads for inspection
+- `GET /health` – health check
+
+Run it with your Recall token (replace the example value with the token for your workspace):
+
+```bash
+RECALL_API_TOKEN="c5a6aaff378e5dc5a7e28b3e2853eff832ce4bde" \
+npm start --workspace=packages/backend
+```
+
+The server defaults to `https://us-west-2.recall.ai`; override via `RECALL_API_BASE` if you use another region. Set `CORS_ORIGIN` to restrict cross-origin access (defaults to `*`).
+
 ### Creating Upload Tokens
 
 Your backend needs to create upload tokens using the Recall.ai API:
@@ -191,13 +236,13 @@ app.post("/webhooks/recall", (req, res) => {
 
 ### Event Listeners
 
-- `onMeetingDetected(callback)` - Meeting window detected
-- `onRecordingStateChange(callback)` - Recording state changes
-- `onRecordingStarted(callback)` - Recording started
-- `onRecordingEnded(callback)` - Recording completed
-- `onUploadProgress(callback)` - Upload progress updates
-- `onError(callback)` - SDK errors
-- `onPermissionStatusChange(callback)` - Permission changes
+Use `recallDesktop.addEventListener(eventType, callback)` to subscribe. Available event types include:
+
+- `meeting-detected`, `meeting-updated`, `meeting-closed`
+- `recording-started`, `recording-ended`, `sdk-state-change`
+- `upload-progress`, `realtime-event`, `error`
+- `permissions-granted`, `permission-status`
+- `media-capture-status`, `participant-capture-status`, `shutdown`
 
 ### Configuration
 
@@ -217,16 +262,14 @@ app.post("/webhooks/recall", (req, res) => {
 
 ### Plugin Development
 
-The plugin uses a mock Recall SDK implementation for development. To integrate with the real SDK:
+- The Electron plugin uses `@recallai/desktop-sdk` directly; no mock setup is required.
+- Before building or type-checking the client package, the `sync-sdk-types` script copies the SDK's TypeScript declarations into `packages/client/src/generated`. This runs automatically via `npm run build --workspace=@todesktop/client-recall` and `npm run typecheck --workspace=@todesktop/client-recall`, but you can invoke it manually with:
 
-1. Install the actual Recall SDK:
+  ```bash
+  npm run sync-sdk-types --workspace=@todesktop/client-recall
+  ```
 
-   ```bash
-   npm install @recallai/desktop-sdk --workspace=packages/plugin
-   ```
+  ## Changelog
 
-2. Replace the mock in `packages/plugin/src/main.ts`:
-   ```typescript
-   // Replace mock with real import
-   import RecallAiSdk from "@recallai/desktop-sdk";
-   ```
+  - 1.2.0
+    - Updated `@recallai/desktop-sdk` to v1.3.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@todesktop/plugin-recall",
-  "version": "1.0.4",
+  "version": "1.2.0",
   "description": "ToDesktop plugin for Recall.ai Desktop Recording SDK - Plugin package",
   "private": false,
   "main": "dist/main.js",
@@ -65,7 +65,7 @@
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@recallai/desktop-sdk": "1.1.0",
+    "@recallai/desktop-sdk": "1.3.5",
     "@types/node": "20.19.2"
   }
 }