@sap-ux/preview-middleware 0.13.22 → 0.13.24

package/dist/client/flp/init.js

@@ -1,6 +1,6 @@
 "use strict";
 
-sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle", "sap/base/util/UriParameters"], function (Log, IconPool, ResourceBundle, UriParameters) {
+sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBundle"], function (Log, IconPool, ResourceBundle) {
   "use strict";
 
   /**
@@ -31,7 +31,7 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
    * @param appUrls urls pointing to included applications
    * @returns Promise of a comma separated list of all required libraries.
    */
-  function getManifestLibs(appUrls) {
+  async function getManifestLibs(appUrls) {
     const result = {};
     const promises = [];
     for (const url of appUrls) {
@@ -79,17 +79,32 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     });
   }
 
+  /**
+   * Fetch the app state from the given application urls, then reset the app state.
+   *
+   * @param container the UShell container
+   */
+  async function resetAppState(container) {
+    const appStateService = await container.getServiceAsync('AppState');
+    const urlParams = new URLSearchParams(window.location.hash);
+    const appStateValue = urlParams.get('sap-iapp-state') ?? urlParams.get('/?sap-iapp-state');
+    if (appStateValue) {
+      appStateService.deleteAppState(appStateValue);
+    }
+  }
+
   /**
    * Fetch the manifest from the given application urls, then parse them for custom libs, and finally request their urls.
    *
    * @param appUrls application urls
+   * @param urlParams URLSearchParams object
    * @returns returns a promise when the registration is completed.
    */
