@atlaskit/pragmatic-drag-and-drop 0.17.0

package/dist/cjs/ledger/dispatch-consumer-event.js

@@ -0,0 +1,132 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeDispatch = makeDispatch;
+var _rafSchd = _interopRequireDefault(require("raf-schd"));
+var scheduleOnDrag = (0, _rafSchd.default)(function (fn) {
+  return fn();
+});
+var dragStart = function () {
+  var scheduled = null;
+  function schedule(fn) {
+    var frameId = requestAnimationFrame(function () {
+      scheduled = null;
+      fn();
+    });
+    scheduled = {
+      frameId: frameId,
+      fn: fn
+    };
+  }
+  function flush() {
+    if (scheduled) {
+      cancelAnimationFrame(scheduled.frameId);
+      scheduled.fn();
+      scheduled = null;
+    }
+  }
+  return {
+    schedule: schedule,
+    flush: flush
+  };
+}();
+function makeDispatch(_ref) {
+  var source = _ref.source,
+    initial = _ref.initial,
+    dispatchEvent = _ref.dispatchEvent;
+  var previous = {
+    dropTargets: []
+  };
+  function safeDispatch(args) {
+    dispatchEvent(args);
+    previous = {
+      dropTargets: args.payload.location.current.dropTargets
+    };
+  }
+  var dispatch = {
+    start: function start(_ref2) {
+      var nativeSetDragImage = _ref2.nativeSetDragImage;
+      // Ensuring that both `onGenerateDragPreview` and `onDragStart` get the same location.
+      // We do this so that `previous` is`[]` in `onDragStart` (which is logical)
+      var location = {
+        current: initial,
+        previous: previous,
+        initial: initial
+      };
+      // a `onGenerateDragPreview` does _not_ add another entry for `previous`
+      // onDragPreview
+      safeDispatch({
+        eventName: 'onGenerateDragPreview',
+        payload: {
+          source: source,
+          location: location,
+          nativeSetDragImage: nativeSetDragImage
+        }
+      });
+      dragStart.schedule(function () {
+        safeDispatch({
+          eventName: 'onDragStart',
+          payload: {
+            source: source,
+            location: location
+          }
+        });
+      });
+    },
+    dragUpdate: function dragUpdate(_ref3) {
+      var current = _ref3.current;
+      dragStart.flush();
+      scheduleOnDrag.cancel();
+      safeDispatch({
+        eventName: 'onDropTargetChange',
+        payload: {
+          source: source,
+          location: {
+            initial: initial,
+            previous: previous,
+            current: current
+          }
+        }
+      });
+    },
+    drag: function drag(_ref4) {
+      var current = _ref4.current;
+      scheduleOnDrag(function () {
+        dragStart.flush();
+        var location = {
+          initial: initial,
+          previous: previous,
+          current: current
+        };
+        safeDispatch({
+          eventName: 'onDrag',
+          payload: {
+            source: source,
+            location: location
+          }
+        });
+      });
+    },
+    drop: function drop(_ref5) {
+      var current = _ref5.current,
+        updatedSourcePayload = _ref5.updatedExternalPayload;
+      dragStart.flush();
+      scheduleOnDrag.cancel();
+      safeDispatch({
+        eventName: 'onDrop',
+        payload: {
+          source: updatedSourcePayload !== null && updatedSourcePayload !== void 0 ? updatedSourcePayload : source,
+          location: {
+            current: current,
+            previous: previous,
+            initial: initial
+          }
+        }
+      });
+    }
+  };
+  return dispatch;
+}

package/dist/cjs/ledger/lifecycle-manager.js

