@zengenti/contensis-react-base 2.5.1-beta.4 → 3.0.0-beta.3

package/models/routing/redux/selectors.d.ts

@@ -1,25 +1,29 @@
-export function selectRouteEntry(state: any): any;
-export function selectMappedEntry(state: any): any;
-export function selectNodeDepends(state: any): any;
-export function selectCurrentHostname(state: any): any;
-export function selectCurrentTreeID(state: any): any;
-export function selectRouteEntryEntryId(state: any): any;
-export function selectRouteEntryContentTypeId(state: any): any;
-export function selectRouteEntryLanguage(state: any): any;
-export function selectRouteEntrySlug(state: any): any;
-export function selectRouteEntryID(state: any): any;
-export function selectCurrentPath(state: any): any;
-export function selectCurrentSearch(state: any): any;
-export function selectCurrentHash(state: any): any;
-export function selectQueryStringAsObject(state: any): any;
-export function selectCurrentProject(state: any): any;
-export function selectIsNotFound(state: any): any;
-export function selectCurrentAncestors(state: any): any;
-export function selectCurrentSiblings(state: any): any;
-export function selectCurrentNode(state: any): any;
-export function selectCurrentChildren(state: any): any;
-export function selectBreadcrumb(state: any): any;
-export function selectRouteErrorMessage(state: any): any;
-export function selectRouteIsError(state: any): any;
-export function selectRouteLoading(state: any): any;
-export function selectRouteStatusCode(state: any): any;
+import { StateType } from "../../config";
+import { AppState } from "../../redux/appstate";
+export declare const selectRouteEntry: (state: AppState, returnType?: StateType | undefined) => any;
+export declare const selectMappedEntry: (state: AppState, returnType?: StateType | undefined) => any;
+export declare const selectNodeDepends: (state: AppState) => any;
+export declare const selectCurrentHostname: (state: AppState) => any;
+export declare const selectCurrentTreeID: (state: AppState) => any;
+export declare const selectRouteEntryEntryId: (state: AppState) => any;
+export declare const selectRouteEntryContentTypeId: (state: AppState) => any;
+export declare const selectRouteEntryLanguage: (state: AppState) => any;
+export declare const selectRouteEntrySlug: (state: AppState) => any;
+export declare const selectRouteEntryID: (state: AppState) => any;
+export declare const selectCurrentPath: (state: AppState) => any;
+export declare const selectCurrentLocation: (state: AppState) => any;
+export declare const selectCurrentSearch: (state: AppState) => any;
+export declare const selectCurrentHash: (state: AppState) => any;
+export declare const selectQueryStringAsObject: (state: AppState) => any;
+export declare const selectCurrentProject: (state: AppState) => any;
+export declare const selectIsNotFound: (state: AppState) => any;
+export declare const selectCurrentAncestors: (state: AppState) => any;
+export declare const selectCurrentSiblings: (state: AppState) => any;
+export declare const selectCurrentNode: (state: AppState, returnType?: StateType | undefined) => any;
+export declare const selectCurrentChildren: (state: any) => any;
+export declare const selectBreadcrumb: (state: AppState) => any;
+export declare const selectRouteErrorMessage: (state: AppState) => any;
+export declare const selectRouteIsError: (state: AppState) => any;
+export declare const selectRouteLoading: (state: AppState) => any;
+export declare const selectRouteStatusCode: (state: AppState) => any;
+export declare const selectStaticRoute: (state: AppState) => any;

package/models/routing/routes.d.ts

@@ -14,6 +14,14 @@ export declare type AppRootProps = {
     routes: AppRoutes;
     withEvents: WithEvents;
 };
