diff --git a/packages/snap-client/docs/classes/Client.html b/packages/snap-client/docs/classes/Client.html index f271cd0fb..311626579 100644 --- a/packages/snap-client/docs/classes/Client.html +++ b/packages/snap-client/docs/classes/Client.html @@ -1,4 +1,4 @@ -Client | @searchspring/snap-client

Class Client

Constructors

constructor +Client | @searchspring/snap-client

Class Client

Constructors

constructor

Properties

config globals mode @@ -9,4 +9,4 @@ recommend search trending -

Constructors

constructor

Properties

Private config

config: ClientConfig

Private globals

globals: ClientGlobals

Private mode

mode: AppMode = AppMode.production

Private requesters

requesters: {
    autocomplete: HybridAPI;
    finder: HybridAPI;
    meta: HybridAPI;
    recommend: RecommendAPI;
    search: HybridAPI;
    suggest: SuggestAPI;
}

Type declaration

  • autocomplete: HybridAPI
  • finder: HybridAPI
  • meta: HybridAPI
  • recommend: RecommendAPI
  • search: HybridAPI
  • suggest: SuggestAPI

Methods

autocomplete

  • autocomplete(params?): Promise<[MetaResponseModel, AutocompleteResponseModel]>

  • Parameters

    • params: AutocompleteRequestModel = {}

    Returns Promise<[MetaResponseModel, AutocompleteResponseModel]>

finder

  • finder(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

meta

  • meta(params?): Promise<MetaResponseModel>

  • Parameters

    • Optional params: MetaRequestModel

    Returns Promise<MetaResponseModel>

recommend

search

  • search(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

trending

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private config

config: ClientConfig

Private globals

globals: ClientGlobals

Private mode

mode: AppMode = AppMode.production

Private requesters

requesters: {
    autocomplete: HybridAPI;
    finder: HybridAPI;
    meta: HybridAPI;
    recommend: RecommendAPI;
    search: HybridAPI;
    suggest: SuggestAPI;
}

Type declaration

  • autocomplete: HybridAPI
  • finder: HybridAPI
  • meta: HybridAPI
  • recommend: RecommendAPI
  • search: HybridAPI
  • suggest: SuggestAPI

Methods

autocomplete

  • autocomplete(params?): Promise<[MetaResponseModel, AutocompleteResponseModel]>

  • Parameters

    • params: AutocompleteRequestModel = {}

    Returns Promise<[MetaResponseModel, AutocompleteResponseModel]>

finder

  • finder(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

meta

  • meta(params?): Promise<MetaResponseModel>

  • Parameters

    • Optional params: MetaRequestModel

    Returns Promise<MetaResponseModel>

recommend

search

  • search(params?): Promise<[MetaResponseModel, SearchResponseModel]>

  • Parameters

    • params: SearchRequestModel = {}

    Returns Promise<[MetaResponseModel, SearchResponseModel]>

trending

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/ClientConfig.html b/packages/snap-client/docs/types/ClientConfig.html index effcb3e30..6aebd8d49 100644 --- a/packages/snap-client/docs/types/ClientConfig.html +++ b/packages/snap-client/docs/types/ClientConfig.html @@ -1 +1 @@ -ClientConfig | @searchspring/snap-client

Type alias ClientConfig

ClientConfig: {
    autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    };
    fetchApi?: WindowOrWorkerGlobalScope["fetch"];
    finder?: RequesterConfig<SearchRequestModel>;
    meta?: RequesterConfig<MetaRequestModel>;
    mode?: keyof typeof AppMode | AppMode;
    recommend?: RequesterConfig<RecommendRequestModel>;
    search?: RequesterConfig<SearchRequestModel>;
    suggest?: RequesterConfig<SuggestRequestModel>;
}

Type declaration

  • Optional autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    }
  • Optional fetchApi?: WindowOrWorkerGlobalScope["fetch"]
  • Optional finder?: RequesterConfig<SearchRequestModel>
  • Optional meta?: RequesterConfig<MetaRequestModel>
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional recommend?: RequesterConfig<RecommendRequestModel>
  • Optional search?: RequesterConfig<SearchRequestModel>
  • Optional suggest?: RequesterConfig<SuggestRequestModel>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ClientConfig | @searchspring/snap-client

Type alias ClientConfig

ClientConfig: {
    autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    };
    fetchApi?: WindowOrWorkerGlobalScope["fetch"];
    finder?: RequesterConfig<SearchRequestModel>;
    meta?: RequesterConfig<MetaRequestModel>;
    mode?: keyof typeof AppMode | AppMode;
    recommend?: RequesterConfig<RecommendRequestModel>;
    search?: RequesterConfig<SearchRequestModel>;
    suggest?: RequesterConfig<SuggestRequestModel>;
}

Type declaration

  • Optional autocomplete?: RequesterConfig<AutocompleteRequestModel> & {
        requesters?: HybridRequesterConfig;
    }
  • Optional fetchApi?: WindowOrWorkerGlobalScope["fetch"]
  • Optional finder?: RequesterConfig<SearchRequestModel>
  • Optional meta?: RequesterConfig<MetaRequestModel>
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional recommend?: RequesterConfig<RecommendRequestModel>
  • Optional search?: RequesterConfig<SearchRequestModel>
  • Optional suggest?: RequesterConfig<SuggestRequestModel>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/ClientGlobals.html b/packages/snap-client/docs/types/ClientGlobals.html index 11598b1fe..8df64a0ea 100644 --- a/packages/snap-client/docs/types/ClientGlobals.html +++ b/packages/snap-client/docs/types/ClientGlobals.html @@ -1 +1 @@ -ClientGlobals | @searchspring/snap-client

Type alias ClientGlobals

ClientGlobals: GenericGlobals & {
    siteId: string;
}

Type declaration

  • siteId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ClientGlobals | @searchspring/snap-client

Type alias ClientGlobals

ClientGlobals: GenericGlobals & {
    siteId: string;
}

Type declaration

  • siteId: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/RecommendCombinedRequestModel.html b/packages/snap-client/docs/types/RecommendCombinedRequestModel.html index 521e236d6..fcf5e6847 100644 --- a/packages/snap-client/docs/types/RecommendCombinedRequestModel.html +++ b/packages/snap-client/docs/types/RecommendCombinedRequestModel.html @@ -1 +1 @@ -RecommendCombinedRequestModel | @searchspring/snap-client

Type alias RecommendCombinedRequestModel

RecommendCombinedRequestModel: {
    blockedItems?: string[];
    branch?: string;
    brands?: string[];
    cart?: string[];
    categories?: string[];
    filters?: RecommendationRequestFilterModel[];
    lastViewed?: string[];
    product?: string;
    products?: string[];
    shopper?: string;
    siteId: string;
    tag: string;
    test?: boolean;
}

Type declaration

  • Optional blockedItems?: string[]
  • Optional branch?: string
  • Optional brands?: string[]
  • Optional cart?: string[]
  • Optional categories?: string[]
  • Optional filters?: RecommendationRequestFilterModel[]
  • Optional lastViewed?: string[]
  • Optional product?: string
  • Optional products?: string[]
  • Optional shopper?: string
  • siteId: string
  • tag: string
  • Optional test?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendCombinedRequestModel | @searchspring/snap-client

Type alias RecommendCombinedRequestModel

RecommendCombinedRequestModel: {
    blockedItems?: string[];
    branch?: string;
    brands?: string[];
    cart?: string[];
    categories?: string[];
    filters?: RecommendationRequestFilterModel[];
    lastViewed?: string[];
    product?: string;
    products?: string[];
    shopper?: string;
    siteId: string;
    tag: string;
    test?: boolean;
}

Type declaration

  • Optional blockedItems?: string[]
  • Optional branch?: string
  • Optional brands?: string[]
  • Optional cart?: string[]
  • Optional categories?: string[]
  • Optional filters?: RecommendationRequestFilterModel[]
  • Optional lastViewed?: string[]
  • Optional product?: string
  • Optional products?: string[]
  • Optional shopper?: string
  • siteId: string
  • tag: string
  • Optional test?: boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/RecommendCombinedResponseModel.html b/packages/snap-client/docs/types/RecommendCombinedResponseModel.html index fb5f339a5..9b59d276e 100644 --- a/packages/snap-client/docs/types/RecommendCombinedResponseModel.html +++ b/packages/snap-client/docs/types/RecommendCombinedResponseModel.html @@ -1 +1 @@ -RecommendCombinedResponseModel | @searchspring/snap-client

Type alias RecommendCombinedResponseModel

RecommendCombinedResponseModel: ProfileResponseModel & {
    results: SearchResponseModelResult[];
} & {
    meta: MetaResponseModel;
}

Type declaration

  • results: SearchResponseModelResult[]

Type declaration

  • meta: MetaResponseModel

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendCombinedResponseModel | @searchspring/snap-client

Type alias RecommendCombinedResponseModel

RecommendCombinedResponseModel: ProfileResponseModel & {
    results: SearchResponseModelResult[];
} & {
    meta: MetaResponseModel;
}

Type declaration

  • results: SearchResponseModelResult[]

Type declaration

  • meta: MetaResponseModel

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-client/docs/types/TrendingResponseModel.html b/packages/snap-client/docs/types/TrendingResponseModel.html index 73bbe35fe..817930cde 100644 --- a/packages/snap-client/docs/types/TrendingResponseModel.html +++ b/packages/snap-client/docs/types/TrendingResponseModel.html @@ -1 +1 @@ -TrendingResponseModel | @searchspring/snap-client

Type alias TrendingResponseModel

TrendingResponseModel: {
    trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    };
}

Type declaration

  • trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    }
    • queries: {
          popularity: number;
          searchQuery: string;
      }[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +TrendingResponseModel | @searchspring/snap-client

Type alias TrendingResponseModel

TrendingResponseModel: {
    trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    };
}

