@atlaskit/editor-plugin-card 0.3.4 → 0.3.6

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

@@ -1,160 +0,0 @@
-import { isLinkMark } from '@atlaskit/editor-common/utils';
-import { appearanceForNodeType } from '../../utils';
-/**
- * Whether a node is a "link" node, ie inline card, block card, embed card
- * (but not a text node with a link mark)
- */
-export function isLinkNode(node) {
-  return !!appearanceForNodeType(node.type);
-}
-
-/**
- * Analytics appearance for link object
- */
-export function appearanceForLink(link) {
-  if (link.type === 'node') {
-    const appearance = appearanceForNodeType(link.node.type);
-    if (appearance) {
-      return appearance;
-    }
-  }
-  return 'url';
-}
-const nodeHasLinkMark = (schema, node) => {
-  if (node.marks) {
-    for (let i = 0; i < node.marks.length; i++) {
-      const mark = node.marks[i];
-      if (isLinkMark(mark, schema)) {
-        return true;
-      }
-    }
-  }
-  return false;
-};
-
-/**
- * Determine if a node is considered to be a link
- */
-export const 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"
- */
-export function findLinksInNode(doc, schema, node, offset) {
-  const links = [];
-  node.descendants((node, pos) => {
-    const nodeContext = getLinkNodeContext(doc, pos);
-
-    // Nodes
-    if (isLinkNode(node)) {
-      links.push({
-        type: 'node',
-        pos: pos + offset,
-        node,
-        nodeContext
-      });
-    }
-
-    // Marks
-    if (node.marks) {
-      for (let i = 0; i < node.marks.length; i++) {
-        const mark = node.marks[i];
-        if (isLinkMark(mark, schema)) {
-          links.push({
-            type: 'mark',
-            pos: pos + offset,
-            mark,
-            nodeContext
-          });
-        }
-      }
-    }
-  });
-  return links;
-}
-export 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;
-}
-export const getLinkNodeContext = (doc, pos) => {
-  const $pos = doc.resolve(pos);
-  const maxDepth = 3;
-  for (let i = 0; i <= maxDepth; i++) {
-    const node = $pos.node($pos.depth - i);
-    if (node && node.type.name !== 'paragraph') {
-      return node.type.name;
-    }
-  }
-  return 'unknown';
-};
-export const linkObjectFromNode = (doc, schema, node, pos) => {
-  const nodeContext = getLinkNodeContext(doc, pos);
-  if (isLinkNode(node)) {
-    return {
-      type: 'node',
-      pos,
-      node,
-      nodeContext
-    };
-  }
-  if (node.marks) {
-    for (let i = 0; i < node.marks.length; i++) {
-      const mark = node.marks[i];
-      if (isLinkMark(mark, schema)) {
-        return {
-          type: 'mark',
-          pos,
-          mark,
-          nodeContext
-        };
-      }
-    }
-  }
-};
-export const findLinksAtPositions = (tr, positions) => {
-  const schema = tr.doc.type.schema;
-  const links = [];
-  for (let i = 0; i < positions.length; i++) {
-    const pos = positions[i];
-    const node = tr.doc.nodeAt(pos);
-    if (!node) {
-      continue;
-    }
-    const 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
- */
-export const areSameLinks = (linksA, linksB) => {
-  if (linksA.length !== linksB.length) {
-    return false;
-  }
-  for (let i = 0; i < linksA.length; i++) {
-    const linkA = linksA[i];
-    const linkB = linksB[i];
-    if (getLinkUrl(linkA) !== getLinkUrl(linkB) || appearanceForLink(linkA) !== appearanceForLink(linkB)) {
-      return false;
-    }
-  }
-  return true;
-};

package/dist/es2019/ui/EditorSmartCardEventsNext.js

@@ -1,188 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import React, { useEffect, useMemo } from 'react';
-import PropTypes from 'prop-types';
-import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { ACTION, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import { useSmartLinkLifecycleAnalytics } from '@atlaskit/link-analytics';
-import { registerSmartCardEventsNext } from '../pm-plugins/actions';
-import { EditorAnalyticsContext } from './EditorAnalyticsContext';
-/**
- * If the metadata is for a history event,
- * returns undo/redo instead of instead of what fn(metadata) would have otherwise
- * returned
- */
-const withHistoryMethod = fn => {
-  return metadata => {
-    const {
-      isUndo,
-      isRedo
-    } = metadata;
-    if (isUndo) {
-      return 'undo';
-    }
-    if (isRedo) {
-      return 'redo';
-    }
-    return fn(metadata);
-  };
-};
-const getMethod = withHistoryMethod(({
-  inputMethod
-}) => {
-  switch (inputMethod) {
-    case INPUT_METHOD.CLIPBOARD:
-      return 'editor_paste';
-    case INPUT_METHOD.FLOATING_TB:
-      return 'editor_floatingToolbar';
-    case INPUT_METHOD.AUTO_DETECT:
-    case INPUT_METHOD.FORMATTING:
-      return 'editor_type';
-    default:
-      return 'unknown';
-  }
-});
-const getUpdateType = withHistoryMethod(({
-  action
-}) => {
-  switch (action) {
-    case ACTION.CHANGED_TYPE:
-      return 'display_update';
-    case ACTION.UPDATED:
-      return 'link_update';
-    default:
-      return 'unknown';
-  }
-});
-const getDeleteType = withHistoryMethod(({
-  action
-}) => {
-  if (action === ACTION.UNLINK) {
-    return 'unlink';
-  }
-  return 'delete';
-});
-const getSourceEventFromMetadata = metadata => {
-  return metadata.sourceEvent instanceof UIAnalyticsEvent ? metadata.sourceEvent : null;
-};
-
-/**
- * Set display category as `link` if not displaying the link as a smart card
- */
-const displayCategoryFromDisplay = display => {
-  if (display === 'url') {
-    return 'link';
-  }
-};
-
-/**
- * Binds the @atlaskit/link-analytics callbacks
- * to the editor card plugin state events callbacks interfaces
- */
-export const EventsBinding = ({
-  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.
-   */
-  const {
-    linkCreated,
-    linkUpdated,
-    linkDeleted
-  } = useSmartLinkLifecycleAnalytics();
-  const events = useMemo(() => {
-    return {
-      created: metadata => {
-        const {
-          url,
-          display,
-          nodeContext
-        } = metadata;
-        const displayCategory = displayCategoryFromDisplay(display);
-        const sourceEvent = getSourceEventFromMetadata(metadata);
-        const creationMethod = getMethod(metadata);
-        linkCreated({
-          url,
-          displayCategory
-        }, sourceEvent, {
-          display,
-          nodeContext,
-          creationMethod
-        });
-      },
-      updated: metadata => {
-        const {
-          url,
-          display,
-          previousDisplay,
-          nodeContext
-        } = metadata;
-        const displayCategory = displayCategoryFromDisplay(display);
-        const sourceEvent = getSourceEventFromMetadata(metadata);
-        const updateMethod = getMethod(metadata);
-        const updateType = getUpdateType(metadata);
-        linkUpdated({
-          url,
-          displayCategory
-        }, sourceEvent, {
-          display,
-          previousDisplay,
-          nodeContext,
-          updateMethod,
-          updateType
-        });
-      },
-      deleted: metadata => {
-        const {
-          url,
-          display,
-          nodeContext
-        } = metadata;
-        const displayCategory = displayCategoryFromDisplay(display);
-        const sourceEvent = getSourceEventFromMetadata(metadata);
-        const deleteMethod = getMethod(metadata);
-        const deleteType = getDeleteType(metadata);
-        linkDeleted({
-          url,
-          displayCategory
-        }, sourceEvent, {
-          display,
-          nodeContext,
-          deleteMethod,
-          deleteType
-        });
-      }
-    };
-  }, [linkCreated, linkUpdated, linkDeleted]);
-  useEffect(() => {
-    editorView.dispatch(registerSmartCardEventsNext(events)(editorView.state.tr));
-  }, [events, editorView]);
-  return null;
-};
-
-// eslint-disable-next-line @repo/internal/react/no-class-components
-export class EditorSmartCardEventsNext extends React.PureComponent {
-  render() {
-    const 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.createElement(cardContext.Provider, {
-      value: cardContext.value
-    }, /*#__PURE__*/React.createElement(EditorAnalyticsContext, {
-      editorView: this.props.editorView
-    }, /*#__PURE__*/React.createElement(EventsBinding, this.props)));
-  }
-}
-_defineProperty(EditorSmartCardEventsNext, "contextTypes", {
-  contextAdapter: PropTypes.object
-});

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

@@ -1,41 +0,0 @@
-/**
- * Simple mechanism to defer analytics related callbacks
- */
-export 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
-  };
-};

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

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

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

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

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

@@ -1,160 +0,0 @@
-import { isLinkMark } from '@atlaskit/editor-common/utils';
-import { appearanceForNodeType } from '../../utils';
-/**
- * Whether a node is a "link" node, ie inline card, block card, embed card
- * (but not a text node with a link mark)
- */
-export function isLinkNode(node) {
-  return !!appearanceForNodeType(node.type);
-}
-
-/**
- * Analytics appearance for link object
- */
-export function appearanceForLink(link) {
-  if (link.type === 'node') {
-    var appearance = 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 (isLinkMark(mark, schema)) {
-        return true;
-      }
-    }
-  }
-  return false;
-};
-
-/**
- * Determine if a node is considered to be a link
- */
-export 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"
- */
-export 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 (isLinkMark(mark, schema)) {
-          links.push({
-            type: 'mark',
-            pos: pos + offset,
-            mark: mark,
-            nodeContext: nodeContext
-          });
-        }
-      }
-    }
-  });
-  return links;
-}
-export 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;
-}
-export 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';
-};
-export 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 (isLinkMark(mark, schema)) {
-        return {
-          type: 'mark',
-          pos: pos,
-          mark: mark,
-          nodeContext: nodeContext
-        };
-      }
-    }
-  }
-};
-export 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
- */
-export 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;
-};