@searchcraft/javascript-sdk 0.13.2 → 0.14.0

package/dist/types/components.d.ts

@@ -84,7 +84,19 @@ export namespace Components {
      * It is consumed within the `searchcraft-filter-panel`.
      * @js-example ```html
      * <!-- index.html -->
+     * <!-- Basic usage -->
      * <searchcraft-facet-list field-name="title" />
+     * <!-- With collapsible section (initially closed) and view more threshold -->
+     * <searchcraft-facet-list
+     *   field-name="category"
+     *   initial-collapse-state="closed"
+     *   view-more-threshold="5"
+     * />
+     * <!-- Show all facets without "view more" link -->
+     * <searchcraft-facet-list
+     *   field-name="brand"
+     *   view-more-threshold="0"
+     * />
      * ```
      * ```js
      * // index.js
@@ -92,6 +104,8 @@ export namespace Components {
      * facetList.addEventListener('facetSelectionUpdated', () => {
      *   console.log('Facet selection updated');
      * });
+     * // Programmatically toggle collapse state
+     * await facetList.handleCollapseToggle();
      * ```
      */
     interface SearchcraftFacetList {
@@ -104,10 +118,30 @@ export namespace Components {
           * @default ''
          */
         "fieldName": string;
+        /**
+          * Returns whether the facet section is currently collapsed.
+          * @returns A promise that resolves to true if collapsed, false if expanded.
+         */
+        "getIsCollapsed": () => Promise<boolean>;
+        /**
+          * Toggles the collapsed state of the facet section.
+          * @returns A promise that resolves when the toggle is complete.
+         */
+        "handleCollapseToggle": () => Promise<void>;
+        /**
+          * Initial collapse state of the facet section.
+          * @default 'open'
+         */
+        "initialCollapseState"?: 'open' | 'closed';
         /**
           * The id of the Searchcraft instance that this component should use.
          */
         "searchcraftId"?: string;
+        /**
+          * The number of facets to show before displaying a "view more" link. Set to 0 to show all facets without a "view more" link.
+          * @default 8
+         */
+        "viewMoreThreshold"?: number;
     }
     /**
      * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -254,10 +288,25 @@ 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
+         */
+        "scrollToTop"?: boolean;
         /**
           * 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.
@@ -317,10 +366,23 @@ export namespace Components {
      * Renders the footer for the searchcraft-popover-form.
      */
     interface SearchcraftPopoverFooter {
+        /**
+          * The SDK variant used to render this component. Used for UTM attribution. This isn't exposed for developer consumption, it's set automatically.
+          * @default 'js'
+         */
+        "sdkVariant"?: 'js' | 'react' | 'vue';
         /**
           * The id of the Searchcraft instance that this component should use.
          */
         "searchcraftId"?: string;
+        /**
+          * Optional href for the "View all" button.
+         */
+        "viewAllResultsHref"?: string;
+        /**
+          * Optional label for the "View all" button.
+         */
+        "viewAllResultsLabel"?: string;
     }
     /**
      * This web component is designed to display search results in a popover container that dynamically appears when the user interacts with a search input field, or when a popover-button is pressed.
@@ -370,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.
@@ -787,7 +867,19 @@ declare global {
      * It is consumed within the `searchcraft-filter-panel`.
      * @js-example ```html
      * <!-- index.html -->
+     * <!-- Basic usage -->
      * <searchcraft-facet-list field-name="title" />
+     * <!-- With collapsible section (initially closed) and view more threshold -->
+     * <searchcraft-facet-list
+     *   field-name="category"
+     *   initial-collapse-state="closed"
+     *   view-more-threshold="5"
+     * />
+     * <!-- Show all facets without "view more" link -->
+     * <searchcraft-facet-list
+     *   field-name="brand"
+     *   view-more-threshold="0"
+     * />
      * ```
      * ```js
      * // index.js
@@ -795,6 +887,8 @@ declare global {
      * facetList.addEventListener('facetSelectionUpdated', () => {
      *   console.log('Facet selection updated');
      * });
+     * // Programmatically toggle collapse state
+     * await facetList.handleCollapseToggle();
      * ```
      */
     interface HTMLSearchcraftFacetListElement extends Components.SearchcraftFacetList, HTMLStencilElement {
@@ -1378,7 +1472,19 @@ declare namespace LocalJSX {
      * It is consumed within the `searchcraft-filter-panel`.
      * @js-example ```html
      * <!-- index.html -->
+     * <!-- Basic usage -->
      * <searchcraft-facet-list field-name="title" />
+     * <!-- With collapsible section (initially closed) and view more threshold -->
+     * <searchcraft-facet-list
+     *   field-name="category"
+     *   initial-collapse-state="closed"
+     *   view-more-threshold="5"
+     * />
+     * <!-- Show all facets without "view more" link -->
+     * <searchcraft-facet-list
+     *   field-name="brand"
+     *   view-more-threshold="0"
+     * />
      * ```
      * ```js
      * // index.js
@@ -1386,6 +1492,8 @@ declare namespace LocalJSX {
      * facetList.addEventListener('facetSelectionUpdated', () => {
      *   console.log('Facet selection updated');
      * });
+     * // Programmatically toggle collapse state
+     * await facetList.handleCollapseToggle();
      * ```
      */
     interface SearchcraftFacetList {
@@ -1398,6 +1506,11 @@ declare namespace LocalJSX {
           * @default ''
          */
         "fieldName"?: string;
+        /**
+          * Initial collapse state of the facet section.
+          * @default 'open'
+         */
+        "initialCollapseState"?: 'open' | 'closed';
         /**
           * Emitted when the facets are updated.
          */
@@ -1406,6 +1519,11 @@ declare namespace LocalJSX {
           * The id of the Searchcraft instance that this component should use.
          */
         "searchcraftId"?: string;
+        /**
+          * The number of facets to show before displaying a "view more" link. Set to 0 to show all facets without a "view more" link.
+          * @default 8
+         */
+        "viewMoreThreshold"?: number;
     }
     /**
      * This web component represents a series of filters that allows users to refine and control their search queries by applying various filter criteria.
@@ -1564,10 +1682,25 @@ 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
+         */
+        "scrollToTop"?: boolean;
         /**
           * 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.
@@ -1631,6 +1764,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.
@@ -1684,11 +1825,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.
@@ -2084,7 +2238,19 @@ declare module "@stencil/core" {
              * It is consumed within the `searchcraft-filter-panel`.
              * @js-example ```html
              * <!-- index.html -->
+             * <!-- Basic usage -->
              * <searchcraft-facet-list field-name="title" />
+             * <!-- With collapsible section (initially closed) and view more threshold -->
+             * <searchcraft-facet-list
+             *   field-name="category"
+             *   initial-collapse-state="closed"
+             *   view-more-threshold="5"
+             * />
+             * <!-- Show all facets without "view more" link -->
+             * <searchcraft-facet-list
+             *   field-name="brand"
+             *   view-more-threshold="0"
+             * />
              * ```
              * ```js
              * // index.js
@@ -2092,6 +2258,8 @@ declare module "@stencil/core" {
              * facetList.addEventListener('facetSelectionUpdated', () => {
              *   console.log('Facet selection updated');
              * });
+             * // Programmatically toggle collapse state
+             * await facetList.handleCollapseToggle();
              * ```
              */
             "searchcraft-facet-list": LocalJSX.SearchcraftFacetList & JSXBase.HTMLAttributes<HTMLSearchcraftFacetListElement>;

package/dist/types/types/sdk-types/searchcraft-filter-panel.types.d.ts

@@ -9,6 +9,19 @@ export interface FacetsFilterItem extends FilterItem {
     options: {
         showSublevel: boolean;
         exclude?: string[];
+        /**
+         * Initial collapse state of the facet section.
+         * - 'open': Section is expanded by default
+         * - 'closed': Section is collapsed by default
+         * @default 'open'
+         */
+        initialCollapseState?: 'open' | 'closed';
+        /**
+         * The number of facets to show before displaying a "view more" link.
+         * Set to 0 to show all facets without a "view more" link.
+         * @default 8
+         */
+        viewMoreThreshold?: number;
     };
 }
 export interface NumericFilterItem extends FilterItem {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.13.2",
+  "version": "0.14.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": "1310ef77a55cc204f8b38fd0372211312746bc43"
+  "gitHead": "d51ad8ec818dd39bcd7ce1f9f3fc9be2fc74558a"
 }