botframework-webchat-api 4.18.2 → 4.19.1-main.20260526.b9ad8fa

package/src/decorator/private/templateMiddleware.ts

@@ -1,58 +0,0 @@
-import { warnOnce } from 'botframework-webchat-core';
-import { createChainOfResponsibility, type ComponentMiddleware } from 'react-chain-of-responsibility';
-import { type EmptyObject } from 'type-fest';
-import { any, array, custom, safeParse, type Output } from 'valibot';
-
-export type MiddlewareWithInit<M extends ComponentMiddleware<any, any, any>, I> = (init: I) => ReturnType<M> | false;
-
-const EMPTY_ARRAY = Object.freeze([]);
-
-export default function templateMiddleware<Init, Request = any, Props extends {} = EmptyObject>(name: string) {
-  type Middleware = ComponentMiddleware<Request, Props>;
-
-  const middlewareSchema = array(
-    any([custom<Middleware>(input => typeof input === 'function', 'Middleware must be a function.')])
-  );
-
-  const isMiddleware = (middleware: unknown): middleware is Output<typeof middlewareSchema> =>
-    safeParse(middlewareSchema, middleware).success;
-
-  const warnInvalid = warnOnce(`"${name}" prop is invalid`);
-
-  const initMiddleware = (
-    middleware: readonly MiddlewareWithInit<Middleware, Init>[],
-    init?: Init
-  ): readonly Middleware[] => {
-    if (middleware) {
-      if (isMiddleware(middleware)) {
-        return Object.freeze(
-          middleware
-            ?.map(middleware => middleware(init))
-            .filter((enhancer): enhancer is ReturnType<Middleware> => !!enhancer)
-            .map(enhancer => () => enhancer)
-        );
-      }
-
-      warnInvalid();
-    }
-
-    return EMPTY_ARRAY;
-  };
-
-  const { Provider, Proxy } = createChainOfResponsibility<Request, Props>();
-
-  Provider.displayName = `${name}Provider`;
-  Proxy.displayName = `${name}Proxy`;
-
-  return {
-    initMiddleware,
-    Provider,
-    Proxy,
-    types: {
-      init: undefined as Init,
-      middleware: undefined as Middleware,
-      props: undefined as Props,
-      request: undefined as Request
-    }
-  };
-}

package/src/hooks/internal/ErrorBox.js

@@ -1,34 +0,0 @@
-/* eslint-disable no-console */
-import { createElement, useEffect } from 'react';
-import PropTypes from 'prop-types';
-
-import useErrorBoxClass from './useErrorBoxClass';
-import useTrackException from '../useTrackException';
-
-const ErrorBox = ({ error, type }) => {
-  const [errorBoxClass] = useErrorBoxClass();
-  const trackException = useTrackException();
-
-  useEffect(() => {
-    trackException(error, false);
-  }, [error, trackException]);
-
-  useEffect(() => {
-    console.group(`botframework-webchat: ${type}`);
-    console.error(error);
-    console.groupEnd();
-  }, [error, type]);
-
-  return !!errorBoxClass && createElement(errorBoxClass, { error, type });
-};
-
-ErrorBox.defaultProps = {
-  type: undefined
-};
-
-ErrorBox.propTypes = {
-  error: PropTypes.any.isRequired,
-  type: PropTypes.string
-};
-
-export default ErrorBox;

package/src/hooks/internal/SendBoxMiddleware.ts

@@ -1,21 +0,0 @@
-import templateMiddleware from './private/templateMiddleware';
-
-const {
-  initMiddleware: initSendBoxMiddleware,
-  Provider: SendBoxMiddlewareProvider,
-  Proxy: SendBoxMiddlewareProxy,
-  types
-} = templateMiddleware<void, void, { className?: string | undefined }>('sendBoxMiddleware');
-
-type SendBoxMiddleware = typeof types.middleware;
-type SendBoxMiddlewareProps = typeof types.props;
-type SendBoxMiddlewareRequest = typeof types.request;
-
-export {
-  SendBoxMiddlewareProvider,
-  SendBoxMiddlewareProxy,
-  initSendBoxMiddleware,
-  type SendBoxMiddleware,
-  type SendBoxMiddlewareProps,
-  type SendBoxMiddlewareRequest
-};

