@atlaskit/pragmatic-drag-and-drop 0.17.0

package/dist/es2019/make-adapter/make-drop-target.js

@@ -0,0 +1,233 @@
+import { addAttribute } from '../util/add-attribute';
+import { combine } from '../util/combine';
+function copyReverse(array) {
+  return array.slice(0).reverse();
+}
+export function makeDropTarget({
+  typeKey,
+  defaultDropEffect
+}) {
+  const registry = new WeakMap();
+  const dropTargetDataAtt = `data-drop-target-for-${typeKey}`;
+  const dropTargetSelector = `[${dropTargetDataAtt}]`;
+  function addToRegistry(args) {
+    registry.set(args.element, args);
+    return () => registry.delete(args.element);
+  }
+  function dropTargetForConsumers(args) {
+    // Guardrail: warn if the draggable element is already registered
+    if (process.env.NODE_ENV !== 'production') {
+      const existing = registry.get(args.element);
+      if (existing) {
+        // eslint-disable-next-line no-console
+        console.warn('You have already registered a `droppable` on the same element', {
+          existing,
+          proposed: args
+        });
+      }
+    }
+    return combine(addAttribute(args.element, {
+      attribute: dropTargetDataAtt,
+      value: 'true'
+    }), addToRegistry(args));
+  }
+  function getActualDropTargets({
+    source,
+    target,
+    input,
+    result = []
+  }) {
+    var _args$getData, _args$getData2, _args$getDropEffect, _args$getDropEffect2, _args$getIsSticky;
+    if (!(target instanceof Element)) {
+      return result;
+    }
+    const closest = target.closest(dropTargetSelector);
+
+    // Cannot find anything else
+    if (closest == null) {
+      return result;
+    }
+    const args = registry.get(closest);
+
+    // error: something had a dropTargetSelector but we could not
+    // find a match. For now, failing silently
+    if (args == null) {
+      return result;
+    }
+    const feedback = {
+      input,
+      source,
+      element: args.element
+    };
+
+    // if dropping is not allowed, skip this drop target
+    // and continue looking up the DOM tree
+    if (args.canDrop && !args.canDrop(feedback)) {
+      return getActualDropTargets({
+        source,
+        target: args.element.parentElement,
+        input,
+        result
+      });
+    }
+    const data = (_args$getData = (_args$getData2 = args.getData) === null || _args$getData2 === void 0 ? void 0 : _args$getData2.call(args, feedback)) !== null && _args$getData !== void 0 ? _args$getData : {};
+    const dropEffect = (_args$getDropEffect = (_args$getDropEffect2 = args.getDropEffect) === null || _args$getDropEffect2 === void 0 ? void 0 : _args$getDropEffect2.call(args, feedback)) !== null && _args$getDropEffect !== void 0 ? _args$getDropEffect : defaultDropEffect;
+    const sticky = Boolean((_args$getIsSticky = args.getIsSticky) === null || _args$getIsSticky === void 0 ? void 0 : _args$getIsSticky.call(args, feedback));
+    const record = {
+      data,
+      element: args.element,
+      dropEffect,
+      sticky
+    };
+    return getActualDropTargets({
+      source,
+      target: args.element.parentElement,
+      input,
+      // Using bubble ordering. Same ordering as `event.getPath()`
+      result: [...result, record]
+    });
+  }
+  function notifyCurrent({
+    eventName,
+    payload
+  }) {
+    for (const record of payload.location.current.dropTargets) {
+      var _entry$eventName;
+      const entry = registry.get(record.element);
+      const args = {
+        ...payload,
+        self: record
+      };
+      entry === null || entry === void 0 ? void 0 : (_entry$eventName = entry[eventName]) === null || _entry$eventName === void 0 ? void 0 : _entry$eventName.call(entry,
+      // I cannot seem to get the types right here.
+      // TS doesn't seem to like that one event can need `nativeSetDragImage`
+      // @ts-expect-error
+      args);
+    }
+  }
+  const actions = {
+    onGenerateDragPreview: notifyCurrent,
+    onDrag: notifyCurrent,
+    onDragStart: notifyCurrent,
+    onDrop: notifyCurrent,
+    onDropTargetChange: ({
+      payload
+    }) => {
+      const isCurrent = new Set(payload.location.current.dropTargets.map(record => record.element));
+      const visited = new Set();
+      for (const record of payload.location.previous.dropTargets) {
+        var _entry$onDropTargetCh;
+        visited.add(record.element);
+        const entry = registry.get(record.element);
+        const isOver = isCurrent.has(record.element);
+        const args = {
+          ...payload,
+          self: record
+        };
+        entry === null || entry === void 0 ? void 0 : (_entry$onDropTargetCh = entry.onDropTargetChange) === null || _entry$onDropTargetCh === void 0 ? void 0 : _entry$onDropTargetCh.call(entry, args);
+
+        // if we cannot find the drop target in the current array, then it has been left
+        if (!isOver) {
+          var _entry$onDragLeave;
+          entry === null || entry === void 0 ? void 0 : (_entry$onDragLeave = entry.onDragLeave) === null || _entry$onDragLeave === void 0 ? void 0 : _entry$onDragLeave.call(entry, args);
+        }
+      }
+      for (const record of payload.location.current.dropTargets) {
+        var _entry$onDropTargetCh2, _entry$onDragEnter;
+        // already published an update to this drop target
+        if (visited.has(record.element)) {
+          continue;
+        }
+        // at this point we have a new drop target that is being entered into
+        const args = {
+          ...payload,
+          self: record
+        };
+        const entry = registry.get(record.element);
+        entry === null || entry === void 0 ? void 0 : (_entry$onDropTargetCh2 = entry.onDropTargetChange) === null || _entry$onDropTargetCh2 === void 0 ? void 0 : _entry$onDropTargetCh2.call(entry, args);
+        entry === null || entry === void 0 ? void 0 : (_entry$onDragEnter = entry.onDragEnter) === null || _entry$onDragEnter === void 0 ? void 0 : _entry$onDragEnter.call(entry, args);
+      }
+    }
+  };
+  function dispatchEvent(args) {
+    // This line does not work in TS 4.2
+    // It does work in TS 4.7
+    // @ts-expect-error
+    actions[args.eventName](args);
+  }
+  function getIsOver({
+    source,
+    target,
+    input,
+    current
+  }) {
+    const actual = getActualDropTargets({
+      source,
+      target,
+      input
+    });
+
+    // stickiness is only relevant when we have less
+    // drop targets than we did before
+    if (actual.length >= current.length) {
+      return actual;
+    }
+
+    // less 'actual' drop targets than before,
+    // we need to see if 'stickiness' applies
+
+    // An old drop target will continue to be dropped on if:
+    // 1. it has the same parent
+    // 2. nothing exists in it's previous index
+
+    const lastCaptureOrdered = copyReverse(current);
+    const actualCaptureOrdered = copyReverse(actual);
+    const resultCaptureOrdered = [];
+    for (let index = 0; index < lastCaptureOrdered.length; index++) {
+      const last = lastCaptureOrdered[index];
+      const fresh = actualCaptureOrdered[index];
+
+      // if a record is in the new index -> use that
+      // it will have the latest data + dropEffect
+      if (fresh != null) {
+        resultCaptureOrdered.push(fresh);
+        continue;
+      }
+
+      // At this point we have no drop target in the old spot
+      // Check to see if we can use a previous sticky drop target
+
+      // stickiness is based on relationships to a parent
+      // so if we hit a drop target that is not sticky we
+      // can finish our search
+      if (!last.sticky) {
+        break;
+      }
+
+      // We only want the previous sticky item to 'stick' if
+      // the parent of the sticky item is unchanged
+
+      // The "parent" is the one inside of `resultCaptureOrdered`
+      // (the parent might be a drop target that was sticky)
+      const parent = resultCaptureOrdered[index - 1];
+      const lastParent = lastCaptureOrdered[index - 1];
+
+      // parents are the same (might both be undefined for index == 0)
+      // we can add the last entry and keep searching
+      if ((parent === null || parent === void 0 ? void 0 : parent.element) === (lastParent === null || lastParent === void 0 ? void 0 : lastParent.element)) {
+        resultCaptureOrdered.push(last);
+        continue;
+      }
+      // parents are not the same, we can exit our search
+      break;
+    }
+
+    // return bubble ordered result
+    return copyReverse(resultCaptureOrdered);
+  }
+  return {
+    dropTargetForConsumers,
+    getIsOver,
+    dispatchEvent
+  };
+}

