@esri/hub-common 9.13.0 → 9.13.1

package/dist/es2017/ArcGISContext.js

@@ -1,14 +1,5 @@
 import { getSelf } from "@esri/arcgis-rest-portal";
-import { getProp, getWithDefault } from ".";
-/**
- * Hash of Hub API end points so updates
- * are centralized
- */
-const hubApiEndpoints = {
-    domains: "/api/v3/domains",
-    search: "/api/v3/datasets",
-    discussions: "/api/discussions/v1",
-};
+import { ArcGISContextState, } from "./ArcGISContextState";
 /**
  * Application Context Object
  *
@@ -64,19 +55,69 @@ export class ArcGISContext {
      * store that along with current user
      */
     async initialize() {
+        let stateOpts = {
+            id: this.id,
+            portalUrl: this._portalUrl,
+            hubUrl: this._hubUrl,
+        };
         if (this._authentication) {
             this.log(`ArcGISContext-${this.id}: Initializing`);
             const ps = await getSelf({ authentication: this._authentication });
             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,
+            };
         }
+        // update the state
+        this._state = new ArcGISContextState(stateOpts);
     }
-    // Set authentication after the instance is up and running
+    /**
+     * Set the Authentication (UserSession) for the context.
+     * This should be called when a user signs into a running
+     * application.
+     * @param auth
+     */
     async setAuthentication(auth) {
         this._authentication = auth;
         this._portalUrl = auth.portal.replace("/sharing/rest", "");
         await this.initialize();
     }
