@zengenti/contensis-react-base 3.3.1 → 3.3.2-beta.0

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

@@ -1,267 +1,12 @@
 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;
-    readonly currentListing: string;
-    readonly term: string;
-    readonly facets: {
-        readonly [x: string]: {
-            readonly entries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredEntries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredResults: readonly any[];
-            readonly filters: {
-                readonly [x: string]: {
-                    readonly contentTypeId?: string | undefined;
-                    readonly customWhere?: readonly ({
-                        readonly [x: string]: any;
-                        readonly field: string;
-                    } | {
-                        readonly not: {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        };
-                    } | {
-                        readonly and: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    } | {
-                        readonly or: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    })[] | undefined;
-                    readonly defaultValue?: string | undefined;
-                    readonly fieldId?: string | undefined;
-                    readonly isGrouped?: boolean | undefined;
-                    readonly isSingleSelect?: boolean | undefined;
-                    readonly isLoading: boolean;
-                    readonly isError: boolean;
-                    readonly items?: readonly {
-                        readonly contentTypeId?: string | undefined;
-                        readonly title?: string | undefined;
-                        readonly type?: string | undefined;
-                        readonly key: string;
-                        readonly path?: string | undefined;
-                        readonly isSelected: boolean;
-                    }[] | undefined;
-                    readonly path?: string | undefined;
-                    readonly renderable?: boolean | undefined;
-                    readonly title?: string | undefined;
-                };
-            };
-            readonly pagingInfo: {
-                readonly isLoading: boolean;
-                readonly pageCount: number;
-                readonly pageSize: number;
-                readonly pageIndex: number;
-                readonly pagesLoaded: readonly number[];
-                readonly prevPageIndex: number;
-                readonly totalCount: number;
-            };
-            readonly preloaded: boolean;
-            readonly projectId: string;
-            readonly queryDuration: number;
-            readonly queryParams: {
-                readonly contentTypeIds: readonly string[];
-                readonly dynamicOrderBy: readonly string[];
-                readonly pageSize: number;
-                readonly excludeIds: readonly string[];
-                readonly internalPaging: boolean;
-                readonly loadMorePaging: boolean;
-                readonly useSearchTerm: boolean;
-            };
-            readonly results: readonly any[];
-            readonly tabId: number;
-            readonly title: string;
-        };
-    };
-    readonly listings: {
-        readonly [x: string]: {
-            readonly entries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredEntries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredResults: readonly any[];
-            readonly filters: {
-                readonly [x: string]: {
-                    readonly contentTypeId?: string | undefined;
-                    readonly customWhere?: readonly ({
-                        readonly [x: string]: any;
-                        readonly field: string;
-                    } | {
-                        readonly not: {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        };
-                    } | {
-                        readonly and: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    } | {
-                        readonly or: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    })[] | undefined;
-                    readonly defaultValue?: string | undefined;
-                    readonly fieldId?: string | undefined;
-                    readonly isGrouped?: boolean | undefined;
-                    readonly isSingleSelect?: boolean | undefined;
-                    readonly isLoading: boolean;
-                    readonly isError: boolean;
-                    readonly items?: readonly {
-                        readonly contentTypeId?: string | undefined;
-                        readonly title?: string | undefined;
-                        readonly type?: string | undefined;
-                        readonly key: string;
-                        readonly path?: string | undefined;
-                        readonly isSelected: boolean;
-                    }[] | undefined;
-                    readonly path?: string | undefined;
-                    readonly renderable?: boolean | undefined;
-                    readonly title?: string | undefined;
-                };
-            };
-            readonly pagingInfo: {
-                readonly isLoading: boolean;
-                readonly pageCount: number;
-                readonly pageSize: number;
-                readonly pageIndex: number;
-                readonly pagesLoaded: readonly number[];
-                readonly prevPageIndex: number;
-                readonly totalCount: number;
-            };
-            readonly preloaded: boolean;
-            readonly projectId: string;
-            readonly queryDuration: number;
-            readonly queryParams: {
-                readonly contentTypeIds: readonly string[];
-                readonly dynamicOrderBy: readonly string[];
-                readonly pageSize: number;
-                readonly excludeIds: readonly string[];
-                readonly internalPaging: boolean;
-                readonly loadMorePaging: boolean;
-                readonly useSearchTerm: boolean;
-            };
-            readonly results: readonly any[];
-            readonly tabId: number;
-            readonly title: string;
-        };
-    };
-    readonly minilist: {
-        readonly [x: string]: {
-            readonly entries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredEntries: {
-                readonly isLoading: boolean;
-                readonly isError: boolean;
-                readonly error?: any;
-            };
-            readonly featuredResults: readonly any[];
-            readonly filters: {
-                readonly [x: string]: {
-                    readonly contentTypeId?: string | undefined;
-                    readonly customWhere?: readonly ({
-                        readonly [x: string]: any;
-                        readonly field: string;
-                    } | {
-                        readonly not: {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        };
-                    } | {
-                        readonly and: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    } | {
-                        readonly or: readonly {
-                            readonly [x: string]: any;
-                            readonly field: string;
-                        }[];
-                    })[] | undefined;
-                    readonly defaultValue?: string | undefined;
-                    readonly fieldId?: string | undefined;
-                    readonly isGrouped?: boolean | undefined;
-                    readonly isSingleSelect?: boolean | undefined;
-                    readonly isLoading: boolean;
-                    readonly isError: boolean;
-                    readonly items?: readonly {
-                        readonly contentTypeId?: string | undefined;
-                        readonly title?: string | undefined;
-                        readonly type?: string | undefined;
-                        readonly key: string;
-                        readonly path?: string | undefined;
-                        readonly isSelected: boolean;
-                    }[] | undefined;
-                    readonly path?: string | undefined;
-                    readonly renderable?: boolean | undefined;
-                    readonly title?: string | undefined;
-                };
-            };
-            readonly pagingInfo: {
-                readonly isLoading: boolean;
-                readonly pageCount: number;
-                readonly pageSize: number;
-                readonly pageIndex: number;
-                readonly pagesLoaded: readonly number[];
-                readonly prevPageIndex: number;
-                readonly totalCount: number;
-            };
-            readonly preloaded: boolean;
-            readonly projectId: string;
-            readonly queryDuration: number;
-            readonly queryParams: {
-                readonly contentTypeIds: readonly string[];
-                readonly dynamicOrderBy: readonly string[];
-                readonly pageSize: number;
-                readonly excludeIds: readonly string[];
-                readonly internalPaging: boolean;
-                readonly loadMorePaging: boolean;
-                readonly useSearchTerm: boolean;
-            };
-            readonly results: readonly any[];
-            readonly tabId: number;
-            readonly title: string;
-        };
-    };
-    readonly tabs: readonly {
-        readonly currentFacet: string;
-        readonly defaultFacet: string;
-        readonly id: number;
-        readonly label: string;
-        readonly totalCount: number;
-    }[];
-    readonly config: {
-        readonly [x: string]: boolean;
-    };
-}>(base?: Base | undefined, action: {
+declare const _default: (config: SearchConfig) => (state?: SearchState | undefined, action: {
     [key: string]: any;
     context: keyof typeof Context;
     facet: string;
     params: {
         [key: string]: string;
     };
-}) => import("immer/dist/internal").WritableDraft<SearchState> | Base;
+}) => SearchState;
 export default _default;

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

