@sap-ux/axios-extension 1.0.2 → 1.1.0

package/README.adoc

@@ -27,11 +27,11 @@ The generic OData service simplifies the access to the service metadata as well
 #### Catalog Service
 Simplified consumption of the SAP catalog service useful for fetching annotations.
 
-#### ABAP UI5 Respository Service
+#### ABAP UI5 Repository Service
 Allows deployment of applications to the UI5 ABAP Repository as well as checking deployed applications.
 
 #### App Index Service
-A class respresenting the app index service allowing to search applications deployed on an ABAP system.
+A class representing the app index service allowing to search applications deployed on an ABAP system.
 
 #### Layered Repository Service
 Allows deployment of adaptation projects.
@@ -64,8 +64,8 @@ const provider = createForAbap({
     baseURL: 'https://sap.example',
     params: { 'sap-client': client }
 });
-const transportRequestSerivce = provider.getAdtService<TransportRequestService>(TransportRequestService);
-const newTrNumber = await transportRequestSerivce.createTransportRequest({
+const transportRequestService = provider.getAdtService<TransportRequestService>(TransportRequestService);
+const newTrNumber = await transportRequestService.createTransportRequest({
     packageName: 'Z_PACKAGE',
     ui5AppName: 'zappname',
     description: 'A new transport request number for deployment'

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

@@ -12,6 +12,10 @@ import { AdtService } from './adt-catalog/services';
 export declare class AbapServiceProvider extends ServiceProvider {
     s4Cloud: boolean | undefined;
     protected atoSettings: AtoSettings;
+    /**
+     * Maintain the public facing URL which is required for destination related flows
+     */
+    protected _publicUrl: string;
     /**
      * Get the name of the currently logged in user. This is the basic implementation that could be overwritten by subclasses.
      * The function returns a promise because it may be required to fetch the information from the backend.
@@ -31,6 +35,18 @@ export declare class AbapServiceProvider extends ServiceProvider {
      * @returns ABAP Transport Organizer settings
      */
     getAtoInfo(): Promise<AtoSettings>;
+    /**
+     * Set the public facing URL, typically used for a destination related flows.
+     *
+     * @param host
+     */
+    set publicUrl(host: string);
+    /**
+     * Retrieve the public facing URL, default to Axios base URL if not configured.
+     *
+     * @returns string Axios baseUrl if public URL is not configured by a destination
+     */
+    get publicUrl(): string;
     /**
      * Detect if the given configuration points to an S/4HANA Cloud system.
      *
@@ -74,7 +90,7 @@ export declare class AbapServiceProvider extends ServiceProvider {
      *
      * @example
      * ```ts
-     * const transportRequestSerivce = abapServiceProvider.getAdtService<TransportRequestService>(TransportRequestService);
+     * const transportRequestService = abapServiceProvider.getAdtService<TransportRequestService>(TransportRequestService);
      * ```
      * @param adtServiceSubclass Subclass of class AdtService, type is specified by using AdtService class constructor signature.
      * @returns Subclass type of class AdtService

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

@@ -69,6 +69,22 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
             return this.atoSettings;
         });
     }
+    /**
+     * Set the public facing URL, typically used for a destination related flows.
+     *
+     * @param host
+     */
+    set publicUrl(host) {
+        this._publicUrl = host;
+    }
+    /**
+     * Retrieve the public facing URL, default to Axios base URL if not configured.
+     *
+     * @returns string Axios baseUrl if public URL is not configured by a destination
+     */
+    get publicUrl() {
+        return this._publicUrl || this.defaults.baseURL;
+    }
     /**
      * Detect if the given configuration points to an S/4HANA Cloud system.
      *
@@ -101,8 +117,8 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
      */
     getAdtCatalogService() {
         if (!this.services[adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH]) {
-            const adtCatalogSerivce = this.createService(adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH, adt_catalog_service_1.AdtCatalogService);
-            this.services[adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH] = adtCatalogSerivce;
+            const adtCatalogService = this.createService(adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH, adt_catalog_service_1.AdtCatalogService);
+            this.services[adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH] = adtCatalogService;
         }
         return this.services[adt_catalog_service_1.AdtCatalogService.ADT_DISCOVERY_SERVICE_PATH];
     }
@@ -171,7 +187,7 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
      *
      * @example
      * ```ts
-     * const transportRequestSerivce = abapServiceProvider.getAdtService<TransportRequestService>(TransportRequestService);
+     * const transportRequestService = abapServiceProvider.getAdtService<TransportRequestService>(TransportRequestService);
      * ```
      * @param adtServiceSubclass Subclass of class AdtService, type is specified by using AdtService class constructor signature.
      * @returns Subclass type of class AdtService
@@ -181,8 +197,8 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
             const subclassName = adtServiceSubclass.name;
             if (!this.services[subclassName]) {
                 // Retrieve ADT schema for the specific input AdtService subclass
-                const adtCatalogSerivce = this.getAdtCatalogService();
-                const adtSchema = yield adtCatalogSerivce.getServiceDefinition(adtServiceSubclass.getAdtCatagory());
+                const adtCatalogService = this.getAdtCatalogService();
+                const adtSchema = yield adtCatalogService.getServiceDefinition(adtServiceSubclass.getAdtCatagory());
                 // No ADT schema available neither locally nor from service query.
                 if (!adtSchema) {
                     return null;

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

@@ -7,7 +7,7 @@ export interface App {
 }
 export type AppIndex = Partial<App>[];
 /**
- * A class respresenting the app index service allowing to search applications deployed on an ABAP system.
+ * A class representing the app index service allowing to search applications deployed on an ABAP system.
  */
 export declare abstract class AppIndexService extends Axios implements Service {
     static readonly PATH = "/sap/bc/ui2/app_index";

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

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppIndexService = void 0;
 const axios_1 = require("axios");
 /**
- * A class respresenting the app index service allowing to search applications deployed on an ABAP system.
+ * A class representing the app index service allowing to search applications deployed on an ABAP system.
  */
 class AppIndexService extends axios_1.Axios {
     /**

package/dist/abap/message.js

@@ -2,6 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.prettyPrintTimeInMs = exports.prettyPrintError = exports.prettyPrintMessage = void 0;
 const url_1 = require("url");
+/**
+ *
+ * @param severity
+ * @param msg
+ * @param log
+ * @param error
+ */
+function logLevel(severity, msg, log, error = false) {
+    if (severity) {
+        severity = severity.toLowerCase();
+        if (severity === 'success') {
+            log.info(msg);
+        }
+        else {
+            if (severity === 'warning') {
+                severity = 'warn';
+            }
+            log[severity](msg);
+        }
+    }
+    else {
+        error ? log.error(msg) : log.info(msg);
+    }
+}
 /**
  * Log a Gateway response.
  *
@@ -57,7 +81,7 @@ function prettyPrintError({ error, log, host }) {
         if (error.innererror) {
             (error.innererror.errordetails || []).forEach((entry) => {
                 if (!entry.message.startsWith('<![CDATA')) {
-                    log.error(entry.message);
+                    logLevel(entry.severity, entry.message, log, true);
                 }
                 logFullURL({ host, path: error['longtext_url'], log });
             });

package/dist/abap/ui5-abap-repository-service.d.ts

@@ -67,12 +67,15 @@ export declare const abapUrlReplaceMap: Map<RegExp, string>;
  */
 export declare class Ui5AbapRepositoryService extends ODataService {
     static readonly PATH = "/sap/opu/odata/UI5/ABAP_REPOSITORY_SRV";
+    private readonly publicUrl;
     /**
      * Extension of the base constructor to set preferred response format if not provided by caller.
      *
-     * @param config optional base configuration for Axios
+     * @param config optional base configuration for Axios appended with optional fields
      */
-    constructor(config?: AxiosRequestConfig);
+    constructor(config?: AxiosRequestConfig & {
+        publicUrl?: string;
+    });
     /**
      * Get information about a deployed application. Returns undefined if the application cannot be found.
      *
@@ -88,16 +91,16 @@ export declare class Ui5AbapRepositoryService extends ODataService {
      * @param config.bsp BSP configuration
      * @param config.testMode if set to true, all requests will be sent, the service checks them, but no actual deployment will happen
      * @param config.safeMode if set then the SafeMode url parameter will be set. SafeMode is by default active, to activate provide false
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     deploy({ archive, bsp, testMode, safeMode }: DeployConfig): Promise<AxiosResponse>;
     /**
      * Undeploy an existing app.
      *
-     * @param config undeployment config
+     * @param config undeploy config
      * @param config.bsp BSP configuration
      * @param config.testMode if set to true, all requests will be sent, the service checks them, but no actual deployment will happen
-     * @returns the Axios response object for futher processing or undefined if no request is sent
+     * @returns the Axios response object for further processing or undefined if no request is sent
      */
     undeploy({ bsp, testMode }: UndeployConfig): Promise<AxiosResponse | undefined>;
     /**
@@ -111,8 +114,8 @@ export declare class Ui5AbapRepositoryService extends ODataService {
      *
      * @param transport optional transport request id
      * @param testMode optional url parameter to enable test mode
-     * @param safeMode optional url paramater to disable the safe model (safemode=false)
-     * @returns the Axios response object for futher processing
+     * @param safeMode optional url parameter to disable the safe model (safemode=false)
+     * @returns the Axios response object for further processing
      */
     protected createConfig(transport?: string, testMode?: boolean, safeMode?: boolean): AxiosRequestConfig;
     /**
@@ -133,16 +136,16 @@ export declare class Ui5AbapRepositoryService extends ODataService {
      * @param payload request payload
      * @param config additional request config
      * @param tryCount number of attempted deploys (sometimes a repo request fails with a known timeout issue, so we retry)
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     protected updateRepoRequest(isExisting: boolean, appName: string, payload: string, config: AxiosRequestConfig, tryCount?: number): Promise<AxiosResponse | undefined>;
     /**
-     * Send a request to the backed to delete an application.
+     * Send a request to the backend to delete an application.
      *
      * @param appName application name
      * @param config additional request config
      * @param tryCount number of attempted deploys (sometimes a repo request fails with a known timeout issue, so we retry)
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     protected deleteRepoRequest(appName: string, config: AxiosRequestConfig, tryCount?: number): Promise<AxiosResponse>;
     /**

package/dist/abap/ui5-abap-repository-service.js

@@ -42,7 +42,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
     /**
      * Extension of the base constructor to set preferred response format if not provided by caller.
      *
-     * @param config optional base configuration for Axios
+     * @param config optional base configuration for Axios appended with optional fields
      */
     constructor(config) {
         var _a, _b;
@@ -51,6 +51,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
         // @see https://axios-http.com/docs/config_defaults
         config.headers['Accept'] = (_b = config.headers['Accept']) !== null && _b !== void 0 ? _b : 'application/json,application/xml,text/plain,*/*';
         super(config);
+        this.publicUrl = config.publicUrl || this.defaults.baseURL;
     }
     /**
      * Get information about a deployed application. Returns undefined if the application cannot be found.
@@ -65,6 +66,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                 return response.odata();
             }
             catch (error) {
+                this.log.debug(`Retrieving application ${app}, error found ${error}`);
                 return undefined;
             }
         });
@@ -77,7 +79,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
      * @param config.bsp BSP configuration
      * @param config.testMode if set to true, all requests will be sent, the service checks them, but no actual deployment will happen
      * @param config.safeMode if set then the SafeMode url parameter will be set. SafeMode is by default active, to activate provide false
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     deploy({ archive, bsp, testMode = false, safeMode }) {
         var _a, _b;
@@ -110,10 +112,10 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
     /**
      * Undeploy an existing app.
      *
-     * @param config undeployment config
+     * @param config undeploy config
      * @param config.bsp BSP configuration
      * @param config.testMode if set to true, all requests will be sent, the service checks them, but no actual deployment will happen
-     * @returns the Axios response object for futher processing or undefined if no request is sent
+     * @returns the Axios response object for further processing or undefined if no request is sent
      */
     undeploy({ bsp, testMode = false }) {
         var _a;
@@ -146,7 +148,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
      * @returns url to be used in the browser.
      */
     getAbapFrontendUrl() {
-        const url = new URL(this.defaults.baseURL);
+        const url = new URL(this.publicUrl);
         exports.abapUrlReplaceMap.forEach((value, key) => {
             url.hostname = url.hostname.replace(key, value);
         });
@@ -157,8 +159,8 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
      *
      * @param transport optional transport request id
      * @param testMode optional url parameter to enable test mode
-     * @param safeMode optional url paramater to disable the safe model (safemode=false)
-     * @returns the Axios response object for futher processing
+     * @param safeMode optional url parameter to disable the safe model (safemode=false)
+     * @returns the Axios response object for further processing
      */
     createConfig(transport, testMode, safeMode) {
         const headers = {
@@ -205,8 +207,8 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
         return (`<entry xmlns="http://www.w3.org/2005/Atom"` +
             `       xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"` +
             `       xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"` +
-            `       xml:base="${this.defaults.baseURL}">` +
-            `  <id>${this.defaults.baseURL}/Repositories('${escapedName}')</id>` +
+            `       xml:base="${this.publicUrl}">` +
+            `  <id>${this.publicUrl}/Repositories('${escapedName}')</id>` +
             `  <title type="text">Repositories('${escapedName}')</title>` +
             `  <updated>${time}</updated>` +
             `  <category term="/UI5/ABAP_REPOSITORY_SRV.Repository" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme"/>` +
@@ -230,10 +232,10 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
      * @param payload request payload
      * @param config additional request config
      * @param tryCount number of attempted deploys (sometimes a repo request fails with a known timeout issue, so we retry)
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     updateRepoRequest(isExisting, appName, payload, config, tryCount = 1) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 // Was the app deployed after the first failed attempt?
@@ -246,6 +248,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                     return Promise.resolve(undefined);
                 }
                 else {
+                    this.log.info(`${appName} found on target system: ${isExisting}`);
                     const response = isExisting
                         ? yield this.put(`/Repositories('${encodeURIComponent(appName)}')`, payload, config)
                         : yield this.post('/Repositories', payload, config);
@@ -260,6 +263,10 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                     }
                     return this.updateRepoRequest(isExisting, appName, payload, config, tryCount + 1);
                 }
+                else if ((_b = config === null || config === void 0 ? void 0 : config.params) === null || _b === void 0 ? void 0 : _b.TestMode) {
+                    // TestMode returns HTTP 403 but includes details of the uploaded files and request
+                    return error.response;
+                }
                 else {
                     throw error;
                 }
@@ -267,12 +274,12 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
         });
     }
     /**
-     * Send a request to the backed to delete an application.
+     * Send a request to the backend to delete an application.
      *
      * @param appName application name
      * @param config additional request config
      * @param tryCount number of attempted deploys (sometimes a repo request fails with a known timeout issue, so we retry)
-     * @returns the Axios response object for futher processing
+     * @returns the Axios response object for further processing
      */
     deleteRepoRequest(appName, config, tryCount = 1) {
         var _a;
@@ -308,8 +315,17 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
         var _a;
         this.log.error(error.message);
         if ((0, odata_request_error_1.isAxiosError)(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data)) {
-            if (error.response.data['error']) {
-                (0, message_1.prettyPrintError)({ error: error.response.data['error'], host, log: this.log });
+            let responseData = error.response.data;
+            if (typeof error.response.data === 'string') {
+                try {
+                    responseData = JSON.parse(error.response.data);
+                }
+                catch (_b) {
+                    // Not much we can do!
+                }
+            }
+            if (responseData === null || responseData === void 0 ? void 0 : responseData['error']) {
+                (0, message_1.prettyPrintError)({ error: responseData['error'], host, log: this.log });
             }
             else {
                 this.log.error(error.response.data);

package/dist/auth/connection.js

@@ -114,7 +114,7 @@ function isHtmlLoginForm(response) {
 }
 /**
  * @param contentTypeHeader contents of Content-Type header (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type)
- * @param responseData data receievd in HTTP response. This is used to infer the Content-Type, if the header is missing or ambiguous
+ * @param responseData data received in HTTP response. This is used to infer the Content-Type, if the header is missing or ambiguous
  * @returns content type
  */
 function getContentType(contentTypeHeader, responseData) {
@@ -164,11 +164,14 @@ function attachConnectionHandler(provider) {
             return response;
         }
     }, (error) => {
-        var _a, _b;
+        var _a;
         // remember xsrf token if provided even on error
-        if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b[CSRF.ResponseHeaderName]) {
-            provider.defaults.headers.common[CSRF.RequestHeaderName] =
-                error.response.headers[CSRF.ResponseHeaderName];
+        if (error.response) {
+            if ((_a = error.response.headers) === null || _a === void 0 ? void 0 : _a[CSRF.ResponseHeaderName]) {
+                provider.defaults.headers.common[CSRF.RequestHeaderName] =
+                    error.response.headers[CSRF.ResponseHeaderName];
+            }
+            provider.cookies.setCookies(error.response);
         }
         throw error;
     });

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

@@ -44,12 +44,18 @@ export declare class ServiceProvider extends Axios implements ServiceProviderExt
      */
     protected generateServiceConfig(path: string): AxiosRequestConfig;
     /**
-     * Create a service instance for the given path and service class.
+     * Create a service instance for the given path, service class and public URL.
      *
      * @param path path of the service relative to the service provider
      * @param ServiceClass class type to be used to create an instance
      * @returns a service instance
      */
     protected createService<T extends Service>(path: string, ServiceClass: any): T;
+    /**
+     * Retrieve the public URL exposing the ABAP UI application.
+     *
+     * @returns string Axios Base URL
+     */
+    protected get publicUrl(): string;
 }
 //# sourceMappingURL=service-provider.d.ts.map

package/dist/base/service-provider.js

@@ -39,18 +39,26 @@ class ServiceProvider extends axios_1.Axios {
         return Object.assign(Object.assign({}, config), { baseURL: this.defaults.baseURL + path, headers: (_b = (_a = this.defaults.headers) === null || _a === void 0 ? void 0 : _a.common) !== null && _b !== void 0 ? _b : {} });
     }
     /**
-     * Create a service instance for the given path and service class.
+     * Create a service instance for the given path, service class and public URL.
      *
      * @param path path of the service relative to the service provider
      * @param ServiceClass class type to be used to create an instance
      * @returns a service instance
      */
     createService(path, ServiceClass) {
-        const service = new ServiceClass(this.generateServiceConfig(path));
+        const service = new ServiceClass(Object.assign(Object.assign({}, this.generateServiceConfig(path)), { publicUrl: this.publicUrl }));
         service.log = this.log;
         service.interceptors = this.interceptors;
         return service;
     }
+    /**
+     * Retrieve the public URL exposing the ABAP UI application.
+     *
+     * @returns string Axios Base URL
+     */
+    get publicUrl() {
+        return this.defaults.baseURL;
+    }
 }
 exports.ServiceProvider = ServiceProvider;
 //# sourceMappingURL=service-provider.js.map

package/dist/factory.js

@@ -47,7 +47,7 @@ function createInstance(ProviderType, config) {
     delete providerConfig.ignoreCertErrors;
     providerConfig.withCredentials = (providerConfig === null || providerConfig === void 0 ? void 0 : providerConfig.auth) && Object.keys(providerConfig.auth).length > 0;
     /**
-     * Make axios throw an error for 4xx errors as well.
+     * Make axios throw an error for 4xx errors.
      *
      * @param status - http response status
      * @returns success (true) or error (false)
@@ -157,6 +157,8 @@ function createForDestination(options, destination, destinationServiceInstance)
     let provider;
     if ((0, btp_utils_1.isAbapSystem)(destination)) {
         provider = createInstance(abap_1.AbapServiceProvider, providerConfig);
+        // For an ABAP destination flow, need to show the destination host URL property instead of the BAS host URL i.e. https://mydest.dest
+        provider.publicUrl = destination.Host;
     }
     else {
         provider = createInstance(service_provider_1.ServiceProvider, providerConfig);

package/package.json

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