@sap-ux/repo-app-import-sub-generator 1.1.20 → 1.1.22

package/generators/app/app-config-abap-repo.d.ts

@@ -1,25 +1,15 @@
-import { OdataVersion } from '@sap-ux/odata-service-inquirer';
+import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { Editor } from 'mem-fs-editor';
-import type { AppInfo, AbapRepositoryContext } from '../app/types.js';
+import type { AppInfo, AbapRepositoryContext, AbapRepoAppConfig } from '../app/types.js';
 import type { AbapDeployConfig } from '@sap-ux/ui5-config';
 /**
- * App configuration derived from the downloaded manifest for the ABAP repository flow.
- * Used only for README generation, launch config creation, and adding a minimal package.json.
+ * Fetches OData metadata for the main service and writes it to local service folder in the webapp.
+ *
+ * @param {AbapServiceProvider} provider - The connected ABAP service provider.
+ * @param {string} webappPath - Absolute path to the webapp folder.
+ * @param {Editor} fs - The mem-fs editor.
  */
-export interface AbapRepoAppConfig {
-    app: {
-        id: string;
-        title: string;
-        flpAppId: string;
-    };
-    service: {
-        url: string | undefined;
-        version: OdataVersion;
-    };
-    ui5: {
-        version: string;
-    };
-}
+export declare function writeServiceMetadata(provider: AbapServiceProvider, webappPath: string, fs: Editor): Promise<void>;
 /**
  * Builds the app configuration for the ABAP repository download flow by reading
  * the downloaded manifest. Returns a typed config object used for README generation, launch config, and deploy config.

package/generators/app/app-config-abap-repo.js

@@ -3,11 +3,31 @@ import { PromptState } from '../prompts/prompt-state.js';
 import RepoAppDownloadLogger from '../utils/logger.js';
 import { t } from '../utils/i18n.js';
 import { getFlpId } from '@sap-ux/fiori-generator-shared';
-import { FileName, getMainService } from '@sap-ux/project-access';
-import { resolveTransportRequest } from '../utils/download-utils.js';
+import { FileName, DirName, getMainService } from '@sap-ux/project-access';
+import { resolveTransportRequest, fetchServiceMetadata } from '../utils/download-utils.js';
 import { AuthenticationType } from '@sap-ux/store';
-import { readManifest } from '../utils/file-helpers.js';
+import { readManifest, getTemplateTypeFromManifest } from '../utils/file-helpers.js';
 import { join } from 'node:path';
+/**
+ * Fetches OData metadata for the main service and writes it to local service folder in the webapp.
+ *
+ * @param {AbapServiceProvider} provider - The connected ABAP service provider.
+ * @param {string} webappPath - Absolute path to the webapp folder.
+ * @param {Editor} fs - The mem-fs editor.
+ */
+export async function writeServiceMetadata(provider, webappPath, fs) {
+    const manifest = readManifest(join(webappPath, FileName.Manifest), fs);
+    const serviceName = getMainService(manifest);
+    const serviceUri = serviceName ? manifest?.['sap.app']?.dataSources?.[serviceName]?.uri : undefined;
+    if (!serviceName || !serviceUri) {
+        RepoAppDownloadLogger.logger?.debug('No main service URI found in manifest; skipping metadata fetch.');
+        return;
+    }
+    const metadata = await fetchServiceMetadata(provider, serviceUri);
+    if (metadata) {
+        fs.write(join(webappPath, DirName.LocalService, serviceName, 'metadata.xml'), metadata);
+    }
+}
 /**
  * Builds the app configuration for the ABAP repository download flow by reading
  * the downloaded manifest. Returns a typed config object used for README generation, launch config, and deploy config.
@@ -28,6 +48,7 @@ export function getAbapRepoAppConfig(webappPath, appInfo, fs) {
         ? manifest?.['sap.app']?.dataSources?.[mainServiceName]?.settings?.odataVersion
         : undefined;
     const odataVersion = odataVersionStr === '4.0' ? OdataVersion.v4 : OdataVersion.v2;
+    const templateType = getTemplateTypeFromManifest(manifest);
     return {
         app: {
             id: appId,
@@ -40,6 +61,9 @@ export function getAbapRepoAppConfig(webappPath, appInfo, fs) {
         },
         ui5: {
             version: ui5Version
+        },
+        template: {
+            type: templateType
         }
     };
 }

package/generators/app/app-config-quick-deploy.js

@@ -8,24 +8,7 @@ import RepoAppDownloadLogger from '../utils/logger.js';
 import { FileName } from '@sap-ux/project-access';
 import { join } from 'node:path';
 import { getUI5Versions } from '@sap-ux/ui5-info';
-import { resolveTransportRequest } from '../utils/download-utils.js';
-/**
- * Fetches the metadata of a given service from the provided ABAP service provider.
- *
- * @param {AbapServiceProvider} provider - The ABAP service provider instance.
- * @param {string} serviceUrl - The URL of the service to retrieve metadata for.
- * @returns {Promise<string | undefined>} - A promise resolving to the service metadata.
- */
-const fetchServiceMetadata = async (provider, serviceUrl) => {
-    try {
-        const metadata = await provider.service(serviceUrl).metadata();
-        RepoAppDownloadLogger.logger?.debug('Metadata fetched successfully');
-        return metadata;
-    }
-    catch (err) {
-        RepoAppDownloadLogger.logger?.error(t('error.metadataFetchError', { error: err.message }));
-    }
-};
+import { resolveTransportRequest, fetchServiceMetadata } from '../utils/download-utils.js';
 /**
  * Gets the application configuration based on the provided user answers and manifest data.
  * This configuration will be used to initialize a new Fiori application.

package/generators/app/index.js

@@ -9,7 +9,7 @@ import { EventName } from '../telemetryEvents/index.js';
 import { getDefaultTargetFolder, generateAppGenInfo, sendTelemetry, TelemetryHelper, isCli, setYeomanEnvConflicterForce } from '@sap-ux/fiori-generator-shared';
 import { AppDownloadType, PromptNames } from './types.js';
 import { getPrompts } from '../prompts/prompts.js';
-import { generate, TemplateType } from '@sap-ux/fiori-elements-writer';
+import { generate } from '@sap-ux/fiori-elements-writer';
 import { join, basename } from 'node:path';
 import { platform } from 'node:os';
 import { runPostAppGenHook } from '../utils/event-hook.js';
@@ -21,7 +21,7 @@ import { writeApplicationInfoSettings } from '@sap-ux/fiori-tools-settings';
 import { generate as generateDeployConfig } from '@sap-ux/abap-deploy-config-writer';
 import { PromptState } from '../prompts/prompt-state.js';
 import { getAppConfig, getAdtDeployConfig } from './app-config-quick-deploy.js';
-import { getAbapRepoAppConfig, getAbapRepoDeployConfig } from './app-config-abap-repo.js';
+import { getAbapRepoAppConfig, getAbapRepoDeployConfig, writeServiceMetadata } from './app-config-abap-repo.js';
 import { makeValidJson, processDebugArtifacts, addPackageJsonIfNotFound } from '../utils/file-helpers.js';
 import { replaceWebappFiles, validateAndUpdateManifestUI5Version } from '../utils/updates.js';
 import { getYUIDetails } from '../prompts/prompt-helpers.js';
@@ -123,12 +123,15 @@ export default class extends Generator {
     async _generateAbapRepositoryApp() {
         const webappPath = join(this.projectPath, DirName.Webapp);
         await extractZip(webappPath, this.fs);
+        const serviceProvider = PromptState.systemSelection?.connectedSystem?.serviceProvider;
+        if (serviceProvider) {
+            await writeServiceMetadata(serviceProvider, webappPath, this.fs);
+        }
         processDebugArtifacts(webappPath, this.fs);
         const appConfig = getAbapRepoAppConfig(webappPath, this.answers.selectedApp, this.fs);
         // If package.json does not exist in the extracted app, add a minimal one with the appId as the package name.
-        addPackageJsonIfNotFound(this.projectPath, appConfig.app.id, this.fs);
+        addPackageJsonIfNotFound(this.projectPath, appConfig, this.fs);
         // Generate deploy config
-        const serviceProvider = PromptState.systemSelection?.connectedSystem?.serviceProvider;
         const context = {
             serviceProvider,
             appDownloadType: AppDownloadType.AbapRepository
@@ -198,7 +201,7 @@ export default class extends Generator {
             generatorName: generatorName,
             generatorVersion: this.rootGeneratorVersion(),
             ui5Version: config.ui5?.version ?? '',
-            template: TemplateType.ListReportObjectPage,
+            template: config.template.type,
             serviceUrl: config.service.url,
             launchText: t('readMe.launchText')
         };

package/generators/app/types.d.ts

@@ -2,9 +2,30 @@ import type Generator from 'yeoman-generator';
 import type { AppWizard } from '@sap-devx/yeoman-ui-types';
 import type { VSCodeInstance, TelemetryData, LogWrapper } from '@sap-ux/fiori-generator-shared';
 import type { AppIndex, AbapServiceProvider } from '@sap-ux/axios-extension';
-import type { OdataServiceAnswers } from '@sap-ux/odata-service-inquirer';
+import type { OdataServiceAnswers, OdataVersion } from '@sap-ux/odata-service-inquirer';
 import type { YUIQuestion } from '@sap-ux/inquirer-common';
 import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
+/**
+ * App configuration derived from the downloaded manifest for the ABAP repository flow.
+ * Used for README generation, launch config creation, and adding a minimal package.json.
+ */
+export interface AbapRepoAppConfig {
+    app: {
+        id: string;
+        title: string;
+        flpAppId: string;
+    };
+    service: {
+        url: string | undefined;
+        version: OdataVersion;
+    };
+    ui5: {
+        version: string;
+    };
+    template: {
+        type: string;
+    };
+}
 /**
  * Identifies which download flow is active.
  * ADTQuickDeploy: app was quick-deployed via ADT; uses qfa.json for config.

package/generators/utils/download-utils.d.ts

@@ -1,5 +1,13 @@
 import type { AbapServiceProvider } from '@sap-ux/axios-extension';
 import type { Editor } from 'mem-fs-editor';
+/**
+ * Fetches the metadata of a given service from the provided ABAP service provider.
+ *
+ * @param {AbapServiceProvider} provider - The ABAP service provider instance.
+ * @param {string} serviceUrl - The URL of the service to retrieve metadata for.
+ * @returns {Promise<string | undefined>} - A promise resolving to the service metadata XML string.
+ */
+export declare function fetchServiceMetadata(provider: AbapServiceProvider, serviceUrl: string): Promise<string | undefined>;
 /**
  * Checks whether the ZIP archive contains an entry named qfa.json
  * and verifies that a file named qfa.json exists  in the archive.

package/generators/utils/download-utils.js

@@ -5,6 +5,23 @@ import RepoAppDownloadLogger from '../utils/logger.js';
 import { qfaJsonFileName } from './constants.js';
 import { TransportChecksService } from '@sap-ux/axios-extension';
 import { restoreServiceProviderLoggers } from '@sap-ux/fiori-generator-shared';
+/**
+ * Fetches the metadata of a given service from the provided ABAP service provider.
+ *
+ * @param {AbapServiceProvider} provider - The ABAP service provider instance.
+ * @param {string} serviceUrl - The URL of the service to retrieve metadata for.
+ * @returns {Promise<string | undefined>} - A promise resolving to the service metadata XML string.
+ */
+export async function fetchServiceMetadata(provider, serviceUrl) {
+    try {
+        const metadata = await provider.service(serviceUrl).metadata();
+        RepoAppDownloadLogger.logger?.debug('Metadata fetched successfully');
+        return metadata;
+    }
+    catch (err) {
+        RepoAppDownloadLogger.logger?.error(t('error.metadataFetchError', { error: err.message }));
+    }
+}
 /**
  * Checks whether the ZIP archive contains an entry named qfa.json
  * and verifies that a file named qfa.json exists  in the archive.

package/generators/utils/file-helpers.d.ts

@@ -1,6 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
+import type { QfaJsonConfig, AbapRepoAppConfig } from '../app/types.js';
 import { type Manifest } from '@sap-ux/project-access';
-import type { QfaJsonConfig } from '../app/types.js';
 /**
  *
  * @param filePath - Path to the JSON file
@@ -27,10 +27,20 @@ export declare function readManifest(manifestFilePath: string, fs: Editor): Mani
 export declare function processDebugArtifacts(extractedProjectPath: string, fs: Editor): void;
 /**
  * Writes a minimal package.json to the project path if one does not already exist.
+ * Sets `sapux: true` for all apps except freestyle templates.
  *
  * @param {string} projectPath - The project root path.
- * @param {string} appId - The application ID used as the package name.
+ * @param {AbapRepoAppConfig} appConfig - The app configuration.
  * @param {Editor} fs - The file system editor.
  */
