| name | adobe-reference-architecture |
| description | Implement Adobe reference architecture for production integrations covering
Firefly Services, PDF Services, I/O Events, and App Builder with layered
project layout, error boundaries, and health monitoring.
Trigger with phrases like "adobe architecture", "adobe project structure",
"how to organize adobe", "adobe layout", "adobe best practices".
|
| allowed-tools | Read, Grep |
| version | 1.6.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
| tags | ["saas","design","adobe"] |
| compatibility | Designed for Claude Code |
Adobe Reference Architecture
Overview
Production-ready architecture patterns for Adobe API integrations, designed around the three main API families: Firefly Services (creative AI), PDF Services (document automation), and I/O Events (event-driven).
Prerequisites
- Understanding of layered architecture
- TypeScript project setup
- Decision on which Adobe APIs to integrate
Instructions
Step 1: Project Structure
my-adobe-project/
โโโ src/
โ โโโ adobe/ # Adobe client layer
โ โ โโโ auth.ts # OAuth Server-to-Server token management
โ โ โโโ firefly-client.ts # Firefly API wrapper (generate, fill, expand)
โ โ โโโ pdf-client.ts # PDF Services wrapper (create, extract, merge)
โ โ โโโ photoshop-client.ts # Photoshop API wrapper (cutout, actions)
โ โ โโโ events-client.ts # I/O Events registration and verification
โ โ โโโ types.ts # Shared Adobe types
โ โ โโโ errors.ts # Error classification (retryable vs permanent)
โ โโโ services/ # Business logic layer
โ โ โโโ image-generation.ts # Orchestrates Firefly + Photoshop workflows
โ โ โโโ document-pipeline.ts # Orchestrates PDF create/extract/merge
โ โ โโโ event-processor.ts # Routes and processes I/O Events
โ โโโ api/ # API layer (routes, controllers)
โ โ โโโ health.ts # Health check including Adobe IMS
โ โ โโโ webhooks/adobe.ts # I/O Events webhook endpoint
โ โ โโโ routes/
โ โ โโโ images.ts # Image generation endpoints
โ โ โโโ documents.ts # Document processing endpoints
โ โโโ jobs/ # Background job layer
โ โ โโโ firefly-batch.ts # Batch image generation queue
โ โ โโโ pdf-extraction.ts # Async PDF extraction worker
โ โโโ index.ts
โโโ tests/
โ โโโ unit/
โ โ โโโ adobe/auth.test.ts
โ โ โโโ services/
โ โโโ integration/
โ โโโ adobe/
โ โโโ firefly.test.ts
โ โโโ pdf-services.test.ts
โโโ config/
โ โโโ adobe.development.json
โ โโโ adobe.staging.json
โ โโโ adobe.production.json
โโโ package.json
Step 2: Layer Architecture
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ API Layer โ
โ Routes, Controllers, Webhook Endpoints โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Service Layer โ
โ Business Logic, Workflow Orchestration โ
โ (image-generation.ts, document-pipeline.ts) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Adobe Client Layer โ
โ auth.ts, firefly-client.ts, pdf-client.ts โ
โ Token caching, retry, error classification โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Infrastructure Layer โ
โ Cache (LRU/Redis), Queue (BullMQ), Monitoring โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