How frontify/brand-sdk works
Main Components
a. Core Packages Layer:
• App Bridge Package
• CLI Package
• TypeScript Types/Helpers Package
• Guideline Blocks Settings Package
• Platform App Package
• Sidebar Settings Package
b. Integration Layer:
• Frontify Platform
• Local Development Environment
• External Applications
c. Communication Layer:
• API Communication
• Event System
• Message Bus
Architectural Patterns to Highlight
a. Bridge Pattern Implementation:
• How App Bridge acts as an abstraction layer between external apps and Frontify's platform
• Message bus system for cross-document communication
b. Plugin Architecture:
• Demonstrate the extensible nature of the RichTextEditor and its plugins
• How different blocks and settings can be composed
┌─────────────────────────────────────────────────────────────────┐
• External Applications │
• ┬─────────────────────────────────┘
┌───────────────────────────────▼─────────────────────────────────┐
• Brand SDK Core │
• ┌─────────────┐ ┌──────────────┐ ┌────────────────────────┐ │
• App Bridge │◄─┤ TypeScript │ │ Guideline Blocks │ │
• Package │ │ Types/Helpers│ │ Settings │ │
• ┬──────┘ └──────────────┘ └────────────────────────┘ │
• ┌──────────────┐ ┌────────────────────────┐ │
• Platform App │ │ Sidebar Settings │ │
• ┘ └────────────────────────┘ │
• ┼───────────────────────────────────────────────────────┘
┌─────────▼───────────────────────────────────────────────────────┐
• Communication Layer │
• ┌─────────────┐ ┌──────────────┐ ┌────────────────────────┐ │
• Message Bus │ │ Event System │ │ API Integration │ │
• ┘ └──────────────┘ └────────────────────────┘ │
• ┘
┌─────────▼───────────────────────────────────────────────────────┐
• Frontify Platform │
• ┘
Important Details
a. Package Relationships:
• How App Bridge depends on TypeScript types
• How Guideline Blocks Settings uses App Bridge
• Demonstrate CLI's relationship with local development
b. Data Flow:
• Bidirectional communication between App Bridge and Frontify Platform
• Event propagation through the Message Bus
• API calls and responses
Additional Elements
a. Development Tools:
• CLI tooling connection to local development
• Build and deployment pipelines
b. Security Layer:
• Authentication and authorization flows
• Secure API communication