@salesforce/webapp-template-feature-react-global-search-experimental 1.76.0 → 1.76.1

package/src/force-app/main/default/webapplications/feature-react-global-search/src/features/global-search/hooks/useObjectSearchData.ts

@@ -6,26 +6,16 @@
  * - getSharedFilters: module-level deduplication for getObjectListFilters across hook instances.
  */
 
-import { useState, useEffect, useRef, useMemo } from "react";
-import { objectInfoService, type SearchParams } from "../api/objectInfoService";
-import type {
-	Column,
-	SearchResultRecord,
-	SearchResultRecordData,
-} from "../types/search/searchResults";
-import type { Filter, FilterCriteria } from "../types/filters/filters";
+import { useState, useEffect } from "react";
+import { objectInfoService } from "../api/objectInfoService";
+import type { Column } from "../types/search/searchResults";
+import type { Filter } from "../types/filters/filters";
 import type { PicklistValue } from "../types/filters/picklist";
-import { createFiltersKey } from "../utils/cacheUtils";
 
 // --- Shared filters cache (deduplicates getObjectListFilters across useObjectColumns + useObjectFilters) ---
 const sharedFiltersCache = new Map<string, Filter[]>();
 const sharedFiltersInFlight = new Map<string, Promise<Filter[]>>();
 
-/**
- * Returns filters for the object, deduplicating the API call across hook instances.
- * Does not pass abort signal to the API so the shared request is not aborted when
- * one consumer's effect cleans up (e.g. React Strict Mode); callers still guard with isCancelled.
- */
 function getSharedFilters(objectApiName: string): Promise<Filter[]> {
 	const cached = sharedFiltersCache.get(objectApiName);
 	if (cached) return Promise.resolve(cached);
@@ -100,7 +90,6 @@ export function useObjectListMetadata(objectApiName: string | null): ObjectListM
 		}
 
 		let isCancelled = false;
