@storefront/flux-capacitor

Index

Modules

Enumerations

SORT_ENUMS

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Action

Action: RefreshState

GenericTransformer

GenericTransformer: function

Type declaration

- (...arg: T[]): T
- Parameters
  - Rest ...arg: T[]
  Returns T

SagaCreator

SagaCreator: function

Type declaration

- (flux: FluxCapacitor): function
- Parameters
  - flux: FluxCapacitor
  Returns function
  - - (): IterableIterator<ForkEffect>
    - Returns IterableIterator<ForkEffect>

State

State: UI

Variables

DEFAULT_AREA

DEFAULT_AREA: "Production" = "Production"

DEFAULT_COLLECTION

DEFAULT_COLLECTION: "default" = "default"

DEFAULT_PAGE_SIZE

DEFAULT_PAGE_SIZE: 10 = 10

DETAILS_CHANGE_ACTIONS

DETAILS_CHANGE_ACTIONS: string[] = [Actions.UPDATE_DETAILS,]

MAX_RECORDS

MAX_RECORDS: 10000 = 10000

PAST_PURCHASES_SEARCH_CHANGE_ACTIONS

PAST_PURCHASES_SEARCH_CHANGE_ACTIONS: string[] = [Actions.UPDATE_PAST_PURCHASE_QUERY,Actions.RESET_PAST_PURCHASE_REFINEMENTS,Actions.SELECT_PAST_PURCHASE_REFINEMENT,Actions.DESELECT_PAST_PURCHASE_REFINEMENT,Actions.SELECT_PAST_PURCHASE_SORT,Actions.UPDATE_PAST_PURCHASE_CURRENT_PAGE,Actions.UPDATE_PAST_PURCHASE_PAGE_SIZE,]

PAST_PURCHASE_SKU_ACTIONS

PAST_PURCHASE_SKU_ACTIONS: string[] = [Actions.FETCH_PAST_PURCHASE_PRODUCTS,Actions.FETCH_SAYT_PAST_PURCHASES,]

PERSONALIZATION_CHANGE_ACTIONS

PERSONALIZATION_CHANGE_ACTIONS: string[] = [Actions.SELECT_REFINEMENT,Actions.ADD_REFINEMENT,]

RECALL_CHANGE_ACTIONS

RECALL_CHANGE_ACTIONS: string[] = [Actions.RESET_REFINEMENTS,Actions.UPDATE_QUERY,Actions.ADD_REFINEMENT,Actions.SELECT_REFINEMENT,Actions.DESELECT_REFINEMENT,]

SAGA_CREATORS

SAGA_CREATORS: (Anonymous function)[] = [autocomplete,collection,productDetails,products,recommendations,refinements,]

SAVE_STATE_ACTIONS

SAVE_STATE_ACTIONS: string[] = [...SEARCH_CHANGE_ACTIONS,...PAST_PURCHASES_SEARCH_CHANGE_ACTIONS,...DETAILS_CHANGE_ACTIONS]

SEARCH_CHANGE_ACTIONS

SEARCH_CHANGE_ACTIONS: string[] = [...RECALL_CHANGE_ACTIONS,Actions.SELECT_COLLECTION,Actions.SELECT_SORT,Actions.UPDATE_PAGE_SIZE,Actions.UPDATE_CURRENT_PAGE,]

STORAGE_KEY

STORAGE_KEY: "gb-personalization" = "gb-personalization"

STORAGE_WHITELIST

STORAGE_WHITELIST: string[] = ['biasing']

UNDOABLE_ACTIONS

UNDOABLE_ACTIONS: string[] = [Actions.RECEIVE_PRODUCTS,Actions.RECEIVE_RECOMMENDATIONS_PRODUCTS,Actions.RECEIVE_COLLECTION_COUNT,Actions.RECEIVE_NAVIGATION_SORT,Actions.RECEIVE_MORE_REFINEMENTS,Actions.RECEIVE_PAST_PURCHASE_PRODUCTS,]

autocompletePastPurchaseRequest

autocompletePastPurchaseRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.autocompleteProducts, Configuration.pastPurchaseAutocompleteOverrides)

autocompleteProductsRequest

autocompleteProductsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.autocompleteProducts, Configuration.autocompleteProductsOverrides)

autocompleteSuggestionsRequest

autocompleteSuggestionsRequest: RequestBuilder<AutocompleteConfig & object, AutocompleteConfig & object> = new RequestBuilder<QueryTimeAutocompleteConfig>(RequestHelpers.autocompleteSuggestions, Configuration.autocompleteSuggestionsOverrides)

