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

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

@@ -49,13 +49,13 @@ const getFetchableFieldsFromLayoutItem = function (
 
 		// add field: fieldType
 		const fieldMetadata = metadata.fields[comp.apiName];
-		fields[comp.apiName] = fieldMetadata ? fieldMetadata.dataType : "";
+		fields[comp.apiName] = fieldMetadata?.dataType ?? "";
 
 		// add relatedField if one exists (Id field -> add relationship name so we request Owner.Name)
 		if (comp.apiName in metadata.fields) {
 			const relationshipName = fieldMetadata?.relationshipName;
 			if (relationshipName) {
-				fields[relationshipName] = fieldMetadata.dataType;
+				fields[relationshipName] = fieldMetadata.dataType ?? "";
 
 				relationFieldMap[comp.apiName] = relationshipName;
 			}
@@ -65,7 +65,7 @@ const getFetchableFieldsFromLayoutItem = function (
 			const idField = findIdFieldForRelationship(metadata, comp.apiName);
 			if (idField) {
 				const idMeta = metadata.fields[idField];
-				fields[idField] = idMeta ? idMeta.dataType : "";
+				fields[idField] = idMeta?.dataType ?? "";
 				relationFieldMap[idField] = comp.apiName;
 			}
 		}
@@ -137,7 +137,7 @@ export const calculateFieldsToFetch = function (
 	const fields = getFetchableFieldsFromLayout(metadata, layout, relationFieldMap);
 	let fieldsToFetch = Object.keys(fields);
 	if (shouldPrefixedWithEntityName) {
-		fieldsToFetch = fieldsToFetch.map((field) => `${metadata.apiName}.${field}`);
+		fieldsToFetch = fieldsToFetch.map((field) => `${metadata.ApiName}.${field}`);
 	}
 	// populate field types for o11y logging
 	const fieldTypes = Object.values(fields).filter((fieldType) => fieldType !== "");

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

@@ -0,0 +1,120 @@
+/**
+ * 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 type { PicklistValue } from "./features/global-search/types/filters/picklist";
+
+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";

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/webapp-template-base-sfdx-project-experimental",
-  "version": "1.76.0",
+  "version": "1.77.0",
   "description": "Base SFDX project template",
   "private": true,
   "files": [

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@salesforce/webapp-template-feature-react-global-search-experimental",
-  "version": "1.76.0",
+  "version": "1.77.0",
   "description": "Global search feature for Salesforce objects with filtering and pagination",
   "license": "SEE LICENSE IN LICENSE.txt",
   "author": "",
   "main": "src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts",
-  "types": "src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts",
+  "types": "index.d.ts",
   "exports": {
     ".": {
-      "types": "./src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts",
+      "types": "./index.d.ts",
       "import": "./src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts",
       "default": "./src/force-app/main/default/webapplications/feature-react-global-search/src/index.ts"
     }

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

@@ -36,17 +36,9 @@ export function extractFieldsFromLayout(
 	return optionalFields;
 }
 
-/**
- * Fetches the Full/View layout for an object (REST). Used by detail view to render sections/rows/items.
- *
- * @param objectApiName - Object API name.
- * @param recordTypeId - Record type Id (default master).
- * @param signal - Optional abort signal.
- */
 export async function getLayout(
 	objectApiName: string,
 	recordTypeId: string = DEFAULT_RECORD_TYPE_ID,
-	signal?: AbortSignal,
 ): Promise<LayoutResponse> {
 	const params = new URLSearchParams({
 		layoutType: "Full",
@@ -54,14 +46,10 @@ export async function getLayout(
 		recordTypeId,
 	});
 	return fetchAndValidate(
-		(abortSignal) =>
-			uiApiClient.get(`/layout/${safeEncodePath(objectApiName)}?${params.toString()}`, {
-				signal: abortSignal,
-			}),
+		() => uiApiClient.get(`/layout/${safeEncodePath(objectApiName)}?${params.toString()}`),
 		{
 			schema: LayoutResponseSchema,
 			errorContext: `layout for ${objectApiName}`,
-			signal,
 		},
 	);
 }
@@ -86,24 +74,13 @@ function optionalFieldsToColumns(optionalFields: string[]): Column[] {
 	}));
 }
 
-/**
- * Fetches everything needed for the detail page: layout (REST), object metadata (GraphQL), single record (GraphQL).
- * Layout drives which fields are requested; getRecordByIdGraphQL fetches that field set by Id.
- *
- * @param objectApiName - Object API name.
- * @param recordId - Record Id.
- * @param recordTypeId - Record type (default master).
- * @param signal - Optional abort signal.
- * @returns { layout, record, objectMetadata } for DetailForm / UiApiDetailForm.
- */
 export async function getRecordDetail(
 	objectApiName: string,
 	recordId: string,
 	recordTypeId: string = DEFAULT_RECORD_TYPE_ID,
-	signal?: AbortSignal,
 ): Promise<RecordDetailResult> {
-	const layout = await getLayout(objectApiName, recordTypeId, signal);
-	const objectMetadata = await objectInfoService.getObjectInfoBatch(objectApiName, signal);
+	const layout = await getLayout(objectApiName, recordTypeId);
+	const objectMetadata = await objectInfoService.getObjectInfoBatch(objectApiName);
 	const firstResult = objectMetadata?.results?.[0]?.result;
 	if (!firstResult) {
 		throw new Error(`Object metadata not found for ${objectApiName}`);

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

@@ -7,188 +7,131 @@
  * @module api/objectInfoGraphQLService
  */
 
-import { getDataSDK } from "@salesforce/sdk-data";
-
-/** GraphQL objectInfoInputs for requesting picklist values (API v65.0+). Only apiName and fieldNames are sent; record type filtering is done from the response. */
-export interface ObjectInfoInput {
-	apiName: string;
-	fieldNames?: string[] | null;
-}
-
-/** Raw GraphQL response shape for uiapi.objectInfos (flexible for schema casing). */
-export interface ObjectInfosGraphQLResponse {
-	uiapi?: {
-		objectInfos?: Array<Record<string, unknown>>;
-	};
-}
+import { getDataSDK, gql } from "@salesforce/sdk-data";
+import type {
+	GetObjectInfosQuery,
+	GetObjectInfosQueryVariables,
+	GetPicklistValuesQuery,
+	GetPicklistValuesQueryVariables,
+	ObjectInfoInput,
+} from "../types/schema";
 
 /**
  * Builds objectInfos query (metadata only). Uses apiNames only — do not pass objectInfoInputs.
  */
-function buildObjectInfosQuery(): string {
-	return `query GetObjectInfos($apiNames: [String!]!) {
-  uiapi {
-    objectInfos(apiNames: $apiNames) {
-      ApiName
-      label
-      labelPlural
-      nameFields
-      defaultRecordTypeId
-      keyPrefix
-      layoutable
-      queryable
-      searchable
-      updateable
-      deletable
-      createable
-      custom
-      mruEnabled
-      feedEnabled
-      fields {
-        ApiName
-        label
-        dataType
-        relationshipName
-        reference
-        compound
-        compoundFieldName
-        compoundComponentName
-        controllingFields
-        controllerName
-        referenceToInfos {
-          ApiName
-          nameFields
-        }
-      }
-      recordTypeInfos {
-        recordTypeId
-        name
-        master
-        available
-        defaultRecordTypeMapping
-      }
-      themeInfo {
-        color
-        iconUrl
-      }
-      childRelationships {
-        relationshipName
-        fieldName
-        childObjectApiName
-      }
-      dependentFields {
-        controllingField
-      }
-    }
-  }
-}`;
-}
+const OBJECT_INFOS_QUERY = gql`
+	query GetObjectInfos($apiNames: [String!]!) {
+		uiapi {
+			objectInfos(apiNames: $apiNames) {
+				ApiName
+				label
+				labelPlural
+				nameFields
+				defaultRecordTypeId
+				keyPrefix
+				layoutable
+				queryable
+				searchable
+				updateable
+				deletable
+				createable
+				custom
+				mruEnabled
+				feedEnabled
+				fields {
+					ApiName
+					label
+					dataType
+					relationshipName
+					reference
+					compound
+					compoundFieldName
+					compoundComponentName
+					controllingFields
+					controllerName
+					referenceToInfos {
+						ApiName
+						nameFields
+					}
+				}
+				recordTypeInfos {
+					recordTypeId
+					name
+					master
+					available
+					defaultRecordTypeMapping
+				}
+				themeInfo {
+					color
+					iconUrl
+				}
+				childRelationships {
+					relationshipName
+					fieldName
+					childObjectApiName
+				}
+				dependentFields {
+					controllingField
+				}
+			}
+		}
+	}
+`;
 
 /**
  * Builds objectInfos query with picklist values (API v65.0+).
  * Schema requires objectInfos to be called with either apiNames or objectInfoInputs, not both.
  * This query uses objectInfoInputs only.
+ * Optimized to only fetch fields used by extractPicklistValuesFromGraphQLObjectInfo.
  */
-function buildObjectInfosWithPicklistsQuery(): string {
-	return `query GetPicklistValues($objectInfoInputs: [ObjectInfoInput!]!) {
-  uiapi {
-    objectInfos(objectInfoInputs: $objectInfoInputs) {
-      ApiName
-      label
-      labelPlural
-      nameFields
-      defaultRecordTypeId
-      keyPrefix
-      layoutable
-      queryable
-      searchable
-      updateable
-      deletable
-      createable
-      custom
-      mruEnabled
-      feedEnabled
-      fields {
-        ApiName
-        label
-        dataType
-        relationshipName
-        reference
-        compound
-        compoundFieldName
-        compoundComponentName
-        controllingFields
-        controllerName
-        referenceToInfos {
-          ApiName
-          nameFields
-        }
-        ... on PicklistField {
-          picklistValuesByRecordTypeIDs {
-            recordTypeID
-            defaultValue {
-              value
-            }
-            picklistValues {
-              label
-              value
-              validFor
-            }
-          }
-        }
-      }
-      recordTypeInfos {
-        recordTypeId
-        name
-        master
-        available
-        defaultRecordTypeMapping
-      }
-      themeInfo {
-        color
-        iconUrl
-      }
-      childRelationships {
-        relationshipName
-        fieldName
-        childObjectApiName
-      }
-      dependentFields {
-        controllingField
-      }
-    }
-  }
-}`;
+const PICKLIST_VALUES_QUERY = gql`
+	query GetPicklistValues($objectInfoInputs: [ObjectInfoInput!]!) {
+		uiapi {
+			objectInfos(objectInfoInputs: $objectInfoInputs) {
+				ApiName
+				fields {
+					ApiName
+					... on PicklistField {
+						picklistValuesByRecordTypeIDs {
+							recordTypeID
+							defaultValue {
+								value
+							}
+							picklistValues {
+								label
+								value
+								validFor
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+`;
+
+export async function queryForObjectInfos(apiNames: string[]): Promise<GetObjectInfosQuery> {
+	return runQuery<GetObjectInfosQuery, GetObjectInfosQueryVariables>(OBJECT_INFOS_QUERY, {
+		apiNames,
+	});
 }
 
-/**
- * Fetches object metadata for the given objects via GraphQL.
- *
- * @param apiNames - Object API names (e.g. ["Account", "Contact"]).
- * @param options.objectInfoInputs - When set, picklist values for specified fields are included (API v65.0+).
- * @param options.signal - Optional abort signal.
- * @returns Raw uiapi.objectInfos response (adapt to REST shape via graphQLObjectInfosToBatchResponse).
- */
-export async function getObjectInfosGraphQL(
-	apiNames: string[],
-	options?: {
-		objectInfoInputs?: ObjectInfoInput[] | null;
-		signal?: AbortSignal;
-	},
-): Promise<ObjectInfosGraphQLResponse> {
-	const names = apiNames.length ? apiNames : [];
-	const hasInputs = options?.objectInfoInputs != null && options.objectInfoInputs.length > 0;
-	const query = hasInputs ? buildObjectInfosWithPicklistsQuery() : buildObjectInfosQuery();
-	const variables: Record<string, unknown> = hasInputs
-		? { objectInfoInputs: options!.objectInfoInputs }
-		: { apiNames: names };
+export async function queryForPicklistValues(
+	objectInfoInputs: ObjectInfoInput[],
+): Promise<GetPicklistValuesQuery> {
+	return runQuery<GetPicklistValuesQuery, GetPicklistValuesQueryVariables>(PICKLIST_VALUES_QUERY, {
+		objectInfoInputs,
+	});
+}
+
+async function runQuery<Q, V>(query: string, variables: V): Promise<Q> {
 	const data = await getDataSDK();
-	const response = await data.graphql?.<ObjectInfosGraphQLResponse>(query, variables);
+	const response = await data.graphql?.<Q, V>(query, variables);
 
 	if (response?.errors?.length) {
 		const errorMessages = response.errors.map((e) => e.message).join("; ");
 		throw new Error(`GraphQL Error: ${errorMessages}`);
 	}
 
-	return response?.data ?? ({} as ObjectInfosGraphQLResponse);
+	return response?.data ?? ({} as Q);
 }