@@ -0,0 +1,335 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.lifecycle = void 0;
+var _bindEventListener = require("bind-event-listener");
+var _enteringAndLeavingTheWindow = require("../util/entering-and-leaving-the-window");
+var _fixPostDragPointerBug = require("../util/fix-post-drag-pointer-bug");
+var _getInput = require("../util/get-input");
+var _dispatchConsumerEvent = require("./dispatch-consumer-event");
+var isActive = false;
+function canStart() {
+  return !isActive;
+}
+function getNativeSetDragImage(event) {
+  if (event.dataTransfer) {
+    // need to use `.bind` as `setDragImage` is required
+    // to be run with `event.dataTransfer` as the "this" context
+    return event.dataTransfer.setDragImage.bind(event.dataTransfer);
+  }
+  return null;
+}
+function hasHierarchyChanged(_ref) {
+  var current = _ref.current,
+    next = _ref.next;
+  if (current.length !== next.length) {
+    return true;
+  }
+  // not checking stickiness, data or dropEffect,
+  // just whether the hierarchy has changed
+  for (var i = 0; i < current.length; i++) {
+    if (current[i].element !== next[i].element) {
+      return true;
+    }
+  }
+  return false;
+}
+function start(_ref2) {
+  var event = _ref2.event,
+    dragInterface = _ref2.dragInterface,
+    getDropTargetsOver = _ref2.getDropTargetsOver,
+    dispatchEvent = _ref2.dispatchEvent;
+  if (!canStart()) {
+    return;
+  }
+  isActive = true;
+  var initial = getStartLocation({
+    event: event,
+    dragInterface: dragInterface,
+    getDropTargetsOver: getDropTargetsOver
+  });
+  var current = initial;
+  // Setting initial drop effect for the drag
+  setDropEffect({
+    event: event,
+    current: initial.dropTargets
+  });
+  var dispatch = (0, _dispatchConsumerEvent.makeDispatch)({
+    source: dragInterface.payload,
+    dispatchEvent: dispatchEvent,
+    initial: initial
+  });
+  function updateDropTargets(next) {
+    // only looking at whether hierarchy has changed to determine whether something as 'changed'
+    var hasChanged = hasHierarchyChanged({
+      current: current.dropTargets,
+      next: next.dropTargets
+    });
+
+    // Always updating the state to include latest data, dropEffect and stickiness
+    // Only updating consumers if the hierarchy has changed in some way
+    // Consumers can get the latest data by using `onDrag`
+    current = next;
+    if (hasChanged) {
+      dispatch.dragUpdate({
+        current: current
+      });
+    }
+  }
+  function onUpdateEvent(event) {
+    var input = (0, _getInput.getInput)(event);
+    var nextDropTargets = getDropTargetsOver({
+      target: event.target,
+      input: input,
+      source: dragInterface.payload,
+      current: current.dropTargets
+    });
+    if (nextDropTargets.length) {
+      // 🩸 must call `event.preventDefault()` to allow a browser drop to occur
+      event.preventDefault();
+      setDropEffect({
+        event: event,
+        current: nextDropTargets
+      });
+    }
+    updateDropTargets({
+      dropTargets: nextDropTargets,
+      input: input
+    });
+  }
+  function onDrop(_ref3) {
+    var updatedExternalPayload = _ref3.updatedExternalPayload;
+    dispatch.drop({
+      current: current,
+      updatedExternalPayload: updatedExternalPayload
+    });
+  }
+  function cancel() {
+    // The spec behaviour is that when a drag is cancelled, or when dropping on no drop targets,
+    // a "dragleave" event is fired on the active drop target before a "dragend" event.
+    // We are replicating that behaviour in `cancel` if there are any active drop targets to
+    // ensure consistent behaviour.
+    //
+    // Note: When cancelling, or dropping on no drop targets, a "dragleave" event
+    // will have already cleared the dropTargets to `[]` (as that particular "dragleave" has a `relatedTarget` of `null`)
+
+    if (current.dropTargets.length) {
+      updateDropTargets({
+        dropTargets: [],
+        input: current.input
+      });
+    }
+    onDrop({
+      updatedExternalPayload: null
+    });
+    finish();
+  }
+  function finish() {
+    isActive = false;
+    unbindEvents();
+  }
+  var unbindEvents = (0, _bindEventListener.bindAll)(window, [{
+    // 👋 Note: we are repurposing the `dragover` event as our `drag` event
+    // this is because firefox does not publish pointer coordinates during
+    // a `drag` event, but does for every other type of drag event
+    // `dragover` fires on all elements that are being dragged over
+    // Because we are binding to `window` - our `dragover` is effectively the same as a `drag`
+    // 🦊😤
+    type: 'dragover',
+    listener: function listener(event) {
+      // We need to regularly calculate the drop targets in order to allow:
+      //  - dynamic `canDrop()` checks
+      //  - rapid updating `getData()` calls to attach data in response to user input (eg for edge detection)
+      // Sadly we cannot schedule inspecting changes resulting from this event
+      // we need to be able to conditionally cancel the event with `event.preventDefault()`
+      // to enable the correct native drop experience.
+
+      // 1. check to see if anything has changed
+      onUpdateEvent(event);
+
+      // 2. let consumers know a move has occurred
+      // This will include the latest 'input' values
+      dispatch.drag({
+        current: current
+      });
+    }
+  }, {
+    type: 'dragenter',
+    listener: onUpdateEvent
+  }, {
+    // This was the only reliable cross browser way I found to detect
+    // when the user is leaving the `window`.
+    // Internal drags: when we leave the `window` we want to clear any active drop targets,
+    // but the drag is not yet over. The user could drag back into the window.
+    // We only need to do this because of stickiness
+    // External drags: when we leave the `window` the drag operation is over,
+    // we will start another drag operation
+    type: 'dragleave',
+    listener: function listener(event) {
+      if (!(0, _enteringAndLeavingTheWindow.isLeavingWindow)({
+        dragLeave: event
+      })) {
+        return;
+      }
+      // When a drag is ending without a drop target (or when the drag is cancelled),
+      // All browsers fire:
+      // 1. "drag"
+      // 2. "dragleave"
+      // These events have `event.relatedTarget == null` so this code path is also hit in those cases.
+      // This is all good! We would be clearing the dropTargets in `cancel()` after the "dragend"
+
+      // 🐛 Bug workaround: intentionally not updating `input` in "dragleave"
+      // In Chrome, this final "dragleave" has default input values (eg clientX == 0)
+      // rather than the users current input values
+      //
+      // - [Conversation](https://twitter.com/alexandereardon/status/1642697633864241152)
+      // - [Bug](https://bugs.chromium.org/p/chromium/issues/detail?id=1429937)
+      updateDropTargets({
+        input: current.input,
+        dropTargets: []
+      });
+      if (dragInterface.startedFrom === 'external') {
+        cancel();
+      }
+    }
+  }, {
+    type: 'drop',
+    listener: function listener(event) {
+      var _dragInterface$getDro;
+      // A "drop" can only happen if the browser allowed the drop
+
+      // Opting out of standard browser drop behaviour for the drag
+      event.preventDefault();
+
+      // applying the latest drop effect to the event
+      setDropEffect({
+        event: event,
+        current: current.dropTargets
+      });
+      onDrop({
+        updatedExternalPayload: dragInterface.startedFrom === 'external' ? ((_dragInterface$getDro = dragInterface.getDropPayload) === null || _dragInterface$getDro === void 0 ? void 0 : _dragInterface$getDro.call(dragInterface, event)) || null : null
+      });
+      finish();
+
+      // Applying this fix after `dispatch.drop` so that frameworks have the opportunity
+      // to update UI in response to a "onDrop".
+      if (dragInterface.startedFrom === 'internal') {
+        (0, _fixPostDragPointerBug.fixPostDragPointerBug)({
+          current: current
+        });
+      }
+    }
+  }, {
+    // "dragend" fires when on the drag source (eg a draggable element)
+    // when the drag is finished.
+    // "dragend" will fire after "drop"(if there was a successful drop)
+    // "dragend" does not fire if the draggable source has been removed during the drag
+    // or for external drag sources (eg files)
+    type: 'dragend',
+    listener: function listener() {
+      cancel();
+
+      // Applying this fix after `dispatch.drop` so that frameworks have the opportunity
+      // to update UI in response to a "onDrop".
+      if (dragInterface.startedFrom === 'internal') {
+        (0, _fixPostDragPointerBug.fixPostDragPointerBug)({
+          current: current
+        });
+      }
+    }
+  },
+  // ## Detecting drag ending for removed draggables
+  //
+  // If a draggable element is removed during a drag and the user drops:
+  // 1. if over a valid drop target: we get a "drop" event to know the drag is finished
+  // 2. if not over a valid drop target (or cancelled): we get nothing
+  // The "dragend" event will not fire on the source draggable if it has been
+  // removed from the DOM.
+  // So we need to figure out if a drag operation has finished by looking at other events
+  // We can do this by looking at other events
+
+  // ### First detection: "pointermove" events
+
+  // 1. "pointermove" events cannot fire during a drag and drop operation
+  // according to the spec. So if we get a "pointermove" it means that
+  // the drag and drop operations has finished. So if we get a "pointermove"
+  // we know that the drag is over
+  // 2. 🦊😤 Drag and drop operations are _supposed_ to suppress
+  // other pointer events. However, firefox will allow a few
+  // pointer event to get through after a drag starts.
+  // The most I've seen is 3
+  {
+    type: 'pointermove',
+    listener: function () {
+      var callCount = 0;
+      return function listener() {
+        // Using 20 as it is far bigger than the most observed (3)
+        if (callCount < 20) {
+          callCount++;
+          return;
+        }
+        cancel();
+      };
+    }()
+  },
+  // ### Second detection: "pointerdown" events
+
+  // If we receive this event then we know that a drag operation has finished
+  // and potentially another one is about to start.
+  // Note: `pointerdown` fires on all browsers / platforms before "dragstart"
+  {
+    type: 'pointerdown',
+    listener: cancel
+  }],
+  // Once we have started a managed drag operation it is important that we see / own all drag events
+  // We got one adoption bug pop up where some code was stopping (`event.stopPropagation()`)
+  // all "drop" events in the bubble phase on the `document.body`.
+  // This meant that we never saw the "drop" event.
+  {
+    capture: true
+  });
+  dispatch.start({
+    nativeSetDragImage: getNativeSetDragImage(event)
+  });
+}
+function setDropEffect(_ref4) {
+  var _current$;
+  var event = _ref4.event,
+    current = _ref4.current;
+  // setting the `dropEffect` to be the innerMost drop targets dropEffect
+  var innerMost = (_current$ = current[0]) === null || _current$ === void 0 ? void 0 : _current$.dropEffect;
+  if (innerMost != null && event.dataTransfer) {
+    event.dataTransfer.dropEffect = innerMost;
+  }
+}
+function getStartLocation(_ref5) {
+  var event = _ref5.event,
+    dragInterface = _ref5.dragInterface,
+    getDropTargetsOver = _ref5.getDropTargetsOver;
+  var input = (0, _getInput.getInput)(event);
+
+  // When dragging from outside of the browser, we don't have any starting drop targets
+  if (dragInterface.startedFrom === 'external') {
+    return {
+      input: input,
+      dropTargets: []
+    };
+  }
+  var dropTargets = getDropTargetsOver({
+    input: input,
+    source: dragInterface.payload,
+    target: event.target,
+    current: []
+  });
+  return {
+    input: input,
+    dropTargets: dropTargets
+  };
+}
+var lifecycle = {
+  canStart: canStart,
+  start: start
+};
+exports.lifecycle = lifecycle;

