@atlaskit/smart-card 33.1.0 → 33.3.0

package/dist/cjs/state/analytics/useSmartLinkAnalytics.js

@@ -1,311 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useSmartLinkAnalytics = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
-var _react = require("react");
-var _linkProvider = require("@atlaskit/link-provider");
-var _linkingCommon = require("@atlaskit/linking-common");
-var _analytics = require("../../utils/analytics");
-var _helpers = require("../helpers");
-var _ufoExperiences = require("./ufoExperiences");
-var _useDispatchAnalytics2 = require("./useDispatchAnalytics");
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-var applyCommonAttributes = function applyCommonAttributes(event, commonAttributes) {
-  if (event && event.attributes) {
-    for (var _i = 0, _Object$entries = Object.entries(commonAttributes); _i < _Object$entries.length; _i++) {
-      var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
-        key = _Object$entries$_i[0],
-        value = _Object$entries$_i[1];
-      if (event.attributes[key] === undefined) {
-        event.attributes[key] = value;
-      }
-    }
-  }
-  return event;
-};
-
-/**
- * This hook provides usage of Smart Link analytics outside of the Card component.
- * Can be provided to Card via the analyticsEvents prop to change the analytics events.
- *
- * @param url URL of the link
- * @param id fallback id of the events sent if no id is available
- * @param defaultLocation location attribute to be used
- * @returns
- */
-var useSmartLinkAnalytics = exports.useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defaultLocation) {
-  var _useDispatchAnalytics = (0, _useDispatchAnalytics2.useDispatchAnalytics)(),
-    dispatchAnalytics = _useDispatchAnalytics.dispatchAnalytics;
-  var defaultId = id || 'NULL';
-  // We don't want to trigger a re-render by using useSmartCardState
-  var _useSmartLinkContext = (0, _linkProvider.useSmartLinkContext)(),
-    store = _useSmartLinkContext.store;
-  var state = store ? (0, _linkingCommon.getUrl)(store, url) : undefined;
-  var details = state ? state.details : undefined;
-  var extractedDefinitionId = (0, _helpers.getDefinitionId)(details);
-  var extractedExtensionKey = (0, _helpers.getExtensionKey)(details);
-  var extractedResourceType = (0, _helpers.getResourceType)(details);
-  var extractedSubproduct = (0, _helpers.getSubproduct)(details);
-  var extractedProduct = (0, _helpers.getProduct)(details);
-  var extractedStatusDetails = (0, _helpers.getStatusDetails)(details);
-  var commonAttributes = (0, _react.useMemo)(function () {
-    return {
-      id: defaultId,
-      definitionId: extractedDefinitionId,
-      extensionKey: extractedExtensionKey,
-      resourceType: extractedResourceType,
-      destinationObjectType: extractedResourceType,
-      destinationSubproduct: extractedSubproduct,
-      destinationProduct: extractedProduct,
-      location: defaultLocation,
-      statusDetails: extractedStatusDetails
-    };
-  }, [defaultId, extractedDefinitionId, extractedExtensionKey, extractedResourceType, extractedSubproduct, extractedProduct, defaultLocation, extractedStatusDetails]);
-
-  /** Contains all ui analytics events */
-  var ui = (0, _react.useMemo)(function () {
-    return {
-      /**
-       * This fires an event that represents when a user
-       * click a button.
-       * @param data A partial analytics event payload
-       * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
-       */
-      buttonClickedEvent: function buttonClickedEvent(data) {
-        return dispatchAnalytics(applyCommonAttributes({
-          action: 'clicked',
-          actionSubject: 'button',
-          actionSubjectId: data.actionSubjectId,
-          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
-          eventType: 'ui'
-        }, commonAttributes));
-      },
-      /**
-       * This fires an event that represents when a user clicks on a Smart Link action.
-       * Note: This also starts the UFO smart-link-action-invocation experience.
-       * @param id The unique ID for this Smart Link.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param actionType The type of the action that was clicked, e.g. PreviewAction
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @returns
-       */
-      actionClickedEvent: function actionClickedEvent(_ref) {
-        var id = _ref.id,
-          actionType = _ref.actionType,
-          display = _ref.display,
-          overrideExtensionKey = _ref.extensionKey,
-          definitionId = _ref.definitionId,
-          resourceType = _ref.resourceType,
-          destinationProduct = _ref.destinationProduct,
-          destinationSubproduct = _ref.destinationSubproduct,
-          location = _ref.location;
-        var extensionKey = overrideExtensionKey !== null && overrideExtensionKey !== void 0 ? overrideExtensionKey : extractedExtensionKey;
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiActionClickedEvent)({
-          id: id !== null && id !== void 0 ? id : defaultId,
-          actionType: actionType,
-          display: display,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
-      },
-      /**
-       * This fires an event that represents when a user close a modal.
-       * @param data A partial analytics event payload
-       * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
-       */
-      modalClosedEvent: function modalClosedEvent(data) {
-        return dispatchAnalytics(applyCommonAttributes({
-          action: 'closed',
-          actionSubject: 'modal',
-          actionSubjectId: data.actionSubjectId,
-          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
-          eventType: 'ui'
-        }, commonAttributes));
-      },
-      /**
-       * This fires an event that represents when a Smart Link was rendered successfully.
-       * Note: this fires even if the Smart Link request errored out.
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @param id The unique ID for this Smart Link.
-       * @param definitionId The definitionId of the Smart Link resolver invoked.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param canBeDatasource An indicator that shows that a smart link can be converted to a datasource
-       * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
-       */
-      renderSuccessEvent: function renderSuccessEvent(_ref2) {
-        var display = _ref2.display,
-          status = _ref2.status,
-          id = _ref2.id,
-          extensionKey = _ref2.extensionKey,
-          definitionId = _ref2.definitionId,
-          resourceType = _ref2.resourceType,
-          destinationProduct = _ref2.destinationProduct,
-          destinationSubproduct = _ref2.destinationSubproduct,
-          location = _ref2.location,
-          _ref2$canBeDatasource = _ref2.canBeDatasource,
-          canBeDatasource = _ref2$canBeDatasource === void 0 ? false : _ref2$canBeDatasource;
-        var experienceId = id ? id : defaultId;
-        (0, _ufoExperiences.succeedUfoExperience)('smart-link-rendered', experienceId, {
-          extensionKey: extensionKey,
-          display: display
-        });
-
-        // UFO will disregard this if authentication experience has not yet been started
-        (0, _ufoExperiences.succeedUfoExperience)('smart-link-authenticated', experienceId, {
-          display: display
-        });
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiRenderSuccessEvent)({
-          display: display,
-          status: status,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location,
-          canBeDatasource: canBeDatasource
-        }), commonAttributes));
-      },
-      /**
-       * This fires an event that represents when a Smart Link renders unsuccessfuly.
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @param id The unique ID for this Smart Link.
-       * @param error: An error representing why the Smart Link render failed.
-       * @param errorInfo: Additional details about the error including the stack trace.
-       * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
-       */
-      renderFailedEvent: function renderFailedEvent(_ref3) {
-        var display = _ref3.display,
-          id = _ref3.id,
-          error = _ref3.error,
-          errorInfo = _ref3.errorInfo,
-          extensionKey = _ref3.extensionKey,
-          definitionId = _ref3.definitionId,
-          resourceType = _ref3.resourceType,
-          destinationProduct = _ref3.destinationProduct,
-          destinationSubproduct = _ref3.destinationSubproduct,
-          location = _ref3.location;
-        var experienceId = id ? id : defaultId;
-        // Start and fail the smart-link-rendered experience. If it has already
-        // been started nothing happens.
-        (0, _ufoExperiences.startUfoExperience)('smart-link-rendered', experienceId);
-        (0, _ufoExperiences.failUfoExperience)('smart-link-rendered', experienceId);
-        (0, _ufoExperiences.failUfoExperience)('smart-link-authenticated', experienceId);
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.uiRenderFailedEvent)({
-          display: display,
-          error: error,
-          errorInfo: errorInfo,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
-      }
-    };
-  }, [dispatchAnalytics, commonAttributes, defaultId, extractedExtensionKey]);
-
-  /** Contains all operational analytics events */
-  var operational = (0, _react.useMemo)(function () {
-    return {
-      /**
-       * This fires an event that represents an action being successfully invoked.
-       * @param id The unique ID for this Smart Link.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param actionType The type of action invoked, e.g. PreviewAction
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       */
-      invokeSucceededEvent: function invokeSucceededEvent(_ref4) {
-        var id = _ref4.id,
-          actionType = _ref4.actionType,
-          display = _ref4.display,
-          extensionKey = _ref4.extensionKey,
-          definitionId = _ref4.definitionId,
-          resourceType = _ref4.resourceType,
-          destinationProduct = _ref4.destinationProduct,
-          destinationSubproduct = _ref4.destinationSubproduct,
-          location = _ref4.location;
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.invokeSucceededEvent)({
-          id: id !== null && id !== void 0 ? id : defaultId,
-          actionType: actionType,
-          display: display,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
-      },
-      /**
-       * This fires an event that represents an action being unsuccessfully invoked.
-       * @param id The unique ID for this Smart Link.
-       * @param extensionKey The extensionKey of the Smart Link resovler invoked.
-       * @param actionType The type of action invoked, e.g. PreviewAction
-       * @param display Whether the card was an Inline, Block, Embed or Flexible UI.
-       * @param reason The reason the invocation failed.
-       */
-      invokeFailedEvent: function invokeFailedEvent(_ref5) {
-        var id = _ref5.id,
-          actionType = _ref5.actionType,
-          display = _ref5.display,
-          reason = _ref5.reason,
-          extensionKey = _ref5.extensionKey,
-          definitionId = _ref5.definitionId,
-          resourceType = _ref5.resourceType,
-          destinationProduct = _ref5.destinationProduct,
-          destinationSubproduct = _ref5.destinationSubproduct,
-          location = _ref5.location;
-        dispatchAnalytics(applyCommonAttributes((0, _analytics.invokeFailedEvent)({
-          id: id !== null && id !== void 0 ? id : defaultId,
-          actionType: actionType,
-          display: display,
-          reason: reason,
-          extensionKey: extensionKey,
-          definitionId: definitionId,
-          resourceType: resourceType,
-          destinationProduct: destinationProduct,
-          destinationSubproduct: destinationSubproduct,
-          location: location
-        }), commonAttributes));
-      }
-    };
-  }, [defaultId, commonAttributes, dispatchAnalytics]);
-
-  /** Contains all screen analytics events */
-  var screen = (0, _react.useMemo)(function () {
-    return {
-      /**
-       * This fires an event that represents when a user view a modal.
-       * @deprecated consider removing when cleaning up FF platform-smart-card-migrate-embed-modal-analytics
-       */
-      modalViewedEvent: function modalViewedEvent(data) {
-        return dispatchAnalytics(applyCommonAttributes({
-          action: 'viewed',
-          actionSubject: data.name,
-          attributes: _objectSpread(_objectSpread({}, _analytics.context), data.attributes),
-          eventType: 'screen',
-          name: data.name
-        }, commonAttributes));
-      }
-    };
-  }, [commonAttributes, dispatchAnalytics]);
-  return (0, _react.useMemo)(function () {
-    return {
-      ui: ui,
-      operational: operational,
-      screen: screen
-    };
-  }, [ui, operational, screen]);
-};

