@atlaskit/editor-plugin-table 0.0.0 → 0.0.1

package/dist/esm/plugins/table/commands-with-analytics.js

@@ -0,0 +1,464 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
+import { findCellClosestToPos, findCellRectClosestToPos, getSelectionRect } from '@atlaskit/editor-tables/utils';
+import { tableBackgroundColorPalette } from '@atlaskit/adf-schema';
+import { ACTION_SUBJECT, EVENT_TYPE, INPUT_METHOD, TABLE_ACTION, TABLE_BREAKOUT } from '@atlaskit/editor-common/analytics';
+import { clearMultipleCells } from './commands/clear';
+import { wrapTableInExpand } from './commands/collapse';
+import { insertColumn, insertRow } from './commands/insert';
+import { deleteTable, setMultipleCellAttrs, deleteTableIfSelected } from './commands/misc';
+import { sortByColumn } from './commands/sort';
+import { splitCell } from './commands/split-cell';
+import { getNextLayout, toggleHeaderColumn, toggleHeaderRow, toggleNumberColumn, toggleTableLayout } from './commands/toggle';
+import { distributeColumnsWidths } from './pm-plugins/table-resizing/commands';
+import { getPluginState } from './pm-plugins/plugin-factory';
+import { deleteColumns, deleteRows, mergeCells } from './transforms';
+import { checkIfNumberColumnEnabled, getSelectedCellInfo, getSelectedTableInfo } from './utils';
+import { withEditorAnalyticsAPI } from './utils/analytics';
+import { getAllowAddColumnCustomStep } from './utils/get-allow-add-column-custom-step';
+var TABLE_BREAKOUT_NAME_MAPPING = {
+  default: TABLE_BREAKOUT.NORMAL,
+  wide: TABLE_BREAKOUT.WIDE,
+  'full-width': TABLE_BREAKOUT.FULL_WIDTH
+}; // #region Analytics wrappers
+
+export var emptyMultipleCellsWithAnalytics = function emptyMultipleCellsWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, targetCellPosition) {
+    return withEditorAnalyticsAPI(function (_ref) {
+      var selection = _ref.selection;
+
+      var _getSelectedCellInfo = getSelectedCellInfo(selection),
+          horizontalCells = _getSelectedCellInfo.horizontalCells,
+          verticalCells = _getSelectedCellInfo.verticalCells,
+          totalRowCount = _getSelectedCellInfo.totalRowCount,
+          totalColumnCount = _getSelectedCellInfo.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.CLEARED,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          inputMethod: inputMethod,
+          horizontalCells: horizontalCells,
+          verticalCells: verticalCells,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(clearMultipleCells(targetCellPosition));
+  };
+};
+export var mergeCellsWithAnalytics = function mergeCellsWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (_ref2) {
+    var selection = _ref2.selection;
+
+    var _getSelectedCellInfo2 = getSelectedCellInfo(selection),
+        horizontalCells = _getSelectedCellInfo2.horizontalCells,
+        verticalCells = _getSelectedCellInfo2.verticalCells,
+        totalCells = _getSelectedCellInfo2.totalCells,
+        totalRowCount = _getSelectedCellInfo2.totalRowCount,
+        totalColumnCount = _getSelectedCellInfo2.totalColumnCount;
+
+    return {
+      action: TABLE_ACTION.MERGED,
+      actionSubject: ACTION_SUBJECT.TABLE,
+      actionSubjectId: null,
+      attributes: {
+        horizontalCells: horizontalCells,
+        verticalCells: verticalCells,
+        totalCells: totalCells,
+        totalRowCount: totalRowCount,
+        totalColumnCount: totalColumnCount
+      },
+      eventType: EVENT_TYPE.TRACK
+    };
+  })(editorAnalyticsAPI)(function (state, dispatch) {
+    if (dispatch) {
+      dispatch(mergeCells(state.tr));
+    }
+
+    return true;
+  });
+};
+export var splitCellWithAnalytics = function splitCellWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (_ref3) {
+    var selection = _ref3.selection;
+
+    var _getSelectedCellInfo3 = getSelectedCellInfo(selection),
+        totalRowCount = _getSelectedCellInfo3.totalRowCount,
+        totalColumnCount = _getSelectedCellInfo3.totalColumnCount;
+
+    var cell = findCellClosestToPos(selection.$anchor);
+
+    if (cell) {
+      var _cell$node$attrs = cell.node.attrs,
+          verticalCells = _cell$node$attrs.rowspan,
+          horizontalCells = _cell$node$attrs.colspan;
+      return {
+        action: TABLE_ACTION.SPLIT,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          horizontalCells: horizontalCells,
+          verticalCells: verticalCells,
+          totalCells: horizontalCells * verticalCells,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    }
+
+    return;
+  })(editorAnalyticsAPI)(splitCell);
+};
+export var setColorWithAnalytics = function setColorWithAnalytics(editorAnalyticsAPI) {
+  return function (cellColor, targetCellPosition) {
+    return withEditorAnalyticsAPI(function (_ref4) {
+      var selection = _ref4.selection;
+
+      var _getSelectedCellInfo4 = getSelectedCellInfo(selection),
+          horizontalCells = _getSelectedCellInfo4.horizontalCells,
+          verticalCells = _getSelectedCellInfo4.verticalCells,
+          totalCells = _getSelectedCellInfo4.totalCells,
+          totalRowCount = _getSelectedCellInfo4.totalRowCount,
+          totalColumnCount = _getSelectedCellInfo4.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.COLORED,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          cellColor: (tableBackgroundColorPalette.get(cellColor.toLowerCase()) || cellColor).toLowerCase(),
+          horizontalCells: horizontalCells,
+          verticalCells: verticalCells,
+          totalCells: totalCells,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(setMultipleCellAttrs({
+      background: cellColor
+    }, targetCellPosition));
+  };
+};
+export var addRowAroundSelection = function addRowAroundSelection(editorAnalyticsAPI) {
+  return function (side) {
+    return function (state, dispatch) {
+      var selection = state.selection;
+      var isCellSelection = selection instanceof CellSelection;
+      var rect = isCellSelection ? getSelectionRect(selection) : findCellRectClosestToPos(selection.$from);
+
+      if (!rect) {
+        return false;
+      }
+
+      var position = isCellSelection && side === 'TOP' ? rect.top : rect.bottom - 1;
+      var offset = side === 'BOTTOM' ? 1 : 0;
+      return insertRowWithAnalytics(editorAnalyticsAPI)(INPUT_METHOD.SHORTCUT, {
+        index: position + offset,
+        moveCursorToInsertedRow: false
+      })(state, dispatch);
+    };
+  };
+};
+export var insertRowWithAnalytics = function insertRowWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, options) {
+    return withEditorAnalyticsAPI(function (state) {
+      var _getSelectedTableInfo = getSelectedTableInfo(state.selection),
+          totalRowCount = _getSelectedTableInfo.totalRowCount,
+          totalColumnCount = _getSelectedTableInfo.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.ADDED_ROW,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          inputMethod: inputMethod,
+          position: options.index,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(insertRow(options.index, options.moveCursorToInsertedRow));
+  };
+};
+export var insertColumnWithAnalytics = function insertColumnWithAnalytics(getEditorContainerWidth, editorAnalyticsAPI) {
+  return function (inputMethod, position) {
+    return withEditorAnalyticsAPI(function (state) {
+      var _getSelectedTableInfo2 = getSelectedTableInfo(state.selection),
+          totalRowCount = _getSelectedTableInfo2.totalRowCount,
+          totalColumnCount = _getSelectedTableInfo2.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.ADDED_COLUMN,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          inputMethod: inputMethod,
+          position: position,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(insertColumn(getEditorContainerWidth)(position));
+  };
+};
+export var deleteRowsWithAnalytics = function deleteRowsWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, rect, isHeaderRowRequired) {
+    return withEditorAnalyticsAPI(function (_ref5) {
+      var selection = _ref5.selection;
+
+      var _getSelectedTableInfo3 = getSelectedTableInfo(selection),
+          totalRowCount = _getSelectedTableInfo3.totalRowCount,
+          totalColumnCount = _getSelectedTableInfo3.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.DELETED_ROW,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          inputMethod: inputMethod,
+          position: rect.top,
+          count: rect.bottom - rect.top,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(function (state, dispatch) {
+      if (dispatch) {
+        dispatch(deleteRows(rect, isHeaderRowRequired)(state.tr));
+      }
+
+      return true;
+    });
+  };
+};
+export var deleteColumnsWithAnalytics = function deleteColumnsWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, rect) {
+    return withEditorAnalyticsAPI(function (_ref6) {
+      var selection = _ref6.selection;
+
+      var _getSelectedTableInfo4 = getSelectedTableInfo(selection),
+          totalRowCount = _getSelectedTableInfo4.totalRowCount,
+          totalColumnCount = _getSelectedTableInfo4.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.DELETED_COLUMN,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          inputMethod: inputMethod,
+          position: rect.left,
+          count: rect.right - rect.left,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(function (state, dispatch) {
+      if (dispatch) {
+        dispatch(deleteColumns(rect, getAllowAddColumnCustomStep(state))(state.tr));
+      }
+
+      return true;
+    });
+  };
+};
+
+var getTableDeletedAnalytics = function getTableDeletedAnalytics(selection, inputMethod) {
+  var _getSelectedTableInfo5 = getSelectedTableInfo(selection),
+      totalRowCount = _getSelectedTableInfo5.totalRowCount,
+      totalColumnCount = _getSelectedTableInfo5.totalColumnCount;
+
+  return {
+    action: TABLE_ACTION.DELETED,
+    actionSubject: ACTION_SUBJECT.TABLE,
+    attributes: {
+      inputMethod: inputMethod,
+      totalRowCount: totalRowCount,
+      totalColumnCount: totalColumnCount
+    },
+    eventType: EVENT_TYPE.TRACK
+  };
+};
+
+export var deleteTableWithAnalytics = function deleteTableWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (_ref7) {
+    var selection = _ref7.selection;
+    return getTableDeletedAnalytics(selection, INPUT_METHOD.FLOATING_TB);
+  })(editorAnalyticsAPI)(deleteTable);
+};
+export var deleteTableIfSelectedWithAnalytics = function deleteTableIfSelectedWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod) {
+    return withEditorAnalyticsAPI(function (_ref8) {
+      var selection = _ref8.selection;
+      return getTableDeletedAnalytics(selection, inputMethod);
+    })(editorAnalyticsAPI)(deleteTableIfSelected);
+  };
+};
+export var toggleHeaderRowWithAnalytics = function toggleHeaderRowWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (state) {
+    var _getSelectedTableInfo6 = getSelectedTableInfo(state.selection),
+        totalRowCount = _getSelectedTableInfo6.totalRowCount,
+        totalColumnCount = _getSelectedTableInfo6.totalColumnCount;
+
+    var _getPluginState = getPluginState(state),
+        isHeaderRowEnabled = _getPluginState.isHeaderRowEnabled;
+
+    return {
+      action: TABLE_ACTION.TOGGLED_HEADER_ROW,
+      actionSubject: ACTION_SUBJECT.TABLE,
+      actionSubjectId: null,
+      attributes: {
+        newState: !isHeaderRowEnabled,
+        totalRowCount: totalRowCount,
+        totalColumnCount: totalColumnCount
+      },
+      eventType: EVENT_TYPE.TRACK
+    };
+  })(editorAnalyticsAPI)(toggleHeaderRow);
+};
+export var toggleHeaderColumnWithAnalytics = function toggleHeaderColumnWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (state) {
+    var _getSelectedTableInfo7 = getSelectedTableInfo(state.selection),
+        totalRowCount = _getSelectedTableInfo7.totalRowCount,
+        totalColumnCount = _getSelectedTableInfo7.totalColumnCount;
+
+    var _getPluginState2 = getPluginState(state),
+        isHeaderColumnEnabled = _getPluginState2.isHeaderColumnEnabled;
+
+    return {
+      action: TABLE_ACTION.TOGGLED_HEADER_COLUMN,
+      actionSubject: ACTION_SUBJECT.TABLE,
+      actionSubjectId: null,
+      attributes: {
+        newState: !isHeaderColumnEnabled,
+        totalRowCount: totalRowCount,
+        totalColumnCount: totalColumnCount
+      },
+      eventType: EVENT_TYPE.TRACK
+    };
+  })(editorAnalyticsAPI)(toggleHeaderColumn);
+};
+export var toggleNumberColumnWithAnalytics = function toggleNumberColumnWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (state) {
+    var _getSelectedTableInfo8 = getSelectedTableInfo(state.selection),
+        totalRowCount = _getSelectedTableInfo8.totalRowCount,
+        totalColumnCount = _getSelectedTableInfo8.totalColumnCount;
+
+    return {
+      action: TABLE_ACTION.TOGGLED_NUMBER_COLUMN,
+      actionSubject: ACTION_SUBJECT.TABLE,
+      actionSubjectId: null,
+      attributes: {
+        newState: !checkIfNumberColumnEnabled(state.selection),
+        totalRowCount: totalRowCount,
+        totalColumnCount: totalColumnCount
+      },
+      eventType: EVENT_TYPE.TRACK
+    };
+  })(editorAnalyticsAPI)(toggleNumberColumn);
+};
+export var toggleTableLayoutWithAnalytics = function toggleTableLayoutWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (state) {
+    var _getSelectedTableInfo9 = getSelectedTableInfo(state.selection),
+        table = _getSelectedTableInfo9.table,
+        totalRowCount = _getSelectedTableInfo9.totalRowCount,
+        totalColumnCount = _getSelectedTableInfo9.totalColumnCount;
+
+    if (table) {
+      var _ref9 = table.node.attrs,
+          layout = _ref9.layout;
+      return {
+        action: TABLE_ACTION.CHANGED_BREAKOUT_MODE,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: {
+          newBreakoutMode: TABLE_BREAKOUT_NAME_MAPPING[getNextLayout(layout)],
+          previousBreakoutMode: TABLE_BREAKOUT_NAME_MAPPING[layout],
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    }
+
+    return;
+  })(editorAnalyticsAPI)(toggleTableLayout);
+};
+export var sortColumnWithAnalytics = function sortColumnWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, columnIndex, sortOrder) {
+    return withEditorAnalyticsAPI(function (state) {
+      var _getSelectedTableInfo10 = getSelectedTableInfo(state.selection),
+          totalRowCount = _getSelectedTableInfo10.totalRowCount,
+          totalColumnCount = _getSelectedTableInfo10.totalColumnCount;
+
+      return {
+        action: TABLE_ACTION.SORTED_COLUMN,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        attributes: {
+          inputMethod: inputMethod,
+          totalRowCount: totalRowCount,
+          totalColumnCount: totalColumnCount,
+          position: columnIndex,
+          sortOrder: sortOrder,
+          mode: 'editor'
+        },
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(sortByColumn(columnIndex, sortOrder));
+  };
+};
+export var distributeColumnsWidthsWithAnalytics = function distributeColumnsWidthsWithAnalytics(editorAnalyticsAPI) {
+  return function (inputMethod, _ref10) {
+    var resizeState = _ref10.resizeState,
+        table = _ref10.table,
+        attributes = _ref10.attributes;
+    return withEditorAnalyticsAPI(function () {
+      return {
+        action: TABLE_ACTION.DISTRIBUTED_COLUMNS_WIDTHS,
+        actionSubject: ACTION_SUBJECT.TABLE,
+        actionSubjectId: null,
+        attributes: _objectSpread({
+          inputMethod: inputMethod
+        }, attributes),
+        eventType: EVENT_TYPE.TRACK
+      };
+    })(editorAnalyticsAPI)(function (state, dispatch) {
+      if (dispatch) {
+        distributeColumnsWidths(resizeState, table)(state, dispatch);
+      }
+
+      return true;
+    });
+  };
+};
+export var wrapTableInExpandWithAnalytics = function wrapTableInExpandWithAnalytics(editorAnalyticsAPI) {
+  return withEditorAnalyticsAPI(function (state) {
+    var _getSelectedTableInfo11 = getSelectedTableInfo(state.selection),
+        totalRowCount = _getSelectedTableInfo11.totalRowCount,
+        totalColumnCount = _getSelectedTableInfo11.totalColumnCount;
+
+    return {
+      action: TABLE_ACTION.COLLAPSED,
+      actionSubject: ACTION_SUBJECT.TABLE,
+      actionSubjectId: null,
+      attributes: {
+        totalRowCount: totalRowCount,
+        totalColumnCount: totalColumnCount
+      },
+      eventType: EVENT_TYPE.TRACK
+    };
+  })(editorAnalyticsAPI)(wrapTableInExpand);
+}; // #endregion

package/dist/esm/plugins/table/create-plugin-config.js

@@ -0,0 +1,20 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+export var pluginConfig = function pluginConfig() {
+  var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return config.advanced ? _objectSpread({
+    allowBackgroundColor: true,
+    allowColumnResizing: true,
+    allowHeaderColumn: true,
+    allowHeaderRow: true,
+    allowMergeCells: true,
+    allowNumberColumn: true,
+    stickToolbarToBottom: true,
+    permittedLayouts: 'all',
+    allowControls: true
+  }, config) : config;
+};