@zengenti/contensis-react-base 2.4.1-beta.7 → 2.5.1-beta.0

package/models/user/hooks/useLogin.d.ts

@@ -0,0 +1,12 @@
+export default useLogin;
+declare function useLogin(): {
+    loginUser: (username: any, password: any) => any;
+    logoutUser: (redirectPath: any) => any;
+    authenticationError: any;
+    authenticationErrorMessage: any;
+    error: any;
+    errorMessage: any;
+    isAuthenticated: any;
+    isLoading: any;
+    user: any;
+};

package/models/user/hooks/useRegistration.d.ts

@@ -0,0 +1,8 @@
+export default useRegistration;
+declare function useRegistration(): {
+    registerUser: (user: any, mappers: any) => any;
+    error: any;
+    isLoading: any;
+    isSuccess: any;
+    user: any;
+};

package/models/user/index.d.ts

@@ -0,0 +1,16 @@
+export { LoginHelper } from './util/LoginHelper.class';
+export { default as LoginContainer } from './containers/Login.container';
+export { default as RegistrationContainer } from './containers/Registration.container';
+export { default as ForgotPasswordContainer } from './containers/ForgotPassword.container';
+export { default as ChangePassword } from './containers/ChangePassword.container';
+export { default as withLogin } from './hocs/withLogin';
+export { default as withRegistration } from './hocs/withRegistration';
+export { default as useLogin } from './hooks/useLogin';
+export { default as useRegistration } from './hooks/useRegistration';
+export { default as useForgotPassword } from './hooks/useForgotPassword';
+export { default as useChangePassword } from './hooks/useChangePassword';
+export { handleRequiresLoginSaga, refreshSecurityToken, } from './redux/sagas/login';
+export * as actions from './redux/actions';
+export { default as reducer, initialUserState } from './redux/reducers';
+export * as selectors from './redux/selectors';
+export * as types from './redux/types';

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

@@ -0,0 +1,6 @@
+export function loginUser(username: any, password: any): any;
+export function logoutUser(redirectPath: any): any;
+export function registerUser(user: any, mappers: any): any;
+export function requestPasswordReset(userEmailObject: any): any;
+export function resetPassword(resetPasswordObject: any): any;
+export function changePassword(userId: any, currentPassword: any, newPassword: any): any;

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

@@ -0,0 +1,4 @@
+export const initialUserState: Map<string, any>;
+declare function _default(state: Map<string, any> | undefined, action: any): any;
+export default _default;
+import { Map } from "immutable";

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

@@ -0,0 +1 @@
+export const userSagas: import("redux-saga/effects").ForkEffect<never>[];

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

@@ -0,0 +1,36 @@
+export function handleRequiresLoginSaga(action: any): Generator<import("redux-saga/effects").SelectEffect | import("redux-saga/effects").CallEffect<Generator<import("redux-saga/effects").SelectEffect | Promise<undefined[] | Error[] | {
+    message: string;
+}[] | {
+    message: string;
+    data: any;
+}[]> | import("redux-saga/effects").PutEffect<{
+    type: string;
+    authenticationState: {
+        error: {
+            message: any;
+            stack: any;
+        };
+    };
+}> | import("redux-saga/effects").CallEffect<Generator<Promise<{
+    authenticationState: {
+        authenticated: boolean;
+        authenticationError: boolean;
+        error: boolean;
+        clientCredentials: null;
+    };
+    user: Error | {
+        groups: any;
+    } | null | undefined;
+}> | import("redux-saga/effects").PutEffect<{
+    type: string;
+    authenticationState: any;
+    user: any;
+}>, void, {
+    authenticationState: any;
+    user: any;
+}>>, any, [any, any]>> | import("redux-saga/effects").PutEffect<{
+    type: string;
+    securityToken: any;
+}>, void, any>;
+export function refreshSecurityToken(): Generator<any, void, unknown>;
+export const loginSagas: import("redux-saga/effects").ForkEffect<never>[];

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

