@sap-ux/axios-extension 1.6.0 → 1.7.0

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

@@ -82,9 +82,10 @@ export declare class AbapServiceProvider extends ServiceProvider {
     /**
      * Create or get an existing instance of design time adaptation service.
      *
+     * @param alias - optional alias path on which the LREP service is exposed
      * @returns an instance of the design time adaptation service.
      */
-    getLayeredRepository(): LayeredRepositoryService;
+    getLayeredRepository(alias?: string): LayeredRepositoryService;
     /**
      * Retrieve singleton instance of AdtService subclass to serve the specific ADT request query.
      *

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

@@ -174,13 +174,15 @@ class AbapServiceProvider extends service_provider_1.ServiceProvider {
     /**
      * Create or get an existing instance of design time adaptation service.
      *
+     * @param alias - optional alias path on which the LREP service is exposed
      * @returns an instance of the design time adaptation service.
      */
-    getLayeredRepository() {
-        if (!this.services[lrep_service_1.LayeredRepositoryService.PATH]) {
-            this.services[lrep_service_1.LayeredRepositoryService.PATH] = this.createService(lrep_service_1.LayeredRepositoryService.PATH, lrep_service_1.LayeredRepositoryService);
+    getLayeredRepository(alias) {
+        const path = alias !== null && alias !== void 0 ? alias : lrep_service_1.LayeredRepositoryService.PATH;
+        if (!this.services[path]) {
+            this.services[path] = this.createService(path, lrep_service_1.LayeredRepositoryService);
         }
-        return this.services[lrep_service_1.LayeredRepositoryService.PATH];
+        return this.services[path];
     }
     /**
      * Retrieve singleton instance of AdtService subclass to serve the specific ADT request query.

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

@@ -4,6 +4,7 @@ import type { AxiosResponse } from 'axios';
 import { Axios } from 'axios';
 import type { Logger } from '@sap-ux/logger';
 import type { ManifestNamespace } from '@sap-ux/project-access';
+import type { TransportConfig } from './ui5-abap-repository-service';
 export type Manifest = ManifestNamespace.SAPJSONSchemaForWebApplicationManifestFile & {
     [key: string]: unknown;
 };
@@ -27,19 +28,11 @@ export type Namespace = NamespaceObject | string;
 /**
  * Required configuration to deploy an adaptation project.
  */
-export interface AdaptationConfig {
+export interface AdaptationConfig extends TransportConfig {
     /**
      * Namespace either as string or object
      */
     namespace: Namespace;
-    /**
-     * Optional ABAP package name
-     */
-    package?: string;
-    /**
-     * Optional transport request
-     */
-    transport?: string;
     /**
      * Optional layer (default: CUSTOMER_BASE)
      */
@@ -83,6 +76,12 @@ type Layer = 'VENDOR' | 'CUSTOMER_BASE';
 export declare class LayeredRepositoryService extends Axios implements Service {
     static readonly PATH = "/sap/bc/lrep";
     log: Logger;
+    /**
+     * Simple request to fetch a CSRF token required for all writing operations.
+     *
+     * @returns the response
+     */
+    getCsrfToken(): Promise<AxiosResponse<any, any>>;
     /**
      * Merge a given app descriptor variant with the stord app descriptor.
      *
@@ -103,16 +102,16 @@ export declare class LayeredRepositoryService extends Axios implements Service {
     /**
      * Deploy the given archive either by creating a new folder in the layered repository or updating an existing one.
      *
-     * @param archivePath path to a zip archive containing the adaptation project
+     * @param archive path to a zip archive or archive as buffer containing the adaptation project
      * @param config adataption project deployment configuration
      * @returns the Axios response object for futher processing
      */
-    deploy(archivePath: string, config: AdaptationConfig): Promise<AxiosResponse>;
+    deploy(archive: Buffer | string, config: AdaptationConfig): Promise<AxiosResponse>;
     /**
      * Undeploy the archive identified by the configuration.
      *
-     * @param config adataption project deployment configuration
-     * @returns the Axios response object for futher processing
+     * @param config adaptation project deployment configuration
+     * @returns the Axios response object for further processing
      */
     undeploy(config: AdaptationConfig): Promise<AxiosResponse>;
     /**

package/dist/abap/lrep-service.js

@@ -23,6 +23,15 @@ const odata_request_error_1 = require("../base/odata-request-error");
 function getNamespaceAsString(namespace) {
     return typeof namespace !== 'string' ? `apps/${namespace['reference']}/appVariants/${namespace['id']}/` : namespace;
 }
+/**
+ * Check if a variable is a buffer.
+ *
+ * @param input variable to be checked
+ * @returns true if the input is a buffer
+ */
+function isBuffer(input) {
+    return input.BYTES_PER_ELEMENT !== undefined;
+}
 /**
  * Path suffix for all DTA actions.
  */
@@ -31,6 +40,24 @@ const DTA_PATH_SUFFIX = '/dta_folder/';
  * A class representing the design time adaptation service allowing to deploy adaptation projects to an ABAP system.
  */
 class LayeredRepositoryService extends axios_1.Axios {
+    /**
+     * Simple request to fetch a CSRF token required for all writing operations.
+     *
+     * @returns the response
+     */
+    getCsrfToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                return yield this.get('/actions/getcsrftoken/');
+            }
+            catch (error) {
+                if ((0, odata_request_error_1.isAxiosError)(error)) {
+                    this.tryLogResponse(error.response);
+                }
+                throw error;
+            }
+        });
+    }
     /**
      * Merge a given app descriptor variant with the stord app descriptor.
      *
@@ -90,14 +117,14 @@ class LayeredRepositoryService extends axios_1.Axios {
     /**
      * Deploy the given archive either by creating a new folder in the layered repository or updating an existing one.
      *
-     * @param archivePath path to a zip archive containing the adaptation project
+     * @param archive path to a zip archive or archive as buffer containing the adaptation project
      * @param config adataption project deployment configuration
      * @returns the Axios response object for futher processing
      */
-    deploy(archivePath, config) {
+    deploy(archive, config) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const archive = (0, fs_1.readFileSync)(archivePath);
+            const data = isBuffer(archive) ? archive : (0, fs_1.readFileSync)(archive);
             const checkResponse = yield this.isExistingVariant(config.namespace);
             const params = {
                 name: getNamespaceAsString(config.namespace),
@@ -110,7 +137,7 @@ class LayeredRepositoryService extends axios_1.Axios {
             const response = yield this.request({
                 method: checkResponse.status === 200 ? 'PUT' : 'POST',
                 url: DTA_PATH_SUFFIX,
-                data: archive,
+                data,
                 params,
                 headers: {
                     'Content-Type': 'application/octet-stream'
@@ -123,11 +150,11 @@ class LayeredRepositoryService extends axios_1.Axios {
     /**
      * Undeploy the archive identified by the configuration.
      *
-     * @param config adataption project deployment configuration
-     * @returns the Axios response object for futher processing
+     * @param config adaptation project deployment configuration
+     * @returns the Axios response object for further processing
      */
     undeploy(config) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const checkResponse = yield this.isExistingVariant(config.namespace);
             if (checkResponse.status !== 200) {
@@ -140,9 +167,19 @@ class LayeredRepositoryService extends axios_1.Axios {
             if (config.transport) {
                 params['changelist'] = config.transport;
             }
-            const response = yield this.delete(DTA_PATH_SUFFIX, { params });
-            this.tryLogResponse(response, 'Undeployment successful.');
-            return response;
+            try {
+                const response = yield this.delete(DTA_PATH_SUFFIX, { params });
+                this.tryLogResponse(response, 'Undeployment successful.');
+                return response;
+            }
+            catch (error) {
+                this.log.error('Undeployment failed');
+                this.log.debug(error);
+                if ((0, odata_request_error_1.isAxiosError)(error) && ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) === 405) {
+                    this.log.error('Newer version of SAP_UI required, please check https://help.sap.com/docs/bas/developing-sap-fiori-app-in-sap-business-application-studio/delete-adaptation-project');
+                }
+                throw error;
+            }
         });
     }
     /**

package/dist/abap/message.d.ts

@@ -57,12 +57,14 @@ export declare function prettyPrintMessage({ msg, log, host, isDest }: {
  * @param options.error error message returned from gateway
  * @param options.log logger to be used
  * @param options.host optional host name to pretty print links
+ * @param options.isDest optional value if additional info should be printed
  * @param showAllMessages optional, show all errors but restrict for certain flows i.e. test mode
  */
-export declare function prettyPrintError({ error, log, host }: {
+export declare function prettyPrintError({ error, log, host, isDest }: {
     error: ErrorMessage;
     log: Logger;
     host?: string;
+    isDest?: boolean;
 }, showAllMessages?: boolean): void;
 /**
  * Print a user friendly time string.

package/dist/abap/message.js

@@ -79,9 +79,10 @@ function logFullURL({ host, path, log, isDest = false }) {
  * @param options.error error message returned from gateway
  * @param options.log logger to be used
  * @param options.host optional host name to pretty print links
+ * @param options.isDest optional value if additional info should be printed
  * @param showAllMessages optional, show all errors but restrict for certain flows i.e. test mode
  */
-function prettyPrintError({ error, log, host }, showAllMessages = true) {
+function prettyPrintError({ error, log, host, isDest }, showAllMessages = true) {
     var _a, _b, _c;
     if (error) {
         if (showAllMessages) {
@@ -91,7 +92,7 @@ function prettyPrintError({ error, log, host }, showAllMessages = true) {
             if (!entry.message.startsWith('<![CDATA')) {
                 logLevel(entry.severity, entry.message, log, true);
             }
-            logFullURL({ host, path: entry['longtext_url'], log });
+            logFullURL({ host, path: entry['longtext_url'], log, isDest });
         });
         if (showAllMessages && ((_c = error.innererror) === null || _c === void 0 ? void 0 : _c.Error_Resolution)) {
             for (const key in error.innererror.Error_Resolution) {

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

@@ -2,10 +2,23 @@
 import type { AxiosResponse, AxiosRequestConfig } from 'axios';
 import type { ErrorMessage } from './message';
 import { ODataService } from '../base/odata-service';
+/**
+ * Required configuration a transportable object.
+ */
+export interface TransportConfig {
+    /**
+     * Optional package for the ABAP development object
+     */
+    package?: string;
+    /**
+     * Optional transport request to record the changes
+     */
+    transport?: string;
+}
 /**
  * Required configuration for the BSP hosting an app.
  */
-export interface BspConfig {
+export interface BspConfig extends TransportConfig {
     /**
      * Name of the BSP, additionally, the last part of the exposed service path
      */
@@ -14,14 +27,6 @@ export interface BspConfig {
      * Optional description of the ABAP development object representing the BSP
      */
     description?: string;
-    /**
-     * Optional package for the ABAP development object
-     */
-    package?: string;
-    /**
-     * Optional transport request to record the changes
-     */
-    transport?: string;
 }
 /**
  * Configuration required for deploying an app.
@@ -83,6 +88,13 @@ export declare class Ui5AbapRepositoryService extends ODataService {
      * @returns application information or undefined
      */
     getInfo(app: string): Promise<AppInfo>;
+    /**
+     * Get the application files as zip archive. This will only work on ABAP systems 2308 or newer.
+     *
+     * @param app application id (BSP application name)
+     * @returns undefined if no app is found or downloading files is not supported, otherwise return the application files as a buffer.
+     */
+    downloadFiles(app: string): Promise<Buffer>;
     /**
      * Deploy the given archive either by creating a new BSP or updating an existing one.
      *
@@ -154,10 +166,12 @@ export declare class Ui5AbapRepositoryService extends ODataService {
      * @param e error thrown by Axios after sending a request
      * @param e.error error from Axios
      * @param e.host hostname
+     * @param e.isDest
      */
-    protected logError({ error, host }: {
+    protected logError({ error, host, isDest }: {
         error: Error;
         host?: string;
+        isDest?: boolean;
     }): void;
     /**
      * Get ErrorMessage object from response contain an error as a string.

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

@@ -75,6 +75,34 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
             }
         });
     }
+    /**
+     * Get the application files as zip archive. This will only work on ABAP systems 2308 or newer.
+     *
+     * @param app application id (BSP application name)
+     * @returns undefined if no app is found or downloading files is not supported, otherwise return the application files as a buffer.
+     */
+    downloadFiles(app) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.get(`/Repositories('${encodeURIComponent(app)}')`, {
+                    params: {
+                        CodePage: 'UTF8',
+                        DownloadFiles: 'RUNTIME'
+                    }
+                });
+                const data = response.odata();
+                return data.ZipArchive ? Buffer.from(data.ZipArchive) : undefined;
+            }
+            catch (error) {
+                this.log.debug(`Retrieving application ${app}, ${error}`);
+                if ((0, odata_request_error_1.isAxiosError)(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                    return undefined;
+                }
+                throw error;
+            }
+        });
+    }
     /**
      * Deploy the given archive either by creating a new BSP or updating an existing one.
      *
@@ -93,6 +121,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
             this.log.debug(`Payload:\n${payload}`);
             const config = this.createConfig(bsp.transport, testMode, safeMode);
             const frontendUrl = this.getAbapFrontendUrl();
+            const isDest = /\.dest\//.test(config.baseURL);
             try {
                 const response = yield this.updateRepoRequest(!!info, bsp.name, payload, config);
                 // An app can be successfully deployed after a timeout exception, no value in showing exception headers
@@ -101,7 +130,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                         msg: response.headers['sap-message'],
                         log: this.log,
                         host: frontendUrl,
-                        isDest: /\.dest\//.test(config.baseURL)
+                        isDest
                     });
                 }
                 if (!testMode) {
@@ -117,13 +146,14 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                     (0, message_1.prettyPrintError)({
                         error: this.getErrorMessageFromString(response === null || response === void 0 ? void 0 : response.data),
                         log: this.log,
-                        host: frontendUrl
+                        host: frontendUrl,
+                        isDest
                     }, false);
                 }
                 return response;
             }
             catch (error) {
-                this.logError({ error, host: frontendUrl });
+                this.logError({ error, host: frontendUrl, isDest });
                 throw error;
             }
         });
@@ -142,11 +172,17 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
             const config = this.createConfig(bsp.transport, testMode);
             const host = this.getAbapFrontendUrl();
             const info = yield this.getInfo(bsp.name);
+            const isDest = /\.dest\//.test(config.baseURL);
             try {
                 if (info) {
                     const response = yield this.deleteRepoRequest(bsp.name, config);
                     if ((_a = response === null || response === void 0 ? void 0 : response.headers) === null || _a === void 0 ? void 0 : _a['sap-message']) {
-                        (0, message_1.prettyPrintMessage)({ msg: response.headers['sap-message'], log: this.log, host });
+                        (0, message_1.prettyPrintMessage)({
+                            msg: response.headers['sap-message'],
+                            log: this.log,
+                            host,
+                            isDest
+                        });
                     }
                     return response;
                 }
@@ -156,7 +192,7 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
                 }
             }
             catch (error) {
-                this.logError({ error, host });
+                this.logError({ error, host, isDest });
                 throw error;
             }
         });
@@ -330,14 +366,15 @@ class Ui5AbapRepositoryService extends odata_service_1.ODataService {
      * @param e error thrown by Axios after sending a request
      * @param e.error error from Axios
      * @param e.host hostname
+     * @param e.isDest
      */
-    logError({ error, host }) {
+    logError({ error, host, isDest }) {
         var _a, _b;
         this.log.error(error.message);
         if ((0, odata_request_error_1.isAxiosError)(error) && ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data)) {
             const errorMessage = this.getErrorMessageFromString((_b = error.response) === null || _b === void 0 ? void 0 : _b.data);
             if (errorMessage) {
-                (0, message_1.prettyPrintError)({ error: errorMessage, host, log: this.log });
+                (0, message_1.prettyPrintError)({ error: errorMessage, host, log: this.log, isDest });
             }
             else {
                 this.log.error(error.response.data.toString());

package/package.json

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