Complete Documentation

🎯 Complete Feature Reference

Explore Mode (Blue) — Querying & Data

Debug Mode (Amber) — Events & Logs

Analyze Mode (Green) — Audit & Administration

In-Page Overlays (On Salesforce Pages)

🏗️ Three-Surface Model

1. Launcher Popup

Quick-access menu shown by clicking the extension icon. Appears as a compact popup (~240px wide).

• Current Org Display: Shows org name, instance URL, and favicon
• Quick Jump Buttons: SOQL, GraphQL, Records, Schema, REST, Audit, Debug Logs
• Resume Workspace: Button to open the last-used workspace tab (if exists)
• Open Full Workspace: Link to new full workspace tab
• Settings Gear: Quick link to Settings tab

2. Workspace Tab

Full-screen browser tab for serious work. URL: chrome-extension://[ID]/popup.html

• Header: Brand logo, mode pill selector (Explore/Debug/Analyze), view tabs, search bar, theme toggle
• Mode Bar: Switch between 3 modes; mode persists across sessions
• View Tabs: Per-mode tabs visible only in active mode (7 tabs in Explore, 2 in Debug, 4 in Analyze)
• Settings Drawer: Slide-over drawer (not a tab) for all configuration
• Persistence: Last-used mode and view tab remembered per session

3. In-Page Overlays

Floating panels and menus injected onto Salesforce pages via content script.

• Show All Data Panel: Floating inspector on record pages; position configurable (right/left/bottom)
• Sidebar: Floating shortcut panel (right/left/bottom), width 500px–900px, collapse button
• Command Palette: Modal search overlay (Ctrl+K); triggered position customizable
• Context Menu: Native right-click menu injected by chrome.contextMenus API
• LWC Explorer: Right-side dock panel (~600px wide) with tree + detail pane
• LMS Monitor: Sub-panel inside LWC Explorer dock

⌨️ Complete Keyboard Shortcuts

Browser-Native Shortcuts (Built-In)

Customizable Shortcuts (Settings > General)

Three actions can be customized with any key combination:

• Toggle Sidebar: Default Ctrl+Shift+S — customize in Settings > General > Keyboard Shortcuts, then reset button
• Toggle Show All Data: No default shortcut — set in Settings > General > Keyboard Shortcuts. Primary access is via the floating button on record detail pages or the right-click context menu.
• Command Palette: Default Ctrl+K — customize in Settings > General > Keyboard Shortcuts, then reset button

In-Query Editor Shortcuts

• Ctrl+Space — Autocomplete (SOQL/GraphQL)
• Ctrl+/ — Toggle comment line (SOQL/GraphQL)
• Ctrl+F — Find in query (SOQL/GraphQL)

SOQL Result Table Shortcuts

• ↑ / ↓ — Navigate rows
• ← / → — Navigate columns
• Enter — Select row or drill into linked record
• Escape — Deselect
• Space — Toggle row checkbox
• Ctrl+A — Select all visible rows

💾 Storage Keys Reference

All user data is stored in chrome.storage.local (or browser equivalent). Keys are org-scoped to prevent cross-org data leaks.

Settings & Preferences

Org & Session Data

Workspace State

Layout & Customization

Session & Transient Data

Cache & Index

⚙️ Configuration & Settings

Settings Sub-Tabs

• Org Management: Saved orgs list with environment label and per-org inline edit toggle
• Appearance: Theme (light/dark/system), font size (12-18px)
• General: Configurable keyboard shortcuts, tab visibility toggles (show/hide per tab)
• Sidebar: Position (right/left/hidden), width (500-900px clamp), quick-tool shortcuts, Show All Data button position, Command Palette trigger position
• Layout: Result view density (Normal 38px / Compact 26px / Dense 20px), SOQL column widths (persisted per org)
• Backup: Cache management (clear cache, reset to defaults), backup/restore (JSON export/import)

Org Management Per-Org Toggles

• Org ID: 15-char or 18-char SF org ID
• Org Name: Display name from org records
• Environment: Prod, Sandbox, Dev Org, Scratch Org (label only)
• Instance: US, EU, Asia, China, etc.
• Allow Editing: Boolean toggle for inline edit protection (fail-open if not in list)
• Delete Button: Removes org from saved list

