@salesforce/templates 66.11.1 → 66.12.0

package/lib/templates/project/angularintapp/README.md

@@ -0,0 +1,77 @@
+# Salesforce DX Project: Next Steps
+
+Now that you’ve created a Salesforce DX project, what’s next? Here are some documentation resources to get you started.
+
+## Web app: install, build, and dev server
+
+From the **SFDX project root** (this directory), run:
+
+```bash
+npm run sf-project-setup
+```
+
+This installs dependencies in the UI Bundle, builds it, and starts the Vite dev server. Use this after cloning or extracting the project.
+
+## Set up the org
+
+`npm run setup` configures a target org from this project in one command: it logs in
+(a required precondition — auto-skipped if the org is already connected), deploys
+metadata, assigns permission sets, imports sample data, refreshes the GraphQL
+schema/types, and builds the UI Bundle. When `--target-org` is omitted it uses your
+default org or, in an interactive terminal, prompts you to pick one.
+
+```bash
+npm run setup -- --target-org <alias>     # or omit --target-org to use the default / pick
+```
+
+Setup does **not** start the dev server. Once the org is set up, use `dev:preview` to
+refresh the GraphQL types against the org and launch the Vite dev server on its own:
+
+```bash
+npm run dev:preview
+```
+
+### Setup configuration (`scripts/org-setup.config.json`)
+
+`org-setup.config.json` controls which steps run and how. Every top-level section is
+optional; an absent section hides its step. It is validated against a shared schema
+at build/CI time and again at the start of every `npm run setup`, so a malformed
+config fails fast rather than misbehaving.
+
+```jsonc
+{
+  "permsetAssignments": {
+    "assignments": {
+      "My_Access": { "assignee": "currentUser" }
+    }
+  },
+  "role": { "assignee": "currentUser", "roleName": "Admin" },
+  "selfRegistration": {
+    "selfRegProfile": "My Prospect Profile",
+    "accountName": "My Self-Registration"
+  }
+}
+```
+
+When a `selfRegistration` section is present, setup runs a **license pre-check**
+before configuring self-registration: it derives the required `UserLicense` from the
+configured `selfRegProfile` (matched on the stable `LicenseDefinitionKey`, not the
+display name) and, if the org lacks that license or has no available seats, **warns
+and skips** self-registration instead of reporting success — so prospect login can't
+silently fail on an under-provisioned org. No separate license field is configured;
+the requirement always follows the profile the flow assigns.
+
+## How Do You Plan to Deploy Your Changes?
+
+Do you want to deploy a set of changes, or create a self-contained application? Choose a [development model](https://developer.salesforce.com/tools/vscode/en/user-guide/development-models).
+
+## Configure Your Salesforce DX Project
+
+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.
+
+## Read All About It
+
+- [Salesforce Extensions Documentation](https://developer.salesforce.com/tools/vscode/)
+- [Salesforce CLI Setup Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm)
+- [Salesforce DX Developer Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm)
+- [Salesforce CLI Command Reference](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference.htm)

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/.forceignore

@@ -0,0 +1,15 @@
+# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
+# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
+#
+
+package.xml
+
+# LWC configuration files
+**/jsconfig.json
+**/.eslintrc.json
+
+# LWC Jest
+**/__tests__/**
+
+node_modules/
+.DS_Store

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/.postcssrc.json

@@ -0,0 +1,5 @@
+{
+  "plugins": {
+    "@tailwindcss/postcss": {}
+  }
+}

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/.prettierignore

@@ -0,0 +1,8 @@
+node_modules
+dist
+.angular
+coverage
+*.min.js
+*.min.css
+*.map
+package-lock.json

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 100,
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": "*.html",
+      "options": {
+        "parser": "angular"
+      }
+    }
+  ]
+}

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/README.md

@@ -0,0 +1,85 @@
+# Base Angular App
+
+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.
+
+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.
+
+## Table of contents
+
+- [Run (development)](#run-development)
+- [Build](#build)
+- [Deploy](#deploy)
+- [Test](#test)
+- [Lint](#lint)
+
+## Run (development)
+
+From the UI Bundle directory (`force-app/main/default/uiBundles/base-angular-app`):
+
+```bash
+npm install
+npm run dev
+```
+
+This starts the Salesforce Angular dev server (`sf-angular-serve`).
+
+## Build
+
+From the UI Bundle directory:
+
+```bash
+npm install
+npm run build
+```
+
+The production build is written to `dist/` inside the UI Bundle folder. Use `npm run watch` to rebuild on change in development mode. Deploy using the steps in [Deploy](#deploy).
+
+## Deploy
+
+From the **SFDX project root** (the directory that contains `force-app/`):
+
+1. Build the UI Bundle:
+
+   ```bash
+   cd force-app/main/default/uiBundles/base-angular-app && npm install && npm run build && cd -
+   ```
+
+2. Deploy the UI Bundle only:
+
+   ```bash
+   sf project deploy start --source-dir force-app/main/default/ui-bundles --target-org <alias>
+   ```
+
+   Or deploy all metadata:
+
+   ```bash
+   sf project deploy start --source-dir force-app --target-org <alias>
+   ```
+
+   Replace `<alias>` with your target org alias.
+
+## Test
+
+From the UI Bundle directory:
+
+```bash
+npm install
+npm run test
+```
+
+This runs the unit test suite via `ng test`. For end-to-end tests:
+
+```bash
+npm run build:e2e
+npm run e2e
+```
+
+This builds with E2E asset rewrites and runs Playwright against the static build. Ensure Chromium is installed (`npx playwright install chromium` if needed).
+
+## Lint
+
+From the UI Bundle directory:
+
+```bash
+npm run lint
+```

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/angular.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "cli": {
+    "packageManager": "npm",
+    "analytics": false,
+    "cache": {
+      "enabled": false
+    }
+  },
+  "newProjectRoot": "projects",
+  "projects": {
+    "angularintapp": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-builders/custom-esbuild:application",
+          "options": {
+            "outputPath": {
+              "base": "dist",
+              "browser": ""
+            },
+            "deployUrl": "./",
+            "browser": "src/main.ts",
+            "tsConfig": "tsconfig.app.json",
+            "assets": [
+              {
+                "glob": "**/*",
+                "input": "public"
+              }
+            ],
+            "styles": ["src/theme.scss", "src/styles.scss"],
+            "stylePreprocessorOptions": {
+              "sass": {
+                "silenceDeprecations": ["import"]
+              }
+            },
+            "plugins": ["./esbuild/api-version.mjs"]
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "4kB",
+                  "maximumError": "8kB"
+                }
+              ],
+              "outputHashing": "all",
+              "optimization": {
+                "scripts": true,
+                "styles": {
+                  "minify": true,
+                  "inlineCritical": false
+                }
+              }
+            },
+            "development": {
+              "optimization": false,
+              "extractLicenses": false,
+              "sourceMap": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-builders/custom-esbuild:dev-server",
+          "options": {
+            "middlewares": ["./middleware/html.mjs", "./middleware/proxy.mjs"]
+          },
+          "configurations": {
+            "production": {
+              "buildTarget": "angularintapp:build:production"
+            },
+            "development": {
+              "buildTarget": "angularintapp:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "test": {
+          "builder": "@angular/build:unit-test"
+        },
+        "lint": {
+          "builder": "@angular-eslint/builder:lint",
+          "options": {
+            "lintFilePatterns": ["src/**/*.ts", "src/**/*.html"]
+          }
+        }
+      }
+    }
+  }
+}

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/angularintapp.uibundle-meta.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<UIBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <masterLabel>angularintapp</masterLabel>
+    <description>A Salesforce UI Bundle.</description>
+    <isActive>true</isActive>
+    <version>1</version>
+    <target>CustomApplication</target>
+</UIBundle>

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/e2e/app.spec.ts

