@esri/hub-common 9.13.2 → 9.16.0

package/dist/es2017/ArcGISContext.js

@@ -1,194 +1,251 @@
-import { getSelf, getUser } from "@esri/arcgis-rest-portal";
-import { ArcGISContextState, } from "./ArcGISContextState";
-import { cloneObject } from ".";
+import { getProp, getWithDefault } from ".";
 /**
- * Application Context Object
- *
- * Abstraction that combines a `UserSession` with
- * the `portal/self` and `user/self` responses to
- * provide a central lookup of platform information.
+ * Hash of Hub API end points so updates
+ * are centralized
+ */
+const hubApiEndpoints = {
+    domains: "/api/v3/domains",
+    search: "/api/v3/datasets",
+    discussions: "/api/discussions/v1",
+};
+/**
+ * Abstraction that holds a `UserSession`, along with
+ * getters to streamline access to various platform
+ * urls, and common constructs like `IRequestOptions`,
+ * `IUserRequestOptions` etc.
  *
- * This is a work-in-progress, and will likely expand over time.
+ * Instances are intended to be immutable, but this is not directly enforced.
  *
- * `ArcGISContext` is used in conjuction with the `arcgis-app-identity`
- * component to orchestrate oAuth.
+ * In most circumstances, this class should be created by
+ * the ArcGISContextManager class.
  */
 export class ArcGISContext {
     /**
-     * Private constructor. Use `ArcGISContext.create(...)` to
-     * instantiate an instance
+     * Create a new instance of `ArcGISContext`.
+     *
      * @param opts
      */
     constructor(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;
         }
-        if (opts.portal) {
-            this._portalSelf = cloneObject(opts.portal);
+        if (opts.properties) {
+            this._properties = opts.properties;
         }
-        if (opts.currentUser) {
-            this._currentUser = cloneObject(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,
+            };
         }
     }
     /**
-     * Static async Factory
-     * @param opts
-     * @returns
-     */
-    static async create(opts = {}) {
-        const ctx = new ArcGISContext(opts);
-        await ctx.initialize();
-        return ctx;
-    }
-    /**
-     * 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
-     * @param message
-     */
-    log(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
-     */
-    async initialize() {
-        // if we have auth, and don't have portalSelf or currentUser, fetch them
-        if (this._authentication && (!this._portalSelf || !this._currentUser)) {
-            this.log(`ArcGISContext-${this.id}: Initializing`);
-            const username = this._authentication.username;
-            const requests = [
-                getSelf({ authentication: this._authentication }),
-                getUser({ username, authentication: this._authentication }),
-            ];
-            try {
-                const [portal, user] = await Promise.all(requests);
-                this._portalSelf = portal;
-                this._currentUser = user;
+     * 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
+        if (this.isAuthenticated) {
+            return {
+                authentication: this.session,
+                isPortal: this.isPortal,
+                portalSelf: this.portal,
+                hubApiUrl: this.hubUrl,
+            };
+        }
+    }
+    /**
+     * Return the portal url i.e. https://www.arcgis.com
+     *
+     * If authenticated @ ArcGIS Online, it will return
+     * the https://org.env.arcgis.com
+     *
+     * If authenticated @ ArcGIS Enterprise, it will return
+     * https://{portalHostname}/{webadaptor}
+     */
+    get portalUrl() {
+        if (this.isAuthenticated) {
+            if (this.isPortal) {
+                return `https://${this._portalSelf.portalHostname}`;
             }
-            catch (ex) {
-                const msg = `ArcGISContext could not fetch portal & user for "${this._authentication.username}" using ${this._authentication.portal}.`;
-                // tslint:disable-next-line:no-console
-                console.error(msg);
-                throw ex;
+            else {
+                return `https://${this._portalSelf.urlKey}.${this._portalSelf.customBaseUrl}`;
             }
         }
-        // update the state
-        this._state = new ArcGISContextState(this.stateOpts);
+        else {
+            return this._portalUrl;
+        }
     }
-    get stateOpts() {
-        const stateOpts = {
-            id: this.id,
-            portalUrl: this._portalUrl,
-            hubUrl: this._hubUrl,
-        };
-        if (this._authentication) {
-            stateOpts.authentication = this._authentication;
+    /**
+     * Returns the url to the sharing api composed from portalUrl
+     * i.e. https://myorg.maps.arcgis.com/sharing/rest
+     */
+    get sharingApiUrl() {
+        return `${this.portalUrl}/sharing/rest`;
+    }
+    /**
+     * Returns the Hub url, based on the portalUrl
+     *
+     * For ArcGIS Enterprise this will return `undefined`
+     */
+    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;
+    }
+    /**
+     * Returns the discussions API URL
+     */
+    get discussionsServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.discussions}`;
         }
-        if (this._portalSelf) {
-            stateOpts.portalSelf = this._portalSelf;
+    }
+    /**
+     * Returns the Hub Search API URL
+     */
+    get hubSearchServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.search}`;
         }
-        if (this._currentUser) {
-            stateOpts.currentUser = this._currentUser;
+    }
+    /**
+     * Returns Hub Domain Service URL
+     */
+    get domainServiceUrl() {
+        if (this._hubUrl) {
+            return `${this._hubUrl}${hubApiEndpoints.domains}`;
         }
-        return stateOpts;
     }
-}
-/**
- * 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) {
-    let result;
-    if (portalUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-        result = "https://hubqa.arcgis.com";
+    /**
+     * Returns the Events configuration object from portal/self
+     *
+     * `{serviceId: '3ef..', publicViewId: 'bc3...'}`
+     */
+    get eventsConfig() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.events");
+        }
     }
-    else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-        result = "https://hubdev.arcgis.com";
+    /**
+     * 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);
     }
-    else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
-        result = "https://hub.arcgis.com";
+    /**
+     * Return the Hub Community Org Id, if defined
+     */
+    get communityOrgId() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.orgId");
+        }
     }