collectionRequest

collectionRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.search, Configuration.collectionOverrides)

fetch

fetch: any

pastPurchaseProductsRequest

pastPurchaseProductsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.pastPurchaseProducts, Configuration.pastPurchaseOverrides)

personalizationTransform

personalizationTransform: any = createTransform(// transform state coming from redux on its way to being serialized and storedAdapter.transformToBrowser,// configuration options (if any))

productDetailsRequest

productDetailsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.search, Configuration.detailsOverrides)

productsRequest

productsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.products, Configuration.searchOverrides)

recommendationsNavigationsRequest

recommendationsNavigationsRequest: RequestBuilder<RecommendationsBody, RecommendationsBody> = new RequestBuilder<Recommendations.RecommendationsBody>(RequestHelpers.recommendationsNavigations, Configuration.recommendationsNavigationsOverrides)

recommendationsProductIdsRequest

recommendationsProductIdsRequest: RequestBuilder<RecommendationsRequest, RecommendationsRequest> = new RequestBuilder<Recommendations.RecommendationsRequest>(RequestHelpers.recommendationsProductIDs, Configuration.recommendationsIdsOverrides)

recommendationsProductsRequest

recommendationsProductsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.search, Configuration.recommendationsProductsOverrides)

recommendationsSuggestionsRequest

recommendationsSuggestionsRequest: RequestBuilder<RecommendationsBody & object | RecommendationsRequest & object, RecommendationsBody | RecommendationsRequest> = new RequestBuilder<Recommendations.Request & { query: string }, Recommendations.Request>(RequestHelpers.recommendationsSuggestions, Configuration.recommendationsSuggestionsOverrides)

refinementsRequest

refinementsRequest: RequestBuilder<Request, Request> = new RequestBuilder<Request>(RequestHelpers.search, Configuration.refinementsOverrides)

Functions

addRefinement

addRefinement(state: State, __namedParameters: object): object

- Defined in core/reducers/data/navigations.ts:122
Parameters
- state: State
- __namedParameters: object
  - high: number
  - low: number
  - navigationId: string
  - range: boolean
  - value: string
Returns object
- byId: object
  - __computed: Object | Object

applyNavigationReducer

applyNavigationReducer(state: State, __namedParameters: object, reducer: Function): object

- Defined in core/reducers/data/past-purchases.ts:143
Parameters
- state: State
- __namedParameters: object
  - payload: string | number | true | false | ProductWithMetadata[] | Template | Page | PastPurchaseProduct[] | Navigation[] | Refinement
- reducer: Function
Returns object
- navigations: any

applyPageReducer

applyPageReducer(state: State, __namedParameters: object, reducer: Function): object

- Defined in core/reducers/data/past-purchases.ts:137
Parameters
- state: State
- __namedParameters: object
  - payload: string | number | true | false | ProductWithMetadata[] | Template | Page | PastPurchaseProduct[] | Navigation[] | Refinement
- reducer: Function
Returns object
- page: any

clearComponentState

clearComponentState(state: State): State

- Defined in core/reducers/ui.ts:41
Parameters
- state: State
Returns State

createAction

createAction<T, P>(type: T, payload?: P, validator?: object): Action<T, P>

- Defined in core/actions/utils.ts:8
Type parameters
- T: string
- P
Parameters
- type: T
- Optional payload: P
- Optional validator: object
Returns Action<T, P>

createComponentState

createComponentState(state: State, __namedParameters: object): object

- Defined in core/reducers/ui.ts:22
Parameters
- state: State
- __namedParameters: object
  - id: string
  - tagName: string
  - tagState: object
Returns object
- __computed: object
  - __computed: object

createSagas

createSagas(sagaCreators: SagaCreator[], flux: FluxCapacitor): function[]

- Defined in core/sagas/index.ts:21
Parameters
- sagaCreators: SagaCreator[]
- flux: FluxCapacitor
Returns function[]

deselectRefinement

deselectRefinement(state: State, __namedParameters: object): Indexed<Navigation> & object

- Defined in core/reducers/data/navigations.ts:86
Parameters
- state: State
- __namedParameters: object
  - navigationId: string
  - refinementIndex: number
Returns Indexed<Navigation> & object

doneFetching

doneFetching(state: State, section: string): object

- Defined in core/reducers/is-fetching.ts:51
Parameters
- state: State
- section: string
Returns object
- __computed: boolean

generateNavigation