@@ -0,0 +1 @@
+export const registerSagas: import("redux-saga/effects").ForkEffect<never>[];

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

@@ -0,0 +1 @@
+export const resetPasswordSagas: import("redux-saga/effects").ForkEffect<never>[];

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

@@ -0,0 +1,27 @@
+export function selectUserIsLoading(state: any): any;
+export function selectUserIsAuthenticated(state: any): any;
+export function selectUserAuthenticationError(state: any): any;
+export function selectUserAuthenticationErrorMessage(state: any): any;
+export function selectUserError(state: any): any;
+export function selectUserErrorMessage(state: any): any;
+export function selectClientCredentials(state: any): any;
+export function selectUser(state: any): any;
+export function selectUserIsZengentiStaff(state: any): any;
+export function selectUserGuid(state: any): any;
+export function selectUsername(state: any): any;
+export function selectUserEmail(state: any): any;
+export function selectUserGroups(state: any): any;
+export function selectUserSecurityToken(state: any): any;
+export function selectUserRegistration(state: any): any;
+export function selectUserRegistrationError(state: any): any;
+export function selectUserRegistrationIsLoading(state: any): any;
+export function selectUserRegistrationIsSuccess(state: any): any;
+export function selectPasswordResetRequestSending(state: any): any;
+export function selectPasswordResetRequestSent(state: any): any;
+export function selectPasswordResetRequestError(state: any): any;
+export function selectResetPasswordSending(state: any): any;
+export function selectResetPasswordSent(state: any): any;
+export function selectResetPasswordError(state: any): any;
+export function selectChangePasswordSending(state: any): any;
+export function selectChangePasswordSent(state: any): any;
+export function selectChangePasswordError(state: any): any;

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

@@ -0,0 +1,21 @@
+export const VALIDATE_USER: string;
+export const SET_AUTHENTICATION_STATE: string;
+export const LOGIN_USER: string;
+export const LOGIN_SUCCESSFUL: string;
+export const LOGIN_FAILED: string;
+export const LOGOUT_USER: string;
+export const REGISTER_USER: string;
+export const REGISTER_USER_SUCCESS: string;
+export const REGISTER_USER_FAILED: string;
+export const REQUEST_USER_PASSWORD_RESET: string;
+export const RESET_USER_PASSWORD: string;
+export const REQUEST_USER_PASSWORD_RESET_SENDING: string;
+export const REQUEST_USER_PASSWORD_RESET_SUCCESS: string;
+export const REQUEST_USER_PASSWORD_RESET_ERROR: string;
+export const RESET_USER_PASSWORD_SENDING: string;
+export const RESET_USER_PASSWORD_SUCCESS: string;
+export const RESET_USER_PASSWORD_ERROR: string;
+export const CHANGE_USER_PASSWORD: string;
+export const CHANGE_USER_PASSWORD_SENDING: string;
+export const CHANGE_USER_PASSWORD_SUCCESS: string;
+export const CHANGE_USER_PASSWORD_ERROR: string;

package/models/user/transformations/mapClientCredentials.d.ts

@@ -0,0 +1,2 @@
+declare function _default(obj: any): any;
+export default _default;

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

@@ -0,0 +1,9 @@
+export function getManagementApiClient({ bearerToken, bearerTokenExpiryDate, refreshToken, refreshTokenExpiryDate, contensisClassicToken, username, password, }: {
+    bearerToken: any;
+    bearerTokenExpiryDate: any;
+    refreshToken: any;
+    refreshTokenExpiryDate: any;
+    contensisClassicToken: any;
+    username: any;
+    password: any;
+}): Promise<import("contensis-management-api").Client>;

package/models/user/util/CookieHelper.class.d.ts

@@ -0,0 +1,5 @@
+export class CookieHelper {
+    static GetCookie(name: any): any;
+    static SetCookie(name: any, value: any, maxAgeDays?: number): void;
+    static DeleteCookie(name: any): void;
+}

