@esri/hub-common 12.11.0 → 12.13.0

package/dist/node/discussions/edit.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteDiscussion = exports.updateDiscussion = exports.createDiscussion = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const models_1 = require("../models");
+const slugs_1 = require("../items/slugs");
+const index_1 = require("../index");
+const PropertyMapper_1 = require("../core/_internal/PropertyMapper");
+const getPropertyMap_1 = require("./_internal/getPropertyMap");
+const computeProps_1 = require("./_internal/computeProps");
+const defaults_1 = require("./defaults");
+/**
+ * @private
+ * Create a new Hub Discussion item
+ *
+ * Minimal properties are name and orgUrlKey
+ *
+ * @param partialDiscussion a partial discussion
+ * @param requestOptions user request options
+ * @returns promise that resolves a IHubDiscussion
+ */
+async function createDiscussion(partialDiscussion, requestOptions) {
+    // merge incoming with the default
+    // this expansion solves the typing somehow
+    const discussion = Object.assign(Object.assign({}, defaults_1.DEFAULT_DISCUSSION), partialDiscussion);
+    // Create a slug from the title if one is not passed in
+    if (!discussion.slug) {
+        discussion.slug = slugs_1.constructSlug(discussion.name, discussion.orgUrlKey);
+    }
+    // Ensure slug is  unique
+    discussion.slug = await slugs_1.getUniqueSlug({ slug: discussion.slug }, requestOptions);
+    // add slug to keywords
+    discussion.typeKeywords = slugs_1.setSlugKeyword(discussion.typeKeywords, discussion.slug);
+    // Map discussion object onto a default discussion Model
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    // create model from object, using the default model as a starting point
+    let model = mapper.objectToModel(discussion, index_1.cloneObject(defaults_1.DEFAULT_DISCUSSION_MODEL));
+    // create the item
+    model = await models_1.createModel(model, requestOptions);
+    // map the model back into a IHubDiscussion
+    let newDiscussion = mapper.modelToObject(model, {});
+    newDiscussion = computeProps_1.computeProps(model, newDiscussion, requestOptions);
+    // and return it
+    return newDiscussion;
+}
+exports.createDiscussion = createDiscussion;
+/**
+ * @private
+ * Update a Hub Discussion
+ * @param discussion the discussion to update
+ * @param requestOptions user request options
+ * @returns promise that resolves a IHubDiscussion
+ */
+async function updateDiscussion(discussion, requestOptions) {
+    // verify that the slug is unique, excluding the current discussion
+    discussion.slug = await slugs_1.getUniqueSlug({ slug: discussion.slug, existingId: discussion.id }, requestOptions);
+    // get the backing item & data
+    const model = await models_1.getModel(discussion.id, requestOptions);
+    // create the PropertyMapper
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    // Note: Although we are fetching the model, and applying changes onto it,
+    // we are not attempting to handle "concurrent edit" conflict resolution
+    // but this is where we would apply that sort of logic
+    const modelToUpdate = mapper.objectToModel(discussion, model);
+    // update the backing item
+    const updatedModel = await models_1.updateModel(modelToUpdate, requestOptions);
+    // now map back into a discussion and return that
+    let updatedDiscussion = mapper.modelToObject(updatedModel, discussion);
+    updatedDiscussion = computeProps_1.computeProps(model, updatedDiscussion, requestOptions);
+    // the casting is needed because modelToObject returns a `Partial<T>`
+    // where as this function returns a `T`
+    return updatedDiscussion;
+}
+exports.updateDiscussion = updateDiscussion;
+/**
+ * @private
+ * Remove a Hub Discussion
+ * @param id the discussion item id
+ * @param requestOptions request options
+ * @returns a promise
+ */
+async function deleteDiscussion(id, requestOptions) {
+    const ro = Object.assign(Object.assign({}, requestOptions), { id });
+    await arcgis_rest_portal_1.removeItem(ro);
+    return;
+}
+exports.deleteDiscussion = deleteDiscussion;
+//# sourceMappingURL=edit.js.map

