@sap-ux/generator-adp 0.1.20 → 0.2.0

package/generators/app/index.d.ts

@@ -42,6 +42,23 @@ export default class extends Generator {
      * Instance of the configuration prompter class.
      */
     private prompter;
+    /**
+     * JSON object representing the complete adaptation project configuration,
+     * passed as a CLI argument.
+     */
+    private readonly jsonInput?;
+    /**
+     * Instance of AbapServiceProvider.
+     */
+    private abapProvider;
+    /**
+     * Publicly available UI5 versions.
+     */
+    private publicVersions;
+    /**
+     * Indicates if the current layer is based on a customer base.
+     */
+    private isCustomerBase;
     /**
      * Creates an instance of the generator.
      *
@@ -68,6 +85,10 @@ export default class extends Generator {
      * Configures logging for the generator.
      */
     private _setupLogging;
+    /**
+     * Initialize the project generator from a json.
+     */
+    private _initFromJson;
 }
 export type { AdpGeneratorOptions };
 //# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -6,17 +6,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = require("path");
 const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
 const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
-const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
-const logger_1 = require("@sap-ux/logger");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const feature_toggle_1 = require("@sap-ux/feature-toggle");
-const layer_1 = require("./layer");
-const i18n_1 = require("../utils/i18n");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const logger_1 = require("@sap-ux/logger");
 const telemetryEvents_1 = require("../telemetryEvents");
+const deps_1 = require("../utils/deps");
+const i18n_1 = require("../utils/i18n");
 const logger_2 = __importDefault(require("../utils/logger"));
+const parse_json_input_1 = require("../utils/parse-json-input");
+const layer_1 = require("./layer");
 const attributes_1 = require("./questions/attributes");
 const configuration_1 = require("./questions/configuration");
-const deps_1 = require("../utils/deps");
+const default_values_1 = require("./questions/helper/default-values");
+const validators_1 = require("./questions/helper/validators");
 /**
  * Generator for creating an Adaptation Project.
  *
@@ -59,6 +62,23 @@ class default_1 extends yeoman_generator_1.default {
      * Instance of the configuration prompter class.
      */
     prompter;
