@searchcraft/javascript-sdk 0.14.0 → 0.15.0

package/dist/components/defineCustomElements.js

@@ -1,26 +1,27 @@
-import { defineCustomElement as define_searchcraft_ad } from './searchcraft-ad.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_button } from './searchcraft-button.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_error_message } from './searchcraft-error-message.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_facet_list } from './searchcraft-facet-list.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_filter_panel } from './searchcraft-filter-panel.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_input_form } from './searchcraft-input-form.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_input_label } from './searchcraft-input-label.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_loading } from './searchcraft-loading.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_pagination } from './searchcraft-pagination.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_popover_button } from './searchcraft-popover-button.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_popover_footer } from './searchcraft-popover-footer.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_popover_form } from './searchcraft-popover-form.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_popover_list_item } from './searchcraft-popover-list-item.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_popover_list_view } from './searchcraft-popover-list-view.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_results_info } from './searchcraft-results-info.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_search_result } from './searchcraft-search-result.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_search_results_per_page } from './searchcraft-search-results-per-page.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_search_results } from './searchcraft-search-results.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_select } from './searchcraft-select.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_slider } from './searchcraft-slider.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_summary_box } from './searchcraft-summary-box.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_theme } from './searchcraft-theme.js?scv=0.14.0';
-import { defineCustomElement as define_searchcraft_toggle_button } from './searchcraft-toggle-button.js?scv=0.14.0';
+import { defineCustomElement as define_searchcraft_ad } from './searchcraft-ad.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_button } from './searchcraft-button.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_error_message } from './searchcraft-error-message.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_facet_list } from './searchcraft-facet-list.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_filter_panel } from './searchcraft-filter-panel.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_input_form } from './searchcraft-input-form.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_input_label } from './searchcraft-input-label.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_loading } from './searchcraft-loading.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_pagination } from './searchcraft-pagination.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_popover_button } from './searchcraft-popover-button.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_popover_footer } from './searchcraft-popover-footer.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_popover_form } from './searchcraft-popover-form.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_popover_list_item } from './searchcraft-popover-list-item.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_popover_list_view } from './searchcraft-popover-list-view.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_results_info } from './searchcraft-results-info.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_results_summary } from './searchcraft-results-summary.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_search_result } from './searchcraft-search-result.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_search_results_per_page } from './searchcraft-search-results-per-page.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_search_results } from './searchcraft-search-results.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_select } from './searchcraft-select.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_slider } from './searchcraft-slider.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_summary_box } from './searchcraft-summary-box.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_theme } from './searchcraft-theme.js?scv=0.15.0';
+import { defineCustomElement as define_searchcraft_toggle_button } from './searchcraft-toggle-button.js?scv=0.15.0';
 
 export const defineCustomElements = () => {
   define_searchcraft_ad();
@@ -38,6 +39,7 @@ export const defineCustomElements = () => {
   define_searchcraft_popover_list_item();
   define_searchcraft_popover_list_view();
   define_searchcraft_results_info();
+  define_searchcraft_results_summary();
   define_searchcraft_search_result();
   define_searchcraft_search_results_per_page();
   define_searchcraft_search_results();

package/dist/components/html.js

@@ -1,4 +1,4 @@
-import { p as purify } from './purify.es.js?scv=0.14.0';
+import { p as purify } from './purify.es.js?scv=0.15.0';
 
 /**
  * This allows you to parse a template string with a function.

package/dist/components/index.d.ts

@@ -369,11 +369,11 @@ export interface SearchcraftConfig {
 	 */
 	searchResultsPerPage?: number;
 	/**
-	 * The URL pointing towards Searchcraft Cloud's semantic search and RAG summary processing layer. When using a `searchcraft-summary-box` component, this value must be specified.
+	 * @deprecated Summary requests now use `endpointURL` and `indexName`. This field is ignored by current SDK summary requests.
 	 */
 	cortexURL?: string;
 	/**
-	 * Instructions provided to the LLM when creating search result summaries.
+	 * @deprecated Summary prompt instructions are configured server-side on the index. This field is ignored by the engine summary endpoint.
 	 */
 	summaryInstructionsPrompt?: string;
 	/**
@@ -653,8 +653,16 @@ declare class SummaryClient {
 	private get;
 	private abortController;
 	private timeout;
+	private hasWarnedAboutDeprecatedCortexURL;
 	constructor(get: SearchcraftStore["getState"], set: SearchcraftStore["setState"]);
-	streamSummaryData(): void;
+	streamSummaryData(requestProperties: SearchClientRequestProperties | string): void;
+	private setSummaryUnavailable;
+	private warnIfUsingDeprecatedCortexURL;
+	private buildSearchClientRequest;
+	private formatParamsForRequest;
+	private processSseBuffer;
+	private handleSseFrame;
+	private parseSseFrame;
 }
 /**
  * Callable functions made available by the SearchcraftStore.
@@ -715,6 +723,7 @@ export interface SearchcraftStateValues {
 	orderByField: string | undefined | null;
 	sortType: "asc" | "desc" | undefined | null;
 	summary: string;
+	summaryErrorMessage: string;
 	hasSummaryBox: boolean;
 	isSummaryLoading: boolean;
 	summaryClient?: SummaryClient;
@@ -1126,7 +1135,7 @@ export namespace Components {
 		/**
 		  * The type of popover button to render.
 		 */
-		"type"?: "skeuomorphic";
+		"type"?: "skeuomorphic" | "magnifying-glass";
 	}
 	/**
 	 * Renders the footer for the searchcraft-popover-form.
@@ -1310,6 +1319,33 @@ export namespace Components {
 		 */
 		"template"?: ResultsInfoTemplate;
 	}