@@ -0,0 +1,15 @@
+import { test, expect } from '@playwright/test';
+
+test.describe('base-angular-app', () => {
+	test('home page loads and shows welcome content', async ({ page }) => {
+		await page.goto('/');
+		await expect(page.getByRole('heading', { name: 'Home' })).toBeVisible();
+		await expect(page.getByText('Welcome to your Angular application.')).toBeVisible();
+	});
+
+	test('not found route shows 404', async ({ page }) => {
+		await page.goto('/non-existent-route');
+		await expect(page.getByRole('heading', { name: '404' })).toBeVisible();
+		await expect(page.getByText('Page not found')).toBeVisible();
+	});
+});

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/esbuild/api-version.mjs

@@ -0,0 +1,17 @@
+/**
+ * Build-time substitution of `__SF_API_VERSION__` (production + main app code in dev).
+ *
+ * Resolves the connected org's API version (from `sf` CLI session) once at
+ * builder startup and injects it via esbuild's `define`. Falls back to "65.0"
+ * if no session is available — matches @salesforce/platform-sdk's default.
+ *
+ * In `ng serve`, this plugin runs on the application esbuild pass but does NOT
+ * reach Vite's optimizeDeps prebundle of node_modules. `scripts/dev.mjs` covers
+ * that gap by passing the same value via `ng serve --define`.
+ *
+ * Referenced from angular.json: architect.build.options.plugins[].
+ */
+import { createApiVersionPlugin } from '@salesforce/angular-plugin-ui-bundle';
+
+const { plugin } = await createApiVersionPlugin();
+export default plugin;

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/eslint.config.js