+    /**
+     * JSON object representing the complete adaptation project configuration,
+     * passed as a CLI argument.
+     */
+    jsonInput;
+    /**
+     * Instance of AbapServiceProvider.
+     */
+    abapProvider;
+    /**
+     * Publicly available UI5 versions.
+     */
+    publicVersions;
+    /**
+     * Indicates if the current layer is based on a customer base.
+     */
+    isCustomerBase;
     /**
      * Creates an instance of the generator.
      *
@@ -72,19 +92,26 @@ class default_1 extends yeoman_generator_1.default {
         this.toolsLogger = new logger_1.ToolsLogger();
         this.vscode = opts.vscode;
         this.options = opts;
-        this._setupPrompts();
         this._setupLogging();
+        const jsonInputString = (0, parse_json_input_1.getFirstArgAsString)(args);
+        this.jsonInput = (0, parse_json_input_1.parseJsonInput)(jsonInputString, this.toolsLogger);
+        if (!this.jsonInput) {
+            this._setupPrompts();
+        }
     }
     async initializing() {
         await (0, i18n_1.initI18n)();
-        const pages = [
-            { name: (0, i18n_1.t)('yuiNavSteps.configurationName'), description: (0, i18n_1.t)('yuiNavSteps.configurationDescr') },
-            { name: (0, i18n_1.t)('yuiNavSteps.projectAttributesName'), description: (0, i18n_1.t)('yuiNavSteps.projectAttributesDescr') }
-        ];
-        this.prompts.splice(0, 0, pages);
         this.layer = await (0, layer_1.getFlexLayer)();
+        this.isCustomerBase = this.layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
         this.systemLookup = new adp_tooling_1.SystemLookup(this.toolsLogger);
-        this.prompter = new configuration_1.ConfigPrompter(this.systemLookup, this.layer, this.toolsLogger);
+        if (!this.jsonInput) {
+            const pages = [
+                { name: (0, i18n_1.t)('yuiNavSteps.configurationName'), description: (0, i18n_1.t)('yuiNavSteps.configurationDescr') },
+                { name: (0, i18n_1.t)('yuiNavSteps.projectAttributesName'), description: (0, i18n_1.t)('yuiNavSteps.projectAttributesDescr') }
+            ];
+            this.prompts.splice(0, 0, pages);
+            this.prompter = new configuration_1.ConfigPrompter(this.systemLookup, this.layer, this.toolsLogger);
+        }
         await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
             consumerModule: {
                 name: '@sap/generator-fiori:generator-adp',
@@ -95,6 +122,9 @@ class default_1 extends yeoman_generator_1.default {
         });
     }
     async prompting() {
+        if (this.jsonInput) {
+            return;
+        }
         const isCLI = (0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli;
         const configQuestions = this.prompter.getPrompts({
             appValidationCli: { hide: !isCLI },
@@ -120,13 +150,18 @@ class default_1 extends yeoman_generator_1.default {
         this.logger.info(`Project Attributes: ${JSON.stringify(this.attributeAnswers, null, 2)}`);
     }
     async writing() {
+        if (this.jsonInput) {
+            await this._initFromJson();
+        }
         try {
+            const provider = this.jsonInput ? this.abapProvider : this.prompter.provider;
+            const publicVersions = this.jsonInput ? this.publicVersions : this.prompter.ui5.publicVersions;
             const packageJson = (0, deps_1.getPackageInfo)();
             const config = await (0, adp_tooling_1.getConfig)({
-                provider: this.prompter.provider,
+                provider,
                 configAnswers: this.configAnswers,
                 attributeAnswers: this.attributeAnswers,
-                publicVersions: this.prompter?.ui5?.publicVersions,
+                publicVersions,
                 layer: this.layer,
                 packageJson,
                 logger: this.toolsLogger
@@ -185,6 +220,49 @@ class default_1 extends yeoman_generator_1.default {
         logger_2.default.configureLogging(this.options.logger, this.rootGeneratorName(), this.log, this.options.vscode, this.options.logLevel, this.options.logWrapper);
         this.logger = logger_2.default.logger;
     }
+    /**
+     * Initialize the project generator from a json.
+     */
+    async _initFromJson() {
+        if (!this.jsonInput) {
+            return;
+        }
+        const { system, client, username = '', password = '', application: baseApplicationName, applicationTitle, targetFolder = '/home/user/projects', projectName = (0, default_values_1.getDefaultProjectName)(targetFolder, `${baseApplicationName}.variant`), namespace = (0, default_values_1.getDefaultNamespace)(projectName, this.isCustomerBase) } = this.jsonInput;
+        await (0, validators_1.validateJsonInput)(this.systemLookup, this.isCustomerBase, {
+            projectName,
+            targetFolder,
+            namespace,
+            system
+        });
+        this.publicVersions = await (0, adp_tooling_1.fetchPublicVersions)();
+        const providerOptions = {
+            system,
+            client,
+            username,
+            password
+        };
+        this.abapProvider = await (0, adp_tooling_1.getConfiguredProvider)(providerOptions, this.toolsLogger);
+        const applications = await (0, adp_tooling_1.loadApps)(this.abapProvider, this.isCustomerBase);
+        const application = applications.find((application) => application.id === baseApplicationName);
+        if (!application) {
+            throw new Error((0, i18n_1.t)('error.applicationNotFound', { appName: baseApplicationName }));
+        }
+        this.configAnswers = {
+            system,
+            username,
+            password,
+            application
+        };
+        this.attributeAnswers = {
+            projectName,
+            title: applicationTitle ?? `${application.title} (variant)`,
+            namespace,
+            targetFolder,
+            // If not provided, latest ui5 version will be used. See getConfig() for a reference.
+            ui5Version: '',
+            enableTypeScript: false
+        };
+    }
 }
 exports.default = default_1;
 //# sourceMappingURL=index.js.map

package/generators/app/questions/helper/validators.d.ts

@@ -0,0 +1,26 @@
+import type { SystemLookup } from '@sap-ux/adp-tooling';
+interface JsonInputParams {
+    projectName: string;
+    targetFolder: string;
+    namespace: string;
+    system: string;
+}
+/**
+ * Validates the input parameters for an adaptation project configuration.
+ *
+ * @param {SystemLookup} systemLookup - The system lookup utility to resolve system names.
+ * @param {boolean} isCustomerBase - Indicates if the project is for the customer base layer.
+ * @param {JsonInputParams} params - The input parameters to validate.
+ * @param {string} params.projectName - The name of the project to validate.
+ * @param {string} params.targetFolder - The target folder where the project will be created.
+ * @param {string} params.namespace - The namespace of the project to validate.
+ * @param {string} params.system - The name of the system to validate.
+ * @throws {Error} Throws an error if any of the validations fail:
+ * - If the project name is invalid.
+ * - If the namespace is invalid.
+ * - If the system cannot be resolved.
+ * @returns {Promise<void>} Resolves if all validations pass, otherwise throws an error.
+ */
+export declare function validateJsonInput(systemLookup: SystemLookup, isCustomerBase: boolean, { projectName, targetFolder, namespace, system }: JsonInputParams): Promise<void>;
+export {};
+//# sourceMappingURL=validators.d.ts.map