+	/**
+	 * This component renders a results summary for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```ts
+	 * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-results-summary />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 */
+	interface SearchcraftResultsSummary {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
+	}
 	/**
 	 * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
 	 */
@@ -1491,6 +1527,9 @@ export namespace Components {
 		"step": number;
 	}
 	/**
+	 * @deprecated Use `searchcraft-results-summary` instead.
+	 * This component is deprecated and will be removed in a future version.
+	 * Please update to use `searchcraft-results-summary` which has the same functionality.
 	 * This component renders a summary box for RAG search result summaries.
 	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
 	 * rendered in this box.
@@ -1935,6 +1974,33 @@ declare global {
 		prototype: HTMLSearchcraftResultsInfoElement;
 		new (): HTMLSearchcraftResultsInfoElement;
 	};
+	/**
+	 * This component renders a results summary for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```ts
+	 * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-results-summary />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 */
+	interface HTMLSearchcraftResultsSummaryElement extends Components.SearchcraftResultsSummary, HTMLStencilElement {
+	}
+	var HTMLSearchcraftResultsSummaryElement: {
+		prototype: HTMLSearchcraftResultsSummaryElement;
+		new (): HTMLSearchcraftResultsSummaryElement;
+	};
 	/**
 	 * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
 	 */
@@ -2065,6 +2131,9 @@ declare global {
 		new (): HTMLSearchcraftSliderElement;
 	};
 	/**
+	 * @deprecated Use `searchcraft-results-summary` instead.
+	 * This component is deprecated and will be removed in a future version.
+	 * Please update to use `searchcraft-results-summary` which has the same functionality.
 	 * This component renders a summary box for RAG search result summaries.
 	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
 	 * rendered in this box.
@@ -2151,6 +2220,7 @@ declare global {
 		"searchcraft-popover-list-item": HTMLSearchcraftPopoverListItemElement;
 		"searchcraft-popover-list-view": HTMLSearchcraftPopoverListViewElement;
 		"searchcraft-results-info": HTMLSearchcraftResultsInfoElement;
+		"searchcraft-results-summary": HTMLSearchcraftResultsSummaryElement;
 		"searchcraft-search-result": HTMLSearchcraftSearchResultElement;
 		"searchcraft-search-results": HTMLSearchcraftSearchResultsElement;
 		"searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
@@ -2524,7 +2594,7 @@ declare namespace LocalJSX {
 		/**
 		  * The type of popover button to render.
 		 */
