botframework-webchat-api 4.18.2 → 4.19.0

package/src/providers/StyleOptions/private/StyleOptionsContext.ts

@@ -0,0 +1,20 @@
+import { createContext, useContext } from 'react';
+
+import defaultStyleOptions from '../../../defaultStyleOptions';
+import { type StrictStyleOptions } from '../../../StyleOptions';
+import rectifyStyleOptions from './rectifyStyleOptions';
+
+type StyleOptionsContextType = {
+  readonly styleOptionsState: readonly [Readonly<StrictStyleOptions>];
+};
+
+const StyleOptionsContext = createContext<StyleOptionsContextType>({
+  styleOptionsState: Object.freeze([rectifyStyleOptions(defaultStyleOptions)])
+});
+
+StyleOptionsContext.displayName = 'StyleOptionsContext';
+
+const useStyleOptionsContext = () => useContext(StyleOptionsContext);
+
+export default StyleOptionsContext;
+export { useStyleOptionsContext, type StyleOptionsContextType };

package/src/providers/StyleOptions/private/rectifyStyleOptions.ts

@@ -0,0 +1,6 @@
+import type { StrictStyleOptions, StyleOptions } from '../../../StyleOptions';
+import normalizeStyleOptions from '../../../normalizeStyleOptions';
+
+export default function rectifyStyleOptions(styleOptions: StyleOptions): StrictStyleOptions {
+  return normalizeStyleOptions(styleOptions);
+}

package/src/providers/StyleOptions/useStyleOptions.ts

@@ -0,0 +1,6 @@
+import { type StrictStyleOptions } from '../../StyleOptions';
+import { useStyleOptionsContext } from './private/StyleOptionsContext';
+
+export default function useStyleOptions(): readonly [StrictStyleOptions] {
+  return useStyleOptionsContext().styleOptionsState;
+}

package/src/tsconfig.json

@@ -1,18 +1,9 @@
 {
   "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "declarationDir": "../lib",
-    "declarationMap": true,
     "downlevelIteration": true,
-    "emitDeclarationOnly": true,
-    "jsx": "react",
-    "module": "ESNext",
-    "moduleResolution": "Bundler",
-    "preserveWatchOutput": true,
-    "pretty": true,
-    "resolveJsonModule": true, // Required for localization files
-    "skipLibCheck": true,
-    "sourceMap": true
-  }
+    "resolveJsonModule": true, // Required for localization files.
+    "strict": false, // We should flip this occasionally and fix all typing issues.
+    "types": ["dom-speech-recognition"]
+  },
+  "extends": "@msinternal/botframework-webchat-tsconfig/legacy"
 }

package/src/types/ActivityStatusMiddleware.ts

@@ -1,5 +1,5 @@
-import type { ReactElement } from 'react';
 import type { WebChatActivity } from 'botframework-webchat-core';
+import type { ReactElement } from 'react';
 
 import type { SendStatus } from '../types/SendStatus';
 
@@ -8,14 +8,6 @@ type RenderActivityStatusOptions = {
   activity: WebChatActivity;
   hideTimestamp: boolean;
   sendState: SendStatus;
-
-  // "nextVisibleActivity" is for backward compatibility, please remove this line on or after 2022-07-22.
-  /** @deprecated */
-  nextVisibleActivity: WebChatActivity;
-
-  // "sameTimestampGroup" is for backward compatibility, please remove this line on or after 2022-07-22.
-  /** @deprecated */
-  sameTimestampGroup: boolean;
 };
 
 type RenderActivityStatus = (options: RenderActivityStatusOptions) => ReactElement;

package/src/types/AttachmentForScreenReaderMiddleware.ts

@@ -1,4 +1,4 @@
-import type { DirectLineAttachment, WebChatActivity } from 'botframework-webchat-core';
+import { type DirectLineAttachment, type WebChatActivity } from 'botframework-webchat-core';
 
 // TODO: We should consider using a prop for "attachmentMiddleware" to render for screen reader, instead of having another middleware.
 
