feat(core): expose appended transactions in the onChange handler (#1558)

remirror · Mar 17, 2022 · 68677ca · 68677ca · github-actions · Mar 17, 2022
1 parent 974a586
commit 68677ca
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 4 deletions.
diff --git a/.changeset/perfect-vans-roll.md b/.changeset/perfect-vans-roll.md
@@ -0,0 +1,6 @@
+---
+'@remirror/core': minor
+'@remirror/react-core': minor
+---
+
+Expose appended transactions via the onChange handler
diff --git a/packages/remirror__core/src/framework/base-framework.ts b/packages/remirror__core/src/framework/base-framework.ts
@@ -259,6 +259,16 @@ export interface RemirrorEventListenerProps<Extension extends AnyExtension>
    */
   tr?: Transaction<GetSchema<Extension>>;
 
+  /**
+   * When the state updates are not controlled and it was a transaction that
+   * caused the state to be updated this value captures all the transaction
+   * updates caused by prosemirror plugins hook state methods like
+   * `filterTransactions` and `appendTransactions`.
+   *
+   * This is for advanced users only.
+   */
+  transactions?: Array<Transaction<GetSchema<Extension>>>;
+
   /**
    * A shorthand way of checking whether the update was triggered by editor
    * usage (internal) or overwriting the state.
@@ -324,7 +334,17 @@ export interface TriggerChangeProps {
 
 export interface ListenerProps<Extension extends AnyExtension>
   extends Partial<EditorStateProps<GetSchema<Extension>>>,
-    Partial<TransactionProps<GetSchema<Extension>>> {}
+    Partial<TransactionProps<GetSchema<Extension>>> {
+  /**
+   * When the state updates are not controlled and it was a transaction that
+   * caused the state to be updated this value captures all the transaction
+   * updates caused by prosemirror plugins hook state methods like
+   * `filterTransactions` and `appendTransactions`.
+   *
+   * This is for advanced users only.
+   */
+  transactions?: Array<Transaction<GetSchema<Extension>>>;
+}
 
 export interface FrameworkEvents<Extension extends AnyExtension>
   extends Pick<ManagerEvents, 'destroy'> {

diff --git a/packages/remirror__core/src/framework/framework.ts b/packages/remirror__core/src/framework/framework.ts
@@ -460,10 +460,11 @@ export abstract class Framework<
   protected eventListenerProps(
     props: ListenerProps<Extension> = object(),
   ): RemirrorEventListenerProps<Extension> {
-    const { state, tr } = props;
+    const { state, tr, transactions } = props;
 
     return {
       tr,
+      transactions,
       internalUpdate: !tr,
       view: this.view,
       firstRender: this.#firstRender,

diff --git a/packages/remirror__react-core/src/react-framework.tsx b/packages/remirror__react-core/src/react-framework.tsx
@@ -200,7 +200,7 @@ export class ReactFramework<Extension extends AnyExtension> extends Framework<
         this.previousStateOverride = this.getState();
       }
 
-      this.onChange({ state, tr });
+      this.onChange({ state, tr, transactions });
 
       return;
     }
@@ -218,7 +218,7 @@ export class ReactFramework<Extension extends AnyExtension> extends Framework<
     // If `transactions` is an empty array, that means the transaction was cancelled by `filterTransaction`.
     if (triggerChange && transactions?.length !== 0) {
       // Update the `onChange` handler before notifying the manager but only when a change should be triggered.
-      this.onChange({ state, tr });
+      this.onChange({ state, tr, transactions });
     }
 
     this.manager.onStateUpdate({ previousState: this.previousState, state, tr, transactions });