@sap-ux/deploy-config-sub-generator 0.0.27 → 0.1.1

package/generators/headless/index.d.ts

@@ -0,0 +1,30 @@
+import { DeploymentGenerator } from '@sap-ux/deploy-config-generator-shared';
+import { DeployTarget } from '@sap-ux/fiori-generator-shared';
+import type { CfDeployConfigOptions } from '@sap-ux/cf-deploy-config-sub-generator';
+import type { AbapDeployConfigOptions } from '@sap-ux/abap-deploy-config-sub-generator';
+import type { AppConfig } from '@sap-ux/fiori-app-sub-generator';
+/**
+ * Headless deployment generator
+ */
+export default class extends DeploymentGenerator {
+    readonly genNamespace: string;
+    absAppConfigPath: string;
+    appConfig: AppConfig;
+    deployTarget?: DeployTarget;
+    /**
+     * Constructor for the headless deployment config generator.
+     *
+     * @param args - the arguments passed in
+     * @param opts - the options passed in
+     */
+    constructor(args: string | string[], opts: any);
+    initializing(): Promise<void>;
+    /**
+     * Transforms the external headless config to the deployment config options.
+     *
+     * @returns the deployment configuration options
+     */
+    transformExtConfig(): CfDeployConfigOptions | AbapDeployConfigOptions | undefined;
+    end(): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/generators/headless/index.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const fs_1 = require("fs");
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const utils_1 = require("../utils");
+/**
+ * Headless deployment generator
+ */
+class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
+    genNamespace;
+    absAppConfigPath;
+    appConfig;
+    deployTarget;
+    /**
+     * Constructor for the headless deployment config generator.
+     *
+     * @param args - the arguments passed in
+     * @param opts - the options passed in
+     */
+    constructor(args, opts) {
+        super(args, opts);
+        this.genNamespace = opts.namespace;
+        try {
+            this.argument('appConfig', {
+                type: String,
+                description: (0, utils_1.t)('headless.info.generatorArgAppConfig'),
+                required: false
+            });
+            // Is this a file path or app config as string
+            if (Object.keys(this.options.appConfig ?? {}).length === 0) {
+                throw Error((0, utils_1.t)('headless.error.headlessGenOptions'));
+            }
+            // Support direct cli/process execution
+            if (typeof this.options.appConfig === 'object') {
+                this.appConfig = this.options.appConfig;
+            }
+            else if (this.fs.exists(this.options.appConfig)) {
+                this.appConfig = JSON.parse(this.fs.read(this.options.appConfig));
+                this.absAppConfigPath = (0, path_1.resolve)(this.options.appConfig);
+            }
+            else {
+                this.appConfig = JSON.parse(this.options.appConfig);
+            } // Limited by OS max cli arg length
+            this.deployTarget = this.appConfig.deployConfig?.deployTarget;
+        }
+        catch (error) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.error((0, utils_1.t)('headless.error.generationExiting'));
+            this.env.error(error);
+        }
+    }
+    async initializing() {
+        deploy_config_generator_shared_1.DeploymentGenerator.logger?.info((0, utils_1.t)('headless.info.generatorNameVersion', {
+            generatorName: this.rootGeneratorName(),
+            generatorVersion: this.rootGeneratorVersion()
+        }));
+        const additionalTelemetryData = {
+            AppGenLaunchSource: this.options.appConfig.telemetryData?.generationSourceName ?? 'Headless',
+            AppGenLaunchSourceVersion: this.options.appConfig.telemetryData?.generationSourceVersion ?? 'Not Provided'
+        };
+        const deployConfigOpts = this.transformExtConfig();
+        if (deployConfigOpts && this.deployTarget) {
+            this.composeWith((0, utils_1.generatorNamespace)(this.genNamespace, this.deployTarget), {
+                arguments: this.args,
+                ...Object.assign(this.options, deployConfigOpts, {
+                    telemetryData: additionalTelemetryData
+                })
+            });
+        }
+    }
+    /**
+     * Transforms the external headless config to the deployment config options.
+     *
+     * @returns the deployment configuration options
+     */
+    transformExtConfig() {
+        let options;
+        if (this.deployTarget === fiori_generator_shared_1.DeployTarget.CF) {
+            const cf = this.appConfig.deployConfig;
+            if (this.appConfig.project.targetFolder) {
+                options = {
+                    projectRoot: this.appConfig.project.targetFolder,
+                    destinationName: cf.destinationName,
+                    destinationAuthType: cf.destinationAuthType,
+                    addManagedAppRouter: cf.addToManagedAppRouter,
+                    launchDeployConfigAsSubGenerator: true,
+                    appRootPath: (0, path_1.join)(this.appConfig.project.targetFolder, this.appConfig.project.name),
+                    addMTADestination: cf.addMTADestination,
+                    lcapModeOnly: cf.lcapModeOnly,
+                    cloudServiceName: cf.cloudServiceName
+                };
+            }
+        }
+        // ABAP support will be added in the future
+        return options;
+    }
+    end() {
+        if (this.options.deleteFile && this.fs.exists(this.absAppConfigPath)) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.info((0, utils_1.t)('headless.info.deletingApplicationConfigFile', { filepath: this.absAppConfigPath }));
+            (0, fs_1.unlinkSync)(this.absAppConfigPath);
+        }
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=index.js.map

