@searchcraft/javascript-sdk 0.1.8 → 0.2.0

package/dist/types/components/searchcraft-auto-search-form/searchcraft-auto-search-form.d.ts

@@ -1,5 +1,5 @@
 import { type EventEmitter } from '../../stencil-public-runtime';
-import { type CoreConfigSDK } from '@searchcraft/core';
+import { type CoreConfigSDK, type SearchcraftResponse } from '@searchcraft/core';
 import type { ScInputCustomEvent } from "../searchcraft-input/searchcraft-input";
 export declare class SearchcraftAutoSearchForm {
     autoSearchFormClass: string;
@@ -14,10 +14,11 @@ export declare class SearchcraftAutoSearchForm {
     rightToLeftOrientation: boolean;
     searchContainerClass: string;
     querySubmit: EventEmitter<string>;
+    inputClearedOrNoResults: EventEmitter<void>;
     error: boolean;
     isRequesting: boolean;
     query: string;
-    searchResults: string;
+    searchResults: SearchcraftResponse | null;
     private debounceTimeout;
     private debounceDelay;
     private searchStore;
@@ -25,6 +26,7 @@ export declare class SearchcraftAutoSearchForm {
     componentDidLoad(): void;
     disconnectedCallback(): void;
     handleInputChange: (event: ScInputCustomEvent<string>) => void;
+    handleInputKeyUp: (event: ScInputCustomEvent<string>) => void;
     handleClearInput: () => void;
     private runSearch;
     handleFormSubmit: (event: Event) => Promise<void>;

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

@@ -2,12 +2,14 @@ import type { SearchcraftResponse } from '@searchcraft/core';
 export declare class SearchcraftBaseSearchResults {
     query: string;
     searchResults: SearchcraftResponse | null;
-    searchKeys: string;
+    hasSearched: boolean;
+    documentAttributesForDisplay: string;
     customStylesForResults: string | Record<string, Record<string, string>>;
     placeAdAtStart: boolean;
     placeAdAtEnd: boolean;
     adInterval: number;
     formatTime: boolean;
+    fallbackElement: HTMLElement | null;
     private unsubscribe;
     componentDidLoad(): void;
     disconnectedCallback(): void;

package/dist/types/components/searchcraft-filters-list/searchcraft-filters-list.d.ts

@@ -0,0 +1,30 @@
+import { type EventEmitter } from '../../stencil-public-runtime';
+import type { Facets } from '@searchcraft/core';
+export declare class SearchcraftFiltersList {
+    filters: Array<{
+        label: string;
+        value: string;
+    }>;
+    filtersUpdated: EventEmitter<string[]>;
+    dynamicFilters: Array<{
+        label: string;
+        value: string;
+    }>;
+    initialFilters: Array<{
+        label: string;
+        value: string;
+    }>;
+    isRequesting: boolean;
+    selectedFilters: Set<string>;
+    originalFilterCounts: Record<string, string>;
+    query: string;
+    resultsCount: number;
+    private searchStore;
+    unsubscribe: () => void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    populateFiltersFromFacets(facets: Facets): void;
+    handleFilterChange: (value: string, checked: boolean) => void;
+    formatLabel(label: string): string;
+    render(): any;
+}

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

@@ -18,9 +18,11 @@ export declare class SearchcraftInput {
     query: string;
     clearInput: EventEmitter<void>;
     searchInputChange: EventEmitter<string>;
+    inputKeyUp: EventEmitter<string>;
     theme: string;
     private get isLightTheme();
     handleInputChange(event: Event): void;
+    handleInputKeyUp(event: KeyboardEvent): void;
     handleClearInput(): void;
     render(): any;
 }

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

@@ -0,0 +1,10 @@
+export declare class SearchcraftResultsInfo {
+    isRequesting: boolean;
+    resultsCount: number;
+    responseTime: string;
+    query: string;
+    unsubscribe: () => void;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    render(): any;
+}

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

@@ -0,0 +1,17 @@
+export declare class SearchcraftSlider {
+    minYear: number;
+    maxYear: number;
+    endYear: number;
+    query: string;
+    startYear: number;
+    hasSearched: boolean;
+    unsubscribe: () => void;
+    private searchStore;
+    resultsCount: number;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    private updateYears;
+    private handleStartYearChange;
+    private handleEndYearChange;
+    render(): any;
+}

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

@@ -0,0 +1,17 @@
+export declare class SearchcraftToggleButton {
+    /**
+     * Type of the toggle - determines what it controls
+     * 'mode': toggles between 'fuzzy' and 'normal'
+     * 'sort': toggles between 'asc' and 'desc'
+     */
+    type: 'mode' | 'sort';
+    isActive: boolean;
+    query: string;
+    resultsCount: number;
+    private unsubscribe;
+    private searchStore;
+    componentDidLoad(): void;
+    disconnectedCallback(): void;
+    private handleToggle;
+    render(): any;
+}

package/dist/types/components.d.ts

@@ -44,10 +44,11 @@ export namespace Components {
         "adInterval": number;
         "customStylesForResults": | string
     | Record<string, Record<string, string>>;
+        "documentAttributesForDisplay": string;
+        "fallbackElement": HTMLElement | null;
         "formatTime": boolean;
         "placeAdAtEnd": boolean;
         "placeAdAtStart": boolean;
-        "searchKeys": string;
     }
     interface SearchcraftButton {
         "iconElement"?: Element;
@@ -77,6 +78,9 @@ export namespace Components {
          */
         "theme": 'light' | 'dark';
     }
+    interface SearchcraftFiltersList {
+        "filters": Array<{ label: string; value: string }>;
+    }
     interface SearchcraftInput {
         "customStyles": string | Record<string, string>;
         "error": boolean;
@@ -113,6 +117,8 @@ export namespace Components {
         "inputLabelClassName"?: string;
         "label"?: string;
     }
+    interface SearchcraftResultsInfo {
+    }
     interface SearchcraftSearchIconSet {
         "height": number;
         /**
@@ -121,10 +127,20 @@ export namespace Components {
         "type": 'search-light' | 'search-dark' | 'error-light' | 'error-dark';
         "width": number;
     }
+    interface SearchcraftSlider {
+        "maxYear": number;
+        "minYear": number;
+    }
     interface SearchcraftSpinnerDark {
     }
     interface SearchcraftSpinnerLight {
     }
+    interface SearchcraftToggleButton {
+        /**
+          * Type of the toggle - determines what it controls 'mode': toggles between 'fuzzy' and 'normal' 'sort': toggles between 'asc' and 'desc'
+         */
+        "type": 'mode' | 'sort';
+    }
 }
 export interface SearchcraftAutoSearchFormCustomEvent<T> extends CustomEvent<T> {
     detail: T;
@@ -146,6 +162,10 @@ export interface SearchcraftClearInputButtonCustomEvent<T> extends CustomEvent<T
     detail: T;
     target: HTMLSearchcraftClearInputButtonElement;
 }
+export interface SearchcraftFiltersListCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLSearchcraftFiltersListElement;
+}
 export interface SearchcraftInputCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLSearchcraftInputElement;
@@ -153,6 +173,7 @@ export interface SearchcraftInputCustomEvent<T> extends CustomEvent<T> {
 declare global {
     interface HTMLSearchcraftAutoSearchFormElementEventMap {
         "querySubmit": string;
+        "inputClearedOrNoResults": void;
     }
     interface HTMLSearchcraftAutoSearchFormElement extends Components.SearchcraftAutoSearchForm, HTMLStencilElement {
         addEventListener<K extends keyof HTMLSearchcraftAutoSearchFormElementEventMap>(type: K, listener: (this: HTMLSearchcraftAutoSearchFormElement, ev: SearchcraftAutoSearchFormCustomEvent<HTMLSearchcraftAutoSearchFormElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -262,9 +283,27 @@ declare global {
         prototype: HTMLSearchcraftErrorMessageElement;
         new (): HTMLSearchcraftErrorMessageElement;
     };
+    interface HTMLSearchcraftFiltersListElementEventMap {
+        "filtersUpdated": string[];
+    }
+    interface HTMLSearchcraftFiltersListElement extends Components.SearchcraftFiltersList, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLSearchcraftFiltersListElementEventMap>(type: K, listener: (this: HTMLSearchcraftFiltersListElement, ev: SearchcraftFiltersListCustomEvent<HTMLSearchcraftFiltersListElementEventMap[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 HTMLSearchcraftFiltersListElementEventMap>(type: K, listener: (this: HTMLSearchcraftFiltersListElement, ev: SearchcraftFiltersListCustomEvent<HTMLSearchcraftFiltersListElementEventMap[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 HTMLSearchcraftFiltersListElement: {
+        prototype: HTMLSearchcraftFiltersListElement;
+        new (): HTMLSearchcraftFiltersListElement;
+    };
     interface HTMLSearchcraftInputElementEventMap {
         "clearInput": void;
         "searchInputChange": string;
+        "inputKeyUp": string;
     }
     interface HTMLSearchcraftInputElement extends Components.SearchcraftInput, HTMLStencilElement {
         addEventListener<K extends keyof HTMLSearchcraftInputElementEventMap>(type: K, listener: (this: HTMLSearchcraftInputElement, ev: SearchcraftInputCustomEvent<HTMLSearchcraftInputElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
@@ -298,12 +337,24 @@ declare global {
         prototype: HTMLSearchcraftInputLabelElement;
         new (): HTMLSearchcraftInputLabelElement;
     };
+    interface HTMLSearchcraftResultsInfoElement extends Components.SearchcraftResultsInfo, HTMLStencilElement {
+    }
+    var HTMLSearchcraftResultsInfoElement: {
+        prototype: HTMLSearchcraftResultsInfoElement;
+        new (): HTMLSearchcraftResultsInfoElement;
+    };
     interface HTMLSearchcraftSearchIconSetElement extends Components.SearchcraftSearchIconSet, HTMLStencilElement {
     }
     var HTMLSearchcraftSearchIconSetElement: {
         prototype: HTMLSearchcraftSearchIconSetElement;
         new (): HTMLSearchcraftSearchIconSetElement;
     };
+    interface HTMLSearchcraftSliderElement extends Components.SearchcraftSlider, HTMLStencilElement {
+    }
+    var HTMLSearchcraftSliderElement: {
+        prototype: HTMLSearchcraftSliderElement;
+        new (): HTMLSearchcraftSliderElement;
+    };
     interface HTMLSearchcraftSpinnerDarkElement extends Components.SearchcraftSpinnerDark, HTMLStencilElement {
     }
     var HTMLSearchcraftSpinnerDarkElement: {
@@ -316,6 +367,12 @@ declare global {
         prototype: HTMLSearchcraftSpinnerLightElement;
         new (): HTMLSearchcraftSpinnerLightElement;
     };
+    interface HTMLSearchcraftToggleButtonElement extends Components.SearchcraftToggleButton, HTMLStencilElement {
+    }
+    var HTMLSearchcraftToggleButtonElement: {
+        prototype: HTMLSearchcraftToggleButtonElement;
+        new (): HTMLSearchcraftToggleButtonElement;
+    };
     interface HTMLElementTagNameMap {
         "searchcraft-auto-search-form": HTMLSearchcraftAutoSearchFormElement;
         "searchcraft-base-search-form": HTMLSearchcraftBaseSearchFormElement;
@@ -326,13 +383,17 @@ declare global {
         "searchcraft-clear-icon-set": HTMLSearchcraftClearIconSetElement;
         "searchcraft-clear-input-button": HTMLSearchcraftClearInputButtonElement;
         "searchcraft-error-message": HTMLSearchcraftErrorMessageElement;
+        "searchcraft-filters-list": HTMLSearchcraftFiltersListElement;
         "searchcraft-input": HTMLSearchcraftInputElement;
         "searchcraft-input-caption": HTMLSearchcraftInputCaptionElement;
         "searchcraft-input-icon": HTMLSearchcraftInputIconElement;
         "searchcraft-input-label": HTMLSearchcraftInputLabelElement;
+        "searchcraft-results-info": HTMLSearchcraftResultsInfoElement;
         "searchcraft-search-icon-set": HTMLSearchcraftSearchIconSetElement;
+        "searchcraft-slider": HTMLSearchcraftSliderElement;
         "searchcraft-spinner-dark": HTMLSearchcraftSpinnerDarkElement;
         "searchcraft-spinner-light": HTMLSearchcraftSpinnerLightElement;
+        "searchcraft-toggle-button": HTMLSearchcraftToggleButtonElement;
     }
 }
 declare namespace LocalJSX {
@@ -345,6 +406,7 @@ declare namespace LocalJSX {
         "inputIconHeight"?: number;
         "inputIconWidth"?: number;
         "labelForInput"?: string;
+        "onInputClearedOrNoResults"?: (event: SearchcraftAutoSearchFormCustomEvent<void>) => void;
         "onQuerySubmit"?: (event: SearchcraftAutoSearchFormCustomEvent<string>) => void;
         "placeholderValue"?: string;
         "rightToLeftOrientation"?: boolean;
@@ -377,10 +439,11 @@ declare namespace LocalJSX {
         "adInterval"?: number;
         "customStylesForResults"?: | string
     | Record<string, Record<string, string>>;
+        "documentAttributesForDisplay"?: string;
+        "fallbackElement"?: HTMLElement | null;
         "formatTime"?: boolean;
         "placeAdAtEnd"?: boolean;
         "placeAdAtStart"?: boolean;
-        "searchKeys"?: string;
     }
     interface SearchcraftButton {
         "iconElement"?: Element;
@@ -412,6 +475,10 @@ declare namespace LocalJSX {
          */
         "theme"?: 'light' | 'dark';
     }
+    interface SearchcraftFiltersList {
+        "filters"?: Array<{ label: string; value: string }>;
+        "onFiltersUpdated"?: (event: SearchcraftFiltersListCustomEvent<string[]>) => void;
+    }
     interface SearchcraftInput {
         "customStyles"?: string | Record<string, string>;
         "error"?: boolean;
@@ -423,6 +490,7 @@ declare namespace LocalJSX {
         "inputIconWidth"?: number;
         "isRequesting"?: boolean;
         "onClearInput"?: (event: SearchcraftInputCustomEvent<void>) => void;
+        "onInputKeyUp"?: (event: SearchcraftInputCustomEvent<string>) => void;
         "onSearchInputChange"?: (event: SearchcraftInputCustomEvent<string>) => void;
         "placeholderValue"?: string;
         "query"?: string;
@@ -450,6 +518,8 @@ declare namespace LocalJSX {
         "inputLabelClassName"?: string;
         "label"?: string;
     }
+    interface SearchcraftResultsInfo {
+    }
     interface SearchcraftSearchIconSet {
         "height"?: number;
         /**
@@ -458,10 +528,20 @@ declare namespace LocalJSX {
         "type"?: 'search-light' | 'search-dark' | 'error-light' | 'error-dark';
         "width"?: number;
     }
+    interface SearchcraftSlider {
+        "maxYear"?: number;
+        "minYear"?: number;
+    }
     interface SearchcraftSpinnerDark {
     }
     interface SearchcraftSpinnerLight {
     }
+    interface SearchcraftToggleButton {
+        /**
+          * Type of the toggle - determines what it controls 'mode': toggles between 'fuzzy' and 'normal' 'sort': toggles between 'asc' and 'desc'
+         */
+        "type"?: 'mode' | 'sort';
+    }
     interface IntrinsicElements {
         "searchcraft-auto-search-form": SearchcraftAutoSearchForm;
         "searchcraft-base-search-form": SearchcraftBaseSearchForm;
@@ -472,13 +552,17 @@ declare namespace LocalJSX {
         "searchcraft-clear-icon-set": SearchcraftClearIconSet;
         "searchcraft-clear-input-button": SearchcraftClearInputButton;
         "searchcraft-error-message": SearchcraftErrorMessage;
+        "searchcraft-filters-list": SearchcraftFiltersList;
         "searchcraft-input": SearchcraftInput;
         "searchcraft-input-caption": SearchcraftInputCaption;
         "searchcraft-input-icon": SearchcraftInputIcon;
         "searchcraft-input-label": SearchcraftInputLabel;
+        "searchcraft-results-info": SearchcraftResultsInfo;
         "searchcraft-search-icon-set": SearchcraftSearchIconSet;
+        "searchcraft-slider": SearchcraftSlider;
         "searchcraft-spinner-dark": SearchcraftSpinnerDark;
         "searchcraft-spinner-light": SearchcraftSpinnerLight;
+        "searchcraft-toggle-button": SearchcraftToggleButton;
     }
 }
 export { LocalJSX as JSX };
@@ -494,13 +578,17 @@ declare module "@stencil/core" {
             "searchcraft-clear-icon-set": LocalJSX.SearchcraftClearIconSet & JSXBase.HTMLAttributes<HTMLSearchcraftClearIconSetElement>;
             "searchcraft-clear-input-button": LocalJSX.SearchcraftClearInputButton & JSXBase.HTMLAttributes<HTMLSearchcraftClearInputButtonElement>;
             "searchcraft-error-message": LocalJSX.SearchcraftErrorMessage & JSXBase.HTMLAttributes<HTMLSearchcraftErrorMessageElement>;
+            "searchcraft-filters-list": LocalJSX.SearchcraftFiltersList & JSXBase.HTMLAttributes<HTMLSearchcraftFiltersListElement>;
             "searchcraft-input": LocalJSX.SearchcraftInput & JSXBase.HTMLAttributes<HTMLSearchcraftInputElement>;
             "searchcraft-input-caption": LocalJSX.SearchcraftInputCaption & JSXBase.HTMLAttributes<HTMLSearchcraftInputCaptionElement>;
             "searchcraft-input-icon": LocalJSX.SearchcraftInputIcon & JSXBase.HTMLAttributes<HTMLSearchcraftInputIconElement>;
             "searchcraft-input-label": LocalJSX.SearchcraftInputLabel & JSXBase.HTMLAttributes<HTMLSearchcraftInputLabelElement>;
+            "searchcraft-results-info": LocalJSX.SearchcraftResultsInfo & JSXBase.HTMLAttributes<HTMLSearchcraftResultsInfoElement>;
             "searchcraft-search-icon-set": LocalJSX.SearchcraftSearchIconSet & JSXBase.HTMLAttributes<HTMLSearchcraftSearchIconSetElement>;
+            "searchcraft-slider": LocalJSX.SearchcraftSlider & JSXBase.HTMLAttributes<HTMLSearchcraftSliderElement>;
             "searchcraft-spinner-dark": LocalJSX.SearchcraftSpinnerDark & JSXBase.HTMLAttributes<HTMLSearchcraftSpinnerDarkElement>;
             "searchcraft-spinner-light": LocalJSX.SearchcraftSpinnerLight & JSXBase.HTMLAttributes<HTMLSearchcraftSpinnerLightElement>;
+            "searchcraft-toggle-button": LocalJSX.SearchcraftToggleButton & JSXBase.HTMLAttributes<HTMLSearchcraftToggleButtonElement>;
         }
     }
 }

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

@@ -1,18 +1,30 @@
-import { type CoreSDK as SearchcraftCore, type SearchcraftResponse } from '@searchcraft/core';
+import { type CoreSDK as SearchcraftCore, type SearchcraftResponse, type Facets } from '@searchcraft/core';
+interface ThemeState {
+    theme: 'light' | 'dark';
+    toggleTheme: () => void;
+}
+interface SearchParams {
+    mode: 'fuzzy' | 'normal';
+    sort: 'asc' | 'desc';
+    yearsRange?: [number, number];
+}
 interface SearchcraftState {
     query: string;
     isRequesting: boolean;
     searchResults: SearchcraftResponse | null;
+    facets: Facets | null;
+    selectedFilters: string[];
+    searchParams: SearchParams;
     setQuery: (query: string) => void;
     setSearchResults: (results: SearchcraftResponse | null) => void;
+    setFacets: (facets: Facets) => void;
+    setSelectedFilters: (filters: string[]) => void;
     setIsRequesting: (isRequesting: boolean) => void;
+    setSearchParams: (params: Partial<SearchParams>) => void;
+    setYearsRange: (yearsRange: [number, number]) => void;
     search: () => Promise<void>;
     initialize: (searchcraft: SearchcraftCore, debug?: boolean) => void;
 }
-interface ThemeState {
-    theme: 'light' | 'dark';
-    toggleTheme: () => void;
-}
 declare const useSearchcraftStore: import("zustand").UseBoundStore<import("zustand").StoreApi<SearchcraftState>>;
 declare const useThemeStore: import("zustand").UseBoundStore<import("zustand").StoreApi<ThemeState>>;
 export { useSearchcraftStore, useThemeStore };

package/dist/types/utils/utils.d.ts

@@ -1,4 +1,4 @@
 export declare function parseCustomStyles(styles: string | Record<string, string>): Record<string, string>;
-export declare function parseSearchKeys(searchKeys: string): string[];
+export declare function parseSearchKeys(documentAttributesForDisplay: string): string[];
 export declare function extractDynamicProperties(document: Record<string, string | number>, keys: string[]): Record<string, string | number>;
 export declare function serializeStyles(styles: Record<string, Record<string, string>>): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@searchcraft/javascript-sdk",
   "private": false,
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "Searchcraft Javascript SDK",
   "author": "Searchcraft",
   "license": "Apache-2.0",