@salesforce/ui-bundle-template-app-react-template-b2x 11.17.1 → 11.19.0

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/index.ts

@@ -0,0 +1,90 @@
+/**
+ * Public API for the search feature.
+ *
+ * Most apps only need:
+ *   ```tsx
+ *   import { Search, config } from ".../features/search";
+ *   <Search config={config} />
+ *   ```
+ *
+ * For more control, drop down to primitives:
+ *   - {@link useSearch} hook + {@link SearchBar} + {@link SearchResults}
+ *   - {@link DefaultResultRow} / {@link DefaultFilterPanel} for opt-in defaults
+ *   - filter components (TextFilter, SelectFilter, ...) for custom sidebars
+ */
+
+// Drop-in wrapper (most common entry point)
+export { Search } from "./components/Search";
+
+// Primitives
+export { useSearch } from "./hooks/useSearch";
+export { useAsyncData } from "./hooks/useAsyncData";
+export { useDistinctValues } from "./hooks/useDistinctValues";
+
+export { SearchBar } from "./components/controls/SearchBar";
+export { SearchResults } from "./components/SearchResults";
+export { MergedSearchResults } from "./components/MergedSearchResults";
+export type { MergedSearchResultsProps } from "./components/MergedSearchResults";
+export { SourceSection } from "./components/SourceSection";
+export { SortControl } from "./components/controls/SortControl";
+export { PaginationControls } from "./components/controls/PaginationControls";
+export { ScopeSelector } from "./components/controls/ScopeSelector";
+export { ActiveFilters } from "./components/filters/ActiveFilters";
+export { DefaultResultRow } from "./components/results/DefaultResultRow";
+export { DefaultFilterPanel } from "./components/filters/DefaultFilterPanel";
+export {
+	FilterProvider,
+	FilterResetButton,
+	useFilterField,
+	useFilterPanel,
+} from "./components/filters/FilterContext";
+
+export { TextFilter } from "./components/filters/inputs/TextFilter";
+export { SelectFilter } from "./components/filters/inputs/SelectFilter";
+export { MultiSelectFilter } from "./components/filters/inputs/MultiSelectFilter";
+export { NumericRangeFilter } from "./components/filters/inputs/NumericRangeFilter";
+export { BooleanFilter } from "./components/filters/inputs/BooleanFilter";
+export { DateRangeFilter } from "./components/filters/inputs/DateRangeFilter";
+export { FilterFieldWrapper } from "./components/filters/inputs/FilterFieldWrapper";
+
+export { fieldValue } from "./utils/fieldUtils";
+export {
+	buildFilter,
+	buildGlobalQueryClause,
+	readSourceParams,
+	writeSourceParams,
+	GLOBAL_QUERY_KEY,
+} from "./utils/filterUtils";
+export type {
+	ActiveFilterValue,
+	DateFilterMode,
+	FilterFieldConfig,
+	FilterFieldType,
+} from "./utils/filterUtils";
+export { buildOrderBy } from "./utils/sortUtils";
+export type { SortFieldConfig, SortState } from "./utils/sortUtils";
+
+export { buildSearchQuery } from "./queryBuilder";
+export type { SourceRequest, SearchQueryPayload } from "./queryBuilder";
+
+export { runSearch } from "./api/searchService";
+export { fetchDistinctValues } from "./api/distinctValuesService";
+export type { PicklistOption } from "./api/distinctValuesService";
+
+export { config } from "./loadConfig";
+
+export { ALL_SCOPE } from "./types";
+export type {
+	DisplayField,
+	SObjectSourceConfig,
+	SearchConfig,
+	SearchPaginationConfig,
+	SourceController,
+	SourceResult,
+	SourcePageInfo,
+	SearchHandle,
+	SearchScope,
+	RenderResultFn,
+	GlobalPagination,
+	MergedResultItem,
+} from "./types";

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/loadConfig.ts

