@atlaskit/editor-plugin-placeholder 6.5.4 → 6.6.1

package/dist/esm/pm-plugins/utils.js

@@ -0,0 +1,232 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { placeholderTextMessages as messages } from '@atlaskit/editor-common/messages';
+import { bracketTyped, hasDocAsParent, isEmptyDocument, isEmptyParagraph } from '@atlaskit/editor-common/utils';
+import { findParentNode } from '@atlaskit/editor-prosemirror/utils';
+import { fg } from '@atlaskit/platform-feature-flags';
+import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
+import { pluginKey } from '../placeholderPlugin';
+import { createLongEmptyNodePlaceholderADF, createShortEmptyNodePlaceholderADF } from './adf-builders';
+import { nodeTypesWithLongPlaceholderText, nodeTypesWithShortPlaceholderText, nodeTypesWithSyncBlockPlaceholderText } from './constants';
+export function getPlaceholderState(editorState) {
+  return pluginKey.getState(editorState);
+}
+export function setPlaceHolderState(_ref) {
+  var placeholderText = _ref.placeholderText,
+    pos = _ref.pos,
+    placeholderPrompts = _ref.placeholderPrompts,
+    typedAndDeleted = _ref.typedAndDeleted,
+    userHadTyped = _ref.userHadTyped,
+    canShowOnEmptyParagraph = _ref.canShowOnEmptyParagraph,
+    showOnEmptyParagraph = _ref.showOnEmptyParagraph,
+    contextPlaceholderADF = _ref.contextPlaceholderADF;
+  return {
+    hasPlaceholder: true,
+    placeholderText: placeholderText,
+    placeholderPrompts: placeholderPrompts,
+    contextPlaceholderADF: contextPlaceholderADF,
+    pos: pos ? pos : 1,
+    typedAndDeleted: typedAndDeleted,
+    userHadTyped: userHadTyped,
+    canShowOnEmptyParagraph: canShowOnEmptyParagraph,
+    showOnEmptyParagraph: showOnEmptyParagraph
+  };
+}
+export var emptyPlaceholder = function emptyPlaceholder(_ref2) {
+  var placeholderText = _ref2.placeholderText,
+    placeholderPrompts = _ref2.placeholderPrompts,
+    userHadTyped = _ref2.userHadTyped,
+    pos = _ref2.pos,
+    canShowOnEmptyParagraph = _ref2.canShowOnEmptyParagraph,
+    showOnEmptyParagraph = _ref2.showOnEmptyParagraph;
+  return {
+    hasPlaceholder: false,
+    placeholderText: placeholderText,
+    placeholderPrompts: placeholderPrompts,
+    userHadTyped: userHadTyped,
+    typedAndDeleted: false,
+    canShowOnEmptyParagraph: canShowOnEmptyParagraph,
+    showOnEmptyParagraph: showOnEmptyParagraph,
+    pos: pos
+  };
+};
+export function createPlaceHolderStateFrom(_ref3) {
+  var isInitial = _ref3.isInitial,
+    isEditorFocused = _ref3.isEditorFocused,
+    editorState = _ref3.editorState,
+    isTypeAheadOpen = _ref3.isTypeAheadOpen,
+    defaultPlaceholderText = _ref3.defaultPlaceholderText,
+    intl = _ref3.intl,
+    bracketPlaceholderText = _ref3.bracketPlaceholderText,
+    emptyLinePlaceholder = _ref3.emptyLinePlaceholder,
+    placeholderADF = _ref3.placeholderADF,
+    placeholderPrompts = _ref3.placeholderPrompts,
+    typedAndDeleted = _ref3.typedAndDeleted,
+    userHadTyped = _ref3.userHadTyped,
+    isPlaceholderHidden = _ref3.isPlaceholderHidden,
+    withEmptyParagraph = _ref3.withEmptyParagraph,
+    showOnEmptyParagraph = _ref3.showOnEmptyParagraph;
+  if (isPlaceholderHidden && withEmptyParagraph) {
+    return _objectSpread(_objectSpread({}, emptyPlaceholder({
+      placeholderText: defaultPlaceholderText,
+      placeholderPrompts: placeholderPrompts,
+      userHadTyped: userHadTyped
+    })), {}, {
+      isPlaceholderHidden: isPlaceholderHidden
+    });
+  }
+  if (isTypeAheadOpen !== null && isTypeAheadOpen !== void 0 && isTypeAheadOpen(editorState)) {
+    return emptyPlaceholder({
+      placeholderText: defaultPlaceholderText,
+      placeholderPrompts: placeholderPrompts,
+      userHadTyped: userHadTyped
+    });
+  }
+  if ((defaultPlaceholderText || placeholderPrompts || placeholderADF) && isEmptyDocument(editorState.doc)) {
+    return setPlaceHolderState({
+      placeholderText: defaultPlaceholderText,
+      pos: 1,
+      placeholderPrompts: placeholderPrompts,
+      typedAndDeleted: typedAndDeleted,
+      userHadTyped: userHadTyped
+    });
+  }
+  if (withEmptyParagraph) {
+    var _editorState$selectio = editorState.selection,
+      from = _editorState$selectio.from,
+      to = _editorState$selectio.to,
+      $to = _editorState$selectio.$to;
+    if ((defaultPlaceholderText || placeholderADF) && withEmptyParagraph && isEditorFocused && !isInitial && !isEmptyDocument(editorState.doc) && from === to && isEmptyParagraph($to.parent) && hasDocAsParent($to)) {
+      return showOnEmptyParagraph ? setPlaceHolderState({
+        placeholderText: defaultPlaceholderText,
+        pos: to,
+        placeholderPrompts: placeholderPrompts,
+        typedAndDeleted: typedAndDeleted,
+        userHadTyped: userHadTyped,
+        canShowOnEmptyParagraph: true,
+        showOnEmptyParagraph: true
+      }) : emptyPlaceholder({
+        placeholderText: defaultPlaceholderText,
+        placeholderPrompts: placeholderPrompts,
+        userHadTyped: userHadTyped,
+        canShowOnEmptyParagraph: true,
+        showOnEmptyParagraph: false,
+        pos: to
+      });
+    }
+  }
+  if (isEditorFocused && editorExperiment('platform_editor_controls', 'variant1')) {
+    var _parentNode$firstChil, _parentNode$firstChil2;
+    var _editorState$selectio2 = editorState.selection,
+      $from = _editorState$selectio2.$from,
+      _$to = _editorState$selectio2.$to;
+    if ($from.pos !== _$to.pos) {
+      return emptyPlaceholder({
+        placeholderText: defaultPlaceholderText,
+        placeholderPrompts: placeholderPrompts,
+        userHadTyped: userHadTyped
+      });
+    }
+    var parentNode = $from.node($from.depth - 1);
+    var parentType = parentNode === null || parentNode === void 0 ? void 0 : parentNode.type.name;
+    if (emptyLinePlaceholder && parentType === 'doc') {
+      var isEmptyLine = isEmptyParagraph($from.parent);
+      if (isEmptyLine) {
+        return setPlaceHolderState({
+          placeholderText: emptyLinePlaceholder,
+          pos: $from.pos,
+          placeholderPrompts: placeholderPrompts,
+          typedAndDeleted: typedAndDeleted,
+          userHadTyped: userHadTyped
+        });
+      }
+    }
+    var isEmptyNode = (parentNode === null || parentNode === void 0 ? void 0 : parentNode.childCount) === 1 && ((_parentNode$firstChil = parentNode.firstChild) === null || _parentNode$firstChil === void 0 ? void 0 : _parentNode$firstChil.content.size) === 0 && ((_parentNode$firstChil2 = parentNode.firstChild) === null || _parentNode$firstChil2 === void 0 ? void 0 : _parentNode$firstChil2.type.name) === 'paragraph';
+    if (nodeTypesWithShortPlaceholderText.includes(parentType) && isEmptyNode) {
+      var _table$node$firstChil;
+      var table = findParentNode(function (node) {
+        return node.type === editorState.schema.nodes.table;
+      })(editorState.selection);
+      if (!table) {
+        return emptyPlaceholder({
+          placeholderText: defaultPlaceholderText,
+          placeholderPrompts: placeholderPrompts,
+          userHadTyped: userHadTyped
+        });
+      }
+      var isFirstCell = (table === null || table === void 0 || (_table$node$firstChil = table.node.firstChild) === null || _table$node$firstChil === void 0 ? void 0 : _table$node$firstChil.content.firstChild) === parentNode;
+      if (isFirstCell) {
+        return setPlaceHolderState({
+          placeholderText: !fg('platform_editor_ai_aifc_patch_ga') ? intl.formatMessage(messages.shortEmptyNodePlaceholderText) : undefined,
+          contextPlaceholderADF: fg('platform_editor_ai_aifc_patch_ga') ? createShortEmptyNodePlaceholderADF(intl) : undefined,
+          pos: $from.pos,
+          placeholderPrompts: placeholderPrompts,
+          typedAndDeleted: typedAndDeleted,
+          userHadTyped: userHadTyped
+        });
+      }
+    }
+    if (nodeTypesWithLongPlaceholderText.includes(parentType) && isEmptyNode) {
+      return setPlaceHolderState({
+        placeholderText: !fg('platform_editor_ai_aifc_patch_ga') ? intl.formatMessage(messages.longEmptyNodePlaceholderText) : undefined,
+        contextPlaceholderADF: fg('platform_editor_ai_aifc_patch_ga') ? createLongEmptyNodePlaceholderADF(intl) : undefined,
+        pos: $from.pos,
+        placeholderPrompts: placeholderPrompts,
+        typedAndDeleted: typedAndDeleted,
+        userHadTyped: userHadTyped
+      });
+    }
+    if (nodeTypesWithSyncBlockPlaceholderText.includes(parentType) && isEmptyNode && editorExperiment('platform_synced_block', true)) {
+      return setPlaceHolderState({
+        placeholderText: intl.formatMessage(messages.syncBlockPlaceholderText),
+        pos: $from.pos,
+        placeholderPrompts: placeholderPrompts,
+        typedAndDeleted: typedAndDeleted,
+        userHadTyped: userHadTyped
+      });
+    }
+    return emptyPlaceholder({
+      placeholderText: defaultPlaceholderText,
+      placeholderPrompts: placeholderPrompts,
+      userHadTyped: userHadTyped
+    });
+  }
+  if (bracketPlaceholderText && bracketTyped(editorState) && isEditorFocused) {
+    var _$from = editorState.selection.$from;
+    // Space is to account for positioning of the bracket
+    var bracketHint = '  ' + bracketPlaceholderText;
+    return setPlaceHolderState({
+      placeholderText: bracketHint,
+      pos: _$from.pos - 1,
+      placeholderPrompts: placeholderPrompts,
+      typedAndDeleted: typedAndDeleted,
+      userHadTyped: userHadTyped
+    });
+  }
+  return emptyPlaceholder({
+    placeholderText: defaultPlaceholderText,
+    placeholderPrompts: placeholderPrompts,
+    userHadTyped: userHadTyped
+  });
+}
+export function calculateUserInteractionState(_ref4) {
+  var placeholderState = _ref4.placeholderState,
+    oldEditorState = _ref4.oldEditorState,
+    newEditorState = _ref4.newEditorState;
+  var wasEmpty = oldEditorState ? isEmptyDocument(oldEditorState.doc) : true;
+  var isEmpty = isEmptyDocument(newEditorState.doc);
+  var hasEverTyped = Boolean(placeholderState === null || placeholderState === void 0 ? void 0 : placeholderState.userHadTyped) ||
+  // Previously typed
+  !wasEmpty ||
+  // Had content before
+  wasEmpty && !isEmpty; // Just added content
+  var justDeletedAll = hasEverTyped && isEmpty && !wasEmpty;
+  var isInTypedAndDeletedState = justDeletedAll || Boolean(placeholderState === null || placeholderState === void 0 ? void 0 : placeholderState.typedAndDeleted) && isEmpty;
+  // Only reset user interaction tracking when editor is cleanly empty
+  var shouldResetInteraction = isEmpty && !isInTypedAndDeletedState;
+  return {
+    userHadTyped: shouldResetInteraction ? false : hasEverTyped,
+    typedAndDeleted: isInTypedAndDeletedState
+  };
+}

