@zengenti/contensis-react-base 4.0.1-beta.1 → 4.0.1-beta.11

package/models/i18n/redux/slice.d.ts

@@ -18,76 +18,131 @@ declare const i18nSlice: import("@reduxjs/toolkit").Slice<{
     resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
     error: Error | undefined;
 }, {
-    GET_ENTRY_URI_ERROR(draft: import("@reduxjs/toolkit").WritableDraft<{
+    GET_ENTRY_URI_ERROR(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload }: PayloadAction<Error>): void;
-    INIT_LOCALES(draft: import("@reduxjs/toolkit").WritableDraft<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload }: PayloadAction<Error>): void;
+    INIT_LOCALES(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         locales: Locales;
         routes: LocaleRoutes;
     } & I18nAppConfig>): void;
-    SET_LANGUAGE(draft: import("@reduxjs/toolkit").WritableDraft<{
+    SET_LANGUAGE(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         language: string;
         dictionary: LocaleDictionary;
         redirect?: string;
     }>): void;
-    SET_LOCALES(draft: import("@reduxjs/toolkit").WritableDraft<{
+    SET_LOCALES(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         locales: Locales;
     } & I18nAppConfig>): void;
     /** UPDATE_LANGUAGE action triggers updateLanguage saga and ends with SET_LANGUAGE */
-    UPDATE_LANGUAGE(_draft: import("@reduxjs/toolkit").WritableDraft<{
+    UPDATE_LANGUAGE(_draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, _: PayloadAction<UpdateLanguageActionPayload>): void;
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, _: PayloadAction<UpdateLanguageActionPayload>): void;
 }, "i18n", "i18n", import("@reduxjs/toolkit").SliceSelectors<{
     currentLanguage: string;
     dictionary: LocaleDictionary;
@@ -101,76 +156,131 @@ declare const i18nSlice: import("@reduxjs/toolkit").Slice<{
     error: Error | undefined;
 }>>;
 export declare const actions: import("@reduxjs/toolkit").CaseReducerActions<{
-    GET_ENTRY_URI_ERROR(draft: import("@reduxjs/toolkit").WritableDraft<{
+    GET_ENTRY_URI_ERROR(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload }: PayloadAction<Error>): void;
-    INIT_LOCALES(draft: import("@reduxjs/toolkit").WritableDraft<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload }: PayloadAction<Error>): void;
+    INIT_LOCALES(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         locales: Locales;
         routes: LocaleRoutes;
     } & I18nAppConfig>): void;
-    SET_LANGUAGE(draft: import("@reduxjs/toolkit").WritableDraft<{
+    SET_LANGUAGE(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         language: string;
         dictionary: LocaleDictionary;
         redirect?: string;
     }>): void;
-    SET_LOCALES(draft: import("@reduxjs/toolkit").WritableDraft<{
+    SET_LOCALES(draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, { payload, }: PayloadAction<{
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, { payload, }: PayloadAction<{
         locales: Locales;
     } & I18nAppConfig>): void;
     /** UPDATE_LANGUAGE action triggers updateLanguage saga and ends with SET_LANGUAGE */
-    UPDATE_LANGUAGE(_draft: import("@reduxjs/toolkit").WritableDraft<{
+    UPDATE_LANGUAGE(_draft: {
         currentLanguage: string;
-        dictionary: LocaleDictionary;
+        dictionary: {
+            [x: string]: any;
+        };
         locales: {
-            [language: string]: any;
+            [x: string]: any;
+        };
+        routes: {
+            [x: string]: {
+                [x: string]: string;
+            };
         };
-        routes: LocaleRoutes;
         primaryLanguage: string;
         supportedLanguages: string[];
         resolver: ((language: string) => Promise<LocaleDictionary> | LocaleDictionary) | undefined;
-        error: Error | undefined;
-    }>, _: PayloadAction<UpdateLanguageActionPayload>): void;
+        error: {
+            name: string;
+            message: string;
+            stack?: string | undefined;
+            cause?: unknown;
+        } | undefined;
+    }, _: PayloadAction<UpdateLanguageActionPayload>): void;
 }, "i18n">, reducer: import("../../../node_modules/redux").Reducer<{
     currentLanguage: string;
     dictionary: LocaleDictionary;

package/models/models/config/ServerConfig.d.ts

@@ -22,9 +22,14 @@ export type ServerConfig = AppConfig & {
      */
     renderToString?: boolean;
     scripts?: {
+        /** Custom attributes to include with rendered script tags */
         attributes?: {
             [key: string]: string;
         };
+        /** Serve the "startup.js" script from a versioned alias
+         *  - avoids caching issues when environment variables have changed
+         *  - Example: `startup-${packagejson.version}.js`
+         */
         startup?: string;
     };
     staticFolderPath?: string;
@@ -32,6 +37,10 @@ export type ServerConfig = AppConfig & {
     staticRoutePath?: string;
     /** Additional static route paths */
     staticRoutePaths?: string[];
+    styles?: {
+        /** Render inline style tags for CSS Modules in SSR (default: false) */
+        inline?: boolean;
+    };
     stats?: string;
     templates: {
         html: string;

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

@@ -5,4 +5,20 @@ export declare const setNavigationPath: (path: string, contentPath: string, loca
 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, status: number) => any;
+/**
+ * Represents a single API call record stored in Redux state.
+ * Used for SSR surrogate key tracking and performance metrics.
+ */
+export interface ApiMetrics {
+    context: 'ssr' | 'client';
+    statusCode: number;
+    contentLength?: number;
+    duration?: number;
+    url: string;
+    /** Only populated during SSR — meaningless client-side. */
+    surrogateKeys?: string[];
+}
+/**
+ * Record API call metrics. Surrogate keys are only included during SSR.
+ */
+export declare const setApiMetrics: (metrics: ApiMetrics) => any;

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

@@ -17,18 +17,18 @@ 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 selectQueryStringAsObject: ((state: AppState) => import("query-string").ParsedQuery<string>) & {
     clearCache: () => void;
     resultsCount: () => number;
     resetResultsCount: () => void;
 } & {
-    resultFunc: (resultFuncArgs_0: any) => any;
-    memoizedResultFunc: ((resultFuncArgs_0: any) => any) & {
+    resultFunc: (resultFuncArgs_0: any) => import("query-string").ParsedQuery<string>;
+    memoizedResultFunc: ((resultFuncArgs_0: any) => import("query-string").ParsedQuery<string>) & {
         clearCache: () => void;
         resultsCount: () => number;
         resetResultsCount: () => void;
     };
-    lastResult: () => any;
+    lastResult: () => import("query-string").ParsedQuery<string>;
     dependencies: [(state: AppState) => any];
     recomputations: () => number;
     resetRecomputations: () => void;

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

@@ -4,7 +4,7 @@ export declare const SET_NODE = "@ROUTING/_SET_NODE";
 export declare const SET_ANCESTORS = "@ROUTING/_SET_ANCESTORS";
 export declare const SET_SIBLINGS = "@ROUTING/_SET_SIBLINGS";
 export declare const SET_ENTRY_ID = "@ROUTING/_SET_ENTRY_ID";
-export declare const SET_SURROGATE_KEYS = "@ROUTING/_SET_SURROGATE_KEYS";
+export declare const SET_API_METRICS = "@ROUTING/_SET_API_METRICS";
 export declare const SET_NAVIGATION_PATH = "@ROUTING/_SET_NAVIGATION_PATH";
 export declare const SET_TARGET_PROJECT = "@ROUTING/_SET_TARGET_PROJECT";
 export declare const SET_ROUTE = "@ROUTING/_SET_ROUTE";

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

@@ -5,7 +5,7 @@ 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<InitListingAction> | import("redux-saga/effects").CallEffect<void> | import("redux-saga/effects").PutEffect<{
     type: string;
-    config?: import("../models/Search").SearchFacet | import("../models/Search").Listing;
+    config?: import("..").SearchFacet | import("..").Listing;
     context: Context | string;
     debug?: import("../models/SearchActions").DebugFlags;
     defaultLang?: string;

package/models/server/features/reverse-proxy/index.d.ts

@@ -1,5 +1,6 @@
 import { Express } from 'express';
-export declare const assetProxy: any;
-export declare const deliveryProxy: any;
+import httpProxy from 'http-proxy';
+export declare const assetProxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
+export declare const deliveryProxy: httpProxy<import("http").IncomingMessage, import("http").ServerResponse<import("http").IncomingMessage>>;
 declare const reverseProxies: (app: Express, reverseProxyPaths?: string[]) => void;
 export default reverseProxies;

package/models/server/util/getVersionInfo.d.ts

@@ -1 +1,9 @@
+/**
+ * Arguably deprecated functionality driven by a version.json file
+ * injected into the container from the CI build process.
+ * This is used to provide version information for the application
+ * such as the commit id and the build number.
+ * @param staticFolderPath if the app is not built into the `dist/static` folder, we can provide a different path to the static folder.
+ * @returns version.json as a JSON object, or an empty object if the file cannot be read.
+ */
 export declare const getVersionInfo: (staticFolderPath: string) => any;

package/models/user/redux/sagas/login.d.ts

@@ -23,6 +23,6 @@ export declare function handleRequiresLoginSaga(action: any): Generator<import("
 }>>, any, [any, any]>> | import("redux-saga/effects").PutEffect<{
     type: string;
     cookies: any;
-    securityToken: any;
+    securityToken: string | (string | null)[] | null;
 }>, any, any>;
 export declare function refreshSecurityToken(): Generator<any, void, unknown>;

package/models/user/util/OidcUserManager.d.ts

@@ -1,19 +1,3 @@
-import { UserManagerSettings } from 'oidc-client';
-export declare const userManagerConfig: {
-    authority: string;
-    client_id: string;
-    redirect_uri: string;
-    post_logout_redirect_uri: string;
-    response_type: string;
-    scope: string;
-    filterProtocolClaims: boolean;
-} | {
-    authority?: undefined;
-    client_id?: undefined;
-    redirect_uri?: undefined;
-    post_logout_redirect_uri?: undefined;
-    response_type?: undefined;
-    scope?: undefined;
-    filterProtocolClaims?: undefined;
-};
+import type { UserManagerSettings } from 'oidc-client';
+export declare const userManagerConfig: UserManagerSettings;
 export declare const createUserManager: (config: UserManagerSettings) => Promise<import("oidc-client").UserManager | undefined>;

package/models/util/ContensisDeliveryApi.d.ts

@@ -10,7 +10,7 @@ export declare class DeliveryApi {
     cookies?: CookieObject;
     ssr?: SSRContext;
     constructor(ssr?: SSRContext);
-    getClientSideVersionStatus: () => any;
+    getClientSideVersionStatus: () => string | (string | null)[] | null;
     getServerSideVersionStatus: (request: Request) => "published" | "latest" | undefined;
     getVersionStatusFromHeaders: (headers: IncomingHttpHeaders) => string | string[] | null;
     getVersionStatusFromHostname: (currentHostname: string) => "published" | "latest";

package/models/util/donotuse_useHistory.d.ts

@@ -1,6 +1,6 @@
 /** @deprecated ponyfill for useHistory hook in react-router v5 removed in v6 */
 export declare const useHistory: () => {
-    push: import("react-router-dom").NavigateFunction;
-    replace: import("react-router-dom").NavigateFunction;
-    location: import("react-router-dom").Location<any>;
+    push: import("react-router").NavigateFunction;
+    replace: import("react-router").NavigateFunction;
+    location: import("react-router").Location<any>;
 };

package/models/util/env.d.ts

@@ -0,0 +1 @@
+export declare const isSSR: boolean;

package/models/util/navigation.d.ts

@@ -1,4 +1,4 @@
-export function queryParams(search: any): any;
+export function queryParams(search: any): import("query-string").ParsedQuery<string>;
 export function routeParams(staticRoute: any): any;
 export function buildUrl(route: any, params: any): any;
 export function clientHostname(): string;