@atlaskit/smart-card 25.4.0 → 25.4.2

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

@@ -0,0 +1,161 @@
+import _typeof from "@babel/runtime/helpers/typeof";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
+import { useCallback } from 'react';
+import { addMetadataToExperience } from '../../analytics';
+import { getStatus } from '../../helpers';
+import { ACTION_ERROR, ACTION_ERROR_FALLBACK, ACTION_RELOADING, ACTION_RESOLVED, ACTION_UPDATE_METADATA_STATUS, APIError, cardAction } from '@atlaskit/linking-common';
+import { ERROR_MESSAGE_FATAL, ERROR_MESSAGE_METADATA, ERROR_MESSAGE_OAUTH } from '../../actions/constants';
+import { getUnauthorizedJsonLd } from '../../../utils/jsonld';
+import { SmartLinkStatus } from '../../../constants';
+import { useSmartLinkContext } from '@atlaskit/link-provider';
+var useResolve = function useResolve() {
+  // Request JSON-LD data for the card from ORS, if it has extended
+  // its cache lifespan OR there is no data for it currently. Once the data
+  // has come back asynchronously, dispatch the resolved action for the card.
+  var _useSmartLinkContext = useSmartLinkContext(),
+    store = _useSmartLinkContext.store,
+    connections = _useSmartLinkContext.connections,
+    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 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;
+    }
+
+    //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));
+    }
+  }, [dispatch, handleResolvedLinkError, hasAuthFlowSupported, setMetadataStatus]);
+  return useCallback( /*#__PURE__*/function () {
+    var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(url) {
+      var isReloading,
+        isMetadataRequest,
+        id,
+        _ref3,
+        details,
+        hasData,
+        _args = arguments;
+      return _regeneratorRuntime().wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              isReloading = _args.length > 1 && _args[1] !== undefined ? _args[1] : false;
+              isMetadataRequest = _args.length > 2 && _args[2] !== undefined ? _args[2] : false;
+              id = _args.length > 3 && _args[3] !== undefined ? _args[3] : '';
+              _ref3 = getState()[url] || {
+                status: SmartLinkStatus.Pending,
+                details: undefined
+              }, details = _ref3.details;
+              hasData = !!(details && details.data);
+              if (!(isReloading || !hasData || isMetadataRequest)) {
+                _context.next = 9;
+                break;
+              }
+              return _context.abrupt("return", connections.client.fetchData(url, isReloading).then(function (response) {
+                return handleResolvedLinkResponse(url, response, isReloading, isMetadataRequest);
+              }).catch(function (error) {
+                return handleResolvedLinkError(url, error, undefined, isMetadataRequest);
+              }));
+            case 9:
+              addMetadataToExperience('smart-link-rendered', id, {
+                cached: true
+              });
+            case 10:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee);
+    }));
+    return function (_x) {
+      return _ref2.apply(this, arguments);
+    };
+  }(), [connections.client, getState, handleResolvedLinkError, handleResolvedLinkResponse]);
+};
+export default useResolve;

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

@@ -16,9 +16,7 @@ export function getLinkClickOutcome(e, clickType) {
   var _browser = browser(),
     mac = _browser.mac,
     safari = _browser.safari;
-  if (e.defaultPrevented) {
-    return 'prevented';
-  }
+
   /**
    * If the link/parent is content editable then left click won't have typical effect
    */
@@ -66,12 +64,13 @@ export function getLinkClickOutcome(e, clickType) {
         return 'contextMenu';
       }
   }
