@atlaskit/editor-common 103.1.3 → 103.3.0

package/dist/types/i18n/vi.d.ts

@@ -30,6 +30,7 @@ declare const _default: {
     'fabric.editor.ai.atlas-prebuilt.atlasGenerateContentConfigItemDescription': string;
     'fabric.editor.ai.atlas-prebuilt.atlasSummarizePageConfigItemDescription': string;
     'fabric.editor.ai.commandPalette.promptBuilderForm.buttons.submit': string;
+    'fabric.editor.ai.commandPalette.promptBuilderForm.generateContent.ariaLabel': string;
     'fabric.editor.ai.config.item.action.insert': string;
     'fabric.editor.ai.config.item.action.insertAtTop': string;
     'fabric.editor.ai.config.item.action.insertBelow': string;
@@ -37,29 +38,6 @@ declare const _default: {
     'fabric.editor.ai.config.item.action.replaceTitle': string;
     'fabric.editor.ai.config.item.action.replaceTitleTooLongDisabledTooltip': string;
     'fabric.editor.ai.config.item.action.rovoAgents.continueInChatLabel': string;
-    'fabric.editor.ai.config.item.advanced-prompt.form.instructions.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.description': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.high': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.low': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.medium': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.error.required': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.casual': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.educational': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.empathetic': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.neutral': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.professional': string;
-    'fabric.editor.ai.config.item.advancedPrompt.promptLabel': string;
-    'fabric.editor.ai.config.item.advancedPrompt.title': string;
     'fabric.editor.ai.config.item.agent.title': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.description': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.title': string;
@@ -207,7 +185,6 @@ declare const _default: {
     'fabric.editor.ai.experience.suggestionGroupHeading.knowledgeSource': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgents': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgentsCount': string;
-    'fabric.editor.ai.experience.suggestionGroupHeading.studio': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.useRovoAgentsCount': string;
     'fabric.editor.ai.experience.useGeneralAiKnowledgeLabel': string;
     'fabric.editor.ai.experience.useRovoOrganisationKnowledgeLabel': string;
@@ -404,6 +381,7 @@ declare const _default: {
     'fabric.editor.errorPanel.description': string;
     'fabric.editor.expand': string;
     'fabric.editor.expand.description': string;
+    'fabric.editor.expandAriaLabel': string;
     'fabric.editor.expandDefaultTitle': string;
     'fabric.editor.expandNode': string;
     'fabric.editor.expandPlaceholder': string;
@@ -413,6 +391,7 @@ declare const _default: {
     'fabric.editor.extension.deleteElementTitle': string;
     'fabric.editor.extension.sourceNoTitledName': string;
     'fabric.editor.extensions.config-panel.save-indicator': string;
+    'fabric.editor.externalExtensionsHeading': string;
     'fabric.editor.externalMediaFile': string;
     'fabric.editor.failed_to_upload': string;
     'fabric.editor.feedbackDialog': string;
@@ -524,6 +503,7 @@ declare const _default: {
     'fabric.editor.lists': string;
     'fabric.editor.listsFormat': string;
     'fabric.editor.lockColumns': string;
+    'fabric.editor.longEmptyNodePlaceholderText': string;
     'fabric.editor.markdown': string;
     'fabric.editor.matchCase': string;
     'fabric.editor.media.DefaultMediaWidthDecreased': string;
@@ -592,6 +572,7 @@ declare const _default: {
     'fabric.editor.orderedList.description': string;
     'fabric.editor.other': string;
     'fabric.editor.outdent': string;
+    'fabric.editor.overflowMenuViewMore': string;
     'fabric.editor.pageActionsLabel': string;
     'fabric.editor.panel': string;
     'fabric.editor.panel.backgroundColor': string;
@@ -605,6 +586,7 @@ declare const _default: {
     'fabric.editor.placeholderText.description': string;
     'fabric.editor.placeholderTextPlaceholder': string;
     'fabric.editor.plainText': string;
+    'fabric.editor.preferencesLink': string;
     'fabric.editor.quickInsert': string;
     'fabric.editor.recordLoomShortTitle': string;
     'fabric.editor.recordVideo': string;
@@ -640,6 +622,7 @@ declare const _default: {
     'fabric.editor.selectTableRow': string;
     'fabric.editor.selectionExtensionDropdownButtonLabel': string;
     'fabric.editor.settingsLinks': string;
+    'fabric.editor.shortEmptyNodePlaceholderText': string;
     'fabric.editor.shortcut': string;
     'fabric.editor.single': string;
     'fabric.editor.singleColumns': string;
@@ -703,8 +686,11 @@ declare const _default: {
     'fabric.editor.time.ago': string;
     'fabric.editor.time.updated': string;
     'fabric.editor.time.viewed': string;
+    'fabric.editor.toolbarAppears': string;
     'fabric.editor.toolbarLabel': string;
     'fabric.editor.toolbarMediaTitle': string;
+    'fabric.editor.toolbarPositionFixedAtTop': string;
+    'fabric.editor.toolbarPositionInline': string;
     'fabric.editor.tooltip.blockPanel': string;
     'fabric.editor.tooltip.bulletList': string;
     'fabric.editor.tooltip.decisionList': string;

package/dist/types/i18n/zh.d.ts

@@ -30,6 +30,7 @@ declare const _default: {
     'fabric.editor.ai.atlas-prebuilt.atlasGenerateContentConfigItemDescription': string;
     'fabric.editor.ai.atlas-prebuilt.atlasSummarizePageConfigItemDescription': string;
     'fabric.editor.ai.commandPalette.promptBuilderForm.buttons.submit': string;
+    'fabric.editor.ai.commandPalette.promptBuilderForm.generateContent.ariaLabel': string;
     'fabric.editor.ai.config.item.action.insert': string;
     'fabric.editor.ai.config.item.action.insertAtTop': string;
     'fabric.editor.ai.config.item.action.insertBelow': string;
@@ -37,29 +38,6 @@ declare const _default: {
     'fabric.editor.ai.config.item.action.replaceTitle': string;
     'fabric.editor.ai.config.item.action.replaceTitleTooLongDisabledTooltip': string;
     'fabric.editor.ai.config.item.action.rovoAgents.continueInChatLabel': string;
-    'fabric.editor.ai.config.item.advanced-prompt.form.instructions.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.description': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.high': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.low': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.medium': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.error.required': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.casual': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.educational': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.empathetic': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.neutral': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.professional': string;
-    'fabric.editor.ai.config.item.advancedPrompt.promptLabel': string;
-    'fabric.editor.ai.config.item.advancedPrompt.title': string;
     'fabric.editor.ai.config.item.agent.title': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.description': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.title': string;
@@ -222,7 +200,6 @@ declare const _default: {
     'fabric.editor.ai.experience.suggestionGroupHeading.knowledgeSource': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgents': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgentsCount': string;
-    'fabric.editor.ai.experience.suggestionGroupHeading.studio': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.useRovoAgentsCount': string;
     'fabric.editor.ai.experience.useGeneralAiKnowledgeLabel': string;
     'fabric.editor.ai.experience.useRovoOrganisationKnowledgeLabel': string;
@@ -419,6 +396,7 @@ declare const _default: {
     'fabric.editor.errorPanel.description': string;
     'fabric.editor.expand': string;
     'fabric.editor.expand.description': string;
+    'fabric.editor.expandAriaLabel': string;
     'fabric.editor.expandDefaultTitle': string;
     'fabric.editor.expandNode': string;
     'fabric.editor.expandPlaceholder': string;
@@ -428,6 +406,7 @@ declare const _default: {
     'fabric.editor.extension.deleteElementTitle': string;
     'fabric.editor.extension.sourceNoTitledName': string;
     'fabric.editor.extensions.config-panel.save-indicator': string;
+    'fabric.editor.externalExtensionsHeading': string;
     'fabric.editor.externalMediaFile': string;
     'fabric.editor.failed_to_upload': string;
     'fabric.editor.feedbackDialog': string;
@@ -539,6 +518,7 @@ declare const _default: {
     'fabric.editor.lists': string;
     'fabric.editor.listsFormat': string;
     'fabric.editor.lockColumns': string;
+    'fabric.editor.longEmptyNodePlaceholderText': string;
     'fabric.editor.markdown': string;
     'fabric.editor.matchCase': string;
     'fabric.editor.media.DefaultMediaWidthDecreased': string;
@@ -607,6 +587,7 @@ declare const _default: {
     'fabric.editor.orderedList.description': string;
     'fabric.editor.other': string;
     'fabric.editor.outdent': string;
+    'fabric.editor.overflowMenuViewMore': string;
     'fabric.editor.pageActionsLabel': string;
     'fabric.editor.panel': string;
     'fabric.editor.panel.backgroundColor': string;
@@ -656,6 +637,7 @@ declare const _default: {
     'fabric.editor.selectTableRow': string;
     'fabric.editor.selectionExtensionDropdownButtonLabel': string;
     'fabric.editor.settingsLinks': string;
+    'fabric.editor.shortEmptyNodePlaceholderText': string;
     'fabric.editor.shortcut': string;
     'fabric.editor.single': string;
     'fabric.editor.singleColumns': string;
@@ -719,8 +701,11 @@ declare const _default: {
     'fabric.editor.time.ago': string;
     'fabric.editor.time.updated': string;
     'fabric.editor.time.viewed': string;
+    'fabric.editor.toolbarAppears': string;
     'fabric.editor.toolbarLabel': string;
     'fabric.editor.toolbarMediaTitle': string;
+    'fabric.editor.toolbarPositionFixedAtTop': string;
+    'fabric.editor.toolbarPositionInline': string;
     'fabric.editor.tooltip.blockPanel': string;
     'fabric.editor.tooltip.bulletList': string;
     'fabric.editor.tooltip.decisionList': string;

package/dist/types/i18n/zh_TW.d.ts

@@ -30,6 +30,7 @@ declare const _default: {
     'fabric.editor.ai.atlas-prebuilt.atlasGenerateContentConfigItemDescription': string;
     'fabric.editor.ai.atlas-prebuilt.atlasSummarizePageConfigItemDescription': string;
     'fabric.editor.ai.commandPalette.promptBuilderForm.buttons.submit': string;
+    'fabric.editor.ai.commandPalette.promptBuilderForm.generateContent.ariaLabel': string;
     'fabric.editor.ai.config.item.action.insert': string;
     'fabric.editor.ai.config.item.action.insertAtTop': string;
     'fabric.editor.ai.config.item.action.insertBelow': string;
@@ -37,29 +38,6 @@ declare const _default: {
     'fabric.editor.ai.config.item.action.replaceTitle': string;
     'fabric.editor.ai.config.item.action.replaceTitleTooLongDisabledTooltip': string;
     'fabric.editor.ai.config.item.action.rovoAgents.continueInChatLabel': string;
-    'fabric.editor.ai.config.item.advanced-prompt.form.instructions.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.description': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.high': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.low': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.creativity.option.medium': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.instructions.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.rules.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.error.required': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.helperMessage': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.task.placeholder': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.label': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.casual': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.educational': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.empathetic': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.neutral': string;
-    'fabric.editor.ai.config.item.advancedPrompt.form.tone.option.professional': string;
-    'fabric.editor.ai.config.item.advancedPrompt.promptLabel': string;
-    'fabric.editor.ai.config.item.advancedPrompt.title': string;
     'fabric.editor.ai.config.item.agent.title': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.description': string;
     'fabric.editor.ai.config.item.atlas-shorten-update.title': string;
@@ -222,7 +200,6 @@ declare const _default: {
     'fabric.editor.ai.experience.suggestionGroupHeading.knowledgeSource': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgents': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.rovoAgentsCount': string;
-    'fabric.editor.ai.experience.suggestionGroupHeading.studio': string;
     'fabric.editor.ai.experience.suggestionGroupHeading.useRovoAgentsCount': string;
     'fabric.editor.ai.experience.useGeneralAiKnowledgeLabel': string;
     'fabric.editor.ai.experience.useRovoOrganisationKnowledgeLabel': string;
@@ -419,6 +396,7 @@ declare const _default: {
     'fabric.editor.errorPanel.description': string;
     'fabric.editor.expand': string;
     'fabric.editor.expand.description': string;
+    'fabric.editor.expandAriaLabel': string;
     'fabric.editor.expandDefaultTitle': string;
     'fabric.editor.expandNode': string;
     'fabric.editor.expandPlaceholder': string;
@@ -428,6 +406,7 @@ declare const _default: {
     'fabric.editor.extension.deleteElementTitle': string;
     'fabric.editor.extension.sourceNoTitledName': string;
     'fabric.editor.extensions.config-panel.save-indicator': string;
+    'fabric.editor.externalExtensionsHeading': string;
     'fabric.editor.externalMediaFile': string;
     'fabric.editor.failed_to_upload': string;
     'fabric.editor.feedbackDialog': string;
@@ -539,6 +518,7 @@ declare const _default: {
     'fabric.editor.lists': string;
     'fabric.editor.listsFormat': string;
     'fabric.editor.lockColumns': string;
+    'fabric.editor.longEmptyNodePlaceholderText': string;
     'fabric.editor.markdown': string;
     'fabric.editor.matchCase': string;
     'fabric.editor.media.DefaultMediaWidthDecreased': string;
@@ -607,6 +587,7 @@ declare const _default: {
     'fabric.editor.orderedList.description': string;
     'fabric.editor.other': string;
     'fabric.editor.outdent': string;
+    'fabric.editor.overflowMenuViewMore': string;
     'fabric.editor.pageActionsLabel': string;
     'fabric.editor.panel': string;
     'fabric.editor.panel.backgroundColor': string;
@@ -656,6 +637,7 @@ declare const _default: {
     'fabric.editor.selectTableRow': string;
     'fabric.editor.selectionExtensionDropdownButtonLabel': string;
     'fabric.editor.settingsLinks': string;
+    'fabric.editor.shortEmptyNodePlaceholderText': string;
     'fabric.editor.shortcut': string;
     'fabric.editor.single': string;
     'fabric.editor.singleColumns': string;
@@ -719,8 +701,11 @@ declare const _default: {
     'fabric.editor.time.ago': string;
     'fabric.editor.time.updated': string;
     'fabric.editor.time.viewed': string;
+    'fabric.editor.toolbarAppears': string;
     'fabric.editor.toolbarLabel': string;
     'fabric.editor.toolbarMediaTitle': string;
+    'fabric.editor.toolbarPositionFixedAtTop': string;
+    'fabric.editor.toolbarPositionInline': string;
     'fabric.editor.tooltip.blockPanel': string;
     'fabric.editor.tooltip.bulletList': string;
     'fabric.editor.tooltip.decisionList': string;

package/dist/types/types/annotation/index.d.ts

@@ -2,6 +2,7 @@
 import type { AnnotationId, AnnotationTypes } from '@atlaskit/adf-schema';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { AnnotationManager } from '../../annotation';
 import type { AnnotationState, AnnotationUpdateEmitter } from './emitter';
 export type AnnotationByMatches = {
     originalSelection: string;
@@ -141,5 +142,6 @@ export type InlineCommentAnnotationProvider = AnnotationTypeProvider<AnnotationT
 };
 export type AnnotationProviders = {
     inlineComment: InlineCommentAnnotationProvider;
+    annotationManager?: AnnotationManager;
 };
 export {};

package/dist/types/types/floating-toolbar.d.ts

@@ -339,6 +339,15 @@ export interface FloatingToolbarConfig {
      * @see clean up ticket ED-26803
      */
     forceStaticToolbar?: boolean;
+    /**
+     * For internal use only, we will be depricating this API soon.
+     * If any config has __suppressAllToolbars set to true, no floating toolbar will be rendered.
+     * Use case:
+     * When a node is nested inside a table and the cursor is inside of the nested node.
+     * Nested node's toolbar is active. When table's menu opens, we provide table's config with
+     * __suppressAllToolbars set to true.
+     */
+    __suppressAllToolbars?: boolean;
 }
 export type FloatingToolbarHandler = (state: EditorState, intl: IntlShape, providerFactory: ProviderFactory, processedConfigs?: Array<FloatingToolbarConfig>) => FloatingToolbarConfig | undefined;
 export {};

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

@@ -2,6 +2,9 @@
 /// <reference types="node/events" />
 /// <reference types="typings/events" />
 import { EventEmitter } from 'events';
+import type { AnnotationId } from '@atlaskit/adf-schema';
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 export type UpdateEvent = 'create' | 'delete' | 'resolve' | 'unresolve' | 'setselectedannotation' | 'sethoveredannotation' | 'removehoveredannotation';
 export type VisibilityEvent = 'setvisibility';
 type AnnotationCallback = (params: string) => void;
@@ -11,4 +14,133 @@ export declare class AnnotationUpdateEmitter extends EventEmitter {
     on(event: UpdateEvent, listener: (annotationId: string) => void): this;
     off(event: string, listener: AnnotationCallback | VisibilityCallback): this;
 }
+type ActionResult = {
+    step: Step;
+    doc: JSONDocNode;
+    /** The list of types of all inline nodes, which were wrapped by annotation. */
+    inlineNodeTypes?: string[];
+    targetNodeType?: string;
+};
+export type AnnotationDraftStartedData = {
+    targetElement: HTMLElement | undefined;
+    /**
+     * This list of inline node types at the draft selection location
+     */
+    inlineNodeTypes: string[];
+    /**
+     * The actionResult can be used by Product so they're able to perform the
+     * required NCS transaction to add the annotation to the document.
+     */
+    actionResult: ActionResult | undefined;
+};
+export type AnnotationSelectedChangeData = {
+    annotationId: AnnotationId;
+    isSelected: boolean;
+    inlineNodeTypes: string[];
+};
+export type AnnotationManagerEvents = {
+    name: 'draftAnnotationStarted';
+    data: AnnotationDraftStartedData;
+} | {
+    name: 'annotationSelectionChanged';
+    data: AnnotationSelectedChangeData;
+};
+export type ManagerFailureReasons = 'manager-not-initialized' | 'hook-execution-error';
+export type StartDraftResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'invalid-range' | 'draft-in-progress';
+} | ({
+    success: true;
+} & AnnotationDraftStartedData);
+export type ClearDraftResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'draft-not-started';
+} | {
+    success: true;
+};
+export type ApplyDraftResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'draft-not-started' | 'range-no-longer-exists';
+} | {
+    success: true;
+    targetElement: HTMLElement | undefined;
+};
+export type GetDraftResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'draft-not-started';
+} | ({
+    success: true;
+} & AnnotationDraftStartedData);
+export type ClearAnnotationResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'id-not-valid';
+} | {
+    success: true;
+    actionResult: ActionResult | undefined;
+};
+export type SelectAnnotationResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'id-not-valid';
+} | {
+    success: true;
+    isSelected: boolean;
+};
+export type HoverAnnotationResult = {
+    success: false;
+    reason: ManagerFailureReasons | 'id-not-valid';
+} | {
+    success: true;
+    isHovered: boolean;
+};
+/**
+ * This is the list of methods which exist on the Manager interface. These are the methods that can be hooked into.
+ */
+export type AnnotationManagerMethods = {
+    allowAnnotation: () => boolean;
+    startDraft: () => StartDraftResult;
+    clearDraft: () => ClearDraftResult;
+    applyDraft: (id: AnnotationId) => ApplyDraftResult;
+    getDraft: () => GetDraftResult;
+    setIsAnnotationSelected: (id: AnnotationId, isSelected: boolean) => SelectAnnotationResult;
+    setIsAnnotationHovered: (id: AnnotationId, isHovered: boolean) => HoverAnnotationResult;
+    clearAnnotation: (id: AnnotationId) => ClearAnnotationResult;
+};
+export type AnnotationManager = AnnotationManagerMethods & {
+    /**
+     * This method is used to set a preemptive gate. A preemptive gate is a function that will be called
+     * before the manager performs an action. If the function returns false, the action will not be performed.
+     */
+    setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
+    /**
+     * This method is used to run the configured preemptive gate check.
+     * @internal
+     */
+    checkPreemptiveGate(): Promise<boolean>;
+    onDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
+    offDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
+    onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    /**
+     * @internal
+     * This method is intended for internal Platform use only. It is not intended for use by Product code.
+     */
+    emit(event: {
+        name: 'draftAnnotationStarted';
+        data: AnnotationDraftStartedData;
+    } | {
+        name: 'annotationSelectionChanged';
+        data: AnnotationSelectedChangeData;
+    }): AnnotationManager;
+    /**
+     * @internal
+     * This method is intended for internal Platform use only. It is not intended for use by Product code.
+     */
+    hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
+    /**
+     * @internal
+     * This method is intended for internal Platform use only. It is not intended for use by Product code.
+     */
+    unhook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
+};
+export declare function createAnnotationManager(): AnnotationManager;
 export {};

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

@@ -0,0 +1,32 @@
+import type { AnnotationId } from '@atlaskit/adf-schema';
+import type { AnnotationDraftStartedData, AnnotationManager, AnnotationManagerEvents, AnnotationManagerMethods, AnnotationSelectedChangeData, ApplyDraftResult, ClearAnnotationResult, ClearDraftResult, GetDraftResult, HoverAnnotationResult, SelectAnnotationResult, StartDraftResult } from './index';
+export declare class SharedAnnotationManager implements AnnotationManager {
+    /**
+     * This is the event emitter that is used to emit events from the manager. It is used to communicate with
+     * other parts of the application.
+     */
+    private emitter;
+    /**
+     * This is the map of hooks that can be added to the manager. Hooks are a 1:1 mapping of methods that can be
+     * called on the manager. They are used to extend the functionality of the manager.
+     */
+    private hooks;
+    private preemptiveGate;
+    setPreemptiveGate(handler: () => Promise<boolean>): AnnotationManager;
+    checkPreemptiveGate(): Promise<boolean>;
+    onDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
+    offDraftAnnotationStarted(handler: (data: AnnotationDraftStartedData) => void): AnnotationManager;
+    onAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    offAnnotationSelectionChange(handler: (data: AnnotationSelectedChangeData) => void): AnnotationManager;
+    emit(event: AnnotationManagerEvents): AnnotationManager;
+    hook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
+    unhook<H extends keyof AnnotationManagerMethods>(method: H, handler: AnnotationManagerMethods[H]): AnnotationManager;
+    allowAnnotation(): boolean;
+    startDraft(): StartDraftResult;
+    clearDraft(): ClearDraftResult;
+    applyDraft(id: AnnotationId): ApplyDraftResult;
+    getDraft(): GetDraftResult;
+    setIsAnnotationSelected(id: string, isSelected: boolean): SelectAnnotationResult;
+    setIsAnnotationHovered(id: string, isHovered: boolean): HoverAnnotationResult;
+    clearAnnotation(id: AnnotationId): ClearAnnotationResult;
+}

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

@@ -4,6 +4,9 @@ type NamedPluginStatesFromInjectionAPI<API extends ExtractInjectionAPI<NextEdito
 }>;
 type ExtractPluginNames<API extends EditorInjectionAPI<any, any>> = keyof API;
 type Cleanup = () => void;
+type Options = {
+    disabled?: boolean;
+};
 /**
  *
  * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
@@ -48,5 +51,5 @@ type Cleanup = () => void;
  * If the callback changes the effect is not re-run - it is still recommended however to wrap your effect in `useCallback`,
  * You can return a function from your effect to call any cleanup activities which will be called on unmount and when `editorApi` changes.
  */
-export declare function usePluginStateEffect<API extends EditorInjectionAPI<any, any>, PluginNames extends ExtractPluginNames<API>>(injectionApi: API | null | undefined, plugins: PluginNames[], effect: (states: NamedPluginStatesFromInjectionAPI<API, PluginNames>) => Cleanup | void): void;
+export declare function usePluginStateEffect<API extends EditorInjectionAPI<any, any>, PluginNames extends ExtractPluginNames<API>>(injectionApi: API | null | undefined, plugins: PluginNames[], effect: (states: NamedPluginStatesFromInjectionAPI<API, PluginNames>) => Cleanup | void, options?: Options): void;
 export {};

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

@@ -3,6 +3,9 @@ export type NamedPluginStatesFromInjectionAPI<API extends ExtractInjectionAPI<Ne
     [K in PluginNames as `${K extends string ? K : never}State`]: API[K] extends BasePluginDependenciesAPI<any> | undefined ? Exclude<API[K], undefined> extends BasePluginDependenciesAPI<infer Metadata> ? Metadata extends NextEditorPluginMetadata ? ExtractPluginSharedState<Metadata> | undefined : never : never : never;
 }>;
 export type ExtractPluginNames<API extends EditorInjectionAPI<any, any>> = keyof API;
+type Options = {
+    disabled?: boolean;
+};
 /**
  *
  * NOTE: Generally you may want to use `usePluginStateSelector` over this which behaves similarly
@@ -64,7 +67,9 @@ export type ExtractPluginNames<API extends EditorInjectionAPI<any, any>> = keyof
  *
  * @param injectionApi Plugin injection API from `NextEditorPlugin`
  * @param plugins Plugin names to get the shared plugin state for
+ * @param options The useSharedPluginState options
  * @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<API extends EditorInjectionAPI<any, any>, PluginNames extends ExtractPluginNames<API>>(injectionApi: API | null | undefined, plugins: PluginNames[]): NamedPluginStatesFromInjectionAPI<API, PluginNames>;
+export declare function useSharedPluginState<API extends EditorInjectionAPI<any, any>, PluginNames extends ExtractPluginNames<API>>(injectionApi: API | null | undefined, plugins: PluginNames[], options?: Options): NamedPluginStatesFromInjectionAPI<API, PluginNames>;
+export {};

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

@@ -26,6 +26,9 @@ type NestedKeys<T> = {
  * ```
  */
 type Path<T, K extends string> = K extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? Path<T[Key], Rest> : never : K extends keyof T ? T[K] : never;
+type Options = {
+    disabled?: boolean;
+};
 /**
  *
  * ⚠️⚠️⚠️ This is a debounced hook ⚠️⚠️⚠️
@@ -68,7 +71,8 @@ type Path<T, K extends string> = K extends `${infer Key}.${infer Rest}` ? Key ex
  *
  * @param api
  * @param plugin
+ * @param options
  * @returns
  */
-export declare function useSharedPluginStateSelector<API extends EditorInjectionAPI<any, any>, PluginName extends ExtractPluginNames<API>, SharedState extends ReturnType<Exclude<API[PluginName], null | undefined>['sharedState']['currentState']>, Key extends NestedKeys<Exclude<SharedState, null | undefined>>, Result extends Path<Exclude<SharedState, null | undefined>, Key>>(api: API | undefined | null, plugin: `${PluginName}.${Key}`): Result | undefined;
+export declare function useSharedPluginStateSelector<API extends EditorInjectionAPI<any, any>, PluginName extends ExtractPluginNames<API>, SharedState extends ReturnType<Exclude<API[PluginName], null | undefined>['sharedState']['currentState']>, Key extends NestedKeys<Exclude<SharedState, null | undefined>>, Result extends Path<Exclude<SharedState, null | undefined>, Key>>(api: API | undefined | null, plugin: `${PluginName}.${Key}`, options?: Options): Result | undefined;
 export {};