@searchcraft/javascript-sdk 0.8.2 → 0.9.1

package/dist/types/components.d.ts

@@ -5,11 +5,18 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { AdClientResponseItem, FilterItem, PopoverResultMappings, SearchClientResponseItem, SearchcraftConfig, SearchResultMappings } from "@searchcraft/core";
+import { AdClientResponseItem, FilterItem, PopoverResultMappings, SearchClientResponseItem, SearchcraftAdSource, SearchcraftCore, SearchResultMappings } from "@searchcraft/core";
 import { SearchcraftSelectOption } from "./components/searchcraft-select/searchcraft-select";
-export { AdClientResponseItem, FilterItem, PopoverResultMappings, SearchClientResponseItem, SearchcraftConfig, SearchResultMappings } from "@searchcraft/core";
+export { AdClientResponseItem, FilterItem, PopoverResultMappings, SearchClientResponseItem, SearchcraftAdSource, SearchcraftCore, SearchResultMappings } from "@searchcraft/core";
 export { SearchcraftSelectOption } from "./components/searchcraft-select/searchcraft-select";
 export namespace Components {
+    /**
+     * An inline ad meant to be rendered in a list of search results.
+     */
+    interface SearchcraftAd {
+        "adClientResponseItem"?: AdClientResponseItem;
+        "adSource": SearchcraftAdSource;
+    }
     /**
      * 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.
@@ -19,7 +26,7 @@ export namespace Components {
         /**
           * The relationship between the current document and the link for the button rendered when containerHref is not present.
          */
-        "buttonRel": 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the button rendered when containerHref is not present.
          */
@@ -27,7 +34,7 @@ export namespace Components {
         /**
           * The relationship between the current document and the link for the containing element.
          */
-        "containerRel": 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the containing element.
          */
@@ -35,7 +42,7 @@ export namespace Components {
         /**
           * A custom styles object.
          */
-        "customStyles": string | undefined;
+        "customStyles"?: string;
         /**
           * The position in the document. Used with the "document_clicked" measure event.
          */
@@ -44,14 +51,8 @@ export namespace Components {
           * The placement of the image.
          */
         "imagePlacement": 'left' | 'right';
-        "item": SearchClientResponseItem | undefined;
-        "searchResultMappings": SearchResultMappings | undefined;
-    }
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface SearchcraftBaseSearchResultAd {
-        "adClientResponseItem"?: AdClientResponseItem;
+        "item"?: SearchClientResponseItem;
+        "searchResultMappings"?: SearchResultMappings;
     }
     /**
      * This web component is responsible for displaying the results of a search query.
@@ -85,11 +86,11 @@ export namespace Components {
         /**
           * The label for the button rendered when containerHref is not present for each result.
          */
-        "buttonLabel": string | undefined;
+        "buttonLabel"?: string;
         /**
           * The relationship between the current document and the link for the button rendered when containerHref is not present for each result.
          */
-        "buttonRel": 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the button rendered when containerHref is not present for each result.
          */
@@ -97,7 +98,7 @@ export namespace Components {
         /**
           * The relationship between the current document and the link for the containing element for each result.
          */
-        "containerRel": 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the containing element for each result.
          */
@@ -105,9 +106,8 @@ export namespace Components {
         /**
           * A custom styles object.
          */
-        "customStylesForResults": | string
-    | Record<string, Record<string, string>>
-    | undefined;
+        "customStylesForResults"?: | string
+    | Record<string, Record<string, string>>;
         /**
           * The placement of the image for each result.
          */
@@ -115,7 +115,7 @@ export namespace Components {
         /**
           * Formats the content rendered for each result.
          */
-        "searchResultMappings": SearchResultMappings | undefined;
+        "searchResultMappings"?: SearchResultMappings;
     }
     /**
      * This web component represents a button to be consumed within the `search-input-form` component.
@@ -213,14 +213,6 @@ export namespace Components {
      * ```js
      * // index.js
      * const searchInputForm = document.querySelector('searchcraft-input-form');
-     * searchInputForm.config = {
-     *   index: [],
-     *   readKey: '',
-     *   endpointUrl: '',
-     * };
-     * searchForm.addEventListener('querySubmit', (event) => {
-     *   console.log('Query submitted', event.detail);
-     * });
      * ```
      */
     interface SearchcraftInputForm {
@@ -231,15 +223,12 @@ export namespace Components {
         /**
           * The label for the submit button.
          */
-        "buttonLabel": string | undefined;
+        "buttonLabel"?: string;
         /**
           * Where to place the search button.
          */
         "buttonPlacement": 'left' | 'right' | 'none';
-        /**
-          * The Searchcraft config object.
-         */
-        "config": SearchcraftConfig | undefined;
+        "core"?: SearchcraftCore;
         /**
           * A custom styles object to be applied to the input element.
          */
@@ -247,7 +236,7 @@ export namespace Components {
         /**
           * The label rendered above the input.
          */
-        "inputLabel": string | undefined;
+        "inputLabel"?: string;
         /**
           * The input element's placeholder value.
          */
@@ -302,11 +291,6 @@ export namespace Components {
      * ```js
      * // index.js
      * const popoverForm = document.querySelector('searchcraft-popover-form');
-     * popoverForm.config = {
-     *   index: [index_name_from_vektron],
-     *   readKey: 'read_key_from_vektron',
-     *   endpointUrl: 'enpoint_url_from_vektron',
-     * };
      * popoverForm.popoverResultMappings = {
      *  containerHref: {
      *   fieldNames: [
@@ -319,10 +303,6 @@ export namespace Components {
      * ```
      */
     interface SearchcraftPopoverForm {
-        /**
-          * The Searchcraft config object.
-         */
-        "config": SearchcraftConfig | undefined;
         /**
           * The hotkey that activates the popover.
          */
@@ -334,7 +314,7 @@ export namespace Components {
         /**
           * Formats the content rendered for each result.
          */
-        "popoverResultMappings": PopoverResultMappings | undefined;
+        "popoverResultMappings"?: PopoverResultMappings;
         /**
           * 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.
          */
@@ -351,12 +331,6 @@ export namespace Components {
         "item": SearchClientResponseItem | undefined;
         "popoverResultMappings": PopoverResultMappings | undefined;
     }
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface SearchcraftPopoverListItemAd {
-        "adClientResponseItem"?: AdClientResponseItem;
-    }
     /**
      * This web component is designed to display a list of results within a popover interface.
      * It is consumed within the `searchcraft-popover-form` component.
@@ -507,11 +481,11 @@ export namespace Components {
         /**
           * The custom theme configuration object.
          */
-        "customTheme": string;
+        "customTheme"?: string;
         /**
           * The name of the theme.
          */
-        "theme": string;
+        "theme"?: string;
     }
     /**
      * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
@@ -528,10 +502,6 @@ export namespace Components {
         "subLabel": string | undefined;
     }
 }
-export interface SearchcraftBaseSearchResultsCustomEvent<T> extends CustomEvent<T> {
-    detail: T;
-    target: HTMLSearchcraftBaseSearchResultsElement;
-}
 export interface SearchcraftButtonCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLSearchcraftButtonElement;
@@ -557,6 +527,15 @@ export interface SearchcraftToggleButtonCustomEvent<T> extends CustomEvent<T> {
     target: HTMLSearchcraftToggleButtonElement;
 }
 declare global {
+    /**
+     * An inline ad meant to be rendered in a list of search results.
+     */
+    interface HTMLSearchcraftAdElement extends Components.SearchcraftAd, HTMLStencilElement {
+    }
+    var HTMLSearchcraftAdElement: {
+        prototype: HTMLSearchcraftAdElement;
+        new (): HTMLSearchcraftAdElement;
+    };
     /**
      * 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.
@@ -568,18 +547,6 @@ declare global {
         prototype: HTMLSearchcraftBaseSearchResultElement;
         new (): HTMLSearchcraftBaseSearchResultElement;
     };
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface HTMLSearchcraftBaseSearchResultAdElement extends Components.SearchcraftBaseSearchResultAd, HTMLStencilElement {
-    }
-    var HTMLSearchcraftBaseSearchResultAdElement: {
-        prototype: HTMLSearchcraftBaseSearchResultAdElement;
-        new (): HTMLSearchcraftBaseSearchResultAdElement;
-    };
-    interface HTMLSearchcraftBaseSearchResultsElementEventMap {
-        "noResults": void;
-    }
     /**
      * This web component is responsible for displaying the results of a search query.
      * Once a query is submitted, the component formats and presents an ordered list of the results.
@@ -609,14 +576,6 @@ declare global {
      * ```
      */
     interface HTMLSearchcraftBaseSearchResultsElement extends Components.SearchcraftBaseSearchResults, HTMLStencilElement {
-        addEventListener<K extends keyof HTMLSearchcraftBaseSearchResultsElementEventMap>(type: K, listener: (this: HTMLSearchcraftBaseSearchResultsElement, ev: SearchcraftBaseSearchResultsCustomEvent<HTMLSearchcraftBaseSearchResultsElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
-        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
-        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
-        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-        removeEventListener<K extends keyof HTMLSearchcraftBaseSearchResultsElementEventMap>(type: K, listener: (this: HTMLSearchcraftBaseSearchResultsElement, ev: SearchcraftBaseSearchResultsCustomEvent<HTMLSearchcraftBaseSearchResultsElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
-        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
-        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
-        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     }
     var HTMLSearchcraftBaseSearchResultsElement: {
         prototype: HTMLSearchcraftBaseSearchResultsElement;
@@ -706,12 +665,9 @@ declare global {
         new (): HTMLSearchcraftFilterPanelElement;
     };
     interface HTMLSearchcraftInputFormElementEventMap {
-        "inputCleared": void;
-        "noResultsReceived": void;
         "inputFocus": void;
         "inputBlur": void;
         "inputInit": void;
-        "querySubmit": string;
     }
     /**
      * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
@@ -724,14 +680,6 @@ declare global {
      * ```js
      * // index.js
      * const searchInputForm = document.querySelector('searchcraft-input-form');
-     * searchInputForm.config = {
-     *   index: [],
-     *   readKey: '',
-     *   endpointUrl: '',
-     * };
-     * searchForm.addEventListener('querySubmit', (event) => {
-     *   console.log('Query submitted', event.detail);
-     * });
      * ```
      */
     interface HTMLSearchcraftInputFormElement extends Components.SearchcraftInputForm, HTMLStencilElement {
@@ -796,11 +744,6 @@ declare global {
      * ```js
      * // index.js
      * const popoverForm = document.querySelector('searchcraft-popover-form');
-     * popoverForm.config = {
-     *   index: [index_name_from_vektron],
-     *   readKey: 'read_key_from_vektron',
-     *   endpointUrl: 'enpoint_url_from_vektron',
-     * };
      * popoverForm.popoverResultMappings = {
      *  containerHref: {
      *   fieldNames: [
@@ -827,15 +770,6 @@ declare global {
         prototype: HTMLSearchcraftPopoverListItemElement;
         new (): HTMLSearchcraftPopoverListItemElement;
     };
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface HTMLSearchcraftPopoverListItemAdElement extends Components.SearchcraftPopoverListItemAd, HTMLStencilElement {
-    }
-    var HTMLSearchcraftPopoverListItemAdElement: {
-        prototype: HTMLSearchcraftPopoverListItemAdElement;
-        new (): HTMLSearchcraftPopoverListItemAdElement;
-    };
     /**
      * This web component is designed to display a list of results within a popover interface.
      * It is consumed within the `searchcraft-popover-form` component.
@@ -972,8 +906,8 @@ declare global {
         new (): HTMLSearchcraftToggleButtonElement;
     };
     interface HTMLElementTagNameMap {
+        "searchcraft-ad": HTMLSearchcraftAdElement;
         "searchcraft-base-search-result": HTMLSearchcraftBaseSearchResultElement;
-        "searchcraft-base-search-result-ad": HTMLSearchcraftBaseSearchResultAdElement;
         "searchcraft-base-search-results": HTMLSearchcraftBaseSearchResultsElement;
         "searchcraft-button": HTMLSearchcraftButtonElement;
         "searchcraft-error-message": HTMLSearchcraftErrorMessageElement;
@@ -985,7 +919,6 @@ declare global {
         "searchcraft-popover-button": HTMLSearchcraftPopoverButtonElement;
         "searchcraft-popover-form": HTMLSearchcraftPopoverFormElement;
         "searchcraft-popover-list-item": HTMLSearchcraftPopoverListItemElement;
-        "searchcraft-popover-list-item-ad": HTMLSearchcraftPopoverListItemAdElement;
         "searchcraft-popover-list-view": HTMLSearchcraftPopoverListViewElement;
         "searchcraft-results-info": HTMLSearchcraftResultsInfoElement;
         "searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
@@ -996,6 +929,13 @@ declare global {
     }
 }
 declare namespace LocalJSX {
+    /**
+     * An inline ad meant to be rendered in a list of search results.
+     */
+    interface SearchcraftAd {
+        "adClientResponseItem"?: AdClientResponseItem;
+        "adSource"?: SearchcraftAdSource;
+    }
     /**
      * 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.
@@ -1005,7 +945,7 @@ declare namespace LocalJSX {
         /**
           * The relationship between the current document and the link for the button rendered when containerHref is not present.
          */
-        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the button rendered when containerHref is not present.
          */
@@ -1013,7 +953,7 @@ declare namespace LocalJSX {
         /**
           * The relationship between the current document and the link for the containing element.
          */
-        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the containing element.
          */
@@ -1021,7 +961,7 @@ declare namespace LocalJSX {
         /**
           * A custom styles object.
          */
-        "customStyles"?: string | undefined;
+        "customStyles"?: string;
         /**
           * The position in the document. Used with the "document_clicked" measure event.
          */
@@ -1030,14 +970,8 @@ declare namespace LocalJSX {
           * The placement of the image.
          */
         "imagePlacement"?: 'left' | 'right';
-        "item"?: SearchClientResponseItem | undefined;
-        "searchResultMappings"?: SearchResultMappings | undefined;
-    }
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface SearchcraftBaseSearchResultAd {
-        "adClientResponseItem"?: AdClientResponseItem;
+        "item"?: SearchClientResponseItem;
+        "searchResultMappings"?: SearchResultMappings;
     }
     /**
      * This web component is responsible for displaying the results of a search query.
@@ -1071,11 +1005,11 @@ declare namespace LocalJSX {
         /**
           * The label for the button rendered when containerHref is not present for each result.
          */
-        "buttonLabel"?: string | undefined;
+        "buttonLabel"?: string;
         /**
           * The relationship between the current document and the link for the button rendered when containerHref is not present for each result.
          */
-        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "buttonRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the button rendered when containerHref is not present for each result.
          */
@@ -1083,7 +1017,7 @@ declare namespace LocalJSX {
         /**
           * The relationship between the current document and the link for the containing element for each result.
          */
-        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow' | undefined;
+        "containerRel"?: 'noreferrer' | 'noopener' | 'nofollow';
         /**
           * Where to open the link for the containing element for each result.
          */
@@ -1092,12 +1026,7 @@ declare namespace LocalJSX {
           * A custom styles object.
          */
         "customStylesForResults"?: | string
-    | Record<string, Record<string, string>>
-    | undefined;
-        /**
-          * When no results are returned.
-         */
-        "onNoResults"?: (event: SearchcraftBaseSearchResultsCustomEvent<void>) => void;
+    | Record<string, Record<string, string>>;
         /**
           * The placement of the image for each result.
          */
@@ -1105,7 +1034,7 @@ declare namespace LocalJSX {
         /**
           * Formats the content rendered for each result.
          */
-        "searchResultMappings"?: SearchResultMappings | undefined;
+        "searchResultMappings"?: SearchResultMappings;
     }
     /**
      * This web component represents a button to be consumed within the `search-input-form` component.
@@ -1211,14 +1140,6 @@ declare namespace LocalJSX {
      * ```js
      * // index.js
      * const searchInputForm = document.querySelector('searchcraft-input-form');
-     * searchInputForm.config = {
-     *   index: [],
-     *   readKey: '',
-     *   endpointUrl: '',
-     * };
-     * searchForm.addEventListener('querySubmit', (event) => {
-     *   console.log('Query submitted', event.detail);
-     * });
      * ```
      */
     interface SearchcraftInputForm {
@@ -1229,15 +1150,12 @@ declare namespace LocalJSX {
         /**
           * The label for the submit button.
          */
-        "buttonLabel"?: string | undefined;
+        "buttonLabel"?: string;
         /**
           * Where to place the search button.
          */
         "buttonPlacement"?: 'left' | 'right' | 'none';
-        /**
-          * The Searchcraft config object.
-         */
-        "config"?: SearchcraftConfig | undefined;
+        "core"?: SearchcraftCore;
         /**
           * A custom styles object to be applied to the input element.
          */
@@ -1245,15 +1163,11 @@ declare namespace LocalJSX {
         /**
           * The label rendered above the input.
          */
-        "inputLabel"?: string | undefined;
+        "inputLabel"?: string;
         /**
           * When the input becomes unfocused.
          */
         "onInputBlur"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
-        /**
-          * When the input is cleared.
-         */
-        "onInputCleared"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
         /**
           * When the input becomes focused.
          */
@@ -1262,14 +1176,6 @@ declare namespace LocalJSX {
           * Event emitted when input initializes.
          */
         "onInputInit"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
-        /**
-          * When no results are returned.
-         */
-        "onNoResultsReceived"?: (event: SearchcraftInputFormCustomEvent<void>) => void;
-        /**
-          * Event emitted when a query has been submitted.
-         */
-        "onQuerySubmit"?: (event: SearchcraftInputFormCustomEvent<string>) => void;
         /**
           * The input element's placeholder value.
          */
@@ -1324,11 +1230,6 @@ declare namespace LocalJSX {
      * ```js
      * // index.js
      * const popoverForm = document.querySelector('searchcraft-popover-form');
-     * popoverForm.config = {
-     *   index: [index_name_from_vektron],
-     *   readKey: 'read_key_from_vektron',
-     *   endpointUrl: 'enpoint_url_from_vektron',
-     * };
      * popoverForm.popoverResultMappings = {
      *  containerHref: {
      *   fieldNames: [
@@ -1341,10 +1242,6 @@ declare namespace LocalJSX {
      * ```
      */
     interface SearchcraftPopoverForm {
-        /**
-          * The Searchcraft config object.
-         */
-        "config"?: SearchcraftConfig | undefined;
         /**
           * The hotkey that activates the popover.
          */
@@ -1356,7 +1253,7 @@ declare namespace LocalJSX {
         /**
           * Formats the content rendered for each result.
          */
-        "popoverResultMappings"?: PopoverResultMappings | undefined;
+        "popoverResultMappings"?: PopoverResultMappings;
         /**
           * 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.
          */
@@ -1373,12 +1270,6 @@ declare namespace LocalJSX {
         "item"?: SearchClientResponseItem | undefined;
         "popoverResultMappings"?: PopoverResultMappings | undefined;
     }
-    /**
-     * A single list item rendered in a searchcraft-popover-list-view.
-     */
-    interface SearchcraftPopoverListItemAd {
-        "adClientResponseItem"?: AdClientResponseItem;
-    }
     /**
      * This web component is designed to display a list of results within a popover interface.
      * It is consumed within the `searchcraft-popover-form` component.
@@ -1562,8 +1453,8 @@ declare namespace LocalJSX {
         "subLabel"?: string | undefined;
     }
     interface IntrinsicElements {
+        "searchcraft-ad": SearchcraftAd;
         "searchcraft-base-search-result": SearchcraftBaseSearchResult;
-        "searchcraft-base-search-result-ad": SearchcraftBaseSearchResultAd;
         "searchcraft-base-search-results": SearchcraftBaseSearchResults;
         "searchcraft-button": SearchcraftButton;
         "searchcraft-error-message": SearchcraftErrorMessage;
@@ -1575,7 +1466,6 @@ declare namespace LocalJSX {
         "searchcraft-popover-button": SearchcraftPopoverButton;
         "searchcraft-popover-form": SearchcraftPopoverForm;
         "searchcraft-popover-list-item": SearchcraftPopoverListItem;
-        "searchcraft-popover-list-item-ad": SearchcraftPopoverListItemAd;
         "searchcraft-popover-list-view": SearchcraftPopoverListView;
         "searchcraft-results-info": SearchcraftResultsInfo;
         "searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
@@ -1589,16 +1479,16 @@ export { LocalJSX as JSX };
 declare module "@stencil/core" {
     export namespace JSX {
         interface IntrinsicElements {
+            /**
+             * An inline ad meant to be rendered in a list of search results.
+             */
+            "searchcraft-ad": LocalJSX.SearchcraftAd & JSXBase.HTMLAttributes<HTMLSearchcraftAdElement>;
             /**
              * 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.
              * It is consumed within the `searchcraft-base-search-results` component.
              */
             "searchcraft-base-search-result": LocalJSX.SearchcraftBaseSearchResult & JSXBase.HTMLAttributes<HTMLSearchcraftBaseSearchResultElement>;
-            /**
-             * A single list item rendered in a searchcraft-popover-list-view.
-             */
-            "searchcraft-base-search-result-ad": LocalJSX.SearchcraftBaseSearchResultAd & JSXBase.HTMLAttributes<HTMLSearchcraftBaseSearchResultAdElement>;
             /**
              * This web component is responsible for displaying the results of a search query.
              * Once a query is submitted, the component formats and presents an ordered list of the results.
@@ -1680,14 +1570,6 @@ declare module "@stencil/core" {
              * ```js
              * // index.js
              * const searchInputForm = document.querySelector('searchcraft-input-form');
-             * searchInputForm.config = {
-             *   index: [],
-             *   readKey: '',
-             *   endpointUrl: '',
-             * };
-             * searchForm.addEventListener('querySubmit', (event) => {
-             *   console.log('Query submitted', event.detail);
-             * });
              * ```
              */
             "searchcraft-input-form": LocalJSX.SearchcraftInputForm & JSXBase.HTMLAttributes<HTMLSearchcraftInputFormElement>;
@@ -1724,11 +1606,6 @@ declare module "@stencil/core" {
              * ```js
              * // index.js
              * const popoverForm = document.querySelector('searchcraft-popover-form');
-             * popoverForm.config = {
-             *   index: [index_name_from_vektron],
-             *   readKey: 'read_key_from_vektron',
-             *   endpointUrl: 'enpoint_url_from_vektron',
-             * };
              * popoverForm.popoverResultMappings = {
              *  containerHref: {
              *   fieldNames: [
@@ -1745,10 +1622,6 @@ declare module "@stencil/core" {
              * A single list item rendered in a searchcraft-popover-list-view.
              */
             "searchcraft-popover-list-item": LocalJSX.SearchcraftPopoverListItem & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverListItemElement>;
-            /**
-             * A single list item rendered in a searchcraft-popover-list-view.
-             */
-            "searchcraft-popover-list-item-ad": LocalJSX.SearchcraftPopoverListItemAd & JSXBase.HTMLAttributes<HTMLSearchcraftPopoverListItemAdElement>;
             /**
              * This web component is designed to display a list of results within a popover interface.
              * It is consumed within the `searchcraft-popover-form` component.

package/dist/types/index.d.ts

@@ -1,3 +1,5 @@
+import { type SearchcraftConfig, SearchcraftCore } from '@searchcraft/core';
+import { searchcraftStore } from "./store/index";
 /**
  * @fileoverview entry point for your component library
  *
@@ -8,7 +10,18 @@
  * to consume components of this package as outlined in the `README.md`.
  */
 export type * from './components';
+export type { SearchcraftConfig };
+export { searchcraftStore };
 export { parseCustomStyles, serializeStyles, } from './utils';
-export { useSearchcraftStore } from './provider/store';
 export type { Components } from './components';
+/**
+ * The consumer-facing `Searchcraft` class.
+ */
+export declare class Searchcraft extends SearchcraftCore {
+    constructor(config: SearchcraftConfig);
+}
+/**
+ * Exports the shared types that all SDKs need
+ */
+export type * from '@searchcraft/core/dist/types/sdk-types';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/store/SearchcraftStore.d.ts

@@ -0,0 +1,4 @@
+import type { SearchcraftState } from './SearchcraftStore.types';
+declare const searchcraftStore: import("zustand").StoreApi<SearchcraftState>;
+export { searchcraftStore };
+//# sourceMappingURL=SearchcraftStore.d.ts.map

package/dist/types/{provider → store}/SearchcraftStore.types.d.ts

@@ -6,7 +6,7 @@ export interface SearchcraftStateFunctions {
     addFacetPathsForIndexField: (data: FacetPathsForIndexField) => void;
     addRangeValueForIndexField: (data: RangeValueForIndexField) => void;
     getSearchcraftInstance: () => SearchcraftCore | undefined;
-    initialize: (searchcraft: SearchcraftCore, debug?: boolean) => void;
+    initialize: (searchcraft: unknown, debug?: boolean) => void;
     removeFacetPathsForIndexField: (fieldName: string) => void;
     removeRangeValueForIndexField: (fieldName: string) => void;
     resetFacetPaths: () => void;
@@ -28,6 +28,7 @@ export interface SearchcraftStateValues {
     logger: Logger | undefined;
     facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
     isPopoverVisible: boolean;
+    isSearchInProgress: boolean;
     rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
     searchMode: 'fuzzy' | 'exact';
     searchClientResponseItems: SearchClientResponseItem[];

package/dist/{collection/provider/store.js → types/store/index.d.ts}

@@ -1,3 +1,3 @@
-export * from './SearchcraftStore.types';
 export * from './SearchcraftStore';
-//# sourceMappingURL=store.js.map
+export * from './SearchcraftStore.types';
+//# sourceMappingURL=index.d.ts.map