-  return '_unknown';
+  return 'unknown';
 }
 var linkClickedEvent = function linkClickedEvent(_ref) {
   var clickType = _ref.clickType,
     clickOutcome = _ref.clickOutcome,
-    keysHeld = _ref.keysHeld;
+    keysHeld = _ref.keysHeld,
+    defaultPrevented = _ref.defaultPrevented;
   return {
     action: 'clicked',
     actionSubject: 'link',
@@ -79,7 +78,8 @@ var linkClickedEvent = function linkClickedEvent(_ref) {
     attributes: {
       clickType: clickType,
       clickOutcome: clickOutcome,
-      keysHeld: keysHeld
+      keysHeld: keysHeld,
+      defaultPrevented: defaultPrevented
     }
   };
 };
@@ -90,10 +90,12 @@ export var createLinkClickedPayload = function createLinkClickedPayload(event) {
   }
   var clickOutcome = getLinkClickOutcome(event, clickType);
   var keysHeld = getKeys(event);
+  var defaultPrevented = event.defaultPrevented;
   return linkClickedEvent({
     clickType: clickType,
     clickOutcome: clickOutcome,
-    keysHeld: keysHeld
+    keysHeld: keysHeld,
+    defaultPrevented: defaultPrevented
   });
 };
 export var fireLinkClickedEvent = function fireLinkClickedEvent(createAnalyticsEvent) {

package/dist/esm/version.json

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

package/dist/esm/view/FlexibleCard/components/common/lozenge-action/index.js

@@ -16,6 +16,7 @@ import useInvoke from '../../../../../state/hooks/use-invoke';
 import { InvokeActionError } from '../../../../../state/hooks/use-invoke/types';
 import extractLozengeActionItems from '../../../../../extractors/action/extract-lozenge-action-items';
 import createStatusUpdateRequest from '../../../../../utils/actions/create-status-update-request';
+import useResolve from '../../../../../state/hooks/use-resolve';
 var validateItems = function validateItems() {
   var items = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   var text = arguments.length > 1 ? arguments[1] : undefined;
@@ -50,6 +51,7 @@ var LozengeAction = function LozengeAction(_ref) {
     errorCode = _useState10[0],
     setErrorCode = _useState10[1];
   var invoke = useInvoke();
+  var reload = useResolve();
   var handleOpenChange = useCallback( /*#__PURE__*/function () {
     var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(args) {
       var responseItems, validItems;
@@ -109,43 +111,51 @@ var LozengeAction = function LozengeAction(_ref) {
   }, [appearance, testId, text]);
   var handleItemClick = useCallback( /*#__PURE__*/function () {
     var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(id) {
-      var request;
+      var updateAction, request, _ref4, url, linkId;
       return _regeneratorRuntime().wrap(function _callee2$(_context2) {
         while (1) {
           switch (_context2.prev = _context2.next) {
             case 0:
               _context2.prev = 0;
-              if (!(action !== null && action !== void 0 && action.update && id)) {
-                _context2.next = 8;
+              updateAction = action === null || action === void 0 ? void 0 : action.update;
+              if (!(updateAction && id)) {
+                _context2.next = 13;
                 break;
               }
               setIsLoading(true);
-              request = createStatusUpdateRequest(action.update, id);
-              _context2.next = 6;
+              request = createStatusUpdateRequest(updateAction, id);
+              _context2.next = 7;
               return invoke(request);
-            case 6:
+            case 7:
               setIsLoading(false);
               setIsOpen(false);
-            case 8:
-              _context2.next = 14;
+              _ref4 = updateAction.details || {}, url = _ref4.url, linkId = _ref4.id;
+              if (!url) {
+                _context2.next = 13;
+                break;
+              }
+              _context2.next = 13;
+              return reload(url, true, undefined, linkId);
+            case 13:
+              _context2.next = 19;
               break;
-            case 10:
-              _context2.prev = 10;
+            case 15:
+              _context2.prev = 15;
               _context2.t0 = _context2["catch"](0);
               // TODO: EDM-6261: Error state
               setIsLoading(false);
               setErrorCode(InvokeActionError.Unknown);
-            case 14:
+            case 19:
             case "end":
               return _context2.stop();
           }
         }
-      }, _callee2, null, [[0, 10]]);
+      }, _callee2, null, [[0, 15]]);
     }));
     return function (_x2) {
       return _ref3.apply(this, arguments);
     };
-  }(), [action === null || action === void 0 ? void 0 : action.update, invoke]);
+  }(), [action === null || action === void 0 ? void 0 : action.update, invoke, reload]);
   var dropdownItemGroup = useMemo(function () {
     if (errorCode) {
       return jsx(LozengeActionError, {

package/dist/types/extractors/common/__mocks__/jsonld.d.ts

@@ -29,230 +29,10 @@ export declare const TEST_UNDEFINED_LINK: JsonLd.Data.UndefinedLinkDocument;
 export declare const TEST_ASSIGN_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
 export declare const TEST_NO_ID_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
 export declare const TEST_VIEW_ACTION: JsonLd.Data.BaseData['schema:potentialAction'];
-export declare const TEST_DOCUMENT_WITH_ACTIONS: {
-    'schema:potentialAction': any[];
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
-    'schema:fileFormat'?: string | undefined;
-    'atlassian:fileSize'?: number | undefined;
-    'schema:commentCount'?: number | undefined;
-    'atlassian:isDeleted'?: boolean | undefined;
-    'atlassian:attachmentCount'?: number | undefined;
-    'atlassian:dateViewed'?: string | undefined;
-    'atlassian:checkItems'?: JsonLd.Primitives.CheckItemProgress | undefined;
-    'atlassian:reactCount'?: number | undefined;
-    'atlassian:state'?: string | JsonLd.Primitives.Object<any> | undefined;
-    'atlassian:viewCount'?: number | undefined;
-    'atlassian:voteCount'?: number | undefined;
-    '@context': JsonLd.Primitives.Context;
-    'atlassian:downloadUrl'?: string | undefined;
-    'atlassian:visitUrl'?: string | undefined;
-    'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
-    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | JsonLd.Primitives.Collection<JsonLd.Primitives.Link | JsonLd.Primitives.Person<any>> | undefined;
-    'schema:dateCreated'?: string | undefined;
-    '@id'?: string | undefined;
-    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
-        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    }> | undefined;
-    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    preview?: string | ((JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel) & JsonLd.Primitives.PreviewExtension) | undefined;
-    replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
-    content?: string | undefined;
-    contentMap?: Record<string, string> | undefined;
-    name?: string | undefined;
-    nameMap?: Record<string, string> | undefined;
-    duration?: string | undefined;
-    mediaType?: string | undefined;
-    endTime?: string | undefined;
-    published?: string | undefined;
-    startTime?: string | undefined;
-    summary?: string | undefined;
-    summaryMap?: Record<string, string> | undefined;
-    updated?: string | undefined;
-};
-export declare const TEST_DOCUMENT_WITH_DOWNLOAD_ACTION: {
-    'atlassian:downloadUrl': string;
-    'schema:potentialAction': import("schema-dts").DownloadAction[];
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
-    'schema:fileFormat'?: string | undefined;
-    'atlassian:fileSize'?: number | undefined;
-    'schema:commentCount'?: number | undefined;
-    'atlassian:isDeleted'?: boolean | undefined;
-    'atlassian:attachmentCount'?: number | undefined;
-    'atlassian:dateViewed'?: string | undefined;
-    'atlassian:checkItems'?: JsonLd.Primitives.CheckItemProgress | undefined;
-    'atlassian:reactCount'?: number | undefined;
-    'atlassian:state'?: string | JsonLd.Primitives.Object<any> | undefined;
-    'atlassian:viewCount'?: number | undefined;
-    'atlassian:voteCount'?: number | undefined;
-    '@context': JsonLd.Primitives.Context;
-    'atlassian:visitUrl'?: string | undefined;
-    'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
-    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | JsonLd.Primitives.Collection<JsonLd.Primitives.Link | JsonLd.Primitives.Person<any>> | undefined;
-    'schema:dateCreated'?: string | undefined;
-    '@id'?: string | undefined;
-    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
-        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    }> | undefined;
-    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    preview?: string | ((JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel) & JsonLd.Primitives.PreviewExtension) | undefined;
-    replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
-    content?: string | undefined;
-    contentMap?: Record<string, string> | undefined;
-    name?: string | undefined;
-    nameMap?: Record<string, string> | undefined;
-    duration?: string | undefined;
-    mediaType?: string | undefined;
-    endTime?: string | undefined;
-    published?: string | undefined;
-    startTime?: string | undefined;
-    summary?: string | undefined;
-    summaryMap?: Record<string, string> | undefined;
-    updated?: string | undefined;
-};
-export declare const TEST_DOCUMENT_WITH_VIEW_ACTION: {
-    'schema:potentialAction': import("schema-dts").ViewAction[];
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
-    'schema:fileFormat'?: string | undefined;
-    'atlassian:fileSize'?: number | undefined;
-    'schema:commentCount'?: number | undefined;
-    'atlassian:isDeleted'?: boolean | undefined;
-    'atlassian:attachmentCount'?: number | undefined;
-    'atlassian:dateViewed'?: string | undefined;
-    'atlassian:checkItems'?: JsonLd.Primitives.CheckItemProgress | undefined;
-    'atlassian:reactCount'?: number | undefined;
-    'atlassian:state'?: string | JsonLd.Primitives.Object<any> | undefined;
-    'atlassian:viewCount'?: number | undefined;
-    'atlassian:voteCount'?: number | undefined;
-    '@context': JsonLd.Primitives.Context;
-    'atlassian:downloadUrl'?: string | undefined;
-    'atlassian:visitUrl'?: string | undefined;
-    'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
-    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | JsonLd.Primitives.Collection<JsonLd.Primitives.Link | JsonLd.Primitives.Person<any>> | undefined;
-    'schema:dateCreated'?: string | undefined;
-    '@id'?: string | undefined;
-    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
-        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    }> | undefined;
-    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    preview?: string | ((JsonLd.Primitives.Object<any> | JsonLd.Primitives.LinkModel) & JsonLd.Primitives.PreviewExtension) | undefined;
-    replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
-    content?: string | undefined;
-    contentMap?: Record<string, string> | undefined;
-    name?: string | undefined;
-    nameMap?: Record<string, string> | undefined;
-    duration?: string | undefined;
-    mediaType?: string | undefined;
-    endTime?: string | undefined;
-    published?: string | undefined;
-    startTime?: string | undefined;
-    summary?: string | undefined;
-    summaryMap?: Record<string, string> | undefined;
-    updated?: string | undefined;
-};
+export declare const TEST_DOCUMENT_WITH_ACTIONS: JsonLd.Data.BaseData;
+export declare const TEST_DOCUMENT_WITH_DOWNLOAD_ACTION: JsonLd.Data.BaseData;
+export declare const TEST_DOCUMENT_WITH_VIEW_ACTION: JsonLd.Data.BaseData;
 export declare const PREVIEW: JsonLd.Data.BaseData['preview'];
-export declare const TEST_DOCUMENT_WITH_PREVIEW: {
-    preview: JsonLd.Primitives.LinkModel & JsonLd.Primitives.PreviewExtension;
-    '@type': "Collection" | "Document" | "schema:BlogPosting" | "schema:TextDigitalDocument" | "schema:DigitalDocument" | "schema:PresentationDigitalDocument" | "schema:SpreadsheetDigitalDocument" | "atlassian:UndefinedLink" | ("Object" | "Document")[] | (JsonLd.Data.DocumentChildType | JsonLd.Data.DocumentParentType)[] | ("Document" | "schema:DigitalDocument")[];
-    'schema:fileFormat'?: string | undefined;
-    'atlassian:fileSize'?: number | undefined;
-    'schema:commentCount'?: number | undefined;
-    'atlassian:isDeleted'?: boolean | undefined;
-    'schema:potentialAction'?: JsonLd.Primitives.Property<JsonLd.Data.DocumentAction> | undefined;
-    'atlassian:attachmentCount'?: number | undefined;
-    'atlassian:dateViewed'?: string | undefined;
-    'atlassian:checkItems'?: JsonLd.Primitives.CheckItemProgress | undefined;
-    'atlassian:reactCount'?: number | undefined;
-    'atlassian:state'?: string | JsonLd.Primitives.Object<any> | undefined;
-    'atlassian:viewCount'?: number | undefined;
-    'atlassian:voteCount'?: number | undefined;
-    '@context': JsonLd.Primitives.Context;
-    'atlassian:downloadUrl'?: string | undefined;
-    'atlassian:visitUrl'?: string | undefined;
-    'atlassian:titlePrefix'?: JsonLd.Data.TitlePrefix | undefined;
-    'atlassian:updatedBy'?: JsonLd.Primitives.Link | JsonLd.Primitives.Person<any> | JsonLd.Primitives.Collection<JsonLd.Primitives.Link | JsonLd.Primitives.Person<any>> | undefined;
-    'schema:dateCreated'?: string | undefined;
-    '@id'?: string | undefined;
-    attachment?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    attributedTo?: JsonLd.Primitives.Property<(JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link) & {
-        actor?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    }> | undefined;
-    audience?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bcc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    bto?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    cc?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    context?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    generator?: JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    icon?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    image?: JsonLd.Primitives.Link | JsonLd.Primitives.Image | undefined;
-    inReplyTo?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    location?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    oneOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    anyOf?: (JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link)[] | undefined;
-    closed?: boolean | JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link | undefined;
-    replies?: JsonLd.Primitives.Collection<any> | undefined;
-    tag?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    to?: JsonLd.Primitives.Property<JsonLd.Primitives.Object<any> | JsonLd.Primitives.Link> | undefined;
-    url?: JsonLd.Primitives.Property<JsonLd.Primitives.Link> | undefined;
-    content?: string | undefined;
-    contentMap?: Record<string, string> | undefined;
-    name?: string | undefined;
-    nameMap?: Record<string, string> | undefined;
-    duration?: string | undefined;
-    mediaType?: string | undefined;
-    endTime?: string | undefined;
-    published?: string | undefined;
-    startTime?: string | undefined;
-    summary?: string | undefined;
-    summaryMap?: Record<string, string> | undefined;
-    updated?: string | undefined;
-};
+export declare const TEST_DOCUMENT_WITH_PREVIEW: JsonLd.Data.BaseData;
 export declare const TEST_DATA_WITH_LATEST_COMMIT_OBJ: JsonLd.Data.SourceCodeRepository;
 export declare const TEST_DATA_WITH_LATEST_COMMIT_TEXT: JsonLd.Data.SourceCodeRepository;

package/dist/types/state/hooks/use-invoke/types.d.ts

@@ -6,6 +6,8 @@ export declare enum InvokeActionError {
 export declare type InvokeActions = {
     create?: InvokeRequest;
     read?: InvokeRequest;
-    update?: InvokeRequest;
+    update?: InvokeRequest & {
+        details?: Record<string, any>;
+    };
     delete?: InvokeRequest;
 };

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

@@ -0,0 +1,2 @@
+declare const useResolve: () => (url: string, isReloading?: any, isMetadataRequest?: any, id?: any) => Promise<void>;
+export default useResolve;

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

@@ -16,6 +16,7 @@ export declare const fireLinkClickedEvent: (createAnalyticsEvent: (payload: Anal
         clickType?: ClickType | undefined;
         clickOutcome?: ClickOutcome | undefined;
         keysHeld?: ("meta" | "alt" | "shift" | "ctrl" | undefined)[] | undefined;
+        defaultPrevented?: boolean | undefined;
     } | undefined;
 } | undefined) => void;
 export {};

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

@@ -106,7 +106,7 @@ export declare type InstrumentEventProps = CommonEventProps & {
     id: string;
 };
 export declare type ClickType = 'left' | 'middle' | 'right' | 'none';
-export declare type ClickOutcome = 'prevented' | 'clickThrough' | 'clickThroughNewTabOrWindow' | 'contextMenu' | 'alt' | 'contentEditable' | '_unknown';
+export declare type ClickOutcome = 'prevented' | 'clickThrough' | 'clickThroughNewTabOrWindow' | 'contextMenu' | 'alt' | 'contentEditable' | 'unknown';
 export declare type UiLinkClickedEventProps = {
     /**
      * Whether the click occurred with the left, middle or right mouse button
@@ -114,10 +114,16 @@ export declare type UiLinkClickedEventProps = {
     clickType: ClickType;
     /**
      * The user outcome for clicking the link as far as can be reasonably be determined
+     * This ignores any programmatic cancellation of the outcome (ie e.preventDefault()) and
+     * thus this represents the user intent, not necessarily the actual outcome
      */
     clickOutcome: ClickOutcome;
     /**
      * The keys held by the user at the time of clicking the link (which influence `clickOutcome`)
      */
     keysHeld: ('alt' | 'ctrl' | 'meta' | 'shift')[];
+    /**
+     * Whether the browser's default behaviour was prevented programmatically
+     */
+    defaultPrevented: boolean;
 };