@@ -49,7 +49,7 @@ export declare const searchTab: {
     label: undefined;
     totalCount: string;
 };
-export declare const filtering: Omit<Filter, "customWhere" | "items"> & {
+export declare const filtering: Omit<Filter, "items" | "customWhere"> & {
     customWhere?: CustomWhereClause[] | undefined;
     items?: FilterItem[] | undefined;
 };

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

@@ -40,10 +40,10 @@ export declare const getTotalCount: (state: AppState, current?: string, context?
 export declare const getSearchTerm: (state: AppState) => string;
 export declare const getSearchTabs: (state: AppState, returnType?: StateType) => Tab[];
 export declare const getQueryParams: (state: AppState, current?: string, context?: Context) => Record<string, any>;
-export declare const getQueryParameter: <K extends keyof SearchQueryParams, K2 extends "internalPaging" | "linkDepth" | "loadMorePaging" | keyof import("../models/Queries").SearchQueryOptions | "env" | "internalPageIndex" | "pagesLoaded" | "prevPageIndex" | "projectId" | "selectedFilters">({ state, facet, context, }: {
+export declare const getQueryParameter: <K extends keyof SearchQueryParams, K2 extends "projectId" | "linkDepth" | "internalPaging" | "loadMorePaging" | keyof import("../models/Queries").SearchQueryOptions | "env" | "internalPageIndex" | "pagesLoaded" | "prevPageIndex" | "selectedFilters">({ state, facet, context, }: {
     state: AppState;
-    facet?: string | undefined;
-    context?: Context | undefined;
+    facet?: string;
+    context?: Context;
 }, key: K | K2, ifnull?: any) => SearchQueryParams[K] | QueryParams2[K2];
 export declare const getCustomApi: (state: AppState, current: string, context?: Context, returnType?: StateType) => CustomApi;
 export declare const getCustomEnv: (state: AppState, current: string, context?: Context) => any;
@@ -76,7 +76,7 @@ export declare const selectFacets: {
     getQueryParams: (state: AppState, facet: string) => Record<string, any>;
     getQueryParameter: ({ state, facet }: {
         state: AppState;
-        facet?: string | undefined;
+        facet?: string;
     }, key: keyof SearchQueryParams | keyof QueryParams2, ifnull: any) => any;
     getRenderableFilters: (state: AppState, facet?: string, context?: Context) => Filters;
     getResults: (state: AppState, current?: string, context?: Context, returnType?: StateType) => any[];
@@ -105,7 +105,7 @@ export declare const selectListing: {
     getQueryParams: (state: AppState, listing?: string) => Record<string, any>;
     getQueryParameter: ({ state, facet }: {
         state: AppState;
-        facet?: string | undefined;
+        facet?: string;
     }, key: keyof SearchQueryParams | keyof QueryParams2, ifnull: any) => any;
     getRenderableFilters: (state: AppState, listing?: string) => Filters;
     getResults: (state: AppState, listing?: string) => any[];

package/models/search/search/ToJs.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
 export declare const toJS: <Props extends {
     [key: string]: any;
-}>(WrappedComponent: React.ComponentType<Props>) => React.ComponentType<Props>;
+}>(WrappedComponent: (props: Props) => React.JSX.Element) => (wrappedComponentProps: Props) => React.JSX.Element;

package/models/search/search/expressions.d.ts

@@ -6,9 +6,9 @@ export declare const contentTypeIdExpression: (contentTypeIds: string[], webpage
 export declare const filterExpressions: (filters: FilterExpression[], isOptional?: boolean) => IExpression[];
 export declare const dataFormatExpression: (contentTypeIds: string[], dataFormat?: string) => ILogicalExpression[];
 export declare const featuredResultsExpression: ({ contentTypeId, fieldId, fieldValue, }?: {
-    contentTypeId?: string | string[] | undefined;
-    fieldId?: string | string[] | undefined;
-    fieldValue?: boolean | undefined;
+    contentTypeId?: string | string[];
+    fieldId?: string | string[];
+    fieldValue?: boolean;
 }) => IExpression[];
 export declare const languagesExpression: (languages: string[]) => IExpression[];
 export declare const includeInSearchExpressions: (webpageTemplates: string[], includeInSearchFields: string[]) => IExpression[];

package/models/search/search/util.d.ts

@@ -3,6 +3,21 @@ import { PagedList, Query } from 'contensis-core-api';
 import { CustomApi } from '../models/Search';
 import { TimedSearchResponse } from '../models/SearchUtil';
 export declare function fixFreeTextForElastic(s: string): string;
+/** `convertKeyForAggregation` and `parseKeyForAggregation` exists to prevent an
+ *  auto-generated aggregation using a reserved keyword because Elasticsearch has a list of
+ *  reserved keywords when it parses the response:
+ *  `'location' is one of the reserved aggregation keywords we use a heuristics based
+ *  response parser and using these reserved keywords could throw its heuristics off
+ *  course. We are working on a solution in Elasticsearch itself to make the response
+ *  parseable. For now these are all the reserved keywords: after_key, _as_string,
+ *  bg_count, bottom_right, bounds, buckets, count, doc_count, doc_count_error_upper_bound,
+ *  fields, from, top, type, from_as_string, hits, key, key_as_string, keys, location,
+ *  max_score, meta, min, min_length, score, sum_other_doc_count, to, to_as_string, top_left,
+ *  total, value, value_as_string, values, geometry, properties`
+ */
+export declare const convertKeyForAggregation: (key: string) => string;
+export declare const parseKeyForAggregation: (key: string) => string;
+export declare const convertFieldIdForAggregation: (fieldId: string) => string;
 export declare const timedSearch: (query: Query, linkDepth?: number, projectId?: string, env?: string) => Promise<null | TimedSearchResponse>;
 export declare const getItemsFromResult: (result?: {
     duration: number;
@@ -24,8 +39,8 @@ export declare const routeParams: (staticRoute?: any, location?: {
     [key: string]: any;
     pathname: string;
     search: string;
-    hash?: string | undefined;
-} | undefined) => any;
+    hash?: string;
+}) => any;
 export declare const callCustomApi: <T>(customApi: CustomApi, filters: {
     [key: string]: string;
 }) => Promise<T>;

package/models/server/features/linkdepth-api/search.d.ts

@@ -6,7 +6,7 @@ type WithOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 type SearchQueryArgs = WithOptional<SearchQueryOptions & {
     idFilters?: SearchQueryOptions['filters'];
     sharedFilters?: SearchQueryOptions['filters'];
-}, 'assetTypes' | 'customWhere' | 'dynamicOrderBy' | 'excludeIds' | 'featuredResults' | 'fieldLinkDepths' | 'fields' | 'includeInSearchFields' | 'languages' | 'omitDefaultSearchFields' | 'orderBy' | 'pageIndex' | 'searchTerm' | 'webpageTemplates' | 'weightedSearchFields'>;
+}, 'aggregations' | 'assetTypes' | 'customWhere' | 'dynamicOrderBy' | 'excludeIds' | 'featuredResults' | 'fieldLinkDepths' | 'fields' | 'includeInSearchFields' | 'languages' | 'omitDefaultSearchFields' | 'orderBy' | 'pageIndex' | 'searchTerm' | 'webpageTemplates' | 'weightedSearchFields'>;
 /**
  * Builds our complete Delivery API Query object from a set of provided arguments
  * @param queryParams

package/models/util/CachedDeliveryApi.d.ts

@@ -10,7 +10,7 @@ declare class CachedSearch {
     ssr?: SSRContext;
     constructor(ssr?: SSRContext);
     getClient(...args: Parameters<DeliveryApi['getClient']>): Client;
-    search(query: Query, linkDepth?: number, project?: string): Promise<import("contensis-core-api").PagedList<import("contensis-delivery-api").Entry>>;
+    search(query: Query, linkDepth?: number, project?: string): Promise<import("contensis-core-api").PagedSearchList<import("contensis-delivery-api").Entry>>;
     searchUsingPost(query: Query, linkDepth?: number, project?: string): any;
     get(id: string, linkDepth?: number, versionStatus?: VersionStatus, project?: string, fields?: string[]): Promise<import("contensis-delivery-api").Entry>;
     getContentType(id: string, project?: string): Promise<import("contensis-core-api").ContentType>;

package/models/util/ContensisDeliveryApi.d.ts

@@ -17,7 +17,7 @@ export declare class DeliveryApi {
     getServerSideVersionStatus: (request: Request) => string | string[] | import("qs").ParsedQs | import("qs").ParsedQs[];
     getVersionStatusFromHeaders: (headers: IncomingHttpHeaders) => string | string[] | null;
     getVersionStatusFromHostname: (currentHostname: string) => "published" | "latest";
-    search: (query: Query, linkDepth?: number, project?: string) => Promise<import("contensis-core-api").PagedList<import("contensis-delivery-api").Entry>>;
+    search: (query: Query, linkDepth?: number, project?: string) => Promise<import("contensis-core-api").PagedSearchList<import("contensis-delivery-api").Entry>>;
     getClient: (versionStatus?: VersionStatus, project?: string) => Client;
     getEntry: (id: string, linkDepth?: number, versionStatus?: VersionStatus, project?: string) => Promise<import("contensis-delivery-api").Entry>;
 }

package/models/util/SSRContext.d.ts

@@ -16,7 +16,7 @@ export declare const useDeliveryApi: () => {
     cookies?: import("../user/util/CookieConstants").CookieObject | undefined;
     ssr?: import("./ContensisDeliveryApi").SSRContext | undefined;
     getClient(versionStatus?: import("contensis-core-api").VersionStatus | undefined, project?: string | undefined): import("contensis-delivery-api").Client;
-    search(query: import("contensis-core-api").Query, linkDepth?: number, project?: string | undefined): Promise<import("contensis-core-api").PagedList<import("contensis-delivery-api").Entry>>;
+    search(query: import("contensis-core-api").Query, linkDepth?: number, project?: string | undefined): Promise<import("contensis-core-api").PagedSearchList<import("contensis-delivery-api").Entry>>;
     searchUsingPost(query: import("contensis-core-api").Query, linkDepth?: number, project?: string): any;
     get(id: string, linkDepth?: number, versionStatus?: import("contensis-core-api").VersionStatus, project?: string | undefined, fields?: string[] | undefined): Promise<import("contensis-delivery-api").Entry>;
     getContentType(id: string, project?: string | undefined): Promise<import("contensis-core-api").ContentType>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zengenti/contensis-react-base",
-  "version": "3.3.1",
+  "version": "3.3.2-beta.0",
   "repository": "https://github.com/zengenti/contensis-react-base",
   "license": "ISC",
   "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.",
@@ -9,13 +9,11 @@
   "types": "models",
   "scripts": {
     "start": "npm run roll:watch",
-    "debug:server": "npm start",
-    "build": "npm run clean:lib && tspc && npm run copymodels && npm run roll:lib",
-    "build:lib": "npm i zengenti-search-package zengenti-forms-package && npm run build",
+    "build": "npm run clean:lib && tspc && npm run roll:lib",
+    "build:lib": "npm i -D zengenti-forms-package && npm run build",
     "roll:lib": "cross-env NODE_ENV=production rollup --bundleConfigAsCjs -c rollup/rollup.config.lib.js",
     "roll:watch": "cross-env NODE_ENV=production rollup --bundleConfigAsCjs -c rollup/rollup.config.lib.js --watch",
     "clean:lib": "rimraf ./models && rimraf ./esm && rimraf ./cjs",
-    "copymodels": "copyfiles --up 3 --follow \"./node_modules/zengenti-search-package/models/**/*\" models/search --verbose",
     "lint": "eslint ./src",
     "lint:fix": "eslint --fix ./src"
   },
@@ -39,6 +37,7 @@
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.3.0",
     "@types/babel__core": "^7.20.5",
+    "@types/deep-equal": "^1.0.4",
     "@types/eslint__js": "^8.42.3",
     "@types/events": "^3.0.3",
     "@types/express": "^4.17.21",
@@ -55,7 +54,6 @@
     "@types/webpack-env": "^1.18.5",
     "babel-plugin-module-resolver": "^5.0.2",
     "babel-plugin-styled-components": "^2.1.4",
-    "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
@@ -73,8 +71,7 @@
     "typescript": "5.4",
     "typescript-eslint": "^8.16.0",
     "typescript-transform-paths": "^3.5.2",
-    "zengenti-forms-package": "git+https://gitlab+deploy-token-11:DRbTWzdaRzkjDWc_VixQ@gitlab.zengenti.com/zengenti-packages/forms.git#next",
-    "zengenti-search-package": "git+https://gitlab+deploy-token-5:XKRGRE1p2PrFAxnWwLNz@gitlab.zengenti.com/zengenti-packages/search.git#immer"
+    "zengenti-forms-package": "git+https://gitlab+deploy-token-11:DRbTWzdaRzkjDWc_VixQ@gitlab.zengenti.com/zengenti-packages/forms.git#next"
   },
   "dependencies": {
     "@hot-loader/react-dom": "^17.0.2",
@@ -83,9 +80,8 @@
     "app-root-path": "^3.1.0",
     "await-to-js": "^3.0.0",
     "chalk": "^4.1.2",
-    "contensis-delivery-api": "^1.5.0",
-    "contensis-management-api": "^2.2.0",
-    "cross-fetch": "3.1.8",
+    "contensis-delivery-api": "^1.6.0",
+    "contensis-management-api": "^2.3.0",
     "custom-env": "^2.0.6",
     "deep-equal": "^2.2.3",
     "deepmerge": "^4.3.1",