@atlaskit/smart-card 19.1.29 → 19.2.0

package/dist/types/extractors/flexible/collaboratorGroup/index.d.ts

@@ -1,4 +1,4 @@
 import { JsonLd } from 'json-ld-types';
-import { LinkPerson } from '../../common/person/types';
+import { LinkPerson } from '@atlaskit/linking-common/extractors';
 export declare type LinkTypeUpdatedBy = JsonLd.Data.Document | JsonLd.Data.Project | JsonLd.Data.SourceCodePullRequest | JsonLd.Data.SourceCodeReference | JsonLd.Data.SourceCodeRepository | JsonLd.Data.Task;
 export declare const extractPersonsUpdatedBy: (jsonLd: LinkTypeUpdatedBy) => LinkPerson[] | undefined;

package/dist/types/extractors/flexible/utils.d.ts

@@ -1,9 +1,12 @@
 import { JsonLd } from 'json-ld-types';
 export declare const extractCommentCount: (data: JsonLd.Data.BaseData) => number | undefined;
+export declare const extractDueOn: (data: JsonLd.Data.BaseData) => string | undefined;
 export declare const extractViewCount: (data: JsonLd.Data.BaseData) => number | undefined;
 export declare const extractReactCount: (data: JsonLd.Data.BaseData) => number | undefined;
 export declare const extractVoteCount: (data: JsonLd.Data.BaseData) => number | undefined;
 export declare const extractCreatedBy: (data: JsonLd.Data.BaseData) => string | undefined;
 export declare const extractModifiedBy: (data: JsonLd.Data.BaseData) => string | undefined;
 export declare const extractProgrammingLanguage: (data: JsonLd.Data.BaseData) => string | undefined;
+export declare const extractSourceBranch: (data: JsonLd.Data.SourceCodePullRequest) => string | undefined;
 export declare const extractSubscriberCount: (data: JsonLd.Data.BaseData) => number | undefined;
+export declare const extractTargetBranch: (data: JsonLd.Data.SourceCodePullRequest) => string | undefined;

package/dist/types/state/flexible-ui-context/types.d.ts

@@ -1,5 +1,5 @@
 import { LinkLozenge } from '../../extractors/common/lozenge/types';
-import { LinkPerson } from '../../extractors/common/person/types';
+import { LinkPerson } from '@atlaskit/linking-common/extractors';
 import { IconType, MediaType } from '../../constants';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
@@ -22,6 +22,13 @@ export declare type FlexibleUiDataContext = {
      * @see CommentCount
      */
     commentCount?: number;
+    /**
+     * Contains the ISO timestamp of when the resource was due.
+     * This value is mapped to JsonLD endTime.
+     * @type string - ISO Timestamp
+     * @see DueOn
+     */
+    dueOn?: string;
     /**
      * Contains the number of views of the linked resource.
      * @type number
@@ -52,6 +59,10 @@ export declare type FlexibleUiDataContext = {
      * @see CreatedOn
      */
     createdOn?: string;
+    /**
+     * Contains the information about the latest commit in the repository
+     */
+    latestCommit?: string;
     /**
      * Contains the favicon of the resource.
      * @type Icon
@@ -88,12 +99,24 @@ export declare type FlexibleUiDataContext = {
      * @see ProgrammingLanguage
      */
     programmingLanguage?: string;
+    /**
+     * Contains the provider icon of the linked resource.
+     * @type Icon
+     * @see Provider
+     */
+    provider?: Icon;
     /**
      * Contains the snippet of the resource.
      * @type string
      * @see Snippet
      */
     snippet?: string;
+    /**
+     * Contains the source branch name of the link typed pull request.
+     * @type string
+     * @see SourceBranch
+     */
+    sourceBranch?: string;
     /**
      * Contains the number of subscribers of the linked resource.
      * @type number
@@ -106,6 +129,12 @@ export declare type FlexibleUiDataContext = {
      * @see SubscriberCount
      */
     state?: LinkLozenge;
+    /**
+     * Contains the target branch name of the link typed pull request.
+     * @type string
+     * @see TargetBranch
+     */
+    targetBranch?: string;
     /**
      * Contains the Title of the linked resource.
      * @type string
@@ -118,16 +147,6 @@ export declare type FlexibleUiDataContext = {
      * @see Title
      */
     url?: string;
-    /**
-     * Contains the provider icon of the linked resource.
-     * @type Icon
-     * @see Provider
-     */
-    provider?: Icon;
-    /**
-     * Contains the information about the latest commit in the repository
-     */
-    latestCommit?: string;
 };
 export declare type Icon = {
     icon?: IconType;

package/dist/types/view/FlexibleCard/components/blocks/types.d.ts

@@ -103,7 +103,7 @@ export declare type ActionItem = NamedActionItem | CustomActionItem;
 /**
  * A type that contains all the possible combinations of elements with their corresponding props.
  */
-export declare type ElementItemProps = AuthorGroup | CollaboratorGroup | CommentCount | CreatedBy | CreatedOn | LatestCommit | LinkIcon | ModifiedBy | ModifiedOn | Preview | Priority | ProgrammingLanguage | Provider | ReactCount | Snippet | State | SubscriberCount | Title | ViewCount | VoteCount;
+export declare type ElementItemProps = AuthorGroup | CollaboratorGroup | CommentCount | CreatedBy | CreatedOn | DueOn | LatestCommit | LinkIcon | ModifiedBy | ModifiedOn | Preview | Priority | ProgrammingLanguage | Provider | ReactCount | Snippet | SourceBranch | State | SubscriberCount | TargetBranch | Title | ViewCount | VoteCount;
 /**
  * Represents the props available for an AuthorGroup element.
  * @see AuthorGroup
@@ -143,6 +143,13 @@ export declare type CreatedOn = {
      */
     text?: string;
 };
