@commercetools-frontend/application-shell 24.7.2 → 24.8.1

package/dist/declarations-connectors/src/utils/apollo-client-runtime-cache.d.ts

@@ -0,0 +1,4 @@
+import { type NormalizedCacheObject, ApolloClient } from '@apollo/client';
+declare const setCachedApolloClient: (apolloClient: ApolloClient<NormalizedCacheObject>) => void;
+declare const getCachedApolloClient: () => ApolloClient<NormalizedCacheObject> | undefined;
+export { setCachedApolloClient, getCachedApolloClient };

package/dist/declarations-connectors/src/utils/apollo-context.d.ts

@@ -0,0 +1,16 @@
+import type { TGraphQLTargets } from '@commercetools-frontend/constants';
+import type { THeaders, TForwardToConfig } from "./http-client.js";
+export type TApolloContext = {
+    uri?: string;
+    headers?: THeaders;
+    forwardToConfig?: TForwardToConfig;
+    skipGraphQlTargetCheck?: boolean;
+    skipTokenRetry?: boolean;
+    target?: TGraphQLTargets;
+    projectKey?: string;
+    teamId?: string;
+    featureFlag?: string;
+    enableSentryErrorReporting?: boolean;
+};
+declare const createApolloContextForProxyForwardTo: (proxyForwardTocontext: TForwardToConfig) => TApolloContext;
+export { createApolloContextForProxyForwardTo };

package/dist/declarations-connectors/src/utils/get-correlation-id/get-correlation-id.d.ts

@@ -0,0 +1,3 @@
+export default function getCorrelationId({ userId, }?: {
+    userId?: string | null;
+}): string;

package/dist/declarations-connectors/src/utils/get-correlation-id/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./get-correlation-id.js";

package/dist/declarations-connectors/src/utils/get-mc-api-url/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./get-mc-api-url.js";

package/dist/declarations-connectors/src/utils/http-client.d.ts

@@ -0,0 +1,107 @@
+/**
+ * This file contains helper functions to configure an HTTP client
+ * with the recommended configuration for the Merchant Center API.
+ */
+export type THeaders = Record<string, string>;
+export type TForwardToAudiencePolicy = 'forward-url-full-path' | 'forward-url-origin';
+export type TForwardToExchangeTokenClaim = 'permissions';
+export type TForwardToConfigVersion = 'v1' | 'v2';
+export type TForwardToConfig = {
+    /**
+     * The URL of the external API to forward the request to.
+     */
+    uri: string;
+    /**
+     * Additional HTTP headers to be included in the request to the external API.
+     */
+    headers?: THeaders;
+    /**
+     * The audience policy for verifying the incoming request from the Merchant Center API.
+     */
+    audiencePolicy?: TForwardToAudiencePolicy;
+    /**
+     * A list of user permissions to be included in the request to the external API.
+     */
+    includeUserPermissions?: boolean;
+    /**
+     * The version of the `/proxy/forward-to` endpoint to use.
+     */
+    version?: TForwardToConfigVersion;
+};
+export type TConfig = {
+    /**
+     * A custom user agent to identify the HTTP client.
+     * We recommend to use the `@commercetools/http-user-agent` package.
+     *
+     * @example
+     * import createHttpUserAgent from '@commercetools/http-user-agent';
+     *
+     * const userAgent = createHttpUserAgent({
+     *   name: 'fetch-client',
+     *   version: '2.6.0',
+     *   libraryName: window.app.applicationName,
+     *   contactEmail: 'support@my-company.com',
+     * });
+     */
+    userAgent?: string;
+    /**
+     * Additional headers to be included in the request.
+     * The provided recommended headers won't be overwritten.
+     * See `TOptions.headers`.
+     */
+    headers?: THeaders;
+    /**
+     * Configuration for using the `/proxy/forward-to` endpoint
+     * to connect to an external API.
+     * {@link https://docs.commercetools.com/merchant-center-customizations/concepts/integrate-with-your-own-api}
+     *
+     * @example
+     * {
+     *   forwardToConfig: {
+     *     uri: 'https://my-api.com/my-endpoint',
+     *   }
+     * }
+     */
+    forwardToConfig?: TForwardToConfig;
+    /**
+     * The project key to be assigned to the `x-project-key` header.
+     * By default the project key is extracted from the URL.
+     * We do not recommend to use this option unless you know what you are doing.
+     */
+    projectKey?: string;
+};
+export type TOptions = {
+    /**
+     * Include user credentials (session token).
+     */
+    credentials: 'include';
+    /**
+     * The HTTP headers included by default are:
+     * - Accept
+     * - Authorization (only in development)
+     * - X-Application-Id
+     * - X-Correlation-Id
+     * - X-Project-Key
+     * - X-User-Agent
+     */
+    headers: THeaders;
+};
+export type TFetcherResponse<Data> = {
+    /**
+     * The parsed response from the server.
+     */
+    data: Data;
+    /**
+     * The HTTP status code from the server response.
+     */
+    statusCode: number;
+    /**
+     * Implement a function to access the HTTP headers from the server response.
+     */
+    getHeader: (headerName: string) => string | null;
+};
+export type TFetcher<Data> = (options: TOptions) => Promise<TFetcherResponse<Data>>;
+declare function buildApiUrl(endpoint: string): string;
+declare function createHttpClientOptions(config?: TConfig): TOptions;
+declare function executeHttpClientRequest<Data>(fetcher: TFetcher<Data>, config?: TConfig): Promise<Data>;
+export { buildApiUrl, createHttpClientOptions, executeHttpClientRequest };

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