generateNavigation(state: State, navigationId: string, refinement: any, index: number): Object | Object

- Defined in core/reducers/data/navigations.ts:103
Parameters
- state: State
- navigationId: string
- refinement: any
- index: number
Returns Object | Object

handleError

handleError(errorAction: Action<any>, actionCreator: function): any

- Defined in core/actions/utils.ts:35
Parameters
- errorAction: Action<any>
- actionCreator: function
  - - (): any
    - Returns any
Returns any

insertSorted

insertSorted(allIds: BiasKey[], __namedParameters: object): BiasKey[]

- Defined in core/reducers/data/personalization.ts:44
Parameters
- allIds: BiasKey[]
- __namedParameters: object
  - field: string
  - value: string
Returns BiasKey[]

normalizeToFunction

normalizeToFunction<T>(objOrFn: Partial<T> | GenericTransformer<T>): GenericTransformer<T>

- Defined in core/utils.ts:46
Type parameters
- T
Parameters
- objOrFn: Partial<T> | GenericTransformer<T>
Returns GenericTransformer<T>

rayify

rayify<T>(arr: T | T[]): T[]

- Defined in core/utils.ts:25
Type parameters
- T
Parameters
- arr: T | T[]
Returns T[]

receiveCount

receiveCount(state: State, __namedParameters: object): object

- Defined in core/reducers/data/collections.ts:24
Parameters
- state: State
- __namedParameters: object
  - collection: string
  - total: number
Returns object
- byId: object
  - __computed: object
    - total: number

receiveMoreRefinements

receiveMoreRefinements(state: State, __namedParameters: object): Indexed<Navigation> & object

- Defined in core/reducers/data/navigations.ts:156
Parameters
- state: State
- __namedParameters: object
  - navigationId: string
  - refinements: (ValueRefinement | RangeRefinement)[]
  - selected: number[]
Returns Indexed<Navigation> & object

receiveNavigationSort

receiveNavigationSort(state: State, sort: Navigation[]): object

- Defined in core/reducers/data/navigations.ts:177
Parameters
- state: State
- sort: Navigation[]
Returns object
- sort: Navigation[]

receiveNavigations

receiveNavigations(state: State, navigations: Navigation[]): object

- Defined in core/reducers/data/navigations.ts:56
Parameters
- state: State
- navigations: Navigation[]
Returns object
- allIds: string[]
- byId: object

receivePage

receivePage(state: State, __namedParameters: object): object

- Defined in core/reducers/data/page.ts:51
Parameters
- state: State
- __namedParameters: object
  - current: number
  - from: number
  - last: number
  - next: number
  - previous: number
  - to: number
Returns object
- current: number
- from: number
- last: number
- next: number
- previous: number
- to: number

receiveProductRecords

receiveProductRecords(state: State, products: ProductWithMetadata[]): object

- Defined in core/reducers/data/autocomplete.ts:45
Parameters
- state: State
- products: ProductWithMetadata[]
Returns object
- products: ProductWithMetadata[]

receiveQuery

receiveQuery(state: State, __namedParameters: object): object

- Defined in core/reducers/data/query.ts:25
Parameters
- state: State
- __namedParameters: object
  - corrected: string
  - didYouMean: string[]
  - original: string
  - related: string[]
  - rewrites: string[]
Returns object
- corrected: string
- didYouMean: string[]
- original: string
- related: string[]
- rewrites: string[]

receiveSuggestions

receiveSuggestions(state: State, __namedParameters: object): object

- Defined in core/reducers/data/autocomplete.ts:34
Parameters
- state: State
- __namedParameters: object
  - categoryValues: string[]
  - navigations: Navigation[]
  - suggestions: Suggestion[]
Returns object
- navigations: Navigation[]
- suggestions: Suggestion[]
- category: object
  - values: string[]

receiveTemplate

receiveTemplate(state: State, template: Template): object

- Defined in core/reducers/data/autocomplete.ts:48
Parameters
- state: State
- template: Template
Returns object
- template: Template

refinementPayload

refinementPayload(field: string, valueOrLow: any, high?: any): object | object

- Defined in core/actions/utils.ts:20
Parameters
- field: string
- valueOrLow: any
- Default value high: any = null
Returns object | object

removeComponentState

removeComponentState(state: State, __namedParameters: object): object

- Defined in core/reducers/ui.ts:31
Parameters
- state: State
- __namedParameters: object
  - id: string
  - tagName: string
Returns object
- __computed: object

resetPage

resetPage(state: State): Page

