@prosekit/extensions 0.12.2 → 0.13.0

package/src/loro/loro-keymap.ts

@@ -11,7 +11,7 @@ import {
 
 const keymap: Keymap = {
   'Mod-z': undo,
-  'Shift-Mod-z': redo,
+  'Mod-Z': redo,
 }
 
 if (!isApple) {

package/src/loro/loro.ts

@@ -7,6 +7,8 @@ import {
 } from '@prosekit/core'
 import type {
   CursorAwareness,
+  CursorEphemeralStore,
+  CursorPluginOptions,
   LoroDocType,
   LoroSyncPluginProps,
   LoroUndoPluginProps,
@@ -16,10 +18,7 @@ import {
   defineLoroCommands,
   type LoroCommandsExtension,
 } from './loro-commands'
-import {
-  defineLoroCursorPlugin,
-  type LoroCursorOptions,
-} from './loro-cursor-plugin'
+import { defineLoroCursorPlugin } from './loro-cursor-plugin'
 import { defineLoroKeymap } from './loro-keymap'
 import { defineLoroSyncPlugin } from './loro-sync-plugin'
 import { defineLoroUndoPlugin } from './loro-undo-plugin'
@@ -31,9 +30,14 @@ export interface LoroOptions {
   doc: LoroDocType
 
   /**
-   * The Awareness instance.
+   * The (legacy) Awareness instance. One of `awareness` or `presence` must be provided.
+   */
+  awareness?: CursorAwareness
+
+  /**
+   * The CursorEphemeralStore instance. One of `awareness` or `presence` must be provided.
    */
-  awareness: CursorAwareness
+  presence?: CursorEphemeralStore
 
   /**
    * Extra options for `LoroSyncPlugin`.
@@ -46,9 +50,9 @@ export interface LoroOptions {
   undo?: Omit<LoroUndoPluginProps, 'doc'>
 
   /**
-   * Extra options for `LoroCursorPlugin`.
+   * Extra options for `LoroCursorPlugin` or `LoroEphemeralCursorPlugin`.
    */
-  cursor?: Omit<LoroCursorOptions, 'awareness'>
+  cursor?: CursorPluginOptions
 }
 
 /**
@@ -60,13 +64,13 @@ export type LoroExtension = Union<[LoroCommandsExtension, PlainExtension]>
  * @public
  */
 export function defineLoro(options: LoroOptions): LoroExtension {
-  const { doc, awareness, sync, undo, cursor } = options
+  const { doc, awareness, presence, sync, undo, cursor } = options
 
   return withPriority(
     union([
       defineLoroKeymap(),
       defineLoroCommands(),
-      defineLoroCursorPlugin({ ...cursor, awareness }),
+      defineLoroCursorPlugin({ ...cursor, awareness, presence }),
       defineLoroUndoPlugin({ ...undo, doc }),
       defineLoroSyncPlugin({ ...sync, doc }),
     ]),

package/src/paragraph/paragraph-keymap.ts

@@ -10,6 +10,6 @@ import { setParagraph } from './paragraph-commands'
  */
 export function defineParagraphKeymap(): PlainExtension {
   return defineKeymap({
-    'mod-alt-0': setParagraph(),
+    'Mod-Alt-0': setParagraph(),
   })
 }

package/src/placeholder/index.ts

@@ -1,6 +1,7 @@
 import {
   definePlugin,
   isInCodeBlock,
+  isTextSelection,
   maybeRun,
   type PlainExtension,
 } from '@prosekit/core'
@@ -98,7 +99,7 @@ function createPlaceholderDecoration(
   if (!placeholderText) return null
 
   const { selection } = state
-  if (!selection.empty) return null
+  if (!selection.empty || !isTextSelection(selection)) return null
 
   const $pos = selection.$anchor
   const node = $pos.parent

package/src/strike/index.ts

@@ -64,8 +64,8 @@ export function defineStrikeCommands(): StrikeCommandsExtension {
  */
 export function defineStrikeKeymap(): PlainExtension {
   return defineKeymap({
-    'Mod-shift-s': toggleMark({ type: 'strike' }),
-    'Mod-shift-x': toggleMark({ type: 'strike' }),
+    'Mod-S': toggleMark({ type: 'strike' }),
+    'Mod-X': toggleMark({ type: 'strike' }),
   })
 }
 

package/src/testing/index.ts

@@ -14,6 +14,7 @@ import {
   createTestEditor,
   type TestEditor,
 } from '@prosekit/core/test'
+import { keyboard } from 'vitest-browser-commands/playwright'
 
 import { defineBlockquote } from '../blockquote'
 import { defineBold } from '../bold'
@@ -41,7 +42,6 @@ import {
   readHtmlTextFromClipboard,
   readPlainTextFromClipboard,
 } from './clipboard'
-import { pressKey } from './keyboard'
 
 /**
  * @internal
@@ -124,7 +124,7 @@ export function setupTest() {
 
   const copy = async () => {
     editor.view.dom.focus()
-    await pressKey('mod-C')
+    await keyboard.press('ControlOrMeta+C')
     const html = await readHtmlTextFromClipboard()
     const plain = await readPlainTextFromClipboard()
     return { html, plain }

package/src/testing/keyboard.ts

@@ -1,35 +1,5 @@
-import { isApple } from '@prosekit/core'
 import { userEvent } from 'vitest/browser'
 
-/**
- * @example
- *
- * ```ts
- * await pressKey('mod-1')
- * await pressKey('Backspace')
- * ```
- *
- * @internal
- */
-export async function pressKey(input: string): Promise<void> {
-  const keys = input.split('-').map((key) => {
-    if (key.toLowerCase() === 'mod') {
-      return isApple ? 'Meta' : 'Control'
-    }
-    return key
-  })
-  const seq: string[] = []
-  for (const key of keys) {
-    // Press key without releasing it
-    seq.push('{' + key + '>}')
-  }
-  for (const key of keys.toReversed()) {
-    // Release a previously pressed key
-    seq.push('{/' + key + '}')
-  }
-  return await userEvent.keyboard(seq.join(''))
-}
-
 export async function inputText(input: string): Promise<void> {
   return await userEvent.keyboard(input)
 }

package/src/text-align/index.ts

@@ -102,10 +102,10 @@ export function defineTextAlignCommands(
  */
 export function defineTextAlignKeymap(types: string[]): PlainExtension {
   return defineKeymap({
-    'mod-shift-l': setTextAlign({ types, value: 'left' }),
-    'mod-shift-e': setTextAlign({ types, value: 'center' }),
-    'mod-shift-r': setTextAlign({ types, value: 'right' }),
-    'mod-shift-j': setTextAlign({ types, value: 'justify' }),
+    'Mod-L': setTextAlign({ types, value: 'left' }),
+    'Mod-E': setTextAlign({ types, value: 'center' }),
+    'Mod-R': setTextAlign({ types, value: 'right' }),
+    'Mod-J': setTextAlign({ types, value: 'justify' }),
   })
 }
 

package/src/yjs/yjs-keymap.ts

@@ -11,7 +11,7 @@ import {
 
 const keymap: Keymap = {
   'Mod-z': undoCommand,
-  'Shift-Mod-z': redoCommand,
+  'Mod-Z': redoCommand,
 }
 
 if (!isApple) {