@salesforce/ui-bundle-template-app-angular-template-b2e 12.5.3 → 12.5.5
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/README.md +54 -0
- package/dist/CHANGELOG.md +16 -0
- package/dist/README.md +82 -44
- package/dist/force-app/main/default/uiBundles/angularintapp/README.md +1 -1
- package/dist/force-app/main/default/uiBundles/angularintapp/package.json +3 -3
- package/dist/package-lock.json +2 -2
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Angular Internal App
|
|
2
|
+
|
|
3
|
+
Angular internal app template — Agentforce conversation client and object search across Salesforce records, surfaced through a CustomApplication without a site container.
|
|
4
|
+
|
|
5
|
+
## In this monorepo
|
|
6
|
+
|
|
7
|
+
This package is a **template app** in the ui-bundle monorepo. It is built by applying feature patches to the base Angular app; the output is written to `dist/`.
|
|
8
|
+
|
|
9
|
+
### Build
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
nx run @salesforce/ui-bundle-template-app-angular-template-b2e:build
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Produces an SFDX project in `dist/` with the UI Bundle at `dist/force-app/main/default/uiBundles/angularintapp/`.
|
|
16
|
+
|
|
17
|
+
### Dev server
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
nx run @salesforce/ui-bundle-template-app-angular-template-b2e:dev
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Starts the Salesforce Angular dev server (`sf-angular-serve`) from the built output in `dist/`.
|
|
24
|
+
|
|
25
|
+
### Watch
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
nx run @salesforce/ui-bundle-template-app-angular-template-b2e:watch
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Re-applies patches automatically when source files change.
|
|
32
|
+
|
|
33
|
+
### Test
|
|
34
|
+
|
|
35
|
+
This package has no dedicated test target. To run tests, build first, then run them from the built UI Bundle:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
nx run @salesforce/ui-bundle-template-app-angular-template-b2e:build
|
|
39
|
+
cd dist/force-app/main/default/uiBundles/angularintapp && npm install && npm test
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Runs the unit test suite via `ng test`.
|
|
43
|
+
|
|
44
|
+
### Clean
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm run clean
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Removes the `dist/` directory.
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
For standalone run, deploy, and test instructions (e.g. after publishing or extracting `dist/`), see the [UI Bundle README](dist/force-app/main/default/uiBundles/angularintapp/README.md).
|
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
|
+
## [12.5.5](https://github.com/salesforce-experience-platform-emu/webapps/compare/v12.5.4...v12.5.5) (2026-09-10)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## [12.5.4](https://github.com/salesforce-experience-platform-emu/webapps/compare/v12.5.3...v12.5.4) (2026-09-09)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
## [12.5.3](https://github.com/salesforce-experience-platform-emu/webapps/compare/v12.5.2...v12.5.3) (2026-09-08)
|
|
7
23
|
|
|
8
24
|
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
package/dist/README.md
CHANGED
|
@@ -1,69 +1,107 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Angular Internal App
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
An internal Angular starter template for the Salesforce platform. Includes an Agentforce conversation client and object search across Salesforce records; intended for internal (non-Experience Cloud) deployment via a CustomApplication in the Lightning Experience App Launcher. Built with Angular (standalone components), Spartan NG (`@spartan-ng/brain` primitives with helm UI components copied into `src/app/shared/`), Tailwind CSS, Lucide icons (`@ng-icons/lucide`), and TypeScript.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What's included
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
This project ships the UI Bundle plus a CustomApplication that surfaces it in the Lightning Experience App Launcher. No additional data-model metadata (objects, Apex, etc.) is included — bring your own data model.
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
force-app/main/default/
|
|
11
|
+
├── applications/ # CustomApplication (App Launcher entry)
|
|
12
|
+
├── permissionsets/ # Permission sets
|
|
13
|
+
└── uiBundles/
|
|
14
|
+
└── angularintapp/ # Angular UI Bundle (source, config, tests)
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Getting started
|
|
18
|
+
|
|
19
|
+
Install project dependencies and start the local dev server:
|
|
8
20
|
|
|
9
21
|
```bash
|
|
22
|
+
npm install
|
|
10
23
|
npm run sf-project-setup
|
|
11
24
|
```
|
|
12
25
|
|
|
13
|
-
This installs
|
|
26
|
+
This installs the UI Bundle dependencies, builds the app, and starts the Salesforce Angular dev server (`sf-angular-serve`). For manual build and test instructions, see the [UI Bundle README](force-app/main/default/uiBundles/angularintapp/README.md).
|
|
27
|
+
|
|
28
|
+
## Add features
|
|
29
|
+
|
|
30
|
+
Use the features CLI to install additional UI features into the UI Bundle.
|
|
31
|
+
|
|
32
|
+
List all available features:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npx @salesforce/ui-bundle-features-experimental list
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Get details about a specific feature (description, dependencies, files, and integration examples):
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx @salesforce/ui-bundle-features-experimental describe <feature-name>
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Install a feature:
|
|
14
45
|
|
|
15
|
-
|
|
46
|
+
```bash
|
|
47
|
+
npx @salesforce/ui-bundle-features-experimental install <feature-name> --ui-bundle-dir angularintapp
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
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.
|
|
51
|
+
|
|
52
|
+
## Deploy
|
|
53
|
+
|
|
54
|
+
### Deploy everything (CustomApplication + UI Bundle)
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
cd force-app/main/default/uiBundles/angularintapp && npm install && npm run build && cd -
|
|
58
|
+
sf project deploy start --source-dir force-app --target-org <alias>
|
|
59
|
+
```
|
|
16
60
|
|
|
17
|
-
|
|
18
|
-
(a required precondition — auto-skipped if the org is already connected), deploys
|
|
19
|
-
metadata, assigns permission sets, imports sample data, refreshes the GraphQL
|
|
20
|
-
schema/types, and builds the UI Bundle. When `--target-org` is omitted it uses your
|
|
21
|
-
default org or, in an interactive terminal, prompts you to pick one.
|
|
61
|
+
### Deploy the UI Bundle only
|
|
22
62
|
|
|
23
63
|
```bash
|
|
24
|
-
|
|
64
|
+
cd force-app/main/default/uiBundles/angularintapp && npm install && npm run build && cd -
|
|
65
|
+
sf project deploy start --source-dir force-app/main/default/uiBundles --target-org <alias>
|
|
25
66
|
```
|
|
26
67
|
|
|
27
|
-
|
|
28
|
-
|
|
68
|
+
Replace `<alias>` with your target org alias.
|
|
69
|
+
|
|
70
|
+
## Setup scripts
|
|
71
|
+
|
|
72
|
+
Two npm scripts at the project root streamline getting started and deployment.
|
|
73
|
+
|
|
74
|
+
**`npm run sf-project-setup`** — installs the UI Bundle dependencies, builds the app, and starts the dev server (see [Getting started](#getting-started)).
|
|
75
|
+
|
|
76
|
+
**`npm run setup`** — runs the full deployment setup in one command: org login (a required precondition, auto-skipped if already connected), UI Bundle build, deploy metadata, fetch GraphQL schema, and run codegen. It no longer starts the dev server — run `npm run dev:preview` for that:
|
|
29
77
|
|
|
30
78
|
```bash
|
|
31
|
-
|
|
79
|
+
# Install project dependencies first (required before running setup)
|
|
80
|
+
npm install
|
|
81
|
+
|
|
82
|
+
npm run setup -- --target-org <alias>
|
|
32
83
|
```
|
|
33
84
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
at build/CI time and again at the start of every `npm run setup`, so a malformed
|
|
39
|
-
config fails fast rather than misbehaving.
|
|
40
|
-
|
|
41
|
-
```jsonc
|
|
42
|
-
{
|
|
43
|
-
"permsetAssignments": {
|
|
44
|
-
"assignments": {
|
|
45
|
-
"My_Access": { "assignee": "currentUser" }
|
|
46
|
-
}
|
|
47
|
-
},
|
|
48
|
-
"role": { "assignee": "currentUser", "roleName": "Admin" },
|
|
49
|
-
"selfRegistration": {
|
|
50
|
-
"selfRegProfile": "My Prospect Profile",
|
|
51
|
-
"accountName": "My Self-Registration"
|
|
52
|
-
}
|
|
53
|
-
}
|
|
85
|
+
Running without flags presents an interactive step picker. Pass `--yes` to skip it and run all steps immediately:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
npm run setup -- --target-org <alias> --yes
|
|
54
89
|
```
|
|
55
90
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
91
|
+
Common options:
|
|
92
|
+
|
|
93
|
+
| Option | Description |
|
|
94
|
+
| ------------------------- | ----------------------------------------------- |
|
|
95
|
+
| `--target-org <alias>` | Target org. If omitted, uses default org/prompt |
|
|
96
|
+
| `--skip-deploy` | Do not deploy metadata |
|
|
97
|
+
| `--skip-graphql` | Skip GraphQL schema fetch and codegen |
|
|
98
|
+
| `--skip-ui-bundle-build` | Skip `npm install` and UI Bundle build |
|
|
99
|
+
| `--ui-bundle-name <name>` | UI Bundle folder name when multiple exist |
|
|
100
|
+
| `-y, --yes` | Skip interactive step picker; run all steps |
|
|
63
101
|
|
|
64
|
-
|
|
102
|
+
> Login is a required precondition (no `--skip-login`), and the dev server is no longer part of setup (no `--skip-dev`); both flags are accepted but ignored. To start the dev server after setup, run `npm run dev:preview`.
|
|
65
103
|
|
|
66
|
-
|
|
104
|
+
For all options: `npm run setup -- --help`.
|
|
67
105
|
|
|
68
106
|
## Configure Your Salesforce DX Project
|
|
69
107
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Base Angular App
|
|
2
2
|
|
|
3
|
-
Base Angular App is a template application that demonstrates how to build an Angular UI Bundle on the Salesforce platform with the Angular CLI, TypeScript, Tailwind, and the Salesforce UI Bundle SDK. It provides a minimal shell (home, 404), routing with standalone components and signals, so feature apps can extend it via the patches pipeline.
|
|
3
|
+
Base Angular App is a template application that demonstrates how to build an Angular UI Bundle on the Salesforce platform with the Angular CLI, TypeScript, Tailwind, Spartan NG (shadcn/ui for Angular), and the Salesforce UI Bundle SDK. It provides a minimal shell (home, 404), routing with standalone components and signals, so feature apps can extend it via the patches pipeline.
|
|
4
4
|
|
|
5
5
|
This UI Bundle lives inside an SFDX project. The project root is the directory that contains `force-app/` and `sfdx-project.json`. Run the commands in the sections below from the paths indicated.
|
|
6
6
|
|
|
@@ -28,8 +28,8 @@
|
|
|
28
28
|
"@angular/router": "^21.2.0",
|
|
29
29
|
"@ng-icons/core": "^32.2.0",
|
|
30
30
|
"@ng-icons/lucide": "^32.2.0",
|
|
31
|
-
"@salesforce/angular-plugin-ui-bundle": "^12.5.
|
|
32
|
-
"@salesforce/platform-sdk": "^12.5.
|
|
31
|
+
"@salesforce/angular-plugin-ui-bundle": "^12.5.5",
|
|
32
|
+
"@salesforce/platform-sdk": "^12.5.5",
|
|
33
33
|
"@spartan-ng/brain": "^1.3.1",
|
|
34
34
|
"class-variance-authority": "^0.7.1",
|
|
35
35
|
"clsx": "^2.1.1",
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
"typescript": "~5.9.2",
|
|
63
63
|
"typescript-eslint": "^8.0.0",
|
|
64
64
|
"vitest": "^4.1.0",
|
|
65
|
-
"@salesforce/graphiti": "^12.5.
|
|
65
|
+
"@salesforce/graphiti": "^12.5.5"
|
|
66
66
|
},
|
|
67
67
|
"overrides": {
|
|
68
68
|
"undici": "^7.28.0"
|
package/dist/package-lock.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/ui-bundle-template-base-sfdx-project",
|
|
3
|
-
"version": "12.5.
|
|
3
|
+
"version": "12.5.5",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/ui-bundle-template-base-sfdx-project",
|
|
9
|
-
"version": "12.5.
|
|
9
|
+
"version": "12.5.5",
|
|
10
10
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"fast-xml-parser": "^5.9.3",
|
package/dist/package.json
CHANGED