@searchcraft/javascript-sdk 0.10.6 → 0.11.0

package/dist/types/components.d.ts

@@ -5,9 +5,9 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { AdClientResponseItem, FilterItem, PopoverButtonTemplate, PopoverResultMappings, ResultsInfoTemplate, SearchClientResponseItem, SearchcraftAdSource, SearchcraftCore, SearchResultTemplate, SearchResultTemplateData } from "@searchcraft/core";
+import { AdClientResponseItem, FilterItem, PopoverButtonTemplate, PopoverResultMappings, ResultsInfoTemplate, SearchClientResponseItem, SearchResultTemplate, SearchResultTemplateData } from "./types/index";
 import { SearchcraftSelectOption } from "./components/searchcraft-select/searchcraft-select";
-export { AdClientResponseItem, FilterItem, PopoverButtonTemplate, PopoverResultMappings, ResultsInfoTemplate, SearchClientResponseItem, SearchcraftAdSource, SearchcraftCore, SearchResultTemplate, SearchResultTemplateData } from "@searchcraft/core";
+export { AdClientResponseItem, FilterItem, PopoverButtonTemplate, PopoverResultMappings, ResultsInfoTemplate, SearchClientResponseItem, SearchResultTemplate, SearchResultTemplateData } from "./types/index";
 export { SearchcraftSelectOption } from "./components/searchcraft-select/searchcraft-select";
 export namespace Components {
     /**
@@ -15,8 +15,15 @@ export namespace Components {
      */
     interface SearchcraftAd {
         "adClientResponseItem"?: AdClientResponseItem;
-        "adContainerId": string;
-        "adSource": SearchcraftAdSource;
+        "adSource": 'Custom' | 'Nativo' | 'adMarketplace';
+        /**
+          * Where the ad is being rendered within the search results div. Lifecycle behavior differs for ads being rendered in different positions, so we need to be able to handle all of those cases.
+         */
+        "renderPosition": 'interstitial' | 'top' | 'bottom';
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component represents a button.
@@ -82,6 +89,10 @@ export namespace Components {
           * The name of the field where facets are applied.
          */
         "fieldName": string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -114,6 +125,10 @@ export namespace Components {
           * The items to filter.
          */
         "items": FilterItem[];
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
@@ -147,7 +162,6 @@ export namespace Components {
           * Where to place the search button.
          */
         "buttonPlacement"?: 'left' | 'right' | 'none';
-        "core"?: SearchcraftCore;
         /**
           * The label rendered above the input.
          */
@@ -160,6 +174,10 @@ export namespace Components {
           * The input element's placeholder value.
          */
         "placeholderValue"?: string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component serves as the input label for the searchcraft-input-form component.
@@ -174,6 +192,12 @@ export namespace Components {
         "inputLabelClassName"?: string | undefined;
         "label": string;
     }
+    /**
+     * Renders a loading spinner/loading state for use in things like the summary box.
+     */
+    interface SearchcraftLoading {
+        "label"?: string;
+    }
     /**
      * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
      * @react-import ```jsx
@@ -193,6 +217,10 @@ export namespace Components {
      * ```
      */
     interface SearchcraftPagination {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * Renders a button which, when clicked, turns on popover visibility.
@@ -235,6 +263,10 @@ export namespace Components {
      * ```
      */
     interface SearchcraftPopoverButton {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering the button contents.
          */
@@ -248,6 +280,10 @@ export namespace Components {
      * Renders the footer for the searchcraft-popover-form.
      */
     interface SearchcraftPopoverFooter {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: 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.
@@ -286,6 +322,10 @@ export namespace Components {
           * Formats the content rendered for each result.
          */
         "popoverResultMappings"?: PopoverResultMappings;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * 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.
          */
@@ -301,6 +341,10 @@ export namespace Components {
         "documentPosition": number;
         "item": SearchClientResponseItem | undefined;
         "popoverResultMappings": PopoverResultMappings | undefined;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to display a list of results within a popover interface.
@@ -321,6 +365,10 @@ export namespace Components {
         "searchClientResponseItems": SearchClientResponseItem[] | undefined;
         "searchResultsPage": number;
         "searchResultsPerPage": number;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to display the number of results returned from a search query.
@@ -357,6 +405,10 @@ export namespace Components {
      * ```
      */
     interface SearchcraftResultsInfo {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering the results info.
          */
@@ -375,6 +427,10 @@ export namespace Components {
          */
         "index": number;
         "item"?: SearchClientResponseItem;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering a result.
          */
@@ -426,6 +482,10 @@ export namespace Components {
           * A query that will appears when the component initializes or the search term is ''..
          */
         "initialQuery"?: string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering a result. Passed to `searchcraft-search-result`.
          */
@@ -455,6 +515,10 @@ export namespace Components {
           * The amount the options will increase (e.g. 20 = [20, 40, 60, 80, 100]). The base value is defined by the `searchResultsPerPage` option in the configuration.
          */
         "increment": string | number;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to allow users to select between a group of options.
@@ -522,6 +586,33 @@ export namespace Components {
          */
         "step": number;
     }
+    /**
+     * 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.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-summary-box />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     */
+    interface SearchcraftSummaryBox {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
+    }
     /**
      * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'
      * @react-import ```jsx
@@ -550,6 +641,10 @@ export namespace Components {
           * The label.
          */
         "label": string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * The secondary label displayed below the main label.
          */
@@ -739,6 +834,15 @@ declare global {
         prototype: HTMLSearchcraftInputLabelElement;
         new (): HTMLSearchcraftInputLabelElement;
     };
+    /**
+     * Renders a loading spinner/loading state for use in things like the summary box.
+     */
+    interface HTMLSearchcraftLoadingElement extends Components.SearchcraftLoading, HTMLStencilElement {
+    }
+    var HTMLSearchcraftLoadingElement: {
+        prototype: HTMLSearchcraftLoadingElement;
+        new (): HTMLSearchcraftLoadingElement;
+    };
     /**
      * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
      * @react-import ```jsx
@@ -1039,6 +1143,33 @@ declare global {
         prototype: HTMLSearchcraftSliderElement;
         new (): HTMLSearchcraftSliderElement;
     };
+    /**
+     * 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.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-summary-box />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     */
+    interface HTMLSearchcraftSummaryBoxElement extends Components.SearchcraftSummaryBox, HTMLStencilElement {
+    }
+    var HTMLSearchcraftSummaryBoxElement: {
+        prototype: HTMLSearchcraftSummaryBoxElement;
+        new (): HTMLSearchcraftSummaryBoxElement;
+    };
     /**
      * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'
      * @react-import ```jsx
@@ -1091,6 +1222,7 @@ declare global {
         "searchcraft-filter-panel": HTMLSearchcraftFilterPanelElement;
         "searchcraft-input-form": HTMLSearchcraftInputFormElement;
         "searchcraft-input-label": HTMLSearchcraftInputLabelElement;
+        "searchcraft-loading": HTMLSearchcraftLoadingElement;
         "searchcraft-pagination": HTMLSearchcraftPaginationElement;
         "searchcraft-popover-button": HTMLSearchcraftPopoverButtonElement;
         "searchcraft-popover-footer": HTMLSearchcraftPopoverFooterElement;
@@ -1103,6 +1235,7 @@ declare global {
         "searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
         "searchcraft-select": HTMLSearchcraftSelectElement;
         "searchcraft-slider": HTMLSearchcraftSliderElement;
+        "searchcraft-summary-box": HTMLSearchcraftSummaryBoxElement;
         "searchcraft-theme": HTMLSearchcraftThemeElement;
         "searchcraft-toggle-button": HTMLSearchcraftToggleButtonElement;
     }
@@ -1113,8 +1246,15 @@ declare namespace LocalJSX {
      */
     interface SearchcraftAd {
         "adClientResponseItem"?: AdClientResponseItem;
-        "adContainerId"?: string;
-        "adSource"?: SearchcraftAdSource;
+        "adSource"?: 'Custom' | 'Nativo' | 'adMarketplace';
+        /**
+          * Where the ad is being rendered within the search results div. Lifecycle behavior differs for ads being rendered in different positions, so we need to be able to handle all of those cases.
+         */
+        "renderPosition"?: 'interstitial' | 'top' | 'bottom';
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component represents a button.
@@ -1188,6 +1328,10 @@ declare namespace LocalJSX {
           * Emitted when the facets are updated.
          */
         "onFacetSelectionUpdated"?: (event: SearchcraftFacetListCustomEvent<{ paths: string[] }>) => void;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -1220,6 +1364,10 @@ declare namespace LocalJSX {
           * The items to filter.
          */
         "items"?: FilterItem[];
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
@@ -1253,7 +1401,6 @@ declare namespace LocalJSX {
           * Where to place the search button.
          */
         "buttonPlacement"?: 'left' | 'right' | 'none';
-        "core"?: SearchcraftCore;
         /**
           * The label rendered above the input.
          */
@@ -1278,6 +1425,10 @@ declare namespace LocalJSX {
           * The input element's placeholder value.
          */
         "placeholderValue"?: string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component serves as the input label for the searchcraft-input-form component.
@@ -1292,6 +1443,12 @@ declare namespace LocalJSX {
         "inputLabelClassName"?: string | undefined;
         "label"?: string;
     }
+    /**
+     * Renders a loading spinner/loading state for use in things like the summary box.
+     */
+    interface SearchcraftLoading {
+        "label"?: string;
+    }
     /**
      * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
      * @react-import ```jsx
@@ -1311,6 +1468,10 @@ declare namespace LocalJSX {
      * ```
      */
     interface SearchcraftPagination {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * Renders a button which, when clicked, turns on popover visibility.
@@ -1353,6 +1514,10 @@ declare namespace LocalJSX {
      * ```
      */
     interface SearchcraftPopoverButton {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering the button contents.
          */
@@ -1366,6 +1531,10 @@ declare namespace LocalJSX {
      * Renders the footer for the searchcraft-popover-form.
      */
     interface SearchcraftPopoverFooter {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: 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.
@@ -1404,6 +1573,10 @@ declare namespace LocalJSX {
           * Formats the content rendered for each result.
          */
         "popoverResultMappings"?: PopoverResultMappings;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * 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.
          */
@@ -1419,6 +1592,10 @@ declare namespace LocalJSX {
         "documentPosition"?: number;
         "item"?: SearchClientResponseItem | undefined;
         "popoverResultMappings"?: PopoverResultMappings | undefined;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to display a list of results within a popover interface.
@@ -1439,6 +1616,10 @@ declare namespace LocalJSX {
         "searchClientResponseItems"?: SearchClientResponseItem[] | undefined;
         "searchResultsPage": number;
         "searchResultsPerPage": number;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to display the number of results returned from a search query.
@@ -1475,6 +1656,10 @@ declare namespace LocalJSX {
      * ```
      */
     interface SearchcraftResultsInfo {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering the results info.
          */
@@ -1493,6 +1678,10 @@ declare namespace LocalJSX {
          */
         "index": number;
         "item"?: SearchClientResponseItem;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering a result.
          */
@@ -1544,6 +1733,10 @@ declare namespace LocalJSX {
           * A query that will appears when the component initializes or the search term is ''..
          */
         "initialQuery"?: string;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * A callback function responsible for rendering a result. Passed to `searchcraft-search-result`.
          */
@@ -1573,6 +1766,10 @@ declare namespace LocalJSX {
           * The amount the options will increase (e.g. 20 = [20, 40, 60, 80, 100]). The base value is defined by the `searchResultsPerPage` option in the configuration.
          */
         "increment"?: string | number;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
     }
     /**
      * This web component is designed to allow users to select between a group of options.
@@ -1648,6 +1845,33 @@ declare namespace LocalJSX {
          */
         "step"?: number;
     }
+    /**
+     * 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.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```jsx
+     * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-summary-box />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftSummaryBox />
+     * ```
+     */
+    interface SearchcraftSummaryBox {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
+    }
     /**
      * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'
      * @react-import ```jsx
@@ -1680,6 +1904,10 @@ declare namespace LocalJSX {
           * When the toggle element is changed.
          */
         "onToggleUpdated"?: (event: SearchcraftToggleButtonCustomEvent<boolean>) => void;
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
         /**
           * The secondary label displayed below the main label.
          */
@@ -1693,6 +1921,7 @@ declare namespace LocalJSX {
         "searchcraft-filter-panel": SearchcraftFilterPanel;
         "searchcraft-input-form": SearchcraftInputForm;
         "searchcraft-input-label": SearchcraftInputLabel;
+        "searchcraft-loading": SearchcraftLoading;
         "searchcraft-pagination": SearchcraftPagination;
         "searchcraft-popover-button": SearchcraftPopoverButton;
         "searchcraft-popover-footer": SearchcraftPopoverFooter;
@@ -1705,6 +1934,7 @@ declare namespace LocalJSX {
         "searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
         "searchcraft-select": SearchcraftSelect;
         "searchcraft-slider": SearchcraftSlider;
+        "searchcraft-summary-box": SearchcraftSummaryBox;
         "searchcraft-theme": SearchcraftTheme;
         "searchcraft-toggle-button": SearchcraftToggleButton;
     }
@@ -1801,6 +2031,10 @@ declare module "@stencil/core" {
              * ```
              */
             "searchcraft-input-label": LocalJSX.SearchcraftInputLabel & JSXBase.HTMLAttributes<HTMLSearchcraftInputLabelElement>;
+            /**
+             * Renders a loading spinner/loading state for use in things like the summary box.
+             */
+            "searchcraft-loading": LocalJSX.SearchcraftLoading & JSXBase.HTMLAttributes<HTMLSearchcraftLoadingElement>;
             /**
              * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
              * @react-import ```jsx
@@ -2019,6 +2253,28 @@ declare module "@stencil/core" {
              * This web component is designed to allow users to select a value from a range defined by a minimum and maximum value. The component renders a slider interface, which can be used to visually choose a value between two boundaries.
              */
             "searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
+            /**
+             * 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.
+             * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+             * @react-import ```jsx
+             * import { SearchcraftSummaryBox } from "@searchcraft/react-sdk";
+             * ```
+             * @vue-import ```jsx
+             * import { SearchcraftSummaryBox } from "@searchcraft/vue-sdk";
+             * ```
+             * @js-example ```html
+             * <searchcraft-summary-box />
+             * ```
+             * @react-example ```jsx
+             * <SearchcraftSummaryBox />
+             * ```
+             * @vue-example ```jsx
+             * <SearchcraftSummaryBox />
+             * ```
+             */
+            "searchcraft-summary-box": LocalJSX.SearchcraftSummaryBox & JSXBase.HTMLAttributes<HTMLSearchcraftSummaryBoxElement>;
             /**
              * This web component adds Searchcraft's built-in css theme to your page. It does not render anything visible, its only function is to manage the css styles on the page.'
              * @react-import ```jsx

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-import { type SearchcraftConfig, SearchcraftCore } from '@searchcraft/core';
-import { searchcraftStore } from "./store/index";
+import { SearchcraftCore } from "./classes/index";
+import type { SearchcraftConfig } from "./types/index";
 /**
  * @fileoverview entry point for your component library
  *
@@ -13,14 +13,13 @@ import { searchcraftStore } from "./store/index";
  * The consumer-facing `Searchcraft` class.
  */
 export declare class Searchcraft extends SearchcraftCore {
-    constructor(config: SearchcraftConfig);
+    constructor(config: SearchcraftConfig, searchcraftId?: string | undefined);
 }
 /**
  * Exports the shared types that all SDKs need
  */
 export type { SearchcraftConfig };
-export { searchcraftStore };
 export type { Components, JSX } from './components';
 export { SearchcraftCore };
-export type * from '@searchcraft/core/dist/types/sdk-types';
+export type * from '@types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1,24 +1,19 @@
-import type { FacetPathsForIndexField, FacetPrime, RangeValueForIndexField, Logger, SearchcraftCore, SearchClientResponseItem, AdClientResponseItem, SearchcraftResponse, SearchClientRequestProperties } from '@searchcraft/core';
+import type { StoreApi } from 'zustand';
+import type { FacetPathsForIndexField, FacetPrime, RangeValueForIndexField, SearchClientResponseItem, AdClientResponseItem, SearchClientRequestProperties, SearchClientRequest } from "../types/index";
+import type { SearchcraftCore } from "../classes/index";
+import type { SummaryClient } from "../clients/SummaryClient";
 /**
  * Callable functions made available by the SearchcraftStore.
  */
 export interface SearchcraftStateFunctions {
     addFacetPathsForIndexField: (field: FacetPathsForIndexField) => void;
     addRangeValueForIndexField: (field: RangeValueForIndexField) => void;
-    getSearchcraftCore: () => SearchcraftCore | undefined;
-    init: (searchcraft: SearchcraftCore | undefined, debug?: boolean) => void;
     removeFacetPathsForIndexField: (fieldName: string) => void;
     removeRangeValueForIndexField: (fieldName: string) => void;
-    resetFacetPaths: () => void;
+    resetSearchValues: () => void;
     search: () => Promise<void>;
-    set: (state: Partial<SearchcraftState> | ((state: SearchcraftState) => Partial<SearchcraftState>)) => SearchcraftState;
-    setAdClientResponseItems: (items: AdClientResponseItem[]) => void;
-    setSearchClientResponseItemsFromResponse: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[], supplementalResponse: SearchcraftResponse | undefined) => void;
-    setInitialSearchClientResponseItemsFromResponse: (request: SearchClientRequestProperties | string, response: SearchcraftResponse, items: SearchClientResponseItem[]) => void;
-    setInitialQuery: (query: string) => void;
     setPopoverVisibility: (isVisible: boolean) => void;
     setSearchResultsCount: (count: number) => void;
-    setSearchClientResponseItems: (items: SearchClientResponseItem[]) => void;
     setSearchResultsPage: (page: number) => void;
     setSearchResultsPerPage: (perPage: number) => void;
     setSearchTerm: (searchTerm: string) => void;
@@ -34,19 +29,19 @@ export interface SearchcraftStateFunctions {
  */
 export interface SearchcraftStateValues {
     adClientResponseItems: AdClientResponseItem[];
+    cachedAdClientResponseItems: AdClientResponseItem[];
     core: SearchcraftCore | undefined;
     hotkey: string;
     hotkeyModifier: 'ctrl' | 'meta' | 'alt' | 'option';
-    logger: Logger | undefined;
     facetPathsForIndexFields: Record<string, FacetPathsForIndexField>;
-    initialQuery: string;
-    initialSearchClientResponseItems: SearchClientResponseItem[];
     isPopoverVisible: boolean;
     isSearchInProgress: boolean;
     rangeValueForIndexFields: Record<string, RangeValueForIndexField>;
     searchMode: 'fuzzy' | 'exact';
-    searchClientRequest: SearchClientRequestProperties | string | undefined | null;
+    searchClientRequest?: SearchClientRequest;
+    searchClientRequestProperties: SearchClientRequestProperties | string | undefined | null;
     searchClientResponseItems: SearchClientResponseItem[];
+    cachedSearchClientResponseItems: SearchClientResponseItem[];
     searchResponseTimeTaken: number | undefined;
     searchResponseFacetPrime: FacetPrime | undefined | null;
     supplementalFacetPrime: FacetPrime | undefined | null;
@@ -56,8 +51,12 @@ export interface SearchcraftStateValues {
     searchTerm: string;
     orderByField: string | undefined | null;
     sortType: 'asc' | 'desc' | undefined | null;
-    afterInit: (state: SearchcraftState) => void;
+    summary: string;
+    hasSummaryBox: boolean;
+    isSummaryLoading: boolean;
+    summaryClient?: SummaryClient;
 }
 export interface SearchcraftState extends SearchcraftStateFunctions, SearchcraftStateValues {
 }
+export type SearchcraftStore = StoreApi<SearchcraftState>;
 //# sourceMappingURL=SearchcraftStore.types.d.ts.map

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

@@ -0,0 +1,13 @@
+import { type StoreApi } from 'zustand';
+import type { SearchcraftState, SearchcraftStateValues } from './SearchcraftStore.types';
+/**
+ * This is a factory function for creating new searchcraft stores.
+ *
+ * Searchcraft Stores contain the state information used by a SearchcraftCore instance.
+ *
+ * This factory function only needs to be called when a new SearchcraftCore is instantiated.
+ * @returns
+ */
+declare const createSearchcraftStore: (searchcraftId: string | undefined, initialState?: Partial<SearchcraftStateValues>) => StoreApi<SearchcraftState>;
+export { createSearchcraftStore };
+//# sourceMappingURL=SearchcraftStoreFactory.d.ts.map