@@ -0,0 +1,14 @@
+/**
+ * Typed re-export of the static config.json that ships with the feature.
+ *
+ * Application code:
+ *   import { config } from ".../features/search/loadConfig";
+ *   const handle = useSearch(config);
+ *
+ * To customize, edit `config.json` directly (no code changes required).
+ */
+
+import rawConfig from "./config.json";
+import type { SearchConfig } from "./types";
+
+export const config: SearchConfig = rawConfig as SearchConfig;

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/queryBuilder.ts

@@ -0,0 +1,156 @@
+/**
+ * Builds a single multi-aliased GraphQL document for search.
+ *
+ * Each SObject source becomes one aliased child of `uiapi.query`, with its own
+ * `first / after / where / orderBy` variables. Variable names are
+ * `${sourceKey}_first` etc. so two sources with similar names never collide.
+ *
+ * Selection sets are generated from `displayFields`:
+ *   - string `"Name"` → `Name @optional { value displayValue }`
+ *   - `{ name, raw: true }` → `Name`
+ *   - `{ name, subfields }` → nested `Name @optional { ... }`
+ *
+ * The `idField` (default "Id") is always emitted; it is **not** wrapped
+ * because uiapi's Id is a scalar.
+ */
+
+import { buildFilter, buildGlobalQueryClause, type ActiveFilterValue } from "./utils/filterUtils";
+import { buildOrderBy, type SortState } from "./utils/sortUtils";
+import type { DisplayField, SObjectSourceConfig } from "./types";
+
+const KEY_PATTERN = /^[A-Za-z_][A-Za-z0-9_]*$/;
+
+function assertValidKey(key: string): void {
+	if (!KEY_PATTERN.test(key)) {
+		throw new Error(
+			`Invalid source key "${key}". Must match /^[A-Za-z_][A-Za-z0-9_]*$/ to be a valid GraphQL alias and variable prefix.`,
+		);
+	}
+}
+
+export interface SearchQueryPayload {
+	document: string;
+	variables: Record<string, unknown>;
+}
+
+export interface SourceRequest {
+	source: SObjectSourceConfig;
+	q: string;
+	filters: ActiveFilterValue[];
+	sort: SortState | null;
+	pageSize: number;
+	afterCursor: string | undefined;
+}
+
+/**
+ * Combines a per-source structured-filter clause with the global-q `or` clause.
+ * Returns `undefined` when neither side has any constraints.
+ */
+function buildSourceWhere(
+	source: SObjectSourceConfig,
+	q: string,
+	filters: ActiveFilterValue[],
+): unknown {
+	const clauses: unknown[] = [];
+	const globalClause = buildGlobalQueryClause(q, source.searchableFields);
+	if (globalClause) clauses.push(globalClause);
+	const structured = buildFilter(filters, source.filterBy ?? []);
+	if (structured) clauses.push(structured);
+	if (clauses.length === 0) return undefined;
+	if (clauses.length === 1) return clauses[0];
+	return { and: clauses };
+}
+
+/** Builds the multi-aliased query document and a flat variables map. */
+export function buildSearchQuery(requests: SourceRequest[]): SearchQueryPayload {
+	if (requests.length === 0) {
+		throw new Error("buildSearchQuery requires at least one source request");
+	}
+
+	const variableDeclarations: string[] = [];
+	const querySelections: string[] = [];
+	const variables: Record<string, unknown> = {};
+
+	for (const request of requests) {
+		const { source } = request;
+		assertValidKey(source.key);
+
+		const firstVar = `${source.key}_first`;
+		const afterVar = `${source.key}_after`;
+		const whereVar = `${source.key}_where`;
+		const orderByVar = `${source.key}_orderBy`;
+		const whereType = source.whereTypeName ?? `${source.objectName}_Filter`;
+		const orderByType = source.orderByTypeName ?? `${source.objectName}_OrderBy`;
+
+		variableDeclarations.push(
+			`$${firstVar}: Int`,
+			`$${afterVar}: String`,
+			`$${whereVar}: ${whereType}`,
+			`$${orderByVar}: ${orderByType}`,
+		);
+
+		querySelections.push(
+			`${source.key}: ${source.objectName}(` +
+				`first: $${firstVar}, ` +
+				`after: $${afterVar}, ` +
+				`where: $${whereVar}, ` +
+				`orderBy: $${orderByVar}` +
+				`) {\n` +
+				buildSelectionBody(source) +
+				`\n}`,
+		);
+
+		variables[firstVar] = request.pageSize;
+		variables[afterVar] = request.afterCursor ?? null;
+		variables[whereVar] = buildSourceWhere(source, request.q, request.filters) ?? null;
+		variables[orderByVar] = buildOrderBy(request.sort) ?? null;
+	}
+
+	const document =
+		`query Search(${variableDeclarations.join(", ")}) {\n` +
+		`  uiapi {\n` +
+		`    query {\n` +
+		querySelections.map((s) => indent(s, "      ")).join("\n") +
+		`\n    }\n` +
+		`  }\n` +
+		`}\n`;
+
+	return { document, variables };
+}
+
+function buildSelectionBody(source: SObjectSourceConfig): string {
+	const idField = source.idField ?? "Id";
+	const fieldLines = [`    ${idField}`];
+	for (const field of source.displayFields) {
+		fieldLines.push(...renderField(field, "    "));
+	}
+	return [
+		`  edges { node {`,
+		...fieldLines,
+		`  } }`,
+		`  pageInfo { hasNextPage hasPreviousPage startCursor endCursor }`,
+		`  totalCount`,
+	].join("\n");
+}
+
+function renderField(field: DisplayField, indentStr: string): string[] {
+	if (typeof field === "string") {
+		return [`${indentStr}${field} @optional { value displayValue }`];
+	}
+	if ("raw" in field) {
+		return [`${indentStr}${field.name}`];
+	}
+	const lines = [`${indentStr}${field.name} @optional {`];
+	for (const sub of field.subfields) {
+		lines.push(...renderField(sub, indentStr + "  "));
+	}
+	lines.push(`${indentStr}}`);
+	return lines;
+}
+
+function indent(s: string, prefix: string): string {
+	return s
+		.split("\n")
+		.map((line) => prefix + line)
+		.join("\n");
+}

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/types.ts

