@esri/hub-common 9.13.0 → 9.13.1

package/dist/umd/common.umd.js

@@ -1,5 +1,5 @@
 /* @preserve
- * @esri/hub-common - v9.12.0 - Thu Jan 20 2022 20:07:02 GMT+0000 (Coordinated Universal Time)
+ * @esri/hub-common - v9.13.0 - Fri Jan 21 2022 23:22:52 GMT+0000 (Coordinated Universal Time)
  * Copyright (c) 2022 Environmental Systems Research Institute, Inc.
  * Apache-2.0
  */
@@ -10733,117 +10733,29 @@
         discussions: "/api/discussions/v1",
     };
     /**
-     * Application Context Object
-     *
-     * Abstraction that combines a `UserSession` with
-     * the `portal/self` and `user/self` responses to
-     * provide a central lookup of platform information.
-     *
-     * This is a work-in-progress, and will likely expand over time.
+     * @internal
+     * Thin class just used to enable getters
      *
-     * `ArcGISContext` is used in conjuction with the `arcgis-app-identity`
-     * component to orchestrate oAuth.
+     * This class should not be used by anything other than
+     * the ArcGISContext class
      */
-    var ArcGISContext = /** @class */ (function () {
-        /**
-         * Private constructor. Use `ArcGISContext.create(...)` to
-         * instantiate an instance
-         * @param opts
-         */
-        function ArcGISContext(opts) {
+    var ArcGISContextState = /** @class */ (function () {
+        function ArcGISContextState(opts) {
             this._portalUrl = "https://www.arcgis.com";
-            this._debug = false;
-            // Having a unique id makes debugging easier
-            this.id = new Date().getTime();
-            if (opts.debug) {
-                this._debug = opts.debug;
-            }
-            this.log("ArcGISContext:ctor: Creating " + this.id);
+            this.id = opts.id;
+            this._portalUrl = opts.portalUrl;
+            this._hubUrl = opts.hubUrl;
             if (opts.authentication) {
                 this._authentication = opts.authentication;
-                this._portalUrl = this._authentication.portal.replace("/sharing/rest", "");
-                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
             }
-            else if (opts.portalUrl) {
-                this._portalUrl = opts.portalUrl;
-                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
+            if (opts.portalSelf) {
+                this._portalSelf = opts.portalSelf;
             }
-            else {
-                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
+            if (opts.currentUser) {
+                this._currentUser = opts.currentUser;
             }
         }
-        /**
-         * Static async Factory
-         * @param opts
-         * @returns
-         */
-        ArcGISContext.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);
-                            return [4 /*yield*/, ctx.initialize()];
-                        case 1:
-                            _a.sent();
-                            return [2 /*return*/, ctx];
-                    }
-                });
-            });
-        };
-        /**
-         * If we have a UserSession, fetch portal/self and
-         * store that along with current user
-         */
-        ArcGISContext.prototype.initialize = function () {
-            return __awaiter(this, void 0, void 0, function () {
-                var ps;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            if (!this._authentication) return [3 /*break*/, 2];
-                            this.log("ArcGISContext-" + this.id + ": Initializing");
-                            return [4 /*yield*/, getSelf({ authentication: this._authentication })];
-                        case 1:
-                            ps = _a.sent();
-                            this._portalSelf = ps;
-                            this._currentUser = ps.user;
-                            _a.label = 2;
-                        case 2: return [2 /*return*/];
-                    }
-                });
-            });
-        };
-        // Set authentication after the instance is up and running
-        ArcGISContext.prototype.setAuthentication = function (auth) {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0:
-                            this._authentication = auth;
-                            this._portalUrl = auth.portal.replace("/sharing/rest", "");
-                            return [4 /*yield*/, this.initialize()];
-                        case 1:
-                            _a.sent();
-                            return [2 /*return*/];
-                    }
-                });
-            });
-        };
-        /**
-         * @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);
-            }
-        };
-        Object.defineProperty(ArcGISContext.prototype, "session", {
+        Object.defineProperty(ArcGISContextState.prototype, "session", {
             /**
              * Return the UserSession if authenticated
              */