-		"type"?: "skeuomorphic";
+		"type"?: "skeuomorphic" | "magnifying-glass";
 	}
 	/**
 	 * Renders the footer for the searchcraft-popover-form.
@@ -2708,6 +2778,33 @@ declare namespace LocalJSX {
 		 */
 		"template"?: ResultsInfoTemplate;
 	}
+	/**
+	 * This component renders a results summary for RAG search result summaries.
+	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+	 * rendered in this box.
+	 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+	 * @react-import ```jsx
+	 * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+	 * ```
+	 * @vue-import ```ts
+	 * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+	 * ```
+	 * @js-example ```html
+	 * <searchcraft-results-summary />
+	 * ```
+	 * @react-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 * @vue-example ```jsx
+	 * <SearchcraftResultsSummary />
+	 * ```
+	 */
+	interface SearchcraftResultsSummary {
+		/**
+		  * The id of the Searchcraft instance that this component should use.
+		 */
+		"searchcraftId"?: string;
+	}
 	/**
 	 * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
 	 */
@@ -2897,6 +2994,9 @@ declare namespace LocalJSX {
 		"step"?: number;
 	}
 	/**
+	 * @deprecated Use `searchcraft-results-summary` instead.
+	 * This component is deprecated and will be removed in a future version.
+	 * Please update to use `searchcraft-results-summary` which has the same functionality.
 	 * This component renders a summary box for RAG search result summaries.
 	 * When the user makes a search, a network call is made to retrieve the summary content, which is then
 	 * rendered in this box.
@@ -2981,6 +3081,7 @@ declare namespace LocalJSX {
 		"searchcraft-popover-list-item": SearchcraftPopoverListItem;
 		"searchcraft-popover-list-view": SearchcraftPopoverListView;
 		"searchcraft-results-info": SearchcraftResultsInfo;
+		"searchcraft-results-summary": SearchcraftResultsSummary;
 		"searchcraft-search-result": SearchcraftSearchResult;
 		"searchcraft-search-results": SearchcraftSearchResults;
 		"searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
@@ -3236,6 +3337,28 @@ declare module "@stencil/core" {
 			 * ```
 			 */
 			"searchcraft-results-info": LocalJSX.SearchcraftResultsInfo & JSXBase.HTMLAttributes<HTMLSearchcraftResultsInfoElement>;
+			/**
+			 * This component renders a results summary for RAG search result summaries.
+			 * When the user makes a search, a network call is made to retrieve the summary content, which is then
+			 * rendered in this box.
+			 * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+			 * @react-import ```jsx
+			 * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+			 * ```
+			 * @vue-import ```ts
+			 * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+			 * ```
+			 * @js-example ```html
+			 * <searchcraft-results-summary />
+			 * ```
+			 * @react-example ```jsx
+			 * <SearchcraftResultsSummary />
+			 * ```
+			 * @vue-example ```jsx
+			 * <SearchcraftResultsSummary />
+			 * ```
+			 */
+			"searchcraft-results-summary": LocalJSX.SearchcraftResultsSummary & JSXBase.HTMLAttributes<HTMLSearchcraftResultsSummaryElement>;
 			/**
 			 * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
 			 */
@@ -3319,6 +3442,9 @@ declare module "@stencil/core" {
 			 */
 			"searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
 			/**
+			 * @deprecated Use `searchcraft-results-summary` instead.
+			 * This component is deprecated and will be removed in a future version.
+			 * Please update to use `searchcraft-results-summary` which has the same functionality.
 			 * This component renders a summary box for RAG search result summaries.
 			 * When the user makes a search, a network call is made to retrieve the summary content, which is then
 			 * rendered in this box.