@zengenti/contensis-react-base 3.0.0-beta.36 → 3.0.0-beta.37

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

@@ -1,3 +1,5 @@
+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';
@@ -32,7 +34,7 @@ export declare type Listing = {
     /** Display title */
     title?: string;
 };
-export declare type Facet = {
+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] */
@@ -147,7 +149,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?: {
@@ -161,28 +163,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: QueryParams) => {
+    [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,7 +16,7 @@ export declare type DebugFlags = boolean | {
     preloadOtherFacets?: boolean;
 };
 export declare type TriggerSearchParams = {
-    config?: Facet | Listing;
+    config?: SearchFacet | Listing;
     context: Context;
     debug?: DebugFlags;
     defaultLang?: string;
@@ -87,7 +87,7 @@ export declare type SetSearchEntriesParams = {
     defaultLang: string;
     facet: string;
     mappers: Mappers;
-    nextFacet: Facet;
+    nextFacet: SearchFacet;
     preload: boolean;
     ogState: AppState;
     debug: DebugFlags;

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

@@ -1,5 +1,5 @@
 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';
 export interface ListingProps<SearchResults = any> {
@@ -47,7 +47,7 @@ export interface SearchProps<SearchResults = any> {
 }
 export interface UseMinilistProps {
     id: string;
-    config?: Facet;
+    config?: SearchFacet;
     debug?: DebugFlags;
     defaultLang?: string;
     excludeIds?: string[];

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

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

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

@@ -1,5 +1,6 @@
 import { SearchConfig } from '../models/Search';
 import { Context } from '../models/Enums';
+import { SearchState } from '../models/SearchState';
 declare const _default: (config: SearchConfig) => <Base extends {
     readonly context: "facets" | "listings" | "minilist";
     readonly currentFacet: string;
@@ -256,5 +257,5 @@ declare const _default: (config: SearchConfig) => <Base extends {
     params: {
         [key: string]: string;
     };
-}) => Base;
+}) => import("immer/dist/internal").WritableDraft<SearchState> | Base;
 export default _default;

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

@@ -1,4 +1,4 @@
-import { AppState } from '../models/SearchState';
+import { Entry } from 'contensis-delivery-api/lib/models';
 import { InitListingAction, SetRouteFiltersOptions, TriggerSearchAction } from '../models/SearchActions';
 import { Mappers } from '../models/Search';
 import { Context } from '../models/Enums';
@@ -6,13 +6,13 @@ export declare const searchSagas: import("redux-saga/effects").ForkEffect<never>
 export declare function setRouteFilters(action: InitListingAction | SetRouteFiltersOptions): Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<InitListingAction> | import("redux-saga/effects").CallEffect<void>, void, any>;
 export declare function doSearch(action: TriggerSearchAction): Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").PutEffect<{
     type: string;
-    config?: import("../models/Search").Listing | import("../models/Search").Facet | undefined;
+    config?: import("../models/Search").Listing | import("../models/Search").SearchFacet | undefined;
     context: Context;
     debug?: import("../models/SearchActions").DebugFlags | undefined;
     defaultLang?: string | undefined;
     excludeIds?: string[] | undefined;
     facet: string;
-    mapper?: ((entries: any[], facet?: string | undefined, context?: Context | undefined, state?: AppState | undefined) => any[]) | undefined;
+    mapper?: import("../models/Search").SearchResultsMapper<any, Entry> | undefined;
     mappers?: Mappers | undefined;
     params?: {
         [key: string]: string;

package/models/search/transformations/entry-to-filteritem.mapper.d.ts

@@ -1,2 +1,3 @@
+import { FilterItemsMapper } from '../models/Search';
+declare const mapEntriesToFilterItems: FilterItemsMapper;
 export default mapEntriesToFilterItems;
-declare function mapEntriesToFilterItems(entries: any): any;

package/models/search/transformations/state-to-searchuri.d.ts

@@ -1,14 +1,3 @@
-import { AppState } from '../models/SearchState';
-declare type SearchStateParams = {
-    state: AppState;
-    facet?: string;
-    orderBy?: string;
-    pageIndex: number;
-    term?: string;
-};
-declare const mapStateToSearchUri: (params: SearchStateParams) => {
-    path: Location['pathname'];
-    search: Location['search'];
-    hash: Location['hash'];
-};
+import { NavigateMapper } from '../models/Search';
+declare const mapStateToSearchUri: NavigateMapper;
 export default mapStateToSearchUri;

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@zengenti/contensis-react-base",
-  "version": "3.0.0-beta.36",
+  "version": "3.0.0-beta.37",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -14006,7 +14006,7 @@
       }
     },
     "zengenti-search-package": {
-      "version": "git+https://gitlab+deploy-token-5:XKRGRE1p2PrFAxnWwLNz@gitlab.zengenti.com/zengenti-packages/search.git#a8e1089b388e9e3f84673adf283c45178f6b354f",
+      "version": "git+https://gitlab+deploy-token-5:XKRGRE1p2PrFAxnWwLNz@gitlab.zengenti.com/zengenti-packages/search.git#6e058fca27cde2a766df1cc359b8d99754d731a5",
       "from": "git+https://gitlab+deploy-token-5:XKRGRE1p2PrFAxnWwLNz@gitlab.zengenti.com/zengenti-packages/search.git#immer",
       "dev": true,
       "requires": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zengenti/contensis-react-base",
-  "version": "3.0.0-beta.36",
+  "version": "3.0.0-beta.37",
   "repository": "https://github.com/zengenti/contensis-react-base",
   "license": "None",
   "description": "Turbocharge your React web apps with Contensis. This package handles all dependencies for creating full featured web apps in React with Contensis and Site View. Routing is driven by Site View, Redux is used for global state management and server-side rendering (SSR) is handled for you. Also taking care of intricate hosting issues such as cache invalidation and supporting authenticated content where required.",