@atlaskit/editor-common 74.41.2 → 74.42.1

package/dist/types/preset/plugin-injection-api.d.ts

@@ -1,9 +1,14 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { DefaultEditorPlugin, NextEditorPlugin, PluginDependenciesAPI, PluginInjectionAPI } from '../types/next-editor-plugin';
+import type { PluginCommand } from '../types/plugin-command';
 type NextEditorPluginInitializedType = ReturnType<NextEditorPlugin<any>>;
 type SharedStateAPIProps = {
     getEditorState: () => EditorState | undefined;
 };
+interface PluginInjectionAPIProps extends SharedStateAPIProps {
+    getEditorView: () => EditorView | undefined;
+}
 type EditorStateDiff = {
     readonly newEditorState: EditorState;
     readonly oldEditorState: EditorState | undefined;
@@ -34,10 +39,13 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
     private actionsAPI;
     private commandsAPI;
     private plugins;
-    constructor({ getEditorState }: SharedStateAPIProps);
+    private getEditorView;
+    constructor({ getEditorState, getEditorView }: PluginInjectionAPIProps);
     api<T extends NextEditorPlugin<any, any>>(): {
         dependencies: import("../types/next-editor-plugin").CreatePluginDependenciesAPI<[NextEditorPlugin<T extends (config?: any, api?: PluginInjectionAPI<infer Name extends string, any> | undefined) => DefaultEditorPlugin<infer Name extends string, any> ? Name : never, T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never>, ..."dependencies" extends keyof (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never) ? (T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"] extends (((config?: any, api?: PluginInjectionAPI<any, any> | undefined) => DefaultEditorPlugin<any, any>) | import("../types/next-editor-plugin").OptionalPlugin<(config?: any, api?: PluginInjectionAPI<any, any> | undefined) => DefaultEditorPlugin<any, any>>)[] ? Exclude<(T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never)["dependencies"], undefined> : [] : []]>;
+        executeCommand: (command: PluginCommand | undefined) => boolean;
     };
+    private executeCommand;
     onEditorViewUpdated: ({ newEditorState, oldEditorState, }: EditorStateDiff) => void;
     onEditorPluginInitialized: (plugin: NextEditorPluginInitializedType) => void;
     private addPlugin;

package/dist/types/quick-insert/use-icon-themed.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Warning -- if additional color modes beyond light and dark are added in future -- this will have unexpected behaviour
+ */
+export declare const useIconThemed: () => {
+    iconThemed: (colors: {
+        light: string;
+        dark: string;
+    }) => string;
+};

package/dist/types/types/next-editor-plugin.d.ts

@@ -38,6 +38,14 @@ export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorP
         NextEditorPlugin<Name, Metadata>,
         ...ExtractPluginDependenciesFromMetadata<Metadata>
     ]>;
+    /**
+     * Dispatches a PluginCommand to ProseMirror
+     *
+     * @param action A function (PluginCommand | undefined) that takes a `Transaction` and returns a `Transaction` if it
+     * is successful or `null` if it shouldn't be dispatched.
+     * @returns (boolean) if the command was successful in dispatching
+     */
+    executeCommand: (action: PluginCommand | undefined) => boolean;
 };
 export type PluginInjectionAPIWithDependency<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? {
     dependencies: CreatePluginDependenciesAPI<[

package/dist/types-ts4.5/analytics/types/table-events.d.ts

@@ -1,6 +1,6 @@
 import type { TableSortOrder as SortOrder } from '@atlaskit/adf-schema/steps';
 import type { ACTION_SUBJECT, INPUT_METHOD } from './enums';
-import type { TableAEP, UIAEP } from './utils';
+import type { OperationalAEP, TableAEP, UIAEP } from './utils';
 export declare enum TABLE_ACTION {
     DELETED = "deleted",
     CLEARED = "cleared",
@@ -23,7 +23,8 @@ export declare enum TABLE_ACTION {
     ATTEMPTED_TABLE_WIDTH_CHANGE = "attemptedTableWidthChange",
     DISTRIBUTED_COLUMNS_WIDTHS = "distributedColumnsWidths",
     FIXED = "fixed",
-    RESIZED = "resized"
+    RESIZED = "resized",
+    RESIZE_PERF_SAMPLING = "resizePerfSampling"
 }
 export declare enum TABLE_BREAKOUT {
     WIDE = "wide",
@@ -57,6 +58,12 @@ type ResizedInfo = {
     totalTableWidth: number | null;
     nodeSize: number;
 } & TotalRowAndColCount;
+type ResizePreviewInfo = {
+    frameRate: number;
+    isInitialSample: boolean;
+    docSize: number;
+    nodeSize: number;
+};
 type TableDeleteAEP = TableAEP<TABLE_ACTION.DELETED, {
     inputMethod: INPUT_METHOD.KEYBOARD | INPUT_METHOD.FLOATING_TB;
 } & TotalRowAndColCount, undefined>;
@@ -106,5 +113,6 @@ type TableFixedAEP = TableAEP<TABLE_ACTION.FIXED, {
     reason: string;
 }, undefined>;
 type TableResizedAEP = TableAEP<TABLE_ACTION.RESIZED, ResizedInfo, undefined>;
-export type TableEventPayload = TableDeleteAEP | TableClearAEP | TableMergeSplitAEP | TableColorAEP | TableToggleHeaderAEP | TableChangeBreakoutAEP | TableCopyAndCutAEP | TableAddRowOrColumnAEP | TableSortColumnAEP | TableDeleteRowOrColumnAEP | TableReplaceAEP | TableAttemptedResizeAEP | TableDistributeColumnsWidthsAEP | TableCollapsedAEP | TableFixedAEP | TableResizedAEP;
+type TableResizePerfSamplingAEP = OperationalAEP<TABLE_ACTION.RESIZE_PERF_SAMPLING, ACTION_SUBJECT.TABLE, undefined, ResizePreviewInfo, undefined>;
+export type TableEventPayload = TableDeleteAEP | TableClearAEP | TableMergeSplitAEP | TableColorAEP | TableToggleHeaderAEP | TableChangeBreakoutAEP | TableCopyAndCutAEP | TableAddRowOrColumnAEP | TableSortColumnAEP | TableDeleteRowOrColumnAEP | TableReplaceAEP | TableAttemptedResizeAEP | TableDistributeColumnsWidthsAEP | TableCollapsedAEP | TableFixedAEP | TableResizedAEP | TableResizePerfSamplingAEP;
 export {};

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

@@ -1,8 +1,8 @@
-import type { ExtractPluginSharedState, NextEditorPluginMetadata, PluginDependenciesAPI, PluginInjectionAPI } from '../types/next-editor-plugin';
-type NamedPluginStatesFromInjectionAPI<API extends PluginInjectionAPI<any, any> | undefined, PluginList extends string[]> = Readonly<{
-    [K in PluginList[number] as `${K}State`]: API extends PluginInjectionAPI<any, any> ? API['dependencies'][K] extends PluginDependenciesAPI<infer Plugin> | undefined ? ExtractPluginSharedState<Plugin> | undefined : never : never;
+import type { ExtractPluginSharedState, NextEditorPlugin, PluginDependenciesAPI, PluginInjectionAPIWithDependencies } from '../types/next-editor-plugin';
+type NamedPluginStatesFromInjectionAPI<API extends PluginInjectionAPIWithDependencies<any> | undefined, PluginList extends string[]> = Readonly<{
+    [K in PluginList[number] as `${K}State`]: API extends PluginInjectionAPIWithDependencies<any> ? API['dependencies'][K] extends PluginDependenciesAPI<infer Plugin> | undefined ? ExtractPluginSharedState<Plugin> | undefined : never : never;
 }>;
-type ExtractPluginNames<Name extends string, Metadata extends NextEditorPluginMetadata> = keyof PluginInjectionAPI<Name, Metadata>['dependencies'];
+type ExtractPluginNames<API extends PluginInjectionAPIWithDependencies<any>> = API extends PluginInjectionAPIWithDependencies<any> ? keyof API['dependencies'] : never;
 /**
  *
  * Used to return the current plugin state of
@@ -35,5 +35,5 @@ type ExtractPluginNames<Name extends string, Metadata extends NextEditorPluginMe
  * @returns A corresponding object, the keys are names of the plugin with `State` appended,
  * the values are the shared state exposed by that plugin.
  */
-export declare function useSharedPluginState<Name extends string, Metadata extends NextEditorPluginMetadata, PluginNames extends ExtractPluginNames<Name, Metadata>[]>(injectionApi: PluginInjectionAPI<Name, Metadata> | undefined, plugins: PluginNames): NamedPluginStatesFromInjectionAPI<typeof injectionApi, PluginNames>;
+export declare function useSharedPluginState<Plugins extends NextEditorPlugin<any, any>[], PluginNames extends ExtractPluginNames<PluginInjectionAPIWithDependencies<Plugins>>[]>(injectionApi: PluginInjectionAPIWithDependencies<Plugins> | undefined, plugins: PluginNames): NamedPluginStatesFromInjectionAPI<typeof injectionApi, PluginNames>;
 export {};

package/dist/types-ts4.5/preset/plugin-commands.d.ts

@@ -1,3 +1,13 @@
 import type { Command } from '../types/command';
 import type { PluginCommand } from '../types/plugin-command';
+/**
+ * Convert a PluginCommand to a standard Prosemirror Command.
+ * The preferred approach to dispatching a `PluginCommand` is via the
+ * `executeCommand` on `pluginInjectionAPI`. In some cases
+ * the type may require a Command until we refactor this out and this
+ * function is suitable for those cases.
+ *
+ * @param command A plugin command (a function that modifies and returns a `Transaction`)
+ * @returns Command
+ */
 export declare function pluginCommandToPMCommand(command: PluginCommand | undefined): Command;

package/dist/types-ts4.5/preset/plugin-injection-api.d.ts

@@ -1,9 +1,14 @@
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { DefaultEditorPlugin, NextEditorPlugin, PluginDependenciesAPI, PluginInjectionAPI } from '../types/next-editor-plugin';
+import type { PluginCommand } from '../types/plugin-command';
 type NextEditorPluginInitializedType = ReturnType<NextEditorPlugin<any>>;
 type SharedStateAPIProps = {
     getEditorState: () => EditorState | undefined;
 };
+interface PluginInjectionAPIProps extends SharedStateAPIProps {
+    getEditorView: () => EditorView | undefined;
+}
 type EditorStateDiff = {
     readonly newEditorState: EditorState;
     readonly oldEditorState: EditorState | undefined;
@@ -34,7 +39,8 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
     private actionsAPI;
     private commandsAPI;
     private plugins;
-    constructor({ getEditorState }: SharedStateAPIProps);
+    private getEditorView;
+    constructor({ getEditorState, getEditorView }: PluginInjectionAPIProps);
     api<T extends NextEditorPlugin<any, any>>(): {
         dependencies: import("../types/next-editor-plugin").CreatePluginDependenciesAPI<[
             NextEditorPlugin<T extends (config?: any, api?: PluginInjectionAPI<infer Name extends string, any> | undefined) => DefaultEditorPlugin<infer Name extends string, any> ? Name : never, T extends NextEditorPlugin<any, infer Metadata extends import("../types/next-editor-plugin").NextEditorPluginMetadata> ? Metadata : never>,
@@ -42,7 +48,9 @@ export declare class EditorPluginInjectionAPI implements PluginInjectionAPIDefin
             ] : [
             ]
         ]>;
+        executeCommand: (command: PluginCommand | undefined) => boolean;
     };
+    private executeCommand;
     onEditorViewUpdated: ({ newEditorState, oldEditorState, }: EditorStateDiff) => void;
     onEditorPluginInitialized: (plugin: NextEditorPluginInitializedType) => void;
     private addPlugin;

package/dist/types-ts4.5/quick-insert/use-icon-themed.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Warning -- if additional color modes beyond light and dark are added in future -- this will have unexpected behaviour
+ */
+export declare const useIconThemed: () => {
+    iconThemed: (colors: {
+        light: string;
+        dark: string;
+    }) => string;
+};

package/dist/types-ts4.5/types/next-editor-plugin.d.ts

@@ -38,6 +38,14 @@ export type PluginInjectionAPI<Name extends string, Metadata extends NextEditorP
         NextEditorPlugin<Name, Metadata>,
         ...ExtractPluginDependenciesFromMetadata<Metadata>
     ]>;
+    /**
+     * Dispatches a PluginCommand to ProseMirror
+     *
+     * @param action A function (PluginCommand | undefined) that takes a `Transaction` and returns a `Transaction` if it
+     * is successful or `null` if it shouldn't be dispatched.
+     * @returns (boolean) if the command was successful in dispatching
+     */
+    executeCommand: (action: PluginCommand | undefined) => boolean;
 };
 export type PluginInjectionAPIWithDependency<Plugin> = Plugin extends NextEditorPlugin<infer Name, infer Metadata> ? {
     dependencies: CreatePluginDependenciesAPI<[

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-common",
-  "version": "74.41.2",
+  "version": "74.42.1",
   "description": "A package that contains common classes and components for editor and renderer",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"