Type declaration

  • trending: {
        queries: {
            popularity: number;
            searchQuery: string;
        }[];
    }
    • queries: {
          popularity: number;
          searchQuery: string;
      }[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/AbstractController.html b/packages/snap-controller/docs/classes/AbstractController.html index 493cd4313..734c964f2 100644 --- a/packages/snap-controller/docs/classes/AbstractController.html +++ b/packages/snap-controller/docs/classes/AbstractController.html @@ -1,4 +1,4 @@ -AbstractController | @searchspring/snap-controller

Class AbstractControllerAbstract

Hierarchy (view full)

Constructors

constructor +AbstractController | @searchspring/snap-controller

Class AbstractControllerAbstract

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -22,4 +22,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: ControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: AbstractStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: string = 'abstract'

urlManager

urlManager: UrlManager

Accessors

initialized

Methods

addTargeter

createTargeter

  • createTargeter(target, onTarget, document?): undefined | DomTargeter

  • Parameters

    • target: Target
    • onTarget: OnTarget
    • Optional document: Document

    Returns undefined | DomTargeter

handleError

  • handleError(err, details?): void

  • Parameters

    • err: unknown
    • Optional details: {
          [any: string]: unknown;
      }
      • [any: string]: unknown

    Returns void

init

on

plugin

retarget

Abstract search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: ControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: AbstractStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: string = 'abstract'

urlManager

urlManager: UrlManager

Accessors

initialized

Methods

addTargeter

createTargeter

  • createTargeter(target, onTarget, document?): undefined | DomTargeter

  • Parameters

    • target: Target
    • onTarget: OnTarget
    • Optional document: Document

    Returns undefined | DomTargeter

handleError

  • handleError(err, details?): void

  • Parameters

    • err: unknown
    • Optional details: {
          [any: string]: unknown;
      }
      • [any: string]: unknown

    Returns void

init

on

plugin

retarget

Abstract search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/AutocompleteController.html b/packages/snap-controller/docs/classes/AutocompleteController.html index e32defdc7..baad8a41c 100644 --- a/packages/snap-controller/docs/classes/AutocompleteController.html +++ b/packages/snap-controller/docs/classes/AutocompleteController.html @@ -1,4 +1,4 @@ -AutocompleteController | @searchspring/snap-controller

Class AutocompleteController

Hierarchy (view full)

Constructors

constructor +AutocompleteController | @searchspring/snap-controller

Class AutocompleteController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -31,4 +31,4 @@ setFocused unbind use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: AutocompleteControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

handlers

handlers: {
    document: {
        click: ((e) => void);
    };
    input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    };
} = ...

Type declaration

  • document: {
        click: ((e) => void);
    }
    • click: ((e) => void)
        • (e): void

        • Parameters

          • e: MouseEvent

          Returns void

  • input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    }
    • enterKey: ((e) => Promise<undefined | boolean>)
        • (e): Promise<undefined | boolean>

        • Parameters

          • e: KeyboardEvent

          Returns Promise<undefined | boolean>

    • escKey: ((e) => void)
        • (e): void

        • Parameters

          • e: KeyboardEvent

          Returns void

    • focus: ((e) => void)
        • (e): void

        • Parameters

          • e: FocusEvent

          Returns void

    • formElementChange: ((e) => void)
        • (e): void

        • Parameters

          • e: ChangeEvent<HTMLInputElement>

          Returns void

    • formSubmit: ((e) => Promise<void>)
        • (e): Promise<void>

        • Parameters

          • e: FormEvent<HTMLInputElement>

          Returns Promise<void>

    • input: ((e) => void)
        • (e): void

        • Parameters

          • e: Event

          Returns void

    • timeoutDelay: undefined | Timeout

id

id: string

log

log: Logger

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: AutocompleteStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: AutocompleteTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.autocomplete

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

bind

createTargeter

handleError

init

on

plugin

reset

retarget

search

searchTrending

setFocused

unbind

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: AutocompleteControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

handlers

handlers: {
    document: {
        click: ((e) => void);
    };
    input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    };
} = ...

Type declaration

  • document: {
        click: ((e) => void);
    }
    • click: ((e) => void)
        • (e): void

        • Parameters

          • e: MouseEvent

          Returns void

  • input: {
        enterKey: ((e) => Promise<undefined | boolean>);
        escKey: ((e) => void);
        focus: ((e) => void);
        formElementChange: ((e) => void);
        formSubmit: ((e) => Promise<void>);
        input: ((e) => void);
        timeoutDelay: undefined | Timeout;
    }
    • enterKey: ((e) => Promise<undefined | boolean>)
        • (e): Promise<undefined | boolean>

        • Parameters

          • e: KeyboardEvent

          Returns Promise<undefined | boolean>

    • escKey: ((e) => void)
        • (e): void

        • Parameters

          • e: KeyboardEvent

          Returns void

    • focus: ((e) => void)
        • (e): void

        • Parameters

          • e: FocusEvent

          Returns void

    • formElementChange: ((e) => void)
        • (e): void

        • Parameters

          • e: ChangeEvent<HTMLInputElement>

          Returns void

    • formSubmit: ((e) => Promise<void>)
        • (e): Promise<void>

        • Parameters

          • e: FormEvent<HTMLInputElement>

          Returns Promise<void>

    • input: ((e) => void)
        • (e): void

        • Parameters

          • e: Event

          Returns void

    • timeoutDelay: undefined | Timeout

id

id: string

log

log: Logger

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: AutocompleteStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: AutocompleteTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.autocomplete

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

bind

createTargeter

handleError

init

on

plugin

reset

retarget

search

searchTrending

setFocused

unbind

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/FinderController.html b/packages/snap-controller/docs/classes/FinderController.html index aad8c1bae..24643d6e8 100644 --- a/packages/snap-controller/docs/classes/FinderController.html +++ b/packages/snap-controller/docs/classes/FinderController.html @@ -1,4 +1,4 @@ -FinderController | @searchspring/snap-controller

Class FinderController

Hierarchy (view full)

Constructors

constructor +FinderController | @searchspring/snap-controller

Class FinderController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -25,4 +25,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: FinderControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: FinderStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.finder

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

find

handleError

init

on

plugin

reset

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: FinderControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: FinderStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.finder

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

find

handleError

init

on

plugin

reset

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/RecommendationController.html b/packages/snap-controller/docs/classes/RecommendationController.html index 9e7053a88..736f4a2ca 100644 --- a/packages/snap-controller/docs/classes/RecommendationController.html +++ b/packages/snap-controller/docs/classes/RecommendationController.html @@ -1,4 +1,4 @@ -RecommendationController | @searchspring/snap-controller

Class RecommendationController

Hierarchy (view full)

Constructors

constructor +RecommendationController | @searchspring/snap-controller

Class RecommendationController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -25,4 +25,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: RecommendationControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

events

events: {
    click?: BeaconEvent;
    impression?: BeaconEvent;
    product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>;
    render?: BeaconEvent;
} = ...

Type declaration

  • Optional click?: BeaconEvent
  • Optional impression?: BeaconEvent
  • Optional product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>
  • Optional render?: BeaconEvent

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: RecommendationStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: RecommendationTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.recommendation

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: RecommendationControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

events

events: {
    click?: BeaconEvent;
    impression?: BeaconEvent;
    product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>;
    render?: BeaconEvent;
} = ...

Type declaration

  • Optional click?: BeaconEvent
  • Optional impression?: BeaconEvent
  • Optional product?: Record<string, {
        impression?: BeaconEvent;
        render?: BeaconEvent;
    }>
  • Optional render?: BeaconEvent

id

id: string

log

log: Logger

profiler

profiler: Profiler

store

store: RecommendationStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: RecommendationTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.recommendation

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/classes/SearchController.html b/packages/snap-controller/docs/classes/SearchController.html index cb21dbce3..153a78d0d 100644 --- a/packages/snap-controller/docs/classes/SearchController.html +++ b/packages/snap-controller/docs/classes/SearchController.html @@ -1,4 +1,4 @@ -SearchController | @searchspring/snap-controller

Class SearchController

Hierarchy (view full)

Constructors

constructor +SearchController | @searchspring/snap-controller

Class SearchController

Hierarchy (view full)

Constructors

constructor

Properties

_initialized client config @@ -26,4 +26,4 @@ retarget search use -

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: SearchControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

Private previousResults

previousResults: SearchResponseModelResult[] = []

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: SearchStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: SearchTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.search

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Protected _initialized

_initialized: boolean = false

client

client: Client

config

config: SearchControllerConfig

context

context: ContextVariables

eventManager

eventManager: EventManager

id

id: string

log

log: Logger

Private previousResults

previousResults: SearchResponseModelResult[] = []

profiler

profiler: Profiler

storage

storage: StorageStore

store

store: SearchStore

targeters

targeters: {
    [key: string]: DomTargeter;
} = {}

Type declaration

  • [key: string]: DomTargeter

track

track: SearchTrackMethods = ...

tracker

tracker: Tracker

type

type: ControllerTypes = ControllerTypes.search

urlManager

urlManager: UrlManager

Accessors

initialized

params

Methods

addTargeter

createTargeter

handleError

init

on

plugin

retarget

search

use

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/enums/ControllerTypes.html b/packages/snap-controller/docs/enums/ControllerTypes.html index b2319871d..a2f5d56a1 100644 --- a/packages/snap-controller/docs/enums/ControllerTypes.html +++ b/packages/snap-controller/docs/enums/ControllerTypes.html @@ -1,5 +1,5 @@ -ControllerTypes | @searchspring/snap-controller

Enumeration ControllerTypes

Enumeration Members

autocomplete +ControllerTypes | @searchspring/snap-controller

Enumeration ControllerTypes

Enumeration Members

autocomplete finder recommendation search -

Enumeration Members

autocomplete

autocomplete: "autocomplete"

finder

finder: "finder"

recommendation

recommendation: "recommendation"

search

search: "search"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

autocomplete

autocomplete: "autocomplete"

finder

finder: "finder"

recommendation

recommendation: "recommendation"

search

search: "search"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AfterSearchObj.html b/packages/snap-controller/docs/types/AfterSearchObj.html index 27165cb49..c71f202d7 100644 --- a/packages/snap-controller/docs/types/AfterSearchObj.html +++ b/packages/snap-controller/docs/types/AfterSearchObj.html @@ -1 +1 @@ -AfterSearchObj | @searchspring/snap-controller

Type alias AfterSearchObj

