@salesforce/ui-bundle-template-feature-angular-authentication 12.5.4

package/LICENSE.txt

@@ -0,0 +1,82 @@
+Terms of Use
+
+Copyright 2026 Salesforce, Inc. All rights reserved.
+
+These Terms of Use govern the download, installation, and/or use of this
+software provided by Salesforce, Inc. ("Salesforce") (the "Software"), were
+last updated on April 15, 2025, and constitute a legally binding
+agreement between you and Salesforce. If you do not agree to these Terms of
+Use, do not install or use the Software.
+
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free
+copyright license to reproduce, prepare derivative works of, publicly
+display, publicly perform, sublicense, and distribute the Software and
+derivative works subject to these Terms. These Terms shall be included in
+all copies or substantial portions of the Software.
+
+Subject to the limited rights expressly granted hereunder, Salesforce
+reserves all rights, title, and interest in and to all intellectual
+property subsisting in the Software. No rights are granted to you hereunder
+other than as expressly set forth herein. Users residing in countries on
+the United States Office of Foreign Assets Control sanction list, or which
+are otherwise subject to a US export embargo, may not use the Software.
+
+Implementation of the Software may require development work, for which you
+are responsible. The Software may contain bugs, errors and
+incompatibilities and is made available on an AS IS basis without support,
+updates, or service level commitments.
+
+Salesforce reserves the right at any time to modify, suspend, or
+discontinue, the Software (or any part thereof) with or without notice. You
+agree that Salesforce shall not be liable to you or to any third party for
+any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or
+proceeding made or brought against Salesforce by a third party arising out
+of or accruing from (a) your use of the Software, and (b) any application
+you develop with the Software that infringes any copyright, trademark,
+trade secret, trade dress, patent, or other intellectual property right of
+any person or defames any person or violates their rights of publicity or
+privacy (each a "Claim Against Salesforce"), and will indemnify Salesforce
+from any damages, attorney fees, and costs finally awarded against
+Salesforce as a result of, or for any amounts paid by Salesforce under a
+settlement approved by you in writing of, a Claim Against Salesforce,
+provided Salesforce (x) promptly gives you written notice of the Claim
+Against Salesforce, (y) gives you sole control of the defense and
+settlement of the Claim Against Salesforce (except that you may not settle
+any Claim Against Salesforce unless it unconditionally releases Salesforce
+of all liability), and (z) gives you all reasonable assistance, at your
+expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT
+SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES,
+INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL,
+PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA,
+OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN
+CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU
+HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+These Terms of Use shall be governed exclusively by the internal laws of
+the State of California, without regard to its conflicts of laws
+rules. Each party hereby consents to the exclusive jurisdiction of the
+state and federal courts located in San Francisco County, California to
+adjudicate any dispute arising out of or relating to these Terms of Use and
+the download, installation, and/or use of the Software. Except as expressly
+stated herein, these Terms of Use constitute the entire agreement between
+the parties, and supersede all prior and contemporaneous agreements,
+proposals, or representations, written or oral, concerning their subject
+matter. No modification, amendment, or waiver of any provision of these
+Terms of Use shall be effective unless it is by an update to these Terms of
+Use that Salesforce makes available, or is in writing and signed by the
+party against whom the modification, amendment, or waiver is to be
+asserted.
+
+Data Privacy: Salesforce may collect, process, and store device,
+system, and other information related to your use of the Software. This
+information includes, but is not limited to, IP address, user metrics, and
+other data ("Usage Data"). Salesforce may use Usage Data for analytics,
+product development, and marketing purposes. You acknowledge that files
+generated in conjunction with the Software may contain sensitive or
+confidential data, and you are solely responsible for anonymizing and
+protecting such data.

package/README.md

