@esri/hub-common 9.13.2 → 9.14.0

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.13.1 - Sat Jan 22 2022 18:07:51 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.13.2 - Tue Jan 25 2022 00:14:10 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -4976,6 +4976,52 @@
         return content.replace("(", "<br/>(");
     }
 
+    /**
+     * Cross-walk from a portalUrl to the corresponding Hub API Url
+     *
+     * If the passed url is not recognized, then this will return `undefined`
+     * @param portalUrl
+     * @returns
+     */
+    function getHubApiFromPortalUrl(portalUrl) {
+        var result;
+        if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
+            result = "https://hubqa.arcgis.com";
+        }
+        else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
+            result = "https://hubdev.arcgis.com";
+        }
+        else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
+            result = "https://hub.arcgis.com";
+        }
+        return result;
+    }
+
+    /**
+     * Given an org url, get the portal base url
+     *
+     * i.e. https://myorg.maps.arcgis.com will return https://www.arcgis.com
+     *
+     * @param orgUrl
+     * @returns
+     */
+    function getPortalBaseFromOrgUrl(orgUrl) {
+        var result = orgUrl;
+        if (orgUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
+            result = "https://qaext.arcgis.com";
+        }
+        else if (orgUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
+            result = "https://devext.arcgis.com";
+        }
+        else {
+            /* istanbul ignore else */
+            if (orgUrl.match(/(www|\.maps)\.arcgis.com/)) {
+                result = "https://www.arcgis.com";
+            }
+        }
+        return result;
+    }
+
     var MAP_OR_FEATURE_SERVER_URL_REGEX = /\/(map|feature)server/i;
     /**
      *
@@ -8793,7 +8839,7 @@
      * Construct a the full url to a group thumbnail
      *
      * - If the group has a thumbnail, construct the full url
-     * - If the group is not public, append on the token
+     * - If the group is not public, append on the token (if passed in)
      * @param portalUrl
      * @param group
      * @param token
@@ -9524,12 +9570,11 @@
             return __generator(this, function (_b) {
                 expanded = expandContentFilter(filter);
                 api = expandApi(options.api || "arcgis");
-                // map over the apis, depending on the type we issue the queries
-                // const searchPromises = apis.map((api) => {
                 // Portal Search
                 if (api.type === "arcgis") {
                     so = serializeContentFilterForPortal(expanded);
-                    // pass auth forward
+                    // if we have auth, pass it forward
+                    // otherwise set the portal property
                     if (options.authentication) {
                         so.authentication = options.authentication;
                     }
@@ -9542,7 +9587,6 @@
                         so.countSize = 200;
                     }
                     // copy over various options
-                    // TODO: Dry this up - typscript makes this... inconvenient
                     if (options.num) {
                         so.num = options.num;
                     }
@@ -9569,8 +9613,6 @@
                         },
                     });
                 }
-                // });
-                // return for results
                 return [2 /*return*/, searchPromise];
             });
         });