package/dist/cjs/ledger/usage-ledger.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.register = register;
+// Extending `Map` to allow us to link Key and Values together
+
+var ledger = new Map();
+function registerUsage(_ref) {
+  var typeKey = _ref.typeKey,
+    mount = _ref.mount;
+  var entry = ledger.get(typeKey);
+  if (entry) {
+    entry.usageCount++;
+    return entry;
+  }
+  var initial = {
+    typeKey: typeKey,
+    unmount: mount(),
+    usageCount: 1
+  };
+  ledger.set(typeKey, initial);
+  return initial;
+}
+function register(args) {
+  var entry = registerUsage(args);
+  return function unregister() {
+    entry.usageCount--;
+    if (entry.usageCount > 0) {
+      return;
+    }
+    // Only a single usage left, remove it
+    entry.unmount();
+    ledger.delete(args.typeKey);
+  };
+}

package/dist/cjs/make-adapter/make-adapter.js

@@ -0,0 +1,59 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.makeAdapter = makeAdapter;
+var _lifecycleManager = require("../ledger/lifecycle-manager");
+var _usageLedger = require("../ledger/usage-ledger");
+var _makeDropTarget = require("./make-drop-target");
+var _makeMonitor = require("./make-monitor");
+function makeAdapter(_ref) {
+  var typeKey = _ref.typeKey,
+    mount = _ref.mount,
+    dispatchEventToSource = _ref.dispatchEventToSource,
+    defaultDropEffect = _ref.defaultDropEffect;
+  var monitorAPI = (0, _makeMonitor.makeMonitor)();
+  var dropTargetAPI = (0, _makeDropTarget.makeDropTarget)({
+    typeKey: typeKey,
+    defaultDropEffect: defaultDropEffect
+  });
+  function dispatchEvent(args) {
+    // 1. forward the event to source
+    dispatchEventToSource === null || dispatchEventToSource === void 0 ? void 0 : dispatchEventToSource(args);
+
+    // 2. forward the event to relevant dropTargets
+    dropTargetAPI.dispatchEvent(args);
+
+    // 3. forward event to monitors
+    monitorAPI.dispatchEvent(args);
+  }
+  function start(_ref2) {
+    var event = _ref2.event,
+      dragInterface = _ref2.dragInterface;
+    _lifecycleManager.lifecycle.start({
+      event: event,
+      dragInterface: dragInterface,
+      getDropTargetsOver: dropTargetAPI.getIsOver,
+      dispatchEvent: dispatchEvent
+    });
+  }
+  function registerUsage() {
+    function mountAdapter() {
+      var api = {
+        canStart: _lifecycleManager.lifecycle.canStart,
+        start: start
+      };
+      return mount(api);
+    }
+    return (0, _usageLedger.register)({
+      typeKey: typeKey,
+      mount: mountAdapter
+    });
+  }
+  return {
+    registerUsage: registerUsage,
+    dropTarget: dropTargetAPI.dropTargetForConsumers,
+    monitor: monitorAPI.monitorForConsumers
+  };
+}