package/dist/node/discussions/edit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"edit.js","sourceRoot":"","sources":["../../../src/discussions/edit.ts"],"names":[],"mappings":";;;AACA,iEAAwE;AAExE,sCAA+D;AAC/D,0CAA8E;AAC9E,oCAAuC;AACvC,qEAAkE;AAClE,+DAA4D;AAC5D,2DAAwD;AACxD,yCAA0E;AAE1E;;;;;;;;;GASG;AACI,KAAK,UAAU,gBAAgB,CACpC,iBAA0C,EAC1C,cAAmC;IAEnC,kCAAkC;IAClC,2CAA2C;IAC3C,MAAM,UAAU,mCAAQ,6BAAkB,GAAK,iBAAiB,CAAE,CAAC;IAEnE,uDAAuD;IACvD,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;QACpB,UAAU,CAAC,IAAI,GAAG,qBAAa,CAAC,UAAU,CAAC,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC;KACxE;IACD,yBAAyB;IACzB,UAAU,CAAC,IAAI,GAAG,MAAM,qBAAa,CACnC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,EACzB,cAAc,CACf,CAAC;IACF,uBAAuB;IACvB,UAAU,CAAC,YAAY,GAAG,sBAAc,CACtC,UAAU,CAAC,YAAY,EACvB,UAAU,CAAC,IAAI,CAChB,CAAC;IACF,wDAAwD;IACxD,MAAM,MAAM,GAAG,IAAI,+BAAc,CAA0B,+BAAc,EAAE,CAAC,CAAC;IAC7E,wEAAwE;IACxE,IAAI,KAAK,GAAG,MAAM,CAAC,aAAa,CAC9B,UAAU,EACV,mBAAW,CAAC,mCAAwB,CAAC,CACtC,CAAC;IACF,kBAAkB;IAClB,KAAK,GAAG,MAAM,oBAAW,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACjD,2CAA2C;IAC3C,IAAI,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACpD,aAAa,GAAG,2BAAY,CAAC,KAAK,EAAE,aAAa,EAAE,cAAc,CAAC,CAAC;IACnE,gBAAgB;IAChB,OAAO,aAA+B,CAAC;AACzC,CAAC;AApCD,4CAoCC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CACpC,UAA0B,EAC1B,cAAmC;IAEnC,mEAAmE;IACnE,UAAU,CAAC,IAAI,GAAG,MAAM,qBAAa,CACnC,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,EACpD,cAAc,CACf,CAAC;IACF,8BAA8B;IAC9B,MAAM,KAAK,GAAG,MAAM,iBAAQ,CAAC,UAAU,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IAC5D,4BAA4B;IAC5B,MAAM,MAAM,GAAG,IAAI,+BAAc,CAA0B,+BAAc,EAAE,CAAC,CAAC;IAC7E,0EAA0E;IAC1E,wEAAwE;IACxE,sDAAsD;IACtD,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC9D,0BAA0B;IAC1B,MAAM,YAAY,GAAG,MAAM,oBAAW,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;IACtE,iDAAiD;IACjD,IAAI,iBAAiB,GAAG,MAAM,CAAC,aAAa,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACvE,iBAAiB,GAAG,2BAAY,CAAC,KAAK,EAAE,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAC3E,qEAAqE;IACrE,uCAAuC;IACvC,OAAO,iBAAmC,CAAC;AAC7C,CAAC;AAzBD,4CAyBC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB,CACpC,EAAU,EACV,cAAmC;IAEnC,MAAM,EAAE,GAAG,gCAAK,cAAc,GAAK,EAAE,EAAE,EAAE,CAAsB,CAAC;IAChE,MAAM,+BAAU,CAAC,EAAE,CAAC,CAAC;IACrB,OAAO;AACT,CAAC;AAPD,4CAOC"}

package/dist/node/discussions/fetch.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertItemToDiscussion = exports.fetchDiscussion = void 0;
+const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const models_1 = require("../models");
+const slugs_1 = require("../items/slugs");
+const index_1 = require("../index");
+const PropertyMapper_1 = require("../core/_internal/PropertyMapper");
+const getPropertyMap_1 = require("./_internal/getPropertyMap");
+const computeProps_1 = require("./_internal/computeProps");
+/**
+ * @private
+ * Get a Discussion by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions request options
+ * @returns a promise that resolves a IHubDiscussion
+ */
+async function fetchDiscussion(identifier, requestOptions) {
+    let getPrms;
+    if (index_1.isGuid(identifier)) {
+        // get item by id
+        getPrms = arcgis_rest_portal_1.getItem(identifier, requestOptions);
+    }
+    else {
+        getPrms = slugs_1.getItemBySlug(identifier, requestOptions);
+    }
+    return getPrms.then((item) => {
+        if (!item)
+            return null;
+        return convertItemToDiscussion(item, requestOptions);
+    });
+}
+exports.fetchDiscussion = fetchDiscussion;
+/**
+ * @private
+ * Convert a Hub Discussion Item into a Hub Discussion, fetching any additional
+ * information that may be required
+ * @param item the discussion item
+ * @param auth request options
+ * @returns a promise that resolves a IHubDiscussion
+ */
+async function convertItemToDiscussion(item, requestOptions) {
+    const model = await models_1.fetchModelFromItem(item, requestOptions);
+    const mapper = new PropertyMapper_1.PropertyMapper(getPropertyMap_1.getPropertyMap());
+    const discussion = mapper.modelToObject(model, {});
+    return computeProps_1.computeProps(model, discussion, requestOptions);
+}
+exports.convertItemToDiscussion = convertItemToDiscussion;
+//# sourceMappingURL=fetch.js.map