+/**
+ * Represents the props available for an DueOn element.
+ * @see CreatedOn
+ */
+export declare type DueOn = {
+    name: ElementName.DueOn;
+};
 /**
  * Represents the props available for an LastCommit element.
  * @see BadgeProps
@@ -217,6 +224,13 @@ export declare type ReactCount = {
 export declare type Snippet = {
     name: ElementName.Snippet;
 };
+/**
+ * Represents the props available for an SourceBranch element.
+ * @see SourceBranch
+ */
+export declare type SourceBranch = {
+    name: ElementName.SourceBranch;
+};
 /**
  * Represents the props available for an State element.
  * @see State
@@ -231,6 +245,13 @@ export declare type State = {
 export declare type SubscriberCount = {
     name: ElementName.SubscriberCount;
 };
+/**
+ * Represents the props available for an TargetBranch element.
+ * @see TargetBranch
+ */
+export declare type TargetBranch = {
+    name: ElementName.TargetBranch;
+};
 /**
  * Represents the props available for an Title element.
  * @see Title

package/dist/types/view/FlexibleCard/components/elements/index.d.ts

@@ -32,6 +32,11 @@ export declare const CreatedOn: import("react").FC<DateTimeProps>;
  * @see Text
  */
 export declare const CreatedBy: import("react").FC<TextProps>;
+/**
+ * Creates a DueOn Lozenge element using the data from dueOn in the Flexible UI Context.
+ * @see Lozenge
+ */
+export declare const DueOn: import("react").FC<LozengeProps>;
 /**
  * Creates an element that contains Last Commit hash
  */
@@ -81,6 +86,11 @@ export declare const ReactCount: import("react").FC<BadgeProps>;
  * @see Text
  */
 export declare const Snippet: import("react").FC<TextProps>;
+/**
+ * Creates a SourceBranch Text element using the data from sourceBranch in the Flexible UI Context.
+ * @see Text
+ */
+export declare const SourceBranch: import("react").FC<TextProps>;
 /**
  * Creates a State Lozenge element using the data from State in the Flexible UI Context.
  * @see Lozenge
@@ -91,6 +101,11 @@ export declare const State: import("react").FC<LozengeProps>;
  * @see Badge
  */
 export declare const SubscriberCount: import("react").FC<BadgeProps>;
+/**
+ * Creates a TargetBranch Text element using the data from targetBranch in the Flexible UI Context.
+ * @see Text
+ */
+export declare const TargetBranch: import("react").FC<TextProps>;
 /**
  * Creates a Title Link element using the data from Title in the Flexible UI Context.
  * This represents the main link text within the Smart Link.

package/dist/types/view/FlexibleCard/components/elements/lozenge/types.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 import { ElementProps } from '../types';
 export declare type LozengeAppearance = 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'success';
 export declare type LozengeProps = ElementProps & {
@@ -8,5 +9,5 @@ export declare type LozengeProps = ElementProps & {
     /**
      * The text to display within the lozenge.
      */