package/generators/app/questions/helper/validators.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateJsonInput = void 0;
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const i18n_1 = require("../../../utils/i18n");
+const type_guards_1 = require("../../../utils/type-guards");
+/**
+ * Validates the input parameters for an adaptation project configuration.
+ *
+ * @param {SystemLookup} systemLookup - The system lookup utility to resolve system names.
+ * @param {boolean} isCustomerBase - Indicates if the project is for the customer base layer.
+ * @param {JsonInputParams} params - The input parameters to validate.
+ * @param {string} params.projectName - The name of the project to validate.
+ * @param {string} params.targetFolder - The target folder where the project will be created.
+ * @param {string} params.namespace - The namespace of the project to validate.
+ * @param {string} params.system - The name of the system to validate.
+ * @throws {Error} Throws an error if any of the validations fail:
+ * - If the project name is invalid.
+ * - If the namespace is invalid.
+ * - If the system cannot be resolved.
+ * @returns {Promise<void>} Resolves if all validations pass, otherwise throws an error.
+ */
+async function validateJsonInput(systemLookup, isCustomerBase, { projectName, targetFolder, namespace, system }) {
+    let validationResult = (0, project_input_validator_1.validateProjectName)(projectName, targetFolder, isCustomerBase);
+    if ((0, type_guards_1.isString)(validationResult)) {
+        throw new Error(validationResult);
+    }
+    validationResult = (0, project_input_validator_1.validateNamespaceAdp)(namespace, projectName, isCustomerBase);
+    if ((0, type_guards_1.isString)(validationResult)) {
+        throw new Error(validationResult);
+    }
+    const systemEndpoint = await systemLookup.getSystemByName(system);
+    if (!systemEndpoint) {
+        throw new Error((0, i18n_1.t)('error.systemNotFound', { system }));
+    }
+}
+exports.validateJsonInput = validateJsonInput;
+//# sourceMappingURL=validators.js.map

package/generators/app/types.d.ts

@@ -110,4 +110,19 @@ export type AttributePromptOptions = Partial<{
     [attributePromptNames.ui5ValidationCli]: CliValidationPromptOptions;
     [attributePromptNames.enableTypeScript]: EnableTypeScriptPromptOptions;
 }>;
+/**
+ * An interface representing the json input used to store the complete adaptation project
+ * generator configurations. The json is passed as an CLI argument.
+ */
+export interface JsonInput {
+    system: string;
+    client?: string;
+    username?: string;
+    password?: string;
+    application: string;
+    applicationTitle?: string;
+    targetFolder?: string;
+    projectName?: string;
+    namespace?: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/generators/translations/generator-adp.i18n.json

@@ -44,6 +44,8 @@
         "notDeployableSystemError": "The system that you have selected is not an ABAP On-Premise system which supports DTA_FOLDER deployment. Adaptation projects are only supported on those systems. Please choose an ABAP On-Premise system which supports DTA_FOLDER deployment.",
         "notFlexEnabledError": "The system that you have selected is not an ABAP On-Premise system which supports flexibility. Adaptation projects are only supported on those systems. Please choose an ABAP On-Premise system which supports flexibility. If you continue, you will only be able to create an extension project.",
         "manifestCouldNotBeValidated": "The manifest.json file of the selected application could not be validated. Please select a different application.",
-        "appDoesNotSupportAdaptation": "The application that you have selected does not support flexibility. Adaptation projects are only supported with those applications. Please choose an application which supports flexibility."
+        "appDoesNotSupportAdaptation": "The application that you have selected does not support flexibility. Adaptation projects are only supported with those applications. Please choose an application which supports flexibility.",
+        "systemNotFound": "System not found or not supported: {{system}}. Please check the system exists.",
+        "applicationNotFound": "Application not found or not supported: {{appName}}. Please check the application exists."
     }
 }

package/generators/utils/parse-json-input.d.ts

@@ -0,0 +1,20 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { JsonInput } from '../app/types';
+/**
+ * Returns the first argument from a list of CLI arguments. If the first argument
+ * is not a string returns empty string.
+ *
+ * @param {string | string[]} args - The list of CLI command arguments.
+ * @returns {string} The first parameter in the argument's list as string.
+ */
+export declare function getFirstArgAsString(args: string | string[]): string;
+/**
+ * Parse a json string as an object conforming to the {@link JsonInput} interface.
+ *
+ * @param {string} jsonString - The json string representation.
+ * @param {ToolsLogger} logger - The logger instance.
+ * @returns {JsonInput | undefined} The parsed json object, in case of an error or
+ * if the object does not match the above interface - returns undefined.
+ */
+export declare function parseJsonInput(jsonString: string, logger: ToolsLogger): JsonInput | undefined;
+//# sourceMappingURL=parse-json-input.d.ts.map

