Clean up middleware signature#5504
Merged
compulim merged 26 commits intomicrosoft:mainfrom Jun 25, 2025
Merged
Conversation
OEvgeny
reviewed
Jun 24, 2025
OEvgeny
reviewed
Jun 24, 2025
packages/api/src/decorator/ActivityBorder/private/ActivityBorderDecoratorMiddleware.ts
Outdated
Show resolved
Hide resolved
OEvgeny
reviewed
Jun 24, 2025
OEvgeny
reviewed
Jun 25, 2025
OEvgeny
reviewed
Jun 25, 2025
OEvgeny
approved these changes
Jun 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog Entry
Breaking changes
activityBorderDecoratorMiddleware, related to PR #5504activityGroupingDecoratorMiddleware, related to PR #5504sendBoxMiddleware, related to PR #5504sendBoxToolbarMiddleware, related to PR #5504Added
sendBoxMiddlewareandsendBoxToolbarMiddleware, by @compulim, in PR #5120 and #5504createSendBoxMiddlewareandcreateSendBoxToolbarMiddlewarecorrespondingly, related to PR #5504Description
Clean up middleware signature to prepare for poly-middleware.
Eventually, we will unite all middleware signature to the following format.
Design
Introduction of
createXXXMiddlewareNarrowing and guarding function overloading is still weak in TypeScript. Until they improve it, we need a "wrapping function" to make middleware typed properly.
We cannot do use first argument to differentiate the type of return value.
We will also leverage the
createXXXMiddlewarefor backward/forward compatibility.Specific Changes
initwill always be a string, onlyRequestandPropsare customizablecreateActivityBorderMiddleware(),createActivityGroupingMiddleware(),createSendBoxMiddleware()andcreateSendBoxToolbarMiddleware()helper functions to wrap their decorator middleware correspondinglytemplateMiddlewareInfer*<typeof template>to infer fromtemplate['~types']CHANGELOG.mdI have updated documentationReview Checklist
Accessibility reviewed (tab order, content readability, alt text, color contrast)Browser and platform compatibilities reviewedCSS styles reviewed (minimal rules, noz-index)Documents reviewed (docs, samples, live demo)Internationalization reviewed (strings, unit formatting)package.jsonandpackage-lock.jsonreviewedSecurity reviewed (no data URIs, check for nonce leak)