@salesforce/templates 66.5.5 → 66.5.6

package/lib/templates/project/reactb2e/_r_/features/feature-graphql-graphql-data-access-rule.md

@@ -1,470 +0,0 @@
----
-paths:
-  - "**/*.ts"
-  - "**/*.tsx"
----
-
-# GraphQL Data Access
-
-Instructs agents to use the established GraphQL utilities for Salesforce data access.
-
-## TypeScript Types & Code Generation
-
-### Generated Types File
-
-Types are auto-generated at: `src/api/graphql-operations-types.ts`
-
-### Generation Command
-
-```bash
-npm run graphql:codegen
-```
-
-The codegen configuration is at `codegen.yml` and generates types from:
-
-- Schema: `schema.graphql` (project root)
-- Documents: `src/**/*.{graphql,ts,tsx}`
-
-### Type Naming Convention
-
-For a GraphQL operation named `GetHighRevenueAccounts`:
-
-- **Query/Mutation Response Type**: `GetHighRevenueAccountsQuery` or `GetHighRevenueAccountsMutation`
-- **Input Variables Type**: `GetHighRevenueAccountsQueryVariables` or `GetHighRevenueAccountsMutationVariables`
-
-## Core Types & Function Signatures
-
-### getDataSDK Function
-
-Available from `@salesforce/sdk-data`:
-
-```typescript
-import { getDataSDK } from "@salesforce/sdk-data";
-
-const data = await getDataSDK();
-const response = await data.graphql?.<ResponseType, VariablesType>(query, variables);
-```
-
-`getDataSDK()` returns a lazily-initialized `DataSDK` singleton. The `graphql` method uses optional chaining (`?.`) because not all surfaces support GraphQL.
-
-### gql Template Tag
-
-Also available from `@salesforce/sdk-data` for inline query definitions:
-
-```typescript
-import { gql } from "@salesforce/sdk-data";
-
-const MY_QUERY = gql`
-  query MyQuery {
-    uiapi {
-      ...
-    }
-  }
-`;
-```
-
-The `gql` tag is a template literal that allows defining GraphQL queries inline while maintaining syntax highlighting in most editors.
-
-### GraphQLResponse Shape
-
-`data.graphql?.()` returns `GraphQLResponse<T>`. Callers destructure `{ data, errors }` and handle errors themselves:
-
-```typescript
-interface GraphQLResponse<T> {
-  data: T;
-  errors?: Array<{
-    message: string;
-    locations?: Array<{ line: number; column: number }>;
-    path?: string[];
-  }>;
-}
-```
-
-### Handling Mixed Responses (Partial Success)
-
-GraphQL can return **both `data` and `errors`** in the same response (partial success). For example, some fields may resolve while others fail due to field-level security. Choose a strategy per use case:
-
-```typescript
-// Strategy A: Strict — treat any errors as failure (default for most queries)
-if (response?.errors?.length) {
-  throw new Error(response.errors.map((e) => e.message).join("; "));
-}
-const result = response?.data;
-
-// Strategy B: Tolerant — log errors but use partial data
-if (response?.errors?.length) {
-  console.warn("GraphQL partial errors:", response.errors);
-}
-const result = response?.data;
-
-// Strategy C: Discriminated — fail only when no data came back
-if (response?.errors?.length && !response?.data) {
-  throw new Error(response.errors.map((e) => e.message).join("; "));
-}
-if (response?.errors?.length) {
-  console.warn("Partial success with errors:", response.errors);
-}
-const result = response?.data;
-```
-
-**When to use each:**
-
-- **Strategy A** — Default. Use for queries where incomplete data would be misleading (e.g., financial summaries, approval workflows).
-- **Strategy B** — Use when partial data is still useful and the UI can degrade gracefully (e.g., dashboard tiles, optional fields).
-- **Strategy C** — Use for mutations where the operation may succeed but some return fields are inaccessible.
-
-For mutation-specific partial responses, see `docs/generate-mutation-query.md` which covers `PARTIAL` and `FAILED` status handling workflows.
-
-### NodeOfConnection Utility Type
-
-Extract the node type from a connection (edges/node pattern):
-
-```typescript
-import { type NodeOfConnection } from "@salesforce/sdk-data";
-
-// Extract Account node type from the query response
-type AccountNode = NodeOfConnection<GetHighRevenueAccountsQuery["uiapi"]["query"]["Account"]>;
-```
-
-### UIAPI Response Shape
-
-All Salesforce GraphQL record queries follow this structure (https://developer.salesforce.com/docs/platform/graphql/guide/query-record-objects.html):
-
-```typescript
-interface UIAPIQueryResponse {
-  uiapi: {
-    query: {
-      [ObjectName]: {
-        edges?: Array<{
-          node?: {
-            Id: string;
-            [FieldName]?: { value?: FieldType | null } | null;
-            // Reference fields include the related record
-            [ReferenceField]?: {
-              value?: string | null; // The ID
-              [RelatedField]?: { value?: RelatedType | null } | null;
-            } | null;
-          } | null;
-        } | null> | null;
-      } | null;
-    };
-  };
-}
-```
-
-## Required Workflow
-
-There are **two acceptable patterns** for defining GraphQL queries:
-
-### Pattern 1: External .graphql File (Recommended for complex queries)
-
-#### Step 1: Create .graphql File
-
-Store queries in `.graphql` files for codegen to process:
-
-```graphql
-# src/api/utils/query/myQuery.graphql
-query GetMyData($myVariable: String) {
-  uiapi {
-    query {
-      MyObject(first: 10, where: { Field: { eq: $myVariable } }) {
-        edges {
-          node {
-            Id
-            Name {
-              value
-            }
-          }
-        }
-      }
-    }
-  }
-}
-```
-
-#### Step 2: Run Code Generation
-
-```bash
-npm run graphql:codegen
-```
-
-This generates types in `graphql-operations-types.ts`:
-
-- `GetMyDataQuery` - response type
-- `GetMyDataQueryVariables` - variables type
-
-#### Step 3: Import and Use
-
-```typescript
-import { getDataSDK, type NodeOfConnection } from "@salesforce/sdk-data";
-import MY_QUERY from "./query/myQuery.graphql?raw";
-import type { GetMyDataQuery, GetMyDataQueryVariables } from "../graphql-operations-types";
-
-type MyNode = NodeOfConnection<GetMyDataQuery["uiapi"]["query"]["MyObject"]>;
-
-export async function getMyData(variables: GetMyDataQueryVariables): Promise<MyNode[]> {
-  const data = await getDataSDK();
-  const response = await data.graphql?.<GetMyDataQuery, GetMyDataQueryVariables>(
-    MY_QUERY,
-    variables,
-  );
-
-  if (response?.errors?.length) {
-    const errorMessages = response.errors.map((e) => e.message).join("; ");
-    throw new Error(`GraphQL Error: ${errorMessages}`);
-  }
-
-  return response?.data?.uiapi?.query?.MyObject?.edges?.map((edge) => edge?.node) || [];
-}
-```
-
-**Key imports for Pattern 1:**
-
-- `getDataSDK` - Get the DataSDK singleton
-- `NodeOfConnection` - Extract node types from connection responses
-- Query from `.graphql` file with `?raw` suffix
-- Generated types from `graphql-operations-types.ts`
-
-**Pattern 1 Benefits:**
-
-- Full codegen support with automatic type generation
-- Syntax highlighting and validation in `.graphql` files
-- Easier to share queries across multiple files/components
-- Better for complex queries with fragments and multiple variables
-- IDE support for GraphQL (autocomplete, validation)
-- Queries can be tested independently
-- Clear separation of concerns between query definition and usage
-
-**Pattern 1 Limitations:**
-
-- Requires separate file management
-- Extra step to run codegen after query changes
-- More boilerplate (file import with `?raw`, separate file to maintain)
-- Slight overhead for very simple queries
-- Need to navigate between files during development
-- Doesn't support dynamic queries (e.g., the set of fields changes based on runtime conditions and cannot be predetermined)
-
-### Pattern 2: Inline Query with gql Tag (Recommended for simple queries)
-
-For simpler queries without variables or when colocation is preferred:
-
-```typescript
-import { getDataSDK, gql } from "@salesforce/sdk-data";
-import { type CurrentUserQuery } from "../graphql-operations-types";
-
-const CURRENT_USER_QUERY = gql`
-  query CurrentUser {
-    uiapi {
-      currentUser {
-        Id
-        Name {
-          value
-        }
-      }
-    }
-  }
-`;
-
-interface User {
-  id: string;
-  name: string;
-}
-
-export async function getCurrentUser(): Promise<User | null> {
-  try {
-    const data = await getDataSDK();
-    const response = await data.graphql?.<CurrentUserQuery>(CURRENT_USER_QUERY);
-
-    if (response?.errors?.length) {
-      throw new Error(response.errors.map((e) => e.message).join("; "));
-    }
-
-    const userData = response?.data?.uiapi.currentUser;
-
-    if (!userData) {
-      throw new Error("No user data found");
-    }
-
-    return {
-      id: userData.Id,
-      name: userData.Name?.value || "User",
-    };
-  } catch (error) {
-    console.error("Error fetching user data:", error);
-    throw error;
-  }
-}
-```
-
-**Key imports for Pattern 2:**
-
-- `getDataSDK` - Get the DataSDK singleton
-- `gql` - Template tag for inline query definition
-- Generated types from `graphql-operations-types.ts`
-
-**Pattern 2 Benefits:**
-
-- Query is colocated with usage code
-- Supports dynamic queries (e.g., the set of fields changes based on runtime conditions and cannot be predetermined)
-- No separate file to maintain
-- Still gets type-checked against generated types
-- Simpler for straightforward queries
-
-**Pattern 2 Limitations:**
-
-- Inline queries without `gql` template tag are not processed by codegen
-- Must manually ensure query name matches generated types
-- Less suitable for complex queries with fragments
-
-## Conditional Field Selection with Directives
-
-For dynamic fieldsets with known fields that should be conditionally included, use GraphQL directives instead of building queries dynamically. This preserves type generation while allowing runtime control.
-
-### Directives
-
-- **`@include(if: $condition)`** - include field/fragment when `$condition` is `true`
-- **`@skip(if: $condition)`** - skip field/fragment when `$condition` is `true`
-
-### Example with Fragments
-
-```graphql
-query GetAccountDetails($id: ID!, $includeFinancials: Boolean!, $includeContacts: Boolean!) {
-  uiapi {
-    query {
-      Account(where: { Id: { eq: $id } }) {
-        edges {
-          node {
-            Id
-            Name {
-              value
-            }
-            ...FinancialFields @include(if: $includeFinancials)
-            ...ContactFields @include(if: $includeContacts)
-          }
-        }
-      }
-    }
-  }
-}
-
-fragment FinancialFields on Account {
-  AnnualRevenue {
-    value
-  }
-  NumberOfEmployees {
-    value
-  }
-}
-
-fragment ContactFields on Account {
-  Phone {
-    value
-  }
-  Website {
-    value
-  }
-}
-```
-
-### Usage
-
-```typescript
-import { getDataSDK } from "@salesforce/sdk-data";
-import QUERY from "./query/getAccountDetails.graphql?raw";
-import type {
-  GetAccountDetailsQuery,
-  GetAccountDetailsQueryVariables,
-} from "../graphql-operations-types";
-
-const data = await getDataSDK();
-const response = await data.graphql?.<GetAccountDetailsQuery, GetAccountDetailsQueryVariables>(
-  QUERY,
-  {
-    id: accountId,
-    includeFinancials: userWantsFinancials,
-    includeContacts: userWantsContacts,
-  },
-);
-```
-
-## Anti-Patterns (Not Recommended)
-
-### Direct API Calls
-
-```typescript
-// NOT RECOMMENDED: Direct axios/fetch calls for GraphQL
-const response = await axios.post("/graphql", { query });
-
-// PREFERRED: Use the DataSDK
-const data = await getDataSDK();
-const response = await data.graphql?.<ResponseType>(query, variables);
-```
-
-### Missing Type Definitions
-
-```typescript
-// NOT RECOMMENDED: Untyped GraphQL calls
-const data = await getDataSDK();
-await data.graphql?.(query);
-
-// PREFERRED: Provide response type
-const data = await getDataSDK();
-const response = await data.graphql?.<GetMyDataQuery>(query);
-```
-
-### Plain String Queries (Without gql Tag)
-
-```typescript
-// NOT RECOMMENDED: Plain string queries without gql tag
-const query = `query { ... }`;
-const data = await getDataSDK();
-await data.graphql?.(query);
-
-// PREFERRED: Use gql tag for inline queries
-const QUERY = gql`query { ... }`;
-const data = await getDataSDK();
-const response = await data.graphql?.<ResponseType>(QUERY);
-
-// OR: Use .graphql file for complex queries
-import QUERY from "./query/myQuery.graphql?raw";
-const data = await getDataSDK();
-const response = await data.graphql?.<ResponseType>(QUERY);
-```
-
-## Benefits of the DataSDK GraphQL API
-
-- Uses the DataSDK with proper authentication and CSRF token handling
-- Consistent typing with `GraphQLResponse<T>` interface
-- Optional chaining (`?.`) safely handles surfaces where GraphQL is unavailable
-- Callers get full `GraphQLResponse<T>` for flexible error handling
-
-## Quality Checklist
-
-Before completing GraphQL data access code:
-
-### For Pattern 1 (.graphql files):
-
-1. [ ] Create `.graphql` file for the query/mutation
-2. [ ] Run `npm run graphql:codegen` to generate types
-3. [ ] Import query with `?raw` suffix
-4. [ ] Import generated types from `graphql-operations-types.ts`
-5. [ ] Use `data.graphql?.<ResponseType>()` with proper generic
-6. [ ] Handle `response.errors` and destructure `response.data`
-7. [ ] Use `NodeOfConnection` for cleaner node types when needed
-8. [ ] Handle optional chaining for nested response data
-9. [ ] Follow the pattern in `accounts.ts`
-
-### For Pattern 2 (inline with gql):
-
-1. [ ] Define query using `gql` template tag
-2. [ ] Ensure query name matches generated types in `graphql-operations-types.ts`
-3. [ ] Import generated types for the query
-4. [ ] Use `data.graphql?.<ResponseType>()` with proper generic
-5. [ ] Handle `response.errors` and destructure `response.data`
-6. [ ] Handle optional chaining for nested response data
-7. [ ] Follow the pattern in `user.ts`
-
-### General:
-
-- [ ] Choose Pattern 1 for complex queries with variables, fragments, or when shared
-- [ ] Choose Pattern 2 for simple, colocated queries without complex requirements

package/lib/templates/project/reactb2e/_r_/features/feature-react-agentforce-conversation-client-embedded-agent-rule.md

@@ -1,18 +0,0 @@
----
-paths:
-  - "**/*.tsx"
-  - "**/components/**/*.ts"
----
-
-# Agentforce Conversation Client (standards)
-
-## DO NOT build a chat UI from scratch
-
-When the user asks for a chat UI, chat widget, chatbot, agent, or conversational interface — **always use the existing `AgentforceConversationClient` component** from `@salesforce/webapp-template-feature-react-agentforce-conversation-client-experimental`. Never generate a custom chat implementation, third-party chat library, WebSocket/REST chat, or direct calls to `embedAgentforceClient`.
-
-## Hard constraints
-
-- **`agentId` is required.** The component will not work without it. Always ask the user for their agent ID before generating code. Do not proceed without one.
-- **Use the React wrapper only.** Import `AgentforceConversationClient` from the package. Never call `embedAgentforceClient` directly.
-- **One instance per window.** Render in the app layout alongside `<Outlet />`, not on individual pages. The component is a singleton.
-- **No auth hard-coding.** The component resolves `salesforceOrigin` and `frontdoorUrl` automatically.

package/lib/templates/project/reactb2e/_r_/features/feature-react-chart-analytics-charts-rule.md

@@ -1,27 +0,0 @@
----
-paths:
-  - "**/*.tsx"
-  - "**/components/**/*.ts"
----
-
-# Analytics charts (standards)
-
-When adding or editing chart UI in this project, follow these conventions.
-
-## Components and library
-
-- Use the shared **AnalyticsChart** component (and **ChartContainer** when a framed block is needed). Do not use raw Recharts components for standard line or bar charts.
-- The project must have **recharts** installed (`npm install recharts`).
-
-## Data shape
-
-- **Time-series** (line): data must be an array of `{ x: string, y: number }`. Map raw fields (e.g. `date`, `value`) to these keys before passing to the chart.
-- **Categorical** (bar): data must be an array of `{ name: string, value: number }`. Map raw fields (e.g. `category`, `total`) accordingly.
-
-## Theming
-
-- Use only the **theme** prop on AnalyticsChart: `red` (decline/loss), `green` (growth/gain), `neutral` (default or mixed). Do not introduce ad-hoc color schemes for these semantics.
-
-## Placement
-
-- Render charts inside the existing application frame (e.g. main content or a route). Do not replace the full app shell with a single chart.

package/lib/templates/project/reactb2e/_r_/skills/_k_/SKILL.md

@@ -1,148 +0,0 @@
----
-name: feature-react-agentforce-conversation-client-embedded-agent
-description: Embed an Agentforce conversation client (chat UI) into a React web application. Use when the user wants to add an employee agent, a chat client, chatbot, chat widget, chat component, conversation client, or conversational interface to their React app. Also applies when the user asks to embed or integrate any Salesforce agent — including employee agent, travel agent, HR agent, or any custom-named agent — or mentions Agentforce, Agentforce widget, Agentforce chat, or agent chat. ALWAYS use this skill instead of building a chat UI from scratch. Do NOT generate custom chat components, use third-party chat libraries, or create WebSocket/REST chat implementations. Do NOT use for non-React contexts or Lightning Web Components without React.
----
-
-# Embedded Agentforce chat (workflow)
-
-When the user wants an embedded Agentforce chat client in a React app, follow this workflow.
-
-## DO NOT build a chat UI from scratch
-
-When the user asks for a chat UI, chat widget, chatbot, conversational interface, agent embed, or anything related to an embedded agent — **always use the `AgentforceConversationClient` component** from `@salesforce/webapp-template-feature-react-agentforce-conversation-client-experimental`.
-
-**Never do any of the following:**
-
-- Build a custom chat component from scratch (no custom message bubbles, input boxes, or chat layouts)
-- Use third-party chat libraries (e.g. `react-chat-widget`, `stream-chat`, `chatscope`, or similar)
-- Create WebSocket, polling, or REST-based chat implementations
-- Generate custom HTML/CSS chat UIs
-- Write a wrapper around `embedAgentforceClient` directly — always use the provided React component
-
-If the user asks for chat functionality that goes beyond what `AgentforceConversationClient` supports (e.g. custom message rendering, message history, typing indicators), explain that the embedded Agentforce client handles all of this internally and cannot be customized beyond the supported `agentforceClientConfig` options (`renderingConfig`, `styleTokens`, `agentId`).
-
-## CRITICAL: Agent ID is required
-
-The Agentforce Conversation Client **will not work** without an `agentId`. There is no default agent — the component renders nothing and silently fails if `agentId` is missing. **Always ask the user for their agent ID before writing any code.**
-
-> **Before proceeding:** Ask the user for their Salesforce agent ID (18-character record ID starting with `0Xx`). If they do not have one, direct them to **Setup → Agents** in their Salesforce org to find or create one. Do not generate code without an `agentId`.
-
-## 1. Collect the agent ID
-
-Ask the user:
-
-- "What is your Salesforce agent ID? (You can find it in Setup → Agents → select an agent → copy the ID from the URL. It's an 18-character ID starting with `0Xx`.)"
-
-If the user does not provide one:
-
-- Explain that the conversation client **requires** an agent ID and will not function without it.
-- Direct them to **Setup → Agents** in their org.
-- Do **not** proceed to generate the embed code until an agent ID is provided.
-
-## 2. Install the package
-
-```bash
-npm install @salesforce/webapp-template-feature-react-agentforce-conversation-client-experimental
-```
-
-This single install also brings in `@salesforce/agentforce-conversation-client` (the underlying SDK) automatically.
-
-## 3. Use the shared wrapper
-
-Use the `AgentforceConversationClient` React component. It resolves auth automatically:
-
-- **Dev (localhost)**: fetches `frontdoorUrl` from `/__lo/frontdoor`
-- **Prod (hosted in org)**: uses `salesforceOrigin` from `window.location.origin`
-
-## 4. Embed in the layout
-
-Render `<AgentforceConversationClient />` in the app layout so the chat client loads globally. Keep it alongside the existing layout (do not replace the page shell). **Always pass `agentId`.**
-
-```tsx
-import { Outlet } from "react-router";
-import { AgentforceConversationClient } from "@salesforce/webapp-template-feature-react-agentforce-conversation-client-experimental";
-
-export default function AppLayout() {
-  return (
-    <>
-      <Outlet />
-      <AgentforceConversationClient
-        agentforceClientConfig={{
-          agentId: "0Xx000000000000AAA",
-        }}
-      />
-    </>
-  );
-}
-```
-
-Replace `"0Xx000000000000AAA"` with the agent ID provided by the user.
-
-## 5. Configure rendering and theming (optional)
-
-Pass additional options via the `agentforceClientConfig` prop:
-
-| Option                             | Purpose                                                    | Required |
-| ---------------------------------- | ---------------------------------------------------------- | -------- |
-| `agentId`                          | The agent to load — **required, will not work without it** | **Yes**  |
-| `renderingConfig.mode`             | `"floating"` (default) or `"inline"`                       | No       |
-| `renderingConfig.width` / `height` | Inline dimensions (number for px, string for CSS)          | No       |
-| `styleTokens`                      | Theme colors and style overrides                           | No       |
-
-See [embed-examples.md](docs/embed-examples.md) for complete examples of each mode.
-
-## 6. Validate prerequisites
-
-Before the conversation client will work, the user must verify all of the following in their Salesforce org:
-
-1. **Agent is active:** The org must have the agent referenced by `agentId` in an **Active** state and deployed to the correct channel (**Setup → Agents**).
-2. **Trusted domains:** The org must allow `localhost:<PORT>` in **Trusted Domains for Inline Frames** (**Setup → Session Settings → Trusted Domains for Inline Frames**). Required for local development.
-3. **First-party cookies disabled:** **"Require first party use of Salesforce cookies"** must be **unchecked/disabled** in **Setup → My Domain**. If this setting is enabled, the embedded conversation client will fail to authenticate and will not load.
-
-## Quick reference: rendering modes
-
-### Floating (default rendering mode)
-
-A persistent chat widget overlay pinned to the bottom-right corner. Floating is the default rendering mode — but `agentId` is still required.
-
-```tsx
-<AgentforceConversationClient
-  agentforceClientConfig={{
-    agentId: "0Xx000000000000AAA",
-  }}
-/>
-```
-
-### Inline
-
-The chat renders within the page layout at a specific size.
-
-```tsx
-<AgentforceConversationClient
-  agentforceClientConfig={{
-    agentId: "0Xx000000000000AAA",
-    renderingConfig: { mode: "inline", width: 420, height: 600 },
-  }}
-/>
-```
-
-### Theming
-
-Use `styleTokens` to customize the chat appearance.
-
-```tsx
-<AgentforceConversationClient
-  agentforceClientConfig={{
-    agentId: "0Xx000000000000AAA",
-    styleTokens: {
-      headerBlockBackground: "#0176d3",
-      headerBlockTextColor: "#ffffff",
-      messageBlockInboundColor: "#0176d3",
-    },
-  }}
-/>
-```
-
-## Troubleshooting
-
-If the chat widget does not appear, fails to authenticate, or behaves unexpectedly, see [troubleshooting.md](docs/troubleshooting.md).