@atlaskit/adf-schema 26.1.0 → 26.2.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/adf-schema
 
+## 26.2.0
+
+### Minor Changes
+
+- [`a5877196a3c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a5877196a3c) - [ux] EDM-6499 Fix handling of tel and other custom URI links
+
 ## 26.1.0
 
 ### Minor Changes

package/dist/cjs/utils/url.js

@@ -11,11 +11,17 @@ exports.linkifyMatch = exports.linkify = exports.isSafeUrl = void 0;
 exports.normalizeUrl = normalizeUrl;
 var _linkifyIt = _interopRequireDefault(require("linkify-it"));
 /**
- * This file has been duplicated in packages/linking-platform/link-picker/src/common/utils/url.ts
+ * This file has been partially duplicated in packages/linking-platform/linking-common/src/url.ts
  * Any changes made here should be mirrored there.
+ * Ticket for dedeplication: https://product-fabric.atlassian.net/browse/EDM-7138
+ * Ticket for fixing linkification of filename-like urls: https://product-fabric.atlassian.net/browse/EDM-7190
  */
 
-var whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im, /^notes:/im, /^hipchat:\/\//im, /^sourcetree:/im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
+var whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im,
+// This is not a valid notes link, but we support this pattern for backwards compatibility
+/^notes:/im, /^notes:\/\//im, /^hipchat:\/\//im,
+// This is not a valid sourcetree link, but we support this pattern for backwards compatibility
+/^sourcetree:/im, /^sourcetree:\/\//im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
 
 /**
  * Please notify the Editor Mobile team (Slack: #help-mobilekit) if the logic for this changes.
@@ -34,17 +40,30 @@ var linkify = (0, _linkifyIt.default)();
 exports.linkify = linkify;
 linkify.add('sourcetree:', 'http:');
 linkify.add('jamfselfservice:', 'http:');
+var urlWithoutSpacesValidator = {
+  validate: /[^\s]+/
+};
+
+// `tel:` URI spec is https://datatracker.ietf.org/doc/html/rfc3966
+// We're not validating the phone number or separators - but if there's a space it definitely isn't a valid `tel:` URI
+linkify.add('tel:', urlWithoutSpacesValidator);
+linkify.add('notes:', 'http:');
 var tlds = 'biz|com|edu|gov|net|org|pro|web|xxx|aero|asia|coop|info|museum|name|shop|рф'.split('|');
 var tlds2Char = 'a[cdefgilmnoqrtuwxz]|b[abdefghijmnorstvwyz]|c[acdfghiklmnoruvwxyz]|d[ejkmoz]|e[cegrstu]|f[ijkmor]|g[abdefghilmnpqrstuwy]|h[kmnrtu]|i[delmnoqrst]|j[emop]|k[eghimnprwyz]|l[abcikrstuvy]|m[acdeghklmnopqrtuvwxyz]|n[acefgilopruz]|om|p[aefghkmnrtw]|qa|r[eosuw]|s[abcdegijklmnrtuvxyz]|t[cdfghjklmnortvwz]|u[agksyz]|v[aceginu]|w[fs]|y[et]|z[amw]';
 tlds.push(tlds2Char);
 linkify.tlds(tlds, false);
+
+// linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+// https://product-fabric.atlassian.net/browse/ED-13669
 var LINK_REGEXP = /(https?|ftp|jamfselfservice|gopher|dynamicsnav|integrity|file|smb):\/\/[^\s]+/;
+
+/** Attempt to find a link match using a regex string defining a URL */
 exports.LINK_REGEXP = LINK_REGEXP;
 var linkifyMatch = function linkifyMatch(text) {
-  var matches = [];
   if (!LINK_REGEXP.test(text)) {
-    return matches;
+    return [];
   }
+  var matches = [];
   var startpos = 0;
   var substr;
   while (substr = text.substr(startpos)) {
@@ -68,11 +87,19 @@ var linkifyMatch = function linkifyMatch(text) {
   }
   return matches;
 };
+
+/**
+ * Attempt to find a link match. Tries to use our regex search first.
+ * If this doesn't match (e.g. no protocol), try using linkify-it library.
+ * Returns null if url string empty or no string given, or if no match found.
+ */
 exports.linkifyMatch = linkifyMatch;
 function getLinkMatch(str) {
   if (!str) {
     return null;
   }
+  // linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+  // https://product-fabric.atlassian.net/browse/ED-13669
   var match = linkifyMatch(str);
   if (!match.length) {
     match = linkify.match(str);
@@ -82,6 +109,7 @@ function getLinkMatch(str) {
 
 /**
  * Adds protocol to url if needed.
+ * Returns empty string if no url given or if no link match found.
  */
 function normalizeUrl(url) {
   var match = getLinkMatch(url);

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "26.1.0",
+	"version": "26.2.0",
 	"sideEffects": false
 }

package/dist/es2019/utils/url.js

@@ -1,9 +1,15 @@
 /**
- * This file has been duplicated in packages/linking-platform/link-picker/src/common/utils/url.ts
+ * This file has been partially duplicated in packages/linking-platform/linking-common/src/url.ts
  * Any changes made here should be mirrored there.
+ * Ticket for dedeplication: https://product-fabric.atlassian.net/browse/EDM-7138
+ * Ticket for fixing linkification of filename-like urls: https://product-fabric.atlassian.net/browse/EDM-7190
  */
 import LinkifyIt from 'linkify-it';
-const whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im, /^notes:/im, /^hipchat:\/\//im, /^sourcetree:/im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
+const whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im,
+// This is not a valid notes link, but we support this pattern for backwards compatibility
+/^notes:/im, /^notes:\/\//im, /^hipchat:\/\//im,
+// This is not a valid sourcetree link, but we support this pattern for backwards compatibility
+/^sourcetree:/im, /^sourcetree:\/\//im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
 
 /**
  * Please notify the Editor Mobile team (Slack: #help-mobilekit) if the logic for this changes.
@@ -18,16 +24,29 @@ export const isSafeUrl = url => {
 export const linkify = LinkifyIt();
 linkify.add('sourcetree:', 'http:');
 linkify.add('jamfselfservice:', 'http:');
+const urlWithoutSpacesValidator = {
+  validate: /[^\s]+/
+};
+
+// `tel:` URI spec is https://datatracker.ietf.org/doc/html/rfc3966
+// We're not validating the phone number or separators - but if there's a space it definitely isn't a valid `tel:` URI
+linkify.add('tel:', urlWithoutSpacesValidator);
+linkify.add('notes:', 'http:');
 const tlds = 'biz|com|edu|gov|net|org|pro|web|xxx|aero|asia|coop|info|museum|name|shop|рф'.split('|');
 const tlds2Char = 'a[cdefgilmnoqrtuwxz]|b[abdefghijmnorstvwyz]|c[acdfghiklmnoruvwxyz]|d[ejkmoz]|e[cegrstu]|f[ijkmor]|g[abdefghilmnpqrstuwy]|h[kmnrtu]|i[delmnoqrst]|j[emop]|k[eghimnprwyz]|l[abcikrstuvy]|m[acdeghklmnopqrtuvwxyz]|n[acefgilopruz]|om|p[aefghkmnrtw]|qa|r[eosuw]|s[abcdegijklmnrtuvxyz]|t[cdfghjklmnortvwz]|u[agksyz]|v[aceginu]|w[fs]|y[et]|z[amw]';
 tlds.push(tlds2Char);
 linkify.tlds(tlds, false);
+
+// linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+// https://product-fabric.atlassian.net/browse/ED-13669
 export const LINK_REGEXP = /(https?|ftp|jamfselfservice|gopher|dynamicsnav|integrity|file|smb):\/\/[^\s]+/;
+
+/** Attempt to find a link match using a regex string defining a URL */
 export const linkifyMatch = text => {
-  const matches = [];
   if (!LINK_REGEXP.test(text)) {
-    return matches;
+    return [];
   }
+  const matches = [];
   let startpos = 0;
   let substr;
   while (substr = text.substr(startpos)) {
@@ -51,10 +70,18 @@ export const linkifyMatch = text => {
   }
   return matches;
 };
+
+/**
+ * Attempt to find a link match. Tries to use our regex search first.
+ * If this doesn't match (e.g. no protocol), try using linkify-it library.
+ * Returns null if url string empty or no string given, or if no match found.
+ */
 export function getLinkMatch(str) {
   if (!str) {
     return null;
   }
+  // linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+  // https://product-fabric.atlassian.net/browse/ED-13669
   let match = linkifyMatch(str);
   if (!match.length) {
     match = linkify.match(str);
@@ -64,6 +91,7 @@ export function getLinkMatch(str) {
 
 /**
  * Adds protocol to url if needed.
+ * Returns empty string if no url given or if no link match found.
  */
 export function normalizeUrl(url) {
   const match = getLinkMatch(url);

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "26.1.0",
+	"version": "26.2.0",
 	"sideEffects": false
 }

package/dist/esm/utils/url.js

@@ -1,9 +1,15 @@
 /**
- * This file has been duplicated in packages/linking-platform/link-picker/src/common/utils/url.ts
+ * This file has been partially duplicated in packages/linking-platform/linking-common/src/url.ts
  * Any changes made here should be mirrored there.
+ * Ticket for dedeplication: https://product-fabric.atlassian.net/browse/EDM-7138
+ * Ticket for fixing linkification of filename-like urls: https://product-fabric.atlassian.net/browse/EDM-7190
  */
 import LinkifyIt from 'linkify-it';
-var whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im, /^notes:/im, /^hipchat:\/\//im, /^sourcetree:/im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
+var whitelistedURLPatterns = [/^https?:\/\//im, /^ftps?:\/\//im, /^gopher:\/\//im, /^integrity:\/\//im, /^file:\/\//im, /^smb:\/\//im, /^dynamicsnav:\/\//im, /^jamfselfservice:\/\//im, /^\//im, /^mailto:/im, /^skype:/im, /^callto:/im, /^facetime:/im, /^git:/im, /^irc6?:/im, /^news:/im, /^nntp:/im, /^feed:/im, /^cvs:/im, /^svn:/im, /^mvn:/im, /^ssh:/im, /^scp:\/\//im, /^sftp:\/\//im, /^itms:/im,
+// This is not a valid notes link, but we support this pattern for backwards compatibility
+/^notes:/im, /^notes:\/\//im, /^hipchat:\/\//im,
+// This is not a valid sourcetree link, but we support this pattern for backwards compatibility
+/^sourcetree:/im, /^sourcetree:\/\//im, /^urn:/im, /^tel:/im, /^xmpp:/im, /^telnet:/im, /^vnc:/im, /^rdp:/im, /^whatsapp:/im, /^slack:/im, /^sips?:/im, /^magnet:/im, /^#/im];
 
 /**
  * Please notify the Editor Mobile team (Slack: #help-mobilekit) if the logic for this changes.
@@ -20,16 +26,29 @@ export var isSafeUrl = function isSafeUrl(url) {
 export var linkify = LinkifyIt();
 linkify.add('sourcetree:', 'http:');
 linkify.add('jamfselfservice:', 'http:');
+var urlWithoutSpacesValidator = {
+  validate: /[^\s]+/
+};
+
+// `tel:` URI spec is https://datatracker.ietf.org/doc/html/rfc3966
+// We're not validating the phone number or separators - but if there's a space it definitely isn't a valid `tel:` URI
+linkify.add('tel:', urlWithoutSpacesValidator);
+linkify.add('notes:', 'http:');
 var tlds = 'biz|com|edu|gov|net|org|pro|web|xxx|aero|asia|coop|info|museum|name|shop|рф'.split('|');
 var tlds2Char = 'a[cdefgilmnoqrtuwxz]|b[abdefghijmnorstvwyz]|c[acdfghiklmnoruvwxyz]|d[ejkmoz]|e[cegrstu]|f[ijkmor]|g[abdefghilmnpqrstuwy]|h[kmnrtu]|i[delmnoqrst]|j[emop]|k[eghimnprwyz]|l[abcikrstuvy]|m[acdeghklmnopqrtuvwxyz]|n[acefgilopruz]|om|p[aefghkmnrtw]|qa|r[eosuw]|s[abcdegijklmnrtuvxyz]|t[cdfghjklmnortvwz]|u[agksyz]|v[aceginu]|w[fs]|y[et]|z[amw]';
 tlds.push(tlds2Char);
 linkify.tlds(tlds, false);
+
+// linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+// https://product-fabric.atlassian.net/browse/ED-13669
 export var LINK_REGEXP = /(https?|ftp|jamfselfservice|gopher|dynamicsnav|integrity|file|smb):\/\/[^\s]+/;
+
+/** Attempt to find a link match using a regex string defining a URL */
 export var linkifyMatch = function linkifyMatch(text) {
-  var matches = [];
   if (!LINK_REGEXP.test(text)) {
-    return matches;
+    return [];
   }
+  var matches = [];
   var startpos = 0;
   var substr;
   while (substr = text.substr(startpos)) {
@@ -53,10 +72,18 @@ export var linkifyMatch = function linkifyMatch(text) {
   }
   return matches;
 };
+
+/**
+ * Attempt to find a link match. Tries to use our regex search first.
+ * If this doesn't match (e.g. no protocol), try using linkify-it library.
+ * Returns null if url string empty or no string given, or if no match found.
+ */
 export function getLinkMatch(str) {
   if (!str) {
     return null;
   }
+  // linkify-it mishandles closing braces on long urls, so we preference using our own regex first:
+  // https://product-fabric.atlassian.net/browse/ED-13669
   var match = linkifyMatch(str);
   if (!match.length) {
     match = linkify.match(str);
@@ -66,6 +93,7 @@ export function getLinkMatch(str) {
 
 /**
  * Adds protocol to url if needed.
+ * Returns empty string if no url given or if no link match found.
  */
 export function normalizeUrl(url) {
   var match = getLinkMatch(url);

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/adf-schema",
-	"version": "26.1.0",
+	"version": "26.2.0",
 	"sideEffects": false
 }

package/dist/types/utils/url.d.ts

@@ -1,6 +1,8 @@
 /**
- * This file has been duplicated in packages/linking-platform/link-picker/src/common/utils/url.ts
+ * This file has been partially duplicated in packages/linking-platform/linking-common/src/url.ts
  * Any changes made here should be mirrored there.
+ * Ticket for dedeplication: https://product-fabric.atlassian.net/browse/EDM-7138
+ * Ticket for fixing linkification of filename-like urls: https://product-fabric.atlassian.net/browse/EDM-7190
  */
 import LinkifyIt from 'linkify-it';
 /**
@@ -19,10 +21,17 @@ export interface Match {
 }
 export declare const linkify: LinkifyIt.LinkifyIt;
 export declare const LINK_REGEXP: RegExp;
+/** Attempt to find a link match using a regex string defining a URL */
 export declare const linkifyMatch: (text: string) => Match[];
+/**
+ * Attempt to find a link match. Tries to use our regex search first.
+ * If this doesn't match (e.g. no protocol), try using linkify-it library.
+ * Returns null if url string empty or no string given, or if no match found.
+ */
 export declare function getLinkMatch(str?: string): Match | null;
 /**
  * Adds protocol to url if needed.
+ * Returns empty string if no url given or if no link match found.
  */
 export declare function normalizeUrl(url?: string): string;
 /**

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

@@ -1,6 +1,8 @@
 /**
- * This file has been duplicated in packages/linking-platform/link-picker/src/common/utils/url.ts
+ * This file has been partially duplicated in packages/linking-platform/linking-common/src/url.ts
  * Any changes made here should be mirrored there.
+ * Ticket for dedeplication: https://product-fabric.atlassian.net/browse/EDM-7138
+ * Ticket for fixing linkification of filename-like urls: https://product-fabric.atlassian.net/browse/EDM-7190
  */
 import LinkifyIt from 'linkify-it';
 /**
@@ -19,10 +21,17 @@ export interface Match {
 }
 export declare const linkify: LinkifyIt.LinkifyIt;
 export declare const LINK_REGEXP: RegExp;
+/** Attempt to find a link match using a regex string defining a URL */
 export declare const linkifyMatch: (text: string) => Match[];
+/**
+ * Attempt to find a link match. Tries to use our regex search first.
+ * If this doesn't match (e.g. no protocol), try using linkify-it library.
+ * Returns null if url string empty or no string given, or if no match found.
+ */
 export declare function getLinkMatch(str?: string): Match | null;
 /**
  * Adds protocol to url if needed.
+ * Returns empty string if no url given or if no link match found.
  */
 export declare function normalizeUrl(url?: string): string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/adf-schema",
-  "version": "26.1.0",
+  "version": "26.2.0",
   "description": "Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -58,7 +58,7 @@
     "prosemirror-transform": "1.3.2"
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^18.9.0",
+    "@atlaskit/editor-test-helpers": "^18.10.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@types/linkify-it": "^2.0.4",
     "prosemirror-history": "^1.1.3",

package/report.api.md

@@ -740,7 +740,7 @@ export function getEmojiAcName({
   shortName: string;
 }): string;
 
-// @public (undocumented)
+// @public
 export function getLinkMatch(str?: string): Match | null;
 
 // @public (undocumented)
@@ -975,7 +975,7 @@ export interface LinkDefinition {
 // @public (undocumented)
 export const linkify: LinkifyIt.LinkifyIt;
 
-// @public (undocumented)
+// @public
 export const linkifyMatch: (text: string) => Match[];
 
 // @public (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -670,7 +670,7 @@ export function getEmojiAcName({ id, shortName, }: {
     shortName: string;
 }): string;
 
-// @public (undocumented)
+// @public
 export function getLinkMatch(str?: string): Match | null;
 
 // @public (undocumented)
@@ -877,7 +877,7 @@ export interface LinkDefinition {
 // @public (undocumented)
 export const linkify: LinkifyIt.LinkifyIt;
 
-// @public (undocumented)
+// @public
 export const linkifyMatch: (text: string) => Match[];
 
 // @public (undocumented)