--- name: fireflies-upgrade-migration description: | Analyze, plan, and execute Fireflies.ai SDK upgrades with breaking change detection. Use when upgrading Fireflies.ai SDK versions, detecting deprecations, or migrating to new API versions. Trigger with phrases like "upgrade fireflies", "fireflies migration", "fireflies breaking changes", "update fireflies SDK", "analyze fireflies version". allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(git:*) version: 1.0.0 license: MIT author: Jeremy Longshore --- # Fireflies.ai Upgrade & Migration ## Overview Guide for upgrading Fireflies.ai SDK versions and handling breaking changes. ## Prerequisites - Current Fireflies.ai SDK installed - Git for version control - Test suite available - Staging environment ## Instructions ### Step 1: Check Current Version ```bash npm list @fireflies/sdk npm view @fireflies/sdk version ``` ### Step 2: Review Changelog ```bash open https://github.com/fireflies/sdk/releases ``` ### Step 3: Create Upgrade Branch ```bash git checkout -b upgrade/fireflies-sdk-vX.Y.Z npm install @fireflies/sdk@latest npm test ``` ### Step 4: Handle Breaking Changes Update import statements, configuration, and method signatures as needed. ## Output - Updated SDK version - Fixed breaking changes - Passing test suite - Documented rollback procedure ## Error Handling | SDK Version | API Version | Node.js | Breaking Changes | |-------------|-------------|---------|------------------| | 3.x | 2024-01 | 18+ | Major refactor | | 2.x | 2023-06 | 16+ | Auth changes | | 1.x | 2022-01 | 14+ | Initial release | ## Examples ### Import Changes ```typescript // Before (v1.x) import { Client } from '@fireflies/sdk'; // After (v2.x) import { Fireflies.aiClient } from '@fireflies/sdk'; ``` ### Configuration Changes ```typescript // Before (v1.x) const client = new Client({ key: 'xxx' }); // After (v2.x) const client = new Fireflies.aiClient({ apiKey: 'xxx', }); ``` ### Rollback Procedure ```bash npm install @fireflies/sdk@1.x.x --save-exact ``` ### Deprecation Handling ```typescript // Monitor for deprecation warnings in development if (process.env.NODE_ENV === 'development') { process.on('warning', (warning) => { if (warning.name === 'DeprecationWarning') { console.warn('[Fireflies.ai]', warning.message); // Log to tracking system for proactive updates } }); } // Common deprecation patterns to watch for: // - Renamed methods: client.oldMethod() -> client.newMethod() // - Changed parameters: { key: 'x' } -> { apiKey: 'x' } // - Removed features: Check release notes before upgrading ``` ## Resources - [Fireflies.ai Changelog](https://github.com/fireflies/sdk/releases) - [Fireflies.ai Migration Guide](https://docs.fireflies.com/migration) ## Next Steps For CI integration during upgrades, see `fireflies-ci-integration`.