package/generators/utils/parse-json-input.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseJsonInput = exports.getFirstArgAsString = void 0;
+const type_guards_1 = require("./type-guards");
+/**
+ * Returns the first argument from a list of CLI arguments. If the first argument
+ * is not a string returns empty string.
+ *
+ * @param {string | string[]} args - The list of CLI command arguments.
+ * @returns {string} The first parameter in the argument's list as string.
+ */
+function getFirstArgAsString(args) {
+    if ((0, type_guards_1.isString)(args)) {
+        return args;
+    }
+    if (Array.isArray(args) && args.length) {
+        return args[0];
+    }
+    return '';
+}
+exports.getFirstArgAsString = getFirstArgAsString;
+/**
+ * Parse a json string as an object conforming to the {@link JsonInput} interface.
+ *
+ * @param {string} jsonString - The json string representation.
+ * @param {ToolsLogger} logger - The logger instance.
+ * @returns {JsonInput | undefined} The parsed json object, in case of an error or
+ * if the object does not match the above interface - returns undefined.
+ */
+function parseJsonInput(jsonString, logger) {
+    try {
+        const parsed = JSON.parse(jsonString);
+        if (!(0, type_guards_1.isJsonInput)(parsed)) {
+            return undefined;
+        }
+        return parsed;
+    }
+    catch (error) {
+        logger.debug(`Failed to parse adp JSON input: ${error.message}`);
+        return undefined;
+    }
+}
+exports.parseJsonInput = parseJsonInput;
+//# sourceMappingURL=parse-json-input.js.map

package/generators/utils/type-guards.d.ts

@@ -0,0 +1,16 @@
+import type { JsonInput } from '../app/types';
+/**
+ * Type guard for a string values.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value is of type string.
+ */
+export declare function isString(value: unknown): value is string;
+/**
+ * Type guard for an adaptation project configuration json.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value conforms to the AdpJsonInput interface.
+ */
+export declare function isJsonInput(value: unknown): value is JsonInput;
+//# sourceMappingURL=type-guards.d.ts.map

package/generators/utils/type-guards.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isJsonInput = exports.isString = void 0;
+/**
+ * Type guard for a string values.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value is of type string.
+ */
+function isString(value) {
+    return typeof value === 'string';
+}
+exports.isString = isString;
+/**
+ * Type guard for an adaptation project configuration json.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value conforms to the AdpJsonInput interface.
+ */
+function isJsonInput(value) {
+    if (!isPlainObject(value)) {
+        return false;
+    }
+    return (isString(value.system) &&
+        isString(value.application) &&
+        isOptionalString(value.applicationTitle) &&
+        isOptionalString(value.client) &&
+        isOptionalString(value.username) &&
+        isOptionalString(value.password) &&
+        isOptionalString(value.targetFolder) &&
+        isOptionalString(value.projectName) &&
+        isOptionalString(value.namespace));
+}
+exports.isJsonInput = isJsonInput;
+/**
+ * Type guard for a plain javascript object.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value is a plain javascripot object.
+ */
+function isPlainObject(value) {
+    return typeof value === 'object' && value !== null && Object.getPrototypeOf(value) === Object.prototype;
+}
+/**
+ * Type guard for an optional strings.
+ *
+ * @param {unknown} value - The value being checked.
+ * @returns {boolean} True if the value is string or undefined.
+ */
+function isOptionalString(value) {
+    return typeof value === 'undefined' || isString(value);
+}
+//# sourceMappingURL=type-guards.js.map

package/package.json

@@ -2,7 +2,7 @@
   "name": "@sap-ux/generator-adp",
   "displayName": "SAPUI5 Adaptation Project",
   "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": "0.1.20",
+  "version": "0.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,17 +29,17 @@
     "i18next": "23.5.1",
     "yeoman-generator": "5.10.0",
     "uuid": "10.0.0",
-    "@sap-ux/adp-tooling": "0.13.41",
-    "@sap-ux/axios-extension": "1.20.2",
+    "@sap-ux/adp-tooling": "0.13.42",
     "@sap-ux/btp-utils": "1.0.3",
+    "@sap-ux/axios-extension": "1.20.2",
+    "@sap-ux/inquirer-common": "0.6.42",
     "@sap-ux/feature-toggle": "0.2.3",
-    "@sap-ux/inquirer-common": "0.6.41",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.29.21",
+    "@sap-ux/project-access": "1.29.22",
     "@sap-ux/store": "1.0.0",
     "@sap-ux/system-access": "0.5.38",
-    "@sap-ux/project-input-validator": "0.5.4",
-    "@sap-ux/fiori-generator-shared": "0.11.2"
+    "@sap-ux/project-input-validator": "0.5.5",
+    "@sap-ux/fiori-generator-shared": "0.11.3"
   },
   "devDependencies": {
     "@jest/types": "29.6.3",