+export declare type RouteComponentProps<P = any> = {
+    [key: string]: any;
+    projectId?: string;
+    contentTypeId?: string;
+    entry?: Entry | null;
+    mappedEntry?: P;
+    isLoggedIn?: boolean;
+};
 export declare type RouteLoaderProps = {
     loadingComponent?: React.ComponentType;
     notFoundComponent?: React.ComponentType;
@@ -31,7 +39,7 @@ declare type UserGroupRequisite = {
 export declare type RequireLogin = boolean | UserGroupRequisite[];
 export declare type ContentTypeMapping = {
     contentTypeID: string;
-    component: RouteComponent<any>;
+    component: RouteComponent<RouteComponentProps>;
     entryMapper?: EntryMapper;
     fields?: string[];
     injectRedux?: ReduxInjector;
@@ -45,7 +53,7 @@ export declare type ContentTypeMapping = {
     requireLogin?: RequireLogin;
 };
 export declare type StaticRoute = Omit<RouteConfig, 'component'> & {
-    component: RouteComponent<any>;
+    component: RouteComponent<RouteComponentProps>;
     fetchNode?: boolean;
     fetchNodeLevel?: number;
     injectRedux?: ReduxInjector;

package/models/search/hooks/useMinilist.hook.d.ts

@@ -1,23 +1,10 @@
-import { Facet, Mappers } from '../models/Search';
-import { DebugFlags } from '../models/SearchActions';
-declare type UseMiniListProps = {
-    id: string;
-    config?: Facet;
-    debug?: DebugFlags;
-    defaultLang?: string;
-    excludeIds?: string[];
-    mapper?: Mappers['results'];
-    mappers?: Mappers;
-    params?: {
-        [key: string]: string;
-    };
-};
-declare const useMinilist: ({ id, config, excludeIds, mapper, mappers, params, defaultLang, debug, }?: UseMiniListProps) => {
-    filters: Object;
-    isLoading: any;
-    pagingInfo: any;
+import { UseMinilistProps } from '../models/SearchProps';
+declare const useMinilist: ({ id, config, excludeIds, mapper, mappers, params, defaultLang, debug, }?: UseMinilistProps) => {
+    filters: import("../models/SearchState").Filters;
+    isLoading: boolean;
+    pagingInfo: import("../models/SearchState").Paging;
     results: any[];
-    searchTerm: any;
-    title: any;
+    searchTerm: string;
+    title: string;
 };
 export default useMinilist;

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

@@ -29,13 +29,18 @@ export declare type Listing = {
     title: string;
 };
 export declare type Facet = {
+    /** Display title */
+    title: string;
+    /** Experimental: use a custom API to retrieve search results */
+    customApi?: CustomApi;
+} | ({
     /** 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;
 };
@@ -56,6 +61,8 @@ export declare type SearchFilter = {
     isSingleSelect?: boolean;
     /** Supply an empty array or a hardcoded list of FilterItem depending on the type of filter we require */
     items: FilterItem[];
+    /** Set to false to not include this filter in filters prop */
+    renderable?: boolean;
     /** The title to render next to the filter */
     title: string;
 };

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

@@ -1,4 +1,3 @@
-import { List } from 'immutable';
 import { PagedList } from 'contensis-core-api';
 import { Entry, TaxonomyNode } from 'contensis-delivery-api/lib/models';
 import { Context } from '../models/Enums';
@@ -53,7 +52,7 @@ export declare type LoadFiltersSearchResults = Action & {
     facetKey: string;
     filterKey: string;
     payload: TaxonomyNode | PagedList<Entry>;
-    selectedKeys: List<string>;
+    selectedKeys: string[];
     context: Context;
     mapper: Mappers['filterItems'];
 };
@@ -61,7 +60,7 @@ export declare type SearchResults = {
     action: ExecuteSearchAction;
     featuredResult?: TimedSearchResponse;
     pageIndex: number;
-    prevResults: List<any>;
+    prevResults: any[];
     result: TimedSearchResponse;
     state: AppState;
 };
@@ -70,7 +69,7 @@ export declare type LoadFiltersCompleteAction = Action & {
     facetKey: string;
     filterKey: string;
     payload: TaxonomyNode | PagedList<Entry>;
-    selectedKeys: List<string>;
+    selectedKeys: string[];
     context: Context;
     mapper: Mappers['filterItems'];
 };

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

@@ -1,5 +1,7 @@
 import { clearFilters, updateCurrentFacet, updateCurrentTab, updatePageIndex, updateSearchTerm, updateSelectedFilters, updateSortOrder } from '../redux/actions';
-import { Facet, Facets, Filters, Paging } from '../models/SearchState';
+import { Facet, Mappers } from '../models/Search';
+import { DebugFlags } from '../models/SearchActions';
+import { Facet as StateFacet, Facets, Filters, Paging } from '../models/SearchState';
 export interface ListingProps<SearchResults = any> {
     clearFilters: typeof clearFilters;
     currentListing: string;
@@ -24,7 +26,7 @@ export interface SearchProps<SearchResults = any> {
     currentFacet: string;
     currentPageIndex: number;
     currentTabIndex: number;
-    facet: Facet;
+    facet: StateFacet;
     facets: Facets;
     featuredResults: SearchResults[];
     filters: Filters;
@@ -43,3 +45,15 @@ export interface SearchProps<SearchResults = any> {
     updateSelectedFilters: typeof updateSelectedFilters;
     updateSortOrder: typeof updateSortOrder;
 }
+export interface UseMinilistProps {
+    id: string;
+    config?: Facet;
+    debug?: DebugFlags;
+    defaultLang?: string;
+    excludeIds?: string[];
+    mapper?: Mappers['results'];
+    mappers?: Mappers;
+    params?: {
+        [key: string]: string;
+    };
+}

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

@@ -1,13 +1,16 @@
-import { List, Map, OrderedMap } from 'immutable';
-import { initialState, searchFacet } from '../redux/schema';
+import { Context } from './Enums';
 import { CustomWhereClause } from './Search';
-export declare type AppState = Map<'search', typeof initialState>;
+export declare type AppState = Record<'search', SearchState>;
 export declare type SearchState = {
+    context: keyof typeof Context;
     currentFacet: string;
+    currentListing: string;
     term: string;
-    facets: OrderedMap<string, OrderedMap<string, typeof searchFacet>>;
-    tabs: List<Tab>;
-    config: Map<string, boolean>;
+    facets: Facets;
+    listings: Facets;
+    minilist: Facets;
+    tabs: Tab[];
+    config: Record<string, boolean>;
 };
 export declare type Facets = {
     [key: string]: Facet;
@@ -16,10 +19,12 @@ export declare type Facet = {
     entries: {
         isLoading: boolean;
         isError: boolean;
+        error?: any;
     };
     featuredEntries: {
         isLoading: boolean;
         isError: boolean;
+        error?: any;
     };
     featuredResults: any[];
     filters: Filters;
@@ -28,13 +33,20 @@ export declare type Facet = {
         pageCount: number;
         pageSize: number;
         pageIndex: number;
+        pagesLoaded: number[];
+        prevPageIndex: number;
         totalCount: number;
     };
     preloaded: boolean;
+    projectId: string;
     queryDuration: number;
     queryParams: {
         contentTypeIds: string[];
         dynamicOrderBy: string[];
+        excludeIds: string[];
+        internalPaging: boolean;
+        loadMorePaging: boolean;
+        useSearchTerm: boolean;
     };
     results: any[];
     tabId: number;
@@ -53,6 +65,7 @@ export declare type Filter = {
     isError: boolean;
     items?: FilterItem[];
     path?: string;
+    renderable?: boolean;
     title?: string;
 };
 export declare type FilterItem = {
@@ -74,10 +87,13 @@ export declare type Paging = {
 };
 export declare type Tab = {
     currentFacet: string;
-    facets: {
-        [key: string]: Facet;
-    };
+    defaultFacet: string;
     id: number;
     label: string;
     totalCount: number;
 };
+export declare type TabAndFacets = Tab & {
+    facets: {
+        [key: string]: Facet;
+    };
+};

package/models/search/models/WithSearch.d.ts

@@ -0,0 +1,61 @@
+import { Facet, Filter, Paging, Tab } from './SearchState';
+export declare type WithSearch<T> = {
+    className: string;
+    /** Dispatch action to clear all selected filters */
+    clearFilters: Function;
+    /** The key of the current facet  */
+    currentFacet: string;
+    /** The index of the current page */
+    currentPageIndex: number;
+    /** The index of the current tab */
+    currentTabIndex: number;
+    /** The entire facet object from the state */
+    facet: Facet;
+    /** All facets from state */
+    facets: {
+        [key: string]: Facet;
+    };
+    /** Featured results entry array */
+    featuredResults: T[];
+    /** ? */
+    filters: {
+        [key: string]: Filter;
+    };
+    /** Search loading status */
+    isLoading: boolean;
+    /** Array of entries for current page of results */
+    results: T[];
+    /**
+     * Results info object
+     *
+     * This is defined in the SearchTranformation.resultsInfo that is passed to the withSearch HOC
+     */
+    resultsInfo: any;
+    /** The paging information of the current search */
+    paging: Paging;
+    /** Page loading status (best used with loadMorePaging) */
+    pageIsLoading: boolean;
+    /** The currently applied keyword / search term */
+    searchTerm: string;
+    /** The current sort order of the results */
+    sortOrder: string[];
+    /** An array of each tab on the state */
+    tabsAndFacets: Tab[];
+    /** param {string} facet : The key of the facet to set */
+    updateCurrentFacet: Function;
+    /** param {number} id : The tabId to set */
+    updateCurrentTab: Function;
+    /** param {number} pageIndex : The page index to set */
+    updatePageIndex: Function;
+    /** param {string} term : The keyword term to set */
+    updateSearchTerm: Function;
+    /**
+     * param filter
+     * param key
+     */
+    updateSelectedFilters: Function;
+    /**
+     * param orderBy
+     */
+    updateSortOrder: Function;
+};

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

@@ -0,0 +1,3 @@
+export declare const makeFromJS: (returnType?: 'immutable' | 'js') => any;
+declare const getImmutableOrJS: <S extends Record<string, unknown>, T extends unknown>(state: S, stateKey: T | T[], fallbackValue?: any, returnType?: 'immutable' | 'js') => any;
+export default getImmutableOrJS;