@sap-ux/axios-extension 1.1.0 → 1.2.1

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

@@ -0,0 +1,48 @@
+import { AdtService } from './adt-service';
+import type { AdtCategory, ArchiveFileNodeType, ArchiveFileContentType } from '../../types';
+/**
+ * FileStoreService implements ADT requests to obtain the content
+ * of deployed archive.
+ */
+export declare class FileStoreService extends AdtService {
+    /**
+     * @see AdtService.getAdtCatagory()
+     */
+    private static adtCategory;
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory(): AdtCategory;
+    /**
+     * If target `path` is a file, the file content is returned as string type.
+     * If target `path` is a folder, files and folders in this folder are returned as an array
+     * of ArchiveFileNode objects.
+     *
+     * @see ArchiveFileNode
+     * @param type
+     *  Specifies if input `path` refers to a file or a folder. When starting exploring
+     *  the file structure from the root, type should be set to `folder`. The type information
+     *  of files and folders inside root folder can be found in the returned `ArchiveFileNode` entries.
+     * @param appName Deployed Fiori app name
+     * @param path
+     *   Default value is empty string. In this case the output would be folder structure information of the root folder.
+     *   Otherwise provide path to a folder or a file in the deployed archive. E.g. `/webapp/index.html`.
+     * @returns Folder content (ArchiveFileNode[]) | file content (string)
+     */
+    getAppArchiveContent<T extends ArchiveFileNodeType>(type: T, appName: string, path?: string): Promise<ArchiveFileContentType<T>>;
+    /**
+     * Parse response data from ADT service. If the content is XML document of
+     * folder structure, this method returns a list of `ArchiveFileNode` object. If the content
+     * is text string, this method returns the text cotent.
+     *
+     * @see ArchiveFileNode
+     * @param appName Deployed Fiori app name
+     * @param responseData Response from ADT service
+     * @param type Reponse data is the file content or folder content.
+     * @returns Folder content (ArchiveFileNode[]) | file content (string)
+     */
+    private parseArchiveContentResponse;
+}
+//# sourceMappingURL=filestore-service.d.ts.map

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

@@ -0,0 +1,119 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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.FileStoreService = void 0;
+const adt_service_1 = require("./adt-service");
+const fast_xml_parser_1 = __importDefault(require("fast-xml-parser"));
+/**
+ * FileStoreService implements ADT requests to obtain the content
+ * of deployed archive.
+ */
+class FileStoreService extends adt_service_1.AdtService {
+    /**
+     * Get ADT scheme ID.
+     *
+     * @returns AdtCategory
+     */
+    static getAdtCatagory() {
+        return FileStoreService.adtCategory;
+    }
+    /**
+     * If target `path` is a file, the file content is returned as string type.
+     * If target `path` is a folder, files and folders in this folder are returned as an array
+     * of ArchiveFileNode objects.
+     *
+     * @see ArchiveFileNode
+     * @param type
+     *  Specifies if input `path` refers to a file or a folder. When starting exploring
+     *  the file structure from the root, type should be set to `folder`. The type information
+     *  of files and folders inside root folder can be found in the returned `ArchiveFileNode` entries.
+     * @param appName Deployed Fiori app name
+     * @param path
+     *   Default value is empty string. In this case the output would be folder structure information of the root folder.
+     *   Otherwise provide path to a folder or a file in the deployed archive. E.g. `/webapp/index.html`.
+     * @returns Folder content (ArchiveFileNode[]) | file content (string)
+     */
+    getAppArchiveContent(type, appName, path = '') {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = type === 'folder' ? 'application/atom+xml' : 'application/octet-stream';
+            const config = {
+                headers: {
+                    Accept: 'application/xml',
+                    'Content-Type': contentType
+                }
+            };
+            if (path && !path.startsWith('/')) {
+                throw new Error('Input argument "path" needs to start with /');
+            }
+            const encodedFullPath = encodeURIComponent(`${appName}${path}`);
+            const response = yield this.get(`/${encodedFullPath}/content`, config);
+            return this.parseArchiveContentResponse(appName, response.data, type);
+        });
+    }
+    /**
+     * Parse response data from ADT service. If the content is XML document of
+     * folder structure, this method returns a list of `ArchiveFileNode` object. If the content
+     * is text string, this method returns the text cotent.
+     *
+     * @see ArchiveFileNode
+     * @param appName Deployed Fiori app name
+     * @param responseData Response from ADT service
+     * @param type Reponse data is the file content or folder content.
+     * @returns Folder content (ArchiveFileNode[]) | file content (string)
+     */
+    parseArchiveContentResponse(appName, responseData, type) {
+        // File content that is not xml data.
+        if (type === 'file') {
+            return responseData;
+        }
+        // A list of file/folder items in the response data as xml string.
+        if (fast_xml_parser_1.default.validate(responseData) !== true) {
+            throw new Error('Invalid XML content');
+        }
+        const options = {
+            attributeNamePrefix: '',
+            ignoreAttributes: false,
+            ignoreNameSpace: true,
+            parseAttributeValue: true
+        };
+        const obj = fast_xml_parser_1.default.getTraversalObj(responseData, options);
+        const parsed = fast_xml_parser_1.default.convertToJson(obj, options);
+        let fileNodeArray = [];
+        if (parsed === null || parsed === void 0 ? void 0 : parsed.feed) {
+            if (Array.isArray(parsed.feed.entry)) {
+                fileNodeArray = parsed.feed.entry;
+            }
+            else {
+                fileNodeArray = [parsed.feed.entry];
+            }
+        }
+        return fileNodeArray.map((fileNode) => {
+            const exposedFileNode = {
+                basename: fileNode.title.split('/').pop(),
+                path: fileNode.title.substring(appName.length),
+                type: fileNode.category.term
+            };
+            return exposedFileNode;
+        });
+    }
+}
+exports.FileStoreService = FileStoreService;
+/**
+ * @see AdtService.getAdtCatagory()
+ */
+FileStoreService.adtCategory = {
+    scheme: 'http://www.sap.com/adt/categories/filestore',
+    term: 'filestore-ui5-bsp'
+};
+//# sourceMappingURL=filestore-service.js.map

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

