@sap-ux/fiori-app-sub-generator 0.0.2

package/generators/utils/stepsHelper.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateDependentStep = updateDependentStep;
+exports.hasActiveStep = hasActiveStep;
+exports.hasStep = hasStep;
+exports.getYeomanUiStepConfig = getYeomanUiStepConfig;
+exports.validateNextStep = validateNextStep;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const i18n_1 = require("../utils/i18n");
+/**
+ * Find the index of a step in the Yeoman UI steps.
+ *
+ * @param stepName The name (title) of the step to check. Not the step key.
+ * @param prompts
+ * @returns
+ */
+function getStepIndex(stepName, prompts) {
+    const steps = prompts.items;
+    return steps?.findIndex((step) => {
+        return step.name === (0, i18n_1.t)(stepName);
+    });
+}
+/**
+ * Update the dependent step in the active steps of the Yeoman UI steps. Ultimately this will result in a new step being added to the Application Wizard.
+ *
+ * @param currentStepName The name (title) of the step that is being toggled. Not the step key.
+ * @param stepConfigList
+ * @param action Add dependent step if true, remove if false.
+ * @param dependentStepName
+ */
+function updateDependentStep(currentStepName, stepConfigList, action, dependentStepName) {
+    stepConfigList.forEach((stepConfig) => {
+        const dependentSteps = stepConfig.dependentMap[currentStepName];
+        const indexOfdependentSteps = [];
+        dependentSteps.forEach((dependentStep) => {
+            const index = getStepIndex(dependentStep.name, stepConfig.activeSteps);
+            indexOfdependentSteps.push(index);
+        });
+        const currentStepIndex = getStepIndex(currentStepName, stepConfig.activeSteps);
+        // We turn on/off all the dependent steps together, check only index 0 is sufficient
+        if (!dependentStepName) {
+            if (indexOfdependentSteps.length > 0 && indexOfdependentSteps[0] >= 0 && !action) {
+                // If user doens't want to add deployment config, remove them from active steps.
+                // For each dependent step at index i we remove, the next dependent step will be at index i.
+                // So we keep removing dependent steps at indexOfdependentSteps[0].
+                indexOfdependentSteps.forEach(() => {
+                    stepConfig.activeSteps.splice(indexOfdependentSteps[0], 1, []);
+                });
+            }
+            if (indexOfdependentSteps.length > 0 && indexOfdependentSteps[0] < 0 && action) {
+                // If user doens't want to add deployment config, add them to active steps.
+                for (let i = 0; i < indexOfdependentSteps.length; i++) {
+                    const dependentStep = dependentSteps[i];
+                    // If the dependency step is at index currentStepIndex, the dependent steps
+                    // are added to index currentStepIndex + 1, currentStepIndex + 2, etc.
+                    stepConfig.activeSteps.splice(currentStepIndex + i + 1, 0, [
+                        { name: dependentStep.name, description: dependentStep.description }
+                    ]);
+                }
+            }
+        }
+        else if (!action) {
+            const dependentStepIndex = getStepIndex(dependentStepName, stepConfig.activeSteps);
+            if (dependentStepIndex >= 0) {
+                stepConfig.activeSteps.splice(dependentStepIndex, 1, []);
+            }
+        }
+        else {
+            // Count number of dependent steps that are active
+            let count = 0;
+            let dependentStepToAdd;
+            for (const dependentStep of dependentSteps) {
+                if (dependentStep.name === dependentStepName) {
+                    dependentStepToAdd = dependentStep;
+                    break;
+                }
+                const index = getStepIndex(dependentStep.name, stepConfig.activeSteps);
+                if (index >= 0) {
+                    count++;
+                }
+            }
+            if (dependentStepToAdd) {
+                const index = getStepIndex(dependentStepToAdd.name, stepConfig.activeSteps);
+                if (index < 0) {
+                    stepConfig.activeSteps.splice(currentStepIndex + count + 1, 0, [
+                        { name: dependentStepToAdd.name, description: dependentStepToAdd.description }
+                    ]);
+                }
+            }
+        }
+    });
+}
+/**
+ * Check if a step is considered active in the Yeoman UI steps.
+ *
+ * @param stepName The name (title) of the step to check. Not the step key.
+ * @param yuiSteps
+ * @returns
+ */
+function hasActiveStep(stepName, yuiSteps) {
+    return getStepIndex(stepName, yuiSteps) > -1;
+}
+/**
+ *  Check if a step is present in the steps array. Non-present steps are not added to the Application Wizard, essentially skipping them.
+ *
+ * @param steps
+ * @param stepKey
+ * @returns
+ */
+function hasStep(steps, stepKey) {
+    return !!steps.find((step) => step.key === stepKey);
+}
+/**
+ * Get the Yeoman UI step configuration.
+ *
+ * @param stepsArr
+ * @returns
+ */
+function getYeomanUiStepConfig(stepsArr) {
+    const activeStepsArr = [];
+    const dependentMap = {};
+    stepsArr.forEach((step, index) => {
+        if (step['dependency']) {
+            if (index - 1 < 0) {
+                throw (0, i18n_1.t)('error.invalidYUIStepConfig');
+            }
+            const dependencyStepName = step['dependency'];
+            if (dependencyStepName) {
+                if (!dependentMap[dependencyStepName]) {
+                    dependentMap[dependencyStepName] = [];
+                }
+                dependentMap[dependencyStepName].push(step);
+            }
+        }
+        else {
+            activeStepsArr.push(step);
+        }
+    });
+    const stepConfig = {
+        activeSteps: new yeoman_ui_types_1.Prompts(activeStepsArr),
+        dependentMap: dependentMap
+    };
+    return stepConfig;
+}
+/**
+ * Used in Inquirer prompt validators to dynamically add or remove dependent steps to the Application Wizard.
+ * For example, may be used when a user checks `addDeployConfig` to add that deployment config step to the wizard.
+ *
+ * @param addDependentStep
+ * @param currentStepName
+ * @param appGenStepConfigList
+ * @param dependentStepName
+ * @returns
+ */
+function validateNextStep(addDependentStep, currentStepName, appGenStepConfigList, dependentStepName) {
+    if (appGenStepConfigList) {
+        updateDependentStep(currentStepName, appGenStepConfigList, addDependentStep, dependentStepName);
+    }
+    return true;
+}
+//# sourceMappingURL=stepsHelper.js.map