@@ -0,0 +1,60 @@
+import js from '@eslint/js';
+import angular from 'angular-eslint';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+	// Global ignores
+	{
+		ignores: ['dist/**/*', '.angular/**/*', 'coverage/**/*', 'node_modules/**/*'],
+	},
+	// TypeScript files
+	{
+		files: ['**/*.ts'],
+		extends: [
+			js.configs.recommended,
+			...tseslint.configs.recommended,
+			...angular.configs.tsRecommended,
+		],
+		processor: angular.processInlineTemplates,
+		rules: {
+			'@angular-eslint/directive-selector': [
+				'error',
+				{
+					type: 'attribute',
+					prefix: 'app',
+					style: 'camelCase',
+				},
+			],
+			'@angular-eslint/component-selector': [
+				'error',
+				{
+					type: 'element',
+					prefix: 'app',
+					style: 'kebab-case',
+				},
+			],
+			// The UI wrapper components (app-button, app-card, …) intentionally
+			// alias an input to `class` so callers can write `class="…"` on the host
+			// and have it forward to the inner Material element. Allow that one name.
+			'@angular-eslint/no-input-rename': ['error', { allowedNames: ['class'] }],
+			'@typescript-eslint/no-unused-vars': [
+				'error',
+				{
+					argsIgnorePattern: '^_',
+					varsIgnorePattern: '^_',
+					caughtErrorsIgnorePattern: '^_',
+					ignoreRestSiblings: true,
+				},
+			],
+			'@typescript-eslint/no-explicit-any': 'off',
+			'@typescript-eslint/explicit-function-return-type': 'off',
+			'@typescript-eslint/explicit-module-boundary-types': 'off',
+		},
+	},
+	// Template files
+	{
+		files: ['**/*.html'],
+		extends: [...angular.configs.templateRecommended, ...angular.configs.templateAccessibility],
+		rules: {},
+	},
+);

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/middleware/html.mjs

@@ -0,0 +1,3 @@
+import { createHtmlMiddleware } from '@salesforce/angular-plugin-ui-bundle';
+
+export default await createHtmlMiddleware();

package/lib/templates/project/angularintapp/_p_/_m_/_w_/_a_/middleware/proxy.mjs

@@ -0,0 +1,12 @@
+/**
+ * Proxy middleware for Angular CLI dev server.
+ *
+ * Forwards `/services/*` and other manifest-routed paths to the connected
+ * Salesforce org with authentication. Watches `ui-bundle.json` for changes
+ * and recreates the proxy handler automatically (manual browser refresh needed).
+ *
+ * Referenced from angular.json: architect.serve.options.middlewares[].
+ */
+import { createProxyMiddleware } from '@salesforce/angular-plugin-ui-bundle';
+
+export default await createProxyMiddleware();