@atlaskit/editor-tables 2.1.6 → 2.2.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-tables
 
+## 2.2.1
+
+### Patch Changes
+
+- [`403e0d2d291`](https://bitbucket.org/atlassian/atlassian-frontend/commits/403e0d2d291) - ED-16246 fix prevent @types/prosemirror-commands @types/prosemirror-keymap updating to incompatible version.
+
+## 2.2.0
+
+### Minor Changes
+
+- [`d8acf7254db`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d8acf7254db) - ED-8567 added tracking for fixTables()
+
 ## 2.1.6
 
 ### Patch Changes

package/cell-bookmark/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/cell-bookmark.js",
   "module:es2019": "../dist/es2019/cell-bookmark.js",
   "sideEffects": false,
-  "types": "../dist/types/cell-bookmark.d.ts"
+  "types": "../dist/types/cell-bookmark.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/cell-bookmark.d.ts"
+      ]
+    }
+  }
 }

package/cell-selection/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/cell-selection.js",
   "module:es2019": "../dist/es2019/cell-selection.js",
   "sideEffects": false,
-  "types": "../dist/types/cell-selection.d.ts"
+  "types": "../dist/types/cell-selection.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/cell-selection.d.ts"
+      ]
+    }
+  }
 }

package/dist/cjs/pm-plugins/table-editing.js

@@ -22,7 +22,8 @@ var _pluginKey = require("./plugin-key");
 function tableEditing() {
   var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
       _ref$allowTableNodeSe = _ref.allowTableNodeSelection,
-      allowTableNodeSelection = _ref$allowTableNodeSe === void 0 ? false : _ref$allowTableNodeSe;
+      allowTableNodeSelection = _ref$allowTableNodeSe === void 0 ? false : _ref$allowTableNodeSe,
+      reportFixedTable = _ref.reportFixedTable;
 
   return new _prosemirrorState.Plugin({
     key: _pluginKey.tableEditingKey,
@@ -69,7 +70,7 @@ function tableEditing() {
       handlePaste: _utils.handlePaste
     },
     appendTransaction: function appendTransaction(_, oldState, state) {
-      return (0, _normalizeSelection.normalizeSelection)(state, (0, _fixTables.fixTables)(state, oldState), allowTableNodeSelection);
+      return (0, _normalizeSelection.normalizeSelection)(state, (0, _fixTables.fixTables)(state, oldState, reportFixedTable), allowTableNodeSelection);
     }
   });
 }

package/dist/cjs/utils/fix-tables.js

