@atlaskit/editor-plugin-table 5.5.11 → 5.5.12

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/editor-plugin-table
 
+## 5.5.12
+
+### Patch Changes
+
+- [#60612](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/60612) [`7edc766361a2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/7edc766361a2) - Created an EditorCommad on table plugin to insert a table of custom size
+
 ## 5.5.11
 
 ### Patch Changes

package/dist/cjs/plugins/table/commands/insert.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.addColumnAfter = void 0;
 exports.addColumnAt = addColumnAt;
-exports.insertRow = exports.insertColumn = exports.createTable = exports.addColumnBefore = void 0;
+exports.insertTableWithSize = exports.insertRow = exports.insertColumn = exports.createTable = exports.addColumnBefore = void 0;
 var _customSteps = require("@atlaskit/custom-steps");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _state = require("@atlaskit/editor-prosemirror/state");
@@ -154,4 +154,19 @@ var createTable = exports.createTable = function createTable() {
     return true;
   };
 };
-// #endregion
+// #endregion
+
+var insertTableWithSize = exports.insertTableWithSize = function insertTableWithSize(editorAnalyticsAPI) {
+  return function (rowsCount, colsCount, inputMethod) {
+    return function (_ref) {
+      var tr = _ref.tr;
+      var tableNode = (0, _utils2.createTable)({
+        schema: tr.doc.type.schema,
+        rowsCount: rowsCount,
+        colsCount: colsCount
+      });
+      var newTr = (0, _utils.safeInsert)(tableNode)(tr).scrollIntoView();
+      return newTr;
+    };
+  };
+};

package/dist/cjs/plugins/table/index.js

@@ -18,6 +18,7 @@ var _withPluginState = require("@atlaskit/editor-common/with-plugin-state");
 var _pmPlugins = require("@atlaskit/editor-tables/pm-plugins");
 var _utils2 = require("@atlaskit/editor-tables/utils");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
+var _insert = require("./commands/insert");
 var _createPluginConfig = require("./create-plugin-config");
 var _plugin = require("./pm-plugins/analytics/plugin");
 var _pluginKey = require("./pm-plugins/analytics/plugin-key");
