@esri/hub-common 9.12.0 → 9.13.0

package/dist/node/ArcGISContext.js

@@ -0,0 +1,284 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcGISContext = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+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",
+};
+/**
+ * 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.
+ */
+class ArcGISContext {
+    /**
+     * Private constructor. Use `ArcGISContext.create(...)` to
+     * instantiate an instance
+     * @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}`);
+        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
+     */
+    static async create(opts = {}) {
+        const ctx = new ArcGISContext(opts);
+        await ctx.initialize();
+        return ctx;
+    }
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * store that along with current user
+     */
+    async initialize() {
+        if (this._authentication) {
+            this.log(`ArcGISContext-${this.id}: Initializing`);
+            const ps = await arcgis_rest_portal_1.getSelf({ authentication: this._authentication });
+            this._portalSelf = ps;
+            this._currentUser = ps.user;
+        }
+    }
+    // Set authentication after the instance is up and running
+    async setAuthentication(auth) {
+        this._authentication = auth;
+        this._portalUrl = auth.portal.replace("/sharing/rest", "");
+        await this.initialize();
+    }
+    /**
+     * @internal
+     * Log debugging messages to the console
+     * @param message
+     */
+    log(message) {
+        if (this._debug) {
+            // tslint:disable-next-line:no-console
+            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 _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.ArcGISContext = ArcGISContext;
+/**
+ * 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";
+    }
+    else if (portalUrl.match(/(devext|\.mapsdevext)\.arcgis.com/)) {
+        result = "https://hubdev.arcgis.com";
+    }
+    else if (portalUrl.match(/(www|\.maps)\.arcgis.com/)) {
+        result = "https://hub.arcgis.com";
+    }
+    return result;
+}
+//# sourceMappingURL=ArcGISContext.js.map

package/dist/node/ArcGISContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ArcGISContext.js","sourceRoot":"","sources":["../../src/ArcGISContext.ts"],"names":[],"mappings":";;;AAAA,iEAA4D;AAM5D,wBAAgE;AAGhE;;;GAGG;AACH,MAAM,eAAe,GAAG;IACtB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AA+BF;;;;;;;;;;;GAWG;AACH,MAAa,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,4BAAO,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,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;AAjSD,sCAiSC;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"}

package/dist/node/index.js

@@ -24,6 +24,7 @@ tslib_1.__exportStar(require("./utils"), exports);
 tslib_1.__exportStar(require("./i18n"), exports);
 tslib_1.__exportStar(require("./request"), exports);
 tslib_1.__exportStar(require("./surveys"), exports);
+tslib_1.__exportStar(require("./ArcGISContext"), exports);
 const OperationStack_1 = require("./OperationStack");
 exports.OperationStack = OperationStack_1.default;
 const OperationError_1 = require("./OperationError");

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;;;;AAEhB,mDAAyB;AACzB,gDAAsB;AACtB,iDAAuB;AACvB,uDAA6B;AAC7B,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,kDAAwB;AACxB,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,kDAAwB;AACxB,kDAAwB;AACxB,iDAAuB;AACvB,iDAAuB;AACvB,kDAAwB;AACxB,iDAAuB;AACvB,oDAA0B;AAC1B,oDAA0B;AAE1B,qDAA8C;AAGrC,yBAHF,wBAAc,CAGE;AAFvB,qDAA8C;AAErB,yBAFlB,wBAAc,CAEkB;AACvC,6BAAkC;AAAzB,4FAAA,IAAI,OAAA;AAAE,4FAAA,IAAI,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;;;;AAEhB,mDAAyB;AACzB,gDAAsB;AACtB,iDAAuB;AACvB,uDAA6B;AAC7B,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,kDAAwB;AACxB,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,kDAAwB;AACxB,kDAAwB;AACxB,iDAAuB;AACvB,iDAAuB;AACvB,kDAAwB;AACxB,iDAAuB;AACvB,oDAA0B;AAC1B,oDAA0B;AAC1B,0DAAgC;AAEhC,qDAA8C;AAIrC,yBAJF,wBAAc,CAIE;AAHvB,qDAA8C;AAGrB,yBAHlB,wBAAc,CAGkB;AACvC,6BAAkC;AAAzB,4FAAA,IAAI,OAAA;AAAE,4FAAA,IAAI,OAAA"}

package/dist/node/utils/index.js

@@ -18,4 +18,5 @@ tslib_1.__exportStar(require("./increment-string"), exports);
 tslib_1.__exportStar(require("./logger"), exports);
 tslib_1.__exportStar(require("./is-update-group"), exports);
 tslib_1.__exportStar(require("./revertable-tasks"), exports);
+tslib_1.__exportStar(require("./sessionLocalStorage"), exports);
 //# sourceMappingURL=index.js.map

package/dist/node/utils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,kDAAwB;AACxB,iEAAuC;AACvC,sEAA4C;AAC5C,sDAA4B;AAC5B,mEAAyC;AACzC,4DAAkC;AAClC,kEAAwC;AACxC,qDAA2B;AAC3B,oDAA0B;AAC1B,mDAAyB;AACzB,oDAA0B;AAC1B,4DAAkC;AAClC,2DAAiC;AACjC,6DAAmC;AACnC,mDAAyB;AACzB,4DAAkC;AAClC,6DAAmC;AACnC,gEAAsC"}

package/dist/node/utils/sessionLocalStorage.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.saveSession = exports.getSession = exports.clearSession = void 0;
+const arcgis_rest_auth_1 = require("@esri/arcgis-rest-auth");
+/**
+ * Remove any serialized sessions associated with the passed clientId
+ * from a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ */
+function clearSession(clientId, 
+/* istanbul ignore next */
+win = window) {
+    if (win.localStorage) {
+        win.localStorage.removeItem(`__CONTEXT_${clientId}`);
+    }
+}
+exports.clearSession = clearSession;
+/**
+ * Re-hydrate a UserSession from a browser's local storage.
+ * If not found,
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ * @returns
+ */
+function getSession(clientId, 
+/* istanbul ignore next */
+win = window) {
+    let result = null;
+    if (win.localStorage) {
+        const serializedSession = win.localStorage.getItem(`__CONTEXT_${clientId}`);
+        if (serializedSession) {
+            result = arcgis_rest_auth_1.UserSession.deserialize(serializedSession);
+        }
+    }
+    return result;
+}
+exports.getSession = getSession;
+/**
+ * Serialize a UserSession into a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param session UserSession
+ * @param win optional window (used for testing)
+ */
+function saveSession(clientId, session, 
+/* istanbul ignore next */
+win = window) {
+    if (win.localStorage) {
+        win.localStorage.setItem(`__CONTEXT_${clientId}`, session.serialize());
+    }
+}
+exports.saveSession = saveSession;
+//# sourceMappingURL=sessionLocalStorage.js.map

package/dist/node/utils/sessionLocalStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionLocalStorage.js","sourceRoot":"","sources":["../../../src/utils/sessionLocalStorage.ts"],"names":[],"mappings":";;;AAAA,6DAAqD;AAErD;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,QAAgB;AAChB,0BAA0B;AAC1B,MAAW,MAAM;IAEjB,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC;KACtD;AACH,CAAC;AARD,oCAQC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CACxB,QAAgB;AAChB,0BAA0B;AAC1B,MAAW,MAAM;IAEjB,IAAI,MAAM,GAAuB,IAAI,CAAC;IACtC,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,MAAM,iBAAiB,GAAG,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAC;QAC5E,IAAI,iBAAiB,EAAE;YACrB,MAAM,GAAG,8BAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;SACrD;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAbD,gCAaC;AAED;;;;;GAKG;AACH,SAAgB,WAAW,CACzB,QAAgB,EAChB,OAAoB;AACpB,0BAA0B;AAC1B,MAAW,MAAM;IAEjB,IAAI,GAAG,CAAC,YAAY,EAAE;QACpB,GAAG,CAAC,YAAY,CAAC,OAAO,CAAC,aAAa,QAAQ,EAAE,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC;KACxE;AACH,CAAC;AATD,kCASC"}

package/dist/types/ArcGISContext.d.ts

@@ -0,0 +1,148 @@
+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";
+/**
+ * Options that can be passed into `ArcGISContext.create`
+ */
+export interface IArcGISContextOptions {
+    /**
+     * Existing user session, which may be created from Identity Manager
+     * `const session = UserSession.fromCredential(idMgr.getCredential());`
+     */
+    authentication?: UserSession;
+    /**
+     * ArcGIS Online or ArcGIS Enterprise portal url.
+     * Do not include  `/sharing/rest`
+     * Defaults to `https://www.arcgis.com`
+     * For ArcGIS Enterprise, you must include the webadaptor name.
+     * i.e. https://gis.mytown.gov/portal
+     *
+     * When Authentication is present, the UserSession.portal value is
+     * used instead of this property.
+     */
+    portalUrl?: string;
+    /**
+     * If set to `true` additional logging will be sent to the console
+     * Defaults to false.
+     */
+    debug?: boolean;
+}
+/**
+ * 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.
+ */
+export declare class ArcGISContext {
+    /**
+     * Random identifier useful for debugging issues
+     * where race-conditions can result in multiple
+     * contexts getting created
+     */
+    id: number;
+    private _authentication;
+    private _portalUrl;
+    private _hubUrl;
+    private _portalSelf;
+    private _currentUser;
+    private _debug;
+    /**
+     * Private constructor. Use `ArcGISContext.create(...)` to
+     * instantiate an instance
+     * @param opts
+     */
+    private constructor();
+    /**
+     * Static async Factory
+     * @param opts
+     * @returns
+     */
+    static create(opts?: IArcGISContextOptions): Promise<ArcGISContext>;
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * 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
+     */
+    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;
+}

package/dist/types/index.d.ts

@@ -18,6 +18,7 @@ export * from "./utils";
 export * from "./i18n";
 export * from "./request";
 export * from "./surveys";
+export * from "./ArcGISContext";
 import OperationStack from "./OperationStack";
 import OperationError from "./OperationError";
 export { OperationStack, OperationError };

package/dist/types/types.d.ts

@@ -82,7 +82,11 @@ export interface ISolutionTemplate extends IModel {
     };
 }
 export declare type GenericAsyncFunc = (...args: any) => Promise<any>;
-interface IHubRequestOptionsPortalSelf extends IPortal {
+/**
+ * @internal
+ * This just adds user to the IPortal interface
+ */
+export interface IHubRequestOptionsPortalSelf extends IPortal {
     user?: IUser;
 }
 export interface IHubRequestOptions extends IRequestOptions {
@@ -415,4 +419,3 @@ export interface ISearchResponse<T> {
     next: (params?: any) => Promise<ISearchResponse<T>>;
     facets?: IFacet[];
 }
-export {};

package/dist/types/utils/index.d.ts

@@ -15,3 +15,4 @@ export * from "./increment-string";
 export * from "./logger";
 export * from "./is-update-group";
 export * from "./revertable-tasks";
+export * from "./sessionLocalStorage";

package/dist/types/utils/sessionLocalStorage.d.ts

@@ -0,0 +1,23 @@
+import { UserSession } from "@esri/arcgis-rest-auth";
+/**
+ * Remove any serialized sessions associated with the passed clientId
+ * from a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ */
+export declare function clearSession(clientId: string, win?: any): void;
+/**
+ * Re-hydrate a UserSession from a browser's local storage.
+ * If not found,
+ * @param clientId oAuth Client Id
+ * @param win optional window (used for testing)
+ * @returns
+ */
+export declare function getSession(clientId: string, win?: any): UserSession | null;
+/**
+ * Serialize a UserSession into a browser's local storage
+ * @param clientId oAuth Client Id
+ * @param session UserSession
+ * @param win optional window (used for testing)
+ */
+export declare function saveSession(clientId: string, session: UserSession, win?: any): void;