Remove factory function, use class constructor directly

compulim · compulim · commit 767313eeafbe · 2025-12-23T00:28:41.000Z
diff --git a/packages/component/src/ActivityDebug/ActivityDebugContext.ts b/packages/component/src/ActivityDebug/ActivityDebugContext.ts
diff --git a/packages/component/src/ActivityDebug/RestrictedActivityDebugAPI.ts b/packages/component/src/ActivityDebug/RestrictedActivityDebugAPI.ts
@@ -0,0 +1,16 @@
+import { RestrictedDebugAPI } from 'botframework-webchat-core/internal';
+import type { ArrayElement } from 'type-fest';
+
+const BREAKPOINT_NAMES = ['render'] as const;
+
+type ActivityBreakpointName = ArrayElement<typeof BREAKPOINT_NAMES>;
+type ActivityDebugContext = {  readonly activity: any;
+};
+
+class RestrictedActivityDebugAPI extends RestrictedDebugAPI<ActivityBreakpointName, ActivityDebugContext> {
+  constructor(getActivity: () => any) {
+    super(BREAKPOINT_NAMES, Object.freeze({ activity: getActivity }));
+  }
+}
+
+export default RestrictedActivityDebugAPI;
diff --git a/packages/component/src/ActivityDebug/createActivityPrivateDebugAPI.ts b/packages/component/src/ActivityDebug/createActivityPrivateDebugAPI.ts
diff --git a/packages/component/src/ActivityDebug/index.ts b/packages/component/src/ActivityDebug/index.ts
@@ -1,2 +1 @@
-export { type ActivityDebugContext } from './ActivityDebugContext';
-export { default as createActivityPrivateDebugAPI } from './createActivityPrivateDebugAPI';
+export { default as RestrictedActivityDebugAPI } from './RestrictedActivityDebugAPI';
diff --git a/packages/component/src/Composer.tsx b/packages/component/src/Composer.tsx
@@ -111,12 +111,12 @@ const ComposerCoreUI = memo(({ children, nonce }: ComposerCoreUIProps) => {
 
     if (current) {
       current['webChat'] = rootDebugAPI;
+
+      return () => delete current['webChat'];
     }
 
     return () => {
-      if (current) {
-        delete current['webChat'];
-      }
+      // Intentionally left blank.
     };
   }, [rootDebugAPI]);
 
diff --git a/packages/component/src/Transcript/ActivityRow.tsx b/packages/component/src/Transcript/ActivityRow.tsx
@@ -1,27 +1,27 @@
 import { hooks } from 'botframework-webchat-api';
-import { createRestrictedDebugAPI } from 'botframework-webchat-core/internal';
 import classNames from 'classnames';
 import PropTypes from 'prop-types';
 import React, { forwardRef, memo, useCallback, useMemo, useRef } from 'react';
+import { useRefFrom } from 'use-ref-from';
 
 import SpeakActivity from '../Activity/Speak';
+import { RestrictedActivityDebugAPI } from '../ActivityDebug';
 import useActiveDescendantId from '../providers/TranscriptFocus/useActiveDescendantId';
 import useFocusByActivityKey from '../providers/TranscriptFocus/useFocusByActivityKey';
 import useGetDescendantIdByActivityKey from '../providers/TranscriptFocus/useGetDescendantIdByActivityKey';
 import ScreenReaderText from '../ScreenReaderText';
 import { android } from '../Utils/detectBrowser';
 import FocusTrap from './FocusTrap';
-import useActivityAccessibleName from './useActivityAccessibleName';
-
-import type { WebChatActivity } from 'botframework-webchat-core';
-import type { MouseEventHandler, PropsWithChildren } from 'react';
-import { useRefFrom } from 'use-ref-from';
 import {
   TranscriptFocusContent,
   TranscriptFocusContentActiveDescendant,
   TranscriptFocusContentOverlay,
   TranscriptFocusIndicator
 } from './TranscriptFocus';
+import useActivityAccessibleName from './useActivityAccessibleName';
+
+import type { WebChatActivity } from 'botframework-webchat-core';
+import type { MouseEventHandler, PropsWithChildren } from 'react';
 
 const { useActivityKeysByRead, useGetHasAcknowledgedByActivityKey, useGetKeyByActivity } = hooks;
 
