botframework-webchat-api 4.17.1 → 4.18.1-hotfix.20260127.b53acdf

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/src/types/Typing.ts

@@ -1,8 +1,7 @@
-type Typing = {
+export type Typing = {
   at: number;
   expireAt: number;
   name: string;
   role: 'bot' | 'user';
+  type: 'busy' | 'livestream';
 };
-
-export type { Typing };

package/src/utils/validateProps.spec.ts

@@ -0,0 +1,74 @@
+import { number, object } from 'valibot';
+import validateProps from './validateProps';
+
+beforeEach(() =>
+  jest.spyOn(console, 'error').mockImplementation(() => {
+    // Intentionally left blank.
+  })
+);
+
+afterEach(() => jest.restoreAllMocks());
+
+test('when isolation is not specified then success should return as-is', () => {
+  const props = { one: 1, two: 2 };
+  const result = validateProps(object({ one: number() }), props);
+
+  expect(result).toBe(props);
+});
+
+test('when no isolation then success should return as-is', () => {
+  const props = { one: 1, two: 2 };
+  const result = validateProps(object({ one: number() }), props, 'no isolation');
+
+  expect(result).toBe(props);
+});
+
+test('when in strict isolation then success should return isolated result', () => {
+  const props = { one: 1, two: 2 };
+  const result = validateProps(object({ one: number() }), props, 'strict');
+
+  expect(result).not.toBe(props);
+  expect(result).toEqual({ one: 1 });
+});
+
+test('when isolation is not specified then failure should throw', () => {
+  const props = { two: 2 };
+
+  expect(() => validateProps(object({ one: number() }), props)).toThrow();
+});
+
+test('when no isolation then failure should throw', () => {
+  const props = { two: 2 };
+
+  expect(() => validateProps(object({ one: number() }), props, 'no isolation')).toThrow();
+});
+
+test('when in strict isolation then failure should throw', () => {
+  const props = { two: 2 };
+
+  expect(() => validateProps(object({ one: number() }), props, 'strict')).toThrow();
+});
+
+test('when under production mode and isolation is not specified then failure should warn', () => {
+  process.env.NODE_ENV = 'production';
+
+  const props = { two: 2 };
+
+  expect(validateProps(object({ one: number() }), props, 'strict')).toBe(props);
+});
+
+test('when under production mode and no isolation then failure should warn', () => {
+  process.env.NODE_ENV = 'production';
+
+  const props = { two: 2 };
+
+  expect(validateProps(object({ one: number() }), props, 'strict')).toBe(props);
+});
+
+test('when under production mode and in strict isolation then failure should warn', () => {
+  process.env.NODE_ENV = 'production';
+
+  const props = { two: 2 };
+
+  expect(validateProps(object({ one: number() }), props, 'strict')).toBe(props);
+});

package/src/utils/validateProps.ts

@@ -0,0 +1,56 @@
+import { parse, safeParse, type BaseIssue, type BaseSchema, type InferInput, type InferOutput } from 'valibot';
+
+/**
+ * Specifies the props isolation mode.
+ *
+ * - `"no isolation"` will return the props as-is without cloning or modifications
+ * - `"strict"` will isolate the props using `valibot.parse()`
+ *    - Depends on schema design, it could clone object instances, remove extraneous properties from objects, or fill in optional fields
+ */
+type IsolationMode = 'no isolation' | 'strict';
+
+export default function validateProps<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
+  propsSchema: TSchema,
+  props: unknown,
+  isolationMode?: 'no isolation' | undefined
+): InferInput<TSchema>;
+
+export default function validateProps<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
+  propsSchema: TSchema,
+  props: unknown,
+  isolationMode?: 'strict'
+): InferOutput<TSchema>;
+
+/**
+ * Validates props against the specified valibot schema when running under development mode.
+ *
+ * This function will not perform any validations when running under production mode.
+ *
+ * @param propsSchema validation schema
+ * @param props props to validate
+ * @param mode specifies the isolation mode, default to `"no isolation"`
+ * @returns
+ */
+export default function validateProps<const TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
+  propsSchema: TSchema,
+  props: InferInput<TSchema>,
+  isolationMode?: IsolationMode | undefined
+): InferInput<TSchema> | InferOutput<TSchema> {
+  if (process.env.NODE_ENV === 'production') {
+    return props as unknown as InferInput<TSchema>;
+  }
+
+  if (isolationMode !== 'strict' && safeParse(propsSchema, props).success) {
+    return props as unknown as InferInput<TSchema>;
+  }
+
+  // Code path hit here when under strict isolation, or no isolation and failed earlier.
+
+  try {
+    return parse(propsSchema, props);
+  } catch (error) {
+    console.error('botframework-webchat: Validation error while parsing props.', error.issues);
+
+    throw error;
+  }
+}

package/dist/chunk-4ZIUY4G5.mjs

@@ -1,3 +0,0 @@
-var d=Object.create;var n=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty;var f=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports),A=(t,e)=>{for(var i in e)n(t,i,{get:e[i],enumerable:!0})},l=(t,e,i,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of m(e))!y.call(t,o)&&o!==i&&n(t,o,{get:()=>e[o],enumerable:!(r=c(e,o))||r.enumerable});return t};var S=(t,e,i)=>(i=t!=null?d(p(t)):{},l(e||!t||!t.__esModule?n(i,"default",{value:t,enumerable:!0}):i,t));import{createContext as v}from"react";var a=v(void 0);a.displayName="WebChatAPIContext";var s=a;import{useContext as g}from"react";function u(){let t=g(s);if(!t)throw new Error("This hook can only be used on a component that is a descendant of <Composer>");return t}export{f as a,A as b,S as c,s as d,u as e};
-/*! For license information please see chunk-4ZIUY4G5.mjs.LEGAL.txt */
-//# sourceMappingURL=chunk-4ZIUY4G5.mjs.map

package/dist/chunk-4ZIUY4G5.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":"+jBAQA,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"]}