@@ -0,0 +1,307 @@
+/**
+ * Configuration types for unified (multi-source) search.
+ *
+ * The application developer declares a SearchConfig with one entry per
+ * searchable backend. Today every source is an SObject queried via the uiapi
+ * GraphQL bridge; future adapters (CMS, REST, etc.) can plug in by introducing
+ * a new `kind` and a matching runtime adapter without changing any consumer.
+ *
+ * The library handles query construction, filter/sort/pagination state, URL
+ * sync, and result fan-out. The application owns rendering and routing.
+ */
+
+import type { FilterFieldConfig, ActiveFilterValue } from "./utils/filterUtils";
+import type { SortFieldConfig, SortState } from "./utils/sortUtils";
+
+/**
+ * A single field to include in the GraphQL selection set of an SObject source.
+ *
+ * - `"Name"` (string shorthand): emits `Name @optional { value displayValue }`.
+ * - `{ name, subfields }`: emits a nested selection (relationship traversal).
+ * - `{ name, raw: true }`: emits the bare field name (e.g. for Id-like fields
+ *   that are not wrapped in `{ value displayValue }`).
+ *
+ * The configured `idField` (default: "Id") is added automatically; do not list
+ * it explicitly.
+ */
+export type DisplayField =
+	| string
+	| { name: string; raw: true }
+	| { name: string; subfields: DisplayField[] };
+
+/** Configuration for one SObject source in a search experience. */
+export interface SObjectSourceConfig {
+	/** Discriminator — selects the runtime adapter. */
+	kind: "sobject";
+	/**
+	 * Stable identifier. Used as the GraphQL alias, the URL namespace, and the
+	 * result-map key. Must match `/^[A-Za-z_][A-Za-z0-9_]*$/`.
+	 */
+	key: string;
+	/** GraphQL object name (e.g. "Account", "Contact"). */
+	objectName: string;
+	/**
+	 * Plural display label — used in section headers, the scope dropdown, and
+	 * empty-state messages (e.g. "Accounts", "Maintenance Requests").
+	 */
+	label: string;
+	/**
+	 * Singular display label for a single record of this type (e.g. "Account",
+	 * "Maintenance Request"). Used for the per-card source badge in the merged
+	 * grid. Falls back to `label` when omitted.
+	 */
+	labelSingular?: string;
+	/** Field name that uniquely identifies a record. Defaults to "Id". */
+	idField?: string;
+	/**
+	 * URL pattern used by the default renderer to build a result link.
+	 *
+	 * Tokens of the form `:fieldName` are replaced with the corresponding
+	 * field's value at render time (e.g. `:id` resolves to the record's
+	 * `idField` value, `:Name` resolves to the Name field's `value`).
+	 *
+	 * Example: `"/accounts/:id"` produces `<Link to="/accounts/001xx0000003DGb">`.
+	 *
+	 * Optional — when omitted, the default renderer emits non-clickable rows.
+	 */
+	routePattern?: string;
+	/**
+	 * Fields the global `q` term should match against.
+	 * Built into an `or` of `like %q%`. Supports dot-notation for relationship
+	 * fields (e.g. "Owner.Name").
+	 */
+	searchableFields: string[];
+	/**
+	 * Fields to include in the GraphQL selection set. The id field is added
+	 * automatically; do not list it.
+	 */
+	displayFields: DisplayField[];
+	/**
+	 * Optional structured filters for this source.
+	 *
+	 * Named `filterBy` (rather than "the filters shown in the panel") because a
+	 * future entry may constrain the query without rendering a control — e.g. a
+	 * default `Status != Completed` that hides completed items from results while
+	 * never appearing in the UI. Today every entry renders an input via
+	 * `DefaultFilterPanel`.
+	 */
+	filterBy?: FilterFieldConfig[];
+	/** Optional sort options surfaced in the per-source sort dropdown. */
+	sortBy?: SortFieldConfig[];
+	/** Initial sort applied when no URL sort is present. */
+	defaultSort?: SortState;
+	/**
+	 * GraphQL type name for the `where` variable.
+	 * Defaults to `${objectName}_Filter` — override only for non-conventional schemas.
+	 */
+	whereTypeName?: string;
+	/** GraphQL type name for the `orderBy` variable. Defaults to `${objectName}_OrderBy`. */
+	orderByTypeName?: string;
+}
+
+/**
+ * One global pagination config for the whole search experience. It is the
+ * single source of truth — there is no per-source pagination. The same
+ * `pageSize` / `pageSizeOptions` apply across every object type and in every
+ * scope, including single-object pages (`restrictTo` / `lockedScope`) and when
+ * the scope dropdown narrows to one source.
+ */
+export interface SearchPaginationConfig {
+	/**
+	 * How results are paginated:
+	 *   - `"per-source"` (default): each source advances its own cursor; a page
+	 *     can hold up to `sources × pageSize` items. This is what the drop-in
+	 *     `<Search>` (one section per source) expects.
+	 *   - `"merged"`: treat the cumulative result set as one list and window it
+	 *     into fixed pages of `pageSize`. Each page shows exactly `pageSize` items
+	 *     across all sources — use for a single combined grid.
+	 */
+	mode?: "per-source" | "merged";
+	/**
+	 * In `"merged"` mode, how nodes from different sources are ordered:
+	 *   - `"sequential"` (default): source 1 in full, then source 2, …
+	 *   - `"interleaved"`: round-robin — every source gets equal priority.
+	 *   - `"proportional"`: each source spread by its result count, so larger
+	 *     sources appear more often. Ignored in `"per-source"` mode.
+	 */
+	mergeOrder?: "sequential" | "interleaved" | "proportional";
+	/** Items per page (across all sources in `"merged"` mode; per source otherwise). */
+	pageSize: number;
+	/** Page sizes offered in the "results per page" control. */
+	pageSizeOptions: number[];
+}
+
+/** Top-level config passed to {@link useSearch}. */
+export interface SearchConfig {
+	sources: SObjectSourceConfig[];
+	/**
+	 * Global pagination config — the single source of truth for page size, page
+	 * options, mode, and merge order. See {@link SearchPaginationConfig}. When
+	 * omitted, pagination defaults to per-source mode, page size 10, options
+	 * `[10, 25, 50]`.
+	 */
+	pagination?: SearchPaginationConfig;
+}
+
+// ---------------------------------------------------------------------------
+// Runtime types
+// ---------------------------------------------------------------------------
+
+export interface SourcePageInfo {
+	hasNextPage: boolean;
+	hasPreviousPage: boolean;
+	endCursor: string | null;
+	startCursor: string | null;
+}
+
+/**
+ * Per-source result. Nodes are typed as `unknown` at the library boundary —
+ * the application narrows them in its `renderResult` callback (typically by
+ * casting to a codegen-generated node type).
+ */
+export interface SourceResult {
+	nodes: unknown[];
+	pageInfo: SourcePageInfo | null;
+	totalCount: number | null;
+}
+
+export interface SourceController {
+	config: SObjectSourceConfig;
+	result: SourceResult | null;
+	loading: boolean;
+	error: string | null;
+	filters: {
+		active: ActiveFilterValue[];
+		set: (field: string, value: ActiveFilterValue | undefined) => void;
+		remove: (field: string) => void;
+	};
+	sort: {
+		current: SortState | null;
+		set: (sort: SortState | null) => void;
+	};
+	pagination: {
+		pageSize: number;
+		/** Allowed page sizes — from the global pagination config. */
+		pageSizeOptions: readonly number[];
+		pageIndex: number;
+		hasNextPage: boolean;
+		hasPreviousPage: boolean;
+		setPageSize: (size: number) => void;
+		goToNextPage: () => void;
+		goToPreviousPage: () => void;
+	};
+}
+
+/**
+ * The currently-selected search scope.
+ *
+ * - `"all"`: every source in the config is queried and rendered.
+ * - any source `key`: only that source is queried and rendered. Other sources
+ *   skip both the network request and the UI section.
+ */
+export type SearchScope = "all" | string;
+
+export const ALL_SCOPE = "all" as const;
+
+/**
+ * One result node tagged with the source it came from. Produced by
+ * {@link SearchHandle.mergedResults} so a single combined grid can render
+ * cross-source results and still pick the right card per node.
+ */
+export interface MergedResultItem {
+	/** The `key` of the source this node came from. */
+	sourceKey: string;
+	/** The raw result node (cast to your typed node in the renderer). */
+	node: unknown;
+}
+
+/**
+ * Aggregate pagination across every in-scope source, exposed by
+ * {@link SearchHandle.globalPagination}. Its exact behaviour depends on the
+ * `pagination` mode passed to {@link useSearch}:
+ *
+ * - **`"merged"`** (recommended for a single combined grid): the cumulative
+ *   result set is treated as one list and windowed into fixed pages of
+ *   `pageSize`. Page `P` always shows **exactly** `pageSize` items (the last
+ *   page may show fewer), `pageCount` is `ceil(totalCount / pageSize)`, and
+ *   `goToPage` can jump to any page. Under the hood each in-scope source fetches
+ *   `(P + 1) * pageSize` rows from its front, the results are concatenated in
+ *   config order, and the page-`P` slice is taken — so the math is exact, not an
+ *   estimate.
+ * - **`"per-source"`** (default): each source paginates with its own cursor and
+ *   a "global page" is the furthest-advanced in-scope source's page. `Next`
+ *   advances only the sources still on the current global page that have more
+ *   data; a source that runs out is left behind. `goToPage` is best-effort
+ *   (adjacent pages only) because cursors can't seek to an arbitrary offset.
+ */
+export interface GlobalPagination {
+	/** Current global page, 0-based. */
+	pageIndex: number;
+	/**
+	 * Total number of global pages. In `"merged"` mode this is exactly
+	 * `ceil(totalCount / pageSize)`. In `"per-source"` mode it is the `max` over
+	 * in-scope sources of `ceil(totalCount / pageSize)` and may be an estimate if
+	 * a source omits `totalCount`. `0` when there are no results, otherwise `>= 1`.
+	 */
+	pageCount: number;
+	/** Shared page size. */
+	pageSize: number;
+	/** Allowed page sizes (from the first in-scope source). */
+	pageSizeOptions: readonly number[];
+	/** True when there is a page after the current one. */
+	hasNextPage: boolean;
+	/** True when the current global page is past the first. */
+	hasPreviousPage: boolean;
+	/** Cumulative result count summed across in-scope sources. */
+	totalCount: number;
+	/** Advance to the next global page. */
+	goToNextPage: () => void;
+	/** Step back to the previous global page. */
+	goToPreviousPage: () => void;
+	/**
+	 * Jump to a specific 0-based page. Exact in `"merged"` mode; in
+	 * `"per-source"` mode only adjacent pages are honoured (others are a no-op).
+	 */
+	goToPage: (pageIndex: number) => void;
+	/** Set the page size (resets to the first page). */
+	setPageSize: (size: number) => void;
+}
+
+export interface SearchHandle {
+	q: string;
+	setQ: (q: string) => void;
+	scope: SearchScope;
+	setScope: (scope: SearchScope) => void;
+	/**
+	 * True when the caller passed `lockedScope` to `useSearch`. Consumers
+	 * should hide the scope dropdown and read-only display the locked source.
+	 */
+	scopeLocked: boolean;
+	sources: Record<string, SourceController>;
+	/**
+	 * Source controllers that participate in the current scope, in config
+	 * declaration order. In `"all"` scope this is every source; otherwise just
+	 * the selected one. Convenience for callers building aggregate UI.
+	 */
+	inScopeSources: SourceController[];
+	/**
+	 * In-scope nodes flattened into one list (config order, source by source),
+	 * each tagged with its `sourceKey` — for rendering a single combined grid
+	 * instead of one section per source. In `"merged"` pagination mode this is
+	 * exactly the current page's window (at most `globalPagination.pageSize`
+	 * items); in `"per-source"` mode it is every in-scope source's current page
+	 * concatenated.
+	 */
+	mergedResults: MergedResultItem[];
+	/**
+	 * Aggregate pagination across all in-scope sources — drive one shared
+	 * pager over the cumulative result set. See {@link GlobalPagination}.
+	 */
+	globalPagination: GlobalPagination;
+	loading: boolean;
+	error: string | null;
+	resetAll: () => void;
+}
+
+/** Type alias for a render callback per source key. */
+export type RenderResultFn = (sourceKey: string, node: unknown) => React.ReactNode;

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/utils/debounce.ts

