Rename to LegacyAttachmentMiddleware and added bf-wc-middleware/internal

compulim · compulim · commit cb26a582d510 · 2025-08-17T21:52:55.000Z
diff --git a/packages/api/src/hooks/Composer.tsx b/packages/api/src/hooks/Composer.tsx
@@ -1,6 +1,6 @@
 import { PolyMiddlewareComposer, type PolyMiddleware } from '@msinternal/botframework-webchat-middleware';
 import {
-  type AttachmentMiddleware,
+  type LegacyAttachmentMiddleware,
   type LegacyActivityMiddleware
 } from '@msinternal/botframework-webchat-middleware/legacy';
 import { ReduxStoreComposer } from '@msinternal/botframework-webchat-redux-store';
@@ -216,7 +216,7 @@ type ComposerCoreProps = Readonly<{
   activityMiddleware?: OneOrMany<LegacyActivityMiddleware>;
   activityStatusMiddleware?: OneOrMany<ActivityStatusMiddleware>;
   attachmentForScreenReaderMiddleware?: OneOrMany<AttachmentForScreenReaderMiddleware>;
-  attachmentMiddleware?: OneOrMany<AttachmentMiddleware>;
+  attachmentMiddleware?: OneOrMany<LegacyAttachmentMiddleware>;
   avatarMiddleware?: OneOrMany<AvatarMiddleware>;
   cardActionMiddleware?: OneOrMany<CardActionMiddleware>;
   children?: ReactNode | ((context: ContextOf<React.Context<WebChatAPIContextType>>) => ReactNode);
diff --git a/packages/api/src/hooks/internal/WebChatAPIContext.ts b/packages/api/src/hooks/internal/WebChatAPIContext.ts
@@ -1,4 +1,4 @@
-import { type RenderAttachment } from '@msinternal/botframework-webchat-middleware/legacy';
+import { type LegacyRenderAttachment } from '@msinternal/botframework-webchat-middleware/legacy';
 import {
   type DirectLineJSBotConnection,
   type Observable,
@@ -25,7 +25,7 @@ import { RenderToast } from '../../types/ToastMiddleware';
 export type WebChatAPIContextType = {
   activityStatusRenderer: RenderActivityStatus;
   attachmentForScreenReaderRenderer?: AttachmentForScreenReaderComponentFactory;
-  attachmentRenderer?: RenderAttachment;
+  attachmentRenderer?: LegacyRenderAttachment;
   avatarRenderer: AvatarComponentFactory;
   clearSuggestedActions?: () => void;
   dir?: string;
diff --git a/packages/api/src/hooks/useRenderAttachment.ts b/packages/api/src/hooks/useRenderAttachment.ts
@@ -1,7 +1,7 @@
-import { type RenderAttachment } from '@msinternal/botframework-webchat-middleware/legacy';
+import { type LegacyRenderAttachment } from '@msinternal/botframework-webchat-middleware/legacy';
 import useWebChatAPIContext from './internal/useWebChatAPIContext';
 
-export default function useRenderAttachment(): RenderAttachment | undefined {
+export default function useRenderAttachment(): LegacyRenderAttachment | undefined {
   const { attachmentRenderer } = useWebChatAPIContext();
 
   return attachmentRenderer;
diff --git a/packages/api/src/index.ts b/packages/api/src/index.ts
@@ -1,9 +1,9 @@
 // TODO: Move the pattern to re-export.
 import {
-  type AttachmentMiddleware,
   type LegacyActivityComponentFactory,
   type LegacyActivityMiddleware,
-  type RenderAttachment
+  type LegacyAttachmentMiddleware,
+  type LegacyRenderAttachment
 } from '@msinternal/botframework-webchat-middleware/legacy';
 import StyleOptions, { StrictStyleOptions } from './StyleOptions';
 import defaultStyleOptions from './defaultStyleOptions';
@@ -71,7 +71,8 @@ export type {
   ActivityStatusRenderer,
   AttachmentForScreenReaderComponentFactory,
   AttachmentForScreenReaderMiddleware,
-  AttachmentMiddleware,
+  /** @deprecated Use `polyMiddleware` instead, this will be removed on or after 2027-08-16. */
+  LegacyAttachmentMiddleware as AttachmentMiddleware,
   AvatarComponentFactory,
   AvatarMiddleware,
   CardActionMiddleware,
@@ -85,7 +86,7 @@ export type {
   PerformCardAction,
   PostActivityFile,
   RenderActivityStatus,
-  RenderAttachment,
+  LegacyRenderAttachment as RenderAttachment,
   RenderToast,
   RenderTypingIndicator,
   ScrollToEndButtonComponentFactory,
diff --git a/packages/api/src/internal.ts b/packages/api/src/internal.ts
@@ -5,6 +5,6 @@ export {
   createActivityPolyMiddlewareFromLegacy,
   legacyActivityBridgeComponentPropsSchema,
   type LegacyActivityBridgeComponentProps
-} from '@msinternal/botframework-webchat-middleware';
+} from '@msinternal/botframework-webchat-middleware/internal';
 
 export { LowPriorityDecoratorComposer, useSetDictateState };
diff --git a/packages/middleware/internal.js b/packages/middleware/internal.js
@@ -0,0 +1,3 @@
+// This is required for Webpack 4 which does not support named exports.
+// eslint-disable-next-line no-undef
+module.exports = require('./dist/botframework-webchat-middleware.internal.js');
diff --git a/packages/middleware/package.json b/packages/middleware/package.json
@@ -5,6 +5,16 @@
   "main": "./dist/botframework-webchat-middleware.js",
   "types": "./dist/botframework-webchat-middleware.d.ts",
   "exports": {
+    "./internal": {
+      "import": {
+        "types": "./dist/botframework-webchat-middleware.internal.d.mts",
+        "default": "./dist/botframework-webchat-middleware.internal.mjs"
+      },
+      "require": {
+        "types": "./dist/botframework-webchat-middleware.internal.d.ts",
+        "default": "./dist/botframework-webchat-middleware.internal.js"
+      }
+    },
     "./legacy": {
       "import": {
         "types": "./dist/botframework-webchat-middleware.legacy.d.mts",
diff --git a/packages/middleware/src/index.ts b/packages/middleware/src/index.ts
@@ -15,13 +15,5 @@ export {
   type ActivityPolyMiddlewareRequest
 } from './activityPolyMiddleware';
 
-export {
-  default as createActivityPolyMiddlewareFromLegacy,
-  fallbackComponentPropsSchema,
-  legacyActivityBridgeComponentPropsSchema,
-  type FallbackComponentProps,
-  type LegacyActivityBridgeComponentProps
-} from './internal/createActivityPolyMiddlewareFromLegacy';
-
 export { default as PolyMiddlewareComposer } from './PolyMiddlewareComposer';
 export { type PolyMiddleware } from './types/PolyMiddleware';
diff --git a/packages/middleware/src/internal.ts b/packages/middleware/src/internal.ts
@@ -0,0 +1,7 @@
+export {
+  default as createActivityPolyMiddlewareFromLegacy,
+  fallbackComponentPropsSchema,
+  legacyActivityBridgeComponentPropsSchema,
+  type FallbackComponentProps,
+  type LegacyActivityBridgeComponentProps
+} from './internal/createActivityPolyMiddlewareFromLegacy';
diff --git a/packages/middleware/src/internal/createActivityPolyMiddlewareFromLegacy.tsx b/packages/middleware/src/internal/createActivityPolyMiddlewareFromLegacy.tsx
@@ -2,7 +2,7 @@ import { type WebChatActivity } from 'botframework-webchat-core';
 import { composeEnhancer } from 'handler-chain';
 import React, { type ComponentType, type ReactNode } from 'react';
 import { type LegacyActivityMiddleware } from '../legacy/activityMiddleware';
-import { type RenderAttachment } from '../legacy/attachmentMiddleware';
+import { type LegacyRenderAttachment } from '../legacy/attachmentMiddleware';
 
 import {
   boolean,
@@ -27,7 +27,7 @@ import {
 const webChatActivitySchema = custom<WebChatActivity>(value => safeParse(object({}), value).success);
 
 type LegacyRenderFunction = (
-  renderAttachment: RenderAttachment,
+  renderAttachment: LegacyRenderAttachment,
   options: {
     readonly hideTimestamp: boolean;
     readonly renderActivityStatus: (options: { hideTimestamp: boolean }) => ReactNode;
diff --git a/packages/middleware/src/legacy.ts b/packages/middleware/src/legacy.ts
@@ -4,4 +4,5 @@ export {
   type LegacyActivityProps,
   type LegacyActivityRenderer
 } from './legacy/activityMiddleware';
-export { type default as AttachmentMiddleware, type RenderAttachment } from './legacy/attachmentMiddleware';
+
+export { type LegacyAttachmentMiddleware, type LegacyRenderAttachment } from './legacy/attachmentMiddleware';
diff --git a/packages/middleware/src/legacy/activityMiddleware.ts b/packages/middleware/src/legacy/activityMiddleware.ts
@@ -2,7 +2,7 @@
 import { type WebChatActivity } from 'botframework-webchat-core';
 import { type ReactNode } from 'react';
 
-import { type RenderAttachment } from './attachmentMiddleware';
+import { type LegacyRenderAttachment } from './attachmentMiddleware';
 
 type LegacyActivityProps = {
   children?: never | undefined;
@@ -26,7 +26,7 @@ type LegacyActivityComponentFactory = (
 // TODO: [P2] This is inherited from our older signature (pre-hook) which requires passing "renderAttachment" argument.
 //       With hooks, the middleware should not need "renderAttachment", they can grab it from "useCreateAttachmentRenderer" hook.
 type LegacyRenderActivity = (
-  renderAttachment: RenderAttachment,
+  renderAttachment: LegacyRenderAttachment,
   { hideTimestamp, renderActivityStatus, renderAvatar, showCallout }: LegacyActivityProps
 ) => Exclude<ReactNode, boolean>;
 
diff --git a/packages/middleware/src/legacy/attachmentMiddleware.ts b/packages/middleware/src/legacy/attachmentMiddleware.ts
@@ -1,17 +1,15 @@
 // TODO: This is moved from /api, need to revisit/rewrite everything in this file.
+import { type DirectLineAttachment, type WebChatActivity } from 'botframework-webchat-core';
 import { type ReactNode } from 'react';
-import type { DirectLineAttachment, WebChatActivity } from 'botframework-webchat-core';
 
-type AttachmentProps = {
+type LegacyAttachmentProps = {
   activity: WebChatActivity;
   attachment: DirectLineAttachment;
 };
 
-type RenderAttachment = (props?: AttachmentProps) => ReactNode;
+type LegacyRenderAttachment = (props?: LegacyAttachmentProps) => ReactNode;
 
-type AttachmentEnhancer = (next: RenderAttachment) => RenderAttachment;
-type AttachmentMiddleware = () => AttachmentEnhancer;
+type LegacyAttachmentEnhancer = (next: LegacyRenderAttachment) => LegacyRenderAttachment;
+type LegacyAttachmentMiddleware = () => LegacyAttachmentEnhancer;
 
-export default AttachmentMiddleware;
-
-export type { RenderAttachment };
+export { type LegacyAttachmentMiddleware, type LegacyRenderAttachment };
diff --git a/packages/middleware/tsup.config.ts b/packages/middleware/tsup.config.ts
@@ -5,6 +5,7 @@ const config: typeof baseConfig = {
   ...baseConfig,
   entry: {
     'botframework-webchat-middleware': './src/index.ts',
+    'botframework-webchat-middleware.internal': './src/internal.ts',
     'botframework-webchat-middleware.legacy': './src/legacy.ts'
   }
 };

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// This is required for Webpack 4 which does not support named exports.`
	`2`	`+// eslint-disable-next-line no-undef`
	`3`	`+module.exports = require('./dist/botframework-webchat-middleware.internal.js');`