@@ -9584,14 +9626,29 @@
      * @returns
      */
     function searchPortal(searchOptions) {
+        var _a;
+        var portalUrl = ((_a = searchOptions.authentication) === null || _a === void 0 ? void 0 : _a.portal) || searchOptions.portal;
+        var token;
+        if (searchOptions.authentication) {
+            var us = searchOptions.authentication;
+            token = us.token;
+        }
+        var thumbnailify = function (content) {
+            content.thumbnailUrl = getItemThumbnailUrl(content, portalUrl, token);
+            return content;
+        };
         return searchItems(searchOptions).then(function (resp) {
             var hasNext = resp.nextStart > -1;
+            // convert items to IHubContent's
             var content = resp.results.map(itemToContent);
+            // if we have a site, add those urls
             if (searchOptions.site) {
                 content = content.map(function (entry) {
                     return setContentSiteUrls(entry, searchOptions.site);
                 });
             }
+            // add thumbnailUrl
+            content = content.map(thumbnailify);
             // convert aggregations into facets
             var facets = convertPortalResponseToFacets(resp);
             return {
@@ -9613,10 +9670,9 @@
      * @returns
      */
     function _searchGroups(filter, options) {
-        var _a;
         return __awaiter(this, void 0, void 0, function () {
             var expanded, api, so;
-            return __generator(this, function (_b) {
+            return __generator(this, function (_a) {
                 expanded = expandGroupFilter(filter);
                 api = expandApi(options.api || "arcgis");
                 if (api.type === "arcgis") {
@@ -9629,7 +9685,6 @@
                     else {
                         so.portal = api.url + "/sharing/rest";
                     }
-                    // TODO: Dry this up - typscript makes this... inconvenient
                     if (options.num) {
                         so.num = options.num;
                     }
@@ -9639,10 +9694,6 @@
                     if (options.sortOrder) {
                         so.sortOrder = options.sortOrder;
                     }
-                    api.url + "/sharing/rest";
-                    if ((_a = so.authentication) === null || _a === void 0 ? void 0 : _a.portal) {
-                        so.authentication.portal;
-                    }
                     if (options.site) {
                         so.site = cloneObject$1(options.site);
                     }
@@ -9665,8 +9716,7 @@
             group.siteTeamUrl = searchOptions.site.item.url + "/teams/" + group.id + "/about";
             return group;
         };
-        var portalUrl = ((_a = searchOptions.authentication) === null || _a === void 0 ? void 0 : _a.portal) ||
-            "https://www.arcgis.com/sharing/rest";
+        var portalUrl = ((_a = searchOptions.authentication) === null || _a === void 0 ? void 0 : _a.portal) || searchOptions.portal;
         var token;
         if (searchOptions.authentication) {
             var us = searchOptions.authentication;
@@ -10733,14 +10783,19 @@
         discussions: "/api/discussions/v1",
     };
     /**
-     * @internal
+     * ArcGISContext
+     *
+     * Abstraction that holds a UserSession, along with
+     * getters to streamline access to various platform
+     * urls, and common constructs like IRequestOptions
+     *
      * Thin class just used to enable getters
      *
      * This class should not be used by anything other than
-     * the ArcGISContext class
+     * the ArcGISContextManager class
      */
-    var ArcGISContextState = /** @class */ (function () {
-        function ArcGISContextState(opts) {
+    var ArcGISContext = /** @class */ (function () {
+        function ArcGISContext(opts) {
             this._portalUrl = "https://www.arcgis.com";
             this.id = opts.id;
             this._portalUrl = opts.portalUrl;
@@ -10755,7 +10810,7 @@
                 this._currentUser = opts.currentUser;
             }
         }
-        Object.defineProperty(ArcGISContextState.prototype, "session", {
+        Object.defineProperty(ArcGISContext.prototype, "session", {
             /**
              * Return the UserSession if authenticated
              */
@@ -10765,7 +10820,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "isAuthenticated", {
+        Object.defineProperty(ArcGISContext.prototype, "isAuthenticated", {
             /**
              * Return boolean indicating if authenticatio is present
              */
@@ -10775,7 +10830,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "userRequestOptions", {
+        Object.defineProperty(ArcGISContext.prototype, "userRequestOptions", {
             /**
              * Return `IUserRequestOptions`, which is used for REST-JS
              * functions which require authentication information.
@@ -10793,7 +10848,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "requestOptions", {
+        Object.defineProperty(ArcGISContext.prototype, "requestOptions", {
             /**
              * Return `IRequestOptions`, which is used by REST-JS functions
              * which *may* use authentication information if provided.
@@ -10817,7 +10872,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "hubRequestOptions", {
+        Object.defineProperty(ArcGISContext.prototype, "hubRequestOptions", {
             /**
              * Return a `IHubRequestOptions` object
              */
@@ -10833,10 +10888,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "portalUrl", {
-            // ==============================
-            // Getters / Computed Properties
-            // ==============================
+        Object.defineProperty(ArcGISContext.prototype, "portalUrl", {
             /**
              * Return the portal url.
              *
@@ -10862,7 +10914,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "sharingApiUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "sharingApiUrl", {
             /**
              * Returns the url to the sharing api
              * i.e. https://myorg.maps.arcgis.com/sharing/rest
@@ -10873,14 +10925,14 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "hubUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "hubUrl", {
             get: function () {
                 return this._hubUrl;
             },
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "isPortal", {
+        Object.defineProperty(ArcGISContext.prototype, "isPortal", {
             /**
              * Returns boolean indicating if the backing system
              * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
@@ -10893,7 +10945,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "discussionsServiceUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "discussionsServiceUrl", {
             // Hub APIs
             // ----------
             // Discussions
@@ -10905,7 +10957,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "hubSearchServiceUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "hubSearchServiceUrl", {
             // Hub Search
             get: function () {
                 if (this._hubUrl) {
@@ -10915,7 +10967,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "domainServiceUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "domainServiceUrl", {
             // Domain
             get: function () {
                 if (this._hubUrl) {
@@ -10925,7 +10977,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "eventsConfig", {
+        Object.defineProperty(ArcGISContext.prototype, "eventsConfig", {
             // Events
             // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
             get: function () {
@@ -10936,7 +10988,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "hubEnabled", {
+        Object.defineProperty(ArcGISContext.prototype, "hubEnabled", {
             /**
              * Returns boolean indicating if the current user
              * belongs to an organization that has licensed
@@ -10948,7 +11000,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "communityOrgId", {
+        Object.defineProperty(ArcGISContext.prototype, "communityOrgId", {
             /**
              * Return Hub Community Org Id, if defined
              */
@@ -10960,7 +11012,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "communityOrgHostname", {
+        Object.defineProperty(ArcGISContext.prototype, "communityOrgHostname", {
             get: function () {
                 if (this._portalSelf) {
                     return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
@@ -10969,7 +11021,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "communityOrgUrl", {
+        Object.defineProperty(ArcGISContext.prototype, "communityOrgUrl", {
             get: function () {
                 if (this.communityOrgHostname) {
                     return "https://" + this.communityOrgHostname;
@@ -10978,7 +11030,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "helperServices", {
+        Object.defineProperty(ArcGISContext.prototype, "helperServices", {
             // Platform API service urls are all in helperServices
             // and not consistent to expose as urls
             get: function () {
@@ -10989,50 +11041,55 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "currentUser", {
+        Object.defineProperty(ArcGISContext.prototype, "currentUser", {
             get: function () {
                 return this._currentUser;
             },
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContextState.prototype, "portal", {
+        Object.defineProperty(ArcGISContext.prototype, "portal", {
             get: function () {
                 return this._portalSelf;
             },
             enumerable: false,
             configurable: true
         });
-        return ArcGISContextState;
+        return ArcGISContext;
     }());
 
     /**
-     * Application Context Object
+     * ArcGIS Context Manager
+     *
+     * The manager exposes context (`IArcGISContext`), which combines a `UserSession` with
+     * the `portal/self` and `user/self` responses to provide a central lookup for platform
+     * information, api urls, and other useful properties for developers such as IRequestOptions
+     * IUserRequestOptions, IHubRequestOptions etc.
      *
-     * Abstraction that combines a `UserSession` with
-     * the `portal/self` and `user/self` responses to
-     * provide a central lookup of platform information.
+     * The context is exposed on gthe `.context` property, and as the authentication changes
+     * the `.context` is re-created. This is done to allow web frameworks to watch for
+     * changes on that single property, instead of having to leverage observers or events
+     * for change detection.
      *
      * This is a work-in-progress, and will likely expand over time.
      *
-     * `ArcGISContext` is used in conjuction with the `arcgis-app-identity`
-     * component to orchestrate oAuth.
      */
-    var ArcGISContext = /** @class */ (function () {
+    var ArcGISContextManager = /** @class */ (function () {
         /**
-         * Private constructor. Use `ArcGISContext.create(...)` to
+         * Private constructor. Use `ArcGISContextManager.create(...)` to
          * instantiate an instance
          * @param opts
          */
-        function ArcGISContext(opts) {
+        function ArcGISContextManager(opts) {
             this._portalUrl = "https://www.arcgis.com";
-            this._debug = false;
+            this._logLevel = exports.Level.error;
             // Having a unique id makes debugging easier
             this.id = new Date().getTime();
-            if (opts.debug) {
-                this._debug = opts.debug;
+            if (opts.logLevel) {
+                this._logLevel = opts.logLevel;
             }
-            this.log("ArcGISContext:ctor: Creating " + this.id);
+            Logger.setLogLevel(this._logLevel);
+            Logger.debug("ArcGISContextManager:ctor: Creating " + this.id);
             if (opts.authentication) {
                 this._authentication = opts.authentication;
                 this._portalUrl = this._authentication.portal.replace("/sharing/rest", "");
@@ -11057,14 +11114,14 @@
          * @param opts
          * @returns
          */
-        ArcGISContext.create = function (opts) {
+        ArcGISContextManager.create = function (opts) {
             if (opts === void 0) { opts = {}; }
             return __awaiter(this, void 0, void 0, function () {
                 var ctx;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
-                            ctx = new ArcGISContext(opts);
+                            ctx = new ArcGISContextManager(opts);
                             return [4 /*yield*/, ctx.initialize()];
                         case 1:
                             _a.sent();
@@ -11079,7 +11136,7 @@
          * application.
          * @param auth
          */
-        ArcGISContext.prototype.setAuthentication = function (auth) {
+        ArcGISContextManager.prototype.setAuthentication = function (auth) {
             return __awaiter(this, void 0, void 0, function () {
                 return __generator(this, function (_a) {
                     switch (_a.label) {
@@ -11099,23 +11156,23 @@
          * called when a user signs out of an application, but
          * the application continues running
          */
-        ArcGISContext.prototype.clearAuthentication = function () {
+        ArcGISContextManager.prototype.clearAuthentication = function () {
             // Reset the portalUrl from the org url to the base url
             // for ArcGIS Enterprise, we just leave the _portalUrl as-is
-            if (!this._state.isPortal) {
+            if (!this._context.isPortal) {
                 this._portalUrl = getPortalBaseFromOrgUrl(this._portalUrl);
             }
             // Clear the auth, portalSelf and currentUser props
             this._authentication = null;
             this._portalSelf = null;
             this._currentUser = null;
-            this._state = new ArcGISContextState({
+            this._context = new ArcGISContext({
                 id: this.id,
                 portalUrl: this._portalUrl,
                 hubUrl: this._hubUrl,
             });
         };
-        Object.defineProperty(ArcGISContext.prototype, "state", {
+        Object.defineProperty(ArcGISContextManager.prototype, "context", {
             /**
              * Return a reference to the current state.
              * When `.setAuthentication()` or `.clearAuthenentication()` are
@@ -11123,34 +11180,23 @@
              * like React or Ember can detect changes.
              */
             get: function () {
-                return this._state;
+                return this._context;
             },
             enumerable: false,
             configurable: true
         });
-        /**
-         * @internal
-         * Log debugging messages to the console
-         * @param message
-         */
-        ArcGISContext.prototype.log = function (message) {
-            if (this._debug) {
-                // tslint:disable-next-line:no-console
-                console.info(message);
-            }
-        };
         /**
          * If we have a UserSession, fetch portal/self and
          * store that along with current user
          */
-        ArcGISContext.prototype.initialize = function () {
+        ArcGISContextManager.prototype.initialize = function () {
             return __awaiter(this, void 0, void 0, function () {
                 var username, requests, _a, portal, user, ex_1, msg;
                 return __generator(this, function (_b) {
                     switch (_b.label) {
                         case 0:
                             if (!(this._authentication && (!this._portalSelf || !this._currentUser))) return [3 /*break*/, 4];
-                            this.log("ArcGISContext-" + this.id + ": Initializing");
+                            Logger.debug("ArcGISContextManager-" + this.id + ": Initializing");
                             username = this._authentication.username;
                             requests = [
                                 getSelf({ authentication: this._authentication }),
@@ -11164,80 +11210,50 @@
                             _a = _b.sent(), portal = _a[0], user = _a[1];
                             this._portalSelf = portal;
                             this._currentUser = user;
+                            Logger.debug("ArcGISContextManager-" + this.id + ": received portalSelf and currentUser");
                             return [3 /*break*/, 4];
                         case 3:
                             ex_1 = _b.sent();
-                            msg = "ArcGISContext could not fetch portal & user for \"" + this._authentication.username + "\" using " + this._authentication.portal + ".";
+                            msg = "ArcGISContextManager could not fetch portal & user for \"" + this._authentication.username + "\" using " + this._authentication.portal + ".";
+                            Logger.error(msg);
                             // tslint:disable-next-line:no-console
                             console.error(msg);
                             throw ex_1;
                         case 4:
-                            // update the state
-                            this._state = new ArcGISContextState(this.stateOpts);
+                            Logger.debug("ArcGISContextManager-" + this.id + ": updating context");
+                            // update the context
+                            this._context = new ArcGISContext(this.contextOpts);
                             return [2 /*return*/];
                     }
                 });
             });
         };
-        Object.defineProperty(ArcGISContext.prototype, "stateOpts", {
+        Object.defineProperty(ArcGISContextManager.prototype, "contextOpts", {
+            /**
+             * Getter to streamline the creation of updated Context instances
+             */
             get: function () {
-                var stateOpts = {
+                var contextOpts = {
                     id: this.id,
                     portalUrl: this._portalUrl,
                     hubUrl: this._hubUrl,
                 };
                 if (this._authentication) {
-                    stateOpts.authentication = this._authentication;
+                    contextOpts.authentication = this._authentication;
                 }
                 if (this._portalSelf) {
-                    stateOpts.portalSelf = this._portalSelf;
+                    contextOpts.portalSelf = this._portalSelf;
                 }
                 if (this._currentUser) {
-                    stateOpts.currentUser = this._currentUser;
+                    contextOpts.currentUser = this._currentUser;
                 }
-                return stateOpts;
+                return contextOpts;
             },
             enumerable: false,
             configurable: true
         });
-        return ArcGISContext;
+        return ArcGISContextManager;
     }());
-    /**
-     * Cross-walk from a portalUrl to the corresponding Hub.
-     *
-     * If the passed url is not recognized, then this will return `undefined`
-     * @param portalUrl
-     * @returns
-     */
-    function getHubApiFromPortalUrl(portalUrl) {
-        var result;
-        if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-            result = "https://hubqa.arcgis.com";
-        }
-        else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-            result = "https://hubdev.arcgis.com";
-        }
-        else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
-            result = "https://hub.arcgis.com";
-        }
-        return result;
-    }
-    function getPortalBaseFromOrgUrl(orgUrl) {
-        var result;
-        if (orgUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-            result = "https://qaext.arcgis.com";
-        }
-        else if (orgUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-            result = "https://devext.arcgis.com";
-        }
-        else {
-            /* istanbul ignore else */
-            if (orgUrl.match(/(www|\.maps)\.arcgis.com/)) {
-                result = "https://www.arcgis.com";
-            }
-        }
-        return result;
-    }
 
     /* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
      * Apache-2.0 */
@@ -11499,6 +11515,7 @@
     }
 
     exports.ArcGISContext = ArcGISContext;
+    exports.ArcGISContextManager = ArcGISContextManager;
     exports.GLOBAL_EXTENT = GLOBAL_EXTENT;
     exports.HUB_CDN_URLMAP = HUB_CDN_URLMAP;
     exports.HUB_LOCALES = HUB_LOCALES;
@@ -11627,6 +11644,7 @@
     exports.getFamily = getFamily;
     exports.getGeographicOrgExtent = getGeographicOrgExtent;
     exports.getGroupThumbnailUrl = getGroupThumbnailUrl;
+    exports.getHubApiFromPortalUrl = getHubApiFromPortalUrl;
     exports.getHubApiUrl = getHubApiUrl;
     exports.getHubApiUrlFromPortal = getHubApiUrlFromPortal;
     exports.getHubLocaleAssetUrl = getHubLocaleAssetUrl;
@@ -11647,6 +11665,7 @@
     exports.getNextFunction = getNextFunction;
     exports.getOrgExtentAsBBox = getOrgExtentAsBBox;
     exports.getPortalApiUrl = getPortalApiUrl;
+    exports.getPortalBaseFromOrgUrl = getPortalBaseFromOrgUrl;
     exports.getPortalUrl = getPortalUrl;
     exports.getProp = getProp;
     exports.getProps = getProps;