@salesforce/templates 66.17.4 → 66.18.0

package/lib/templates/project/vueinternalapp/_p_/_m_/_w_/_a_/src/_f_/search/config.json

@@ -0,0 +1,88 @@
+{
+  "pagination": {
+    "mode": "per-source",
+    "pageSize": 10,
+    "pageSizeOptions": [5, 10, 20]
+  },
+  "sources": [
+    {
+      "kind": "sobject",
+      "key": "accounts",
+      "objectName": "Account",
+      "label": "Accounts",
+      "labelSingular": "Account",
+      "routePattern": "/accounts/:id",
+      "searchableFields": ["Name", "Phone", "Industry"],
+      "displayFields": [
+        "Name",
+        "Industry",
+        "Type",
+        "Phone",
+        "AnnualRevenue",
+        { "name": "Owner", "subfields": ["Name"] }
+      ],
+      "filterBy": [
+        { "field": "Industry", "label": "Industry", "type": "picklist" },
+        { "field": "Type", "label": "Type", "type": "picklist" },
+        { "field": "AnnualRevenue", "label": "Annual Revenue", "type": "numeric" }
+      ],
+      "sortBy": [
+        { "field": "Name", "label": "Name" },
+        { "field": "Industry", "label": "Industry" },
+        { "field": "AnnualRevenue", "label": "Annual Revenue" },
+        { "field": "CreatedDate", "label": "Created Date" }
+      ]
+    },
+    {
+      "kind": "sobject",
+      "key": "contacts",
+      "objectName": "Contact",
+      "label": "Contacts",
+      "labelSingular": "Contact",
+      "searchableFields": ["Name", "Email", "Phone"],
+      "displayFields": [
+        "Name",
+        "Title",
+        "Email",
+        "Phone",
+        { "name": "Account", "subfields": ["Name"] }
+      ],
+      "sortBy": [
+        { "field": "Name", "label": "Name" },
+        { "field": "CreatedDate", "label": "Created Date" }
+      ]
+    },
+    {
+      "kind": "sobject",
+      "key": "opportunities",
+      "objectName": "Opportunity",
+      "label": "Opportunities",
+      "labelSingular": "Opportunity",
+      "searchableFields": ["Name"],
+      "displayFields": [
+        "Name",
+        "StageName",
+        "Amount",
+        "CloseDate",
+        { "name": "Account", "subfields": ["Name"] }
+      ],
+      "filterBy": [
+        { "field": "StageName", "label": "Stage", "type": "picklist" },
+        { "field": "Amount", "label": "Amount", "type": "numeric" },
+        { "field": "CloseDate", "label": "Close Date", "type": "daterange" }
+      ],
+      "sortBy": [
+        { "field": "CloseDate", "label": "Close Date" },
+        { "field": "Amount", "label": "Amount" },
+        { "field": "Name", "label": "Name" }
+      ],
+      "defaultSort": { "field": "CloseDate", "direction": "DESC" }
+    },
+    {
+      "kind": "cms",
+      "key": "content",
+      "label": "Content",
+      "labelSingular": "Content"
+    }
+  ]
+}

package/lib/templates/project/vueinternalapp/_p_/_m_/_w_/_a_/src/_f_/search/constants.ts

@@ -0,0 +1,8 @@
+/**
+ * Minimum trimmed keyword length before a search fires. Both the SObject and
+ * CMS search backends reject terms shorter than this (returning errors that the
+ * UI would otherwise render as "Search failed for this source." on every
+ * source), so the query is gated client-side until the user types at least this
+ * many characters. Shared so every `<Search>` consumer inherits the same floor.
+ */
+export const MIN_QUERY_LENGTH = 3;

package/lib/templates/project/vueinternalapp/_p_/_m_/_w_/_a_/src/_f_/search/index.ts

