@searchcraft/javascript-sdk 0.13.3 → 0.15.0

package/dist/types/components.d.ts

@@ -288,6 +288,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
@@ -297,6 +302,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.
@@ -350,16 +360,29 @@ export namespace Components {
         /**
           * The type of popover button to render.
          */
-        "type"?: 'skeuomorphic';
+        "type"?: 'skeuomorphic' | 'magnifying-glass';
     }
     /**
      * 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.
@@ -409,15 +432,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.
@@ -503,6 +544,33 @@ export namespace Components {
          */
         "template"?: ResultsInfoTemplate;
     }
+    /**
+     * This component renders a results summary for RAG search result summaries.
+     * When the user makes a search, a network call is made to retrieve the summary content, which is then
+     * rendered in this box.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```ts
+     * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-results-summary />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     */
+    interface SearchcraftResultsSummary {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
+    }
     /**
      * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
      */
@@ -684,6 +752,9 @@ export namespace Components {
         "step": number;
     }
     /**
+     * @deprecated Use `searchcraft-results-summary` instead.
+     * This component is deprecated and will be removed in a future version.
+     * Please update to use `searchcraft-results-summary` which has the same functionality.
      * This component renders a summary box for RAG search result summaries.
      * When the user makes a search, a network call is made to retrieve the summary content, which is then
      * rendered in this box.
@@ -1126,6 +1197,33 @@ declare global {
         prototype: HTMLSearchcraftResultsInfoElement;
         new (): HTMLSearchcraftResultsInfoElement;
     };
+    /**
+     * This component renders a results summary for RAG search result summaries.
+     * When the user makes a search, a network call is made to retrieve the summary content, which is then
+     * rendered in this box.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```ts
+     * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-results-summary />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     */
+    interface HTMLSearchcraftResultsSummaryElement extends Components.SearchcraftResultsSummary, HTMLStencilElement {
+    }
+    var HTMLSearchcraftResultsSummaryElement: {
+        prototype: HTMLSearchcraftResultsSummaryElement;
+        new (): HTMLSearchcraftResultsSummaryElement;
+    };
     /**
      * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
      */
@@ -1256,6 +1354,9 @@ declare global {
         new (): HTMLSearchcraftSliderElement;
     };
     /**
+     * @deprecated Use `searchcraft-results-summary` instead.
+     * This component is deprecated and will be removed in a future version.
+     * Please update to use `searchcraft-results-summary` which has the same functionality.
      * This component renders a summary box for RAG search result summaries.
      * When the user makes a search, a network call is made to retrieve the summary content, which is then
      * rendered in this box.
@@ -1342,6 +1443,7 @@ declare global {
         "searchcraft-popover-list-item": HTMLSearchcraftPopoverListItemElement;
         "searchcraft-popover-list-view": HTMLSearchcraftPopoverListViewElement;
         "searchcraft-results-info": HTMLSearchcraftResultsInfoElement;
+        "searchcraft-results-summary": HTMLSearchcraftResultsSummaryElement;
         "searchcraft-search-result": HTMLSearchcraftSearchResultElement;
         "searchcraft-search-results": HTMLSearchcraftSearchResultsElement;
         "searchcraft-search-results-per-page": HTMLSearchcraftSearchResultsPerPageElement;
@@ -1641,6 +1743,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
@@ -1650,6 +1757,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.
@@ -1703,7 +1815,7 @@ declare namespace LocalJSX {
         /**
           * The type of popover button to render.
          */
-        "type"?: 'skeuomorphic';
+        "type"?: 'skeuomorphic' | 'magnifying-glass';
     }
     /**
      * Renders the footer for the searchcraft-popover-form.
@@ -1713,6 +1825,14 @@ declare namespace LocalJSX {
           * 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.
@@ -1766,11 +1886,24 @@ declare namespace LocalJSX {
           * 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.
@@ -1856,6 +1989,33 @@ declare namespace LocalJSX {
          */
         "template"?: ResultsInfoTemplate;
     }
+    /**
+     * This component renders a results summary for RAG search result summaries.
+     * When the user makes a search, a network call is made to retrieve the summary content, which is then
+     * rendered in this box.
+     * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+     * @react-import ```jsx
+     * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+     * ```
+     * @vue-import ```ts
+     * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+     * ```
+     * @js-example ```html
+     * <searchcraft-results-summary />
+     * ```
+     * @react-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     * @vue-example ```jsx
+     * <SearchcraftResultsSummary />
+     * ```
+     */
+    interface SearchcraftResultsSummary {
+        /**
+          * The id of the Searchcraft instance that this component should use.
+         */
+        "searchcraftId"?: string;
+    }
     /**
      * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
      */
