@searchcraft/javascript-sdk 0.10.7 → 0.11.1

package/dist/types/components/searchcraft-input-form/searchcraft-input-form.d.ts

@@ -1,5 +1,5 @@
 import { type EventEmitter } from '../../stencil-public-runtime';
-import type { SearchcraftCore } from '@searchcraft/core';
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * This web component provides a user-friendly interface for querying an indexed dataset, enabling users to easily search large collections of data.
  * It abstracts the complexities of index-based searching, making it accessible to users of all technical levels.
@@ -30,6 +30,10 @@ import type { SearchcraftCore } from '@searchcraft/core';
  * ```
  */
 export declare class SearchcraftInputForm {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     /**
      * Whether or not to automatically submit the search term when the input changes.
      */
@@ -71,17 +75,16 @@ export declare class SearchcraftInputForm {
     inputValue: string;
     searchTerm: string;
     error: boolean;
-    core?: SearchcraftCore;
-    private searchcraftStore;
-    private unsubscribe;
+    private core?;
+    private unsubscribe?;
+    private cleanupCore?;
     init(): void;
     onCoreChange(): void;
+    onCoreAvailable(core: SearchcraftCore): void;
     connectedCallback(): void;
-    componentDidLoad(): void;
     disconnectedCallback(): void;
     handleInput: (event: Event) => void;
     private performSearch;
-    private handleReset;
     handleClearInput: () => void;
     handleFormSubmit: (event: Event) => Promise<void>;
     render(): any;

package/dist/types/components/searchcraft-loading/searchcraft-loading.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Renders a loading spinner/loading state for use in things like the summary box.
+ *
+ * @internal
+ */
+export declare class SearchcraftInputLabel {
+    label?: string;
+    render(): any;
+}
+//# sourceMappingURL=searchcraft-loading.d.ts.map

package/dist/types/components/searchcraft-pagination/searchcraft-pagination.d.ts

@@ -1,3 +1,4 @@
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * This web component is designed to facilitate pagination of search results. Once a query is submitted, calculates the number for pages.
  *
@@ -27,6 +28,10 @@
  * ```
  */
 export declare class SearchcraftPagination {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     searchTerm: any;
     searchResultsPerPage: any;
     searchResultsPage: any;
@@ -36,7 +41,9 @@ export declare class SearchcraftPagination {
     searchResultsRangeMax: number;
     setSearchResultsPage: (page: number) => void;
     private unsubscribe;
-    componentDidLoad(): void;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     handleGoToPage(page: number): void;
     renderOddPaginationItem(page: number): any;

package/dist/types/components/searchcraft-popover-button/searchcraft-popover-button.d.ts

@@ -1,4 +1,5 @@
-import type { PopoverButtonTemplate } from '@searchcraft/core';
+import type { SearchcraftCore } from "../../classes/index";
+import type { PopoverButtonTemplate } from "../../types/index";
 /**
  * Renders a button which, when clicked, turns on popover visibility.
  *
@@ -60,14 +61,21 @@ export declare class SearchcraftPopoverButton {
      * The type of popover button to render.
      */
     type?: 'skeuomorphic';
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     hotkey: any;
     hotkeyModifier: any;
     hotkeyModifierSymbol: any;
     isPopoverVisible: any;
     userAgent: any;
     private unsubscribe;
+    private cleanupCore?;
+    private core?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     handleOnClick(): void;
-    componentDidLoad(): void;
     disconnectedCallback(): void;
     setUserAgent(): "window" | "mac" | "other";
     renderOptionSymbol: () => any;

package/dist/types/components/searchcraft-popover-footer/searchcraft-popover-footer.d.ts

@@ -1,12 +1,19 @@
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * Renders the footer for the searchcraft-popover-form.
  *
  * @internal
  */
 export declare class SearchcraftPopoverFooter {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     searchResultsCount: any;
     private unsubscribe;
-    componentDidLoad(): void;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     render(): any;
 }

package/dist/types/components/searchcraft-popover-form/searchcraft-popover-form.d.ts

@@ -1,4 +1,5 @@
-import type { SearchClientResponseItem, AdClientResponseItem, PopoverResultMappings } from '@searchcraft/core';
+import type { SearchClientResponseItem, AdClientResponseItem, PopoverResultMappings } from "../../types/index";
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * 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.
  *
@@ -56,8 +57,11 @@ export declare class SearchcraftPopoverForm {
      * The hotkey modifier that activates the popover. Used together with the `hotkey` prop.
      */
     hotkeyModifier?: 'ctrl' | 'meta' | 'alt' | 'option';
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     isPopoverVisibleInState: boolean;
-    unsubscribe: (() => void) | undefined;
     searchClientResponseItems: SearchClientResponseItem[];
     adClientResponseItems: AdClientResponseItem[];
     searchTerm: string | undefined;
@@ -69,7 +73,11 @@ export declare class SearchcraftPopoverForm {
     searchResultsPerPage: any;
     modalElement: any;
     hostElement: HTMLElement;
-    componentDidLoad(): void;
+    private unsubscribe;
+    private cleanupCore?;
+    core?: SearchcraftCore;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     handleDocumentClick: (event: MouseEvent) => void;
     /**

package/dist/types/components/searchcraft-popover-list-item/searchcraft-popover-list-item.d.ts

@@ -1,4 +1,5 @@
-import type { SearchDocument, SearchClientResponseItem, PopoverResultMappings } from '@searchcraft/core';
+import type { SearchDocument, SearchClientResponseItem, PopoverResultMappings } from "../../types/index";
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * A single list item rendered in a searchcraft-popover-list-view.
  *
@@ -9,12 +10,19 @@ export declare class SearchcraftPopoverListItem {
     popoverResultMappings: PopoverResultMappings | undefined;
     /** The document position relative to the search results (For Measure) */
     documentPosition: number;
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     title?: string;
     subtitle?: string;
     href?: string;
     imageSource?: string;
     imageAlt?: string;
+    core?: SearchcraftCore;
+    private cleanupCore?;
     mapValuesFromDocument(document: SearchDocument): void;
+    onCoreAvailable(core: SearchcraftCore): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
     handleLinkClick: () => void;

package/dist/types/components/searchcraft-popover-list-view/searchcraft-popover-list-view.d.ts

@@ -1,5 +1,5 @@
-import type { AdClientResponseItem, SearchClientResponseItem } from '@searchcraft/core';
-import type { PopoverResultMappings } from '@searchcraft/core';
+import type { AdClientResponseItem, SearchClientResponseItem, PopoverResultMappings } from "../../types/index";
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * This web component is designed to display a list of results within a popover interface.
  * It is consumed within the `searchcraft-popover-form` component.
@@ -12,6 +12,10 @@ import type { PopoverResultMappings } from '@searchcraft/core';
  * @internal
  */
 export declare class SearchcraftPopoverListView {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     /**
      * The mappings that define how the data in the documents are mapped to the
      * list-view-item elements.
@@ -24,7 +28,11 @@ export declare class SearchcraftPopoverListView {
     adClientResponseItems: AdClientResponseItem[] | undefined;
     searchResultsPage: number;
     searchResultsPerPage: number;
-    private config;
+    private config?;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
     renderWithADMAds(): any;
     renderWithCustomAds(): any;
     renderWithNativoAds(): any;

package/dist/types/components/searchcraft-results-info/searchcraft-results-info.d.ts

@@ -1,4 +1,5 @@
-import type { ResultsInfoTemplate } from '@searchcraft/core';
+import type { SearchcraftCore } from "../../classes/index";
+import type { ResultsInfoTemplate } from "../../types/index";
 /**
  * This web component is designed to display the number of results returned from a search query.
  *
@@ -50,6 +51,10 @@ export declare class SearchcraftResultsInfo {
      * A callback function responsible for rendering the results info.
      */
     template?: ResultsInfoTemplate;
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     searchTerm: any;
     searchResultsPage: any;
     searchResultsPerPage: any;
@@ -58,6 +63,8 @@ export declare class SearchcraftResultsInfo {
     range: number[];
     responseTime: string;
     unsubscribe: () => void;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
     render(): any;

package/dist/types/components/searchcraft-search-result/searchcraft-search-result.d.ts

@@ -1,4 +1,5 @@
-import type { SearchClientResponseItem, SearchResultTemplate, SearchResultTemplateData } from '@searchcraft/core';
+import type { SearchClientResponseItem, SearchResultTemplate, SearchResultTemplateData } from "../../types/index";
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * 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.
  *
@@ -18,9 +19,17 @@ export declare class SearchcraftSearchResult {
      * A callback function responsible for rendering a result.
      */
     template?: SearchResultTemplate<SearchResultTemplateData>;
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     templateHtml: string | undefined;
     hostElement?: HTMLElement;
+    core?: SearchcraftCore;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
     connectedCallback(): void;
+    disconnectedCallback(): void;
     handleResultContainerClick: (event: MouseEvent) => void;
     handleKeyDown: () => void;
     render(): any;

package/dist/types/components/searchcraft-search-results/searchcraft-search-results.d.ts

@@ -1,5 +1,6 @@
-import type { AdClientResponseItem, SearchClientResponseItem, SearchcraftConfig, SearchResultTemplate, SearchResultTemplateData } from '@searchcraft/core';
-import { type SearchcraftState } from "../../store/index";
+import type { AdClientResponseItem, SearchClientResponseItem, SearchcraftConfig, SearchResultTemplate, SearchResultTemplateData } from "../../types/index";
+import type { SearchcraftState } from "../../store/index";
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * 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.
  *
@@ -55,6 +56,10 @@ import { type SearchcraftState } from "../../store/index";
  * ```
  */
 export declare class SearchcraftSearchResults {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     /**
      * A query that will appears when the component initializes or the search term is ''..
      */
@@ -65,14 +70,15 @@ export declare class SearchcraftSearchResults {
     template?: SearchResultTemplate<SearchResultTemplateData>;
     adClientResponseItems: AdClientResponseItem[];
     config?: SearchcraftConfig;
-    initialSearchClientResponseItems?: SearchClientResponseItem[];
     isSearchInProgress: boolean;
     searchClientResponseItems?: SearchClientResponseItem[];
     searchResultsPage: any;
     searchResultsPerPage: any;
     searchTerm: string;
-    private unsubscribe;
-    componentDidLoad(): void;
+    private unsubscribe?;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     handleStateChange(state: SearchcraftState): void;
     renderEmptyState(): any;

package/dist/types/components/searchcraft-search-results-per-page/searchcraft-search-results-per-page.d.ts

@@ -1,3 +1,4 @@
+import type { SearchcraftCore } from "../../classes/index";
 /**
  * This web component is designed to choose the number of search results displayed.
  *
@@ -33,6 +34,10 @@ export declare class SearchcraftSearchResultsPerPage {
      * 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;
     searchTerm: any;
     searchResultsPage: any;
     searchResultsPerPage: any;
@@ -42,7 +47,9 @@ export declare class SearchcraftSearchResultsPerPage {
     setSearchResultsPerPage: (perPage: number) => void;
     setSearchResultsPage: (page: number) => void;
     private unsubscribe;
-    componentDidLoad(): void;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
     disconnectedCallback(): void;
     render(): any;
 }

package/dist/types/components/searchcraft-summary-box/searchcraft-summary-box.d.ts

@@ -0,0 +1,49 @@
+import type { SearchcraftCore } from "../../classes/index";
+/**
+ * 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 />
+ * ```
+ */
+export declare class SearchcraftSummaryBox {
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
+    summary: string;
+    isLoading: boolean;
+    hostElement?: HTMLElement;
+    private unsubscribe?;
+    private cleanupCore?;
+    onCoreAvailable(core: SearchcraftCore): void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): any;
+}
+//# sourceMappingURL=searchcraft-summary-box.d.ts.map

package/dist/types/components/searchcraft-toggle-button/searchcraft-toggle-button.d.ts

@@ -1,3 +1,4 @@
+import type { SearchcraftCore } from "../../classes/index";
 import { type EventEmitter } from '../../stencil-public-runtime';
 /**
  * This web component simulates a light switch functionality, providing a simple and intuitive toggle between two states—on and off.
@@ -13,14 +14,20 @@ export declare class SearchcraftToggleButton {
      * The secondary label displayed below the main label.
      */
     subLabel: string | undefined;
+    /**
+     * The id of the Searchcraft instance that this component should use.
+     */
+    searchcraftId?: string;
     /**
      * When the toggle element is changed.
      */
     toggleUpdated?: EventEmitter<boolean>;
     isActive: boolean;
-    unsubscribe: (() => void) | undefined;
     lastSearchTerm: string | undefined;
+    private unsubscribe;
+    private cleanupCore?;
     private handleToggle;
+    onCoreAvailable(core: SearchcraftCore): void;
     connectedCallback(): void;
     disconnectedCallback(): void;
     render(): any;