+    /**
+     * Clear the Authentication (UserSession). This should be
+     * called when a user signs out of an application, but
+     * the application continues running
+     */
+    clearAuthentication() {
+        // 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,
+        });
+    }
+    /**
+     * 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 state() {
+        return this._state;
+    }
     /**
      * @internal
      * Log debugging messages to the console
@@ -88,174 +129,6 @@ export class ArcGISContext {
             console.info(message);
         }
     }
-    /**
-     * Return the UserSession if authenticated
-     */
-    get session() {
-        return this._authentication;
-    }
-    /**
-     * Return boolean indicating if authenticatio is present
-     */
-    get isAuthenticated() {
-        return !!this._authentication;
-    }
-    /**
-     * Return `IUserRequestOptions`, which is used for REST-JS
-     * functions which require authentication information.
-     *
-     * If context is not authenticated, this function will throw
-     */
-    get userRequestOptions() {
-        if (this.isAuthenticated) {
-            return {
-                authentication: this._authentication,
-                portal: this.sharingApiUrl,
-            };
-        }
-    }
-    /**
-     * Return `IRequestOptions`, which is used by REST-JS functions
-     * which *may* use authentication information if provided.
-     *
-     * If context is not authenticated, this function just returns
-     * the `portal` property, which informs REST-JS what Sharing API
-     * instance to use (i.e. AGO, Enterprise etc)
-     */
-    get requestOptions() {
-        let ro = {
-            portal: this.sharingApiUrl,
-        };
-        if (this.isAuthenticated) {
-            ro = {
-                authentication: this._authentication,
-                portal: this.sharingApiUrl,
-            };
-        }
-        return ro;
-    }
-    /**
-     * Return a `IHubRequestOptions` object
-     */
-    get hubRequestOptions() {
-        // We may add more logic around what is returned in some corner cases
-        return {
-            authentication: this.session,
-            isPortal: this.isPortal,
-            portalSelf: this.portal,
-            hubApiUrl: this.hubUrl,
-        };
-    }
-    // ==============================
-    // Getters / Computed Properties
-    // ==============================
-    /**
-     * Return the portal url.
-     *
-     * If authenticated @ ArcGIS Online, it will return
-     * the https://org.env.arcgis.com
-     *
-     * If authenticated @ ArcGIS Enterprise, it will return
-     * https://portalHostname, which includes the web adaptor
-     */
-    get portalUrl() {
-        if (this.isAuthenticated) {
-            if (this.isPortal) {
-                return `https://${this._portalSelf.portalHostname}`;
-            }
-            else {
-                return `https://${this._portalSelf.urlKey}.${this._portalSelf.customBaseUrl}`;
-            }
-        }
-        else {
-            return this._portalUrl;
-        }
-    }
-    /**
-     * Returns the url to the sharing api
-     * i.e. https://myorg.maps.arcgis.com/sharing/rest
-     */
-    get sharingApiUrl() {
-        return `${this.portalUrl}/sharing/rest`;
-    }
-    get hubUrl() {
-        return this._hubUrl;
-    }
-    /**
-     * Returns boolean indicating if the backing system
-     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
-     */
-    get isPortal() {
-        return this._portalSelf
-            ? this._portalSelf.isPortal
-            : this._portalUrl.indexOf("arcgis.com") === -1;
-    }
-    // Hub APIs
-    // ----------
-    // Discussions
-    get discussionsServiceUrl() {
-        if (this._hubUrl) {
-            return `${this._hubUrl}${hubApiEndpoints.discussions}`;
-        }
-    }
-    // Hub Search
-    get hubSearchServiceUrl() {
-        if (this._hubUrl) {
-            return `${this._hubUrl}${hubApiEndpoints.search}`;
-        }
-    }
-    // Domain
-    get domainServiceUrl() {
-        if (this._hubUrl) {
-            return `${this._hubUrl}${hubApiEndpoints.domains}`;
-        }
-    }
-    // Events
-    // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
-    get eventsConfig() {
-        if (this._portalSelf) {
-            return getProp(this._portalSelf, "portalProperties.hub.settings.events");
-        }
-    }
-    /**
-     * Returns boolean indicating if the current user
-     * belongs to an organization that has licensed
-     * ArcGIS Hub
-     */
-    get hubEnabled() {
-        return getWithDefault(this._portalSelf, "portalProperties.hub.enabled", false);
-    }
-    /**
-     * Return Hub Community Org Id, if defined
-     */
-    get communityOrgId() {
-        if (this._portalSelf) {
-            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.orgId");
-        }
-    }
-    get communityOrgHostname() {
-        if (this._portalSelf) {
-            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
-        }
-    }
-    get communityOrgUrl() {
-        if (this.communityOrgHostname) {
-            return `https://${this.communityOrgHostname}`;
-        }
-    }
-    // Platform API service urls are all in helperServices
-    // and not consistent to expose as urls
-    get helperServices() {
-        if (this._portalSelf) {
-            return this._portalSelf.helperServices;
-        }
-    }
-    get currentUser() {
-        return this._currentUser;
-    }
-    get portal() {
-        return this._portalSelf;
-    }
 }
 /**
  * Cross-walk from a portalUrl to the corresponding Hub.
@@ -277,4 +150,20 @@ function getHubApiFromPortalUrl(portalUrl) {
     }
     return result;
 }
+function getPortalBaseFromOrgUrl(orgUrl) {
+    let 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;
+}
 //# sourceMappingURL=ArcGISContext.js.map

package/dist/es2017/ArcGISContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"ArcGISContext.js","sourceRoot":"","sources":["../../src/ArcGISContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,0BAA0B,CAAC;AAM5D,OAAO,EAAE,OAAO,EAAE,cAAc,EAAsB,MAAM,GAAG,CAAC;AAGhE;;;GAGG;AACH,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AA+BF;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,aAAa;IAoBxB;;;;OAIG;IACH,YAAoB,IAA2B;QAfvC,eAAU,GAAW,wBAAwB,CAAC;QAQ9C,WAAM,GAAG,KAAK,CAAC;QAQrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;SAC1B;QACD,IAAI,CAAC,GAAG,CAAC,gCAAgC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAEpD,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;YAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CACnD,eAAe,EACf,EAAE,CACH,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;aAAM,IAAI,IAAI,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,OAA8B,EAAE;QAEhC,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACnD,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;SAC7B;IACH,CAAC;IAED,0DAA0D;IAC1D,KAAK,CAAC,iBAAiB,CAAC,IAAiB;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACK,GAAG,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,sCAAsC;YACtC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACvB;IACH,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,IAAW,kBAAkB;QAC3B,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO;gBACL,cAAc,EAAE,IAAI,CAAC,eAAe;gBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;aAC3B,CAAC;SACH;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAW,cAAc;QACvB,IAAI,EAAE,GAAQ;YACZ,MAAM,EAAE,IAAI,CAAC,aAAa;SAC3B,CAAC;QACF,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,EAAE,GAAG;gBACH,cAAc,EAAE,IAAI,CAAC,eAAe;gBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;aAC3B,CAAC;SACH;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,IAAW,iBAAiB;QAC1B,qEAAqE;QACrE,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,OAAO;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,MAAM;YACvB,SAAS,EAAE,IAAI,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;IAED,iCAAiC;IACjC,gCAAgC;IAChC,iCAAiC;IAEjC;;;;;;;;OAQG;IACH,IAAW,SAAS;QAClB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjB,OAAO,WAAW,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;aACrD;iBAAM;gBACL,OAAO,WAAW,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;aAC/E;SACF;aAAM;YACL,OAAO,IAAI,CAAC,UAAU,CAAC;SACxB;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,eAAe,CAAC;IAC1C,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,WAAW;YACrB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;YAC3B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,WAAW;IACX,aAAa;IACb,cAAc;IACd,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,WAAW,EAAE,CAAC;SACxD;IACH,CAAC;IAED,aAAa;IACb,IAAW,mBAAmB;QAC5B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;SACnD;IACH,CAAC;IAED,SAAS;IACT,IAAW,gBAAgB;QACzB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;SACpD;IACH,CAAC;IAED,SAAS;IACT,wDAAwD;IACxD,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACnB,OAAO,cAAc,CACnB,IAAI,CAAC,WAAW,EAChB,8BAA8B,EAC9B,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,kDAAkD,CACnD,CAAC;SACH;IACH,CAAC;IAED,IAAW,oBAAoB;QAC7B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,2DAA2D,CAC5D,CAAC;SACH;IACH,CAAC;IAED,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,OAAO,WAAW,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC/C;IACH,CAAC;IAED,sDAAsD;IACtD,uCAAuC;IACvC,IAAW,cAAc;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;SACxC;IACH,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,SAAiB;IAC/C,IAAI,MAAM,CAAC;IAEX,IAAI,SAAS,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QACnD,MAAM,GAAG,0BAA0B,CAAC;KACrC;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC/D,MAAM,GAAG,2BAA2B,CAAC;KACtC;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;QACtD,MAAM,GAAG,wBAAwB,CAAC;KACnC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"ArcGISContext.js","sourceRoot":"","sources":["../../src/ArcGISContext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAW,MAAM,0BAA0B,CAAC;AAE5D,OAAO,EACL,kBAAkB,GAGnB,MAAM,sBAAsB,CAAC;AA+B9B;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,aAAa;IAsBxB;;;;OAIG;IACH,YAAoB,IAA2B;QAfvC,eAAU,GAAW,wBAAwB,CAAC;QAQ9C,WAAM,GAAG,KAAK,CAAC;QAQrB,4CAA4C;QAC5C,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC;SAC1B;QACD,IAAI,CAAC,GAAG,CAAC,gCAAgC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAEpD,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;YAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,CACnD,eAAe,EACf,EAAE,CACH,CAAC;YACF,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;aAAM,IAAI,IAAI,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;YACjC,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;aAAM;YACL,IAAI,CAAC,OAAO,GAAG,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SACxD;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,OAA8B,EAAE;QAEhC,MAAM,GAAG,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,SAAS,GAA+B;YAC1C,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,MAAM,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC;QACF,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACnD,MAAM,EAAE,GAAG,MAAM,OAAO,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC;YACnE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;YAC5B,SAAS,GAAG;gBACV,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,SAAS,EAAE,IAAI,CAAC,UAAU;gBAC1B,MAAM,EAAE,IAAI,CAAC,OAAO;gBACpB,UAAU,EAAE,IAAI,CAAC,WAAW;gBAC5B,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,cAAc,EAAE,IAAI,CAAC,eAAe;aACrC,CAAC;SACH;QACD,mBAAmB;QACnB,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAiB;QACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC3D,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,mBAAmB;QACjB,uDAAuD;QACvD,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACzB,IAAI,CAAC,UAAU,GAAG,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC5D;QACD,mDAAmD;QACnD,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAAC;YACnC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,MAAM,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACK,GAAG,CAAC,OAAe;QACzB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,sCAAsC;YACtC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACvB;IACH,CAAC;CACF;AAED;;;;;;GAMG;AACH,SAAS,sBAAsB,CAAC,SAAiB;IAC/C,IAAI,MAAM,CAAC;IAEX,IAAI,SAAS,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QACnD,MAAM,GAAG,0BAA0B,CAAC;KACrC;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC/D,MAAM,GAAG,2BAA2B,CAAC;KACtC;SAAM,IAAI,SAAS,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;QACtD,MAAM,GAAG,wBAAwB,CAAC;KACnC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAc;IAC7C,IAAI,MAAM,CAAC;IAEX,IAAI,MAAM,CAAC,KAAK,CAAC,8BAA8B,CAAC,EAAE;QAChD,MAAM,GAAG,0BAA0B,CAAC;KACrC;SAAM,IAAI,MAAM,CAAC,KAAK,CAAC,mCAAmC,CAAC,EAAE;QAC5D,MAAM,GAAG,2BAA2B,CAAC;KACtC;SAAM;QACL,0BAA0B;QAC1B,IAAI,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,EAAE;YAC5C,MAAM,GAAG,wBAAwB,CAAC;SACnC;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/es2017/ArcGISContextState.js

@@ -0,0 +1,203 @@
+import { getProp, getWithDefault } from ".";
+/**
+ * Hash of Hub API end points so updates
+ * are centralized
+ */
+const hubApiEndpoints = {
+    domains: "/api/v3/domains",
+    search: "/api/v3/datasets",
+    discussions: "/api/discussions/v1",
+};
+/**
+ * @internal
+ * Thin class just used to enable getters
+ *
+ * This class should not be used by anything other than
+ * the ArcGISContext class
+ */
+export class ArcGISContextState {
+    constructor(opts) {
+        this._portalUrl = "https://www.arcgis.com";
+        this.id = opts.id;
+        this._portalUrl = opts.portalUrl;
+        this._hubUrl = opts.hubUrl;
+        if (opts.authentication) {
+            this._authentication = opts.authentication;
+        }
+        if (opts.portalSelf) {
+            this._portalSelf = opts.portalSelf;
+        }
+        if (opts.currentUser) {
+            this._currentUser = opts.currentUser;
+        }
+    }
+    /**
+     * Return the UserSession if authenticated
+     */
+    get session() {
+        return this._authentication;
+    }
+    /**
+     * Return boolean indicating if authenticatio is present
+     */
+    get isAuthenticated() {
+        return !!this._authentication;
+    }
+    /**
+     * Return `IUserRequestOptions`, which is used for REST-JS
+     * functions which require authentication information.
+     *
+     * If context is not authenticated, this function will throw
+     */
+    get userRequestOptions() {
+        if (this.isAuthenticated) {
+            return {
+                authentication: this._authentication,
+                portal: this.sharingApiUrl,
+            };
+        }
+    }
+    /**
+     * Return `IRequestOptions`, which is used by REST-JS functions
+     * which *may* use authentication information if provided.
+     *
+     * If context is not authenticated, this function just returns
+     * the `portal` property, which informs REST-JS what Sharing API
+     * instance to use (i.e. AGO, Enterprise etc)
+     */
+    get requestOptions() {
+        let ro = {
+            portal: this.sharingApiUrl,
+        };
+        if (this.isAuthenticated) {
+            ro = {
+                authentication: this._authentication,
+                portal: this.sharingApiUrl,
+            };
+        }
+        return ro;
+    }
+    /**
+     * Return a `IHubRequestOptions` object
+     */
+    get hubRequestOptions() {
+        // We may add more logic around what is returned in some corner cases
+        return {
+            authentication: this.session,
+            isPortal: this.isPortal,
+            portalSelf: this.portal,
+            hubApiUrl: this.hubUrl,
+        };
+    }
+    // ==============================
+    // Getters / Computed Properties
+    // ==============================
+    /**
+     * Return the portal url.
+     *
+     * If authenticated @ ArcGIS Online, it will return
+     * the https://org.env.arcgis.com
+     *
+     * If authenticated @ ArcGIS Enterprise, it will return
+     * https://portalHostname, which includes the web adaptor
+     */
+    get portalUrl() {
+        if (this.isAuthenticated) {
+            if (this.isPortal) {
+                return `https://${this._portalSelf.portalHostname}`;
+            }
+            else {
+                return `https://${this._portalSelf.urlKey}.${this._portalSelf.customBaseUrl}`;
+            }
+        }
+        else {
+            return this._portalUrl;
+        }
+    }
+    /**
+     * Returns the url to the sharing api
+     * i.e. https://myorg.maps.arcgis.com/sharing/rest
+     */
+    get sharingApiUrl() {
+        return `${this.portalUrl}/sharing/rest`;
+    }
+    get hubUrl() {
+        return this._hubUrl;
+    }
+    /**
+     * Returns boolean indicating if the backing system
+     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+     */
+    get isPortal() {
+        return this._portalSelf
+            ? this._portalSelf.isPortal
+            : this._portalUrl.indexOf("arcgis.com") === -1;
+    }
+    // Hub APIs
+    // ----------
+    // Discussions
+    get discussionsServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.discussions}`;
+        }
+    }
+    // Hub Search
+    get hubSearchServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.search}`;
+        }
+    }
+    // Domain
+    get domainServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.domains}`;
+        }
+    }
+    // Events
+    // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
+    get eventsConfig() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.events");
+        }
+    }
+    /**
+     * Returns boolean indicating if the current user
+     * belongs to an organization that has licensed
+     * ArcGIS Hub
+     */
+    get hubEnabled() {
+        return getWithDefault(this._portalSelf, "portalProperties.hub.enabled", false);
+    }
+    /**
+     * Return Hub Community Org Id, if defined
+     */
+    get communityOrgId() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.orgId");
+        }
+    }
+    get communityOrgHostname() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
+        }
+    }
+    get communityOrgUrl() {
+        if (this.communityOrgHostname) {
+            return `https://${this.communityOrgHostname}`;
+        }
+    }
+    // Platform API service urls are all in helperServices
+    // and not consistent to expose as urls
+    get helperServices() {
+        if (this._portalSelf) {
+            return this._portalSelf.helperServices;
+        }
+    }
+    get currentUser() {
+        return this._currentUser;
+    }
+    get portal() {
+        return this._portalSelf;
+    }
+}
+//# sourceMappingURL=ArcGISContextState.js.map