@@ -0,0 +1,130 @@
+# feature-angular-authentication
+
+Complete user **authentication** for **Angular** UI Bundles: login, registration,
+password management, session timeout, and route protection.
+
+This feature ships:
+
+- **`authGuard`** — a functional route guard that protects authenticated-only routes.
+- **`AuthService`** — an injectable service that resolves the current user and manages auth state.
+- **`AuthAppLayoutComponent`** — a route layout for the authenticated shell.
+- **Authentication pages** — Login, Register, Profile, Forgot Password, Reset Password, Change Password.
+- **Apex classes** — the server-side handlers (`UIBundleLogin`, `UIBundleRegistration`, `UIBundleForgotPassword`, `UIBundleChangePassword`, `UIBundleAuthUtils`).
+
+Built with Angular standalone components, signals, and Reactive Forms.
+
+## Features
+
+- Checks authentication status via UI API GraphQL (`uiapi.currentUser`).
+- Protects routes with `authGuard`, redirecting unauthenticated users to login.
+- Supports a return URL (`retUrl`) query parameter for post-login navigation.
+- Session timeout with a configurable duration.
+- Password strength validation via hand-written reactive-form validators.
+- Forgot password and reset password flows.
+- User profile display and change-password functionality.
+
+## Install
+
+```bash
+npx @salesforce/ui-bundle-features-experimental install angular-authentication --ui-bundle-dir <your-ui-bundle>
+```
+
+This copies the authentication library, the auth pages, the profile GraphQL
+service, and the Apex handler classes into your project. It also copies the
+feature's route file to
+`src/app/features/authentication/__example__authentication-routes.ts` as an
+integration example — the CLI lists it as an `__example__` file to review, merge,
+and delete.
+
+## Usage
+
+### Protecting routes
+
+Add the auth routes from the example file into your app's route file
+(`src/app/app.routes.ts`). The top-level layout node swaps to
+`AuthAppLayoutComponent`, and protected routes use `canActivate: [authGuard]`:
+
+```typescript
+import { Routes } from "@angular/router";
+import { AuthAppLayoutComponent } from "./features/authentication/...";
+import { authGuard } from "./features/authentication/auth/auth.guard";
+import { ProfilePageComponent } from "./pages/profile/profile-page";
+
+export const routes: Routes = [
+  {
+    path: "",
+    component: AuthAppLayoutComponent,
+    children: [
+      { path: "login", loadComponent: () => import("./pages/login/login-page") },
+      { path: "register", loadComponent: () => import("./pages/register/register-page") },
+      {
+        path: "profile",
+        canActivate: [authGuard],
+        component: ProfilePageComponent,
+      },
+      // ...forgot-password, reset-password, change-password
+    ],
+  },
+];
+```
+
+The feature's route file (copied on install to
+`__example__authentication-routes.ts`) shows the full route set — merge it into
+your own route file rather than replacing it, so your existing routes are
+preserved, then delete the example file.
+
+### Reading auth state
+
+Inject `AuthService` in any component to read the current user and auth state:
+
+```typescript
+import { Component, inject } from "@angular/core";
+import { AuthService } from "./features/authentication/auth/auth.service";
+
+@Component({
+  /* ... */
+})
+export class MyComponent {
+  private readonly auth = inject(AuthService);
+
+  readonly user = this.auth.user; // signal
+  readonly isAuthenticated = this.auth.isAuthenticated; // signal
+}
+```
+
+## Local preview limitations
+
+Some authentication surfaces **only work on the deployed Experience site**, not
+in local preview (`npm run dev` on `http://localhost`). This is expected: the
+local dev server proxies requests to the org **outside the Experience site's
+guest/community context**, so the site session does not exist.
+
+| Surface                                      | Local preview (`localhost`)                                                         | Deployed site                                             |
+| -------------------------------------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| **Login / registration / password flows**    | The site session cannot be established, so these fail with a generic message.       | Work — the platform completes the flow.                   |
+| **MFA challenge**                            | The site session cannot be established, so login fails with a generic message.      | Works — the platform renders and completes the challenge. |
+| **Current-user check** (`uiapi.currentUser`) | Works — the local dev proxy forwards GraphQL calls with the CLI-authenticated user. | Works                                                     |
+
+**How to test these:** open the **published site** login page, e.g.
+`https://<your-domain>.site.com/<site-path>/login`. The login failure above is
+expected locally and is **not** a misconfiguration.
+
+## Notes
+
+- Routes integrate by **merging** the feature's `app.routes.ts` into your app's
+  route file — the top-level layout node swaps to `AuthAppLayoutComponent`, and
+  the auth routes are appended alongside your existing routes.
+- The Apex classes deploy to your project's `classes/` directory and are
+  required for the login/registration/password flows to work server-side.
+- This feature is dependency-free at the package level — Angular, the router, and
+  forms are provided by the base app.
+
+## Development
+
+```bash
+# Build the feature (applies patches from template to dist)
+npm run build
+
+# Type-check
+npm run typecheck
+```

package/dist/.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/dist/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run precommit

package/dist/.prettierignore

@@ -0,0 +1,11 @@
+# List files or directories below to ignore them when running prettier
+# More information: https://prettier.io/docs/en/ignore.html
+#
+
+**/staticresources/**
+.localdevserver
+.sfdx
+.sf
+.vscode
+
+coverage/

package/dist/.prettierrc

@@ -0,0 +1,17 @@
+{
+  "trailingComma": "none",
+  "plugins": [
+    "prettier-plugin-apex",
+    "@prettier/plugin-xml"
+  ],
+  "overrides": [
+    {
+      "files": "**/lwc/**/*.html",
+      "options": { "parser": "lwc" }
+    },
+    {
+      "files": "*.{cmp,page,component}",
+      "options": { "parser": "html" }
+    }
+  ]
+}