# jmsavani/capacitor-android-call-logs architecture

> Architecture diagram of the GitHub repository jmsavani/capacitor-android-call-logs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jmsavani/capacitor-android-call-logs
- Repository: https://github.com/jmsavani/capacitor-android-call-logs

## Overview

##### Main Components
- Example App (Host)
– A web-based frontend (example/src/…) that runs inside Capacitor.
- Capacitor Core Runtime
– Bridges JS calls to native layers via the Plugin Bridge.
- Plugin JS/TS Layer
– src/index.ts: public API (echo, checkPermission, isEnabled, getCallLogs)
– src/web.ts: web fallback implementation
– src/definitions.ts: type definitions for all methods
– rollup.config.js: bundling for npm package
- Native Android Plugin
– android/src/main/java/com/cap/call/logs/CapacitorCallLogsPlugin.java
– Queries Android CallLog content provider
– Gradle build scripts under android/
- Native iOS Plugin
– ios/Plugin/CapacitorCallLogsPlugin.swift + Obj-C headers
– Xcode project under ios/Plugin.xcodeproj
- Operating System Services
– Android ContentResolver > CallLog Provider
– (iOS: not implemented; calls throw or no‐op)

##### Relationships & Data Flow
1. Example App invokes a method: CallLogs.getCallLogs({…})
2. Plugin JS calls Capacitor.Plugins.CallLogs via the Capacitor Bridge
3. Bridge routes call to platform plugin:
– Android: JNI invocation → Java Plugin class → ContentResolver query → return JSON array
– iOS: Swift Plugin method stub (no API) → return not-supported or error
– Web: fallback defined in web.ts → return Promise.reject or stub
4. Result propagates back through the bridge to JS, then to Example App

##### Architectural Patterns & Principles
– Adapter/Bridge Pattern: abstracts native calls behind a uniform JS API
– Single-Responsibility: separate TS definitions, web fallback, platform implementations
– Modular Build: rollup for JS packaging, Gradle/Xcode for native builds
– Cross-Platform Plugin Structure: consistent folder layout for android/ ios/ src/

##### Technologies & Frameworks
– Capacitor (runtime, plugin bridge)
– TypeScript + Rollup (package, definitions, web fallback)
– Java + Android SDK (plugin implementation, Gradle)
– Swift/Objective-C + Xcode (iOS plugin project)
– Example app: HTML/JS/CSS + Vite

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% Layers and Components
  subgraph "Example App Layer"
    ExampleApp["Example App"]:::yellow
  end

  subgraph "Plugin JS/TS Layer"
    PublicAPI["Public API\n(src/index.ts)"]:::blue
    Definitions["Type Definitions\n(src/definitions.ts)"]:::blue
    WebFallback["Web Fallback\n(src/web.ts)"]:::blue
    Bundler["Bundler Config\n(rollup.config.js)"]:::blue
  end

  CapacitorBridge["Capacitor Core Runtime\n(Plugin Bridge)"]:::gray

  subgraph "Platform Implementations"
    subgraph "Android Plugin"
      JavaPlugin["CapacitorCallLogsPlugin.java"]:::green
      HelperClass["CapacitorCallLogs.java"]:::green
      GradleScript["build.gradle"]:::green
      ContentResolver["Android ContentResolver\nCallLog Provider"]:::gray
    end

    subgraph "iOS Plugin"
      SwiftImpl["CapacitorCallLogs.swift"]:::purple
      SwiftPlugin["CapacitorCallLogsPlugin.swift"]:::purple
      ObjCHeader["CapacitorCallLogsPlugin.h"]:::purple
      ObjCImpl["CapacitorCallLogsPlugin.m"]:::purple
      XcodeProj["Plugin.xcodeproj"]:::purple
      IOSStub["iOS Not-Implemented Stub\n(throws error)"]:::gray
    end

    subgraph "Web Fallback"
      WebFallback
    end
  end

  %% Data Flow
  ExampleApp -->|"CallLogs.getCallLogs()"| PublicAPI
  PublicAPI -->|"Invoker"| CapacitorBridge
  CapacitorBridge -->|"Android Call"| JavaPlugin
  JavaPlugin -->|"queries"| ContentResolver
  ContentResolver -->|"JSON logs"| JavaPlugin
  JavaPlugin -->|"response"| CapacitorBridge

  CapacitorBridge -->|"iOS Call"| SwiftPlugin
  SwiftPlugin -->|"stub"| IOSStub
  IOSStub -->|"error"| CapacitorBridge

  CapacitorBridge -->|"Web Call"| WebFallback
  WebFallback -->|"reject/error"| CapacitorBridge

  CapacitorBridge -->|"response"| PublicAPI
  PublicAPI -->|"Promise resolves"| ExampleApp

  %% Supporting Relationships
  PublicAPI --> Definitions
  PublicAPI --> Bundler

  %% Click Events
  click ExampleApp "https://github.com/jmsavani/capacitor-android-call-logs/tree/master/example/src/"
  click PublicAPI "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/src/index.ts"
  click Definitions "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/src/definitions.ts"
  click WebFallback "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/src/web.ts"
  click Bundler "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/rollup.config.js"
  click JavaPlugin "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/android/src/main/java/com/cap/call/logs/CapacitorCallLogsPlugin.java"
  click HelperClass "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/android/src/main/java/com/cap/call/logs/CapacitorCallLogs.java"
  click GradleScript "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/android/build.gradle"
  click SwiftImpl "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/ios/Plugin/CapacitorCallLogs.swift"
  click SwiftPlugin "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/ios/Plugin/CapacitorCallLogsPlugin.swift"
  click ObjCHeader "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/ios/Plugin/CapacitorCallLogsPlugin.h"
  click ObjCImpl "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/ios/Plugin/CapacitorCallLogsPlugin.m"
  click XcodeProj "https://github.com/jmsavani/capacitor-android-call-logs/blob/master/ios/Plugin.xcodeproj"

  %% Styles
  classDef yellow fill:#f9f,stroke:#333,stroke-width:1px
  classDef blue fill:#bbf,stroke:#333,stroke-width:1px
  classDef green fill:#bfb,stroke:#333,stroke-width:1px
  classDef purple fill:#fbc,stroke:#333,stroke-width:1px
  classDef gray fill:#ddd,stroke:#666,stroke-width:1px,stroke-dasharray: 2 2
```
