@sap-ux/axios-extension 0.12.0 → 0.13.0

package/README.adoc

@@ -65,7 +65,11 @@ const provider = createForAbap({
     params: { 'sap-client': client }
 });
 const transportRequestSerivce = provider.getAdtService<TransportRequestService>(TransportRequestService);
-const newTrNumber = await transportRequestSerivce.createTransportRequest('A new transport request number for deployment');
+const newTrNumber = await transportRequestSerivce.createTransportRequest({
+    packageName: 'Z_PACKAGE',
+    ui5AppName: 'zappname',
+    description: 'A new transport request number for deployment'
+});
 ```
 #### ADT Service Implementation
 Supported ADT services are implemented in link:./src/abap/adt-catalog/services[src/abap/adt-catalog/services].

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

@@ -1,5 +1,5 @@
 export { AdtService } from './adt-service';
 export { AtoService } from './ato-service';
 export { TransportChecksService } from './transportcheck-service';
-export { TransportRequestService } from './transportrequest-service';
+export { TransportRequestService, NewUi5ObjectRequestParams } from './transportrequest-service';
 //# sourceMappingURL=index.d.ts.map

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

@@ -2,7 +2,7 @@ import { AdtService } from './adt-service';
 import type { AdtCategory, TransportRequest } from '../../types';
 /**
  * TransportChecksService implements ADT requests for fetching a list of available transport requests
- * for a given package name and a give app name.
+ * for a given package name and a given app name.
  */
 export declare class TransportChecksService extends AdtService {
     /**
@@ -15,6 +15,7 @@ export declare class TransportChecksService extends AdtService {
      */
     static getAdtCatagory(): AdtCategory;
     /**
+     * TransportChecksService API function to fetch a list of available transport requests.
      *
      * @param packageName Package name for deployment
      * @param appName Fiori project name for deployment. A new project that has not been deployed before is also allowed

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

@@ -39,7 +39,7 @@ const xpath = __importStar(require("xpath"));
 const xmldom_1 = require("@xmldom/xmldom");
 /**
  * TransportChecksService implements ADT requests for fetching a list of available transport requests
- * for a given package name and a give app name.
+ * for a given package name and a given app name.
  */
 class TransportChecksService extends adt_service_1.AdtService {
     /**
@@ -50,6 +50,7 @@ class TransportChecksService extends adt_service_1.AdtService {
         return TransportChecksService.AdtCategory;
     }
     /**
+     * TransportChecksService API function to fetch a list of available transport requests.
      *
      * @param packageName Package name for deployment
      * @param appName Fiori project name for deployment. A new project that has not been deployed before is also allowed

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

@@ -1,5 +1,23 @@
 import { AdtService } from './adt-service';
 import type { AdtCategory } from '../../types';
+/**
+ * Input parameter for creating a new transport request for an UI5 app object.
+ */
+export interface NewUi5ObjectRequestParams {
+    /**
+     * A valid package name is required to create a new transport request
+     */
+    packageName: string;
+    /**
+     * Name of a Fiori UI5 app to be deployed.
+     * It is acceptable to use a new app name that does not exist.
+     */
+    ui5AppName: string;
+    /**
+     * Description of the new transport request to be created
+     */
+    description: string;
+}
 /**
  * TransportRequestService implements ADT requests for creating a new transport request number
  * that can be used for deploying Fiori project to ABAP backend.
@@ -15,15 +33,16 @@ export declare class TransportRequestService extends AdtService {
      */
     static getAdtCatagory(): AdtCategory;
     /**
+     * TransportRequestService API function to create a new transport number.
      *
-     * @param description Description of the new transport request to be created
+     * @param reqParam Request parameter for creating a new transport request for an UI5 app object.
      * @returns Newly created transport request number
      */
-    createTransportRequest(description: string): Promise<string>;
+    createTransportRequest(reqParam: NewUi5ObjectRequestParams): Promise<string>;
     /**
      * Read the newly created transport number from response XML data.
      *
-     * @param xml XML response of create transport request.
+     * @param text XML response of create transport request.
      * @returns Newly created transport number or null
      */
     private getTransportNumberFromResponse;

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

@@ -1,23 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -27,15 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TransportRequestService = void 0;
 const adt_service_1 = require("./adt-service");
-const fast_xml_parser_1 = __importDefault(require("fast-xml-parser"));
-const xpath = __importStar(require("xpath"));
-const xmldom_1 = require("@xmldom/xmldom");
 /**
  * TransportRequestService implements ADT requests for creating a new transport request number
  * that can be used for deploying Fiori project to ABAP backend.
@@ -49,24 +24,31 @@ class TransportRequestService extends adt_service_1.AdtService {
         return TransportRequestService.AdtCategory;
     }
     /**
+     * TransportRequestService API function to create a new transport number.
      *
-     * @param description Description of the new transport request to be created
+     * @param reqParam Request parameter for creating a new transport request for an UI5 app object.
      * @returns Newly created transport request number
      */
-    createTransportRequest(description) {
+    createTransportRequest(reqParam) {
         return __awaiter(this, void 0, void 0, function* () {
             const acceptHeaders = {
                 headers: {
-                    Accept: 'application/vnd.sap.adt.transportorganizer.v1+xml',
-                    'content-type': 'text/plain'
+                    Accept: 'text/plain',
+                    'content-type': 'application/vnd.sap.as+xml; charset=UTF-8; dataname=com.sap.adt.CreateCorrectionRequest'
                 }
             };
             const data = `
