@sap-ux/axios-extension 1.21.4 → 1.22.1

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

@@ -6,6 +6,7 @@ import { ODataVersion } from '../base/odata-service';
 import { LayeredRepositoryService } from './lrep-service';
 import type { AbapCDSView, AtoSettings, BusinessObject } from './types';
 import { AdtService } from './adt-catalog/services';
+import { ODataServiceGenerator } from './adt-catalog/generators/odata-service-generator';
 import { UiServiceGenerator } from './adt-catalog/generators/ui-service-generator';
 /**
  * Extension of the service provider for ABAP services.
@@ -104,6 +105,13 @@ export declare class AbapServiceProvider extends ServiceProvider {
      * @returns a UI Service generator
      */
     getUiServiceGenerator(referencedObject: BusinessObject | AbapCDSView): Promise<UiServiceGenerator>;
+    /**
+     * Gets an OData Service generator.
+     *
+     * @param packageName - Name of package to be used for generated artifacts in ABAP system
+     * @returns An OData Service generator
+     */
+    getODataServiceGenerator(packageName: string): Promise<ODataServiceGenerator>;
     /**
      * Get the service URL from the generator config.
      *
@@ -112,8 +120,6 @@ export declare class AbapServiceProvider extends ServiceProvider {
      */
     private getServiceUrlFromConfig;
     /**
-     * Get the content type from the generator config.
-     *
      * @param config - generator config
      * @returns the type of the content link from service generator config
      */

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

@@ -12,6 +12,7 @@ const types_1 = require("./types");
 // Can't use an `import type` here. We need the classname at runtime to create object instances:
 // eslint-disable-next-line @typescript-eslint/consistent-type-imports
 const services_1 = require("./adt-catalog/services");
+const odata_service_generator_1 = require("./adt-catalog/generators/odata-service-generator");
 const ui_service_generator_1 = require("./adt-catalog/generators/ui-service-generator");
 /**
  * Extension of the service provider for ABAP services.
@@ -207,6 +208,23 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
         gen.configure(config, referencedObject, this.getContentType(config));
         return gen;
     }
+    /**
+     * Gets an OData Service generator.
+     *
+     * @param packageName - Name of package to be used for generated artifacts in ABAP system
+     * @returns An OData Service generator
+     */
+    async getODataServiceGenerator(packageName) {
+        const generatorService = await this.getAdtService(services_1.RapGeneratorService);
+        if (!generatorService) {
+            throw new Error('RAP Generator are not support on this system');
+        }
+        const config = await generatorService.getRAPGeneratorConfig();
+        const generator = this.createService(this.getServiceUrlFromConfig(config), odata_service_generator_1.ODataServiceGenerator);
+        generator.setContentType(this.getContentType(config));
+        generator.configure(config, packageName || '$TMP');
+        return generator;
+    }
     /**
      * Get the service URL from the generator config.
      *
@@ -222,8 +240,6 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
         return config.link[0].href.substring(0, endIndex);
     }
     /**
-     * Get the content type from the generator config.
-     *
      * @param config - generator config
      * @returns the type of the content link from service generator config
      */

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

@@ -1,2 +1,3 @@
 export { UiServiceGenerator } from './ui-service-generator';
+export { ODataServiceGenerator } from './odata-service-generator';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UiServiceGenerator = void 0;
+exports.ODataServiceGenerator = exports.UiServiceGenerator = void 0;
 var ui_service_generator_1 = require("./ui-service-generator");
 Object.defineProperty(exports, "UiServiceGenerator", { enumerable: true, get: function () { return ui_service_generator_1.UiServiceGenerator; } });