- Defined in core/reducers/data/page.ts:37
Parameters
- state: State
Returns Page

resetRefinements

resetRefinements(state: State, navigationId: boolean | string): object

- Defined in core/reducers/data/navigations.ts:33
Parameters
- state: State
- navigationId: boolean | string
Returns object
- byId: object
  - __computed: Navigation

rootReducer

rootReducer(state: any, action: any): State

- Defined in core/reducers/index.ts:27
Parameters
- state: any
- action: any
Returns State

selectRefinement

selectRefinement(state: State, __namedParameters: object): Indexed<Navigation> & object

- Defined in core/reducers/data/navigations.ts:68
Parameters
- state: State
- __namedParameters: object
  - navigationId: string
  - refinementIndex: number
Returns Indexed<Navigation> & object

shouldResetRefinements

shouldResetRefinements(__namedParameters: object, state: State): boolean

- Defined in core/actions/utils.ts:39
Parameters
- __namedParameters: object
  - high: number
  - index: number
  - low: number
  - navigationId: string
  - range: boolean
  - value: string
- state: State
Returns boolean

sortBasedOn

sortBasedOn<T, S>(toBeSorted: T[], basisArray: S[], callback?: function): T[]

- Defined in core/utils.ts:28
Type parameters
- T
- S
Parameters
- toBeSorted: T[]
- basisArray: S[]
- Optional callback: function
  - - (sorted: T, unsorted: S): boolean
    - Parameters
      - sorted: T
      - unsorted: S
      Returns boolean
Returns T[]

startFetching

startFetching(state: State, section: string): object

- Defined in core/reducers/is-fetching.ts:48
Parameters
- state: State
- section: string
Returns object
- __computed: boolean

undoWithoutHistory

undoWithoutHistory(store: any): (Anonymous function)

- Defined in core/reducers/index.ts:14
Parameters
- store: any
Returns (Anonymous function)

update

update(state: State, __namedParameters: object): object

- Defined in core/reducers/data/details.ts:20
Parameters
- state: State
- __namedParameters: object
  - data: Product
  - template: Template
Returns object
- data: Product
- template: Template

updateArea

updateArea(state?: string): string

- Defined in core/reducers/data/area.ts:5
Parameters
- Default value state: string = DEFAULT_AREA
Returns string

updateAutocomplete

updateAutocomplete(state?: State, action: Action): State

- Defined in core/reducers/data/autocomplete.ts:20
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateBiasing

updateBiasing(state: State, payload: Biasing): object

- Defined in core/reducers/data/personalization.ts:28
Parameters
- state: State
- payload: Biasing
Returns object
- biasing: object
  - allIds: BiasKey[]
  - byId: object
    - __computed: object
      - __computed: SingleBias

updateCollections

updateCollections(state?: State, action: Action): State

- Defined in core/reducers/data/collections.ts:13
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateCurrent

updateCurrent(state: State, current: number): object

- Defined in core/reducers/data/page.ts:41
Parameters
- state: State
- current: number
Returns object
- current: number

updateDetails

updateDetails(state?: State, action: Action): State

- Defined in core/reducers/data/details.ts:11
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateFetching

updateFetching(state: State, __namedParameters: object): object

- Defined in core/reducers/data/infinite-scroll.ts:20
Parameters
- state: State
- __namedParameters: object
  - isFetchingBackward: boolean
  - isFetchingForward: boolean
Returns object
- isFetchingBackward: boolean
- isFetchingForward: boolean

updateInfiniteScroll

updateInfiniteScroll(state?: State, action: Action): State

- Defined in core/reducers/data/infinite-scroll.ts:12
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateIsFetching

updateIsFetching(state?: State, action: Action): State

- Defined in core/reducers/is-fetching.ts:29
Parameters
- Default value state: State = DEFAULT_FETCHING
- action: Action
Returns State

updateIsRunning

updateIsRunning(state?: State, action: Action): State

- Defined in core/reducers/is-running.ts:7
Parameters
- Default value state: State = false
- action: Action
Returns State

updateMorePastPurchaseProducts

updateMorePastPurchaseProducts(state: State, action: ReceiveMorePastPurchaseProducts): object

- Defined in core/reducers/data/past-purchases.ts:107
Parameters
- state: State
- action: ReceiveMorePastPurchaseProducts
Returns object
- products: ProductWithMetadata[]

updateMoreProducts

updateMoreProducts(state: State, __namedParameters: object): ProductWithMetadata[]