package/dist/es2019/make-adapter/make-monitor.js

@@ -0,0 +1,80 @@
+export function makeMonitor() {
+  const registry = new Set();
+  let dragging = null;
+  function tryAddToActive(monitor) {
+    if (!dragging) {
+      return;
+    }
+    // Monitor is allowed to monitor events if:
+    // 1. It has no `canMonitor` function (default is that a monitor can listen to everything)
+    // 2. `canMonitor` returns true
+    if (!monitor.canMonitor || monitor.canMonitor(dragging.canMonitorArgs)) {
+      dragging.active.add(monitor);
+    }
+  }
+  function monitorForConsumers(args) {
+    // We are giving each `args` a new reference so that you
+    // can create multiple monitors with the same `args`.
+    const entry = {
+      ...args
+    };
+    registry.add(entry);
+
+    // if there is an active drag we need to see if this new monitor is relevant
+    tryAddToActive(entry);
+    return function cleanup() {
+      registry.delete(entry);
+
+      // We need to stop publishing events during a drag to this monitor!
+      if (dragging) {
+        dragging.active.delete(entry);
+      }
+    };
+  }
+  function dispatchEvent({
+    eventName,
+    payload
+  }) {
+    if (eventName === 'onGenerateDragPreview') {
+      dragging = {
+        canMonitorArgs: {
+          initial: payload.location.initial,
+          source: payload.source
+        },
+        active: new Set()
+      };
+      for (const monitor of registry) {
+        tryAddToActive(monitor);
+      }
+    }
+
+    // This should never happen.
+    if (!dragging) {
+      return;
+    }
+
+    // Creating an array from the set _before_ iterating
+    // This is so that monitors added during the current event will not be called.
+    // This behaviour matches native EventTargets where an event listener
+    // cannot add another event listener during an active event to the same
+    // event target in the same event (for us we have a single global event target)
+    const active = Array.from(dragging.active);
+    for (const monitor of active) {
+      // A monitor can be removed by another monitor during an event.
+      // We need to check that the monitor is still registered before calling it
+      if (dragging.active.has(monitor)) {
+        var _monitor$eventName;
+        // @ts-expect-error: I cannot get this type working!
+        (_monitor$eventName = monitor[eventName]) === null || _monitor$eventName === void 0 ? void 0 : _monitor$eventName.call(monitor, payload);
+      }
+    }
+    if (eventName === 'onDrop') {
+      dragging.active.clear();
+      dragging = null;
+    }
+  }
+  return {
+    dispatchEvent,
+    monitorForConsumers
+  };
+}