package/dist/node/discussions/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../src/discussions/fetch.ts"],"names":[],"mappings":";;;AACA,iEAA0D;AAE1D,sCAA+C;AAC/C,0CAA+C;AAC/C,oCAAkC;AAClC,qEAAkE;AAClE,+DAA4D;AAC5D,2DAAwD;AAExD;;;;;;GAMG;AACI,KAAK,UAAU,eAAe,CACnC,UAAkB,EAClB,cAA+B;IAE/B,IAAI,OAAO,CAAC;IACZ,IAAI,cAAM,CAAC,UAAU,CAAC,EAAE;QACtB,iBAAiB;QACjB,OAAO,GAAG,4BAAO,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KAC/C;SAAM;QACL,OAAO,GAAG,qBAAa,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;KACrD;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QAC3B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QACvB,OAAO,uBAAuB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC;AAfD,0CAeC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,uBAAuB,CAC3C,IAAW,EACX,cAA+B;IAE/B,MAAM,KAAK,GAAG,MAAM,2BAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,+BAAc,CAA0B,+BAAc,EAAE,CAAC,CAAC;IAC7E,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAmB,CAAC;IACrE,OAAO,2BAAY,CAAC,KAAK,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;AACzD,CAAC;AARD,0DAQC"}

package/dist/node/discussions/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./HubDiscussion"), exports);
+tslib_1.__exportStar(require("./edit"), exports);
+tslib_1.__exportStar(require("./fetch"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/discussions/index.ts"],"names":[],"mappings":";;;AAAA,0DAAgC;AAChC,iDAAuB;AACvB,kDAAwB"}

package/dist/node/index.js

@@ -19,6 +19,7 @@ tslib_1.__exportStar(require("./extent"), exports);
 tslib_1.__exportStar(require("./groups"), exports);
 tslib_1.__exportStar(require("./i18n"), exports);
 tslib_1.__exportStar(require("./initiatives"), exports);
+tslib_1.__exportStar(require("./discussions"), exports);
 tslib_1.__exportStar(require("./items"), exports);
 tslib_1.__exportStar(require("./models"), exports);
 tslib_1.__exportStar(require("./objects"), exports);

package/dist/node/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;AAChB,0BAA0B;;;;AAE1B,mDAAyB;AACzB,gDAAsB;AACtB,0DAAgC;AAChC,iEAAuC;AACvC,iDAAuB;AACvB,uDAA6B;AAC7B,oDAA0B;AAC1B,iDAAuB;AACvB,yDAA+B;AAC/B,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,iDAAuB;AACvB,wDAA8B;AAC9B,kDAAwB;AACxB,mDAAyB;AACzB,oDAA0B;AAC1B,gDAAsB;AACtB,kDAAwB;AACxB,wDAA8B;AAC9B,qDAA2B;AAC3B,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,kDAAwB;AACxB,oDAA0B;AAC1B,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,uDAA6B;AAE7B,qDAA8C;AAKrC,yBALF,wBAAc,CAKE;AAJvB,qDAA8C;AAIrB,yBAJlB,wBAAc,CAIkB;AAHvC,yCAAkC;AAGO,mBAHlC,kBAAQ,CAGkC;AACjD,6BAAkC;AAAzB,4FAAA,IAAI,OAAA;AAAE,4FAAA,IAAI,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;gBACgB;AAChB,0BAA0B;;;;AAE1B,mDAAyB;AACzB,gDAAsB;AACtB,0DAAgC;AAChC,iEAAuC;AACvC,iDAAuB;AACvB,uDAA6B;AAC7B,oDAA0B;AAC1B,iDAAuB;AACvB,yDAA+B;AAC/B,sDAA4B;AAC5B,mDAAyB;AACzB,mDAAyB;AACzB,iDAAuB;AACvB,wDAA8B;AAC9B,wDAA8B;AAC9B,kDAAwB;AACxB,mDAAyB;AACzB,oDAA0B;AAC1B,gDAAsB;AACtB,kDAAwB;AACxB,wDAA8B;AAC9B,qDAA2B;AAC3B,oDAA0B;AAC1B,sDAA4B;AAC5B,mDAAyB;AACzB,kDAAwB;AACxB,oDAA0B;AAC1B,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,iDAAuB;AACvB,kDAAwB;AACxB,uDAA6B;AAE7B,qDAA8C;AAKrC,yBALF,wBAAc,CAKE;AAJvB,qDAA8C;AAIrB,yBAJlB,wBAAc,CAIkB;AAHvC,yCAAkC;AAGO,mBAHlC,kBAAQ,CAGkC;AACjD,6BAAkC;AAAzB,4FAAA,IAAI,OAAA;AAAE,4FAAA,IAAI,OAAA"}

package/dist/node/permissions/HubPermissionPolicies.js

@@ -4,6 +4,7 @@ exports.getPermissionPolicy = exports.HubPermissionsPolicies = void 0;
 const InitiativeBusinessRules_1 = require("../initiatives/_internal/InitiativeBusinessRules");
 const ProjectBusinessRules_1 = require("../projects/_internal/ProjectBusinessRules");
 const SiteBusinessRules_1 = require("../sites/_internal/SiteBusinessRules");
+const DiscussionBusinessRules_1 = require("../discussions/_internal/DiscussionBusinessRules");
 // Examples of possible Permission Policies
 // const DiscussionPermissionPolicies: IPermissionPolicy[] = [
 //   {
@@ -64,6 +65,7 @@ exports.HubPermissionsPolicies = [
     ...SiteBusinessRules_1.SitesPermissionPolicies,
     ...ProjectBusinessRules_1.ProjectPermissionPolicies,
     ...InitiativeBusinessRules_1.InitiativePermissionPolicies,
+    ...DiscussionBusinessRules_1.DiscussionPermissionPolicies,
 ];
 /**
  * Get the policies defined for a specific permission

package/dist/node/permissions/HubPermissionPolicies.js.map

@@ -1 +1 @@
-{"version":3,"file":"HubPermissionPolicies.js","sourceRoot":"","sources":["../../../src/permissions/HubPermissionPolicies.ts"],"names":[],"mappings":";;;AAAA,8FAAgG;AAChG,qFAAuF;AACvF,4EAA+E;AAI/E,2CAA2C;AAC3C,8DAA8D;AAC9D,MAAM;AACN,gDAAgD;AAChD,2BAA2B;AAC3B,mCAAmC;AACnC,8CAA8C;AAC9C,OAAO;AACP,MAAM;AACN,uDAAuD;AACvD,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,iDAAiD;AACjD,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,UAAU;AACV,2CAA2C;AAC3C,uCAAuC;AACvC,oCAAoC;AACpC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,gDAAgD;AAChD,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,6CAA6C;AAC7C,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AAEL;;GAEG;AACU,QAAA,sBAAsB,GAAwB;IACzD,GAAG,2CAAuB;IAC1B,GAAG,gDAAyB;IAC5B,GAAG,sDAA4B;CAChC,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,8BAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;AACzE,CAAC;AAFD,kDAEC"}
+{"version":3,"file":"HubPermissionPolicies.js","sourceRoot":"","sources":["../../../src/permissions/HubPermissionPolicies.ts"],"names":[],"mappings":";;;AAAA,8FAAgG;AAChG,qFAAuF;AACvF,4EAA+E;AAC/E,8FAAgG;AAIhG,2CAA2C;AAC3C,8DAA8D;AAC9D,MAAM;AACN,gDAAgD;AAChD,2BAA2B;AAC3B,mCAAmC;AACnC,8CAA8C;AAC9C,OAAO;AACP,MAAM;AACN,uDAAuD;AACvD,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,iDAAiD;AACjD,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,UAAU;AACV,2CAA2C;AAC3C,uCAAuC;AACvC,oCAAoC;AACpC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,gDAAgD;AAChD,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,MAAM;AACN,6CAA6C;AAC7C,mCAAmC;AACnC,2BAA2B;AAC3B,8CAA8C;AAC9C,oBAAoB;AACpB,UAAU;AACV,2CAA2C;AAC3C,gCAAgC;AAChC,kCAAkC;AAClC,WAAW;AACX,SAAS;AACT,OAAO;AACP,KAAK;AAEL;;GAEG;AACU,QAAA,sBAAsB,GAAwB;IACzD,GAAG,2CAAuB;IAC1B,GAAG,gDAAyB;IAC5B,GAAG,sDAA4B;IAC/B,GAAG,sDAA4B;CAChC,CAAC;AAEF;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,8BAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,UAAU,CAAC,CAAC;AACzE,CAAC;AAFD,kDAEC"}

package/dist/node/permissions/types/Permission.js

@@ -4,6 +4,7 @@ exports.isPermission = void 0;
 const ProjectBusinessRules_1 = require("../../projects/_internal/ProjectBusinessRules");
 const SiteBusinessRules_1 = require("../../sites/_internal/SiteBusinessRules");
 const InitiativeBusinessRules_1 = require("../../initiatives/_internal/InitiativeBusinessRules");
+const DiscussionBusinessRules_1 = require("../../discussions/_internal/DiscussionBusinessRules");
 /**
  * Defines the values for Permissions
  * It's critical that the arrays defined in the modules use `as const`
@@ -13,6 +14,7 @@ const validPermissions = [
     ...SiteBusinessRules_1.SitePermissions,
     ...ProjectBusinessRules_1.ProjectPermissions,
     ...InitiativeBusinessRules_1.InitiativePermissions,
+    ...DiscussionBusinessRules_1.DiscussionPermissions,
 ];
 /**
  * Validate a Permission

package/dist/node/permissions/types/Permission.js.map

@@ -1 +1 @@
-{"version":3,"file":"Permission.js","sourceRoot":"","sources":["../../../../src/permissions/types/Permission.ts"],"names":[],"mappings":";;;AAAA,wFAAmF;AACnF,+EAA0E;AAC1E,iGAA4F;AAE5F;;;;GAIG;AACH,MAAM,gBAAgB,GAAG;IACvB,GAAG,mCAAe;IAClB,GAAG,yCAAkB;IACrB,GAAG,+CAAqB;CAChB,CAAC;AAOX;;;;GAIG;AACH,SAAgB,YAAY,CAAC,eAAuB;IAClD,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAA6B,CAAC,CAAC;AAClE,CAAC;AAFD,oCAEC"}
+{"version":3,"file":"Permission.js","sourceRoot":"","sources":["../../../../src/permissions/types/Permission.ts"],"names":[],"mappings":";;;AAAA,wFAAmF;AACnF,+EAA0E;AAC1E,iGAA4F;AAC5F,iGAA4F;AAE5F;;;;GAIG;AACH,MAAM,gBAAgB,GAAG;IACvB,GAAG,mCAAe;IAClB,GAAG,yCAAkB;IACrB,GAAG,+CAAqB;IACxB,GAAG,+CAAqB;CAChB,CAAC;AAOX;;;;GAIG;AACH,SAAgB,YAAY,CAAC,eAAuB;IAClD,OAAO,gBAAgB,CAAC,QAAQ,CAAC,eAA6B,CAAC,CAAC;AAClE,CAAC;AAFD,oCAEC"}

package/dist/node/versioning/updateVersion.js

@@ -9,16 +9,37 @@ const getVersionData_1 = require("./_internal/getVersionData");
 const constants_1 = require("./_internal/constants");
 const getIncludeListFromItemType_1 = require("./_internal/getIncludeListFromItemType");
 const arcgis_rest_portal_1 = require("@esri/arcgis-rest-portal");
+const utils_1 = require("./utils");
+/**
+ * Custom error to be thrown when attempting to save a stale version
+ * @class StaleVersionError
+ * @extends {Error}
+ */
+class StaleVersionError extends Error {
+    constructor(id, updated) {
+        super(`Version ${id} is stale. Use force to overwrite.`);
+        this.updated = updated;
+        this.name = "StaleVersionError";
+    }
+}
 /**
  * Updates the specified version with with the state of the supplied model
+ * throws an exception if the version is stale and force is not true
  * @param model
  * @param version
  * @param requestOptions
+ * @param force
  * @returns
  */
-async function updateVersion(model, version, requestOptions) {
+async function updateVersion(model, version, requestOptions, force) {
     // we expect the model to contain the changes that we want to apply to the version
     // but we also need the versionResource so we can preserve the created and creator props
+    if (!force) {
+        const isStaleResponse = await utils_1.checkForStaleVersion(model.item.id, version, requestOptions);
+        if (isStaleResponse.isStale) {
+            throw new StaleVersionError(version.id, isStaleResponse.updated);
+        }
+    }
     const includeList = getIncludeListFromItemType_1.getIncludeListFromItemType(model);
     version.data = getVersionData_1.getVersionData(model, includeList);
     const prefix = getPrefix_1.getPrefix(version.id);

package/dist/node/versioning/updateVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAE9D;;;;;;GAMG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC;IAEtC,kFAAkF;IAClF,wFAAwF;IAExF,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AA7BD,sCA6BC"}
+{"version":3,"file":"updateVersion.js","sourceRoot":"","sources":["../../../src/versioning/updateVersion.ts"],"names":[],"mappings":";;;AACA,kDAA8C;AAC9C,4DAAwD;AACxD,0EAAoE;AAGpE,qDAAkD;AAClD,+DAA4D;AAC5D,qDAG+B;AAC/B,uFAAoF;AACpF,iEAA8D;AAC9D,mCAA+C;AAE/C;;;;GAIG;AACH,MAAM,iBAAkB,SAAQ,KAAK;IACnC,YAAY,EAAU,EAAS,OAAe;QAC5C,KAAK,CAAC,WAAW,EAAE,oCAAoC,CAAC,CAAC;QAD5B,YAAO,GAAP,OAAO,CAAQ;QAE5C,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAClC,CAAC;CACF;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,aAAa,CACjC,KAAa,EACb,OAAiB,EACjB,cAAsC,EACtC,KAAe;IAEf,kFAAkF;IAClF,wFAAwF;IAExF,IAAI,CAAC,KAAK,EAAE;QACV,MAAM,eAAe,GAAG,MAAM,4BAAoB,CAChD,KAAK,CAAC,IAAI,CAAC,EAAE,EACb,OAAO,EACP,cAAc,CACf,CAAC;QACF,IAAI,eAAe,CAAC,OAAO,EAAE;YAC3B,MAAM,IAAI,iBAAiB,CAAC,OAAO,CAAC,EAAE,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;SAClE;KACF;IAED,MAAM,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;IACtD,OAAO,CAAC,IAAI,GAAG,+BAAc,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAElD,MAAM,MAAM,GAAG,qBAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,MAAM,WAAW,GAAG,sCAAgB,CAAC,OAAO,CAAC,CAAC;IAE9C,MAAM,UAAU,GAAG,4BAAY,CAAC,OAAO,EAAE,EAAE,EAAE,uCAA2B,CAAC,CAAC;IAE1E,MAAM,uCAAkB,iCACnB,cAAc,KACjB,EAAE,EAAE,kBAAO,CAAC,KAAK,EAAE,SAAS,CAAC,EAC7B,IAAI,EAAE,iCAAqB,EAC3B,KAAK,EAAE,kBAAO,CAAC,KAAK,EAAE,YAAY,CAAC,EACnC,MAAM,EAAE,EAAE,UAAU,EAAE,EACtB,MAAM,EACN,OAAO,EAAE,IAAI,EACb,QAAQ,EAAE,WAAW,IACrB,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC;AAzCD,sCAyCC"}

package/dist/node/versioning/utils.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyVersion = void 0;
+exports.checkForStaleVersion = exports.applyVersion = void 0;
 const util_1 = require("../util");
 const merge_objects_1 = require("../objects/merge-objects");
+const getVersion_1 = require("./getVersion");
 const getIncludeListFromItemType_1 = require("./_internal/getIncludeListFromItemType");
 /**
  * Applies the versioned data to the model
@@ -18,4 +19,20 @@ function applyVersion(model, version, includeList) {
     return merge_objects_1.mergeObjects(version.data, util_1.cloneObject(model), includeList);
 }
 exports.applyVersion = applyVersion;
+/**
+ * Checks if the upstream version is newer than the passed in version
+ * @param itemId
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+async function checkForStaleVersion(itemId, version, requestOptions) {
+    const upstream = await getVersion_1.getVersion(itemId, version.id, requestOptions);
+    const isStale = upstream.updated > version.updated;
+    return {
+        isStale,
+        updated: upstream.updated,
+    };
+}
+exports.checkForStaleVersion = checkForStaleVersion;
 //# sourceMappingURL=utils.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AACtC,4DAAwD;AAGxD,uFAAoF;AAEpF;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,4BAAY,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC;AATD,oCASC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/versioning/utils.ts"],"names":[],"mappings":";;;AAAA,kCAAsC;AACtC,4DAAwD;AAGxD,6CAA0C;AAC1C,uFAAoF;AAEpF;;;;;;GAMG;AACH,SAAgB,YAAY,CAC1B,KAAa,EACb,OAAiB,EACjB,WAAsB;IAEtB,IAAI,CAAC,WAAW,EAAE;QAChB,WAAW,GAAG,uDAA0B,CAAC,KAAK,CAAC,CAAC;KACjD;IACD,OAAO,4BAAY,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAW,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;AACrE,CAAC;AATD,oCASC;AAOD;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAAc,EACd,OAAiB,EACjB,cAAsC;IAEtC,MAAM,QAAQ,GAAG,MAAM,uBAAU,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;IACtE,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IACnD,OAAO;QACL,OAAO;QACP,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,CAAC;AACJ,CAAC;AAXD,oDAWC"}

package/dist/types/content/_internal.d.ts

@@ -76,6 +76,7 @@ export declare const setContentBoundary: (content: IHubContent, boundary: Geogra
     url?: string;
     id: string;
     itemControl: string;
+    orgId?: string;
     access?: import("../core").AccessLevel;
     culture?: string;
     description?: string;

package/dist/types/core/HubItemEntity.d.ts

@@ -76,6 +76,11 @@ export declare abstract class HubItemEntity<T extends IHubItemEntity> implements
      * @returns
      */
     get canDelete(): boolean;
+    /**
+     * The orgId of the Entity, if available
+     * @returns the entity orgId, when available
+     */
+    get orgId(): string;
     /**
      * Share the Entity with the specified group id
      * @param groupId

package/dist/types/core/types/HubEntityType.d.ts

@@ -1 +1 @@
-export declare type HubEntityType = "site" | "project" | "initiative" | "page";
+export declare type HubEntityType = "site" | "project" | "initiative" | "page" | "discussion";

package/dist/types/core/types/IHubDiscussion.d.ts

@@ -0,0 +1,8 @@
+import { IWithPermissions, IWithSlug } from "../traits";
+import { IHubItemEntity } from "./IHubItemEntity";
+/**
+ * DRAFT: Under development and more properties will likely be added
+ * @internal
+ */
+export interface IHubDiscussion extends IHubItemEntity, IWithSlug, IWithPermissions {
+}

package/dist/types/core/types/IHubItemEntity.d.ts

@@ -81,4 +81,8 @@ export interface IHubItemEntity extends IHubEntityBase, IWithPermissions {
      */
     canDelete: boolean;
     location?: IHubLocation;
+    /**
+     * The orgId of the Entity, if available
+     */
+    orgId?: string;
 }

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

@@ -2,6 +2,7 @@ export * from "./HubEntity";
 export * from "./HubEntityType";
 export * from "./IHubContent";
 export * from "./IHubContentEnrichments";
+export * from "./IHubDiscussion";
 export * from "./IHubEntityBase";
 export * from "./IHubEvent";
 export * from "./IHubImage";

package/dist/types/discussions/HubDiscussion.d.ts

@@ -0,0 +1,44 @@
+import { IWithSharingBehavior, IWithStoreBehavior } from "../core/behaviors";
+import { IArcGISContext } from "../ArcGISContext";
+import { IHubDiscussion } from "../core/types";
+import { HubItemEntity } from "../core/HubItemEntity";
+/**
+ * Hub Discussion Class
+ */
+export declare class HubDiscussion extends HubItemEntity<IHubDiscussion> implements IWithStoreBehavior<IHubDiscussion>, IWithSharingBehavior {
+    /**
+     * Create an instance from an IHubDiscussion object
+     * @param json JSON object to create a HubDiscussion from
+     * @param context ArcGIS context
+     * @returns a HubDiscussion
+     */
+    static fromJson(json: Partial<IHubDiscussion>, context: IArcGISContext): HubDiscussion;
+    /**
+     * Create a new HubDiscussion, returning a HubDiscussion instance.
+     * Note: This does not persist the Discussion into the backing store
+     * @param partialDiscussion a partial IHubDiscussion
+     * @param context ArcGIS context
+     * @returns promise that resolves a HubDiscussion
+     */
+    static create(partialDiscussion: Partial<IHubDiscussion>, context: IArcGISContext, save?: boolean): Promise<HubDiscussion>;
+    /**
+     * Fetch a Discussion from the backing store and return a HubDiscussion instance.
+     * @param identifier slug or item id
+     * @param context ArcGIS context
+     * @returns promise that resolves a HubDiscussion
+     */
+    static fetch(identifier: string, context: IArcGISContext): Promise<HubDiscussion>;
+    private static applyDefaults;
+    /**
+     * Apply a new state to the instance
+     * @param changes A partial IHubDiscussion
+     */
+    update(changes: Partial<IHubDiscussion>): void;
+    save(): Promise<void>;
+    /**
+     * Delete the HubDiscussion from the store
+     * set a flag to indicate that it is destroyed
+     * @returns a promise
+     */
+    delete(): Promise<void>;
+}

package/dist/types/discussions/_internal/DiscussionBusinessRules.d.ts

@@ -0,0 +1,27 @@
+import { EntityCapabilities, ICapabilityPermission } from "../../capabilities";
+import { IPermissionPolicy } from "../../permissions";
+/**
+ * Default capabilities for a Discussion. If not listed here, the capability will not be available
+ * This hash is combined with the capabilities hash stored in the item data. Regardless of what
+ * properties are defined in the item data, only the capabilities defined here will be available
+ * @private
+ */
+export declare const DiscussionDefaultCapabilities: EntityCapabilities;
+/**
+ * List of all the Discussion Capability Permissions
+ * These are considered Hub Business Rules and are not intended
+ * to be modified by consumers
+ * @private
+ */
+export declare const DiscussionCapabilityPermissions: ICapabilityPermission[];
+/**
+ * Discussion Permission Policies
+ * These define the requirements any user must meet to perform related actions
+ * @private
+ */
+export declare const DiscussionPermissions: readonly ["hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view"];
+/**
+ * Discussion permission policies
+ * @private
+ */
+export declare const DiscussionPermissionPolicies: IPermissionPolicy[];

package/dist/types/discussions/_internal/computeProps.d.ts

@@ -0,0 +1,12 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IModel } from "../../types";
+import { IHubDiscussion } from "../../core";
+/**
+ * Given a model and a Discussion, set various computed properties that can't be directly mapped
+ * @private
+ * @param model
+ * @param discussion
+ * @param requestOptions
+ * @returns an IHubDiscussion
+ */
+export declare function computeProps(model: IModel, discussion: Partial<IHubDiscussion>, requestOptions: IRequestOptions): IHubDiscussion;

package/dist/types/discussions/_internal/getPropertyMap.d.ts

@@ -0,0 +1,8 @@
+import { IPropertyMap } from "../../core/_internal/PropertyMapper";
+/**
+ * Returns an Array of IPropertyMap objects
+ * that define the projection of properties from a IModel to an IHubDiscussion
+ * @returns an IPropertyMap array
+ * @private
+ */
+export declare function getPropertyMap(): IPropertyMap[];

package/dist/types/discussions/defaults.d.ts

@@ -0,0 +1,11 @@
+import { IHubDiscussion } from "../core/types";
+import { IModel } from "../types";
+export declare const HUB_DISCUSSION_ITEM_TYPE = "Discussion";
+/**
+ * Default values of a IHubDiscussion
+ */
+export declare const DEFAULT_DISCUSSION: Partial<IHubDiscussion>;
+/**
+ * Default values for a new HubDiscussion Model
+ */
+export declare const DEFAULT_DISCUSSION_MODEL: IModel;

package/dist/types/discussions/edit.d.ts

@@ -0,0 +1,29 @@
+import { IUserRequestOptions } from "@esri/arcgis-rest-auth";
+import { IHubDiscussion } from "../core/types";
+/**
+ * @private
+ * Create a new Hub Discussion item
+ *
+ * Minimal properties are name and orgUrlKey
+ *
+ * @param partialDiscussion a partial discussion
+ * @param requestOptions user request options
+ * @returns promise that resolves a IHubDiscussion
+ */
+export declare function createDiscussion(partialDiscussion: Partial<IHubDiscussion>, requestOptions: IUserRequestOptions): Promise<IHubDiscussion>;
+/**
+ * @private
+ * Update a Hub Discussion
+ * @param discussion the discussion to update
+ * @param requestOptions user request options
+ * @returns promise that resolves a IHubDiscussion
+ */
+export declare function updateDiscussion(discussion: IHubDiscussion, requestOptions: IUserRequestOptions): Promise<IHubDiscussion>;
+/**
+ * @private
+ * Remove a Hub Discussion
+ * @param id the discussion item id
+ * @param requestOptions request options
+ * @returns a promise
+ */
+export declare function deleteDiscussion(id: string, requestOptions: IUserRequestOptions): Promise<void>;

package/dist/types/discussions/fetch.d.ts

@@ -0,0 +1,20 @@
+import { IRequestOptions } from "@esri/arcgis-rest-request";
+import { IItem } from "@esri/arcgis-rest-portal";
+import { IHubDiscussion } from "../core/types";
+/**
+ * @private
+ * Get a Discussion by id or slug
+ * @param identifier item id or slug
+ * @param requestOptions request options
+ * @returns a promise that resolves a IHubDiscussion
+ */
+export declare function fetchDiscussion(identifier: string, requestOptions: IRequestOptions): Promise<IHubDiscussion>;
+/**
+ * @private
+ * Convert a Hub Discussion Item into a Hub Discussion, fetching any additional
+ * information that may be required
+ * @param item the discussion item
+ * @param auth request options
+ * @returns a promise that resolves a IHubDiscussion
+ */
+export declare function convertItemToDiscussion(item: IItem, requestOptions: IRequestOptions): Promise<IHubDiscussion>;

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

@@ -0,0 +1,3 @@
+export * from "./HubDiscussion";
+export * from "./edit";
+export * from "./fetch";

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ export * from "./extent";
 export * from "./groups";
 export * from "./i18n";
 export * from "./initiatives";
+export * from "./discussions";
 export * from "./items";
 export * from "./models";
 export * from "./objects";

package/dist/types/permissions/types/Permission.d.ts

@@ -3,11 +3,11 @@
  * It's critical that the arrays defined in the modules use `as const`
  * otherwise Permission devolves into just a string type
  */
-declare const validPermissions: readonly ["hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view"];
+declare const validPermissions: readonly ["hub:site:create", "hub:site:delete", "hub:site:edit", "hub:site:view", "hub:project:create", "hub:project:delete", "hub:project:edit", "hub:project:view", "hub:initiative:create", "hub:initiative:delete", "hub:initiative:edit", "hub:initiative:view", "hub:discussion:create", "hub:discussion:delete", "hub:discussion:edit", "hub:discussion:view"];
 /**
  * Defines the possible values for Permissions
  */
-export declare type Permission = typeof validPermissions[number];
+export declare type Permission = (typeof validPermissions)[number];
 /**
  * Validate a Permission
  * @param permission

package/dist/types/versioning/updateVersion.d.ts

@@ -3,9 +3,11 @@ import { IModel } from "../types";
 import { IVersion } from "./types";
 /**
  * Updates the specified version with with the state of the supplied model
+ * throws an exception if the version is stale and force is not true
  * @param model
  * @param version
  * @param requestOptions
+ * @param force
  * @returns
  */
-export declare function updateVersion(model: IModel, version: IVersion, requestOptions: IHubUserRequestOptions): Promise<IVersion>;
+export declare function updateVersion(model: IModel, version: IVersion, requestOptions: IHubUserRequestOptions, force?: boolean): Promise<IVersion>;

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

@@ -1,4 +1,4 @@
-import { IModel } from "../types";
+import { IHubUserRequestOptions, IModel } from "../types";
 import { IVersion } from "./types/IVersion";
 /**
  * Applies the versioned data to the model
@@ -8,3 +8,16 @@ import { IVersion } from "./types/IVersion";
  * @returns
  */
 export declare function applyVersion(model: IModel, version: IVersion, includeList?: string[]): IModel;
+interface IStaleVersionResponse {
+    isStale: boolean;
+    updated: number;
+}
+/**
+ * Checks if the upstream version is newer than the passed in version
+ * @param itemId
+ * @param version
+ * @param requestOptions
+ * @returns
+ */
+export declare function checkForStaleVersion(itemId: string, version: IVersion, requestOptions: IHubUserRequestOptions): Promise<IStaleVersionResponse>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@esri/hub-common",
-  "version": "12.11.0",
+  "version": "12.13.0",
   "description": "Common TypeScript types and utility functions for @esri/hub.js.",
   "main": "dist/node/index.js",
   "module": "dist/esm/index.js",