package/src/hooks/internal/SendBoxToolbarMiddleware.ts

@@ -1,21 +0,0 @@
-import templateMiddleware from './private/templateMiddleware';
-
-const {
-  initMiddleware: initSendBoxToolbarMiddleware,
-  Provider: SendBoxToolbarMiddlewareProvider,
-  Proxy: SendBoxToolbarMiddlewareProxy,
-  types
-} = templateMiddleware<void, void, { className?: string | undefined }>('sendBoxToolbarMiddleware');
-
-type SendBoxToolbarMiddleware = typeof types.middleware;
-type SendBoxToolbarMiddlewareProps = typeof types.props;
-type SendBoxToolbarMiddlewareRequest = typeof types.request;
-
-export {
-  SendBoxToolbarMiddlewareProvider,
-  SendBoxToolbarMiddlewareProxy,
-  initSendBoxToolbarMiddleware,
-  type SendBoxToolbarMiddleware,
-  type SendBoxToolbarMiddlewareProps,
-  type SendBoxToolbarMiddlewareRequest
-};

package/src/hooks/internal/private/templateMiddleware.ts

@@ -1,4 +0,0 @@
-import templateMiddleware from '../../../decorator/private/templateMiddleware';
-
-// TODO: We should move them to a common directory.
-export default templateMiddleware;

package/src/hooks/internal/useCreateActivityRendererInternal.ts

@@ -1,46 +0,0 @@
-import { isValidElement, useMemo } from 'react';
-
-import { ActivityComponentFactory } from '../../types/ActivityMiddleware';
-import { RenderAttachment } from '../../types/AttachmentMiddleware';
-import useRenderAttachment from '../useRenderAttachment';
-import useWebChatAPIContext from './useWebChatAPIContext';
-
-export default function useCreateActivityRendererInternal(
-  renderAttachmentOverride?: RenderAttachment
-): ActivityComponentFactory {
-  const { activityRenderer: createActivityRenderer } = useWebChatAPIContext();
-  const defaultRenderAttachment = useRenderAttachment();
-
-  const renderAttachment: RenderAttachment = renderAttachmentOverride || defaultRenderAttachment;
-
-  return useMemo(
-    () =>
-      (...createActivityRendererOptions) => {
-        const renderActivity = createActivityRenderer(...createActivityRendererOptions);
-
-        if (!renderActivity) {
-          return false;
-        }
-
-        return renderActivityOptions => {
-          if (isValidElement(renderActivity)) {
-            return renderActivity;
-          }
-
-          const activityElement = renderActivity(
-            (...renderAttachmentArgs) => renderAttachment(...renderAttachmentArgs),
-            renderActivityOptions
-          );
-
-          // "activityElement" cannot be false. If the middleware want to hide the "activityElement", it should return "false" when we call createActivityRenderer().
-          activityElement ||
-            console.warn(
-              'botframework-webchat: To hide an activity, the activity renderer should return false. It should not return a function that will return false when called.'
-            );
-
-          return activityElement;
-        };
-      },
-    [createActivityRenderer, renderAttachment]
-  );
-}

package/src/hooks/internal/useDebugDeps.js

@@ -1,30 +0,0 @@
-/* eslint no-console: "off" */
-
-import { isForbiddenPropertyName } from 'botframework-webchat-core';
-import { useRef } from 'react';
-
-export default function useDebugDeps(depsMap, name) {
-  const lastDepsMapRef = useRef({});
-
-  const { current: lastDepsMap } = lastDepsMapRef;
-  const keys = new Set([...Object.keys(depsMap), ...Object.keys(lastDepsMap)]);
-  const keysChanged = Array.from(keys).filter(
-    // Mitigation through denylisting.
-    // eslint-disable-next-line security/detect-object-injection
-    key => !isForbiddenPropertyName(key) && !Object.is(depsMap[key], lastDepsMap[key])
-  );
-
-  if (keysChanged.length) {
-    console.groupCollapsed(`Changes found in ${name}`);
-
-    keysChanged.forEach(key => {
-      // Mitigation through denylisting.
-      // eslint-disable-next-line security/detect-object-injection
-      isForbiddenPropertyName(key) || console.log(key, { from: lastDepsMap[key], to: depsMap[key] });
-    });
-
-    console.groupEnd();
-  }
-
-  lastDepsMapRef.current = depsMap;
-}