package/dist/es2017/ArcGISContextState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGISContextState.js","sourceRoot":"","sources":["../../src/ArcGISContextState.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,cAAc,EAAsB,MAAM,GAAG,CAAC;AAEhE;;;GAGG;AACH,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AA6CF;;;;;;GAMG;AACH,MAAM,OAAO,kBAAkB;IAY7B,YAAY,IAAgC;QARpC,eAAU,GAAW,wBAAwB,CAAC;QASpD,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;QACjC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,cAAc,CAAC;SAC5C;QAED,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;SACpC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC;SACtC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACH,IAAW,kBAAkB;QAC3B,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO;gBACL,cAAc,EAAE,IAAI,CAAC,eAAe;gBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;aAC3B,CAAC;SACH;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAW,cAAc;QACvB,IAAI,EAAE,GAAQ;YACZ,MAAM,EAAE,IAAI,CAAC,aAAa;SAC3B,CAAC;QACF,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,EAAE,GAAG;gBACH,cAAc,EAAE,IAAI,CAAC,eAAe;gBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;aAC3B,CAAC;SACH;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,IAAW,iBAAiB;QAC1B,qEAAqE;QACrE,OAAO;YACL,cAAc,EAAE,IAAI,CAAC,OAAO;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,MAAM;YACvB,SAAS,EAAE,IAAI,CAAC,MAAM;SACvB,CAAC;IACJ,CAAC;IAED,iCAAiC;IACjC,gCAAgC;IAChC,iCAAiC;IAEjC;;;;;;;;OAQG;IACH,IAAW,SAAS;QAClB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjB,OAAO,WAAW,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;aACrD;iBAAM;gBACL,OAAO,WAAW,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;aAC/E;SACF;aAAM;YACL,OAAO,IAAI,CAAC,UAAU,CAAC;SACxB;IACH,CAAC;IAED;;;OAGG;IACH,IAAW,aAAa;QACtB,OAAO,GAAG,IAAI,CAAC,SAAS,eAAe,CAAC;IAC1C,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,WAAW;YACrB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;YAC3B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;IAED,WAAW;IACX,aAAa;IACb,cAAc;IACd,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,WAAW,EAAE,CAAC;SACxD;IACH,CAAC;IAED,aAAa;IACb,IAAW,mBAAmB;QAC5B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;SACnD;IACH,CAAC;IAED,SAAS;IACT,IAAW,gBAAgB;QACzB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;SACpD;IACH,CAAC;IAED,SAAS;IACT,wDAAwD;IACxD,IAAW,YAAY;QACrB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACnB,OAAO,cAAc,CACnB,IAAI,CAAC,WAAW,EAChB,8BAA8B,EAC9B,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,kDAAkD,CACnD,CAAC;SACH;IACH,CAAC;IAED,IAAW,oBAAoB;QAC7B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,2DAA2D,CAC5D,CAAC;SACH;IACH,CAAC;IAED,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,OAAO,WAAW,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC/C;IACH,CAAC;IAED,sDAAsD;IACtD,uCAAuC;IACvC,IAAW,cAAc;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;SACxC;IACH,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}