@commercetools-frontend/application-shell 0.0.0-FEC-157-preview-releases-20241126230331

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

@@ -0,0 +1,42 @@
+export declare const DIMENSIONS: {
+    readonly header: "56px";
+};
+export declare const NAVBAR: {
+    readonly expanderHeight: "50px";
+    readonly expanderSize: "40px";
+    readonly iconSize: "24px";
+    readonly iconSizeHover: "28px";
+    readonly itemSize: "48px";
+    readonly itemHeight: "56px";
+    readonly sublistIndentationWhenCollapsed: "72px";
+    readonly sublistIndentationWhenExpanded: "248px";
+    readonly sublistItemMinHeight: "50px";
+    readonly sublistWidth: "272px";
+    readonly leftNavigationTransition: "all 150ms cubic-bezier(1, 0, 0.58, 1)";
+    readonly widthLeftNavigation: "80px";
+    readonly widthLeftNavigationWhenExpanded: "256px";
+};
+export declare const WINDOW_SIZES: {
+    readonly STANDARD: 1024;
+    readonly WIDE: 1200;
+};
+export declare const CONTAINERS: {
+    readonly LOCALE_SWITCHER: "locale-switcher-container";
+    readonly LEFT_OF_PROFILE: "left-of-profile";
+};
+export declare const SUSPENSION_REASONS: {
+    readonly TEMPORARY_MAINTENANCE: "TemporaryMaintenance";
+    readonly PAYMENT: "Payment";
+    readonly OTHER: "Other";
+};
+export declare const OIDC_RESPONSE_TYPES: {
+    readonly ID_TOKEN: "id_token";
+};
+export declare const OIDC_CLAIMS: {
+    readonly OPEN_ID: "openid";
+    readonly PROJECT_KEY: "project_key";
+    readonly TEAM_ID: "team_id";
+    readonly APPLICATION_ID: "application_id";
+    readonly VIEW: "view";
+    readonly MANAGE: "manage";
+};

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 '@commercetools-frontend/application-shell-connectors';
+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-applications-menu/index.d.ts

@@ -0,0 +1 @@
+export { default } from './use-applications-menu';

package/dist/declarations/src/hooks/use-applications-menu/use-applications-menu.d.ts

@@ -0,0 +1,13 @@
+import type { QueryFunctionOptions } from '@apollo/client/react';
+import type { TApplicationContext } from '@commercetools-frontend/application-shell-connectors';
+import type { TFetchApplicationsMenuQuery } from '../../types/generated/proxy';
+export type MenuKey = 'appBar' | 'navBarGroups';
+export type MenuLoaderResult<Key extends MenuKey> = Key extends 'appBar' ? TFetchApplicationsMenuQuery['applicationsMenu']['appBar'] : Key extends 'navBarGroups' ? TFetchApplicationsMenuQuery['applicationsMenu']['navBarGroups'] : never;
+export type Config = {
+    environment: TApplicationContext<{}>['environment'];
+    queryOptions?: {
+        onError?: QueryFunctionOptions['onError'];
+    };
+};
+declare function useApplicationsMenu<Key extends MenuKey>(menuKey: Key, config: Config): MenuLoaderResult<Key> | undefined;
+export default useApplicationsMenu;

package/dist/declarations/src/hooks/use-is-served-by-proxy/index.d.ts

@@ -0,0 +1 @@
+export { default } from './use-is-served-by-proxy';

package/dist/declarations/src/hooks/use-is-served-by-proxy/use-is-served-by-proxy.d.ts

@@ -0,0 +1,2 @@
+declare const useIsServedByProxy: () => boolean;
+export default useIsServedByProxy;

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

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

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';
+export { default as version } from './version';
+export { default as ApplicationShell } from './components/application-shell';
+export { default as ApplicationShellProvider } from './components/application-shell-provider';
+export { getBrowserLocale } from './components/application-shell-provider/utils';
+export { default as ApplicationPageTitle } from './components/application-page-title';
+export { default as CustomViewShell } from './components/custom-view-shell';
+export { default as FetchUser } from './components/fetch-user';
+export { default as ErrorApologizer } from './components/error-apologizer';
+export { applyDefaultMiddlewares } from './configure-store';
+export { default as InjectReducers } from './components/inject-reducers';
+export { default as RedirectToLogin } from './components/redirect-to-login';
+export { default as RedirectToLogout } from './components/redirect-to-logout';
+export { default as RouteCatchAll } from './components/route-catch-all';
+export { default as SetupFlopFlipProvider } from './components/setup-flop-flip-provider';
+export { default as ConfigureIntlProvider } from './components/configure-intl-provider';
+export { default as SuspendedRoute } from './components/suspended-route';
+export { default as getPreviousProjectKey } from './utils/get-previous-project-key';
+export { default as setupGlobalErrorListener } from './utils/setup-global-error-listener';
+export { default as useRoutesCreator } from './hooks/use-routes-creator';
+export { buildApiUrl, createApolloClient, createApolloContextForProxyForwardTo, createHttpClientOptions, executeHttpClientRequest, getMcApiUrl, selectUserId, selectProjectKeyFromUrl, useMcQuery, useMcLazyQuery, useMcMutation, } from '@commercetools-frontend/application-shell-connectors';
+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 { default as ldAdapter } from '@flopflip/launchdarkly-adapter';

package/dist/declarations/src/middleware/hide-notifications.d.ts

@@ -0,0 +1,3 @@
+import type { Action, Dispatch, MiddlewareAPI } from 'redux';
+declare const hideNotificationsMiddleware: ({ getState }: MiddlewareAPI) => (next: Dispatch<Action>) => (action: Action) => Action<any>;
+export default hideNotificationsMiddleware;

package/dist/declarations/src/middleware/logger.d.ts

@@ -0,0 +1,3 @@
+import type { Middleware } from 'redux';
+declare const loggerMiddleware: Middleware;
+export default loggerMiddleware;

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';

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 '@commercetools-frontend/application-shell-connectors';
+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';
+export * from './custom-views-utils';

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

@@ -0,0 +1,83 @@
+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 * as rtlHooks from '@testing-library/react-hooks';
+import { type TProviderProps } from '@commercetools-frontend/application-shell-connectors';
+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';
+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> & rtlHooks.RenderHookOptions<RenderedHookProps>;
+export type TRenderHookResult<RenderHookCallbackProps, RenderHookCallbackValue, AdditionalEnvironmentProperties extends {} = {}, StoreState extends {} = {}> = rtlHooks.RenderHookResult<RenderHookCallbackProps, RenderHookCallbackValue> & 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>;
+export * from '@testing-library/react';
+declare const hooks: {
+    renderHook: typeof renderHook;
+    act: rtlHooks.Act;
+    cleanup: () => Promise<void>;
+    addCleanup: (callback: rtlHooks.CleanupCallback) => () => void;
+    removeCleanup: (callback: rtlHooks.CleanupCallback) => void;
+    suppressErrorOutput: () => () => void;
+};
+export { renderApp, renderAppWithRedux, hooks, mapResourceAccessToAppliedPermissions, denormalizePermissions, denormalizeActionRights, denormalizeDataFences, };