@@ -0,0 +1,115 @@
+/**
+ * Public API for the search feature.
+ *
+ * Most apps only need:
+ *   ```vue
+ *   <script setup lang="ts">
+ *   import { Search, config } from ".../features/search";
+ *   </script>
+ *   <template><Search :config="config" /></template>
+ *   ```
+ *
+ * For more control, drop down to primitives:
+ *   - {@link useSearch} composable + {@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 { default as Search } from "./components/Search.vue";
+
+// Primitives
+export { useSearch } from "./composables/useSearch";
+export type { UseSearchOptions } from "./composables/useSearch";
+export { useAsyncData } from "./composables/useAsyncData";
+export { useDistinctValues } from "./composables/useDistinctValues";
+
+export { default as SearchBar } from "./components/controls/SearchBar.vue";
+export { default as SearchResults } from "./components/SearchResults.vue";
+export { default as MergedSearchResults } from "./components/MergedSearchResults.vue";
+export type { MergedSearchResultsProps } from "./components/MergedSearchResults.types";
+export { default as SourceSection } from "./components/SourceSection.vue";
+export { default as SortControl } from "./components/controls/SortControl.vue";
+export { default as PaginationControls } from "./components/controls/PaginationControls.vue";
+export { default as ScopeSelector } from "./components/controls/ScopeSelector.vue";
+export { default as ActiveFilters } from "./components/filters/ActiveFilters.vue";
+export { default as DefaultResultRow } from "./components/results/DefaultResultRow.vue";
+export { default as GlobalSearchBox } from "./components/GlobalSearchBox.vue";
+export type { GlobalSearchBoxProps } from "./components/GlobalSearchBox.types";
+export { default as CmsResultRow } from "./components/results/CmsResultRow.vue";
+export { resolveResultRenderer } from "./components/results/resolveResultRenderer";
+export type { ResultRenderer } from "./components/results/resolveResultRenderer";
+export { default as DefaultFilterPanel } from "./components/filters/DefaultFilterPanel.vue";
+export { default as FilterProvider } from "./components/filters/FilterProvider.vue";
+export { default as FilterResetButton } from "./components/filters/FilterResetButton.vue";
+export { useFilterField, useFilterPanel } from "./components/filters/FilterContext";
+
+export { default as TextFilter } from "./components/filters/inputs/TextFilter.vue";
+export { default as SelectFilter } from "./components/filters/inputs/SelectFilter.vue";
+export { default as MultiSelectFilter } from "./components/filters/inputs/MultiSelectFilter.vue";
+export { default as NumericRangeFilter } from "./components/filters/inputs/NumericRangeFilter.vue";
+export { default as BooleanFilter } from "./components/filters/inputs/BooleanFilter.vue";
+export { default as DateRangeFilter } from "./components/filters/inputs/DateRangeFilter.vue";
+export { default as FilterFieldWrapper } from "./components/filters/inputs/FilterFieldWrapper.vue";
+
+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 { MIN_QUERY_LENGTH } from "./constants";
+
+// CMS adapter surface — the registered adapter, its config type, and the
+// runtime content-type discovery composable. Apps adding a CMS source import
+// `CmsSourceConfig` for typing; advanced integrations can reuse the adapter
+// contracts and the discovery composable directly.
+export { cmsAdapter } from "./adapters/cms";
+export { useSearchableContentTypes } from "./adapters/cms/composables/useSearchableContentTypes";
+export type { UseSearchableContentTypesResult } from "./adapters/cms/composables/useSearchableContentTypes";
+export { formatContentTypeLabel, isValidCmsFqn } from "./adapters/cms/contentTypeUtils";
+export type {
+	SourceAdapter,
+	SourceRequest as AdapterSourceRequest,
+	QueryFragmentContribution,
+} from "./adapters/types";
+export type { CmsSourceConfig, CmsSearchItem, CmsSearchResponse } from "./adapters/cms/types";
+export { getAdapter } from "./adapters/registry";
+export type { RunSearchOutcome } from "./api/searchService";
+
+export { ALL_SCOPE, CMS_SCOPE_SEPARATOR, parseScope } from "./types";
+export type {
+	DisplayField,
+	SObjectSourceConfig,
+	SourceConfig,
+	SearchConfig,
+	SearchPaginationConfig,
+	SourceController,
+	SourceResult,
+	SourcePageInfo,
+	SearchHandle,
+	SearchScope,
+	ParsedScope,
+	RenderResultFn,
+	GlobalPagination,
+	MergedResultItem,
+} from "./types";

package/lib/templates/project/vueinternalapp/_p_/_m_/_w_/_a_/src/_f_/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/lib/templates/project/vueinternalapp/_p_/_m_/_w_/_a_/src/_f_/search/queryBuilder.ts

@@ -0,0 +1,100 @@
+/**
+ * Builds a single combined GraphQL document for search across every source.
+ *
+ * The builder is kind-agnostic: for each source request it asks the registered
+ * adapter (`getAdapter(kind).buildRequest`) for a `QueryFragmentContribution`
+ * and assembles them:
+ *   - `placement: "uiapi.query"` fragments (e.g. SObject sources) go inside the
+ *     shared `uiapi { query { … } }` block.
+ *   - `placement: "root"` fragments (e.g. the CMS `managed_content` block) go in
+ *     as siblings of `uiapi` at the document root.
+ *   - every contribution's `variableDeclarations` are concatenated into the
+ *     `query Search(...)` header and every contribution's `variables` merged
+ *     into one flat map.
+ *
+ * A contribution may declare zero extra variables (the CMS bootstrap call omits
+ * `$cmsContentTypeFQNs` entirely), so the merge tolerates declaration lists of
+ * differing lengths and never emits a declared-but-unused variable.
+ *
+ * When only SObject sources participate, the emitted document is identical to
+ * the pre-adapter builder — the `uiapi` block is unchanged and no root siblings
+ * are added.
+ */
+
+import { getAdapter } from "./adapters/registry";
+import type { SourceRequest } from "./adapters/types";
+
+// `SourceRequest` is now defined canonically in `adapters/types.ts`; re-export
+// it here for backward compatibility (the barrel and existing consumers import
+// `SourceRequest` from `./queryBuilder`).
+export type { SourceRequest } from "./adapters/types";
+
+export interface SearchQueryPayload {
+	document: string;
+	variables: Record<string, unknown>;
+}
+
+/**
+ * Builds the combined query document and a flat variables map by dispatching
+ * each source through its adapter and partitioning fragments by placement.
+ */
+export function buildSearchQuery(requests: SourceRequest[]): SearchQueryPayload {
+	if (requests.length === 0) {
+		throw new Error("buildSearchQuery requires at least one source request");
+	}
+
+	const variableDeclarations: string[] = [];
+	const uiapiFragments: string[] = [];
+	const rootFragments: string[] = [];
+	const variables: Record<string, unknown> = {};
+
+	for (const request of requests) {
+		const contribution = getAdapter(request.source.kind).buildRequest(request);
+
+		// Concatenate declarations (may be empty for a given source) and merge
+		// values — an omitted declaration means the variable is never declared,
+		// so it is likewise never supplied.
+		variableDeclarations.push(...contribution.variableDeclarations);
+		Object.assign(variables, contribution.variables);
+
+		if (contribution.placement === "root") {
+			rootFragments.push(contribution.fragment);
+		} else {
+			uiapiFragments.push(contribution.fragment);
+		}
+	}
+
+	const parts: string[] = [`query Search(${variableDeclarations.join(", ")}) {`];
+
+	// The `uiapi { query { … } }` block holds every `uiapi.query`-placed fragment.
+	// Emit it only when at least one such fragment exists — a CMS-only request
+	// (all SObject sources dropped) must not produce an empty, invalid selection
+	// set. When SObject sources are present its shape is identical to the
+	// pre-adapter builder.
+	if (uiapiFragments.length > 0) {
+		parts.push(`  uiapi {`);
+		parts.push(`    query {`);
+		parts.push(uiapiFragments.map((s) => indent(s, "      ")).join("\n"));
+		parts.push(`    }`);
+		parts.push(`  }`);
+	}
+
+	// Root-placement fragments (e.g. CMS `managed_content`) are siblings of uiapi.
+	for (const fragment of rootFragments) {
+		parts.push(indent(fragment, "  "));
+	}
+
+	parts.push(`}`);
+
+	// Trailing newline preserved from the original builder.
+	const document = parts.join("\n") + "\n";
+
+	return { document, variables };
+}
+
+function indent(s: string, prefix: string): string {
+	return s
+		.split("\n")
+		.map((line) => prefix + line)
+		.join("\n");
+}