@atlaskit/editor-plugin-card 0.3.4 → 0.3.6

package/tmp/api-report-tmp.d.ts

@@ -20,6 +20,7 @@ import type { gridPlugin } from '@atlaskit/editor-plugin-grid';
 import type { hyperlinkPlugin } from '@atlaskit/editor-plugin-hyperlink';
 import type { LinkPickerOptions } from '@atlaskit/editor-common/types';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
 import type { OptionalPlugin } from '@atlaskit/editor-common/types';
 import { SmartLinkEvents } from '@atlaskit/smart-card';
 import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
@@ -48,12 +49,16 @@ export const cardPlugin: NextEditorPlugin<'card', {
     actions: CardPluginActions;
 }>;
 
+// @public (undocumented)
+type CardPluginEvent = DatasourceEvent | LinkEvent;
+
 // @public (undocumented)
 type CardPluginOptions = CardOptions & {
     editorAppearance?: EditorAppearance;
     platform: 'mobile' | 'web';
     fullWidthMode?: boolean;
     linkPicker?: LinkPickerOptions;
+    cardPluginEvents?: EditorCardPluginEvents<CardPluginEvent>;
 };
 
 // @public (undocumented)
@@ -63,7 +68,6 @@ type CardPluginState = {
     cards: CardInfo[];
     showLinkingToolbar: boolean;
     smartLinkEvents?: SmartLinkEvents;
-    smartLinkEventsNext?: SmartLinkEventsNext;
     editorAppearance?: EditorAppearance;
     showDatasourceModal: boolean;
     datasourceModalType?: DatasourceModalType;
@@ -71,13 +75,86 @@ type CardPluginState = {
     layout?: DatasourceTableLayout;
 };
 
+// @public (undocumented)
+type DatasourceCreatedEvent = {
+    event: EVENT.CREATED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type DatasourceDeletedEvent = {
+    event: EVENT.DELETED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type DatasourceEvent = DatasourceCreatedEvent | DatasourceDeletedEvent | DatasourceUpdatedEvent;
+
 // @public (undocumented)
 type DatasourceTableLayout = 'center' | 'full-width' | 'wide';
 
+// @public (undocumented)
+type DatasourceUpdatedEvent = {
+    event: EVENT.UPDATED;
+    subject: EVENT_SUBJECT.DATASOURCE;
+    data: Metadata_2<UpdateMetadata>;
+};
+
+// @public (undocumented)
+type EditorCardPluginEvents<T> = {
+    push: (...events: T[]) => void;
+    subscribe: (listener: Subscriber<T>) => () => void;
+    flush: () => void;
+    getSize: () => number;
+};
+
+// @public (undocumented)
+enum EVENT {
+    // (undocumented)
+    CREATED = "created",
+    // (undocumented)
+    DELETED = "deleted",
+    // (undocumented)
+    UPDATED = "updated"
+}
+
+// @public (undocumented)
+enum EVENT_SUBJECT {
+    // (undocumented)
+    DATASOURCE = "datasource",
+    // (undocumented)
+    LINK = "link"
+}
+
+// @public
+type LinkCreatedEvent = {
+    event: EVENT.CREATED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type LinkDeletedEvent = {
+    event: EVENT.DELETED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2;
+};
+
+// @public (undocumented)
+type LinkEvent = LinkCreatedEvent | LinkDeletedEvent | LinkUpdatedEvent;
+
+// @public (undocumented)
+type LinkUpdatedEvent = {
+    event: EVENT.UPDATED;
+    subject: EVENT_SUBJECT.LINK;
+    data: Metadata_2<UpdateMetadata>;
+};
+
 // @public (undocumented)
 type Metadata_2<T = {}> = {
-    url: string;
-    display: string;
+    node: Node_2;
     isUndo?: boolean;
     isRedo?: boolean;
     action?: string;
@@ -101,11 +178,7 @@ type Request_2 = {
 export { Request_2 as Request }
 
 // @public (undocumented)
-type SmartLinkEventsNext = {
-    created: (metadata: Metadata_2) => void;
-    updated: (metadata: Metadata_2<UpdateMetadata>) => void;
-    deleted: (metadata: Metadata_2) => void;
-};
+type Subscriber<T> = (event: T) => void;
 
 // @public (undocumented)
 type UpdateMetadata = {

package/dist/cjs/pm-plugins/analytics/create-analytics-queue.js

@@ -1,48 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createAnalyticsQueue = void 0;
-/**
- * Simple mechanism to defer analytics related callbacks
- */
-var createAnalyticsQueue = function createAnalyticsQueue() {
-  var enabled = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-  var queue = [];
-  var callbacksRef = {
-    current: null
-  };
-  var setCallbacks = function setCallbacks(callbacks) {
-    callbacksRef.current = callbacks;
-  };
-  var push = function push() {
-    var callbacks = callbacksRef.current;
-    if (!enabled || !callbacks) {
-      return;
-    }
-    queue.push.apply(queue, arguments);
-  };
-  var flush = function flush() {
-    var callbacks = callbacksRef.current;
-    if (!enabled || !callbacks) {
-      return;
-    }
-    while (queue.length) {
-      var event = queue.pop();
-      if (event) {
-        callbacks[event.type](event.data);
-      }
-    }
-  };
-  var getSize = function getSize() {
-    return queue.length;
-  };
-  return {
-    push: push,
-    flush: flush,
-    setCallbacks: setCallbacks,
-    getSize: getSize
-  };
-};
-exports.createAnalyticsQueue = createAnalyticsQueue;

package/dist/cjs/pm-plugins/analytics/types.js

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

package/dist/cjs/pm-plugins/analytics/utils.js

@@ -1,178 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.appearanceForLink = appearanceForLink;
-exports.findLinksAtPositions = exports.areSameLinks = void 0;
-exports.findLinksInNode = findLinksInNode;
-exports.getLinkNodeContext = void 0;
-exports.getLinkUrl = getLinkUrl;
-exports.isLink = void 0;
-exports.isLinkNode = isLinkNode;
-exports.linkObjectFromNode = void 0;
-var _utils = require("@atlaskit/editor-common/utils");
-var _utils2 = require("../../utils");
-/**
- * Whether a node is a "link" node, ie inline card, block card, embed card
- * (but not a text node with a link mark)
- */
-function isLinkNode(node) {
-  return !!(0, _utils2.appearanceForNodeType)(node.type);
-}
-
-/**
- * Analytics appearance for link object
- */
-function appearanceForLink(link) {
-  if (link.type === 'node') {
-    var appearance = (0, _utils2.appearanceForNodeType)(link.node.type);
-    if (appearance) {
-      return appearance;
-    }
-  }
-  return 'url';
-}
-var nodeHasLinkMark = function nodeHasLinkMark(schema, node) {
-  if (node.marks) {
-    for (var i = 0; i < node.marks.length; i++) {
-      var mark = node.marks[i];
-      if ((0, _utils.isLinkMark)(mark, schema)) {
-        return true;
-      }
-    }
-  }
-  return false;
-};
-
-/**
- * Determine if a node is considered to be a link
- */
-var isLink = function isLink(schema, node) {
-  if (isLinkNode(node)) {
-    return true;
-  }
-  return nodeHasLinkMark(schema, node);
-};
-
-/**
- * Given a node, find all nodes and marks that are considered "links"
- * @param state EditorState
- * @param fragment Fragment to search
- * @returns Array of nodes and marks found in the fragment that are "links"
- */
-exports.isLink = isLink;
-function findLinksInNode(doc, schema, node, offset) {
-  var links = [];
-  node.descendants(function (node, pos) {
-    var nodeContext = getLinkNodeContext(doc, pos);
-
-    // Nodes
-    if (isLinkNode(node)) {
-      links.push({
-        type: 'node',
-        pos: pos + offset,
-        node: node,
-        nodeContext: nodeContext
-      });
-    }
-
-    // Marks
-    if (node.marks) {
-      for (var i = 0; i < node.marks.length; i++) {
-        var mark = node.marks[i];
-        if ((0, _utils.isLinkMark)(mark, schema)) {
-          links.push({
-            type: 'mark',
-            pos: pos + offset,
-            mark: mark,
-            nodeContext: nodeContext
-          });
-        }
-      }
-    }
-  });
-  return links;
-}
-function getLinkUrl(link) {
-  var _link$mark$attrs;
-  if (link.type === 'node') {
-    var _link$node$attrs;
-    return (_link$node$attrs = link.node.attrs) === null || _link$node$attrs === void 0 ? void 0 : _link$node$attrs.url;
-  }
-  return (_link$mark$attrs = link.mark.attrs) === null || _link$mark$attrs === void 0 ? void 0 : _link$mark$attrs.href;
-}
-var getLinkNodeContext = function getLinkNodeContext(doc, pos) {
-  var $pos = doc.resolve(pos);
-  var maxDepth = 3;
-  for (var i = 0; i <= maxDepth; i++) {
-    var node = $pos.node($pos.depth - i);
-    if (node && node.type.name !== 'paragraph') {
-      return node.type.name;
-    }
-  }
-  return 'unknown';
-};
-exports.getLinkNodeContext = getLinkNodeContext;
-var linkObjectFromNode = function linkObjectFromNode(doc, schema, node, pos) {
-  var nodeContext = getLinkNodeContext(doc, pos);
-  if (isLinkNode(node)) {
-    return {
-      type: 'node',
-      pos: pos,
-      node: node,
-      nodeContext: nodeContext
-    };
-  }
-  if (node.marks) {
-    for (var i = 0; i < node.marks.length; i++) {
-      var mark = node.marks[i];
-      if ((0, _utils.isLinkMark)(mark, schema)) {
-        return {
-          type: 'mark',
-          pos: pos,
-          mark: mark,
-          nodeContext: nodeContext
-        };
-      }
-    }
-  }
-};
-exports.linkObjectFromNode = linkObjectFromNode;
-var findLinksAtPositions = function findLinksAtPositions(tr, positions) {
-  var schema = tr.doc.type.schema;
-  var links = [];
-  for (var i = 0; i < positions.length; i++) {
-    var pos = positions[i];
-    var node = tr.doc.nodeAt(pos);
-    if (!node) {
-      continue;
-    }
-    var link = linkObjectFromNode(tr.doc, schema, node, pos);
-    if (!link) {
-      continue;
-    }
-    links.push(link);
-  }
-  return links;
-};
-
-/**
- * Returns whether or not two sets of links appear to likely be the same set of links
- * That they are in the same order and that both their hrefs and appearances match
- */
-exports.findLinksAtPositions = findLinksAtPositions;
-var areSameLinks = function areSameLinks(linksA, linksB) {
-  if (linksA.length !== linksB.length) {
-    return false;
-  }
-  for (var i = 0; i < linksA.length; i++) {
-    var linkA = linksA[i];
-    var linkB = linksB[i];
-    if (getLinkUrl(linkA) !== getLinkUrl(linkB) || appearanceForLink(linkA) !== appearanceForLink(linkB)) {
-      return false;
-    }
-  }
-  return true;
-};
-exports.areSameLinks = areSameLinks;

package/dist/cjs/ui/EditorSmartCardEventsNext.js

@@ -1,204 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-var _typeof = require("@babel/runtime/helpers/typeof");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.EventsBinding = exports.EditorSmartCardEventsNext = void 0;
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
-var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
-var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _react = _interopRequireWildcard(require("react"));
-var _propTypes = _interopRequireDefault(require("prop-types"));
-var _analyticsNext = require("@atlaskit/analytics-next");
-var _analytics = require("@atlaskit/editor-common/analytics");
-var _linkAnalytics = require("@atlaskit/link-analytics");
-var _actions = require("../pm-plugins/actions");
-var _EditorAnalyticsContext = require("./EditorAnalyticsContext");
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-/**
- * If the metadata is for a history event,
- * returns undo/redo instead of instead of what fn(metadata) would have otherwise
- * returned
- */
-var withHistoryMethod = function withHistoryMethod(fn) {
-  return function (metadata) {
-    var isUndo = metadata.isUndo,
-      isRedo = metadata.isRedo;
-    if (isUndo) {
-      return 'undo';
-    }
-    if (isRedo) {
-      return 'redo';
-    }
-    return fn(metadata);
-  };
-};
-var getMethod = withHistoryMethod(function (_ref) {
-  var inputMethod = _ref.inputMethod;
-  switch (inputMethod) {
-    case _analytics.INPUT_METHOD.CLIPBOARD:
-      return 'editor_paste';
-    case _analytics.INPUT_METHOD.FLOATING_TB:
-      return 'editor_floatingToolbar';
-    case _analytics.INPUT_METHOD.AUTO_DETECT:
-    case _analytics.INPUT_METHOD.FORMATTING:
-      return 'editor_type';
-    default:
-      return 'unknown';
-  }
-});
-var getUpdateType = withHistoryMethod(function (_ref2) {
-  var action = _ref2.action;
-  switch (action) {
-    case _analytics.ACTION.CHANGED_TYPE:
-      return 'display_update';
-    case _analytics.ACTION.UPDATED:
-      return 'link_update';
-    default:
-      return 'unknown';
-  }
-});
-var getDeleteType = withHistoryMethod(function (_ref3) {
-  var action = _ref3.action;
-  if (action === _analytics.ACTION.UNLINK) {
-    return 'unlink';
-  }
-  return 'delete';
-});
-var getSourceEventFromMetadata = function getSourceEventFromMetadata(metadata) {
-  return metadata.sourceEvent instanceof _analyticsNext.UIAnalyticsEvent ? metadata.sourceEvent : null;
-};
-
-/**
- * Set display category as `link` if not displaying the link as a smart card
- */
-var displayCategoryFromDisplay = function displayCategoryFromDisplay(display) {
-  if (display === 'url') {
-    return 'link';
-  }
-};
-
-/**
- * Binds the @atlaskit/link-analytics callbacks
- * to the editor card plugin state events callbacks interfaces
- */
-var EventsBinding = function EventsBinding(_ref4) {
-  var editorView = _ref4.editorView;
-  /**
-   * These callbacks internally use window.requestIdleCallback/requestAnimationFrame
-   * to defer any heavy operations involving network
-   *
-   * The callbacks themselves should not be deferred, they should be called syncronously the moment
-   * the events take place.
-   */
-  var _useSmartLinkLifecycl = (0, _linkAnalytics.useSmartLinkLifecycleAnalytics)(),
-    linkCreated = _useSmartLinkLifecycl.linkCreated,
-    linkUpdated = _useSmartLinkLifecycl.linkUpdated,
-    linkDeleted = _useSmartLinkLifecycl.linkDeleted;
-  var events = (0, _react.useMemo)(function () {
-    return {
-      created: function created(metadata) {
-        var url = metadata.url,
-          display = metadata.display,
-          nodeContext = metadata.nodeContext;
-        var displayCategory = displayCategoryFromDisplay(display);
-        var sourceEvent = getSourceEventFromMetadata(metadata);
-        var creationMethod = getMethod(metadata);
-        linkCreated({
-          url: url,
-          displayCategory: displayCategory
-        }, sourceEvent, {
-          display: display,
-          nodeContext: nodeContext,
-          creationMethod: creationMethod
-        });
-      },
-      updated: function updated(metadata) {
-        var url = metadata.url,
-          display = metadata.display,
-          previousDisplay = metadata.previousDisplay,
-          nodeContext = metadata.nodeContext;
-        var displayCategory = displayCategoryFromDisplay(display);
-        var sourceEvent = getSourceEventFromMetadata(metadata);
-        var updateMethod = getMethod(metadata);
-        var updateType = getUpdateType(metadata);
-        linkUpdated({
-          url: url,
-          displayCategory: displayCategory
-        }, sourceEvent, {
-          display: display,
-          previousDisplay: previousDisplay,
-          nodeContext: nodeContext,
-          updateMethod: updateMethod,
-          updateType: updateType
-        });
-      },
-      deleted: function deleted(metadata) {
-        var url = metadata.url,
-          display = metadata.display,
-          nodeContext = metadata.nodeContext;
-        var displayCategory = displayCategoryFromDisplay(display);
-        var sourceEvent = getSourceEventFromMetadata(metadata);
-        var deleteMethod = getMethod(metadata);
-        var deleteType = getDeleteType(metadata);
-        linkDeleted({
-          url: url,
-          displayCategory: displayCategory
-        }, sourceEvent, {
-          display: display,
-          nodeContext: nodeContext,
-          deleteMethod: deleteMethod,
-          deleteType: deleteType
-        });
-      }
-    };
-  }, [linkCreated, linkUpdated, linkDeleted]);
-  (0, _react.useEffect)(function () {
-    editorView.dispatch((0, _actions.registerSmartCardEventsNext)(events)(editorView.state.tr));
-  }, [events, editorView]);
-  return null;
-};
-
-// eslint-disable-next-line @repo/internal/react/no-class-components
-exports.EventsBinding = EventsBinding;
-var EditorSmartCardEventsNext = /*#__PURE__*/function (_React$PureComponent) {
-  (0, _inherits2.default)(EditorSmartCardEventsNext, _React$PureComponent);
-  var _super = _createSuper(EditorSmartCardEventsNext);
-  function EditorSmartCardEventsNext() {
-    (0, _classCallCheck2.default)(this, EditorSmartCardEventsNext);
-    return _super.apply(this, arguments);
-  }
-  (0, _createClass2.default)(EditorSmartCardEventsNext, [{
-    key: "render",
-    value: function render() {
-      var cardContext = this.context.contextAdapter.card;
-
-      /**
-       * The analytics hook needs to be able to communicate with the card context
-       * If we can't access it, don't mount the event bindings
-       * This effectively entirely disables all tracking behaviour
-       */
-      if (!cardContext) {
-        return null;
-      }
-      return /*#__PURE__*/_react.default.createElement(cardContext.Provider, {
-        value: cardContext.value
-      }, /*#__PURE__*/_react.default.createElement(_EditorAnalyticsContext.EditorAnalyticsContext, {
-        editorView: this.props.editorView
-      }, /*#__PURE__*/_react.default.createElement(EventsBinding, this.props)));
-    }
-  }]);
-  return EditorSmartCardEventsNext;
-}(_react.default.PureComponent);
-exports.EditorSmartCardEventsNext = EditorSmartCardEventsNext;
-(0, _defineProperty2.default)(EditorSmartCardEventsNext, "contextTypes", {
-  contextAdapter: _propTypes.default.object
-});

package/dist/es2019/pm-plugins/analytics/create-analytics-queue.js

@@ -1,38 +0,0 @@
-/**
- * Simple mechanism to defer analytics related callbacks
- */
-export const createAnalyticsQueue = (enabled = true) => {
-  const queue = [];
-  const callbacksRef = {
-    current: null
-  };
-  const setCallbacks = callbacks => {
-    callbacksRef.current = callbacks;
-  };
-  const push = (...events) => {
-    const callbacks = callbacksRef.current;
-    if (!enabled || !callbacks) {
-      return;
-    }
-    queue.push(...events);
-  };
-  const flush = () => {
-    const callbacks = callbacksRef.current;
-    if (!enabled || !callbacks) {
-      return;
-    }
-    while (queue.length) {
-      const event = queue.pop();
-      if (event) {
-        callbacks[event.type](event.data);
-      }
-    }
-  };
-  const getSize = () => queue.length;
-  return {
-    push,
-    flush,
-    setCallbacks,
-    getSize
-  };
-};

package/dist/es2019/pm-plugins/analytics/index.js

@@ -1,2 +0,0 @@
-export { createAnalyticsQueue } from './create-analytics-queue';
-export { eventsFromTransaction } from './events-from-tr';

package/dist/es2019/pm-plugins/analytics/types.js

@@ -1 +0,0 @@
-export {};