@atlaskit/smart-card 27.4.0 → 27.4.2

package/dist/esm/state/hooks/use-response/index.js

@@ -0,0 +1,126 @@
+import { useCallback, useMemo } from 'react';
+import { ACTION_ERROR, ACTION_ERROR_FALLBACK, ACTION_RELOADING, ACTION_RESOLVED, ACTION_UPDATE_METADATA_STATUS, APIError, cardAction, getStatus } from '@atlaskit/linking-common';
+import { SmartLinkStatus } from '../../../constants';
+import { getUnauthorizedJsonLd } from '../../../utils/jsonld';
+import { ERROR_MESSAGE_FATAL, ERROR_MESSAGE_METADATA, ERROR_MESSAGE_OAUTH } from '../../actions/constants';
+import { unstable_batchedUpdates } from 'react-dom';
+import { useSmartLinkContext } from '@atlaskit/link-provider';
+var useResponse = function useResponse() {
+  // Takes in the JSON-LD response and dispatch the resolved action for the card.
+  // It will dispatch a successful or error action
+  var _useSmartLinkContext = useSmartLinkContext(),
+    store = _useSmartLinkContext.store,
+    config = _useSmartLinkContext.config;
+  var getState = store.getState,
+    dispatch = store.dispatch;
+  var hasAuthFlowSupported = config.authFlow !== 'disabled';
+  var setMetadataStatus = useCallback(function (url, metadataStatus) {
+    dispatch(cardAction(ACTION_UPDATE_METADATA_STATUS, {
+      url: url
+    }, undefined, undefined, metadataStatus));
+  }, [dispatch]);
+  var handleResolvedLinkError = useCallback(function (url, error, response, isMetadataRequest) {
+    var _ref = getState()[url] || {
+        status: SmartLinkStatus.Pending,
+        details: undefined
+      },
+      details = _ref.details;
+    var hasData = !!(details && details.data);
+    // If metadata request then set metadata status, return and do not alter link status
+    if (isMetadataRequest) {
+      setMetadataStatus(url, 'errored');
+      return;
+    }
+    if (error.kind === 'fatal') {
+      // If there's no previous data in the store for this URL, then bail
+      // out and let the editor handle fallbacks (returns to a blue link).
+      if (!hasData && status !== 'resolved') {
+        dispatch(cardAction(ACTION_ERROR, {
+          url: url
+        }, details, error));
+        throw error;
+      }
+      // If we already have resolved data for this URL in the store, then
+      // simply fallback to the previous data.
+      if (hasData) {
+        dispatch(cardAction(ACTION_RESOLVED, {
+          url: url
+        }, details));
+      }
+      // Handle AuthErrors (user did not have access to resource) -
+      // Missing AAID in ASAP claims, or missing UserContext, or 403 from downstream
+    } else if (error.kind === 'auth') {
+      dispatch(cardAction(ACTION_RESOLVED, {
+        url: url
+      }, getUnauthorizedJsonLd()));
+    } else {
+      if (error.kind === 'fallback') {
+        // Fallback to blue link with smart link formatting. Not part of reliability.
+        dispatch(cardAction(ACTION_ERROR_FALLBACK, {
+          url: url
+        }, response, error));
+      } else {
+        // Fallback to blue link with smart link formatting. Part of reliability.
+        dispatch(cardAction(ACTION_ERROR, {
+          url: url
+        }, undefined, error));
+      }
+    }
+  }, [getState, setMetadataStatus, dispatch]);
+  var handleResolvedLinkSuccess = useCallback(function (resourceUrl, response, isReloading, isMetadataRequest) {
+    //if a link resolves normally, metadata will also always be resolved
+    setMetadataStatus(resourceUrl, 'resolved');
+    // Dispatch Analytics and resolved card action - including unauthorized states.
+    if (isReloading) {
+      dispatch(cardAction(ACTION_RELOADING, {
+        url: resourceUrl
+      }, response));
+    } else {
+      dispatch(cardAction(ACTION_RESOLVED, {
+        url: resourceUrl
+      }, response, undefined, undefined, isMetadataRequest));
+    }
+  }, [setMetadataStatus, dispatch]);
+  var handleResolvedLinkResponse = useCallback(function (resourceUrl, response) {
+    var isReloading = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+    var isMetadataRequest = arguments.length > 3 ? arguments[3] : undefined;
+    var hostname = new URL(resourceUrl).hostname;
+    var nextStatus = response ? getStatus(response) : 'fatal';
+
+    // If we require authorization & do not have an authFlow available,
+    // throw an error and render as a normal blue link.
+    if ((nextStatus === 'unauthorized' || nextStatus === 'forbidden') && !hasAuthFlowSupported) {
+      handleResolvedLinkError(resourceUrl, new APIError('fallback', hostname, ERROR_MESSAGE_OAUTH), response, isMetadataRequest);
+      return;
+    }
+
+    // Handle any other errors
+    if (nextStatus === 'fatal') {
+      handleResolvedLinkError(resourceUrl, new APIError('fatal', hostname, ERROR_MESSAGE_FATAL), undefined, isMetadataRequest);
+      return;
+    }
+
+    // Handle errors of any other kind in the metadata request response
+    if (isMetadataRequest && nextStatus !== 'resolved') {
+      handleResolvedLinkError(resourceUrl, new APIError('error', hostname, ERROR_MESSAGE_METADATA), response, isMetadataRequest);
+      return;
+    }
+
+    /**
+     * Using unstable_batchedUpdates because this store update happens async and triggers a rerender
+     * more info:
+     * https://github.com/facebook/react/blob/v18.2.0/packages/use-sync-external-store/src/useSyncExternalStoreShimClient.js#L113
+     * https://react-redux.js.org/api/batch
+     */
+    unstable_batchedUpdates(function () {
+      handleResolvedLinkSuccess(resourceUrl, response, isReloading, isMetadataRequest);
+    });
+  }, [handleResolvedLinkError, handleResolvedLinkSuccess, hasAuthFlowSupported]);
+  return useMemo(function () {
+    return {
+      handleResolvedLinkError: handleResolvedLinkError,
+      handleResolvedLinkResponse: handleResolvedLinkResponse
+    };
+  }, [handleResolvedLinkError, handleResolvedLinkResponse]);
+};
+export default useResponse;