package/src/hooks/internal/useErrorBoxClass.js

@@ -1,7 +0,0 @@
-import useWebChatAPIContext from './useWebChatAPIContext';
-
-export default function useErrorBoxClass() {
-  const { internalErrorBoxClass } = useWebChatAPIContext();
-
-  return [internalErrorBoxClass];
-}

package/src/hooks/middleware/createDefaultGroupActivitiesMiddleware.ts

@@ -1,75 +0,0 @@
-import GroupActivitiesMiddleware from '../../types/GroupActivitiesMiddleware';
-
-import type { GlobalScopePonyfill, WebChatActivity } from 'botframework-webchat-core';
-import type { SendStatus } from '../../types/SendStatus';
-
-function bin<T>(items: T[], grouping: (last: T, current: T) => boolean): T[][] {
-  let lastBin: T[];
-  const bins: T[][] = [];
-  let lastItem: T;
-
-  items.forEach(item => {
-    if (lastItem && grouping(lastItem, item)) {
-      lastBin.push(item);
-    } else {
-      lastBin = [item];
-      bins.push(lastBin);
-    }
-
-    lastItem = item;
-  });
-
-  return bins;
-}
-
-function sending(activity: WebChatActivity): SendStatus | undefined {
-  if (activity.from.role === 'user') {
-    const {
-      channelData: { state, 'webchat:send-status': sendStatus }
-    } = activity;
-
-    // `channelData.state` is being deprecated in favor of `channelData['webchat:send-status']`.
-    // Please refer to #4362 for details. Remove on or after 2024-07-31.
-    return sendStatus || (state === 'sent' ? 'sent' : 'sending');
-  }
-}
-
-function shouldGroupTimestamp(
-  activityX: WebChatActivity,
-  activityY: WebChatActivity,
-  groupTimestamp: boolean | number,
-  { Date }: GlobalScopePonyfill
-): boolean {
-  if (groupTimestamp === false) {
-    // Hide timestamp for all activities.
-    return true;
-  } else if (activityX && activityY) {
-    if (sending(activityX) !== sending(activityY)) {
-      return false;
-    }
-
-    groupTimestamp = typeof groupTimestamp === 'number' ? groupTimestamp : Infinity;
-
-    const timeX = new Date(activityX.timestamp).getTime();
-    const timeY = new Date(activityY.timestamp).getTime();
-
-    return Math.abs(timeX - timeY) <= groupTimestamp;
-  }
-
-  return false;
-}
-
-export default function createDefaultGroupActivitiesMiddleware({
-  groupTimestamp,
-  ponyfill
-}: {
-  groupTimestamp: boolean | number;
-  ponyfill: GlobalScopePonyfill;
-}): GroupActivitiesMiddleware {
-  return () =>
-    () =>
-    ({ activities }) => ({
-      sender: bin(activities, (x, y) => x.from.role === y.from.role),
-      status: bin(activities, (x, y) => shouldGroupTimestamp(x, y, groupTimestamp, ponyfill))
-    });
-}

package/src/hooks/useGroupActivities.ts

@@ -1,10 +0,0 @@
-import type { WebChatActivity } from 'botframework-webchat-core';
-
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useGroupActivities(): ({ activities }: { activities: WebChatActivity[] }) => {
-  sender: WebChatActivity[][];
-  status: WebChatActivity[][];
-} {
-  return useWebChatAPIContext().groupActivities;
-}

package/src/internal.ts

@@ -1,3 +0,0 @@
-import useSetDictateState from './hooks/internal/useSetDictateState';
-
-export { useSetDictateState };

package/src/patchStyleOptionsFromDeprecatedProps.js