Inline Edit Protection

Inline editing is disabled by org ID. If an org ID is NOT in the tfpInlineEditDisabledOrgs map, editing is allowed.

• Check on load: Compare session org ID (both 15 and 18-char) against the map
• Show warning toast if blocked: "Inline editing is disabled for this org"
• Per-tab guards: Records, SOQL Builder, Show All Data all check the same protection

Sidebar Quick-Tool Customization

Configure shortcuts in Settings > Sidebar. Each shortcut can point to:

• A workspace feature (SOQL, Records, Schema, etc.)
• A Salesforce page (Setup, Reports, etc.)
• A saved SOQL query
• A custom command (record lookup, etc.)

🏛️ Architecture Overview

Three-Layer Extension Model

Module Systems

Background (Service Worker): ES modules (import/export). Popup + Content: IIFE + window globals (no import/export).

Data Flow

1. User interacts with Workspace or Salesforce page
2. UI sends message via chrome.runtime.sendMessage() to background.js
3. Background.js routes to appropriate handler (bg_sf_api.js, bg_org_tab_tracking.js, etc.)
4. Handler calls Salesforce REST/Tooling/GraphQL API with session from bg_session_auth.js
5. Result cached in chrome.storage.local (org-scoped by ID)
6. Response sent back to popup or content script

Session Management

Session detected from Salesforce cookies (sid, sfdc, etc.). Flows:

1. Content script detects SF page → sends session to background.js
2. Background stores in orgInstanceMap (one per org)
3. Popup requests session via GET_SESSION message
4. Fallback: Utils.getSessionFromCookies() if service worker is crashed

Permissions

See Permissions section below.

🔐 Permissions Explained

Required Permissions

• storage — Local storage for settings, cache, workspace state
• tabs — Tab management, URL detection for Salesforce pages
• scripting — Inject content script into Salesforce pages
• webRequest (background only) — Optional monitoring of Salesforce API calls
• contextMenus — Right-click menu on record pages

Host Permissions

Why We Ask for What We Ask

• Cookies: We read browser cookies to detect Salesforce session (sid), not to track you
• Scripts: We inject the content script only on Salesforce pages to enable overlays
• Storage: All settings are stored locally in your browser, not sent to any server
• Network: We only make CORS requests to your Salesforce instance (not cross-origin)

What We DON'T Do

• We don't collect usage analytics
• We don't send your data to external servers
• We don't modify Salesforce UI without your explicit action
• We don't store API responses beyond your current session

🌐 Browser Compatibility

Supported Browsers

Known Issues by Browser

• Firefox: Content script context may invalidate during SPA navigation. Reload the Salesforce page if "Extension context invalidated" appears. Gecko ID required in manifest.json.
• Opera: No known issues. Chromium-based, full Chrome API support.
• Edge: Requires Microsoft Store installation or manual developer mode loading. Full API support.

API Polyfills

Firefox doesn't use the chrome.* namespace natively; it uses browser.*. The extension maps chrome.* → browser.* automatically at build time via manifest build script.

📋 Version History & Changelog

🔄 Migration Guides

Upgrading from v1.x to v2.0+

What Changed: Major UI reorganization (3-mode architecture, Launcher popup, Settings redesign, tab reorganization).

• Your existing SOQL queries and REST collections are automatically migrated
• Inline edit setting (old tfpDisableInlineEditProd boolean) is auto-migrated to per-org map
• Sidebar shortcuts are renamed: old "de-tool" → "rec-tool" (Records), "org-panel" → "org-tool" (Org Tools)
• Data Explorer tab is now called Records; Org & Favicon is now Org Management
• No manual action needed — upgrade seamlessly

Switching Machines

How to transfer settings:

1. On old machine: Settings > Advanced > Backup → Export JSON
2. Install extension on new machine
3. On new machine: Settings > Advanced > Restore → Import JSON

Clearing Cache & Resetting Defaults

1. Settings > Advanced > Cache Management
2. Click "Clear All Cache" — removes describe results, search history, workspace state
3. Click "Reset to Defaults" — restores all settings to initial state