package/dist/es2019/util/add-attribute.js

@@ -0,0 +1,7 @@
+export function addAttribute(element, {
+  attribute,
+  value
+}) {
+  element.setAttribute(attribute, value);
+  return () => element.removeAttribute(attribute);
+}

package/dist/es2019/util/combine.js

@@ -0,0 +1,6 @@
+/** Create a new combined function that will call all the provided functions */
+export function combine(...fns) {
+  return function cleanup() {
+    fns.forEach(fn => fn());
+  };
+}

package/dist/es2019/util/disable-native-drag-preview.js

@@ -0,0 +1,31 @@
+// In order to disable the native drag preview you can
+// use `event.dataTransfer.setDragImage()` to set a small
+// invisible image as the drag preview.
+// There are alternative techniques,
+// (eg setting opacity to in onGenerateDragPreview and then 1 in onDragStart)
+// but the technique in this file worked best across browsers and platforms
+
+// Here we are preloading the image so that it is ready for the first drag.
+// Even though the image is base64 encoded, the browser queues an async task
+// to decode the image. The image needs to be decoded before it can be used
+const tinyTransparentImage = (() => {
+  // SSR safe
+  if (typeof window === 'undefined') {
+    return null;
+  }
+
+  // Image generated by: https://png-pixel.com/
+  // It is a 1x1 transparent gif
+  // It is the smallest possible transparent image we could find that works on all platforms
+  // Note: using an encoded SVG would be nicer code, but it doesn't work on iOS
+  const img = new Image();
+  img.src = 'data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw==';
+  return img;
+})();
+export function disableNativeDragPreview({
+  nativeSetDragImage
+}) {
+  if (nativeSetDragImage && tinyTransparentImage) {
+    nativeSetDragImage(tinyTransparentImage, 0, 0);
+  }
+}