@@ -60,12 +60,12 @@ function changedDescendants(old, cur, offsetStart, f) {
 // document.
 
 
-function fixTables(state, oldState) {
+function fixTables(state, oldState, reportFixedTable) {
   var tr;
 
   var check = function check(node, pos) {
     if (node.type.spec.tableRole === 'table') {
-      tr = fixTable(state, node, pos, tr);
+      tr = fixTable(state, node, pos, tr, reportFixedTable);
     }
   };
 
@@ -81,7 +81,7 @@ function fixTables(state, oldState) {
 // it was given, if non-null, or create a new one if necessary.
 
 
-function fixTable(state, table, tablePos, transaction) {
+function fixTable(state, table, tablePos, transaction, reportFixedTable) {
   var tr = transaction;
 
   var map = _tableMap.TableMap.get(table);
@@ -105,6 +105,14 @@ function fixTable(state, table, tablePos, transaction) {
   for (var _i = 0; _i < map.problems.length; _i++) {
     var prob = map.problems[_i];
 
+    if (reportFixedTable) {
+      reportFixedTable({
+        state: state,
+        tr: tr,
+        reason: prob.type || 'unknown'
+      });
+    }
+
     if (prob.type === _tableMap.TableProblemTypes.COLLISION) {
       var collision = prob;
       var cell = table.nodeAt(prob.pos);

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-tables",
-	"version": "2.1.6",
+	"version": "2.2.1",
 	"sideEffects": false
 }

package/dist/es2019/pm-plugins/table-editing.js

@@ -18,7 +18,8 @@ import { tableEditingKey } from './plugin-key'; // :: () → Plugin
 // perform more specific behavior.
 
 export function tableEditing({
-  allowTableNodeSelection = false
+  allowTableNodeSelection = false,
+  reportFixedTable
 } = {}) {
   return new Plugin({
     key: tableEditingKey,
@@ -70,7 +71,7 @@ export function tableEditing({
     },
 
     appendTransaction(_, oldState, state) {
-      return normalizeSelection(state, fixTables(state, oldState), allowTableNodeSelection);
+      return normalizeSelection(state, fixTables(state, oldState, reportFixedTable), allowTableNodeSelection);
     }
 
   });

package/dist/es2019/utils/fix-tables.js

@@ -1,10 +1,11 @@
 import { fixTablesKey } from '../pm-plugins/plugin-key';
 import { TableMap, TableProblemTypes } from '../table-map';
 import { removeColSpan } from './colspan';
-import { tableNodeTypes } from './table-node-types'; // Helper for iterating through the nodes in a document that changed
+import { tableNodeTypes } from './table-node-types';
+
+// Helper for iterating through the nodes in a document that changed
 // compared to the given previous document. Useful for avoiding
 // duplicate work on each transaction.
-
 function changedDescendants(old, cur, offsetStart, f) {
   let offset = offsetStart;
   const oldSize = old.childCount;
@@ -40,12 +41,12 @@ function changedDescendants(old, cur, offsetStart, f) {
 // document.
 
 
-export function fixTables(state, oldState) {
+export function fixTables(state, oldState, reportFixedTable) {
   let tr;
 
   const check = (node, pos) => {
     if (node.type.spec.tableRole === 'table') {
-      tr = fixTable(state, node, pos, tr);
+      tr = fixTable(state, node, pos, tr, reportFixedTable);
     }
   };
 
@@ -60,7 +61,7 @@ export function fixTables(state, oldState) {
 // Fix the given table, if necessary. Will append to the transaction
 // it was given, if non-null, or create a new one if necessary.
 
-export function fixTable(state, table, tablePos, transaction) {
+export function fixTable(state, table, tablePos, transaction, reportFixedTable) {
   let tr = transaction;
   const map = TableMap.get(table);
 
@@ -83,6 +84,14 @@ export function fixTable(state, table, tablePos, transaction) {
   for (let i = 0; i < map.problems.length; i++) {
     const prob = map.problems[i];
 
+    if (reportFixedTable) {
+      reportFixedTable({
+        state,
+        tr,
+        reason: prob.type || 'unknown'
+      });
+    }
+
     if (prob.type === TableProblemTypes.COLLISION) {
       const collision = prob;
       const cell = table.nodeAt(prob.pos);

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-tables",
-	"version": "2.1.6",
+	"version": "2.2.1",
 	"sideEffects": false
 }

package/dist/esm/pm-plugins/table-editing.js

@@ -20,7 +20,8 @@ import { tableEditingKey } from './plugin-key'; // :: () → Plugin
 export function tableEditing() {
   var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
       _ref$allowTableNodeSe = _ref.allowTableNodeSelection,
-      allowTableNodeSelection = _ref$allowTableNodeSe === void 0 ? false : _ref$allowTableNodeSe;
+      allowTableNodeSelection = _ref$allowTableNodeSe === void 0 ? false : _ref$allowTableNodeSe,
+      reportFixedTable = _ref.reportFixedTable;
 
   return new Plugin({
     key: tableEditingKey,
@@ -67,7 +68,7 @@ export function tableEditing() {
       handlePaste: handlePaste
     },
     appendTransaction: function appendTransaction(_, oldState, state) {
-      return normalizeSelection(state, fixTables(state, oldState), allowTableNodeSelection);
+      return normalizeSelection(state, fixTables(state, oldState, reportFixedTable), allowTableNodeSelection);
     }
   });
 }

package/dist/esm/utils/fix-tables.js

@@ -7,10 +7,11 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 import { fixTablesKey } from '../pm-plugins/plugin-key';
 import { TableMap, TableProblemTypes } from '../table-map';
 import { removeColSpan } from './colspan';
-import { tableNodeTypes } from './table-node-types'; // Helper for iterating through the nodes in a document that changed
+import { tableNodeTypes } from './table-node-types';
+
+// Helper for iterating through the nodes in a document that changed
 // compared to the given previous document. Useful for avoiding
 // duplicate work on each transaction.
-
 function changedDescendants(old, cur, offsetStart, f) {
   var offset = offsetStart;
   var oldSize = old.childCount;
@@ -46,12 +47,12 @@ function changedDescendants(old, cur, offsetStart, f) {
 // document.
 
 
-export function fixTables(state, oldState) {
+export function fixTables(state, oldState, reportFixedTable) {
   var tr;
 
   var check = function check(node, pos) {
     if (node.type.spec.tableRole === 'table') {
-      tr = fixTable(state, node, pos, tr);
+      tr = fixTable(state, node, pos, tr, reportFixedTable);
     }
   };
 
@@ -66,7 +67,7 @@ export function fixTables(state, oldState) {
 // Fix the given table, if necessary. Will append to the transaction
 // it was given, if non-null, or create a new one if necessary.
 
-export function fixTable(state, table, tablePos, transaction) {
+export function fixTable(state, table, tablePos, transaction, reportFixedTable) {
   var tr = transaction;
   var map = TableMap.get(table);
 
@@ -89,6 +90,14 @@ export function fixTable(state, table, tablePos, transaction) {
   for (var _i = 0; _i < map.problems.length; _i++) {
     var prob = map.problems[_i];
 
+    if (reportFixedTable) {
+      reportFixedTable({
+        state: state,
+        tr: tr,
+        reason: prob.type || 'unknown'
+      });
+    }
+
     if (prob.type === TableProblemTypes.COLLISION) {
       var collision = prob;
       var cell = table.nodeAt(prob.pos);

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-tables",
-	"version": "2.1.6",
+	"version": "2.2.1",
 	"sideEffects": false
 }

package/dist/types/pm-plugins/table-editing.d.ts

@@ -1,6 +1,8 @@
 import { Plugin } from 'prosemirror-state';
+import { ReportFixedTable } from '../utils/fix-tables';
 declare type PluginState = number | null;
-export declare function tableEditing({ allowTableNodeSelection }?: {
-    allowTableNodeSelection?: boolean | undefined;
+export declare function tableEditing({ allowTableNodeSelection, reportFixedTable, }?: {
+    allowTableNodeSelection?: boolean;
+    reportFixedTable?: ReportFixedTable;
 }): Plugin<PluginState>;
 export {};

package/dist/types/utils/fix-tables.d.ts

@@ -1,4 +1,9 @@
 import { Node } from 'prosemirror-model';
 import { EditorState, Transaction } from 'prosemirror-state';
-export declare function fixTables(state: EditorState, oldState?: EditorState): Transaction | undefined;
-export declare function fixTable(state: EditorState, table: Node, tablePos: number, transaction?: Transaction): Transaction | undefined;
+export declare type ReportFixedTable = ({ state, tr, reason, }: {
+    state: EditorState;
+    tr: Transaction;
+    reason: string;
+}) => void;
+export declare function fixTables(state: EditorState, oldState?: EditorState, reportFixedTable?: ReportFixedTable): Transaction | undefined;
+export declare function fixTable(state: EditorState, table: Node, tablePos: number, transaction?: Transaction, reportFixedTable?: ReportFixedTable): Transaction | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-tables",
-  "version": "2.1.6",
+  "version": "2.2.1",
   "description": "A package that contains common classes and utility functions for editor tables",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@atlaskit/adf-schema": "^24.0.0",
-    "@atlaskit/editor-test-helpers": "^17.1.0",
+    "@atlaskit/editor-test-helpers": "^17.2.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1"
   },
   "techstack": {
@@ -42,8 +42,11 @@
     },
     "@repo/internal": {
       "deprecation": "no-deprecated-imports",
-      "theming": "tokens"
+      "theming": "tokens",
+      "styling": [
+        "emotion"
+      ]
     }
   },
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
-}
+}

package/pm-plugins/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/pm-plugins.js",
   "module:es2019": "../dist/es2019/pm-plugins.js",
   "sideEffects": false,
-  "types": "../dist/types/pm-plugins.d.ts"
+  "types": "../dist/types/pm-plugins.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/pm-plugins.d.ts"
+      ]
+    }
+  }
 }

package/report.api.md

@@ -2,6 +2,12 @@
 
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
 
+<!--
+	Generated API Report version: 2.0
+-->
+
+[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
 ```ts
 import { ContentNodeWithPos } from 'prosemirror-utils';
 import { Mapping } from 'prosemirror-transform';
@@ -11,127 +17,184 @@ import { Selection as Selection_2 } from 'prosemirror-state';
 import { Slice } from 'prosemirror-model';
 import { Transaction } from 'prosemirror-state';
 
-declare type Axis = 'horiz' | 'vert';
+// @public (undocumented)
+type Axis = 'horiz' | 'vert';
 
-declare class CellBookmark {
+// @public (undocumented)
+class CellBookmark {
+  constructor(anchor: number, head: number);
+  // (undocumented)
   readonly anchor: number;
+  // (undocumented)
   readonly head: number;
-  constructor(anchor: number, head: number);
+  // (undocumented)
   map(mapping: Mapping): CellBookmark;
+  // (undocumented)
   resolve(doc: Node_2): Selection_2;
 }
 
-export declare class CellSelection extends Selection_2 {
+// @public (undocumented)
+export class CellSelection extends Selection_2 {
+  // (undocumented)
   readonly $anchorCell: ResolvedPos;
+  // (undocumented)
   readonly $headCell: ResolvedPos;
-  readonly visible: boolean;
   constructor($anchorCell: ResolvedPos, $headCell?: ResolvedPos);
-  map(doc: Node_2, mapping: Mapping): Selection_2;
-  content(): Slice;
-  replace(tr: Transaction, content?: Slice<any>): void;
-  replaceWith(tr: Transaction, node: Node_2): void;
-  forEachCell(f: (node: Node_2, pos: number) => void): void;
-  isColSelection(): boolean;
+  // (undocumented)
   static colSelection(
     $anchorCell: ResolvedPos,
     $headCell?: ResolvedPos,
   ): CellSelection;
-  isRowSelection(): boolean;
-  eq(other: CellSelection): boolean;
-  static rowSelection(
-    $anchorCell: ResolvedPos,
-    $headCell?: ResolvedPos,
-  ): CellSelection;
-  toJSON(): SerializedCellSelection;
-  static fromJSON(doc: Node_2, json: SerializedCellSelection): CellSelection;
+  // (undocumented)
+  content(): Slice;
+  // (undocumented)
   static create(
     doc: Node_2,
     anchorCell: number,
     headCell?: number,
   ): CellSelection;
+  // (undocumented)
+  eq(other: CellSelection): boolean;
+  // (undocumented)
+  forEachCell(f: (node: Node_2, pos: number) => void): void;
+  // (undocumented)
+  static fromJSON(doc: Node_2, json: SerializedCellSelection): CellSelection;
+  // (undocumented)
   getBookmark(): CellBookmark;
+  // (undocumented)
+  isColSelection(): boolean;
+  // (undocumented)
+  isRowSelection(): boolean;
+  // (undocumented)
+  map(doc: Node_2, mapping: Mapping): Selection_2;
+  // (undocumented)
+  replace(tr: Transaction, content?: Slice<any>): void;
+  // (undocumented)
+  replaceWith(tr: Transaction, node: Node_2): void;
+  // (undocumented)
+  static rowSelection(
+    $anchorCell: ResolvedPos,
+    $headCell?: ResolvedPos,
+  ): CellSelection;
+  // (undocumented)
+  toJSON(): SerializedCellSelection;
+  // (undocumented)
+  readonly visible: boolean;
 }
 
-export declare const findTable: (
+// @public (undocumented)
+export const findTable: (
   selection: Selection_2,
 ) => ContentNodeWithPos | undefined;
 
-export declare class Rect {
+// @public (undocumented)
+export class Rect {
+  constructor(left: number, top: number, right: number, bottom: number);
+  // (undocumented)
+  bottom: number;
+  // (undocumented)
   left: number;
-  top: number;
+  // (undocumented)
   right: number;
-  bottom: number;
-  constructor(left: number, top: number, right: number, bottom: number);
+  // (undocumented)
+  top: number;
 }
 
-declare interface SerializedCellSelection {
-  type: 'cell';
+// @public (undocumented)
+interface SerializedCellSelection {
+  // (undocumented)
   anchor: number;
+  // (undocumented)
   head: number;
+  // (undocumented)
+  type: 'cell';
 }
 
-export declare class TableMap {
-  width: number;
-  height: number;
-  map: number[];
-  problems?: TableProblem[] | null;
+// @public (undocumented)
+export class TableMap {
   constructor(
     width: number,
     height: number,
     map: number[],
     problems?: TableProblem[] | null,
   );
-  findCell(pos: number): Rect;
+  // (undocumented)
+  cellsInRect(rect: Rect): number[];
+  // (undocumented)
   colCount(pos: number): number;
+  // (undocumented)
+  findCell(pos: number): Rect;
+  // (undocumented)
+  static get(table: Node_2): TableMap;
+  // (undocumented)
+  height: number;
+  // (undocumented)
+  map: number[];
+  // (undocumented)
   nextCell(pos: number, axis: Axis, dir: number): number | null;
-  rectBetween(a: number, b: number): Rect;
-  cellsInRect(rect: Rect): number[];
+  // (undocumented)
   positionAt(row: number, col: number, table: Node_2): number;
-  static get(table: Node_2): TableMap;
+  // (undocumented)
+  problems?: TableProblem[] | null;
+  // (undocumented)
+  rectBetween(a: number, b: number): Rect;
+  // (undocumented)
+  width: number;
 }
 
-declare type TableProblem =
+// @public (undocumented)
+type TableProblem =
   | TableProblemCollision
   | TableProblemLongRowspan
   | TableProblemMissing
   | TableProblemColWidthMismatch;
 
-declare type TableProblemCollision = {
+// @public (undocumented)
+type TableProblemCollision = {
   type: TableProblemTypes.COLLISION;
   row: number;
   pos: number;
   n: number;
 };
 
-declare type TableProblemColWidthMismatch = {
+// @public (undocumented)
+type TableProblemColWidthMismatch = {
   type: TableProblemTypes;
   pos: number;
   colwidth: number;
 };
 
-declare type TableProblemLongRowspan = {
+// @public (undocumented)
+type TableProblemLongRowspan = {
   type: TableProblemTypes.OVERLONG_ROWSPAN;
   pos: number;
   n: number;
 };
 
-declare type TableProblemMissing = {
+// @public (undocumented)
+type TableProblemMissing = {
   type: TableProblemTypes.MISSING;
   row: number;
   n: number;
 };
 
-declare enum TableProblemTypes {
+// @public (undocumented)
+enum TableProblemTypes {
+  // (undocumented)
   COLLISION = 'collision',
-  OVERLONG_ROWSPAN = 'overlong_rowspan',
-  MISSING = 'missing',
+  // (undocumented)
   COLWIDTH_MISMATCH = 'colwidth mismatch',
+  // (undocumented)
+  MISSING = 'missing',
+  // (undocumented)
+  OVERLONG_ROWSPAN = 'overlong_rowspan',
 }
 
-export declare const uuid: {
+// @public (undocumented)
+export const uuid: {
   setStatic(value: string | false): void;
   generate(): string;
 };
 
-export {};
+// (No @packageDocumentation comment for this package)
 ```

package/table-map/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/table-map.js",
   "module:es2019": "../dist/es2019/table-map.js",
   "sideEffects": false,
-  "types": "../dist/types/table-map.d.ts"
+  "types": "../dist/types/table-map.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/table-map.d.ts"
+      ]
+    }
+  }
 }

package/types/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/types.js",
   "module:es2019": "../dist/es2019/types.js",
   "sideEffects": false,
-  "types": "../dist/types/types.d.ts"
+  "types": "../dist/types/types.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/types.d.ts"
+      ]
+    }
+  }
 }

package/utils/package.json

@@ -4,5 +4,12 @@
   "module": "../dist/esm/utils.js",
   "module:es2019": "../dist/es2019/utils.js",
   "sideEffects": false,
-  "types": "../dist/types/utils.d.ts"
+  "types": "../dist/types/utils.d.ts",
+  "typesVersions": {
+    ">=4.0 <4.5": {
+      "*": [
+        "../dist/types-ts4.0/utils.d.ts"
+      ]
+    }
+  }
 }