refactor: add MessageDraftComposerMiddlewareValue type

MartinCupela · MartinCupela · commit 74237d58b7ae · 2025-04-14T15:45:26.000+02:00
diff --git a/src/messageComposer/middleware/messageComposer/attachments.ts b/src/messageComposer/middleware/messageComposer/attachments.ts
@@ -1,10 +1,11 @@
-import type {
-  MessageComposerMiddlewareValue,
-  MessageDraftComposerMiddlewareValue,
-} from './types';
-import type { MessageComposer } from '../../messageComposer';
+import type { MiddlewareHandlerParams } from '../../../middleware';
 import type { Attachment } from '../../../types';
+import type { MessageComposer } from '../../messageComposer';
 import type { LocalAttachment } from '../../types';
+import type {
+  MessageComposerMiddlewareValueState,
+  MessageDraftComposerMiddlewareValueState,
+} from './types';
 
 const localAttachmentToAttachment = (localAttachment: LocalAttachment) => {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -17,12 +18,7 @@ export const createAttachmentsCompositionMiddleware = (composer: MessageComposer
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     const { attachmentManager } = composer;
     if (!attachmentManager) return nextHandler(input);
 
@@ -68,12 +64,7 @@ export const createDraftAttachmentsCompositionMiddleware = (
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageDraftComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageDraftComposerMiddlewareValue,
-    ) => Promise<MessageDraftComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageDraftComposerMiddlewareValueState>) => {
     const { attachmentManager } = composer;
     if (!attachmentManager) return nextHandler(input);
 
diff --git a/src/messageComposer/middleware/messageComposer/cleanData.ts b/src/messageComposer/middleware/messageComposer/cleanData.ts
@@ -1,18 +1,14 @@
+import type { MiddlewareHandlerParams } from '../../../middleware';
 import { formatMessage, toUpdatedMessagePayload } from '../../../utils';
 import type { MessageComposer } from '../../messageComposer';
-import type { MessageComposerMiddlewareValue } from './types';
+import type { MessageComposerMiddlewareValueState } from './types';
 
 export const createCompositionDataCleanupMiddleware = (composer: MessageComposer) => ({
   id: 'stream-io/message-composer-middleware/data-cleanup',
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     const common = {
       type: composer.editedMessage?.type ?? 'regular',
     };
diff --git a/src/messageComposer/middleware/messageComposer/compositionValidation.ts b/src/messageComposer/middleware/messageComposer/compositionValidation.ts
@@ -1,21 +1,17 @@
+import { textIsEmpty } from '../../textComposer';
 import type {
-  MessageComposerMiddlewareValue,
-  MessageDraftComposerMiddlewareValue,
+  MessageComposerMiddlewareValueState,
+  MessageDraftComposerMiddlewareValueState,
 } from './types';
-import { textIsEmpty } from '../../textComposer';
 import type { MessageComposer } from '../../messageComposer';
+import type { MiddlewareHandlerParams } from '../../../middleware';
 
 export const createCompositionValidationMiddleware = (composer: MessageComposer) => ({
   id: 'stream-io/message-composer-middleware/data-validation',
   compose: async ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     const { maxLengthOnSend } = composer.config.text ?? {};
     const inputText = input.state.message.text ?? '';
     const isEmptyMessage =
@@ -41,12 +37,7 @@ export const createDraftCompositionValidationMiddleware = (
   compose: async ({
     input,
     nextHandler,
-  }: {
-    input: MessageDraftComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageDraftComposerMiddlewareValue,
-    ) => Promise<MessageDraftComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageDraftComposerMiddlewareValueState>) => {
     const hasData =
       !textIsEmpty(input.state.draft.text ?? '') ||
       input.state.draft.attachments?.length ||
diff --git a/src/messageComposer/middleware/messageComposer/linkPreviews.ts b/src/messageComposer/middleware/messageComposer/linkPreviews.ts
@@ -1,21 +1,17 @@
+import type { MiddlewareHandlerParams } from '../../../middleware';
+import type { Attachment } from '../../../types';
+import type { MessageComposer } from '../../messageComposer';
 import type {
-  MessageComposerMiddlewareValue,
-  MessageDraftComposerMiddlewareValue,
+  MessageComposerMiddlewareValueState,
+  MessageDraftComposerMiddlewareValueState,
 } from './types';
-import type { MessageComposer } from '../../messageComposer';
-import type { Attachment } from '../../../types';
 
 export const createLinkPreviewsCompositionMiddleware = (composer: MessageComposer) => ({
   id: 'stream-io/message-composer-middleware/link-previews',
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     const { linkPreviewsManager } = composer;
     if (!linkPreviewsManager) return nextHandler(input);
 
@@ -66,12 +62,7 @@ export const createDraftLinkPreviewsCompositionMiddleware = (
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageDraftComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageDraftComposerMiddlewareValue,
-    ) => Promise<MessageDraftComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageDraftComposerMiddlewareValueState>) => {
     const { linkPreviewsManager } = composer;
     if (!linkPreviewsManager) return nextHandler(input);
 
diff --git a/src/messageComposer/middleware/messageComposer/messageComposerState.ts b/src/messageComposer/middleware/messageComposer/messageComposerState.ts
@@ -1,9 +1,10 @@
 import type {
-  MessageComposerMiddlewareValue,
-  MessageDraftComposerMiddlewareValue,
+  MessageComposerMiddlewareValueState,
+  MessageDraftComposerMiddlewareValueState,
 } from './types';
 import type { MessageComposer } from '../../messageComposer';
 import type { LocalMessage, LocalMessageBase } from '../../../types';
+import type { MiddlewareHandlerParams } from '../../../middleware';
 
 export const createMessageComposerStateCompositionMiddleware = (
   composer: MessageComposer,
@@ -12,12 +13,7 @@ export const createMessageComposerStateCompositionMiddleware = (
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     const payload: Pick<LocalMessage, 'poll_id' | 'quoted_message_id'> = {};
     if (composer.quotedMessage) {
       payload.quoted_message_id = composer.quotedMessage.id;
@@ -51,12 +47,7 @@ export const createDraftMessageComposerStateCompositionMiddleware = (
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageDraftComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageDraftComposerMiddlewareValue,
-    ) => Promise<MessageDraftComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageDraftComposerMiddlewareValueState>) => {
     const payload: Pick<LocalMessage, 'poll_id' | 'quoted_message_id'> = {};
     if (composer.quotedMessage) {
       payload.quoted_message_id = composer.quotedMessage.id;
diff --git a/src/messageComposer/middleware/messageComposer/textComposer.ts b/src/messageComposer/middleware/messageComposer/textComposer.ts
@@ -1,20 +1,16 @@
 import type {
-  MessageComposerMiddlewareValue,
-  MessageDraftComposerMiddlewareValue,
+  MessageComposerMiddlewareValueState,
+  MessageDraftComposerMiddlewareValueState,
 } from './types';
 import type { MessageComposer } from '../../messageComposer';
+import type { MiddlewareHandlerParams } from '../../../middleware';
 
 export const createTextComposerCompositionMiddleware = (composer: MessageComposer) => ({
   id: 'stream-io/message-composer-middleware/text-composition',
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageComposerMiddlewareValue,
-    ) => Promise<MessageComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageComposerMiddlewareValueState>) => {
     if (!composer.textComposer) return nextHandler(input);
     const { mentionedUsers, text } = composer.textComposer;
     // Instead of checking if a user is still mentioned every time the text changes,
@@ -57,12 +53,7 @@ export const createDraftTextComposerCompositionMiddleware = (
   compose: ({
     input,
     nextHandler,
-  }: {
-    input: MessageDraftComposerMiddlewareValue;
-    nextHandler: (
-      input: MessageDraftComposerMiddlewareValue,
-    ) => Promise<MessageDraftComposerMiddlewareValue>;
-  }) => {
+  }: MiddlewareHandlerParams<MessageDraftComposerMiddlewareValueState>) => {
     if (!composer.textComposer) return nextHandler(input);
     const { maxLengthOnSend } = composer.config.text ?? {};
     const { mentionedUsers, text: inputText } = composer.textComposer;
diff --git a/src/messageComposer/middleware/pollComposer/composition.ts b/src/messageComposer/middleware/pollComposer/composition.ts
@@ -1,12 +1,16 @@
-import type { Middleware } from '../../../middleware';
-import type { MessageComposer } from '../../messageComposer';
 import type { PollComposerCompositionMiddlewareValueState } from './types';
+import type { MessageComposer } from '../../messageComposer';
+import type { Middleware } from '../../../middleware';
+import type { MiddlewareHandlerParams } from '../../../middleware';
 
 export const createPollCompositionValidationMiddleware = (
   composer: MessageComposer,
 ): Middleware<PollComposerCompositionMiddlewareValueState> => ({
   id: 'stream-io/poll-composer-composition',
-  compose: ({ input, nextHandler }) => {
+  compose: ({
+    input,
+    nextHandler,
+  }: MiddlewareHandlerParams<PollComposerCompositionMiddlewareValueState>) => {
     if (composer.pollComposer.canCreatePoll) return nextHandler(input);
     return nextHandler({ ...input, status: 'discard' });
   },
diff --git a/src/messageComposer/middleware/pollComposer/state.ts b/src/messageComposer/middleware/pollComposer/state.ts
@@ -5,7 +5,7 @@ import type {
 } from './types';
 import { generateUUIDv4 } from '../../../utils';
 import type { Middleware } from '../../../middleware';
-
+import type { MiddlewareHandlerParams } from '../../../middleware';
 export const VALID_MAX_VOTES_VALUE_REGEX = /^([2-9]|10)$/;
 
 export const MAX_POLL_OPTIONS = 100 as const;
@@ -121,7 +121,10 @@ const processors: Partial<Record<keyof PollComposerState['data'], Processor>> =
 export const createPollComposerStateMiddleware =
   (): Middleware<PollComposerStateMiddlewareValueState> => ({
     id: 'stream-io/poll-composer-state-processing',
-    handleFieldChange: ({ input, nextHandler }) => {
+    handleFieldChange: ({
+      input,
+      nextHandler,
+    }: MiddlewareHandlerParams<PollComposerStateMiddlewareValueState>) => {
       if (!input.state.targetFields) return nextHandler(input);
       const {
         state: { previousState, targetFields },
@@ -167,7 +170,10 @@ export const createPollComposerStateMiddleware =
         },
       });
     },
-    handleFieldBlur: ({ input, nextHandler }) => {
+    handleFieldBlur: ({
+      input,
+      nextHandler,
+    }: MiddlewareHandlerParams<PollComposerStateMiddlewareValueState>) => {
       const {
         state: { previousState, targetFields },
       } = input;
diff --git a/src/middleware.ts b/src/middleware.ts
@@ -18,10 +18,13 @@ export type MiddlewareValue<TState> = {
   status?: MiddlewareStatus;
 };
 
-export type MiddlewareHandler<TState> = (params: {
+export type MiddlewareHandlerParams<TState> = {
   input: MiddlewareValue<TState>;
   nextHandler: (input: MiddlewareValue<TState>) => Promise<MiddlewareValue<TState>>;
-}) => Promise<MiddlewareValue<TState>>;
+};
+export type MiddlewareHandler<TState> = (
+  params: MiddlewareHandlerParams<TState>,
+) => Promise<MiddlewareValue<TState>>;
 
 export type Middleware<TState> = {
   id: string;
