@sap-ux/preview-middleware 0.20.2 → 0.20.4

package/README.md

@@ -31,7 +31,9 @@ When this middleware is used together with the `reload-middleware`, then the ord
 | `editors`               | `array`    | optional                                       | `undefined`      | List of configurations allowing to add mount points for additional editors                                                                                                                                                                            |
 | `editors.rta`           | `array`    | optional                                       | `undefined`      | Configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                     |
 | `editors.rta.layer`     | `string`   | optional                                       | `(calculated)`   | Property for defining the runtime adaptation layer for changes (default is `CUSTOMER_BASE` or read from the project for adaptation projects)                                                                                                          |
-| `editors.rta.endpoints` | `array`    | optional                                       | `undefined`      | List of mount points for editing                                                                                                                                                                                                                      |
+| `editors.rta.endpoints` | `array`    | optional                                       | `undefined`      | List of mount points for editing                                                                                                                                               
+| `editors.cardGenerator` | ---    | optional                                       | `undefined`      | Configuration object to enable card generation for an application.
+| `editors.cardGenerator.path` | `string`   | optional                              | `test/flpGeneratorSandbox.html`      | The mount point of the local SAP Fiori launchpad which will be considered for card generation.          
 | `test`                  | `array`    | optional                                       | `undefined`      | List of configurations for automated testing.                                                                                                                                                                                                         |
 | `debug`                 | `boolean`  | optional                                       | `false`          | Enables the debug output                                                                                                                                                                                                                              |
 

package/dist/base/config.d.ts

@@ -57,6 +57,7 @@ export interface TemplateConfig {
     }[];
     locateReuseLibsScript?: boolean;
     enhancedHomePage?: boolean;
+    enableCardGenerator?: boolean;
 }
 /**
  * Static settings
@@ -70,6 +71,11 @@ export declare const PREVIEW_URL: {
     };
     readonly api: "/preview/api";
 };
+export declare const CARD_GENERATOR_DEFAULT: {
+    readonly previewGeneratorSandbox: "/test/flpCardGeneratorSandbox.html";
+    readonly cardsStore: "/cards/store";
+    readonly i18nStore: "/editor/i18n";
+};
 /**
  * Default theme
  */

package/dist/base/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_INTENT = exports.DEFAULT_PATH = exports.DEFAULT_THEME = exports.PREVIEW_URL = void 0;
+exports.DEFAULT_INTENT = exports.DEFAULT_PATH = exports.DEFAULT_THEME = exports.CARD_GENERATOR_DEFAULT = exports.PREVIEW_URL = void 0;
 exports.getFlpConfigWithDefaults = getFlpConfigWithDefaults;
 exports.sanitizeConfig = sanitizeConfig;
 exports.sanitizeRtaConfig = sanitizeRtaConfig;
@@ -30,6 +30,11 @@ exports.PREVIEW_URL = {
     },
     api: '/preview/api'
 };
+exports.CARD_GENERATOR_DEFAULT = {
+    previewGeneratorSandbox: '/test/flpCardGeneratorSandbox.html',
+    cardsStore: '/cards/store',
+    i18nStore: '/editor/i18n'
+};
 /**
  * Default theme
  */
@@ -270,7 +275,8 @@ function createFlpTemplateConfig(config, manifest, resources = {}) {
             bootstrapOptions: ''
         },
         locateReuseLibsScript: config.libs,
-        enhancedHomePage: config.enhancedHomePage
+        enhancedHomePage: config.enhancedHomePage,
+        enableCardGenerator: false
     };
 }
 /**

package/dist/base/flp.d.ts

@@ -38,6 +38,7 @@ export declare class FlpSandbox {
     private readonly logger;
     private readonly utils;
     private readonly project;
+    private readonly cardGenerator?;
     /**
      * Constructor setting defaults and keeping reference to workspace resources.
      *
@@ -132,6 +133,15 @@ export declare class FlpSandbox {
      * Add routes for html and scripts required for a local FLP.
      */
     private addStandardRoutes;
+    /**
+     * Adds a middleware route for the Card Generator in the FLP sandbox.
+     *
+     * This route dynamically updates the `templateConfig` with the Card Generator application details
+     * and serves the FLP sandbox HTML using the `flpGetHandler`.
+     *
+     * @private
+     */
+    private addCardGeneratorMiddlewareRoute;
     /**
      * Read the UI5 version.
      * In case of an error, the default UI5 version '1.121.0' is returned.
@@ -263,6 +273,36 @@ export declare class FlpSandbox {
      * @param id application id from manifest
      */
     private addTestRoutes;
