Source: types/product-search.js

/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
/* Copyright (c) 2018 Mobify Research & Development Inc. All rights reserved. */
/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */

import PropTypes from 'prop-types'
import {Integer} from './integer'
import {Filter} from './filter'
import {ProductSearchResult} from './product-search-result'
import {SortOption} from './sort-option'

export const ProductSearch = {
    count: Integer.isRequired,
    filters: PropTypes.arrayOf(PropTypes.shape(Filter)),
    results: PropTypes.arrayOf(PropTypes.shape(ProductSearchResult)),
    query: PropTypes.string,
    selectedFilters: PropTypes.object,
    selectedSortingOption: PropTypes.string,
    sortingOptions: PropTypes.arrayOf(PropTypes.shape(SortOption)),
    start: Integer.isRequired,
    total: Integer.isRequired
}

/**
 * @memberOf module:@mobify/commerce-integrations/dist/types
 * @typedef {Object} ProductSearch
 * @property {module:@mobify/commerce-integrations/dist/types.Integer} count The number of products returned.
 * @property {Array.<module:@mobify/commerce-integrations/dist/types.Filter>} filters The available search filters.
 * @property {Array.<module:@mobify/commerce-integrations/dist/types.ProductSearchResult>} results The product search results.
 * @property {String} query The search query.
 * @property {Object} selectedFilters The selected filters applied to the results as a propertyId and value map.
 * @property {String} selectedSortingOption The selected sorting option. NOTE: Only single sorting is supported.
 * @property {Array.<module:@mobify/commerce-integrations/dist/types.SortOption>} sortingOptions The available sorting options.
 * @property {module:@mobify/commerce-integrations/dist/types.Integer} start The search start index.
 * @property {module:@mobify/commerce-integrations/dist/types.Integer} total The search hit count.
 */