@atlaskit/editor-card-provider 3.0.2 → 3.0.4

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-card-provider
 
+## 3.0.4
+
+### Patch Changes
+
+- [`1674b5907b4`](https://bitbucket.org/atlassian/atlassian-frontend/commits/1674b5907b4) - [ux] Make confluence whiteboard urls default to embed view
+
+## 3.0.3
+
+### Patch Changes
+
+- [`f10ed88032c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/f10ed88032c) - With the renaming of Jira Roadmaps to Timeline, we are updating the regex rules to match timeline in conjunction to roadmaps
+- Updated dependencies
+
 ## 3.0.2
 
 ### Patch Changes

package/dist/cjs/provider.js

@@ -11,6 +11,8 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _setPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/setPrototypeOf"));
 require("setimmediate");
 var _dataloader = _interopRequireDefault(require("dataloader"));
 var _linkingCommon = require("@atlaskit/linking-common");
@@ -21,12 +23,14 @@ var _linkProvider = require("@atlaskit/link-provider");
 var api = _interopRequireWildcard(require("./api"));
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-// import setimmediate to temporary fix dataloader 2.0.0 bug
+function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(re, groups) { return new BabelRegExp(re, void 0, groups); }; var _super = RegExp.prototype, _groups = new WeakMap(); function BabelRegExp(re, flags, groups) { var _this = new RegExp(re, flags); return _groups.set(_this, groups || _groups.get(re)), (0, _setPrototypeOf2.default)(_this, BabelRegExp.prototype); } function buildGroups(result, re) { var g = _groups.get(re); return Object.keys(g).reduce(function (groups, name) { var i = g[name]; if ("number" == typeof i) groups[name] = result[i];else { for (var k = 0; void 0 === result[i[k]] && k + 1 < i.length;) k++; groups[name] = result[i[k]]; } return groups; }, Object.create(null)); } return (0, _inherits2.default)(BabelRegExp, RegExp), BabelRegExp.prototype.exec = function (str) { var result = _super.exec.call(this, str); if (result) { result.groups = buildGroups(result, this); var indices = result.indices; indices && (indices.groups = buildGroups(indices, this)); } return result; }, BabelRegExp.prototype[Symbol.replace] = function (str, substitution) { if ("string" == typeof substitution) { var groups = _groups.get(this); return _super[Symbol.replace].call(this, str, substitution.replace(/\$<([^>]+)>/g, function (_, name) { var group = groups[name]; return "$" + (Array.isArray(group) ? group.join("$") : group); })); } if ("function" == typeof substitution) { var _this = this; return _super[Symbol.replace].call(this, str, function () { var args = arguments; return "object" != _typeof(args[args.length - 1]) && (args = [].slice.call(args)).push(buildGroups(args, _this)), substitution.apply(this, args); }); } return _super[Symbol.replace].call(this, str, substitution); }, _wrapRegExp.apply(this, arguments); } // import setimmediate to temporary fix dataloader 2.0.0 bug
 // @see https://github.com/graphql/dataloader/issues/249
-
 var BATCH_WAIT_TIME = 50;
-var isJiraRoadMap = function isJiraRoadMap(url) {
-  return url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/roadmap\/?/);
+
+// Check if it is matching a Jira Roadmaps or Jira Timeline url
+// NOT to be confused with JSM timeline
+var isJiraRoadmapOrTimeline = function isJiraRoadmapOrTimeline(url) {
+  return url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/(timeline|roadmap)\/?/);
 };
 var isPolarisView = function isPolarisView(url) {
   return url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$|^https:\/\/.*?\/secure\/JiraProductDiscoveryAnonymous\.jspa\?hash=\w+|^https:\/\/.*?\/jira\/polaris\/share\/\w+/);
@@ -40,9 +44,16 @@ var isGiphyMedia = function isGiphyMedia(url) {
 var isProformaView = function isProformaView(url) {
   return url.match(/^https:\/\/[^/]+\/jira\/(core|software(\/c)?|servicedesk)\/projects\/\w+\/forms\/form\/direct\/\d+\/\d+.*$/);
 };
+var isConfluenceWhiteboard = function isConfluenceWhiteboard(url) {
+  return url.match( /*#__PURE__*/_wrapRegExp(/\/wiki\/spaces\/?.*\/whiteboard\/(\d+)(\?\/)?/, {
+    resourceId: 1
+  })) || url.match( /*#__PURE__*/_wrapRegExp(/\/wiki\/spaces\/?.*\/whiteboard\/([0-9a-fA-F]{8}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{12})(\?\/)?/, {
+    resourceId: 1
+  }));
+};
 var EditorCardProvider = /*#__PURE__*/function () {
   function EditorCardProvider(envKey, baseUrlOverride) {
-    var _this = this;
+    var _this2 = this;
     (0, _classCallCheck2.default)(this, EditorCardProvider);
     this.baseUrl = baseUrlOverride || (0, _environments.getBaseUrl)(envKey);
     this.resolverUrl = (0, _environments.getResolverUrl)(envKey, baseUrlOverride);
@@ -51,7 +62,7 @@ var EditorCardProvider = /*#__PURE__*/function () {
       Origin: this.baseUrl
     };
     this.providersLoader = new _dataloader.default(function (keys) {
-      return _this.batchProviders(keys);
+      return _this2.batchProviders(keys);
     }, {
       batchScheduleFn: function batchScheduleFn(callback) {
         return setTimeout(callback, BATCH_WAIT_TIME);
@@ -230,7 +241,7 @@ var EditorCardProvider = /*#__PURE__*/function () {
     value: function () {
       var _findUserPreference = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee6(url) {
         var _this$providersData,
-          _this2 = this;
+          _this3 = this;
         var userPreferences, defaultAppearance, appearances, allMatchedLabeledAppearances, longestMatchedLabeledAppearance;
         return _regenerator.default.wrap(function _callee6$(_context6) {
           while (1) switch (_context6.prev = _context6.next) {
@@ -250,7 +261,7 @@ var EditorCardProvider = /*#__PURE__*/function () {
               defaultAppearance = userPreferences.defaultAppearance, appearances = userPreferences.appearances;
               allMatchedLabeledAppearances = appearances.filter(function (_ref) {
                 var urlSegment = _ref.urlSegment;
-                return _this2.doesUrlMatchPath(urlSegment, url);
+                return _this3.doesUrlMatchPath(urlSegment, url);
               });
               if (!(allMatchedLabeledAppearances.length > 0)) {
                 _context6.next = 10;
@@ -309,7 +320,7 @@ var EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "getHardCodedAppearance",
     value: function getHardCodedAppearance(url) {
-      if (isJiraRoadMap(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url)) {
+      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url)) {
         return 'embed';
       }
     }
@@ -414,7 +425,7 @@ var EditorCardProvider = /*#__PURE__*/function () {
               // if user's default choice is NOT "inline" (so, block or embed at this point, url was dealt with above)
               userPreference ||
               // If user's default choice is "inline" or user hasn't specified preferences at all,
-              // we check whatever one of the hardcoded providers match url (jira roadmap, polaris, etc)
+              // we check whatever one of the hardcoded providers match url (jira /timeline, polaris, etc)
               hardCodedAppearance ||
               // If non match, we see if this provider has default appearance for this particular regexp
               providerDefaultAppearance ||

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.2",
+	"version": "3.0.4",
 	"sideEffects": false
 }

package/dist/es2019/provider.js

@@ -9,11 +9,15 @@ import { getStatus } from './utils';
 import { CardClient } from '@atlaskit/link-provider';
 import * as api from './api';
 const BATCH_WAIT_TIME = 50;
-const isJiraRoadMap = url => url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/roadmap\/?/);
+
+// Check if it is matching a Jira Roadmaps or Jira Timeline url
+// NOT to be confused with JSM timeline
+const isJiraRoadmapOrTimeline = url => url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/(timeline|roadmap)\/?/);
 const isPolarisView = url => url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$|^https:\/\/.*?\/secure\/JiraProductDiscoveryAnonymous\.jspa\?hash=\w+|^https:\/\/.*?\/jira\/polaris\/share\/\w+/);
 const isJwmView = url => url.match(/^https:\/\/.*?\/jira\/core\/projects\/[^\/]+?\/(timeline|calendar|list|board|summary|(form\/[^\/]+?))\/?/);
 const isGiphyMedia = url => url.match(/^https:\/\/(.*?\.)?giphy\.com\/(gifs|media|clips)\//);
 const isProformaView = url => url.match(/^https:\/\/[^/]+\/jira\/(core|software(\/c)?|servicedesk)\/projects\/\w+\/forms\/form\/direct\/\d+\/\d+.*$/);
+const isConfluenceWhiteboard = url => url.match(/\/wiki\/spaces\/?.*\/whiteboard\/(?<resourceId>\d+)(\?\/)?/) || url.match(/\/wiki\/spaces\/?.*\/whiteboard\/(?<resourceId>[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12})(\?\/)?/);
 export class EditorCardProvider {
   constructor(envKey, baseUrlOverride) {
     this.baseUrl = baseUrlOverride || getBaseUrl(envKey);
@@ -105,7 +109,7 @@ export class EditorCardProvider {
     return (_this$providersData2 = this.providersData) === null || _this$providersData2 === void 0 ? void 0 : _this$providersData2.patterns.find(pattern => url.match(pattern.source));
   }
   getHardCodedAppearance(url) {
-    if (isJiraRoadMap(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url)) {
+    if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url)) {
       return 'embed';
     }
   }
@@ -158,7 +162,7 @@ export class EditorCardProvider {
         // if user's default choice is NOT "inline" (so, block or embed at this point, url was dealt with above)
         userPreference ||
         // If user's default choice is "inline" or user hasn't specified preferences at all,
-        // we check whatever one of the hardcoded providers match url (jira roadmap, polaris, etc)
+        // we check whatever one of the hardcoded providers match url (jira /timeline, polaris, etc)
         hardCodedAppearance ||
         // If non match, we see if this provider has default appearance for this particular regexp
         providerDefaultAppearance ||

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.2",
+	"version": "3.0.4",
 	"sideEffects": false
 }

package/dist/esm/provider.js

@@ -1,8 +1,12 @@
+import _typeof from "@babel/runtime/helpers/typeof";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _setPrototypeOf from "@babel/runtime/helpers/setPrototypeOf";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(re, groups) { return new BabelRegExp(re, void 0, groups); }; var _super = RegExp.prototype, _groups = new WeakMap(); function BabelRegExp(re, flags, groups) { var _this = new RegExp(re, flags); return _groups.set(_this, groups || _groups.get(re)), _setPrototypeOf(_this, BabelRegExp.prototype); } function buildGroups(result, re) { var g = _groups.get(re); return Object.keys(g).reduce(function (groups, name) { var i = g[name]; if ("number" == typeof i) groups[name] = result[i];else { for (var k = 0; void 0 === result[i[k]] && k + 1 < i.length;) k++; groups[name] = result[i[k]]; } return groups; }, Object.create(null)); } return _inherits(BabelRegExp, RegExp), BabelRegExp.prototype.exec = function (str) { var result = _super.exec.call(this, str); if (result) { result.groups = buildGroups(result, this); var indices = result.indices; indices && (indices.groups = buildGroups(indices, this)); } return result; }, BabelRegExp.prototype[Symbol.replace] = function (str, substitution) { if ("string" == typeof substitution) { var groups = _groups.get(this); return _super[Symbol.replace].call(this, str, substitution.replace(/\$<([^>]+)>/g, function (_, name) { var group = groups[name]; return "$" + (Array.isArray(group) ? group.join("$") : group); })); } if ("function" == typeof substitution) { var _this = this; return _super[Symbol.replace].call(this, str, function () { var args = arguments; return "object" != _typeof(args[args.length - 1]) && (args = [].slice.call(args)).push(buildGroups(args, _this)), substitution.apply(this, args); }); } return _super[Symbol.replace].call(this, str, substitution); }, _wrapRegExp.apply(this, arguments); }
 // import setimmediate to temporary fix dataloader 2.0.0 bug
 // @see https://github.com/graphql/dataloader/issues/249
 import 'setimmediate';
@@ -14,8 +18,11 @@ import { getStatus } from './utils';
 import { CardClient } from '@atlaskit/link-provider';
 import * as api from './api';
 var BATCH_WAIT_TIME = 50;
-var isJiraRoadMap = function isJiraRoadMap(url) {
-  return url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/roadmap\/?/);
+
+// Check if it is matching a Jira Roadmaps or Jira Timeline url
+// NOT to be confused with JSM timeline
+var isJiraRoadmapOrTimeline = function isJiraRoadmapOrTimeline(url) {
+  return url.match(/^https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/.*?\/(timeline|roadmap)\/?/);
 };
 var isPolarisView = function isPolarisView(url) {
   return url.match(/^https:\/\/.*?\/jira\/polaris\/projects\/[^\/]+?\/ideas\/view\/\d+$|^https:\/\/.*?\/secure\/JiraProductDiscoveryAnonymous\.jspa\?hash=\w+|^https:\/\/.*?\/jira\/polaris\/share\/\w+/);
@@ -29,9 +36,16 @@ var isGiphyMedia = function isGiphyMedia(url) {
 var isProformaView = function isProformaView(url) {
   return url.match(/^https:\/\/[^/]+\/jira\/(core|software(\/c)?|servicedesk)\/projects\/\w+\/forms\/form\/direct\/\d+\/\d+.*$/);
 };
+var isConfluenceWhiteboard = function isConfluenceWhiteboard(url) {
+  return url.match( /*#__PURE__*/_wrapRegExp(/\/wiki\/spaces\/?.*\/whiteboard\/(\d+)(\?\/)?/, {
+    resourceId: 1
+  })) || url.match( /*#__PURE__*/_wrapRegExp(/\/wiki\/spaces\/?.*\/whiteboard\/([0-9a-fA-F]{8}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{4}\b\x2D[0-9a-fA-F]{12})(\?\/)?/, {
+    resourceId: 1
+  }));
+};
 export var EditorCardProvider = /*#__PURE__*/function () {
   function EditorCardProvider(envKey, baseUrlOverride) {
-    var _this = this;
+    var _this2 = this;
     _classCallCheck(this, EditorCardProvider);
     this.baseUrl = baseUrlOverride || getBaseUrl(envKey);
     this.resolverUrl = getResolverUrl(envKey, baseUrlOverride);
@@ -40,7 +54,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
       Origin: this.baseUrl
     };
     this.providersLoader = new DataLoader(function (keys) {
-      return _this.batchProviders(keys);
+      return _this2.batchProviders(keys);
     }, {
       batchScheduleFn: function batchScheduleFn(callback) {
         return setTimeout(callback, BATCH_WAIT_TIME);
@@ -219,7 +233,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
     value: function () {
       var _findUserPreference = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee6(url) {
         var _this$providersData,
-          _this2 = this;
+          _this3 = this;
         var userPreferences, defaultAppearance, appearances, allMatchedLabeledAppearances, longestMatchedLabeledAppearance;
         return _regeneratorRuntime.wrap(function _callee6$(_context6) {
           while (1) switch (_context6.prev = _context6.next) {
@@ -239,7 +253,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
               defaultAppearance = userPreferences.defaultAppearance, appearances = userPreferences.appearances;
               allMatchedLabeledAppearances = appearances.filter(function (_ref) {
                 var urlSegment = _ref.urlSegment;
-                return _this2.doesUrlMatchPath(urlSegment, url);
+                return _this3.doesUrlMatchPath(urlSegment, url);
               });
               if (!(allMatchedLabeledAppearances.length > 0)) {
                 _context6.next = 10;
@@ -298,7 +312,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "getHardCodedAppearance",
     value: function getHardCodedAppearance(url) {
-      if (isJiraRoadMap(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url)) {
+      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url)) {
         return 'embed';
       }
     }
@@ -403,7 +417,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
               // if user's default choice is NOT "inline" (so, block or embed at this point, url was dealt with above)
               userPreference ||
               // If user's default choice is "inline" or user hasn't specified preferences at all,
-              // we check whatever one of the hardcoded providers match url (jira roadmap, polaris, etc)
+              // we check whatever one of the hardcoded providers match url (jira /timeline, polaris, etc)
               hardCodedAppearance ||
               // If non match, we see if this provider has default appearance for this particular regexp
               providerDefaultAppearance ||

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.0.2",
+	"version": "3.0.4",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-card-provider",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,14 +34,14 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/linking-common": "^2.10.0",
+    "@atlaskit/linking-common": "^2.15.0",
     "@babel/runtime": "^7.0.0",
     "dataloader": "^2.0.0",
     "json-ld-types": "3.7.0",
     "setimmediate": "^1.0.5"
   },
   "peerDependencies": {
-    "@atlaskit/link-provider": "^1.6.2",
+    "@atlaskit/link-provider": "^1.6.3",
     "react": "^16.8.0"
   },
   "devDependencies": {

package/report.api.md

@@ -69,7 +69,7 @@ type EnvironmentsKeys = keyof typeof BaseUrls;
 
 ```json
 {
-  "@atlaskit/link-provider": "^1.6.2",
+  "@atlaskit/link-provider": "^1.6.3",
   "react": "^16.8.0"
 }
 ```