# LightningTypeBundle Metadata Type for Agentforce UI

> Introduced in API v64.0, LightningTypeBundle defines custom data types (lightningTypes/<Name>/) with JSON schemas and custom LWC editors and renderers for Agentforce agents across Employee, Enhanced Chat, and Mobile channels.

- Source: https://sfdxtalk.com/docs/metadata/lightning-type-bundle-metadata-type/
- Category: Metadata
- Applies to: Salesforce Winter '27 (API version 68.0)
- Level: advanced
- Published: 2026-11-12
- Last updated: 2026-11-12
- Publisher: SFDX Talk Editorial (unofficial; not affiliated with or endorsed by Salesforce)
- License: CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/)

## Why `LightningTypeBundle` Is a Game-Changer for Agentforce

Available starting in **API version 64.0**, **`LightningTypeBundle`** bridges the gap between backend **Agentforce Actions** ([GenAiFunction](/docs/metadata/genai-function-metadata-type/)) and rich, interactive **Lightning Web Components** ([LightningComponentBundle](/docs/metadata/lightning-component-bundle-metadata-type/)).

Without `LightningTypeBundle`, an Agentforce agent responds only with plain markdown text. By defining a `LightningTypeBundle` mapped to an Apex class (`@apexClassType/c__FlightOption`), you can replace plain text prompts and responses with:

- **Custom Input Editors (`editor.json`):** Render an interactive date picker, seat map, or filter form inside the Agentforce chat window when the agent needs structured parameters.
- **Custom Output Renderers (`renderer.json`):** Render rich interactive LWC carousels, pricing comparison cards, or approval widgets when an Agentforce action returns structured Apex output.

```mermaid
flowchart LR
    APEX["Apex Class<br/>(@InvocableVariable + @AuraEnabled)"] --> SCHEMA["schema.json<br/>(lightning:type: @apexClassType/c__FlightResult)"]
    SCHEMA --> CHANNELS["Channel Folder<br/>(lightningDesktopGenAi / enhancedWebChat)"]
    CHANNELS --> EDITOR["editor.json<br/>(Input LWC: c/flightFilterEditor)"]
    CHANNELS --> RENDERER["renderer.json<br/>(Output LWC: c/flightOptionCard)"]
    EDITOR --> AGENT["Agentforce Action UI"]
    RENDERER --> AGENT
```

---

## SFDX Directory Structure (`lightningTypes/`)

Unlike standard XML metadata types, a `LightningTypeBundle` is a JSON-driven folder inside `force-app/main/default/lightningTypes/<TypeName>/`:

```text
force-app/main/default/lightningTypes/flightSearchResponse/
├── schema.json
├── lightningDesktopGenAi/
│   ├── editor.json
│   └── renderer.json
└── enhancedWebChat/
    └── renderer.json
```

### Supported Channel Directories

| Folder Name | Target Experience / Channel | Supported Overrides |
|---|---|---|
| `lightningDesktopGenAi` | Agentforce (Default) / Employee Agent in Lightning Experience | `editor.json`, `renderer.json` |
| `enhancedWebChat` | Messaging for In-App and Web (MIAW) / Agentforce Service Agent | `editor.json`, `renderer.json` |
| `lightningMobileGenAi` | Agentforce on the Salesforce Mobile App | `editor.json`, `renderer.json` |
| `experienceBuilder` | Experience Builder Property Panel & Site Components | `editor.json`, `renderer.json` |

---

## Real-World Example: Custom Agentforce Output Card Linked to Apex

### 1. Apex Data Transfer Class (`classes/FlightQuoteResult.cls`)

Every property exposed to a `LightningTypeBundle` must carry **both** `@InvocableVariable` (for the Agentforce action) and `@AuraEnabled` (for the LWC renderer):

```java
public with sharing class FlightQuoteResult {
    @InvocableVariable(label='Flight Number')
    @AuraEnabled
    public String flightNumber;

    @InvocableVariable(label='Total Fare USD')
    @AuraEnabled
    public Decimal totalFare;
}
```

### 2. Schema Definition (`lightningTypes/flightQuoteResult/schema.json`)

```json
{
  "title": "Flight Quote Result",
  "description": "Structured flight quote returned by the booking Agentforce action",
  "lightning:type": "@apexClassType/c__FlightQuoteResult"
}
```

### 3. Desktop Agentforce Renderer (`lightningTypes/flightQuoteResult/lightningDesktopGenAi/renderer.json`)

```json
{
  "renderer": {
    "componentOverrides": {
      "$": {
        "definition": "c/flightQuoteCard"
      }
    }
  }
}
```

### 4. Exposing the LWC Target (`lwc/flightQuoteCard/flightQuoteCard.js-meta.xml`)

Your LWC must declare the corresponding capability (`lightning__AgentforceOutput` or `lightning__AgentforceInput`) and bind to the custom `LightningTypeBundle`:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion>68.0</apiVersion>
    <isExposed>true</isExposed>
    <targets>
        <target>lightning__AgentforceOutput</target>
    </targets>
    <targetConfigs>
        <targetConfig targets="lightning__AgentforceOutput">
            <sourceType name="c__flightQuoteResult"/>
        </targetConfig>
    </targetConfigs>
</LightningComponentBundle>
```

---

## Deploying `LightningTypeBundle` with `package.xml`

```xml
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>flightQuoteResult</members>
        <name>LightningTypeBundle</name>
    </types>
    <version>68.0</version>
</Package>
```

> [!WARNING]
> **Deploy Order Matters:** Because `schema.json` references `@apexClassType/c__FlightQuoteResult` and your LWC's `targetConfig` references `c__flightQuoteResult`, always deploy the `ApexClass` first (or in the same transaction) before deploying the `LightningTypeBundle` and `LightningComponentBundle`.

## Frequently Asked Questions

### What is a LightningTypeBundle in Salesforce?

Introduced in API version 64.0, LightningTypeBundle defines a custom Lightning type in the lightningTypes/ directory. It maps a JSON Schema or an Apex class (@apexClassType/c__MyClass) to custom LWC editor and renderer components for Agentforce conversations and Experience Builder.

### How do you bind a LightningTypeBundle to an Apex InvocableMethod input or output?

In your lightningTypes/TypeName/schema.json file, set lightning:type to @apexClassType/c__YourApexClassName, and annotate the Apex class properties with @AuraEnabled and @InvocableVariable.

### Which Agentforce channels support custom LightningTypeBundle renderers and editors?

You can configure channel-specific overrides using folder names inside the bundle: lightningDesktopGenAi (Agentforce Employee/Default), enhancedWebChat (Messaging for In-App and Web), lightningMobileGenAi (Salesforce Mobile), and experienceBuilder.

### What is the difference between editor.json and renderer.json inside a LightningTypeBundle?

editor.json specifies the custom LWC used to collect structured user input for an Agentforce action, while renderer.json specifies the custom LWC used to display rich structured output cards returned by an Agentforce action.

## Official References

- https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_lightningtypebundle.htm