@esri/hub-common 9.10.1 → 9.13.0

package/dist/es2017/ArcGISContext.js

@@ -0,0 +1,280 @@
+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",
+};
+/**
+ * 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 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 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 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.
+ *
+ * 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/es2017/ArcGISContext.js.map

@@ -0,0 +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"}

package/dist/es2017/OperationError.js

@@ -0,0 +1,34 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { getWithDefault } from "./objects/get-with-default";
+/**
+ * Generic Solution Error with an Error stack as well
+ * as an optional serialized OperationStack.
+ *
+ * Also accepts a `rootCause` Error object
+ */
+export default class OperationError extends Error {
+    /**
+     * Creates an instance of OperationError.
+     * @param {string} operation
+     * @param {string} [message]
+     * @param {Error} [rootCause]
+     * @memberof OperationError
+     */
+    constructor(operation, message, rootCause) {
+        message = message || "UNKNOWN_ERROR";
+        // if the rootCause has a .rootCause, use that so we don't deeply nest
+        rootCause = getWithDefault(rootCause, "rootCause", rootCause);
+        super(message);
+        this.operation = operation;
+        this.name = "OperationError";
+        this.rootCause = rootCause;
+        Object.setPrototypeOf(this, OperationError.prototype);
+        // using rootCause.stack ensures that the resulting error will have the original
+        // message + call stack. If that's not an option, we create a new
+        // stack... which is better than nothing, but it will look like
+        // OperationError is the source of the error
+        this.stack = getWithDefault(rootCause, "stack", new Error().stack);
+    }
+}
+//# sourceMappingURL=OperationError.js.map

package/dist/es2017/OperationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationError.js","sourceRoot":"","sources":["../../src/OperationError.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAG5D;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,KAAK;IAwB/C;;;;;;OAMG;IACH,YAAY,SAAiB,EAAE,OAAgB,EAAE,SAAiB;QAChE,OAAO,GAAG,OAAO,IAAI,eAAe,CAAC;QACrC,sEAAsE;QACtE,SAAS,GAAG,cAAc,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QAC9D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;QACtD,gFAAgF;QAChF,iEAAiE;QACjE,+DAA+D;QAC/D,4CAA4C;QAC5C,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;CACF"}

package/dist/es2017/OperationStack.js