@@ -0,0 +1,7 @@
+export { default as selectTeamIdFromStorage } from "./select-team-id-from-storage/index.js";
+export { default as selectProjectKeyFromUrl } from "./select-project-key-from-url/index.js";
+export { default as selectUserId } from "./select-user-id/index.js";
+export { default as getCorrelationId } from "./get-correlation-id/index.js";
+export { default as getMcApiUrl } from "./get-mc-api-url/index.js";
+export { createApolloContextForProxyForwardTo } from "./apollo-context.js";
+export { isLoggerEnabled, default as logger } from "./logger.js";

package/dist/declarations-connectors/src/utils/logger.d.ts

@@ -0,0 +1,10 @@
+export declare const isLoggerEnabled: () => boolean;
+declare const logger: {
+    groupCollapsed(groupTitle?: string, ...optionalParams: unknown[]): void;
+    groupEnd(): void;
+    info(message?: unknown, ...optionalParams: unknown[]): void;
+    log(message?: unknown, ...optionalParams: unknown[]): void;
+    error(message?: unknown, ...optionalParams: unknown[]): void;
+    warn(message?: unknown, ...optionalParams: unknown[]): void;
+};
+export default logger;

package/dist/declarations-connectors/src/utils/oidc-storage.d.ts

@@ -0,0 +1,12 @@
+declare const getSessionToken: () => string | null;
+declare const setActiveSession: (sessionToken?: string) => void;
+declare const clearSession: () => void;
+declare const getActiveProjectKey: () => string | null;
+declare const removeActiveProjectKey: () => void;
+declare const setActiveProjectKey: (projectKey: string) => void;
+declare const getSessionScope: () => string | null;
+declare const setSessionScope: (scope: string) => void;
+declare const getSessionState: <State extends {}>(stateId?: string) => State | null;
+declare const setSessionState: <State extends {}>(stateId: string, state: State) => void;
+declare const removeSessionState: (stateId?: string) => void;
+export { getSessionToken, setActiveSession, clearSession, getSessionState, setSessionState, removeSessionState, getActiveProjectKey, setActiveProjectKey, removeActiveProjectKey, getSessionScope, setSessionScope, };

package/dist/declarations-connectors/src/utils/select-project-key-from-url/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./select-project-key-from-url.js";

package/dist/declarations-connectors/src/utils/select-project-key-from-url/select-project-key-from-url.d.ts

@@ -0,0 +1 @@
+export default function selectProjectKeyFromUrl(locationPath?: string): string | undefined;

package/dist/declarations-connectors/src/utils/select-team-id-from-storage/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./select-team-id-from-storage.js";

package/dist/declarations-connectors/src/utils/select-team-id-from-storage/select-team-id-from-storage.d.ts

@@ -0,0 +1 @@
+export default function selectTeamIdFromStorage(): string | undefined;

package/dist/declarations-connectors/src/utils/select-user-id/index.d.ts

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

package/dist/declarations-connectors/src/utils/select-user-id/select-user-id.d.ts

@@ -0,0 +1 @@
+export default function selectUserId(): string | null;

package/dist/declarations-connectors/src/version.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "__@APPLICATION_KIT_PACKAGE/VERSION_OF_RELEASE__";
+export default _default;

package/dist/{index-b76590b3.cjs.prod.js → index-245e2980.cjs.prod.js}

@@ -12,11 +12,13 @@ var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
 var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
 var _reduceInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/reduce');
 var _Object$entries = require('@babel/runtime-corejs3/core-js-stable/object/entries');
+var _concatInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/concat');
 var _Reflect$has = require('@babel/runtime-corejs3/core-js-stable/reflect/has');
 var toolkit = require('@reduxjs/toolkit');
 var mapValues = require('lodash/mapValues');
 var omitEmpty = require('omit-empty-es');
