@esri/hub-common 14.30.1 → 14.32.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"getObjectSize.js","sourceRoot":"","sources":["../../../src/utils/getObjectSize.ts"],"names":[],"mappings":";;;AAKA,4DAA4D;AAC5D,SAAgB,aAAa,CAAC,MAA2B;IACvD,4DAA4D;IAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IAChD,MAAM,SAAS,GAAG,KAAK,GAAG,IAAI,CAAC;IAC/B,MAAM,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;IACnC,OAAO;QACL,KAAK;QACL,SAAS;QACT,SAAS;KACV,CAAC;AACJ,CAAC;AAVD,sCAUC"}

package/dist/node/utils/hubUserAppResources.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserHubSettings = exports.setUserHubSettings = exports.getUserSiteSettings = exports.setUserSiteSettings = void 0;
+const clearUserSiteSettings_1 = require("./internal/clearUserSiteSettings");
+const clearUserHubSettings_1 = require("./internal/clearUserHubSettings");
+const siteSettingsMigrations_1 = require("./internal/siteSettingsMigrations");
+const userAppResources_1 = require("./internal/userAppResources");
+/**
+ * Store User settings in the Site App's cache
+ * @param settings
+ * @param context
+ * @param replace
+ * @returns
+ */
+async function setUserSiteSettings(settings, context, replace = false) {
+    const token = context.tokenFor(clearUserSiteSettings_1.USER_SITE_SETTINGS_APP);
+    if (token) {
+        // always stamp in the updated and username properties
+        settings.updated = new Date().getTime();
+        settings.username = context.currentUser.username;
+        const resource = {
+            key: clearUserSiteSettings_1.USER_SITE_SETTINGS_KEY,
+            data: settings,
+            access: "userappprivate",
+        };
+        return userAppResources_1.setUserResource(resource, context.currentUser.username, context.portalUrl, token, replace);
+    }
+    else {
+        throw new Error(`No user-app-resource token available to store Site Settings`);
+    }
+}
+exports.setUserSiteSettings = setUserSiteSettings;
+/**
+ * Get the current user's settings for the current Site
+ * @param context
+ * @returns
+ */
+async function getUserSiteSettings(context) {
+    const token = context.tokenFor(clearUserSiteSettings_1.USER_SITE_SETTINGS_APP);
+    if (token) {
+        const settings = (await userAppResources_1.getUserResource(context.currentUser.username, clearUserSiteSettings_1.USER_SITE_SETTINGS_KEY, context.portalUrl, token));
+        // run though schema upgrades
+        return siteSettingsMigrations_1.applySiteSettingsMigrations(settings);
+    }
+    else {
+        return Promise.resolve(null);
+    }
+}
+exports.getUserSiteSettings = getUserSiteSettings;
+/**
+ * Store the current user's Hub settings
+ * @param settings
+ * @param context
+ * @param replace
+ * @returns
+ */
+async function setUserHubSettings(settings, context, replace = false) {
+    const token = context.tokenFor(clearUserHubSettings_1.USER_HUB_SETTINGS_APP);
+    if (token) {
+        // always stamp in the updated and username properties
+        settings.updated = new Date().getTime();
+        settings.username = context.currentUser.username;
+        const resource = {
+            key: clearUserHubSettings_1.USER_HUB_SETTINGS_KEY,
+            data: settings,
+            access: "userappprivate",
+        };
+        return userAppResources_1.setUserResource(resource, context.currentUser.username, context.portalUrl, token, replace);
+    }
+    else {
+        throw new Error(`No user-app-resource token available to store Site Settings`);
+    }
+}
+exports.setUserHubSettings = setUserHubSettings;
+/**
+ * Get the current user's settings for ArcGIS Hub
+ * @param context
+ * @returns
+ */
+async function getUserHubSettings(context) {
+    const token = context.tokenFor(clearUserHubSettings_1.USER_HUB_SETTINGS_APP);
+    if (token) {
+        const settings = await userAppResources_1.getUserResource(context.currentUser.username, clearUserHubSettings_1.USER_HUB_SETTINGS_KEY, context.portalUrl, token);
+        return siteSettingsMigrations_1.applyHubSettingsMigrations(settings);
+    }
+    else {
+        return Promise.resolve(null);
+    }
+}
+exports.getUserHubSettings = getUserHubSettings;
+//# sourceMappingURL=hubUserAppResources.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hubUserAppResources.js","sourceRoot":"","sources":["../../../src/utils/hubUserAppResources.ts"],"names":[],"mappings":";;;AACA,4EAG0C;AAC1C,0EAGyC;AACzC,8EAG2C;AAC3C,kEAIqC;AAoBrC;;;;;;GAMG;AACI,KAAK,UAAU,mBAAmB,CACvC,QAA2B,EAC3B,OAAuB,EACvB,UAAmB,KAAK;IAExB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,8CAAsB,CAAC,CAAC;IAEvD,IAAI,KAAK,EAAE;QACT,sDAAsD;QACtD,QAAQ,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACxC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC;QAEjD,MAAM,QAAQ,GAAqB;YACjC,GAAG,EAAE,8CAAsB;YAC3B,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB;SACzB,CAAC;QACF,OAAO,kCAAe,CACpB,QAAQ,EACR,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,OAAO,CAAC,SAAS,EACjB,KAAK,EACL,OAAO,CACR,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;KACH;AACH,CAAC;AA7BD,kDA6BC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CACvC,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,8CAAsB,CAAC,CAAC;IAEvD,IAAI,KAAK,EAAE;QACT,MAAM,QAAQ,GAAG,CAAC,MAAM,kCAAe,CACrC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,8CAAsB,EACtB,OAAO,CAAC,SAAS,EACjB,KAAK,CACN,CAA+B,CAAC;QACjC,6BAA6B;QAC7B,OAAO,oDAA2B,CAAC,QAAQ,CAAC,CAAC;KAC9C;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KAC9B;AACH,CAAC;AAjBD,kDAiBC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CACtC,QAA0B,EAC1B,OAAuB,EACvB,UAAmB,KAAK;IAExB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,4CAAqB,CAAC,CAAC;IAEtD,IAAI,KAAK,EAAE;QACT,sDAAsD;QACtD,QAAQ,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACxC,QAAQ,CAAC,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC;QACjD,MAAM,QAAQ,GAAqB;YACjC,GAAG,EAAE,4CAAqB;YAC1B,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,gBAAgB;SACzB,CAAC;QACF,OAAO,kCAAe,CACpB,QAAQ,EACR,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,OAAO,CAAC,SAAS,EACjB,KAAK,EACL,OAAO,CACR,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CACb,6DAA6D,CAC9D,CAAC;KACH;AACH,CAAC;AA5BD,gDA4BC;AAED;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CACtC,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,4CAAqB,CAAC,CAAC;IAEtD,IAAI,KAAK,EAAE;QACT,MAAM,QAAQ,GAAG,MAAM,kCAAe,CACpC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,4CAAqB,EACrB,OAAO,CAAC,SAAS,EACjB,KAAK,CACN,CAAC;QACF,OAAO,mDAA0B,CAAC,QAAQ,CAAC,CAAC;KAC7C;SAAM;QACL,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KAC9B;AACH,CAAC;AAhBD,gDAgBC"}

