@atlaskit/smart-card 33.2.0 → 33.3.0

package/dist/types-ts4.5/view/InlineCard/types.d.ts

@@ -1,6 +1,5 @@
 import { type EventHandler, type KeyboardEvent, type MouseEvent } from 'react';
 import { type CardProviderRenderers } from '@atlaskit/link-provider';
-import { type AnalyticsFacade } from '../../state/analytics';
 import { type CardState } from '../../state/types';
 import type { CardActionOptions } from '../Card/types';
 import { type HoverPreviewOptions } from '../HoverCard/types';
@@ -24,7 +23,6 @@ export type InlineCardProps = {
     showHoverPreview?: boolean;
     hoverPreviewOptions?: HoverPreviewOptions;
     actionOptions?: CardActionOptions;
-    analytics: AnalyticsFacade;
     removeTextHighlightingFromTitle?: boolean;
     resolvingPlaceholder?: string;
     truncateInline?: boolean;

package/dist/types-ts4.5/view/common/UnauthorisedViewContent.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="react" />
-import { type AnalyticsFacade } from '../../state/analytics';
 type UnauthorisedViewContentProps = {
     /**
      * Is the name of the provider for the account that needs to be connected
@@ -17,11 +16,6 @@ type UnauthorisedViewContentProps = {
      * serving as a hook for automated tests
      */
     testId?: string;
-    /**
-     * An analytics facade object which will be used to send analytics.
-     * @internal
-     */
-    analytics?: AnalyticsFacade;
 };
 /**
  * This component is used in unauthorized views of a smart link.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/smart-card",
-	"version": "33.2.0",
+	"version": "33.3.0",
 	"description": "Smart card component",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"

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

@@ -1,139 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useSmartLinkAnalytics = void 0;
-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 _useDispatchAnalytics2 = require("./useDispatchAnalytics");
-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 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(_ref) {
-        var id = _ref.id,
-          actionType = _ref.actionType,
-          display = _ref.display,
-          extensionKey = _ref.extensionKey,
-          definitionId = _ref.definitionId,
-          resourceType = _ref.resourceType,
-          destinationProduct = _ref.destinationProduct,
-          destinationSubproduct = _ref.destinationSubproduct,
-          location = _ref.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(_ref2) {
-        var id = _ref2.id,
-          actionType = _ref2.actionType,
-          display = _ref2.display,
-          reason = _ref2.reason,
-          extensionKey = _ref2.extensionKey,
-          definitionId = _ref2.definitionId,
-          resourceType = _ref2.resourceType,
-          destinationProduct = _ref2.destinationProduct,
-          destinationSubproduct = _ref2.destinationSubproduct,
-          location = _ref2.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]);
-  return (0, _react.useMemo)(function () {
-    return {
-      operational: operational,
-      screen: screen
-    };
-  }, [operational]);
-};

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

@@ -1,126 +0,0 @@
-import { useMemo } from 'react';
-import { useSmartLinkContext } from '@atlaskit/link-provider';
-import { getUrl } from '@atlaskit/linking-common';
-import { invokeFailedEvent, invokeSucceededEvent } from '../../utils/analytics';
-import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getStatusDetails, getSubproduct } from '../helpers';
-import { useDispatchAnalytics } from './useDispatchAnalytics';
-const applyCommonAttributes = (event, commonAttributes) => {
-  if (event && event.attributes) {
-    for (const [key, value] of Object.entries(commonAttributes)) {
-      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
- */
-export const useSmartLinkAnalytics = (url, id, defaultLocation) => {
-  const {
-    dispatchAnalytics
-  } = useDispatchAnalytics();
-  const defaultId = id || 'NULL';
-  // We don't want to trigger a re-render by using useSmartCardState
-  const {
-    store
-  } = useSmartLinkContext();
-  const state = store ? getUrl(store, url) : undefined;
-  const details = state ? state.details : undefined;
-  const extractedDefinitionId = getDefinitionId(details);
-  const extractedExtensionKey = getExtensionKey(details);
-  const extractedResourceType = getResourceType(details);
-  const extractedSubproduct = getSubproduct(details);
-  const extractedProduct = getProduct(details);
-  const extractedStatusDetails = getStatusDetails(details);
-  const commonAttributes = useMemo(() => ({
-    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 operational analytics events */
-  const operational = useMemo(() => ({
-    /**
-     * 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: ({
-      id,
-      actionType,
-      display,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location
-    }) => {
-      dispatchAnalytics(applyCommonAttributes(invokeSucceededEvent({
-        id: id !== null && id !== void 0 ? id : defaultId,
-        actionType,
-        display,
-        extensionKey,
-        definitionId,
-        resourceType,
-        destinationProduct,
-        destinationSubproduct,
-        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: ({
-      id,
-      actionType,
-      display,
-      reason,
-      extensionKey,
-      definitionId,
-      resourceType,
-      destinationProduct,
-      destinationSubproduct,
-      location
-    }) => {
-      dispatchAnalytics(applyCommonAttributes(invokeFailedEvent({
-        id: id !== null && id !== void 0 ? id : defaultId,
-        actionType,
-        display,
-        reason,
-        extensionKey,
-        definitionId,
-        resourceType,
-        destinationProduct,
-        destinationSubproduct,
-        location
-      }), commonAttributes));
-    }
-  }), [defaultId, commonAttributes, dispatchAnalytics]);
-  return useMemo(() => ({
-    operational,
-    screen
-  }), [operational]);
-};

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

@@ -1,132 +0,0 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import { useMemo } from 'react';
-import { useSmartLinkContext } from '@atlaskit/link-provider';
-import { getUrl } from '@atlaskit/linking-common';
-import { invokeFailedEvent as _invokeFailedEvent, invokeSucceededEvent as _invokeSucceededEvent } from '../../utils/analytics';
-import { getDefinitionId, getExtensionKey, getProduct, getResourceType, getStatusDetails, getSubproduct } from '../helpers';
-import { useDispatchAnalytics } from './useDispatchAnalytics';
-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 = _slicedToArray(_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
- */
-export var useSmartLinkAnalytics = function useSmartLinkAnalytics(url, id, defaultLocation) {
-  var _useDispatchAnalytics = useDispatchAnalytics(),
-    dispatchAnalytics = _useDispatchAnalytics.dispatchAnalytics;
-  var defaultId = id || 'NULL';
-  // We don't want to trigger a re-render by using useSmartCardState
-  var _useSmartLinkContext = useSmartLinkContext(),
-    store = _useSmartLinkContext.store;
-  var state = store ? getUrl(store, url) : undefined;
-  var details = state ? state.details : undefined;
-  var extractedDefinitionId = getDefinitionId(details);
-  var extractedExtensionKey = getExtensionKey(details);
-  var extractedResourceType = getResourceType(details);
-  var extractedSubproduct = getSubproduct(details);
-  var extractedProduct = getProduct(details);
-  var extractedStatusDetails = getStatusDetails(details);
-  var commonAttributes = 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 operational analytics events */
-  var operational = 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(_ref) {
-        var id = _ref.id,
-          actionType = _ref.actionType,
-          display = _ref.display,
-          extensionKey = _ref.extensionKey,
-          definitionId = _ref.definitionId,
-          resourceType = _ref.resourceType,
-          destinationProduct = _ref.destinationProduct,
-          destinationSubproduct = _ref.destinationSubproduct,
-          location = _ref.location;
-        dispatchAnalytics(applyCommonAttributes(_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(_ref2) {
-        var id = _ref2.id,
-          actionType = _ref2.actionType,
-          display = _ref2.display,
-          reason = _ref2.reason,
-          extensionKey = _ref2.extensionKey,
-          definitionId = _ref2.definitionId,
-          resourceType = _ref2.resourceType,
-          destinationProduct = _ref2.destinationProduct,
-          destinationSubproduct = _ref2.destinationSubproduct,
-          location = _ref2.location;
-        dispatchAnalytics(applyCommonAttributes(_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]);
-  return useMemo(function () {
-    return {
-      operational: operational,
-      screen: screen
-    };
-  }, [operational]);
-};

package/dist/types/state/analytics/useSmartLinkAnalytics.d.ts

@@ -1,33 +0,0 @@
-import { type InvokeFailedEventProps, type InvokeSucceededEventProps } from '../../utils/analytics/types';
-/**
- * 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
- */
-export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLocation?: string) => {
-    operational: {
-        /**
-         * 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: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
-        /**
-         * 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: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
-    };
-    screen: Screen;
-};
-export type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

package/dist/types/utils/analytics/__mocks__/analytics.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/types-ts4.5/state/analytics/useSmartLinkAnalytics.d.ts

@@ -1,33 +0,0 @@
-import { type InvokeFailedEventProps, type InvokeSucceededEventProps } from '../../utils/analytics/types';
-/**
- * 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
- */
-export declare const useSmartLinkAnalytics: (url: string, id?: string, defaultLocation?: string) => {
-    operational: {
-        /**
-         * 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: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
-        /**
-         * 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: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
-    };
-    screen: Screen;
-};
-export type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;

package/dist/types-ts4.5/utils/analytics/__mocks__/analytics.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;