@esri/hub-common 9.13.0 → 9.13.1

package/dist/node/ArcGISContextState.js

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcGISContextState = void 0;
+const _1 = require(".");
+/**
+ * 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
+ */
+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 _1.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 _1.getWithDefault(this._portalSelf, "portalProperties.hub.enabled", false);
+    }
+    /**
+     * Return Hub Community Org Id, if defined
+     */
+    get communityOrgId() {
+        if (this._portalSelf) {
+            return _1.getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.orgId");
+        }
+    }
+    get communityOrgHostname() {
+        if (this._portalSelf) {
+            return _1.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;
+    }
+}
+exports.ArcGISContextState = ArcGISContextState;
+//# sourceMappingURL=ArcGISContextState.js.map

package/dist/node/ArcGISContextState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGISContextState.js","sourceRoot":"","sources":["../../src/ArcGISContextState.ts"],"names":[],"mappings":";;;AAOA,wBAAgE;AAEhE;;;GAGG;AACH,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AA6CF;;;;;;GAMG;AACH,MAAa,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,UAAO,CAAC,IAAI,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;SAC1E;IACH,CAAC;IAED;;;;OAIG;IACH,IAAW,UAAU;QACnB,OAAO,iBAAc,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,UAAO,CACZ,IAAI,CAAC,WAAW,EAChB,kDAAkD,CACnD,CAAC;SACH;IACH,CAAC;IAED,IAAW,oBAAoB;QAC7B,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,UAAO,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;AAjOD,gDAiOC"}

package/dist/types/ArcGISContext.d.ts

@@ -1,7 +1,5 @@
-import { IPortal } from "@esri/arcgis-rest-portal";
-import { IUser, IUserRequestOptions, UserSession } from "@esri/arcgis-rest-auth";
-import { IHubRequestOptions } from ".";
-import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { UserSession } from "@esri/arcgis-rest-auth";
+import { IArcGISContextState } from "./ArcGISContextState";
 /**
  * Options that can be passed into `ArcGISContext.create`
  */