- Defined in core/reducers/data/products.ts:16
Parameters
- state: State
- __namedParameters: object
  - payload: ProductWithMetadata[]
Returns ProductWithMetadata[]

updateNavigations

updateNavigations(state?: State, action: Action): Indexed<Navigation> & object

- Defined in core/reducers/data/navigations.ts:20
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns Indexed<Navigation> & object

updateOriginal

updateOriginal(state: State, query: string): object

- Defined in core/reducers/data/query.ts:21
Parameters
- state: State
- query: string
Returns object
- original: string

updatePage

updatePage(state?: State, action: Action): State

- Defined in core/reducers/data/page.ts:23
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updatePastPurchaseAllRecordCount

updatePastPurchaseAllRecordCount(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:123
Parameters
- state: State
- __namedParameters: object
  - payload: number
Returns object
- count: object
  - allRecordCount: number

updatePastPurchaseCurrentRecordCount

updatePastPurchaseCurrentRecordCount(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:114
Parameters
- state: State
- __namedParameters: object
  - payload: number
Returns object
- count: object
  - currentRecordCount: number

updatePastPurchaseProducts

updatePastPurchaseProducts(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:101
Parameters
- state: State
- __namedParameters: object
  - payload: ProductWithMetadata[]
Returns object
- products: ProductWithMetadata[]

updatePastPurchaseQuery

updatePastPurchaseQuery(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:152
Parameters
- state: State
- __namedParameters: object
  - payload: string
Returns object
- query: string

updatePastPurchaseSkus

updatePastPurchaseSkus(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:94
Parameters
- state: State
- __namedParameters: object
  - payload: PastPurchaseProduct[]
Returns object
- defaultSkus: PastPurchaseProduct[]
- skus: PastPurchaseProduct[]

updatePastPurchaseSortSelected

updatePastPurchaseSortSelected(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:158
Parameters
- state: State
- __namedParameters: object
  - payload: number
Returns object
- skus: PastPurchaseProduct[]
- sort: object
  - selected: number

updatePastPurchaseTemplate

updatePastPurchaseTemplate(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:180
Parameters
- state: State
- __namedParameters: object
  - payload: Template
Returns object
- template: Template

updatePastPurchases

updatePastPurchases(state?: State, action: Action): State

- Defined in core/reducers/data/past-purchases.ts:69
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updatePersonalization

updatePersonalization(state?: State, action: Action): State

- Defined in core/reducers/data/personalization.ts:21
Parameters
- Default value state: State = DEFAULT
- action: Action
Returns State

updateProducts

updateProducts(state?: State, action: Action): State

- Defined in core/reducers/data/products.ts:7
Parameters
- Default value state: State = []
- action: Action
Returns State

updateProductsLoaded

updateProductsLoaded(state?: State, action: Action): State

- Defined in core/reducers/data/productsLoaded.ts:9
Parameters
- Default value state: State = false
- action: Action
Returns State

updateQuery

updateQuery(state: State, query: string): object

- Defined in core/reducers/data/autocomplete.ts:30
Parameters
- state: State
- query: string
Returns object
- query: string

updateRecommendations

updateRecommendations(state?: State, action: Action): State

- Defined in core/reducers/data/recommendations.ts:14
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateRecommendationsProducts

updateRecommendationsProducts(state: State, __namedParameters: object): object

- Defined in core/reducers/data/recommendations.ts:21
Parameters
- state: State
- __namedParameters: object
  - payload: ProductWithMetadata[]
Returns object
- suggested: object
  - products: ProductWithMetadata[]

updateRecordCount

updateRecordCount(state?: State, action: Action): State

- Defined in core/reducers/data/record-count.ts:6
Parameters
- Default value state: State = null
- action: Action
Returns State

updateRedirect

updateRedirect(state?: State, action: Action): State

- Defined in core/reducers/data/redirect.ts:6
Parameters
- Default value state: State = null
- action: Action
Returns State

updateSaytPastPurchases

updateSaytPastPurchases(state: State, __namedParameters: object): object

- Defined in core/reducers/data/past-purchases.ts:131
Parameters
- state: State
- __namedParameters: object
  - payload: ProductWithMetadata[]
Returns object
- saytPastPurchases: ProductWithMetadata[]

updateSection

updateSection(state: State, value: any, section: string): object

- Defined in core/reducers/session.ts:45
Parameters
- state: State
- value: any
- section: string
Returns object
- __computed: any

updateSecuredPayload

updateSecuredPayload(state: any, securedPayload: SecuredPayload): any

- Defined in core/reducers/session.ts:30
Parameters
- state: any
- securedPayload: SecuredPayload
Returns any

updateSelected

updateSelected(state: State, selected: string): object
updateSelected(state: State, selected: number): object

- Defined in core/reducers/data/collections.ts:21
Parameters
- state: State
- selected: string
Returns object
- selected: string
- Defined in core/reducers/data/sorts.ts:18
Parameters
- state: State
- selected: number
Returns object
- selected: number

updateSession

updateSession(state?: State, action: Action): State

- Defined in core/reducers/session.ts:9
Parameters
- Default value state: State = {}
- action: Action
Returns State

updateSize

updateSize(state: State, size: number): Page

- Defined in core/reducers/data/page.ts:45
Parameters
- state: State
- size: number
Returns Page

updateSorts

updateSorts(state?: State, action: Action): State

- Defined in core/reducers/data/sorts.ts:11
Parameters
- Default value state: State = DEFAULTS
- action: Action
Returns State

updateState

updateState(state: State, __namedParameters: object): any

- Defined in core/reducers/index.ts:44
Parameters
- state: State
- __namedParameters: object
  - payload: any
Returns any

updateTemplate

updateTemplate(state?: State, action: Action): State

- Defined in core/reducers/data/template.ts:7
Parameters
- Default value state: State = <any>{}
- action: Action
Returns State

updateUi

updateUi(state?: State, __namedParameters: object): State

- Defined in core/reducers/ui.ts:9
Parameters
- Default value state: State = {}
- __namedParameters: object
  - meta: Metadata
  - payload: any
  - type: any
Returns State

Object literals

DEFAULT

DEFAULT: object

biasing

biasing: object

allIds

allIds: undefined[] = []

byId

byId: object

Type declaration

DEFAULTS

DEFAULTS: object = <any>{suggested: {products: []},}

allIds

allIds: undefined[] = []

current

current: number = 1

didYouMean

didYouMean: undefined[] = []

first

first: number = 1

from

from: number = 1

isFetchingBackward

isFetchingBackward: boolean = false

isFetchingForward

isFetchingForward: boolean = false

items

items: undefined[] = []

navigations

navigations: undefined[] = []

products

products: undefined[] = []

related: undefined[] = []

rewrites

rewrites: undefined[] = []

searchCharMinLimit

searchCharMinLimit: number = 1

showCategoryValuesForFirstMatch

showCategoryValuesForFirstMatch: boolean = false

sort

sort: undefined[] = []

suggestions

suggestions: undefined[] = []

template

template: any = <any>{}

byId

byId: object

__computed

__computed: object

name

name: string = DEFAULT_COLLECTION

values

values: undefined[] = []

sizes

sizes: object

items

items: number[] = [DEFAULT_PAGE_SIZE]

selected

selected: number = 0

DEFAULT_FETCHING

DEFAULT_FETCHING: object

autocompleteProducts

autocompleteProducts: boolean = false

autocompleteSuggestions

autocompleteSuggestions: boolean = false

details

details: boolean = false

moreProducts

moreProducts: boolean = false

moreRefinements

moreRefinements: boolean = false

search

search: boolean = false

Routes

Routes: object

DETAILS

DETAILS: string = "details"

NAVIGATION

NAVIGATION: string = "navigation"

PAST_PURCHASE

PAST_PURCHASE: string = "pastpurchase"

SEARCH

SEARCH: string = "search"

hasSelectedPastPurchaseRefinements

hasSelectedPastPurchaseRefinements: object

msg

msg: string = "no refinements to clear"

func

func(_: any, state: State): boolean

- Defined in core/actions/validators.ts:119
Parameters
- _: any
- state: State
Returns boolean

hasSelectedPastPurchaseRefinementsByField

hasSelectedPastPurchaseRefinementsByField: object

msg

msg: string = "no refinements to clear for field"

func

func(field: string, state: State): boolean

- Defined in core/actions/validators.ts:125
Parameters
- field: string
- state: State
Returns boolean

hasSelectedRefinements

hasSelectedRefinements: object

msg

msg: string = "no refinements to clear"

func

func(_: any, state: State): boolean

- Defined in core/actions/validators.ts:58
Parameters
- _: any
- state: State
Returns boolean

hasSelectedRefinementsByField

hasSelectedRefinementsByField: object

msg

msg: string = "no refinements to clear for field"

func

func(field: string, state: State): boolean

- Defined in core/actions/validators.ts:64
Parameters
- field: string
- state: State
Returns boolean

isCollectionDeselected

isCollectionDeselected: object

msg

msg: string = "collection is already selected"

func

func(id: string, state: State): boolean

- Defined in core/actions/validators.ts:130
Parameters
- id: string
- state: State
Returns boolean

isDifferentAutocompleteQuery

isDifferentAutocompleteQuery: object

msg

msg: string = "suggestions for query have already been requested"

func

func(query: string, state: State): boolean

- Defined in core/actions/validators.ts:155
Parameters
- query: string
- state: State
Returns boolean

isDifferentPageSize

isDifferentPageSize: object

msg

msg: string = "page size is already selected"

func

func(size: number, state: State): boolean

- Defined in core/actions/validators.ts:140
Parameters
- size: number
- state: State
Returns boolean

isDifferentPastPurchasePageSize

isDifferentPastPurchasePageSize: object

msg

msg: string = "page size is already selected"

func

func(size: number, state: State): boolean

- Defined in core/actions/validators.ts:104
Parameters
- size: number
- state: State
Returns boolean

isNotFetching

isNotFetching: object

msg

msg: string = "is already fetching"

func

func(forward: boolean, state: State): boolean

- Defined in core/actions/validators.ts:165
Parameters
- forward: boolean
- state: State
Returns boolean

isNotFullRange

isNotFullRange: object

msg

msg: string = "range must be smaller than full range"

func

func(__namedParameters: object, state: State): boolean

- Defined in core/actions/validators.ts:43
Parameters
- __namedParameters: object
  - high: number
  - low: number
  - navigationId: string
  - range: boolean
- state: State
Returns boolean

isOnDifferentPage

isOnDifferentPage: object

msg

msg: string = "page is already selected"

func

func(page: number, state: State): boolean

- Defined in core/actions/validators.ts:145
Parameters
- page: number
- state: State
Returns boolean

isOnDifferentPastPurchasePage

isOnDifferentPastPurchasePage: object

msg

msg: string = "page is already selected"

func

func(page: number, state: State): boolean

- Defined in core/actions/validators.ts:109
Parameters
- page: number
- state: State
Returns boolean

isPastPurchaseRefinementDeselectedByIndex

isPastPurchaseRefinementDeselectedByIndex: object

msg

msg: string = "navigation does not exist or refinement is already selected"

func

func(__namedParameters: object, state: State): boolean

- Defined in core/actions/validators.ts:84
Parameters
- __namedParameters: object
  - index: number
  - navigationId: string
- state: State
Returns boolean

isPastPurchaseRefinementSelectedByIndex

isPastPurchaseRefinementSelectedByIndex: object

msg

msg: string = "navigation does not exist or refinement is not selected"

func

func(__namedParameters: object, state: State): boolean

- Defined in core/actions/validators.ts:89
Parameters
- __namedParameters: object
  - index: number
  - navigationId: string
- state: State
Returns boolean

isPastPurchasesSortDeselected

isPastPurchasesSortDeselected: object

msg

msg: string = "past purchases sort is already selected"

func

func(index: number, state: State): boolean

- Defined in core/actions/validators.ts:94
Parameters
- index: number
- state: State
Returns boolean

isRangeRefinement

isRangeRefinement: object

msg

msg: string = "low and high values must be numeric"

func

func(__namedParameters: object): boolean

- Defined in core/actions/validators.ts:22
Parameters
- __namedParameters: object
  - high: number
  - low: number
  - range: boolean
Returns boolean

isRefinementDeselectedByIndex

isRefinementDeselectedByIndex: object

msg

msg: string = "navigation does not exist or refinement is already selected"

func

func(__namedParameters: object, state: State): boolean

- Defined in core/actions/validators.ts:74
Parameters
- __namedParameters: object
  - index: number
  - navigationId: string
- state: State
Returns boolean

isRefinementDeselectedByValue

isRefinementDeselectedByValue: object

msg

msg: string = "refinement is already selected"

func

func(payload: AddRefinement, state: State): boolean

- Defined in core/actions/validators.ts:32
Parameters
- payload: AddRefinement
- state: State
Returns boolean

isRefinementSelectedByIndex

isRefinementSelectedByIndex: object

msg

msg: string = "navigation does not exist or refinement is not selected"

func

func(__namedParameters: object, state: State): boolean

- Defined in core/actions/validators.ts:79
Parameters
- __namedParameters: object
  - index: number
  - navigationId: string
- state: State
Returns boolean

isSortDeselected

isSortDeselected: object

msg

msg: string = "sort is already selected"

func

func(index: number, state: State): boolean

- Defined in core/actions/validators.ts:135
Parameters
- index: number
- state: State
Returns boolean

isString

isString: object

msg

msg: string = "must be a non-empty string"

func

func(value: any): boolean

- Defined in core/actions/validators.ts:12
Parameters
- value: any
Returns boolean

isValidBias

isValidBias: object

msg

msg: string = "bias is invalid"

func

func(payload: Biasing): boolean

- Defined in core/actions/validators.ts:160
Parameters
- payload: Biasing
Returns boolean

isValidClearField

isValidClearField: object

msg

msg: string = "clear must be a string or true"

func

func(field: string | true | false): boolean

- Defined in core/actions/validators.ts:53
Parameters
- field: string | true | false
Returns boolean

isValidPage

isValidPage: object

msg

msg: string = "page is invalid"

func

func(page: number, state: State): boolean

- Defined in core/actions/validators.ts:150
Parameters
- page: number
- state: State
Returns boolean

isValidPastPurchasePage

isValidPastPurchasePage: object

msg

msg: string = "page is invalid"

func

func(page: number, state: State): boolean

- Defined in core/actions/validators.ts:114
Parameters
- page: number
- state: State
Returns boolean

isValidQuery

isValidQuery: object

msg

msg: string = "search term is empty"

func

func(query: string): boolean

- Defined in core/actions/validators.ts:17
Parameters
- query: string
Returns boolean

isValidRange

isValidRange: object

msg

msg: string = "low value must be lower than high"

func

func(__namedParameters: object): boolean

- Defined in core/actions/validators.ts:48
Parameters
- __namedParameters: object
  - high: number
  - low: number
  - range: boolean
Returns boolean

isValueRefinement

isValueRefinement: object

msg

msg: string = `value ${isString.msg}`

func

func(__namedParameters: object): boolean

- Defined in core/actions/validators.ts:27
Parameters
- __namedParameters: object
  - range: boolean
  - value: string
Returns boolean

notOnFirstPage

notOnFirstPage: object

msg

msg: string = "page must not be on first page"

func

func(_: any, state: State): boolean

- Defined in core/actions/validators.ts:69
Parameters
- _: any
- state: State
Returns boolean

notOnFirstPastPurchasePage

notOnFirstPastPurchasePage: object

msg

msg: string = "page must not be on first page"

func

func(_: any, state: State): boolean

- Defined in core/actions/validators.ts:99
Parameters
- _: any
- state: State
Returns boolean

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Action

GenericTransformer

Type declaration

Parameters

Rest ...arg: T[]

Returns T

SagaCreator

Type declaration

Parameters

flux: FluxCapacitor

Returns function

Returns IterableIterator<ForkEffect>

State

Variables

DEFAULT_AREA

DEFAULT_COLLECTION

DEFAULT_PAGE_SIZE

DETAILS_CHANGE_ACTIONS

MAX_RECORDS

PAST_PURCHASES_SEARCH_CHANGE_ACTIONS

PAST_PURCHASE_SKU_ACTIONS

PERSONALIZATION_CHANGE_ACTIONS

RECALL_CHANGE_ACTIONS

SAGA_CREATORS

SAVE_STATE_ACTIONS

SEARCH_CHANGE_ACTIONS

STORAGE_KEY

STORAGE_WHITELIST

UNDOABLE_ACTIONS

autocompletePastPurchaseRequest

autocompleteProductsRequest

autocompleteSuggestionsRequest

collectionRequest

fetch

pastPurchaseProductsRequest

personalizationTransform

productDetailsRequest

productsRequest

recommendationsNavigationsRequest

recommendationsProductIdsRequest

recommendationsProductsRequest

recommendationsSuggestionsRequest

refinementsRequest

Functions

addRefinement

Parameters

state: State

__namedParameters: object

high: number

low: number

navigationId: string

range: boolean

value: string

Returns object

byId: object

__computed: Object | Object

applyNavigationReducer

Parameters

state: State

__namedParameters: object

payload: string | number | true | false | ProductWithMetadata[] | Template | Page | PastPurchaseProduct[] | Navigation[] | Refinement

reducer: Function

Returns object

navigations: any

applyPageReducer

Parameters

state: State

__namedParameters: object

payload: string | number | true | false | ProductWithMetadata[] | Template | Page | PastPurchaseProduct[] | Navigation[] | Refinement

reducer: Function