@@ -11,11 +11,18 @@ type AttachmentForScreenReaderComponentFactoryOptions = [
   }
 ];
 
-type AttachmentForScreenReaderComponentFactory = ComponentFactory<AttachmentForScreenReaderComponentFactoryOptions, {}>;
+type AttachmentForScreenReaderComponentFactory = ComponentFactory<
+  AttachmentForScreenReaderComponentFactoryOptions,
+  // Following @types/react to use {} for props.
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  {}
+>;
 
 type AttachmentForScreenReaderMiddleware = ComponentMiddleware<
   [],
   AttachmentForScreenReaderComponentFactoryOptions,
+  // Following @types/react to use {} for props.
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   {}
 >;
 

package/src/types/AvatarMiddleware.ts

@@ -1,18 +1,29 @@
-import type { WebChatActivity } from 'botframework-webchat-core';
+import { type WebChatActivity } from 'botframework-webchat-core';
 
+import {
+  __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol,
+  type AvatarPolymiddlewareRequest
+} from '@msinternal/botframework-webchat-api-middleware';
 import { StrictStyleOptions } from '../StyleOptions';
 import ComponentMiddleware, { ComponentFactory } from './ComponentMiddleware';
 
 type AvatarComponentFactoryArguments = [
   {
+    // We need to keep the original polymiddleweare request while running inside legacy middleware.
+    // When we transit from legacy middleware back to polymiddleware, we can restore the request object.
+    [__INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol]: AvatarPolymiddlewareRequest;
     activity: WebChatActivity;
     fromUser: boolean;
     styleOptions: StrictStyleOptions;
   }
 ];
 
+// Following @types/react to use {} for props.
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 type AvatarComponentFactory = ComponentFactory<AvatarComponentFactoryArguments, {}>;
 
+// Following @types/react to use {} for props.
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 type AvatarMiddleware = ComponentMiddleware<[], AvatarComponentFactoryArguments, {}>;
 
 export default AvatarMiddleware;

package/src/types/CardActionMiddleware.ts

@@ -13,6 +13,8 @@ type CardActionMiddleware = FunctionMiddleware<
       target: any;
     }
   ],
+  // Following @types/react to use {} for props.
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
   {}
 >;
 

package/src/types/ComponentMiddleware.ts

