@atlaskit/editor-plugin-base 0.1.0

package/dist/types-ts4.5/pm-plugins/fix-chrome-88-selection.d.ts

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const fixChromeSelectionKey: PluginKey<any>;
+declare const _default: () => SafePlugin<any>;
+export default _default;

package/dist/types-ts4.5/pm-plugins/frozen-editor.d.ts

@@ -0,0 +1,12 @@
+import type { DispatchAnalyticsEvent } from '@atlaskit/editor-common/analytics';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { BrowserFreezetracking, InputTracking } from '@atlaskit/editor-common/types';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const frozenEditorPluginKey: PluginKey<any>;
+export declare const DEFAULT_FREEZE_THRESHOLD = 600;
+export declare const NORMAL_SEVERITY_THRESHOLD = 2000;
+export declare const DEGRADED_SEVERITY_THRESHOLD = 3000;
+export declare const DEFAULT_TRACK_SEVERITY_THRESHOLD_NORMAL = 100;
+export declare const DEFAULT_TRACK_SEVERITY_THRESHOLD_DEGRADED = 500;
+declare const _default: (dispatchAnalyticsEvent: DispatchAnalyticsEvent, inputTracking?: InputTracking, browserFreezeTracking?: BrowserFreezetracking, ufo?: boolean) => SafePlugin<any>;
+export default _default;

package/dist/types-ts4.5/pm-plugins/inline-cursor-target.d.ts

@@ -0,0 +1,17 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { Node } from '@atlaskit/editor-prosemirror/model';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { Decoration } from '@atlaskit/editor-prosemirror/view';
+export declare const inlineCursorTargetStateKey: PluginKey<any>;
+export declare const isInlineNodeView: (node: Node | null | undefined) => boolean | null | undefined;
+export interface InlineCursorTargetState {
+    cursorTarget?: {
+        decorations: (Decoration | null)[];
+        positions: {
+            from: number;
+            to: number;
+        };
+    };
+}
+declare const _default: () => SafePlugin<InlineCursorTargetState>;
+export default _default;

package/dist/types-ts4.5/pm-plugins/newline-preserve-marks.d.ts

@@ -0,0 +1,5 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export declare const newlinePreserveMarksKey: PluginKey<any>;
+declare const _default: () => SafePlugin<any>;
+export default _default;

package/dist/types-ts4.5/pm-plugins/scroll-gutter/index.d.ts

@@ -0,0 +1,22 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export declare const getKeyboardHeight: (state?: EditorState) => number | undefined;
+export type ScrollGutterPluginOptions = {
+    /** Element the page uses for scrolling */
+    getScrollElement?: (view: EditorView) => HTMLElement | null;
+    /**
+     * Whether to allow custom functionality to scroll to gutter element in
+     * plugin's handleScrollToSelection function
+     * Default is true
+     */
+    allowCustomScrollHandler?: boolean;
+    /**
+     * Persist scroll gutter when the mobile appearance is COMPACT
+     * Default is false
+     */
+    persistScrollGutter?: boolean;
+    gutterSize?: number;
+};
+declare const _default: (pluginOptions?: ScrollGutterPluginOptions) => SafePlugin<{}> | undefined;
+export default _default;

package/dist/types-ts4.5/pm-plugins/scroll-gutter/plugin-key.d.ts

@@ -0,0 +1,7 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export type ScrollGutterPluginState = {
+    keyboardHeight: number;
+};
+export declare const scrollGutterPluginKey: PluginKey<ScrollGutterPluginState>;
+export declare const getScrollGutterPluginState: (state?: EditorState) => ScrollGutterPluginState | undefined;

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+export type CommandDispatch = (tr: Transaction) => void;
+export type Command = (state: EditorState, dispatch?: CommandDispatch, view?: EditorView) => boolean;

package/dist/types-ts4.5/utils/frozen-editor.d.ts

@@ -0,0 +1,2 @@
+/** Allows the possibility of overriding interaction type values in unit tests via jest.mock or spyOn. */
+export declare const setInteractionType: <T>(value: T) => T;

package/dist/types-ts4.5/utils/input-latency-tracking.d.ts