package/dist/types/placeholderPlugin.d.ts

@@ -1,13 +1,5 @@
-import type { IntlShape } from 'react-intl-next';
-import type { DocNode } from '@atlaskit/adf-schema';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { PlaceholderPlugin } from './placeholderPluginType';
 export declare const EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000;
 export declare const pluginKey: PluginKey<any>;
-export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;
-export declare function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
 export declare const placeholderPlugin: PlaceholderPlugin;

package/dist/types/pm-plugins/adf-builders.d.ts

@@ -0,0 +1,4 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+export declare const createShortEmptyNodePlaceholderADF: ({ formatMessage }: IntlShape) => DocNode;
+export declare const createLongEmptyNodePlaceholderADF: ({ formatMessage }: IntlShape) => DocNode;

package/dist/types/pm-plugins/animation.d.ts

@@ -0,0 +1 @@
+export declare const cycleThroughPlaceholderPrompts: (placeholderPrompts: string[], activeTypewriterTimeouts: (() => void)[] | undefined, placeholderNodeWithText: HTMLElement, initialDelayWhenUserTypedAndDeleted?: number) => void;

package/dist/types/pm-plugins/constants.d.ts

@@ -0,0 +1,9 @@
+export declare const placeholderTestId = "placeholder-test-id";
+export declare const TYPEWRITER_TYPE_DELAY = 50;
+export declare const TYPEWRITER_PAUSE_BEFORE_ERASE = 2000;
+export declare const TYPEWRITER_ERASE_DELAY = 40;
+export declare const TYPEWRITER_CYCLE_DELAY = 500;
+export declare const TYPEWRITER_TYPED_AND_DELETED_DELAY = 1500;
+export declare const nodeTypesWithLongPlaceholderText: string[];
+export declare const nodeTypesWithShortPlaceholderText: string[];
+export declare const nodeTypesWithSyncBlockPlaceholderText: string[];