package/generators/utils/telemetry.d.ts

@@ -0,0 +1,16 @@
+import { ApiHubType, type TelemetryBusinessHubType, type Service, type TelemetrySapSystemType } from '../types';
+/**
+ * Get the SAP system type as reported in telemetry events.
+ *
+ * @param connectedSystem
+ * @returns
+ */
+export declare function getTelemetrySapSystemType(connectedSystem: Service['connectedSystem']): TelemetrySapSystemType | undefined;
+/**
+ * Get the business hub type as reported in telemetry events.
+ *
+ * @param apiHubType
+ * @returns
+ */
+export declare function getTelemetryBusinessHubType(apiHubType?: ApiHubType): TelemetryBusinessHubType | undefined;
+//# sourceMappingURL=telemetry.d.ts.map

package/generators/utils/telemetry.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTelemetrySapSystemType = getTelemetrySapSystemType;
+exports.getTelemetryBusinessHubType = getTelemetryBusinessHubType;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const common_1 = require("./common");
+/**
+ * Get the SAP system type as reported in telemetry events.
+ *
+ * @param connectedSystem
+ * @returns
+ */
+function getTelemetrySapSystemType(connectedSystem) {
+    if ((0, common_1.isBTPHosted)(connectedSystem)) {
+        return 'SCP';
+    }
+    if ((connectedSystem?.destination && (0, btp_utils_1.isOnPremiseDestination)(connectedSystem.destination)) ||
+        (connectedSystem?.backendSystem && !connectedSystem.backendSystem.serviceKeys)) {
+        return 'ABAP';
+    }
+    // The only remaining case is CF on VSCode
+    if (connectedSystem?.serviceProvider) {
+        return 'CF';
+    }
+}
+/**
+ * Get the business hub type as reported in telemetry events.
+ *
+ * @param apiHubType
+ * @returns
+ */
+function getTelemetryBusinessHubType(apiHubType) {
+    if (apiHubType === "API_HUB" /* ApiHubType.apiHub */) {
+        return 'BusinessAcceleratorHub';
+    }
+    else if (apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */) {
+        return 'BusinessHubEnterprise';
+    }
+    return undefined;
+}
+//# sourceMappingURL=telemetry.js.map

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@sap-ux/fiori-app-sub-generator",
+  "description": "A yeoman (sub) generator that can generate Fiori applications. Not for standalone use.",
+  "version": "0.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/fiori-app-sub-generator"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Afiori-app-sub-generator"
+  },
+  "license": "Apache-2.0",
+  "main": "generators/index.js",
+  "files": [
+    "LICENSE",
+    "generators",
+    "!generators/*.map",
+    "!generators/**/*.map"
+  ],
+  "dependencies": {
+    "@sap-ux/annotation-converter": "0.10.3",
+    "@sap-ux/edmx-parser": "0.9.0",
+    "@sap/service-provider-apis": "2.1.5",
+    "i18next": "23.11.2",
+    "inquirer": "8.2.6",
+    "lodash": "4.17.21",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
+    "uuid": "11.0.5",
+    "yeoman-generator": "5.10.0",
+    "@sap-ux/annotation-generator": "0.3.22",
+    "@sap-ux/axios-extension": "1.19.2",
+    "@sap-ux/btp-utils": "1.0.2",
+    "@sap-ux/cap-config-writer": "0.9.23",
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/fiori-elements-writer": "2.1.36",
+    "@sap-ux/fiori-freestyle-writer": "2.2.6",
+    "@sap-ux/fiori-generator-shared": "0.10.0",
+    "@sap-ux/fiori-tools-settings": "0.1.0",
+    "@sap-ux/launch-config": "0.8.1",
+    "@sap-ux/odata-service-inquirer": "2.2.28",
+    "@sap-ux/odata-service-writer": "0.26.13",
+    "@sap-ux/project-access": "1.29.18",
+    "@sap-ux/store": "1.0.0",
+    "@sap-ux/telemetry": "0.5.72",
+    "@sap-ux/ui5-application-inquirer": "0.11.2",
+    "@sap-ux/ui5-info": "0.9.1"
+  },
+  "devDependencies": {
+    "@sap-devx/yeoman-ui-types": "1.16.9",
+    "@types/inquirer": "8.2.6",
+    "@types/lodash": "4.14.202",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/vscode": "1.73.1",
+    "@types/yeoman-environment": "2.10.11",
+    "@types/yeoman-generator": "5.2.14",
+    "@types/yeoman-test": "4.0.6",
+    "jest-extended": "4.0.2",
+    "jest-mock": "29.7.0",
+    "mock-spawn": "0.2.6",
+    "rimraf": "5.0.5",
+    "yeoman-test": "6.3.0",
+    "@sap-ux/flp-config-sub-generator": "0.1.52",
+    "@sap-ux/inquirer-common": "0.6.33",
+    "@sap-ux/jest-file-matchers": "0.2.1",
+    "@sap-ux/logger": "0.6.0"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob generators test/test-output coverage *.tsbuildinfo",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}