@esri/solutions-components 0.6.36 → 0.6.38

package/dist/cjs/{clean-url-d5326abb.js → restHelpersGet-c94617cf.js}

@@ -5,6 +5,8 @@
  */
 'use strict';
 
+require('./solution-resource-f9e3b289.js');
+
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -566,8 +568,404 @@ function cleanUrl(url) {
     return url;
 }
 
+/** @license
+ * Copyright 2020 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Supplies the File constructor for Microsoft Legacy Edge.
+ *
+ * @param fileBits Contents for file
+ * @param fileName Name for file
+ * @param options Bucket of options, euch as `type` for the MIME type; defaults to empty string for `type`
+ * @returns File or, for Microsoft Legacy Edge, Blob
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/File/File
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Blob/Blob
+ */
+function new_File(fileBits, fileName, options) {
+    let file;
+    try {
+        // Modern browser
+        file = new File(fileBits, fileName, options);
+    }
+    catch (error) {
+        // Microsoft Legacy Edge
+        /* istanbul ignore next */
+        file = (function () {
+            if (typeof options === "undefined") {
+                // Microsoft Legacy Edge fails in karma if options is not defined
+                options = {
+                    type: ""
+                };
+            }
+            const blob = new Blob(fileBits, options);
+            blob.lastModified = new Date();
+            blob.name = fileName;
+            return blob;
+        })();
+    }
+    return file;
+}
+
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Extracts JSON from a Blob.
+ *
+ * @param blob Blob to use as source
+ * @returns A promise that will resolve with JSON or null
+ */
+function blobToJson(blob) {
+    return new Promise(resolve => {
+        blobToText(blob).then(blobContents => {
+            try {
+                resolve(JSON.parse(blobContents));
+            }
+            catch (err) {
+                resolve(null);
+            }
+        }, () => resolve(null));
+    });
+}
+/**
+ * Converts a Blob to a File.
+ *
+ * @param blob Blob to use as source
+ * @param filename Name to use for file
+ * @param mimeType MIME type to override blob's MIME type
+ * @returns File created out of Blob and filename
+ */
+function blobToFile(blob, filename, mimeType) {
+    return blob
+        ? new_File([blob], filename ? filename : "", {
+            type: mimeType || blob.type
+        })
+        : null;
+}
+/**
+ * Extracts text from a Blob.
+ *
+ * @param blob Blob to use as source
+ * @returns A promise that will resolve with text read from blob
+ */
+function blobToText(blob) {
+    return new Promise(resolve => {
+        const reader = new FileReader();
+        reader.onload = function (evt) {
+            // Disable needed because Node requires cast
+            // tslint:disable-next-line: no-unnecessary-type-assertion
+            const blobContents = evt.target.result;
+            resolve(blobContents ? blobContents : ""); // not handling ArrayContents variant
+        };
+        reader.readAsText(blob);
+    });
+}
+/**
+ * Checks that a URL path ends with a slash.
+ *
+ * @param url URL to check
+ * @returns URL, appended with slash if missing
+ */
+function checkUrlPathTermination(url) {
+    return url ? (url.endsWith("/") ? url : url + "/") : url;
+}
+/**
+ * Gets a property out of a deeply nested object.
+ * Does not handle anything but nested object graph
+ *
+ * @param obj Object to retrieve value from
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property
+ *             in obj
+ * @returns Value at end of path
+ */
+function getProp(obj, path) {
+    return path.split(".").reduce(function (prev, curr) {
+        /* istanbul ignore next no need to test undefined scenario */
+        return prev ? prev[curr] : undefined;
+    }, obj);
+}
+/**
+ * Sets a deeply nested property of an object.
+ * Creates the full path if it does not exist.
+ *
+ * @param obj Object to set value of
+ * @param path Path into an object, e.g., "data.values.webmap", where "data" is a top-level property in obj
+ * @param value The value to set at the end of the path
+ */
+function setCreateProp(obj, path, value) {
+    const pathParts = path.split(".");
+    pathParts.reduce((a, b, c) => {
+        if (c === pathParts.length - 1) {
+            a[b] = value;
+            return value;
+        }
+        else {
+            if (!a[b]) {
+                a[b] = {};
+            }
+            return a[b];
+        }
+    }, obj);
+}
+
+/**
+ * Gets a Blob from a web site.
+ *
+ * @param url Address of Blob
+ * @param authentication Credentials for the request
+ * @param requestOptions - Options for the request, including parameters relevant to the endpoint.
+ * @returns Promise that will resolve with Blob or an AGO-style JSON failure response
+ */
+function getBlob(url, authentication, requestOptions = {}) {
+    if (!url) {
+        return Promise.reject("Url must be provided");
+    }
+    const blobRequestOptions = {
+        authentication: authentication,
+        rawResponse: true,
+        ...requestOptions
+    };
+    return request(url, blobRequestOptions).then(response => {
+        return response.blob();
+    });
+}
+
+/** @license
+ * Copyright 2018 Esri
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// ------------------------------------------------------------------------------------------------------------------ //
+const ZIP_FILE_HEADER_SIGNATURE = "PK";
+/**
+ * Gets a Blob from a web site and casts it as a file using the supplied name.
+ *
+ * @param url Address of Blob
+ * @param filename Name to use for file
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with a File, undefined if the Blob is null, or an AGO-style JSON failure response
+ */
+function getBlobAsFile(url, filename, authentication, ignoreErrors = [], mimeType) {
+    return new Promise((resolve, reject) => {
+        // Get the blob from the URL
+        getBlobCheckForError(url, authentication, ignoreErrors).then(blob => !blob ? resolve(null) : resolve(blobToFile(blob, filename, mimeType)), reject);
+    });
+}
+/**
+ * Gets a Blob from a web site and checks for a JSON error packet in the Blob.
+ *
+ * @param url Address of Blob
+ * @param authentication Credentials for the request
+ * @param ignoreErrors List of HTTP error codes that should be ignored
+ * @returns Promise that will resolve with Blob or an AGO-REST JSON failure response
+ */
+function getBlobCheckForError(url, authentication, ignoreErrors = []) {
+    return new Promise((resolve, reject) => {
+        // Get the blob from the URL
+        getBlob(url, authentication).then(blob => {
+            // Reclassify text/plain blobs as needed
+            _fixTextBlobType(blob).then(adjustedBlob => {
+                if (adjustedBlob.type === "application/json") {
+                    // Blob may be an error
+                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+                    blobToJson(adjustedBlob).then((json) => {
+                        // Check for valid JSON with an error
+                        if (json?.error) {
+                            const code = json.error.code;
+                            if (code !== undefined && ignoreErrors.indexOf(code) >= 0) {
+                                resolve(null); // Error, but ignored
+                            }
+                            else {
+                                reject(json); // Other error; fail with error
+                            }
+                        }
+                        else {
+                            resolve(adjustedBlob);
+                        }
+                    });
+                }
+                else {
+                    resolve(adjustedBlob);
+                }
+            }, reject);
+        }, reject);
+    });
+}
+/**
+ * Gets the data information of an AGO item in its JSON form.
+ *
+ * @param itemId Id of an item whose data information is sought
+ * @param filename Name to use for file
+ * @param authentication Credentials for the request to AGO
+ * @returns Promise that will resolve with JSON, or an AGO-style JSON failure response
+ */
+function getItemDataAsJson(itemId, authentication) {
+    return new Promise(resolve => {
+        getItemDataBlob(itemId, authentication).then(blob => resolve(blobToJson(blob)), () => resolve(null));
+    });
+}
+/**
+ * Gets the data information of an AGO item in its raw (Blob) form.
+ *
+ * @param itemId Id of an item whose data information is sought
+ * @param authentication Credentials for the request to AGO
+ * @returns A promise that will resolve with the data Blob or null if the item doesn't have a data section
+ */
+function getItemDataBlob(itemId, authentication) {
+    return new Promise(resolve => {
+        const url = getItemDataBlobUrl(itemId, authentication);
+        getBlobCheckForError(url, authentication, [400, 500]).then(blob => resolve(_fixTextBlobType(blob)), () => resolve(null));
+    });
+}
+/**
+ * Gets the URL to the data information of an AGO item in its raw (Blob) form.
+ *
+ * @param itemId Id of an item whose data information is sought
+ * @param authentication Credentials for the request to AGO
+ * @returns URL string
+ */
+function getItemDataBlobUrl(itemId, authentication) {
+    return `${getPortalSharingUrlFromAuth(authentication)}/content/items/${itemId}/data`;
+}
+/**
+ * Gets a JSON from a web site.
+ *
+ * @param url Address of JSON
+ * @param authentication Credentials for the request
+ * @returns Promise that will resolve with JSON
+ */
+function getJson(url, authentication) {
+    // Get the blob from the URL
+    const requestOptions = { httpMethod: "GET" };
+    return getBlob(url, authentication, requestOptions)
+        .then(blob => {
+        // Reclassify text/plain blobs as needed
+        return _fixTextBlobType(blob);
+    })
+        .then(adjustedBlob => {
+        if (adjustedBlob.type === "application/json") {
+            // Blob may be an error
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            return blobToJson(adjustedBlob);
+        }
+        else {
+            return Promise.resolve(null);
+        }
+    });
+}
+/**
+ * Extracts the portal sharing url from a supplied authentication.
+ *
+ * @param authentication Credentials for the request to AGO
+ * @returns Portal sharing url to be used in API requests, defaulting to `https://www.arcgis.com/sharing/rest`
+ */
+function getPortalSharingUrlFromAuth(authentication) {
+    // If auth was passed, use that portal
+    return getProp(authentication, "portal") || "https://www.arcgis.com/sharing/rest";
+}
+function getThumbnailFile(url, filename, authentication) {
+    return new Promise(resolve => {
+        getBlobAsFile(url, filename, authentication, [500]).then(resolve, () => resolve(null));
+    });
+}
+// ------------------------------------------------------------------------------------------------------------------ //
+/**
+ * Fixes the types of Blobs incorrectly typed as text/plain.
+ *
+ * @param blob Blob to check
+ * @returns Promise resolving to original Blob, unless it's originally typed as text/plain but is
+ * really JSON, ZIP, or XML
+ * @private
+ */
+function _fixTextBlobType(blob) {
+    return new Promise((resolve, reject) => {
+        if (blob &&
+            blob.size > 0 &&
+            (blob.type.startsWith("text/plain") ||
+                blob.type.startsWith("application/json"))) {
+            blobToText(blob).then(blobText => {
+                // Convertible to JSON?
+                try {
+                    JSON.parse(blobText);
+                    // Yes; reclassify as JSON
+                    resolve(new Blob([blob], { type: "application/json" }));
+                }
+                catch (ignored) {
+                    // Nope; test for ZIP file
+                    if (blobText.length > 4 &&
+                        blobText.substr(0, 4) === ZIP_FILE_HEADER_SIGNATURE) {
+                        // Yes; reclassify as ZIP
+                        resolve(new Blob([blob], { type: "application/zip" }));
+                    }
+                    else if (blobText.startsWith("<")) {
+                        // Reclassify as XML; since the blob started out as text/plain, it's more likely that is
+                        // meant to be human-readable, so we'll use text/xml instead of application/xml
+                        resolve(new Blob([blob], { type: "text/xml" }));
+                    }
+                    else {
+                        // Leave as text
+                        resolve(blob);
+                    }
+                }
+            }, 
+            // Faulty blob
+            reject);
+        }
+        else {
+            // Empty or not typed as plain text, so simply return
+            if (blob) {
+                resolve(blob);
+            }
+            else {
+                reject();
+            }
+        }
+    });
+}
+
 exports.ArcGISAuthError = ArcGISAuthError;
 exports.NODEJS_DEFAULT_REFERER_HEADER = NODEJS_DEFAULT_REFERER_HEADER;
+exports.blobToFile = blobToFile;
+exports.checkUrlPathTermination = checkUrlPathTermination;
 exports.cleanUrl = cleanUrl;
 exports.encodeQueryString = encodeQueryString;
+exports.getItemDataAsJson = getItemDataAsJson;
+exports.getJson = getJson;
+exports.getProp = getProp;
+exports.getThumbnailFile = getThumbnailFile;
 exports.request = request;
+exports.setCreateProp = setCreateProp;