-var thunk = require('redux-thunk');
+var redux = require('redux');
+var reduxThunk = require('redux-thunk');
 var applicationShellConnectors = require('@commercetools-frontend/application-shell-connectors');
 var constants = require('@commercetools-frontend/constants');
 var notifications = require('@commercetools-frontend/notifications');
@@ -42,10 +44,10 @@ var _Object$defineProperties__default = /*#__PURE__*/_interopDefault(_Object$def
 var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defineProperty);
 var _reduceInstanceProperty__default = /*#__PURE__*/_interopDefault(_reduceInstanceProperty);
 var _Object$entries__default = /*#__PURE__*/_interopDefault(_Object$entries);
+var _concatInstanceProperty__default = /*#__PURE__*/_interopDefault(_concatInstanceProperty);
 var _Reflect$has__default = /*#__PURE__*/_interopDefault(_Reflect$has);
 var mapValues__default = /*#__PURE__*/_interopDefault(mapValues);
 var omitEmpty__default = /*#__PURE__*/_interopDefault(omitEmpty);
-var thunk__default = /*#__PURE__*/_interopDefault(thunk);
 var _indexOfInstanceProperty__default = /*#__PURE__*/_interopDefault(_indexOfInstanceProperty);
 var _sliceInstanceProperty__default = /*#__PURE__*/_interopDefault(_sliceInstanceProperty);
 var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