@@ -0,0 +1,260 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { cloneObject, createId } from "./util";
+import { getWithDefault } from "./objects/get-with-default";
+/**
+ * Allows an application to track a series of operations, storing information
+ * about the arguments passes in and the results returned
+ *
+ * ```js
+ * import { OperationStack } from '@esri/solution-common';
+ *
+ * const stack = new OperationStack();
+ *
+ * // start an operation by type
+ * const id = stack.start('getItem');
+ * //.. work happens...
+ * stack.finish(id);
+ *
+ * // start an operation with an Operation object
+ * stack.start({
+ *   id: 'createItem_1',
+ *   type: 'createItem',
+ *   inputs: {
+ *    item: {...truncated...},
+ *    portal: 'https://www.arcgis.com',
+ *    username: 'jsmith'
+ *   },
+ * });
+ * // make the call
+ * stack.finish('createItem_1', {newItemId: '00cf213'});
+ *
+ * // later you can get that information back out of the stack
+ * const prevOp = stack.getOperation('createItem_1);
+ *
+ * // and if you need to roll back you can use the
+ * // .cleanup and .output properties to help orchestrate
+ *
+ * ```
+ *
+ *
+ * Can be used to implement "atomic" operations in an environment that does not
+ * have this as a core feature
+ */
+export default class OperationStack {
+    /**
+     * Creates an instance of OperationStack.
+     * @memberof OperationStack
+     */
+    constructor() {
+        this.operations = [];
+    }
+    /**
+     * Start an Operation
+     *
+     * ```js
+     * const stack = new OperationStack();
+     * stack.startOperation({
+     *  id: 'get-bc3',
+     *  type: 'getItem',
+     *  cleanup: 'n/a',
+     *  inputs: {
+     *    id: 'bc3',
+     *    owner: 'vader'
+     *  }
+     * });
+     * // do work
+     * stack.finish('get-bc3');
+     * ```
+     *
+     *
+     * @param {IOperation} operation
+     * @memberof OperationStack
+     */
+    startOperation(operation) {
+        const op = cloneObject(operation);
+        op.startedAt = new Date().getTime();
+        op.state = "working";
+        this.operations.push(op);
+    }
+    /**
+     * Start an operation without requiring a full operation
+     *
+     * ```js
+     * const opId = stack.start('getItems');
+     * //...work happens
+     * stack.finish(opId);
+     * ```
+     *
+     * @param {string} type Type of the operation. i.e. getItem
+     * @param {Record<string, unknown>} [params] optionally pass in id, inputs, cleanup
+     * @returns {string} Identifier of the new stack entry
+     * @memberof OperationStack
+     */
+    start(type, params) {
+        const op = {
+            type,
+            id: getWithDefault(params, "id", createId(`${type}_`)),
+            inputs: getWithDefault(params, "inputs", {}),
+            cleanup: getWithDefault(params, "cleanup", "n/a"),
+            startedAt: new Date().getTime(),
+            state: "working"
+        };
+        this.operations.push(op);
+        return op.id;
+    }
+    /**
+     * Returns a reference to an Operation
+     *
+     * @param {string} id Unique Identifier
+     * @returns {Operation}
+     * @memberof OperationStack
+     */
+    getOperation(id) {
+        return this.operations.find(o => o.id === id);
+    }
+    /**
+     * Returns reference to the operations array
+     *
+     * @returns {Operation[]}
+     * @memberof OperationStack
+     */
+    getOperations() {
+        return this.operations;
+    }
+    /**
+     * Inform the stack that an operation has finished.
+     *
+     * This will append in a duration property, and mark
+     * the state as 'completed'.
+     *
+     * @param {string} id Unique identifier of the Operation
+     * @param {Record<string, unknown>} [options] outputs
+     * @memberof OperationStack
+     */
+    finish(id, options) {
+        const op = this.getOperation(id);
+        if (op) {
+            op.duration = new Date().getTime() - op.startedAt;
+            op.state = "completed";
+            if (options) {
+                op.output = cloneObject(options);
+            }
+        }
+        else {
+            throw new Error(`No operation with id ${id} present in stack`);
+        }
+    }
+    /**
+     * Merge a serialized operation stack into
+     * a stack instance
+     *
+     * ```js
+     *    import { OperationStack } from '@esri/solution-common';
+     *    function someFunction() {
+     *      const stack = new OperationStack();
+     *      stack.start('getItem', {id: 'get-bc3'});
+     *      // do some work...
+     *      stack.finish('get-bc3');
+     *
+     *      const itm = {title: 'Fake Item', type: 'Web Map'};
+     *      // create an entry for the function we are about to call...
+     *      stack.start('createItem', {id: 'createItem_01', inputs: {item: itm}});
+     *      // call a function that does work, and has it's own stack
+     *      // and returns a serialized version as part of it's results
+     *      return createItem(itm)
+     *      .then((result) => {
+     *        // tell the stack the last operation finished...
+     *        stack.finish('createItem_01');
+     *        // merge in the stack from the function we called
+     *        stack.merge(result.stack);
+     *        // > stack.getCompleted().length === 3
+     *      });
+     *    }
+     *
+     *    function createItem (itm) {
+     *      const otherStack = new OperationStack();
+     *      const id = otherStack.start('createItem');
+     *      // make calls to create item etc
+     *      otherStack.finish(id, {itemId: newItem.id});
+     *      otherStack.start('protectItem', {id: 'protect-00c'});
+     *      // make call to protect item...
+     *      otherStack.finish('protect-00c');
+     *      // all done... return a result with a stack
+     *      return Promise.resolve({
+     *        success:true,
+     *        stack: otherStack.serialize()
+     *      });
+     *    }
+     * ```
+     *
+     *  Typically used to create a comprehensive list of operations
+     *  when a function returns a `SerializedOperationStack` as part of
+     *  it's response
+     *
+     *
+     * @param {ISerializedOperationStack} stack
+     * @memberof OperationStack
+     */
+    merge(stack) {
+        this.operations = [...this.operations, ...stack.operations];
+    }
+    /**
+     * Get a list of the completed operations
+     *
+     * @returns {IOperation[]}
+     * @memberof OperationStack
+     */
+    getCompleted() {
+        return cloneObject(this.operations.filter(e => e.state === "completed"));
+    }
+    /**
+     *  Return an array of working operations
+     *
+     * @returns {IOperation[]}
+     * @memberof OperationStack
+     */
+    getWorking() {
+        return cloneObject(this.operations.filter(e => e.state === "working"));
+    }
+    /**
+     * Serialize the completed operations into a set of
+     * human readable messages, sorted by the startedAt timestamp
+     *
+     *
+     * @returns {string}
+     * @memberof IOperationStack
+     */
+    toString() {
+        // sort the operations by StartedAt
+        const allOps = this.operations.sort((a, b) => {
+            if (a.startedAt < b.startedAt) {
+                return -1;
+            }
+            if (b.startedAt < a.startedAt) {
+                return 1;
+            }
+            return 0;
+        });
+        return allOps.map(getOperationMessage).join("\n");
+    }
+    /**
+     * Serialize the stack into simple objects
+     *
+     * @returns {ISerializedOperationStack}
+     * @memberof OperationStack
+     */
+    serialize() {
+        return {
+            operations: cloneObject(this.getOperations())
+        };
+    }
+}
+function getOperationMessage(op) {
+    let msg = `${op.startedAt} : Operation ${op.id} started with inputs ${JSON.stringify(op.inputs)} but was not completed`;
+    if (op.state === "completed") {
+        msg = `${op.startedAt} : Operation ${op.id} took ${op.duration} ms with inputs ${JSON.stringify(op.inputs)} and output ${op.output ? JSON.stringify(op.output) : "n/a"}`;
+    }
+    return msg;
+}
+//# sourceMappingURL=OperationStack.js.map

