@atlaskit/feedback-collector 11.0.0 → 12.1.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @atlaskit/feedback-collector
 
+## 12.1.0
+
+### Minor Changes
+
+- [`56507598609`](https://bitbucket.org/atlassian/atlassian-frontend/commits/56507598609) - Skip minor dependency bump
+
+### Patch Changes
+
+- Updated dependencies
+
+## 12.0.0
+
+### Major Changes
+
+- [`278c2413bf4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/278c2413bf4) - Adding and renaming properties to the component. This was introduced to support teams defining and using their own values for the checkboxes.
+
+  If you overwrite the `canBeContactedDefaultValue` or `enrollInResearchDefaultValue`, you'll need to update the property name in use
+
+  A recap of the changes to properties:
+
+  `canBeContactedDefaultValue` -> `canBeContactedAgreeValue`
+  `enrollInResearchDefaultValue` -> `enrollInResearchAgreeValue`
+  (new) -> `canBeContactedDeclineValue`
+  (new) -> `enrollInResearchDeclineValue`
+
 ## 11.0.0
 
 ### Major Changes

package/README.md

@@ -10,4 +10,4 @@ yarn add @atlaskit/feedback-collector
 
 ## Usage
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/core/feedback-collector).
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/self-help-experience/feedback-collector).

package/dist/cjs/components/FeedbackCollector.js

@@ -47,57 +47,55 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
       var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(formValues) {
         var entrypointId, fetchUrl, formData, body, postData;
         return _regenerator.default.wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                entrypointId = _this.props.entrypointId;
-                fetchUrl = _this.getFeedbackUrl(); // Don't dispatch unless we have suitable props (allows tests to pass through empty strings and avoid redundant network calls)
-                if (!entrypointId) {
-                  _context.next = 10;
-                  break;
-                }
-                _context.next = 5;
-                return _this.mapFormToJSD(formValues);
-              case 5:
-                formData = _context.sent;
-                body = {
-                  feedback: _objectSpread({
-                    entrypointId: _this.props.entrypointId,
-                    entrypointUiVersion: _this.getPackageVersion()
-                  }, formData)
-                };
-                if ((0, _isApiGatewayUrl.isApiGatewayUrl)(fetchUrl)) {
-                  fetchUrl += '/feedback-collector-api';
-                } else if (!_this.props.customFeedbackUrl) {
-                  fetchUrl = 'https://feedback-collector-api.services.atlassian.com';
-                }
-                postData = _buffer.Buffer.from(JSON.stringify(body)).toString('base64');
-                fetch("".concat(fetchUrl, "/v2/feedback"), {
-                  method: 'POST',
-                  headers: {
-                    'Content-Type': 'application/json'
-                  },
-                  body: JSON.stringify({
-                    data: postData
-                  }),
-                  credentials: 'include'
-                });
-              case 10:
-                _this.props.onClose();
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              entrypointId = _this.props.entrypointId;
+              fetchUrl = _this.getFeedbackUrl(); // Don't dispatch unless we have suitable props (allows tests to pass through empty strings and avoid redundant network calls)
+              if (!entrypointId) {
+                _context.next = 10;
+                break;
+              }
+              _context.next = 5;
+              return _this.mapFormToJSD(formValues);
+            case 5:
+              formData = _context.sent;
+              body = {
+                feedback: _objectSpread({
+                  entrypointId: _this.props.entrypointId,
+                  entrypointUiVersion: _this.getPackageVersion()
+                }, formData)
+              };
+              if ((0, _isApiGatewayUrl.isApiGatewayUrl)(fetchUrl)) {
+                fetchUrl += '/feedback-collector-api';
+              } else if (!_this.props.customFeedbackUrl) {
+                fetchUrl = 'https://feedback-collector-api.services.atlassian.com';
+              }
+              postData = _buffer.Buffer.from(JSON.stringify(body)).toString('base64');
+              fetch("".concat(fetchUrl, "/v2/feedback"), {
+                method: 'POST',
+                headers: {
+                  'Content-Type': 'application/json'
+                },
+                body: JSON.stringify({
+                  data: postData
+                }),
+                credentials: 'include'
+              });
+            case 10:
+              _this.props.onClose();
 
-                // slightly delay confirming submit since we don't wait for the REST call to succeed
-                //
-                // Because `onClose` is invoked prior to this timeout triggering, the `componentWillUnmount`
-                // may occur before the `onSubmit` is called. To prevent prematurely cancelling the
-                // network request, we deliberately don't clear this timeout inside `componentWillUnmount`.
-                //
-                setTimeout(function () {
-                  return _this.props.onSubmit(formValues);
-                }, _this.props.timeoutOnSubmit);
-              case 12:
-              case "end":
-                return _context.stop();
-            }
+              // slightly delay confirming submit since we don't wait for the REST call to succeed
+              //
+              // Because `onClose` is invoked prior to this timeout triggering, the `componentWillUnmount`
+              // may occur before the `onSubmit` is called. To prevent prematurely cancelling the
+              // network request, we deliberately don't clear this timeout inside `componentWillUnmount`.
+              //
+              setTimeout(function () {
+                return _this.props.onSubmit(formValues);
+              }, _this.props.timeoutOnSubmit);
+            case 12:
+            case "end":
+              return _context.stop();
           }
         }, _callee);
       }));
@@ -138,7 +136,7 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
   }, {
     key: "getPackageVersion",
     value: function getPackageVersion() {
-      return "11.0.0" || 'Unknown, at least 11.0.0';
+      return "12.1.0" || 'Unknown, at least 11.0.0';
     }
   }, {
     key: "getEntitlementInformation",
@@ -147,82 +145,80 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
         var _productName;
         var url, productName, productEntitlement, entitlementDetails, productKey, _document$querySelect, hasPremium, entitlement, entitlementInformation, cloudSiteId;
         return _regenerator.default.wrap(function _callee2$(_context2) {
-          while (1) {
-            switch (_context2.prev = _context2.next) {
-              case 0:
-                url = this.getGatewayUrl(); // jira / confluence / bitbucket / trello
-                if (!window.location.host.includes('bitbucket.org')) {
-                  _context2.next = 9;
-                  break;
-                }
-                productName = 'Bitbucket';
-                productKey = 'bitbucket';
-                entitlementDetails = JSON.parse(JSON.stringify((_document$querySelect = document.querySelector('meta[id="bb-bootstrap"]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.getAttribute('data-current-user')));
-                hasPremium = entitlementDetails['hasPremium'];
-                productEntitlement = hasPremium ? 'PREMIUM' : 'STANDARD';
-                _context2.next = 24;
-                break;
-              case 9:
-                if (!['trellis.coffee', 'trello.com'].includes(window.location.host)) {
-                  _context2.next = 14;
-                  break;
-                }
-                productName = 'Trello';
-                productKey = 'trello';
-                _context2.next = 24;
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              url = this.getGatewayUrl(); // jira / confluence / bitbucket / trello
+              if (!window.location.host.includes('bitbucket.org')) {
+                _context2.next = 9;
                 break;
-              case 14:
-                if (document.querySelector('meta[id="confluence-context-path"]')) {
-                  productName = 'Confluence';
-                  productKey = 'pricingplan.confluence.ondemand';
-                } else {
-                  productName = 'Jira';
-                  productKey = 'jira-software.ondemand';
-                }
-                _context2.prev = 15;
-                _context2.next = 18;
-                return fetch("".concat(url, "/customer-context/entitlements/").concat(window.location.host), _objectSpread({
-                  method: 'GET',
-                  headers: {
-                    'Content-Type': 'application/json'
-                  }
-                }, (0, _isApiGatewayUrl.isApiGatewayUrl)(url) ? {
-                  credentials: 'include'
-                } : {}));
-              case 18:
-                entitlementDetails = _context2.sent;
-                _context2.next = 24;
+              }
+              productName = 'Bitbucket';
+              productKey = 'bitbucket';
+              entitlementDetails = JSON.parse(JSON.stringify((_document$querySelect = document.querySelector('meta[id="bb-bootstrap"]')) === null || _document$querySelect === void 0 ? void 0 : _document$querySelect.getAttribute('data-current-user')));
+              hasPremium = entitlementDetails['hasPremium'];
+              productEntitlement = hasPremium ? 'PREMIUM' : 'STANDARD';
+              _context2.next = 24;
+              break;
+            case 9:
+              if (!['trellis.coffee', 'trello.com'].includes(window.location.host)) {
+                _context2.next = 14;
                 break;
-              case 21:
-                _context2.prev = 21;
-                _context2.t0 = _context2["catch"](15);
-                entitlementDetails = undefined;
-              case 24:
-                entitlementInformation = [];
-                cloudSiteId = entitlementDetails && entitlementDetails.cloudSiteId || '';
-                if (entitlementDetails && entitlementDetails.children) {
-                  entitlement = entitlementDetails.children.find(function (entitlement) {
-                    return entitlement.key === productKey;
-                  });
+              }
+              productName = 'Trello';
+              productKey = 'trello';
+              _context2.next = 24;
+              break;
+            case 14:
+              if (document.querySelector('meta[id="confluence-context-path"]')) {
+                productName = 'Confluence';
+                productKey = 'pricingplan.confluence.ondemand';
+              } else {
+                productName = 'Jira';
+                productKey = 'jira-software.ondemand';
+              }
+              _context2.prev = 15;
+              _context2.next = 18;
+              return fetch("".concat(url, "/customer-context/entitlements/").concat(window.location.host), _objectSpread({
+                method: 'GET',
+                headers: {
+                  'Content-Type': 'application/json'
                 }
-                entitlementInformation.push({
-                  id: 'product',
-                  value: productName ? (_productName = productName) === null || _productName === void 0 ? void 0 : _productName.toLowerCase() : ''
-                }, {
-                  id: 'hostingType',
-                  value: entitlement && entitlement.product ? entitlement.product.hostingType : 'CLOUD'
-                }, {
-                  id: 'entitlementEdition',
-                  value: productEntitlement || ''
-                }, {
-                  id: 'cloudId',
-                  value: cloudSiteId
+              }, (0, _isApiGatewayUrl.isApiGatewayUrl)(url) ? {
+                credentials: 'include'
+              } : {}));
+            case 18:
+              entitlementDetails = _context2.sent;
+              _context2.next = 24;
+              break;
+            case 21:
+              _context2.prev = 21;
+              _context2.t0 = _context2["catch"](15);
+              entitlementDetails = undefined;
+            case 24:
+              entitlementInformation = [];
+              cloudSiteId = entitlementDetails && entitlementDetails.cloudSiteId || '';
+              if (entitlementDetails && entitlementDetails.children) {
+                entitlement = entitlementDetails.children.find(function (entitlement) {
+                  return entitlement.key === productKey;
                 });
-                return _context2.abrupt("return", entitlementInformation);
-              case 29:
-              case "end":
-                return _context2.stop();
-            }
+              }
+              entitlementInformation.push({
+                id: 'product',
+                value: productName ? (_productName = productName) === null || _productName === void 0 ? void 0 : _productName.toLowerCase() : ''
+              }, {
+                id: 'hostingType',
+                value: entitlement && entitlement.product ? entitlement.product.hostingType : 'CLOUD'
+              }, {
+                id: 'entitlementEdition',
+                value: productEntitlement || ''
+              }, {
+                id: 'cloudId',
+                value: cloudSiteId
+              });
+              return _context2.abrupt("return", entitlementInformation);
+            case 29:
+            case "end":
+              return _context2.stop();
           }
         }, _callee2, this, [[15, 21]]);
       }));
@@ -254,62 +250,60 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
       var _getEmailAndAtlassianID = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(formValues) {
         var url, result, json;
         return _regenerator.default.wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                _context3.prev = 0;
-                if (!formValues.canBeContacted) {
-                  _context3.next = 14;
-                  break;
-                }
-                if (!(this.props.email || !this.props.shouldGetEntitlementDetails)) {
-                  _context3.next = 4;
-                  break;
-                }
-                return _context3.abrupt("return", {
-                  email: this.props.email,
-                  aaidOrHash: _buffer.Buffer.from(this.props.email).toString('base64')
-                });
-              case 4:
-                url = this.getGatewayUrl();
-                _context3.next = 7;
-                return fetch("".concat(url, "/me"), _objectSpread({
-                  method: 'GET',
-                  headers: {
-                    'Content-Type': 'application/json'
-                  }
-                }, (0, _isApiGatewayUrl.isApiGatewayUrl)(url) ? {
-                  credentials: 'include'
-                } : {}));
-              case 7:
-                result = _context3.sent;
-                _context3.next = 10;
-                return result.json();
-              case 10:
-                json = _context3.sent;
-                return _context3.abrupt("return", {
-                  email: json.email,
-                  aaidOrHash: json.account_id
-                });
-              case 14:
-                return _context3.abrupt("return", {
-                  email: this.props.emailDefaultValue,
-                  aaidOrHash: _buffer.Buffer.from(this.props.emailDefaultValue).toString('base64')
-                });
-              case 15:
-                _context3.next = 20;
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              _context3.prev = 0;
+              if (!formValues.canBeContacted) {
+                _context3.next = 14;
                 break;
-              case 17:
-                _context3.prev = 17;
-                _context3.t0 = _context3["catch"](0);
-                return _context3.abrupt("return", {
-                  email: this.props.emailDefaultValue,
-                  aaidOrHash: _buffer.Buffer.from(this.props.emailDefaultValue).toString('base64')
-                });
-              case 20:
-              case "end":
-                return _context3.stop();
-            }
+              }
+              if (!(this.props.email || !this.props.shouldGetEntitlementDetails)) {
+                _context3.next = 4;
+                break;
+              }
+              return _context3.abrupt("return", {
+                email: this.props.email,
+                aaidOrHash: _buffer.Buffer.from(this.props.email).toString('base64')
+              });
+            case 4:
+              url = this.getGatewayUrl();
+              _context3.next = 7;
+              return fetch("".concat(url, "/me"), _objectSpread({
+                method: 'GET',
+                headers: {
+                  'Content-Type': 'application/json'
+                }
+              }, (0, _isApiGatewayUrl.isApiGatewayUrl)(url) ? {
+                credentials: 'include'
+              } : {}));
+            case 7:
+              result = _context3.sent;
+              _context3.next = 10;
+              return result.json();
+            case 10:
+              json = _context3.sent;
+              return _context3.abrupt("return", {
+                email: json.email,
+                aaidOrHash: json.account_id
+              });
+            case 14:
+              return _context3.abrupt("return", {
+                email: this.props.emailDefaultValue,
+                aaidOrHash: _buffer.Buffer.from(this.props.emailDefaultValue).toString('base64')
+              });
+            case 15:
+              _context3.next = 20;
+              break;
+            case 17:
+              _context3.prev = 17;
+              _context3.t0 = _context3["catch"](0);
+              return _context3.abrupt("return", {
+                email: this.props.emailDefaultValue,
+                aaidOrHash: _buffer.Buffer.from(this.props.emailDefaultValue).toString('base64')
+              });
+            case 20:
+            case "end":
+              return _context3.stop();
           }
         }, _callee3, this, [[0, 17]]);
       }));
@@ -339,54 +333,58 @@ var FeedbackCollector = /*#__PURE__*/function (_Component) {
       var _mapFormToJSD = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(formValues) {
         var entitlementInformation, userDetails;
         return _regenerator.default.wrap(function _callee4$(_context4) {
-          while (1) {
-            switch (_context4.prev = _context4.next) {
-              case 0:
-                entitlementInformation = null;
-                if (!this.props.shouldGetEntitlementDetails) {
-                  _context4.next = 5;
-                  break;
-                }
-                _context4.next = 4;
-                return this.getEntitlementInformation();
-              case 4:
-                entitlementInformation = _context4.sent;
-              case 5:
-                _context4.next = 7;
-                return this.getEmailAndAtlassianID(formValues);
-              case 7:
-                userDetails = _context4.sent;
-                return _context4.abrupt("return", {
-                  fields: [].concat((0, _toConsumableArray2.default)(entitlementInformation !== null && entitlementInformation || []), [this.props.showTypeField ? {
-                    id: this.props.typeFieldId,
-                    value: this.getTypeFieldValue(formValues.type)
-                  } : undefined, {
-                    id: this.props.summaryFieldId,
-                    value: this.getSummary(formValues)
-                  }, {
-                    id: this.props.descriptionFieldId,
-                    value: this.getDescription(formValues)
-                  }, {
-                    id: this.props.emailFieldId,
-                    value: userDetails.email
-                  }, {
-                    id: 'aaidOrHash',
-                    value: userDetails.aaidOrHash
-                  }, {
-                    id: this.props.customerNameFieldId,
-                    value: this.getCustomerName()
-                  }, formValues.canBeContacted ? {
-                    id: this.props.canBeContactedFieldId,
-                    value: this.props.canBeContactedDefaultValue
-                  } : undefined, formValues.enrollInResearchGroup ? {
-                    id: this.props.enrollInResearchFieldId,
-                    value: this.props.enrollInResearchDefaultValue
-                  } : undefined], (0, _toConsumableArray2.default)(this.props.additionalFields)).filter(Boolean)
-                });
-              case 9:
-              case "end":
-                return _context4.stop();
-            }
+          while (1) switch (_context4.prev = _context4.next) {
+            case 0:
+              entitlementInformation = null;
+              if (!this.props.shouldGetEntitlementDetails) {
+                _context4.next = 5;
+                break;
+              }
+              _context4.next = 4;
+              return this.getEntitlementInformation();
+            case 4:
+              entitlementInformation = _context4.sent;
+            case 5:
+              _context4.next = 7;
+              return this.getEmailAndAtlassianID(formValues);
+            case 7:
+              userDetails = _context4.sent;
+              return _context4.abrupt("return", {
+                fields: [].concat((0, _toConsumableArray2.default)(entitlementInformation !== null && entitlementInformation || []), [this.props.showTypeField ? {
+                  id: this.props.typeFieldId,
+                  value: this.getTypeFieldValue(formValues.type)
+                } : undefined, {
+                  id: this.props.summaryFieldId,
+                  value: this.getSummary(formValues)
+                }, {
+                  id: this.props.descriptionFieldId,
+                  value: this.getDescription(formValues)
+                }, {
+                  id: this.props.emailFieldId,
+                  value: userDetails.email
+                }, {
+                  id: 'aaidOrHash',
+                  value: userDetails.aaidOrHash
+                }, {
+                  id: this.props.customerNameFieldId,
+                  value: this.getCustomerName()
+                }, formValues.canBeContacted ? {
+                  id: this.props.canBeContactedFieldId,
+                  value: this.props.canBeContactedAgreeValue
+                } : {
+                  id: this.props.canBeContactedFieldId,
+                  value: this.props.canBeContactedDeclineValue
+                }, formValues.enrollInResearchGroup ? {
+                  id: this.props.enrollInResearchFieldId,
+                  value: this.props.enrollInResearchAgreeValue
+                } : {
+                  id: this.props.enrollInResearchFieldId,
+                  value: this.props.enrollInResearchDeclineValue
+                }], (0, _toConsumableArray2.default)(this.props.additionalFields)).filter(Boolean)
+              });
+            case 9:
+            case "end":
+              return _context4.stop();
           }
         }, _callee4, this);
       }));
@@ -423,18 +421,24 @@ exports.default = FeedbackCollector;
   url: '/gateway/api',
   shouldGetEntitlementDetails: true,
   canBeContactedFieldId: 'customfield_10043',
-  canBeContactedDefaultValue: [{
+  canBeContactedAgreeValue: [{
     id: '10109'
   }],
+  canBeContactedDeclineValue: [{
+    id: '10111'
+  }],
   additionalFields: [],
   customerNameFieldId: 'customfield_10045',
   customerNameDefaultValue: 'unknown',
   descriptionFieldId: 'description',
   descriptionDefaultValue: '',
   enrollInResearchFieldId: 'customfield_10044',
-  enrollInResearchDefaultValue: [{
+  enrollInResearchAgreeValue: [{
     id: '10110'
   }],
+  enrollInResearchDeclineValue: [{
+    id: '10112'
+  }],
   emailFieldId: 'email',
   emailDefaultValue: 'do-not-reply@atlassian.com',
   summaryFieldId: 'summary',

package/dist/cjs/components/FeedbackForm.js

@@ -110,23 +110,21 @@ var FeedbackForm = function FeedbackForm(_ref) {
   }, /*#__PURE__*/_react.default.createElement(_form.default, {
     onSubmit: /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
       return _regenerator.default.wrap(function _callee$(_context) {
-        while (1) {
-          switch (_context.prev = _context.next) {
-            case 0:
-              setIsSubmitting(true);
-              _context.next = 3;
-              return onSubmit({
-                canBeContacted: canBeContacted,
-                description: description,
-                enrollInResearchGroup: enrollInResearchGroup,
-                type: type
-              });
-            case 3:
-              setIsSubmitting(false);
-            case 4:
-            case "end":
-              return _context.stop();
-          }
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            setIsSubmitting(true);
+            _context.next = 3;
+            return onSubmit({
+              canBeContacted: canBeContacted,
+              description: description,
+              enrollInResearchGroup: enrollInResearchGroup,
+              type: type
+            });
+          case 3:
+            setIsSubmitting(false);
+          case 4:
+          case "end":
+            return _context.stop();
         }
       }, _callee);
     }))

package/dist/cjs/components/IntlProviderWithResolvedMessages.js

@@ -26,22 +26,20 @@ var IntlProviderWithResolvedMessages = function IntlProviderWithResolvedMessages
       var _ref2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
         var messages;
         return _regenerator.default.wrap(function _callee$(_context) {
-          while (1) {
-            switch (_context.prev = _context.next) {
-              case 0:
-                if (!locale) {
-                  _context.next = 5;
-                  break;
-                }
-                _context.next = 3;
-                return (0, _i18nGetMessagesForLocale.getMessagesForLocale)(locale);
-              case 3:
-                messages = _context.sent;
-                setResolvedMessagesForLocale(messages);
-              case 5:
-              case "end":
-                return _context.stop();
-            }
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              if (!locale) {
+                _context.next = 5;
+                break;
+              }
+              _context.next = 3;
+              return (0, _i18nGetMessagesForLocale.getMessagesForLocale)(locale);
+            case 3:
+              messages = _context.sent;
+              setResolvedMessagesForLocale(messages);
+            case 5:
+            case "end":
+              return _context.stop();
           }
         }, _callee);
       }));