kris/afv-library
1
0
Fork 0
mirror of https://github.com/forcedotcom/afv-library.git synced 2026-08-10 01:32:48 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: workaround llm being eager to scaffold ui

Browse Source
This commit is contained in:
Jose David Rodriguez Velasco 2026-04-01 14:15:32 -04:00
parent c472e3f43c
commit 54b882417e
No known key found for this signature in database
GPG Key ID: 92B747E95BDABF79
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
skills/using-ui-bundle-salesforce-data/SKILL.md
View File

@ -24,6 +24,16 @@ const res = await sdk.fetch?.("/services/apexrest/my-resource");
**Always use optional chaining** (`sdk.graphql?.()`, `sdk.fetch?.()`) — these methods may be undefined in some surfaces. **Always use optional chaining** (`sdk.graphql?.()`, `sdk.fetch?.()`) — these methods may be undefined in some surfaces.
## Preconditions — verify before starting
| # | Requirement | How to verify | If missing |
|---|-------------|---------------|------------|
| 1 | `@salesforce/sdk-data` installed | Check `package.json` in the UI bundle dir | Cannot proceed — tell user to install it |
| 2 | `schema.graphql` at project root | Check if file exists | Run `npm run graphql:schema` from UI bundle dir |
| 3 | Custom objects/fields deployed | Run `graphql-search.sh <Entity>` — no output means not deployed | Ask user to deploy metadata and assign permission sets |
**If preconditions are not met**, you may scaffold components, routes, layout, and UI logic, but use empty arrays / `null` for data and mark query locations with `// TODO: add query after schema verification` and include in the plan to go back, resolve requirements and write the GraphQL. Do not write GraphQL query strings until the schema workflow is complete.
## Supported APIs ## Supported APIs
**Only the following APIs are permitted.** Any endpoint not listed here must not be used. **Only the following APIs are permitted.** Any endpoint not listed here must not be used.
@ -86,9 +96,7 @@ These rules exist because Salesforce GraphQL has platform-specific behaviors tha
The `schema.graphql` file (265K+ lines) is the source of truth. **Never open or parse it directly** — no cat, less, head, tail, editors, or programmatic parsers. The `schema.graphql` file (265K+ lines) is the source of truth. **Never open or parse it directly** — no cat, less, head, tail, editors, or programmatic parsers.
1. Check if `schema.graphql` exists at the SFDX project root Verify preconditions 1–3 (see [Preconditions](#preconditions--verify-before-starting)), then proceed to Step 2.
2. If the file is missing entirely, generate it from the **UI bundle dir** (only in that case): `cd force-app/main/default/uiBundles/<app-name> && npm run graphql:schema`
3. Custom objects appear only after metadata is deployed.
### Step 2: Look Up Entity Schema ### Step 2: Look Up Entity Schema
@ -477,6 +485,8 @@ Two integration patterns:
### Pattern 1 — External `.graphql` file (complex queries) ### Pattern 1 — External `.graphql` file (complex queries)
**One operation per `.graphql` file.** Each file contains exactly one `query` or `mutation` (plus its fragments). Do not combine multiple operations in a single file.
```typescript ```typescript
import { createDataSDK, type NodeOfConnection } from "@salesforce/sdk-data"; import { createDataSDK, type NodeOfConnection } from "@salesforce/sdk-data";
import MY_QUERY from "./query/myQuery.graphql?raw"; // ?raw suffix required import MY_QUERY from "./query/myQuery.graphql?raw"; // ?raw suffix required