package/dist/es2017/OperationStack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OperationStack.js","sourceRoot":"","sources":["../../src/OperationStack.ts"],"names":[],"mappings":"AAAA;gBACgB;AAEhB,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAG5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;IAUjC;;;OAGG;IACH;QACE,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;IACvB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,cAAc,CAAC,SAAqB;QAClC,MAAM,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;QAClC,EAAE,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACpC,EAAE,CAAC,KAAK,GAAG,SAAS,CAAC;QACrB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAY,EAAE,MAAgC;QAClD,MAAM,EAAE,GAAG;YACT,IAAI;YACJ,EAAE,EAAE,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;YACtD,MAAM,EAAE,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC;YAC5C,OAAO,EAAE,cAAc,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC;YACjD,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE;YAC/B,KAAK,EAAE,SAAS;SACH,CAAC;QAEhB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,EAAE,CAAC,EAAE,CAAC;IACf,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAChD,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IACD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,OAAiC;QAClD,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACjC,IAAI,EAAE,EAAE;YACN,EAAE,CAAC,QAAQ,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC;YAClD,EAAE,CAAC,KAAK,GAAG,WAAW,CAAC;YACvB,IAAI,OAAO,EAAE;gBACX,EAAE,CAAC,MAAM,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;aAClC;SACF;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,wBAAwB,EAAE,mBAAmB,CAAC,CAAC;SAChE;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkDG;IACH,KAAK,CAAC,KAAgC;QACpC,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,YAAY;QACV,OAAO,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACR,OAAO,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ;QACN,mCAAmC;QACnC,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YAC3C,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,EAAE;gBAC7B,OAAO,CAAC,CAAC,CAAC;aACX;YACD,IAAI,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,EAAE;gBAC7B,OAAO,CAAC,CAAC;aACV;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,SAAS;QACP,OAAO;YACL,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;SAC9C,CAAC;IACJ,CAAC;CACF;AAED,SAAS,mBAAmB,CAAC,EAAc;IACzC,IAAI,GAAG,GAAG,GAAG,EAAE,CAAC,SAAS,gBACvB,EAAE,CAAC,EACL,wBAAwB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,wBAAwB,CAAC;IAC1E,IAAI,EAAE,CAAC,KAAK,KAAK,WAAW,EAAE;QAC5B,GAAG,GAAG,GAAG,EAAE,CAAC,SAAS,gBAAgB,EAAE,CAAC,EAAE,SACxC,EAAE,CAAC,QACL,mBAAmB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,eAC1C,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAC1C,EAAE,CAAC;KACJ;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/es2017/access/can-edit-event.js

