@atlaskit/editor-common 72.5.1 → 72.6.1

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

@@ -6,47 +6,74 @@
  */
 import type { EditorState } from 'prosemirror-state';
 import type { EditorPlugin } from './editor-plugin';
-interface DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> extends EditorPlugin {
-    name: Name;
-}
-interface DefaultEditorPluginWithSharedPluginState<Name, Metadata extends NextEditorPluginMetadata> {
+declare type IsAny<T> = 0 extends 1 & T ? true : false;
+declare type PickSharedStatePropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractSharedStateFromMetadata<Metadata> extends never ? never : 'getSharedState';
+declare type WithSharedState<Metadata extends NextEditorPluginMetadata> = {
+    [Property in keyof Pick<Metadata, 'sharedState'> as PickSharedStatePropertyName<Metadata>]: (editorState: EditorState) => ExtractSharedStateFromMetadata<Metadata>;
+};
+declare type PickActionsPropertyName<Metadata extends NextEditorPluginMetadata> = IsAny<Metadata> extends true ? never : ExtractActionsFromMetadata<Metadata> extends never ? never : 'actions';
+declare type WithActions<Metadata extends NextEditorPluginMetadata> = {
+    [Property in keyof Pick<Metadata, 'actions'> as PickActionsPropertyName<Metadata>]: ExtractActionsFromMetadata<Metadata>;
+};
+export declare type DefaultEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata> = EditorPlugin & WithSharedState<Metadata> & WithActions<Metadata> & {
     name: Name;
-    getSharedState: (editorState: EditorState) => ExtractSharedStateFromMetadata<Metadata>;
-}
-declare type CheckSharedState<Name extends string, Metadata extends NextEditorPluginMetadata> = Exclude<ExtractSharedStateFromMetadata<Metadata>, never> extends never ? DefaultEditorPlugin<Name, Metadata> : DefaultEditorPluginWithSharedPluginState<Name, Metadata>;
-interface NextEditorPluginMetadata {
+};
+declare type MaybeAction = ((...agrs: any) => any) | ((...agrs: any) => void);
+declare type NextEditorPluginActions = Record<string, MaybeAction>;
+export interface NextEditorPluginMetadata {
     readonly sharedState?: any;
     readonly pluginConfiguration?: any;
-    readonly dependencies?: NextEditorPlugin<any, any>[];
+    readonly dependencies?: DependencyPlugin[];
+    readonly actions?: NextEditorPluginActions;
 }
-declare type NextEditorPluginProps<Metadata extends NextEditorPluginMetadata> = {
-    externalPlugins: ExternalPluginAPI<ExtractPluginDependenciesFromMetadata<Metadata>>;
+export declare type PluginInjectionAPI<Name extends string, Metadata extends NextEditorPluginMetadata> = {
+    externalPlugins: CreatePluginDependenciesAPI<[
+        NextEditorPlugin<Name, Metadata>,
+        ...ExtractPluginDependenciesFromMetadata<Metadata>
+    ]>;
+};
+declare type NextEditorPluginFunctionDefinition<Name extends string, Metadata extends NextEditorPluginMetadata, Configuration> = (config: Configuration, api?: PluginInjectionAPI<Name, Metadata>) => DefaultEditorPlugin<Name, Metadata>;
+declare type NextEditorPluginFunctionOptionalConfigDefinition<Name extends string, Metadata extends NextEditorPluginMetadata, Configuration = undefined> = (config?: Configuration, api?: PluginInjectionAPI<Name, Metadata>) => DefaultEditorPlugin<Name, Metadata>;
+declare type OptionalPrivateProperty = {
+    __optionalPluginType: true;
 };
-declare type NextEditorPluginFunctionDefinition<Name extends string, Metadata extends NextEditorPluginMetadata, Configuration> = (config: Configuration, api?: NextEditorPluginProps<Metadata>) => CheckSharedState<Name, Metadata>;
-declare type NextEditorPluginFunctionOptionalConfigDefinition<Name extends string, Metadata extends NextEditorPluginMetadata, Configuration = undefined> = (config?: Configuration, api?: NextEditorPluginProps<Metadata>) => CheckSharedState<Name, Metadata>;
+export declare type OptionalPlugin<EditorPlugin extends NextEditorPlugin<any, any>> = EditorPlugin & OptionalPrivateProperty;
+declare type DependencyPlugin = OptionalPlugin<NextEditorPlugin<any, any>> | NextEditorPlugin<any, any>;
 export declare type NextEditorPlugin<Name extends string, Metadata extends NextEditorPluginMetadata = {}> = Metadata extends NextEditorPluginMetadata ? 'pluginConfiguration' extends keyof Metadata ? undefined extends Metadata['pluginConfiguration'] ? NextEditorPluginFunctionOptionalConfigDefinition<Name, Metadata, Metadata['pluginConfiguration']> : NextEditorPluginFunctionDefinition<Name, Metadata, Metadata['pluginConfiguration']> : NextEditorPluginFunctionOptionalConfigDefinition<Name, Metadata> : never;
-declare type ExtractPluginDependenciesFromMetadata<Metadata> = 'dependencies' extends keyof Metadata ? Metadata['dependencies'] extends NextEditorPlugin<any, any>[] ? Exclude<Metadata['dependencies'], undefined> : [] : [];
+declare type FilterOptionalPlugins<T extends DependencyPlugin[]> = T extends [
+    infer Head,
+    ...infer Tail
+] ? Tail extends DependencyPlugin[] ? Head extends OptionalPlugin<NextEditorPlugin<any, any>> ? FilterOptionalPlugins<Tail> : [Head, ...FilterOptionalPlugins<Tail>] : T : T;
+declare type ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata extends NextEditorPluginMetadata> = Metadata['dependencies'] extends DependencyPlugin[] ? FilterOptionalPlugins<Metadata['dependencies']> : [];
+declare type ExtractPluginDependenciesFromMetadata<Metadata> = 'dependencies' extends keyof Metadata ? Metadata['dependencies'] extends DependencyPlugin[] ? Exclude<Metadata['dependencies'], undefined> : [] : [];
 declare type ExtractSharedStateFromMetadata<Metadata> = 'sharedState' extends keyof Metadata ? Metadata['sharedState'] : never;
+declare type ExtractActionsFromMetadata<Metadata> = 'actions' extends keyof Metadata ? Metadata['actions'] : never;
 declare type ExtractPluginConfigurationFromMetadata<Metadata> = 'pluginConfiguration' extends keyof Metadata ? Metadata['pluginConfiguration'] : never;
-declare type ExtractPluginDependencies<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => CheckSharedState<any, infer Metadata> ? ExtractPluginDependenciesFromMetadata<Metadata> : never : never;
-declare type ExtractPluginConfiguration<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => CheckSharedState<any, infer Metadata> ? ExtractPluginConfigurationFromMetadata<Metadata> : never : never;
-declare type ExtractPluginSharedState<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => CheckSharedState<any, infer Metadata> ? ExtractSharedStateFromMetadata<Metadata> : never : never;
-declare type ExtractPluginName<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (...args: any) => CheckSharedState<infer PluginName, any> ? PluginName : never : never;
-declare type ExternalPluginAPIProps<Plugin extends NextEditorPlugin<any, any>> = {
-    sharedPluginState: {
-        currentState: () => ExtractPluginSharedState<Plugin>;
-        onChange: (sub: (props: ExtractPluginSharedState<Plugin>) => void) => void;
+export declare type ExtractPluginDependencies<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginDependenciesFromMetadataWithoutOptionals<Metadata> : never : never;
+declare type ExtractPluginConfiguration<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractPluginConfigurationFromMetadata<Metadata> : never : never;
+declare type ExtractPluginSharedState<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractSharedStateFromMetadata<Metadata> : never : never;
+declare type ExtractPluginActions<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (config: any, api: any) => DefaultEditorPlugin<any, infer Metadata> ? ExtractActionsFromMetadata<Metadata> : never : never;
+declare type ExtractPluginName<Plugin> = Plugin extends NextEditorPlugin<any, any> ? Plugin extends (...args: any) => DefaultEditorPlugin<infer PluginName, any> ? PluginName : never : never;
+declare type Unsubscribe = () => void;
+export declare type PluginDependenciesAPI<Plugin extends NextEditorPlugin<any, any>> = {
+    sharedState: {
+        currentState: () => ExtractPluginSharedState<Plugin> | undefined;
+        onChange: (sub: (props: {
+            nextSharedState: ExtractPluginSharedState<Plugin>;
+            prevSharedState: ExtractPluginSharedState<Plugin>;
+        }) => void) => Unsubscribe;
     };
+    actions: ExtractPluginActions<Plugin>;
 };
-declare type ExternalPluginAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
-    [Plugin in PluginList[number] as ExtractPluginName<Plugin>]: Plugin extends NextEditorPlugin<any, any> ? ExternalPluginAPIProps<Plugin> : never;
+export declare type CreatePluginDependenciesAPI<PluginList extends NextEditorPlugin<any, any>[]> = {
+    [Plugin in PluginList[number] as ExtractPluginName<Plugin>]: Plugin extends OptionalPlugin<NextEditorPlugin<any, any>> ? PluginDependenciesAPI<Plugin> | undefined : Plugin extends NextEditorPlugin<any, any> ? PluginDependenciesAPI<Plugin> : never;
 };
 export declare type PluginAsArray<Plugin> = undefined extends ExtractPluginConfiguration<Plugin> ? [Plugin, ExtractPluginConfiguration<Plugin>?] : [Plugin, ExtractPluginConfiguration<Plugin>];
-export declare type AllBuilderPlugins = PluginAsArray<any> | NextEditorPlugin<any, any>;
+export declare type AllEditorPresetPluginTypes = PluginAsArray<any> | NextEditorPlugin<any, any>;
 declare type ExtractNextEditorPlugin<Plugin> = Plugin extends PluginAsArray<any> ? Plugin[0] : never;
-export declare type VerifyPluginDependencies<Plugin, PluginsStack extends AllBuilderPlugins[]> = ExtractPluginDependencies<Plugin> extends [] ? Plugin extends PluginAsArray<any> | NextEditorPlugin<any, any> ? Plugin : never : 
+export declare type VerifyPluginDependencies<Plugin, PluginsStack extends AllEditorPresetPluginTypes[]> = ExtractPluginDependencies<Plugin> extends [] ? Plugin extends PluginAsArray<any> | NextEditorPlugin<any, any> ? Plugin : never : 
 /**
- * case 1: We're looking for its dependent plugins indexed on `AllBuilderPlugins`
+ * case 1: We're looking for its dependent plugins indexed on `AllEditorPresetPluginTypes`
  */
 ExtractPluginDependencies<Plugin>[number] extends (ExtractPluginDependencies<Plugin>[number] & PluginsStack[number])
 /**
@@ -58,9 +85,10 @@ ExtractPluginDependencies<Plugin>[number] extends (ExtractPluginDependencies<Plu
 /**
  * Used to check if a plugin being added can be added to a Preset/builder
  */
-export declare type SafePresetCheck<Plugin, StackPlugins extends AllBuilderPlugins[]> = Plugin extends Plugin & VerifyPluginDependencies<Plugin, StackPlugins> ? Plugin extends NextEditorPlugin<any, any> ? CheckBasicPlugin<Plugin> : never : never;
+export declare type SafePresetCheck<Plugin, StackPlugins extends AllEditorPresetPluginTypes[]> = Plugin extends Plugin & VerifyPluginDependencies<Plugin, StackPlugins> ? Plugin extends NextEditorPlugin<any, any> ? CheckBasicPlugin<Plugin> : never : never;
 declare type CheckTupleRequirements<Plugin, Config, ArrayType> = unknown extends Config ? Plugin | ArrayType : undefined extends Config ? Plugin | ArrayType : [
     Config
 ] extends [never] ? Plugin : ArrayType;
 declare type CheckBasicPlugin<Plugin> = Plugin extends (args: any, api: any) => EditorPlugin ? CheckTupleRequirements<Plugin, ExtractPluginConfiguration<Plugin>, PluginAsArray<Plugin>> : never;
+export declare type ExtractPluginNameFromAllBuilderPlugins<Plugin extends AllEditorPresetPluginTypes> = Plugin extends Array<any> ? Plugin extends [infer MaybePlugin, ...any] ? MaybePlugin extends NextEditorPlugin<any, any> ? ExtractPluginName<MaybePlugin> : never : never : Plugin extends NextEditorPlugin<any, any> ? ExtractPluginName<Plugin> : never;
 export {};

package/dist/types/ui/DropList/index.d.ts

@@ -10,10 +10,11 @@ interface Props extends WithAnalyticsEventsProps {
     testId?: string;
     shouldFitContainer: boolean;
     children?: ReactNode;
+    id?: string;
 }
 export declare type OpenChangedEvent = {
     isOpen: boolean;
     event: MouseEvent | KeyboardEvent;
 };
-declare const _default: import("react").ForwardRefExoticComponent<Pick<Omit<Props, keyof WithAnalyticsEventsProps> & import("react").RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "key" | "children" | "position" | "trigger" | "testId" | "analyticsContext" | "isOpen" | "onPositioned" | "onOpenChange" | "shouldFitContainer"> & import("react").RefAttributes<any>>;
+declare const _default: import("react").ForwardRefExoticComponent<Pick<Omit<Props, keyof WithAnalyticsEventsProps> & import("react").RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "key" | "id" | "children" | "position" | "trigger" | "testId" | "analyticsContext" | "isOpen" | "onPositioned" | "onOpenChange" | "shouldFitContainer"> & import("react").RefAttributes<any>>;
 export default _default;

package/dist/types/ui-color/ColorPalette/Palettes/index.d.ts

@@ -1,2 +1,3 @@
 export type { PaletteColor } from './type';
 export { DEFAULT_BORDER_COLOR } from './common';
+export { textPaletteTooltipMessages, backgroundPaletteTooltipMessages, } from './paletteMessagesTokenModeNames';