-    return result;
-}
-function getPortalBaseFromOrgUrl(orgUrl) {
-    let result;
-    if (orgUrl.match(/(qaext|\.mapsqa)\.arcgis.com/)) {
-        result = "https://qaext.arcgis.com";
+    /**
+     * Returns the Hub Community Org Hostname, if defined
+     *
+     * i.e. c-org.maps.arcgis.com
+     */
+    get communityOrgHostname() {
+        if (this._portalSelf) {
+            return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
+        }
     }
-    else if (orgUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
-        result = "https://devext.arcgis.com";
+    /**
+     * Returns the Hub Community Org url
+     *
+     * i.e. https://c-org.maps.arcgis.com
+     */
+    get communityOrgUrl() {
+        if (this.communityOrgHostname) {
+            return `https://${this.communityOrgHostname}`;
+        }
     }
-    else {
-        /* istanbul ignore else */
-        if (orgUrl.match(/(www|\.maps)\.arcgis.com/)) {
-            result = "https://www.arcgis.com";
+    /**
+     * Returns the hash of helper services from portal self
+     */
+    get helperServices() {
+        if (this._portalSelf) {
+            return this._portalSelf.helperServices;
         }
     }
-    return result;
+    /**
+     * Returns the current user as IUser
+     */
+    get currentUser() {
+        return this._currentUser;
+    }
+    /**
+     * Returns the portal object as IPortal
+     */
+    get portal() {
+        return this._portalSelf;
+    }
+    /**
+     * Return the properties hash that was passed in.
+     * Useful for app-specific context such as the active
+     * Site for ArcGIS Hub
+     */
+    get properties() {
+        return this._properties;
+    }
 }
 //# 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,EAAE,OAAO,EAAW,MAAM,0BAA0B,CAAC;AAErE,OAAO,EACL,kBAAkB,GAGnB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,CAAC;AA2ChC;;;;;;;;;;;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;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7C;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;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;;;;;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;IAED;;;OAGG;IACK,KAAK,CAAC,UAAU;QACtB,wEAAwE;QACxE,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACrE,IAAI,CAAC,GAAG,CAAC,iBAAiB,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC;YACnD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;YAC/C,MAAM,QAAQ,GAAuC;gBACnD,OAAO,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACjD,OAAO,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;aAC5D,CAAC;YACF,IAAI;gBACF,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;gBAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;aAC1B;YAAC,OAAO,EAAE,EAAE;gBACX,MAAM,GAAG,GAAG,oDAAoD,IAAI,CAAC,eAAe,CAAC,QAAQ,WAAW,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC;gBACvI,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM,EAAE,CAAC;aACV;SACF;QACD,mBAAmB;QACnB,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,IAAY,SAAS;QACnB,MAAM,SAAS,GAA+B;YAC5C,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,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC;SACjD;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,SAAS,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;SACzC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;SAC3C;QACD,OAAO,SAAS,CAAC;IACnB,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"}
+{"version":3,"file":"ArcGISContext.js","sourceRoot":"","sources":["../../src/ArcGISContext.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;AAmLF;;;;;;;;;;GAUG;AACH,MAAM,OAAO,aAAa;IAoBxB;;;;OAIG;IACH,YAAY,IAA2B;QAf/B,eAAU,GAAW,wBAAwB,CAAC;QAgBpD,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;QACD,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;SACpC;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,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO;gBACL,cAAc,EAAE,IAAI,CAAC,OAAO;gBAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,SAAS,EAAE,IAAI,CAAC,MAAM;aACvB,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;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;;;;OAIG;IACH,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;;OAEG;IACH,IAAW,qBAAqB;QAC9B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,WAAW,EAAE,CAAC;SACxD;IACH,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC5B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC;SACnD;IACH,CAAC;IAED;;OAEG;IACH,IAAW,gBAAgB;QACzB,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO,GAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAO,EAAE,CAAC;SACpD;IACH,CAAC;IAED;;;;OAIG;IACH,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;;;;OAIG;IACH,IAAW,oBAAoB;QAC7B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,2DAA2D,CAC5D,CAAC;SACH;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,eAAe;QACxB,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,OAAO,WAAW,IAAI,CAAC,oBAAoB,EAAE,CAAC;SAC/C;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;SACxC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;CACF"}

package/dist/es2017/ArcGISContextManager.js

@@ -0,0 +1,171 @@
+import { getSelf, getUser } from "@esri/arcgis-rest-portal";
+import { ArcGISContext, } from "./ArcGISContext";
+import { cloneObject, Logger, Level } from ".";
+import { getHubApiFromPortalUrl } from "./urls/getHubApiFromPortalUrl";
+import { getPortalBaseFromOrgUrl } from "./urls/getPortalBaseFromOrgUrl";
+/**
+ * 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.
+ *
+ * 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.
+ *
+ * Please see the [ArcGISContext Guide](/hub.js/guides/context) for additional information.
+ *
+ */
+export class ArcGISContextManager {
+    /**
+     * Private constructor. Use `ArcGISContextManager.create(...)` to
+     * instantiate an instance
+     * @param opts
+     */
+    constructor(opts) {
+        this._portalUrl = "https://www.arcgis.com";
+        this._logLevel = Level.error;
+        // Having a unique id makes debugging easier
+        this.id = new Date().getTime();
+        if (opts.logLevel) {
+            this._logLevel = opts.logLevel;
+        }
+        Logger.setLogLevel(this._logLevel);
+        Logger.debug(`ArcGISContextManager:ctor: Creating ${this.id}`);
+        if (opts.properties) {
+            this._properties = opts.properties;
+        }
+        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);
+        }
+        if (opts.portal) {
+            this._portalSelf = cloneObject(opts.portal);
+        }
+        if (opts.currentUser) {
+            this._currentUser = cloneObject(opts.currentUser);
+        }
+    }
+    /**
+     * Used to create a new instance of the ArcGISContext class.
+     *
+     * ```js
+     * const ctxMgr = await ArcGISContextManager.create();
+     * ```
+     *
+     * @param opts
+     * @returns
+     */
+    static async create(opts = {}) {
+        const ctx = new ArcGISContextManager(opts);
+        await ctx.initialize();
+        return ctx;
+    }
+    /**
+     * 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();
+    }
+    /**
+     * Set the properties hash and re-create the context
+     * @param properties
+     */
+    setProperties(properties) {
+        this._properties = properties;
+        this._context = new ArcGISContext(this.contextOpts);
+    }
+    /**
+     * 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._context.isPortal) {
+            this._portalUrl = getPortalBaseFromOrgUrl(this._portalUrl);
+        }
+        // Clear the auth, portalSelf and currentUser props
+        this._authentication = null;
+        this._portalSelf = null;
+        this._currentUser = null;
+        this._context = new ArcGISContext(this.contextOpts);
+    }
+    /**
+     * 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 context() {
+        return this._context;
+    }
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * store that along with current user
+     */
+    async initialize() {
+        // if we have auth, and don't have portalSelf or currentUser, fetch them
+        if (this._authentication && (!this._portalSelf || !this._currentUser)) {
+            Logger.debug(`ArcGISContextManager-${this.id}: Initializing`);
+            const username = this._authentication.username;
+            const requests = [
+                getSelf({ authentication: this._authentication }),
+                getUser({ username, authentication: this._authentication }),
+            ];
+            try {
+                const [portal, user] = await Promise.all(requests);
+                this._portalSelf = portal;
+                this._currentUser = user;
+                Logger.debug(`ArcGISContextManager-${this.id}: received portalSelf and currentUser`);
+            }
+            catch (ex) {
+                const 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;
+            }
+        }
+        Logger.debug(`ArcGISContextManager-${this.id}: updating context`);
+        // update the context
+        this._context = new ArcGISContext(this.contextOpts);
+    }
+    /**
+     * Getter to streamline the creation of updated Context instances
+     */
+    get contextOpts() {
+        const contextOpts = {
+            id: this.id,
+            portalUrl: this._portalUrl,
+            hubUrl: this._hubUrl,
+            properties: this._properties,
+        };
+        if (this._authentication) {
+            contextOpts.authentication = this._authentication;
+        }
+        if (this._portalSelf) {
+            contextOpts.portalSelf = this._portalSelf;
+        }
+        if (this._currentUser) {
+            contextOpts.currentUser = this._currentUser;
+        }
+        return contextOpts;
+    }
+}
+//# sourceMappingURL=ArcGISContextManager.js.map

package/dist/es2017/ArcGISContextManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGISContextManager.js","sourceRoot":"","sources":["../../src/ArcGISContextManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAW,MAAM,0BAA0B,CAAC;AAErE,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AAqDzE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,oBAAoB;IAwB/B;;;;OAIG;IACH,YAAoB,IAAkC;QAjB9C,eAAU,GAAW,wBAAwB,CAAC;QAU9C,cAAS,GAAU,KAAK,CAAC,KAAK,CAAC;QAQrC,4CAA4C;QAC5C,IAAI,CAAC,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QAC/B,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;SAChC;QACD,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACnC,MAAM,CAAC,KAAK,CAAC,uCAAuC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAE/D,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC;SACpC;QAED,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;QAED,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7C;QAED,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SACnD;IACH,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,OAAqC,EAAE;QAEvC,MAAM,GAAG,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,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;;;OAGG;IACH,aAAa,CAAC,UAA+B;QAC3C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,mBAAmB;QACjB,uDAAuD;QACvD,4DAA4D;QAC5D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAC3B,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,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,UAAU;QACtB,wEAAwE;QACxE,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;YACrE,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAC;YAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC;YAC/C,MAAM,QAAQ,GAAuC;gBACnD,OAAO,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACjD,OAAO,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC;aAC5D,CAAC;YACF,IAAI;gBACF,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACnD,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;gBAC1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;gBACzB,MAAM,CAAC,KAAK,CACV,wBAAwB,IAAI,CAAC,EAAE,uCAAuC,CACvE,CAAC;aACH;YAAC,OAAO,EAAE,EAAE;gBACX,MAAM,GAAG,GAAG,2DAA2D,IAAI,CAAC,eAAe,CAAC,QAAQ,WAAW,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC;gBAC9I,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClB,sCAAsC;gBACtC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM,EAAE,CAAC;aACV;SACF;QACD,MAAM,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC;QAClE,qBAAqB;QACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAY,WAAW;QACrB,MAAM,WAAW,GAA0B;YACzC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC7B,CAAC;QACF,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,WAAW,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC;SACnD;QACD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,WAAW,CAAC,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC;SAC3C;QACD,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC;SAC7C;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CACF"}