@sf-explorer/salesforce-data-models

Comprehensive Salesforce data models and Entity Relationship Diagram (ERD) templates covering Sales Cloud, Service Cloud, Revenue Cloud, Field Service, Financial Services Cloud, and more.

Installation

npm install @sf-explorer/salesforce-data-models

Features

• 🏢 17+ Pre-built Data Models covering major Salesforce clouds and products
• 📊 Standardized ERD Format with nodes and edges for easy visualization
• 🎯 Categorized & Tagged for easy discovery and filtering
• 🔍 Search & Filter APIs built-in
• 📦 Tree-shakeable ESM modules with TypeScript support
• 🚀 Lazy Loading for optimal performance

Available Models

Core Clouds

• Service Cloud - Cases, entitlements, knowledge articles, and customer service workflows
• Sales Cloud - Leads, opportunities, accounts, contacts, and sales processes
• Data Cloud - Single Source of Truth with unified customer profiles

Revenue Cloud Advanced

• Product Catalog - Products, price books, quotes, and billing relationships
• Invoicing Data Model - Billing, invoicing, payments, and accounting workflows

Financial Services Cloud

• Insurance Data Model - Policy management, claims, and customer relationships
• Know Your Customer (KYC) - Compliance, verification, and risk assessment

Field Service

• FSL Core Data Model - Work orders, service appointments, and resource management

Industry Clouds

• Energy & Utilities Cloud - Meters, usage tracking, and billing cycles

Platform & Security

• Real Time Event Monitoring - Shield events for security monitoring (40+ events)
• Security Model - Users, profiles, permission sets, roles, and sharing rules
• Business Rule Engine - Automated decision-making and workflow automation

AI & Analytics

• Agentforce - AI agent topics, intents, and conversation flows
• Agentforce Feedback - AI performance monitoring and improvement
• Agent Interactions - Conversation tracking and management
• Discovery Framework - Assessment and discovery tools
• Action Plans - Action plan management and templates

Usage

Basic Usage

import { erdModels, ERDData } from '@sf-explorer/salesforce-data-models'

// Load a specific model
const serviceCloudModel = erdModels.find(m => m.value === 'serviceCloud')
const data: ERDData = await serviceCloudModel.content()

console.log(`Loaded ${data.nodes.length} nodes and ${data.edges.length} edges`)

Using Filter Functions

import { 
  getFeaturedERDs, 
  getERDsByCategory, 
  getERDsByComplexity,
  searchERDs 
} from '@sf-explorer/salesforce-data-models'

// Get featured models
const featured = getFeaturedERDs()

// Get models by category
const serviceClouds = getERDsByCategory('service-cloud')

// Get models by complexity
const beginnerModels = getERDsByComplexity('beginner')

// Search models
const agentModels = searchERDs('agent')

Working with Categories

import { erdCategories } from '@sf-explorer/salesforce-data-models'

// Display category information
Object.entries(erdCategories).forEach(([key, category]) => {
  console.log(`${category.name}: ${category.description}`)
})

TypeScript Support

import type { 
  ERDData, 
  ERDNode, 
  ERDEdge, 
  ERDModel,
  ERDCategory 
} from '@sf-explorer/salesforce-data-models'

// All types are fully documented
function processERD(data: ERDData) {
  data.nodes.forEach((node: ERDNode) => {
    console.log(`Node ${node.id} at position (${node.position?.x}, ${node.position?.y})`)
  })
}

Data Structure

Each ERD model contains:

interface ERDData {
  nodes: ERDNode[]  // Entities/Objects in the model
  edges: ERDEdge[]  // Relationships between entities
}

interface ERDNode {
  id: string
  type?: string
  position?: { x: number; y: number }
  data?: any
}

interface ERDEdge {
  id: string
  source: string
  target: string
  type?: string
  data?: any
}

Model Metadata

Each model includes rich metadata:

interface ERDModel {
  value: string          // Unique identifier
  label: string          // Display name
  description: string    // Detailed description
  icon: string          // Salesforce Lightning icon name
  category: string      // Category for grouping
  complexity: 'beginner' | 'intermediate' | 'advanced'
  featured: boolean     // Whether to highlight in UI
  tags: string[]        // Searchable tags
  content: () => Promise<ERDData>  // Lazy-loaded data
}

Optimizations

All data models are optimized for production use:

• ⚡ Lightweight Schemas - Enum fields limited to 30 most common values (reduced from 200-2800+ values)
• 📦 Small Bundle Size - 2.83 MB total (37% smaller than unoptimized)
• 🚀 Fast Loading - Lazy-loaded modules for optimal performance
• 🌳 Tree-shakeable - Import only what you need

Enum Optimization Details

Some Salesforce fields have hundreds of possible values:

• TimeZoneSidKey: 425 → 30 values
• Language: 217 → 30 values
• SobjectType: 2,803 → 30 values
• Country/State codes: 240-367 → 30 values

The first 30 most common values are retained. Applications needing the full list can query Salesforce APIs directly.

Use Cases

• 📐 ERD Visualization - Build interactive entity relationship diagrams
• 📚 Documentation - Generate Salesforce data model documentation
• 🎓 Training - Educational materials for Salesforce architecture
• 🔄 Schema Migration - Plan and document data migrations
• 🏗️ Solution Architecture - Design and present Salesforce solutions
• 🔍 Discovery - Explore and understand Salesforce data structures

Integration Examples

With React Flow

import { erdModels } from '@sf-explorer/salesforce-data-models'
import ReactFlow from 'reactflow'

function MyDiagram() {
  const [elements, setElements] = useState({ nodes: [], edges: [] })
  
  useEffect(() => {
    const loadModel = async () => {
      const model = erdModels.find(m => m.value === 'salescloud')
      const data = await model.content()
      setElements(data)
    }
    loadModel()
  }, [])
  
  return <ReactFlow nodes={elements.nodes} edges={elements.edges} />
}

With Draw.io/DrawDB Converters

import { erdModels } from '@sf-explorer/salesforce-data-models'
import { boardToDrawio } from '@sf-explorer/board-to-drawio'
import { boardToDrawDB } from '@sf-explorer/board-to-drawdb'

// Convert to Draw.io format
const model = erdModels.find(m => m.value === 'serviceCloud')
const data = await model.content()
const drawioXml = boardToDrawio(data)

// Convert to DrawDB format
const drawdbJson = boardToDrawDB(data)

Related Packages

• @sf-explorer/board-to-drawio - Convert models to Draw.io format
• @sf-explorer/board-to-drawdb - Convert models to DrawDB format

License

MIT

Contributing

Issues and pull requests are welcome! Visit our GitHub repository.

Support

For questions and support, please open an issue on GitHub.