-                <?xml version="1.0" encoding="ASCII"?>
-                <tm:root xmlns:tm="http://www.sap.com/cts/adt/tm" tm:useraction="newrequest">
-                    <tm:request tm:desc="${description}" tm:type="K" tm:target="LOCAL" tm:cts_project="">
-                    </tm:request>
-                </tm:root>
+                <?xml version="1.0" encoding="UTF-8"?>
+                <asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
+                    <asx:values>
+                        <DATA>
+                            <OPERATION>I</OPERATION>
+                            <DEVCLASS>${reqParam.packageName}</DEVCLASS>
+                            <REQUEST_TEXT>${reqParam.description}</REQUEST_TEXT>
+                            <REF>/sap/bc/adt/filestore/ui5-bsp/objects/${reqParam.ui5AppName}/$create</REF>
+                        </DATA>
+                    </asx:values>
+                </asx:abap>
             `;
             const response = yield this.post('', data, acceptHeaders);
             return this.getTransportNumberFromResponse(response.data);
@@ -75,23 +57,17 @@ class TransportRequestService extends adt_service_1.AdtService {
     /**
      * Read the newly created transport number from response XML data.
      *
-     * @param xml XML response of create transport request.
+     * @param text XML response of create transport request.
      * @returns Newly created transport number or null
      */
-    getTransportNumberFromResponse(xml) {
-        if (fast_xml_parser_1.default.validate(xml) !== true) {
-            this.log.warn(`Invalid XML: ${xml}`);
-            return '';
-        }
-        const doc = new xmldom_1.DOMParser().parseFromString(xml);
-        const select = xpath.useNamespaces({ 'tm': 'http://www.sap.com/cts/adt/tm' });
-        const attrElement = select('//tm:request/@tm:number', doc);
-        if (attrElement && attrElement.length === 1) {
-            const createdTransportNumber = attrElement[0].nodeValue;
-            return createdTransportNumber;
+    getTransportNumberFromResponse(text) {
+        const responseStringPrefix = '/com.sap.cts/object_record/';
+        if (!text || !text.startsWith(responseStringPrefix)) {
+            return null;
         }
         else {
-            return null;
+            const newTransportNumber = text.replace(responseStringPrefix, '');
+            return newTransportNumber;
         }
     }
 }
@@ -101,6 +77,6 @@ exports.TransportRequestService = TransportRequestService;
  */
 TransportRequestService.AdtCategory = {
     scheme: 'http://www.sap.com/adt/categories/cts',
-    term: 'transportmanagement'
+    term: 'transports'
 };
 //# sourceMappingURL=transportrequest-service.js.map

package/package.json

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