@@ -2045,6 +2205,9 @@ declare namespace LocalJSX {
         "step"?: number;
     }
     /**
+     * @deprecated Use `searchcraft-results-summary` instead.
+     * This component is deprecated and will be removed in a future version.
+     * Please update to use `searchcraft-results-summary` which has the same functionality.
      * This component renders a summary box for RAG search result summaries.
      * When the user makes a search, a network call is made to retrieve the summary content, which is then
      * rendered in this box.
@@ -2129,6 +2292,7 @@ declare namespace LocalJSX {
         "searchcraft-popover-list-item": SearchcraftPopoverListItem;
         "searchcraft-popover-list-view": SearchcraftPopoverListView;
         "searchcraft-results-info": SearchcraftResultsInfo;
+        "searchcraft-results-summary": SearchcraftResultsSummary;
         "searchcraft-search-result": SearchcraftSearchResult;
         "searchcraft-search-results": SearchcraftSearchResults;
         "searchcraft-search-results-per-page": SearchcraftSearchResultsPerPage;
@@ -2385,6 +2549,28 @@ declare module "@stencil/core" {
              * ```
              */
             "searchcraft-results-info": LocalJSX.SearchcraftResultsInfo & JSXBase.HTMLAttributes<HTMLSearchcraftResultsInfoElement>;
+            /**
+             * This component renders a results summary for RAG search result summaries.
+             * When the user makes a search, a network call is made to retrieve the summary content, which is then
+             * rendered in this box.
+             * NOTE: This component requires the usage of a read key that has "SUMMARY" permissions.
+             * @react-import ```jsx
+             * import { SearchcraftResultsSummary } from "@searchcraft/react-sdk";
+             * ```
+             * @vue-import ```ts
+             * import { SearchcraftResultsSummary } from "@searchcraft/vue-sdk";
+             * ```
+             * @js-example ```html
+             * <searchcraft-results-summary />
+             * ```
+             * @react-example ```jsx
+             * <SearchcraftResultsSummary />
+             * ```
+             * @vue-example ```jsx
+             * <SearchcraftResultsSummary />
+             * ```
+             */
+            "searchcraft-results-summary": LocalJSX.SearchcraftResultsSummary & JSXBase.HTMLAttributes<HTMLSearchcraftResultsSummaryElement>;
             /**
              * This web component is designed to display detailed information for a single search result. Once a query is submitted, the component formats and presents the result.
              */
@@ -2468,6 +2654,9 @@ declare module "@stencil/core" {
              */
             "searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
             /**
+             * @deprecated Use `searchcraft-results-summary` instead.
+             * This component is deprecated and will be removed in a future version.
+             * Please update to use `searchcraft-results-summary` which has the same functionality.
              * This component renders a summary box for RAG search result summaries.
              * When the user makes a search, a network call is made to retrieve the summary content, which is then
              * rendered in this box.

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

@@ -61,6 +61,7 @@ export interface SearchcraftStateValues {
     orderByField: string | undefined | null;
     sortType: 'asc' | 'desc' | undefined | null;
     summary: string;
+    summaryErrorMessage: string;
     hasSummaryBox: boolean;
     isSummaryLoading: boolean;
     summaryClient?: SummaryClient;

package/dist/types/types/core-types/SearchcraftConfig.types.d.ts

@@ -34,11 +34,11 @@ export interface SearchcraftConfig {
      */
     searchResultsPerPage?: number;
     /**
-     * The URL pointing towards Searchcraft Cloud's semantic search and RAG summary processing layer. When using a `searchcraft-summary-box` component, this value must be specified.
+     * @deprecated Summary requests now use `endpointURL` and `indexName`. This field is ignored by current SDK summary requests.
      */
     cortexURL?: string;
     /**
-     * Instructions provided to the LLM when creating search result summaries.
+     * @deprecated Summary prompt instructions are configured server-side on the index. This field is ignored by the engine summary endpoint.
      */
     summaryInstructionsPrompt?: string;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.13.3",
+  "version": "0.15.0",
   "description": "Searchcraft Javascript SDK",
   "author": "Searchcraft Inc.",
   "license": "Apache-2.0",
@@ -31,6 +31,23 @@
   "files": [
     "dist/"
   ],
+  "keywords": [
+    "searchcraft",
+    "search",
+    "search-ui",
+    "search-sdk",
+    "search-api",
+    "facets",
+    "filters",
+    "pagination",
+    "fuzzy-search",
+    "semantic-search",
+    "javascript-sdk",
+    "full-text-search",
+    "search-components",
+    "federated-search",
+    "web-components"
+  ],
   "scripts": {
     "build": "stencil build",
     "docs": "typedoc --options typedoc.json",
@@ -55,5 +72,5 @@
     "nanoid": "^5.0.9",
     "zustand": "^5.0.1"
   },
-  "gitHead": "40e365cc415bae53b6e2f4078bb24fa0581d81d2"
+  "gitHead": "ad47b8cf8ac6f9938093c2f3852d39a6038b8e6b"
 }