@@ -10853,7 +10765,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "isAuthenticated", {
+        Object.defineProperty(ArcGISContextState.prototype, "isAuthenticated", {
             /**
              * Return boolean indicating if authenticatio is present
              */
@@ -10863,7 +10775,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "userRequestOptions", {
+        Object.defineProperty(ArcGISContextState.prototype, "userRequestOptions", {
             /**
              * Return `IUserRequestOptions`, which is used for REST-JS
              * functions which require authentication information.
@@ -10881,7 +10793,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "requestOptions", {
+        Object.defineProperty(ArcGISContextState.prototype, "requestOptions", {
             /**
              * Return `IRequestOptions`, which is used by REST-JS functions
              * which *may* use authentication information if provided.
@@ -10905,7 +10817,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "hubRequestOptions", {
+        Object.defineProperty(ArcGISContextState.prototype, "hubRequestOptions", {
             /**
              * Return a `IHubRequestOptions` object
              */
@@ -10921,7 +10833,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "portalUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "portalUrl", {
             // ==============================
             // Getters / Computed Properties
             // ==============================
@@ -10950,7 +10862,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "sharingApiUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "sharingApiUrl", {
             /**
              * Returns the url to the sharing api
              * i.e. https://myorg.maps.arcgis.com/sharing/rest
@@ -10961,14 +10873,14 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "hubUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "hubUrl", {
             get: function () {
                 return this._hubUrl;
             },
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "isPortal", {
+        Object.defineProperty(ArcGISContextState.prototype, "isPortal", {
             /**
              * Returns boolean indicating if the backing system
              * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
@@ -10981,7 +10893,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "discussionsServiceUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "discussionsServiceUrl", {
             // Hub APIs
             // ----------
             // Discussions
@@ -10993,7 +10905,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "hubSearchServiceUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "hubSearchServiceUrl", {
             // Hub Search
             get: function () {
                 if (this._hubUrl) {
@@ -11003,7 +10915,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "domainServiceUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "domainServiceUrl", {
             // Domain
             get: function () {
                 if (this._hubUrl) {
@@ -11013,7 +10925,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "eventsConfig", {
+        Object.defineProperty(ArcGISContextState.prototype, "eventsConfig", {
             // Events
             // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
             get: function () {
@@ -11024,7 +10936,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "hubEnabled", {
+        Object.defineProperty(ArcGISContextState.prototype, "hubEnabled", {
             /**
              * Returns boolean indicating if the current user
              * belongs to an organization that has licensed
@@ -11036,7 +10948,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "communityOrgId", {
+        Object.defineProperty(ArcGISContextState.prototype, "communityOrgId", {
             /**
              * Return Hub Community Org Id, if defined
              */
@@ -11048,7 +10960,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "communityOrgHostname", {
+        Object.defineProperty(ArcGISContextState.prototype, "communityOrgHostname", {
             get: function () {
                 if (this._portalSelf) {
                     return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
@@ -11057,7 +10969,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "communityOrgUrl", {
+        Object.defineProperty(ArcGISContextState.prototype, "communityOrgUrl", {
             get: function () {
                 if (this.communityOrgHostname) {
                     return "https://" + this.communityOrgHostname;
@@ -11066,7 +10978,7 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "helperServices", {
+        Object.defineProperty(ArcGISContextState.prototype, "helperServices", {
             // Platform API service urls are all in helperServices
             // and not consistent to expose as urls
             get: function () {
@@ -11077,20 +10989,189 @@
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "currentUser", {
+        Object.defineProperty(ArcGISContextState.prototype, "currentUser", {
             get: function () {
                 return this._currentUser;
             },
             enumerable: false,
             configurable: true
         });
-        Object.defineProperty(ArcGISContext.prototype, "portal", {
+        Object.defineProperty(ArcGISContextState.prototype, "portal", {
             get: function () {
                 return this._portalSelf;
             },
             enumerable: false,
             configurable: true
         });
+        return ArcGISContextState;
+    }());
+
+    /**
+     * Application Context Object
+     *
+     * Abstraction that combines a `UserSession` with
+     * the `portal/self` and `user/self` responses to
+     * provide a central lookup of platform information.
+     *
+     * 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 () {
+        /**
+         * Private constructor. Use `ArcGISContext.create(...)` to
+         * instantiate an instance
+         * @param opts
+         */
+        function ArcGISContext(opts) {
+            this._portalUrl = "https://www.arcgis.com";
+            this._debug = false;
+            // Having a unique id makes debugging easier
+            this.id = new Date().getTime();
+            if (opts.debug) {
+                this._debug = opts.debug;
+            }
+            this.log("ArcGISContext:ctor: Creating " + this.id);
+            if (opts.authentication) {
+                this._authentication = opts.authentication;
+                this._portalUrl = this._authentication.portal.replace("/sharing/rest", "");
+                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
+            }
+            else if (opts.portalUrl) {
+                this._portalUrl = opts.portalUrl;
+                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
+            }
+            else {
+                this._hubUrl = getHubApiFromPortalUrl(this._portalUrl);
+            }
+        }
+        /**
+         * Static async Factory
+         * @param opts
+         * @returns
+         */
+        ArcGISContext.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);
+                            return [4 /*yield*/, ctx.initialize()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/, ctx];
+                    }
+                });
+            });
+        };
+        /**
+         * If we have a UserSession, fetch portal/self and
+         * store that along with current user
+         */
+        ArcGISContext.prototype.initialize = function () {
+            return __awaiter(this, void 0, void 0, function () {
+                var stateOpts, ps;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            stateOpts = {
+                                id: this.id,
+                                portalUrl: this._portalUrl,
+                                hubUrl: this._hubUrl,
+                            };
+                            if (!this._authentication) return [3 /*break*/, 2];
+                            this.log("ArcGISContext-" + this.id + ": Initializing");
+                            return [4 /*yield*/, getSelf({ authentication: this._authentication })];
+                        case 1:
+                            ps = _a.sent();
+                            this._portalSelf = ps;
+                            this._currentUser = ps.user;
+                            stateOpts = {
+                                id: this.id,
+                                portalUrl: this._portalUrl,
+                                hubUrl: this._hubUrl,
+                                portalSelf: this._portalSelf,
+                                currentUser: this._currentUser,
+                                authentication: this._authentication,
+                            };
+                            _a.label = 2;
+                        case 2:
+                            // update the state
+                            this._state = new ArcGISContextState(stateOpts);
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
+        /**
+         * Set the Authentication (UserSession) for the context.
+         * This should be called when a user signs into a running
+         * application.
+         * @param auth
+         */
+        ArcGISContext.prototype.setAuthentication = function (auth) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            this._authentication = auth;
+                            this._portalUrl = auth.portal.replace("/sharing/rest", "");
+                            return [4 /*yield*/, this.initialize()];
+                        case 1:
+                            _a.sent();
+                            return [2 /*return*/];
+                    }
+                });
+            });
+        };
+        /**
+         * Clear the Authentication (UserSession). This should be
+         * called when a user signs out of an application, but
+         * the application continues running
+         */
+        ArcGISContext.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) {
+                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({
+                id: this.id,
+                portalUrl: this._portalUrl,
+                hubUrl: this._hubUrl,
+            });
+        };
+        Object.defineProperty(ArcGISContext.prototype, "state", {
+            /**
+             * Return a reference to the current state.
+             * When `.setAuthentication()` or `.clearAuthenentication()` are
+             * called, the state will be re-created. This is done so frameworks
+             * like React or Ember can detect changes.
+             */
+            get: function () {
+                return this._state;
+            },
+            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);
+            }
+        };
         return ArcGISContext;
     }());
     /**
@@ -11113,6 +11194,22 @@
         }
         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 */