@@ -0,0 +1,42 @@
+import type { SEVERITY } from '@atlaskit/editor-common/utils';
+interface Opts {
+    dispatchAverage?: (data: {
+        mean: number;
+        median: number;
+        sampleSize: number;
+    }, severity: SEVERITY) => void;
+    dispatchSample?: (sample: number, severity: SEVERITY) => void;
+    onSampleStart?: () => void;
+    onSampleEnd?: (time: number, info: {
+        isSlow: boolean;
+        severity: SEVERITY;
+    }) => void;
+    onSlowInput?: (time: number) => void;
+    samplingRate: number;
+    slowThreshold: number;
+    normalThreshold: number;
+    degradedThreshold: number;
+}
+export default class InputLatencyTracker {
+    private samples;
+    private total;
+    private samplingRate;
+    private slowThreshold;
+    private normalThreshold;
+    private degradedThreshold;
+    private dispatchAverage;
+    private dispatchSample;
+    private onSampleStart;
+    private onSampleEnd;
+    private onSlowInput;
+    constructor({ samplingRate, slowThreshold, normalThreshold, degradedThreshold, dispatchAverage, dispatchSample, onSampleStart, onSampleEnd, onSlowInput, }: Opts);
+    start(): () => void;
+    flush(): void;
+    private dispatch;
+    private push;
+    private severity;
+    private getLast;
+    private getMean;
+    private getMedian;
+}
+export {};

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@atlaskit/editor-plugin-base",
+  "version": "0.1.0",
+  "description": "Base plugin for @atlaskit/editor-core",
+  "author": "Atlassian Pty Ltd",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "atlassian": {
+    "team": "Editor",
+    "singleton": true,
+    "releaseModel": "continuous"
+  },
+  "repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "module:es2019": "dist/es2019/index.js",
+  "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
+  "sideEffects": false,
+  "atlaskit:src": "src/index.ts",
+  "af:exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "@atlaskit/adf-schema": "^29.1.0",
+    "@atlaskit/editor-common": "^76.0.0",
+    "@atlaskit/editor-plugin-feature-flags": "^1.0.1",
+    "@atlaskit/editor-prosemirror": "1.1.0",
+    "@atlaskit/platform-feature-flags": "^0.2.0",
+    "@babel/runtime": "^7.0.0"
+  },
+  "devDependencies": {
+    "@atlaskit/editor-plugin-analytics": "^0.2.0",
+    "@atlaskit/editor-plugin-content-insertion": "^0.1.0",
+    "@atlaskit/editor-plugin-emoji": "^0.3.0",
+    "@atlaskit/editor-plugin-guideline": "^0.5.0",
+    "@atlaskit/editor-plugin-table": "^4.0.0",
+    "@atlaskit/editor-plugin-width": "^0.2.0",
+    "@atlaskit/util-data-test": "^17.8.0",
+    "@atlaskit/webdriver-runner": "*",
+    "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
+    "@testing-library/react": "^12.1.5",
+    "raf-stub": "^2.0.1"
+  },
+  "techstack": {
+    "@atlassian/frontend": {
+      "import-structure": [
+        "atlassian-conventions"
+      ],
+      "circular-dependencies": [
+        "file-and-folder-level"
+      ]
+    },
+    "@repo/internal": {
+      "dom-events": "use-bind-event-listener",
+      "analytics": [
+        "analytics-next"
+      ],
+      "design-tokens": [
+        "color"
+      ],
+      "theming": [
+        "react-context"
+      ],
+      "ui-components": [
+        "lite-mode"
+      ],
+      "deprecation": [
+        "no-deprecated-imports"
+      ],
+      "styling": [
+        "static",
+        "emotion"
+      ]
+    }
+  },
+  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0",
+  "platform-feature-flags": {
+    "platform.editor.disable-chrome-88-selection-fix_uk53m": {
+      "type": "boolean"
+    }
+  }
+}

package/report.api.md