package/dist/es2019/extractors/action/extractDownloadActionProps.js

@@ -1,24 +0,0 @@
-import { ActionName } from '../../constants';
-import { downloadUrl } from '../../utils';
-import { extractDownloadAction as extractDownloadActionData } from '../flexible/actions/extract-download-action';
-
-/**
- * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
- * Replace with platform/packages/linking-platform/smart-card/src/extractors/action/extract-invoke-download-action.ts
- */
-export const extractDownloadActionProps = ({
-  response,
-  actionOptions,
-  extensionKey = 'empty-object-provider',
-  source = 'block'
-}) => {
-  const data = extractDownloadActionData(response.data, actionOptions);
-  if (data) {
-    return {
-      actionType: ActionName.DownloadAction,
-      actionFn: () => downloadUrl(data.downloadUrl),
-      display: source,
-      extensionKey
-    };
-  }
-};

package/dist/es2019/extractors/action/extractPreviewActionProps.js

@@ -1,36 +0,0 @@
-import { ActionName } from '../../constants';
-import { openEmbedModal } from '../../view/EmbedModal/utils';
-import { extractPreviewAction as extractPreviewActionData } from '../flexible/actions/extract-preview-action';
-
-/**
- * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
- * Replaced with platform/packages/linking-platform/smart-card/src/extractors/action/extract-invoke-preview-action.ts
- */
-export const extractPreviewActionProps = ({
-  response,
-  analytics,
-  extensionKey = 'empty-object-provider',
-  source = 'block',
-  actionOptions,
-  origin
-}) => {
-  const data = extractPreviewActionData(response, actionOptions);
-  if (data !== null && data !== void 0 && data.src) {
-    return {
-      actionType: ActionName.PreviewAction,
-      actionFn: () => openEmbedModal({
-        download: data === null || data === void 0 ? void 0 : data.downloadUrl,
-        showModal: true,
-        onClose: () => {},
-        analytics,
-        extensionKey,
-        origin,
-        ...data
-      }),
-      // These values have already been set in analytics context.
-      // We only pass these here for ufo experience.
-      display: source,
-      extensionKey
-    };
-  }
-};