package/dist/es2019/util/entering-and-leaving-the-window.js

@@ -0,0 +1,159 @@
+import { bindAll } from 'bind-event-listener';
+
+// *Usually* to detect if you are entering / leaving a window you can
+// use the `event.relatedTarget` property:
+
+// "dragenter":
+// - `event.relatedTarget` should point to the element that you are coming from
+//   - Scenario: A -> B
+//   - `event.target`: `B` (entering B)
+//   - `event.relatedTarget`: `A`: (leaving A - where you are coming from)
+// - if `event.relatedTarget` is `null` then you are entering the window (coming from `null`)
+//
+// "dragleave"
+// - `event.relatedTarget` should point to the element you are going to
+//   - Scenario: A -> B (entered B, leaving A)
+//   - `event.target`: `A` (leaving A)
+//   - `event.relatedTarget`: `B`: (entering into B - where you are going to)
+// - if `event.relatedTarget` is `null` then you are leaving the window (going to `null`)
+//
+// Unfortunately in Safari `event.relatedTarget` is *always* set to `null`
+// Safari bug: https://bugs.webkit.org/show_bug.cgi?id=242627
+// To work around this we count "dragenter" and "dragleave" events
+const safariFix = {
+  isSafari: false,
+  // Using symbols for event properties so we don't clash with
+  // anything on the `event` object
+  leavingWindow: Symbol('leaving'),
+  enteringWindow: Symbol('entering')
+};
+export function isEnteringWindow({
+  dragEnter
+}) {
+  if (dragEnter.type !== 'dragenter') {
+    return false;
+  }
+  if (safariFix.isSafari) {
+    return dragEnter.hasOwnProperty(safariFix.enteringWindow);
+  }
+  // This is the standard check.
+  // if `relatedTarget` is `null` during a "dragenter"
+  // then we are entering the`window`
+  return dragEnter.relatedTarget == null;
+}
+export function isLeavingWindow({
+  dragLeave
+}) {
+  if (dragLeave.type !== 'dragleave') {
+    return false;
+  }
+  if (safariFix.isSafari) {
+    return dragLeave.hasOwnProperty(safariFix.leavingWindow);
+  }
+  // This is the standard check.
+  // if `relatedTarget` is `null` during a "dragleave"
+  // then we are leave the `window`
+  return dragLeave.relatedTarget == null;
+}
+
+// NOTE: this fix currently has no test coverage
+// - our drag and drop browser tests currently only run in Chrome due to tooling limitations
+// - it didn't feel helpful to unit test as it is merely replicating a bug
+
+(function fixSafari() {
+  // Don't do anything when server side rendering
+  if (typeof window === 'undefined') {
+    return;
+  }
+
+  // rather than checking the userAgent for "jsdom" we can do this check
+  // so that the check will be removed completely in production code
+  if (process.env.NODE_ENV === 'test') {
+    return;
+  }
+  const {
+    userAgent
+  } = navigator;
+  const isSafari = userAgent.includes('AppleWebKit') && !userAgent.includes('Chrome');
+  if (!isSafari) {
+    return;
+  }
+  safariFix.isSafari = true;
+  function getInitialState() {
+    return {
+      enterCount: 0,
+      isOverWindow: false
+    };
+  }
+  let state = getInitialState();
+  function resetState() {
+    state = getInitialState();
+  }
+
+  // These event listeners are bound _forever_ and _never_ removed
+  // We don't bother cleaning up these event listeners (for now)
+  // as this workaround is only for Safari
+
+  // This is how the event count works:
+  //
+  // lift (+1 enterCount)
+  // - dragstart(draggable) [enterCount: 0]
+  // - dragenter(draggable) [enterCount: 1]
+  // leaving draggable (+0 enterCount)
+  // - dragenter(document.body) [enterCount: 2]
+  // - dragleave(draggable) [enterCount: 1]
+  // leaving window (-1 enterCount)
+  // - dragleave(document.body) [enterCount: 0] {leaving the window}
+
+  // Things to note:
+  // - dragenter and dragleave bubble
+  // - the first dragenter when entering a window might not be on `window`
+  //   - it could be on an element that is pressed up against the window
+  //   - (so we cannot rely on `event.target` values)
+
+  bindAll(window, [{
+    type: 'dragstart',
+    listener: () => {
+      state.enterCount = 0;
+      // drag start occurs in the source window
+      state.isOverWindow = true;
+
+      // When a drag first starts it will also trigger a "dragenter" on the draggable element
+    }
+  }, {
+    type: 'drop',
+    listener: resetState
+  }, {
+    type: 'dragend',
+    listener: resetState
+  }, {
+    type: 'dragenter',
+    listener: event => {
+      if (!state.isOverWindow && state.enterCount === 0) {
+        // Patching the `event` object
+        // The `event` object is shared with all event listeners for the event
+        // @ts-ignore
+        event[safariFix.enteringWindow] = true;
+      }
+      state.isOverWindow = true;
+      state.enterCount++;
+    }
+  }, {
+    type: 'dragleave',
+    listener: event => {
+      state.enterCount--;
+      if (state.isOverWindow && state.enterCount === 0) {
+        // Patching the `event` object as it is shared with all event listeners
+        // The `event` object is shared with all event listeners for the event
+        // @ts-ignore
+        event[safariFix.leavingWindow] = true;
+        state.isOverWindow = false;
+      }
+    }
+  }],
+  // using `capture: true` so that adding event listeners
+  // in bubble phase will have the correct symbols
+  {
+    capture: true
+  });
+})();