@@ -47,6 +45,7 @@ export declare class ArcGISContext {
      * contexts getting created
      */
     id: number;
+    private _state;
     private _authentication;
     private _portalUrl;
     private _hubUrl;
@@ -70,79 +69,30 @@ export declare class ArcGISContext {
      * store that along with current user
      */
     initialize(): Promise<void>;
-    setAuthentication(auth: UserSession): Promise<void>;
-    /**
-     * @internal
-     * Log debugging messages to the console
-     * @param message
-     */
-    private log;
-    /**
-     * Return the UserSession if authenticated
-     */
-    get session(): UserSession;
-    /**
-     * Return boolean indicating if authenticatio is present
-     */
-    get isAuthenticated(): boolean;
-    /**
-     * Return `IUserRequestOptions`, which is used for REST-JS
-     * functions which require authentication information.
-     *
-     * If context is not authenticated, this function will throw
-     */
-    get userRequestOptions(): IUserRequestOptions;
     /**
-     * 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(): IRequestOptions;
-    /**
-     * Return a `IHubRequestOptions` object
-     */
-    get hubRequestOptions(): IHubRequestOptions;
-    /**
-     * 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
+     * Set the Authentication (UserSession) for the context.
+     * This should be called when a user signs into a running
+     * application.
+     * @param auth
      */
-    get portalUrl(): string;
-    /**
-     * Returns the url to the sharing api
-     * i.e. https://myorg.maps.arcgis.com/sharing/rest
-     */
-    get sharingApiUrl(): string;
-    get hubUrl(): string;
+    setAuthentication(auth: UserSession): Promise<void>;
     /**
-     * Returns boolean indicating if the backing system
-     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+     * Clear the Authentication (UserSession). This should be
+     * called when a user signs out of an application, but
+     * the application continues running
      */
-    get isPortal(): boolean;
-    get discussionsServiceUrl(): string;
-    get hubSearchServiceUrl(): string;
-    get domainServiceUrl(): string;
-    get eventsConfig(): any;
+    clearAuthentication(): void;
     /**
-     * Returns boolean indicating if the current user
-     * belongs to an organization that has licensed
-     * ArcGIS Hub
+     * 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 hubEnabled(): boolean;
+    get state(): IArcGISContextState;
     /**
-     * Return Hub Community Org Id, if defined
+     * @internal
+     * Log debugging messages to the console
+     * @param message
      */
-    get communityOrgId(): string;
-    get communityOrgHostname(): string;
-    get communityOrgUrl(): string;
-    get helperServices(): any;
-    get currentUser(): IUser;
-    get portal(): IPortal;
+    private log;
 }

package/dist/types/ArcGISContextState.d.ts

@@ -0,0 +1,129 @@
+import { IUser, IUserRequestOptions, UserSession } from "@esri/arcgis-rest-auth";
+import { IPortal } from "@esri/arcgis-rest-portal";
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IHubRequestOptions } from ".";
+/**
+ * Defined the properties of the ArcGISContext.state
+ * object. This wll be a class instance, and when authentication
+ * changes, the instance will be replaced. This is done to allow
+ * frameworks like React or Ember to bind into the .state property
+ * and react when it changes.
+ */
+export interface IArcGISContextState {
+    id: number;
+    session: UserSession;
+    isAuthenticated: boolean;
+    userRequestOptions: IUserRequestOptions;
+    requestOptions: IRequestOptions;
+    hubRequestOptions: IHubRequestOptions;
+    portalUrl: string;
+    sharingApiUrl: string;
+    hubUrl: string;
+    isPortal: boolean;
+    discussionsServiceUrl: string;
+    hubSearchServiceUrl: string;
+    domainServiceUrl: string;
+    eventsConfig: any;
+    hubEnabled: boolean;
+    communityOrgId: string;
+    communityOrgHostname: string;
+    communityOrgUrl: string;
+    helperServices: any;
+    currentUser: IUser;
+    portal: IPortal;
+}
+/**
+ * @internal
+ */
+export interface IArcGISContextStateOptions {
+    id: number;
+    portalUrl: string;
+    hubUrl: string;
+    authentication?: UserSession;
+    portalSelf?: IPortal;
+    currentUser?: IUser;
+}
+/**
+ * @internal
+ * Thin class just used to enable getters
+ *
+ * This class should not be used by anything other than
+ * the ArcGISContext class
+ */
+export declare class ArcGISContextState implements IArcGISContextState {
+    id: number;
+    private _authentication;
+    private _portalUrl;
+    private _hubUrl;
+    private _portalSelf;
+    private _currentUser;
+    constructor(opts: IArcGISContextStateOptions);
+    /**
+     * Return the UserSession if authenticated
+     */
+    get session(): UserSession;
+    /**
+     * Return boolean indicating if authenticatio is present
+     */
+    get isAuthenticated(): boolean;
+    /**
+     * Return `IUserRequestOptions`, which is used for REST-JS
+     * functions which require authentication information.
+     *
+     * If context is not authenticated, this function will throw
+     */
+    get userRequestOptions(): IUserRequestOptions;
+    /**
+     * 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(): IRequestOptions;
+    /**
+     * Return a `IHubRequestOptions` object
+     */
+    get hubRequestOptions(): IHubRequestOptions;
+    /**
+     * 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(): string;
+    /**
+     * Returns the url to the sharing api
+     * i.e. https://myorg.maps.arcgis.com/sharing/rest
+     */
+    get sharingApiUrl(): string;
+    get hubUrl(): string;
+    /**
+     * Returns boolean indicating if the backing system
+     * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+     */
+    get isPortal(): boolean;
+    get discussionsServiceUrl(): string;
+    get hubSearchServiceUrl(): string;
+    get domainServiceUrl(): string;
+    get eventsConfig(): any;
+    /**
+     * Returns boolean indicating if the current user
+     * belongs to an organization that has licensed
+     * ArcGIS Hub
+     */
+    get hubEnabled(): boolean;
+    /**
+     * Return Hub Community Org Id, if defined
+     */
+    get communityOrgId(): string;
+    get communityOrgHostname(): string;
+    get communityOrgUrl(): string;
+    get helperServices(): any;
+    get currentUser(): IUser;
+    get portal(): IPortal;
+}