package/models/user/util/LoginHelper.class.d.ts

@@ -0,0 +1,52 @@
+export const LOGIN_COOKIE: "ContensisCMSUserName";
+export const REFRESH_TOKEN_COOKIE: "RefreshToken";
+export class LoginHelper {
+    static CMS_URL: string;
+    static WSFED_LOGIN: boolean;
+    static LOGIN_ROUTE: string;
+    static ACCESS_DENIED_ROUTE: string;
+    static SetLoginCookies({ contensisClassicToken, refreshToken }: {
+        contensisClassicToken: any;
+        refreshToken: any;
+    }): void;
+    static GetCachedCredentials(): {
+        bearerToken: null;
+        bearerTokenExpiryDate: null;
+        refreshToken: any;
+        refreshTokenExpiryDate: null;
+        contensisClassicToken: any;
+    };
+    static ClearCachedCredentials(): void;
+    static LoginUser({ username, password, clientCredentials }: {
+        username: any;
+        password: any;
+        clientCredentials: any;
+    }): Promise<{
+        authenticationState: {
+            authenticated: boolean;
+            authenticationError: boolean;
+            error: boolean;
+            clientCredentials: null;
+        };
+        user: Error | {
+            groups: any;
+        } | null | undefined;
+    }>;
+    static GetUserDetails: (client: any) => Promise<(Error | {
+        groups: any;
+    } | null)[]>;
+    static LogoutUser(redirectPath: any): void;
+    static ClientRedirectToHome(location: any): void;
+    static ClientRedirectToSignInPage(redirectPath: any): Promise<void>;
+    static ClientRedirectToAccessDeniedPage(originalPath: any): void;
+    static ClientRedirectToPath(redirectPath: any): void;
+    static WsFedLogin(redirectUri: any): Promise<void>;
+    static WsFedLogout(redirectPath: any): Promise<void>;
+    static GetCredentialsForSecurityToken(securityToken: any): Promise<undefined[] | Error[] | {
+        message: string;
+    }[] | {
+        message: string;
+        data: any;
+    }[]>;
+    static isZengentiStaff(email: any): boolean;
+}

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

@@ -0,0 +1,18 @@
+export 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;
+};
+export function createUserManager(config: any): Promise<{} | undefined>;

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

@@ -0,0 +1,3 @@
+import { Group } from 'contensis-management-api/lib/models';
+import { RequireLogin } from "../../routing/routes";
+export declare const matchUserGroup: (userGroups?: Group[], requiredGroups?: RequireLogin) => boolean;

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

@@ -0,0 +1,12 @@
+export class UserHelper {
+    static GetUsersEnvironments(securityToken: any): Promise<any>;
+    static ResendUserVerification(userEmail: any): Promise<any>;
+    static RequestPasswordReset(userEmailObject: any): Promise<any>;
+    static ResetPassword(resetPasswordObject: any): Promise<any>;
+    static get(url: any, options?: {
+        method: string;
+        headers: {
+            'Content-Type': string;
+        };
+    }): Promise<any>;
+}

package/models/util/ContensisDeliveryApi.d.ts