package/dist/es2019/util/fix-post-drag-pointer-bug.js

@@ -0,0 +1,110 @@
+import { bindAll } from 'bind-event-listener';
+/** Set a `style` property on a `HTMLElement`
+ *
+ * @returns a `cleanup` function to restore the `style` property to it's original state
+ */
+function setStyle(el, {
+  property,
+  rule,
+  priority = ''
+}) {
+  const originalValue = el.style.getPropertyValue(property);
+  const originalPriority = el.style.getPropertyPriority(property);
+  el.style.setProperty(property, rule, priority);
+  return function cleanup() {
+    el.style.setProperty(property, originalValue, originalPriority);
+  };
+}
+
+/**
+ * Allow the user to continue to interact with the element their pointer is over at the end of the drag.
+ * This is important to allow the user to be able to click, drag (etc) after they have finished a drag
+ *
+ * @returns a `cleanup` function to restore all elements under the users pointer to their original state
+ */
+function allowPointerEventsOnElementUnderPointer({
+  current
+}) {
+  const underUsersPointer = document.elementFromPoint(current.input.clientX, current.input.clientY);
+  if (!(underUsersPointer instanceof HTMLElement)) {
+    return null;
+  }
+
+  // Debug note: change from 'pointer-events: none' to 'background: green'
+  // to get a better sense of what is being achieved
+  return setStyle(underUsersPointer, {
+    property: 'pointer-events',
+    rule: 'auto',
+    priority: 'important'
+  });
+}
+function blockPointerEventsOnEverything() {
+  var _element$sheet;
+  const element = document.createElement('style');
+  // Adding a data attribute so to make it super clear to consumers
+  // (and to our tests) what this temporary style tag is for
+  element.setAttribute('pdnd-post-drag-fix', 'true');
+  document.head.appendChild(element);
+
+  // Debug note: change from 'pointer-events: none' to 'background: red'
+  // to get a better sense of what is being achieved
+  (_element$sheet = element.sheet) === null || _element$sheet === void 0 ? void 0 : _element$sheet.insertRule('* { pointer-events: none !important; }');
+  return function cleanup() {
+    document.head.removeChild(element);
+  };
+}
+
+/** 🔥🤮 Fix (Chrome, Safari and Firefox) bug where the element under where the user started dragging
+ * (on the viewport) is entered into by the browser after a drag finishes ("drop" or "dragend")
+ *
+ * @description
+ *
+ * Block pointer events on all elements except for the specific element that pointer is currently over
+ *
+ * - [Visual explanation of bug](https://twitter.com/alexandereardon/status/1633614212873465856)
+ * - [Chrome bug](https://bugs.chromium.org/p/chromium/issues/detail?id=410328)
+ */
+export function fixPostDragPointerBug({
+  current
+}) {
+  // Queuing a microtask to give any opportunity for frameworks to update their UI in a microtask
+  // Note: react@18 does standard state updates in a microtask
+  // We do this so our `atDestination` gets the _actual_ element that is under the users pointer
+  // at the end of the drag.
+  queueMicrotask(() => {
+    const undoUnderPointer = allowPointerEventsOnElementUnderPointer({
+      current
+    });
+
+    // This will also block pointer-events on the children of the element under the users pointer.
+    // This is what we want. If the user drops on a container element we don't want the children
+    // of the container to be incorrectly entered into
+    const undoGlobalBlock = blockPointerEventsOnEverything();
+    function cleanup() {
+      unbindEvents();
+      undoUnderPointer === null || undoUnderPointer === void 0 ? void 0 : undoUnderPointer();
+      undoGlobalBlock();
+    }
+    const unbindEvents = bindAll(window, [{
+      type: 'pointerdown',
+      listener: cleanup
+    }, {
+      type: 'pointermove',
+      listener: cleanup
+    }, {
+      type: 'focusin',
+      listener: cleanup
+    }, {
+      type: 'focusout',
+      listener: cleanup
+    },
+    // a 'pointerdown' should happen before 'dragstart', but just being super safe
+    {
+      type: 'dragstart',
+      listener: cleanup
+    }], {
+      // Using `capture` is more likely to not be impacted by consumers stopping events
+      capture: true
+    });
+  });
+}

