feat(editor): Add new /templates/search endpoint

packages/editor-ui/src/Interface.ts

@@ -828,6 +828,24 @@ export interface ITemplatesWorkflowInfo {
 	};
 }
 
+export type TemplateCategoryFilter = {
+	name: string;
+	result_count: number;
+};
+
+export type TemplateSearchFacet = {
+	field_name: string;
+	sampled: boolean;
+	stats: {
+		total_values: number;
+	};
+	counts: Array<{
+		count: number;
+		highlighted: string;
+		value: string;
+	}>;
+};
+
 export interface ITemplatesWorkflowResponse extends ITemplatesWorkflow, IWorkflowTemplate {
 	description: string | null;
 	image: ITemplatesImage[];
@@ -1355,14 +1373,15 @@ export interface INodeTypesState {
 }
 
 export interface ITemplateState {
-	categories: { [id: string]: ITemplatesCategory };
+	categories: TemplateCategoryFilter[];
 	collections: { [id: string]: ITemplatesCollection };
 	workflows: { [id: string]: ITemplatesWorkflow | ITemplatesWorkflowFull };
 	workflowSearches: {
 		[search: string]: {
 			workflowIds: string[];
 			totalWorkflows: number;
 			loadingMore?: boolean;
+			categories?: TemplateCategoryFilter[];
 		};
 	};
 	collectionSearches: {
@@ -1372,6 +1391,7 @@ export interface ITemplateState {
 	};
 	currentSessionId: string;
 	previousSessionId: string;
+	totalTemplateCount: number;
 }
 
 export interface IVersionsState {

packages/editor-ui/src/api/templates.ts

@@ -6,6 +6,7 @@ import type {
 	ITemplatesCollectionResponse,
 	ITemplatesWorkflowResponse,
 	IWorkflowTemplate,
+	TemplateSearchFacet,
 } from '@/Interface';
 import type { IDataObject } from 'n8n-workflow';
 import { get } from '@/utils/apiUtils';
@@ -42,10 +43,15 @@ export async function getWorkflows(
 	apiEndpoint: string,
 	query: { skip: number; limit: number; categories: number[]; search: string },
 	headers?: IDataObject,
-): Promise<{ totalWorkflows: number; workflows: ITemplatesWorkflow[] }> {
+): Promise<{
+	totalWorkflows: number;
+	workflows: ITemplatesWorkflow[];
+	filters: TemplateSearchFacet[];
+	out_of: number;
+}> {
 	return get(
 		apiEndpoint,
-		'/templates/workflows',
+		'/templates/search',
 		{
 			skip: query.skip,
 			rows: query.limit,

packages/editor-ui/src/components/TemplateFilters.vue

@@ -7,21 +7,26 @@
 		<ul v-if="!loading" :class="$style.categories">
 			<li :class="$style.item">
 				<el-checkbox
-					:label="$locale.baseText('templates.allCategories')"
 					:model-value="allSelected"
 					@update:modelValue="(value) => resetCategories(value)"
-				/>
+				>
+					{{ $locale.baseText('templates.allCategories') }}
+					<n8n-tag :text="String(totalTemplateCount)" />
+				</el-checkbox>
 			</li>
 			<li
-				v-for="category in collapsed ? sortedCategories.slice(0, expandLimit) : sortedCategories"
-				:key="category.id"
+				v-for="(category, index) in collapsed
+					? sortedCategories.slice(0, expandLimit)
+					: sortedCategories"
+				:key="index"
 				:class="$style.item"
 			>
 				<el-checkbox
-					:label="category.name"
-					:model-value="isSelected(category.id)"
+					:model-value="isSelected(category.name)"
 					@update:modelValue="(value) => handleCheckboxChanged(value, category)"
-				/>
+				>
+					{{ category.name }} <n8n-tag :text="String(category.result_count)" />
+				</el-checkbox>
 			</li>
 		</ul>
 		<div
@@ -38,7 +43,10 @@
 
 <script lang="ts">
 import { defineComponent } from 'vue';
-import type { ITemplatesCategory } from '@/Interface';
+import type { TemplateCategoryFilter } from '@/Interface';
+import type { PropType } from 'vue';
+import { useTemplatesStore } from '@/stores/templates.store';
+import { mapStores } from 'pinia';
 
 export default defineComponent({
 	name: 'TemplateFilters',
@@ -48,7 +56,8 @@
 			default: false,
 		},
 		categories: {
-			type: Array,
+			type: Array as PropType<TemplateCategoryFilter[]>,
+			default: [],
 		},
 		expandLimit: {
 			type: Number,
@@ -59,28 +68,36 @@
 		},
 		selected: {
 			type: Array,
+			default: [],
 		},
 	},
 	data() {
 		return {
 			collapsed: true,
-			sortedCategories: [] as ITemplatesCategory[],
+			sortedCategories: [] as TemplateCategoryFilter[],
 		};
 	},
 	computed: {
+		...mapStores(useTemplatesStore),
 		allSelected(): boolean {
 			return this.selected.length === 0;
 		},
+		totalTemplateCount(): number {
+			return this.templatesStore.allCategories.reduce(
+				(acc, { result_count }) => acc + result_count,
+				0,
+			);
+		},
 	},
 	watch: {
 		categories: {
-			handler(categories: ITemplatesCategory[]) {
+			handler(categories: TemplateCategoryFilter[]) {
 				if (!this.sortOnPopulate) {
 					this.sortedCategories = categories;
 				} else {
 					const selected = this.selected || [];
-					const selectedCategories = categories.filter(({ id }) => selected.includes(id));
-					const notSelectedCategories = categories.filter(({ id }) => !selected.includes(id));
+					const selectedCategories = categories.filter(({ name }) => selected.includes(name));
+					const notSelectedCategories = categories.filter(({ name }) => !selected.includes(name));
 					this.sortedCategories = selectedCategories.concat(notSelectedCategories);
 				}
 			},
@@ -91,8 +108,8 @@
 		collapseAction() {
 			this.collapsed = false;
 		},
-		handleCheckboxChanged(value: boolean, selectedCategory: ITemplatesCategory) {
-			this.$emit(value ? 'select' : 'clear', selectedCategory.id);
+		handleCheckboxChanged(value: boolean, selectedCategory: TemplateCategoryFilter) {
+			this.$emit(value ? 'select' : 'clear', selectedCategory.name);
 		},
 		isSelected(categoryId: string) {
 			return this.selected.includes(categoryId);

packages/editor-ui/src/components/TemplateList.vue

@@ -2,7 +2,7 @@
 	<div v-if="loading || workflows.length" :class="$style.list">
 		<div v-if="!simpleView" :class="$style.header">
 			<n8n-heading :bold="true" size="medium" color="text-light">
-				{{ $locale.baseText('templates.workflows') }}
+				{{ $locale.baseText('templates.workflows') }} ({{ totalCount }})
 				<span v-if="!loading && totalWorkflows" v-text="`(${totalWorkflows})`" />
 			</n8n-heading>
 		</div>
@@ -63,6 +63,10 @@ export default defineComponent({
 			type: Boolean,
 			default: false,
 		},
+		totalCount: {
+			type: Number,
+			default: 0,
+		},
 	},
 	mounted() {
 		if (this.infiniteScrollEnabled) {

packages/editor-ui/src/stores/templates.store.ts

@@ -10,10 +10,11 @@
 	ITemplatesWorkflow,
 	ITemplatesWorkflowFull,
 	IWorkflowTemplate,
+	TemplateCategoryFilter,
+	TemplateSearchFacet,
 } from '@/Interface';
 import { useSettingsStore } from './settings.store';
 import {
-	getCategories,
 	getCollectionById,
 	getCollections,
 	getTemplateById,
@@ -32,19 +33,18 @@
 
 export const useTemplatesStore = defineStore(STORES.TEMPLATES, {
 	state: (): ITemplateState => ({
-		categories: {},
+		categories: [],
 		collections: {},
 		workflows: {},
 		collectionSearches: {},
 		workflowSearches: {},
 		currentSessionId: '',
 		previousSessionId: '',
+		totalTemplateCount: 0,
 	}),
 	getters: {
-		allCategories(): ITemplatesCategory[] {
-			return Object.values(this.categories).sort((a: ITemplatesCategory, b: ITemplatesCategory) =>
-				a.name > b.name ? 1 : -1,
-			);
+		allCategories(): TemplateCategoryFilter[] {
+			return this.categories;
 		},
 		getTemplateById() {
 			return (id: string): null | ITemplatesWorkflow => this.workflows[id];
@@ -111,14 +111,6 @@
 		},
 	},
 	actions: {
-		addCategories(categories: ITemplatesCategory[]): void {
-			categories.forEach((category: ITemplatesCategory) => {
-				this.categories = {
-					...this.categories,
-					[category.id]: category,
-				};
-			});
-		},
 		addCollections(collections: Array<ITemplatesCollection | ITemplatesCollectionFull>): void {
 			collections.forEach((collection) => {
 				const workflows = (collection.workflows || []).map((workflow) => ({ id: workflow.id }));
@@ -175,6 +167,7 @@
 					[searchKey]: {
 						workflowIds: workflowIds as unknown as string[],
 						totalWorkflows: data.totalWorkflows,
+						categories: this.categories,
 					},
 				};
 
@@ -186,6 +179,7 @@
 				[searchKey]: {
 					workflowIds: [...cachedResults.workflowIds, ...workflowIds] as string[],
 					totalWorkflows: data.totalWorkflows,
+					categories: this.categories,
 				},
 			};
 		},
@@ -254,20 +248,6 @@
 			this.addWorkflows(response.collection.workflows);
 			return this.getCollectionById(collectionId);
 		},
-		async getCategories(): Promise<ITemplatesCategory[]> {
-			const cachedCategories = this.allCategories;
-			if (cachedCategories.length) {
-				return cachedCategories;
-			}
-			const settingsStore = useSettingsStore();
-			const apiEndpoint: string = settingsStore.templatesHost;
-			const versionCli: string = settingsStore.versionCli;
-			const response = await getCategories(apiEndpoint, { 'n8n-version': versionCli });
-			const categories = response.categories;
-
-			this.addCategories(categories);
-			return categories;
-		},
 		async getCollections(query: ITemplatesQuery): Promise<ITemplatesCollection[]> {
 			const cachedResults = this.getSearchedCollections(query);
 			if (cachedResults) {
@@ -291,6 +271,7 @@
 		async getWorkflows(query: ITemplatesQuery): Promise<ITemplatesWorkflow[]> {
 			const cachedResults = this.getSearchedWorkflows(query);
 			if (cachedResults) {
+				this.categories = this.workflowSearches[getSearchKey(query)].categories ?? [];
 				return cachedResults;
 			}
 
@@ -300,14 +281,26 @@
 
 			const payload = await getWorkflows(
 				apiEndpoint,
-				{ ...query, skip: 0, limit: TEMPLATES_PAGE_SIZE },
+				{ ...query, skip: 1, limit: TEMPLATES_PAGE_SIZE },
 				{ 'n8n-version': versionCli },
 			);
 
 			this.addWorkflows(payload.workflows);
+			this.setCategories(payload.filters);
 			this.addWorkflowsSearch({ ...payload, query });
+			this.totalTemplateCount = payload.out_of
 			return this.getSearchedWorkflows(query) || [];
 		},
+		setCategories(facets: TemplateSearchFacet[]): void {
+			const categories = facets.find((facet) => facet.field_name === 'categories');
+			if (!categories) {
+				return;
+			}
+			this.categories = categories.counts.map((category) => ({
+				name: category.value,
+				result_count: category.count,
+			}));
+		},
 		async getMoreWorkflows(query: ITemplatesQuery): Promise<ITemplatesWorkflow[]> {
 			if (this.isSearchLoadingMore(query) && !this.isSearchFinished(query)) {
 				return [];
@@ -320,12 +313,13 @@
 			try {
 				const payload = await getWorkflows(apiEndpoint, {
 					...query,
-					skip: cachedResults.length,
+					skip: cachedResults.length / TEMPLATES_PAGE_SIZE + 1,
 					limit: TEMPLATES_PAGE_SIZE,
 				});
 
 				this.setWorkflowSearchLoaded(query);
 				this.addWorkflows(payload.workflows);
+				this.setCategories(payload.filters);
 				this.addWorkflowsSearch({ ...payload, query });
 
 				return this.getSearchedWorkflows(query) || [];