@atlaskit/editor-plugin-table 2.11.0 → 2.12.0

package/docs/0-intro.tsx

@@ -0,0 +1,53 @@
+import React from 'react';
+
+import { AtlassianInternalWarning, code, md } from '@atlaskit/docs';
+import { createEditorUseOnlyNotice } from '@atlaskit/editor-core/docs/editor-use-only';
+import { token } from '@atlaskit/tokens';
+
+export default md`
+
+${createEditorUseOnlyNotice('Editor Plugin Table', [
+  { name: 'Editor Core', link: '/packages/editor/editor-core' },
+])}
+
+
+  ${(
+    <div style={{ marginTop: token('space.100', '8px') }}>
+      <AtlassianInternalWarning />
+    </div>
+  )}
+
+  This package includes the table plugin used by \`@atlaskit/editor-core\`.
+
+  ## Usage
+---
+
+The \`dependencies\`, \`configuration\`, \`state\`, \`actions\`, and \`commands\` of the plugin are defined
+below:  
+
+${code`
+type TablePlugin = NextEditorPlugin<
+  'table',
+  {
+    pluginConfiguration: TablePluginOptions | undefined;
+    actions: {
+      insertTable: InsertTableAction;
+    };
+    dependencies: [
+      AnalyticsPlugin,
+      ContentInsertionPlugin,
+      WidthPlugin,
+      GuidelinePlugin,
+    ];
+  }
+>;
+`}
+
+
+  ## Support
+---
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+## License
+---
+ Please see [Atlassian Frontend - License](https://developer.atlassian.com/cloud/framework/atlassian-frontend/#license) for more licensing information.
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-table",
-  "version": "2.11.0",
+  "version": "2.12.0",
   "description": "Table plugin for the @atlaskit/editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -28,17 +28,17 @@
   },
   "dependencies": {
     "@atlaskit/adf-schema": "28.1.2",
-    "@atlaskit/editor-common": "^74.54.0",
+    "@atlaskit/editor-common": "^74.55.0",
     "@atlaskit/editor-palette": "1.5.1",
-    "@atlaskit/editor-plugin-analytics": "^0.1.0",
-    "@atlaskit/editor-plugin-content-insertion": "^0.0.11",
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-plugin-content-insertion": "^0.1.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-shared-styles": "^2.6.0",
     "@atlaskit/editor-tables": "^2.3.0",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/platform-feature-flags": "^0.2.1",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.17.0",
+    "@atlaskit/tokens": "^1.18.0",
     "@atlaskit/tooltip": "^17.8.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
@@ -55,12 +55,12 @@
   },
   "devDependencies": {
     "@atlaskit/analytics-next": "^9.1.0",
-    "@atlaskit/editor-plugin-decorations": "^0.1.0",
-    "@atlaskit/editor-plugin-feature-flags": "^0.1.3",
-    "@atlaskit/editor-plugin-grid": "^0.1.0",
-    "@atlaskit/editor-plugin-guideline": "^0.4.0",
-    "@atlaskit/editor-plugin-hyperlink": "^0.3.0",
-    "@atlaskit/editor-plugin-width": "^0.1.0",
+    "@atlaskit/editor-plugin-decorations": "^0.2.0",
+    "@atlaskit/editor-plugin-feature-flags": "^0.2.0",
+    "@atlaskit/editor-plugin-grid": "^0.2.0",
+    "@atlaskit/editor-plugin-guideline": "^0.5.0",
+    "@atlaskit/editor-plugin-hyperlink": "^0.4.0",
+    "@atlaskit/editor-plugin-width": "^0.2.0",
     "@atlaskit/visual-regression": "*",
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",

package/report.api.md

@@ -117,7 +117,7 @@ interface TablePluginOptions {
   wasFullWidthEnabled?: boolean;
 }
 
-// @public (undocumented)
+// @public
 export const tablesPlugin: TablePlugin;
 
 // (No @packageDocumentation comment for this package)

package/src/plugins/table/index.tsx

@@ -104,6 +104,10 @@ export type TablePlugin = NextEditorPlugin<
   }
 >;
 
+/**
+ * Table plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
 const tablesPlugin: TablePlugin = ({ config: options, api }) => {
   const editorViewRef: Record<'current', EditorView | null> = { current: null };
   const defaultGetEditorContainerWidth: GetEditorContainerWidth = () => {

package/tmp/api-report-tmp.d.ts

@@ -103,7 +103,7 @@ interface TablePluginOptions {
     wasFullWidthEnabled?: boolean;
 }
 
-// @public (undocumented)
+// @public
 export const tablesPlugin: TablePlugin;
 
 // (No @packageDocumentation comment for this package)

package/tsconfig.app.json

@@ -0,0 +1,82 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "include": ["./src/**/*.ts", "./src/**/*.tsx"],
+  "exclude": [
+    "**/docs/**/*",
+    "**/__tests__/**/*",
+    "**/vr-tests/**/*",
+    "**/__perf__/**/*",
+    "**/*.test.*",
+    "**/test.*",
+    "**/test-*",
+    "**/examples.ts",
+    "**/examples.tsx",
+    "**/examples/*.ts",
+    "**/examples/*.tsx",
+    "**/examples/**/*.ts",
+    "**/examples/**/*.tsx",
+    "**/storybook/**/*",
+    "**/constellation/**/*",
+    ".storybook/*",
+    "./__fixtures__/**/*",
+    "./__generated__/**/*",
+    "./mocks/**/*",
+    "./__mocks__/**/*",
+    "**/mock.*",
+    "**/codemods/**/*.ts",
+    "**/codemods/**/*.tsx",
+    "./src/plugins/table/nodeviews/__mocks__/**/*"
+  ],
+  "compilerOptions": {
+    "baseUrl": "./",
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__editor-plugin-table/app"
+  },
+  "references": [
+    {
+      "path": "../adf-schema/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-common/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-palette/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-analytics/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-content-insertion/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-guideline/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-width/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-prosemirror/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-shared-styles/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-tables/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/icon/tsconfig.app.json"
+    },
+    {
+      "path": "../../platform/feature-flags/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/theme/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/tokens/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/tooltip/tsconfig.app.json"
+    }
+  ]
+}

package/tsconfig.dev.json

@@ -0,0 +1,112 @@
+{
+  "extends": "../../../tsconfig.base.json",
+  "include": [
+    "**/docs/**/*",
+    "**/__tests__/**/*",
+    "**/vr-tests/**/*",
+    "**/__perf__/**/*",
+    "**/*.test.*",
+    "**/test.*",
+    "**/test-*",
+    "**/examples.ts",
+    "**/examples.tsx",
+    "**/examples/*.ts",
+    "**/examples/*.tsx",
+    "**/examples/**/*.ts",
+    "**/examples/**/*.tsx",
+    "**/storybook/**/*",
+    "**/constellation/**/*",
+    ".storybook/*",
+    "./__fixtures__/**/*",
+    "./__generated__/**/*",
+    "./mocks/**/*",
+    "./__mocks__/**/*",
+    "**/mock.*",
+    "**/codemods/**/*.ts",
+    "**/codemods/**/*.tsx",
+    "./src/plugins/table/nodeviews/__mocks__/**/*"
+  ],
+  "exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
+  "compilerOptions": {
+    "baseUrl": "./",
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__editor-plugin-table/dev"
+  },
+  "references": [
+    {
+      "path": "tsconfig.app.json"
+    },
+    {
+      "path": "../adf-schema/tsconfig.app.json"
+    },
+    {
+      "path": "../../analytics/analytics-next/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/button/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-common/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-core/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-analytics/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-content-insertion/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-decorations/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-feature-flags/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-grid/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-guideline/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-width/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-prosemirror/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-shared-styles/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-tables/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-test-helpers/tsconfig.app.json"
+    },
+    {
+      "path": "../../linking-platform/link-provider/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/logo/tsconfig.app.json"
+    },
+    {
+      "path": "../../media/media-integration-test-helpers/tsconfig.app.json"
+    },
+    {
+      "path": "../synchrony-test-helpers/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/theme/tsconfig.app.json"
+    },
+    {
+      "path": "../../../build/test-tooling/visual-regression/tsconfig.app.json"
+    },
+    {
+      "path": "../../../build/test-tooling/webdriver-runner/tsconfig.app.json"
+    },
+    {
+      "path": "../../platform/feature-flags-test-utils/tsconfig.app.json"
+    }
+  ]
+}