package/dist/types/pm-plugins/decorations.d.ts

@@ -0,0 +1,4 @@
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;

package/dist/types/pm-plugins/main.d.ts

@@ -0,0 +1,6 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { PlaceholderPlugin } from '../placeholderPluginType';
+export default function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;

package/dist/types/pm-plugins/placeholderPluginLegacy.d.ts

@@ -0,0 +1,13 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { PlaceholderPlugin } from '../placeholderPluginType';
+export declare const EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000;
+export declare const pluginKey: PluginKey<any>;
+export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;
+export declare function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
+export declare const placeholderPluginLegacy: PlaceholderPlugin;

package/dist/types/pm-plugins/types.d.ts

@@ -0,0 +1,37 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export interface PlaceHolderState {
+    canShowOnEmptyParagraph?: boolean;
+    contextPlaceholderADF?: DocNode;
+    hasPlaceholder: boolean;
+    isPlaceholderHidden?: boolean;
+    placeholderPrompts?: string[];
+    placeholderText?: string;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+}
+export type CreatePlaceholderStateProps = {
+    bracketPlaceholderText?: string;
+    defaultPlaceholderText: string | undefined;
+    editorState: EditorState;
+    emptyLinePlaceholder?: string;
+    intl: IntlShape;
+    isEditorFocused: boolean;
+    isInitial?: boolean;
+    isPlaceholderHidden?: boolean;
+    isTypeAheadOpen: ((editorState: EditorState) => boolean) | undefined;
+    placeholderADF?: DocNode;
+    placeholderPrompts?: string[];
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+    withEmptyParagraph?: boolean;
+};
+export type UserInteractionState = {
+    newEditorState: EditorState;
+    oldEditorState?: EditorState;
+    placeholderState?: PlaceHolderState;
+};