package/dist/es2019/extractors/action/extractViewActionProps.js

@@ -1,23 +0,0 @@
-import { openUrl } from '../../utils';
-import { extractViewAction as extractViewActionData } from '../flexible/actions/extract-view-action';
-
-/**
- * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
- * Replace with platform/packages/linking-platform/smart-card/src/extractors/action/extract-invoke-view-action.ts
- */
-export const extractViewActionProps = ({
-  response,
-  actionOptions,
-  extensionKey = 'empty-object-provider',
-  source = 'block'
-}) => {
-  const data = extractViewActionData(response.data, actionOptions);
-  if (data) {
-    return {
-      actionType: 'ViewAction',
-      actionFn: () => openUrl(data.viewUrl),
-      display: source,
-      extensionKey
-    };
-  }
-};

package/dist/es2019/extractors/flexible/actions/extract-view-action.js

@@ -1,20 +0,0 @@
-import { extractLink } from '@atlaskit/link-extractors';
-import { canShowAction } from '../../../utils/actions/can-show-action';
-import { CardAction } from '../../../view/Card/types';
-import { getActionsFromJsonLd } from '../../common/actions/extractActions';
-
-/**
- * TODO: Remove on cleanup of platform-smart-card-migrate-embed-modal-analytics
- */
-export const extractViewAction = (data, actionOptions) => {
-  if (!canShowAction(CardAction.ViewAction, actionOptions)) {
-    return;
-  }
-  const viewActionExists = getActionsFromJsonLd(data).find(action => action['@type'] === 'ViewAction');
-  if (viewActionExists) {
-    return {
-      viewUrl: extractLink(data)
-    };
-  }
-  return undefined;
-};