+    /**
+     * Stores the card manifest files in the webapp folder of the project and updates the application manifest.
+     *
+     * @param {Request} req - The HTTP request object containing the card manifest data in the body.
+     * @param {Response} res - The HTTP response object used to send the response back to the client.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private storeCardManifestHandler;
+    /**
+     * Adds a route to store card manifest files, the files are stored in the webapp folder of the project.
+     * The application manifest.json file is updated with the new card manifests information within the sap.cards.ap.embeds.
+     *
+     * @returns {Promise<void>} A promise that resolves when the route is added.
+     */
+    addStoreCardManifestRoute(): Promise<void>;
+    /**
+     * Handles the storage of i18n keys in the i18n file.
+     *
+     * @param {Request} req - The HTTP request object containing the i18n key-value pairs in the body.
+     * @param {Response} res - The HTTP response object used to send the response back to the client.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    private storeI18nKeysHandler;
+    /**
+     * Adds a route to store i18n properties in the i18n file.
+     * This function updates the i18n file with new properties provided in the request body.
+     *
+     * @returns {Promise<void>} A promise that resolves when the route is added.
+     */
+    addStoreI18nKeysRoute(): Promise<void>;
 }
 /**
  * Initialize the preview for an adaptation project.

package/dist/base/flp.js

@@ -1,13 +1,45 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlpSandbox = void 0;
 exports.initAdp = initAdp;
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
-const fs_1 = require("fs");
 const ejs_1 = require("ejs");
 const express_1 = require("express");
-const path_1 = require("path");
+const path_1 = __importStar(require("path"));
 const project_access_1 = require("@sap-ux/project-access");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const btp_utils_1 = require("@sap-ux/btp-utils");
@@ -16,6 +48,9 @@ const flex_1 = require("./flex");
 const test_1 = require("./test");
 const config_1 = require("./config");
 const cdm_1 = require("./cdm");
+const fs_1 = require("fs");
+const cards_1 = require("./utils/cards");
+const i18n_1 = require("@sap-ux/i18n");
 const DEFAULT_LIVERELOAD_PORT = 35729;
 /**
  * Class handling preview of a sandbox FLP.
@@ -33,6 +68,7 @@ class FlpSandbox {
     logger;
     utils;
     project;
+    cardGenerator;
     /**
      * Constructor setting defaults and keeping reference to workspace resources.
      *
@@ -50,6 +86,7 @@ class FlpSandbox {
         this.rta = config.editors?.rta ?? (0, config_1.sanitizeRtaConfig)(config.rta, logger); //NOSONAR
         logger.debug(`Config: ${JSON.stringify({ flp: this.flpConfig, rta: this.rta, test: this.test })}`);
         this.router = (0, express_1.Router)();
+        this.cardGenerator = config.editors?.cardGenerator;
     }
     /**
      * Registers a handler function to be called when a change request occurs.
@@ -81,6 +118,15 @@ class FlpSandbox {
             intent: this.flpConfig.intent
         }, this.logger);
         this.addStandardRoutes();
+        const cardGeneratorPath = this.cardGenerator?.path;
+        if (cardGeneratorPath) {
+            if (!cardGeneratorPath.startsWith('/')) {
+                this.cardGenerator.path = `/${cardGeneratorPath}`;
+            }
+            await this.addCardGeneratorMiddlewareRoute();
+            await this.addStoreCardManifestRoute();
+            await this.addStoreI18nKeysRoute();
+        }
         if (this.rta) {
             this.rta.options ??= {};
             this.rta.options.baseId = componentId ?? id;
@@ -285,9 +331,7 @@ class FlpSandbox {
     async flpGetHandler(req, res, next) {
         // connect API (karma test runner) has no request query property
         if ('query' in req && 'redirect' in res && !req.query['sap-ui-xx-viewCache']) {
-            const url = 'ui5-patched-router' in req
-                ? (0, path_1.join)(req['ui5-patched-router']?.baseUrl ?? '', this.flpConfig.path)
-                : this.flpConfig.path;
+            const url = 'ui5-patched-router' in req ? (0, path_1.join)(req['ui5-patched-router']?.baseUrl ?? '', req.path) : req.path;
             // Redirect to the same URL but add the necessary parameter
             const params = structuredClone(req.query);
             params['sap-ui-xx-viewCache'] = 'false';
@@ -323,6 +367,22 @@ class FlpSandbox {
             await this.flpGetHandler(req, res, next);
         });
     }
+    /**
+     * Adds a middleware route for the Card Generator in the FLP sandbox.
+     *
+     * This route dynamically updates the `templateConfig` with the Card Generator application details
+     * and serves the FLP sandbox HTML using the `flpGetHandler`.
+     *
+     * @private
+     */
+    async addCardGeneratorMiddlewareRoute() {
+        const previewGeneratorPath = this.cardGenerator?.path ?? config_1.CARD_GENERATOR_DEFAULT.previewGeneratorSandbox;
+        this.logger.debug(`Add route for ${previewGeneratorPath}`);
+        this.router.get(previewGeneratorPath, async (req, res, next) => {
+            this.templateConfig.enableCardGenerator = !!this.cardGenerator?.path;
+            await this.flpGetHandler(req, res, next);
+        });
+    }
     /**
      * Read the UI5 version.
      * In case of an error, the default UI5 version '1.121.0' is returned.
@@ -691,6 +751,97 @@ class FlpSandbox {
             });
         }
     }
+    /**
+     * Stores the card manifest files in the webapp folder of the project and updates the application manifest.
+     *
+     * @param {Request} req - The HTTP request object containing the card manifest data in the body.
+     * @param {Response} res - The HTTP response object used to send the response back to the client.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    async storeCardManifestHandler(req, res) {
+        try {
+            const { floorplan, localPath, fileName = project_access_1.FileName.Manifest, manifests } = req.body;
+            this.fs = this.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+            const webappPath = await (0, project_access_1.getWebappPath)(path_1.default.resolve(), this.fs);
+            const fullPath = (0, path_1.join)(webappPath, localPath);
+            const filePath = fileName.endsWith('.json') ? (0, path_1.join)(fullPath, fileName) : `${(0, path_1.join)(fullPath, fileName)}.json`;
+            const integrationCard = (0, cards_1.getIntegrationCard)(manifests);
+            this.fs.write(filePath, JSON.stringify(integrationCard.manifest, null, 2));
+            const entitySet = integrationCard.entitySet;
+            const sapCardsAp = (this.manifest['sap.cards.ap'] ??= {});
+            sapCardsAp.embeds ??= {};
+            sapCardsAp.embeds[floorplan] = {
+                default: entitySet,
+                manifests: {
+                    [entitySet]: [
+                        {
+                            localUri: localPath
+                        }
+                    ]
+                }
+            };
+            const appAccess = await (0, project_access_1.createApplicationAccess)(path_1.default.resolve(), this.fs);
+            await appAccess.updateManifestJSON(this.manifest, this.fs);
+            this.fs.commit(() => this.sendResponse(res, 'text/plain', 201, `Files were updated/created`));
+        }
+        catch (error) {
+            this.logger.error(`Files could not be created/updated. Error: ${error}`);
+            this.sendResponse(res, 'text/plain', 500, 'Files could not be created/updated.');
+        }
+    }
+    /**
+     * Adds a route to store card manifest files, the files are stored in the webapp folder of the project.
+     * The application manifest.json file is updated with the new card manifests information within the sap.cards.ap.embeds.
+     *
+     * @returns {Promise<void>} A promise that resolves when the route is added.
+     */
+    async addStoreCardManifestRoute() {
+        this.router.use(config_1.CARD_GENERATOR_DEFAULT.cardsStore, (0, express_1.json)());
+        this.logger.debug(`Add route for ${config_1.CARD_GENERATOR_DEFAULT.cardsStore}`);
+        this.router.post(config_1.CARD_GENERATOR_DEFAULT.cardsStore, async (req, res) => {
+            await this.storeCardManifestHandler(req, res);
+        });
+    }
+    /**
+     * Handles the storage of i18n keys in the i18n file.
+     *
+     * @param {Request} req - The HTTP request object containing the i18n key-value pairs in the body.
+     * @param {Response} res - The HTTP response object used to send the response back to the client.
+     * @returns {Promise<void>} A promise that resolves when the operation is complete.
+     */
+    async storeI18nKeysHandler(req, res) {
+        try {
+            this.fs = this.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+            const webappPath = await (0, project_access_1.getWebappPath)(path_1.default.resolve(), this.fs);
+            const i18nPath = this.manifest['sap.app'].i18n;
+            const filePath = i18nPath ? (0, path_1.join)(webappPath, i18nPath) : (0, path_1.join)(webappPath, 'i18n', 'i18n.properties');
+            const entries = req.body || [];
+            entries.forEach((entry) => {
+                if (entry.comment) {
+                    entry.annotation = entry.comment;
+                }
+            });
+            await (0, i18n_1.createPropertiesI18nEntries)(filePath, entries);
+            this.fs.commit(() => this.sendResponse(res, 'text/plain', 201, `i18n file updated.`));
+        }
+        catch (error) {
+            this.logger.error(`File could not be updated. Error: ${error}`);
+            this.sendResponse(res, 'text/plain', 500, 'File could not be updated.');
+        }
+    }
+    /**
+     * Adds a route to store i18n properties in the i18n file.
+     * This function updates the i18n file with new properties provided in the request body.
+     *
+     * @returns {Promise<void>} A promise that resolves when the route is added.
+     */
+    async addStoreI18nKeysRoute() {
+        this.router.use(config_1.CARD_GENERATOR_DEFAULT.i18nStore, (0, express_1.json)());
+        this.logger.debug(`Add route for ${config_1.CARD_GENERATOR_DEFAULT.i18nStore}`);
+        this.router.post(config_1.CARD_GENERATOR_DEFAULT.i18nStore, async (req, res) => {
+            await this.storeI18nKeysHandler(req, res);
+        });
+    }
 }
 exports.FlpSandbox = FlpSandbox;
 /**

package/dist/base/utils/cards.d.ts

@@ -0,0 +1,9 @@
+import type { MultiCardsPayload } from '../../types';
+/**
+ * Retrieves the integration card from the provided payload and prepares it for saving.
+ *
+ * @param {MultiCardsPayload[]} multipleCard - The payload containing multiple card manifests.
+ * @returns {MultiCardsPayload} The integration card manifest.
+ */
+export declare function getIntegrationCard(multipleCard: MultiCardsPayload[]): MultiCardsPayload;
+//# sourceMappingURL=cards.d.ts.map