@@ -0,0 +1,40 @@
+export * from "contensis-delivery-api";
+export const deliveryApi: DeliveryApi;
+export const cachedSearch: CachedSearch;
+declare class DeliveryApi {
+    getClientSideVersionStatus: () => "published" | "latest" | null;
+    getVersionStatusFromHostname: (currentHostname: any) => "published" | "latest";
+    search: (query: any, linkDepth: any, project: any, env: any) => Promise<import("contensis-core-api").PagedList<import("contensis-delivery-api/lib/models").Entry>>;
+    getClient: (deliveryApiStatus: string | undefined, project: any, env: any) => Client;
+    getEntry: (id: any, linkDepth: number | undefined, deliveryApiStatus: string | undefined, project: any, env: any) => Promise<import("contensis-delivery-api/lib/models").Entry>;
+}
+declare class CachedSearch {
+    cache: LruCache;
+    taxonomyLookup: {};
+    search(query: any, linkDepth: any, project: any, env: any): any;
+    get(id: any, linkDepth: any, versionStatus: any, project: any, env: any): any;
+    getContentType(id: any, project: any, env: any): any;
+    getTaxonomyNode(key: any, project: any, env: any): any;
+    getRootNode(options: any, project: any, env: any): any;
+    getNode(options: any, project: any, env: any): any;
+    getAncestors(options: any, project: any, env: any): any;
+    getChildren(options: any, project: any, env: any): any;
+    getSiblings(options: any, project: any, env: any): any;
+    request(key: any, execute: any): any;
+    extendTaxonomyNode(node: any): any;
+    getTaxonomyId(node: any): any;
+    getTaxonomyKey(id: any): any;
+}
+import { Client } from "contensis-delivery-api";
+declare class LruCache {
+    constructor(limit?: number);
+    map: {};
+    head: any;
+    tail: any;
+    limit: number;
+    size: number;
+    get(key: any): any;
+    set(key: any, value: any): void;
+    setHead(node: any): void;
+    remove(key: any): void;
+}

package/models/util/ToJs.d.ts

@@ -0,0 +1 @@
+export function toJS(WrappedComponent: any): (wrappedComponentProps: any) => JSX.Element;

package/models/util/fromJSLeaveImmer.d.ts

@@ -0,0 +1,2 @@
+export default fromJSLeaveImmer;
+declare function fromJSLeaveImmer(js: any): any;

package/models/util/fromJSOrdered.d.ts

@@ -0,0 +1,2 @@
+export default fromJSOrdered;
+declare function fromJSOrdered(js: any): any;

package/models/util/index.d.ts

@@ -0,0 +1,5 @@
+export { default as setCachingHeaders } from "../server/features/caching/setCachingHeaders";
+export { default as stringifyStrings } from './stringifyStrings';
+export { default as urls } from './urls';
+export * from './json-mapper';
+export { default as VersionInfo } from "../app/pages/VersionInfo";

package/models/util/json-mapper.d.ts

