@atlaskit/smart-card 17.2.1 → 17.4.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @atlaskit/smart-card
 
+## 17.4.0
+
+### Minor Changes
+
+- [`392b7d2b98f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/392b7d2b98f) - Add Provider element
+
+## 17.3.2
+
+### Patch Changes
+
+- [`02ed34221ef`](https://bitbucket.org/atlassian/atlassian-frontend/commits/02ed34221ef) - Flexible UI: Add Snippet element
+
+## 17.3.1
+
+### Patch Changes
+
+- [`66dc86e0331`](https://bitbucket.org/atlassian/atlassian-frontend/commits/66dc86e0331) - Flexible UI: Check for null element
+
+## 17.3.0
+
+### Minor Changes
+
+- [`dab29fc6697`](https://bitbucket.org/atlassian/atlassian-frontend/commits/dab29fc6697) - [ux] Flexible UI: AvatarGroup sizing updated for small and medium size
+
+### Patch Changes
+
+- [`25408fac413`](https://bitbucket.org/atlassian/atlassian-frontend/commits/25408fac413) - Flexible UI: Add MetadataBlock example
+
 ## 17.2.1
 
 ### Patch Changes

package/dist/cjs/constants.js

@@ -60,7 +60,20 @@ exports.SmartLinkTheme = SmartLinkTheme;
   SmartLinkTheme["Link"] = "link";
 })(SmartLinkTheme || (exports.SmartLinkTheme = SmartLinkTheme = {}));
 
-var SmartLinkWidth;
+var SmartLinkWidth; // When adding an element...
+// 1) Create base element if it doesn't already existed.
+//    Base element are inside src/view/FlexibleCard/components/elements.
+//    E.g. Badge,DateTime, Icon, Lozenge, etc.
+// 2) Update FlexibleUiContext with the new prop for data representing
+//    the element, preferably with the same name as the element itself.
+//    (src/state/flexible-ui-context/types.ts)
+// 3) Update Flexible UI extractor (src/extractors/flexible/index.ts)
+// 4) Set base element and data mapping.
+//    (src/view/FlexibleCard/components/elements/utils.tsx)
+// 5) Create element. (src/view/FlexibleCard/components/elements/index.ts)
+// 6) Update element ElementDisplaySchema for inline/block display
+//    (src/view/FlexibleCard/components/blocks/utils.tsx)
+
 exports.SmartLinkWidth = SmartLinkWidth;
 
 (function (SmartLinkWidth) {
@@ -82,9 +95,11 @@ exports.ElementName = ElementName;
   ElementName["ModifiedOn"] = "ModifiedOn";
   ElementName["Priority"] = "Priority";
   ElementName["ProgrammingLanguage"] = "ProgrammingLanguage";
+  ElementName["Snippet"] = "Snippet";
   ElementName["State"] = "State";
   ElementName["SubscriberCount"] = "SubscriberCount";
   ElementName["Title"] = "Title";
+  ElementName["Provider"] = "Provider";
 })(ElementName || (exports.ElementName = ElementName = {}));
 
 var ActionName;

package/dist/cjs/extractors/flexible/icon/extract-document-type-icon.js

@@ -10,25 +10,46 @@ var _constants = require("../../../constants");
 var extractDocumentTypeIcon = function extractDocumentTypeIcon(documentType, label) {
   switch (documentType) {
     case 'schema:BlogPosting':
-      return [_constants.IconType.Blog, label || 'Blog'];
+      return {
+        icon: _constants.IconType.Blog,
+        label: label || 'Blog'
+      };
 
     case 'schema:DigitalDocument':
-      return [_constants.IconType.File, label || 'File'];
+      return {
+        icon: _constants.IconType.File,
+        label: label || 'File'
+      };
 
     case 'schema:TextDigitalDocument':
-      return [_constants.IconType.Document, label || 'Document'];
+      return {
+        icon: _constants.IconType.Document,
+        label: label || 'Document'
+      };
 
     case 'schema:PresentationDigitalDocument':
-      return [_constants.IconType.Presentation, label || 'Presentation'];
+      return {
+        icon: _constants.IconType.Presentation,
+        label: label || 'Presentation'
+      };
 
     case 'schema:SpreadsheetDigitalDocument':
-      return [_constants.IconType.Spreadsheet, label || 'Spreadsheet'];
+      return {
+        icon: _constants.IconType.Spreadsheet,
+        label: label || 'Spreadsheet'
+      };
 
     case 'atlassian:Template':
-      return [_constants.IconType.Template, label || 'Template'];
+      return {
+        icon: _constants.IconType.Template,
+        label: label || 'Template'
+      };
 
     case 'atlassian:UndefinedLink':
-      return [_constants.IconType.Document, label || 'Undefined link'];
+      return {
+        icon: _constants.IconType.Document,
+        label: label || 'Undefined link'
+      };
 
     default:
       return undefined;

package/dist/cjs/extractors/flexible/icon/extract-file-formatIcon.js

@@ -11,66 +11,111 @@ var extractFileFormatIcon = function extractFileFormatIcon(fileFormat) {
   switch (fileFormat) {
     // Generic documents
     case 'folder':
-      return [_constants.IconType.Folder, 'Folder'];
+      return {
+        icon: _constants.IconType.Folder,
+        label: 'Folder'
+      };
 
     case 'text/plain':
     case 'application/vnd.oasis.opendocument.text':
     case 'application/vnd.apple.pages':
-      return [_constants.IconType.Document, 'Document'];
+      return {
+        icon: _constants.IconType.Document,
+        label: 'Document'
+      };
 
     case 'application/pdf':
-      return [_constants.IconType.PDF, 'PDF document'];
+      return {
+        icon: _constants.IconType.PDF,
+        label: 'PDF document'
+      };
 
     case 'application/vnd.oasis.opendocument.presentation':
     case 'application/vnd.apple.keynote':
-      return [_constants.IconType.Presentation, 'Presentation'];
+      return {
+        icon: _constants.IconType.Presentation,
+        label: 'Presentation'
+      };
 
     case 'application/vnd.oasis.opendocument.spreadsheet':
     case 'application/vnd.apple.numbers':
-      return [_constants.IconType.Spreadsheet, 'Spreadsheet'];
+      return {
+        icon: _constants.IconType.Spreadsheet,
+        label: 'Spreadsheet'
+      };
     // Google Drive
 
     case 'application/vnd.google-apps.document':
-      return [_constants.IconType.GoogleDocs, 'Google Docs'];
+      return {
+        icon: _constants.IconType.GoogleDocs,
+        label: 'Google Docs'
+      };
 
     case 'application/vnd.google-apps.form':
-      return [_constants.IconType.GoogleForms, 'Google Form'];
+      return {
+        icon: _constants.IconType.GoogleForms,
+        label: 'Google Form'
+      };
 
     case 'application/vnd.google-apps.spreadsheet':
-      return [_constants.IconType.GoogleSheets, 'Google Sheets'];
+      return {
+        icon: _constants.IconType.GoogleSheets,
+        label: 'Google Sheets'
+      };
 
     case 'application/vnd.google-apps.presentation':
-      return [_constants.IconType.GoogleSlides, 'Google Slides'];
+      return {
+        icon: _constants.IconType.GoogleSlides,
+        label: 'Google Slides'
+      };
     // Microsoft
 
     case 'application/vnd.ms-excel':
     case 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet':
-      return [_constants.IconType.MSExcel, 'Excel spreadsheet'];
+      return {
+        icon: _constants.IconType.MSExcel,
+        label: 'Excel spreadsheet'
+      };
 
     case 'application/vnd.ms-powerpoint':
     case 'application/vnd.openxmlformats-officedocument.presentationml.presentation':
-      return [_constants.IconType.MSPowerpoint, 'PowerPoint presentation'];
+      return {
+        icon: _constants.IconType.MSPowerpoint,
+        label: 'PowerPoint presentation'
+      };
 
     case 'application/msword':
     case 'application/vnd.openxmlformats-officedocument.wordprocessingml.document':
-      return [_constants.IconType.MSWord, 'Word document'];
+      return {
+        icon: _constants.IconType.MSWord,
+        label: 'Word document'
+      };
 
     case 'image/png':
     case 'image/jpeg':
     case 'image/bmp':
     case 'image/webp':
     case 'image/svg+xml':
-      return [_constants.IconType.Image, 'Image'];
+      return {
+        icon: _constants.IconType.Image,
+        label: 'Image'
+      };
 
     case 'image/gif':
-      return [_constants.IconType.GIF, 'GIF'];
+      return {
+        icon: _constants.IconType.GIF,
+        label: 'GIF'
+      };
 
     case 'audio/midi':
     case 'audio/mpeg':
     case 'audio/webm':
     case 'audio/ogg':
     case 'audio/wav':
-      return [_constants.IconType.Audio, 'Audio'];
+      return {
+        icon: _constants.IconType.Audio,
+        label: 'Audio'
+      };
 
     case 'video/mp4':
     case 'video/quicktime':
@@ -79,13 +124,19 @@ var extractFileFormatIcon = function extractFileFormatIcon(fileFormat) {
     case 'video/ogg':
     case 'video/x-ms-wmv':
     case 'video/x-msvideo':
-      return [_constants.IconType.Video, 'Video'];
+      return {
+        icon: _constants.IconType.Video,
+        label: 'Video'
+      };
     // Others
 
     case 'text/css':
     case 'text/html':
     case 'application/javascript':
-      return [_constants.IconType.Code, 'Source Code'];
+      return {
+        icon: _constants.IconType.Code,
+        label: 'Source Code'
+      };
 
     case 'application/zip':
     case 'application/x-tar':
@@ -93,19 +144,34 @@ var extractFileFormatIcon = function extractFileFormatIcon(fileFormat) {
     case 'application/x-7z-compressed':
     case 'application/x-apple-diskimage':
     case 'application/vnd.rar':
-      return [_constants.IconType.Archive, 'Archive'];
+      return {
+        icon: _constants.IconType.Archive,
+        label: 'Archive'
+      };
 
     case 'application/dmg':
-      return [_constants.IconType.Executable, 'Executable'];
+      return {
+        icon: _constants.IconType.Executable,
+        label: 'Executable'
+      };
 
     case 'application/sketch':
-      return [_constants.IconType.Sketch, 'Sketch'];
+      return {
+        icon: _constants.IconType.Sketch,
+        label: 'Sketch'
+      };
 
     case 'application/octet-stream':
-      return [_constants.IconType.Generic, 'Binary file'];
+      return {
+        icon: _constants.IconType.Generic,
+        label: 'Binary file'
+      };
 
     case 'application/invision.prototype':
-      return [_constants.IconType.Generic, 'Prototype'];
+      return {
+        icon: _constants.IconType.Generic,
+        label: 'Prototype'
+      };
 
     default:
       return undefined;

package/dist/cjs/extractors/flexible/icon/extract-jira-task-icon.js

@@ -12,32 +12,59 @@ var extractJiraTaskIcon = function extractJiraTaskIcon(taskType) {
 
   switch (taskType) {
     case 'JiraBug':
-      return [_constants.IconType.Bug, label];
+      return {
+        icon: _constants.IconType.Bug,
+        label: label
+      };
 
     case 'JiraChange':
-      return [_constants.IconType.Change, label];
+      return {
+        icon: _constants.IconType.Change,
+        label: label
+      };
 
     case 'JiraEpic':
-      return [_constants.IconType.Epic, label];
+      return {
+        icon: _constants.IconType.Epic,
+        label: label
+      };
 
     case 'JiraIncident':
-      return [_constants.IconType.Incident, label];
+      return {
+        icon: _constants.IconType.Incident,
+        label: label
+      };
 
     case 'JiraProblem':
-      return [_constants.IconType.Problem, label];
+      return {
+        icon: _constants.IconType.Problem,
+        label: label
+      };
 
     case 'JiraServiceRequest':
-      return [_constants.IconType.ServiceRequest, label];
+      return {
+        icon: _constants.IconType.ServiceRequest,
+        label: label
+      };
 
     case 'JiraStory':
-      return [_constants.IconType.Story, label];
+      return {
+        icon: _constants.IconType.Story,
+        label: label
+      };
 
     case 'JiraSubTask':
-      return [_constants.IconType.SubTask, label];
+      return {
+        icon: _constants.IconType.SubTask,
+        label: label
+      };
 
     case 'JiraTask':
     default:
-      return [_constants.IconType.Task, label];
+      return {
+        icon: _constants.IconType.Task,
+        label: label
+      };
   }
 };
 

package/dist/cjs/extractors/flexible/icon/extract-jsonld-data-icon.js

@@ -33,7 +33,10 @@ var extractTask = function extractTask(data, label) {
       url = _ref.icon;
 
   var taskType = id === null || id === void 0 ? void 0 : id.split('#').pop();
-  var taskIcon = url ? [undefined, label, url] : undefined;
+  var taskIcon = url ? {
+    label: label,
+    url: url
+  } : undefined;
   return {
     taskType: taskType,
     taskIcon: taskIcon
@@ -65,7 +68,7 @@ var extractJsonldDataIcon = function extractJsonldDataIcon(data) {
   var type = extractType(data);
   var urlIcon = (0, _extractUrlIcon.default)(data.icon, label);
   var provider = generator === null || generator === void 0 ? void 0 : generator['@id'];
-  var providerIcon = (0, _extractProviderIcon.default)(provider, generator === null || generator === void 0 ? void 0 : generator.icon, label);
+  var providerIcon = (0, _extractProviderIcon.default)(data);
 
   switch (type) {
     case 'Document':
@@ -94,25 +97,46 @@ var extractJsonldDataIcon = function extractJsonldDataIcon(data) {
             taskType = _extractTask.taskType,
             taskIcon = _extractTask.taskIcon;
 
-        return taskType === 'JiraCustomTaskType' ? taskIcon || urlIcon || providerIcon || [_constants2.IconType.Task, taskLabel] : (0, _extractJiraTaskIcon.default)(taskType, taskLabel);
+        return taskType === 'JiraCustomTaskType' ? taskIcon || urlIcon || providerIcon || {
+          icon: _constants2.IconType.Task,
+          label: taskLabel
+        } : (0, _extractJiraTaskIcon.default)(taskType, taskLabel);
       }
 
-      return [_constants2.IconType.Task, taskLabel];
+      return {
+        icon: _constants2.IconType.Task,
+        label: taskLabel
+      };
 
     case 'atlassian:Project':
-      return urlIcon || [_constants2.IconType.Project, label || 'Project'];
+      return urlIcon || {
+        icon: _constants2.IconType.Project,
+        label: label || 'Project'
+      };
 
     case 'atlassian:SourceCodeCommit':
-      return [_constants2.IconType.Commit, label || 'Commit'];
+      return {
+        icon: _constants2.IconType.Commit,
+        label: label || 'Commit'
+      };
 
     case 'atlassian:SourceCodePullRequest':
-      return [_constants2.IconType.PullRequest, label || 'Pull request'];
+      return {
+        icon: _constants2.IconType.PullRequest,
+        label: label || 'Pull request'
+      };
 
     case 'atlassian:SourceCodeReference':
-      return [_constants2.IconType.Branch, label || 'Reference'];
+      return {
+        icon: _constants2.IconType.Branch,
+        label: label || 'Reference'
+      };
 
     case 'atlassian:SourceCodeRepository':
-      return [_constants2.IconType.Repo, label || 'Repository'];
+      return {
+        icon: _constants2.IconType.Repo,
+        label: label || 'Repository'
+      };
 
     default:
       return providerIcon;

package/dist/cjs/extractors/flexible/icon/extract-provider-icon.js

@@ -13,13 +13,30 @@ var _constants2 = require("../../../constants");
 
 var _extractUrlIcon = _interopRequireDefault(require("./extract-url-icon"));
 
-var extractProviderIcon = function extractProviderIcon(provider, icon, label) {
+var _primitives = require("../../common/primitives");
+
+var extractProviderIcon = function extractProviderIcon(data) {
+  if (!data) {
+    return undefined;
+  }
+
+  var generator = data.generator;
+  var provider = generator === null || generator === void 0 ? void 0 : generator['@id'];
+  var icon = generator === null || generator === void 0 ? void 0 : generator.icon;
+  var label = (generator === null || generator === void 0 ? void 0 : generator.name) || (0, _primitives.extractTitle)(data);
+
   if (provider === _constants.CONFLUENCE_GENERATOR_ID) {
-    return [_constants2.IconType.Confluence, label || 'Confluence'];
+    return {
+      icon: _constants2.IconType.Confluence,
+      label: label || 'Confluence'
+    };
   }
 
   if (provider === _constants.JIRA_GENERATOR_ID) {
-    return [_constants2.IconType.Jira, label || 'Jira'];
+    return {
+      icon: _constants2.IconType.Jira,
+      label: label || 'Jira'
+    };
   }
 
   return (0, _extractUrlIcon.default)(icon, label);

package/dist/cjs/extractors/flexible/icon/extract-url-icon.js

@@ -9,7 +9,10 @@ var _utils = require("../../common/utils");
 
 var extractUrlIcon = function extractUrlIcon(icon, label) {
   var url = icon && (0, _utils.extractUrlFromIconJsonLd)(icon);
-  return url ? [undefined, label, url] : undefined;
+  return url ? {
+    label: label,
+    url: url
+  } : undefined;
 };
 
 var _default = extractUrlIcon;

package/dist/cjs/extractors/flexible/icon/index.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.extractLinkIcon = exports.extractErrorIcon = void 0;
 
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _extractJsonldDataIcon = _interopRequireDefault(require("./extract-jsonld-data-icon"));
 
@@ -17,22 +17,16 @@ var _constants = require("../../../constants");
 
 var _extractIconRenderer = _interopRequireDefault(require("./extract-icon-renderer"));
 
-var extractLinkIcon = function extractLinkIcon(response, renderers) {
-  var data = response.data;
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
-  var _ref = (0, _extractJsonldDataIcon.default)(data) || [],
-      _ref2 = (0, _slicedToArray2.default)(_ref, 3),
-      icon = _ref2[0],
-      label = _ref2[1],
-      url = _ref2[2];
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
+var extractLinkIcon = function extractLinkIcon(response, renderers) {
+  var data = response.data;
   var render = (0, _extractIconRenderer.default)(data, renderers);
-  return {
-    icon: icon,
-    label: label,
-    render: render,
-    url: url
-  };
+  return _objectSpread(_objectSpread({}, (0, _extractJsonldDataIcon.default)(data)), {}, {
+    render: render
+  });
 };
 
 exports.extractLinkIcon = extractLinkIcon;
@@ -41,13 +35,10 @@ var extractErrorIcon = function extractErrorIcon(response, status) {
   // Try to get provider icon first.
   if (response) {
     var data = response.data;
-    var generator = data.generator;
-    var provider = generator === null || generator === void 0 ? void 0 : generator['@id'];
 
-    var _ref3 = (0, _extractProviderIcon.default)(provider, generator === null || generator === void 0 ? void 0 : generator.icon) || [],
-        _ref4 = (0, _slicedToArray2.default)(_ref3, 3),
-        icon = _ref4[0],
-        url = _ref4[2];
+    var _ref = (0, _extractProviderIcon.default)(data) || {},
+        icon = _ref.icon,
+        url = _ref.url;
 
     if (icon || url) {
       return {

package/dist/cjs/extractors/flexible/index.js

@@ -25,6 +25,8 @@ var _extractDateCreated = require("../common/date/extractDateCreated");
 
 var _extractPriority = _interopRequireDefault(require("./extract-priority"));
 
+var _extractProviderIcon = _interopRequireDefault(require("./icon/extract-provider-icon"));
+
 var extractFlexibleUiContext = function extractFlexibleUiContext(response, renderers) {
   if (!response) {
     return undefined;
@@ -43,9 +45,12 @@ var extractFlexibleUiContext = function extractFlexibleUiContext(response, rende
     modifiedOn: (0, _extractDateUpdated.extractDateUpdated)(data),
     priority: (0, _extractPriority.default)(data),
     programmingLanguage: (0, _utils.extractProgrammingLanguage)(data),
+    snippet: (0, _primitives.extractSummary)(data) || undefined,
+    // Explicitly set here to remove an empty string
     state: (0, _lozenge.extractLozenge)(data),
     subscriberCount: (0, _utils.extractSubscriberCount)(data),
     title: (0, _primitives.extractTitle)(data) || url,
+    provider: (0, _extractProviderIcon.default)(data),
     url: url
   };
 };

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "17.2.1",
+	"version": "17.4.0",
 	"sideEffects": false
 }

package/dist/cjs/view/FlexibleCard/components/blocks/metadata-block/index.js

@@ -37,18 +37,32 @@ var getElementGroupStyles = function getElementGroupStyles(size, maxLines) {
   // MetadataBlock allows metadata elements to be displayed in
   // multiple lines, with maximum of 2 lines.
   // a) We need the height of the line to be equal on both left and right
-  //    sides so they line up nicely. 1.75 is the The maximum height of
-  //    all elements in specific size. This height belongs to AvatarGroup.
+  //    sides so they line up nicely.
   // b) There is no way to truncate non-text elements nicely. Here
   //    it's fix max height of the element group so that anything that is
   //    overflown will not be visible.
-  var lineHeight = 1.75;
+  var lineHeight = getLineHeight(size);
   var gap = (0, _utils.getGapSize)(size);
   var gapHeight = gap * (maxLines - 1);
   var height = lineHeight * maxLines + gapHeight;
   return (0, _core.css)(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n    flex-wrap: wrap;\n    line-height: ", "rem;\n    max-height: ", "rem;\n    > span,\n    > div {\n      min-height: ", "rem;\n      max-height: ", "rem;\n      line-height: ", "rem;\n    }\n  "])), lineHeight, height, lineHeight, lineHeight, lineHeight);
 };
 
+var getLineHeight = function getLineHeight(size) {
+  // The maximum height of all elements in specific size.
+  // These heights belongs to AvatarGroup.
+  switch (size) {
+    case _constants.SmartLinkSize.XLarge:
+    case _constants.SmartLinkSize.Large:
+      return 1.75;
+
+    case _constants.SmartLinkSize.Medium:
+    case _constants.SmartLinkSize.Small:
+    default:
+      return 1.5;
+  }
+};
+
 var getMaxLines = function getMaxLines(maxLines) {
   if (maxLines > MAXIMUM_MAX_LINES) {
     return DEFAULT_MAX_LINES;