+var odata_service_generator_1 = require("./odata-service-generator");
+Object.defineProperty(exports, "ODataServiceGenerator", { enumerable: true, get: function () { return odata_service_generator_1.ODataServiceGenerator; } });
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,65 @@
+import type { GeneratorEntry } from './types';
+import type { ODataServiceTechnicalDetails, ValidationMessage } from '../../types';
+import { AdtService } from '../services';
+/**
+ * Extension of the Generator service to generate OData services
+ */
+export declare class ODataServiceGenerator extends AdtService {
+    /**
+     * package to be used for generated objects
+     */
+    protected packageName: string;
+    protected contentType: string;
+    /**
+     * Configure the UI service generator.
+     *
+     * @param _config - The generator configuration.
+     * @param packageName - package to be used for generated objects
+     */
+    configure(_config: GeneratorEntry, packageName: string): void;
+    /**
+     * Set the content type to be used for post requests of genertor.
+     *
+     * @param contentType - content type to be used for generated objects
+     */
+    setContentType(contentType: string): void;
+    /**
+     * Validates input for OData Service generation.
+     *
+     * @param input - JSON string
+     * @returns messages
+     */
+    validate(input: string): Promise<ValidationMessage[]>;
+    /**
+     * Gets technical details of (to be generated) OData service.
+     * - this is a workaround for the missing service definition name in the generator response
+     * - actual name might be different e.g. because of name collisions at the time when the actual generation is called.
+     *
+     * @param input - JSON string
+     * @returns technical name of service definition
+     */
+    getTechnicalDetails(input: string): Promise<ODataServiceTechnicalDetails>;
+    /**
+     * Generates OData Service.
+     *
+     * @param input - JSON string
+     * @returns HTTP status code as number
+     * @throws Error if the generation fails
+     */
+    generate(input: string): Promise<number>;
+    /**
+     * Parse an xml document for validation messages.
+     *
+     * @param xml response for "validation" request
+     * @returns messages
+     */
+    private parseValidateResponse;
+    /**
+     * Parse an XML document to find the technical name of the service definition.
+     *
+     * @param xml response for "preview" request
+     * @returns technical details of service definition
+     */
+    private parsePreviewResponse;
+}
+//# sourceMappingURL=odata-service-generator.d.ts.map

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

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ODataServiceGenerator = void 0;
+const services_1 = require("../services");
+/**
+ * Extension of the Generator service to generate OData services
+ */
+class ODataServiceGenerator extends services_1.AdtService {
+    /**
+     * package to be used for generated objects
+     */
+    packageName;
+    contentType;
+    /**
+     * Configure the UI service generator.
+     *
+     * @param _config - The generator configuration.
+     * @param packageName - package to be used for generated objects
+     */
+    configure(_config, packageName) {
+        this.packageName = packageName;
+    }
+    /**
+     * Set the content type to be used for post requests of genertor.
+     *
+     * @param contentType - content type to be used for generated objects
+     */
+    setContentType(contentType) {
+        this.contentType = contentType;
+    }
+    /**
+     * Validates input for OData Service generation.
+     *
+     * @param input - JSON string
+     * @returns messages
+     */
+    async validate(input) {
+        const response = await this.post(`/validation`, input, {
+            headers: {
+                'Content-Type': this.contentType,
+                Accept: 'application/vnd.sap.adt.validationMessages.v1+xml, application/vnd.sap.as+xml;charset=UTF-8;dataname=com.sap.adt.StatusMessage'
+            },
+            params: {
+                package: this.packageName
+            }
+        });
+        return this.parseValidateResponse(response.data);
+    }
+    /**
+     * Gets technical details of (to be generated) OData service.
+     * - this is a workaround for the missing service definition name in the generator response
+     * - actual name might be different e.g. because of name collisions at the time when the actual generation is called.
+     *
+     * @param input - JSON string
+     * @returns technical name of service definition
+     */
+    async getTechnicalDetails(input) {
+        const response = await this.post(`/preview`, input, {
+            headers: {
+                'Content-Type': this.contentType,
+                Accept: 'application/vnd.sap.adt.repository.objects.massoperation.v1+xml'
+            },
+            params: {
+                package: this.packageName
+            }
+        });
+        return this.parsePreviewResponse(response.data);
+    }
+    /**
+     * Generates OData Service.
+     *
+     * @param input - JSON string
+     * @returns HTTP status code as number
+     * @throws Error if the generation fails
+     */
+    async generate(input) {
+        const response = await this.post(``, input, {
+            headers: {
+                'Content-Type': this.contentType,
+                'Accept': 'application/vnd.sap.adt.repository.generator.v1+json'
+            },
+            params: {
+                package: this.packageName
+            }
+        });
+        // return http status code as number
+        return response.status;
+    }
+    /**
+     * Parse an xml document for validation messages.
+     *
+     * @param xml response for "validation" request
+     * @returns messages
+     */
+    parseValidateResponse(xml) {
+        const parsed = this.parseResponse(xml);
+        let validationMessages = parsed.validationMessages;
+        if (!Array.isArray(validationMessages)) {
+            validationMessages = [validationMessages];
+        }
+        return validationMessages.map((entry) => entry.validationMessage || {}) || [];
+    }
+    /**
+     * Parse an XML document to find the technical name of the service definition.
+     *
+     * @param xml response for "preview" request
+     * @returns technical details of service definition
+     */
+    parsePreviewResponse(xml) {
+        const parsed = this.parseResponse(xml);
+        const serviceLayerGroup = (parsed.group.group || []).find((entry) => entry.name === 'Business Service Layer');
+        if (!serviceLayerGroup) {
+            return;
+        }
+        const objects = !Array.isArray(serviceLayerGroup.object)
+            ? [serviceLayerGroup.object]
+            : serviceLayerGroup.object;
+        const serviceObject = objects.find((entry) => entry.objectReference?.type === 'SRVD/SRV');
+        const serviceBindingObject = objects.find((entry) => entry.objectReference?.type === 'SRVB/SVB');
+        if (!serviceObject || !serviceBindingObject) {
+            return;
+        }
+        return {
+            serviceName: serviceBindingObject.objectReference?.name || '',
+            serviceDefinitionName: serviceObject.objectReference?.name || '',
+            serviceVersion: '0001'
+        };
+    }
+}
+exports.ODataServiceGenerator = ODataServiceGenerator;
+//# sourceMappingURL=odata-service-generator.js.map

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