package/dist/types/pm-plugins/utils.d.ts

@@ -0,0 +1,27 @@
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { PlaceHolderState, CreatePlaceholderStateProps, UserInteractionState } from './types';
+export declare function getPlaceholderState(editorState: EditorState): PlaceHolderState;
+export declare function setPlaceHolderState({ placeholderText, pos, placeholderPrompts, typedAndDeleted, userHadTyped, canShowOnEmptyParagraph, showOnEmptyParagraph, contextPlaceholderADF, }: {
+    canShowOnEmptyParagraph?: boolean;
+    contextPlaceholderADF?: DocNode;
+    placeholderPrompts?: string[];
+    placeholderText?: string;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+}): PlaceHolderState;
+export declare const emptyPlaceholder: ({ placeholderText, placeholderPrompts, userHadTyped, pos, canShowOnEmptyParagraph, showOnEmptyParagraph, }: {
+    canShowOnEmptyParagraph?: boolean;
+    placeholderPrompts?: string[];
+    placeholderText: string | undefined;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    userHadTyped?: boolean;
+}) => PlaceHolderState;
+export declare function createPlaceHolderStateFrom({ isInitial, isEditorFocused, editorState, isTypeAheadOpen, defaultPlaceholderText, intl, bracketPlaceholderText, emptyLinePlaceholder, placeholderADF, placeholderPrompts, typedAndDeleted, userHadTyped, isPlaceholderHidden, withEmptyParagraph, showOnEmptyParagraph, }: CreatePlaceholderStateProps): PlaceHolderState;
+export declare function calculateUserInteractionState({ placeholderState, oldEditorState, newEditorState, }: UserInteractionState): {
+    typedAndDeleted: boolean;
+    userHadTyped: boolean;
+};

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

