@salesforce/templates 66.13.4 → 66.13.6

package/lib/templates/project/reactexternalapp/_p_/_m_/classes/UIBundleSocialLoginConfig.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>67.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/lib/templates/project/reactexternalapp/_p_/_m_/classes/UIBundleSocialLoginConfig_Test.cls

@@ -0,0 +1,101 @@
+/**
+ * Test class for UIBundleSocialLoginConfig REST endpoint.
+ *
+ * Auth.AuthConfiguration requires a valid community URL so these tests
+ * exercise the error-handling path and verify the response wrapper structure.
+ * Integration-level testing of actual Auth Provider/SAML discovery happens
+ * in the target org via the React component E2E flow.
+ */
+@isTest
+private class UIBundleSocialLoginConfig_Test {
+
+    /**
+     * Test that the endpoint returns an empty config when no community context
+     * is available (covers the catch block graceful fallback).
+     */
+    @isTest
+    static void testGetConfigNoSiteContext() {
+        RestRequest req = new RestRequest();
+        req.requestURI = '/services/apexrest/auth/social-login-config';
+        req.httpMethod = 'GET';
+        req.params.put('startURL', '/');
+        RestContext.request = req;
+        RestContext.response = new RestResponse();
+
+        Test.startTest();
+        UIBundleSocialLoginConfig.SocialLoginConfigResponse result =
+            UIBundleSocialLoginConfig.getConfig();
+        Test.stopTest();
+
+        // Should return empty lists (graceful fallback), not null
+        System.assertNotEquals(null, result, 'Response should not be null');
+        System.assertNotEquals(null, result.authProviders, 'authProviders list should not be null');
+        System.assertNotEquals(null, result.samlProviders, 'samlProviders list should not be null');
+        System.assertEquals(0, result.authProviders.size(), 'authProviders should be empty without community context');
+        System.assertEquals(0, result.samlProviders.size(), 'samlProviders should be empty without community context');
+        System.assertEquals(null, result.autoRedirectUrl, 'autoRedirectUrl should be null without providers');
+    }
+
+    /**
+     * Test that the endpoint handles a missing startURL parameter gracefully
+     * (defaults to "/").
+     */
+    @isTest
+    static void testGetConfigNoStartUrl() {
+        RestRequest req = new RestRequest();
+        req.requestURI = '/services/apexrest/auth/social-login-config';
+        req.httpMethod = 'GET';
+        // Intentionally not setting startURL param
+        RestContext.request = req;
+        RestContext.response = new RestResponse();
+
+        Test.startTest();
+        UIBundleSocialLoginConfig.SocialLoginConfigResponse result =
+            UIBundleSocialLoginConfig.getConfig();
+        Test.stopTest();
+
+        System.assertNotEquals(null, result, 'Response should not be null even without startURL');
+        System.assertNotEquals(null, result.authProviders, 'authProviders should not be null');
+        System.assertNotEquals(null, result.samlProviders, 'samlProviders should not be null');
+    }
+
+    /**
+     * Test the inner class constructors for code coverage.
+     */
+    @isTest
+    static void testInnerClassConstructors() {
+        Test.startTest();
+
+        UIBundleSocialLoginConfig.AuthProviderInfo authInfo =
+            new UIBundleSocialLoginConfig.AuthProviderInfo(
+                'TestProvider', 'Test Provider', 'https://example.com/icon.png', 'https://example.com/sso'
+            );
+        System.assertEquals('TestProvider', authInfo.developerName);
+        System.assertEquals('Test Provider', authInfo.friendlyName);
+        System.assertEquals('https://example.com/icon.png', authInfo.iconUrl);
+        System.assertEquals('https://example.com/sso', authInfo.ssoUrl);
+
+        UIBundleSocialLoginConfig.SamlProviderInfo samlInfo =
+            new UIBundleSocialLoginConfig.SamlProviderInfo(
+                '001000000000001', 'Test SAML', 'https://example.com/saml/sso'
+            );
+        System.assertEquals('001000000000001', samlInfo.id);
+        System.assertEquals('Test SAML', samlInfo.masterLabel);
+        System.assertEquals('https://example.com/saml/sso', samlInfo.ssoUrl);
+
+        List<UIBundleSocialLoginConfig.AuthProviderInfo> authList =
+            new List<UIBundleSocialLoginConfig.AuthProviderInfo>{ authInfo };
+        List<UIBundleSocialLoginConfig.SamlProviderInfo> samlList =
+            new List<UIBundleSocialLoginConfig.SamlProviderInfo>{ samlInfo };
+
+        UIBundleSocialLoginConfig.SocialLoginConfigResponse resp =
+            new UIBundleSocialLoginConfig.SocialLoginConfigResponse(
+                authList, samlList, 'https://example.com/redirect'
+            );
+        System.assertEquals(1, resp.authProviders.size());
+        System.assertEquals(1, resp.samlProviders.size());
+        System.assertEquals('https://example.com/redirect', resp.autoRedirectUrl);
+
+        Test.stopTest();
+    }
+}