-    text?: string;
+    text?: string | React.ReactNode;
 };

package/dist/types/view/FlexibleCard/components/elements/types.d.ts

@@ -1,6 +1,12 @@
 import { SerializedStyles } from '@emotion/core';
-import { SmartLinkSize } from '../../../../constants';
+import { ElementName, SmartLinkSize } from '../../../../constants';
 export declare type ElementProps = {
+    /**
+     * Name of the element, can be used as a selector.
+     * E.g. [data-smart-element="Provider"]
+     * @internal
+     */
+    name?: ElementName;
     /**
      * Any additional CSS properties to apply to the element.
      */

package/dist/types/view/HoverCard/types.d.ts

@@ -13,6 +13,7 @@ export declare type PreviewInvokeMethod = 'keyboard' | 'mouse_hover' | 'mouse_cl
 export interface MetadataOptions {
     primary: Array<ElementItem>;
     secondary: Array<ElementItem>;
+    subtitle: Array<ElementItem>;
 }
 export declare type HoverCardContentProps = {
     analytics: AnalyticsFacade;

package/dist/types/view/HoverCard/utils.d.ts

@@ -1,3 +1,3 @@
 import { JsonLd } from 'json-ld-types';
 export declare const HOVER_CARD_ANALYTICS_DISPLAY = "flexible";
-export declare const getSimulatedMetadata: (extensionKey?: string) => JsonLd.Primitives.Property<any>;
+export declare const getSimulatedMetadata: (extensionKey?: string, types?: JsonLd.Primitives.ObjectType[]) => JsonLd.Primitives.Property<any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "19.1.29",
+  "version": "19.2.0",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -33,7 +33,7 @@
     "@atlaskit/icon-object": "^6.2.0",
     "@atlaskit/icon-priority": "^6.3.0",
     "@atlaskit/in-product-testing": "^0.1.0",
-    "@atlaskit/linking-common": "^1.1.0",
+    "@atlaskit/linking-common": "^1.2.0",
     "@atlaskit/logo": "^13.7.0",
     "@atlaskit/lozenge": "^11.1.0",
     "@atlaskit/media-common": "^2.15.0",
@@ -58,7 +58,7 @@
     "uuid": "^3.1.0"
   },
   "peerDependencies": {
-    "@atlaskit/link-provider": "^1.0.4",
+    "@atlaskit/link-provider": "^1.0.8",
     "react": "^16.8.0",
     "react-dom": "^16.8.0",
     "react-intl-next": "npm:react-intl@^5.18.1"

package/report.api.md

@@ -247,6 +247,8 @@ export enum ElementName {
   // (undocumented)
   CreatedOn = 'CreatedOn',
   // (undocumented)
+  DueOn = 'DueOn',
+  // (undocumented)
   LatestCommit = 'LatestCommit',
   // (undocumented)
   LinkIcon = 'LinkIcon',
@@ -267,10 +269,14 @@ export enum ElementName {
   // (undocumented)
   Snippet = 'Snippet',
   // (undocumented)
+  SourceBranch = 'SourceBranch',
+  // (undocumented)
   State = 'State',
   // (undocumented)
   SubscriberCount = 'SubscriberCount',
   // (undocumented)
+  TargetBranch = 'TargetBranch',
+  // (undocumented)
   Title = 'Title',
   // (undocumented)
   ViewCount = 'ViewCount',

package/dist/cjs/extractors/common/context/extractContext.js

@@ -1,38 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractContext = void 0;
-
-var _utils = require("../utils");
-
-var _extractType = require("../primitives/extractType");
-
-var extractContext = function extractContext(jsonLd) {
-  var context = jsonLd.context;
-
-  if (context) {
-    if (typeof context === 'string') {
-      return {
-        name: context
-      };
-    } else if (context['@type'] === 'Link') {
-      if (context.name) {
-        return {
-          name: context.name
-        };
-      }
-    } else {
-      if (context.name) {
-        return {
-          name: context.name,
-          icon: context.icon && (0, _utils.extractUrlFromIconJsonLd)(context.icon),
-          type: (0, _extractType.extractType)(context)
-        };
-      }
-    }
-  }
-};
-
-exports.extractContext = extractContext;

package/dist/cjs/extractors/common/context/extractProvider.js

@@ -1,83 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractProvider = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _colors = require("@atlaskit/theme/colors");
-
-var _tokens = require("@atlaskit/tokens");
-
-var _confluenceIcon = require("@atlaskit/logo/confluence-icon");
-
-var _jiraIcon = require("@atlaskit/logo/jira-icon");
-
-var _utils = require("../utils");
-
-var _constants = require("../../constants");
-
-var extractProvider = function extractProvider(jsonLd) {
-  var generator = jsonLd.generator;
-
-  if (generator) {
-    if (typeof generator === 'string') {
-      throw Error('Link.generator requires a name and icon.');
-    } else if (generator['@type'] === 'Link') {
-      if (generator.name) {
-        return {
-          text: generator.name
-        };
-      }
-    } else {
-      if (generator.name) {
-        var id = generator['@id'];
-        return {
-          text: generator.name,
-          icon: extractProviderIcon(generator.icon, id),
-          id: id
-        };
-      }
-    }
-  }
-};
-
-exports.extractProvider = extractProvider;
-
-var extractProviderIcon = function extractProviderIcon(icon, id) {
-  if (id) {
-    if (id === _constants.CONFLUENCE_GENERATOR_ID) {
-      return /*#__PURE__*/_react.default.createElement(_confluenceIcon.ConfluenceIcon, {
-        textColor: (0, _tokens.token)('color.text.subtle', _colors.N700)
-        /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
-        ,
-        iconColor: _colors.B200,
-        iconGradientStart: _colors.B400,
-        iconGradientStop: _colors.B200
-        /* eslint-enable @atlaskit/design-system/ensure-design-token-usage */
-        ,
-        size: "xsmall"
-      });
-    } else if (id === _constants.JIRA_GENERATOR_ID) {
-      return /*#__PURE__*/_react.default.createElement(_jiraIcon.JiraIcon, {
-        textColor: (0, _tokens.token)('color.text.subtle', _colors.N700)
-        /* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
-        ,
-        iconColor: _colors.B200,
-        iconGradientStart: _colors.B400,
-        iconGradientStop: _colors.B200
-        /* eslint-enable @atlaskit/design-system/ensure-design-token-usage */
-        ,
-        size: "xsmall"
-      });
-    }
-  }
-
-  if (icon) {
-    return (0, _utils.extractUrlFromIconJsonLd)(icon);
-  }
-};

package/dist/cjs/extractors/common/date/extractDateCreated.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractDateCreated = void 0;
-
-var extractDateCreated = function extractDateCreated(jsonLd) {
-  if (jsonLd['schema:dateCreated']) {
-    return jsonLd['schema:dateCreated'];
-  }
-};
-
-exports.extractDateCreated = extractDateCreated;

package/dist/cjs/extractors/common/date/extractDateUpdated.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractDateUpdated = void 0;
-
-var extractDateUpdated = function extractDateUpdated(jsonLd) {
-  if (jsonLd.updated) {
-    return jsonLd.updated;
-  }
-};
-
-exports.extractDateUpdated = extractDateUpdated;

package/dist/cjs/extractors/common/person/extractMembers.js

@@ -1,37 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractMembers = void 0;
-
-var _utils = require("../utils");
-
-var extractMembers = function extractMembers(jsonLd) {
-  var members = jsonLd['atlassian:member'];
-
-  if (members) {
-    if (typeof members === 'string') {
-      throw Error('Link[atlassian:members] must be an array or object.');
-    } else if (members.hasOwnProperty('totalItems')) {
-      var collection = members;
-
-      if (collection.items) {
-        return collection.items.map(function (member) {
-          return (0, _utils.extractPersonFromJsonLd)(member);
-        }).filter(function (member) {
-          return !!member;
-        });
-      }
-    } else {
-      var memberItem = members;
-      var memberItemForLink = (0, _utils.extractPersonFromJsonLd)(memberItem);
-
-      if (memberItemForLink) {
-        return [memberItemForLink];
-      }
-    }
-  }
-};
-
-exports.extractMembers = extractMembers;

package/dist/cjs/extractors/common/person/extractPersonAssignedTo.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractPersonAssignedTo = void 0;
-
-var _utils = require("../utils");
-
-var extractPersonAssignedTo = function extractPersonAssignedTo(jsonLd) {
-  var assignedTo = jsonLd['atlassian:assignedTo'];
-
-  if (assignedTo) {
-    return (0, _utils.extractPersonFromJsonLd)(assignedTo);
-  }
-};
-
-exports.extractPersonAssignedTo = extractPersonAssignedTo;

package/dist/cjs/extractors/common/person/extractPersonCreatedBy.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractPersonCreatedBy = void 0;
-
-var _utils = require("../utils");
-
-var extractPersonCreatedBy = function extractPersonCreatedBy(jsonLd) {
-  var attributedTo = jsonLd.attributedTo;
-
-  if (attributedTo) {
-    if (Array.isArray(attributedTo)) {
-      return attributedTo.map(_utils.extractPersonFromJsonLd).filter(function (item) {
-        return !!item;
-      });
-    } else {
-      var item = (0, _utils.extractPersonFromJsonLd)(attributedTo);
-
-      if (item) {
-        return [item];
-      }
-    }
-  }
-};
-
-exports.extractPersonCreatedBy = extractPersonCreatedBy;

package/dist/cjs/extractors/common/person/extractPersonUpdatedBy.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractPersonUpdatedBy = void 0;
-
-var _utils = require("../utils");
-
-var extractPersonUpdatedBy = function extractPersonUpdatedBy(jsonLd) {
-  var updatedBy = jsonLd['atlassian:updatedBy'];
-
-  if (updatedBy) {
-    return (0, _utils.extractPersonFromJsonLd)(updatedBy);
-  }
-};
-
-exports.extractPersonUpdatedBy = extractPersonUpdatedBy;

package/dist/cjs/extractors/common/person/index.js

@@ -1,37 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "extractMembers", {
-  enumerable: true,
-  get: function get() {
-    return _extractMembers.extractMembers;
-  }
-});
-Object.defineProperty(exports, "extractPersonAssignedTo", {
-  enumerable: true,
-  get: function get() {
-    return _extractPersonAssignedTo.extractPersonAssignedTo;
-  }
-});
-Object.defineProperty(exports, "extractPersonCreatedBy", {
-  enumerable: true,
-  get: function get() {
-    return _extractPersonCreatedBy.extractPersonCreatedBy;
-  }
-});
-Object.defineProperty(exports, "extractPersonUpdatedBy", {
-  enumerable: true,
-  get: function get() {
-    return _extractPersonUpdatedBy.extractPersonUpdatedBy;
-  }
-});
-
-var _extractMembers = require("./extractMembers");
-
-var _extractPersonAssignedTo = require("./extractPersonAssignedTo");
-
-var _extractPersonCreatedBy = require("./extractPersonCreatedBy");
-
-var _extractPersonUpdatedBy = require("./extractPersonUpdatedBy");

package/dist/cjs/extractors/common/person/types.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/dist/cjs/extractors/common/preview/extractImage.js

@@ -1,26 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractImage = void 0;
-
-var _linkingCommon = require("@atlaskit/linking-common");
-
-var extractImage = function extractImage(jsonLd) {
-  var image = jsonLd.image;
-
-  if (image) {
-    if (typeof image === 'string') {
-      return image;
-    } else if (image['@type'] === 'Link') {
-      return (0, _linkingCommon.extractUrlFromLinkJsonLd)(image);
-    } else if (image['@type'] === 'Image') {
-      if (image.url) {
-        return (0, _linkingCommon.extractUrlFromLinkJsonLd)(image.url);
-      }
-    }
-  }
-};
-
-exports.extractImage = extractImage;

package/dist/cjs/extractors/common/preview/index.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "extractImage", {
-  enumerable: true,
-  get: function get() {
-    return _extractImage.extractImage;
-  }
-});
-Object.defineProperty(exports, "extractPreview", {
-  enumerable: true,
-  get: function get() {
-    return _linkingCommon.extractPreview;
-  }
-});
-
-var _linkingCommon = require("@atlaskit/linking-common");
-
-var _extractImage = require("./extractImage");

package/dist/cjs/extractors/common/primitives/extractLink.js

@@ -1,22 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.extractLink = void 0;
-
-var _linkingCommon = require("@atlaskit/linking-common");
-
-var extractLink = function extractLink(jsonLd) {
-  var url = jsonLd.url;
-
-  if (url) {
-    if (typeof url === 'string') {
-      return url;
-    } else {
-      return (0, _linkingCommon.extractUrlFromLinkJsonLd)(url);
-    }
-  }
-};
-
-exports.extractLink = extractLink;