-		const ac = new AbortController();
 
 		const run = async () => {
 			setState((s) => ({ ...s, loading: true, error: null }));
@@ -111,12 +100,9 @@ export function useObjectListMetadata(objectApiName: string | null): ObjectListM
 				const selectFilters = filters.filter((f) => f.affordance?.toLowerCase() === "select");
 				const picklistPromises = selectFilters.map((f) =>
 					objectInfoService
-						.getPicklistValues(objectApiName!, f.targetFieldPath, undefined, ac.signal)
+						.getPicklistValues(objectApiName!, f.targetFieldPath)
 						.then((values) => ({ fieldPath: f.targetFieldPath, values }))
-						.catch((err) => {
-							if (err?.name === "AbortError") throw err;
-							return { fieldPath: f.targetFieldPath, values: [] as PicklistValue[] };
-						}),
+						.catch(() => ({ fieldPath: f.targetFieldPath, values: [] as PicklistValue[] })),
 				);
 				const picklistResults = await Promise.all(picklistPromises);
 				if (isCancelled) return;
@@ -134,7 +120,7 @@ export function useObjectListMetadata(objectApiName: string | null): ObjectListM
 					error: null,
 				});
 			} catch (err) {
-				if (isCancelled || (err instanceof Error && err.name === "AbortError")) return;
+				if (isCancelled) return;
 				setState((s) => ({
 					...s,
 					columns: [],
@@ -149,7 +135,6 @@ export function useObjectListMetadata(objectApiName: string | null): ObjectListM
 		run();
 		return () => {
 			isCancelled = true;
-			ac.abort();
 		};
 	}, [objectApiName]);
 
@@ -169,212 +154,6 @@ export function useObjectColumns(objectApiName: string | null) {
 	};
 }
 
-/**
- * Hook: useObjectSearchResults
- *
- * Fetches search results for a specific object based on the provided query parameters.
- * Maintains the *latest* result set for the object in state to prevent redundant
- * network requests when the component re-renders with the same parameters.
- * Includes debouncing for search queries (but not pagination).
- *
- * @param objectApiName - The API name of the object to search
- * @param searchQuery - The search query string
- * @param searchPageSize - Number of results per page (default: 50)
- * @param searchPageToken - Pagination token (default: '0')
- * @param filters - Array of filter criteria to apply (default: [])
- * @param sortBy - Sort field and direction (default: 'relevance')
- * @returns Object containing results array, pagination tokens, loading state, and error state
- *
- * @example
- * ```tsx
- * const { results, nextPageToken, previousPageToken, currentPageToken, resultsLoading, resultsError } = useObjectSearchResults(
- *   'Account',
- *   'test query',
- *   25,
- *   '0',
- *   [{ objectApiName: 'Account', fieldPath: 'Name', operator: 'contains', values: ['test'] }]
- * );
- * ```
- */
-export function useObjectSearchResults(
-	objectApiName: string | null,
-	searchQuery: string,
-	searchPageSize: number = 50,
-	searchPageToken: string = "0",
-	filters: FilterCriteria[] = [],
-	sortBy: string = "relevance",
-) {
-	const [resultsCache, setResultsCache] = useState<
-		Record<
-			string,
-			{
-				results: SearchResultRecord[];
-				query: string;
-				pageToken: string;
-				pageSize: number;
-				filtersKey: string;
-				sortBy: string;
-				nextPageToken: string | null;
-				previousPageToken: string | null;
-				currentPageToken: string;
-			}
-		>
-	>({});
-	const [loading, setLoading] = useState<Record<string, boolean>>({});
-	const [error, setError] = useState<Record<string, string | null>>({});
-
-	const debounceTimeout = useRef<ReturnType<typeof setTimeout> | null>(null);
-	const abortControllerRef = useRef<AbortController | null>(null);
-	const resultsCacheRef = useRef(resultsCache);
-
-	const filtersKey = useMemo(() => {
-		const filtersArray = Array.isArray(filters) ? filters : [];
-		return createFiltersKey(filtersArray);
-	}, [filters]);
-
-	useEffect(() => {
-		resultsCacheRef.current = resultsCache;
-	}, [resultsCache]);
-
-	useEffect(() => {
-		if (!objectApiName || !searchQuery.trim()) {
-			return;
-		}
-
-		let isCancelled = false;
-		const abortController = new AbortController();
-
-		if (abortControllerRef.current) {
-			abortControllerRef.current.abort();
-		}
-		abortControllerRef.current = abortController;
-
-		if (debounceTimeout.current) {
-			clearTimeout(debounceTimeout.current);
-			debounceTimeout.current = null;
-		}
-
-		const cached = resultsCacheRef.current[objectApiName];
-		if (
-			!abortController.signal.aborted &&
-			cached &&
-			cached.query === searchQuery &&
-			cached.pageToken === searchPageToken &&
-			cached.pageSize === searchPageSize &&
-			cached.filtersKey === filtersKey &&
-			cached.sortBy === sortBy
-		) {
-			return;
-		}
-
-		if (abortController.signal.aborted) {
-			return;
-		}
-
-		const fetchResults = async () => {
-			setLoading((prev) => ({ ...prev, [objectApiName]: true }));
-			setError((prev) => ({ ...prev, [objectApiName]: null }));
-
-			try {
-				const searchParams: SearchParams = {
-					sortBy: sortBy === "relevance" ? "" : sortBy,
-					filters: filters,
-					pageSize: searchPageSize,
-					pageToken: searchPageToken,
-				};
-
-				const keywordSearchResult = await objectInfoService.searchResults(
-					searchQuery,
-					objectApiName,
-					searchParams,
-					abortController.signal,
-				);
-
-				if (isCancelled || abortController.signal.aborted) return;
-
-				const normalizedRecords = keywordSearchResult.records.map((r) => ({
-					record: r.record as SearchResultRecordData,
-					highlightInfo: r.highlightInfo,
-					searchInfo: r.searchInfo,
-				}));
-
-				const nextPageToken: string | null = keywordSearchResult.nextPageToken ?? null;
-				const previousPageToken: string | null = keywordSearchResult.previousPageToken ?? null;
-
-				setResultsCache((prev): typeof prev => ({
-					...prev,
-					[objectApiName]: {
-						results: normalizedRecords,
-						query: searchQuery,
-						pageToken: searchPageToken,
-						pageSize: searchPageSize,
-						filtersKey: filtersKey,
-						sortBy,
-						nextPageToken,
-						previousPageToken,
-						currentPageToken: keywordSearchResult.currentPageToken,
-					},
-				}));
-			} catch (err) {
-				if (isCancelled || (err instanceof Error && err.name === "AbortError")) {
-					return;
-				}
-				setError((prev) => ({ ...prev, [objectApiName]: "Unable to load search results" }));
-				// Cache empty result so we skip refetch on remount (avoid infinite loop on API error)
-				setResultsCache((prev) => ({
-					...prev,
-					[objectApiName]: {
-						results: [],
-						query: searchQuery,
-						pageToken: searchPageToken,
-						pageSize: searchPageSize,
-						filtersKey: filtersKey,
-						sortBy,
-						nextPageToken: null,
-						previousPageToken: null,
-						currentPageToken: searchPageToken,
-					},
-				}));
-			} finally {
-				if (!isCancelled) {
-					setLoading((prev) => ({ ...prev, [objectApiName]: false }));
-				}
-			}
-		};
-
-		if (searchPageToken === "0") {
-			debounceTimeout.current = setTimeout(() => {
-				fetchResults();
-			}, 300);
-		} else {
-			fetchResults();
-		}
-
-		return () => {
-			isCancelled = true;
-			abortController.abort();
-			if (debounceTimeout.current) {
-				clearTimeout(debounceTimeout.current);
-				debounceTimeout.current = null;
-			}
-			if (abortControllerRef.current === abortController) {
-				abortControllerRef.current = null;
-			}
-		};
-	}, [objectApiName, searchQuery, searchPageSize, searchPageToken, filtersKey, sortBy]);
-
-	return {
-		results: objectApiName ? resultsCache[objectApiName]?.results || [] : [],
-		nextPageToken: objectApiName ? resultsCache[objectApiName]?.nextPageToken || null : null,
-		previousPageToken: objectApiName
-			? resultsCache[objectApiName]?.previousPageToken || null
-			: null,
-		currentPageToken: objectApiName ? resultsCache[objectApiName]?.currentPageToken || "0" : "0",
-		resultsLoading: objectApiName ? loading[objectApiName] || false : false,
-		resultsError: objectApiName ? error[objectApiName] || null : null,
-	};
-}
-
 /**
  * Hook: useObjectFilters
  * Thin wrapper over useObjectListMetadata for backward compatibility.

package/src/force-app/main/default/webapplications/feature-react-global-search/src/features/global-search/hooks/useRecordDetailLayout.ts

@@ -16,7 +16,6 @@ export interface UseRecordDetailLayoutParams {
 	objectApiName: string | null;
 	recordId: string | null;
 	recordTypeId?: string | null;
-	/** When provided, skips the fetch and uses this data (avoids duplicate API calls when parent already fetched). Callers should memoize this (e.g. useMemo) to avoid unnecessary effect runs. */
 	initialData?: {
 		layout: LayoutResponse;
 		record: GraphQLRecordNode;
@@ -25,7 +24,6 @@ export interface UseRecordDetailLayoutParams {
 }
 
 const MAX_CACHE_SIZE = 50;
-/** Cache entries older than this are treated as stale and refetched. */
 const CACHE_TTL_MS = 5 * 60 * 1000;
 
 type CacheEntry = {
@@ -35,17 +33,6 @@ type CacheEntry = {
 	cachedAt: number;
 };
 
-/**
- * Detail page data: layout (REST), object metadata (GraphQL), single record (GraphQL).
- *
- * Calls objectDetailService.getRecordDetail once per objectApiName/recordId/recordTypeId.
- * Caches result in memory (TTL 5min, max 50 entries). Used by DetailPage and UiApiDetailForm.
- *
- * @param objectApiName - Object API name.
- * @param recordId - Record Id.
- * @param recordTypeId - Optional record type (default master).
- * @returns { layout, record, objectMetadata, loading, error }.
- */
 export function useRecordDetailLayout({
 	objectApiName,
 	recordId,
@@ -71,7 +58,6 @@ export function useRecordDetailLayout({
 			return;
 		}
 
-		// Skip fetch when parent already provided data (avoids duplicate API calls)
 		if (
 			initialData?.layout != null &&
 			initialData?.record != null &&
@@ -92,7 +78,6 @@ export function useRecordDetailLayout({
 		}
 
 		let isCancelled = false;
-		const abortController = new AbortController();
 
 		const fetchDetail = async () => {
 			setLoading(true);
@@ -107,7 +92,6 @@ export function useRecordDetailLayout({
 					objectApiName,
 					recordId,
 					recordTypeId ?? undefined,
-					abortController.signal,
 				);
 
 				if (isCancelled) return;
@@ -127,9 +111,7 @@ export function useRecordDetailLayout({
 				setRecord(recordData);
 				setObjectMetadata(objectMetadataData);
 			} catch (err) {
-				if (isCancelled || (err instanceof Error && err.name === "AbortError")) {
-					return;
-				}
+				if (isCancelled) return;
 				setError("Failed to load record details");
 			} finally {
 				if (!isCancelled) {
@@ -142,7 +124,6 @@ export function useRecordDetailLayout({
 
 		return () => {
 			isCancelled = true;
-			abortController.abort();
 		};
 	}, [objectApiName, recordId, recordTypeId, cacheKey, initialData]);
 

package/src/force-app/main/default/webapplications/feature-react-global-search/src/features/global-search/utils/apiUtils.ts

@@ -2,77 +2,31 @@
  * API Utilities
  *
  * Generic utility functions for API requests, validation, and URL handling.
- * These utilities are framework-agnostic and can be reused across different API services.
  */
 
 import type { ZodSchema } from "zod";
 
-/**
- * Options for fetchAndValidate utility function
- */
 export interface FetchAndValidateOptions<T> {
-	/** Zod schema for validation */
 	schema: ZodSchema<T>;
-	/** Error context for better error messages (e.g., "object info batch", "list info") */
 	errorContext: string;
-	/** Optional function to extract/transform data from response before validation */
 	extractData?: (data: unknown) => unknown;
-	/** Optional AbortSignal to cancel the request */
-	signal?: AbortSignal;
 }
 
-/**
- * Generic utility function to fetch, parse, and validate API responses.
- * Handles common patterns: fetch -> check status -> parse JSON -> validate Zod -> handle errors
- *
- * @param fetchFn - Function that returns a Promise<Response> (e.g., uiApiClient.get or uiApiClient.post)
- * @param options - Configuration options including schema, error context, optional data extraction, and AbortSignal
- * @returns Promise resolving to validated data of type T
- *
- * @remarks
- * - Handles abort signals properly to prevent race conditions
- * - Provides detailed error messages with context
- * - Validates responses using Zod schemas for type safety
- * - Supports data extraction/transformation before validation
- *
- * @example
- * ```tsx
- * const data = await fetchAndValidate(
- *   (signal) => apiClient.get('/endpoint', { signal }),
- *   {
- *     schema: MySchema,
- *     errorContext: 'user data',
- *     extractData: (data) => data.items,
- *     signal: abortController.signal
- *   }
- * );
- * ```
- */
 export async function fetchAndValidate<T>(
-	fetchFn: (signal?: AbortSignal) => Promise<Response>,
+	fetchFn: () => Promise<Response>,
 	options: FetchAndValidateOptions<T>,
 ): Promise<T> {
-	const { schema, errorContext, extractData, signal } = options;
+	const { schema, errorContext, extractData } = options;
 
 	try {
-		const response = await fetchFn(signal);
-
-		if (signal?.aborted) {
-			throw new DOMException("The operation was aborted.", "AbortError");
-		}
+		const response = await fetchFn();
 
 		if (!response.ok) {
 			throw new Error(`Failed to fetch ${errorContext}: ${response.status} ${response.statusText}`);
 		}
 
 		const data = await response.json();
-
-		if (signal?.aborted) {
-			throw new DOMException("The operation was aborted.", "AbortError");
-		}
-
 		const dataToValidate = extractData ? extractData(data) : data;
-
 		const validationResult = schema.safeParse(dataToValidate);
 
 		if (!validationResult.success) {
@@ -81,14 +35,6 @@ export async function fetchAndValidate<T>(
 
 		return validationResult.data;
 	} catch (error) {
-		if (error instanceof DOMException && error.name === "AbortError") {
-			throw error;
-		}
-
-		if (error instanceof Error && error.name === "AbortError") {
-			throw error;
-		}
-
 		if (error instanceof Error && error.name === "ZodError") {
 			throw new Error(`Invalid ${errorContext} response format: ${error.message}`);
 		}
@@ -108,18 +54,6 @@ export async function fetchAndValidate<T>(
 	}
 }
 
-/**
- * Helper to safely encode path components for URLs
- * Wraps encodeURIComponent for better semantic meaning
- *
- * @param segment - The path segment to encode
- * @returns URL-encoded path segment
- *
- * @example
- * ```tsx
- * const safePath = safeEncodePath('Account Name'); // 'Account%20Name'
- * ```
- */
 export function safeEncodePath(segment: string): string {
 	return encodeURIComponent(segment);
 }

package/src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts

@@ -0,0 +1,125 @@
+/**
+ * Public API for the Global Search feature package.
+ *
+ * Design goals:
+ * - Export **API services, hooks, types, schemas, and utilities** that customers can import from node_modules.
+ * - Do **not** export UI components or feature constants (customers build their own UI).
+ *
+ * Source implementation lives under `src/features/global-search/**`.
+ */
+
+// ---------------------------------------------------------------------------
+// API layer
+// ---------------------------------------------------------------------------
+
+export { objectInfoService } from "./features/global-search/api/objectInfoService";
+export {
+	objectDetailService,
+	extractFieldsFromLayout,
+} from "./features/global-search/api/objectDetailService";
+export type { RecordDetailResult } from "./features/global-search/api/objectDetailService";
+
+export {
+	getRecordsGraphQL,
+	getRecordByIdGraphQL,
+	buildGetRecordsQuery,
+	buildWhereFromCriteria,
+	buildOrderByFromSort,
+} from "./features/global-search/api/recordListGraphQLService";
+export type {
+	RecordListGraphQLResult,
+	RecordListGraphQLVariables,
+	RecordListGraphQLOptions,
+	GraphQLRecordNode,
+} from "./features/global-search/api/recordListGraphQLService";
+
+// ---------------------------------------------------------------------------
+// Hooks
+// ---------------------------------------------------------------------------
+
+export { useObjectInfoBatch } from "./features/global-search/hooks/useObjectInfoBatch";
+export {
+	useObjectListMetadata,
+	useObjectColumns,
+	useObjectFilters,
+} from "./features/global-search/hooks/useObjectSearchData";
+export { useRecordListGraphQL } from "./features/global-search/hooks/useRecordListGraphQL";
+export { useRecordDetailLayout } from "./features/global-search/hooks/useRecordDetailLayout";
+
+export type { ObjectListMetadata } from "./features/global-search/hooks/useObjectSearchData";
+
+export type {
+	UseRecordListGraphQLOptions,
+	UseRecordListGraphQLReturn,
+} from "./features/global-search/hooks/useRecordListGraphQL";
+
+export type {
+	UseRecordDetailLayoutParams,
+	UseRecordDetailLayoutReturn,
+} from "./features/global-search/hooks/useRecordDetailLayout";
+
+// ---------------------------------------------------------------------------
+// Types + Zod schemas (runtime validation)
+// ---------------------------------------------------------------------------
+
+export {
+	ColumnArraySchema,
+	SearchResultRecordArraySchema,
+	KeywordSearchResultSchema,
+	SearchResultsResponseSchema,
+} from "./features/global-search/types/search/searchResults";
+export type {
+	Column,
+	SearchResultRecord,
+	KeywordSearchResult,
+	SearchResultsResponse,
+} from "./features/global-search/types/search/searchResults";
+
+export {
+	FilterArraySchema,
+	FilterCriteriaArraySchema,
+	FILTER_OPERATORS,
+} from "./features/global-search/types/filters/filters";
+export type {
+	Filter,
+	FilterCriteria,
+	FilterOperator,
+	FiltersResponse,
+} from "./features/global-search/types/filters/filters";
+
+export { PicklistValueArraySchema } from "./features/global-search/types/filters/picklist";
+export type { PicklistValue } from "./features/global-search/types/filters/picklist";
+
+export {
+	ObjectInfoBatchResponseSchema,
+	ObjectInfoResultSchema,
+} from "./features/global-search/types/objectInfo/objectInfo";
+export type {
+	ObjectInfoBatchResponse,
+	ObjectInfoResult,
+} from "./features/global-search/types/objectInfo/objectInfo";
+
+export { LayoutResponseSchema } from "./features/global-search/types/recordDetail/recordDetail";
+export type { LayoutResponse } from "./features/global-search/types/recordDetail/recordDetail";
+
+// ---------------------------------------------------------------------------
+// Utilities
+// ---------------------------------------------------------------------------
+
+export { fetchAndValidate, safeEncodePath } from "./features/global-search/utils/apiUtils";
+export { debounce } from "./features/global-search/utils/debounce";
+export { createFiltersKey } from "./features/global-search/utils/cacheUtils";
+export {
+	calculateFieldsToFetch,
+	getSafeKey,
+	isValidSalesforceId,
+} from "./features/global-search/utils/recordUtils";
+export { parseFilterValue } from "./features/global-search/utils/filterUtils";
+export { sanitizeFilterValue } from "./features/global-search/utils/sanitizationUtils";
+export {
+	getGraphQLNodeValue,
+	getDisplayValueForDetailFieldFromNode,
+	getDisplayValueForLayoutItemFromNode,
+	getGraphQLRecordDisplayName,
+} from "./features/global-search/utils/graphQLNodeFieldUtils";
+export { graphQLNodeToSearchResultRecordData } from "./features/global-search/utils/graphQLRecordAdapter";