# ericrsmith35/datatablev2 architecture

> Architecture diagram of the GitHub repository ericrsmith35/datatablev2, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ericrsmith35/datatablev2
- Repository: https://github.com/ericrsmith35/datatablev2

## Overview

##### Project type and purpose
- This is a Salesforce-DX project that packages a Lightning Web Component library (“datatableV2” and “richDatatable”) designed to run inside Salesforce Flow screens.
- It includes:
- LWC components (UI layer)
- Apex classes (SObjectController2) for data access
- Salesforce Flows (Datatable Configuration Helper) for run-time configuration
- A Packaging Manifest (package.xml) and SFDX config (sfdx-project.json) for deployment

##### File structure
- Top-level files & directories:
- config/project-scratch-def.json: Scratch org definition
- force-app/main/default/classes: Apex controllers & tests
- force-app/main/default/lwc: UI components (datatableV2, richDatatable) and JS configs
- force-app/main/default/flows: Flow definitions for configuration helper
- manifest/package.xml & sfdx-project.json: packaging/deployment metadata
- scripts/: sample Apex/soql scripts for dev/test
- Architectural clues:
- Separation of UI (LWC) vs. business logic (Apex) vs. orchestration (Flow)
- Uses Salesforce Metadata API (via Flow) requiring a Remote Site Setting
- Packaged as an unlocked package or managed package installable in any org

##### Key insights from the README
- Purpose: “Configure and display a datatable in a Flow screen”
- Core components:
- datatableV2 LWC (runs in Flow Screens)
- SObjectController2 Apex class (queries SObjects dynamically)
- Datatable Configuration Helper Flow (uses Metadata API to build JSON config)
- Dependencies: Flow Base Components, DualListBox component, Remote Site Setting

A. Developer & CI/CD environment (local machine)
- VS Code + Salesforce CLI
- Source repo (Git) with SFDX project
- Deployment pipeline (SFDX push or package install) → Salesforce Org
B. Salesforce Org (runtime container)
1. Lightning Experience (Browser)
– Hosts Flow screens where the LWC runs
2. UI Layer: Lightning Web Components
– datatableV2 & richDatatable
– Exposed as Flow Screen Components
3. Orchestration Layer: Salesforce Flow
– Datatable Configuration Helper & subflow
– Calls into LWC (configuration mode) & Apex (Metadata API)
4. Business Logic Layer: Apex Class (SObjectController2)
– Imperative methods & @wire adapters to execute dynamic SOQL
5. Data Layer: Salesforce Database (SObjects)
– Queried by Apex, returned as JSON to LWC
6. External Service: Metadata API endpoint
– Flow elements perform HTTP call‐out to <orgDomain>/services/Soap/m/...
– Requires Remote Site Setting
C. External Dependencies
- Flow Base Components package
- DualListBox package

##### Architectural patterns & design principles
- Clear separation of concerns:
- UI (LWC) ←→ service layer (Apex) ←→ data store (SObjects)
- Configuration flow decoupled from data retrieval flow
- Dynamic metadata‐driven configuration via Metadata API
- Reusable, declarative UI components for Flow screens
- Package modularity: unlocked / managed packaging

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Developer & CI/CD
    Dev["Developer Workstation"] 
    CICD["CI/CD & SFDX CLI"]
    Dev -->|"works locally"| CICD

    %% Packaging & Scripts
    packageXML["package.xml"]
    sfdxConfig["sfdx-project.json"]
    scratchDef["project-scratch-def.json"]
    scripts["Dev Scripts\n(scripts/)"]
    Dev -->|"updates metadata"| packageXML
    Dev --> sfdxConfig
    Dev --> scratchDef
    Dev --> scripts

    %% Salesforce Org Container
    subgraph "Salesforce Org"
        direction TB

        %% Browser
        Browser["Lightning Experience\n(Browser)"]

        %% UI Layer
        subgraph "UI Layer"
            direction TB
            dtv2["LWC: datatableV2"]:::ui
            rich["LWC: richDatatable"]:::ui
        end

        %% Orchestration Layer
        subgraph "Orchestration Layer"
            direction TB
            flowMain["Flow: Datatable Configuration Helper"]:::orchestration
            flowSub["Subflow: Temp Configuration Helper"]:::orchestration
        end

        %% Business Logic Layer
        subgraph "Business Logic Layer"
            apex["Apex: SObjectController2"]:::business
        end

        %% Data Layer
        subgraph "Data Layer"
            db["Salesforce Database\n(SObjects)"]:::data
        end

        %% External Service
        external["Metadata API Endpoint"]:::external
    end

    %% Deployment
    CICD -->|"deploys source"| flowMain

    %% Runtime: Configuration Path
    Browser -->|"invokes Flow screen"| flowMain
    flowMain -->|"calls Metadata API"| external
    external -->|"returns config JSON"| flowMain
    flowMain -->|"passes config"| dtv2

    %% Runtime: Data Path
    Browser -->|"hosts LWC on Flow screen"| dtv2
    dtv2 -->|"invoke getRecords()"| apex
    apex -->|"SOQL query"| db
    db -->|"returns SObject data"| apex
    apex -->|"returns JSON records"| dtv2

    %% RichDatatable as alternative component
    Browser -->|"hosts LWC on Flow screen"| rich
    rich -->|"invoke getRecords()"| apex

    %% Click Events
    click dtv2 "https://github.com/ericrsmith35/datatablev2/tree/master/force-app/main/default/lwc/datatableV2/"
    click rich "https://github.com/ericrsmith35/datatablev2/tree/master/force-app/main/default/lwc/richDatatable/"
    click apex "https://github.com/ericrsmith35/datatablev2/blob/master/force-app/main/default/classes/SObjectController2.cls"
    click flowMain "https://github.com/ericrsmith35/datatablev2/blob/master/force-app/main/default/flows/Datatable_Configuration_Helper.flow-meta.xml"
    click flowSub "https://github.com/ericrsmith35/datatablev2/blob/master/force-app/main/default/flows/Datatable_Configuration_Helper_Temp_SubFlow.flow-meta.xml"
    click packageXML "https://github.com/ericrsmith35/datatablev2/blob/master/manifest/package.xml"
    click sfdxConfig "https://github.com/ericrsmith35/datatablev2/blob/master/sfdx-project.json"
    click scratchDef "https://github.com/ericrsmith35/datatablev2/blob/master/config/project-scratch-def.json"
    click scripts "https://github.com/ericrsmith35/datatablev2/tree/master/scripts/"

    %% Styles
    classDef ui fill:#e0ffe0,stroke:#2e7d32,stroke-width:1px
    classDef orchestration fill:#e0e0ff,stroke:#1565c0,stroke-width:1px
    classDef business fill:#ffe0b2,stroke:#ef6c00,stroke-width:1px
    classDef data fill:#f0f4c3,stroke:#827717,stroke-width:1px
    classDef external fill:#ffffff,stroke:#000000,stroke-dasharray:5 5,stroke-width:1px
```
