@commercetools-frontend/constants 27.10.0 → 27.11.1

package/dist/commercetools-frontend-constants.cjs.dev.js

@@ -2,8 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/includes');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
+
 // NOTE: This string will be replaced on build time with the package version.
-var version = "27.10.0";
+var version = "27.11.1";
 
 /**
  * The project key must be between 2 and 36 characters long. It can only contain alphanumeric lowercase characters (a-z, 0-9),
@@ -125,10 +131,37 @@ const MC_API_PROXY_TARGETS = {
   STORES_SEARCGH: 'stores-search'
 };
 
+/** Development-only navbar group header for the local menuLinks cache. */
+
 // Global application environment on window object
 
 // Used for Custom Views, as we want to keep the `entryPointUriPath` value required in the runtime config.
 const CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH = '@@custom-view-host@@';
+const STATIC_URL_PATHS = {
+  LOGIN: 'login',
+  LOGOUT: 'logout',
+  ACCOUNT: 'account',
+  AGENT_SPHERE: 'agent-sphere'
+};
+const includesStaticUrlPath = (list, value) => {
+  var _context;
+  return _includesInstanceProperty__default["default"](_context = list).call(_context, value);
+};
+
+/** First path segment of an entry point or URL path (e.g. `agent-sphere/registry` → `agent-sphere`). */
+const topLevelPathSegment = value => value.split('/')[0] ?? value;
+
+/** First URL segment is never a `:projectKey`. */
+const STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY = [STATIC_URL_PATHS.LOGIN, STATIC_URL_PATHS.LOGOUT, STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isStaticUrlPathInPositionOfProjectKey = value => includesStaticUrlPath(STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY, topLevelPathSegment(value));
+
+/** Apps whose `entryPointUriPath` is the first URL segment (no `/:projectKey` prefix). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS = [STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPoint = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS, topLevelPathSegment(value));
+
+/** Subset that still loads a project (navbar, FetchProject from storage). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT = [STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPointInProjectContext = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT, topLevelPathSegment(value));
 const SUPPORTED_HEADERS = {
   ACCEPT: 'Accept',
   ACCEPT_VERSION: 'Accept-version',
@@ -262,11 +295,18 @@ exports.ORGANIZATION_GENERAL_ERROR = ORGANIZATION_GENERAL_ERROR;
 exports.PERMISSION_GROUP_NAME_REGEX = PERMISSION_GROUP_NAME_REGEX;
 exports.PORTALS_CONTAINER_ID = PORTALS_CONTAINER_ID;
 exports.PORTALS_CONTAINER_INDENTATION_SIZE = PORTALS_CONTAINER_INDENTATION_SIZE;
+exports.PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS = PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS;
+exports.PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT = PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT;
 exports.PROJECT_KEY_REGEX = PROJECT_KEY_REGEX;
 exports.SHOW_LOADING = SHOW_LOADING;
+exports.STATIC_URL_PATHS = STATIC_URL_PATHS;
+exports.STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY = STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY;
 exports.STATUS_CODES = STATUS_CODES;
 exports.STORAGE_KEYS = STORAGE_KEYS;
 exports.SUPPORTED_HEADERS = SUPPORTED_HEADERS;
 exports.SUPPORT_PORTAL_URL = SUPPORT_PORTAL_URL;
 exports.featureFlags = featureToggles;
+exports.isProjectKeylessApplicationEntryPoint = isProjectKeylessApplicationEntryPoint;
+exports.isProjectKeylessApplicationEntryPointInProjectContext = isProjectKeylessApplicationEntryPointInProjectContext;
+exports.isStaticUrlPathInPositionOfProjectKey = isStaticUrlPathInPositionOfProjectKey;
 exports.version = version;

package/dist/commercetools-frontend-constants.cjs.prod.js

@@ -2,8 +2,14 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var _includesInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/includes');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+var _includesInstanceProperty__default = /*#__PURE__*/_interopDefault(_includesInstanceProperty);
+
 // NOTE: This string will be replaced on build time with the package version.
-var version = "27.10.0";
+var version = "27.11.1";
 
 /**
  * The project key must be between 2 and 36 characters long. It can only contain alphanumeric lowercase characters (a-z, 0-9),
@@ -125,10 +131,37 @@ const MC_API_PROXY_TARGETS = {
   STORES_SEARCGH: 'stores-search'
 };
 
+/** Development-only navbar group header for the local menuLinks cache. */
+
 // Global application environment on window object
 
 // Used for Custom Views, as we want to keep the `entryPointUriPath` value required in the runtime config.
 const CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH = '@@custom-view-host@@';
+const STATIC_URL_PATHS = {
+  LOGIN: 'login',
+  LOGOUT: 'logout',
+  ACCOUNT: 'account',
+  AGENT_SPHERE: 'agent-sphere'
+};
+const includesStaticUrlPath = (list, value) => {
+  var _context;
+  return _includesInstanceProperty__default["default"](_context = list).call(_context, value);
+};
+
+/** First path segment of an entry point or URL path (e.g. `agent-sphere/registry` → `agent-sphere`). */
+const topLevelPathSegment = value => value.split('/')[0] ?? value;
+
+/** First URL segment is never a `:projectKey`. */
+const STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY = [STATIC_URL_PATHS.LOGIN, STATIC_URL_PATHS.LOGOUT, STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isStaticUrlPathInPositionOfProjectKey = value => includesStaticUrlPath(STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY, topLevelPathSegment(value));
+
+/** Apps whose `entryPointUriPath` is the first URL segment (no `/:projectKey` prefix). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS = [STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPoint = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS, topLevelPathSegment(value));
+
+/** Subset that still loads a project (navbar, FetchProject from storage). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT = [STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPointInProjectContext = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT, topLevelPathSegment(value));
 const SUPPORTED_HEADERS = {
   ACCEPT: 'Accept',
   ACCEPT_VERSION: 'Accept-version',
@@ -262,11 +295,18 @@ exports.ORGANIZATION_GENERAL_ERROR = ORGANIZATION_GENERAL_ERROR;
 exports.PERMISSION_GROUP_NAME_REGEX = PERMISSION_GROUP_NAME_REGEX;
 exports.PORTALS_CONTAINER_ID = PORTALS_CONTAINER_ID;
 exports.PORTALS_CONTAINER_INDENTATION_SIZE = PORTALS_CONTAINER_INDENTATION_SIZE;
+exports.PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS = PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS;
+exports.PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT = PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT;
 exports.PROJECT_KEY_REGEX = PROJECT_KEY_REGEX;
 exports.SHOW_LOADING = SHOW_LOADING;
+exports.STATIC_URL_PATHS = STATIC_URL_PATHS;
+exports.STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY = STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY;
 exports.STATUS_CODES = STATUS_CODES;
 exports.STORAGE_KEYS = STORAGE_KEYS;
 exports.SUPPORTED_HEADERS = SUPPORTED_HEADERS;
 exports.SUPPORT_PORTAL_URL = SUPPORT_PORTAL_URL;
 exports.featureFlags = featureToggles;
+exports.isProjectKeylessApplicationEntryPoint = isProjectKeylessApplicationEntryPoint;
+exports.isProjectKeylessApplicationEntryPointInProjectContext = isProjectKeylessApplicationEntryPointInProjectContext;
+exports.isStaticUrlPathInPositionOfProjectKey = isStaticUrlPathInPositionOfProjectKey;
 exports.version = version;

package/dist/commercetools-frontend-constants.esm.js

@@ -1,5 +1,7 @@
+import _includesInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/includes';
+
 // NOTE: This string will be replaced on build time with the package version.
-var version = "27.10.0";
+var version = "27.11.1";
 
 /**
  * The project key must be between 2 and 36 characters long. It can only contain alphanumeric lowercase characters (a-z, 0-9),
@@ -121,10 +123,37 @@ const MC_API_PROXY_TARGETS = {
   STORES_SEARCGH: 'stores-search'
 };
 
+/** Development-only navbar group header for the local menuLinks cache. */
+
 // Global application environment on window object
 
 // Used for Custom Views, as we want to keep the `entryPointUriPath` value required in the runtime config.
 const CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH = '@@custom-view-host@@';
+const STATIC_URL_PATHS = {
+  LOGIN: 'login',
+  LOGOUT: 'logout',
+  ACCOUNT: 'account',
+  AGENT_SPHERE: 'agent-sphere'
+};
+const includesStaticUrlPath = (list, value) => {
+  var _context;
+  return _includesInstanceProperty(_context = list).call(_context, value);
+};
+
+/** First path segment of an entry point or URL path (e.g. `agent-sphere/registry` → `agent-sphere`). */
+const topLevelPathSegment = value => value.split('/')[0] ?? value;
+
+/** First URL segment is never a `:projectKey`. */
+const STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY = [STATIC_URL_PATHS.LOGIN, STATIC_URL_PATHS.LOGOUT, STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isStaticUrlPathInPositionOfProjectKey = value => includesStaticUrlPath(STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY, topLevelPathSegment(value));
+
+/** Apps whose `entryPointUriPath` is the first URL segment (no `/:projectKey` prefix). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS = [STATIC_URL_PATHS.ACCOUNT, STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPoint = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS, topLevelPathSegment(value));
+
+/** Subset that still loads a project (navbar, FetchProject from storage). */
+const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT = [STATIC_URL_PATHS.AGENT_SPHERE];
+const isProjectKeylessApplicationEntryPointInProjectContext = value => includesStaticUrlPath(PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT, topLevelPathSegment(value));
 const SUPPORTED_HEADERS = {
   ACCEPT: 'Accept',
   ACCEPT_VERSION: 'Accept-version',
@@ -233,4 +262,4 @@ var featureToggles = /*#__PURE__*/Object.freeze({
   DEFAULT_FLAGS: DEFAULT_FLAGS
 });
 
-export { CUSTOM_VIEWS_EVENTS_META, CUSTOM_VIEWS_EVENTS_NAMES, CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH, DOMAINS, ENTRY_POINT_URI_PATH_REGEX, GRAPHQL_TARGETS, HIDE_ALL_PAGE_NOTIFICATIONS, HIDE_LOADING, HTTP_SECURITY_HEADERS, HTTP_SECURITY_HEADER_KEYS, LOGIN_STRATEGY_DEFAULT, LOGIN_STRATEGY_OIDC, LOGIN_STRATEGY_SSO, LOGOUT_REASONS, MC_API_PROXY_TARGETS, MC_MAIN_CONTAINER_PORTAL_ID, NOTIFICATION_DOMAINS, NOTIFICATION_KINDS_GLOBAL, NOTIFICATION_KINDS_PAGE, NOTIFICATION_KINDS_SIDE, NO_VALUE_FALLBACK, ORGANIZATION_GENERAL_ERROR, PERMISSION_GROUP_NAME_REGEX, PORTALS_CONTAINER_ID, PORTALS_CONTAINER_INDENTATION_SIZE, PROJECT_KEY_REGEX, SHOW_LOADING, STATUS_CODES, STORAGE_KEYS, SUPPORTED_HEADERS, SUPPORT_PORTAL_URL, featureToggles as featureFlags, version };
+export { CUSTOM_VIEWS_EVENTS_META, CUSTOM_VIEWS_EVENTS_NAMES, CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH, DOMAINS, ENTRY_POINT_URI_PATH_REGEX, GRAPHQL_TARGETS, HIDE_ALL_PAGE_NOTIFICATIONS, HIDE_LOADING, HTTP_SECURITY_HEADERS, HTTP_SECURITY_HEADER_KEYS, LOGIN_STRATEGY_DEFAULT, LOGIN_STRATEGY_OIDC, LOGIN_STRATEGY_SSO, LOGOUT_REASONS, MC_API_PROXY_TARGETS, MC_MAIN_CONTAINER_PORTAL_ID, NOTIFICATION_DOMAINS, NOTIFICATION_KINDS_GLOBAL, NOTIFICATION_KINDS_PAGE, NOTIFICATION_KINDS_SIDE, NO_VALUE_FALLBACK, ORGANIZATION_GENERAL_ERROR, PERMISSION_GROUP_NAME_REGEX, PORTALS_CONTAINER_ID, PORTALS_CONTAINER_INDENTATION_SIZE, PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS, PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT, PROJECT_KEY_REGEX, SHOW_LOADING, STATIC_URL_PATHS, STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY, STATUS_CODES, STORAGE_KEYS, SUPPORTED_HEADERS, SUPPORT_PORTAL_URL, featureToggles as featureFlags, isProjectKeylessApplicationEntryPoint, isProjectKeylessApplicationEntryPointInProjectContext, isStaticUrlPathInPositionOfProjectKey, version };

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

@@ -190,6 +190,11 @@ export type ApplicationOidcForDevelopmentConfig = {
         manage: string[];
     }[];
 };
+/** Development-only navbar group header for the local menuLinks cache. */
+export type ApplicationNavBarGroupForDevelopmentConfig = {
+    label?: string;
+    isNew?: boolean;
+};
 export type CustomViewData = {
     id: string;
     defaultLabel: string;
@@ -204,6 +209,7 @@ export type CustomViewData = {
 export type ApplicationRuntimeEnvironmentForDevelopment = {
     oidc?: ApplicationOidcForDevelopmentConfig;
     menuLinks?: ApplicationMenuLinksForDevelopmentConfig;
+    menuGroup?: ApplicationNavBarGroupForDevelopmentConfig;
     customViewHostUrl?: string;
     customViewConfig?: CustomViewData;
     mcIdentityLoginModeOverride?: 'legacy';
@@ -229,6 +235,21 @@ export interface ApplicationWindow extends Window {
     app: ApplicationRuntimeEnvironment;
 }
 export declare const CUSTOM_VIEW_HOST_ENTRY_POINT_URI_PATH = "@@custom-view-host@@";
+export declare const STATIC_URL_PATHS: {
+    readonly LOGIN: "login";
+    readonly LOGOUT: "logout";
+    readonly ACCOUNT: "account";
+    readonly AGENT_SPHERE: "agent-sphere";
+};
+/** First URL segment is never a `:projectKey`. */
+export declare const STATIC_URL_PATHS_IN_POSITION_OF_PROJECT_KEY: readonly ["login", "logout", "account", "agent-sphere"];
+export declare const isStaticUrlPathInPositionOfProjectKey: (value: string) => boolean;
+/** Apps whose `entryPointUriPath` is the first URL segment (no `/:projectKey` prefix). */
+export declare const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS: readonly ["account", "agent-sphere"];
+export declare const isProjectKeylessApplicationEntryPoint: (value: string) => boolean;
+/** Subset that still loads a project (navbar, FetchProject from storage). */
+export declare const PROJECT_KEYLESS_APPLICATION_ENTRY_POINTS_IN_PROJECT_CONTEXT: readonly ["agent-sphere"];
+export declare const isProjectKeylessApplicationEntryPointInProjectContext: (value: string) => boolean;
 export declare const SUPPORTED_HEADERS: {
     readonly ACCEPT: "Accept";
     readonly ACCEPT_VERSION: "Accept-version";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools-frontend/constants",
-  "version": "27.10.0",
+  "version": "27.11.1",
   "description": "Shared constants for MC applications",
   "bugs": "https://github.com/commercetools/merchant-center-application-kit/issues",
   "repository": {