package/dist/base/utils/cards.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getIntegrationCard = getIntegrationCard;
+const package_json_1 = __importDefault(require("../../../package.json"));
+const CARD_TYPES = {
+    INTEGRATION: 'integration',
+    ADAPTIVE: 'adaptive'
+};
+/**
+ * Prepares an integration card manifest for saving by adding the design time preview middleware i.e.`dtpMiddleware` version to the card manifest.
+ *
+ * @param {CardManifest} cardManifest - The card manifest object to be updated.
+ * @returns {void}
+ */
+function prepareIntegrationCardForSaving(cardManifest) {
+    const version = package_json_1.default.version;
+    const insights = cardManifest?.['sap.insights'];
+    if (!insights.versions) {
+        insights.versions = {
+            dtpMiddleware: version
+        };
+    }
+    else {
+        insights.versions.dtpMiddleware = version;
+    }
+}
+/**
+ * Retrieves the integration card from the provided payload and prepares it for saving.
+ *
+ * @param {MultiCardsPayload[]} multipleCard - The payload containing multiple card manifests.
+ * @returns {MultiCardsPayload} The integration card manifest.
+ */
+function getIntegrationCard(multipleCard) {
+    const integrationCard = multipleCard.find((card) => card.type === CARD_TYPES.INTEGRATION) ?? {
+        type: CARD_TYPES.INTEGRATION,
+        manifest: {
+            'sap.insights': {}
+        },
+        entitySet: ''
+    };
+    prepareIntegrationCardForSaving(integrationCard.manifest);
+    return integrationCard;
+}
+//# sourceMappingURL=cards.js.map

