How klipy-com/ios-demo-app works
Project type and purpose
• This is a SwiftUI-based iOS demo application showcasing a Masonry-style media grid, chat UI, ad integration, and a robust networking layer.
• It follows MVVM + Use-Case + Service + Repository patterns to fetch/display media (GIFs, stickers, clips) from the Klipy API and to render ads securely via a custom WebView.
File structure
• Top-level “KlipyiOS-demo” Xcode project, plus:
• App/
– ChatFeature/ (chat views, view-model, coordinator)
– Components/ (reusable SwiftUI controls: ChatMessage, ChatPreview, CustomMenu, MediaSearchBar, MessageInput, WebView)
– Core/ (domain models + utilities)
– MasonryLayout/ (layout algorithm & views)
– DynamicMediaView/ (media browsing/search)
– ViewUtilities/
– AppDelegate.swift, ContentView.swift, RootView.swift, KlipyiOS_demoApp.swift
• Infrastructure/ (Models, Services, Use Cases, UserAgentManager)
• Networking/ (Moya-based core, async wrapper, error mapping, protocols)
• Utilities/ (JSON decoder)
• Assets, GoogleService-Info.plist, Info.plist
• Build scripts/config: buildServer.json
• README files in modules describe responsibilities.
Architecture from README
• Presentation: SwiftUI Views + ViewModels (MVVM)
• Business logic: Use-Case layer for each service
• Service layer: domain-agnostic API calls, ad-parameter injection
• Networking: Moya/Alamofire with async/await wrappers, error mapping
• Repository pattern for data abstraction (Infrastructure Models)
• MasonryLayoutCalculator drives the perfect grid display.
Main components & interactions
a. Presentation Layer
• SwiftUI Views (RootView → ContentView → Module Views: MasonryGridView, ChatView, DynamicMediaView)
• ViewModels (ChatFeatureViewModel, DynamicMediaViewModel, PreviewViewModel)
• MasonryLayoutCalculator & GridItemLayout/RowLayout utility
b. Domain / Use-Case Layer
• UseCase classes (GifServiceUseCase, ClipsServiceUseCase, StickersServiceUseCase, MediaServiceUseCase, HealthCheckServiceUseCase)
c. Service Layer
• Services (GifService, ClipsService, StickersService, HealthCheckService)
• AdParameters + UserAgentManager (header & param injection)
d. Networking Layer
• NetworkingProviderProtocol / RestApiProtocol → Moya targets (KlipyTargetType, KlipyMultiTarget)
• AsyncMoyaRequestWrapper → request() → API endpoints
• Error mapping (ApiErrorResponse, ApiErrorWrapper, MoyaErrorMapping)
e. Data Models & Caching
• Infrastructure Models → DomainModels (MediaFile, ClipItem, GifItem, StickerItem, Paging)
• JSONCustomDecoder / SDWebImage caching / LazyGIFView
f. External Systems
• Klipy REST API (media endpoints, ad endpoints)
• Ad rendering via KlipyWebView (UIViewRepresentable)
• Device resources (network, local cache, audio)
Relationships & data flows
• User taps UI → SwiftUI View invokes ViewModel → calls UseCase → UseCase uses Service → Service adds ad parameters & headers → Service asks Networking layer → Moya sends HTTP to Klipy API → Response mapped to Infrastructure Models → forwarded to UseCase → ViewModel transforms to UI Models → SwiftUI updates.
• MasonryLayoutCalculator receives media items → computes rows & item positions → MasonryGridView renders.
Architectural patterns & design principles
• MVVM for clear separation of View vs. state/logic
• Use-Case layer isolates business rules
• Service/Repository abstracts API details
• Networking protocols for testability
• Single-responsibility: each module (Chat, Components, DynamicMediaView) is self-contained
• Modular directory layout for feature isolation