@atlaskit/editor-card-provider 3.8.2 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-card-provider
 
+## 3.10.0
+
+### Minor Changes
+
+- [#144036](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/144036)
+  [`0509cf0b76664`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0509cf0b76664) -
+  [ux] Update editor card provider to return embed card for backlog and board links
+
+## 3.9.0
+
+### Minor Changes
+
+- [#139456](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/139456)
+  [`a788f5ceac7a2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a788f5ceac7a2) -
+  [ux] Add optional forth optional parameter to EditorCardProvider.resolve method called
+  `isEmbedFriendlyLocation` which when given `false` value will prevent auto-conversion (on link
+  paste) to an embed based on FE speciafied regexp rules. If value is not given it will act as true
+  and remain old behaviour
+
 ## 3.8.2
 
 ### Patch Changes

package/dist/cjs/provider.js

@@ -65,6 +65,12 @@ var isLoomUrl = function isLoomUrl(url) {
 var isJiraDashboard = function isJiraDashboard(url) {
   return url.match(/^https:\/\/.*?\/jira\/dashboards\/[0-9]+.*/);
 };
+var isJiraBacklog = function isJiraBacklog(url) {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\/backlog\??.*/);
+};
+var isJiraBoard = function isJiraBoard(url) {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\??.*/);
+};
 var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function () {
   function EditorCardProvider(envKey, baseUrlOverride, product) {
     var _this = this;
@@ -346,7 +352,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "getHardCodedAppearance",
     value: function getHardCodedAppearance(url) {
-      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url)) {
+      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url) || isJiraBacklog(url) || isJiraBoard(url)) {
         return 'embed';
       }
     }
@@ -441,7 +447,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "resolve",
     value: function () {
-      var _resolve = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(url, appearance, shouldForceAppearance) {
+      var _resolve = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee10(url, appearance, shouldForceAppearance, isEmbedFriendlyLocation) {
         var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, isSupported, providerDefaultAppearance, preferredAppearance, canItBeEmbed, datasource, id, parameters;
         return _regenerator.default.wrap(function _callee10$(_context10) {
           while (1) switch (_context10.prev = _context10.next) {
@@ -491,7 +497,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function () {
               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 /timeline, polaris, etc)
-              hardCodedAppearance ||
+              (isEmbedFriendlyLocation || isEmbedFriendlyLocation === undefined) && hardCodedAppearance ||
               // If non match, we see if this provider has default appearance for this particular regexp
               providerDefaultAppearance ||
               // If not, we pick what editor (or any other client) requested
@@ -544,7 +550,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function () {
           }
         }, _callee10, this, [[0, 35]]);
       }));
-      function resolve(_x8, _x9, _x10) {
+      function resolve(_x8, _x9, _x10, _x11) {
         return _resolve.apply(this, arguments);
       }
       return resolve;

package/dist/es2019/provider.js

@@ -24,6 +24,12 @@ const isLoomUrl = url => {
 const isJiraDashboard = url => {
   return url.match(/^https:\/\/.*?\/jira\/dashboards\/[0-9]+.*/);
 };
+const isJiraBacklog = url => {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\/backlog\??.*/);
+};
+const isJiraBoard = url => {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\??.*/);
+};
 export class EditorCardProvider {
   constructor(envKey, baseUrlOverride, product) {
     this.baseUrl = baseUrlOverride || getBaseUrl(envKey);
@@ -128,7 +134,7 @@ export class EditorCardProvider {
    * @returns 'embed' for the card appearance to embed by default
    */
   getHardCodedAppearance(url) {
-    if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url)) {
+    if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url) || isJiraBacklog(url) || isJiraBoard(url)) {
       return 'embed';
     }
   }
@@ -173,7 +179,7 @@ export class EditorCardProvider {
       return undefined;
     }
   }
-  async resolve(url, appearance, shouldForceAppearance) {
+  async resolve(url, appearance, shouldForceAppearance, isEmbedFriendlyLocation) {
     try {
       if (shouldForceAppearance === true) {
         // At this point we don't need to check pattern nor call `check` because manual change means
@@ -197,7 +203,7 @@ export class EditorCardProvider {
         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 /timeline, polaris, etc)
-        hardCodedAppearance ||
+        (isEmbedFriendlyLocation || isEmbedFriendlyLocation === undefined) && hardCodedAppearance ||
         // If non match, we see if this provider has default appearance for this particular regexp
         providerDefaultAppearance ||
         // If not, we pick what editor (or any other client) requested

package/dist/esm/provider.js

@@ -57,6 +57,12 @@ var isLoomUrl = function isLoomUrl(url) {
 var isJiraDashboard = function isJiraDashboard(url) {
   return url.match(/^https:\/\/.*?\/jira\/dashboards\/[0-9]+.*/);
 };
+var isJiraBacklog = function isJiraBacklog(url) {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\/backlog\??.*/);
+};
+var isJiraBoard = function isJiraBoard(url) {
+  return url.match(/https:\/\/.*?\/jira\/software\/(c\/)?projects\/[^\/]+?\/boards\/\d\??.*/);
+};
 export var EditorCardProvider = /*#__PURE__*/function () {
   function EditorCardProvider(envKey, baseUrlOverride, product) {
     var _this = this;
@@ -338,7 +344,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "getHardCodedAppearance",
     value: function getHardCodedAppearance(url) {
-      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url)) {
+      if (isJiraRoadmapOrTimeline(url) || isPolarisView(url) || isJwmView(url) || isJiraList(url) || isGiphyMedia(url) || isProformaView(url) || isConfluenceWhiteboard(url) || isConfluenceDatabase(url) || isYoutubeVideo(url) || isLoomUrl(url) || isJiraDashboard(url) || isJiraBacklog(url) || isJiraBoard(url)) {
         return 'embed';
       }
     }
@@ -433,7 +439,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
   }, {
     key: "resolve",
     value: function () {
-      var _resolve = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(url, appearance, shouldForceAppearance) {
+      var _resolve = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(url, appearance, shouldForceAppearance, isEmbedFriendlyLocation) {
         var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, isSupported, providerDefaultAppearance, preferredAppearance, canItBeEmbed, datasource, id, parameters;
         return _regeneratorRuntime.wrap(function _callee10$(_context10) {
           while (1) switch (_context10.prev = _context10.next) {
@@ -483,7 +489,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
               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 /timeline, polaris, etc)
-              hardCodedAppearance ||
+              (isEmbedFriendlyLocation || isEmbedFriendlyLocation === undefined) && hardCodedAppearance ||
               // If non match, we see if this provider has default appearance for this particular regexp
               providerDefaultAppearance ||
               // If not, we pick what editor (or any other client) requested
@@ -536,7 +542,7 @@ export var EditorCardProvider = /*#__PURE__*/function () {
           }
         }, _callee10, this, [[0, 35]]);
       }));
-      function resolve(_x8, _x9, _x10) {
+      function resolve(_x8, _x9, _x10, _x11) {
         return _resolve.apply(this, arguments);
       }
       return resolve;

package/dist/types/provider.d.ts

@@ -36,7 +36,7 @@ export declare class EditorCardProvider implements CardProvider {
      * Make a /resolve call and find out if result has datasource capability
      */
     private getDatasourceFromResolveResponse;
-    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<CardAdf | DatasourceAdf>;
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean, isEmbedFriendlyLocation?: boolean): Promise<CardAdf | DatasourceAdf>;
 }
 export declare const editorCardProvider: EditorCardProvider;
 export type { CardProvider } from './types';

package/dist/types/types.d.ts

@@ -1,6 +1,6 @@
 import { type CardAppearance } from '@atlaskit/linking-common';
 export interface CardProvider {
-    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean, isEmbedFriendlyLocation?: boolean): Promise<any>;
 }
 export type ORSCheckResponse = {
     isSupported: boolean;

package/dist/types-ts4.5/provider.d.ts

@@ -36,7 +36,7 @@ export declare class EditorCardProvider implements CardProvider {
      * Make a /resolve call and find out if result has datasource capability
      */
     private getDatasourceFromResolveResponse;
-    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<CardAdf | DatasourceAdf>;
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean, isEmbedFriendlyLocation?: boolean): Promise<CardAdf | DatasourceAdf>;
 }
 export declare const editorCardProvider: EditorCardProvider;
 export type { CardProvider } from './types';

package/dist/types-ts4.5/types.d.ts

@@ -1,6 +1,6 @@
 import { type CardAppearance } from '@atlaskit/linking-common';
 export interface CardProvider {
-    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean): Promise<any>;
+    resolve(url: string, appearance: CardAppearance, shouldForceAppearance?: boolean, isEmbedFriendlyLocation?: boolean): Promise<any>;
 }
 export type ORSCheckResponse = {
     isSupported: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "3.8.2",
+	"version": "3.10.0",
 	"description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",