@@ -91,10 +91,7 @@ const ActivityRow = forwardRef<HTMLElement, ActivityRowProps>(({ activity, child
 
   const prevArticleRef = useRef<HTMLElement>(null);
 
-  const restrictedDebugAPI = useMemo(
-    () => createRestrictedDebugAPI(['render'], { activity: () => activityRef.current }),
-    [activityRef]
-  );
+  const restrictedDebugAPI = useMemo(() => new RestrictedActivityDebugAPI(() => activityRef.current), [activityRef]);
 
   const debugAPI = useMemo(() => restrictedDebugAPI.toPublic(), [restrictedDebugAPI]);
 
diff --git a/packages/core-debug-api/src/RestrictedDebugAPI.ts b/packages/core-debug-api/src/RestrictedDebugAPI.ts
@@ -1,18 +1,20 @@
-import type { BaseContextGetters, BreakpointObject, ContextOfGetters, RestrictedDebugAPIType } from '../types';
-import { SHOULD_LOCKDOWN } from './constants';
-import DebugAPI from './DebugAPI';
+import { SHOULD_LOCKDOWN } from './private/constants';
+import DebugAPI from './private/DebugAPI';
+import type { BaseContext, BreakpointObject, RestrictedDebugAPIType } from './types';
 
 // 🔒 This function must be left empty.
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
 const BREAKPOINT_FUNCTION = <T>(__DEBUG_CONTEXT__: T) => {};
 
-class RestrictedDebugAPI<
-  TBreakpointName extends string,
-  TContextGetters extends BaseContextGetters
-> implements RestrictedDebugAPIType<TBreakpointName, TContextGetters> {
-  constructor(breakpointNames: readonly TBreakpointName[], contextGetters: TContextGetters) {
-    type TContext = { [K in keyof TContextGetters]: ReturnType<TContextGetters[K]> };
+type AsGetters<T> = {
+  readonly [K in keyof T]: () => T[K];
+};
 
+abstract class RestrictedDebugAPI<
+  TBreakpointName extends string,
+  TContext extends BaseContext
+> implements RestrictedDebugAPIType<TBreakpointName, TContext> {
+  constructor(breakpointNames: readonly TBreakpointName[], contextGetters: AsGetters<TContext>) {
     this.#context = Object.create(null) satisfies Partial<TContext> as TContext;
 
     for (const [name, getter] of Object.entries(contextGetters)) {
@@ -67,14 +69,19 @@ class RestrictedDebugAPI<
     }
   }
 
-  #breakpoint: BreakpointObject<TBreakpointName, ContextOfGetters<TContextGetters>>;
-  #context: ContextOfGetters<TContextGetters>;
+  #breakpoint: BreakpointObject<TBreakpointName, TContext>;
+  #context: TContext;
 
   toPublic() {
     return new DebugAPI(this.#breakpoint, this.#context);
   }
 
   UNSAFE_callBreakpoint: Readonly<Record<TBreakpointName, (...args: any[]) => void>>;
+
+  // eslint-disable-next-line class-methods-use-this
+  get '~types'() {
+    return Object.freeze({ public: undefined as any });
+  }
 }
 
 export default RestrictedDebugAPI;
diff --git a/packages/core-debug-api/src/createRestrictedDebugAPI.ts b/packages/core-debug-api/src/createRestrictedDebugAPI.ts
diff --git a/packages/core-debug-api/src/index.ts b/packages/core-debug-api/src/index.ts
@@ -1,2 +1,2 @@
-export { default as createRestrictedDebugAPI } from './createRestrictedDebugAPI';
-export { type BreakpointObject, type DebugAPIType, type RestrictedDebugAPIType } from './types';
+export { default as RestrictedDebugAPI } from './RestrictedDebugAPI';
+export { type BreakpointObject, type DebugAPIType, type InferPublic, type RestrictedDebugAPIType } from './types';
diff --git a/packages/core-debug-api/src/types.ts b/packages/core-debug-api/src/types.ts
@@ -1,4 +1,5 @@
 type BaseContextGetters = { readonly [key: string]: () => unknown };
+type BaseContext = { readonly [key: string]: unknown };
 type ContextOfGetters<T extends BaseContextGetters> = { [K in keyof T]: ReturnType<T[K]> };
 
 type BreakpointObject<TName extends string, TContext extends object> = Readonly<
@@ -32,16 +33,30 @@ interface DebugAPIType<TBreakpointName extends string, TContext extends object>
  *
  * For public consumption, call `toPublic()` to create an object for receiving side.
  */
-interface RestrictedDebugAPIType<TBreakpointName extends string, TContextGetters extends BaseContextGetters> {
+interface RestrictedDebugAPIType<TBreakpointName extends string, TContext extends BaseContext> {
   /**
    * Creates a public version of Debug API for external consumption.
    */
-  toPublic(): DebugAPIType<TBreakpointName, ContextOfGetters<TContextGetters>>;
+  toPublic(): DebugAPIType<TBreakpointName, TContext>;
 
   /**
    * Triggers a breakpoint function.
    */
   get UNSAFE_callBreakpoint(): Readonly<Record<TBreakpointName, (...args: any[]) => void>>;
+
+  readonly '~types': {
+    readonly public: DebugAPIType<TBreakpointName, TContext>;
+  };
 }
 
-export type { BaseContextGetters, BreakpointObject, ContextOfGetters, DebugAPIType, RestrictedDebugAPIType };
+type InferPublic<T extends RestrictedDebugAPIType<any, any>> = T['~types']['public'];
+
+export type {
+  BaseContext,
+  BaseContextGetters,
+  BreakpointObject,
+  ContextOfGetters,
+  DebugAPIType,
+  InferPublic,
+  RestrictedDebugAPIType
+};
diff --git a/packages/core/src/createReducer.ts b/packages/core/src/createReducer.ts
@@ -21,10 +21,10 @@ import suggestedActionsOriginActivity from './reducers/suggestedActionsOriginAct
 import type { GlobalScopePonyfill } from './types/GlobalScopePonyfill';
 import type { RestrictedRootDebugAPI } from './types/RootDebugAPI';
 
-export default function createReducer(ponyfill: GlobalScopePonyfill, rootPrivateDebugAPI: RestrictedRootDebugAPI) {
+export default function createReducer(ponyfill: GlobalScopePonyfill, restrictedRootDebugAPI: RestrictedRootDebugAPI) {
   return combineActivitiesReducer(
     ponyfill,
-    rootPrivateDebugAPI,
+    restrictedRootDebugAPI,
     combineReducers({
       connectivityStatus,
       dictateInterims,
diff --git a/packages/core/src/createStore.ts b/packages/core/src/createStore.ts
@@ -5,9 +5,9 @@ import createSagaMiddleware from 'redux-saga';
 import sagaError from './actions/sagaError';
 import createReducer from './createReducer';
 import createSagas from './createSagas';
+import { RestrictedRootDebugAPI } from './types/RootDebugAPI';
 
 import type { GlobalScopePonyfill } from './types/GlobalScopePonyfill';
-import { createRestrictedDebugAPI } from '@msinternal/botframework-webchat-core-debug-api';
 
 type CreateStoreOptions = {
   /**
@@ -113,10 +113,7 @@ export function withOptions(options: CreateStoreOptions, initialState?, ...middl
   // eslint-disable-next-line prefer-const
   let store: Store | undefined;
 
-  const restrictedRootDebugAPI = createRestrictedDebugAPI(['incomingActivity'], {
-    // We can guarantee `store` is not accessed before it is defined few lines below.
-    activities: () => store?.getState().activities
-  });
+  const restrictedRootDebugAPI = new RestrictedRootDebugAPI(() => store?.getState().activities);
 
   // We are sure the "getStore" (first argument) is not called on "createEnhancerAndSagaMiddleware()".
   const { enhancer, sagaMiddleware } = createEnhancerAndSagaMiddleware(() => store, ...middlewares);
diff --git a/packages/core/src/internal/index.ts b/packages/core/src/internal/index.ts
@@ -7,4 +7,4 @@ export {
 
 export { type RootDebugAPI } from '../types/RootDebugAPI';
 
-export { createRestrictedDebugAPI, type DebugAPIType } from '@msinternal/botframework-webchat-core-debug-api';
+export { RestrictedDebugAPI, type InferPublic } from '@msinternal/botframework-webchat-core-debug-api';
diff --git a/packages/core/src/reducers/activities/combineActivitiesReducer.ts b/packages/core/src/reducers/activities/combineActivitiesReducer.ts
@@ -22,13 +22,13 @@ type ActivitiesState = {
  */
 export default function combineActivitiesReducer<M>(
   ponyfill: GlobalScopePonyfill,
-  rootPrivateDebugAPI: RestrictedRootDebugAPI,
+  restrictedRootDebugAPI: RestrictedRootDebugAPI,
   existingSlicedReducer: ReturnType<typeof combineReducers<M>>
 ): Reducer<StateFromReducersMapObject<M> & ActivitiesState, ActionFromReducersMapObject<M> & GroupedActivitiesAction> {
   type ExistingState = StateFromReducersMapObject<M>;
   type ExistingAction = ActionFromReducersMapObject<M>;
 
-  const groupedActivitiesReducer = createGroupedActivitiesReducer(ponyfill, rootPrivateDebugAPI);
+  const groupedActivitiesReducer = createGroupedActivitiesReducer(ponyfill, restrictedRootDebugAPI);
 
   return function (
     state: (ExistingState & ActivitiesState) | undefined,
diff --git a/packages/core/src/reducers/activities/createGroupedActivitiesReducer.ts b/packages/core/src/reducers/activities/createGroupedActivitiesReducer.ts
@@ -62,7 +62,7 @@ function getClientActivityID(activity: WebChatActivity): string | undefined {
 
 function createGroupedActivitiesReducer(
   ponyfill: GlobalScopePonyfill,
-  rootPrivateDebugAPI: RestrictedRootDebugAPI
+  restrictedRootDebugAPI: RestrictedRootDebugAPI
 ): Reducer<GroupedActivitiesState, GroupedActivitiesAction> {
   return function activities(
     state: GroupedActivitiesState = DEFAULT_STATE,
@@ -192,7 +192,7 @@ function createGroupedActivitiesReducer(
         } = action;
 
         // We cannot call breakpoint inside Redux because DebugContext cannot call getState(), need setTimeout.
-        queueMicrotask(() => rootPrivateDebugAPI.UNSAFE_callBreakpoint.incomingActivity({ activity }));
+        queueMicrotask(() => restrictedRootDebugAPI.UNSAFE_callBreakpoint.incomingActivity({ activity }));
 
         activity = patchActivity(activity, ponyfill);
 
diff --git a/packages/core/src/types/RootDebugAPI.ts b/packages/core/src/types/RootDebugAPI.ts
@@ -1,25 +1,32 @@
-import { type RestrictedDebugAPIType } from '@msinternal/botframework-webchat-core-debug-api';
+import { RestrictedDebugAPI, type InferPublic } from '@msinternal/botframework-webchat-core-debug-api';
+import type { ArrayElement } from 'type-fest';
 
-type RootDebugBreakpointName = 'incomingActivity';
+const BREAKPOINT_NAMES = ['incomingActivity'] as const;
+
+type RootBreakpointName = ArrayElement<typeof BREAKPOINT_NAMES>;
 
 type RootDebugContext = {
   readonly activities: readonly any[];
 };
 
-type RestrictedRootDebugAPI = RestrictedDebugAPIType<
-  RootDebugBreakpointName,
-  {
-    [K in keyof RootDebugContext]: () => RootDebugContext[K];
+class RestrictedRootDebugAPI extends RestrictedDebugAPI<RootBreakpointName, RootDebugContext> {
+  constructor(getActivities: () => RootDebugContext['activities']) {
+    super(
+      BREAKPOINT_NAMES,
+      Object.freeze({
+        activities: getActivities
+      })
+    );
   }
->;
+}
 
 // TODO: [P1] Not sure why it break "api" packages. "api" tries to reference the "core-debug-api" package and failed.
 //       Maybe types are not rolled up in "core" packages properly.
-// type RootDebugAPI = InferPublic<RootPrivateDebugAPI>;
+type RootDebugAPI = InferPublic<RestrictedRootDebugAPI>;
 
-type RootDebugAPI = {
-  get breakpoint(): Readonly<Record<RootDebugBreakpointName, (__DEBUG_CONTEXT__: RootDebugContext) => void>>;
-  get debugger(): void;
-};
+// type RootDebugAPI = {
+//   get breakpoint(): Readonly<Record<RootBreakpointName, (__DEBUG_CONTEXT__: RootDebugContext) => void>>;
+//   get debugger(): void;
+// };
 
-export { type RootDebugAPI, type RestrictedRootDebugAPI };
+export { RestrictedRootDebugAPI, type RootDebugAPI };

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1 @@`
`1`		`-export { type ActivityDebugContext } from './ActivityDebugContext';`
`2`		`-export { default as createActivityPrivateDebugAPI } from './createActivityPrivateDebugAPI';`
	`1`	`+export { default as RestrictedActivityDebugAPI } from './RestrictedActivityDebugAPI';`