package/dist/client/adp/quick-actions/fe-v4/create-table-action.js

@@ -10,7 +10,7 @@ sap.ui.define(["sap/ui/dt/OverlayUtil", "../../../utils/core", "../../dialog-fac
   const TableQuickActionDefinitionBase = ___table_quick_action_base["TableQuickActionDefinitionBase"];
   const MDC_TABLE_TYPE = ___control_types["MDC_TABLE_TYPE"];
   const preprocessActionExecution = ___fe_v2_create_table_custom_column["preprocessActionExecution"];
-  const CREATE_TABLE_ACTION = 'create_table_action';
+  const CREATE_TABLE_ACTION = 'create-table-action';
 
   /**
    * Quick Action for creating table action.

package/dist/client/adp/quick-actions/fe-v4/create-table-action.ts

@@ -12,7 +12,7 @@ import { TableQuickActionDefinitionBase } from '../table-quick-action-base';
 import { MDC_TABLE_TYPE } from '../control-types';
 import { preprocessActionExecution } from '../fe-v2/create-table-custom-column';
 
-export const CREATE_TABLE_ACTION = 'create_table_action';
+export const CREATE_TABLE_ACTION = 'create-table-action';
 
 /**
  * Quick Action for creating table action.

package/dist/client/cpe/context-menu-service.js

@@ -5,8 +5,9 @@ sap.ui.define([
     '../i18n',
     'sap/base/Log',
     '../utils/core',
-    '../utils/version'
-], function (___sap_ux_private_control_property_editor_common, ___adp_dialog_factory, ___i18n, Log, ___utils_core, ___utils_version) {
+    '../utils/version',
+    '../utils/application'
+], function (___sap_ux_private_control_property_editor_common, ___adp_dialog_factory, ___i18n, Log, ___utils_core, ___utils_version, ___utils_application) {
     'use strict';
     const executeContextMenuAction = ___sap_ux_private_control_property_editor_common['executeContextMenuAction'];
     const reportTelemetry = ___sap_ux_private_control_property_editor_common['reportTelemetry'];
@@ -15,6 +16,7 @@ sap.ui.define([
     const getTextBundle = ___i18n['getTextBundle'];
     const getControlById = ___utils_core['getControlById'];
     const getUi5Version = ___utils_version['getUi5Version'];
+    const getApplicationType = ___utils_application['getApplicationType'];
     class ContextMenuService {
         sendAction = () => {
         };
@@ -36,7 +38,8 @@ sap.ui.define([
                             category: 'OutlineContextMenu',
                             actionName,
                             controlName,
-                            ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`
+                            ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`,
+                            appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
                         });
                     } catch (err) {
                         Log.error('Error in reporting Telemetry:', err);

package/dist/client/cpe/context-menu-service.ts

@@ -12,6 +12,7 @@ import { getTextBundle } from '../i18n';
 import Log from 'sap/base/Log';
 import { getControlById } from '../utils/core';
 import { getUi5Version } from '../utils/version';
+import { getApplicationType } from '../utils/application';
 
 /**
  * A Class of ContextMenuService
@@ -46,7 +47,8 @@ export class ContextMenuService {
                         category: 'OutlineContextMenu',
                         actionName,
                         controlName,
-                        ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`
+                        ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`,
+                        appType: getApplicationType(this.rta.getRootControlInstance().getManifest())
                     });
                 } catch (err) {
                     Log.error('Error in reporting Telemetry:', err);

package/dist/client/cpe/quick-actions/quick-action-service.js

@@ -3,8 +3,10 @@ sap.ui.define([
     'sap/base/Log',
     'open/ux/preview/client/thirdparty/@sap-ux-private/control-property-editor-common',
     '../../i18n',
-    '../../adp/dialog-factory'
-], function (Log, ___sap_ux_private_control_property_editor_common, ____i18n, ____adp_dialog_factory) {
+    '../../adp/dialog-factory',
+    '../../utils/application',
+    '../../utils/version'
+], function (Log, ___sap_ux_private_control_property_editor_common, ____i18n, ____adp_dialog_factory, ____utils_application, ____utils_version) {
     'use strict';
     const executeQuickAction = ___sap_ux_private_control_property_editor_common['executeQuickAction'];
     const quickActionListChanged = ___sap_ux_private_control_property_editor_common['quickActionListChanged'];
@@ -15,6 +17,8 @@ sap.ui.define([
     const reportTelemetry = ___sap_ux_private_control_property_editor_common['reportTelemetry'];
     const getTextBundle = ____i18n['getTextBundle'];
     const DialogFactory = ____adp_dialog_factory['DialogFactory'];
+    const getApplicationType = ____utils_application['getApplicationType'];
+    const getUi5Version = ____utils_version['getUi5Version'];
     class QuickActionService {
         sendAction = () => {
         };
@@ -104,11 +108,14 @@ sap.ui.define([
         }
         async executeAction(actionInstance, payload) {
             try {
+                const versionInfo = await getUi5Version();
                 await reportTelemetry({
                     category: 'QuickAction',
                     actionName: actionInstance.type,
                     telemetryEventIdentifier: actionInstance.getTelemetryIdentifier(true),
-                    quickActionSteps: actionInstance.quickActionSteps
+                    quickActionSteps: actionInstance.quickActionSteps,
+                    appType: getApplicationType(this.rta.getRootControlInstance().getManifest()),
+                    ui5Version: `${ versionInfo.major }.${ versionInfo.minor }.${ versionInfo.patch }`
                 });
             } catch (error) {
                 Log.error('Error in reporting Telemetry:', error);

package/dist/client/cpe/quick-actions/quick-action-service.ts

@@ -23,6 +23,9 @@ import { OutlineService } from '../outline/service';
 import { getTextBundle, TextBundle } from '../../i18n';
 import { ChangeService } from '../changes';
 import { DialogFactory } from '../../adp/dialog-factory';
+import { getApplicationType } from '../../utils/application';
+import { getUi5Version } from '../../utils/version';
+
 
 /**
  * Service providing Quick Actions.
@@ -152,11 +155,14 @@ export class QuickActionService implements Service {
 
     private async executeAction(actionInstance: QuickActionDefinition, payload: QuickActionExecutionPayload) {
         try {
+            const versionInfo = await getUi5Version();
             await reportTelemetry({
                 category: 'QuickAction',
                 actionName: actionInstance.type,
                 telemetryEventIdentifier: actionInstance.getTelemetryIdentifier(true),
-                quickActionSteps: actionInstance.quickActionSteps
+                quickActionSteps: actionInstance.quickActionSteps,
+                appType: getApplicationType(this.rta.getRootControlInstance().getManifest()),
+                ui5Version: `${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`
             });
         } catch (error) {
             Log.error('Error in reporting Telemetry:', error);

package/dist/client/flp/init.js

@@ -176,8 +176,25 @@ sap.ui.define([
             document.title = resourceBundle.getText(i18nKey) ?? document.title;
         }
     }
+    function addCardGenerationUserAction(componentInstance, container) {
+        sap.ui.require(['sap/cards/ap/generator/CardGenerator'], async CardGenerator => {
+            const extensionService = await container.getServiceAsync('Extension');
+            const controlProperties = {
+                icon: 'sap-icon://add',
+                id: 'generate_card',
+                text: 'Generate Card',
+                tooltip: 'Generate Card',
+                press: () => {
+                    CardGenerator.initializeAsync(componentInstance);
+                }
+            };
+            const parameters = { controlType: 'sap.ushell.ui.launchpad.ActionItem' };
+            const generateCardAction = await extensionService.createUserAction(controlProperties, parameters);
+            generateCardAction.showForCurrentApp();
+        });
+    }
     async function init(_ref) {
-        let {appUrls, flex, customInit, enhancedHomePage} = _ref;
+        let {appUrls, flex, customInit, enhancedHomePage, enableCardGenerator} = _ref;
         const urlParams = new URLSearchParams(window.location.search);
         const container = sap?.ushell?.Container ?? (await __ui5_require_async('sap/ushell/Container')).default;
         let scenario = '';
@@ -218,6 +235,20 @@ sap.ui.define([
                 });
             });
         }
+        if (enableCardGenerator && !isLowerThanMinimalUi5Version(ui5VersionInfo, {
+                major: 1,
+                minor: 121
+            })) {
+            container.attachRendererCreatedEvent(async function () {
+                const lifecycleService = await container.getServiceAsync('AppLifeCycle');
+                lifecycleService.attachAppLoaded(event => {
+                    const componentInstance = event.getParameter('componentInstance');
+                    addCardGenerationUserAction(componentInstance, container);
+                });
+            });
+        } else {
+            Log.warning('Card generator is not supported for the current UI5 version.');
+        }
         if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
             await resetAppState(container);
         }
@@ -243,7 +274,8 @@ sap.ui.define([
             appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
             flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
             customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit'),
-            enhancedHomePage: !!bootstrapConfig.getAttribute('data-open-ux-preview-enhanced-homepage')
+            enhancedHomePage: !!bootstrapConfig.getAttribute('data-open-ux-preview-enhanced-homepage'),
+            enableCardGenerator: !!bootstrapConfig.getAttribute('data-open-ux-preview-enable-card-generator')
         }).catch(e => {
             const error = getError(e);
             Log.error('Sandbox initialization failed: ' + error.message);

package/dist/client/flp/init.ts

@@ -13,6 +13,9 @@ import initConnectors from './initConnectors';
 import { getUi5Version, isLowerThanMinimalUi5Version, Ui5VersionInfo } from '../utils/version';
 import { CommunicationService } from '../cpe/communication-service';
 import { getTextBundle } from '../i18n';
+import type Component from 'sap/ui/core/Component';
+import type Extension from 'sap/ushell/services/Extension';
+import type { CardGeneratorType } from 'sap/cards/ap/generator';
 
 /**
  * SAPUI5 delivered namespaces from https://ui5.sap.com/#/api/sap
@@ -251,6 +254,34 @@ export function setI18nTitle(resourceBundle: ResourceBundle, i18nKey = 'appTitle
     }
 }
 
+/**
+ * This function dynamically adds a "Generate Card" action to the SAP Fiori Launchpad for the given component instance.
+ * 
+ * @param componentInstance - The instance of the component for which the card generation action is being added.
+ * @param container - The SAP Fiori Launchpad container instance used to access services.
+ */
+function addCardGenerationUserAction(componentInstance : Component, container : typeof sap.ushell.Container) {
+    sap.ui.require([
+        'sap/cards/ap/generator/CardGenerator'
+    ], async (CardGenerator : CardGeneratorType) => {
+        const extensionService = await container.getServiceAsync<Extension>('Extension');
+        const controlProperties = {
+            icon: 'sap-icon://add',
+            id: 'generate_card',
+            text: 'Generate Card',
+            tooltip: 'Generate Card',
+            press: () => {
+                CardGenerator.initializeAsync(componentInstance);
+            }
+        };
+        const parameters = {
+            controlType: 'sap.ushell.ui.launchpad.ActionItem'
+        };
+        const generateCardAction = await extensionService.createUserAction(controlProperties, parameters);
+        generateCardAction.showForCurrentApp();
+    });
+}
+
 /**
  * Apply additional configuration and initialize sandbox.
  *
@@ -265,12 +296,14 @@ export async function init({
     appUrls,
     flex,
     customInit,
-    enhancedHomePage
+    enhancedHomePage,
+    enableCardGenerator
 }: {
     appUrls?: string | null;
     flex?: string | null;
     customInit?: string | null;
     enhancedHomePage?: boolean | null;
+    enableCardGenerator?: boolean
 }): Promise<void> {
     const urlParams = new URLSearchParams(window.location.search);
     const container = sap?.ushell?.Container ??
@@ -320,6 +353,17 @@ export async function init({
             });
         });
     }
+    if (enableCardGenerator && !isLowerThanMinimalUi5Version(ui5VersionInfo, { major: 1, minor: 121 })) {
+        container.attachRendererCreatedEvent(async function () {
+            const lifecycleService = await container.getServiceAsync<AppLifeCycle>('AppLifeCycle');
+            lifecycleService.attachAppLoaded((event) => {
+                const componentInstance = event.getParameter('componentInstance');
+                addCardGenerationUserAction(componentInstance as unknown as Component, container);
+            });
+        });
+    } else {  
+        Log.warning('Card generator is not supported for the current UI5 version.');
+    } 
 
     // reset app state if requested
     if (urlParams.get('fiori-tools-iapp-state')?.toLocaleLowerCase() !== 'true') {
@@ -362,7 +406,8 @@ if (bootstrapConfig) {
         appUrls: bootstrapConfig.getAttribute('data-open-ux-preview-libs-manifests'),
         flex: bootstrapConfig.getAttribute('data-open-ux-preview-flex-settings'),
         customInit: bootstrapConfig.getAttribute('data-open-ux-preview-customInit'),
-        enhancedHomePage: !!bootstrapConfig.getAttribute('data-open-ux-preview-enhanced-homepage')
+        enhancedHomePage: !!bootstrapConfig.getAttribute('data-open-ux-preview-enhanced-homepage'),
+        enableCardGenerator: !!bootstrapConfig.getAttribute('data-open-ux-preview-enable-card-generator')
     }).catch((e) => {
         const error = getError(e);
         Log.error('Sandbox initialization failed: ' + error.message);

package/dist/types/index.d.ts

@@ -105,6 +105,9 @@ export type TestConfigDefaults = {
         framework: 'Testsuite';
     };
 };
+export type CardGeneratorConfig = {
+    path?: string;
+};
 /**
  * Middleware configuration.
  */
@@ -117,6 +120,7 @@ export interface MiddlewareConfig {
     rta?: InternalRtaConfig;
     editors?: {
         rta?: RtaConfig;
+        cardGenerator?: CardGeneratorConfig;
     };
     adp?: AdpPreviewConfig;
     debug?: boolean;
@@ -229,5 +233,23 @@ export declare const FLPHomePageDefaults: {
     catalogId: string;
     sectionId: string;
 };
+export interface MultiCardsPayload {
+    type: string;
+    manifest: CardManifest;
+    entitySet: string;
+}
+export interface I18nEntry {
+    key: string;
+    value: string;
+    comment?: string;
+    annotation?: string;
+}
+export interface CardManifest {
+    'sap.insights': {
+        versions?: {
+            dtpMiddleware?: string;
+        };
+    };
+}
 export {};
 //# sourceMappingURL=index.d.ts.map

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.20.2",
+  "version": "0.20.4",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -28,10 +28,10 @@
     "@sap-ux/adp-tooling": "0.14.2",
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/control-property-editor-sources": "npm:@sap-ux/control-property-editor@0.6.5",
-    "@sap-ux/feature-toggle": "0.3.0",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/project-access": "1.30.1",
-    "@sap-ux/system-access": "0.6.0"
+    "@sap-ux/system-access": "0.6.0",
+    "@sap-ux/feature-toggle": "0.3.0"
   },
   "devDependencies": {
     "@sap-ux-private/playwright": "0.2.0",
@@ -49,7 +49,7 @@
     "nock": "13.4.0",
     "npm-run-all2": "6.2.0",
     "supertest": "6.3.3",
-    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.1",
+    "@private/preview-middleware-client": "npm:@sap-ux-private/preview-middleware-client@0.14.3",
     "@sap-ux/axios-extension": "1.21.0",
     "@sap-ux/i18n": "0.3.0",
     "@sap-ux/store": "1.1.0",

package/templates/flp/cdm.html

@@ -42,6 +42,9 @@
         data-sap-ui-resourceroots='<%- JSON.stringify(ui5.resources) %>'
         data-sap-ui-frameOptions="allow"
         data-sap-ui-xx-componentPreload="off"<%- ui5.bootstrapOptions %>
+        <% if (enableCardGenerator) { %>
+            data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
         data-sap-ui-oninit="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
         data-open-ux-preview-customInit='<%- init %>'<% } if (locals.flex) { %>
         data-open-ux-preview-features='<%- JSON.stringify(features) %>'

package/templates/flp/sandbox.html

@@ -59,6 +59,9 @@
         data-sap-ui-resourceroots='<%- JSON.stringify(ui5.resources) %>'
         data-sap-ui-frameOptions="allow"
         data-sap-ui-xx-componentPreload="off"<%- ui5.bootstrapOptions %>
+        <% if (enableCardGenerator) { %>
+            data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
         data-sap-ui-oninit="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
         data-open-ux-preview-customInit='<%- init %>'<% } if (locals.flex) { %>
         data-open-ux-preview-features='<%- JSON.stringify(features) %>'

package/templates/flp/sandbox2.html

@@ -57,6 +57,9 @@
         data-sap-ui-resource-roots='<%- JSON.stringify(ui5.resources) %>'
         data-sap-ui-frame-options="allow"
         data-sap-ui-xx-component-preload="off"<%- ui5.bootstrapOptions %>
+        <% if (enableCardGenerator) { %>
+            data-open-ux-preview-enable-card-generator="<%- enableCardGenerator %>"
+        <% } %>
         data-sap-ui-on-init="module:open/ux/preview/client/flp/init"<% if (locals.init) { %>
         data-open-ux-preview-customInit='<%- init %>'<% } if (locals.flex) { %>
         data-open-ux-preview-features='<%- JSON.stringify(features) %>'