@@ -0,0 +1,17 @@
+/** Default debounce delay for keystroke-driven inputs. */
+export const FILTER_DEBOUNCE_MS = 300;
+
+/**
+ * Creates a debounced version of `fn`. Each call resets the internal timer;
+ * `fn` runs only after the timer expires without being reset.
+ */
+export function debounce<T extends (...args: any[]) => void>(
+	fn: T,
+	ms: number,
+): (...args: Parameters<T>) => void {
+	let timer: ReturnType<typeof setTimeout> | undefined;
+	return (...args: Parameters<T>) => {
+		clearTimeout(timer);
+		timer = setTimeout(() => fn(...args), ms);
+	};
+}

package/dist/force-app/main/default/uiBundles/reactexternalapp/src/features/search/utils/fieldUtils.ts

@@ -0,0 +1,14 @@
+/**
+ * Helpers for reading values out of uiapi GraphQL response nodes.
+ *
+ * Nodes typically come back wrapped as `{ value, displayValue }`. `fieldValue`
+ * picks the user-facing string (preferring displayValue) or returns null.
+ */
+
+export function fieldValue(
+	field: { displayValue?: string | null; value?: unknown } | null | undefined,
+): string | null {
+	if (field?.displayValue != null) return field.displayValue;
+	if (field?.value != null) return String(field.value);
+	return null;
+}