package/lib/templates/project/reactexternalapp/_p_/_m_/classes/UIBundleSocialLoginConfig_Test.cls-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>67.0</apiVersion>
+    <status>Active</status>
+</ApexClass>

package/lib/templates/project/reactexternalapp/_p_/_m_/package.xml

@@ -16,5 +16,9 @@
         <members>reactexternalapp</members>
         <name>Network</name>
     </types>
+    <types>
+        <members>reactexternalapp_Guest_User_Api_Access</members>
+        <name>PermissionSet</name>
+    </types>
     <version>67.0</version>
 </Package>

package/lib/templates/project/reactexternalapp/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/ui-bundle-template-base-sfdx-project",
-  "version": "10.12.2",
+  "version": "11.53.1",
   "description": "Base SFDX project template",
   "license": "SEE LICENSE IN LICENSE.txt",
   "publishConfig": {
@@ -11,6 +11,7 @@
     "build": "echo 'No build required for base-sfdx-project'",
     "clean": "echo 'No clean required for base-sfdx-project'",
     "lint": "eslint --no-error-on-unmatched-pattern **/{aura,lwc}/**/*.js",
+    "validate:org-setup-config": "node scripts/validate-org-setup-config.mjs",
     "test": "npm run test:unit",
     "test:coverage": "npm run test",
     "test:unit": "sfdx-lwc-jest -- --passWithNoTests",
@@ -20,7 +21,12 @@
     "prettier": "prettier --write \"**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,xml,yaml,yml}\"",
     "prettier:verify": "prettier --check \"**/*.{cls,cmp,component,css,html,js,json,md,page,trigger,xml,yaml,yml}\"",
     "precommit": "lint-staged",
-    "setup": "node scripts/org-setup.mjs"
+    "setup": "node scripts/org-setup.mjs",
+    "dev:preview": "node scripts/org-setup-dev.mjs"
+  },
+  "dependencies": {
+    "fast-xml-parser": "^5.9.3",
+    "zod": "^3.24.1"
   },
   "devDependencies": {
     "@lwc/eslint-plugin-lwc": "^3.3.0",

package/lib/templates/project/reactexternalapp/scripts/org-setup-config-schema.mjs

@@ -0,0 +1,120 @@
+/**
+ * Shared schema + validator for org-setup.config.json (W-23043729).
+ *
+ * Authored ONCE, used at TWO moments:
+ *   (a) build / CI time — `scripts/validate-org-setup-config.mjs` validates every
+ *       org-setup.config.json this repo ships, failing the build on any violation.
+ *   (b) setup runtime — `org-setup.mjs` calls `validateConfig` once in main(),
+ *       before any step runs, to catch the developer's local post-scaffold edits.
+ *
+ * `validateConfig` is pure: it parses + validates and RETURNS a result. Each call
+ * site owns its own print/exit, so the build gate can report every bad file and
+ * the runtime can exit immediately — and the validator stays unit-testable.
+ *
+ * The zod schema uses `.strict()` at every level so unknown keys (e.g. the
+ * `permsetAssignment` singular typo) are rejected rather than silently ignored.
+ */
+
+import { z } from 'zod';
+
+/** Closed set of assignee values — no arbitrary usernames. */
+const Assignee = z.enum(['currentUser', 'guestUser', 'skip']);
+
+// No siteName: for guestUser the site is derived from the single
+// networks/<siteName>.network-meta.xml the app ships (see spec §5.2).
+const Assignment = z
+  .object({
+    assignee: Assignee,
+  })
+  .strict();
+
+export const ConfigSchema = z
+  .object({
+    permsetAssignments: z
+      .object({
+        // guestUser is valid here — siteName is derived, not per-assignment.
+        defaultAssignee: Assignee.default('skip'),
+        assignments: z.record(z.string(), Assignment).default({}),
+      })
+      .strict()
+      .optional(),
+    role: z
+      .object({
+        assignee: z.literal('currentUser'), // only value the role code honors
+        roleName: z.string().min(1),
+      })
+      .strict()
+      .optional(),
+    selfRegistration: z
+      .object({
+        // No siteName: the site is derived from the single
+        // networks/<siteName>.network-meta.xml the app ships (see spec §5.2),
+        // exactly like the guestUser permset path.
+        //
+        // selfRegProfile also drives the M1 license pre-check (W-23043735):
+        // setup derives the required UserLicense from this profile
+        // (Profile.UserLicense, matched on the stable LicenseDefinitionKey) and
+        // warns + skips self-registration when the org lacks it or has no seats.
+        // No separate license field is declared — the requirement can't drift
+        // from the profile the flow actually assigns.
+        selfRegProfile: z.string().min(1),
+        accountName: z.string().min(1),
+      })
+      .strict()
+      .optional(),
+    socialLogin: z
+      .object({
+        // Profile to add to NetworkMemberGroup so SSO-registered users can access
+        // the community (e.g. "Customer Community User"). Also enables the
+        // "Allow standard external profiles" org setting.
+        communityMemberProfile: z.string().min(1),
+        // DeveloperName of AuthProvider (OAuth) or SamlSsoConfig (SAML) records to link to the site's AuthConfig.
+        // Required because React (Site Container) sites hide SSO config in Admin UI.
+        authProviderNames: z.array(z.string().min(1)).min(1),
+        // Permission set to assign to community users created via SSO.
+        // Required because getCurrentUser() calls /chatter/users/me which needs
+        // API access (PermissionsApiEnabled) that the community profile lacks.
+        // Typically the app's "*_Guest_User_Api_Access" permset.
+        communityUserPermset: z.string().min(1).optional(),
+      })
+      .strict()
+      .optional(),
+  })
+  .strict();
+
+/**
+ * Render a single zod issue as a "path: message" line. Empty path (a root-level
+ * problem) renders as "<root>: message".
+ */
+function formatIssue(issue) {
+  const path = issue.path.length > 0 ? issue.path.join('.') : '<root>';
+  return `${path}: ${issue.message}`;
+}
+
+/**
+ * Parse + validate a raw org-setup.config.json string.
+ *
+ * @param {string} rawText  raw file contents (not yet JSON-parsed)
+ * @param {string} [configPath]  path used only for error messages
+ * @returns {{ ok: true, data: object } | { ok: false, errors: string[] }}
+ *   On success, `data` is the parsed + defaulted config. On failure, `errors`
+ *   is a non-empty list of human-readable messages (JSON parse error or zod
+ *   issues). The caller decides whether to print/exit.
+ */
+export function validateConfig(rawText, configPath) {
+  const where = configPath ? ` (${configPath})` : '';
+
+  let parsed;
+  try {
+    parsed = JSON.parse(rawText);
+  } catch (err) {
+    return { ok: false, errors: [`malformed JSON${where}: ${err.message}`] };
+  }
+
+  const result = ConfigSchema.safeParse(parsed);
+  if (!result.success) {
+    return { ok: false, errors: result.error.issues.map(formatIssue) };
+  }
+
+  return { ok: true, data: result.data };
+}

package/lib/templates/project/reactexternalapp/scripts/org-setup-dev.mjs

@@ -0,0 +1,87 @@
+#!/usr/bin/env node
+/**
+ * Dev preview: refresh the GraphQL schema/types against a target org, then launch
+ * the Vite dev server (spec §5.5, M4). This is the step that used to be the final
+ * `dev` stage of org-setup.mjs — extracted here so `npm run setup` terminates
+ * cleanly after graphql, and the long-lived dev server is an explicit, separate
+ * `npm run dev:preview`.
+ *
+ * Unlike setup, this does NOT log in or deploy — it assumes the org is already
+ * set up. It shares org/bundle resolution and the process runner with org-setup
+ * via org-setup-utils.mjs.
+ *
+ * Usage:
+ *   npm run dev:preview                                 # prompt to pick an org + bundle
+ *   npm run dev:preview -- --target-org myorg
+ *   npm run dev:preview -- --target-org myorg --ui-bundle-name my-app
+ *
+ * Flow (in order):
+ *   1. resolve target org (explicit --target-org, else prompt / default org)
+ *   2. resolve UI bundle (explicit --ui-bundle-name, else picker / warning)
+ *   3. npm install            (in the UI bundle)
+ *   4. npm run graphql:schema (SF_TARGET_ORG=<org>)  — introspect the live schema
+ *   5. npm run graphql:codegen                       — regenerate typed operations
+ *   6. npm run dev            (blocking, Ctrl+C to stop)
+ */
+
+import { resolve, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+import { run, resolveSfdxSource, discoverUIBundleDir, resolveTargetOrg } from './org-setup-utils.mjs';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const ROOT = resolve(__dirname, '..');
+
+function parseArgs() {
+  const args = process.argv.slice(2);
+  let targetOrg = null;
+  let uiBundleName = null;
+  for (let i = 0; i < args.length; i++) {
+    if (args[i] === '--target-org' && args[i + 1]) {
+      targetOrg = args[++i];
+    } else if (args[i] === '--ui-bundle-name' && args[i + 1]) {
+      uiBundleName = args[++i];
+    } else if (args[i] === '--help' || args[i] === '-h') {
+      console.log(`
+Dev preview — refresh GraphQL types then launch the Vite dev server
+
+Usage:
+  npm run dev:preview -- [--target-org <alias>] [--ui-bundle-name <name>]
+
+Options:
+  --target-org <alias>    Target Salesforce org alias. If omitted, you are prompted
+                          to pick from authenticated orgs (or the default org is used).
+  --ui-bundle-name <name> UI bundle folder under uiBundles/ (default: auto-detect / prompt)
+  -h, --help              Show this help
+`);
+      process.exit(0);
+    }
+  }
+  return { targetOrg, uiBundleName };
+}
+
+async function main() {
+  const parsed = parseArgs();
+
+  const targetOrg = await resolveTargetOrg(parsed);
+  const uiBundlesDir = resolve(resolveSfdxSource(ROOT), 'uiBundles');
+  const uiBundleDir = await discoverUIBundleDir(uiBundlesDir, parsed.uiBundleName);
+
+  console.log('Dev preview — target org:', targetOrg, '| UI bundle:', uiBundleDir);
+
+  run('UI Bundle npm install', 'npm', ['install'], { cwd: uiBundleDir });
+  run('GraphQL schema (introspect)', 'npm', ['run', 'graphql:schema'], {
+    cwd: uiBundleDir,
+    env: { ...process.env, SF_TARGET_ORG: targetOrg },
+  });
+  run('GraphQL codegen', 'npm', ['run', 'graphql:codegen'], { cwd: uiBundleDir });
+
+  console.log('\n--- Launching dev server (Ctrl+C to stop) ---\n');
+  const devResult = run('Dev server', 'npm', ['run', 'dev'], { cwd: uiBundleDir, optional: true });
+  process.exit(devResult.status ?? 0);
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});