@zengenti/contensis-react-base 3.0.0-beta.9 → 3.0.0

package/models/search/models/Search.d.ts

@@ -1,4 +1,7 @@
+import { Entry } from 'contensis-delivery-api/lib/models';
+import MappingTemplate from 'jsonpath-mapper/dist/models/Template';
 import { Context } from './Enums';
+import { FieldOperators, LogicOperators } from './Queries';
 import { AppState } from './SearchState';
 export declare type Tab = {
     /** The facet to render as default */
@@ -15,8 +18,11 @@ export declare type CustomApi = {
     uri: string;
 };
 export declare type Listing = {
+    /** Display title */
+    title?: string;
     /** Experimental: use a custom API to retrieve search results */
     customApi?: CustomApi;
+} | {
     /** Experimental: override the rootUrl of the Delivery API client  */
     env?: string;
     /** An object with a key for each filter that is required in this facet */
@@ -24,23 +30,18 @@ export declare type Listing = {
     /** Use this to target the search to a project other than the default configured */
     projectId?: string;
     /** Query params object to drive the search for this facet */
-    queryParams: QueryParams;
+    queryParams: SearchQueryParams;
     /** Display title */
-    title: string;
+    title?: string;
 };
-export declare type Facet = {
-    /** Display title */
-    title: string;
-    /** Experimental: use a custom API to retrieve search results */
-    customApi?: CustomApi;
-} | ({
+export declare type SearchFacet = {
     /** The first facet to be shown if no facet is supplied via a route parameter [default false] */
     isDefault?: boolean;
     /** Set to true to temporarily disable the facet [default false] */
     isDisabled?: boolean;
     /** The id of the tab the facet applies to. Use 0 for default or the id assigned to the tab */
     tabId?: number;
-} & Listing);
+} & Listing;
 export declare type SearchFilters = {
     [key: string]: SearchFilter;
 };
@@ -49,10 +50,14 @@ export declare type SearchFilter = {
     contentTypeId?: string | string[];
     /** An array of CustomWhereClause to include in the search query when dynamically loading entries via the contentTypeId key */
     customWhere?: CustomWhereClause;
+    /** Use this to set a specific value to render for the initial / unselected option in this filter */
+    defaultValue?: string;
     /** The content type field we will apply the filter key to, to filter the list of returned results. */
     fieldId: string | string[];
     /** The Delivery API search operator we will use to filter the list of returned results. */
-    fieldOperator?: string;
+    fieldOperator?: FieldOperators;
+    /** The Delivery API locgical operator we will use to filter the list of returned results when multiple filter items are selected. */
+    logicOperator?: LogicOperators;
     /** The taxonomy path we will dynamically load into state under the items[] */
     path?: string;
     /** Setting to true will sync selected filters under matching filter keys in other facets */
@@ -86,7 +91,7 @@ export declare type FeaturedResults = {
     /** The number of featured results to retrieve */
     count?: number;
 };
-export declare type QueryParams = {
+export declare type SearchQueryParams = {
     /** An array of assetTypes to search over (sys.dataFormat == 'asset'); Prefix an entry with a "!" to exclude that asset type from the search */
     assetTypes?: string[];
     /** An array of contentTypeIds to search over (sys.dataFormat == 'entry'); Prefix an entry with a "!" to exclude that content type from the search */
@@ -146,7 +151,7 @@ export declare type WeightedSearchField = {
 export declare type SearchConfig = {
     /** An object with a key for each facet that is required for the search */
     facets: {
-        [key: string]: Facet;
+        [key: string]: SearchFacet;
     };
     /** An object with a key for each independent listing that is required for the site */
     listings?: {
@@ -160,28 +165,55 @@ export declare type SearchConfig = {
     tabs: Tab[];
 };
 export declare type ConfigTypes = {
-    [key: string]: Facet;
+    [key: string]: SearchFacet;
 } | {
     [key: string]: Listing;
 };
-export declare type Mappers = {
-    customApi?: (queryParams: QueryParams) => {
-        [key: string]: string;
-    };
-    results: (entries: any[], facet?: string, context?: Context, state?: AppState) => any[];
-    filterItems?: (entries: any[]) => any[];
-    navigate?: ({ state, facet, orderBy, pageIndex, term, }: {
-        state: AppState;
-        facet?: string;
-        orderBy?: string;
-        pageIndex: number;
-        term?: string;
-    }) => NavigateUri;
-    resultsInfo?: (state: AppState) => any;
-};
+/**
+ * Type your mapper for mapping API responses (entries) into usable props for your components to render
+ */
+export declare type SearchResultsMapper<Target = any, Source = Entry> = (entries: Source[], facet?: string, context?: Context, state?: AppState) => Target[];
+/**
+ * Type your custom filter item mapping function with this to ensure correctly typed FilterItems are returned to work with search functions
+ */
+export declare type FilterItemsMapper<T = Entry> = (entries: T[]) => FilterItem[];
+/**
+ * The uri object type we need to return from the Navigate mapper after any search action has been called
+ */
 export declare type NavigateUri = {
     path: string;
     search: string;
     hash: string;
 };
+/**
+ * Type your jsonpath-mapper mapping template with this to map your next search uri to your custom uri structure after calling any search action
+ */
+export declare type SearchUriMapping = MappingTemplate<SearchStateParams>;
+/**
+ * Type the argument passed to the Navigate mapper, this provides the relevant keys and data available to manipulate and return the next uri after any search action has been called
+ */
+export declare type SearchStateParams = {
+    state: AppState;
+    facet?: string;
+    orderBy?: string;
+    pageIndex: number;
+    term?: string;
+};
+/** Type your Navigate mapper with this, the Navigate mapper is called after any search action has been called and is required to return the next uri to be parsed by your project's route configuration and provide the right uri parameters to drive the next search query and resulting state */
+export declare type NavigateMapper = ({ state, facet, orderBy, pageIndex, term, }: SearchStateParams) => NavigateUri;
+/** Type your Results Info mapper with this, remember "resultsInfo" prop is a custom object you define yourself - you can provide any keys you wish, conveying detailed messaging or UX tweaks to cover all kinds of scenarios based on data in the search state at that time */
+export declare type ResultsInfoMapper<T = any> = (state: AppState) => T;
+/** Experimental**: If you are trying to use the custom API feature you can add specific keys to the resultant querystring that for the custom API GET request */
+export declare type CustomApiParamsMapper = (queryParams: SearchQueryParams) => {
+    [key: string]: string;
+};
+/** Type your Mappers object with this type to provide a accurate, type-safe "mapper" argument to your search implementation */
+export declare type Mappers = {
+    customApi?: CustomApiParamsMapper;
+    results: SearchResultsMapper;
+    filterItems?: FilterItemsMapper;
+    navigate?: NavigateMapper;
+    resultsInfo?: ResultsInfoMapper;
+};
+/** SearchTransformations is just an alias for Mappers object / argument */
 export declare type SearchTransformations = Mappers;

package/models/search/models/SearchActions.d.ts

@@ -1,7 +1,7 @@
 import { PagedList } from 'contensis-core-api';
 import { Entry, TaxonomyNode } from 'contensis-delivery-api/lib/models';
 import { Context } from '../models/Enums';
-import { Facet, Listing, Mappers } from '../models/Search';
+import { SearchFacet, Listing, Mappers } from '../models/Search';
 import { AppState } from './SearchState';
 import { QueryParams } from './Queries';
 import { TimedSearchResponse } from './SearchUtil';
@@ -16,8 +16,8 @@ export declare type DebugFlags = boolean | {
     preloadOtherFacets?: boolean;
 };
 export declare type TriggerSearchParams = {
-    config?: Facet | Listing;
-    context: Context;
+    config?: SearchFacet | Listing;
+    context: Context | string;
     debug?: DebugFlags;
     defaultLang?: string;
     excludeIds?: string[];
@@ -46,6 +46,7 @@ declare type InitListingParams = {
 export declare type InitListingAction = Action & InitListingParams & {
     ssr?: boolean;
 };
+export declare type SetRouteFiltersOptions = Partial<InitListingAction>;
 export declare type InitListingActionCreator = (p: InitListingParams) => InitListingAction;
 export declare type LoadFiltersSearchResults = Action & {
     error: any;
@@ -86,7 +87,7 @@ export declare type SetSearchEntriesParams = {
     defaultLang: string;
     facet: string;
     mappers: Mappers;
-    nextFacet: Facet;
+    nextFacet: SearchFacet;
     preload: boolean;
     ogState: AppState;
     debug: DebugFlags;
@@ -98,10 +99,12 @@ export declare type SetSearchEntriesAction = Action & SetSearchEntriesParams;
 export declare type ApplySearchFilterAction = Action & {
     filter: string;
     key: string;
+    isUnknownItem: boolean;
+    scrollYPos?: number;
 };
 export declare type ApplySearchFilterActionCreator = (filter: string, key: string) => ApplySearchFilterAction;
 export declare type ClearFiltersAction = Action;
-export declare type ClearFiltersActionCreator = () => ClearFiltersAction;
+export declare type ClearFiltersActionCreator = (filterKey?: string) => ClearFiltersAction;
 export declare type UpdateCurrentFacetAction = Action & {
     facet: string;
 };
@@ -121,6 +124,7 @@ export declare type UpdateSortOrderAction = Action & {
 export declare type UpdateSortOrderActionCreator = (orderBy: string, facet: string) => UpdateSortOrderAction;
 export declare type UpdatePageIndexAction = Action & {
     pageIndex: number;
+    scrollYPos?: number;
 };
 export declare type UpdatePageIndexActionCreator = (pageIndex: number) => UpdatePageIndexAction;
 export {};

package/models/search/models/SearchProps.d.ts

@@ -1,7 +1,20 @@
 import { clearFilters, updateCurrentFacet, updateCurrentTab, updatePageIndex, updateSearchTerm, updateSelectedFilters, updateSortOrder } from '../redux/actions';
-import { Facet, Mappers } from '../models/Search';
+import { SearchFacet, Mappers } from '../models/Search';
 import { DebugFlags } from '../models/SearchActions';
-import { Facet as StateFacet, Facets, Filters, Paging } from '../models/SearchState';
+import { Facet as StateFacet, Facets, Filters, Paging, SelectedFilters, TabAndFacets } from '../models/SearchState';
+export interface MinilistProps<SearchResults = any> {
+    filters: Filters;
+    isLoading: boolean;
+    paging: Paging;
+    results: SearchResults[];
+    resultsInfo: any;
+    searchTerm: string;
+    sortOrder: string[];
+    title: string;
+    updatePageIndex: typeof updatePageIndex;
+    updateSelectedFilters: typeof updateSelectedFilters;
+    updateSortOrder: typeof updateSortOrder;
+}
 export interface ListingProps<SearchResults = any> {
     clearFilters: typeof clearFilters;
     currentListing: string;
@@ -9,12 +22,15 @@ export interface ListingProps<SearchResults = any> {
     featured: SearchResults[];
     filters: Filters;
     isLoading: boolean;
-    paging: Paging;
+    listing: StateFacet;
     pageIsLoading: boolean;
+    paging: Paging;
     results: SearchResults[];
     resultsInfo: any;
     searchTerm: string;
+    selectedFilters: SelectedFilters;
     sortOrder: string[];
+    title: string;
     updateCurrentFacet: typeof updateCurrentFacet;
     updatePageIndex: typeof updatePageIndex;
     updateSearchTerm: typeof updateSearchTerm;
@@ -27,17 +43,26 @@ export interface SearchProps<SearchResults = any> {
     currentPageIndex: number;
     currentTabIndex: number;
     facet: StateFacet;
+    facetTitles: {
+        isSelected: boolean;
+        key: string;
+        title: string;
+        totalCount: number;
+    }[];
     facets: Facets;
-    featuredResults: SearchResults[];
+    featured: SearchResults[];
     filters: Filters;
     isLoading: boolean;
-    paging: Paging;
     pageIsLoading: boolean;
+    paging: Paging;
     results: SearchResults[];
     resultsInfo: any;
     searchTerm: string;
+    searchTotalCount: number;
+    selectedFilters: SelectedFilters;
     sortOrder: string[];
-    tabsAndFacets: any;
+    tabsAndFacets: TabAndFacets;
+    totalCount: number;
     updateCurrentFacet: typeof updateCurrentFacet;
     updateCurrentTab: typeof updateCurrentTab;
     updatePageIndex: typeof updatePageIndex;
@@ -45,9 +70,29 @@ export interface SearchProps<SearchResults = any> {
     updateSelectedFilters: typeof updateSelectedFilters;
     updateSortOrder: typeof updateSortOrder;
 }
+export interface UseFacetsProps {
+    debug?: DebugFlags;
+    defaultLang?: string;
+    mappers?: Mappers;
+    /** Reserved for future use */
+    id?: string;
+    params?: {
+        [key: string]: string;
+    };
+}
+export interface UseListingProps {
+    debug?: DebugFlags;
+    defaultLang?: string;
+    mappers?: Mappers;
+    /** Reserved for future use */
+    id?: string;
+    params?: {
+        [key: string]: string;
+    };
+}
 export interface UseMinilistProps {
     id: string;
-    config?: Facet;
+    config?: SearchFacet;
     debug?: DebugFlags;
     defaultLang?: string;
     excludeIds?: string[];

package/models/search/models/SearchState.d.ts

@@ -1,6 +1,6 @@
 import { Context } from './Enums';
 import { CustomWhereClause } from './Search';
-export declare type AppState = Record<'search', SearchState>;
+export declare type AppState = Record<'search', SearchState> & Record<string, any>;
 export declare type SearchState = {
     context: keyof typeof Context;
     currentFacet: string;
@@ -58,6 +58,7 @@ export declare type Filters = {
 export declare type Filter = {
     contentTypeId?: string;
     customWhere?: CustomWhereClause;
+    defaultValue?: string;
     fieldId?: string;
     isGrouped?: boolean;
     isSingleSelect?: boolean;
@@ -76,6 +77,9 @@ export declare type FilterItem = {
     path?: string;
     isSelected: boolean;
 };
+export declare type SelectedFilters = {
+    [k: string]: string[];
+};
 export declare type Paging = {
     isLoading: boolean;
     pageCount: number;

package/models/search/models/index.d.ts

@@ -1,3 +1,5 @@
-export type { CustomApi, CustomWhereClause, Facet as SearchFacet, FeaturedResults, FilterItem, Listing, NavigateUri, QueryParams, SearchConfig, SearchFilter, SearchFilters, SearchTransformations, Tab, WeightedSearchField, } from './Search';
+export * from './Queries';
+export * from './Search';
+export type { SetRouteFiltersOptions } from './SearchActions';
 export * from './SearchProps';
 export type { Facet, Filter, Filters, SearchState } from './SearchState';

package/models/search/redux/actions.d.ts

@@ -11,9 +11,10 @@ export declare const navigate: (path: string, state?: any) => {
     state: any;
 };
 export declare const clearFilters: ClearFiltersActionCreator;
-export declare const updatePageIndex: (pageIndex: number) => {
+export declare const updatePageIndex: (pageIndex: number, scrollYPos?: number | undefined) => {
     type: string;
     pageIndex: number;
+    scrollYPos: number | undefined;
 };
 export declare const updateCurrentFacet: (facet: string) => {
     type: string;
@@ -27,10 +28,12 @@ export declare const updateSearchTerm: (term: string) => {
     type: string;
     term: string;
 };
-export declare const updateSelectedFilters: (filter: string, key: string) => {
+export declare const updateSelectedFilters: (filter: string, key: string, isUnknownItem?: boolean, scrollYPos?: number | undefined) => {
     type: string;
     filter: string;
     key: string;
+    isUnknownItem: boolean;
+    scrollYPos: number | undefined;
 };
 export declare const updateSortOrder: (orderBy: string, facet?: string | undefined) => {
     type: string;