@searchcraft/react-sdk 0.1.4 → 0.5.1

package/dist/index.d.ts

@@ -1,178 +1,59 @@
-import { ChangeEventHandler } from 'react';
-import { Dispatch } from 'react';
+import { Components } from '@searchcraft/javascript-sdk';
 import { FC } from 'react';
-import { ReactNode } from 'react';
-import { CoreSDK as SearchcraftCore } from '@searchcraft/core';
-import { SearchError } from '@searchcraft/core';
-import { SearchResult } from '@searchcraft/core';
-import { SetStateAction } from 'react';
-
-/**
- * * Button-less form used to submit the search query with a timing configurable debounced function.
- */
-export declare const AutoSearchForm: FC<AutoSearchFormProps>;
-
-declare interface AutoSearchFormProps {
-    autoSearchFormClass?: string;
-    handleSubmit: (query: string) => void;
-    inputCaptionValue?: string;
-    labelForInput?: string;
-    onClearInput?: () => void;
-    placeholderValue?: string;
-    rightToLeftOrientation?: boolean;
-    searchContainerClass?: string;
+
+export declare const SearchcraftBaseSearchResult: FC<SearchcraftBaseSearchResultProps>;
+
+export declare interface SearchcraftBaseSearchResultProps extends Components.SearchcraftBaseSearchResult {
 }
 
-/**
- * * Form used to submit the search query using a provided search function.
- */
-export declare const BaseSearchForm: FC<BaseSearchFormProps>;
-
-declare interface BaseSearchFormProps {
-    errorMessage?: string;
-    handleSubmit: (query: string) => void;
-    labelForInput?: string;
-    onClearInput?: () => void;
-    placeholderValue?: string;
-    rightToLeftOrientation?: boolean;
+export declare const SearchcraftBaseSearchResults: FC<SearchcraftBaseSearchResultsProps>;
+
+export declare interface SearchcraftBaseSearchResultsProps extends Components.SearchcraftBaseSearchResults {
 }
 
-export declare const BaseSearchResult: FC<BaseSearchResultProps>;
-
-declare interface BaseSearchResultProps {
-    buttonCallbackFn?: () => void;
-    buttonLabel?: string;
-    imageAltText?: string;
-    imageSrc?: string;
-    interactiveResult?: boolean;
-    callbackFn?: () => void;
-    keyDownCallbackFn?: () => void;
-    resultBodyContent?: string;
-    resultHeading?: string;
-    resultSubheading?: string;
+export declare const SearchcraftButton: FC<SearchcraftButtonProps>;
+
+export declare interface SearchcraftButtonProps extends Components.SearchcraftButton {
 }
 
-export declare const BaseSearchResults: FC;
-
-export declare const Button: FC<ButtonProps>;
-
-declare type ButtonProps = {
-    className?: string;
-    iconElement?: ReactNode;
-    iconOnly?: boolean;
-    iconPosition?: string;
-    label?: string;
-    onClick?: () => void;
-};
-
-export declare const ErrorMessage: FC<ErrorMessageProps>;
-
-declare type ErrorMessageProps = {
-    className?: string;
-    errorMessage?: string;
-};
-
-export declare const Input: FC<InputProps>;
-
-declare type InputCaptionProps = {
-    error?: boolean;
-    inputCaptionClassName?: string;
-    inputCaptionValue: string;
-    rightToLeftOrientation?: boolean;
-};
-
-export declare const InputLabel: FC<InputLabelProps>;
-
-declare type InputLabelProps = {
-    className?: string;
-    label: string;
-};
-
-declare type InputProps = {
-    error?: boolean;
-    formClassName?: string;
-    inputCaptionClassName?: string;
-    inputCaptionValue?: string;
-    inputClassName?: string;
-    onClearInput?: () => void;
-    onSearchInputChange: ChangeEventHandler<HTMLInputElement>;
-    placeholderValue?: string;
-    rightToLeftOrientation?: boolean;
-    query: string;
-};
-
-export declare interface ProviderConfigTypes {
-    index: string[];
-    apiKey: string;
-    endpointURL: string;
+export declare const SearchcraftErrorMessage: FC<SearchcraftErrorMessageProps>;
+
+export declare interface SearchcraftErrorMessageProps extends Components.SearchcraftErrorMessage {
 }
 
-/** The context provided by the Searchcraft React SDK */
-export declare interface ProviderContextTypes {
-    /**
-     * Error occurred while making a search query.
-     */
-    error: Error | null;
-    /**
-     * The db name(s) created in Vektron to query.
-     */
-    index: string[];
-    /**
-     * Value exposed when a search is in progress.
-     */
-    isRequesting: boolean;
-    /**
-     * Can be either fuzzy or normal. The default is fuzzy.
-     */
-    mode: 'fuzzy' | 'normal';
-    /**
-     * Input value given by the user to query the DB by.
-     */
-    query: string;
-    /**
-     * Setter function to update the value being sent to the SDK.
-     */
-    setQuery: Dispatch<SetStateAction<string>>;
-    /**
-     * Function for searching that requires search mode and search type.
-     */
-    search: (query: string, mode: 'fuzzy' | 'normal') => void;
-    /**
-     * Object that is returned from the Searchcraft API when a search request has resolved
-     */
-    searchResults?: SearchResult | SearchError | null;
+export declare const SearchcraftFacetList: FC<SearchcraftFacetListProps>;
+
+export declare interface SearchcraftFacetListProps extends Components.SearchcraftFacetList {
 }
 
-declare const Searchcraft: FC & {
-    AutoSearchForm: FC<AutoSearchFormProps>;
-    BaseSearchForm: FC<BaseSearchFormProps>;
-    BaseSearchResult: FC<BaseSearchResultProps>;
-    BaseSearchResults: FC;
-    Button: FC;
-    ClearInputButton: FC;
-    ErrorMessage: FC;
-    Input: FC<InputProps>;
-    InputCaption: FC<InputCaptionProps>;
-    InputIcon: FC;
-    InputLabel: FC<InputLabelProps>;
-    Provider: FC<{
-        searchcraft: SearchcraftCore;
-        debug?: boolean;
-    }>;
-};
-export default Searchcraft;
-
-export { SearchcraftCore }
-
-declare interface ThemeContextType {
-    theme: ThemeOptionType;
-    toggleTheme: () => void;
+export declare const SearchcraftFilterPanel: FC<SearchcraftFilterPanelProps>;
+
+export declare interface SearchcraftFilterPanelProps extends Components.SearchcraftFilterPanel {
 }
 
-declare type ThemeOptionType = 'light' | 'dark';
+export declare const SearchcraftInputForm: FC<SearchcraftInputFormProps>;
 
-export declare const useSearchcraft: () => ProviderContextTypes;
+export declare interface SearchcraftInputFormProps extends Components.SearchcraftInputForm {
+}
 
-export declare const useTheme: () => ThemeContextType;
+export declare const SearchcraftInputLabel: FC<SearchcraftInputLabelProps>;
+
+export declare interface SearchcraftInputLabelProps extends Components.SearchcraftInputLabel {
+}
+
+export declare const SearchcraftResultsInfo: FC<SearchcraftResultsInfoProps>;
+
+export declare interface SearchcraftResultsInfoProps extends Components.SearchcraftResultsInfo {
+}
+
+export declare const SearchcraftSlider: FC<SearchcraftSliderProps>;
+
+export declare interface SearchcraftSliderProps extends Components.SearchcraftSlider {
+}
+
+export declare const SearchcraftToggleButton: FC<SearchcraftToggleButtonProps>;
+
+export declare interface SearchcraftToggleButtonProps extends Components.SearchcraftToggleButton {
+}
 
 export { }