@@ -30,7 +30,7 @@ type ComponentEnhancer<TComponentFactoryArguments extends any[], TProps> = (
  * The signature of the middleware is:
  *
  * ```
- * (...args: SetupArguments) => (next: Enhancer) => (...args: ComponentFactoryArguments) => false | React.FC<Props>
+ * (...args: SetupArguments) => (next: Enhancer) => (...args: ComponentFactoryArguments) => false | React.ComponentType<Props>
  * ```
  */
 type ComponentMiddleware<TSetupArguments extends any[], TComponentFactoryArguments extends any[], TProps> = (

package/src/types/GroupActivitiesMiddleware.ts

@@ -2,21 +2,17 @@ import type { WebChatActivity } from 'botframework-webchat-core';
 
 import FunctionMiddleware, { CallFunction } from './FunctionMiddleware';
 
+type GroupedActivities = readonly (readonly WebChatActivity[])[];
+
 type GroupActivities = CallFunction<
-  [{ activities: WebChatActivity[] }],
-  {
-    sender: WebChatActivity[][];
-    status: WebChatActivity[][];
-  }
+  [Readonly<{ activities: readonly WebChatActivity[] }>],
+  { [key: string]: GroupedActivities }
 >;
 
 type GroupActivitiesMiddleware = FunctionMiddleware<
-  [],
-  [{ activities: WebChatActivity[] }],
-  {
-    sender: WebChatActivity[][];
-    status: WebChatActivity[][];
-  }
+  [string],
+  [Readonly<{ activities: readonly WebChatActivity[] }>],
+  { [key: string]: GroupedActivities }
 >;
 
 export default GroupActivitiesMiddleware;

package/dist/chunk-2S76JUVM.mjs

@@ -1,3 +0,0 @@
-import{warnOnce as l}from"botframework-webchat-core";import{createChainOfResponsibility as u}from"react-chain-of-responsibility";import{any as y,array as f,custom as m,safeParse as c}from"valibot";var w=Object.freeze([]);function M(i){let d=f(y([m(e=>typeof e=="function","Middleware must be a function.")])),a=e=>c(d,e).success,o=l(`"${i}" prop is invalid`),s=(e,p)=>{if(e){if(a(e))return Object.freeze(e?.map(t=>t(p)).filter(t=>!!t).map(t=>()=>t));o()}return w},{Provider:r,Proxy:n}=u();return r.displayName=`${i}Provider`,n.displayName=`${i}Proxy`,{initMiddleware:s,Provider:r,Proxy:n,types:{init:void 0,middleware:void 0,props:void 0,request:void 0}}}export{M as a};
-/*! For license information please see chunk-2S76JUVM.mjs.LEGAL.txt */
-//# sourceMappingURL=chunk-2S76JUVM.mjs.map

package/dist/chunk-2S76JUVM.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/decorator/private/templateMiddleware.ts"],"sourcesContent":["import { warnOnce } from 'botframework-webchat-core';\nimport { createChainOfResponsibility, type ComponentMiddleware } from 'react-chain-of-responsibility';\nimport { type EmptyObject } from 'type-fest';\nimport { any, array, custom, safeParse, type Output } from 'valibot';\n\nexport type MiddlewareWithInit<M extends ComponentMiddleware<any, any, any>, I> = (init: I) => ReturnType<M> | false;\n\nconst EMPTY_ARRAY = Object.freeze([]);\n\nexport default function templateMiddleware<Init, Request = any, Props extends {} = EmptyObject>(name: string) {\n  type Middleware = ComponentMiddleware<Request, Props>;\n\n  const middlewareSchema = array(\n    any([custom<Middleware>(input => typeof input === 'function', 'Middleware must be a function.')])\n  );\n\n  const isMiddleware = (middleware: unknown): middleware is Output<typeof middlewareSchema> =>\n    safeParse(middlewareSchema, middleware).success;\n\n  const warnInvalid = warnOnce(`\"${name}\" prop is invalid`);\n\n  const initMiddleware = (\n    middleware: readonly MiddlewareWithInit<Middleware, Init>[],\n    init?: Init\n  ): readonly Middleware[] => {\n    if (middleware) {\n      if (isMiddleware(middleware)) {\n        return Object.freeze(\n          middleware\n            ?.map(middleware => middleware(init))\n            .filter((enhancer): enhancer is ReturnType<Middleware> => !!enhancer)\n            .map(enhancer => () => enhancer)\n        );\n      }\n\n      warnInvalid();\n    }\n\n    return EMPTY_ARRAY;\n  };\n\n  const { Provider, Proxy } = createChainOfResponsibility<Request, Props>();\n\n  Provider.displayName = `${name}Provider`;\n  Proxy.displayName = `${name}Proxy`;\n\n  return {\n    initMiddleware,\n    Provider,\n    Proxy,\n    types: {\n      init: undefined as Init,\n      middleware: undefined as Middleware,\n      props: undefined as Props,\n      request: undefined as Request\n    }\n  };\n}\n"],"mappings":"AAAA,OAAS,YAAAA,MAAgB,4BACzB,OAAS,+BAAAC,MAA6D,gCAEtE,OAAS,OAAAC,EAAK,SAAAC,EAAO,UAAAC,EAAQ,aAAAC,MAA8B,UAI3D,IAAMC,EAAc,OAAO,OAAO,CAAC,CAAC,EAErB,SAARC,EAAyFC,EAAc,CAG5G,IAAMC,EAAmBN,EACvBD,EAAI,CAACE,EAAmBM,GAAS,OAAOA,GAAU,WAAY,gCAAgC,CAAC,CAAC,CAClG,EAEMC,EAAgBC,GACpBP,EAAUI,EAAkBG,CAAU,EAAE,QAEpCC,EAAcb,EAAS,IAAIQ,CAAI,mBAAmB,EAElDM,EAAiB,CACrBF,EACAG,IAC0B,CAC1B,GAAIH,EAAY,CACd,GAAID,EAAaC,CAAU,EACzB,OAAO,OAAO,OACZA,GACI,IAAIA,GAAcA,EAAWG,CAAI,CAAC,EACnC,OAAQC,GAAiD,CAAC,CAACA,CAAQ,EACnE,IAAIA,GAAY,IAAMA,CAAQ,CACnC,EAGFH,EAAY,CACd,CAEA,OAAOP,CACT,EAEM,CAAE,SAAAW,EAAU,MAAAC,CAAM,EAAIjB,EAA4C,EAExE,OAAAgB,EAAS,YAAc,GAAGT,CAAI,WAC9BU,EAAM,YAAc,GAAGV,CAAI,QAEpB,CACL,eAAAM,EACA,SAAAG,EACA,MAAAC,EACA,MAAO,CACL,KAAM,OACN,WAAY,OACZ,MAAO,OACP,QAAS,MACX,CACF,CACF","names":["warnOnce","createChainOfResponsibility","any","array","custom","safeParse","EMPTY_ARRAY","templateMiddleware","name","middlewareSchema","input","isMiddleware","middleware","warnInvalid","initMiddleware","init","enhancer","Provider","Proxy"]}

package/dist/chunk-ZAMHKQQC.mjs

@@ -1,3 +0,0 @@
-import{createContext as o}from"react";var e=o(void 0);e.displayName="WebChatAPIContext";var i=e;import{useContext as n}from"react";function r(){let t=n(i);if(!t)throw new Error("This hook can only be used on a component that is a descendant of <Composer>");return t}export{i as a,r as b};
-/*! For license information please see chunk-ZAMHKQQC.mjs.LEGAL.txt */
-//# sourceMappingURL=chunk-ZAMHKQQC.mjs.map

package/dist/chunk-ZAMHKQQC.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/hooks/internal/WebChatAPIContext.ts","../src/hooks/internal/useWebChatAPIContext.ts"],"sourcesContent":["import {\n  type DirectLineJSBotConnection,\n  type Observable,\n  type WebChatActivity,\n  type sendFiles,\n  type sendMessage,\n  type setSendBoxAttachments\n} from 'botframework-webchat-core';\nimport { createContext } from 'react';\n\nimport { StrictStyleOptions } from '../../StyleOptions';\nimport { LegacyActivityRenderer } from '../../types/ActivityMiddleware';\nimport { RenderActivityStatus } from '../../types/ActivityStatusMiddleware';\nimport { AttachmentForScreenReaderComponentFactory } from '../../types/AttachmentForScreenReaderMiddleware';\nimport { RenderAttachment } from '../../types/AttachmentMiddleware';\nimport { AvatarComponentFactory } from '../../types/AvatarMiddleware';\nimport { PerformCardAction } from '../../types/CardActionMiddleware';\nimport { GroupActivities } from '../../types/GroupActivitiesMiddleware';\nimport LocalizedStrings from '../../types/LocalizedStrings';\nimport { type Notification } from '../../types/Notification';\nimport PrecompiledGlobalize from '../../types/PrecompiledGlobalize';\nimport { ScrollToEndButtonComponentFactory } from '../../types/ScrollToEndButtonMiddleware';\nimport TelemetryMeasurementEvent from '../../types/TelemetryMeasurementEvent';\nimport { RenderToast } from '../../types/ToastMiddleware';\n\ntype WebChatAPIContext = {\n  activityRenderer?: LegacyActivityRenderer;\n  activityStatusRenderer: RenderActivityStatus;\n  attachmentForScreenReaderRenderer?: AttachmentForScreenReaderComponentFactory;\n  attachmentRenderer?: RenderAttachment;\n  avatarRenderer: AvatarComponentFactory;\n  clearSuggestedActions?: () => void;\n  dir?: string;\n  directLine?: DirectLineJSBotConnection;\n  disabled?: boolean;\n  dismissNotification?: (id: string) => void;\n  downscaleImageToDataURL?: (\n    blob: Blob,\n    maxWidth: number,\n    maxHeight: number,\n    type: string,\n    quality: number\n  ) => Promise<URL>;\n  emitTypingIndicator?: () => void;\n  grammars?: any;\n  groupActivities?: GroupActivities;\n  internalErrorBoxClass?: React.Component | Function;\n  language?: string;\n  localizedGlobalizeState?: PrecompiledGlobalize[];\n  localizedStrings?: { [language: string]: LocalizedStrings };\n  markActivity?: (activity: { id: string }, name: string, value?: any) => void;\n  onCardAction?: PerformCardAction;\n  onTelemetry?: (event: TelemetryMeasurementEvent) => void;\n  postActivity?: (activity: WebChatActivity) => Observable<string>;\n  renderMarkdown?: (\n    markdown: string,\n    newLineOptions: { markdownRespectCRLF: boolean },\n    linkOptions: { externalLinkAlt: string }\n  ) => string;\n  scrollToEndButtonRenderer?: ScrollToEndButtonComponentFactory;\n  selectVoice?: (\n    voices: (typeof window.SpeechSynthesisVoice)[],\n    activity: WebChatActivity\n  ) => typeof window.SpeechSynthesisVoice;\n  sendEvent?: (name: string, value: any) => void;\n  sendFiles?: (...args: Parameters<typeof sendFiles>) => void;\n  sendMessage?: (...args: Parameters<typeof sendMessage>) => void;\n  sendMessageBack?: (value: any, text?: string, displayText?: string) => void;\n  sendPostBack?: (value?: any) => void;\n  sendTypingIndicator?: boolean;\n  setDictateInterims?: (interims: string[]) => void;\n  setDictateState?: (dictateState: number) => void;\n  setNotification?: (notification: Notification) => void;\n  setSendBox?: (value: string) => void;\n  setSendBoxAttachments?: (...args: Parameters<typeof setSendBoxAttachments>) => void;\n  setSendTimeout?: (timeout: number) => void;\n  startDictate?: () => void;\n  startSpeakingActivity?: () => void;\n  stopDictate?: () => void;\n  stopSpeakingActivity?: () => void;\n  styleOptions?: StrictStyleOptions;\n  submitSendBox?: (method?: string, { channelData }?: { channelData: any }) => void;\n  telemetryDimensionsRef?: React.Ref<any>;\n  toastRenderer?: RenderToast;\n  trackDimension?: (name: string, data: any) => void;\n  typingIndicatorRenderer?: any; // TODO\n  userID?: string;\n  username?: string;\n};\n\nconst context = createContext<WebChatAPIContext>(undefined);\n\ncontext.displayName = 'WebChatAPIContext';\n\nexport default context;\n","import { useContext } from 'react';\n\nimport WebChatAPIContext from './WebChatAPIContext';\n\nexport default function useWebChatAPIContext() {\n  const context = useContext(WebChatAPIContext);\n\n  if (!context) {\n    throw new Error('This hook can only be used on a component that is a descendant of <Composer>');\n  }\n\n  return context;\n}\n"],"mappings":"AAQA,OAAS,iBAAAA,MAAqB,QAkF9B,IAAMC,EAAUD,EAAiC,MAAS,EAE1DC,EAAQ,YAAc,oBAEtB,IAAOC,EAAQD,EC9Ff,OAAS,cAAAE,MAAkB,QAIZ,SAARC,GAAwC,CAC7C,IAAMC,EAAUC,EAAWC,CAAiB,EAE5C,GAAI,CAACF,EACH,MAAM,IAAI,MAAM,8EAA8E,EAGhG,OAAOA,CACT","names":["createContext","context","WebChatAPIContext_default","useContext","useWebChatAPIContext","context","useContext","WebChatAPIContext_default"]}