@sap-ux/axios-extension 1.15.1 → 1.16.1

package/dist/abap/abap-service-provider.d.ts

@@ -4,7 +4,7 @@ import { Ui5AbapRepositoryService } from './ui5-abap-repository-service';
 import { AppIndexService } from './app-index-service';
 import { ODataVersion } from '../base/odata-service';
 import { LayeredRepositoryService } from './lrep-service';
-import type { AtoSettings, BusinessObject } from './types';
+import type { AbapCDSView, AtoSettings, BusinessObject } from './types';
 import { AdtService } from './adt-catalog/services';
 import { UiServiceGenerator } from './adt-catalog/generators/ui-service-generator';
 /**
@@ -98,12 +98,12 @@ export declare class AbapServiceProvider extends ServiceProvider {
      */
     getAdtService<T extends AdtService>(adtServiceSubclass: typeof AdtService): Promise<T | null>;
     /**
-     * Create a UI Service generator for the given business object.
+     * Create a UI Service generator for the given referenced object.
      *
-     * @param bo - business object
+     * @param referencedObject - referenced object (business object or abap cds view)
      * @returns a UI Service generator
      */
-    getUiServiceGenerator(bo: BusinessObject): Promise<UiServiceGenerator>;
+    getUiServiceGenerator(referencedObject: BusinessObject | AbapCDSView): Promise<UiServiceGenerator>;
     /**
      * Get the service URL from the generator config.
      *

package/dist/abap/abap-service-provider.js

@@ -195,19 +195,19 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
         return this.services[subclassName];
     }
     /**
-     * Create a UI Service generator for the given business object.
+     * Create a UI Service generator for the given referenced object.
      *
-     * @param bo - business object
+     * @param referencedObject - referenced object (business object or abap cds view)
      * @returns a UI Service generator
      */
