@atlaskit/collab-provider 9.20.7 → 9.21.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/collab-provider
 
+## 9.21.0
+
+### Minor Changes
+
+- [#63832](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/63832) [`9fa0bec86202`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9fa0bec86202) - Expose Comment API through collab provider
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 9.20.7
 
 ### Patch Changes

package/dist/cjs/api/api.js

@@ -0,0 +1,176 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Api = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
+var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/wrapNativeSuper"));
+var _utils = require("../helpers/utils");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+var logger = (0, _utils.createLogger)('Api', 'blue');
+var AddCommentError = /*#__PURE__*/function (_Error) {
+  (0, _inherits2.default)(AddCommentError, _Error);
+  var _super = _createSuper(AddCommentError);
+  function AddCommentError(message, status, meta) {
+    var _this;
+    (0, _classCallCheck2.default)(this, AddCommentError);
+    _this = _super.call(this, message);
+    _this.name = 'AddCommentError';
+    _this.status = status;
+    _this.meta = meta;
+    return _this;
+  }
+  return (0, _createClass2.default)(AddCommentError);
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+/**
+ * We create this API component, and export it under collab provider (e.g. provider.api.sendComment())
+ * From a design perspective, this makes it more disitinctive, and less confusing.
+ * Collab provider follows a state machine philosophy, whereas this new component does CRUD function calls
+ * In future we can add to this api class without adding complexity to provider
+ *
+ */
+var Api = exports.Api = /*#__PURE__*/function () {
+  function Api(config, documentService, channel) {
+    var _this2 = this;
+    (0, _classCallCheck2.default)(this, Api);
+    (0, _defineProperty2.default)(this, "submitComment", /*#__PURE__*/function () {
+      var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(steps, version) {
+        var reqBody, url, fetchOptions;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              reqBody = JSON.stringify({
+                productId: 'ccollab',
+                version: version,
+                steps: steps
+              });
+              url = "".concat(_this2.config.url, "/document/").concat(encodeURIComponent(_this2.config.documentAri), "/comment");
+              logger("Request url: ", url);
+              _context.t0 = _objectSpread;
+              _context.t1 = _objectSpread;
+              _context.t2 = {};
+              if (!_this2.config.permissionTokenRefresh) {
+                _context.next = 13;
+                break;
+              }
+              _context.next = 9;
+              return _this2.channel.getChannelToken();
+            case 9:
+              _context.t4 = _context.sent;
+              _context.t3 = {
+                'x-token': _context.t4
+              };
+              _context.next = 14;
+              break;
+            case 13:
+              _context.t3 = {};
+            case 14:
+              _context.t5 = _context.t3;
+              _context.t6 = (0, _context.t1)(_context.t2, _context.t5);
+              _context.t7 = {};
+              _context.t8 = {
+                'x-product': (0, _utils.getProduct)(_this2.config.productInfo),
+                'x-subproduct': (0, _utils.getSubProduct)(_this2.config.productInfo),
+                'Content-Type': 'application/json'
+              };
+              _context.t9 = (0, _context.t0)(_context.t6, _context.t7, _context.t8);
+              _context.t10 = reqBody;
+              fetchOptions = {
+                credentials: 'include',
+                headers: _context.t9,
+                method: 'POST',
+                body: _context.t10
+              };
+              _context.next = 23;
+              return fetch(url, fetchOptions);
+            case 23:
+              return _context.abrupt("return", _context.sent);
+            case 24:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      return function (_x, _x2) {
+        return _ref.apply(this, arguments);
+      };
+    }());
+    this.config = config;
+    this.documentService = documentService;
+    this.channel = channel;
+  }
+  (0, _createClass2.default)(Api, [{
+    key: "addComment",
+    value: function () {
+      var _addComment = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(steps) {
+        var stepVersion, response, status, _yield$response$json, message, meta;
+        return _regenerator.default.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
+            case 0:
+              stepVersion = this.documentService.getCurrentPmVersion();
+              _context2.prev = 1;
+              _context2.next = 4;
+              return this.submitComment(steps, stepVersion);
+            case 4:
+              response = _context2.sent;
+              status = response.status;
+              _context2.next = 8;
+              return response.json();
+            case 8:
+              _yield$response$json = _context2.sent;
+              message = _yield$response$json.message;
+              meta = _yield$response$json.meta;
+              if (!(status === 201)) {
+                _context2.next = 14;
+                break;
+              }
+              logger("NCS response: ".concat(message));
+              return _context2.abrupt("return", {
+                message: message
+              });
+            case 14:
+              if (!(status >= 400 && status <= 499)) {
+                _context2.next = 17;
+                break;
+              }
+              logger("NCS error meta: ".concat(JSON.stringify(meta)));
+              // Include details in error response
+              throw new AddCommentError("Failed to add comment - Client error: ".concat(message), status, JSON.stringify(meta));
+            case 17:
+              throw new AddCommentError("Failed to add comment - Server error", status);
+            case 20:
+              _context2.prev = 20;
+              _context2.t0 = _context2["catch"](1);
+              if (!(_context2.t0 instanceof AddCommentError)) {
+                _context2.next = 26;
+                break;
+              }
+              throw _context2.t0;
+            case 26:
+              throw new Error("Error submitting comment: ".concat(_context2.t0));
+            case 27:
+            case "end":
+              return _context2.stop();
+          }
+        }, _callee2, this, [[1, 20]]);
+      }));
+      function addComment(_x3) {
+        return _addComment.apply(this, arguments);
+      }
+      return addComment;
+    }()
+  }]);
+  return Api;
+}();