Skip to main content

Migration Guide

Smoothly upgrade from legacy versions of SAMMY Three to take advantage of new features and improvements.

Overview

The latest version of SAMMY Three includes significant improvements and new features. This guide will help you migrate your existing implementation.

Breaking Changes

Important API changes that require updates

New Features

Exciting capabilities to adopt

Deprecations

Features being phased out

Version Comparison

What’s New

Audio Processing

Advanced noise suppression with AI-powered filtering and environment presets

Interactive Guides

Built-in walkthrough system with URL activation and progress tracking

MCP Integration

Model Context Protocol support for dynamic tool discovery

Worker Architecture

Improved performance with background workers and CSP compliance

Critical DOM Renders

Automatic capture at conversation boundaries for better context

Migration Steps

Step 1: Update Package

Step 2: Update Imports

Step 3: Update Configuration

The configuration structure has been updated for better organization.

Step 4: Update Component Structure

Step 5: Update Method Calls

Breaking Changes

Authentication

API keys are no longer supported. You must use JWT tokens for authentication.

Event Handling

Events are now handled through provider callbacks instead of event emitters.

Screen Capture

Capture configuration has been restructured.

New Features to Adopt

Audio Processing

Take advantage of the new audio processing capabilities:

Interactive Guides

Implement the new guides system:

MCP Tools

Enable dynamic tool discovery:

Worker Mode

Enable for better performance:

Deprecated Features

Features Being Removed

Deprecated: Direct API client access

Common Migration Issues

Issue: Token Expiration

The new version requires proper token refresh handling.

Issue: Missing Microphone Permission

Permission handling is now more explicit.

Issue: Worker Initialization Failed

Some environments may not support workers.

Testing Your Migration

Migration Checklist

Update all package imports
Replace class components with hooks
Update authentication to use JWT tokens
Convert event handlers to callbacks
Test audio in target environments
Verify screen capture works correctly
Test error handling flows
Validate performance improvements

Testing Script

Support Resources

Documentation

Complete implementation guide

API Reference

Detailed API documentation

GitHub Issues

Report migration issues

Version History