-    async getUiServiceGenerator(bo) {
+    async getUiServiceGenerator(referencedObject) {
         const generatorService = await this.getAdtService(services_1.GeneratorService);
         if (!generatorService) {
-            throw new Error('Generators are not support on this system');
+            throw new Error('Generators are not supported on this system');
         }
-        const config = await generatorService.getUIServiceGeneratorConfig(bo.name);
+        const config = await generatorService.getUIServiceGeneratorConfig(referencedObject.uri);
         const gen = this.createService(this.getServiceUrlFromConfig(config), ui_service_generator_1.UiServiceGenerator);
-        gen.configure(config, bo);
+        gen.configure(config, referencedObject);
         return gen;
     }
     /**

package/dist/abap/adt-catalog/generators/ui-service-generator.d.ts

@@ -1,18 +1,18 @@
 import type { GeneratorEntry } from './types';
-import type { BusinessObject, ValidationResponse } from '../../types';
+import type { AbapCDSView, BusinessObject, ValidationResponse } from '../../types';
 import { AdtService } from '../services';
 /**
  *
  */
 export declare class UiServiceGenerator extends AdtService {
-    protected bo: BusinessObject;
+    protected referencedObject: BusinessObject | AbapCDSView;
     /**
      * Configure the UI service generator.
      *
      * @param _config - The generator configuration.
-     * @param bo - The business object.
+     * @param referencedObject - The referenced object (business object or abap cds view).
      */
-    configure(_config: GeneratorEntry, bo: BusinessObject): void;
+    configure(_config: GeneratorEntry, referencedObject: BusinessObject | AbapCDSView): void;
     /**
      * Get the schema of the service binding.
      *

package/dist/abap/adt-catalog/generators/ui-service-generator.js

@@ -6,15 +6,15 @@ const services_1 = require("../services");
  *
  */
 class UiServiceGenerator extends services_1.AdtService {
-    bo;
+    referencedObject;
     /**
      * Configure the UI service generator.
      *
      * @param _config - The generator configuration.
-     * @param bo - The business object.
+     * @param referencedObject - The referenced object (business object or abap cds view).
      */
-    configure(_config, bo) {
-        this.bo = bo;
+    configure(_config, referencedObject) {
+        this.referencedObject = referencedObject;
     }
     /**
      * Get the schema of the service binding.
@@ -27,7 +27,7 @@ class UiServiceGenerator extends services_1.AdtService {
                 Accept: 'application/vnd.sap.adt.repository.generator.schema.v1+json'
             },
             params: {
-                referencedObject: this.bo.uri
+                referencedObject: this.referencedObject.uri
             }
         });
         return JSON.parse(response.data);
@@ -44,7 +44,7 @@ class UiServiceGenerator extends services_1.AdtService {
                 Accept: 'application/vnd.sap.adt.repository.generator.content.v1+json'
             },
             params: {
-                referencedObject: this.bo.uri,
+                referencedObject: this.referencedObject.uri,
                 package: pckg
             }
         });
@@ -69,7 +69,7 @@ class UiServiceGenerator extends services_1.AdtService {
                 Accept: 'application/vnd.sap.adt.validationMessages.v1+xml'
             },
             params: {
-                referencedObject: this.bo.uri,
+                referencedObject: this.referencedObject.uri,
                 package: pckg,
                 checks: 'package'
             }
@@ -89,7 +89,7 @@ class UiServiceGenerator extends services_1.AdtService {
                 Accept: 'application/vnd.sap.adt.validationMessages.v1+xml'
             },
             params: {
-                referencedObject: this.bo.uri,
+                referencedObject: this.referencedObject.uri,
                 checks: 'package,referencedobject,authorization'
             }
         });
@@ -110,7 +110,7 @@ class UiServiceGenerator extends services_1.AdtService {
                 Accept: 'application/vnd.sap.adt.repository.generator.v1+json, application/vnd.sap.as+xml;charset=UTF-8;dataname=com.sap.adt.StatusMessage'
             },
             params: {
-                referencedObject: this.bo.uri,
+                referencedObject: this.referencedObject.uri,
                 corrNr: transport
             }
         });

package/dist/abap/adt-catalog/services/abapcdsview-service.d.ts

@@ -0,0 +1,32 @@
+import { AdtService } from './adt-service';
+import type { AbapCDSView, AdtCategory } from '../../types';
+/**
+ * AbapCDSViewService implements ADT requests to obtain the list of abap cds views.
+ */
+export declare class AbapCDSViewService extends AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    private static adtCategory;
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory(): AdtCategory;
+    /**
+     * Get all abap cds views from ADT service.
+     *
+     * @param maxResults - The maximum number of abap cds views to be returned.
+     * @returns A list of abap cds views.
+     */
+    getAbapCDSViews(maxResults?: number): Promise<AbapCDSView[]>;
+    /**
+     * Parse the XML document of abap cds view entries from ADT service.
+     *
+     * @param xml xml document containing abap cds view entries.
+     * @returns A list of abap cds view names.
+     */
+    private parseAbapCDSViewResponse;
+}
+//# sourceMappingURL=abapcdsview-service.d.ts.map

package/dist/abap/adt-catalog/services/abapcdsview-service.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbapCDSViewService = void 0;
+const adt_service_1 = require("./adt-service");
+/**
+ * AbapCDSViewService implements ADT requests to obtain the list of abap cds views.
+ */
+class AbapCDSViewService extends adt_service_1.AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    static adtCategory = {
+        scheme: 'http://www.sap.com/adt/categories/respository',
+        term: 'search'
+    };
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory() {
+        return AbapCDSViewService.adtCategory;
+    }
+    /**
+     * Get all abap cds views from ADT service.
+     *
+     * @param maxResults - The maximum number of abap cds views to be returned.
+     * @returns A list of abap cds views.
+     */
+    async getAbapCDSViews(maxResults = 10000) {
+        const config = {
+            headers: {
+                Accept: 'application/xml'
+            },
+            params: {
+                operation: 'quickSearch',
+                query: `*`,
+                maxResults: maxResults,
+                objectType: 'DDLS',
+                releaseState: 'USE_IN_CLOUD_DEVELOPMENT'
+            }
+        };
+        const response = await this.get('', config);
+        return this.parseAbapCDSViewResponse(response.data);
+    }
+    /**
+     * Parse the XML document of abap cds view entries from ADT service.
+     *
+     * @param xml xml document containing abap cds view entries.
+     * @returns A list of abap cds view names.
+     */
+    parseAbapCDSViewResponse(xml) {
+        const parsed = this.parseResponse(xml);
+        let abapCDSViewArray = [];
+        if (parsed?.objectReferences?.objectReference) {
+            if (Array.isArray(parsed.objectReferences.objectReference)) {
+                abapCDSViewArray = parsed.objectReferences.objectReference;
+            }
+            else {
+                abapCDSViewArray = [parsed.objectReferences.objectReference];
+            }
+        }
+        return abapCDSViewArray.map((item) => {
+            const { name, uri, description } = item;
+            return { name, uri, description };
+        });
+    }
+}
+exports.AbapCDSViewService = AbapCDSViewService;
+//# sourceMappingURL=abapcdsview-service.js.map

package/dist/abap/adt-catalog/services/generator-service.d.ts

@@ -17,11 +17,11 @@ export declare class GeneratorService extends AdtService {
     static getAdtCatagory(): AdtCategory;
     private id;
     /**
-     * Get the UI service generator for the given business object.
+     * Get the UI service generator for the given referenced object.
      *
-     * @param businessObjectName - The business object name.
+     * @param objectUri - The object (business object or abap cds view) uri.
      * @returns TBD
      */
-    getUIServiceGeneratorConfig(businessObjectName: string): Promise<GeneratorEntry>;
+    getUIServiceGeneratorConfig(objectUri: string): Promise<GeneratorEntry>;
 }
 //# sourceMappingURL=generator-service.d.ts.map

package/dist/abap/adt-catalog/services/generator-service.js

@@ -23,18 +23,18 @@ class GeneratorService extends adt_service_1.AdtService {
     }
     id;
     /**
-     * Get the UI service generator for the given business object.
+     * Get the UI service generator for the given referenced object.
      *
-     * @param businessObjectName - The business object name.
+     * @param objectUri - The object (business object or abap cds view) uri.
      * @returns TBD
      */
-    async getUIServiceGeneratorConfig(businessObjectName) {
+    async getUIServiceGeneratorConfig(objectUri) {
         const response = await this.get('', {
             headers: {
                 Accept: 'application/atom+xml;type=feed'
             },
             params: {
-                referencedObject: `/sap/bc/adt/bo/behaviordefinitions/${businessObjectName.toLocaleLowerCase()}`,
+                referencedObject: objectUri,
                 type: 'webapi'
             }
         });

package/dist/abap/adt-catalog/services/index.d.ts

@@ -6,4 +6,6 @@ export { ListPackageService } from './list-package-service';
 export { FileStoreService } from './filestore-service';
 export { GeneratorService } from './generator-service';
 export { BusinessObjectsService } from './businessobjects-service';
+export { UI5RtVersionService } from './ui5-rt-version-service';
+export { AbapCDSViewService } from './abapcdsview-service';
 //# sourceMappingURL=index.d.ts.map

package/dist/abap/adt-catalog/services/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BusinessObjectsService = exports.GeneratorService = exports.FileStoreService = exports.ListPackageService = exports.TransportRequestService = exports.TransportChecksService = exports.AtoService = exports.AdtService = void 0;
+exports.AbapCDSViewService = exports.UI5RtVersionService = exports.BusinessObjectsService = exports.GeneratorService = exports.FileStoreService = exports.ListPackageService = exports.TransportRequestService = exports.TransportChecksService = exports.AtoService = exports.AdtService = void 0;
 var adt_service_1 = require("./adt-service");
 Object.defineProperty(exports, "AdtService", { enumerable: true, get: function () { return adt_service_1.AdtService; } });
 var ato_service_1 = require("./ato-service");
@@ -17,4 +17,8 @@ var generator_service_1 = require("./generator-service");
 Object.defineProperty(exports, "GeneratorService", { enumerable: true, get: function () { return generator_service_1.GeneratorService; } });
 var businessobjects_service_1 = require("./businessobjects-service");
 Object.defineProperty(exports, "BusinessObjectsService", { enumerable: true, get: function () { return businessobjects_service_1.BusinessObjectsService; } });
+var ui5_rt_version_service_1 = require("./ui5-rt-version-service");
+Object.defineProperty(exports, "UI5RtVersionService", { enumerable: true, get: function () { return ui5_rt_version_service_1.UI5RtVersionService; } });
+var abapcdsview_service_1 = require("./abapcdsview-service");
+Object.defineProperty(exports, "AbapCDSViewService", { enumerable: true, get: function () { return abapcdsview_service_1.AbapCDSViewService; } });
 //# sourceMappingURL=index.js.map

package/dist/abap/adt-catalog/services/ui5-rt-version-service.d.ts

@@ -0,0 +1,25 @@
+import type { AdtCategory } from '../../types';
+import { AdtService } from './adt-service';
+/**
+ * UI5RtVersionService implements ADT requests to get UI5 Version
+ * of ABAP system.
+ */
+export declare class UI5RtVersionService extends AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    private static adtCategory;
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory(): AdtCategory;
+    /**
+     * Get UI5 Version of ABAP system.
+     *
+     * @returns UI5 Version on the connected ABAP System.
+     */
+    getUI5Version(): Promise<string>;
+}
+//# sourceMappingURL=ui5-rt-version-service.d.ts.map

package/dist/abap/adt-catalog/services/ui5-rt-version-service.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UI5RtVersionService = void 0;
+const adt_service_1 = require("./adt-service");
+/**
+ * UI5RtVersionService implements ADT requests to get UI5 Version
+ * of ABAP system.
+ */
+class UI5RtVersionService extends adt_service_1.AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    static adtCategory = {
+        scheme: 'http://www.sap.com/adt/categories/filestore',
+        term: 'ui5-rt-version'
+    };
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory() {
+        return UI5RtVersionService.adtCategory;
+    }
+    /**
+     * Get UI5 Version of ABAP system.
+     *
+     * @returns UI5 Version on the connected ABAP System.
+     */
+    async getUI5Version() {
+        try {
+            const result = await this.get('');
+            return result.data;
+        }
+        catch (error) {
+            this.log.error('Could not fetch UI5 Version.');
+            this.log.debug(error);
+            throw error;
+        }
+    }
+}
+exports.UI5RtVersionService = UI5RtVersionService;
+//# sourceMappingURL=ui5-rt-version-service.js.map

package/dist/abap/app-index-service.d.ts

@@ -42,6 +42,13 @@ export declare abstract class AppIndexService extends Axios implements Service {
     search(searchParams?: {
         [property: string]: string;
     }, resultFields?: string[]): Promise<AppIndex>;
+    /**
+     * Check for a given app id whether the manifest first is supported.
+     *
+     * @param {string} appId - The id of the app.
+     * @returns {Promise<boolean>} - "true" for apps supporting manifest first which are apps with minUI5Version at least 1.30 and not scaffolding-based (i.e. dependency to sap.ca.scfld.md library), otherwise it returns "false".
+     */
+    getIsManiFirstSupported(appId: string): Promise<boolean>;
     /**
      * Gets the app info for the specified id.
      *

package/dist/abap/app-index-service.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppIndexService = void 0;
 const axios_1 = require("axios");
-const odata_request_error_1 = require("../base/odata-request-error");
 /**
  * A class representing the app index service allowing to search applications deployed on an ABAP system.
  */
@@ -24,6 +23,27 @@ class AppIndexService extends axios_1.Axios {
         const response = await this.get('/', { params });
         return JSON.parse(response.data).results;
     }
+    /**
+     * Check for a given app id whether the manifest first is supported.
+     *
+     * @param {string} appId - The id of the app.
+     * @returns {Promise<boolean>} - "true" for apps supporting manifest first which are apps with minUI5Version at least 1.30 and not scaffolding-based (i.e. dependency to sap.ca.scfld.md library), otherwise it returns "false".
+     */
+    async getIsManiFirstSupported(appId) {
+        try {
+            const params = {
+                'id': appId
+            };
+            const response = await this.get('/ui5_app_mani_first_supported', { params });
+            const isManiFirstSupported = JSON.parse(response.data);
+            return isManiFirstSupported;
+        }
+        catch (error) {
+            this.log.error(`Fail fetching ui5_app_mani_first_supported for app with id: ${appId}.`);
+            this.log.debug(error);
+            throw error;
+        }
+    }
     /**
      * Gets the app info for the specified id.
      *
@@ -36,7 +56,7 @@ class AppIndexService extends axios_1.Axios {
             return JSON.parse(response.data);
         }
         catch (error) {
-            if ((0, odata_request_error_1.isAxiosError)(error)) {
+            if ((0, axios_1.isAxiosError)(error)) {
                 this.log.error(`Failed fetching ui5_app_info_json for app with id ${appId}.`);
             }
             else {

package/dist/abap/index.d.ts

@@ -1,5 +1,5 @@
 export { AppInfo, BspConfig, DeployConfig, Ui5AbapRepositoryService, UndeployConfig } from './ui5-abap-repository-service';
-export { LayeredRepositoryService, AdaptationConfig, MergedAppDescriptor } from './lrep-service';
+export { LayeredRepositoryService, AdaptationConfig, MergedAppDescriptor, SystemInfo, AdaptationProjectType } from './lrep-service';
 export { AbapServiceProvider } from './abap-service-provider';
 export { AppIndex, AppIndexService, Ui5AppInfo } from './app-index-service';
 export * from './message';

package/dist/abap/index.js

@@ -14,11 +14,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TenantType = exports.AppIndexService = exports.AbapServiceProvider = exports.LayeredRepositoryService = exports.Ui5AbapRepositoryService = void 0;
+exports.TenantType = exports.AppIndexService = exports.AbapServiceProvider = exports.AdaptationProjectType = exports.LayeredRepositoryService = exports.Ui5AbapRepositoryService = void 0;
 var ui5_abap_repository_service_1 = require("./ui5-abap-repository-service");
 Object.defineProperty(exports, "Ui5AbapRepositoryService", { enumerable: true, get: function () { return ui5_abap_repository_service_1.Ui5AbapRepositoryService; } });
 var lrep_service_1 = require("./lrep-service");
 Object.defineProperty(exports, "LayeredRepositoryService", { enumerable: true, get: function () { return lrep_service_1.LayeredRepositoryService; } });
+Object.defineProperty(exports, "AdaptationProjectType", { enumerable: true, get: function () { return lrep_service_1.AdaptationProjectType; } });
 var abap_service_provider_1 = require("./abap-service-provider");
 Object.defineProperty(exports, "AbapServiceProvider", { enumerable: true, get: function () { return abap_service_provider_1.AbapServiceProvider; } });
 var app_index_service_1 = require("./app-index-service");

package/dist/abap/lrep-service.d.ts

@@ -67,6 +67,28 @@ export interface Message {
     id: string;
     variables?: string[];
 }
+/**
+ * All available adaptation project types from system.
+ */
+export declare enum AdaptationProjectType {
+    ON_PREMISE = "onPremise",
+    CLOUD_READY = "cloudReady"
+}
+/**
+ * Structure of the system info reponse data.
+ */
+export interface SystemInfo {
+    /**
+     * Supported adaptation project types from system.
+     */
+    adaptationProjectTypes: AdaptationProjectType[];
+    activeLanguages: Language[];
+}
+interface Language {
+    sap: string;
+    description: string;
+    i18n: string;
+}
 /**
  * Technically supported layers, however, in practice only `CUSTOMER_BASE` is used
  */
@@ -115,6 +137,14 @@ export declare class LayeredRepositoryService extends Axios implements Service {
      * @returns the Axios response object for further processing
      */
     undeploy(config: AdaptationConfig): Promise<AxiosResponse>;
+    /**
+     * Get system info.
+     *
+     * @param language
+     * @param cloudPackage name
+     * @returns the system info object
+     */
+    getSystemInfo(language?: string, cloudPackage?: string): Promise<SystemInfo>;
     /**
      * Try parsing the response and log the result. If the parsing fails and an alternative is provided, log it instead.
      *

package/dist/abap/lrep-service.js

@@ -1,11 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LayeredRepositoryService = void 0;
+exports.LayeredRepositoryService = exports.AdaptationProjectType = void 0;
 const axios_1 = require("axios");
 const logger_1 = require("@sap-ux/logger");
 const fs_1 = require("fs");
 const odata_request_error_1 = require("../base/odata-request-error");
 const message_1 = require("./message");
+/**
+ * All available adaptation project types from system.
+ */
+var AdaptationProjectType;
+(function (AdaptationProjectType) {
+    AdaptationProjectType["ON_PREMISE"] = "onPremise";
+    AdaptationProjectType["CLOUD_READY"] = "cloudReady";
+})(AdaptationProjectType || (exports.AdaptationProjectType = AdaptationProjectType = {}));
 /**
  * Returns the namespace as string.
  *
@@ -169,6 +177,31 @@ class LayeredRepositoryService extends axios_1.Axios {
             throw error;
         }
     }
+    /**
+     * Get system info.
+     *
+     * @param language
+     * @param cloudPackage name
+     * @returns the system info object
+     */
+    async getSystemInfo(language = 'EN', cloudPackage) {
+        try {
+            const params = {
+                'sap-language': language
+            };
+            if (cloudPackage) {
+                params['package'] = cloudPackage;
+            }
+            const response = await this.get(`${DTA_PATH_SUFFIX}system_info`, { params });
+            this.tryLogResponse(response, 'Successful getting system info.');
+            return JSON.parse(response.data);
+        }
+        catch (error) {
+            this.log.error('Getting system data failed.');
+            this.log.debug(error);
+            throw error;
+        }
+    }
     /**
      * Try parsing the response and log the result. If the parsing fails and an alternative is provided, log it instead.
      *

package/dist/abap/types/adt-types.d.ts

@@ -119,6 +119,11 @@ export type BusinessObject = {
     uri: string;
     description?: string;
 };
+export type AbapCDSView = {
+    name: string;
+    uri: string;
+    description?: string;
+};
 export type PublishResponse = {
     SEVERITY: string;
     SHORT_TEXT: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/axios-extension",
-  "version": "1.15.1",
+  "version": "1.16.1",
   "description": "Extension of the Axios module adding convenience methods to interact with SAP systems especially with OData services.",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
     "@types/lodash": "4.14.202",
     "nock": "13.4.0",
     "supertest": "6.3.3",
-    "@sap-ux/project-access": "1.23.0"
+    "@sap-ux/project-access": "1.25.7"
   },
   "files": [
     "dist",