-export declare function addPackageJsonIfNotFound(projectPath: string, appId: string, fs: Editor): void;
+export declare function addPackageJsonIfNotFound(projectPath: string, appConfig: AbapRepoAppConfig, fs: Editor): void;
+/**
+ * Derives the template type string from a manifest's sourceTemplate id.
+ * Returns the suffix after `@sap/generator-fiori:` (e.g. `lrop`, `fpm`),
+ * or `'unknown'` if the id is absent or is not a fiori generated app.
+ *
+ * @param {Manifest} manifest - The parsed manifest object.
+ * @returns {string} The template type string.
+ */
+export declare function getTemplateTypeFromManifest(manifest: Manifest): string;
 //# sourceMappingURL=file-helpers.d.ts.map

package/generators/utils/file-helpers.js

@@ -2,6 +2,9 @@ import { t } from './i18n.js';
 import RepoAppDownloadLogger from './logger.js';
 import { PromptState } from '../prompts/prompt-state.js';
 import { join } from 'node:path';
+import { TemplateType as FioriElementsTemplateType } from '@sap-ux/fiori-elements-writer';
+import { TemplateType as FioriFreestyleTemplateType } from '@sap-ux/fiori-freestyle-writer';
+import { FileName } from '@sap-ux/project-access';
 /**
  *
  * @param filePath - Path to the JSON file
@@ -48,10 +51,12 @@ export function readManifest(manifestFilePath, fs) {
  * @param {Editor} fs - The file system editor.
  */
 export function processDebugArtifacts(extractedProjectPath, fs) {
+    const dbgSuffix = '-dbg.';
     PromptState.admZip?.getEntries().forEach((entry) => {
         const name = entry.entryName;
-        if (name.endsWith('-dbg.js')) {
-            const extractedDebugPath = join(extractedProjectPath, name.replace('-dbg.js', '.js'));
+        if (name.includes(dbgSuffix)) {
+            // copies contents of -dbg.js to .js file and removes the -dbg.js file
+            const extractedDebugPath = join(extractedProjectPath, name.replace(dbgSuffix, '.'));
             const debugPath = join(extractedProjectPath, name);
             fs.write(extractedDebugPath, entry.getData().toString('utf8'));
             fs.delete(debugPath);
@@ -68,15 +73,43 @@ export function processDebugArtifacts(extractedProjectPath, fs) {
 }
 /**
  * Writes a minimal package.json to the project path if one does not already exist.
+ * Sets `sapux: true` for all apps except freestyle templates.
  *
  * @param {string} projectPath - The project root path.
- * @param {string} appId - The application ID used as the package name.
+ * @param {AbapRepoAppConfig} appConfig - The app configuration.
  * @param {Editor} fs - The file system editor.
  */
-export function addPackageJsonIfNotFound(projectPath, appId, fs) {
-    const packageJsonPath = join(projectPath, 'package.json');
+export function addPackageJsonIfNotFound(projectPath, appConfig, fs) {
+    const packageJsonPath = join(projectPath, FileName.Package);
     if (!fs.exists(packageJsonPath)) {
-        fs.writeJSON(packageJsonPath, { name: appId });
+        const packageJson = { name: appConfig.app.id };
+        const freestyleTemplates = new Set(Object.values(FioriFreestyleTemplateType));
+        if (!freestyleTemplates.has(appConfig.template.type)) {
+            packageJson['sapux'] = true;
+        }
+        fs.writeJSON(packageJsonPath, packageJson);
+    }
+}
+/**
+ * Derives the template type string from a manifest's sourceTemplate id.
+ * Returns the suffix after `@sap/generator-fiori:` (e.g. `lrop`, `fpm`),
+ * or `'unknown'` if the id is absent or is not a fiori generated app.
+ *
+ * @param {Manifest} manifest - The parsed manifest object.
+ * @returns {string} The template type string.
+ */
+export function getTemplateTypeFromManifest(manifest) {
+    const sourceTemplateId = manifest?.['sap.app']?.sourceTemplate?.id ?? '';
+    const fioriGeneratorPrefix = '@sap/generator-fiori:';
+    // set of all known @sap/generator-fiori template suffixes for validating sourceTemplate.id in manifest.json.
+    const knownTemplates = new Set([
+        ...Object.values(FioriElementsTemplateType),
+        ...Object.values(FioriFreestyleTemplateType)
+    ]);
+    if (!sourceTemplateId.startsWith(fioriGeneratorPrefix)) {
+        return 'unknown';
     }
+    const suffix = sourceTemplateId.slice(fioriGeneratorPrefix.length);
+    return knownTemplates.has(suffix) ? suffix : 'unknown';
 }
 //# sourceMappingURL=file-helpers.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/repo-app-import-sub-generator",
   "description": "Generator to download LROP Fiori applications deployed from an ABAP repository.",
-  "version": "1.1.20",
+  "version": "1.1.22",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -21,26 +21,27 @@
   ],
   "dependencies": {
     "@sap-devx/yeoman-ui-types": "1.25.0",
-    "adm-zip": "0.5.16",
+    "adm-zip": "0.5.17",
     "i18next": "25.10.10",
     "inquirer": "8.2.7",
     "yeoman-generator": "5.10.0",
-    "@sap-ux/feature-toggle": "1.0.2",
-    "@sap-ux/fiori-generator-shared": "1.0.12",
-    "@sap-ux/inquirer-common": "1.0.13",
+    "@sap-ux/feature-toggle": "1.0.3",
+    "@sap-ux/fiori-generator-shared": "1.0.13",
+    "@sap-ux/odata-service-inquirer": "3.0.16",
+    "@sap-ux/inquirer-common": "1.0.14",
     "@sap-ux/project-access": "2.1.3",
-    "@sap-ux/odata-service-inquirer": "3.0.15",
-    "@sap-ux/fiori-elements-writer": "3.0.38",
+    "@sap-ux/fiori-elements-writer": "3.0.39",
     "@sap-ux/logger": "1.0.1",
-    "@sap-ux/project-input-validator": "1.0.7",
-    "@sap-ux/launch-config": "1.0.7",
+    "@sap-ux/fiori-freestyle-writer": "3.0.35",
+    "@sap-ux/launch-config": "1.0.8",
     "@sap-ux/fiori-tools-settings": "1.0.1",
-    "@sap-ux/abap-deploy-config-writer": "1.0.9",
-    "@sap-ux/btp-utils": "2.0.2",
-    "@sap-ux/ui5-info": "1.0.1",
-    "@sap-ux/axios-extension": "2.0.3",
-    "@sap-ux/store": "2.0.1",
-    "@sap-ux/system-access": "1.0.3",
+    "@sap-ux/abap-deploy-config-writer": "1.0.10",
+    "@sap-ux/btp-utils": "2.0.3",
+    "@sap-ux/project-input-validator": "1.0.7",
+    "@sap-ux/ui5-info": "1.0.2",
+    "@sap-ux/axios-extension": "2.0.4",
+    "@sap-ux/system-access": "1.0.4",
+    "@sap-ux/store": "2.0.2",
     "@sap-ux/guided-answers-helper": "1.0.1"
   },
   "devDependencies": {
@@ -55,7 +56,7 @@
     "@types/inquirer-autocomplete-prompt": "2.0.2",
     "@types/yeoman-test": "4.0.6",
     "@types/fs-extra": "11.0.4",
-    "fs-extra": "11.3.4",
+    "fs-extra": "11.3.5",
     "@vscode-logging/logger": "2.0.9",
     "@types/adm-zip": "0.5.8",
     "memfs": "3.4.13",
@@ -66,8 +67,8 @@
     "unionfs": "4.6.0",
     "yeoman-environment": "3.19.3",
     "yeoman-test": "6.3.0",
-    "@sap-ux/nodejs-utils": "1.0.3",
-    "@sap-ux/store": "2.0.1",
+    "@sap-ux/nodejs-utils": "1.0.4",
+    "@sap-ux/store": "2.0.2",
     "@sap-ux/ui5-config": "1.0.3"
   },
   "engines": {