package/dist/es2019/util/get-input.js

@@ -0,0 +1,14 @@
+export function getInput(event) {
+  return {
+    altKey: event.altKey,
+    button: event.button,
+    buttons: event.buttons,
+    ctrlKey: event.ctrlKey,
+    metaKey: event.metaKey,
+    shiftKey: event.shiftKey,
+    clientX: event.clientX,
+    clientY: event.clientY,
+    pageX: event.pageX,
+    pageY: event.pageY
+  };
+}

package/dist/es2019/util/once.js

@@ -0,0 +1,13 @@
+/** Provide a function that you only ever want to be called a single time */
+export function once(fn) {
+  let cache = null;
+  return function wrapped(...args) {
+    if (!cache) {
+      const result = fn.apply(this, args);
+      cache = {
+        result: result
+      };
+    }
+    return cache.result;
+  };
+}

package/dist/es2019/util/reorder.js

@@ -0,0 +1,17 @@
+/**
+ * Reorder a provided `list`
+ * Returns a new array and does not modify the original array
+ */
+export function reorder({
+  list,
+  startIndex,
+  finishIndex
+}) {
+  if (startIndex === -1 || finishIndex === -1) {
+    return list;
+  }
+  const result = Array.from(list);
+  const [removed] = result.splice(startIndex, 1);
+  result.splice(finishIndex, 0, removed);
+  return result;
+}

package/dist/es2019/util/scroll-just-enough-into-view.js

@@ -0,0 +1,12 @@
+/**
+ * Scroll an `element` just enough into view so that the element becomes totally visible.
+ * If the element is already totally visible then no scrolling will occur.
+ */
+export function scrollJustEnoughIntoView({
+  element
+}) {
+  element.scrollIntoView({
+    block: 'nearest',
+    inline: 'nearest'
+  });
+}