AfterSearchObj: {
    controller: AbstractController;
    request: SearchRequestModel;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AfterSearchObj | @searchspring/snap-controller

Type alias AfterSearchObj

AfterSearchObj: {
    controller: AbstractController;
    request: SearchRequestModel;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AfterStoreObj.html b/packages/snap-controller/docs/types/AfterStoreObj.html index 62ac439ce..729831a67 100644 --- a/packages/snap-controller/docs/types/AfterStoreObj.html +++ b/packages/snap-controller/docs/types/AfterStoreObj.html @@ -1 +1 @@ -AfterStoreObj | @searchspring/snap-controller

Type alias AfterStoreObj

AfterStoreObj: {
    controller: AbstractController;
    request: any;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AfterStoreObj | @searchspring/snap-controller

Type alias AfterStoreObj

AfterStoreObj: {
    controller: AbstractController;
    request: any;
    response: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/Attachments.html b/packages/snap-controller/docs/types/Attachments.html index 916fff86b..d01fc8fb1 100644 --- a/packages/snap-controller/docs/types/Attachments.html +++ b/packages/snap-controller/docs/types/Attachments.html @@ -1 +1 @@ -Attachments | @searchspring/snap-controller

Type alias Attachments

Attachments: {
    middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    };
    plugins?: PluginGrouping[];
    [any: string]: unknown;
}

Type declaration

  • [any: string]: unknown
  • Optional middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    }
    • [eventName: string]: Middleware<any> | Middleware<any>[]
  • Optional plugins?: PluginGrouping[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Attachments | @searchspring/snap-controller

Type alias Attachments

Attachments: {
    middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    };
    plugins?: PluginGrouping[];
    [any: string]: unknown;
}

Type declaration

  • [any: string]: unknown
  • Optional middleware?: {
        [eventName: string]: Middleware<any> | Middleware<any>[];
    }
    • [eventName: string]: Middleware<any> | Middleware<any>[]
  • Optional plugins?: PluginGrouping[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/AutocompleteControllerConfig.html b/packages/snap-controller/docs/types/AutocompleteControllerConfig.html index 7841112d0..b6fe8d7ca 100644 --- a/packages/snap-controller/docs/types/AutocompleteControllerConfig.html +++ b/packages/snap-controller/docs/types/AutocompleteControllerConfig.html @@ -1 +1 @@ -AutocompleteControllerConfig | @searchspring/snap-controller

Type alias AutocompleteControllerConfig

AutocompleteControllerConfig: ControllerConfig & AutocompleteStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +AutocompleteControllerConfig | @searchspring/snap-controller

Type alias AutocompleteControllerConfig

AutocompleteControllerConfig: ControllerConfig & AutocompleteStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/BeforeSearchObj.html b/packages/snap-controller/docs/types/BeforeSearchObj.html index 1e840d6be..846a3b16d 100644 --- a/packages/snap-controller/docs/types/BeforeSearchObj.html +++ b/packages/snap-controller/docs/types/BeforeSearchObj.html @@ -1 +1 @@ -BeforeSearchObj | @searchspring/snap-controller

Type alias BeforeSearchObj

BeforeSearchObj: {
    controller: AbstractController;
    request: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +BeforeSearchObj | @searchspring/snap-controller

Type alias BeforeSearchObj

BeforeSearchObj: {
    controller: AbstractController;
    request: any;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ContextVariables.html b/packages/snap-controller/docs/types/ContextVariables.html index bf3a9efd9..225477752 100644 --- a/packages/snap-controller/docs/types/ContextVariables.html +++ b/packages/snap-controller/docs/types/ContextVariables.html @@ -1 +1 @@ -ContextVariables | @searchspring/snap-controller

Type alias ContextVariables

ContextVariables: {
    shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    };
    [variable: string]: any;
}

Type declaration

  • [variable: string]: any
  • Optional shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    }
    • [variable: string]: any
    • Optional cart?: ProductViewEvent[]
    • id: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ContextVariables | @searchspring/snap-controller

Type alias ContextVariables

ContextVariables: {
    shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    };
    [variable: string]: any;
}

Type declaration

  • [variable: string]: any
  • Optional shopper?: {
        cart?: ProductViewEvent[];
        id: string;
        [variable: string]: any;
    }
    • [variable: string]: any
    • Optional cart?: ProductViewEvent[]
    • id: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerConfig.html b/packages/snap-controller/docs/types/ControllerConfig.html index 2f92cb599..d402a1907 100644 --- a/packages/snap-controller/docs/types/ControllerConfig.html +++ b/packages/snap-controller/docs/types/ControllerConfig.html @@ -1 +1 @@ -ControllerConfig | @searchspring/snap-controller

Type alias ControllerConfig

ControllerConfig: StoreConfig & Attachments

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerConfig | @searchspring/snap-controller

Type alias ControllerConfig

ControllerConfig: StoreConfig & Attachments

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerConfigs.html b/packages/snap-controller/docs/types/ControllerConfigs.html index 328765dc9..3ba0a81b5 100644 --- a/packages/snap-controller/docs/types/ControllerConfigs.html +++ b/packages/snap-controller/docs/types/ControllerConfigs.html @@ -1 +1 @@ -ControllerConfigs | @searchspring/snap-controller

Type alias ControllerConfigs

ControllerConfigs: SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerConfigs | @searchspring/snap-controller

Type alias ControllerConfigs

ControllerConfigs: SearchControllerConfig | AutocompleteControllerConfig | FinderControllerConfig | RecommendationControllerConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ControllerServices.html b/packages/snap-controller/docs/types/ControllerServices.html index ff99c5a21..bc660b04e 100644 --- a/packages/snap-controller/docs/types/ControllerServices.html +++ b/packages/snap-controller/docs/types/ControllerServices.html @@ -1 +1 @@ -ControllerServices | @searchspring/snap-controller

Type alias ControllerServices

ControllerServices: {
    client: Client;
    eventManager: EventManager;
    logger: Logger;
    profiler: Profiler;
    store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore;
    tracker: Tracker;
    urlManager: UrlManager;
}

Type declaration

  • client: Client
  • eventManager: EventManager
  • logger: Logger
  • profiler: Profiler
  • store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore
  • tracker: Tracker
  • urlManager: UrlManager

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ControllerServices | @searchspring/snap-controller

Type alias ControllerServices

ControllerServices: {
    client: Client;
    eventManager: EventManager;
    logger: Logger;
    profiler: Profiler;
    store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore;
    tracker: Tracker;
    urlManager: UrlManager;
}

Type declaration

  • client: Client
  • eventManager: EventManager
  • logger: Logger
  • profiler: Profiler
  • store: SearchStore | AutocompleteStore | FinderStore | RecommendationStore
  • tracker: Tracker
  • urlManager: UrlManager

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/Controllers.html b/packages/snap-controller/docs/types/Controllers.html index 2d010df04..feb4c1f86 100644 --- a/packages/snap-controller/docs/types/Controllers.html +++ b/packages/snap-controller/docs/types/Controllers.html @@ -1 +1 @@ -Controllers | @searchspring/snap-controller

Type alias Controllers

Controllers: SearchController | AutocompleteController | FinderController | RecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Controllers | @searchspring/snap-controller

Type alias Controllers

Controllers: SearchController | AutocompleteController | FinderController | RecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/ElementPositionObj.html b/packages/snap-controller/docs/types/ElementPositionObj.html index c8ec02475..89e5aa070 100644 --- a/packages/snap-controller/docs/types/ElementPositionObj.html +++ b/packages/snap-controller/docs/types/ElementPositionObj.html @@ -1 +1 @@ -ElementPositionObj | @searchspring/snap-controller

Type alias ElementPositionObj

ElementPositionObj: {
    domRect?: DOMRect;
    href?: string;
    selector?: string;
}

Type declaration

  • Optional domRect?: DOMRect
  • Optional href?: string
  • Optional selector?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +ElementPositionObj | @searchspring/snap-controller

Type alias ElementPositionObj

ElementPositionObj: {
    domRect?: DOMRect;
    href?: string;
    selector?: string;
}

Type declaration

  • Optional domRect?: DOMRect
  • Optional href?: string
  • Optional selector?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/FinderControllerConfig.html b/packages/snap-controller/docs/types/FinderControllerConfig.html index 3fad3dd7e..489feec3e 100644 --- a/packages/snap-controller/docs/types/FinderControllerConfig.html +++ b/packages/snap-controller/docs/types/FinderControllerConfig.html @@ -1 +1 @@ -FinderControllerConfig | @searchspring/snap-controller

Type alias FinderControllerConfig

FinderControllerConfig: ControllerConfig & FinderStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +FinderControllerConfig | @searchspring/snap-controller

Type alias FinderControllerConfig

FinderControllerConfig: ControllerConfig & FinderStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/PluginFunction.html b/packages/snap-controller/docs/types/PluginFunction.html index 10d08d13a..7855c1627 100644 --- a/packages/snap-controller/docs/types/PluginFunction.html +++ b/packages/snap-controller/docs/types/PluginFunction.html @@ -1 +1 @@ -PluginFunction | @searchspring/snap-controller

Type alias PluginFunction

PluginFunction: ((cntrlr, ...args) => Promise<void> | void)

Type declaration

    • (cntrlr, ...args): Promise<void> | void

    • Parameters

      Returns Promise<void> | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PluginFunction | @searchspring/snap-controller

Type alias PluginFunction

PluginFunction: ((cntrlr, ...args) => Promise<void> | void)

Type declaration

    • (cntrlr, ...args): Promise<void> | void

    • Parameters

      Returns Promise<void> | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/PluginGrouping.html b/packages/snap-controller/docs/types/PluginGrouping.html index 4d7a50da6..25cbb765f 100644 --- a/packages/snap-controller/docs/types/PluginGrouping.html +++ b/packages/snap-controller/docs/types/PluginGrouping.html @@ -1 +1 @@ -PluginGrouping | @searchspring/snap-controller

Type alias PluginGrouping

PluginGrouping: [func: PluginFunction, args: unknown[]]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +PluginGrouping | @searchspring/snap-controller

Type alias PluginGrouping

PluginGrouping: [func: PluginFunction, args: unknown[]]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/RecommendationControllerConfig.html b/packages/snap-controller/docs/types/RecommendationControllerConfig.html index 61f0a3207..adbcdf8d9 100644 --- a/packages/snap-controller/docs/types/RecommendationControllerConfig.html +++ b/packages/snap-controller/docs/types/RecommendationControllerConfig.html @@ -1 +1 @@ -RecommendationControllerConfig | @searchspring/snap-controller

Type alias RecommendationControllerConfig

RecommendationControllerConfig: ControllerConfig & RecommendationStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RecommendationControllerConfig | @searchspring/snap-controller

Type alias RecommendationControllerConfig

RecommendationControllerConfig: ControllerConfig & RecommendationStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/RestorePositionObj.html b/packages/snap-controller/docs/types/RestorePositionObj.html index 4cb5aa66e..2e16607d6 100644 --- a/packages/snap-controller/docs/types/RestorePositionObj.html +++ b/packages/snap-controller/docs/types/RestorePositionObj.html @@ -1 +1 @@ -RestorePositionObj | @searchspring/snap-controller

Type alias RestorePositionObj

RestorePositionObj: {
    controller: AbstractController;
    element?: ElementPositionObj;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +RestorePositionObj | @searchspring/snap-controller

Type alias RestorePositionObj

RestorePositionObj: {
    controller: AbstractController;
    element?: ElementPositionObj;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/types/SearchControllerConfig.html b/packages/snap-controller/docs/types/SearchControllerConfig.html index 906f32eaf..edc00d217 100644 --- a/packages/snap-controller/docs/types/SearchControllerConfig.html +++ b/packages/snap-controller/docs/types/SearchControllerConfig.html @@ -1 +1 @@ -SearchControllerConfig | @searchspring/snap-controller

Type alias SearchControllerConfig

SearchControllerConfig: ControllerConfig & SearchStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SearchControllerConfig | @searchspring/snap-controller

Type alias SearchControllerConfig

SearchControllerConfig: ControllerConfig & SearchStoreConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-controller/docs/variables/INPUT_DELAY.html b/packages/snap-controller/docs/variables/INPUT_DELAY.html index c2dd4e0e3..be0fa735e 100644 --- a/packages/snap-controller/docs/variables/INPUT_DELAY.html +++ b/packages/snap-controller/docs/variables/INPUT_DELAY.html @@ -1 +1 @@ -INPUT_DELAY | @searchspring/snap-controller

Variable INPUT_DELAYConst

INPUT_DELAY: 200 = 200

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +INPUT_DELAY | @searchspring/snap-controller

Variable INPUT_DELAYConst

INPUT_DELAY: 200 = 200

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/classes/EventManager.html b/packages/snap-event-manager/docs/classes/EventManager.html index aa35278e6..04428cd4a 100644 --- a/packages/snap-event-manager/docs/classes/EventManager.html +++ b/packages/snap-event-manager/docs/classes/EventManager.html @@ -1,5 +1,5 @@ -EventManager | @searchspring/snap-event-manager

Class EventManager

Constructors

constructor +EventManager | @searchspring/snap-event-manager

Class EventManager

Constructors

constructor

Properties

events

Methods

fire on -

Constructors

constructor

Properties

events

events: Record<string, MiddlewareManager<any>> = {}

Methods

fire

  • fire<T>(event, context?): Promise<void>

  • Type Parameters

    • T

    Parameters

    • event: string
    • Optional context: T

    Returns Promise<void>

on

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

events

events: Record<string, MiddlewareManager<any>> = {}

Methods

fire

  • fire<T>(event, context?): Promise<void>

  • Type Parameters

    • T

    Parameters

    • event: string
    • Optional context: T

    Returns Promise<void>

on

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Callback.html b/packages/snap-event-manager/docs/types/Callback.html index 8b3d63867..94e2f839a 100644 --- a/packages/snap-event-manager/docs/types/Callback.html +++ b/packages/snap-event-manager/docs/types/Callback.html @@ -1 +1 @@ -Callback | @searchspring/snap-event-manager

Type alias Callback

Callback: ((cancel) => void)

Type declaration

    • (cancel): void

    • Parameters

      • cancel: boolean | void

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Callback | @searchspring/snap-event-manager

Type alias Callback

Callback: ((cancel) => void)

Type declaration

    • (cancel): void

    • Parameters

      • cancel: boolean | void

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Middleware.html b/packages/snap-event-manager/docs/types/Middleware.html index 9cda1a2d8..09a98b34c 100644 --- a/packages/snap-event-manager/docs/types/Middleware.html +++ b/packages/snap-event-manager/docs/types/Middleware.html @@ -1 +1 @@ -Middleware | @searchspring/snap-event-manager

Type alias Middleware<T>

Middleware<T>: ((context, next) => Promise<boolean | void> | boolean | void)

Type Parameters

  • T

Type declaration

    • (context, next): Promise<boolean | void> | boolean | void

    • Parameters

      Returns Promise<boolean | void> | boolean | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Middleware | @searchspring/snap-event-manager

Type alias Middleware<T>

Middleware<T>: ((context, next) => Promise<boolean | void> | boolean | void)

Type Parameters

  • T

Type declaration

    • (context, next): Promise<boolean | void> | boolean | void

    • Parameters

      Returns Promise<boolean | void> | boolean | void

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-event-manager/docs/types/Next.html b/packages/snap-event-manager/docs/types/Next.html index 57c8568c8..7641c1887 100644 --- a/packages/snap-event-manager/docs/types/Next.html +++ b/packages/snap-event-manager/docs/types/Next.html @@ -1 +1 @@ -Next | @searchspring/snap-event-manager

Type alias Next

Next: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Next | @searchspring/snap-event-manager

Type alias Next

Next: (() => void | Promise<void>)

Type declaration

    • (): void | Promise<void>

    • Returns void | Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/classes/Logger.html b/packages/snap-logger/docs/classes/Logger.html index 15b6766a1..84039169f 100644 --- a/packages/snap-logger/docs/classes/Logger.html +++ b/packages/snap-logger/docs/classes/Logger.html @@ -1,4 +1,4 @@ -Logger | @searchspring/snap-logger

Class Logger

Constructors

constructor +Logger | @searchspring/snap-logger

Class Logger

Constructors

constructor

Properties

colors emoji mode @@ -11,4 +11,4 @@ profile setNamespace warn -

Constructors

constructor

Properties

colors

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = colors

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

emoji

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = emoji

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Private mode

mode: AppMode = AppMode.production

Private prefix

prefix: string = ''

Methods

debug

  • debug(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

dev

  • dev(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

error

  • error(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

image

  • image(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          height: string | number;
          url: string;
          width: string | number;
      }
      • height: string | number
      • url: string
      • width: string | number
    • Rest ...params: any[]

    Returns void

imageText

  • imageText(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          style: string;
          text: string;
          url: string;
      }
      • style: string
      • text: string
      • url: string
    • Rest ...params: any[]

    Returns void

profile

  • profile(profile, ...params): void

  • Parameters

    • profile: any
    • Rest ...params: any[]

    Returns void

setNamespace

  • setNamespace(group): void

  • Parameters

    • group: string

    Returns void

warn

  • warn(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

colors

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = colors

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

emoji

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = emoji

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Private mode

mode: AppMode = AppMode.production

Private prefix

prefix: string = ''

Methods

debug

  • debug(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

dev

  • dev(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

error

  • error(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

image

  • image(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          height: string | number;
          url: string;
          width: string | number;
      }
      • height: string | number
      • url: string
      • width: string | number
    • Rest ...params: any[]

    Returns void

imageText

  • imageText(__namedParameters, ...params): void

  • Parameters

    • __namedParameters: {
          style: string;
          text: string;
          url: string;
      }
      • style: string
      • text: string
      • url: string
    • Rest ...params: any[]

    Returns void

profile

  • profile(profile, ...params): void

  • Parameters

    • profile: any
    • Rest ...params: any[]

    Returns void

setNamespace

  • setNamespace(group): void

  • Parameters

    • group: string

    Returns void

warn

  • warn(...params): void

  • Parameters

    • Rest ...params: any[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/types/LoggerConfig.html b/packages/snap-logger/docs/types/LoggerConfig.html index a9d5637ed..7f455e076 100644 --- a/packages/snap-logger/docs/types/LoggerConfig.html +++ b/packages/snap-logger/docs/types/LoggerConfig.html @@ -1 +1 @@ -LoggerConfig | @searchspring/snap-logger

Type alias LoggerConfig

LoggerConfig: {
    mode?: keyof typeof AppMode | AppMode;
    prefix?: string;
}

Type declaration

  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional prefix?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +LoggerConfig | @searchspring/snap-logger

Type alias LoggerConfig

LoggerConfig: {
    mode?: keyof typeof AppMode | AppMode;
    prefix?: string;
}

Type declaration

  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional prefix?: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/variables/colors.html b/packages/snap-logger/docs/variables/colors.html index fd8926ed5..c1b93e56f 100644 --- a/packages/snap-logger/docs/variables/colors.html +++ b/packages/snap-logger/docs/variables/colors.html @@ -1 +1 @@ -colors | @searchspring/snap-logger

Variable colorsConst

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = ...

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +colors | @searchspring/snap-logger

Variable colorsConst

colors: {
    blue: string;
    bluedark: string;
    bluegreen: string;
    bluelight: string;
    green: string;
    greenblue: string;
    greendark: string;
    grey: string;
    indigo: string;
    orange: string;
    orangedark: string;
    orangelight: string;
    red: string;
    reddark: string;
    redlight: string;
    yellow: string;
} = ...

Type declaration

  • blue: string
  • bluedark: string
  • bluegreen: string
  • bluelight: string
  • green: string
  • greenblue: string
  • greendark: string
  • grey: string
  • indigo: string
  • orange: string
  • orangedark: string
  • orangelight: string
  • red: string
  • reddark: string
  • redlight: string
  • yellow: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-logger/docs/variables/emoji.html b/packages/snap-logger/docs/variables/emoji.html index 0636c77cd..9b9572b00 100644 --- a/packages/snap-logger/docs/variables/emoji.html +++ b/packages/snap-logger/docs/variables/emoji.html @@ -1 +1 @@ -emoji | @searchspring/snap-logger

Variable emojiConst

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = ...

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +emoji | @searchspring/snap-logger

Variable emojiConst

emoji: {
    bang: string;
    bright: string;
    check: string;
    clock: string;
    cloud: string;
    dim: string;
    gear: string;
    interobang: string;
    lightning: string;
    magic: string;
    rocket: string;
    search: string;
    snap: string;
    ufo: string;
    vortex: string;
    warning: string;
} = ...

Type declaration

  • bang: string
  • bright: string
  • check: string
  • clock: string
  • cloud: string
  • dim: string
  • gear: string
  • interobang: string
  • lightning: string
  • magic: string
  • rocket: string
  • search: string
  • snap: string
  • ufo: string
  • vortex: string
  • warning: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact-components/docs/iframe.html b/packages/snap-preact-components/docs/iframe.html index 3ed148066..43bb1fcb0 100644 --- a/packages/snap-preact-components/docs/iframe.html +++ b/packages/snap-preact-components/docs/iframe.html @@ -348,4 +348,4 @@ - window['STORIES'] = [{"titlePrefix":"","directory":"./src","files":"**/*.stories.mdx","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.mdx)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.@(js|jsx|ts|tsx)","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|jsx|ts|tsx))$"}]; \ No newline at end of file + window['STORIES'] = [{"titlePrefix":"","directory":"./src","files":"**/*.stories.mdx","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.mdx)$"},{"titlePrefix":"","directory":"./src","files":"**/*.stories.@(js|jsx|ts|tsx)","importPathMatcher":"^\\.[\\\\/](?:src(?:\\/(?!\\.)(?:(?:(?!(?:^|\\/)\\.).)*?)\\/|\\/|$)(?!\\.)(?=.)[^/]*?\\.stories\\.(js|jsx|ts|tsx))$"}]; \ No newline at end of file diff --git a/packages/snap-preact-components/docs/main.5a850b51.iframe.bundle.js b/packages/snap-preact-components/docs/main.e66028ee.iframe.bundle.js similarity index 99% rename from packages/snap-preact-components/docs/main.5a850b51.iframe.bundle.js rename to packages/snap-preact-components/docs/main.e66028ee.iframe.bundle.js index 3478d9ac2..48be415c5 100644 --- a/packages/snap-preact-components/docs/main.5a850b51.iframe.bundle.js +++ b/packages/snap-preact-components/docs/main.e66028ee.iframe.bundle.js @@ -1,4 +1,4 @@ -/*! For license information please see main.5a850b51.iframe.bundle.js.LICENSE.txt */ +/*! For license information please see main.e66028ee.iframe.bundle.js.LICENSE.txt */ (self.webpackChunk_searchspring_snap_preact_components = self.webpackChunk_searchspring_snap_preact_components || []).push([ [792], { @@ -43765,14 +43765,18 @@ config = arguments.length > 1 && void 0 !== arguments[1] ? arguments[1] : this.config; try { var options = []; - (this.data = variantData.map(function (variant) { - return ( - Object.keys(variant.options).forEach(function (variantOption) { - options.includes(variantOption) || options.push(variantOption); - }), - new Variant(variant) - ); - })), + (this.data = variantData + .filter(function (variant) { + return !1 !== variant.attributes.available; + }) + .map(function (variant) { + return ( + Object.keys(variant.options).forEach(function (variantOption) { + options.includes(variantOption) || options.push(variantOption); + }), + new Variant(variant) + ); + })), (this.selections = []), options.map(function (option) { var _this2$config, @@ -43902,7 +43906,9 @@ selectedSelections = variants.selections.filter(function (selection) { return selection.field != _this5.field && selection.selected; }), - availableVariants = variants.data, + availableVariants = variants.data.filter(function (variant) { + return variant.available; + }), _loop2 = function _loop2(selectedSelection) { availableVariants = availableVariants.filter(function (variant) { var _selectedSelection$se2; @@ -48801,7 +48807,7 @@ (this.event = payload.event), (this.id = payload.id), (this.pid = payload.pid), - (this.meta = { initiator: { lib: 'searchspring/snap', 'lib.version': '0.56.4', 'lib.framework': config.framework } }), + (this.meta = { initiator: { lib: 'searchspring/snap', 'lib.version': '0.56.5', 'lib.framework': config.framework } }), (this.id = (0, v4.A)()); }); function Tracker_toConsumableArray(arr) { @@ -49316,7 +49322,7 @@ website: { trackingCode: this.globals.siteId }, }), (null !== (_window$searchspring = window.searchspring) && void 0 !== _window$searchspring && _window$searchspring.tracker) || - ((window.searchspring = window.searchspring || {}), (window.searchspring.tracker = this), (window.searchspring.version = '0.56.4')), + ((window.searchspring = window.searchspring || {}), (window.searchspring.tracker = this), (window.searchspring.version = '0.56.5')), setTimeout(function () { _this.targeters.push( new DomTargeter([{ selector: 'script[type^="searchspring/track/"]', emptyTarget: !1 }], function (target, elem) { diff --git a/packages/snap-preact-components/docs/main.5a850b51.iframe.bundle.js.LICENSE.txt b/packages/snap-preact-components/docs/main.e66028ee.iframe.bundle.js.LICENSE.txt similarity index 100% rename from packages/snap-preact-components/docs/main.5a850b51.iframe.bundle.js.LICENSE.txt rename to packages/snap-preact-components/docs/main.e66028ee.iframe.bundle.js.LICENSE.txt diff --git a/packages/snap-preact/docs/classes/Snap.html b/packages/snap-preact/docs/classes/Snap.html index e8492a331..450efd5af 100644 --- a/packages/snap-preact/docs/classes/Snap.html +++ b/packages/snap-preact/docs/classes/Snap.html @@ -1,4 +1,4 @@ -Snap | @searchspring/snap-preact

Class Snap

Constructors

constructor +Snap | @searchspring/snap-preact

Class Snap

Constructors

constructor

Properties

_controllerPromises _instantiatorPromises client @@ -15,4 +15,4 @@ getController getControllers getInstantiator -

Constructors

constructor

Properties

Private _controllerPromises

_controllerPromises: {
    [controllerConfigId: string]: Promise<Controllers>;
} = {}

Type declaration

  • [controllerConfigId: string]: Promise<Controllers>

Private _instantiatorPromises

_instantiatorPromises: {
    [instantiatorId: string]: Promise<RecommendationInstantiator>;
} = {}

Type declaration

  • [instantiatorId: string]: Promise<RecommendationInstantiator>

client

client: Client

Private config

config: SnapConfig

context

context: ContextVariables

controllers

controllers: {
    [controllerConfigId: string]: Controllers;
} = {}

Type declaration

  • [controllerConfigId: string]: Controllers

eventManager

eventManager: EventManager

handlers

handlers: {
    error: ((event) => void);
} = ...

Type declaration

  • error: ((event) => void)
      • (event): void

      • Parameters

        • event: ErrorEvent

        Returns void

logger

logger: Logger

Private mode

mode: AppMode = AppMode.production

tracker

tracker: Tracker

Methods

Private _createController

  • _createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((cntrlr) => void | Promise<void>)
        • (cntrlr): void | Promise<void>

        • Parameters

          • cntrlr: Controllers

          Returns void | Promise<void>

    Returns Promise<Controllers>

createController

  • createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((value?) => void | Promise<void>)
        • (value?): void | Promise<void>

        • Parameters

          • Optional value: Controllers | PromiseLike<Controllers>

          Returns void | Promise<void>

    Returns Promise<Controllers>

getController

getControllers

  • getControllers(...controllerIds): Promise<Controllers[]>

  • Parameters

    • Rest ...controllerIds: string[]

    Returns Promise<Controllers[]>

getInstantiator

  • getInstantiator(id): Promise<RecommendationInstantiator>

  • Parameters

    • id: string

    Returns Promise<RecommendationInstantiator>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private _controllerPromises

_controllerPromises: {
    [controllerConfigId: string]: Promise<Controllers>;
} = {}

Type declaration

  • [controllerConfigId: string]: Promise<Controllers>

Private _instantiatorPromises

_instantiatorPromises: {
    [instantiatorId: string]: Promise<RecommendationInstantiator>;
} = {}

Type declaration

  • [instantiatorId: string]: Promise<RecommendationInstantiator>

client

client: Client

Private config

config: SnapConfig

context

context: ContextVariables

controllers

controllers: {
    [controllerConfigId: string]: Controllers;
} = {}

Type declaration

  • [controllerConfigId: string]: Controllers

eventManager

eventManager: EventManager

handlers

handlers: {
    error: ((event) => void);
} = ...

Type declaration

  • error: ((event) => void)
      • (event): void

      • Parameters

        • event: ErrorEvent

        Returns void

logger

logger: Logger

Private mode

mode: AppMode = AppMode.production

tracker

tracker: Tracker

Methods

Private _createController

  • _createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((cntrlr) => void | Promise<void>)
        • (cntrlr): void | Promise<void>

        • Parameters

          • cntrlr: Controllers

          Returns void | Promise<void>

    Returns Promise<Controllers>

createController

  • createController(type, config, services?, urlConfig?, context?, callback?): Promise<Controllers>

  • Parameters

    • type: "search" | "autocomplete" | "finder" | "recommendation"
    • config: ControllerConfigs
    • Optional services: SnapControllerServices
    • Optional urlConfig: Partial<{
          parameters: Partial<{
              core: Partial<{
                  fallbackQuery: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  filter: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  oq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  page: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  pageSize: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  query: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  rq: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  sort: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
                  tag: Partial<{
                      name: string;
                      type: Partial<(...) | (...)>;
                  }>;
              }>;
              custom: Partial<{}>;
          }>;
          settings: Partial<{
              corePrefix: string;
              coreType?: Partial<undefined | "query" | "hash">;
              customType: Partial<"query" | "hash">;
              serializeUrlRoot: Partial<boolean>;
          }>;
          urlRoot: string;
      }>
    • Optional context: ContextVariables
    • Optional callback: ((value?) => void | Promise<void>)
        • (value?): void | Promise<void>

        • Parameters

          • Optional value: Controllers | PromiseLike<Controllers>

          Returns void | Promise<void>

    Returns Promise<Controllers>

getController

getControllers

  • getControllers(...controllerIds): Promise<Controllers[]>

  • Parameters

    • Rest ...controllerIds: string[]

    Returns Promise<Controllers[]>

getInstantiator

  • getInstantiator(id): Promise<RecommendationInstantiator>

  • Parameters

    • id: string

    Returns Promise<RecommendationInstantiator>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createAutocompleteController.html b/packages/snap-preact/docs/functions/createAutocompleteController.html index 5a356689f..2498bc893 100644 --- a/packages/snap-preact/docs/functions/createAutocompleteController.html +++ b/packages/snap-preact/docs/functions/createAutocompleteController.html @@ -1 +1 @@ -createAutocompleteController | @searchspring/snap-preact

Function createAutocompleteController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createAutocompleteController | @searchspring/snap-preact

Function createAutocompleteController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createFinderController.html b/packages/snap-preact/docs/functions/createFinderController.html index 7eefec762..96e0240ce 100644 --- a/packages/snap-preact/docs/functions/createFinderController.html +++ b/packages/snap-preact/docs/functions/createFinderController.html @@ -1 +1 @@ -createFinderController | @searchspring/snap-preact

Function createFinderController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createFinderController | @searchspring/snap-preact

Function createFinderController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createRecommendationController.html b/packages/snap-preact/docs/functions/createRecommendationController.html index e4bfc4acc..845ff0af0 100644 --- a/packages/snap-preact/docs/functions/createRecommendationController.html +++ b/packages/snap-preact/docs/functions/createRecommendationController.html @@ -1 +1 @@ -createRecommendationController | @searchspring/snap-preact

Function createRecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createRecommendationController | @searchspring/snap-preact

Function createRecommendationController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/functions/createSearchController.html b/packages/snap-preact/docs/functions/createSearchController.html index e4c1960ce..b76244cc5 100644 --- a/packages/snap-preact/docs/functions/createSearchController.html +++ b/packages/snap-preact/docs/functions/createSearchController.html @@ -1 +1 @@ -createSearchController | @searchspring/snap-preact

Function createSearchController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +createSearchController | @searchspring/snap-preact

Function createSearchController

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/types/SnapConfig.html b/packages/snap-preact/docs/types/SnapConfig.html index dff72d3d9..1761e954f 100644 --- a/packages/snap-preact/docs/types/SnapConfig.html +++ b/packages/snap-preact/docs/types/SnapConfig.html @@ -1 +1 @@ -SnapConfig | @searchspring/snap-preact

Type alias SnapConfig

SnapConfig: {
    client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    };
    context?: ContextVariables;
    controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    };
    features?: SnapFeatures;
    instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    };
    mode?: keyof typeof AppMode | AppMode;
    tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    };
    url?: UrlTranslatorConfig;
}

Type declaration

  • Optional client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    }
    • Optional config?: ClientConfig
    • Optional globals?: Partial<ClientGlobals>
  • Optional context?: ContextVariables
  • Optional controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    }
    • Optional autocomplete?: {
          config: AutocompleteControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional finder?: {
          config: FinderControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional recommendation?: {
          config: RecommendationControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional search?: {
          config: SearchControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig & {
              initial?: InitialUrlConfig;
          };
      }[]
  • Optional features?: SnapFeatures
  • Optional instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    }
    • Optional recommendation?: RecommendationInstantiatorConfig
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    }
    • Optional config?: TrackerConfig
    • Optional globals?: TrackerGlobals
  • Optional url?: UrlTranslatorConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +SnapConfig | @searchspring/snap-preact

Type alias SnapConfig

SnapConfig: {
    client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    };
    context?: ContextVariables;
    controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    };
    features?: SnapFeatures;
    instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    };
    mode?: keyof typeof AppMode | AppMode;
    tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    };
    url?: UrlTranslatorConfig;
}

Type declaration

  • Optional client?: {
        config?: ClientConfig;
        globals?: Partial<ClientGlobals>;
    }
    • Optional config?: ClientConfig
    • Optional globals?: Partial<ClientGlobals>
  • Optional context?: ContextVariables
  • Optional controllers?: {
        autocomplete?: {
            config: AutocompleteControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        finder?: {
            config: FinderControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        recommendation?: {
            config: RecommendationControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig;
        }[];
        search?: {
            config: SearchControllerConfig;
            context?: ContextVariables;
            services?: SnapControllerServices;
            targeters?: ExtendedTarget[];
            url?: UrlTranslatorConfig & {
                initial?: InitialUrlConfig;
            };
        }[];
    }
    • Optional autocomplete?: {
          config: AutocompleteControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional finder?: {
          config: FinderControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional recommendation?: {
          config: RecommendationControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig;
      }[]
    • Optional search?: {
          config: SearchControllerConfig;
          context?: ContextVariables;
          services?: SnapControllerServices;
          targeters?: ExtendedTarget[];
          url?: UrlTranslatorConfig & {
              initial?: InitialUrlConfig;
          };
      }[]
  • Optional features?: SnapFeatures
  • Optional instantiators?: {
        recommendation?: RecommendationInstantiatorConfig;
    }
    • Optional recommendation?: RecommendationInstantiatorConfig
  • Optional mode?: keyof typeof AppMode | AppMode
  • Optional tracker?: {
        config?: TrackerConfig;
        globals?: TrackerGlobals;
    }
    • Optional config?: TrackerConfig
    • Optional globals?: TrackerGlobals
  • Optional url?: UrlTranslatorConfig

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-preact/docs/variables/polyfills.html b/packages/snap-preact/docs/variables/polyfills.html index 3e2c38ee2..1a09f05bb 100644 --- a/packages/snap-preact/docs/variables/polyfills.html +++ b/packages/snap-preact/docs/variables/polyfills.html @@ -1 +1 @@ -polyfills | @searchspring/snap-preact

Variable polyfillsConst

polyfills: Promise<void> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +polyfills | @searchspring/snap-preact

Variable polyfillsConst

polyfills: Promise<void> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-profiler/docs/classes/Profiler.html b/packages/snap-profiler/docs/classes/Profiler.html index 3e7cee83b..ab6305f4d 100644 --- a/packages/snap-profiler/docs/classes/Profiler.html +++ b/packages/snap-profiler/docs/classes/Profiler.html @@ -1,6 +1,6 @@ -Profiler | @searchspring/snap-profiler

Class Profiler

Constructors

constructor +Profiler | @searchspring/snap-profiler

Class Profiler

Constructors

constructor

Properties

namespace profiles

Methods

create setNamespace -

Constructors

constructor

Properties

namespace

namespace: string

profiles

profiles: Profile<any>[]

Methods

create

  • create<T>(__namedParameters): Profile<T>

  • Type Parameters

    • T

    Parameters

    • __namedParameters: ProfileDetails<T>

    Returns Profile<T>

setNamespace

  • setNamespace(namespace): void

  • Parameters

    • namespace: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

namespace

namespace: string

profiles

profiles: Profile<any>[]

Methods

create

  • create<T>(__namedParameters): Profile<T>

  • Type Parameters

    • T

    Parameters

    • __namedParameters: ProfileDetails<T>

    Returns Profile<T>

setNamespace

  • setNamespace(namespace): void

  • Parameters

    • namespace: string

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/AbstractStore.html b/packages/snap-store-mobx/docs/classes/AbstractStore.html index 6f92da36b..f5b1b210f 100644 --- a/packages/snap-store-mobx/docs/classes/AbstractStore.html +++ b/packages/snap-store-mobx/docs/classes/AbstractStore.html @@ -1,4 +1,4 @@ -AbstractStore | @searchspring/snap-store-mobx

Class AbstractStoreAbstract

Hierarchy (view full)

Constructors

constructor +AbstractStore | @searchspring/snap-store-mobx

Class AbstractStoreAbstract

Hierarchy (view full)

Constructors

constructor

Properties

config custom error @@ -7,4 +7,4 @@

Methods

setConfig toJSON update -

Constructors

constructor

Properties

config

config: StoreConfigs

custom

custom: {} = {}

Type declaration

    error

    error: undefined | {
        code?: number;
        message?: string;
        type?: ErrorType;
    }

    Type declaration

    • Optional code?: number
    • Optional message?: string
    • Optional type?: ErrorType

    loaded

    loaded: boolean = false

    loading

    loading: boolean = false

    Methods

    setConfig

    toJSON

    Abstract update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    config

    config: StoreConfigs

    custom

    custom: {} = {}

    Type declaration

      error

      error: undefined | {
          code?: number;
          message?: string;
          type?: ErrorType;
      }

      Type declaration

      • Optional code?: number
      • Optional message?: string
      • Optional type?: ErrorType

      loaded

      loaded: boolean = false

      loading

      loading: boolean = false

      Methods

      setConfig

      toJSON

      Abstract update

      Settings

      Member Visibility

      Theme

      On This Page

      Generated using TypeDoc

      \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/AutocompleteStore.html b/packages/snap-store-mobx/docs/classes/AutocompleteStore.html index 034f1ec9e..3c248d4f9 100644 --- a/packages/snap-store-mobx/docs/classes/AutocompleteStore.html +++ b/packages/snap-store-mobx/docs/classes/AutocompleteStore.html @@ -1,4 +1,4 @@ -AutocompleteStore | @searchspring/snap-store-mobx

      Class AutocompleteStore

      Hierarchy (view full)

      Constructors

      constructor +AutocompleteStore | @searchspring/snap-store-mobx

      Class AutocompleteStore

      Hierarchy (view full)

      Constructors

      constructor

      Properties

      config custom error @@ -29,4 +29,4 @@ toJSON update updateTrendingTerms -

      Constructors

      constructor

      Properties

      config

      config: StoreConfigs

      custom

      custom: {} = {}

      Type declaration

        error

        error: undefined | {
            code?: number;
            message?: string;
            type?: ErrorType;
        }

        Type declaration

        • Optional code?: number
        • Optional message?: string
        • Optional type?: ErrorType

        facets

        facets: AutocompleteFacetStore

        filters

        filters: SearchFilterStore

        history

        history: AutocompleteHistoryStore

        loaded

        loaded: boolean = false

        loading

        loading: boolean = false

        merchandising

        merchandising: SearchMerchandisingStore

        meta

        meta: MetaStore

        pagination

        pagination: SearchPaginationStore

        results

        results: SearchResultStore

        search

        search: AutocompleteQueryStore

        services

        services: StoreServices

        sorting

        sorting: SearchSortingStore

        state

        state: AutocompleteStateStore

        storage

        storage: StorageStore

        terms

        terms: AutocompleteTermStore

        trending

        trending: AutocompleteTrendingStore

        Methods

        initHistory

        reset

        resetHistory

        resetSuggestions

        resetTerms

        resetTrending

        setConfig

        setService

        toJSON

        update

        updateTrendingTerms

        Settings

        Member Visibility

        Theme

        On This Page

        Generated using TypeDoc

        \ No newline at end of file +

        Constructors

        constructor

        Properties

        config

        config: StoreConfigs

        custom

        custom: {} = {}

        Type declaration

          error

          error: undefined | {
              code?: number;
              message?: string;
              type?: ErrorType;
          }

          Type declaration

          • Optional code?: number
          • Optional message?: string
          • Optional type?: ErrorType

          facets

          facets: AutocompleteFacetStore

          filters

          filters: SearchFilterStore

          history

          history: AutocompleteHistoryStore

          loaded

          loaded: boolean = false

          loading

          loading: boolean = false

          merchandising

          merchandising: SearchMerchandisingStore

          meta

          meta: MetaStore

          pagination

          pagination: SearchPaginationStore

          results

          results: SearchResultStore

          search

          search: AutocompleteQueryStore

          services

          services: StoreServices

          sorting

          sorting: SearchSortingStore

          state

          state: AutocompleteStateStore

          storage

          storage: StorageStore

          terms

          terms: AutocompleteTermStore

          trending

          trending: AutocompleteTrendingStore

          Methods

          initHistory

          reset

          resetHistory

          resetSuggestions

          resetTerms

          resetTrending

          setConfig

          setService

          toJSON

          update

          updateTrendingTerms

          Settings

          Member Visibility

          Theme

          On This Page

          Generated using TypeDoc

          \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Banner.html b/packages/snap-store-mobx/docs/classes/Banner.html index c4e0fe97a..1e91ae649 100644 --- a/packages/snap-store-mobx/docs/classes/Banner.html +++ b/packages/snap-store-mobx/docs/classes/Banner.html @@ -1,4 +1,4 @@ -Banner | @searchspring/snap-store-mobx

          Class Banner

          Constructors

          constructor +Banner | @searchspring/snap-store-mobx

          Class Banner

          Constructors

          constructor

          Properties

          attributes config custom @@ -6,4 +6,4 @@ mappings type value -

          Constructors

          constructor

          Properties

          attributes

          attributes: Record<string, unknown> = {}

          config

          config: SearchResponseModelMerchandisingContentConfig

          custom

          custom: {} = {}

          Type declaration

            id

            id: string

            mappings

            mappings: SearchResponseModelResultMappings = ...

            type

            type: string = 'banner'

            value

            value: string

            Settings

            Member Visibility

            Theme

            On This Page

            Generated using TypeDoc

            \ No newline at end of file +

            Constructors

            constructor

            Properties

            attributes

            attributes: Record<string, unknown> = {}

            config

            config: SearchResponseModelMerchandisingContentConfig

            custom

            custom: {} = {}

            Type declaration

              id

              id: string

              mappings

              mappings: SearchResponseModelResultMappings = ...

              type

              type: string = 'banner'

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/CartStore.html b/packages/snap-store-mobx/docs/classes/CartStore.html index 576d8ead6..a46049368 100644 --- a/packages/snap-store-mobx/docs/classes/CartStore.html +++ b/packages/snap-store-mobx/docs/classes/CartStore.html @@ -1,4 +1,4 @@ -CartStore | @searchspring/snap-store-mobx

              Class CartStore

              Constructors

              constructor +CartStore | @searchspring/snap-store-mobx

              Class CartStore

              Constructors

              constructor

              Properties

              eventManager items

              Accessors

              count @@ -8,4 +8,4 @@ on removeItems reset -

              Constructors

              constructor

              Properties

              Private eventManager

              eventManager: EventManager

              items

              items: Product[] = []

              Accessors

              count

              msrp

              price

              Methods

              addItems

              on

              removeItems

              reset

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              Private eventManager

              eventManager: EventManager

              items

              items: Product[] = []

              Accessors

              count

              msrp

              price

              Methods

              addItems

              on

              removeItems

              reset

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html b/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html index 982639c63..8d4fdc11b 100644 --- a/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetHierarchyValue.html @@ -1,4 +1,4 @@ -FacetHierarchyValue | @searchspring/snap-store-mobx

              Class FacetHierarchyValue

              Hierarchy (view full)

              Constructors

              constructor +FacetHierarchyValue | @searchspring/snap-store-mobx

              Class FacetHierarchyValue

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              count custom filtered @@ -8,4 +8,4 @@ preview? url value -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              history

              history: boolean = false

              label

              label: string

              level

              level: number = 0

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              history

              history: boolean = false

              label

              label: string

              level

              level: number = 0

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetRangeValue.html b/packages/snap-store-mobx/docs/classes/FacetRangeValue.html index d903d6d26..cacab333f 100644 --- a/packages/snap-store-mobx/docs/classes/FacetRangeValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetRangeValue.html @@ -1,4 +1,4 @@ -FacetRangeValue | @searchspring/snap-store-mobx

              Class FacetRangeValue

              Constructors

              constructor +FacetRangeValue | @searchspring/snap-store-mobx

              Class FacetRangeValue

              Constructors

              constructor

              Properties

              count custom filtered @@ -6,4 +6,4 @@ label low url -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              high

              high: number

              label

              label: string

              low

              low: number

              url

              url: UrlManager

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              high

              high: number

              label

              label: string

              low

              low: number

              url

              url: UrlManager

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FacetValue.html b/packages/snap-store-mobx/docs/classes/FacetValue.html index c97793129..8ca176a56 100644 --- a/packages/snap-store-mobx/docs/classes/FacetValue.html +++ b/packages/snap-store-mobx/docs/classes/FacetValue.html @@ -1,4 +1,4 @@ -FacetValue | @searchspring/snap-store-mobx

              Class FacetValue

              Hierarchy (view full)

              Constructors

              constructor +FacetValue | @searchspring/snap-store-mobx

              Class FacetValue

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              count custom filtered @@ -6,4 +6,4 @@ preview? url value -

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              label

              label: string

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              count

              count: number

              custom

              custom: object

              filtered

              filtered: boolean

              label

              label: string

              Optional preview

              preview?: (() => void)

              Type declaration

                • (): void

                • Returns void

              url

              url: UrlManager

              value

              value: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Filter.html b/packages/snap-store-mobx/docs/classes/Filter.html index ba89682d9..a82a4cbc1 100644 --- a/packages/snap-store-mobx/docs/classes/Filter.html +++ b/packages/snap-store-mobx/docs/classes/Filter.html @@ -1,6 +1,6 @@ -Filter | @searchspring/snap-store-mobx

              Class Filter

              Constructors

              constructor +Filter | @searchspring/snap-store-mobx

              Class Filter

              Constructors

              constructor

              Properties

              facet label url value -

              Constructors

              constructor

              Properties

              facet

              facet: {
                  field?: string;
                  label?: string;
              }

              Type declaration

              • Optional field?: string
              • Optional label?: string

              label

              label: string

              url

              url: UrlManager

              value

              value: {
                  label?: string;
                  value?: string;
              }

              Type declaration

              • Optional label?: string
              • Optional value?: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file +

              Constructors

              constructor

              Properties

              facet

              facet: {
                  field?: string;
                  label?: string;
              }

              Type declaration

              • Optional field?: string
              • Optional label?: string

              label

              label: string

              url

              url: UrlManager

              value

              value: {
                  label?: string;
                  value?: string;
              }

              Type declaration

              • Optional label?: string
              • Optional value?: string

              Settings

              Member Visibility

              Theme

              On This Page

              Generated using TypeDoc

              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/FinderStore.html b/packages/snap-store-mobx/docs/classes/FinderStore.html index 2e14701ab..455081db7 100644 --- a/packages/snap-store-mobx/docs/classes/FinderStore.html +++ b/packages/snap-store-mobx/docs/classes/FinderStore.html @@ -1,4 +1,4 @@ -FinderStore | @searchspring/snap-store-mobx

              Class FinderStore

              Hierarchy (view full)

              Constructors

              constructor +FinderStore | @searchspring/snap-store-mobx

              Class FinderStore

              Hierarchy (view full)

              Constructors

              constructor

              Properties

              config custom error @@ -18,4 +18,4 @@ setService toJSON update -

              Constructors

              constructor

              Properties

              config

              config: FinderStoreConfig

              custom

              custom: {} = {}

              Type declaration

                error

                error: undefined | {
                    code?: number;
                    message?: string;
                    type?: ErrorType;
                }

                Type declaration

                • Optional code?: number
                • Optional message?: string
                • Optional type?: ErrorType

                loaded

                loaded: boolean = false

                loading

                loading: boolean = false

                meta

                meta: MetaStore

                pagination

                pagination: SearchPaginationStore

                persistedStorage

                persistedStorage: StorageStore

                save

                save: (() => void) = ...

                Type declaration

                  • (): void

                  • Returns void

                selections

                selections: FinderSelectionStore

                services

                services: StoreServices

                state

                state: FinderStoreState = ...

                storage

                storage: StorageStore

                Methods

                loadPersisted

                reset

                setConfig

                setService

                toJSON

                update

                Settings

                Member Visibility

                Theme

                On This Page

                Generated using TypeDoc

                \ No newline at end of file +

                Constructors

                constructor

                Properties

                config

                config: FinderStoreConfig

                custom

                custom: {} = {}

                Type declaration

                  error

                  error: undefined | {
                      code?: number;
                      message?: string;
                      type?: ErrorType;
                  }

                  Type declaration

                  • Optional code?: number
                  • Optional message?: string
                  • Optional type?: ErrorType

                  loaded

                  loaded: boolean = false

                  loading

                  loading: boolean = false

                  meta

                  meta: MetaStore

                  pagination

                  pagination: SearchPaginationStore

                  persistedStorage

                  persistedStorage: StorageStore

                  save

                  save: (() => void) = ...

                  Type declaration

                    • (): void

                    • Returns void

                  selections

                  selections: FinderSelectionStore

                  services

                  services: StoreServices

                  state

                  state: FinderStoreState = ...

                  storage

                  storage: StorageStore

                  Methods

                  loadPersisted

                  reset

                  setConfig

                  setService

                  toJSON

                  update

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/MetaStore.html b/packages/snap-store-mobx/docs/classes/MetaStore.html index 7835a70df..6284dde85 100644 --- a/packages/snap-store-mobx/docs/classes/MetaStore.html +++ b/packages/snap-store-mobx/docs/classes/MetaStore.html @@ -1,4 +1,4 @@ -MetaStore | @searchspring/snap-store-mobx

                  Class MetaStore

                  Constructors

                  constructor +MetaStore | @searchspring/snap-store-mobx

                  Class MetaStore

                  Constructors

                  constructor

                  Properties

                  badges data -

                  Constructors

                  constructor

                  Properties

                  badges

                  badges: MetaBadges

                  data

                  data: MetaResponseModel

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file +

                  Constructors

                  constructor

                  Properties

                  badges

                  badges: MetaBadges

                  data

                  data: MetaResponseModel

                  Settings

                  Member Visibility

                  Theme

                  On This Page

                  Generated using TypeDoc

                  \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/Product.html b/packages/snap-store-mobx/docs/classes/Product.html index 99c35151a..fc41eb544 100644 --- a/packages/snap-store-mobx/docs/classes/Product.html +++ b/packages/snap-store-mobx/docs/classes/Product.html @@ -1,4 +1,4 @@ -Product | @searchspring/snap-store-mobx

                  Class Product

                  Constructors

                  constructor +Product | @searchspring/snap-store-mobx

                  Class Product

                  Constructors

                  constructor

                  Properties

                  attributes badges children? @@ -10,4 +10,4 @@ type variants?

                  Accessors

                  display -

                  Constructors

                  constructor

                  Properties

                  attributes

                  attributes: Record<string, unknown> = {}

                  badges

                  badges: Badges

                  Optional children

                  children?: Child[] = []

                  custom

                  custom: {} = {}

                  Type declaration

                    id

                    id: string

                    mappings

                    mappings: SearchResponseModelResultMappings = ...

                    mask

                    mask: ProductMask = ...

                    quantity

                    quantity: number = 1

                    type

                    type: string = 'product'

                    Optional variants

                    variants?: Variants

                    Accessors

                    display

                    Settings

                    Member Visibility

                    Theme

                    On This Page

                    Generated using TypeDoc

                    \ No newline at end of file +

                    Constructors

                    constructor

                    Properties

                    attributes

                    attributes: Record<string, unknown> = {}

                    badges

                    badges: Badges

                    Optional children

                    children?: Child[] = []

                    custom

                    custom: {} = {}

                    Type declaration

                      id

                      id: string

                      mappings

                      mappings: SearchResponseModelResultMappings = ...

                      mask

                      mask: ProductMask = ...

                      quantity

                      quantity: number = 1

                      type

                      type: string = 'product'

                      Optional variants

                      variants?: Variants

                      Accessors

                      display

                      Settings

                      Member Visibility

                      Theme

                      On This Page

                      Generated using TypeDoc

                      \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/RangeFacet.html b/packages/snap-store-mobx/docs/classes/RangeFacet.html index 67917bd40..36b0e62b2 100644 --- a/packages/snap-store-mobx/docs/classes/RangeFacet.html +++ b/packages/snap-store-mobx/docs/classes/RangeFacet.html @@ -1,4 +1,4 @@ -RangeFacet | @searchspring/snap-store-mobx

                      Class RangeFacet

                      Hierarchy

                      • Facet
                        • RangeFacet

                      Constructors

                      constructor +RangeFacet | @searchspring/snap-store-mobx

                      Class RangeFacet

                      Hierarchy

                      • Facet
                        • RangeFacet

                      Constructors

                      constructor

                      Properties

                      active? collapsed custom @@ -16,4 +16,4 @@

                      Accessors

                      clear filteredCount

                      Methods

                      toggleCollapse -

                      Constructors

                      constructor

                      Properties

                      Optional active

                      active?: SearchRequestModelFilterRangeAllOfValue = ...

                      collapsed

                      collapsed: boolean = false

                      custom

                      custom: {} = {}

                      Type declaration

                        display

                        display: string = ''

                        field

                        field: string

                        filtered

                        filtered: boolean = false

                        formatSeparator

                        formatSeparator: string

                        formatValue

                        formatValue: string

                        label

                        label: string = ''

                        Optional range

                        range?: SearchRequestModelFilterRangeAllOfValue = ...

                        services

                        services: StoreServices

                        Optional step

                        step?: number

                        storage

                        storage: StorageStore

                        type

                        type: string

                        Accessors

                        clear

                        filteredCount

                        Methods

                        toggleCollapse

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        Generated using TypeDoc

                        \ No newline at end of file +

                        Constructors

                        constructor

                        Properties

                        Optional active

                        active?: SearchRequestModelFilterRangeAllOfValue = ...

                        collapsed

                        collapsed: boolean = false

                        custom

                        custom: {} = {}

                        Type declaration

                          display

                          display: string = ''

                          field

                          field: string

                          filtered

                          filtered: boolean = false

                          formatSeparator

                          formatSeparator: string

                          formatValue

                          formatValue: string

                          label

                          label: string = ''

                          Optional range

                          range?: SearchRequestModelFilterRangeAllOfValue = ...

                          services

                          services: StoreServices

                          Optional step

                          step?: number

                          storage

                          storage: StorageStore

                          type

                          type: string

                          Accessors

                          clear

                          filteredCount

                          Methods

                          toggleCollapse

                          Settings

                          Member Visibility

                          Theme

                          On This Page

                          Generated using TypeDoc

                          \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/RecommendationStore.html b/packages/snap-store-mobx/docs/classes/RecommendationStore.html index 21b24c0da..2cad74c95 100644 --- a/packages/snap-store-mobx/docs/classes/RecommendationStore.html +++ b/packages/snap-store-mobx/docs/classes/RecommendationStore.html @@ -1,4 +1,4 @@ -RecommendationStore | @searchspring/snap-store-mobx

                          Class RecommendationStore

                          Hierarchy (view full)

                          Constructors

                          constructor +RecommendationStore | @searchspring/snap-store-mobx

                          Class RecommendationStore

                          Hierarchy (view full)

                          Constructors

                          constructor

                          Properties

                          cart config custom @@ -13,4 +13,4 @@ setConfig toJSON update -

                          Constructors

                          constructor

                          Properties

                          cart

                          cart: CartStore

                          config

                          config: StoreConfigs

                          custom

                          custom: {} = {}

                          Type declaration

                            error

                            error: undefined | {
                                code?: number;
                                message?: string;
                                type?: ErrorType;
                            }

                            Type declaration

                            • Optional code?: number
                            • Optional message?: string
                            • Optional type?: ErrorType

                            loaded

                            loaded: boolean = false

                            loading

                            loading: boolean = false

                            meta

                            meta: MetaStore

                            profile

                            profile: RecommendationProfileStore

                            results

                            results: Product[]

                            services

                            services: StoreServices

                            Methods

                            reset

                            setConfig

                            toJSON

                            update

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            Generated using TypeDoc

                            \ No newline at end of file +

                            Constructors

                            constructor

                            Properties

                            cart

                            cart: CartStore

                            config

                            config: StoreConfigs

                            custom

                            custom: {} = {}

                            Type declaration

                              error

                              error: undefined | {
                                  code?: number;
                                  message?: string;
                                  type?: ErrorType;
                              }

                              Type declaration

                              • Optional code?: number
                              • Optional message?: string
                              • Optional type?: ErrorType

                              loaded

                              loaded: boolean = false

                              loading

                              loading: boolean = false

                              meta

                              meta: MetaStore

                              profile

                              profile: RecommendationProfileStore

                              results

                              results: Product[]

                              services

                              services: StoreServices

                              Methods

                              reset

                              setConfig

                              toJSON

                              update

                              Settings

                              Member Visibility

                              Theme

                              On This Page

                              Generated using TypeDoc

                              \ No newline at end of file diff --git a/packages/snap-store-mobx/docs/classes/SearchFacetStore.html b/packages/snap-store-mobx/docs/classes/SearchFacetStore.html index 24e028719..26eb39aec 100644 --- a/packages/snap-store-mobx/docs/classes/SearchFacetStore.html +++ b/packages/snap-store-mobx/docs/classes/SearchFacetStore.html @@ -1,4 +1,4 @@ -SearchFacetStore | @searchspring/snap-store-mobx

                              Class SearchFacetStore

                              Hierarchy

                              • Array
                                • SearchFacetStore

                              Constructors

                              constructor +SearchFacetStore | @searchspring/snap-store-mobx

                              Class SearchFacetStore

                              Hierarchy

                              • Array
                                • SearchFacetStore

                              Constructors

                              constructor

                              Properties

                              [unscopables] length

                              Accessors

                              [species] @@ -38,13 +38,13 @@ from isArray of -

                              Constructors

                              constructor

                              Properties

                              Readonly [unscopables]

                              [unscopables]: {
                                  [unscopables]?: boolean;
                                  length?: boolean;
                                  [iterator]?: any;
                                  at?: any;
                                  concat?: any;
                                  copyWithin?: any;
                                  entries?: any;
                                  every?: any;
                                  fill?: any;
                                  filter?: any;
                                  find?: any;
                                  findIndex?: any;
                                  flat?: any;
                                  flatMap?: any;
                                  forEach?: any;
                                  includes?: any;
                                  indexOf?: any;
                                  join?: any;
                                  keys?: any;
                                  lastIndexOf?: any;
                                  map?: any;
                                  pop?: any;
                                  push?: any;
                                  reduce?: any;
                                  reduceRight?: any;
                                  reverse?: any;
                                  shift?: any;
                                  slice?: any;
                                  some?: any;
                                  sort?: any;
                                  splice?: any;
                                  toLocaleString?: any;
                                  toString?: any;
                                  unshift?: any;
                                  values?: any;
                              }

                              Is an object whose properties have the value 'true' +

                              Constructors

                              constructor

                              Properties

                              Readonly [unscopables]

                              [unscopables]: {
                                  [unscopables]?: boolean;
                                  length?: boolean;
                                  [iterator]?: any;
                                  at?: any;
                                  concat?: any;
                                  copyWithin?: any;
                                  entries?: any;
                                  every?: any;
                                  fill?: any;
                                  filter?: any;
                                  find?: any;
                                  findIndex?: any;
                                  flat?: any;
                                  flatMap?: any;
                                  forEach?: any;
                                  includes?: any;
                                  indexOf?: any;
                                  join?: any;
                                  keys?: any;
                                  lastIndexOf?: any;
                                  map?: any;
                                  pop?: any;
                                  push?: any;
                                  reduce?: any;
                                  reduceRight?: any;
                                  reverse?: any;
                                  shift?: any;
                                  slice?: any;
                                  some?: any;
                                  sort?: any;
                                  splice?: any;
                                  toLocaleString?: any;
                                  toString?: any;
                                  unshift?: any;
                                  values?: any;
                              }

                              Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

                              Type declaration

                              • Optional Readonly [unscopables]?: boolean

                                Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

                              • Optional length?: boolean

                                Gets or sets the length of the array. This is a number one higher than the highest index in the array.

                              length

                              length: number

                              Gets or sets the length of the array. This is a number one higher than the highest index in the array.

                              -

                              Accessors

                              Static [species]

                              Methods

                              [iterator]

                              • [iterator](): IterableIterator<any>

                              • Iterator

                                +

                              Accessors

                              Static [species]

                              Methods

                              [iterator]

                              • [iterator](): IterableIterator<any>

                              • Iterator

                                Returns IterableIterator<any>

                              at