@@ -5,7 +5,9 @@ export { TransportRequestService, NewUi5ObjectRequestParams } from './transportr
 export { ListPackageService } from './list-package-service';
 export { FileStoreService } from './filestore-service';
 export { GeneratorService } from './generator-service';
+export { RapGeneratorService } from './rap-generator-service';
 export { BusinessObjectsService } from './businessobjects-service';
 export { UI5RtVersionService } from './ui5-rt-version-service';
 export { AbapCDSViewService } from './abapcdsview-service';
+export { PublishService } from './publish-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.AbapCDSViewService = exports.UI5RtVersionService = exports.BusinessObjectsService = exports.GeneratorService = exports.FileStoreService = exports.ListPackageService = exports.TransportRequestService = exports.TransportChecksService = exports.AtoService = exports.AdtService = void 0;
+exports.PublishService = exports.AbapCDSViewService = exports.UI5RtVersionService = exports.BusinessObjectsService = exports.RapGeneratorService = 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");
@@ -15,10 +15,14 @@ var filestore_service_1 = require("./filestore-service");
 Object.defineProperty(exports, "FileStoreService", { enumerable: true, get: function () { return filestore_service_1.FileStoreService; } });
 var generator_service_1 = require("./generator-service");
 Object.defineProperty(exports, "GeneratorService", { enumerable: true, get: function () { return generator_service_1.GeneratorService; } });
+var rap_generator_service_1 = require("./rap-generator-service");
+Object.defineProperty(exports, "RapGeneratorService", { enumerable: true, get: function () { return rap_generator_service_1.RapGeneratorService; } });
 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; } });
+var publish_service_1 = require("./publish-service");
+Object.defineProperty(exports, "PublishService", { enumerable: true, get: function () { return publish_service_1.PublishService; } });
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,25 @@
+import { AdtService } from './adt-service';
+import type { AdtCategory, ODataServiceTechnicalDetails } from '../../types';
+/**
+ *
+ */
+export declare class PublishService extends AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    private static readonly adtCategory;
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory(): AdtCategory;
+    /**
+     * Get OData V4 service URI for the given business object.
+     *
+     * @param technicalDetails - technical name of OData service
+     * @returns service URI.
+     */
+    getODataV4ServiceUri(technicalDetails: ODataServiceTechnicalDetails): Promise<string>;
+}
+//# sourceMappingURL=publish-service.d.ts.map

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

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublishService = void 0;
+const adt_service_1 = require("./adt-service");
+/**
+ *
+ */
+class PublishService extends adt_service_1.AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    static adtCategory = {
+        scheme: 'http://www.sap.com/categories/servicebindings/bindingtypes',
+        term: 'ODataV4'
+    };
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory() {
+        return PublishService.adtCategory;
+    }
+    /**
+     * Get OData V4 service URI for the given business object.
+     *
+     * @param technicalDetails - technical name of OData service
+     * @returns service URI.
+     */
+    async getODataV4ServiceUri(technicalDetails) {
+        const { serviceDefinitionName, serviceName, serviceVersion } = technicalDetails;
+        const response = await this.get(`/${serviceName}`, {
+            headers: {
+                Accept: 'application/vnd.sap.adt.businessservices.odatav4.v2+xml'
+            },
+            params: {
+                servicename: serviceName,
+                serviceversion: serviceVersion,
+                srvdname: serviceDefinitionName
+            }
+        });
+        const data = this.parseResponse(response.data);
+        return String(data.serviceGroup.services.serviceUrl);
+    }
+}
+exports.PublishService = PublishService;
+//# sourceMappingURL=publish-service.js.map

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