@@ -124,7 +126,7 @@ const loggerMiddleware = reduxLogger.createLogger({
 });
 
 function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context2, _context3; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t), !0)).call(_context2, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t))).call(_context3, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context3, _context4; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t), !0)).call(_context3, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context4 = ownKeys(Object(t))).call(_context4, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
 const mergeObjectValues = object => {
   var _context;
   return _reduceInstanceProperty__default["default"](_context = _Object$entries__default["default"](object)).call(_context, (acc, _ref) => {
@@ -158,7 +160,7 @@ const applyDefaultMiddlewares = function () {
   for (var _len = arguments.length, middlewares = new Array(_len), _key = 0; _key < _len; _key++) {
     middlewares[_key] = arguments[_key];
   }
-  return toolkit.applyMiddleware(...middlewares, thunk__default["default"], loggerMiddleware);
+  return redux.applyMiddleware(...middlewares, reduxThunk.thunk, loggerMiddleware);
 };
 const createInternalReducer = function () {
   let injectedReducers = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -171,7 +173,7 @@ const createInternalReducer = function () {
   const preloadedStateReducers = mapValues__default["default"](preloadedState, value => () => value);
 
   // NOTE: since we don't know in advance which reducers will be injected,
-  // we pass an `unknown` type to express this uncertainty and make the compiler happy.
+  // we let TypeScript infer the type from the reducer map.
   return toolkit.combineReducers(_objectSpread(_objectSpread({
     requestsInFlight: requestsInFlightReducer,
     notifications: notifications.reducer
@@ -189,16 +191,19 @@ const createReduxStore = function () {
     devTools: {
       actionsDenylist: [constants.SHOW_LOADING, constants.HIDE_LOADING]
     },
-    middleware: getDefaultMiddleware => [...additionalMiddlewares, hideNotificationsMiddleware, notifications.middleware, sdkMiddleware, ...getDefaultMiddleware({
-      // https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data
-      serializableCheck: false,
-      // This default check is logging warnings to console for some MC FE tests, probably
-      // due to lower resources when running tests on CI.
-      // We don't consider this check to be very valuable in this context so we decided
-      // to turn it off.
-      // https://redux-toolkit.js.org/api/immutabilityMiddleware
-      immutableCheck: false
-    }), loggerMiddleware]
+    middleware: getDefaultMiddleware => {
+      var _context2;
+      return _concatInstanceProperty__default["default"](_context2 = getDefaultMiddleware({
+        // https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data
+        serializableCheck: false,
+        // This default check is logging warnings to console for some MC FE tests, probably
+        // due to lower resources when running tests on CI.
+        // We don't consider this check to be very valuable in this context so we decided
+        // to turn it off.
+        // https://redux-toolkit.js.org/api/immutabilityMiddleware
+        immutableCheck: false
+      }).prepend(sdkMiddleware).prepend(notifications.middleware).prepend(hideNotificationsMiddleware).prepend(...additionalMiddlewares)).call(_context2, loggerMiddleware);
+    }
   });
   const enhancedStore = store;
 

package/dist/{index-0459c0f4.cjs.dev.js → index-614accc4.cjs.dev.js}

@@ -12,11 +12,13 @@ var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
 var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
 var _reduceInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/reduce');
 var _Object$entries = require('@babel/runtime-corejs3/core-js-stable/object/entries');
+var _concatInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/concat');
 var _Reflect$has = require('@babel/runtime-corejs3/core-js-stable/reflect/has');
 var toolkit = require('@reduxjs/toolkit');
 var mapValues = require('lodash/mapValues');
 var omitEmpty = require('omit-empty-es');
-var thunk = require('redux-thunk');
+var redux = require('redux');
+var reduxThunk = require('redux-thunk');
 var applicationShellConnectors = require('@commercetools-frontend/application-shell-connectors');
 var constants = require('@commercetools-frontend/constants');
 var notifications = require('@commercetools-frontend/notifications');
@@ -42,10 +44,10 @@ var _Object$defineProperties__default = /*#__PURE__*/_interopDefault(_Object$def
 var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defineProperty);
 var _reduceInstanceProperty__default = /*#__PURE__*/_interopDefault(_reduceInstanceProperty);
 var _Object$entries__default = /*#__PURE__*/_interopDefault(_Object$entries);
+var _concatInstanceProperty__default = /*#__PURE__*/_interopDefault(_concatInstanceProperty);
 var _Reflect$has__default = /*#__PURE__*/_interopDefault(_Reflect$has);
 var mapValues__default = /*#__PURE__*/_interopDefault(mapValues);
 var omitEmpty__default = /*#__PURE__*/_interopDefault(omitEmpty);
-var thunk__default = /*#__PURE__*/_interopDefault(thunk);
 var _indexOfInstanceProperty__default = /*#__PURE__*/_interopDefault(_indexOfInstanceProperty);
 var _sliceInstanceProperty__default = /*#__PURE__*/_interopDefault(_sliceInstanceProperty);
 var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
@@ -124,7 +126,7 @@ const loggerMiddleware = reduxLogger.createLogger({
 });
 
 function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context2, _context3; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t), !0)).call(_context2, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t))).call(_context3, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context3, _context4; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t), !0)).call(_context3, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context4 = ownKeys(Object(t))).call(_context4, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
 const mergeObjectValues = object => {
   var _context;
   return _reduceInstanceProperty__default["default"](_context = _Object$entries__default["default"](object)).call(_context, (acc, _ref) => {
@@ -158,7 +160,7 @@ const applyDefaultMiddlewares = function () {
   for (var _len = arguments.length, middlewares = new Array(_len), _key = 0; _key < _len; _key++) {
     middlewares[_key] = arguments[_key];
   }
-  return toolkit.applyMiddleware(...middlewares, thunk__default["default"], loggerMiddleware);
+  return redux.applyMiddleware(...middlewares, reduxThunk.thunk, loggerMiddleware);
 };
 const createInternalReducer = function () {
   let injectedReducers = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -171,7 +173,7 @@ const createInternalReducer = function () {
   const preloadedStateReducers = mapValues__default["default"](preloadedState, value => () => value);
 
   // NOTE: since we don't know in advance which reducers will be injected,
-  // we pass an `unknown` type to express this uncertainty and make the compiler happy.
+  // we let TypeScript infer the type from the reducer map.
   return toolkit.combineReducers(_objectSpread(_objectSpread({
     requestsInFlight: requestsInFlightReducer,
     notifications: notifications.reducer
@@ -189,16 +191,19 @@ const createReduxStore = function () {
     devTools: {
       actionsDenylist: [constants.SHOW_LOADING, constants.HIDE_LOADING]
     },
-    middleware: getDefaultMiddleware => [...additionalMiddlewares, hideNotificationsMiddleware, notifications.middleware, sdkMiddleware, ...getDefaultMiddleware({
-      // https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data
-      serializableCheck: false,
-      // This default check is logging warnings to console for some MC FE tests, probably
-      // due to lower resources when running tests on CI.
-      // We don't consider this check to be very valuable in this context so we decided
-      // to turn it off.
-      // https://redux-toolkit.js.org/api/immutabilityMiddleware
-      immutableCheck: false
-    }), loggerMiddleware]
+    middleware: getDefaultMiddleware => {
+      var _context2;
+      return _concatInstanceProperty__default["default"](_context2 = getDefaultMiddleware({
+        // https://redux-toolkit.js.org/usage/usage-guide#working-with-non-serializable-data
+        serializableCheck: false,
+        // This default check is logging warnings to console for some MC FE tests, probably
+        // due to lower resources when running tests on CI.
+        // We don't consider this check to be very valuable in this context so we decided
+        // to turn it off.
+        // https://redux-toolkit.js.org/api/immutabilityMiddleware
+        immutableCheck: false
+      }).prepend(sdkMiddleware).prepend(notifications.middleware).prepend(hideNotificationsMiddleware).prepend(...additionalMiddlewares)).call(_context2, loggerMiddleware);
+    }
   });
   const enhancedStore = store;