@sap-ux/generator-adp 1.0.37 → 1.0.39

package/generators/app/index.d.ts

@@ -84,6 +84,10 @@ export default class extends Generator {
      * Indicates if the current environment is a CF environment.
      */
     private isCfEnv;
+    /**
+     * Tracks whether the writing phase failed, to prevent end() from overwriting a failure result.
+     */
+    private writingFailed;
     /**
      * Indicates if the user is logged in to CF.
      */

package/generators/app/index.js

@@ -23,6 +23,7 @@ const index_js_1 = require("../telemetry/index.js");
 const steps_js_1 = require("../utils/steps.js");
 const subgenHelpers_js_1 = require("../utils/subgenHelpers.js");
 const templates_js_1 = require("../utils/templates.js");
+const write_result_js_1 = require("../utils/write-result.js");
 const workspace_js_1 = require("../utils/workspace.js");
 const layer_js_1 = require("./layer.js");
 const attributes_js_1 = require("./questions/attributes.js");
@@ -119,6 +120,10 @@ class default_1 extends yeoman_generator_1.default {
      * Indicates if the current environment is a CF environment.
      */
     isCfEnv = false;
+    /**
+     * Tracks whether the writing phase failed, to prevent end() from overwriting a failure result.
+     */
+    writingFailed = false;
     /**
      * Indicates if the user is logged in to CF.
      */
@@ -336,7 +341,12 @@ class default_1 extends yeoman_generator_1.default {
             await (0, adp_tooling_1.generate)(this._getProjectPath(), config, this.fs);
         }
         catch (e) {
-            this.logger.error(`Writing phase failed: ${e}`);
+            const message = e instanceof Error ? e.message : String(e);
+            this.logger.error(`Writing phase failed: ${message}`);
+            this.writingFailed = true;
+            if (this.jsonInput?.id) {
+                (0, write_result_js_1.writeResult)(this.jsonInput.id, `Failure: ${message}`);
+            }
             throw new Error((0, i18n_js_1.t)('error.updatingApp'));
         }
         finally {
@@ -356,6 +366,10 @@ class default_1 extends yeoman_generator_1.default {
     }
     async end() {
         const projectPath = this._getProjectPath();
+        // Report the generated project path back to the BAS orchestrator once files are written to disk.
+        if (this.jsonInput?.id && !this.writingFailed) {
+            (0, write_result_js_1.writeResult)(this.jsonInput.id, projectPath);
+        }
         const data = fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
             appType: 'generator-adp',
             ...this.options.telemetryData,

package/generators/app/types.d.ts

@@ -253,6 +253,12 @@ export interface ExtensionProjectData {
  * generator configurations. The json is passed as an CLI argument.
  */
 export interface JsonInput {
+    /**
+     * Correlation key sent by the SAP Business Application Studio orchestrator. When present, the
+     * generation outcome (project path on success, `Failure: <message>` on error) is written back
+     * under this key so the orchestrator can poll the result of an async headless generation.
+     */
+    id?: string;
     system: string;
     client?: string;
     username?: string;

package/generators/utils/type-guards.js

@@ -21,7 +21,8 @@ function isJsonInput(value) {
     if (!isPlainObject(value)) {
         return false;
     }
-    return (isString(value.system) &&
+    return (isOptionalString(value.id) &&
+        isString(value.system) &&
         isString(value.application) &&
         isOptionalString(value.applicationTitle) &&
         isOptionalString(value.client) &&

package/generators/utils/write-result.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Absolute path of the file the SAP Business Application Studio orchestrator polls for
+ * headless generation results. Each result is stored under the correlation `id` supplied
+ * in the generator JSON input.
+ */
+export declare const RESULT_FILE_PATH = "/home/user/tmpProjectTemplate.json";
+/**
+ * Writes the outcome of a headless generation run to the orchestrator result file, keyed by
+ * the correlation `id` from the JSON input. Existing entries are preserved; a missing or
+ * malformed result file is treated as empty. The result file is a best-effort side channel:
+ * a write failure is swallowed so it never masks the actual generation outcome.
+ *
+ * @param {string} id - The correlation key supplied by the orchestrator in the JSON input.
+ * @param {string} result - The generated project path on success, or `Failure: <message>` on error.
+ */
+export declare function writeResult(id: string, result: string): void;
+//# sourceMappingURL=write-result.d.ts.map

package/generators/utils/write-result.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RESULT_FILE_PATH = void 0;
+exports.writeResult = writeResult;
+const node_fs_1 = require("node:fs");
+/**
+ * Absolute path of the file the SAP Business Application Studio orchestrator polls for
+ * headless generation results. Each result is stored under the correlation `id` supplied
+ * in the generator JSON input.
+ */
+exports.RESULT_FILE_PATH = '/home/user/tmpProjectTemplate.json';
+/**
+ * Writes the outcome of a headless generation run to the orchestrator result file, keyed by
+ * the correlation `id` from the JSON input. Existing entries are preserved; a missing or
+ * malformed result file is treated as empty. The result file is a best-effort side channel:
+ * a write failure is swallowed so it never masks the actual generation outcome.
+ *
+ * @param {string} id - The correlation key supplied by the orchestrator in the JSON input.
+ * @param {string} result - The generated project path on success, or `Failure: <message>` on error.
+ */
+function writeResult(id, result) {
+    let fileContent = {};
+    if ((0, node_fs_1.existsSync)(exports.RESULT_FILE_PATH)) {
+        try {
+            const parsed = JSON.parse((0, node_fs_1.readFileSync)(exports.RESULT_FILE_PATH, 'utf-8'));
+            if (parsed && typeof parsed === 'object' && !Array.isArray(parsed)) {
+                // Safe after the runtime object check; the file only ever holds a flat id -> result map.
+                fileContent = parsed;
+            }
+        }
+        catch {
+            fileContent = {};
+        }
+    }
+    fileContent[id] = result;
+    try {
+        (0, node_fs_1.writeFileSync)(exports.RESULT_FILE_PATH, JSON.stringify(fileContent));
+    }
+    catch {
+        // Best-effort side channel; never let a failed result write break generation.
+    }
+}
+//# sourceMappingURL=write-result.js.map

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "SAPUI5 Adaptation Project",
   "homepage": "https://help.sap.com/viewer/584e0bcbfd4a4aff91c815cefa0bce2d/Cloud/en-US/ada9567b767941aba8d49fdb4fdedea7.html",
   "description": "Adaptation project allows you to create an app variant for an existing SAP Fiori elements-based or SAPUI5 freestyle application, without changing the original application.",
-  "version": "1.0.37",
+  "version": "1.0.39",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,7 +30,7 @@
     "i18next": "25.10.10",
     "yeoman-generator": "5.10.0",
     "uuid": "11.1.1",
-    "@sap-ux/adp-tooling": "1.0.35",
+    "@sap-ux/adp-tooling": "1.0.36",
     "@sap-ux/axios-extension": "2.0.7",
     "@sap-ux/btp-utils": "2.0.5",
     "@sap-ux/feature-toggle": "1.0.5",
@@ -49,7 +49,7 @@
     "@jest/types": "30.4.1",
     "@types/fs-extra": "11.0.4",
     "@types/inquirer": "8.2.6",
-    "@types/vscode": "1.106.1",
+    "@types/vscode": "1.109.0",
     "@types/yeoman-environment": "2.10.11",
     "@types/yeoman-generator": "5.2.14",
     "@types/yeoman-test": "4.0.6",
@@ -58,7 +58,7 @@
     "fs-extra": "11.3.5",
     "rimraf": "6.1.3",
     "yeoman-test": "6.3.0",
-    "@sap-ux/deploy-config-sub-generator": "1.0.47"
+    "@sap-ux/deploy-config-sub-generator": "1.0.48"
   },
   "engines": {
     "node": ">=22.x"