@@ -3,4 +3,5 @@ export { AtoService } from './ato-service';
 export { TransportChecksService } from './transportcheck-service';
 export { TransportRequestService, NewUi5ObjectRequestParams } from './transportrequest-service';
 export { ListPackageService } from './list-package-service';
+export { FileStoreService } from './filestore-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.ListPackageService = exports.TransportRequestService = exports.TransportChecksService = exports.AtoService = exports.AdtService = void 0;
+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");
@@ -11,4 +11,6 @@ var transportrequest_service_1 = require("./transportrequest-service");
 Object.defineProperty(exports, "TransportRequestService", { enumerable: true, get: function () { return transportrequest_service_1.TransportRequestService; } });
 var list_package_service_1 = require("./list-package-service");
 Object.defineProperty(exports, "ListPackageService", { enumerable: true, get: function () { return list_package_service_1.ListPackageService; } });
+var filestore_service_1 = require("./filestore-service");
+Object.defineProperty(exports, "FileStoreService", { enumerable: true, get: function () { return filestore_service_1.FileStoreService; } });
 //# sourceMappingURL=index.js.map

package/dist/abap/index.d.ts

@@ -5,5 +5,5 @@ export { AppIndex, AppIndexService } from './app-index-service';
 export * from './message';
 export * from './catalog';
 export * from './adt-catalog';
-export { TenantType } from './types';
+export { TenantType, ArchiveFileNode } from './types';
 //# sourceMappingURL=index.d.ts.map

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

@@ -8,4 +8,32 @@ export interface PackageInfo {
     type: string;
     name: string;
 }
+/**
+ * This type is used internally for the list of `ArchiveFileNode`
+ * returned from ADT rest api. Each `ArchiveFileNode` provides
+ * metadata information of a file/folder in the archived Fiori app.
+ * It should not be exposed for public use via axios-extension.
+ */
+export interface AdtFileNode {
+    base: string;
+    author: string;
+    category: {
+        term: 'folder' | 'file';
+    };
+    content: {
+        type: string;
+        src: string;
+    };
+    contributor: string;
+    id: string;
+    link: {
+        href: string;
+        ref: 'appindex' | 'self' | 'execute';
+        type?: string;
+    }[];
+    summary: {
+        type: 'text';
+    };
+    title: string;
+}
 //# sourceMappingURL=adt-internal-types.d.ts.map

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

@@ -79,4 +79,23 @@ export interface AtoSettings {
 }
 export type AdtTransportStatus = 'S' | 'E';
 export declare const LocalPackageText: string[];
+export interface ArchiveFileNode {
+    /**
+     * file or folder name only
+     */
+    basename: string;
+    /**
+     * Path to the file or folder. Ready to be passed to the `path`
+     * argument of FileStoreService.getAppArchiveContent() method.
+     *
+     * @see FileStoreService.getAppArchiveContent
+     */
+    path: string;
+    /**
+     * 'file' | 'folder'
+     */
+    type: ArchiveFileNodeType;
+}
+export type ArchiveFileNodeType = 'file' | 'folder';
+export type ArchiveFileContentType<T> = T extends 'file' ? string : T extends 'folder' ? ArchiveFileNode[] : never;
 //# sourceMappingURL=adt-types.d.ts.map

package/dist/auth/connection.js

@@ -42,7 +42,7 @@ class Cookies {
     addCookie(cookieString) {
         var _a;
         const cookie = cookieString.split(';');
-        const [key, ...values] = (_a = cookie[0]) === null || _a === void 0 ? void 0 : _a.split('=');
+        const [key, ...values] = ((_a = cookie[0]) === null || _a === void 0 ? void 0 : _a.split('=')) || [];
         const value = values === null || values === void 0 ? void 0 : values.join('='); // Account for embedded '=' in the value
         if (key && cookieString.indexOf('Max-Age=0') >= 0) {
             delete this.cookies[key];

package/package.json

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