package/dist/node/utils/index.js

@@ -26,4 +26,6 @@ tslib_1.__exportStar(require("./titleize"), exports);
 tslib_1.__exportStar(require("./memoize"), exports);
 tslib_1.__exportStar(require("./getEnvironmentFromPortalUrl"), exports);
 tslib_1.__exportStar(require("./poll"), exports);
+tslib_1.__exportStar(require("./hubUserAppResources"), exports);
+tslib_1.__exportStar(require("./getObjectSize"), 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,yDAA+B;AAC/B,kDAAwB;AACxB,qDAA2B;AAC3B,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;AACtC,sDAA4B;AAC5B,qDAA2B;AAC3B,oDAA0B;AAC1B,wEAA8C;AAC9C,iDAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/index.ts"],"names":[],"mappings":";;;AAAA,yDAA+B;AAC/B,kDAAwB;AACxB,qDAA2B;AAC3B,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;AACtC,sDAA4B;AAC5B,qDAA2B;AAC3B,oDAA0B;AAC1B,wEAA8C;AAC9C,iDAAuB;AACvB,gEAAsC;AACtC,0DAAgC"}

package/dist/node/utils/internal/clearUserHubSettings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearUserHubSettings = exports.USER_HUB_SETTINGS_KEY = exports.USER_HUB_SETTINGS_APP = void 0;
+const userAppResources_1 = require("./userAppResources");
+exports.USER_HUB_SETTINGS_APP = "hubforarcgis";
+exports.USER_HUB_SETTINGS_KEY = "hub-settings.json";
+/**
+ * @private
+ * Internal use only; Clear User Hub Settings
+ * @param context
+ * @returns
+ */
+function clearUserHubSettings(context) {
+    const token = context.tokenFor(exports.USER_HUB_SETTINGS_APP);
+    const key = exports.USER_HUB_SETTINGS_KEY;
+    return userAppResources_1.removeUserResource(context.currentUser.username, key, context.portalUrl, token);
+}
+exports.clearUserHubSettings = clearUserHubSettings;
+//# sourceMappingURL=clearUserHubSettings.js.map

package/dist/node/utils/internal/clearUserHubSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearUserHubSettings.js","sourceRoot":"","sources":["../../../../src/utils/internal/clearUserHubSettings.ts"],"names":[],"mappings":";;;AAEA,yDAAwD;AAE3C,QAAA,qBAAqB,GAAoB,cAAc,CAAC;AACxD,QAAA,qBAAqB,GAAG,mBAAmB,CAAC;AACzD;;;;;GAKG;AAEH,SAAgB,oBAAoB,CAClC,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,6BAAqB,CAAC,CAAC;IACtD,MAAM,GAAG,GAAG,6BAAqB,CAAC;IAClC,OAAO,qCAAkB,CACvB,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,GAAG,EACH,OAAO,CAAC,SAAS,EACjB,KAAK,CACN,CAAC;AACJ,CAAC;AAXD,oDAWC"}

package/dist/node/utils/internal/clearUserSiteSettings.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clearUserSiteSettings = exports.USER_SITE_SETTINGS_KEY = exports.USER_SITE_SETTINGS_APP = void 0;
+const userAppResources_1 = require("./userAppResources");
+exports.USER_SITE_SETTINGS_APP = "self";
+exports.USER_SITE_SETTINGS_KEY = "hub-site-settings.json";
+/**
+ * @private
+ * Internal use only; Clear User Site Settings
+ * @param context
+ * @returns
+ */
+function clearUserSiteSettings(context) {
+    const token = context.tokenFor(exports.USER_SITE_SETTINGS_APP);
+    const key = exports.USER_SITE_SETTINGS_KEY;
+    return userAppResources_1.removeUserResource(context.currentUser.username, key, context.portalUrl, token);
+}
+exports.clearUserSiteSettings = clearUserSiteSettings;
+//# sourceMappingURL=clearUserSiteSettings.js.map

package/dist/node/utils/internal/clearUserSiteSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clearUserSiteSettings.js","sourceRoot":"","sources":["../../../../src/utils/internal/clearUserSiteSettings.ts"],"names":[],"mappings":";;;AAEA,yDAAwD;AAE3C,QAAA,sBAAsB,GAAoB,MAAM,CAAC;AACjD,QAAA,sBAAsB,GAAG,wBAAwB,CAAC;AAE/D;;;;;GAKG;AACH,SAAgB,qBAAqB,CACnC,OAAuB;IAEvB,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,8BAAsB,CAAC,CAAC;IACvD,MAAM,GAAG,GAAG,8BAAsB,CAAC;IACnC,OAAO,qCAAkB,CACvB,OAAO,CAAC,WAAW,CAAC,QAAQ,EAC5B,GAAG,EACH,OAAO,CAAC,SAAS,EACjB,KAAK,CACN,CAAC;AACJ,CAAC;AAXD,sDAWC"}

package/dist/node/utils/internal/siteSettingsMigrations.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.applyHubSettingsMigrations = exports.applySiteSettingsMigrations = void 0;
+const util_1 = require("../../util");
+/**
+ * Apply migrations for Site Settings
+ * @param settings
+ * @returns
+ */
+function applySiteSettingsMigrations(settings) {
+    // const currentSchema = 1;
+    return util_1.cloneObject(settings);
+}
+exports.applySiteSettingsMigrations = applySiteSettingsMigrations;
+/**
+ * Apply migrations for Hub Settings
+ * @param settings
+ * @returns
+ */
+function applyHubSettingsMigrations(settings) {
+    // const currentSchema = 1;
+    return util_1.cloneObject(settings);
+}
+exports.applyHubSettingsMigrations = applyHubSettingsMigrations;
+//# sourceMappingURL=siteSettingsMigrations.js.map

package/dist/node/utils/internal/siteSettingsMigrations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"siteSettingsMigrations.js","sourceRoot":"","sources":["../../../../src/utils/internal/siteSettingsMigrations.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AAGzC;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,QAA6B;IAE7B,2BAA2B;IAE3B,OAAO,kBAAW,CAAC,QAAQ,CAAsB,CAAC;AACpD,CAAC;AAND,kEAMC;AAED;;;;GAIG;AACH,SAAgB,0BAA0B,CACxC,QAA6B;IAE7B,2BAA2B;IAE3B,OAAO,kBAAW,CAAC,QAAQ,CAAqB,CAAC;AACnD,CAAC;AAND,gEAMC"}

package/dist/node/utils/internal/userAppResources.js

@@ -0,0 +1,108 @@
+"use strict";
+// These Types and Functions can land in rest-js
+// a friendly name for the scope of the resource
+// the API deals with clientIds, which are
+// listed here https://confluencewikidev.esri.com/pages/viewpage.action?pageId=50561461
+// Generally speaking, the UserResourceScope is a downcased version of the
+// clientId. Hub is unique b/c Sites have their own clientId,
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listUserResources = exports.removeUserResource = exports.getUserResource = exports.setUserResource = void 0;
+const arcgis_rest_request_1 = require("@esri/arcgis-rest-request");
+const fail_safe_1 = require("../fail-safe");
+const getObjectSize_1 = require("../getObjectSize");
+/**
+ * @private
+ * Set a User-App-Resource
+ * By default this will fetch and merge with an existing resource.
+ * Passing `true` as the last parameter,
+ * @param resource
+ * @param username
+ * @param portalUrl
+ * @param token
+ * @param replace
+ * @returns
+ */
+async function setUserResource(resource, username, portalUrl, token, replace = false) {
+    // Ensure we are below 5MB max size
+    if (getObjectSize_1.getObjectSize(resource.data).megabytes > 4.95) {
+        throw new Error(`User Resource is too large to store. Please ensure it is less than 5MB in size`);
+    }
+    let payload = resource.data;
+    if (!replace) {
+        const fsGetResource = fail_safe_1.failSafe(getUserResource, {});
+        const currentResource = await fsGetResource(username, resource.key, portalUrl, token);
+        // extend current object witn updated object
+        payload = Object.assign(Object.assign({}, currentResource), resource.data);
+    }
+    const ro = {
+        portal: portalUrl,
+        httpMethod: "POST",
+        params: {
+            text: JSON.stringify(payload),
+            access: resource.access,
+            key: resource.key,
+            token,
+        },
+    };
+    // TODO Experiment w/ how we can make this call w/o creating a UserSession with the token
+    return arcgis_rest_request_1.request(`${portalUrl}/sharing/rest/community/users/${username}/addResource`, ro);
+}
+exports.setUserResource = setUserResource;
+/**
+ * @private
+ * Gets a user app resource
+ * If the resource does not exist, this will throw. This can be wrapped in `failSafe`
+ * configured to return an empty object.
+ * @param username
+ * @param key
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+function getUserResource(username, key, portalUrl, token) {
+    const ro = {
+        portal: portalUrl,
+    };
+    return arcgis_rest_request_1.request(`${portalUrl}/sharing/rest/community/users/${username}/resources/${key}?token=${token}`, ro);
+}
+exports.getUserResource = getUserResource;
+/**
+ * @private
+ * Remove a resource
+ * Used primarily in tests, but can be useful if you need to clean up
+ * settings that are no longer used
+ * @param username
+ * @param key
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+function removeUserResource(username, key, portalUrl, token) {
+    const ro = {
+        portal: portalUrl,
+        httpMethod: "POST",
+        params: {
+            key,
+            token,
+        },
+    };
+    return arcgis_rest_request_1.request(`${portalUrl}/sharing/rest/community/users/${username}/removeResource`, ro);
+}
+exports.removeUserResource = removeUserResource;
+/**
+ * @private
+ * List user resources associated with the user/token.
+ * Defaults to listing only resources associated with the app the token is associated with
+ * @param username
+ * @param portalUrl
+ * @param token
+ * @returns
+ */
+function listUserResources(username, portalUrl, token, returnAllApps = false) {
+    const ro = {
+        portal: portalUrl,
+    };
+    return arcgis_rest_request_1.request(`${portalUrl}/sharing/rest/community/users/${username}/resources?f=json&token=${token}&returnAllApps=${returnAllApps}`, ro);
+}
+exports.listUserResources = listUserResources;
+//# sourceMappingURL=userAppResources.js.map

package/dist/node/utils/internal/userAppResources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userAppResources.js","sourceRoot":"","sources":["../../../../src/utils/internal/userAppResources.ts"],"names":[],"mappings":";AAAA,gDAAgD;AAChD,gDAAgD;AAChD,0CAA0C;AAC1C,uFAAuF;AACvF,0EAA0E;AAC1E,6DAA6D;;;AAE7D,mEAAqE;AACrE,4CAAwC;AACxC,oDAAiD;AAiGjD;;;;;;;;;;;GAWG;AACI,KAAK,UAAU,eAAe,CACnC,QAA0B,EAC1B,QAAgB,EAChB,SAAiB,EACjB,KAAa,EACb,UAAmB,KAAK;IAExB,mCAAmC;IACnC,IAAI,6BAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,GAAG,IAAI,EAAE;QACjD,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;KACH;IAED,IAAI,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,EAAE;QACZ,MAAM,aAAa,GAAG,oBAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QACpD,MAAM,eAAe,GAAG,MAAM,aAAa,CACzC,QAAQ,EACR,QAAQ,CAAC,GAAG,EACZ,SAAS,EACT,KAAK,CACN,CAAC;QACF,4CAA4C;QAC5C,OAAO,mCAAQ,eAAe,GAAK,QAAQ,CAAC,IAAI,CAAE,CAAC;KACpD;IACD,MAAM,EAAE,GAAoB;QAC1B,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE;YACN,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;YAC7B,MAAM,EAAE,QAAQ,CAAC,MAAM;YACvB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,KAAK;SACN;KACF,CAAC;IACF,yFAAyF;IACzF,OAAO,6BAAO,CACZ,GAAG,SAAS,iCAAiC,QAAQ,cAAc,EACnE,EAAE,CACH,CAAC;AACJ,CAAC;AAzCD,0CAyCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAC7B,QAAgB,EAChB,GAAW,EACX,SAAiB,EACjB,KAAa;IAEb,MAAM,EAAE,GAAoB;QAC1B,MAAM,EAAE,SAAS;KAClB,CAAC;IACF,OAAO,6BAAO,CACZ,GAAG,SAAS,iCAAiC,QAAQ,cAAc,GAAG,UAAU,KAAK,EAAE,EACvF,EAAE,CACH,CAAC;AACJ,CAAC;AAbD,0CAaC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAChC,QAAgB,EAChB,GAAW,EACX,SAAiB,EACjB,KAAa;IAEb,MAAM,EAAE,GAAoB;QAC1B,MAAM,EAAE,SAAS;QACjB,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE;YACN,GAAG;YACH,KAAK;SACN;KACF,CAAC;IACF,OAAO,6BAAO,CACZ,GAAG,SAAS,iCAAiC,QAAQ,iBAAiB,EACtE,EAAE,CACH,CAAC;AACJ,CAAC;AAlBD,gDAkBC;AAED;;;;;;;;GAQG;AACH,SAAgB,iBAAiB,CAC/B,QAAgB,EAChB,SAAiB,EACjB,KAAa,EACb,gBAAyB,KAAK;IAE9B,MAAM,EAAE,GAAoB;QAC1B,MAAM,EAAE,SAAS;KAClB,CAAC;IACF,OAAO,6BAAO,CACZ,GAAG,SAAS,iCAAiC,QAAQ,2BAA2B,KAAK,kBAAkB,aAAa,EAAE,EACtH,EAAE,CACmC,CAAC;AAC1C,CAAC;AAbD,8CAaC"}

package/dist/node/utils/poll.js

@@ -4,26 +4,39 @@ exports.poll = void 0;
 /**
  * Function to poll a provided request until a validation
  * state or timeout is reached
+ *
+ * NOTE: we expose this as a public util, but should use this
+ * functionality sparingly when dealing with the Portal API.
+ * Best practice is to leverage this polling functionality
+ * internally on functions that we know incur a Portal delay.
+ *
  * @param requestFn
  * @param validationFn
  * @param opts
  */
 exports.poll = async (requestFn, validationFn, opts) => {
-    const options = opts || /* istanbul ignore next - must pass in overrides for tests */ {};
-    const timeout = options.timeout || 30000;
-    const timeBetweenRequests = options.timeBetweenRequests ||
-        /* istanbul ignore next - cannot delay by this much in tests */ 3000;
+    const options = opts || /* istanbul ignore next - we must pass in overrides for tests */ {};
+    const timeout = isNaN(options.timeout) ? 30000 : options.timeout;
+    /* istanbul ignore next - should not cover the 3000 case in tests */
+    const timeBetweenRequests = isNaN(options.timeBetweenRequests)
+        ? 3000
+        : options.timeBetweenRequests;
     let resp;
     let requestCount = 0;
+    let timeElapsed = 0;
     do {
         // On subsequent requests, check if the timeout has been reached
         // If YES: throw an error
         // If NO: delay before the next request
         if (requestCount > 0) {
-            if (requestCount * timeBetweenRequests >= timeout) {
+            timeElapsed += requestCount * timeBetweenRequests;
+            if (timeElapsed >= timeout) {
                 throw new Error("Polling timeout");
             }
-            await delay(timeBetweenRequests);
+            // NOTE: we incrementally increase the time between requests
+            // so as not to hammer an API with subsequent calls.
+            // This was specifically requested by the Portal API team
+            await delay(requestCount * timeBetweenRequests);
         }
         resp = await requestFn();
         requestCount++;

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

@@ -1 +1 @@
-{"version":3,"file":"poll.js","sourceRoot":"","sources":["../../../src/utils/poll.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACU,QAAA,IAAI,GAAG,KAAK,EACvB,SAAoB,EACpB,YAAoC,EACpC,IAGC,EACa,EAAE;IAChB,MAAM,OAAO,GACX,IAAI,IAAI,6DAA6D,CAAC,EAAE,CAAC;IAC3E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC;IACzC,MAAM,mBAAmB,GACvB,OAAO,CAAC,mBAAmB;QAC3B,+DAA+D,CAAC,IAAI,CAAC;IAEvE,IAAI,IAAS,CAAC;IACd,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,GAAG;QACD,gEAAgE;QAChE,yBAAyB;QACzB,uCAAuC;QACvC,IAAI,YAAY,GAAG,CAAC,EAAE;YACpB,IAAI,YAAY,GAAG,mBAAmB,IAAI,OAAO,EAAE;gBACjD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;aACpC;YACD,MAAM,KAAK,CAAC,mBAAmB,CAAC,CAAC;SAClC;QAED,IAAI,GAAG,MAAM,SAAS,EAAE,CAAC;QACzB,YAAY,EAAE,CAAC;KAChB,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;IAE9B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,YAAoB,EAAE,EAAE;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;AACrE,CAAC,CAAC"}
+{"version":3,"file":"poll.js","sourceRoot":"","sources":["../../../src/utils/poll.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;GAYG;AACU,QAAA,IAAI,GAAG,KAAK,EACvB,SAAoB,EACpB,YAAoC,EACpC,IAGC,EACa,EAAE;IAChB,MAAM,OAAO,GACX,IAAI,IAAI,gEAAgE,CAAC,EAAE,CAAC;IAC9E,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IACjE,oEAAoE;IACpE,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC;QAC5D,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC;IAEhC,IAAI,IAAS,CAAC;IACd,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,WAAW,GAAG,CAAC,CAAC;IAEpB,GAAG;QACD,gEAAgE;QAChE,yBAAyB;QACzB,uCAAuC;QACvC,IAAI,YAAY,GAAG,CAAC,EAAE;YACpB,WAAW,IAAI,YAAY,GAAG,mBAAmB,CAAC;YAClD,IAAI,WAAW,IAAI,OAAO,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;aACpC;YAED,4DAA4D;YAC5D,oDAAoD;YACpD,yDAAyD;YACzD,MAAM,KAAK,CAAC,YAAY,GAAG,mBAAmB,CAAC,CAAC;SACjD;QAED,IAAI,GAAG,MAAM,SAAS,EAAE,CAAC;QACzB,YAAY,EAAE,CAAC;KAChB,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE;IAE9B,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,KAAK,GAAG,CAAC,YAAoB,EAAE,EAAE;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC;AACrE,CAAC,CAAC"}

package/dist/types/ArcGISContext.d.ts

@@ -4,6 +4,7 @@ import { IRequestOptions } from "@esri/arcgis-rest-request";
 import { HubServiceStatus } from "./core";
 import { HubEnvironment, HubLicense, IFeatureFlags } from "./permissions/types";
 import { IHubRequestOptions, IHubTrustedOrgsResponse } from "./types";
+import { IUserResourceToken, UserResourceApp } from "./ArcGISContextManager";
 /**
  * Defines the properties of the ArcGISContext.
  * Typically components or functions will get an instance
@@ -170,6 +171,16 @@ export interface IArcGISContext {
      * Trusted orgs xhr response
      */
     trustedOrgs: IHubTrustedOrgsResponse[];
+    /**
+     * Array of exchanged tokens for use
+     * with user-app-resources
+     */
+    userResourceTokens?: IUserResourceToken[];
+    /**
+     * Return the token for a given app, if defined
+     * @param app
+     */
+    tokenFor(app: UserResourceApp): string;
 }
 /**
  * Options for the ArcGISContext constructor
@@ -230,6 +241,11 @@ export interface IArcGISContextOptions {
      * Trusted orgs xhr response
      */
     trustedOrgs?: IHubTrustedOrgsResponse[];
+    /**
+     * Array of exchanged tokens for use
+     * with user-app-resources
+     */
+    userResourceTokens?: IUserResourceToken[];
 }
 /**
  * Abstraction that holds a `UserSession`, along with
@@ -261,6 +277,7 @@ export declare class ArcGISContext implements IArcGISContext {
     private _featureFlags;
     private _trustedOrgIds;
     private _trustedOrgs;
+    private _userResourceTokens;
     /**
      * Create a new instance of `ArcGISContext`.
      *
@@ -419,4 +436,14 @@ export declare class ArcGISContext implements IArcGISContext {
      * Returns the array of Trusted Orgs
      */
     get trustedOrgs(): IHubTrustedOrgsResponse[];
+    /**
+     * Return the whole array of user resource tokens
+     */
+    get userResourceTokens(): IUserResourceToken[];
+    /**
+     * Return a token for a specific app
+     * @param app
+     * @returns
+     */
+    tokenFor(app: UserResourceApp): string;
 }

package/dist/types/ArcGISContextManager.d.ts

@@ -5,6 +5,14 @@ import { Level } from "./utils/logger";
 import { HubServiceStatus } from "./core";
 import { IFeatureFlags } from "./permissions";
 import { IHubTrustedOrgsResponse } from "./types";
+export declare type UserResourceApp = "self" | "hubforarcgis" | "arcgisonline";
+export interface IUserResourceConfig {
+    app: UserResourceApp;
+    clientId: string;
+}
+export interface IUserResourceToken extends IUserResourceConfig {
+    token: string;
+}
 /**
  * Options that can be passed into `ArcGISContextManager.create`
  */
@@ -65,6 +73,16 @@ export interface IArcGISContextManagerOptions {
      * Trusted orgs xhr response
      */
     trustedOrgs?: IHubTrustedOrgsResponse[];
+    /**
+     * Array of app, clientId's that Context Manager should
+     * exchange tokens for
+     */
+    resourceConfigs?: IUserResourceConfig[];
+    /**
+     * Array of app, clientId, token objects which Context
+     * Manager has exchanged tokens for
+     */
+    resourceTokens?: IUserResourceToken[];
 }
 /**
  * The manager exposes context (`IArcGISContext`), which combines a `UserSession` with
@@ -99,6 +117,8 @@ export declare class ArcGISContextManager {
     private _featureFlags;
     private _trustedOrgIds;
     private _trustedOrgs;
+    private _resourceConfigs;
+    private _resourceTokens;
     /**
      * Private constructor. Use `ArcGISContextManager.create(...)` to
      * instantiate an instance
@@ -166,3 +186,4 @@ export declare class ArcGISContextManager {
      */
     private get contextOpts();
 }
+export declare const ALPHA_ORGS: string[];

package/dist/types/sites/feed-configuration.d.ts

@@ -0,0 +1,20 @@
+import { IModel } from "../types";
+declare type FeedFormat = "dcat-us" | "dcat-ap" | "rss";
+/**
+ * Returns feed configuration from a site model
+ *
+ * @param {IModel} site - site model
+ * @param {FeedFormat} format - feed format
+ * @param {string} version  - semantic version
+ */
+export declare function getFeedConfiguration(site: IModel, format: FeedFormat, version: string): any;
+/**
+ * Returns feed configuration from a site model
+ *
+ * @param {IModel} site - site model
+ * @param {FeedFormat} format - feed format
+ * @param {string} version  - semantic version
+ * @param {Record<string, any>} feedConfig - feed configuration
+ */
+export declare function setFeedConfiguration(site: IModel, format: FeedFormat, version: string, feedConfig: Record<string, any>): void;
+export {};

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

@@ -10,3 +10,4 @@ export * from "./HubSites";
 export * from "./site-schema-version";
 export * from "./themes";
 export * from "./upgrade-site-schema";
+export * from "./feed-configuration";

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

@@ -0,0 +1,6 @@
+export interface IObjectSize {
+    bytes: number;
+    kilobytes: number;
+    megabytes: number;
+}
+export declare function getObjectSize(object: Record<string, any>): IObjectSize;

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

@@ -0,0 +1,45 @@
+import { IArcGISContext } from "../ArcGISContext";
+/**
+ * Site Level Settings
+ */
+export interface IUserSiteSettings {
+    schemaVersion: number;
+    username?: string;
+    updated?: number;
+}
+/**
+ * Hub Level Settings
+ */
+export interface IUserHubSettings {
+    schemaVersion: number;
+    username?: string;
+    updated?: number;
+}
+/**
+ * Store User settings in the Site App's cache
+ * @param settings
+ * @param context
+ * @param replace
+ * @returns
+ */
+export declare function setUserSiteSettings(settings: IUserSiteSettings, context: IArcGISContext, replace?: boolean): Promise<void>;
+/**
+ * Get the current user's settings for the current Site
+ * @param context
+ * @returns
+ */
+export declare function getUserSiteSettings(context: IArcGISContext): Promise<IUserSiteSettings>;
+/**
+ * Store the current user's Hub settings
+ * @param settings
+ * @param context
+ * @param replace
+ * @returns
+ */
+export declare function setUserHubSettings(settings: IUserHubSettings, context: IArcGISContext, replace?: boolean): Promise<void>;
+/**
+ * Get the current user's settings for ArcGIS Hub
+ * @param context
+ * @returns
+ */
+export declare function getUserHubSettings(context: IArcGISContext): Promise<IUserHubSettings>;

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

@@ -23,3 +23,5 @@ export * from "./titleize";
 export * from "./memoize";
 export * from "./getEnvironmentFromPortalUrl";
 export * from "./poll";
+export * from "./hubUserAppResources";
+export * from "./getObjectSize";

package/dist/types/utils/internal/clearUserHubSettings.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { UserResourceApp } from "../../ArcGISContextManager";
+export declare const USER_HUB_SETTINGS_APP: UserResourceApp;
+export declare const USER_HUB_SETTINGS_KEY = "hub-settings.json";
+/**
+ * @private
+ * Internal use only; Clear User Hub Settings
+ * @param context
+ * @returns
+ */
+export declare function clearUserHubSettings(context: IArcGISContext): Promise<Record<string, any>>;

package/dist/types/utils/internal/clearUserSiteSettings.d.ts

@@ -0,0 +1,11 @@
+import { IArcGISContext } from "../../ArcGISContext";
+import { UserResourceApp } from "../../ArcGISContextManager";
+export declare const USER_SITE_SETTINGS_APP: UserResourceApp;
+export declare const USER_SITE_SETTINGS_KEY = "hub-site-settings.json";
+/**
+ * @private
+ * Internal use only; Clear User Site Settings
+ * @param context
+ * @returns
+ */
+export declare function clearUserSiteSettings(context: IArcGISContext): Promise<Record<string, any>>;

package/dist/types/utils/internal/siteSettingsMigrations.d.ts

@@ -0,0 +1,13 @@
+import { IUserHubSettings, IUserSiteSettings } from "../hubUserAppResources";
+/**
+ * Apply migrations for Site Settings
+ * @param settings
+ * @returns
+ */
+export declare function applySiteSettingsMigrations(settings: Record<string, any>): IUserSiteSettings;
+/**
+ * Apply migrations for Hub Settings
+ * @param settings
+ * @returns
+ */
+export declare function applyHubSettingsMigrations(settings: Record<string, any>): IUserHubSettings;