@@ -1,13 +1,5 @@
-import type { IntlShape } from 'react-intl-next';
-import type { DocNode } from '@atlaskit/adf-schema';
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
 import type { PlaceholderPlugin } from './placeholderPluginType';
 export declare const EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000;
 export declare const pluginKey: PluginKey<any>;
-export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;
-export declare function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
 export declare const placeholderPlugin: PlaceholderPlugin;

package/dist/types-ts4.5/pm-plugins/adf-builders.d.ts

@@ -0,0 +1,4 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+export declare const createShortEmptyNodePlaceholderADF: ({ formatMessage }: IntlShape) => DocNode;
+export declare const createLongEmptyNodePlaceholderADF: ({ formatMessage }: IntlShape) => DocNode;

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

@@ -0,0 +1 @@
+export declare const cycleThroughPlaceholderPrompts: (placeholderPrompts: string[], activeTypewriterTimeouts: (() => void)[] | undefined, placeholderNodeWithText: HTMLElement, initialDelayWhenUserTypedAndDeleted?: number) => void;

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

@@ -0,0 +1,9 @@
+export declare const placeholderTestId = "placeholder-test-id";
+export declare const TYPEWRITER_TYPE_DELAY = 50;
+export declare const TYPEWRITER_PAUSE_BEFORE_ERASE = 2000;
+export declare const TYPEWRITER_ERASE_DELAY = 40;
+export declare const TYPEWRITER_CYCLE_DELAY = 500;
+export declare const TYPEWRITER_TYPED_AND_DELETED_DELAY = 1500;
+export declare const nodeTypesWithLongPlaceholderText: string[];
+export declare const nodeTypesWithShortPlaceholderText: string[];
+export declare const nodeTypesWithSyncBlockPlaceholderText: string[];

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

@@ -0,0 +1,4 @@
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;

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

@@ -0,0 +1,6 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { PlaceholderPlugin } from '../placeholderPluginType';
+export default function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;

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

@@ -0,0 +1,13 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
+import type { PlaceholderPlugin } from '../placeholderPluginType';
+export declare const EMPTY_PARAGRAPH_TIMEOUT_DELAY = 2000;
+export declare const pluginKey: PluginKey<any>;
+export declare function createPlaceholderDecoration(editorState: EditorState, placeholderText: string, placeholderPrompts?: string[], activeTypewriterTimeouts?: (() => void)[], pos?: number, initialDelayWhenUserTypedAndDeleted?: number, placeholderADF?: DocNode): DecorationSet;
+export declare function createPlugin(intl: IntlShape, defaultPlaceholderText?: string, bracketPlaceholderText?: string, emptyLinePlaceholder?: string, placeholderPrompts?: string[], withEmptyParagraph?: boolean, placeholderADF?: DocNode, api?: ExtractInjectionAPI<PlaceholderPlugin>): SafePlugin | undefined;
+export declare const placeholderPluginLegacy: PlaceholderPlugin;

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

