@searchcraft/javascript-sdk 0.12.0 → 0.12.2

package/README.md

@@ -27,7 +27,7 @@ Add the web components to your html. They should be placed with the rest of your
   ...
   <searchcraft-filter-panel></searchcraft-filter-panel>
   ...
-  <searchcraft-results-info /></searchcraft-results-info>
+  <searchcraft-results-info></searchcraft-results-info>
   ...
   <searchcraft-search-results></searchcraft-search-results>
   ...

package/dist/components/index.d.ts

@@ -183,6 +183,7 @@ export interface FacetsFilterItem extends FilterItem {
 	type: "facets";
 	options: {
 		showSublevel: boolean;
+		exclude?: string[];
 	};
 }
 export interface NumericFilterItem extends FilterItem {
@@ -683,6 +684,11 @@ export interface SearchcraftStateValues {
 	searchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
 	searchClientResponseItems: SearchClientResponseItem[];
 	cachedSearchClientResponseItems: SearchClientResponseItem[];
+	cachedSearchResponseFacetPrime: FacetPrime | undefined | null;
+	cachedSupplementalFacetPrime: FacetPrime | undefined | null;
+	cachedSearchResponseTimeTaken: number | undefined;
+	cachedSearchResultsCount: number | undefined;
+	cachedSearchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
 	searchResponseTimeTaken: number | undefined;
 	searchResponseFacetPrime: FacetPrime | undefined | null;
 	supplementalFacetPrime: FacetPrime | undefined | null;
@@ -828,6 +834,10 @@ export namespace Components {
 	 * ```
 	 */
 	interface SearchcraftFacetList {
+		/**
+		  * Array of facet values to exclude from rendering.
+		 */
+		"exclude"?: string[];
 		/**
 		  * The name of the field where facets are applied.
 		 */
@@ -921,6 +931,10 @@ export namespace Components {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * The value to display in the input field.
+		 */
+		"value"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.
@@ -2073,6 +2087,10 @@ declare namespace LocalJSX {
 	 * ```
 	 */
 	interface SearchcraftFacetList {
+		/**
+		  * Array of facet values to exclude from rendering.
+		 */
+		"exclude"?: string[];
 		/**
 		  * The name of the field where facets are applied.
 		 */
@@ -2184,6 +2202,10 @@ declare namespace LocalJSX {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * The value to display in the input field.
+		 */
+		"value"?: string;
 	}
 	/**
 	 * This web component serves as the input label for the searchcraft-input-form component.

package/dist/components/index.js

@@ -1303,6 +1303,11 @@ const initialSearchcraftStateValues = {
     searchClientRequestProperties: undefined,
     searchClientResponseItems: [],
     cachedSearchClientResponseItems: [],
+    cachedSearchResponseFacetPrime: undefined,
+    cachedSupplementalFacetPrime: undefined,
+    cachedSearchResponseTimeTaken: undefined,
+    cachedSearchResultsCount: undefined,
+    cachedSearchClientRequestProperties: undefined,
     searchResponseTimeTaken: undefined,
     searchResponseFacetPrime: undefined,
     supplementalFacetPrime: undefined,
@@ -1335,27 +1340,38 @@ const createSearchcraftStore = (searchcraftId, initialState = {}) => {
     }
     const newStore = zustand.createStore((set, get) => {
         const functions = {
-            addFacetPathsForIndexField: (facetPaths) => set((state) => ({
-                facetPathsForIndexFields: {
-                    ...state.facetPathsForIndexFields,
-                    [facetPaths.fieldName]: facetPaths,
-                },
-            })),
+            addFacetPathsForIndexField: (facetPaths) => {
+                set((state) => ({
+                    facetPathsForIndexFields: {
+                        ...state.facetPathsForIndexFields,
+                        [facetPaths.fieldName]: facetPaths,
+                    },
+                    searchResultsPage: 1, // Reset to page 1 when filters change
+                }));
+            },
             addRangeValueForIndexField: (rangeValue) => set((state) => ({
                 rangeValueForIndexFields: {
                     ...state.rangeValueForIndexFields,
                     [rangeValue.fieldName]: rangeValue,
                 },
             })),
-            removeFacetPathsForIndexField: (fieldName) => set((state) => {
-                const currentPaths = state.facetPathsForIndexFields;
-                delete currentPaths[fieldName];
-                return {
-                    facetPathsForIndexFields: {
-                        ...currentPaths,
-                    },
-                };
-            }),
+            removeFacetPathsForIndexField: (fieldName) => {
+                console.log('[FACET] removeFacetPathsForIndexField', {
+                    fieldName,
+                    currentPage: get().searchResultsPage,
+                    stackTrace: new Error().stack,
+                });
+                set((state) => {
+                    const currentPaths = state.facetPathsForIndexFields;
+                    delete currentPaths[fieldName];
+                    return {
+                        facetPathsForIndexFields: {
+                            ...currentPaths,
+                        },
+                        searchResultsPage: 1, // Reset to page 1 when filters change
+                    };
+                });
+            },
             removeRangeValueForIndexField: (fieldName) => set((state) => {
                 const currentValues = state.rangeValueForIndexFields;
                 delete currentValues[fieldName];
@@ -1383,14 +1399,83 @@ const createSearchcraftStore = (searchcraftId, initialState = {}) => {
                 if (state.core.config.cortexURL && !options?.skipSummary) {
                     state.summaryClient?.streamSummaryData();
                 }
+                // Check if this is an initialQuery case (string requestProperties with empty searchTerm)
+                const isInitialQuery = typeof state.cachedSearchClientRequestProperties === 'string' &&
+                    state.searchTerm.trim() === '';
+                // Check if there are any active filters or pagination changes
+                const hasActiveFilters = Object.keys(state.facetPathsForIndexFields).length > 0 ||
+                    Object.keys(state.rangeValueForIndexFields).length > 0;
+                const hasNonDefaultPagination = state.searchResultsPage !== 1;
+                const hasNonDefaultSearchMode = state.searchMode !== 'fuzzy';
                 if (!state.searchTerm.trim()) {
+                    // If it's initialQuery and there are filters, pagination, or mode changes, perform a search
+                    if (isInitialQuery &&
+                        (hasActiveFilters ||
+                            hasNonDefaultPagination ||
+                            hasNonDefaultSearchMode)) {
+                        // Parse the initialQuery
+                        const initialQueryObj = JSON.parse(state.cachedSearchClientRequestProperties);
+                        set({ isSearchInProgress: true });
+                        // Build the modified query array starting with the base query
+                        const baseQuery = Array.isArray(initialQueryObj.query)
+                            ? initialQueryObj.query.filter((q) => !q.occur)
+                            : [initialQueryObj.query];
+                        const queries = [...baseQuery];
+                        // Add facet filters
+                        if (state.facetPathsForIndexFields) {
+                            Object.keys(state.facetPathsForIndexFields).forEach((fieldName) => {
+                                const item = state.facetPathsForIndexFields?.[fieldName];
+                                if (item) {
+                                    queries.push({
+                                        occur: 'must',
+                                        exact: {
+                                            ctx: item.value,
+                                        },
+                                    });
+                                }
+                            });
+                        }
+                        // Add range filters
+                        if (state.rangeValueForIndexFields) {
+                            Object.keys(state.rangeValueForIndexFields).forEach((fieldName) => {
+                                const item = state.rangeValueForIndexFields?.[fieldName];
+                                if (item) {
+                                    queries.push({
+                                        occur: 'must',
+                                        exact: {
+                                            ctx: item.value,
+                                        },
+                                    });
+                                }
+                            });
+                        }
+                        // Build the modified request with filters and pagination
+                        const modifiedRequest = {
+                            ...initialQueryObj,
+                            query: queries,
+                            offset: state.searchResultsPerPage
+                                ? state.searchResultsPerPage * (state.searchResultsPage - 1)
+                                : 0,
+                            limit: state.searchResultsPerPage,
+                        };
+                        state.core.getResponseItems({
+                            requestProperties: JSON.stringify(modifiedRequest),
+                            shouldCacheResultsForEmptyState: false,
+                        });
+                        return;
+                    }
+                    // Otherwise, restore cached results
                     state.core?.searchClient?.abortRequests();
                     set({
                         searchClientResponseItems: [
                             ...state.cachedSearchClientResponseItems,
                         ],
                         adClientResponseItems: [...state.cachedAdClientResponseItems],
-                        searchResultsCount: 0,
+                        searchResponseFacetPrime: state.cachedSearchResponseFacetPrime,
+                        supplementalFacetPrime: state.cachedSupplementalFacetPrime,
+                        searchResponseTimeTaken: state.cachedSearchResponseTimeTaken,
+                        searchResultsCount: state.cachedSearchResultsCount || 0,
+                        searchClientRequestProperties: state.cachedSearchClientRequestProperties,
                         searchResultsPage: 1,
                         searchTerm: '',
                     });
@@ -1438,6 +1523,11 @@ const createSearchcraftStore = (searchcraftId, initialState = {}) => {
                             ...state.cachedSearchClientResponseItems,
                         ],
                         adClientResponseItems: [...state.cachedAdClientResponseItems],
+                        searchResponseFacetPrime: state.cachedSearchResponseFacetPrime,
+                        supplementalFacetPrime: state.cachedSupplementalFacetPrime,
+                        searchResponseTimeTaken: state.cachedSearchResponseTimeTaken,
+                        searchResultsCount: state.cachedSearchResultsCount || 0,
+                        searchClientRequestProperties: state.cachedSearchClientRequestProperties,
                     }),
                 });
             },
@@ -1652,6 +1742,30 @@ class SearchcraftCore {
                         }
                     }
                 }
+                else if (typeof props.requestProperties === 'string') {
+                    // Handle supplemental search for initialQuery with filters
+                    const requestObj = JSON.parse(props.requestProperties);
+                    // Check if there are any filter queries (queries beyond the base query)
+                    const queryArray = Array.isArray(requestObj.query)
+                        ? requestObj.query
+                        : [requestObj.query];
+                    if (queryArray.length > 1) {
+                        // Remove filter queries to get base query for supplemental search
+                        const baseQuery = queryArray.filter((q) => q.occur !== 'must');
+                        const supplementalRequest = {
+                            ...requestObj,
+                            query: baseQuery.length > 0 ? baseQuery : queryArray.slice(0, 1),
+                        };
+                        try {
+                            supplementalResponse =
+                                await this?.searchClient?.getSearchResponseItems(JSON.stringify(supplementalRequest), true);
+                        }
+                        catch (error) {
+                            Logger.info(`Search request error: ${error}`);
+                            return;
+                        }
+                    }
+                }
                 this.store.setState({
                     isSearchInProgress: false,
                     searchClientResponseItems: items,
@@ -1662,6 +1776,11 @@ class SearchcraftCore {
                     searchClientRequestProperties: props.requestProperties,
                     ...(props.shouldCacheResultsForEmptyState && {
                         cachedSearchClientResponseItems: items,
+                        cachedSearchResponseFacetPrime: response.data.facets,
+                        cachedSupplementalFacetPrime: supplementalResponse?.data.facets,
+                        cachedSearchResponseTimeTaken: response.data.time_taken,
+                        cachedSearchResultsCount: response.data.count,
+                        cachedSearchClientRequestProperties: props.requestProperties,
                     }),
                 });
             })();
@@ -1691,7 +1810,7 @@ class SearchcraftCore {
 }
 
 const name = "@searchcraft/javascript-sdk";
-const version = "0.12.0";
+const version = "0.12.2";
 
 /**
  * @fileoverview entry point for your component library