@salesforce/webapp-template-app-react-sample-b2x-experimental 1.68.0 → 1.69.0

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/forms/filters-form.tsx

@@ -0,0 +1,114 @@
+import { FieldGroup } from "../ui/field";
+import { StatusAlert } from "../alerts/status-alert";
+import { CardLayout } from "../layout/card-layout";
+import { SubmitButton } from "./submit-button";
+import { Button } from "../ui/button";
+import { useFormContext } from "../../hooks/form";
+import { useId, useEffect, useRef } from "react";
+
+const SUCCESS_AUTO_DISMISS_DELAY = 3000;
+
+interface FiltersFormProps extends Omit<React.ComponentProps<"form">, "onSubmit"> {
+	title: string;
+	description?: string;
+	error?: React.ReactNode;
+	success?: React.ReactNode;
+	submit: {
+		text: string;
+		loadingText?: string;
+	};
+	reset?: {
+		text: string;
+		onReset: () => void;
+	};
+	onSuccessDismiss?: () => void;
+}
+
+/**
+ * Wrapper component that provides consistent layout and error/success alert positioning
+ * for all filter forms.
+ */
+export function FiltersForm({
+	id: providedId,
+	title,
+	description,
+	error,
+	success,
+	children,
+	submit,
+	reset,
+	onSuccessDismiss,
+	...props
+}: FiltersFormProps) {
+	const form = useFormContext();
+	const generatedId = useId();
+	const id = providedId ?? generatedId;
+
+	const isSubmittingSelector = (state: { isSubmitting: boolean }) => state.isSubmitting;
+	const timeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
+
+	useEffect(() => {
+		if (timeoutRef.current) {
+			clearTimeout(timeoutRef.current);
+			timeoutRef.current = null;
+		}
+
+		if (success && onSuccessDismiss) {
+			timeoutRef.current = setTimeout(() => {
+				onSuccessDismiss();
+				timeoutRef.current = null;
+			}, SUCCESS_AUTO_DISMISS_DELAY);
+		}
+
+		return () => {
+			if (timeoutRef.current) {
+				clearTimeout(timeoutRef.current);
+				timeoutRef.current = null;
+			}
+		};
+	}, [success, onSuccessDismiss]);
+
+	return (
+		<CardLayout title={title} description={description}>
+			<div className="space-y-6">
+				{error && <StatusAlert variant="error">{error}</StatusAlert>}
+				{success && <StatusAlert variant="success">{success}</StatusAlert>}
+
+				<form
+					id={id}
+					onSubmit={(e) => {
+						e.preventDefault();
+						e.stopPropagation();
+						form.handleSubmit();
+					}}
+					{...props}
+				>
+					<FieldGroup>{children}</FieldGroup>
+					<div className="flex flex-col sm:flex-row gap-2 pt-4">
+						<SubmitButton
+							form={id}
+							label={submit.text}
+							loadingLabel={submit.loadingText}
+							className="flex-1"
+						/>
+						{reset && (
+							<form.Subscribe selector={isSubmittingSelector}>
+								{(isSubmitting: boolean) => (
+									<Button
+										type="button"
+										variant="outline"
+										onClick={reset.onReset}
+										className="flex-1"
+										disabled={isSubmitting}
+									>
+										{reset.text}
+									</Button>
+								)}
+							</form.Subscribe>
+						)}
+					</div>
+				</form>
+			</div>
+		</CardLayout>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/forms/submit-button.tsx

@@ -0,0 +1,47 @@
+import { Button } from "../ui/button";
+import { Spinner } from "../ui/spinner";
+import { cn } from "../../lib/utils";
+import { useFormContext } from "../../hooks/form";
+
+interface SubmitButtonProps extends Omit<React.ComponentProps<typeof Button>, "type" | "disabled"> {
+	/** Button text when not submitting */
+	label: string;
+	/** Button text while submitting */
+	loadingLabel?: string;
+	/** Form id to associate with (for buttons outside form element) */
+	form?: string;
+}
+
+const isSubmittingSelector = (state: { isSubmitting: boolean }) => state.isSubmitting;
+
+/**
+ * Submit button that subscribes to form submission state.
+ * Disables interaction during submission and provides visual feedback.
+ */
+export function SubmitButton({
+	label,
+	loadingLabel = "Applying…",
+	className,
+	form: formId,
+	...props
+}: SubmitButtonProps) {
+	const form = useFormContext();
+	return (
+		<form.Subscribe selector={isSubmittingSelector}>
+			{(isSubmitting: boolean) => (
+				<Button
+					type="submit"
+					form={formId}
+					className={cn("w-full", className)}
+					disabled={isSubmitting}
+					aria-label={isSubmitting ? loadingLabel : label}
+					aria-busy={isSubmitting}
+					{...props}
+				>
+					{isSubmitting && <Spinner className="mr-2" aria-hidden="true" />}
+					<span aria-live="polite">{isSubmitting ? loadingLabel : label}</span>
+				</Button>
+			)}
+		</form.Subscribe>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/layout/card-layout.tsx

@@ -0,0 +1,19 @@
+import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "../ui/card";
+
+interface CardLayoutProps {
+	title: string;
+	description?: string;
+	children: React.ReactNode;
+}
+
+export function CardLayout({ title, description, children }: CardLayoutProps) {
+	return (
+		<Card className="w-full">
+			<CardHeader>
+				<CardTitle className="text-2xl">{title}</CardTitle>
+				{description && <CardDescription>{description}</CardDescription>}
+			</CardHeader>
+			<CardContent>{children}</CardContent>
+		</Card>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/search/ResultCardFields.tsx

@@ -0,0 +1,71 @@
+/**
+ * ResultCardFields Component
+ *
+ * Displays secondary fields (up to 3) for a search result card.
+ * Excludes the primary field and handles nested field values.
+ *
+ * @param record - The search result record data
+ * @param columns - Array of column definitions
+ * @param excludeFieldApiName - Field API name to exclude (usually the primary field)
+ *
+ * @remarks
+ * - Displays up to 3 secondary fields
+ * - Handles nested field paths (e.g., "Owner.Alias")
+ * - Skips fields with null/undefined/empty values
+ * - Responsive layout (vertical on mobile, horizontal on desktop)
+ *
+ * @example
+ * ```tsx
+ * <ResultCardFields
+ *   record={searchResult}
+ *   columns={columns}
+ *   excludeFieldApiName="Name"
+ * />
+ * ```
+ */
+import type { Column, SearchResultRecordData } from "../../types/search/searchResults";
+import { getNestedFieldValue } from "../../utils/fieldUtils";
+
+interface ResultCardFieldsProps {
+	record: SearchResultRecordData;
+	columns: Column[];
+	excludeFieldApiName?: string;
+}
+
+export default function ResultCardFields({
+	record,
+	columns,
+	excludeFieldApiName,
+}: ResultCardFieldsProps) {
+	const secondaryFields = columns.filter(
+		(col) => col && col.fieldApiName && col.fieldApiName !== excludeFieldApiName,
+	);
+
+	return (
+		<dl className="space-y-2" aria-label="Additional record information">
+			{secondaryFields.map((column) => {
+				if (!column || !column.fieldApiName) {
+					return null;
+				}
+
+				const displayValue = getNestedFieldValue(record.fields, column.fieldApiName);
+
+				if (displayValue === null || displayValue === undefined || displayValue === "") {
+					return null;
+				}
+
+				return (
+					<div
+						key={column.fieldApiName}
+						className="flex flex-col sm:flex-row sm:items-center gap-1 sm:gap-2"
+					>
+						<dt className="text-sm font-medium text-muted-foreground min-w-[100px]">
+							{column.label || column.fieldApiName}:
+						</dt>
+						<dd className="text-sm text-foreground">{displayValue}</dd>
+					</div>
+				);
+			})}
+		</dl>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/search/SearchHeader.tsx

@@ -0,0 +1,31 @@
+/**
+ * SearchHeader Component
+ *
+ * Displays the header for search results or browse-all (same UI).
+ * labelPlural comes from object metadata (e.g. useObjectInfoBatch) so it is not hard-coded.
+ */
+interface SearchHeaderProps {
+	query?: string;
+	isBrowseAll?: boolean;
+	/** Plural label for the primary object (e.g. "Accounts"). From object metadata. */
+	labelPlural?: string;
+}
+
+export default function SearchHeader({
+	query,
+	isBrowseAll,
+	labelPlural = "records",
+}: SearchHeaderProps) {
+	return (
+		<header className="mb-6" aria-label="Search results header">
+			<h1 className="text-3xl font-bold mb-2">
+				{isBrowseAll ? `Browse All ${labelPlural}` : "Search Results"}
+			</h1>
+			{!isBrowseAll && query && (
+				<p className="text-lg" aria-live="polite">
+					Results for: <span className="font-semibold">"{query}"</span>
+				</p>
+			)}
+		</header>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/search/SearchPagination.tsx

@@ -0,0 +1,144 @@
+/**
+ * SearchPagination Component
+ *
+ * Displays pagination controls for search results.
+ * Previous/Next are disabled using hasPreviousPage/hasNextPage from the API so no request is made when there is no page.
+ *
+ * @remarks
+ * - Layout: page size selector on the left, prev/page/next controls on the right (corners).
+ * - Previous disabled when !hasPreviousPage (cursor stack enables prev when pageIndex > 0).
+ * - Next disabled when !hasNextPage or nextPageToken is null.
+ */
+import { Button } from "../ui/button";
+import {
+	Select,
+	SelectContent,
+	SelectItem,
+	SelectTrigger,
+	SelectValue,
+} from "../ui/select";
+import { Label } from "../ui/label";
+import { PAGE_SIZE_OPTIONS, getValidPageSize, isValidPageSize } from "../../utils/paginationUtils";
+import { ChevronLeft, ChevronRight } from "lucide-react";
+
+interface SearchPaginationProps {
+	currentPageToken: string;
+	nextPageToken: string | null;
+	previousPageToken: string | null;
+	hasNextPage?: boolean;
+	hasPreviousPage?: boolean;
+	pageSize: number;
+	/** direction: 'prev' | 'next' | 'first'. When 'first' (e.g. page size change), parent typically resets pagination; token may be '' for prev when going to page 0. */
+	onPageChange: (newPageToken: string, direction?: "next" | "prev" | "first") => void;
+	onPageSizeChange: (newPageSize: number) => void;
+}
+
+export default function SearchPagination({
+	currentPageToken,
+	nextPageToken,
+	previousPageToken,
+	hasNextPage = false,
+	hasPreviousPage = false,
+	pageSize,
+	onPageChange,
+	onPageSizeChange,
+}: SearchPaginationProps) {
+	const validPageSize = getValidPageSize(pageSize);
+
+	const currentPageTokenNum = parseInt(currentPageToken, 10) || 0;
+	const currentPage = currentPageTokenNum + 1;
+
+	const canGoPrevious = Boolean(hasPreviousPage);
+	const canGoNext = Boolean(hasNextPage && nextPageToken != null);
+
+	const handlePrevious = () => {
+		if (canGoPrevious) {
+			onPageChange(previousPageToken ?? "", "prev");
+		}
+	};
+
+	const handleNext = () => {
+		if (canGoNext && nextPageToken != null) {
+			onPageChange(nextPageToken, "next");
+		}
+	};
+
+	const handlePageSizeChange = (newPageSize: string) => {
+		const newSize = parseInt(newPageSize, 10);
+		if (!isNaN(newSize) && isValidPageSize(newSize) && newSize !== validPageSize) {
+			onPageSizeChange(newSize);
+			onPageChange("0", "first");
+		}
+	};
+
+	return (
+		<nav
+			className="w-full flex flex-row flex-wrap items-center justify-between gap-4 py-2"
+			aria-label="Search results pagination"
+		>
+			<div
+				className="flex items-center gap-2 shrink-0"
+				role="group"
+				aria-label="Page size selector"
+			>
+				<Label htmlFor="page-size-select" className="text-sm font-normal whitespace-nowrap">
+					Results per page:
+				</Label>
+				<Select value={validPageSize.toString()} onValueChange={handlePageSizeChange}>
+					<SelectTrigger
+						id="page-size-select"
+						className="w-[70px]"
+						aria-label="Select number of results per page"
+					>
+						<SelectValue />
+					</SelectTrigger>
+					<SelectContent>
+						{PAGE_SIZE_OPTIONS.map((option) => (
+							<SelectItem key={option.value} value={option.value}>
+								{option.label}
+							</SelectItem>
+						))}
+					</SelectContent>
+				</Select>
+			</div>
+
+			<div className="flex items-center gap-1 shrink-0" role="group" aria-label="Page navigation">
+				<Button
+					type="button"
+					variant="outline"
+					size="sm"
+					disabled={!canGoPrevious}
+					onClick={handlePrevious}
+					aria-label={
+						canGoPrevious
+							? `Go to previous page (Page ${currentPage - 1})`
+							: "Previous page (disabled)"
+					}
+				>
+					<ChevronLeft className="size-4" aria-hidden />
+					Previous
+				</Button>
+				<span
+					className="min-w-[4rem] text-center text-sm text-muted-foreground px-2"
+					aria-label={`Page ${currentPage}, current page`}
+					aria-current="page"
+				>
+					Page {currentPage}
+				</span>
+				<Button
+					type="button"
+					variant="outline"
+					size="sm"
+					disabled={!canGoNext}
+					onClick={handleNext}
+					aria-label={
+						canGoNext ? `Go to next page (Page ${currentPage + 1})` : "Next page (disabled)"
+					}
+				>
+					Next
+					<ChevronRight className="size-4" aria-hidden />
+				</Button>
+			</div>
+		</nav>
+	);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/components/search/SearchResultsPanel.tsx

@@ -0,0 +1,197 @@
+/**
+ * SearchResultsPanel Component
+ *
+ * Displays the search results panel with loading, error, and empty states.
+ * Renders a list of SearchResultCard components and pagination controls.
+ *
+ * @param columns - Array of column definitions for displaying result data
+ * @param results - Array of search result records to display
+ * @param columnsLoading - Whether column metadata is currently loading
+ * @param resultsLoading - Whether search results are currently loading
+ * @param columnsError - Error message if column fetch failed
+ * @param resultsError - Error message if results fetch failed
+ * @param currentPageToken - Current pagination token
+ * @param pageSize - Number of results per page
+ * @param onPageChange - Callback when pagination changes; second arg optional: "next" | "prev" | "first" (cursor-stack pagination)
+ * @param onPageSizeChange - Callback when page size changes
+ *
+ * @example
+ * ```tsx
+ * <SearchResultsPanel
+ *   columns={columns}
+ *   results={results}
+ *   columnsLoading={false}
+ *   resultsLoading={false}
+ *   columnsError={null}
+ *   resultsError={null}
+ *   currentPageToken="0"
+ *   pageSize={25}
+ *   onPageChange={(token, direction) => handlePageChange(token, direction)}
+ *   onPageSizeChange={(size) => setPageSize(size)}
+ * />
+ * ```
+ */
+import { useMemo } from "react";
+import { Alert, AlertDescription, AlertTitle } from "../ui/alert";
+import { Skeleton } from "../ui/skeleton";
+import { AlertCircle } from "lucide-react";
+import {
+	Select,
+	SelectContent,
+	SelectItem,
+	SelectTrigger,
+	SelectValue,
+} from "../ui/select";
+import { Label } from "../ui/label";
+import SearchResultCard from "../SearchResultCard";
+import SearchPagination from "./SearchPagination";
+import type { Column, SearchResultRecord } from "../../types/search/searchResults";
+import { getSafeKey } from "../../utils/recordUtils";
+
+interface SearchResultsPanelProps {
+	/** API name of the object being searched (e.g. for detail page navigation). */
+	objectApiName?: string;
+	columns: Column[];
+	results: SearchResultRecord[];
+	columnsLoading: boolean;
+	resultsLoading: boolean;
+	columnsError: string | null;
+	resultsError: string | null;
+	currentPageToken: string;
+	nextPageToken: string | null;
+	previousPageToken: string | null;
+	hasNextPage?: boolean;
+	hasPreviousPage?: boolean;
+	pageSize: number;
+	sortBy: string;
+	onPageChange: (newPageToken: string, direction?: "next" | "prev" | "first") => void;
+	onPageSizeChange: (newPageSize: number) => void;
+	onSortByChange: (newSortBy: string) => void;
+}
+
+export default function SearchResultsPanel({
+	objectApiName,
+	columns,
+	results,
+	columnsLoading,
+	resultsLoading,
+	columnsError,
+	resultsError,
+	currentPageToken,
+	nextPageToken,
+	previousPageToken,
+	hasNextPage = false,
+	hasPreviousPage = false,
+	pageSize,
+	sortBy,
+	onPageChange,
+	onPageSizeChange,
+	onSortByChange,
+}: SearchResultsPanelProps) {
+	const sortableColumns = useMemo(() => columns.filter(({ sortable }) => sortable), [columns]);
+
+	const validResults = useMemo(
+		() => results.filter((record) => record && record.record && record.record.id),
+		[results],
+	);
+	if (columnsError || resultsError) {
+		return (
+			<Alert variant="destructive" role="alert">
+				<AlertCircle className="h-4 w-4" aria-hidden="true" />
+				<AlertTitle>Error</AlertTitle>
+				<AlertDescription>
+					{columnsError || resultsError || "Failed to load search results"}
+				</AlertDescription>
+			</Alert>
+		);
+	}
+
+	if (resultsLoading || columnsLoading) {
+		return (
+			<div
+				className="space-y-4"
+				role="status"
+				aria-live="polite"
+				aria-label="Loading search results"
+			>
+				<span className="sr-only">Loading search results</span>
+				{[1, 2, 3].map((i) => (
+					<div key={i} className="border rounded-lg p-6" aria-hidden="true">
+						<Skeleton className="h-6 w-3/4 mb-4" />
+						<Skeleton className="h-4 w-full mb-2" />
+						<Skeleton className="h-4 w-2/3" />
+					</div>
+				))}
+			</div>
+		);
+	}
+
+	if (results.length === 0) {
+		return (
+			<div className="text-center py-12" role="status" aria-live="polite">
+				<p className="text-lg mb-2">No results found</p>
+				<p className="text-sm">Try adjusting your search query or filters</p>
+			</div>
+		);
+	}
+
+	return (
+		<>
+			{sortableColumns.length > 0 && (
+				<div
+					className="mb-6 flex items-center gap-2 justify-end"
+					role="group"
+					aria-label="Sort options"
+				>
+					<Label htmlFor="sort-by-select" className="text-sm font-normal whitespace-nowrap">
+						Sort by:
+					</Label>
+					<Select value={sortBy || ""} onValueChange={onSortByChange}>
+						<SelectTrigger
+							id="sort-by-select"
+							className="w-[200px]"
+							aria-label="Sort search results by field"
+						>
+							<SelectValue placeholder="Select field..." />
+						</SelectTrigger>
+						<SelectContent>
+							<SelectItem value="relevance">Relevance</SelectItem>
+							{sortableColumns.map((column) => (
+								<SelectItem key={column.fieldApiName} value={column.fieldApiName}>
+									{column.label}
+								</SelectItem>
+							))}
+						</SelectContent>
+					</Select>
+				</div>
+			)}
+
+			<div className="space-y-4 mb-6" role="list" aria-label="Search results list">
+				{validResults.map((record, index) => {
+					const recordId = record.record.id;
+					const safeKey = getSafeKey(recordId, index);
+					return (
+						<div key={safeKey} role="listitem">
+							<SearchResultCard
+								record={record.record}
+								columns={columns}
+								objectApiName={objectApiName}
+							/>
+						</div>
+					);
+				})}
+			</div>
+
+			<SearchPagination
+				currentPageToken={currentPageToken}
+				nextPageToken={nextPageToken}
+				previousPageToken={previousPageToken}
+				hasNextPage={hasNextPage}
+				hasPreviousPage={hasPreviousPage}
+				pageSize={pageSize}
+				onPageChange={onPageChange}
+				onPageSizeChange={onPageSizeChange}
+			/>
+		</>
+	);
+}