--- name: fireflies-reference-architecture-7db5af5c2592 description: | Implement Fireflies.ai reference architecture with best-practice project layout. Use when designing new Fireflies.ai integrations, reviewing project structure, or establishing architecture standards for Fireflies.ai applications. Trigger with phrases like "fireflies architecture", "fireflies best practices", "fireflies project structure", "how to organize fireflies", "fireflies layout". allowed-tools: Read, Grep version: 1.0.0 license: MIT author: Jeremy Longshore --- # Fireflies.ai Reference Architecture ## Overview Production-ready architecture patterns for Fireflies.ai integrations. ## Prerequisites - Understanding of layered architecture - Fireflies.ai SDK knowledge - TypeScript project setup - Testing framework configured ## Project Structure ``` my-fireflies-project/ ├── src/ │ ├── fireflies/ │ │ ├── client.ts # Singleton client wrapper │ │ ├── config.ts # Environment configuration │ │ ├── types.ts # TypeScript types │ │ ├── errors.ts # Custom error classes │ │ └── handlers/ │ │ ├── webhooks.ts # Webhook handlers │ │ └── events.ts # Event processing │ ├── services/ │ │ └── fireflies/ │ │ ├── index.ts # Service facade │ │ ├── sync.ts # Data synchronization │ │ └── cache.ts # Caching layer │ ├── api/ │ │ └── fireflies/ │ │ └── webhook.ts # Webhook endpoint │ └── jobs/ │ └── fireflies/ │ └── sync.ts # Background sync job ├── tests/ │ ├── unit/ │ │ └── fireflies/ │ └── integration/ │ └── fireflies/ ├── config/ │ ├── fireflies.development.json │ ├── fireflies.staging.json │ └── fireflies.production.json └── docs/ └── fireflies/ ├── SETUP.md └── RUNBOOK.md ``` ## Layer Architecture ``` ┌─────────────────────────────────────────┐ │ API Layer │ │ (Controllers, Routes, Webhooks) │ ├─────────────────────────────────────────┤ │ Service Layer │ │ (Business Logic, Orchestration) │ ├─────────────────────────────────────────┤ │ Fireflies.ai Layer │ │ (Client, Types, Error Handling) │ ├─────────────────────────────────────────┤ │ Infrastructure Layer │ │ (Cache, Queue, Monitoring) │ └─────────────────────────────────────────┘ ``` ## Key Components ### Step 1: Client Wrapper ```typescript // src/fireflies/client.ts export class Fireflies.aiService { private client: Fireflies.aiClient; private cache: Cache; private monitor: Monitor; constructor(config: Fireflies.aiConfig) { this.client = new Fireflies.aiClient(config); this.cache = new Cache(config.cacheOptions); this.monitor = new Monitor('fireflies'); } async get(id: string): Promise { return this.cache.getOrFetch(id, () => this.monitor.track('get', () => this.client.get(id)) ); } } ``` ### Step 2: Error Boundary ```typescript // src/fireflies/errors.ts export class Fireflies.aiServiceError extends Error { constructor( message: string, public readonly code: string, public readonly retryable: boolean, public readonly originalError?: Error ) { super(message); this.name = 'Fireflies.aiServiceError'; } } export function wrapFireflies.aiError(error: unknown): Fireflies.aiServiceError { // Transform SDK errors to application errors } ``` ### Step 3: Health Check ```typescript // src/fireflies/health.ts export async function checkFireflies.aiHealth(): Promise { try { const start = Date.now(); await firefliesClient.ping(); return { status: 'healthy', latencyMs: Date.now() - start, }; } catch (error) { return { status: 'unhealthy', error: error.message }; } } ``` ## Data Flow Diagram ``` User Request │ ▼ ┌─────────────┐ │ API │ │ Gateway │ └──────┬──────┘ │ ▼ ┌─────────────┐ ┌─────────────┐ │ Service │───▶│ Cache │ │ Layer │ │ (Redis) │ └──────┬──────┘ └─────────────┘ │ ▼ ┌─────────────┐ │ Fireflies.ai │ │ Client │ └──────┬──────┘ │ ▼ ┌─────────────┐ │ Fireflies.ai │ │ API │ └─────────────┘ ``` ## Configuration Management ```typescript // config/fireflies.ts export interface Fireflies.aiConfig { apiKey: string; environment: 'development' | 'staging' | 'production'; timeout: number; retries: number; cache: { enabled: boolean; ttlSeconds: number; }; } export function loadFireflies.aiConfig(): Fireflies.aiConfig { const env = process.env.NODE_ENV || 'development'; return require(`./fireflies.${env}.json`); } ``` ## Instructions ### Step 1: Create Directory Structure Set up the project layout following the reference structure above. ### Step 2: Implement Client Wrapper Create the singleton client with caching and monitoring. ### Step 3: Add Error Handling Implement custom error classes for Fireflies.ai operations. ### Step 4: Configure Health Checks Add health check endpoint for Fireflies.ai connectivity. ## Output - Structured project layout - Client wrapper with caching - Error boundary implemented - Health checks configured ## Error Handling | Issue | Cause | Solution | |-------|-------|----------| | Circular dependencies | Wrong layering | Separate concerns by layer | | Config not loading | Wrong paths | Verify config file locations | | Type errors | Missing types | Add Fireflies.ai types | | Test isolation | Shared state | Use dependency injection | ## Examples ### Quick Setup Script ```bash # Create reference structure mkdir -p src/fireflies/{handlers} src/services/fireflies src/api/fireflies touch src/fireflies/{client,config,types,errors}.ts touch src/services/fireflies/{index,sync,cache}.ts ``` ## Resources - [Fireflies.ai SDK Documentation](https://docs.fireflies.com/sdk) - [Fireflies.ai Best Practices](https://docs.fireflies.com/best-practices) ## Flagship Skills For multi-environment setup, see `fireflies-multi-env-setup`. --- Source attribution: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/fireflies-pack/skills/fireflies-reference-architecture/SKILL.md License: MIT License information: https://opensource.org/license/mit Original upstream instructions; downloaded from Dave AI. ## Upstream license notice MIT License (with OpenAI/Anthropic Rider) Copyright (c) 2026 Jeffrey Emanuel Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: ADDITIONAL RIDER / RESTRICTION (OpenAI / Anthropic): This rider is part of the "conditions" of this License. In the event of any conflict between this rider and any other portion of this License, this rider controls. "Restricted Parties" means OpenAI, L.L.C.; Anthropic, PBC; any of their respective Affiliates; and any person or entity acting directly or indirectly on behalf of, for the benefit of, or under the direction of any of the foregoing (including any officer, director, employee, contractor, agent, consultant, service provider, or representative). Notwithstanding any other provision of this License, no rights are granted to any Restricted Party. Any purported license, sublicense, assignment, transfer, or other permission to any Restricted Party is null and void absent the express prior written permission of Jeffrey Emanuel. You may not provide, disclose, distribute, sublicense, sell, lease, lend, host, make available, or otherwise permit access to the Software or any derivative work of the Software (as defined in applicable copyright law) (collectively, "Derivative Works") to or for any Restricted Party. For purposes of this rider, "use" includes, without limitation: copying, modifying, merging, publishing, distributing, sublicensing, selling, transferring, making available, hosting, deploying, executing, benchmarking, testing, analyzing, indexing, or incorporating the Software or any Derivative Works into any dataset, training corpus, evaluation harness, or pipeline for machine learning or other automated systems. This rider applies to the Software and all Derivative Works. As a condition of use, you agree that this rider is a precondition to exercising any rights under this License, and you agree that any distribution of the Software or any Derivative Works must include this rider provision unmodified. Any breach of this rider automatically and immediately terminates the permissions granted by this License. Upon termination, you must immediately cease all use and distribution of the Software and any Derivative Works and destroy all copies under your control. You agree that a breach of this rider would cause irreparable harm and that Jeffrey Emanuel may seek injunctive or other equitable relief to enforce this rider, in addition to any other remedies available at law. To the maximum extent permitted by applicable law, the prevailing party in any action to enforce this rider shall be entitled to recover reasonable attorneys' fees and costs. For purposes of this rider, "Affiliate" means any entity that directly or indirectly controls, is controlled by, or is under common control with the specified party. "Control" means ownership of more than 50% of the voting securities or other ownership interest, or the power to direct management or policies by contract or otherwise. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # Dave AI resource metadata Creator / publisher: Dicklesworthstone Original project: https://github.com/Dicklesworthstone/pi_agent_rust/blob/f28fc46ee0db8e710d95b8b55592cd38d60f2b26/tests/ext_conformance/artifacts/plugins-community/plugins/saas-packs/fireflies-pack/skills/fireflies-reference-architecture/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering, Product Management Roles: Backend Developer, Growth Product Manager, Product Manager Specialties: Backend Tools: Fireflies.Ai Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: 507545ea0930c9dc4ee4dfeb7d205ab25be1243be9517258dc248684078e3bbb