@@ -0,0 +1,27 @@
+import { AdtService } from './adt-service';
+import type { AdtCategory } from '../../types';
+import type { GeneratorEntry } from '../generators/types';
+/**
+ * RapGeneratorService implements ADT requests for generating an OData Service
+ * from ABAP backend system.
+ */
+export declare class RapGeneratorService extends AdtService {
+    /**
+     * @see AdtService.getAdtCategory()
+     */
+    private static readonly adtCategory;
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory(): AdtCategory;
+    private readonly id;
+    /**
+     * Get the RAP Generator (published-x-ui-service).
+     *
+     * @returns Promise<GeneratorEntry>
+     */
+    getRAPGeneratorConfig(): Promise<GeneratorEntry>;
+}
+//# sourceMappingURL=rap-generator-service.d.ts.map

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RapGeneratorService = void 0;
+const adt_service_1 = require("./adt-service");
+/**
+ * RapGeneratorService implements ADT requests for generating an OData Service
+ * from ABAP backend system.
+ */
+class RapGeneratorService extends adt_service_1.AdtService {
+    /**
+     * @see AdtService.getAdtCategory()
+     */
+    static adtCategory = {
+        scheme: 'http://www.sap.com/adt/categories/respository',
+        term: 'generators'
+    };
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory() {
+        return RapGeneratorService.adtCategory;
+    }
+    id;
+    /**
+     * Get the RAP Generator (published-x-ui-service).
+     *
+     * @returns Promise<GeneratorEntry>
+     */
+    async getRAPGeneratorConfig() {
+        const response = await this.get('', {
+            headers: {
+                Accept: 'application/atom+xml;type=feed'
+            },
+            params: {
+                type: 'webapi',
+                fetchAllGenerators: true
+            }
+        });
+        let generators = (this.parseResponse(response.data).feed?.entry ?? []);
+        if (generators && !Array.isArray(generators)) {
+            generators = [generators];
+        }
+        const data = generators.find((generator) => generator.id === 'published-x-ui-service');
+        if (data) {
+            return data;
+        }
+        else {
+            throw new Error('OData Service Generator not found');
+        }
+    }
+}
+exports.RapGeneratorService = RapGeneratorService;
+//# sourceMappingURL=rap-generator-service.js.map

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

@@ -129,6 +129,15 @@ export type PublishResponse = {
     SHORT_TEXT: string;
     LONG_TEXT: string;
 };
+export type ValidationMessage = {
+    severity?: string;
+    text?: string;
+};
+export type ODataServiceTechnicalDetails = {
+    serviceName: string;
+    serviceVersion: string;
+    serviceDefinitionName: string;
+};
 export type ValidationResponse = {
     severity: string;
     short_text: string;

package/dist/factory.d.ts

@@ -1,5 +1,5 @@
 import type { AxiosRequestConfig } from 'axios';
-import type { Destination } from '@sap-ux/btp-utils';
+import { type Destination } from '@sap-ux/btp-utils';
 import type { ServiceInfo, RefreshTokenChanged } from './auth';
 import type { ProviderConfiguration } from './base/service-provider';
 import { ServiceProvider } from './base/service-provider';

package/dist/factory.js

@@ -20,7 +20,6 @@ const patchTls_1 = require("./base/patchTls");
 const proxy_from_env_1 = require("proxy-from-env");
 const https_proxy_agent_1 = require("https-proxy-agent");
 const http_proxy_agent_1 = require("http-proxy-agent");
-const feature_toggle_1 = require("@sap-ux/feature-toggle");
 /**
  * PatchedHttpsProxyAgent is a custom implementation of HttpsProxyAgent that allows to pass additional options, currently not supported by the original implementation when calling tls.connect
  */
@@ -62,8 +61,7 @@ function createInstance(ProviderType, config) {
         rejectUnauthorized: !providerConfig.ignoreCertErrors
     };
     const localProxy = (0, proxy_from_env_1.getProxyForUrl)(config.baseURL);
-    const isPatchProxyEnabled = (0, feature_toggle_1.isFeatureEnabled)('sap.ux.enablePatchProxy');
-    if (isPatchProxyEnabled && localProxy) {
+    if (localProxy && !(0, btp_utils_1.isAppStudio)()) {
         // axios doesn't handle proxies correctly, instead use a custom agent with axios proxy disabled
         providerConfig.httpsAgent = new PatchedHttpsProxyAgent(localProxy, agentOptions);
         providerConfig.httpAgent = new http_proxy_agent_1.HttpProxyAgent(localProxy);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/axios-extension",
-  "version": "1.21.4",
+  "version": "1.22.1",
   "description": "Extension of the Axios module adding convenience methods to interact with SAP systems especially with OData services.",
   "repository": {
     "type": "git",