@searchcraft/javascript-sdk 0.13.3 → 0.14.0

package/dist/components/defineCustomElements.js

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

package/dist/components/html.js

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

package/dist/components/index.d.ts

@@ -1054,6 +1054,11 @@ export namespace Components {
 	 * ```
 	 */
 	interface SearchcraftPagination {
+		/**
+		  * The URL query string parameter name used to track the current page. When a user navigates to a URL that contains this parameter, the pagination component will automatically navigate to that page.
+		  * @default "p"
+		 */
+		"pageQueryParam": string;
 		/**
 		  * Whether to scroll to the top of the search results when pagination buttons are clicked.
 		  * @default true
@@ -1063,6 +1068,11 @@ export namespace Components {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Whether to use a query string parameter to track and restore the current page. Set to `false` to disable query string synchronisation entirely.
+		  * @default true
+		 */
+		"usePageQueryParam": boolean;
 	}
 	/**
 	 * Renders a button which, when clicked, turns on popover visibility.
@@ -1122,10 +1132,23 @@ export namespace Components {
 	 * Renders the footer for the searchcraft-popover-form.
 	 */
 	interface SearchcraftPopoverFooter {
+		/**
+		  * The SDK variant used to render this component. Used for UTM attribution. This isn't exposed for developer consumption, it's set automatically.
+		  * @default 'js'
+		 */
+		"sdkVariant"?: "js" | "react" | "vue";
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Optional href for the "View all" button.
+		 */
+		"viewAllResultsHref"?: string;
+		/**
+		  * Optional label for the "View all" button.
+		 */
+		"viewAllResultsLabel"?: string;
 	}
 	/**
 	 * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.
@@ -1175,15 +1198,33 @@ export namespace Components {
 		  * Formats the content rendered for each result.
 		 */
 		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * The SDK variant used to render this component. Used for UTM attribution on the footer link.
+		  * @default 'js'
+		 */
+		"sdkVariant"?: "js" | "react" | "vue";
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Whether to display the AI generative summary box before the search results. NOTE: This requires the usage of a read key that has "SUMMARY" permissions and either a subscription to Searchcraft Cloud with AI features enabled or a self-hosted model connected.
+		  * @default false
+		 */
+		"showSummaryBox"?: boolean;
 		/**
 		  * The type of popover form to render. - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content. - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component. - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.
 		  * @default 'inline'
 		 */
 		"type"?: "inline" | "fullscreen" | "modal";
+		/**
+		  * Base URL for the "View all" footer link. The current search term will be appended (URL encoded).  For example, in a CMS-backed site you might set this to `/?s=` so the final URL becomes `/?s=<search-term>`.
+		 */
+		"viewAllResultsBaseUrl"?: string;
+		/**
+		  * Optional label for the "View All" footer button. Defaults to "View All".
+		 */
+		"viewAllResultsLabel"?: string;
 	}
 	/**
 	 * A single list item rendered in a searchcraft-popover-list-view.
@@ -2411,6 +2452,11 @@ declare namespace LocalJSX {
 	 * ```
 	 */
 	interface SearchcraftPagination {
+		/**
+		  * The URL query string parameter name used to track the current page. When a user navigates to a URL that contains this parameter, the pagination component will automatically navigate to that page.
+		  * @default "p"
+		 */
+		"pageQueryParam"?: string;
 		/**
 		  * Whether to scroll to the top of the search results when pagination buttons are clicked.
 		  * @default true
@@ -2420,6 +2466,11 @@ declare namespace LocalJSX {
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Whether to use a query string parameter to track and restore the current page. Set to `false` to disable query string synchronisation entirely.
+		  * @default true
+		 */
+		"usePageQueryParam"?: boolean;
 	}
 	/**
 	 * Renders a button which, when clicked, turns on popover visibility.
@@ -2479,10 +2530,23 @@ declare namespace LocalJSX {
 	 * Renders the footer for the searchcraft-popover-form.
 	 */
 	interface SearchcraftPopoverFooter {
+		/**
+		  * The SDK variant used to render this component. Used for UTM attribution. This isn't exposed for developer consumption, it's set automatically.
+		  * @default 'js'
+		 */
+		"sdkVariant"?: "js" | "react" | "vue";
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Optional href for the "View all" button.
+		 */
+		"viewAllResultsHref"?: string;
+		/**
+		  * Optional label for the "View all" button.
+		 */
+		"viewAllResultsLabel"?: string;
 	}
 	/**
 	 * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.
@@ -2532,15 +2596,33 @@ declare namespace LocalJSX {
 		  * Formats the content rendered for each result.
 		 */
 		"popoverResultMappings"?: PopoverResultMappings;
+		/**
+		  * The SDK variant used to render this component. Used for UTM attribution on the footer link.
+		  * @default 'js'
+		 */
+		"sdkVariant"?: "js" | "react" | "vue";
 		/**
 		  * The id of the Searchcraft instance that this component should use.
 		 */
 		"searchcraftId"?: string;
+		/**
+		  * Whether to display the AI generative summary box before the search results. NOTE: This requires the usage of a read key that has "SUMMARY" permissions and either a subscription to Searchcraft Cloud with AI features enabled or a self-hosted model connected.
+		  * @default false
+		 */
+		"showSummaryBox"?: boolean;
 		/**
 		  * The type of popover form to render. - `inline` - Renders inline with the rest of the content on the page. The search results pop over the page content. - `fullscreen` - Renders in fullscreen view. Used together with the `searchcraft-popover-button` component. - `modal` - Renders in a modal view. Used together with the `searchcraft-popover-button` component.
 		  * @default 'inline'
 		 */
 		"type"?: "inline" | "fullscreen" | "modal";
+		/**
+		  * Base URL for the "View all" footer link. The current search term will be appended (URL encoded).  For example, in a CMS-backed site you might set this to `/?s=` so the final URL becomes `/?s=<search-term>`.
+		 */
+		"viewAllResultsBaseUrl"?: string;
+		/**
+		  * Optional label for the "View All" footer button. Defaults to "View All".
+		 */
+		"viewAllResultsLabel"?: string;
 	}
 	/**
 	 * A single list item rendered in a searchcraft-popover-list-view.

package/dist/components/index.js

@@ -1,29 +1,30 @@
-export { g as getAssetPath, r as render, s as setAssetPath, a as setNonce, b as setPlatformOptions } from './index2.js?v=0.13.3';
-import { n as nanoid } from './searchcraft-ad2.js?v=0.13.3';
-import { D as DEFAULT_CORE_INSTANCE_ID, r as registry } from './CoreInstanceRegistry.js?v=0.13.3';
-export { SearchcraftAd, defineCustomElement as defineCustomElementSearchcraftAd } from './searchcraft-ad.js?v=0.13.3';
-export { SearchcraftButton, defineCustomElement as defineCustomElementSearchcraftButton } from './searchcraft-button.js?v=0.13.3';
-export { SearchcraftErrorMessage, defineCustomElement as defineCustomElementSearchcraftErrorMessage } from './searchcraft-error-message.js?v=0.13.3';
-export { SearchcraftFacetList, defineCustomElement as defineCustomElementSearchcraftFacetList } from './searchcraft-facet-list.js?v=0.13.3';
-export { SearchcraftFilterPanel, defineCustomElement as defineCustomElementSearchcraftFilterPanel } from './searchcraft-filter-panel.js?v=0.13.3';
-export { SearchcraftInputForm, defineCustomElement as defineCustomElementSearchcraftInputForm } from './searchcraft-input-form.js?v=0.13.3';
-export { SearchcraftInputLabel, defineCustomElement as defineCustomElementSearchcraftInputLabel } from './searchcraft-input-label.js?v=0.13.3';
-export { SearchcraftLoading, defineCustomElement as defineCustomElementSearchcraftLoading } from './searchcraft-loading.js?v=0.13.3';
-export { SearchcraftPagination, defineCustomElement as defineCustomElementSearchcraftPagination } from './searchcraft-pagination.js?v=0.13.3';
-export { SearchcraftPopoverButton, defineCustomElement as defineCustomElementSearchcraftPopoverButton } from './searchcraft-popover-button.js?v=0.13.3';
-export { SearchcraftPopoverFooter, defineCustomElement as defineCustomElementSearchcraftPopoverFooter } from './searchcraft-popover-footer.js?v=0.13.3';
-export { SearchcraftPopoverForm, defineCustomElement as defineCustomElementSearchcraftPopoverForm } from './searchcraft-popover-form.js?v=0.13.3';
-export { SearchcraftPopoverListItem, defineCustomElement as defineCustomElementSearchcraftPopoverListItem } from './searchcraft-popover-list-item.js?v=0.13.3';
-export { SearchcraftPopoverListView, defineCustomElement as defineCustomElementSearchcraftPopoverListView } from './searchcraft-popover-list-view.js?v=0.13.3';
-export { SearchcraftResultsInfo, defineCustomElement as defineCustomElementSearchcraftResultsInfo } from './searchcraft-results-info.js?v=0.13.3';
-export { SearchcraftSearchResult, defineCustomElement as defineCustomElementSearchcraftSearchResult } from './searchcraft-search-result.js?v=0.13.3';
-export { SearchcraftSearchResults, defineCustomElement as defineCustomElementSearchcraftSearchResults } from './searchcraft-search-results.js?v=0.13.3';
-export { SearchcraftSearchResultsPerPage, defineCustomElement as defineCustomElementSearchcraftSearchResultsPerPage } from './searchcraft-search-results-per-page.js?v=0.13.3';
-export { SearchcraftSelect, defineCustomElement as defineCustomElementSearchcraftSelect } from './searchcraft-select.js?v=0.13.3';
-export { SearchcraftSlider, defineCustomElement as defineCustomElementSearchcraftSlider } from './searchcraft-slider.js?v=0.13.3';
-export { SearchcraftSummaryBox, defineCustomElement as defineCustomElementSearchcraftSummaryBox } from './searchcraft-summary-box.js?v=0.13.3';
-export { SearchcraftTheme, defineCustomElement as defineCustomElementSearchcraftTheme } from './searchcraft-theme.js?v=0.13.3';
-export { SearchcraftToggleButton, defineCustomElement as defineCustomElementSearchcraftToggleButton } from './searchcraft-toggle-button.js?v=0.13.3';
+export { g as getAssetPath, r as render, s as setAssetPath, a as setNonce, b as setPlatformOptions } from './index2.js?scv=0.14.0';
+import { n as nanoid } from './searchcraft-ad2.js?scv=0.14.0';
+import { D as DEFAULT_CORE_INSTANCE_ID, r as registry } from './CoreInstanceRegistry.js?scv=0.14.0';
+import { v as version, n as name } from './searchcraft-popover-footer2.js?scv=0.14.0';
+export { SearchcraftAd, defineCustomElement as defineCustomElementSearchcraftAd } from './searchcraft-ad.js?scv=0.14.0';
+export { SearchcraftButton, defineCustomElement as defineCustomElementSearchcraftButton } from './searchcraft-button.js?scv=0.14.0';
+export { SearchcraftErrorMessage, defineCustomElement as defineCustomElementSearchcraftErrorMessage } from './searchcraft-error-message.js?scv=0.14.0';
+export { SearchcraftFacetList, defineCustomElement as defineCustomElementSearchcraftFacetList } from './searchcraft-facet-list.js?scv=0.14.0';
+export { SearchcraftFilterPanel, defineCustomElement as defineCustomElementSearchcraftFilterPanel } from './searchcraft-filter-panel.js?scv=0.14.0';
+export { SearchcraftInputForm, defineCustomElement as defineCustomElementSearchcraftInputForm } from './searchcraft-input-form.js?scv=0.14.0';
+export { SearchcraftInputLabel, defineCustomElement as defineCustomElementSearchcraftInputLabel } from './searchcraft-input-label.js?scv=0.14.0';
+export { SearchcraftLoading, defineCustomElement as defineCustomElementSearchcraftLoading } from './searchcraft-loading.js?scv=0.14.0';
+export { SearchcraftPagination, defineCustomElement as defineCustomElementSearchcraftPagination } from './searchcraft-pagination.js?scv=0.14.0';
+export { SearchcraftPopoverButton, defineCustomElement as defineCustomElementSearchcraftPopoverButton } from './searchcraft-popover-button.js?scv=0.14.0';
+export { SearchcraftPopoverFooter, defineCustomElement as defineCustomElementSearchcraftPopoverFooter } from './searchcraft-popover-footer.js?scv=0.14.0';
+export { SearchcraftPopoverForm, defineCustomElement as defineCustomElementSearchcraftPopoverForm } from './searchcraft-popover-form.js?scv=0.14.0';
+export { SearchcraftPopoverListItem, defineCustomElement as defineCustomElementSearchcraftPopoverListItem } from './searchcraft-popover-list-item.js?scv=0.14.0';
+export { SearchcraftPopoverListView, defineCustomElement as defineCustomElementSearchcraftPopoverListView } from './searchcraft-popover-list-view.js?scv=0.14.0';
+export { SearchcraftResultsInfo, defineCustomElement as defineCustomElementSearchcraftResultsInfo } from './searchcraft-results-info.js?scv=0.14.0';
+export { SearchcraftSearchResult, defineCustomElement as defineCustomElementSearchcraftSearchResult } from './searchcraft-search-result.js?scv=0.14.0';
+export { SearchcraftSearchResults, defineCustomElement as defineCustomElementSearchcraftSearchResults } from './searchcraft-search-results.js?scv=0.14.0';
+export { SearchcraftSearchResultsPerPage, defineCustomElement as defineCustomElementSearchcraftSearchResultsPerPage } from './searchcraft-search-results-per-page.js?scv=0.14.0';
+export { SearchcraftSelect, defineCustomElement as defineCustomElementSearchcraftSelect } from './searchcraft-select.js?scv=0.14.0';
+export { SearchcraftSlider, defineCustomElement as defineCustomElementSearchcraftSlider } from './searchcraft-slider.js?scv=0.14.0';
+export { SearchcraftSummaryBox, defineCustomElement as defineCustomElementSearchcraftSummaryBox } from './searchcraft-summary-box.js?scv=0.14.0';
+export { SearchcraftTheme, defineCustomElement as defineCustomElementSearchcraftTheme } from './searchcraft-theme.js?scv=0.14.0';
+export { SearchcraftToggleButton, defineCustomElement as defineCustomElementSearchcraftToggleButton } from './searchcraft-toggle-button.js?scv=0.14.0';
 
 var LogLevel;
 (function (LogLevel) {
@@ -1236,9 +1237,6 @@ class SearchcraftCore {
     };
 }
 
-const name = "@searchcraft/javascript-sdk";
-const version = "0.13.3";
-
 /**
  * @fileoverview entry point for your component library
  *
@@ -1264,4 +1262,4 @@ export { Searchcraft, SearchcraftCore };
 //# sourceMappingURL=index.js.map
 
 //# sourceMappingURL=index.js.map
-export { defineCustomElements } from './defineCustomElements.js?v=0.13.3';
+export { defineCustomElements } from './defineCustomElements.js?scv=0.14.0';