@@ -0,0 +1,37 @@
+import type { IntlShape } from 'react-intl-next';
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+export interface PlaceHolderState {
+    canShowOnEmptyParagraph?: boolean;
+    contextPlaceholderADF?: DocNode;
+    hasPlaceholder: boolean;
+    isPlaceholderHidden?: boolean;
+    placeholderPrompts?: string[];
+    placeholderText?: string;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+}
+export type CreatePlaceholderStateProps = {
+    bracketPlaceholderText?: string;
+    defaultPlaceholderText: string | undefined;
+    editorState: EditorState;
+    emptyLinePlaceholder?: string;
+    intl: IntlShape;
+    isEditorFocused: boolean;
+    isInitial?: boolean;
+    isPlaceholderHidden?: boolean;
+    isTypeAheadOpen: ((editorState: EditorState) => boolean) | undefined;
+    placeholderADF?: DocNode;
+    placeholderPrompts?: string[];
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+    withEmptyParagraph?: boolean;
+};
+export type UserInteractionState = {
+    newEditorState: EditorState;
+    oldEditorState?: EditorState;
+    placeholderState?: PlaceHolderState;
+};

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

@@ -0,0 +1,27 @@
+import type { DocNode } from '@atlaskit/adf-schema';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import type { PlaceHolderState, CreatePlaceholderStateProps, UserInteractionState } from './types';
+export declare function getPlaceholderState(editorState: EditorState): PlaceHolderState;
+export declare function setPlaceHolderState({ placeholderText, pos, placeholderPrompts, typedAndDeleted, userHadTyped, canShowOnEmptyParagraph, showOnEmptyParagraph, contextPlaceholderADF, }: {
+    canShowOnEmptyParagraph?: boolean;
+    contextPlaceholderADF?: DocNode;
+    placeholderPrompts?: string[];
+    placeholderText?: string;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    typedAndDeleted?: boolean;
+    userHadTyped?: boolean;
+}): PlaceHolderState;
+export declare const emptyPlaceholder: ({ placeholderText, placeholderPrompts, userHadTyped, pos, canShowOnEmptyParagraph, showOnEmptyParagraph, }: {
+    canShowOnEmptyParagraph?: boolean;
+    placeholderPrompts?: string[];
+    placeholderText: string | undefined;
+    pos?: number;
+    showOnEmptyParagraph?: boolean;
+    userHadTyped?: boolean;
+}) => PlaceHolderState;
+export declare function createPlaceHolderStateFrom({ isInitial, isEditorFocused, editorState, isTypeAheadOpen, defaultPlaceholderText, intl, bracketPlaceholderText, emptyLinePlaceholder, placeholderADF, placeholderPrompts, typedAndDeleted, userHadTyped, isPlaceholderHidden, withEmptyParagraph, showOnEmptyParagraph, }: CreatePlaceholderStateProps): PlaceHolderState;
+export declare function calculateUserInteractionState({ placeholderState, oldEditorState, newEditorState, }: UserInteractionState): {
+    typedAndDeleted: boolean;
+    userHadTyped: boolean;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-placeholder",
-	"version": "6.5.4",
+	"version": "6.6.1",
 	"description": "Placeholder plugin for @atlaskit/editor-core.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,16 +30,16 @@
 		"@atlaskit/adf-utils": "^19.26.0",
 		"@atlaskit/editor-plugin-composition": "^5.0.0",
 		"@atlaskit/editor-plugin-focus": "^5.0.0",
-		"@atlaskit/editor-plugin-show-diff": "^3.2.0",
+		"@atlaskit/editor-plugin-show-diff": "^3.3.0",
 		"@atlaskit/editor-plugin-type-ahead": "^6.5.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^14.2.0",
+		"@atlaskit/tmp-editor-statsig": "^14.8.0",
 		"@atlaskit/tokens": "^8.4.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.36.0",
+		"@atlaskit/editor-common": "^110.40.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
@@ -48,13 +48,10 @@
 		"@testing-library/react": "^13.4.0"
 	},
 	"platform-feature-flags": {
-		"platform_editor_ai_aifc_patch_beta": {
-			"type": "boolean"
-		},
-		"platform_editor_ai_aifc_patch_beta_2": {
+		"platform_editor_ai_aifc_patch_ga": {
 			"type": "boolean"
 		},
-		"platform_editor_ai_aifc_patch_ga": {
+		"platform_editor_placeholder_plugin_tidying": {
 			"type": "boolean"
 		}
 	},