@zengenti/contensis-react-base 3.0.2-beta.3 → 3.0.2-beta.30

package/esm/version-7550d14d.js

@@ -0,0 +1,87 @@
+import { g as getImmutableOrJS, E as action } from './selectors-5061d7c8.js';
+import { all } from '@redux-saga/core/effects';
+import { r as reduxStore, b as SET_VERSION_STATUS, d as SET_VERSION } from './version-1ef42ad1.js';
+
+const hasNavigationTree = state => getImmutableOrJS(state, ['navigation', 'isReady']);
+const selectNavigationRoot = state => getImmutableOrJS(state, ['navigation', 'root']);
+const selectNavigationChildren = state => getImmutableOrJS(state, ['navigation', 'root', 'children']);
+const selectNavigationDepends = () => [];
+
+var navigation = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  hasNavigationTree: hasNavigationTree,
+  selectNavigationRoot: selectNavigationRoot,
+  selectNavigationChildren: selectNavigationChildren,
+  selectNavigationDepends: selectNavigationDepends
+});
+
+const convertSagaArray = sagas => {
+  if (Array.isArray(sagas)) return function* rootSaga() {
+    yield all(sagas);
+  };
+  return sagas;
+};
+const injectReducer = ({
+  key,
+  reducer
+}, store = reduxStore) => {
+  if (Reflect.has(store.injectedReducers, key) && store.injectedReducers[key] === reducer) return;
+  store.injectedReducers[key] = reducer;
+  store.replaceReducer(store.createReducer(store.injectedReducers));
+};
+const injectSaga = ({
+  key,
+  saga
+}, store = reduxStore) => {
+  const rootSaga = convertSagaArray(saga);
+  let hasSaga = Reflect.has(store.injectedSagas, key);
+  if (process.env.NODE_ENV !== 'production') {
+    const oldDescriptor = store.injectedSagas[key]; // enable hot reloading of daemon and once-till-unmount sagas
+
+    if (hasSaga && oldDescriptor.saga !== rootSaga) {
+      oldDescriptor.task.cancel();
+      hasSaga = false;
+    }
+  }
+  console.info('injectSaga, key: ', key, 'hasSaga: ', hasSaga);
+  if (!hasSaga) {
+    store.injectedSagas[key] = {
+      key,
+      saga: rootSaga,
+      task: store.runSaga(rootSaga)
+    };
+  }
+};
+const injectRedux = ({
+  key,
+  reducer,
+  saga
+}, store = reduxStore) => {
+  console.info('injectRedux, key: ', key);
+  if (reducer) injectReducer({
+    key,
+    reducer
+  }, store);
+  if (saga) injectSaga({
+    key,
+    saga
+  }, store);
+};
+const useInjectRedux = injectRedux;
+
+const setVersion = (commitRef, buildNo) => action(SET_VERSION, {
+  commitRef,
+  buildNo
+});
+const setVersionStatus = status => action(SET_VERSION_STATUS, {
+  status
+});
+
+var version = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  setVersion: setVersion,
+  setVersionStatus: setVersionStatus
+});
+
+export { setVersion as a, injectReducer as b, convertSagaArray as c, injectSaga as d, hasNavigationTree as h, injectRedux as i, navigation as n, setVersionStatus as s, useInjectRedux as u, version as v };
+//# sourceMappingURL=version-7550d14d.js.map