@@ -49,7 +50,7 @@ var defaultGetEditorFeatureFlags = function defaultGetEditorFeatureFlags() {
  * from `@atlaskit/editor-core`.
  */
 var tablesPlugin = function tablesPlugin(_ref) {
-  var _api$analytics;
+  var _api$analytics, _api$analytics2;
   var options = _ref.config,
     api = _ref.api;
   var editorViewRef = {
@@ -84,6 +85,9 @@ var tablesPlugin = function tablesPlugin(_ref) {
         };
       }
     },
+    commands: {
+      insertTableWithSize: (0, _insert.insertTableWithSize)(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)
+    },
     nodes: function nodes() {
       var tableNode = options !== null && options !== void 0 && options.tableResizingEnabled ? _adfSchema.tableWithCustomWidth : _adfSchema.table;
       return [{

package/dist/es2019/plugins/table/commands/insert.js

@@ -133,4 +133,18 @@ export const createTable = () => (state, dispatch) => {
   }
   return true;
 };
-// #endregion
+// #endregion
+
+export const insertTableWithSize = editorAnalyticsAPI => (rowsCount, colsCount, inputMethod) => {
+  return ({
+    tr
+  }) => {
+    const tableNode = createTableNode({
+      schema: tr.doc.type.schema,
+      rowsCount: rowsCount,
+      colsCount: colsCount
+    });
+    const newTr = safeInsert(tableNode)(tr).scrollIntoView();
+    return newTr;
+  };
+};

package/dist/es2019/plugins/table/index.js

@@ -11,6 +11,7 @@ import { WithPluginState } from '@atlaskit/editor-common/with-plugin-state';
 import { tableEditing } from '@atlaskit/editor-tables/pm-plugins';
 import { createTable } from '@atlaskit/editor-tables/utils';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { insertTableWithSize } from './commands/insert';
 import { pluginConfig } from './create-plugin-config';
 import { createPlugin as createTableAnalyticsPlugin } from './pm-plugins/analytics/plugin';
 import { pluginKey as tableAnalyticsPluginKey } from './pm-plugins/analytics/plugin-key';
@@ -43,7 +44,7 @@ const tablesPlugin = ({
   config: options,
   api
 }) => {
-  var _api$analytics;
+  var _api$analytics, _api$analytics2;
   const editorViewRef = {
     current: null
   };
@@ -74,6 +75,9 @@ const tablesPlugin = ({
         })) !== null && _api$contentInsertion !== void 0 ? _api$contentInsertion : false;
       }
     },
+    commands: {
+      insertTableWithSize: insertTableWithSize(api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)
+    },
     nodes() {
       const tableNode = options !== null && options !== void 0 && options.tableResizingEnabled ? tableWithCustomWidth : table;
       return [{

package/dist/esm/plugins/table/commands/insert.js

@@ -145,4 +145,19 @@ export var createTable = function createTable() {
     return true;
   };
 };
-// #endregion
+// #endregion
+
+export var insertTableWithSize = function insertTableWithSize(editorAnalyticsAPI) {
+  return function (rowsCount, colsCount, inputMethod) {
+    return function (_ref) {
+      var tr = _ref.tr;
+      var tableNode = createTableNode({
+        schema: tr.doc.type.schema,
+        rowsCount: rowsCount,
+        colsCount: colsCount
+      });
+      var newTr = safeInsert(tableNode)(tr).scrollIntoView();
+      return newTr;
+    };
+  };
+};

package/dist/esm/plugins/table/index.js

@@ -11,6 +11,7 @@ import { WithPluginState } from '@atlaskit/editor-common/with-plugin-state';
 import { tableEditing } from '@atlaskit/editor-tables/pm-plugins';
 import { createTable } from '@atlaskit/editor-tables/utils';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
+import { insertTableWithSize } from './commands/insert';
 import { pluginConfig } from './create-plugin-config';
 import { createPlugin as createTableAnalyticsPlugin } from './pm-plugins/analytics/plugin';
 import { pluginKey as tableAnalyticsPluginKey } from './pm-plugins/analytics/plugin-key';
@@ -42,7 +43,7 @@ var defaultGetEditorFeatureFlags = function defaultGetEditorFeatureFlags() {
  * from `@atlaskit/editor-core`.
  */
 var tablesPlugin = function tablesPlugin(_ref) {
-  var _api$analytics;
+  var _api$analytics, _api$analytics2;
   var options = _ref.config,
     api = _ref.api;
   var editorViewRef = {
@@ -77,6 +78,9 @@ var tablesPlugin = function tablesPlugin(_ref) {
         };
       }
     },
+    commands: {
+      insertTableWithSize: insertTableWithSize(api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.actions)
+    },
     nodes: function nodes() {
       var tableNode = options !== null && options !== void 0 && options.tableResizingEnabled ? tableWithCustomWidth : table;
       return [{

package/dist/types/plugins/table/commands/insert.d.ts

@@ -1,4 +1,5 @@
-import type { Command, GetEditorContainerWidth } from '@atlaskit/editor-common/types';
+import type { EditorAnalyticsAPI, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command, EditorCommand, GetEditorContainerWidth } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 export declare function addColumnAt(getEditorContainerWidth: GetEditorContainerWidth): (column: number, allowAddColumnCustomStep: boolean | undefined, view: EditorView | undefined) => (tr: Transaction) => Transaction;
@@ -7,3 +8,4 @@ export declare const addColumnAfter: (getEditorContainerWidth: GetEditorContaine
 export declare const insertColumn: (getEditorContainerWidth: GetEditorContainerWidth) => (column: number) => Command;
 export declare const insertRow: (row: number, moveCursorToTheNewRow: boolean) => Command;
 export declare const createTable: () => Command;
+export declare const insertTableWithSize: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (rowsCount: number, colsCount: number, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;

package/dist/types/plugins/table/index.d.ts

@@ -1,5 +1,6 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import type { Command, GetEditorFeatureFlags, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command, EditorCommand, GetEditorFeatureFlags, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ContentInsertionPlugin } from '@atlaskit/editor-plugin-content-insertion';
 import type { GuidelinePlugin } from '@atlaskit/editor-plugin-guideline';
@@ -22,6 +23,9 @@ export type TablePlugin = NextEditorPlugin<'table', {
     actions: {
         insertTable: InsertTableAction;
     };
+    commands: {
+        insertTableWithSize: (rowsCount: number, colsCount: number, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
+    };
     dependencies: [
         AnalyticsPlugin,
         ContentInsertionPlugin,

package/dist/types-ts4.5/plugins/table/commands/insert.d.ts

@@ -1,4 +1,5 @@
-import type { Command, GetEditorContainerWidth } from '@atlaskit/editor-common/types';
+import type { EditorAnalyticsAPI, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command, EditorCommand, GetEditorContainerWidth } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 export declare function addColumnAt(getEditorContainerWidth: GetEditorContainerWidth): (column: number, allowAddColumnCustomStep: boolean | undefined, view: EditorView | undefined) => (tr: Transaction) => Transaction;
@@ -7,3 +8,4 @@ export declare const addColumnAfter: (getEditorContainerWidth: GetEditorContaine
 export declare const insertColumn: (getEditorContainerWidth: GetEditorContainerWidth) => (column: number) => Command;
 export declare const insertRow: (row: number, moveCursorToTheNewRow: boolean) => Command;
 export declare const createTable: () => Command;
+export declare const insertTableWithSize: (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) => (rowsCount: number, colsCount: number, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;

package/dist/types-ts4.5/plugins/table/index.d.ts

@@ -1,5 +1,6 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import type { Command, GetEditorFeatureFlags, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
+import type { Command, EditorCommand, GetEditorFeatureFlags, NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import type { ContentInsertionPlugin } from '@atlaskit/editor-plugin-content-insertion';
 import type { GuidelinePlugin } from '@atlaskit/editor-plugin-guideline';
@@ -22,6 +23,9 @@ export type TablePlugin = NextEditorPlugin<'table', {
     actions: {
         insertTable: InsertTableAction;
     };
+    commands: {
+        insertTableWithSize: (rowsCount: number, colsCount: number, inputMethod?: INPUT_METHOD.PICKER | INPUT_METHOD.ASCII | INPUT_METHOD.TYPEAHEAD) => EditorCommand;
+    };
     dependencies: [
         AnalyticsPlugin,
         ContentInsertionPlugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-table",
-  "version": "5.5.11",
+  "version": "5.5.12",
   "description": "Table plugin for the @atlaskit/editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/src/plugins/table/commands/insert.ts

@@ -1,8 +1,13 @@
 // #region Imports
 import { AddColumnStep } from '@atlaskit/custom-steps';
+import type {
+  EditorAnalyticsAPI,
+  INPUT_METHOD,
+} from '@atlaskit/editor-common/analytics';
 import { TABLE_OVERFLOW_CHANGE_TRIGGER } from '@atlaskit/editor-common/analytics';
 import type {
   Command,
+  EditorCommand,
   GetEditorContainerWidth,
 } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -201,3 +206,24 @@ export const createTable = (): Command => (state, dispatch) => {
   return true;
 };
 // #endregion
+
+export const insertTableWithSize =
+  (editorAnalyticsAPI: EditorAnalyticsAPI | undefined) =>
+  (
+    rowsCount: number,
+    colsCount: number,
+    inputMethod?:
+      | INPUT_METHOD.PICKER
+      | INPUT_METHOD.ASCII
+      | INPUT_METHOD.TYPEAHEAD,
+  ): EditorCommand => {
+    return ({ tr }) => {
+      const tableNode = createTableNode({
+        schema: tr.doc.type.schema,
+        rowsCount: rowsCount,
+        colsCount: colsCount,
+      });
+      const newTr = safeInsert(tableNode)(tr).scrollIntoView();
+      return newTr;
+    };
+  };

package/src/plugins/table/index.tsx

@@ -23,6 +23,7 @@ import { toolbarInsertBlockMessages as messages } from '@atlaskit/editor-common/
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import type {
   Command,
+  EditorCommand,
   EditorPlugin,
   GetEditorContainerWidth,
   GetEditorFeatureFlags,
@@ -41,6 +42,7 @@ import { tableEditing } from '@atlaskit/editor-tables/pm-plugins';
 import { createTable } from '@atlaskit/editor-tables/utils';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
 
+import { insertTableWithSize } from './commands/insert';
 import { pluginConfig } from './create-plugin-config';
 import { createPlugin as createTableAnalyticsPlugin } from './pm-plugins/analytics/plugin';
 import { pluginKey as tableAnalyticsPluginKey } from './pm-plugins/analytics/plugin-key';
@@ -78,6 +80,7 @@ import FloatingDragMenu from './ui/FloatingDragMenu';
 import FloatingInsertButton from './ui/FloatingInsertButton';
 import LayoutButton from './ui/LayoutButton';
 import { isLayoutSupported } from './utils';
+
 export interface TablePluginOptions {
   tableOptions: PluginConfig;
   // experimental custom table resizing experience, set inside editor-core behind a feature flag
@@ -103,6 +106,16 @@ export type TablePlugin = NextEditorPlugin<
     actions: {
       insertTable: InsertTableAction;
     };
+    commands: {
+      insertTableWithSize: (
+        rowsCount: number,
+        colsCount: number,
+        inputMethod?:
+          | INPUT_METHOD.PICKER
+          | INPUT_METHOD.ASCII
+          | INPUT_METHOD.TYPEAHEAD,
+      ) => EditorCommand;
+    };
     dependencies: [
       AnalyticsPlugin,
       ContentInsertionPlugin,
@@ -152,6 +165,9 @@ const tablesPlugin: TablePlugin = ({ config: options, api }) => {
           );
         },
     },
+    commands: {
+      insertTableWithSize: insertTableWithSize(api?.analytics?.actions),
+    },
 
     nodes() {
       const tableNode = options?.tableResizingEnabled