@esri/hub-common 9.10.1 → 9.13.0

package/dist/esm/ArcGISContext.js

@@ -0,0 +1,395 @@
+import { __awaiter, __generator } from "tslib";
+import { getSelf } from "@esri/arcgis-rest-portal";
+import { getProp, getWithDefault } from ".";
+/**
+ * Hash of Hub API end points so updates
+ * are centralized
+ */
+var 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.
+ */
+var ArcGISContext = /** @class */ (function () {
+    /**
+     * Private constructor. Use `ArcGISContext.create(...)` to
+     * instantiate an instance
+     * @param opts
+     */
+    function ArcGISContext(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
+     */
+    ArcGISContext.create = function (opts) {
+        if (opts === void 0) { opts = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var ctx;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        ctx = new ArcGISContext(opts);
+                        return [4 /*yield*/, ctx.initialize()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, ctx];
+                }
+            });
+        });
+    };
+    /**
+     * If we have a UserSession, fetch portal/self and
+     * store that along with current user
+     */
+    ArcGISContext.prototype.initialize = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var ps;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._authentication) return [3 /*break*/, 2];
+                        this.log("ArcGISContext-" + this.id + ": Initializing");
+                        return [4 /*yield*/, getSelf({ authentication: this._authentication })];
+                    case 1:
+                        ps = _a.sent();
+                        this._portalSelf = ps;
+                        this._currentUser = ps.user;
+                        _a.label = 2;
+                    case 2: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    // Set authentication after the instance is up and running
+    ArcGISContext.prototype.setAuthentication = function (auth) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this._authentication = auth;
+                        this._portalUrl = auth.portal.replace("/sharing/rest", "");
+                        return [4 /*yield*/, this.initialize()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * @internal
+     * Log debugging messages to the console
+     * @param message
+     */
+    ArcGISContext.prototype.log = function (message) {
+        if (this._debug) {
+            // tslint:disable-next-line:no-console
+            console.info(message);
+        }
+    };
+    Object.defineProperty(ArcGISContext.prototype, "session", {
+        /**
+         * Return the UserSession if authenticated
+         */
+        get: function () {
+            return this._authentication;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "isAuthenticated", {
+        /**
+         * Return boolean indicating if authenticatio is present
+         */
+        get: function () {
+            return !!this._authentication;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "userRequestOptions", {
+        /**
+         * Return `IUserRequestOptions`, which is used for REST-JS
+         * functions which require authentication information.
+         *
+         * If context is not authenticated, this function will throw
+         */
+        get: function () {
+            if (this.isAuthenticated) {
+                return {
+                    authentication: this._authentication,
+                    portal: this.sharingApiUrl,
+                };
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "requestOptions", {
+        /**
+         * 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: function () {
+            var ro = {
+                portal: this.sharingApiUrl,
+            };
+            if (this.isAuthenticated) {
+                ro = {
+                    authentication: this._authentication,
+                    portal: this.sharingApiUrl,
+                };
+            }
+            return ro;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "hubRequestOptions", {
+        /**
+         * Return a `IHubRequestOptions` object
+         */
+        get: function () {
+            // 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,
+            };
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "portalUrl", {
+        // ==============================
+        // 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: function () {
+            if (this.isAuthenticated) {
+                if (this.isPortal) {
+                    return "https://" + this._portalSelf.portalHostname;
+                }
+                else {
+                    return "https://" + this._portalSelf.urlKey + "." + this._portalSelf.customBaseUrl;
+                }
+            }
+            else {
+                return this._portalUrl;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "sharingApiUrl", {
+        /**
+         * Returns the url to the sharing api
+         * i.e. https://myorg.maps.arcgis.com/sharing/rest
+         */
+        get: function () {
+            return this.portalUrl + "/sharing/rest";
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "hubUrl", {
+        get: function () {
+            return this._hubUrl;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "isPortal", {
+        /**
+         * Returns boolean indicating if the backing system
+         * is ArcGIS Enterprise (formerly ArcGIS Portal) or not
+         */
+        get: function () {
+            return this._portalSelf
+                ? this._portalSelf.isPortal
+                : this._portalUrl.indexOf("arcgis.com") === -1;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "discussionsServiceUrl", {
+        // Hub APIs
+        // ----------
+        // Discussions
+        get: function () {
+            if (this._hubUrl) {
+                return "" + this._hubUrl + hubApiEndpoints.discussions;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "hubSearchServiceUrl", {
+        // Hub Search
+        get: function () {
+            if (this._hubUrl) {
+                return "" + this._hubUrl + hubApiEndpoints.search;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "domainServiceUrl", {
+        // Domain
+        get: function () {
+            if (this._hubUrl) {
+                return "" + this._hubUrl + hubApiEndpoints.domains;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "eventsConfig", {
+        // Events
+        // returns `{serviceId: '3ef..', publicViewId: 'bc3...'}
+        get: function () {
+            if (this._portalSelf) {
+                return getProp(this._portalSelf, "portalProperties.hub.settings.events");
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "hubEnabled", {
+        /**
+         * Returns boolean indicating if the current user
+         * belongs to an organization that has licensed
+         * ArcGIS Hub
+         */
+        get: function () {
+            return getWithDefault(this._portalSelf, "portalProperties.hub.enabled", false);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "communityOrgId", {
+        /**
+         * Return Hub Community Org Id, if defined
+         */
+        get: function () {
+            if (this._portalSelf) {
+                return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.orgId");
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "communityOrgHostname", {
+        get: function () {
+            if (this._portalSelf) {
+                return getProp(this._portalSelf, "portalProperties.hub.settings.communityOrg.portalHostname");
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "communityOrgUrl", {
+        get: function () {
+            if (this.communityOrgHostname) {
+                return "https://" + this.communityOrgHostname;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "helperServices", {
+        // Platform API service urls are all in helperServices
+        // and not consistent to expose as urls
+        get: function () {
+            if (this._portalSelf) {
+                return this._portalSelf.helperServices;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "currentUser", {
+        get: function () {
+            return this._currentUser;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArcGISContext.prototype, "portal", {
+        get: function () {
+            return this._portalSelf;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return ArcGISContext;
+}());
+export { 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) {
+    var 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/esm/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,IAAM,eAAe,GAAG;IACtB,OAAO,EAAE,iBAAiB;IAC1B,MAAM,EAAE,kBAAkB;IAC1B,WAAW,EAAE,qBAAqB;CACnC,CAAC;AA+BF;;;;;;;;;;;GAWG;AACH;IAoBE;;;;OAIG;IACH,uBAAoB,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,kCAAgC,IAAI,CAAC,EAAI,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;IACiB,oBAAM,GAA1B,UACE,IAAgC;QAAhC,qBAAA,EAAA,SAAgC;;;;;;wBAE1B,GAAG,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC;wBACpC,qBAAM,GAAG,CAAC,UAAU,EAAE,EAAA;;wBAAtB,SAAsB,CAAC;wBACvB,sBAAO,GAAG,EAAC;;;;KACZ;IAED;;;OAGG;IACG,kCAAU,GAAhB;;;;;;6BACM,IAAI,CAAC,eAAe,EAApB,wBAAoB;wBACtB,IAAI,CAAC,GAAG,CAAC,mBAAiB,IAAI,CAAC,EAAE,mBAAgB,CAAC,CAAC;wBACxC,qBAAM,OAAO,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,EAAA;;wBAA5D,EAAE,GAAG,SAAuD;wBAClE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;wBACtB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC,IAAI,CAAC;;;;;;KAE/B;IAED,0DAA0D;IACpD,yCAAiB,GAAvB,UAAwB,IAAiB;;;;;wBACvC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;wBAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;wBAC3D,qBAAM,IAAI,CAAC,UAAU,EAAE,EAAA;;wBAAvB,SAAuB,CAAC;;;;;KACzB;IAED;;;;OAIG;IACK,2BAAG,GAAX,UAAY,OAAe;QACzB,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,sCAAsC;YACtC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SACvB;IACH,CAAC;IAKD,sBAAW,kCAAO;QAHlB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,eAAe,CAAC;QAC9B,CAAC;;;OAAA;IAKD,sBAAW,0CAAe;QAH1B;;WAEG;aACH;YACE,OAAO,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC;QAChC,CAAC;;;OAAA;IAQD,sBAAW,6CAAkB;QAN7B;;;;;WAKG;aACH;YACE,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,OAAO;oBACL,cAAc,EAAE,IAAI,CAAC,eAAe;oBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;iBAC3B,CAAC;aACH;QACH,CAAC;;;OAAA;IAUD,sBAAW,yCAAc;QARzB;;;;;;;WAOG;aACH;YACE,IAAI,EAAE,GAAQ;gBACZ,MAAM,EAAE,IAAI,CAAC,aAAa;aAC3B,CAAC;YACF,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,EAAE,GAAG;oBACH,cAAc,EAAE,IAAI,CAAC,eAAe;oBACpC,MAAM,EAAE,IAAI,CAAC,aAAa;iBAC3B,CAAC;aACH;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;;;OAAA;IAKD,sBAAW,4CAAiB;QAH5B;;WAEG;aACH;YACE,qEAAqE;YACrE,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;QACJ,CAAC;;;OAAA;IAeD,sBAAW,oCAAS;QAbpB,iCAAiC;QACjC,gCAAgC;QAChC,iCAAiC;QAEjC;;;;;;;;WAQG;aACH;YACE,IAAI,IAAI,CAAC,eAAe,EAAE;gBACxB,IAAI,IAAI,CAAC,QAAQ,EAAE;oBACjB,OAAO,aAAW,IAAI,CAAC,WAAW,CAAC,cAAgB,CAAC;iBACrD;qBAAM;oBACL,OAAO,aAAW,IAAI,CAAC,WAAW,CAAC,MAAM,SAAI,IAAI,CAAC,WAAW,CAAC,aAAe,CAAC;iBAC/E;aACF;iBAAM;gBACL,OAAO,IAAI,CAAC,UAAU,CAAC;aACxB;QACH,CAAC;;;OAAA;IAMD,sBAAW,wCAAa;QAJxB;;;WAGG;aACH;YACE,OAAU,IAAI,CAAC,SAAS,kBAAe,CAAC;QAC1C,CAAC;;;OAAA;IAED,sBAAW,iCAAM;aAAjB;YACE,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;;;OAAA;IAMD,sBAAW,mCAAQ;QAJnB;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,WAAW;gBACrB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;gBAC3B,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;QACnD,CAAC;;;OAAA;IAKD,sBAAW,gDAAqB;QAHhC,WAAW;QACX,aAAa;QACb,cAAc;aACd;YACE,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,OAAO,KAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,WAAa,CAAC;aACxD;QACH,CAAC;;;OAAA;IAGD,sBAAW,8CAAmB;QAD9B,aAAa;aACb;YACE,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,OAAO,KAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,MAAQ,CAAC;aACnD;QACH,CAAC;;;OAAA;IAGD,sBAAW,2CAAgB;QAD3B,SAAS;aACT;YACE,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,OAAO,KAAG,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC,OAAS,CAAC;aACpD;QACH,CAAC;;;OAAA;IAID,sBAAW,uCAAY;QAFvB,SAAS;QACT,wDAAwD;aACxD;YACE,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,sCAAsC,CAAC,CAAC;aAC1E;QACH,CAAC;;;OAAA;IAOD,sBAAW,qCAAU;QALrB;;;;WAIG;aACH;YACE,OAAO,cAAc,CACnB,IAAI,CAAC,WAAW,EAChB,8BAA8B,EAC9B,KAAK,CACN,CAAC;QACJ,CAAC;;;OAAA;IAKD,sBAAW,yCAAc;QAHzB;;WAEG;aACH;YACE,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,kDAAkD,CACnD,CAAC;aACH;QACH,CAAC;;;OAAA;IAED,sBAAW,+CAAoB;aAA/B;YACE,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,OAAO,OAAO,CACZ,IAAI,CAAC,WAAW,EAChB,2DAA2D,CAC5D,CAAC;aACH;QACH,CAAC;;;OAAA;IAED,sBAAW,0CAAe;aAA1B;YACE,IAAI,IAAI,CAAC,oBAAoB,EAAE;gBAC7B,OAAO,aAAW,IAAI,CAAC,oBAAsB,CAAC;aAC/C;QACH,CAAC;;;OAAA;IAID,sBAAW,yCAAc;QAFzB,sDAAsD;QACtD,uCAAuC;aACvC;YACE,IAAI,IAAI,CAAC,WAAW,EAAE;gBACpB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;aACxC;QACH,CAAC;;;OAAA;IAED,sBAAW,sCAAW;aAAtB;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;;;OAAA;IAED,sBAAW,iCAAM;aAAjB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC;QAC1B,CAAC;;;OAAA;IACH,oBAAC;AAAD,CAAC,AAjSD,IAiSC;;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/esm/OperationError.js

@@ -0,0 +1,40 @@
+/* Copyright (c) 2018-2020 Environmental Systems Research Institute, Inc.
+ * Apache-2.0 */
+import { __extends } from "tslib";
+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
+ */
+var OperationError = /** @class */ (function (_super) {
+    __extends(OperationError, _super);
+    /**
+     * Creates an instance of OperationError.
+     * @param {string} operation
+     * @param {string} [message]
+     * @param {Error} [rootCause]
+     * @memberof OperationError
+     */
+    function OperationError(operation, message, rootCause) {
+        var _this = this;
+        message = message || "UNKNOWN_ERROR";
+        // if the rootCause has a .rootCause, use that so we don't deeply nest
+        rootCause = getWithDefault(rootCause, "rootCause", rootCause);
+        _this = _super.call(this, message) || this;
+        _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);
+        return _this;
+    }
+    return OperationError;
+}(Error));
+export default OperationError;
+//# sourceMappingURL=OperationError.js.map

package/dist/esm/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;IAA4C,kCAAK;IAwB/C;;;;;;OAMG;IACH,wBAAY,SAAiB,EAAE,OAAgB,EAAE,SAAiB;QAAlE,iBAcC;QAbC,OAAO,GAAG,OAAO,IAAI,eAAe,CAAC;QACrC,sEAAsE;QACtE,SAAS,GAAG,cAAc,CAAC,SAAS,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QAC9D,QAAA,kBAAM,OAAO,CAAC,SAAC;QACf,KAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,KAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,KAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;QACtD,gFAAgF;QAChF,iEAAiE;QACjE,+DAA+D;QAC/D,4CAA4C;QAC5C,KAAI,CAAC,KAAK,GAAG,cAAc,CAAC,SAAS,EAAE,OAAO,EAAE,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;;IACrE,CAAC;IACH,qBAAC;AAAD,CAAC,AA9CD,CAA4C,KAAK,GA8ChD"}