@@ -1,14 +0,0 @@
-import updateIn from 'simple-update-in';
-
-// TODO: [P4] We should add a notice for people who want to use "styleSet" instead of "styleOptions".
-//       "styleSet" is actually CSS stylesheet and it is based on the DOM tree.
-//       DOM tree may change from time to time, thus, maintaining "styleSet" becomes a constant effort.
-export default function patchStyleOptionsFromDeprecatedProps(styleOptions) {
-  if (styleOptions.slowConnectionAfter < 0) {
-    console.warn('Web Chat: "slowConnectionAfter" cannot be negative, will set to 0.');
-
-    styleOptions = updateIn(styleOptions, ['slowConnectionAfter'], () => 0);
-  }
-
-  return styleOptions;
-}

package/src/providers/ActivityTyping/private/useMemoWithPrevious.ts

@@ -1,17 +0,0 @@
-// TODO: [P1] Dedupe.
-import { useEffect, useMemo, useRef } from 'react';
-
-import type { DependencyList } from 'react';
-
-export default function useMemoWithPrevious<T>(factory: (prevValue: T | undefined) => T, deps: DependencyList): T {
-  const prevValueRef = useRef<T | undefined>(undefined);
-  // We are building a `useMemo`-like hook, `deps` is passed as-is and `factory` is not one fo the dependencies.
-  // eslint-disable-next-line react-hooks/exhaustive-deps
-  const value = useMemo<T>(() => factory(prevValueRef.current), deps);
-
-  useEffect(() => {
-    prevValueRef.current = value;
-  });
-
-  return value;
-}

package/src/types/ActivityMiddleware.ts

@@ -1,36 +0,0 @@
-import type { ReactNode } from 'react';
-import type { RenderAttachment } from './AttachmentMiddleware';
-import type { WebChatActivity } from 'botframework-webchat-core';
-
-type ActivityProps = {
-  hideTimestamp: boolean;
-  renderActivityStatus: (options: { hideTimestamp: boolean }) => ReactNode;
-  renderAvatar: false | (() => Exclude<ReactNode, boolean | null | undefined>);
-  showCallout: boolean;
-};
-
-type ActivityComponent = (props: ActivityProps) => Exclude<ReactNode, boolean | null | undefined>;
-
-type ActivityComponentFactoryOptions = {
-  activity: WebChatActivity;
-  nextVisibleActivity: WebChatActivity;
-};
-
-type ActivityComponentFactory = (options: ActivityComponentFactoryOptions) => ActivityComponent | false;
-
-// 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,
-  { hideTimestamp, renderActivityStatus, renderAvatar, showCallout }: ActivityProps
-) => Exclude<ReactNode, boolean>;
-
-type LegacyActivityRenderer = (options: ActivityComponentFactoryOptions) => LegacyRenderActivity | false;
-
-// The middleware created by the web developer, are using the legacy signature (with "renderAttachment" argument).
-type ActivityEnhancer = (next: LegacyActivityRenderer) => LegacyActivityRenderer;
-type ActivityMiddleware = () => ActivityEnhancer;
-
-export default ActivityMiddleware;
-
-export type { ActivityComponentFactory, LegacyActivityRenderer };

package/src/types/AttachmentMiddleware.ts

@@ -1,16 +0,0 @@
-import { ReactNode } from 'react';
-import type { DirectLineAttachment, WebChatActivity } from 'botframework-webchat-core';
-
-type AttachmentProps = {
-  activity: WebChatActivity;
-  attachment: DirectLineAttachment;
-};
-
-type RenderAttachment = (props?: AttachmentProps) => ReactNode;
-
-type AttachmentEnhancer = (next: RenderAttachment) => RenderAttachment;
-type AttachmentMiddleware = () => AttachmentEnhancer;
-
-export default AttachmentMiddleware;
-
-export type { RenderAttachment };

package/src/utils/isObject.js

@@ -1,5 +0,0 @@
-const { toString } = {};
-
-export default function isObject(obj) {
-  return toString.call(obj) === '[object Object]';
-}

package/src/utils/warnOnce.ts

@@ -1,10 +0,0 @@
-export default function warnOnce(message: string): () => void {
-  let warned;
-
-  return () => {
-    if (!warned) {
-      console.warn(`botframework-webchat: ${message}.`);
-      warned = 1;
-    }
-  };
-}