@searchcraft/javascript-sdk 0.11.1 → 0.12.1

package/README.md

@@ -49,8 +49,17 @@ As early as possible in your app's lifecycle, initialize searchcraft, passing in
 ```js
 import { Searchcraft } from '@searchcraft/javascript-sdk';
 
+// Index Search Configuration
 const searchcraft = new Searchcraft({
-  index: ['your_index_from_vektron'],
+  indexName: 'your_index_from_vektron',
+  readKey: 'your_read_key_from_vektron',
+  endpointURL: 'your_searchcraft_endpoint_url',
+  searchDebounceDelay: 50, // The amount of debounce, in millis, to add to search requests (optional)
+})
+
+// Federation Search Configuration (searches across multiple indices)
+const federationSearchcraft = new Searchcraft({
+  federationName: 'your_federation_name',
   readKey: 'your_read_key_from_vektron',
   endpointURL: 'your_searchcraft_endpoint_url',
   searchDebounceDelay: 50, // The amount of debounce, in millis, to add to search requests (optional)
@@ -170,7 +179,7 @@ You can subscribe to various events within Searchcraft:
 ```jsx
 
   const searchcraft = new Searchcraft({
-    index: ['your_index_from_vektron'],
+    indexName: 'your_index_from_vektron',
     readKey: 'your_read_key_from_vektron',
     endpointURL: 'your_searchcraft_endpoint_url',
   });

package/dist/components/index.d.ts

