@salesforce/ui-bundle-template-app-react-template-b2e 1.119.0 → 1.119.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/AGENT.md CHANGED
@@ -45,7 +45,7 @@ Replace `<appName>` with the actual folder name found under `uiBundles/`. The so
45
45
  └── data/ # Sample data for import (optional)
46
46
  ```
47
47
 
48
- ## Web application source structure
48
+ ## UI Bundle source structure
49
49
 
50
50
  All application code lives inside the UI Bundle's `src/` directory:
51
51
 
@@ -95,9 +95,11 @@ Used for SFDX metadata tooling. Scripts here target LWC/Aura, not the React app.
95
95
 
96
96
  **One-time org setup:** `node scripts/org-setup.mjs --target-org <alias>` runs login, deploy, permset assignment, data import, GraphQL schema/codegen, UI Bundle build, and optionally the dev server. Use `--help` for all flags.
97
97
 
98
- ### 2. Web app directory (primary workspace)
98
+ ### 2. UI Bundle directory (primary workspace)
99
99
 
100
- **Always `cd` into the UI Bundle directory for dev/build/lint/test:**
100
+ **ALL dev, build, lint, and test commands MUST be run from inside the UI Bundle directory (`<sfdx-source>/uiBundles/<appName>/`). Never run them from the project root.**
101
+
102
+ Resolve the correct path from `sfdx-project.json` before running any command. Do not hardcode the path.
101
103
 
102
104
  | Command | Purpose |
103
105
  |---------|---------|
@@ -109,13 +111,17 @@ Used for SFDX metadata tooling. Scripts here target LWC/Aura, not the React app.
109
111
  | `npm run graphql:codegen` | Generate GraphQL types from schema |
110
112
  | `npm run graphql:schema` | Fetch GraphQL schema from org |
111
113
 
112
- **Before completing any change:** run `npm run build` and `npm run lint` from the UI Bundle directory. Both must pass with zero errors.
114
+ **After every task, without exception:**
115
+ 1. Run `npm run build` from the UI Bundle directory — must pass with zero errors.
116
+ 2. Run `npm run lint` from the UI Bundle directory — must pass with zero errors.
117
+ 3. Run `npm run dev` to start the dev server so the user can verify the result.
113
118
 
119
+ Do not consider a task complete until all three steps have been run successfully.
114
120
  ## Development conventions
115
121
 
116
122
  ### UI
117
123
 
118
- - **Component library:** shadcn/ui primitives in `src/components/ui/`. Always use these over raw HTML equivalents.
124
+ - **Component library:** shadcn/ui primitives in `src/components/ui/`. Always use these over raw HTML equivalents. **Before importing any component, verify both the file exists in `src/components/ui/` AND the named export exists within that file.** Never assume a component or export is available — read the file to confirm the exact exports before importing.
119
125
  - **Styling:** Tailwind CSS only. No inline `style={{}}`. Use `cn()` from `@/lib/utils` for conditional classes.
120
126
  - **Icons:** Lucide React.
121
127
  - **Path alias:** `@/*` maps to `src/*`. Use it for all imports.
@@ -140,6 +146,10 @@ Used for SFDX metadata tooling. Scripts here target LWC/Aura, not the React app.
140
146
 
141
147
  ### Data access (Salesforce)
142
148
 
149
+ **Before writing any code that connects to Salesforce, you MUST invoke the `using-ui-bundle-salesforce-data` skill. Do not write any data access code without consulting it first.**
150
+
151
+ This applies to: GraphQL queries/mutations, REST calls, SDK initialization, custom hooks that fetch data, or any code that imports from `@salesforce/sdk-data`.
152
+
143
153
  - **All data access uses the Data SDK** (`@salesforce/sdk-data`) via `createDataSDK()`.
144
154
  - **Never** use `fetch()` or `axios` directly for Salesforce data.
145
155
  - **GraphQL is preferred** for record operations (`sdk.graphql`). Use `sdk.fetch` only when GraphQL cannot cover the case (UI API REST, Apex REST, Connect REST, Einstein LLM).
@@ -149,25 +159,74 @@ Used for SFDX metadata tooling. Scripts here target LWC/Aura, not the React app.
149
159
  - Use `__SF_API_VERSION__` global for API version in REST calls.
150
160
  - **Blocked APIs:** Enterprise REST query endpoint (`/query` with SOQL), `@AuraEnabled` Apex, Chatter API.
151
161
 
162
+ #### Permitted APIs
163
+
164
+ | API | Method | Endpoints / Use Case |
165
+ |-----|--------|----------------------|
166
+ | GraphQL | `sdk.graphql` | All record queries and mutations via `uiapi { }` namespace |
167
+ | UI API REST | `sdk.fetch` | `/services/data/v{ver}/ui-api/records/{id}` |
168
+ | Apex REST | `sdk.fetch` | `/services/apexrest/{resource}` |
169
+ | Connect REST | `sdk.fetch` | `/services/data/v{ver}/connect/...` |
170
+ | Einstein LLM | `sdk.fetch` | `/services/data/v{ver}/einstein/llm/prompt/generations` |
171
+
172
+ Any endpoint not listed above is not permitted.
173
+
174
+ #### GraphQL non-negotiable rules
175
+
176
+ 1. **Schema is the single source of truth** — every entity and field name must be confirmed via the schema search script before use. Never guess.
177
+ 2. **`@optional` on all record fields** — FLS causes entire queries to fail if any field is inaccessible. Apply to every scalar, parent, and child relationship field.
178
+ 3. **Correct mutation syntax** — mutations wrap under `uiapi(input: { allOrNone: true/false })`, not bare `uiapi { ... }`.
179
+ 4. **Explicit `first:` in every query** — omitting it silently defaults to 10 records. Always include `pageInfo { hasNextPage endCursor }` for paginated queries.
180
+ 5. **SOQL-derived execution limits** — max 10 subqueries per request, max 5 levels of child-to-parent traversal, max 1 level parent-to-child, max 2,000 records per subquery.
181
+ 6. **HTTP 200 does not mean success** — Salesforce returns HTTP 200 even on failure. Always check the `errors` array in the response body.
182
+
183
+ #### GraphQL inline queries
184
+ Must use the `gql` template tag from `@salesforce/sdk-data` — plain template strings bypass `@graphql-eslint` schema validation. For complex queries, use external `.graphql` files with codegen.
185
+
186
+ #### Current user info
187
+ Use GraphQL (`uiapi { currentUser { Id Name { value } } }`), not Chatter (`/chatter/users/me`).
188
+
189
+ #### Schema file (`schema.graphql`)
190
+
191
+ The `schema.graphql` file at the SFDX project root is the source of truth for all entity and field name lookups. It is 265K+ lines — never open or parse it directly. Use the schema search script instead.
192
+
193
+ - **Generate/refresh:** Run `npm run graphql:schema` from the UI bundle directory
194
+ - **When to regenerate:** After any metadata deployment that changes objects, fields, or permission sets
195
+ - **Custom objects** only appear in the schema after metadata deployment AND permission set assignment
196
+ - **After regenerating:** Always re-run `npm run graphql:codegen` and `npm run build` (schema changes may affect generated types)
197
+
152
198
  ### CSP trusted sites
153
199
 
154
200
  Any external domain the app calls (APIs, CDNs, fonts) must have a `.cspTrustedSite-meta.xml` file under `<sfdx-source>/cspTrustedSites/`. Unregistered domains are blocked at runtime. Each subdomain needs its own entry. URLs must be HTTPS with no trailing slash, no path, and no wildcards.
155
201
 
202
+ ## Building and launching the app
203
+
204
+ All build, dev, and test commands run from the UI Bundle directory. Before running any command, read the UI Bundle's `package.json` to confirm available scripts — do not assume script names.
205
+
206
+ Typical scripts found in the UI Bundle:
207
+
208
+ | Command | Purpose |
209
+ |---------|---------|
210
+ | `npm run build` | TypeScript check + Vite production build |
211
+ | `npm run dev` | Start Vite dev server |
212
+ | `npm run lint` | ESLint |
213
+ | `npm run test` | Vitest unit tests |
214
+ | `npm run graphql:codegen` | Generate GraphQL types |
215
+ | `npm run graphql:schema` | Fetch GraphQL schema from org |
216
+
217
+ If dependencies have not been installed yet, run `npm install` in the UI Bundle directory first. Alternatively, run `npm run sf-project-setup` from the project root — it resolves the UI Bundle directory automatically and runs install, build, and dev in sequence.
218
+
219
+ **After any JavaScript or TypeScript change, run `npm run build` to validate the change.** If the build fails, read the error output, identify the cause, fix it, and run `npm run build` again. Do not move on until the build passes.
220
+
156
221
  ## Deploying
157
222
 
158
223
  **Deployment order matters.** Metadata (objects, permission sets) must be deployed before fetching the GraphQL schema. After any metadata deployment that changes objects, fields, or permissions, re-run schema fetch and codegen.
159
224
 
160
- **Recommended sequence:**
225
+ **Deployment steps:**
161
226
 
162
227
  1. Authenticate to the target org
163
228
  2. Build the UI Bundle (`npm run build` in the UI Bundle directory)
164
229
  3. Deploy metadata (`sf project deploy start --source-dir <packageDir> --target-org <alias>`)
165
- 4. Assign permission sets
166
- 5. Import data (only with user confirmation)
167
- 6. Fetch GraphQL schema + run codegen (`npm run graphql:schema && npm run graphql:codegen`)
168
- 7. Rebuild the UI Bundle (schema changes may affect generated types)
169
-
170
- **Or use the one-time org setup:** `node scripts/org-setup.mjs --target-org <alias>`
171
230
 
172
231
  ```bash
173
232
  # Deploy UI Bundle only
@@ -177,17 +236,17 @@ sf project deploy start --source-dir <sfdx-source>/ui-bundles --target-org <alia
177
236
  sf project deploy start --source-dir <packageDir> --target-org <alias>
178
237
  ```
179
238
 
180
- ## Skills
239
+ **Do not open the app after deployment.** Do not run `sf org open`, do not guess the runtime URL, and do not construct paths like `/s/<appName>`. Deployment is complete when the `sf project deploy start` command succeeds.
181
240
 
182
- Check for available skills before implementing any of the following:
241
+ ## Post-deployment org setup
183
242
 
184
- | Area | When to consult |
185
- |------|----------------|
186
- | UI generation | Building pages, components, modifying header/footer/layout |
187
- | Salesforce data access | Reading/writing records, GraphQL queries, REST calls |
188
- | Metadata and deployment | Scaffolding apps, configuring CSP, deployment sequencing |
189
- | Feature installation | Before building something from scratch check if a pre-built feature exists |
190
- | File upload | Adding file upload with Salesforce ContentVersion |
191
- | Agentforce conversation | Adding or modifying the Agentforce chat widget |
243
+ These steps apply after a fresh deployment to configure the org. They are not part of routine deployment.
244
+
245
+ 1. Assign permission sets
246
+ 2. Import data (only with user confirmation)
247
+ 3. Fetch GraphQL schema + run codegen (`npm run graphql:schema && npm run graphql:codegen`)
248
+ 4. Rebuild the UI Bundle (`npm run build`schema changes may affect generated types)
249
+
250
+ ## Skills
192
251
 
193
- Skills are the authoritative source for detailed patterns, constraints, and code examples in each area. This file provides project-level orientation; skills provide implementation depth.
252
+ Before starting any task, check whether a relevant skill exists. If one does, invoke it before writing any code or making any implementation decision. Skills are the authoritative source for patterns, constraints, and code examples.
package/dist/CHANGELOG.md CHANGED
@@ -3,6 +3,22 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.119.2](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.119.1...v1.119.2) (2026-03-31)
7
+
8
+ **Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
9
+
10
+
11
+
12
+
13
+
14
+ ## [1.119.1](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.119.0...v1.119.1) (2026-03-31)
15
+
16
+ **Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
17
+
18
+
19
+
20
+
21
+
6
22
  # [1.119.0](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.118.4...v1.119.0) (2026-03-31)
7
23
 
8
24
  **Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
package/dist/README.md CHANGED
@@ -8,19 +8,42 @@ This project ships the UI Bundle only. No additional Salesforce metadata (object
8
8
 
9
9
  | Path | Description |
10
10
  | ---------------------------------------------------- | --------------------------------------- |
11
- | `force-app/main/default/uiBundles/reactinternalapp/` | React UI Bundle (source, config, tests) |
11
+ | `force-app/main/default/uibundles/reactinternalapp/` | React UI Bundle (source, config, tests) |
12
12
 
13
13
  ## Getting started
14
14
 
15
- Navigate to the UI Bundle and install dependencies:
15
+ Install project dependencies and start the local dev server:
16
16
 
17
17
  ```bash
18
- cd force-app/main/default/uiBundles/reactinternalapp
19
18
  npm install
20
- npm run dev
19
+ npm run sf-project-setup
21
20
  ```
22
21
 
23
- Opens at http://localhost:5173 by default. For build and test instructions, see the [UI Bundle README](force-app/main/default/uiBundles/reactinternalapp/README.md).
22
+ This installs the UI Bundle dependencies, builds the app, and opens the dev server at http://localhost:5173. For manual build and test instructions, see the [UI Bundle README](force-app/main/default/uiBundles/reactinternalapp/README.md).
23
+
24
+ ## Add features
25
+
26
+ Use the features CLI to install additional UI features into the UI Bundle.
27
+
28
+ List all available features:
29
+
30
+ ```bash
31
+ npx @salesforce/ui-bundle-features-experimental list
32
+ ```
33
+
34
+ Get details about a specific feature (description, dependencies, files, and integration examples):
35
+
36
+ ```bash
37
+ npx @salesforce/ui-bundle-features-experimental describe <feature-name>
38
+ ```
39
+
40
+ Install a feature:
41
+
42
+ ```bash
43
+ npx @salesforce/ui-bundle-features-experimental install <feature-name> --ui-bundle-dir reactinternalapp
44
+ ```
45
+
46
+ After installation, the CLI will list any `__example__` files that need manual integration. Read each example file to see the integration pattern, apply it to the target file, then delete the example file.
24
47
 
25
48
  ## Deploy
26
49
 
@@ -35,11 +58,43 @@ sf project deploy start --source-dir force-app --target-org <alias>
35
58
 
36
59
  ```bash
37
60
  cd force-app/main/default/uiBundles/reactinternalapp && npm install && npm run build && cd -
38
- sf project deploy start --source-dir force-app/main/default/ui-bundles --target-org <alias>
61
+ sf project deploy start --source-dir force-app/main/default/uiBundles --target-org <alias>
39
62
  ```
40
63
 
41
64
  Replace `<alias>` with your target org alias.
42
65
 
66
+ ## Setup scripts
67
+
68
+ Two npm scripts at the project root streamline getting started and deployment.
69
+
70
+ **`npm run sf-project-setup`** — installs the UI Bundle dependencies, builds the app, and starts the dev server (see [Getting started](#getting-started)).
71
+
72
+ **`npm run setup`** — runs the full deployment setup in one command: org login (if needed), UI Bundle build, deploy the UI Bundle, fetch GraphQL schema, run codegen, and optionally start the dev server:
73
+
74
+ ```bash
75
+ npm run setup -- --target-org <alias>
76
+ ```
77
+
78
+ Running without flags presents an interactive step picker. Pass `--yes` to skip it and run all steps immediately:
79
+
80
+ ```bash
81
+ npm run setup -- --target-org <alias> --yes
82
+ ```
83
+
84
+ Common options:
85
+
86
+ | Option | Description |
87
+ | ------------------------- | ---------------------------------------------- |
88
+ | `--skip-login` | Skip browser login (org already authenticated) |
89
+ | `--skip-deploy` | Do not deploy metadata |
90
+ | `--skip-graphql` | Skip GraphQL schema fetch and codegen |
91
+ | `--skip-ui-bundle-build` | Skip `npm install` and UI Bundle build |
92
+ | `--skip-dev` | Do not start the dev server at the end |
93
+ | `--ui-bundle-name <name>` | UI Bundle folder name when multiple exist |
94
+ | `-y, --yes` | Skip interactive step picker; run all steps |
95
+
96
+ For all options: `npm run setup -- --help`.
97
+
43
98
  ## Configure Your Salesforce DX Project
44
99
 
45
100
  The `sfdx-project.json` file contains useful configuration information for your project. See [Salesforce DX Project Configuration](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) in the _Salesforce DX Developer Guide_ for details about this file.
@@ -15,8 +15,8 @@
15
15
  "graphql:schema": "node scripts/get-graphql-schema.mjs"
16
16
  },
17
17
  "dependencies": {
18
- "@salesforce/sdk-data": "^1.119.0",
19
- "@salesforce/ui-bundle": "^1.119.0",
18
+ "@salesforce/sdk-data": "^1.119.2",
19
+ "@salesforce/ui-bundle": "^1.119.2",
20
20
  "@tailwindcss/vite": "^4.1.17",
21
21
  "class-variance-authority": "^0.7.1",
22
22
  "clsx": "^2.1.1",
@@ -42,7 +42,7 @@
42
42
  "@graphql-eslint/eslint-plugin": "^4.1.0",
43
43
  "@graphql-tools/utils": "^11.0.0",
44
44
  "@playwright/test": "^1.49.0",
45
- "@salesforce/vite-plugin-ui-bundle": "^1.119.0",
45
+ "@salesforce/vite-plugin-ui-bundle": "^1.119.2",
46
46
  "@testing-library/jest-dom": "^6.6.3",
47
47
  "@testing-library/react": "^16.1.0",
48
48
  "@testing-library/user-event": "^14.5.2",
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@salesforce/webapp-template-base-sfdx-project-experimental",
3
- "version": "1.119.0",
3
+ "version": "1.119.2",
4
4
  "lockfileVersion": 3,
5
5
  "requires": true,
6
6
  "packages": {
7
7
  "": {
8
8
  "name": "@salesforce/webapp-template-base-sfdx-project-experimental",
9
- "version": "1.119.0",
9
+ "version": "1.119.2",
10
10
  "license": "SEE LICENSE IN LICENSE.txt",
11
11
  "devDependencies": {
12
12
  "@lwc/eslint-plugin-lwc": "^3.3.0",
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/ui-bundle-template-base-sfdx-project",
3
- "version": "1.119.0",
3
+ "version": "1.119.2",
4
4
  "description": "Base SFDX project template",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "publishConfig": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/ui-bundle-template-app-react-template-b2e",
3
- "version": "1.119.0",
3
+ "version": "1.119.2",
4
4
  "description": "Salesforce React internal app template",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "author": "",