@commercetools-frontend/application-config 20.12.0 → 21.0.0-rc.1

package/dist/commercetools-frontend-application-config.cjs.dev.js

@@ -19,6 +19,7 @@ var path = require('path');
 var child_process = require('child_process');
 var cosmiconfig = require('cosmiconfig');
 var _Reflect$construct = require('@babel/runtime-corejs3/core-js-stable/reflect/construct');
+var _createClass = require('@babel/runtime-corejs3/helpers/createClass');
 var _classCallCheck = require('@babel/runtime-corejs3/helpers/classCallCheck');
 var _assertThisInitialized = require('@babel/runtime-corejs3/helpers/assertThisInitialized');
 var _inherits = require('@babel/runtime-corejs3/helpers/inherits');
@@ -82,7 +83,7 @@ var MissingOrInvalidConfigError = /*#__PURE__*/function (_Error) {
     return _this;
   }
 
-  return MissingOrInvalidConfigError;
+  return _createClass(MissingOrInvalidConfigError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 
 // for instance in respect to both source files and dist files.
@@ -160,8 +161,9 @@ var schemaJson = {
 			type: "string"
 		},
 		entryPointUriPath: {
-			description: "The unique route path of the Custom Application. This is the identifier that the Merchant Center Proxy uses to match the HTTP request and to forward it to the Custom Application URL. This value also needs to be used in the application client side routes. The value must be the same as the `navbarMenu.uriPath` in the `menu.json` and the application route path when registering the Custom Application. For example, if the Custom Application should be served at the route `/:projectKey/avengers`, the `entryPointUriPath` must be set to `avengers` and the same for the application routes.",
-			type: "string"
+			description: "The unique route path of the Custom Application. This is the identifier that the Merchant Center Proxy uses to match the HTTP request and to forward it to the Custom Application URL (https://docs.commercetools.com/custom-applications/api-reference/application-config).",
+			type: "string",
+			pattern: "^[^\\-_]([0-9a-z]|[\\-_](?![\\-_])){2,64}[^\\-_]$"
 		},
 		cloudIdentifier: {
 			description: "The cloud identifier where the Custom Application is running. This value is used to derive the Merchant Center API URL. Alternatively you can use the `mcApiUrl` property.",
@@ -192,6 +194,8 @@ var schemaJson = {
 				view: {
 					description: "The list of view-only OAuth Scopes (https://docs.commercetools.com/api/scopes).",
 					type: "array",
+					"default": [
+					],
 					items: {
 						type: "string",
 						pattern: "view_(.*)"
@@ -201,6 +205,8 @@ var schemaJson = {
 				manage: {
 					description: "The list of manage-only OAuth Scopes (https://docs.commercetools.com/api/scopes).",
 					type: "array",
+					"default": [
+					],
 					items: {
 						type: "string",
 						pattern: "manage_(.*)"
@@ -231,7 +237,10 @@ var schemaJson = {
 							type: "string"
 						}
 					},
-					additionalProperties: false
+					additionalProperties: false,
+					required: [
+						"initialProjectKey"
+					]
 				},
 				production: {
 					description: "Configuration for production only",
@@ -252,12 +261,14 @@ var schemaJson = {
 					},
 					additionalProperties: false,
 					required: [
+						"applicationId",
 						"url"
 					]
 				}
 			},
 			additionalProperties: false,
 			required: [
+				"development",
 				"production"
 			]
 		},
@@ -317,19 +328,16 @@ var schemaJson = {
 					uniqueItems: true
 				}
 			},
-			additionalProperties: false,
-			required: [
-				"csp"
-			]
+			additionalProperties: false
 		},
-		menuLinks: {
-			description: "Configuration for the menu links on the left-side navbar.",
+		icon: {
+			description: "The SVG icon that represents this application. Pass the raw SVG string or a path to an SVG file, for example a relative path `${path:./app.svg}`, or a path from a module `${path:@commercetools-frontend/assets/application-icons/rocket.svg}`.",
+			type: "string"
+		},
+		mainMenuLink: {
+			description: "Configuration for the main menu link on the left-side navbar.",
 			type: "object",
 			properties: {
-				icon: {
-					description: "The SVG icon that represents this application. Pass the raw SVG string or a path to an SVG file, for example a relative path `${path:./app.svg}`, or a path from a module `${path:@commercetools-frontend/assets/application-icons/04.Rocket.svg}`.",
-					type: "string"
-				},
 				defaultLabel: {
 					description: "A default label to be rendered if there is no matching localized label for the user locale.",
 					type: "string"
@@ -366,89 +374,87 @@ var schemaJson = {
 					}
 				},
 				permissions: {
-					description: "Set the visibility of the menu link. Users must have at least one permission to see the Custom Application in the Merchant Center menu.",
+					description: "Set the visibility of the menu link. Permission values are derived from the `entryPointUriPath`. Users must have at least one permission to see the Custom Application in the Merchant Center menu.",
 					type: "array",
 					"default": [
 					],
 					items: {
 						type: "string"
 					}
-				},
-				submenuLinks: {
-					description: "Configuration for the submenu links on the left-side navbar.",
-					"default": [
-					],
-					type: "array",
-					items: {
-						type: "object",
-						properties: {
-							uriPath: {
-								description: "Route path relative to the entry point URI path of the Custom Application.",
-								type: "string"
-							},
-							defaultLabel: {
-								description: "A default label to be rendered if there is no matching localized label for the user locale.",
-								type: "string"
-							},
-							labelAllLocales: {
-								description: "Localized label based on the application locales available from the user profile.",
-								type: "array",
-								"default": [
-								],
-								items: {
-									type: "object",
-									properties: {
-										locale: {
-											type: "string",
-											"enum": [
-												"en",
-												"de",
-												"es",
-												"fr-FR",
-												"zh-CN",
-												"ja"
-											]
-										},
-										value: {
-											description: "A label for the specific locale or a reference to a translated message. For example `${intl:en:Menu.Avengers}` which looks for the message key `Menu.Avengers` in the `src/i18n/data/en.json`",
-											type: "string"
-										}
-									},
-									additionalProperties: false,
-									required: [
-										"locale",
-										"value"
-									]
-								}
-							},
-							permissions: {
-								description: "Set the visibility of the menu link. Users must have at least one permission to see the Custom Application in the Merchant Center menu.",
-								type: "array",
-								"default": [
-								],
-								items: {
-									type: "string"
-								}
-							}
-						},
-						additionalProperties: true,
-						required: [
-							"uriPath",
-							"defaultLabel",
-							"labelAllLocales",
-							"permissions"
-						]
-					}
 				}
 			},
 			additionalProperties: true,
 			required: [
-				"icon",
 				"defaultLabel",
 				"labelAllLocales",
-				"permissions",
-				"submenuLinks"
+				"permissions"
 			]
+		},
+		submenuLinks: {
+			description: "Configuration for the submenu links on the left-side navbar.",
+			"default": [
+			],
+			type: "array",
+			items: {
+				type: "object",
+				properties: {
+					uriPath: {
+						description: "Route path relative to the entry point URI path of the Custom Application.",
+						type: "string"
+					},
+					defaultLabel: {
+						description: "A default label to be rendered if there is no matching localized label for the user locale.",
+						type: "string"
+					},
+					labelAllLocales: {
+						description: "Localized label based on the application locales available from the user profile.",
+						type: "array",
+						"default": [
+						],
+						items: {
+							type: "object",
+							properties: {
+								locale: {
+									type: "string",
+									"enum": [
+										"en",
+										"de",
+										"es",
+										"fr-FR",
+										"zh-CN",
+										"ja"
+									]
+								},
+								value: {
+									description: "A label for the specific locale or a reference to a translated message. For example `${intl:en:Menu.Avengers}` which looks for the message key `Menu.Avengers` in the `src/i18n/data/en.json`",
+									type: "string"
+								}
+							},
+							additionalProperties: false,
+							required: [
+								"locale",
+								"value"
+							]
+						}
+					},
+					permissions: {
+						description: "Set the visibility of the menu link. Permission values are derived from the `entryPointUriPath`. Users must have at least one permission to see the Custom Application in the Merchant Center menu.",
+						type: "array",
+						"default": [
+						],
+						items: {
+							type: "string"
+						}
+					}
+				},
+				additionalProperties: true,
+				required: [
+					"uriPath",
+					"defaultLabel",
+					"labelAllLocales",
+					"permissions"
+				]
+			}
 		}
 	},
 	additionalProperties: true,
@@ -456,7 +462,11 @@ var schemaJson = {
 		"name",
 		"entryPointUriPath",
 		"cloudIdentifier",
-		"env"
+		"env",
+		"oAuthScopes",
+		"icon",
+		"mainMenuLink",
+		"submenuLinks"
 	]
 };
 
@@ -570,7 +580,7 @@ var getOrThrow = function getOrThrow(fn, errorMessage) {
  * Allows variable placeholders. Supported types are:
  * - `env`: For example `${env:MC_API_URL}`.
  * - `intl`: For example `${intl:en:Menu.title}`.
- * - `path`: For example `${path:./app.svg}`, or `${path:@commercetools-frontend/assets/application-icons/04.Rocket.svg}`.
+ * - `path`: For example `${path:./app.svg}`, or `${path:@commercetools-frontend/assets/application-icons/rocket.svg}`.
  */
 var variableSyntax = /\${([ ~:\w.'",\-/()@]+?)}/g;
 var envRefSyntax = /^env:/g;
@@ -687,9 +697,9 @@ var substituteVariablePlaceholders = function substituteVariablePlaceholders(con
   });
 };
 
-function ownKeys(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); if (enumerableOnly) { symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+function ownKeys(object, enumerableOnly) { var keys = _Object$keys__default["default"](object); if (_Object$getOwnPropertySymbols__default["default"]) { var symbols = _Object$getOwnPropertySymbols__default["default"](object); enumerableOnly && (symbols = _filterInstanceProperty__default["default"](symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor__default["default"](object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { var _context3; _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(source), true)).call(_context3, function (key) { _defineProperty(target, key, source[key]); }); } else if (_Object$getOwnPropertyDescriptors__default["default"]) { _Object$defineProperties__default["default"](target, _Object$getOwnPropertyDescriptors__default["default"](source)); } else { var _context4; _forEachInstanceProperty__default["default"](_context4 = ownKeys(Object(source))).call(_context4, function (key) { _Object$defineProperty__default["default"](target, key, _Object$getOwnPropertyDescriptor__default["default"](source, key)); }); } } return target; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context3, _context4; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(source), !0)).call(_context3, function (key) { _defineProperty(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](target, _Object$getOwnPropertyDescriptors__default["default"](source)) : _forEachInstanceProperty__default["default"](_context4 = ownKeys(Object(source))).call(_context4, function (key) { _Object$defineProperty__default["default"](target, key, _Object$getOwnPropertyDescriptor__default["default"](source, key)); }); } return target; }
 // TODO: make it configurable.
 var developmentPort = 3001;
 var developmentAppUrl = "http://localhost:".concat(developmentPort);
@@ -705,7 +715,7 @@ var omitDevConfigIfEmpty = function omitDevConfigIfEmpty(devConfig) {
 var cachedConfig;
 
 var processConfig = function processConfig() {
-  var _ref2, _processEnv$MC_APP_EN, _appConfig$additional, _ref3, _appConfig$env$develo, _appConfig$env$develo2, _appConfig$headers, _appConfig$headers2, _context2, _appConfig$headers3, _appConfig$headers4;
+  var _ref2, _processEnv$MC_APP_EN, _appConfig$additional, _ref3, _context, _appConfig$env$develo, _appConfig$headers, _appConfig$headers2, _appConfig$headers2$c, _context2, _appConfig$headers3, _appConfig$headers3$c, _appConfig$headers4, _appConfig$headers4$c;
 
   var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
       _ref$disableCache = _ref.disableCache,
@@ -726,9 +736,7 @@ var processConfig = function processConfig() {
     applicationPath: applicationPath
   });
   var additionalAppEnv = (_appConfig$additional = appConfig.additionalEnv) !== null && _appConfig$additional !== void 0 ? _appConfig$additional : {};
-  var revision = (_ref3 = additionalAppEnv.revision) !== null && _ref3 !== void 0 ? _ref3 : ''; // Feature flags
-
-  var isOidcForDevelopmentEnabled = Boolean(JSON.parse(processEnv.ENABLE_OIDC_FOR_DEVELOPMENT || 'false')); // Parse all the supported URLs, which gets implicitly validated
+  var revision = (_ref3 = additionalAppEnv.revision) !== null && _ref3 !== void 0 ? _ref3 : ''; // Parse all the supported URLs, which gets implicitly validated
 
   var envAppUrl = isProd ? appConfig.env.production.url : developmentAppUrl;
   var appUrl = getOrThrow(function () {
@@ -747,37 +755,26 @@ var processConfig = function processConfig() {
   // This is important to determine to which URL the MC should redirect to
   // after successful login.
 
-  var applicationId = isOidcForDevelopmentEnabled ? "__local:".concat(appConfig.entryPointUriPath) : undefined;
-
-  if (isProd) {
-    // TODO: decide if we do require the application ID or not.
-    if (appConfig.env.production.applicationId) {
-      var _context;
-
-      applicationId = _concatInstanceProperty__default["default"](_context = "".concat(appConfig.env.production.applicationId, ":")).call(_context, appConfig.entryPointUriPath);
-    } else {
-      // As long as we don't require the application ID in production, we should
-      // fall back to unset the value.
-      applicationId = undefined;
-    }
-  }
-
+  var applicationId = isProd ? _concatInstanceProperty__default["default"](_context = "".concat(appConfig.env.production.applicationId, ":")).call(_context, appConfig.entryPointUriPath) : "__local:".concat(appConfig.entryPointUriPath);
   var developmentConfig = isProd ? undefined : omitDevConfigIfEmpty({
-    oidc: isOidcForDevelopmentEnabled ? omitEmpty__default["default"]({
+    oidc: omitEmpty__default["default"]({
       authorizeUrl: [// In case the MC API url points to localhost, we need to point
       // to a local running dev login page to handle the workflow properly.
       mcApiUrl.hostname === 'localhost' ? mcApiUrl.origin.replace(mcApiUrl.port, String(developmentPort)) : mcApiUrl.origin.replace('mc-api', 'mc'), '/login/authorize'].join(''),
-      initialProjectKey: (_appConfig$env$develo = appConfig.env.development) === null || _appConfig$env$develo === void 0 ? void 0 : _appConfig$env$develo.initialProjectKey,
-      teamId: (_appConfig$env$develo2 = appConfig.env.development) === null || _appConfig$env$develo2 === void 0 ? void 0 : _appConfig$env$develo2.teamId,
+      initialProjectKey: appConfig.env.development.initialProjectKey,
+      teamId: (_appConfig$env$develo = appConfig.env.development) === null || _appConfig$env$develo === void 0 ? void 0 : _appConfig$env$develo.teamId,
       oAuthScopes: appConfig.oAuthScopes
-    }) : undefined,
-    menuLinks: appConfig.menuLinks,
+    }),
+    menuLinks: _objectSpread(_objectSpread({
+      icon: appConfig.icon
+    }, appConfig.mainMenuLink), {}, {
+      submenuLinks: appConfig.submenuLinks
+    }),
     // @ts-expect-error: the `accountLinks` is not explicitly typed as it's only used by the account app.
     accountLinks: appConfig.accountLinks
   });
   cachedConfig = {
     env: _objectSpread(_objectSpread(_objectSpread({}, omitEmpty__default["default"](additionalAppEnv)), {}, {
-      // TODO: how else should we provide the app identifier?
       applicationId: applicationId,
       applicationName: appConfig.name,
       entryPointUriPath: appConfig.entryPointUriPath
@@ -794,9 +791,9 @@ var processConfig = function processConfig() {
     }),
     headers: _objectSpread(_objectSpread({}, appConfig.headers), {}, {
       csp: _objectSpread(_objectSpread({}, (_appConfig$headers = appConfig.headers) === null || _appConfig$headers === void 0 ? void 0 : _appConfig$headers.csp), {}, {
-        'connect-src': getUniqueValues((_appConfig$headers2 = appConfig.headers) === null || _appConfig$headers2 === void 0 ? void 0 : _appConfig$headers2.csp['connect-src'], _concatInstanceProperty__default["default"](_context2 = [mcApiUrl.origin]).call(_context2, isProd ? [appUrl.href] : [])),
-        'script-src': getUniqueValues((_appConfig$headers3 = appConfig.headers) === null || _appConfig$headers3 === void 0 ? void 0 : _appConfig$headers3.csp['script-src'], isProd ? [appUrl.href, cdnUrl.href] : []),
-        'style-src': getUniqueValues((_appConfig$headers4 = appConfig.headers) === null || _appConfig$headers4 === void 0 ? void 0 : _appConfig$headers4.csp['style-src'], isProd ? [appUrl.href, cdnUrl.href] : [])
+        'connect-src': getUniqueValues((_appConfig$headers2 = appConfig.headers) === null || _appConfig$headers2 === void 0 ? void 0 : (_appConfig$headers2$c = _appConfig$headers2.csp) === null || _appConfig$headers2$c === void 0 ? void 0 : _appConfig$headers2$c['connect-src'], _concatInstanceProperty__default["default"](_context2 = [mcApiUrl.origin]).call(_context2, isProd ? [appUrl.href] : [])),
+        'script-src': getUniqueValues((_appConfig$headers3 = appConfig.headers) === null || _appConfig$headers3 === void 0 ? void 0 : (_appConfig$headers3$c = _appConfig$headers3.csp) === null || _appConfig$headers3$c === void 0 ? void 0 : _appConfig$headers3$c['script-src'], isProd ? [appUrl.href, cdnUrl.href] : []),
+        'style-src': getUniqueValues((_appConfig$headers4 = appConfig.headers) === null || _appConfig$headers4 === void 0 ? void 0 : (_appConfig$headers4$c = _appConfig$headers4.csp) === null || _appConfig$headers4$c === void 0 ? void 0 : _appConfig$headers4$c['style-src'], isProd ? [appUrl.href, cdnUrl.href] : [])
       })
     })
   };