package/esm/version-7550d14d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version-7550d14d.js","sources":["../src/redux/selectors/navigation.js","../src/redux/store/injectors.js","../src/redux/actions/version.js"],"sourcesContent":["import { getImmutableOrJS as getIn } from '~/redux/util';\n\nexport const hasNavigationTree = state =>\n  getIn(state, ['navigation', 'isReady']);\n\nexport const selectNavigationRoot = state =>\n  getIn(state, ['navigation', 'root']);\n\nexport const selectNavigationChildren = state =>\n  getIn(state, ['navigation', 'root', 'children']);\n\nexport const selectNavigationDepends = () => [];\n","import { all } from 'redux-saga/effects';\nimport { reduxStore as DefaultStore } from './store';\n\nexport const convertSagaArray = sagas => {\n  if (Array.isArray(sagas))\n    return function* rootSaga() {\n      yield all(sagas);\n    };\n  return sagas;\n};\n\nexport const injectReducer = ({ key, reducer }, store = DefaultStore) => {\n  if (\n    Reflect.has(store.injectedReducers, key) &&\n    store.injectedReducers[key] === reducer\n  )\n    return;\n  store.injectedReducers[key] = reducer;\n\n  store.replaceReducer(store.createReducer(store.injectedReducers));\n};\n\nexport const injectSaga = ({ key, saga }, store = DefaultStore) => {\n  const rootSaga = convertSagaArray(saga);\n  let hasSaga = Reflect.has(store.injectedSagas, key);\n\n  if (process.env.NODE_ENV !== 'production') {\n    const oldDescriptor = store.injectedSagas[key]; // enable hot reloading of daemon and once-till-unmount sagas\n\n    if (hasSaga && oldDescriptor.saga !== rootSaga) {\n      oldDescriptor.task.cancel();\n      hasSaga = false;\n    }\n  }\n  console.info('injectSaga, key: ', key, 'hasSaga: ', hasSaga);\n\n  if (!hasSaga) {\n    store.injectedSagas[key] = {\n      key,\n      saga: rootSaga,\n      task: store.runSaga(rootSaga),\n    };\n  }\n};\n\nexport const injectRedux = ({ key, reducer, saga }, store = DefaultStore) => {\n  console.info('injectRedux, key: ', key);\n  if (reducer) injectReducer({ key, reducer }, store);\n  if (saga) injectSaga({ key, saga }, store);\n};\n\nexport const useInjectRedux = injectRedux;\n","import { action } from '../util';\nimport { SET_VERSION, SET_VERSION_STATUS } from '../types/version';\n\nexport const setVersion = (commitRef, buildNo) =>\n  action(SET_VERSION, { commitRef, buildNo });\n\nexport const setVersionStatus = status =>\n  action(SET_VERSION_STATUS, { status });\n"],"names":["hasNavigationTree","state","getIn","selectNavigationRoot","selectNavigationChildren","selectNavigationDepends","convertSagaArray","sagas","Array","isArray","rootSaga","all","injectReducer","key","reducer","store","DefaultStore","Reflect","has","injectedReducers","replaceReducer","createReducer","injectSaga","saga","hasSaga","injectedSagas","process","env","NODE_ENV","oldDescriptor","task","cancel","console","info","runSaga","injectRedux","useInjectRedux","setVersion","commitRef","buildNo","action","SET_VERSION","setVersionStatus","status","SET_VERSION_STATUS"],"mappings":";;;;AAEaA,MAAAA,iBAAiB,GAAGC,KAAK,IACpCC,gBAAK,CAACD,KAAK,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC,EAAC;AAElC,MAAME,oBAAoB,GAAGF,KAAK,IACvCC,gBAAK,CAACD,KAAK,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAA;AAE/B,MAAMG,wBAAwB,GAAGH,KAAK,IAC3CC,gBAAK,CAACD,KAAK,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAA;AAE3C,MAAMI,uBAAuB,GAAGA,MAAM,EAAE;;;;;;;;;;ACRlCC,MAAAA,gBAAgB,GAAGC,KAAK,IAAI;EACvC,IAAIC,KAAK,CAACC,OAAO,CAACF,KAAK,CAAC,EACtB,OAAO,UAAUG,QAAQA,GAAG;IAC1B,MAAMC,GAAG,CAACJ,KAAK,CAAC,CAAA;GACjB,CAAA;AACH,EAAA,OAAOA,KAAK,CAAA;AACd,EAAC;AAEM,MAAMK,aAAa,GAAGA,CAAC;EAAEC,GAAG;AAAEC,EAAAA,OAAAA;AAAQ,CAAC,EAAEC,KAAK,GAAGC,UAAY,KAAK;AACvE,EAAA,IACEC,OAAO,CAACC,GAAG,CAACH,KAAK,CAACI,gBAAgB,EAAEN,GAAG,CAAC,IACxCE,KAAK,CAACI,gBAAgB,CAACN,GAAG,CAAC,KAAKC,OAAO,EAEvC,OAAA;AACFC,EAAAA,KAAK,CAACI,gBAAgB,CAACN,GAAG,CAAC,GAAGC,OAAO,CAAA;EAErCC,KAAK,CAACK,cAAc,CAACL,KAAK,CAACM,aAAa,CAACN,KAAK,CAACI,gBAAgB,CAAC,CAAC,CAAA;AACnE,EAAC;AAEM,MAAMG,UAAU,GAAGA,CAAC;EAAET,GAAG;AAAEU,EAAAA,IAAAA;AAAK,CAAC,EAAER,KAAK,GAAGC,UAAY,KAAK;AACjE,EAAA,MAAMN,QAAQ,GAAGJ,gBAAgB,CAACiB,IAAI,CAAC,CAAA;EACvC,IAAIC,OAAO,GAAGP,OAAO,CAACC,GAAG,CAACH,KAAK,CAACU,aAAa,EAAEZ,GAAG,CAAC,CAAA;AAEnD,EAAA,IAAIa,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;IACzC,MAAMC,aAAa,GAAGd,KAAK,CAACU,aAAa,CAACZ,GAAG,CAAC,CAAC;;AAE/C,IAAA,IAAIW,OAAO,IAAIK,aAAa,CAACN,IAAI,KAAKb,QAAQ,EAAE;AAC9CmB,MAAAA,aAAa,CAACC,IAAI,CAACC,MAAM,EAAE,CAAA;AAC3BP,MAAAA,OAAO,GAAG,KAAK,CAAA;AACjB,KAAA;AACF,GAAA;EACAQ,OAAO,CAACC,IAAI,CAAC,mBAAmB,EAAEpB,GAAG,EAAE,WAAW,EAAEW,OAAO,CAAC,CAAA;EAE5D,IAAI,CAACA,OAAO,EAAE;AACZT,IAAAA,KAAK,CAACU,aAAa,CAACZ,GAAG,CAAC,GAAG;MACzBA,GAAG;AACHU,MAAAA,IAAI,EAAEb,QAAQ;AACdoB,MAAAA,IAAI,EAAEf,KAAK,CAACmB,OAAO,CAACxB,QAAQ,CAAA;KAC7B,CAAA;AACH,GAAA;AACF,EAAC;AAEM,MAAMyB,WAAW,GAAGA,CAAC;EAAEtB,GAAG;EAAEC,OAAO;AAAES,EAAAA,IAAAA;AAAK,CAAC,EAAER,KAAK,GAAGC,UAAY,KAAK;AAC3EgB,EAAAA,OAAO,CAACC,IAAI,CAAC,oBAAoB,EAAEpB,GAAG,CAAC,CAAA;EACvC,IAAIC,OAAO,EAAEF,aAAa,CAAC;IAAEC,GAAG;AAAEC,IAAAA,OAAAA;GAAS,EAAEC,KAAK,CAAC,CAAA;EACnD,IAAIQ,IAAI,EAAED,UAAU,CAAC;IAAET,GAAG;AAAEU,IAAAA,IAAAA;GAAM,EAAER,KAAK,CAAC,CAAA;AAC5C,EAAC;AAEM,MAAMqB,cAAc,GAAGD;;AChDvB,MAAME,UAAU,GAAGA,CAACC,SAAS,EAAEC,OAAO,KAC3CC,MAAM,CAACC,WAAW,EAAE;EAAEH,SAAS;AAAEC,EAAAA,OAAAA;AAAQ,CAAC,EAAC;AAEtC,MAAMG,gBAAgB,GAAGC,MAAM,IACpCH,MAAM,CAACI,kBAAkB,EAAE;AAAED,EAAAA,MAAAA;AAAO,CAAC;;;;;;;;;;"}

package/models/client/client.d.ts

@@ -1,7 +1,7 @@
 import 'isomorphic-fetch';
 import React from 'react';
 import { AppConfig } from "../config";
-declare type ReactAppProps = {
+type ReactAppProps = {
     routes: any;
     withEvents: any;
 };

package/models/config.d.ts

@@ -1,7 +1,7 @@
 import { AppRoutes, WithEvents } from './routing/routes';
 import handleResponse from './server/features/response-handler';
-export declare type StateType = 'immutable' | 'js';
-export declare type AppConfig = {
+export type StateType = 'immutable' | 'js';
+export type AppConfig = {
     stateType?: StateType;
     routes: AppRoutes;
     withReducers: {
@@ -10,11 +10,11 @@ export declare type AppConfig = {
     withSagas: any[];
     withEvents: WithEvents;
 };
-export declare type ServerConfig = AppConfig & {
+export type ServerConfig = AppConfig & {
     appRootPath?: string;
     disableSsrRedux?: boolean;
     handleResponses?: typeof handleResponse;
-    handleExceptions?: boolean;
+    handleExceptions?: boolean | string[];
     reverseProxyPaths?: string[];
     packagejson: any;
     proxyDeliveryApi?: boolean;

package/models/redux/appstate.d.ts

@@ -3,13 +3,14 @@ import { Entry, Node } from 'contensis-delivery-api/lib/models';
 import { Group, User } from 'contensis-management-api/lib/models';
 import { MatchedRoute } from 'react-router-config';
 import { StaticRoute } from "../routing/routes";
-export declare type AppState = {
+export type AppState = {
     navigation: {
         root: Node | null;
         isError: boolean;
         isReady: boolean;
     };
     routing: {
+        canonicalPath: string | null;
         currentHostname: null;
         currentPath: string;
         currentNode: Node & {

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

@@ -1,6 +1,10 @@
-export declare const setNotFound: (notFound: any) => any;
-export declare const setNavigationPath: (path: any, location: any, staticRoute: any, withEvents: any, statePath: any, routes: any) => any;
-export declare const setCurrentProject: (project: any, allowedGroups: any, hostname: any) => any;
-export declare const setRoute: (path: any, state: any) => any;
-export declare const setRouteEntry: (entry: any) => any;
-export declare const setSurrogateKeys: (keys: any, url: any) => any;
+import { useLocation } from 'react-router-dom';
+import { Entry } from 'contensis-delivery-api/lib/models';
+import { MatchedRoute, RouteConfig } from 'react-router-config';
+import { AppRoutes, WithEvents } from '../routes';
+import { CookieHelper } from "../../user/util/CookieHelper.class";
+export declare const setNavigationPath: (path: string, location: ReturnType<typeof useLocation>, staticRoute: MatchedRoute<any, RouteConfig> | undefined, withEvents: WithEvents, statePath: string, routes: AppRoutes, cookies: CookieHelper) => any;
+export declare const setCurrentProject: (project: string, allowedGroups: any, hostname: string) => any;
+export declare const setRoute: (path: string, state?: any) => any;
+export declare const setRouteEntry: (entry: Entry) => any;
+export declare const setSurrogateKeys: (keys: string, url: string) => any;

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

@@ -1,7 +1,7 @@
 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 selectRouteEntry: (state: AppState, returnType?: StateType) => any;
+export declare const selectMappedEntry: (state: AppState, returnType?: StateType) => any;
 export declare const selectSurrogateKeys: (state: AppState) => any;
 export declare const selectCurrentHostname: (state: AppState) => any;
 export declare const selectCurrentTreeID: (state: AppState) => any;
@@ -10,6 +10,7 @@ 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 selectCanonicalPath: (state: AppState) => any;
 export declare const selectCurrentPath: (state: AppState) => any;
 export declare const selectCurrentLocation: (state: AppState) => any;
 export declare const selectCurrentSearch: (state: AppState) => any;
@@ -19,9 +20,9 @@ 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 selectCurrentNode: (state: AppState, returnType?: StateType) => any;
 export declare const selectCurrentChildren: (state: any) => any;
-export declare const selectBreadcrumb: (state: AppState) => 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;

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

@@ -5,7 +5,6 @@ export declare const SET_ANCESTORS: string;
 export declare const SET_SIBLINGS: string;
 export declare const SET_ENTRY_ID: string;
 export declare const SET_SURROGATE_KEYS: string;
-export declare const SET_NAVIGATION_NOT_FOUND: string;
 export declare const SET_NAVIGATION_PATH: string;
 export declare const SET_TARGET_PROJECT: string;
 export declare const SET_ROUTE: string;

package/models/routing/routes.d.ts

@@ -2,20 +2,21 @@ import { MatchedRoute, RouteConfig } from 'react-router-config';
 import { Entry, Node } from 'contensis-delivery-api/lib/models';
 import React from 'react';
 import { AppState } from "../redux/appstate";
-declare type RouteComponent<Props> = React.ComponentType<Props>;
-export declare type RouteNode = Node & {
+import { CookieHelper } from "../user/util/CookieHelper.class";
+type RouteComponent<Props> = React.ComponentType<Props>;
+export type RouteNode = Node & {
     ancestors: Node[];
     children: Node[];
 };
-export declare type AppRoutes = {
+export type AppRoutes = {
     ContentTypeMappings: ContentTypeMapping[];
     StaticRoutes: StaticRoute[];
 };
-export declare type AppRootProps = {
+export type AppRootProps = {
     routes: AppRoutes;
     withEvents: WithEvents;
 };
-export declare type RouteComponentProps<P = any> = {
+export type RouteComponentProps<P = any> = {
     [key: string]: any;
     projectId?: string;
     contentTypeId?: string;
@@ -23,23 +24,23 @@ export declare type RouteComponentProps<P = any> = {
     mappedEntry?: P;
     isLoggedIn?: boolean;
 };
-export declare type RouteLoaderProps = {
+export type RouteLoaderProps = {
     loadingComponent?: React.ComponentType;
     notFoundComponent?: React.ComponentType;
     trailingSlashRedirectCode?: 301 | 302;
 };
-export declare type EntryMapper = (<MappedProps>(node: RouteNode, state?: AppState) => MappedProps | unknown) | (<MappedProps>(node: RouteNode, state?: AppState) => Promise<MappedProps | unknown>);
-export declare type ReduxInjector = () => Promise<{
+export type EntryMapper = (<MappedProps>(node: RouteNode, state?: AppState) => MappedProps | unknown) | (<MappedProps>(node: RouteNode, state?: AppState) => Promise<MappedProps | unknown>);
+export type ReduxInjector = () => Promise<{
     key: string;
     reducer: any;
     saga: any;
 }>;
-declare type UserGroupRequisite = {
+type UserGroupRequisite = {
     id?: string;
     name?: string;
 };
-export declare type RequireLogin = boolean | UserGroupRequisite[];
-export declare type ContentTypeMapping = {
+export type RequireLogin = boolean | UserGroupRequisite[];
+export type ContentTypeMapping = {
     contentTypeID: string;
     component: RouteComponent<RouteComponentProps>;
     entryMapper?: EntryMapper;
@@ -59,7 +60,7 @@ export declare type ContentTypeMapping = {
     };
     requireLogin?: RequireLogin;
 };
-export declare type StaticRoute = Omit<RouteConfig, 'component'> & {
+export type StaticRoute = Omit<RouteConfig, 'component'> & {
     component: RouteComponent<RouteComponentProps>;
     fetchNode?: boolean | {
         /**
@@ -79,7 +80,8 @@ export declare type StaticRoute = Omit<RouteConfig, 'component'> & {
     ssr?: boolean;
     ssrOnly?: boolean;
 };
-export declare type OnRouteLoadArgs = {
+export type OnRouteLoadArgs = {
+    cookies: CookieHelper;
     location: {
         pathname: string;
         search: string;
@@ -90,7 +92,8 @@ export declare type OnRouteLoadArgs = {
     staticRoute: MatchedRoute<any, StaticRoute>;
     statePath: string;
 };
-export declare type OnRouteLoadedArgs = {
+export type OnRouteLoadedArgs = {
+    cookies: CookieHelper;
     entry: Entry | any;
     location: {
         pathname: string;
@@ -101,7 +104,7 @@ export declare type OnRouteLoadedArgs = {
     path: string;
     staticRoute: MatchedRoute<any, StaticRoute>;
 };
-export declare type RouteLoadOptions = {
+export type RouteLoadOptions = {
     customNavigation?: boolean | {
         ancestors: boolean | number;
         children: boolean | number;
@@ -114,10 +117,10 @@ export declare type RouteLoadOptions = {
     preventScrollTop?: boolean;
     refetchNode?: true;
 };
-export declare type RouteLoadedOptions = {
+export type RouteLoadedOptions = {
     requireLogin?: RequireLogin;
 };
-export declare type WithEvents = {
+export type WithEvents = {
     onRouteLoad: (args: OnRouteLoadArgs) => Generator<void | RouteLoadOptions>;
     onRouteLoaded: (args: OnRouteLoadedArgs) => Generator<void | RouteLoadedOptions>;
 };

package/models/search/models/Queries.d.ts

@@ -1,16 +1,14 @@
-import { Query } from 'contensis-core-api';
-import { VersionStatus } from 'contensis-core-api/lib/models';
-import { Operators } from 'contensis-delivery-api/lib/entries/query';
+import { Operators, Query, VersionStatus } from 'contensis-core-api';
 import { CustomWhereClause, FeaturedResults, WeightedSearchField } from './Search';
-export declare type FieldOperators = Exclude<keyof Operators, 'and' | 'or' | 'not'>;
-export declare type LogicOperators = 'and' | 'or' | 'not';
-export declare type FilterExpression = {
+export type FieldOperators = Exclude<keyof Operators, 'and' | 'or' | 'not'>;
+export type LogicOperators = 'and' | 'or' | 'not';
+export type FilterExpression = {
     key: string;
     values: string[];
     fieldOperator: FieldOperators;
     logicOperator: LogicOperators;
 };
-export declare type SearchQueryOptions = {
+export type SearchQueryOptions = {
     assetTypes: string[];
     contentTypeIds: string[];
     customWhere: any;
@@ -24,13 +22,14 @@ export declare type SearchQueryOptions = {
     languages: string[];
     pageSize: number;
     pageIndex: number;
+    omitDefaultSearchFields: string[];
     orderBy: string[];
     searchTerm: string;
     versionStatus: VersionStatus;
     webpageTemplates: string[];
     weightedSearchFields: WeightedSearchField[];
 };
-export declare type QueryParams = SearchQueryOptions & {
+export type QueryParams = SearchQueryOptions & {
     env: string;
     internalPageIndex: number;
     internalPaging: boolean;
@@ -43,5 +42,5 @@ export declare type QueryParams = SearchQueryOptions & {
         [key: string]: string;
     };
 };
-export declare type SearchQuery = ({ contentTypeIds, customWhere, dynamicOrderBy, excludeIds, featuredResults, fields, filters, fuzzySearch, languages, pageSize, pageIndex, orderBy, searchTerm, versionStatus, webpageTemplates, weightedSearchFields, }: SearchQueryOptions, isFeatured?: boolean) => Query;
-export declare type FilterQuery = (contentTypeIds: string[], versionStatus: VersionStatus, customWhere?: CustomWhereClause) => Query;
+export type SearchQuery = ({ contentTypeIds, customWhere, dynamicOrderBy, excludeIds, featuredResults, fields, filters, fuzzySearch, languages, pageSize, pageIndex, omitDefaultSearchFields, orderBy, searchTerm, versionStatus, webpageTemplates, weightedSearchFields, }: SearchQueryOptions, isFeatured?: boolean) => Query;
+export type FilterQuery = (contentTypeIds: string[], versionStatus: VersionStatus, customWhere?: CustomWhereClause) => Query;

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

@@ -3,7 +3,7 @@ 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 = {
+export type Tab = {
     /** The facet to render as default */
     defaultFacet?: string;
     /** The zero-based incrementing id assigned to the tab  */
@@ -13,11 +13,11 @@ export declare type Tab = {
     /** The facet to render the total results count as default */
     totalCount?: string;
 };
-export declare type CustomApi = {
+export type CustomApi = {
     /** The uri of the REST API implementing a simple GET request */
     uri: string;
 };
-export declare type Listing = {
+export type Listing = {
     /** Display title */
     title?: string;
     /** Experimental: use a custom API to retrieve search results */
@@ -34,7 +34,7 @@ export declare type Listing = {
     /** Display title */
     title?: string;
 };
-export declare type SearchFacet = {
+export 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] */
@@ -42,10 +42,10 @@ export declare type SearchFacet = {
     /** The id of the tab the facet applies to. Use 0 for default or the id assigned to the tab */
     tabId?: number;
 } & Listing;
-export declare type SearchFilters = {
+export type SearchFilters = {
     [key: string]: SearchFilter;
 };
-export declare type SearchFilter = {
+export type SearchFilter = {
     /** The content type id we will dynamically load entries from and load into state under the items[] */
     contentTypeId?: string | string[];
     /** An array of CustomWhereClause to include in the search query when dynamically loading entries via the contentTypeId key */
@@ -71,7 +71,7 @@ export declare type SearchFilter = {
     /** The title to render next to the filter */
     title: string;
 };
-export declare type FilterItem = {
+export type FilterItem = {
     /** Whether the filter is in a selected state */
     isSelected?: boolean;
     /** This will usually be the entry id or the taxonomy key */
@@ -81,7 +81,7 @@ export declare type FilterItem = {
     /** The title to render next to the filter item */
     title: string;
 };
-export declare type FeaturedResults = {
+export type FeaturedResults = {
     /** If the featured results are flagged with a certain field value, specify the fieldId containing the flagged value */
     fieldId?: string | string[];
     /** If the featured results are flagged with a certain field value, specify the value in the flagged fieldId */
@@ -91,7 +91,7 @@ export declare type FeaturedResults = {
     /** The number of featured results to retrieve */
     count?: number;
 };
-export declare type SearchQueryParams = {
+export 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 */
@@ -112,6 +112,8 @@ export declare type SearchQueryParams = {
     linkDepth?: number;
     /** Alters the pagination style to retain previously loaded pages of results after loading next pages */
     loadMorePaging?: boolean;
+    /** A list of fields to omit from the default search fields that are added to weightedSearchFields */
+    omitDefaultSearchFields?: string[];
     /** An array of orderBy expressions to add to the search query */
     orderBy?: string[];
     /** The number of items returned per page in the search */
@@ -123,7 +125,7 @@ export declare type SearchQueryParams = {
     /** An array of WeightedSearchField to include in the search query */
     weightedSearchFields?: WeightedSearchField[];
 };
-export declare type WhereClause = {
+export type WhereClause = {
     /** The field we wish to query */
     field: string;
     /** The value we want to evaluate with the chosen operator */
@@ -132,14 +134,14 @@ export declare type WhereClause = {
 /**
  * N.B. This shares syntax with adding where operators to a search query when using the Delivery API via HTTP, and should be used sparingly for exceptional cases where the standard query falls short
  */
-export declare type CustomWhereClause = (WhereClause | {
+export type CustomWhereClause = (WhereClause | {
     not: WhereClause;
 } | {
     and: WhereClause[];
 } | {
     or: WhereClause[];
 })[];
-export declare type WeightedSearchField = {
+export type WeightedSearchField = {
     /** The id of the field to query against */
     fieldId: string;
     /** The weighting applied to the field */
@@ -150,7 +152,7 @@ export declare type WeightedSearchField = {
  *
  * You need to provide a search configuration to the reducer so the initialState for your search can be set, this tells the package what you need your search to do, and where to get its data from.
  */
-export declare type SearchConfig = {
+export type SearchConfig = {
     /** An object with a key for each facet that is required for the search */
     facets: {
         [key: string]: SearchFacet;
@@ -166,7 +168,7 @@ export declare type SearchConfig = {
     /** An Array of Tabs */
     tabs: Tab[];
 };
-export declare type ConfigTypes = {
+export type ConfigTypes = {
     [key: string]: SearchFacet;
 } | {
     [key: string]: Listing;
@@ -174,15 +176,15 @@ export declare type ConfigTypes = {
 /**
  * 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[];
+export 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[];
+export 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 = {
+export type NavigateUri = {
     path: string;
     search: string;
     hash: string;
@@ -190,11 +192,11 @@ export declare type NavigateUri = {
 /**
  * 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>;
+export 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 = {
+export type SearchStateParams = {
     state: AppState;
     facet?: string;
     orderBy?: string;
@@ -203,15 +205,15 @@ export declare type SearchStateParams = {
     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, pageSize, term, }: SearchStateParams) => NavigateUri;
+export type NavigateMapper = ({ state, facet, orderBy, pageIndex, pageSize, 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;
+export 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) => {
+export 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 = {
+export type Mappers = {
     customApi?: CustomApiParamsMapper;
     results: SearchResultsMapper;
     filterItems?: FilterItemsMapper;
@@ -219,4 +221,4 @@ export declare type Mappers = {
     resultsInfo?: ResultsInfoMapper;
 };
 /** SearchTransformations is just an alias for Mappers object / argument */
-export declare type SearchTransformations = Mappers;
+export type SearchTransformations = Mappers;