@onecx/integration-interface 8.0.0-rc.9 → 8.0.0

package/README.md

@@ -11,7 +11,6 @@ npm install @onecx/integration-interface
 
 ## Additional Commands
 - `npx nx run integration-interface:build` - Builds the library and outputs the result to the `dist` folder.
-- `npx nx run integration-interface:build-migrations` - Builds the migration files for the library.
 - `npx nx run integration-interface:test` - Runs the unit tests for the library.
 - `npx nx run integration-interface:lint` - Lints the library's codebase.
 - `npx nx run integration-interface:release` - Releases a new version of the library to npm, following semantic versioning guidelines.

package/dist/index.cjs

@@ -49,6 +49,8 @@ __export(index_exports, {
   ImageRepositoryTopic: () => ImageRepositoryTopic,
   IsAuthenticatedTopic: () => IsAuthenticatedTopic,
   MessageTopic: () => MessageTopic,
+  NotificationService: () => NotificationService,
+  NotificationTopic: () => NotificationTopic,
   OverrideType: () => OverrideType,
   ParametersTopic: () => ParametersTopic,
   PermissionsRpcTopic: () => PermissionsRpcTopic,
@@ -61,11 +63,31 @@ __export(index_exports, {
   Technologies: () => Technologies,
   UNVERSIONED_KEY: () => UNVERSIONED_KEY,
   UserProfileTopic: () => UserProfileTopic,
+  buildPortalMessagePayload: () => buildPortalMessagePayload,
+  buildTranslatedMessage: () => buildTranslatedMessage,
+  constructBaseUrlFromWorkspace: () => constructBaseUrlFromWorkspace,
+  constructEndpointUrl: () => constructEndpointUrl,
+  constructRouteUrl: () => constructRouteUrl,
+  determineBrowserLanguage: () => determineBrowserLanguage,
+  dissolveEndpoint: () => dissolveEndpoint,
+  doesUrlExistForWorkspace: () => doesUrlExistForWorkspace,
   ensureIconCache: () => ensureIconCache,
+  fillParamsForPath: () => fillParamsForPath,
+  filterRouteFromList: () => filterRouteFromList,
+  findParameterValue: () => findParameterValue,
   generateClassName: () => generateClassName,
   getDynamicTranslationsCache: () => getDynamicTranslationsCache,
+  getInlinedConfig: () => getInlinedConfig,
+  getShellCapabilities: () => getShellCapabilities,
+  getStringFromUnknown: () => getStringFromUnknown,
   hasShellCapability: () => hasShellCapability,
-  normalizeIconName: () => normalizeIconName
+  normalizeIconName: () => normalizeIconName,
+  resolveConfig: () => resolveConfig,
+  resolveConfigPayload: () => resolveConfigPayload,
+  resolveLegacyLanguage: () => resolveLegacyLanguage,
+  resolveProfileLanguage: () => resolveProfileLanguage,
+  resolveTranslation: () => resolveTranslation,
+  setShellCapabilities: () => setShellCapabilities
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -73,25 +95,39 @@ module.exports = __toCommonJS(index_exports);
 var import_operators = require("rxjs/operators");
 var import_rxjs = require("rxjs");
 
+// libs/accelerator/src/lib/utils/ensure-property.utils.ts
+function ensureProperty(obj, path, initialValue) {
+  let current = obj;
+  for (let i = 0; i < path.length - 1; i++) {
+    const key = path[i];
+    if (current[key] == null || typeof current[key] !== "object") {
+      current[key] = {};
+    }
+    current = current[key];
+  }
+  const lastKey = path.at(-1);
+  if (lastKey === void 0) {
+    return obj;
+  }
+  current[lastKey] ??= initialValue;
+  return obj;
+}
+
 // libs/accelerator/src/lib/declarations.ts
-window["@onecx/accelerator"] ??= {};
-window["@onecx/accelerator"].gatherer ??= {};
-window["@onecx/accelerator"].gatherer.promises ??= {};
-window["@onecx/accelerator"].topic ??= {};
-window["@onecx/accelerator"].topic.useBroadcastChannel ??= "V2";
-window["@onecx/accelerator"].topic.initDate ??= Date.now();
-window["@onecx/accelerator"].topic.tabId ??= Math.ceil(globalThis.performance.now());
+var gatherPromises = ensureProperty(globalThis, ["@onecx/accelerator", "gatherer", "promises"], {});
+var topicUseBroadcastChannel = ensureProperty(gatherPromises, ["@onecx/accelerator", "topic", "useBroadcastChannel"], "V2");
+var topicInitDate = ensureProperty(topicUseBroadcastChannel, ["@onecx/accelerator", "topic", "initDate"], Date.now());
+var topicTabId = ensureProperty(topicInitDate, ["@onecx/accelerator", "topic", "tabId"], Math.ceil(globalThis.performance?.now?.() ?? 0));
 
 // libs/accelerator/src/lib/utils/logs.utils.ts
 function isStatsEnabled() {
-  return window["@onecx/accelerator"]?.topic?.statsEnabled === true;
+  const g2 = ensureProperty(topicTabId, ["@onecx/accelerator", "topic", "statsEnabled"], false);
+  return g2["@onecx/accelerator"].topic.statsEnabled === true;
 }
 function increaseMessageCount(topicName, messageType) {
-  window["@onecx/accelerator"].topic ??= {};
-  window["@onecx/accelerator"].topic.stats ??= {};
-  window["@onecx/accelerator"].topic.stats.messagesPublished ??= {};
+  const g2 = ensureProperty(topicTabId, ["@onecx/accelerator", "topic", "stats", "messagesPublished"], {});
   if (isStatsEnabled()) {
-    const messageStats = window["@onecx/accelerator"].topic.stats.messagesPublished;
+    const messageStats = g2["@onecx/accelerator"].topic.stats.messagesPublished;
     if (!messageStats[topicName]) {
       messageStats[topicName] = {
         TopicNext: 0,
@@ -103,11 +139,9 @@ function increaseMessageCount(topicName, messageType) {
   }
 }
 function increaseInstanceCount(topicName) {
-  window["@onecx/accelerator"].topic ??= {};
-  window["@onecx/accelerator"].topic.stats ??= {};
-  window["@onecx/accelerator"].topic.stats.instancesCreated ??= {};
+  const g2 = ensureProperty(globalThis, ["@onecx/accelerator", "topic", "stats", "instancesCreated"], {});
   if (isStatsEnabled()) {
-    const instanceStats = window["@onecx/accelerator"].topic.stats.instancesCreated;
+    const instanceStats = g2["@onecx/accelerator"].topic.stats.instancesCreated;
     if (!instanceStats[topicName]) {
       instanceStats[topicName] = 0;
     }
@@ -116,13 +150,13 @@ function increaseInstanceCount(topicName) {
 }
 
 // libs/accelerator/src/lib/topic/message.ts
-window["onecxMessageId"] ??= 1;
+var g = ensureProperty(globalThis, ["onecxMessageId"], 1);
 var Message = class {
   // id can be undefined while used via old implementation
   constructor(type) {
     this.type = type;
-    this.timestamp = window.performance.now();
-    this.id = window["onecxMessageId"]++;
+    this.timestamp = globalThis.performance?.now?.() ?? Date.now();
+    this.id = g.onecxMessageId++;
   }
   timestamp;
   id;
@@ -204,26 +238,28 @@ var TopicPublisher = class {
     if (this.publishBroadcastChannel && this.publishBroadcastChannelV2) {
       return;
     }
-    if (window["@onecx/accelerator"]?.topic?.useBroadcastChannel) {
+    if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel) {
       if (typeof BroadcastChannel === "undefined") {
         this.baseLogger.info("BroadcastChannel not supported. Disabling BroadcastChannel for topic publisher");
-        window["@onecx/accelerator"] ??= {};
-        window["@onecx/accelerator"].topic ??= {};
-        window["@onecx/accelerator"].topic.useBroadcastChannel = false;
+        topicTabId["@onecx/accelerator"].topic.useBroadcastChannel = false;
       } else {
         this.publishBroadcastChannel = new BroadcastChannel(`Topic-${this.name}|${this.version}`);
-        this.publishBroadcastChannelV2 = new BroadcastChannel(`TopicV2-${this.name}|${this.version}-${window["@onecx/accelerator"].topic.tabId}`);
+        this.publishBroadcastChannelV2 = new BroadcastChannel(`TopicV2-${this.name}|${this.version}-${topicTabId["@onecx/accelerator"].topic.tabId}`);
       }
     }
   }
   sendMessage(message) {
     this.createBroadcastChannel();
-    if (window["@onecx/accelerator"]?.topic?.useBroadcastChannel === "V2") {
+    if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel === "V2") {
       this.publishBroadcastChannelV2?.postMessage(message);
-    } else if (window["@onecx/accelerator"]?.topic?.useBroadcastChannel) {
+    } else if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel) {
       this.publishBroadcastChannel?.postMessage(message);
     } else {
-      window.postMessage(message, "*");
+      const postMessage = globalThis.postMessage;
+      if (typeof postMessage !== "function") {
+        throw new TypeError("postMessage is not available in this environment");
+      }
+      postMessage(message, "*");
     }
   }
 };
@@ -240,18 +276,13 @@ var Topic = class extends TopicPublisher {
   readBroadcastChannelV2;
   constructor(name, version, sendGetMessage = true) {
     super(name, version);
-    window["@onecx/accelerator"] ??= {};
-    window["@onecx/accelerator"].topic ??= {};
-    window["@onecx/accelerator"].topic.initDate ??= Date.now();
-    if (window["@onecx/accelerator"]?.topic?.useBroadcastChannel) {
+    if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel) {
       if (typeof BroadcastChannel === "undefined") {
         this.logger.info("BroadcastChannel not supported. Disabling BroadcastChannel for topic");
-        window["@onecx/accelerator"] ??= {};
-        window["@onecx/accelerator"].topic ??= {};
-        window["@onecx/accelerator"].topic.useBroadcastChannel = false;
+        topicTabId["@onecx/accelerator"].topic.useBroadcastChannel = false;
       } else {
         this.readBroadcastChannel = new BroadcastChannel(`Topic-${this.name}|${this.version}`);
-        this.readBroadcastChannelV2 = new BroadcastChannel(`TopicV2-${this.name}|${this.version}-${window["@onecx/accelerator"].topic.tabId}`);
+        this.readBroadcastChannelV2 = new BroadcastChannel(`TopicV2-${this.name}|${this.version}-${topicTabId["@onecx/accelerator"].topic.tabId}`);
       }
     }
     if (isStatsEnabled()) {
@@ -260,11 +291,14 @@ var Topic = class extends TopicPublisher {
     this.isInitializedPromise = new Promise((resolve) => {
       this.resolveInitPromise = resolve;
     });
-    window.addEventListener("message", this.windowEventListener);
+    const addEventListener = globalThis.addEventListener;
+    if (typeof addEventListener === "function") {
+      addEventListener("message", this.windowEventListener);
+    }
     this.readBroadcastChannel?.addEventListener("message", (m) => this.onBroadcastChannelMessage(m));
     this.readBroadcastChannelV2?.addEventListener("message", (m) => this.onBroadcastChannelMessageV2(m));
     if (sendGetMessage) {
-      if (window["@onecx/accelerator"].topic.initDate && Date.now() - window["@onecx/accelerator"].topic.initDate < 2e3) {
+      if (topicTabId["@onecx/accelerator"].topic.initDate && Date.now() - topicTabId["@onecx/accelerator"].topic.initDate < 2e3) {
         setTimeout(() => {
           if (!this.isInit) {
             const message = new TopicMessage("TopicGet" /* TopicGet */, this.name, this.version);
@@ -323,7 +357,10 @@ var Topic = class extends TopicPublisher {
     return this.asObservable().toPromise();
   }
   destroy() {
-    window.removeEventListener("message", this.windowEventListener, true);
+    const removeEventListener = globalThis.removeEventListener;
+    if (typeof removeEventListener === "function") {
+      removeEventListener("message", this.windowEventListener, true);
+    }
     this.readBroadcastChannel?.close();
     this.publishBroadcastChannel?.close();
     this.readBroadcastChannelV2?.close();
@@ -379,20 +416,16 @@ var Topic = class extends TopicPublisher {
     }
   }
   disableBroadcastChannel() {
-    window["@onecx/accelerator"] ??= {};
-    window["@onecx/accelerator"].topic ??= {};
-    if (window["@onecx/accelerator"].topic.useBroadcastChannel === true) {
+    if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel === true) {
       this.logger.info("Disabling BroadcastChannel for topic");
     }
-    window["@onecx/accelerator"].topic.useBroadcastChannel = false;
+    topicTabId["@onecx/accelerator"].topic.useBroadcastChannel = false;
   }
   disableBroadcastChannelV2() {
-    window["@onecx/accelerator"] ??= {};
-    window["@onecx/accelerator"].topic ??= {};
-    if (window["@onecx/accelerator"].topic.useBroadcastChannel === "V2") {
+    if (topicTabId["@onecx/accelerator"].topic.useBroadcastChannel === "V2") {
       this.logger.info("Disabling BroadcastChannel V2 for topic");
     }
-    window["@onecx/accelerator"].topic.useBroadcastChannel = true;
+    topicTabId["@onecx/accelerator"].topic.useBroadcastChannel = true;
   }
   handleTopicResolveMessage(m) {
     const publishPromiseResolver = this.publishPromiseResolver[m.data.resolveId];
@@ -430,24 +463,6 @@ var Topic = class extends TopicPublisher {
 // libs/accelerator/src/lib/topic/mocks/fake-topic.ts
 var import_rxjs2 = require("rxjs");
 
-// libs/accelerator/src/lib/utils/ensure-property.utils.ts
-function ensureProperty(obj, path, initialValue) {
-  let current = obj;
-  for (let i = 0; i < path.length - 1; i++) {
-    const key = path[i];
-    if (current[key] == null || typeof current[key] !== "object") {
-      current[key] = {};
-    }
-    current = current[key];
-  }
-  const lastKey = path.at(-1);
-  if (lastKey === void 0) {
-    return obj;
-  }
-  current[lastKey] ??= initialValue;
-  return obj;
-}
-
 // libs/integration-interface/src/lib/topics/current-mfe/v1/current-mfe.topic.ts
 var CurrentMfeTopic = class extends Topic {
   constructor() {
@@ -817,9 +832,17 @@ var ShellCapability = /* @__PURE__ */ ((ShellCapability2) => {
 })(ShellCapability || {});
 
 // libs/integration-interface/src/lib/utils/shell-capability.utils.ts
-function hasShellCapability(capability) {
-  return window["onecx-shell-capabilities"]?.includes(capability) ?? false;
-}
+var SHELL_CAPABILITIES_KEY = "onecx-shell-capabilities";
+var setShellCapabilities = (capabilities) => {
+  ;
+  globalThis[SHELL_CAPABILITIES_KEY] = capabilities;
+};
+var getShellCapabilities = () => {
+  return globalThis[SHELL_CAPABILITIES_KEY];
+};
+var hasShellCapability = (capability) => {
+  return getShellCapabilities()?.includes(capability) ?? false;
+};
 
 // libs/integration-interface/src/lib/services/dynamic-translation.service.ts
 var UNVERSIONED_KEY = "undefined";
@@ -1074,3 +1097,263 @@ var DynamicTranslationService = class {
     this.dynamicTranslationsTopic$.destroy();
   }
 };
+
+// libs/integration-interface/src/lib/utils/workspace.utils.ts
+var aliasStart = "[[";
+var aliasEnd = "]]";
+var paramStart = "{";
+var paramEnd = "}";
+var joinWithSlash = (base, path) => {
+  let normalizedBase = base;
+  let normalizedPath = path;
+  if (!normalizedBase.endsWith("/")) {
+    normalizedBase += "/";
+  }
+  if (normalizedPath.startsWith("/")) {
+    normalizedPath = normalizedPath.slice(1);
+  }
+  return normalizedBase + normalizedPath;
+};
+var constructBaseUrlFromWorkspace = (workspace, warn) => {
+  if (workspace.baseUrl === void 0) {
+    warn("There was no baseUrl for received workspace.");
+    return "";
+  }
+  return workspace.baseUrl;
+};
+var filterRouteFromList = (routes, appId, productName, warn) => {
+  if (!routes) {
+    return void 0;
+  }
+  const productRoutes = routes.filter((route) => route.appId === appId && route.productName === productName);
+  if (productRoutes.length === 0) {
+    return void 0;
+  }
+  if (productRoutes.length > 1) {
+    warn("There were more than one route. First route has been used.");
+  }
+  return productRoutes[0];
+};
+var dissolveEndpoint = (endpointName, endpoints) => {
+  let endpoint = endpoints.find((ep) => ep.name === endpointName);
+  if (!endpoint) {
+    return void 0;
+  }
+  while (endpoint.path?.includes(aliasStart)) {
+    const path = endpoint.path;
+    const startIdx = path.indexOf(aliasStart) + aliasStart.length;
+    const endIdx = path.lastIndexOf(aliasEnd);
+    if (endIdx <= startIdx) {
+      return void 0;
+    }
+    const aliasName = path.substring(startIdx, endIdx);
+    endpoint = endpoints.find((ep) => ep.name === aliasName);
+    if (!endpoint) {
+      return void 0;
+    }
+  }
+  return endpoint;
+};
+var getStringFromUnknown = (value) => {
+  if (value === null || value === void 0) {
+    return "";
+  }
+  if (typeof value === "string") {
+    return value;
+  }
+  return String(value);
+};
+var fillParamsForPath = (path, endpointParameters, warn) => {
+  while (path.includes(paramStart)) {
+    const paramName = path.substring(path.indexOf(paramStart) + paramStart.length, path.indexOf(paramEnd));
+    const paramValue = getStringFromUnknown(endpointParameters[paramName]);
+    if (paramValue && paramValue.length > 0) {
+      path = path.replace(paramStart.concat(paramName).concat(paramEnd), paramValue);
+    } else {
+      warn(`Searched param "${paramName}" was not found in given param list `);
+      return "";
+    }
+  }
+  return path;
+};
+var constructEndpointUrl = (route, endpointName, endpointParameters, warn = console.warn) => {
+  if (!route.endpoints) {
+    return "";
+  }
+  const finalEndpoint = dissolveEndpoint(endpointName, route.endpoints);
+  if (!finalEndpoint?.path) {
+    warn("No endpoint or endpoint.path could be found");
+    return "";
+  }
+  const paramsFilled = fillParamsForPath(finalEndpoint.path, endpointParameters ?? {}, warn);
+  if (paramsFilled === void 0) {
+    warn("Params could not be filled correctly");
+    return "";
+  }
+  return paramsFilled;
+};
+var constructRouteUrl = (workspace, appId, productName, endpointName, endpointParameters, warn = console.warn) => {
+  const route = filterRouteFromList(workspace.routes, appId, productName, warn);
+  let url = constructBaseUrlFromWorkspace(workspace, warn);
+  if (!route) {
+    warn(`No route.baseUrl could be found for given appId "${appId}" and productName "${productName}"`);
+    return url;
+  }
+  if (route.baseUrl?.length) {
+    url = route.baseUrl;
+  }
+  if (endpointName == void 0) {
+    return url;
+  }
+  const endpointPath = constructEndpointUrl(route, endpointName, endpointParameters, warn);
+  if (!endpointPath.length) {
+    return url;
+  }
+  url = joinWithSlash(url, endpointPath);
+  return url;
+};
+var doesUrlExistForWorkspace = (workspace, productName, appId, endpointName, warn = console.warn) => {
+  const checkEndpoint = endpointName !== void 0 && endpointName.length > 0;
+  if (!workspace.routes) {
+    return false;
+  }
+  const route = filterRouteFromList(workspace.routes, appId, productName, warn);
+  if (checkEndpoint) {
+    if (!route?.endpoints?.length) {
+      return false;
+    }
+    const endpoint = route.endpoints.find((ep) => ep.name === endpointName);
+    return !!endpoint?.path?.length;
+  }
+  return !!route?.baseUrl?.length;
+};
+
+// libs/integration-interface/src/lib/utils/user-language.utils.ts
+var determineBrowserLanguage = () => {
+  const windowRef = globalThis.window;
+  if (!windowRef || !windowRef.navigator) {
+    return void 0;
+  }
+  let browserLang = windowRef.navigator.languages?.[0];
+  browserLang = browserLang || windowRef.navigator.language;
+  if (!browserLang) {
+    return void 0;
+  }
+  if (browserLang.includes("-")) {
+    browserLang = browserLang.split("-")[0];
+  }
+  if (browserLang.includes("_")) {
+    browserLang = browserLang.split("_")[0];
+  }
+  return browserLang;
+};
+var resolveLegacyLanguage = (profile, defaultLang, determineLang = determineBrowserLanguage) => {
+  return profile.accountSettings?.localeAndTimeSettings?.locale ?? determineLang() ?? defaultLang;
+};
+var resolveProfileLanguage = (profile, defaultLang, getNormalizedLocales, determineLang = determineBrowserLanguage) => {
+  let locales = profile.settings?.locales;
+  if (!locales) {
+    return resolveLegacyLanguage(profile, defaultLang, determineLang);
+  }
+  if (locales.length === 0) {
+    locales = getNormalizedLocales();
+  }
+  const firstLang = locales.find((lang) => lang.length === 2);
+  return firstLang ?? defaultLang;
+};
+
+// libs/integration-interface/src/lib/utils/parameters.utils.ts
+var findParameterValue = (payload, key, productName, appId) => {
+  return payload.parameters.find((parameter) => parameter.productName === productName && parameter.appId === appId)?.parameters[key];
+};
+
+// libs/integration-interface/src/lib/utils/configuration.utils.ts
+var getInlinedConfig = () => {
+  return globalThis.APP_CONFIG;
+};
+var resolveConfig = async ({
+  defaultConfig = {},
+  skipRemoteConfigLoad,
+  remoteConfigURL,
+  loadRemoteConfig
+}) => {
+  const inlinedConfig = getInlinedConfig();
+  if (inlinedConfig) {
+    return { config: inlinedConfig, source: "inlined" };
+  }
+  if (skipRemoteConfigLoad) {
+    return { config: defaultConfig, source: "default" };
+  }
+  const resolvedUrl = remoteConfigURL || "assets/env.json";
+  const remoteConfig = await loadRemoteConfig(resolvedUrl);
+  return {
+    config: { ...defaultConfig, ...remoteConfig ?? {} },
+    source: "remote"
+  };
+};
+var resolveConfigPayload = async ({
+  defaultConfig = {},
+  skipRemoteConfigLoad,
+  remoteConfigURL,
+  loadRemoteConfig
+}) => {
+  const inlinedConfig = getInlinedConfig();
+  if (inlinedConfig) {
+    return { config: inlinedConfig, source: "inlined" };
+  }
+  if (skipRemoteConfigLoad) {
+    return { config: defaultConfig, source: "default" };
+  }
+  const resolvedUrl = remoteConfigURL || "assets/env.json";
+  const remoteConfig = await loadRemoteConfig(resolvedUrl);
+  return {
+    config: remoteConfig ?? {},
+    source: "remote"
+  };
+};
+
+// libs/integration-interface/src/lib/utils/portal-message.utils.ts
+var buildPortalMessagePayload = (severity, message, summary, detail) => ({
+  ...message,
+  severity,
+  summary,
+  detail
+});
+var resolveTranslation = async (translate, key, params) => {
+  if (!key) {
+    return void 0;
+  }
+  if (!translate) {
+    return key;
+  }
+  return await translate(key, params);
+};
+var buildTranslatedMessage = async (severity, message, translate) => {
+  const [summary, detail] = await Promise.all([
+    resolveTranslation(translate, message.summaryKey, message.summaryParameters),
+    resolveTranslation(translate, message.detailKey, message.detailParameters)
+  ]);
+  return buildPortalMessagePayload(severity, message, summary, detail);
+};
+
+// libs/integration-interface/src/lib/topics/notification/v1/notification.topic.ts
+var NotificationTopic = class extends Topic {
+  constructor() {
+    super("notification", 1);
+  }
+};
+
+// libs/integration-interface/src/lib/services/notification.service.ts
+var NotificationService = class {
+  _notificationTopic$;
+  get notificationTopic() {
+    this._notificationTopic$ ??= new NotificationTopic();
+    return this._notificationTopic$;
+  }
+  set notificationTopic(source) {
+    this._notificationTopic$ = source;
+  }
+  destroy() {
+    this.notificationTopic.destroy();
+  }
+};