-  async function registerComponentDependencyPaths(appUrls) {
+  async function registerComponentDependencyPaths(appUrls, urlParams) {
     const libs = await getManifestLibs(appUrls);
     if (libs && libs.length > 0) {
       let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
-      const sapClient = UriParameters.fromQuery(window.location.search).get('sap-client');
+      const sapClient = urlParams.get('sap-client');
       if (sapClient && sapClient.length === 3) {
         url = url + '&sap-client=' + sapClient;
       }
@@ -129,7 +144,8 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
    */
   function setI18nTitle() {
     let i18nKey = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'appTitle';
-    const locale = sap.ui.getCore().getConfiguration().getLanguage();
+    const localization = sap.ui.require('sap/base/i18n/Localization') ?? sap.ui.getCore().getConfiguration();
+    const locale = localization.getLanguage();
     const resourceBundle = ResourceBundle.create({
       url: 'i18n/i18n.properties',
       locale
@@ -154,10 +170,12 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
       flex,
       customInit
     } = _ref;
+    const urlParams = new URLSearchParams(window.location.search);
+    const container = sap?.ushell?.Container ?? sap.ui.require('sap/ushell/Container');
     // Register RTA if configured
     if (flex) {
-      sap.ushell.Container.attachRendererCreatedEvent(async function () {
-        const lifecycleService = await sap.ushell.Container.getServiceAsync('AppLifeCycle');
+      container.attachRendererCreatedEvent(async function () {
+        const lifecycleService = await container.getServiceAsync('AppLifeCycle');
         lifecycleService.attachAppLoaded(event => {
           const version = sap.ui.version;
           const minor = parseInt(version.split('.')[1], 10);
@@ -186,9 +204,14 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
       });
     }
 
+    // reset app state if requested
+    if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
+      await resetAppState(container);
+    }
+
     // Load custom library paths if configured
     if (appUrls) {
-      await registerComponentDependencyPaths(JSON.parse(appUrls));
+      await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
     }
 
     // Load custom initialization module
@@ -199,7 +222,7 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
     // init
     setI18nTitle();
     registerSAPFonts();
-    const renderer = await sap.ushell.Container.createRenderer(undefined, true);
+    const renderer = await container.createRenderer(undefined, true);
     renderer.placeAt('content');
   }
   const bootstrapConfig = document.getElementById('sap-ui-bootstrap');
@@ -213,6 +236,7 @@ sap.ui.define(["sap/base/Log", "sap/ui/core/IconPool", "sap/base/i18n/ResourceBu
   var __exports = {
     __esModule: true
   };
+  __exports.resetAppState = resetAppState;
   __exports.registerComponentDependencyPaths = registerComponentDependencyPaths;
   __exports.registerSAPFonts = registerSAPFonts;
   __exports.setI18nTitle = setI18nTitle;

package/dist/client/flp/init.ts

@@ -4,8 +4,8 @@ import type { InitRtaScript, RTAPlugin, StartAdaptation } from 'sap/ui/rta/api/s
 import type { RTAOptions } from 'sap/ui/rta/RuntimeAuthoring';
 import IconPool from 'sap/ui/core/IconPool';
 import ResourceBundle from 'sap/base/i18n/ResourceBundle';
-import UriParameters from 'sap/base/util/UriParameters';
-
+import AppState from 'sap/ushell/services/AppState';
+import type Localization from 'sap/base/i18n/Localization';
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
  */
@@ -59,7 +59,7 @@ function addKeys(dependency: Record<string, unknown>, customLibs: Record<string,
  * @param appUrls urls pointing to included applications
  * @returns Promise of a comma separated list of all required libraries.
  */
-function getManifestLibs(appUrls: string[]): Promise<string> {
+async function getManifestLibs(appUrls: string[]): Promise<string> {
     const result = {} as Record<string, true>;
     const promises = [];
     for (const url of appUrls) {
@@ -120,17 +120,32 @@ function registerModules(
     });
 }
 
+/**
+ * Fetch the app state from the given application urls, then reset the app state.
+ *
+ * @param container the UShell container
+ */
+export async function resetAppState(container: typeof sap.ushell.Container): Promise<void> {
+    const appStateService = await container.getServiceAsync<AppState>('AppState');
+    const urlParams = new URLSearchParams(window.location.hash);
+    const appStateValue = urlParams.get('sap-iapp-state') ?? urlParams.get('/?sap-iapp-state');
+    if (appStateValue) {
+        appStateService.deleteAppState(appStateValue);
+    }
+}
+
 /**
  * Fetch the manifest from the given application urls, then parse them for custom libs, and finally request their urls.
  *
  * @param appUrls application urls
+ * @param urlParams URLSearchParams object
  * @returns returns a promise when the registration is completed.
  */
-export async function registerComponentDependencyPaths(appUrls: string[]): Promise<void> {
+export async function registerComponentDependencyPaths(appUrls: string[], urlParams: URLSearchParams): Promise<void> {
     const libs = await getManifestLibs(appUrls);
     if (libs && libs.length > 0) {
         let url = '/sap/bc/ui2/app_index/ui5_app_info?id=' + libs;
-        const sapClient = UriParameters.fromQuery(window.location.search).get('sap-client');
+        const sapClient = urlParams.get('sap-client');
         if (sapClient && sapClient.length === 3) {
             url = url + '&sap-client=' + sapClient;
         }
@@ -169,7 +184,9 @@ export function registerSAPFonts() {
  * @param i18nKey optional parameter to define the i18n key to be used for the title.
  */
 export function setI18nTitle(i18nKey = 'appTitle') {
-    const locale = sap.ui.getCore().getConfiguration().getLanguage();
+    const localization =
+        (sap.ui.require('sap/base/i18n/Localization') as Localization) ?? sap.ui.getCore().getConfiguration();
+    const locale = localization.getLanguage();
     const resourceBundle = ResourceBundle.create({
         url: 'i18n/i18n.properties',
         locale
@@ -197,10 +214,12 @@ export async function init({
     flex?: string | null;
     customInit?: string | null;
 }): Promise<void> {
+    const urlParams = new URLSearchParams(window.location.search);
+    const container = sap?.ushell?.Container ?? (sap.ui.require('sap/ushell/Container') as typeof sap.ushell.Container);
     // Register RTA if configured
     if (flex) {
-        sap.ushell.Container.attachRendererCreatedEvent(async function () {
-            const lifecycleService = await sap.ushell.Container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
+        container.attachRendererCreatedEvent(async function () {
+            const lifecycleService = await container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
             lifecycleService.attachAppLoaded((event) => {
                 const version = sap.ui.version;
                 const minor = parseInt(version.split('.')[1], 10);
@@ -236,9 +255,14 @@ export async function init({
         });
     }
 
+    // reset app state if requested
+    if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
+        await resetAppState(container);
+    }
+
     // Load custom library paths if configured
     if (appUrls) {
-        await registerComponentDependencyPaths(JSON.parse(appUrls));
+        await registerComponentDependencyPaths(JSON.parse(appUrls), urlParams);
     }
 
     // Load custom initialization module
@@ -249,7 +273,7 @@ export async function init({
     // init
     setI18nTitle();
     registerSAPFonts();
-    const renderer = await sap.ushell.Container.createRenderer(undefined, true);
+    const renderer = await container.createRenderer(undefined, true);
     renderer.placeAt('content');
 }
 

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Apreview-middleware"
   },
-  "version": "0.13.22",
+  "version": "0.13.24",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -26,9 +26,9 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "@sap-ux/logger": "0.5.1",
-    "@sap-ux/adp-tooling": "0.9.22",
+    "@sap-ux/adp-tooling": "0.9.23",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.4.17",
-    "@sap-ux/project-access": "1.19.13"
+    "@sap-ux/project-access": "1.19.14"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -44,8 +44,8 @@
     "supertest": "6.3.3",
     "@sap-ux-private/playwright": "0.0.3",
     "dotenv": "16.3.1",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.8",
     "@sap-ux/axios-extension": "1.11.7",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.9.7",
     "@sap-ux/store": "0.5.0",
     "@sap-ux/i18n": "0.0.6"
   },