chore(text editor): add typing to function params

Author: john-traas

src/components/text-editor/prosemirror-adapter/menu/menu-commands.ts

@@ -16,6 +16,7 @@ import {
     removeListNodes,
     convertAllListNodes,
     toggleList,
+    Dispatch,
 } from './utils/list-utils';
 import { adjustSelectionToFullBlocks } from './utils/selection-utils';
 import { copyPasteLinkCommand } from './utils/link-utils';
@@ -225,7 +226,13 @@ const createWrapInCommand = (
  * @param dispatch - The dispatch function.
  * @returns A command for handling list operations when there is no selection.
  */
-const handleListNoSelection = (state, type, schema, otherType, dispatch) => {
+const handleListNoSelection = (
+    state: EditorState,
+    type: NodeType,
+    schema: Schema,
+    otherType: NodeType,
+    dispatch: Dispatch,
+) => {
     const { $from } = state.selection;
     const blockFrom = $from.start();
     const blockTo = $from.end();
@@ -258,7 +265,13 @@ const handleListNoSelection = (state, type, schema, otherType, dispatch) => {
  * @param dispatch - The dispatch function.
  * @returns A command for handling list operations when there is a selection.
  */
-const handleListWithSelection = (state, type, schema, otherType, dispatch) => {
+const handleListWithSelection = (
+    state: EditorState,
+    type: NodeType,
+    schema: Schema,
+    otherType: NodeType,
+    dispatch: Dispatch,
+) => {
     const { $from } = state.selection;
     const listItemType = schema.nodes.list_item;
     const ancestorDepth = findAncestorDepthOfType($from, listItemType);
@@ -298,7 +311,10 @@ const handleListWithSelection = (state, type, schema, otherType, dispatch) => {
  * @param listTypeName - The name of the list type to toggle.
  * @returns A command for toggling list types.
  */
-export const createListCommand = (schema, listTypeName) => {
+export const createListCommand = (
+    schema: Schema,
+    listTypeName: string,
+): CommandWithActive => {
     const type = schema.nodes[listTypeName];
     if (!type) {
         throw new Error(`List type "${listTypeName}" not found in schema`);

src/components/text-editor/prosemirror-adapter/menu/utils/list-utils.ts

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { EditorState } from 'prosemirror-state';
+import { EditorState, Transaction } from 'prosemirror-state';
 import { NodeType, Fragment, Schema } from 'prosemirror-model';
 import { EditorMenuTypes } from '../types';
 import { findWrapping, liftTarget } from 'prosemirror-transform';
@@ -40,7 +40,14 @@ export const getOtherListType = (
     return schema.nodes[otherType];
 };
 
-export const removeListNodes = (state, targetType, schema, dispatch) => {
+export type Dispatch = (tr: Transaction) => void;
+
+export const removeListNodes = (
+    state: EditorState,
+    targetType: NodeType,
+    schema: Schema,
+    dispatch: Dispatch,
+) => {
     let tr = state.tr;
     let changed = false;
 
@@ -100,7 +107,11 @@ const fromBulletToOrderedList = (fromType: NodeType, toType: NodeType) => {
     );
 };
 
-const convertListAttributes = (fromType, toType, attrs) => {
+const convertListAttributes = (
+    fromType: NodeType,
+    toType: NodeType,
+    attrs: Record<string, any>,
+) => {
     const newAttrs = { ...attrs };
     if (fromOrderedToBulletList(fromType, toType)) {
         // Bullet lists generally do not need an "order" attribute.
@@ -113,7 +124,12 @@ const convertListAttributes = (fromType, toType, attrs) => {
     return newAttrs;
 };
 
-export const convertAllListNodes = (state, fromType, toType, dispatch) => {
+export const convertAllListNodes = (
+    state: EditorState,
+    fromType: NodeType,
+    toType: NodeType,
+    dispatch: Dispatch,
+) => {
     let converted = false;
     let tr = state.tr;
 
@@ -149,8 +165,8 @@ export const convertAllListNodes = (state, fromType, toType, dispatch) => {
     return converted;
 };
 
-export const toggleList = (listType) => {
-    return (state, dispatch) => {
+export const toggleList = (listType: NodeType) => {
+    return (state: EditorState, dispatch: Dispatch) => {
         const { $from, $to } = state.selection;
         const range = $from.blockRange($to);
 

src/components/text-editor/prosemirror-adapter/menu/utils/selection-utils.ts

@@ -1,13 +1,17 @@
-import { TextSelection } from 'prosemirror-state';
+import { TextSelection, EditorState } from 'prosemirror-state';
 
-export const adjustSelectionToFullBlocks = (state) => {
+export const adjustSelectionToFullBlocks = (state: EditorState) => {
     const { $from, $to } = state.selection;
     const from = $from.pos === $from.start() ? $from.pos : $from.end();
     const to = $to.pos === $to.end() ? $to.pos : $to.start();
 
     return { from: from, to: to };
 };
 
-export const createBlockSelection = (state, from, to) => {
+export const createBlockSelection = (
+    state: EditorState,
+    from: number,
+    to: number,
+) => {
     return new TextSelection(state.doc.resolve(from), state.doc.resolve(to));
 };