This is a monorepo containing four complementary Salesforce reference packages.
Standard Salesforce objects scraped from official documentation.
- Source: Salesforce documentation websites
- Objects: 2,500+ standard objects from all Salesforce clouds
- Use Case: Official documented objects with comprehensive descriptions
- Includes: Describe API tool for live org queries
- Install:
npm install @sf-explorer/salesforce-object-reference - Version:
📖 Full Documentation 🔧 Describe API Tool
Metadata API objects from Salesforce documentation.
- Source: Metadata API documentation
- Objects: 700+ metadata objects (CustomObject, Flow, ApexClass, etc.)
- Use Case: Metadata deployment and configuration
- Install:
npm install @sf-explorer/salesforce-metadata-reference - Version:
Data Cloud DMO (Data Model Objects) from Salesforce documentation.
- Source: Salesforce Data Cloud DMO documentation
- Objects: 150+ DMO objects (Individual, SalesOrder, LoyaltyProgram, etc.)
- Use Case: Data Cloud data harmonization and unified customer profiles
- Note: These are NOT standard CRM objects - DMOs have API names like
ssot__Individual__dlm - Install:
npm install @sf-explorer/salesforce-object-ssot-reference - Version:
Salesforce Agentforce standard actions from official documentation.
- Source: Salesforce Agentforce Copilot Actions documentation
- Actions: Standard actions for Agentforce/Copilot
- Use Case: Reference for available Agentforce actions and their parameters
- Install:
npm install @sf-explorer/salesforce-agentforce-actions-reference - Version:
sf-doc-to-json/
├── packages/
│ ├── salesforce-object-reference/ # 📚 Standard objects
│ │ ├── src/
│ │ │ ├── doc/
│ │ │ │ ├── objects/ # ~2,500 objects
│ │ │ │ └── *.json # Cloud indexes
│ │ │ └── index.ts
│ │ ├── describe-api/ # Live org Describe API tool
│ │ └── package.json
│ │
│ ├── salesforce-metadata-reference/ # ⚙️ Metadata objects
│ │ ├── src/
│ │ │ ├── doc/
│ │ │ │ ├── objects/ # ~700 metadata objects
│ │ │ │ └── index.json # Metadata index
│ │ │ └── index.ts
│ │ └── package.json
│ │
│ ├── salesforce-object-ssot-reference/ # 🎯 Data Cloud DMO objects
│ │ ├── src/
│ │ │ ├── doc/
│ │ │ │ ├── objects/ # ~150 DMO objects
│ │ │ │ └── index.json # DMO index
│ │ │ └── index.ts
│ │ └── package.json
│ │
│ └── salesforce-agentforce-actions-reference/ # 🤖 Agentforce actions
│ ├── src/
│ │ ├── doc/
│ │ │ ├── actions/ # Agentforce actions
│ │ │ └── index.json # Actions index
│ │ └── index.ts
│ └── package.json
│
├── package.json # Root workspace config
└── README.md # This file
Install the packages you need:
# Standard objects from documentation
npm install @sf-explorer/salesforce-object-reference@1.0.2
# Metadata API objects
npm install @sf-explorer/salesforce-metadata-reference@1.0.0
# SSOT/DMO objects
npm install @sf-explorer/salesforce-object-ssot-reference@1.0.0
# Agentforce actions
npm install @sf-explorer/salesforce-agentforce-actions-reference@1.0.0Then import and use:
// Standard CRM objects (Account, Contact, Opportunity, etc.)
import { getObject } from '@sf-explorer/salesforce-object-reference';
const account = await getObject('Account');
// Metadata API objects (CustomObject, Flow, ApexClass, etc.)
import { getObject as getMetadata } from '@sf-explorer/salesforce-metadata-reference';
const customObject = await getMetadata('CustomObject');
// Data Cloud DMO objects (Individual, SalesOrder, LoyaltyProgram, etc.)
import { getObject as getDMO } from '@sf-explorer/salesforce-object-ssot-reference';
const individual = await getDMO('ssot__Individual__dlm');
// Agentforce actions
import { getAction } from '@sf-explorer/salesforce-agentforce-actions-reference';
const createRecordAction = await getAction('CreateRecord');
⚠️ Important: The SSOT/DMO package contains Data Cloud Data Model Objects, not standard Salesforce CRM objects. For example, the DMOIndividualis different from the CRMContact- they serve different purposes in the Salesforce ecosystem.
Clone and setup the monorepo:
git clone https://github.com/sf-explorer/sf-doc-to-json.git
cd sf-doc-to-json
# Install all dependencies
npm install
# Build all packages
npm run build
# Run tests for all packages
npm run testAll object packages share the same interface:
// Every package exports these functions:
loadIndex() // Load master index
getObject(name) // Get full object details
searchObjects(pattern) // Search by name
getAllObjectNames() // Get all object names
loadAllDescriptions() // Get all descriptions (lightweight)
getObjectDescription(name) // Get single description (lightweight)
searchObjectsByDescription(pattern) // Search by description
loadAllObjects() // Load all objects (heavy)
clearCache() // Clear cached data# Build all packages
npm run build
# Build specific package
npm run build --workspace=@sf-explorer/salesforce-object-reference
npm run build --workspace=@sf-explorer/salesforce-metadata-reference
npm run build --workspace=@sf-explorer/salesforce-object-ssot-reference
npm run build --workspace=@sf-explorer/salesforce-agentforce-actions-reference# Test all packages
npm run test
# Test specific package
npm test --workspace=@sf-explorer/salesforce-metadata-reference# Generate standard objects
npm run fetch:all # All clouds
npm run fetch:fsc # Financial Services Cloud
npm run fetch:core # Core Salesforce
# Generate SSOT/DMO objects
npm run fetch:dmo
# Generate Agentforce actions
npm run fetch:actionsEach package is published independently:
# Standard objects
cd packages/salesforce-object-reference
npm version patch
npm publish --access public
# Metadata objects
cd packages/salesforce-metadata-reference
npm version patch
npm publish --access public
# SSOT objects
cd packages/salesforce-object-ssot-reference
npm version patch
npm publish --access public
# Agentforce actions
cd packages/salesforce-agentforce-actions-reference
npm version patch
npm publish --access public- NPM Packages:
- GitHub: sf-explorer/sf-doc-to-json
- Issues: GitHub Issues
MIT License - see LICENSE
Contributions welcome! See CONTRIBUTING.md for details.
Note: These packages contain data from Salesforce. They are not officially affiliated with or endorsed by Salesforce.