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

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/api/objectInfoGraphQLService.ts

@@ -0,0 +1,194 @@
+/**
+ * Object metadata GraphQL service (uiapi.objectInfos).
+ *
+ * Single endpoint for object describe and picklist values. Used by objectInfoService
+ * to implement getObjectInfoBatch and getPicklistValues. Not used directly by UI.
+ *
+ * @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>>;
+	};
+}
+
+/**
+ * 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
+      }
+    }
+  }
+}`;
+}
+
+/**
+ * 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.
+ */
+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
+      }
+    }
+  }
+}`;
+}
+
+/**
+ * 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 };
+	const data = await getDataSDK();
+	const response = await data.graphql?.<ObjectInfosGraphQLResponse>(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);
+}

package/dist/force-app/main/default/webapplications/appreactsampleb2x/src/api/objectInfoService.ts

@@ -0,0 +1,199 @@
+import { uiApiClient } from "@salesforce/webapp-experimental/api";
+import { z } from "zod";
+import type { SearchResultsResponse, KeywordSearchResult } from "../types/search/searchResults";
+import { SearchResultsResponseSchema } from "../types/search/searchResults";
+import { FilterCriteriaArraySchema } from "../types/filters/filters";
+import type { Filter } from "../types/filters/filters";
+import { FilterArraySchema } from "../types/filters/filters";
+import type { PicklistValue } from "../types/filters/picklist";
+import type { ObjectInfoBatchResponse } from "../types/objectInfo/objectInfo";
+import { fetchAndValidate, safeEncodePath } from "../utils/apiUtils";
+import { getObjectInfosGraphQL } from "./objectInfoGraphQLService";
+import {
+	graphQLObjectInfosToBatchResponse,
+	extractPicklistValuesFromGraphQLObjectInfo,
+} from "../utils/graphQLObjectInfoAdapter";
+
+/**
+ * Object info and search service.
+ *
+ * - getObjectInfoBatch / getPicklistValues: GraphQL (objectInfoGraphQLService).
+ * - getObjectListFilters, searchResults: REST (search-info, search/results).
+ * Hooks use this service; components do not call it directly.
+ *
+ * @module api/objectInfoService
+ */
+
+/** Cache key: sorted, comma-joined object API names. */
+function getObjectInfoBatchCacheKey(objectApiNames: string): string {
+	const names = objectApiNames
+		.split(",")
+		.map((s) => s.trim())
+		.filter(Boolean);
+	return [...names].sort().join(",");
+}
+
+const objectInfoBatchCache = new Map<string, ObjectInfoBatchResponse>();
+const objectInfoBatchInFlight = new Map<string, Promise<ObjectInfoBatchResponse>>();
+
+/**
+ * Fetches batch object information for the specified objects via GraphQL (uiapi.objectInfos).
+ * Results are cached by object set so List, Home, and Detail views share one request.
+ *
+ * @param objectApiNames - Comma-separated list of object API names (e.g., "Account,AccountBrand")
+ * @param signal - Optional AbortSignal to cancel the request
+ * @returns Promise resolving to the object info batch response (REST-compatible shape)
+ */
+export async function getObjectInfoBatch(
+	objectApiNames: string,
+	signal?: AbortSignal,
+): Promise<ObjectInfoBatchResponse> {
+	const names = objectApiNames
+		.split(",")
+		.map((s) => s.trim())
+		.filter(Boolean);
+	if (names.length === 0) {
+		return { results: [] };
+	}
+	const key = getObjectInfoBatchCacheKey(objectApiNames);
+	const cached = objectInfoBatchCache.get(key);
+	if (cached) return Promise.resolve(cached);
+	const inFlight = objectInfoBatchInFlight.get(key);
+	if (inFlight) return inFlight;
+	const promise = (async () => {
+		try {
+			const response = await getObjectInfosGraphQL(names, { signal });
+			const nodes = response?.uiapi?.objectInfos ?? [];
+			const result = graphQLObjectInfosToBatchResponse(nodes, names);
+			objectInfoBatchCache.set(key, result);
+			return result;
+		} finally {
+			objectInfoBatchInFlight.delete(key);
+		}
+	})();
+	objectInfoBatchInFlight.set(key, promise);
+	return promise;
+}
+
+/**
+ * Fetches list filters for a specific object.
+ * Salesforce Search supports "Search Filters" (refinements) which are configured per object.
+ * This API returns the available filters (e.g., "Close Date", "Stage") that the user
+ * can use to narrow down the search results.
+ * @param objectApiName - The API name of the object (e.g., "Account")
+ * @param signal - Optional AbortSignal to cancel the request
+ * @returns Promise resolving to the search filters array
+ */
+export async function getObjectListFilters(
+	objectApiName: string,
+	signal?: AbortSignal,
+): Promise<Filter[]> {
+	return fetchAndValidate(
+		(abortSignal) =>
+			uiApiClient.get(`/search-info/${safeEncodePath(objectApiName)}/filters`, {
+				signal: abortSignal,
+			}),
+		{
+			schema: FilterArraySchema,
+			errorContext: `filters for ${objectApiName}`,
+			extractData: (data: unknown) => {
+				if (!data) return [];
+				return Array.isArray(data) ? data : (data as { filters?: unknown }).filters || [];
+			},
+			signal,
+		},
+	);
+}
+
+/**
+ * Fetches picklist values for a specific field via GraphQL (uiapi.objectInfos with objectInfoInputs).
+ *
+ * @param objectApiName - The API name of the object (e.g., "Account")
+ * @param fieldName - The API name of the field (e.g., "Type")
+ * @param recordTypeId - Optional record type ID (defaults to "012000000000000AAA" which is the default/master record type)
+ * @param signal - Optional AbortSignal to cancel the request
+ * @returns Promise resolving to an array of picklist values
+ */
+export async function getPicklistValues(
+	objectApiName: string,
+	fieldName: string,
+	recordTypeId: string = "012000000000000AAA",
+	signal?: AbortSignal,
+): Promise<PicklistValue[]> {
+	const response = await getObjectInfosGraphQL([objectApiName], {
+		objectInfoInputs: [
+			{
+				apiName: objectApiName,
+				fieldNames: [fieldName],
+			},
+		],
+		signal,
+	});
+	const nodes = response?.uiapi?.objectInfos ?? [];
+	const node = nodes[0];
+	if (!node) return [];
+	return extractPicklistValuesFromGraphQLObjectInfo(node, fieldName, recordTypeId);
+}
+
+// Zod Schema for Search Parameters
+const SearchParamsSchema = z.object({
+	filters: FilterCriteriaArraySchema.optional(),
+	pageSize: z.number().optional(),
+	pageToken: z.string().optional(),
+	sortBy: z.string().optional(),
+});
+
+/**
+ * Search parameters for keyword search
+ */
+export type SearchParams = z.infer<typeof SearchParamsSchema>;
+
+/**
+ * Performs a keyword search on a specific object.
+ * Returns records that match the text query along with pagination information.
+ *
+ * @param query - The search query string
+ * @param objectApiName - The API name of the object to search (e.g., "Account")
+ * @param params - Optional search parameters (pageSize, pageToken, filters, sortBy)
+ * @param signal - Optional AbortSignal to cancel the request
+ * @returns Promise resolving to the keyword search result with records and pagination tokens
+ */
+export async function searchResults(
+	query: string,
+	objectApiName: string,
+	params?: SearchParams,
+	signal?: AbortSignal,
+): Promise<KeywordSearchResult> {
+	const searchParams = new URLSearchParams({
+		q: query,
+		objectApiName: objectApiName,
+	});
+
+	const body = {
+		filters: params?.filters ?? [],
+		pageSize: params?.pageSize ?? 50,
+		pageToken: params?.pageToken ?? "0",
+		sortBy: params?.sortBy ?? "",
+	};
+
+	const response = await fetchAndValidate<SearchResultsResponse>(
+		(abortSignal) =>
+			uiApiClient.post(`/search/results/keyword?${searchParams.toString()}`, body, {
+				signal: abortSignal,
+			}),
+		{
+			schema: SearchResultsResponseSchema,
+			errorContext: `search results for ${objectApiName} with query "${query}"`,
+			signal,
+		},
+	);
+
+	return response.keywordSearchResult;
+}
+
+export const objectInfoService = {
+	getObjectInfoBatch,
+	getObjectListFilters,
+	getPicklistValues,
+	searchResults,
+};