@@ -0,0 +1,19 @@
+import { getProp } from "../objects";
+import { findBy } from "../util";
+import { hasBasePriv } from "./has-base-priv";
+/**
+ * Checks if user has access to edit an event in Hub
+ * @param {IEventModel} model consolidated event model as consumed by Hub, contains the event feature, related initiative model, and attendees group
+ * @param {IUser} user
+ * @returns {boolean}
+ */
+export function canEditEvent(model, user) {
+    let res = false;
+    if (hasBasePriv(user)) {
+        const coreTeamId = getProp(model, "initiative.item.properties.collaborationGroupId");
+        const { groups = [] } = user;
+        res = !!coreTeamId && !!findBy(groups, "id", coreTeamId);
+    }
+    return res;
+}
+//# sourceMappingURL=can-edit-event.js.map

package/dist/es2017/access/can-edit-event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"can-edit-event.js","sourceRoot":"","sources":["../../../src/access/can-edit-event.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAkB,EAAE,IAAW;IAC1D,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACrB,MAAM,UAAU,GAAG,OAAO,CACxB,KAAK,EACL,iDAAiD,CAClD,CAAC;QACF,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC;QAC7B,GAAG,GAAG,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;KAC1D;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/es2017/access/can-edit-item.js

@@ -0,0 +1,34 @@
+import { isUpdateGroup, includes } from "../utils";
+import { getProp } from "../objects";
+import { hasBasePriv } from "./has-base-priv";
+/**
+ * Checks if user has access to edit an item in Hub
+ * @param {IItem} item
+ * @param {IUser} user
+ * @returns {boolean}
+ */
+export function canEditItem(item, user) {
+    let res = false;
+    const itemControls = ["admin", "update"];
+    const { itemControl, owner, orgId: itemOrgId } = item;
+    const { roleId, role, username, groups: userGroups, orgId: userOrgId } = user;
+    const hasItemControl = includes(itemControls, itemControl);
+    const isOwner = !!owner && owner === username;
+    const isOrgItem = !!itemOrgId && itemOrgId === userOrgId;
+    const isItemOrgAdmin = !!isOrgItem && !roleId && role === "org_admin";
+    const hasPlatformControl = hasItemControl || isOwner || isItemOrgAdmin;
+    const hasPriv = hasBasePriv(user);
+    if (hasPriv && hasPlatformControl) {
+        res = true;
+    }
+    else if (hasPriv) {
+        const itemGroups = [
+            ...(getProp(item, "groupIds") || []),
+            getProp(item, "properties.collaborationGroupId")
+        ];
+        const isGroupEditable = (group) => isUpdateGroup(group) && includes(itemGroups, group.id);
+        res = userGroups.some(isGroupEditable);
+    }
+    return res;
+}
+//# sourceMappingURL=can-edit-item.js.map

package/dist/es2017/access/can-edit-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"can-edit-item.js","sourceRoot":"","sources":["../../../src/access/can-edit-item.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,IAAW,EAAE,IAAW;IAClD,IAAI,GAAG,GAAG,KAAK,CAAC;IAChB,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC9E,MAAM,cAAc,GAAG,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,IAAI,KAAK,KAAK,QAAQ,CAAC;IAC9C,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,IAAI,SAAS,KAAK,SAAS,CAAC;IACzD,MAAM,cAAc,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,MAAM,IAAI,IAAI,KAAK,WAAW,CAAC;IACtE,MAAM,kBAAkB,GAAG,cAAc,IAAI,OAAO,IAAI,cAAc,CAAC;IACvE,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,OAAO,IAAI,kBAAkB,EAAE;QACjC,GAAG,GAAG,IAAI,CAAC;KACZ;SAAM,IAAI,OAAO,EAAE;QAClB,MAAM,UAAU,GAAG;YACjB,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,CAAC;YACpC,OAAO,CAAC,IAAI,EAAE,iCAAiC,CAAC;SACjD,CAAC;QACF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAW,EAAE,CACjD,aAAa,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACzD,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;KACxC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}