@@ -0,0 +1,81 @@
+import mapJson from 'jsonpath-mapper';
+import MappingTemplate from 'jsonpath-mapper/dist/models/Template';
+import { EntryMapper } from "../routing/routes";
+export { default as mapJson, jpath } from 'jsonpath-mapper';
+declare type Mappers<S> = {
+    [contentTypeId: string]: MappingTemplate<S>;
+};
+/**
+ *
+ * @param {object} json The source object we wish to transform
+ * @param {object} template The mapping template we wish to apply to the source
+ * object to generate the intended target object
+ */
+export declare const useMapper: <T, S>(json: S, template: MappingTemplate<S>) => T | S;
+/**
+ * useEntriesMapper hook to take a list of entries from Delivery API along
+ * with mappers for each contentTypeId and return an array of mapped objects
+ * @param {any} entry The source entry we wish to transform
+ * @param {object} mappers Object with keys containing mapper templates,
+ * the key name matching sys.contentTypeId
+ * @param {string} field Only include if we need to match content based on
+ * a field other than sys.contentTypeId in the source data
+ * @returns {object} Object transformed using a matched content type or
+ * a default mapper template, returns an empty object if no mapper template
+ * couild be applied.
+ */
+export declare const useEntriesMapper: <S, T extends Mappers<S>>(entry: S, mappers: T, field?: string) => unknown;
+/**
+ * Deprecated: due to misleading name, use the hook useEntriesMapper instead
+ */
+export declare const useEntryMapper: <S, T extends Mappers<S>>(entry: S, mappers: T, field?: string) => unknown;
+/**
+ * mapEntries mapping function to take a list of entries from Delivery API along
+ * with mappers for each contentTypeId and return an array of mapped objects
+ * @param {any} entry The source entry we wish to transform
+ * @param {object} mappers Object with keys containing mapper templates,
+ * the key name matching sys.contentTypeId
+ * @param {string} field Only include if we need to match content based on
+ * a field other than sys.contentTypeId in the source data
+ * @returns {object} Object transformed using a matched content type or
+ * a default mapper template, returns an empty object if no mapper template
+ * couild be applied.
+ */
+export declare const mapEntries: <S, Mappers_1 extends {
+    [contentTypeId: string]: MappingTemplate<S>;
+}>(entries: S[], mappers: Mappers_1, field?: string) => unknown[];
+/**
+ * mapComposer mapping function to take a composer field from Delivery API along
+ * with mappers for each Composer Item "type" and return an array of mapped components
+ * @param {array} composer Composer field array of Composer Items
+ * @param {object} mappers A keyed object with each key matching the Composer Item "type"
+ * @returns {array} Array of mapped objects transformed using a matched Composer Item "type" mapping
+ * or null. Injects a "_type" property into each transformed object in the array to indicate
+ * where the mapping originated and for what component the mapped object is representing
+ */
+export declare const mapComposer: <S extends {
+    type: string;
+    value: any;
+}, T extends Mappers<S>>(composer: S[], mappers: T) => any[];
+/**
+ * useComposerMapper hook to take a composer field from Delivery API along
+ * with mappers for each Composer Item "type" and return an array of mapped components
+ * @param {array} composer Composer field array of Composer Items
+ * @param {object} mappers A keyed object with each key matching the Composer Item "type"
+ * @returns {array} Array of mapped objects transformed using a matched Composer Item "type" mapping
+ * or null. Injects a "_type" property into each transformed object in the array to indicate
+ * where the mapping originated and for what component the mapped object is representing
+ */
+export declare const useComposerMapper: <S extends {
+    type: string;
+    value: any;
+}, T extends Mappers<S>>(composer: S[] | undefined, mappers: T) => any[];
+/**
+ * entryMapper will return a function to satisfy an entryMapper when defining app route
+ * this is essentially a shorthand function to prevent boilerplate repetition inside your routes file
+ * you do not need to use this function should you wish to map your entry via raw JS functions
+ * @param mapping the jsonpath-mapper mapping template to apply when the route is resolved
+ * @returns {mappedEntry}
+ */
+export declare const entryMapper: (mapping: any) => EntryMapper;
+export default mapJson;

package/models/util/navHelper.d.ts

@@ -0,0 +1,7 @@
+export function componentWillMountNavHandler(props: any, urlPropsQueryConfig: any): void;
+export function componentWillReceivePropsNavHandler(nextProps: any, component: any, urlPropsQueryConfig: any, currentPath: any): void;
+export function getUrlFromNavigationSettings(entry: any): string;
+export function getParentUrlFromNavigationSettings(entry: any): string;
+export function getLeafSlugFromRoute(currentPath: any): any;
+export function validateRouteFromNavigationSettings(currentPath: any, entry: any): boolean;
+export function getPathFromEntry(entry: any): any;

package/models/util/navigation.d.ts

@@ -0,0 +1,4 @@
+export function queryParams(search: any): any;
+export function routeParams(staticRoute: any): any;
+export function buildUrl(route: any, params: any): any;
+export function clientHostname(): string;

package/models/util/performance.d.ts

@@ -0,0 +1 @@
+export function now(): number;

package/models/util/pickProject.d.ts

@@ -0,0 +1,2 @@
+export default pickProject;
+declare function pickProject(hostname: any, query: any): any;

package/models/util/stringifyStrings.d.ts

@@ -0,0 +1,2 @@
+export = stringifyStrings;
+declare function stringifyStrings(obj: any): {};

package/models/util/urls.d.ts

@@ -0,0 +1,9 @@
+declare const url: (alias: string, project: string) => {
+    api: string;
+    cms: string;
+    liveWeb: string;
+    previewWeb: string;
+    iisWeb: string;
+    iisPreviewWeb: string;
+};
+export default url;