@atlaskit/editor-card-provider 6.5.6 → 6.6.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-card-provider
 
+## 6.6.0
+
+### Minor Changes
+
+- [`f0140695e5997`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f0140695e5997) -
+  EDITOR-5585 all split function for card provider with config
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.5.7
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.5.6
 
 ### Patch Changes

package/README.md

@@ -30,6 +30,16 @@ const provider = new EditorCardProvider('stg');
 // You may also pass in a base url override, if you'd like EditorCardProvider
 // to make requests other than api-private.atlassian.com (prod) or pug.jira-dev.com (stg)
 const provider = new EditorCardProvider('stg', 'www.acme.com/your-api-here');
+
+// You may optionally pass a url filter to control which card nodes are supported.
+const provider = new EditorCardProvider(
+	'stg',
+	undefined,
+	undefined,
+	undefined,
+	undefined,
+	(url) => url.endsWith('.atlassian.net'),
+);
 ```
 
 ## Team

package/dist/cjs/index.js

@@ -21,5 +21,17 @@ Object.defineProperty(exports, "editorCardProvider", {
     return _provider.editorCardProvider;
   }
 });
+Object.defineProperty(exports, "isExternalUrl", {
+  enumerable: true,
+  get: function get() {
+    return _provider.isExternalUrl;
+  }
+});
+Object.defineProperty(exports, "isInternalUrl", {
+  enumerable: true,
+  get: function get() {
+    return _provider.isInternalUrl;
+  }
+});
 var _provider = require("./provider");
 var _smartCardLocalCacheClient = require("./smart-card-local-cache-client");

package/dist/cjs/provider.js

@@ -5,7 +5,10 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isJiraWorkItem = exports.editorCardProvider = exports.EditorCardProvider = void 0;
+exports.internalUrlCheckers = exports.editorCardProvider = exports.EditorCardProvider = void 0;
+exports.isExternalUrl = isExternalUrl;
+exports.isInternalUrl = isInternalUrl;
+exports.isJiraWorkItem = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
@@ -32,7 +35,6 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
 function _superPropGet(t, o, e, r) { var p = (0, _get2.default)((0, _getPrototypeOf2.default)(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(e, r) { return new BabelRegExp(e, void 0, r); }; var e = RegExp.prototype, r = new WeakMap(); function BabelRegExp(e, t, p) { var o = RegExp(e, t); return r.set(o, p || r.get(e)), (0, _setPrototypeOf2.default)(o, BabelRegExp.prototype); } function buildGroups(e, t) { var p = r.get(t); return Object.keys(p).reduce(function (r, t) { var o = p[t]; if ("number" == typeof o) r[t] = e[o];else { for (var i = 0; void 0 === e[o[i]] && i + 1 < o.length;) i++; r[t] = e[o[i]]; } return r; }, Object.create(null)); } return (0, _inherits2.default)(BabelRegExp, RegExp), BabelRegExp.prototype.exec = function (r) { var t = e.exec.call(this, r); if (t) { t.groups = buildGroups(t, this); var p = t.indices; p && (p.groups = buildGroups(p, this)); } return t; }, BabelRegExp.prototype[Symbol.replace] = function (t, p) { if ("string" == typeof p) { var o = r.get(this); return e[Symbol.replace].call(this, t, p.replace(/\$<([^>]+)(>|$)/g, function (e, r, t) { if ("" === t) return e; var p = o[r]; return Array.isArray(p) ? "$" + p.join("$") : "number" == typeof p ? "$" + p : ""; })); } if ("function" == typeof p) { var i = this; return e[Symbol.replace].call(this, t, function () { var e = arguments; return "object" != _typeof(e[e.length - 1]) && (e = [].slice.call(e)).push(buildGroups(e, i)), p.apply(this, e); }); } return e[Symbol.replace].call(this, t, p); }, _wrapRegExp.apply(this, arguments); } /* eslint-disable require-unicode-regexp,prefer-regex-literals */
 var BATCH_WAIT_TIME = 50;
-
 // Check if it is matching a Jira Roadmaps or Jira Timeline url
 // NOT to be confused with JSM timeline
 var isJiraRoadmapOrTimeline = function isJiraRoadmapOrTimeline(url) {
@@ -136,8 +138,46 @@ var isAvpVisualizationView = function isAvpVisualizationView(url) {
 var isJiraWorkItem = exports.isJiraWorkItem = function isJiraWorkItem(url) {
   return /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 };
+var internalUrlCheckers = exports.internalUrlCheckers = {
+  isJiraRoadmapOrTimeline: isJiraRoadmapOrTimeline,
+  isPolarisView: isPolarisView,
+  isJwmView: isJwmView,
+  isJiraList: isJiraList,
+  isConfluenceWhiteboard: isConfluenceWhiteboard,
+  isConfluenceDatabase: isConfluenceDatabase,
+  isJiraDashboard: isJiraDashboard,
+  isJiraBacklog: isJiraBacklog,
+  isJiraBoard: isJiraBoard,
+  isJiraPlan: isJiraPlan,
+  isJiraVersion: isJiraVersion,
+  isJiraForm: isJiraForm,
+  isJiraSummary: isJiraSummary,
+  isRovoAgentProfilePage: isRovoAgentProfilePage,
+  isConfluenceTeamCalendars: isConfluenceTeamCalendars,
+  isJiraIssueNavigator: isJiraIssueNavigator
+};
+
+/**
+ * Check if a URL is an internal Atlassian URL (Jira, Confluence, etc.)
+ * by testing it against all known internal URL patterns
+ */
+function isInternalUrl(url) {
+  return Object.values(internalUrlCheckers).some(function (checker) {
+    return checker(url);
+  });
+}
+
+/**
+ * Check if a URL is external (not a known internal Atlassian URL)
+ */
+function isExternalUrl(url) {
+  return !isInternalUrl(url);
+}
+function isCardNode(node) {
+  return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+}
 var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_ref) {
-  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient) {
+  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient, supportedUrlFilter) {
     var _this;
     (0, _classCallCheck2.default)(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
@@ -147,6 +187,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
     _this.resolverUrl = (0, _linkingCommon.getResolverUrl)(envKey, baseUrlOverride);
     _this.transformer = new _transformer.Transformer();
     _this.onResolve = onResolve;
+    _this.supportedUrlFilter = supportedUrlFilter;
     _this.requestHeaders = {
       Origin: _this.baseUrl
     };
@@ -228,7 +269,13 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
   }, {
     key: "isNodeSupported",
     value: function isNodeSupported(node) {
-      return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+      if (!isCardNode(node)) {
+        return false;
+      }
+      if (!this.supportedUrlFilter) {
+        return true;
+      }
+      return this.supportedUrlFilter(node.attrs.url);
     }
   }, {
     key: "batchProviders",

package/dist/es2019/index.js

@@ -1,5 +1,5 @@
 // Disable no-re-export rule for entry point files
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider, isInternalUrl, isExternalUrl } from './provider';
 export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/es2019/provider.js

@@ -12,7 +12,6 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { request } from './api';
 import { SmartCardLocalCacheClient } from './smart-card-local-cache-client';
 const BATCH_WAIT_TIME = 50;
-
 // 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)\/?/);
@@ -69,8 +68,44 @@ url.match(/\/wiki\/spaces\/(?<resourceContext>[^\/]+)\/calendars\/(?<resourceId>
 const isJiraIssueNavigator = url => url.match(/^https:\/\/.*?\/jira\/software|core\/(c\/)?projects\/[^\/]+?\/issues\/?/);
 const isAvpVisualizationView = url => url.match(/^https:\/\/.*?\/avpviz\/c\/[^\/]+.*/);
 export const isJiraWorkItem = url => /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
+export const internalUrlCheckers = {
+  isJiraRoadmapOrTimeline,
+  isPolarisView,
+  isJwmView,
+  isJiraList,
+  isConfluenceWhiteboard,
+  isConfluenceDatabase,
+  isJiraDashboard,
+  isJiraBacklog,
+  isJiraBoard,
+  isJiraPlan,
+  isJiraVersion,
+  isJiraForm,
+  isJiraSummary,
+  isRovoAgentProfilePage,
+  isConfluenceTeamCalendars,
+  isJiraIssueNavigator
+};
+
+/**
+ * Check if a URL is an internal Atlassian URL (Jira, Confluence, etc.)
+ * by testing it against all known internal URL patterns
+ */
+export function isInternalUrl(url) {
+  return Object.values(internalUrlCheckers).some(checker => checker(url));
+}
+
+/**
+ * Check if a URL is external (not a known internal Atlassian URL)
+ */
+export function isExternalUrl(url) {
+  return !isInternalUrl(url);
+}
+function isCardNode(node) {
+  return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+}
 export class EditorCardProvider extends NodeDataProvider {
-  constructor(envKey, baseUrlOverride, product, onResolve, customCardClient) {
+  constructor(envKey, baseUrlOverride, product, onResolve, customCardClient, supportedUrlFilter) {
     super();
     _defineProperty(this, "smartCardLocalCacheClient", SmartCardLocalCacheClient.getInstance());
     this.name = 'editorCardProvider';
@@ -78,6 +113,7 @@ export class EditorCardProvider extends NodeDataProvider {
     this.resolverUrl = getResolverUrl(envKey, baseUrlOverride);
     this.transformer = new Transformer();
     this.onResolve = onResolve;
+    this.supportedUrlFilter = supportedUrlFilter;
     this.requestHeaders = {
       Origin: this.baseUrl
     };
@@ -141,7 +177,13 @@ export class EditorCardProvider extends NodeDataProvider {
     return Promise.all(promises);
   }
   isNodeSupported(node) {
-    return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+    if (!isCardNode(node)) {
+      return false;
+    }
+    if (!this.supportedUrlFilter) {
+      return true;
+    }
+    return this.supportedUrlFilter(node.attrs.url);
   }
   async batchProviders(keys) {
     // EDM-2205: Batch requests in the case that user paste multiple links at

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 // Disable no-re-export rule for entry point files
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider, isInternalUrl, isExternalUrl } from './provider';
 export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/esm/provider.js

@@ -27,7 +27,6 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { request } from './api';
 import { SmartCardLocalCacheClient } from './smart-card-local-cache-client';
 var BATCH_WAIT_TIME = 50;
-
 // Check if it is matching a Jira Roadmaps or Jira Timeline url
 // NOT to be confused with JSM timeline
 var isJiraRoadmapOrTimeline = function isJiraRoadmapOrTimeline(url) {
@@ -131,8 +130,46 @@ var isAvpVisualizationView = function isAvpVisualizationView(url) {
 export var isJiraWorkItem = function isJiraWorkItem(url) {
   return /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 };
+export var internalUrlCheckers = {
+  isJiraRoadmapOrTimeline: isJiraRoadmapOrTimeline,
+  isPolarisView: isPolarisView,
+  isJwmView: isJwmView,
+  isJiraList: isJiraList,
+  isConfluenceWhiteboard: isConfluenceWhiteboard,
+  isConfluenceDatabase: isConfluenceDatabase,
+  isJiraDashboard: isJiraDashboard,
+  isJiraBacklog: isJiraBacklog,
+  isJiraBoard: isJiraBoard,
+  isJiraPlan: isJiraPlan,
+  isJiraVersion: isJiraVersion,
+  isJiraForm: isJiraForm,
+  isJiraSummary: isJiraSummary,
+  isRovoAgentProfilePage: isRovoAgentProfilePage,
+  isConfluenceTeamCalendars: isConfluenceTeamCalendars,
+  isJiraIssueNavigator: isJiraIssueNavigator
+};
+
+/**
+ * Check if a URL is an internal Atlassian URL (Jira, Confluence, etc.)
+ * by testing it against all known internal URL patterns
+ */
+export function isInternalUrl(url) {
+  return Object.values(internalUrlCheckers).some(function (checker) {
+    return checker(url);
+  });
+}
+
+/**
+ * Check if a URL is external (not a known internal Atlassian URL)
+ */
+export function isExternalUrl(url) {
+  return !isInternalUrl(url);
+}
+function isCardNode(node) {
+  return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+}
 export var EditorCardProvider = /*#__PURE__*/function (_ref) {
-  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient) {
+  function EditorCardProvider(envKey, baseUrlOverride, product, onResolve, customCardClient, supportedUrlFilter) {
     var _this;
     _classCallCheck(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
@@ -142,6 +179,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
     _this.resolverUrl = getResolverUrl(envKey, baseUrlOverride);
     _this.transformer = new Transformer();
     _this.onResolve = onResolve;
+    _this.supportedUrlFilter = supportedUrlFilter;
     _this.requestHeaders = {
       Origin: _this.baseUrl
     };
@@ -223,7 +261,13 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
   }, {
     key: "isNodeSupported",
     value: function isNodeSupported(node) {
-      return ['inlineCard', 'blockCard', 'embedCard'].includes(node.type) && !!node.attrs && 'url' in node.attrs && typeof node.attrs.url === 'string';
+      if (!isCardNode(node)) {
+        return false;
+      }
+      if (!this.supportedUrlFilter) {
+        return true;
+      }
+      return this.supportedUrlFilter(node.attrs.url);
     }
   }, {
     key: "batchProviders",

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider, isInternalUrl, isExternalUrl } from './provider';
 export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/types/provider.d.ts

@@ -6,10 +6,24 @@ import type { BlockCardAdf, EmbedCardAdf, CardAdf, InlineCardAdf, CardAppearance
 import type { CardProvider } from './types';
 import { CardClient } from '@atlaskit/link-provider';
 import type { JsonLd } from '@atlaskit/json-ld-types';
+type UrlChecker = (url: string) => RegExpMatchArray | null;
 export declare const isJiraWorkItem: (url: string) => boolean;
+export declare const internalUrlCheckers: {
+    [key: string]: UrlChecker;
+};
+/**
+ * Check if a URL is an internal Atlassian URL (Jira, Confluence, etc.)
+ * by testing it against all known internal URL patterns
+ */
+export declare function isInternalUrl(url: string): boolean;
+/**
+ * Check if a URL is external (not a known internal Atlassian URL)
+ */
+export declare function isExternalUrl(url: string): boolean;
 type CardNode = InlineCardAdf | BlockCardAdf | EmbedCardAdf;
+type SupportedUrlFilter = (url: string) => boolean;
 export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonLd.Response> implements CardProvider {
-    readonly name: 'editorCardProvider';
+    readonly name: 'editorCardProvider' | string;
     private baseUrl;
     private resolverUrl;
     private providersData?;
@@ -19,7 +33,8 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private cardClient;
     private smartCardLocalCacheClient;
     private onResolve;
-    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
+    private supportedUrlFilter?;
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient, supportedUrlFilter?: SupportedUrlFilter);
     refreshCache(node: CardNode | PMNode): void;
     getData(node: CardNode | PMNode, callback: (payload: CallbackPayload<JsonLd.Response>) => void): void;
     nodeDataKey(node: CardNode): string;

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

@@ -1,2 +1,2 @@
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider, isInternalUrl, isExternalUrl } from './provider';
 export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

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

@@ -6,10 +6,24 @@ import type { BlockCardAdf, EmbedCardAdf, CardAdf, InlineCardAdf, CardAppearance
 import type { CardProvider } from './types';
 import { CardClient } from '@atlaskit/link-provider';
 import type { JsonLd } from '@atlaskit/json-ld-types';
+type UrlChecker = (url: string) => RegExpMatchArray | null;
 export declare const isJiraWorkItem: (url: string) => boolean;
+export declare const internalUrlCheckers: {
+    [key: string]: UrlChecker;
+};
+/**
+ * Check if a URL is an internal Atlassian URL (Jira, Confluence, etc.)
+ * by testing it against all known internal URL patterns
+ */
+export declare function isInternalUrl(url: string): boolean;
+/**
+ * Check if a URL is external (not a known internal Atlassian URL)
+ */
+export declare function isExternalUrl(url: string): boolean;
 type CardNode = InlineCardAdf | BlockCardAdf | EmbedCardAdf;
+type SupportedUrlFilter = (url: string) => boolean;
 export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonLd.Response> implements CardProvider {
-    readonly name: 'editorCardProvider';
+    readonly name: 'editorCardProvider' | string;
     private baseUrl;
     private resolverUrl;
     private providersData?;
@@ -19,7 +33,8 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private cardClient;
     private smartCardLocalCacheClient;
     private onResolve;
-    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
+    private supportedUrlFilter?;
+    constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient, supportedUrlFilter?: SupportedUrlFilter);
     refreshCache(node: CardNode | PMNode): void;
     getData(node: CardNode | PMNode, callback: (payload: CallbackPayload<JsonLd.Response>) => void): void;
     nodeDataKey(node: CardNode): string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "6.5.6",
+	"version": "6.6.0",
 	"description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -39,7 +39,7 @@
 		"@atlaskit/linking-types": "^14.2.0",
 		"@atlaskit/node-data-provider": "^9.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^47.0.0",
+		"@atlaskit/tmp-editor-statsig": "^48.0.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0"
 	},