@@ -90,6 +90,7 @@ export interface MeasureRequestProperties {
 	searchcraft_organization_id?: string;
 	searchcraft_application_id?: string;
 	searchcraft_index_names: string[];
+	searchcraft_federation_name?: string;
 	search_term?: string;
 	number_of_documents?: number;
 	external_document_id?: string;
@@ -333,8 +334,16 @@ export interface SearchcraftConfig {
 	endpointURL: string;
 	/**
 	 * Name of the Searchcraft search index to search for results within. If you are using Searchcraft Cloud, this value can be found within the Vektron dashboard in the Code Snippets section when configuring a search index.
+	 *
+	 * Note: Either `indexName` or `federationName` must be provided, but not both.
+	 */
+	indexName?: string;
+	/**
+	 * Name of the Searchcraft federation to search across multiple indices. Federation search allows you to search across all indices defined in a federation with a single query.
+	 *
+	 * Note: Either `indexName` or `federationName` must be provided, but not both.
 	 */
-	indexName: string;
+	federationName?: string;
 	/**
 	 * The initial search query to call when Searchcraft is first initialized in your front-end application. This parameter can be used when you want to populate a page with an initial set of search results based on a query.
 	 *
@@ -601,6 +610,7 @@ declare class SearchClient {
 	constructor(parent: SearchcraftCore, config: SearchcraftConfig, userId: string);
 	/**
 	 * Getter for the base url used by the /search endpoint.
+	 * Supports both index and federation search endpoints.
 	 */
 	private get baseSearchUrl();
 	/**
@@ -640,7 +650,9 @@ export interface SearchcraftStateFunctions {
 	removeFacetPathsForIndexField: (fieldName: string) => void;
 	removeRangeValueForIndexField: (fieldName: string) => void;
 	resetSearchValues: () => void;
-	search: () => Promise<void>;
+	search: (options?: {
+		skipSummary?: boolean;
+	}) => Promise<void>;
 	setPopoverVisibility: (isVisible: boolean) => void;
 	setSearchResultsCount: (count: number) => void;
 	setSearchResultsPage: (page: number) => void;
@@ -671,6 +683,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;
@@ -684,6 +701,7 @@ export interface SearchcraftStateValues {
 	hasSummaryBox: boolean;
 	isSummaryLoading: boolean;
 	summaryClient?: SummaryClient;
+	isSummaryNotEnabled: boolean;
 }
 export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {
 }
@@ -908,6 +926,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.
@@ -1048,6 +1070,14 @@ export namespace Components {
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
+		/**
+		  * The input element's placeholder value.
+		 */
+		"placeholderValue"?: string;
 		/**
 		  * Formats the content rendered for each result.
 		 */
@@ -2163,6 +2193,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.
@@ -2303,6 +2337,14 @@ declare namespace LocalJSX {
 		  * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
 		 */
 		"hotkeyModifier"?: "ctrl" | "meta" | "alt" | "option";
+		/**
+		  * The placeholder's render behavior. 'hide-on-focus' - Hide the placeholder text immediately when the input form gains focus. 'hide-on-text-entered' - Only hide the placeholder when the input form has text entered into it.
+		 */
+		"placeholderBehavior"?: "hide-on-focus" | "hide-on-text-entered";
+		/**
+		  * The input element's placeholder value.
+		 */
+		"placeholderValue"?: string;
 		/**
 		  * Formats the content rendered for each result.
 		 */

package/dist/components/index.js

@@ -264,7 +264,8 @@ class MeasureClient {
         const request = {
             event_name: eventName,
             properties: {
-                searchcraft_index_names: [this.config.indexName],
+                searchcraft_index_names: this.config.indexName ? [this.config.indexName] : [],
+                searchcraft_federation_name: this.config.federationName,
                 session_id: this.sessionId,
                 ...properties,
             },
@@ -372,9 +373,12 @@ class SearchClient {
     }
     /**
      * Getter for the base url used by the /search endpoint.
+     * Supports both index and federation search endpoints.
      */
     get baseSearchUrl() {
-        return `${this.config.endpointURL}/index/${this.config.indexName}/search`;
+        return this.config.federationName
+            ? `${this.config.endpointURL}/federation/${this.config.federationName}/search`
+            : `${this.config.endpointURL}/index/${this.config.indexName}/search`;
     }
     /**
      * Immediately cancels all pending search requests.
@@ -1245,6 +1249,14 @@ class SummaryClient {
                     throw new Error('Invalid fetch response');
                 }
                 if (!fetchResponse.ok) {
+                    if (fetchResponse.status === 403) {
+                        console.warn('Please contact Searchcraft to enable AI summaries with your account');
+                        this.set({
+                            isSummaryLoading: false,
+                            isSummaryNotEnabled: true,
+                        });
+                        return;
+                    }
                     throw new Error(`HTTP ${fetchResponse.status}`);
                 }
                 const reader = fetchResponse.body.getReader();
@@ -1291,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,
@@ -1303,6 +1320,7 @@ const initialSearchcraftStateValues = {
     hasSummaryBox: false,
     summaryClient: undefined,
     isSummaryLoading: false,
+    isSummaryNotEnabled: false,
 };
 // const logger = new Logger({ logLevel: LogLevel.NONE });
 const existingStores = {};
@@ -1322,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];
@@ -1362,22 +1391,91 @@ const createSearchcraftStore = (searchcraftId, initialState = {}) => {
                     adClientResponseItems: [...state.cachedAdClientResponseItems],
                 });
             },
-            search: async () => {
+            search: async (options) => {
                 const state = get();
                 if (!state.core) {
                     throw new Error('Searchcraft instance is not initialized.');
                 }
-                if (state.core.config.cortexURL) {
+                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: '',
                     });
@@ -1425,17 +1523,22 @@ 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,
                     }),
                 });
             },
             setSearchResultsCount: (count) => set({ searchResultsCount: count }),
             setSearchResultsPage: async (page) => {
                 set({ searchResultsPage: page });
-                await functions.search();
+                await functions.search({ skipSummary: true });
             },
             setSearchResultsPerPage: async (perPage) => {
                 set({ searchResultsPerPage: perPage });
-                await functions.search();
+                await functions.search({ skipSummary: true });
             },
             setHotKeyAndHotKeyModifier: (hotkey, hotkeyModifier) => {
                 const { hotkey: initialHotkey, hotkeyModifier: initialHotkeyModifier } = initialSearchcraftStateValues;
@@ -1483,8 +1586,11 @@ class SearchcraftCore {
         if (!config.readKey) {
             throw new Error('SDK Configuration Error: readKey not specified.');
         }
-        if (!config.indexName) {
-            throw new Error('SDK Configuration Error: indexName not specified.');
+        if (!config.indexName && !config.federationName) {
+            throw new Error('SDK Configuration Error: Either indexName or federationName must be specified.');
+        }
+        if (config.indexName && config.federationName) {
+            throw new Error('SDK Configuration Error: Cannot specify both indexName and federationName. Please specify only one.');
         }
         this.config = {
             ...config,
@@ -1636,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,
@@ -1646,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,
                     }),
                 });
             })();
@@ -1675,75 +1810,7 @@ class SearchcraftCore {
 }
 
 const name = "@searchcraft/javascript-sdk";
-const version = "0.11.1";
-const description = "Searchcraft Javascript SDK";
-const author = "Searchcraft Inc.";
-const license = "Apache-2.0";
-const module = "dist/components/index.js";
-const types = "dist/components/index.d.ts";
-const exports = {
-	".": {
-		"import": "./dist/components/index.js",
-		types: "./dist/components/index.d.ts"
-	},
-	"./dist/components/*": {
-		"import": "./dist/components/*",
-		types: "./dist/components/*"
-	},
-	"./hydrate": {
-		require: "./dist/hydrate/index.js",
-		"import": "./dist/hydrate/index.mjs",
-		types: "./dist/hydrate/index.d.ts"
-	},
-	"./themes/*.css": "./dist/themes/*.css"
-};
-const repository = {
-	type: "git",
-	url: "https://bitbucket.org/madebychalk/searchcraft-javascript-sdks/"
-};
-const files = [
-	"dist/"
-];
-const scripts = {
-	build: "stencil build",
-	docs: "typedoc --options typedoc.json",
-	dev: "stencil build --dev --watch",
-	test: "stencil test --spec --e2e",
-	"test.watch": "stencil test --spec --e2e --watchAll",
-	generate: "stencil generate"
-};
-const dependencies = {
-	classnames: "^2.3.2",
-	dompurify: "^3.2.4",
-	marked: "^15.0.12",
-	nanoid: "^5.0.9"
-};
-const devDependencies = {
-	"@stencil/core": "^4.7.0",
-	"@stencil/react-output-target": "^0.8.2",
-	"@stencil/sass": "^3.0.12",
-	"@stencil/vue-output-target": "^0.9.2",
-	"@thumbmarkjs/thumbmarkjs": "^0.16.1",
-	"@types/node": "^16.18.11",
-	nanoid: "^5.0.9",
-	zustand: "^5.0.1"
-};
-const packageJson = {
-	name: name,
-	"private": false,
-	version: version,
-	description: description,
-	author: author,
-	license: license,
-	module: module,
-	types: types,
-	exports: exports,
-	repository: repository,
-	files: files,
-	scripts: scripts,
-	dependencies: dependencies,
-	devDependencies: devDependencies
-};
+const version = "0.12.1";
 
 /**
  * @fileoverview entry point for your component library
@@ -1760,8 +1827,8 @@ const packageJson = {
 class Searchcraft extends SearchcraftCore {
     constructor(config, searchcraftId = undefined) {
         super(config, {
-            sdkName: packageJson.name,
-            sdkVersion: packageJson.version,
+            sdkName: name,
+            sdkVersion: version,
         }, searchcraftId);
     }
 }