@esri/hub-common 9.25.5 → 9.26.0

package/dist/es2017/resources/validate-url.js

@@ -0,0 +1,86 @@
+import { ItemType } from "../types";
+import { Logger } from "../utils";
+import { isUrl, isFeatureService, isService, pingFeatureService, pingUrl, detectDataTypeFromHeader, getFileName, detectDataTypeFromExtension, shouldHaveDataUrl, } from "./_internal/_validate-url-helpers";
+/**
+ * Takes in a URL and validates it based on valid url, type of item, etc
+ *
+ * @export
+ * @param {string} url
+ * @return {*}  {Promise<any>}
+ */
+export async function validateUrl(url) {
+    // If URL doesn't pass then exit out immediately.
+    if (!isUrl(url)) {
+        return {
+            pass: false,
+            error: "invalidFormat",
+        };
+    }
+    // Check if it's a FS, Map service, or image service
+    const isFeatureServiceUrl = isFeatureService(url);
+    const isServiceUrl = isService(url);
+    if (isServiceUrl && !isFeatureServiceUrl) {
+        return {
+            pass: false,
+            error: "invalidFormat",
+        };
+    }
+    // Content type which can be determined bby the url file extnesion or the request response header
+    let type;
+    let item;
+    let pingResult = {};
+    try {
+        pingResult = isFeatureServiceUrl
+            ? await pingFeatureService(url)
+            : await pingUrl(url);
+        // return an error if the response is not okay
+        if (!pingResult.ok) {
+            return {
+                pass: false,
+                error: "invalidUrl",
+            };
+        }
+    }
+    catch (e) {
+        // TODO: This is tricky. The fetch() API rejects when a network error
+        // happens. This error can be a CORS error, or a 404 error, or a timeout
+        // error. While an error like 404 does suggest a bad URL, the CORS occurs
+        // because this is a front-end request and the file is likely accessible by
+        // the server. Unfortunately, the error doesn't have any information about
+        // underline failure type. For now, the network failure is ignored, so the
+        // user can paste a URL from any domain and avoid the CORS issue.
+        Logger.error(`error requesting url`);
+    }
+    // Use the metadata from the ping response if exists, otherwise guess the file
+    // name from the URL
+    if (pingResult.item) {
+        item = pingResult.item;
+    }
+    else {
+        item = { title: getFileName(url), url };
+    }
+    if (pingResult.headers) {
+        type = detectDataTypeFromHeader(pingResult.headers);
+    }
+    if (isFeatureServiceUrl) {
+        type = ItemType["Feature Service"];
+    }
+    else if (!type) {
+        // Guess the data type from the extension
+        type = detectDataTypeFromExtension(url);
+    }
+    if (type) {
+        item.type = type;
+    }
+    if (item.type && shouldHaveDataUrl(item.type)) {
+        item.dataUrl = item.url;
+    }
+    return {
+        pass: true,
+        // The type may or may not be true
+        type,
+        // fetched / calculated item
+        item,
+    };
+}
+//# sourceMappingURL=validate-url.js.map

package/dist/es2017/resources/validate-url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-url.js","sourceRoot":"","sources":["../../../src/resources/validate-url.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EACL,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,kBAAkB,EAClB,OAAO,EACP,wBAAwB,EACxB,WAAW,EACX,2BAA2B,EAC3B,iBAAiB,GAClB,MAAM,mCAAmC,CAAC;AAE3C;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAW;IAC3C,iDAAiD;IACjD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACf,OAAO;YACL,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,eAAe;SACvB,CAAC;KACH;IAED,oDAAoD;IACpD,MAAM,mBAAmB,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,YAAY,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAEpC,IAAI,YAAY,IAAI,CAAC,mBAAmB,EAAE;QACxC,OAAO;YACL,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,eAAe;SACvB,CAAC;KACH;IAED,iGAAiG;IACjG,IAAI,IAAI,CAAC;IAET,IAAI,IAAI,CAAC;IAET,IAAI,UAAU,GAA4D,EAAE,CAAC;IAE7E,IAAI;QACF,UAAU,GAAG,mBAAmB;YAC9B,CAAC,CAAC,MAAM,kBAAkB,CAAC,GAAG,CAAC;YAC/B,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;QAEvB,8CAA8C;QAC9C,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE;YAClB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,YAAY;aACpB,CAAC;SACH;KACF;IAAC,OAAO,CAAC,EAAE;QACV,qEAAqE;QACrE,wEAAwE;QACxE,yEAAyE;QACzE,2EAA2E;QAC3E,0EAA0E;QAC1E,0EAA0E;QAC1E,iEAAiE;QACjE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;KACtC;IACD,8EAA8E;IAC9E,oBAAoB;IACpB,IAAI,UAAU,CAAC,IAAI,EAAE;QACnB,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;KACxB;SAAM;QACL,IAAI,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;KACzC;IAED,IAAI,UAAU,CAAC,OAAO,EAAE;QACtB,IAAI,GAAG,wBAAwB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,IAAI,mBAAmB,EAAE;QACvB,IAAI,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAC;KACpC;SAAM,IAAI,CAAC,IAAI,EAAE;QAChB,yCAAyC;QACzC,IAAI,GAAG,2BAA2B,CAAC,GAAG,CAAC,CAAC;KACzC;IAED,IAAI,IAAI,EAAE;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;KAClB;IAED,IAAI,IAAI,CAAC,IAAI,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC;KACzB;IAED,OAAO;QACL,IAAI,EAAE,IAAI;QACV,kCAAkC;QAClC,IAAI;QACJ,4BAA4B;QAC5B,IAAI;KACL,CAAC;AACJ,CAAC"}