package/generators/translations/deploy-config-sub-generator.i18n.json

@@ -8,5 +8,16 @@
     "debug": {
         "exit": "Exiting the deployment generator",
         "loadingPrompts": "Loading deploy prompts..."
+    },
+    "headless": {
+        "info": {
+            "generatorArgAppConfig": "Path to the application config file or application config as a string",
+            "generatorNameVersion": "Generating application with {{- generatorName}} {{generatorVersion}}",
+            "deletingApplicationConfigFile": "Deleting application config file: {{- filepath}}"
+        },
+        "error": {
+            "headlessGenOptions": "Please provide one of the following: 1) The first argument of the filepath to the app config, 2) The first argument of the app config file as a json string or, 3) An option 'appconfig' as a json object",
+            "generationExiting": "Application generation exiting due to error: {{- error}}"
+        }
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/deploy-config-sub-generator",
   "description": "Main generator for configuring ABAP or Cloud Foundry deployment configuration",
-  "version": "0.0.27",
+  "version": "0.1.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -34,13 +34,14 @@
     "@sap-ux/i18n": "0.2.3",
     "@sap-ux/inquirer-common": "0.6.33",
     "@sap-ux/nodejs-utils": "0.1.8",
-    "@sap-ux/odata-service-inquirer": "2.2.28",
+    "@sap-ux/odata-service-inquirer": "2.2.29",
     "@sap-ux/project-access": "1.29.18",
     "@sap-ux/store": "1.0.0",
     "@sap-ux/ui5-config": "0.26.5"
   },
   "devDependencies": {
     "@jest/types": "29.6.3",
+    "@types/fs-extra": "9.0.13",
     "@types/hasbin": "1.2.2",
     "@types/inquirer": "8.2.6",
     "@types/inquirer-autocomplete-prompt": "2.0.1",
@@ -51,6 +52,7 @@
     "@types/yeoman-environment": "2.10.11",
     "@types/yeoman-test": "4.0.6",
     "@sap/mta-lib": "1.7.4",
+    "fs-extra": "10.0.0",
     "js-yaml": "4.1.0",
     "memfs": "3.4.13",
     "rimraf": "5.0.5",
@@ -58,6 +60,8 @@
     "yeoman-test": "6.3.0",
     "@sap-ux/cf-deploy-config-inquirer": "0.2.24",
     "@sap-ux/cf-deploy-config-writer": "0.2.0",
+    "@sap-ux/fiori-app-sub-generator": "0.0.3",
+    "@sap-ux/jest-file-matchers": "0.2.1",
     "@sap-ux/logger": "0.6.0"
   },
   "engines": {