@@ -0,0 +1,89 @@
+<!-- API Report Version: 2.3 -->
+
+## API Report File for "@atlaskit/editor-plugin-base"
+
+> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
+> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
+
+### Table of contents
+
+- [Main Entry Types](#main-entry-types)
+- [Peer Dependencies](#peer-dependencies)
+
+### Main Entry Types
+
+<!--SECTION START: Main Entry Types-->
+
+```ts
+import type { BrowserFreezetracking } from '@atlaskit/editor-common/types';
+import type { Command } from '@atlaskit/editor-common/types';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { InputTracking } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+export type BasePlugin = NextEditorPlugin<
+  'base',
+  {
+    pluginConfiguration: BasePluginOptions | undefined;
+    dependencies: [FeatureFlagsPlugin];
+    sharedState: BasePluginState;
+  }
+>;
+
+// @public (undocumented)
+export const basePlugin: BasePlugin;
+
+// @public (undocumented)
+export interface BasePluginOptions {
+  // (undocumented)
+  allowInlineCursorTarget?: boolean;
+  // (undocumented)
+  allowScrollGutter?: ScrollGutterPluginOptions;
+  // (undocumented)
+  browserFreezeTracking?: BrowserFreezetracking;
+  // (undocumented)
+  inputTracking?: InputTracking;
+  // (undocumented)
+  ufo?: boolean;
+}
+
+// @public (undocumented)
+export type BasePluginState = {
+  contextIdentifier: ContextIdentifierProvider | undefined;
+  keyboardHeight: number | undefined;
+};
+
+// @public (undocumented)
+export const DEGRADED_SEVERITY_THRESHOLD = 3000;
+
+// @public (undocumented)
+export const NORMAL_SEVERITY_THRESHOLD = 2000;
+
+// @public (undocumented)
+export type ScrollGutterPluginOptions = {
+  getScrollElement?: (view: EditorView) => HTMLElement | null;
+  allowCustomScrollHandler?: boolean;
+  persistScrollGutter?: boolean;
+  gutterSize?: number;
+};
+
+// @public (undocumented)
+export const setKeyboardHeight: (keyboardHeight: number) => Command;
+
+// (No @packageDocumentation comment for this package)
+```
+
+<!--SECTION END: Main Entry Types-->
+
+### Peer Dependencies
+
+<!--SECTION START: Peer Dependencies-->
+
+```json
+{}
+```
+
+<!--SECTION END: Peer Dependencies-->

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

@@ -0,0 +1,64 @@
+## API Report File for "@atlaskit/editor-plugin-base"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { BrowserFreezetracking } from '@atlaskit/editor-common/types';
+import type { Command } from '@atlaskit/editor-common/types';
+import type { ContextIdentifierProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { InputTracking } from '@atlaskit/editor-common/types';
+import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+
+// @public (undocumented)
+export type BasePlugin = NextEditorPlugin<'base', {
+    pluginConfiguration: BasePluginOptions | undefined;
+    dependencies: [FeatureFlagsPlugin];
+    sharedState: BasePluginState;
+}>;
+
+// @public (undocumented)
+export const basePlugin: BasePlugin;
+
+// @public (undocumented)
+export interface BasePluginOptions {
+    // (undocumented)
+    allowInlineCursorTarget?: boolean;
+    // (undocumented)
+    allowScrollGutter?: ScrollGutterPluginOptions;
+    // (undocumented)
+    browserFreezeTracking?: BrowserFreezetracking;
+    // (undocumented)
+    inputTracking?: InputTracking;
+    // (undocumented)
+    ufo?: boolean;
+}
+
+// @public (undocumented)
+export type BasePluginState = {
+    contextIdentifier: ContextIdentifierProvider | undefined;
+    keyboardHeight: number | undefined;
+};
+
+// @public (undocumented)
+export const DEGRADED_SEVERITY_THRESHOLD = 3000;
+
+// @public (undocumented)
+export const NORMAL_SEVERITY_THRESHOLD = 2000;
+
+// @public (undocumented)
+export type ScrollGutterPluginOptions = {
+    getScrollElement?: (view: EditorView) => HTMLElement | null;
+    allowCustomScrollHandler?: boolean;
+    persistScrollGutter?: boolean;
+    gutterSize?: number;
+};
+
+// @public (undocumented)
+export const setKeyboardHeight: (keyboardHeight: number) => Command;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/tsconfig.app.json

@@ -0,0 +1,45 @@
+{
+  "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"
+  ],
+  "compilerOptions": {
+    "baseUrl": "",
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__editor-plugin-base/app"
+  },
+  "references": [
+    {
+      "path": "../editor-common/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-feature-flags/tsconfig.app.json"
+    },
+    {
+      "path": "../../platform/feature-flags/tsconfig.app.json"
+    }
+  ]
+}

package/tsconfig.dev.json

@@ -0,0 +1,81 @@
+{
+  "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"
+  ],
+  "exclude": ["./dist/**/*", "./build/**/*", "./node_modules/**/*"],
+  "compilerOptions": {
+    "baseUrl": "",
+    "composite": true,
+    "outDir": "../../../tsDist/@atlaskit__editor-plugin-base/dev"
+  },
+  "references": [
+    {
+      "path": "tsconfig.app.json"
+    },
+    {
+      "path": "../../../build/website/docs/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-emoji/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-feature-flags/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-guideline/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-table/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-plugin-width/tsconfig.app.json"
+    },
+    {
+      "path": "../editor-test-helpers/tsconfig.app.json"
+    },
+    {
+      "path": "../../design-system/tokens/tsconfig.app.json"
+    },
+    {
+      "path": "../../elements/util-data-test/tsconfig.app.json"
+    },
+    {
+      "path": "../../../build/test-tooling/webdriver-runner/tsconfig.app.json"
+    }
+  ]
+}