package/dist/esm/utils/analytics/analytics.js

@@ -15,7 +15,7 @@ export var ANALYTICS_CHANNEL = 'media';
 export var context = {
   componentName: 'smart-cards',
   packageName: "@atlaskit/smart-card",
-  packageVersion: "27.4.0"
+  packageVersion: "27.4.2"
 };
 export var TrackQuickActionType = /*#__PURE__*/function (TrackQuickActionType) {
   TrackQuickActionType["StatusUpdate"] = "StatusUpdate";

package/dist/esm/view/FlexibleCard/components/actions/automation-action/automation-manual-triggers/manual-triggers-modal/main.js

@@ -42,7 +42,7 @@ export var AutomationModal = function AutomationModal(_ref) {
     emptyStateDescription: emptyStateDescription,
     emptyStateAdminDescription: emptyStateAdminDescription,
     onRuleInvocationSuccess: onClose,
-    onRuleInvocationLifecycleDone: function onRuleInvocationLifecycleDone() {
+    onRuleInvocationFailure: function onRuleInvocationFailure() {
       return setSelectedRule(undefined);
     }
   }, function () {

package/dist/esm/view/FlexibleCard/components/actions/automation-action/index.js

@@ -7,6 +7,7 @@ import { useFlexibleUiContext } from '../../../../../state/flexible-ui-context';
 import { useSmartLinkModal } from '../../../../../state/modal';
 import { ActionName } from '../../../../../constants';
 import { messages } from '../../../../../messages';
+import { getModalContent } from './utils';
 var AutomationModal = /*#__PURE__*/lazy(function () {
   return import( /* webpackChunkName: "@atlaskit-internal_smart-card-automation-modal" */'./automation-manual-triggers/manual-triggers-modal');
 });
@@ -15,19 +16,23 @@ var AutomationAction = function AutomationAction(props) {
   var _useIntl = useIntl(),
     formatMessage = _useIntl.formatMessage;
   var modal = useSmartLinkModal();
+  var onClickCallback = props.onClick;
   var context = useFlexibleUiContext();
   var automationActionData = context === null || context === void 0 || (_context$actions = context.actions) === null || _context$actions === void 0 ? void 0 : _context$actions[ActionName.AutomationAction];
   var automationActionOnClick = useCallback(function (automationActionData) {
-    var baseAutomationUrl = automationActionData.baseAutomationUrl,
+    var product = automationActionData.product,
+      resourceType = automationActionData.resourceType,
+      baseAutomationUrl = automationActionData.baseAutomationUrl,
       objectAri = automationActionData.objectAri,
       siteAri = automationActionData.siteAri,
       canManageAutomation = automationActionData.canManageAutomation,
       analyticsSource = automationActionData.analyticsSource,
-      modalTitle = automationActionData.modalTitle,
-      modalDescription = automationActionData.modalDescription,
       objectName = automationActionData.objectName;
-    var automationModalTitle = /*#__PURE__*/React.createElement(FormattedMessage, modalTitle);
-    var automationModalDescription = /*#__PURE__*/React.createElement(FormattedMessage, _extends({}, modalDescription, {
+    var _ref = getModalContent(product, resourceType) || {},
+      modalTitle = _ref.modalTitle,
+      modalDescription = _ref.modalDescription;
+    var automationModalTitle = modalTitle ? /*#__PURE__*/React.createElement(FormattedMessage, modalTitle) : undefined;
+    var automationModalDescription = modalDescription ? /*#__PURE__*/React.createElement(FormattedMessage, _extends({}, modalDescription, {
       values: {
         name: objectName,
         b: function b(chunks) {
@@ -35,7 +40,7 @@ var AutomationAction = function AutomationAction(props) {
         },
         br: /*#__PURE__*/React.createElement("br", null)
       }
-    }));
+    })) : undefined;
     modal.open( /*#__PURE__*/React.createElement(AutomationModal, {
       baseAutomationUrl: baseAutomationUrl,
       objectAri: objectAri,
@@ -48,7 +53,8 @@ var AutomationAction = function AutomationAction(props) {
         return modal.close();
       }
     }));
-  }, [modal]);
+    onClickCallback === null || onClickCallback === void 0 || onClickCallback();
+  }, [modal, onClickCallback]);
   if (!automationActionData) {
     return null;
   }
@@ -62,7 +68,7 @@ var AutomationAction = function AutomationAction(props) {
     }),
     testId: "smart-action-automation-action",
     tooltipMessage: automationActionTooltip
-  }, automationActionData, props, {
+  }, props, {
     onClick: function onClick() {
       return automationActionOnClick(automationActionData);
     }

package/dist/esm/view/FlexibleCard/components/actions/automation-action/utils/index.js

@@ -0,0 +1,13 @@
+import { messages } from '../../../../../../messages';
+export var getModalContent = function getModalContent(product, resourceType) {
+  var _modalContentMap$prod;
+  var modalContentMap = {
+    'confluence': {
+      'page': {
+        modalTitle: messages.automation_action_confluence_page_modal_title,
+        modalDescription: messages.automation_action_confluence_page_modal_description
+      }
+    }
+  };
+  return modalContentMap === null || modalContentMap === void 0 || (_modalContentMap$prod = modalContentMap[product]) === null || _modalContentMap$prod === void 0 ? void 0 : _modalContentMap$prod[resourceType];
+};

package/dist/esm/view/LinkUrl/index.js

@@ -10,7 +10,7 @@ import { useLinkWarningModal } from './LinkWarningModal/hooks/use-link-warning-m
 import LinkWarningModal from './LinkWarningModal';
 var PACKAGE_DATA = {
   packageName: "@atlaskit/smart-card",
-  packageVersion: "27.4.0",
+  packageVersion: "27.4.2",
   componentName: 'linkUrl'
 };
 var Link = withLinkClickedEvent('a');

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

@@ -5,7 +5,6 @@ import { type InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
 import type { CardInnerAppearance } from '../../view/Card/types';
 import type { AnalyticsFacade } from '../analytics';
 import type { ProductType } from '@atlaskit/linking-common';
-import { type MessageDescriptor } from 'react-intl-next';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
  * underlying elements.
@@ -275,14 +274,14 @@ export type AISummaryActionData = {
     url: string;
 };
 export type AutomationActionData = {
+    product: string;
+    resourceType: string;
     baseAutomationUrl: string;
     objectAri: any;
     siteAri: any;
     canManageAutomation: boolean;
     analyticsSource: string;
     objectName?: string;
-    modalTitle: MessageDescriptor;
-    modalDescription: MessageDescriptor;
 };
 export type ViewRelatedLinksActionData = {
     url: string;

package/dist/types/state/hooks/use-response/index.d.ts

@@ -0,0 +1,7 @@
+import { APIError } from '@atlaskit/linking-common';
+import { type JsonLd } from 'json-ld-types';
+declare const useResponse: () => {
+    handleResolvedLinkError: (url: string, error: APIError, response?: JsonLd.Response, isMetadataRequest?: boolean) => void;
+    handleResolvedLinkResponse: (resourceUrl: string, response: JsonLd.Response, isReloading?: any, isMetadataRequest?: boolean) => void;
+};
+export default useResponse;

package/dist/types/view/FlexibleCard/components/actions/automation-action/automation-manual-triggers/manual-triggers-modal/sub-components/header/main.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 type AutomationModalHeaderProps = {
-    modalTitle: React.ReactNode;
+    modalTitle?: React.ReactNode;
     modalDescription?: React.ReactNode;
 };
 export declare const AutomationModalHeader: ({ modalTitle, modalDescription, }: AutomationModalHeaderProps) => JSX.Element;

package/dist/types/view/FlexibleCard/components/actions/automation-action/utils/index.d.ts

@@ -0,0 +1,7 @@
+import { type MessageDescriptor } from "react-intl-next";
+type ModalContent = {
+    modalTitle: MessageDescriptor;
+    modalDescription: MessageDescriptor;
+};
+export declare const getModalContent: (product: string, resourceType: string) => ModalContent | undefined;
+export {};

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

@@ -5,7 +5,6 @@ import { type InvokeRequestWithCardDetails } from '../hooks/use-invoke/types';
 import type { CardInnerAppearance } from '../../view/Card/types';
 import type { AnalyticsFacade } from '../analytics';
 import type { ProductType } from '@atlaskit/linking-common';
-import { type MessageDescriptor } from 'react-intl-next';
 /**
  * This provides the data that will be used by Smart Links Flexible UI to populate it's
  * underlying elements.
@@ -275,14 +274,14 @@ export type AISummaryActionData = {
     url: string;
 };
 export type AutomationActionData = {
+    product: string;
+    resourceType: string;
     baseAutomationUrl: string;
     objectAri: any;
     siteAri: any;
     canManageAutomation: boolean;
     analyticsSource: string;
     objectName?: string;
-    modalTitle: MessageDescriptor;
-    modalDescription: MessageDescriptor;
 };
 export type ViewRelatedLinksActionData = {
     url: string;

package/dist/types-ts4.5/state/hooks/use-response/index.d.ts

@@ -0,0 +1,7 @@
+import { APIError } from '@atlaskit/linking-common';
+import { type JsonLd } from 'json-ld-types';
+declare const useResponse: () => {
+    handleResolvedLinkError: (url: string, error: APIError, response?: JsonLd.Response, isMetadataRequest?: boolean) => void;
+    handleResolvedLinkResponse: (resourceUrl: string, response: JsonLd.Response, isReloading?: any, isMetadataRequest?: boolean) => void;
+};
+export default useResponse;

package/dist/types-ts4.5/view/FlexibleCard/components/actions/automation-action/automation-manual-triggers/manual-triggers-modal/sub-components/header/main.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 type AutomationModalHeaderProps = {
-    modalTitle: React.ReactNode;
+    modalTitle?: React.ReactNode;
     modalDescription?: React.ReactNode;
 };
 export declare const AutomationModalHeader: ({ modalTitle, modalDescription, }: AutomationModalHeaderProps) => JSX.Element;

package/dist/types-ts4.5/view/FlexibleCard/components/actions/automation-action/utils/index.d.ts

@@ -0,0 +1,7 @@
+import { type MessageDescriptor } from "react-intl-next";
+type ModalContent = {
+    modalTitle: MessageDescriptor;
+    modalDescription: MessageDescriptor;
+};
+export declare const getModalContent: (product: string, resourceType: string) => ModalContent | undefined;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/smart-card",
-  "version": "27.4.0",
+  "version": "27.4.2",
   "description": "Smart card component",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -55,7 +55,7 @@
     "@atlaskit/outbound-auth-flow-client": "^3.4.0",
     "@atlaskit/platform-feature-flags": "^0.2.1",
     "@atlaskit/popup": "^1.17.0",
-    "@atlaskit/primitives": "^6.3.0",
+    "@atlaskit/primitives": "^6.4.0",
     "@atlaskit/section-message": "^6.5.0",
     "@atlaskit/select": "^17.10.0",
     "@atlaskit/spinner": "^16.1.0",
@@ -97,7 +97,6 @@
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
     "@atlassian/analytics-tooling": "*",
-    "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/feature-flags-test-utils": "^0.2.0",
     "@testing-library/dom": "^8.17.1",
     "@testing-library/jest-dom": "^5.16.5",
@@ -192,6 +191,5 @@
     "platform.linking-platform.smart-card.enable-view-related-urls-action": {
       "type": "boolean"
     }
-  },
-  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
+  }
 }