@commercetools-frontend/application-shell 0.0.0-CRAFT-1791-20251006162610

package/dist/declarations/src/components/application-shell-provider/application-shell-provider.d.ts

@@ -0,0 +1,17 @@
+import { JSX } from 'react';
+import { ApolloClient, type NormalizedCacheObject } from '@apollo/client';
+import { type TApplicationContext } from "../../../../application-shell-connectors/dist/commercetools-frontend-application-shell-connectors.cjs.js";
+import type { TAsyncLocaleDataProps } from '@commercetools-frontend/i18n';
+type TApplicationShellProviderProps = {
+    apolloClient?: ApolloClient<NormalizedCacheObject>;
+    environment: TApplicationContext<{}>['environment'];
+    applicationMessages: TAsyncLocaleDataProps['applicationMessages'];
+    children: (args: {
+        isAuthenticated: boolean;
+    }) => JSX.Element;
+};
+declare const ApplicationShellProvider: {
+    (props: TApplicationShellProviderProps): import("@emotion/react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default ApplicationShellProvider;

package/dist/declarations/src/components/application-shell-provider/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./application-shell-provider.js";

package/dist/declarations/src/components/application-shell-provider/utils.d.ts

@@ -0,0 +1,3 @@
+import { type EnhancedHistory } from '@commercetools-frontend/browser-history';
+export declare const getBrowserHistory: () => EnhancedHistory;
+export declare const getBrowserLocale: (win: Window) => import("@commercetools-frontend/l10n/supported-locales").TSupportedLocale;

package/dist/declarations/src/components/configure-intl-provider/configure-intl-provider.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+import type { IntlConfig } from 'react-intl';
+type Props = {
+    locale?: string;
+    messages?: IntlConfig['messages'];
+    children: ReactNode;
+};
+declare const ConfigureIntlProvider: {
+    (props: Props): import("@emotion/react/jsx-runtime").JSX.Element | null;
+    displayName: string;
+};
+export default ConfigureIntlProvider;

package/dist/declarations/src/components/configure-intl-provider/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./configure-intl-provider.js";

package/dist/declarations/src/components/custom-view-shell/custom-view-shell.d.ts

@@ -0,0 +1,12 @@
+import { type ReactNode } from 'react';
+import { ApolloClient, type NormalizedCacheObject } from '@apollo/client';
+import { type TAsyncLocaleDataProps } from '@commercetools-frontend/i18n';
+type TCustomViewShellProps = {
+    apolloClient?: ApolloClient<NormalizedCacheObject>;
+    applicationMessages: TAsyncLocaleDataProps['applicationMessages'];
+    disableDevHost?: boolean;
+    enableReactStrictMode?: boolean;
+    children: ReactNode;
+};
+declare const CustomViewShellWrapper: (props: TCustomViewShellProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export default CustomViewShellWrapper;

package/dist/declarations/src/components/custom-view-shell/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./custom-view-shell.js";

package/dist/declarations/src/components/error-apologizer/index.d.ts

@@ -0,0 +1,5 @@
+declare const ErrorApologizer: import("react").LazyExoticComponent<{
+    (): import("@emotion/react/jsx-runtime").JSX.Element;
+    displayName: string;
+}>;
+export default ErrorApologizer;

package/dist/declarations/src/components/fetch-user/fetch-user.d.ts

@@ -0,0 +1,16 @@
+import { ReactNode } from 'react';
+import type { ApolloError } from '@apollo/client/errors';
+import type { TFetchLoggedInUserQuery } from "../../types/generated/mc.js";
+type RenderFnArgs = {
+    isLoading: boolean;
+    error?: ApolloError;
+    user: TFetchLoggedInUserQuery['user'];
+};
+type TFetchUserProps = {
+    children: (args: RenderFnArgs) => ReactNode;
+};
+declare const FetchUser: {
+    (props: TFetchUserProps): import("@emotion/react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default FetchUser;

package/dist/declarations/src/components/fetch-user/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./fetch-user.js";

package/dist/declarations/src/components/inject-reducers/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./inject-reducers.js";

package/dist/declarations/src/components/inject-reducers/inject-reducers.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+import type { ReducersMapObject } from 'redux';
+type Props = {
+    id: string;
+    reducers: ReducersMapObject;
+    shouldCleanUpOnUnmount?: boolean;
+    children: ReactNode;
+};
+declare const InjectReducers: {
+    ({ shouldCleanUpOnUnmount, ...props }: Props): import("@emotion/react/jsx-runtime").JSX.Element | null;
+    displayName: string;
+};
+export default InjectReducers;

package/dist/declarations/src/components/redirect-to-login/index.d.ts

@@ -0,0 +1,5 @@
+declare const RedirectToLogin: import("react").LazyExoticComponent<{
+    (): null;
+    displayName: string;
+}>;
+export default RedirectToLogin;

package/dist/declarations/src/components/redirect-to-logout/index.d.ts

@@ -0,0 +1,4 @@
+declare const RedirectToLogout: import("react").LazyExoticComponent<(props: {
+    reason?: typeof import("@commercetools-frontend/constants").LOGOUT_REASONS[keyof typeof import("@commercetools-frontend/constants").LOGOUT_REASONS];
+}) => import("@emotion/react/jsx-runtime").JSX.Element>;
+export default RedirectToLogout;

package/dist/declarations/src/components/route-catch-all/index.d.ts

@@ -0,0 +1,2 @@
+declare const RouteCatchAll: import("react").LazyExoticComponent<() => import("@emotion/react/jsx-runtime").JSX.Element>;
+export default RouteCatchAll;

package/dist/declarations/src/components/setup-flop-flip-provider/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./setup-flop-flip-provider.js";

package/dist/declarations/src/components/setup-flop-flip-provider/setup-flop-flip-provider.d.ts

@@ -0,0 +1,17 @@
+import { ReactNode } from 'react';
+import { type TFlags } from '@flopflip/types';
+import type { TFetchLoggedInUserQuery } from "../../types/generated/mc.js";
+type TSetupFlopFlipProviderProps = {
+    projectKey?: string;
+    user?: TFetchLoggedInUserQuery['user'];
+    flags?: TFlags;
+    defaultFlags?: TFlags;
+    ldClientSideId?: string;
+    children: ReactNode;
+    shouldDeferAdapterConfiguration?: boolean;
+};
+export declare const SetupFlopFlipProvider: {
+    (props: TSetupFlopFlipProviderProps): import("@emotion/react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default SetupFlopFlipProvider;

package/dist/declarations/src/components/suspended-route/index.d.ts

@@ -0,0 +1,3 @@
+export { SuspendedRoute } from "./suspended-route.js";
+export { SuspendedProtectedRoute } from "./suspended-protected-route.js";
+export { ProtectedRoute } from "./protected-route.js";

package/dist/declarations/src/components/suspended-route/protected-route.d.ts

@@ -0,0 +1,7 @@
+import { RouteProps } from 'react-router-dom';
+type TProtectedRouteProps = {
+    condition: boolean;
+    fallback?: React.ReactNode;
+} & RouteProps;
+declare const ProtectedRoute: React.FC<TProtectedRouteProps>;
+export { ProtectedRoute, type TProtectedRouteProps };

package/dist/declarations/src/components/suspended-route/suspended-protected-route.d.ts

@@ -0,0 +1,7 @@
+import { type TProtectedRouteProps } from "./protected-route.js";
+type TSuspendedProtectedRouteProps = TProtectedRouteProps & {
+    loading?: React.ReactNode;
+    fallback?: React.ReactNode;
+};
+declare const SuspendedProtectedRoute: React.FC<TSuspendedProtectedRouteProps>;
+export { SuspendedProtectedRoute, type TSuspendedProtectedRouteProps };

package/dist/declarations/src/components/suspended-route/suspended-route.d.ts

@@ -0,0 +1,10 @@
+import { type ReactNode } from 'react';
+import { type RouteProps } from 'react-router-dom';
+type TSuspendedRouteProps = Omit<RouteProps, 'children'> & {
+    children: ReactNode;
+};
+declare const SuspendedRoute: {
+    (props: TSuspendedRouteProps): import("@emotion/react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export { SuspendedRoute };

package/dist/declarations/src/configure-store.d.ts

@@ -0,0 +1,22 @@
+import { type ReducersMapObject, type Store, type Middleware, type StoreEnhancer } from '@reduxjs/toolkit';
+export type TEnhancedStore = Store & {
+    injectedReducers: {
+        [key: string]: ReducersMapObject;
+    };
+    injectReducers: (payload: {
+        id: string;
+        reducers: ReducersMapObject;
+    }) => void;
+    removeReducers: (payload: {
+        id: string;
+    }) => void;
+};
+/**
+ * @deprecated: This function should not be used directly anymore.
+ */
+export declare const applyDefaultMiddlewares: (...middlewares: Middleware[]) => StoreEnhancer<{
+    dispatch: unknown;
+}, {}>;
+export declare const createReduxStore: (preloadedState?: {}, additionalMiddlewares?: Middleware[]) => TEnhancedStore;
+declare const _default: TEnhancedStore;
+export default _default;

package/dist/declarations/src/export-types.d.ts

@@ -0,0 +1,8 @@
+import type { TApolloContext as ApolloContext, THttpClientFetcher as TFetcher, THttpClientFetcherResponse as TFetcherResponse, THttpClientHeaders as THeaders, THttpClientConfig as TConfig, THttpClientOptions as TOptions, TForwardToAudiencePolicy as ForwardToAudiencePolicy } from "../../application-shell-connectors/dist/commercetools-frontend-application-shell-connectors.cjs.js";
+export type TApolloContext = ApolloContext;
+export type TForwardToAudiencePolicy = ForwardToAudiencePolicy;
+export type THttpClientFetcher<Data> = TFetcher<Data>;
+export type THttpClientFetcherResponse<Data> = TFetcherResponse<Data>;
+export type THttpClientHeaders = THeaders;
+export type THttpClientConfig = TConfig;
+export type THttpClientOptions = TOptions;

package/dist/declarations/src/hooks/use-routes-creator/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./use-routes-creator.js";

package/dist/declarations/src/hooks/use-routes-creator/use-routes-creator.d.ts

@@ -0,0 +1,22 @@
+import type { History } from 'history';
+import { useLocation } from 'react-router-dom';
+export interface RouteParams extends Record<string, string> {
+}
+/**
+ * The route path to match. Usually it starts with `/:projectKey/my-entry-point`.
+ */
+export type RoutePath = string;
+export type TMakeRouteOptions<Params extends RouteParams> = {
+    params: Partial<Params>;
+    goTo: History['push'];
+    location: ReturnType<typeof useLocation>;
+};
+export type TRoute<Params extends RouteParams> = {
+    path: string;
+    getUrl: (params?: Params, nextQueryParams?: URLSearchParams) => string;
+    go: (params?: Params, nextQueryParams?: URLSearchParams) => void;
+};
+declare function useRoutesCreator(): {
+    createRoute: <ParamKeys>(routePath: RoutePath) => TRoute<ParamKeys extends string ? Record<ParamKeys, string> : never>;
+};
+export default useRoutesCreator;

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,33 @@
+export * from "./export-types.js";
+export { default as version } from "./version.js";
+export { default as ApplicationShell } from "./components/application-shell/index.js";
+export { default as ApplicationShellProvider } from "./components/application-shell-provider/index.js";
+export { getBrowserLocale } from "./components/application-shell-provider/utils.js";
+export { default as ApplicationPageTitle } from "./components/application-page-title/index.js";
+export { default as CustomViewShell } from "./components/custom-view-shell/index.js";
+export { default as FetchUser } from "./components/fetch-user/index.js";
+export { default as ErrorApologizer } from "./components/error-apologizer/index.js";
+export { applyDefaultMiddlewares } from "./configure-store.js";
+export { default as InjectReducers } from "./components/inject-reducers/index.js";
+export { default as RedirectToLogin } from "./components/redirect-to-login/index.js";
+export { default as RedirectToLogout } from "./components/redirect-to-logout/index.js";
+export { default as RouteCatchAll } from "./components/route-catch-all/index.js";
+export { default as SetupFlopFlipProvider } from "./components/setup-flop-flip-provider/index.js";
+export { default as ConfigureIntlProvider } from "./components/configure-intl-provider/index.js";
+export { SuspendedRoute, ProtectedRoute, SuspendedProtectedRoute, } from "./components/suspended-route/index.js";
+export { default as getPreviousProjectKey } from "./utils/get-previous-project-key/index.js";
+export { default as setupGlobalErrorListener } from "./utils/setup-global-error-listener/index.js";
+export { default as useRoutesCreator } from "./hooks/use-routes-creator/index.js";
+export { buildApiUrl, createApolloClient, createApolloContextForProxyForwardTo, createHttpClientOptions, executeHttpClientRequest, getMcApiUrl, selectUserId, selectProjectKeyFromUrl, useMcQuery, useMcLazyQuery, useMcMutation, } from "../../application-shell-connectors/dist/commercetools-frontend-application-shell-connectors.cjs.js";
+export { entryPointUriPathToPermissionKeys, entryPointUriPathToResourceAccesses, } from '@commercetools-frontend/application-config/ssr';
+/**
+ * NOTE:
+ *    These are library re-exports which are shared between app-kit and
+ *    MC apps. Not having them re-exported here often leads to bundling
+ *    them twice given app-kit and any MC app require different versions.
+ *    Something they never should anyways and causes breakage.
+ *
+ *    More information can be found here: https://github.com/commercetools/fe-chapter-notes/issues/61
+ */
+export { ToggleFeature, injectFeatureToggle, injectFeatureToggles, branchOnFeatureToggle, ConfigureFlopFlip, ReconfigureFlopFlip, useFeatureToggle, useFeatureToggles, useFlagVariation, useFlagVariations, useAdapterStatus, useAdapterReconfiguration, } from '@flopflip/react-broadcast';
+export { adapter as ldAdapter } from '@flopflip/launchdarkly-adapter';

package/dist/declarations/src/ssr/index.d.ts

@@ -0,0 +1,2 @@
+export { entryPointUriPathToPermissionKeys, entryPointUriPathToResourceAccesses, } from '@commercetools-frontend/application-config/ssr';
+export { buildOidcScope } from "../utils/oidc.js";

package/dist/declarations/src/test-utils/custom-views-utils.d.ts

@@ -0,0 +1,21 @@
+import type { ReactNode } from 'react';
+import { ApolloClient, type NormalizedCacheObject } from '@apollo/client';
+import type { RenderResult } from '@testing-library/react';
+import { type TProviderProps } from "../../../application-shell-connectors/dist/commercetools-frontend-application-shell-connectors.cjs.js";
+import { type CustomViewData } from '@commercetools-frontend/constants';
+type TRenderCustomViewParams = {
+    locale: string;
+    projectKey?: string;
+    projectAllAppliedPermissions?: {
+        name: string;
+        value: boolean;
+    }[];
+    customViewHostUrl?: string;
+    customViewConfig?: Partial<CustomViewData>;
+    apolloClient?: ApolloClient<NormalizedCacheObject>;
+    environment?: Partial<TProviderProps<{}>['environment']>;
+    user?: Partial<TProviderProps<{}>['user']>;
+    children: ReactNode;
+};
+export declare const renderCustomView: (props: TRenderCustomViewParams) => RenderResult;
+export {};

package/dist/declarations/src/test-utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./test-utils.js";
+export * from "./custom-views-utils.js";

package/dist/declarations/src/test-utils/test-utils.d.ts

@@ -0,0 +1,87 @@
+import { type ReactElement } from 'react';
+import { ApolloClient, type NormalizedCacheObject } from '@apollo/client';
+import { type MockedResponse } from '@apollo/client/testing';
+import type { TFlags } from '@flopflip/types';
+import * as rtl from '@testing-library/react';
+import { type TProviderProps } from "../../../application-shell-connectors/dist/commercetools-frontend-application-shell-connectors.cjs.js";
+import { createEnhancedHistory } from '@commercetools-frontend/browser-history';
+import { type TMapNotificationToComponentProps } from '@commercetools-frontend/react-notifications';
+import { type TSdkMock } from '@commercetools-frontend/sdk/test-utils';
+import { createReduxStore } from "../configure-store.js";
+type TPermissions = {
+    [key: string]: boolean;
+};
+type TAllAppliedPermission = {
+    name: string;
+    value: boolean;
+};
+declare const denormalizePermissions: (permissions?: TPermissions) => TAllAppliedPermission[];
+type TNormalizedActionRights = {
+    [key: string]: TPermissions;
+};
+type TAllAppliedActionRight = TAllAppliedPermission & {
+    group: string;
+};
+declare const denormalizeActionRights: (actionRights?: TNormalizedActionRights) => TAllAppliedActionRight[];
+type TNormalizedDataFenceStorePermissions = {
+    [key: string]: {
+        values: string[];
+    };
+};
+type TNormalizedDataFenceStores = {
+    [key: string]: TNormalizedDataFenceStorePermissions;
+};
+type TNormalizedDataFences = {
+    store: TNormalizedDataFenceStores;
+};
+type TAllAppliedDataFence = {
+    __typename: 'StoreDataFence';
+    type: string;
+    name: string;
+    value: string;
+    group: string;
+};
+declare const denormalizeDataFences: (dataFences?: TNormalizedDataFences) => TAllAppliedDataFence[];
+declare const mapResourceAccessToAppliedPermissions: (resourceAccesses: string[]) => TAllAppliedPermission[];
+export type TRenderAppOptions<AdditionalEnvironmentProperties extends {} = {}> = {
+    locale: string;
+    mocks?: ReadonlyArray<MockedResponse>;
+    apolloClient?: ApolloClient<NormalizedCacheObject>;
+    route: string;
+    disableRoutePermissionCheck: boolean;
+    disableAutomaticEntryPointRoutes: boolean;
+    history: ReturnType<typeof createEnhancedHistory>;
+    flags: TFlags;
+    environment: Partial<TProviderProps<AdditionalEnvironmentProperties>['environment']>;
+    user: Partial<TProviderProps<AdditionalEnvironmentProperties>['user']>;
+    project: Partial<TProviderProps<AdditionalEnvironmentProperties>['project']>;
+    dataLocale: TProviderProps<AdditionalEnvironmentProperties>['projectDataLocale'];
+} & rtl.RenderOptions;
+type TRenderAppResult<AdditionalEnvironmentProperties extends {} = {}> = rtl.RenderResult & Pick<TRenderAppOptions<AdditionalEnvironmentProperties>, 'history' | 'user' | 'project' | 'environment'>;
+declare function renderApp<AdditionalEnvironmentProperties extends {} = {}>(ui: ReactElement, options?: Partial<TRenderAppOptions<AdditionalEnvironmentProperties>>): TRenderAppResult<AdditionalEnvironmentProperties>;
+export type TRenderAppWithReduxOptions<AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}> = {
+    store: ReturnType<typeof createReduxStore>;
+    storeState: StoreState;
+    sdkMocks: TSdkMock[];
+    mapNotificationToComponent: TMapNotificationToComponentProps['mapNotificationToComponent'];
+} & TRenderAppOptions<AdditionalEnvironmentProperties>;
+type TRenderAppWithReduxResult<AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}> = TRenderAppResult<AdditionalEnvironmentProperties> & Pick<TRenderAppWithReduxOptions<AdditionalEnvironmentProperties, StoreState>, 'store'>;
+declare function renderAppWithRedux<AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}>(ui: ReactElement, options?: Partial<TRenderAppWithReduxOptions<AdditionalEnvironmentProperties, StoreState>>): TRenderAppWithReduxResult<AdditionalEnvironmentProperties, StoreState>;
+export type TRenderHookOptions<RenderedHookProps, AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}> = TRenderAppWithReduxOptions<AdditionalEnvironmentProperties, StoreState> & rtl.RenderHookOptions<RenderedHookProps>;
+export type TRenderHookResult<RenderHookCallbackProps, RenderHookCallbackValue, AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}> = Omit<rtl.RenderHookResult<RenderHookCallbackProps, RenderHookCallbackValue>, 'rerender' | 'result'> & {
+    result: {
+        current: RenderHookCallbackValue;
+    };
+    rerender: (props?: RenderHookCallbackProps) => void;
+} & Pick<TRenderAppWithReduxResult<AdditionalEnvironmentProperties, StoreState>, 'store' | 'history' | 'user' | 'project' | 'environment'>;
+declare function renderHook<RenderedHookProps, RenderedHookResult, AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}>(callback: (props: RenderedHookProps) => RenderedHookResult, options?: Partial<TRenderHookOptions<RenderedHookProps, AdditionalEnvironmentProperties, StoreState>>): TRenderHookResult<RenderedHookProps, RenderedHookResult, AdditionalEnvironmentProperties, StoreState>;
+declare const hooks: {
+    renderHook: typeof renderHook;
+};
+type TCustomFireEventApi = typeof rtl.fireEvent & {
+    asyncFocus: (element: HTMLElement) => Promise<void>;
+    asyncBlur: (element: HTMLElement) => Promise<void>;
+};
+declare const customFireEvent: TCustomFireEventApi;
+export * from '@testing-library/react';
+export { renderApp, renderAppWithRedux, hooks, mapResourceAccessToAppliedPermissions, denormalizePermissions, denormalizeActionRights, denormalizeDataFences, customFireEvent, };