botframework-webchat-api 4.13.0 → 4.15.0

package/src/types/WebSpeechPonyfill.ts

@@ -0,0 +1,24 @@
+/* globals SpeechGrammarList, SpeechRecognition, SpeechSynthesis */
+
+type WebSpeechPonyfill = {
+  /**
+   * Function to resume `AudioContext` object when called.
+   *
+   * Web Chat will call this function on user gestures to resume suspended `AudioContext`.
+   */
+  resumeAudioContext?: () => Promise<void>;
+
+  /** Polyfill for Web Speech API `SpeechGrammarList` class. */
+  SpeechGrammarList?: typeof SpeechGrammarList;
+
+  /** Polyfill for Web Speech API `SpeechRecognition` class. */
+  SpeechRecognition?: typeof SpeechRecognition;
+
+  /** Polyfill for Web Speech API `speechSynthesis` instance. */
+  speechSynthesis?: SpeechSynthesis;
+
+  /** Polyfill for Web Speech API `SpeechSynthesisUtterance` class. */
+  SpeechSynthesisUtterance?: typeof SpeechSynthesisUtterance;
+};
+
+export default WebSpeechPonyfill;

package/src/types/WebSpeechPonyfillFactory.ts

@@ -0,0 +1,5 @@
+import WebSpeechPonyfill from './WebSpeechPonyfill';
+
+type WebSpeechPonyfillFactory = ({ referenceGrammarID }: { referenceGrammarID?: string }) => WebSpeechPonyfill;
+
+export default WebSpeechPonyfillFactory;

package/src/utils/createCustomEvent.ts

@@ -0,0 +1,28 @@
+import { isForbiddenPropertyName } from 'botframework-webchat-core';
+
+export default function createCustomEvent<T>(
+  name: string,
+  eventInitDict: T
+): {
+  type: string;
+} & T {
+  let event: Event;
+
+  if (typeof CustomEvent === 'function') {
+    event = new CustomEvent(name);
+  } else {
+    event = document.createEvent('Event');
+
+    event.initEvent(name, true, true);
+  }
+
+  Object.entries(eventInitDict).forEach(([key, value]) => {
+    if (!isForbiddenPropertyName(key)) {
+      // Mitigation through denylisting.
+      // eslint-disable-next-line security/detect-object-injection
+      event[key] = value;
+    }
+  });
+
+  return event as any;
+}

package/src/utils/findLastIndex.spec.js

@@ -0,0 +1,31 @@
+/* eslint no-magic-numbers: "off" */
+
+import findLastIndex from './findLastIndex';
+
+describe('find last index', () => {
+  test('of an existing element should return the index of last occurrence', () => {
+    const actual = findLastIndex([1, 2, 3, 2, 1], value => value === 2);
+
+    expect(actual).toBe(3);
+  });
+
+  test('of a non-existing element should return -1', () => {
+    const actual = findLastIndex([1, 2, 3, 2, 1], value => value === 4);
+
+    expect(actual).toBe(-1);
+  });
+
+  test('of an empty array should return -1', () => {
+    const actual = findLastIndex([], value => value === 1);
+
+    expect(actual).toBe(-1);
+  });
+
+  test('without a predicate should throw', () => {
+    expect(() => findLastIndex([])).toThrowError('not a function');
+  });
+
+  test('without an array should throw', () => {
+    expect(() => findLastIndex(undefined, value => value === 1)).toThrowError();
+  });
+});

package/src/utils/findLastIndex.ts

@@ -0,0 +1,11 @@
+export default function findLastIndex<T>(array: readonly T[], predicate: (value: T, index: number) => boolean): number {
+  const index = [...array].reverse().findIndex(predicate);
+
+  if (~index) {
+    const { length } = array || [];
+
+    return length - index - 1;
+  }
+
+  return index;
+}

package/src/utils/findMin.spec.js

@@ -1,3 +1,5 @@
+/* eslint no-magic-numbers: "off" */
+
 import findMin, { map as findMinFromMap } from './findMin';
 
 describe('array: minimum of 2 values', () => {

package/src/utils/{findMin.js → findMin.ts}

@@ -1,10 +1,10 @@
-function isUndefined(obj) {
+function isUndefined(obj: any): boolean {
   return typeof obj === 'undefined';
 }
 
 const DEFAULT_SELECTOR = value => value;
 
-function findMin(array, selector = DEFAULT_SELECTOR) {
+function findMin<T>(array: T[], selector = DEFAULT_SELECTOR): T {
   return array.reduce((minValue, value) => {
     const minScore = isUndefined(minValue) ? minValue : selector(minValue);
     const score = isUndefined(value) ? value : selector(value);
@@ -19,7 +19,7 @@ function findMin(array, selector = DEFAULT_SELECTOR) {
   }, undefined);
 }
 
-function map(map, selector = DEFAULT_SELECTOR) {
+function map<T>(map: { [key: string]: T }, selector = DEFAULT_SELECTOR): [string, T] {
   return findMin(
     Object.entries(map).map(entry => (isUndefined(entry[1]) ? undefined : entry)),
     ([key, value]) => selector.call(map, value, key)

package/src/utils/mapMap.spec.js

@@ -1,3 +1,5 @@
+/* eslint no-magic-numbers: "off" */
+
 import mapMap from './mapMap';
 
 test('multiply a map by 10', () => {

package/src/utils/mapMap.ts

@@ -0,0 +1,16 @@
+import { isForbiddenPropertyName } from 'botframework-webchat-core';
+
+export default function mapMap<T>(
+  map: { [key: string]: T },
+  mapper: (value: T, key: string) => T
+): { [key: string]: T } {
+  return Object.entries(map).reduce((result, [key, value]) => {
+    if (!isForbiddenPropertyName(key)) {
+      // Mitigation through denylisting.
+      // eslint-disable-next-line security/detect-object-injection
+      result[key] = mapper(value, key);
+    }
+
+    return result;
+  }, {});
+}

package/src/utils/{normalizeLanguage.js → normalizeLanguage.ts}

@@ -2,7 +2,7 @@
 
 // https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/language-support
 
-export default function normalizeLanguage(language) {
+export default function normalizeLanguage(language: string): string {
   language = language.toLowerCase();
 
   if (language === 'ar-eg') {

package/src/utils/{randomId.js → randomId.ts}

@@ -2,6 +2,6 @@
 
 import random from 'math-random';
 
-export default function randomId(maxLength = 5) {
+export default function randomId(maxLength = 5): string {
   return random().toString(36).substr(2, maxLength);
 }

package/src/utils/warnOnce.ts

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

package/.eslintignore

@@ -1,9 +0,0 @@
-/src/__tests__/**/*
-/src/**/*.spec.js
-/src/**/*.spec.jsx
-/src/**/*.spec.ts
-/src/**/*.spec.tsx
-/src/**/*.test.js
-/src/**/*.test.jsx
-/src/**/*.test.ts
-/src/**/*.test.tsx

package/lib/hooks/utils/singleToArray.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = singleToArray;
-
-function singleToArray(singleOrArray) {
-  return singleOrArray ? Array.isArray(singleOrArray) ? singleOrArray : [singleOrArray] : [];
-}
-//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9ob29rcy91dGlscy9zaW5nbGVUb0FycmF5LmpzIl0sIm5hbWVzIjpbInNpbmdsZVRvQXJyYXkiLCJzaW5nbGVPckFycmF5IiwiQXJyYXkiLCJpc0FycmF5Il0sIm1hcHBpbmdzIjoiOzs7Ozs7O0FBQWUsU0FBU0EsYUFBVCxDQUF1QkMsYUFBdkIsRUFBc0M7QUFDbkQsU0FBT0EsYUFBYSxHQUFJQyxLQUFLLENBQUNDLE9BQU4sQ0FBY0YsYUFBZCxJQUErQkEsYUFBL0IsR0FBK0MsQ0FBQ0EsYUFBRCxDQUFuRCxHQUFzRSxFQUExRjtBQUNEIiwic291cmNlUm9vdCI6ImNvbXBvbmVudDovLy8iLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgZGVmYXVsdCBmdW5jdGlvbiBzaW5nbGVUb0FycmF5KHNpbmdsZU9yQXJyYXkpIHtcbiAgcmV0dXJuIHNpbmdsZU9yQXJyYXkgPyAoQXJyYXkuaXNBcnJheShzaW5nbGVPckFycmF5KSA/IHNpbmdsZU9yQXJyYXkgOiBbc2luZ2xlT3JBcnJheV0pIDogW107XG59XG4iXX0=

package/scripts/createPrecompiledGlobalize.js

@@ -1,41 +0,0 @@
-const { format } = require('prettier');
-const { dirname, join, relative } = require('path');
-const { existsSync, mkdirSync, writeFileSync } = require('fs');
-const Globalize = require('globalize');
-const globalizeCompiler = require('globalize-compiler');
-const languages = Object.values(require('../src/localization/overrides.json')).map(
-  ({ GLOBALIZE_LANGUAGE }) => GLOBALIZE_LANGUAGE
-);
-
-Globalize.load(require('cldr-data').entireSupplemental());
-
-const formattersAndParsers = languages.reduce((formattersAndParsers, language) => {
-  Globalize.load(require('cldr-data').entireMainFor(language));
-
-  const globalize = new Globalize(language);
-
-  return [
-    ...formattersAndParsers,
-    ...[
-      globalize.dateFormatter({ skeleton: 'MMMMdhm' }),
-      globalize.pluralGenerator(),
-      globalize.relativeTimeFormatter('hour'),
-      globalize.relativeTimeFormatter('minute'),
-      globalize.unitFormatter('byte', { form: 'long' }),
-      globalize.unitFormatter('kilobyte', { form: 'short' }),
-      globalize.unitFormatter('megabyte', { form: 'short' }),
-      globalize.unitFormatter('gigabyte', { form: 'short' })
-    ]
-  ];
-}, []);
-
-const code = format(globalizeCompiler.compile(formattersAndParsers), { parser: 'babel' });
-const filename = join(__dirname, '../lib/external/PrecompiledGlobalize.js');
-
-// globalize-compiler is emitting AMD code, pointing to "globalize-runtime" instead of "globalize/dist/globalize-runtime"
-const patchedCode = code.replace(/\"globalize-runtime\//g, '"globalize/dist/globalize-runtime/');
-
-existsSync(dirname(filename)) || mkdirSync(dirname(filename));
-writeFileSync(filename, patchedCode);
-
-console.log(`Successfully compiled globalize to ${relative(process.cwd(), filename)}.`);

package/src/hooks/internal/useCreateActivityRendererInternal.js

@@ -1,41 +0,0 @@
-import { isValidElement, useMemo } from 'react';
-
-import useRenderAttachment from '../useRenderAttachment';
-import useWebChatAPIContext from './useWebChatAPIContext';
-
-export default function useCreateActivityRendererInternal(renderAttachmentOverride) {
-  const { activityRenderer: createActivityRenderer } = useWebChatAPIContext();
-  const defaultRenderAttachment = useRenderAttachment();
-
-  const 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/middleware/concatMiddleware.js

@@ -1,19 +0,0 @@
-export default function concatMiddleware(...middleware) {
-  return setupArgs => {
-    const setup = middleware.reduce(
-      (setup, middleware) => (middleware ? [...setup, middleware(setupArgs)] : setup),
-      []
-    );
-
-    return last => {
-      const stack = setup.slice();
-      const work = index => (...runArgs) => {
-        const next = stack[index];
-
-        return (next ? next(work(index + 1)) : last)(...runArgs);
-      };
-
-      return work(0);
-    };
-  };
-}

package/src/hooks/middleware/createDefaultCardActionMiddleware.js

@@ -1,36 +0,0 @@
-import { sendMessage, sendMessageBack, sendPostBack } from 'botframework-webchat-core';
-
-export default function createDefaultCardActionMiddleware() {
-  return ({ dispatch }) => next => (...args) => {
-    const [
-      {
-        cardAction: { displayText, text, type, value }
-      }
-    ] = args;
-
-    switch (type) {
-      case 'imBack':
-        if (typeof value === 'string') {
-          // TODO: [P4] Instead of calling dispatch, we should move to dispatchers instead for completeness
-          dispatch(sendMessage(value, 'imBack'));
-        } else {
-          throw new Error('cannot send "imBack" with a non-string value');
-        }
-
-        break;
-
-      case 'messageBack':
-        dispatch(sendMessageBack(value, text, displayText));
-
-        break;
-
-      case 'postBack':
-        dispatch(sendPostBack(value));
-
-        break;
-
-      default:
-        return next(...args);
-    }
-  };
-}

package/src/hooks/useActivities.js

@@ -1,5 +0,0 @@
-import { useSelector } from './internal/WebChatReduxContext';
-
-export default function useActivities() {
-  return [useSelector(({ activities }) => activities)];
-}

package/src/hooks/useCreateAvatarRenderer.js

@@ -1,32 +0,0 @@
-import { useMemo } from 'react';
-
-import useStyleOptions from './useStyleOptions';
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useCreateAvatarRenderer() {
-  const [styleOptions] = useStyleOptions();
-  const { avatarRenderer } = useWebChatAPIContext();
-
-  return useMemo(
-    () => ({ activity }) => {
-      const { from: { role } = {} } = activity;
-
-      const result = avatarRenderer({
-        activity,
-        fromUser: role === 'user',
-        styleOptions
-      });
-
-      if (result !== false && typeof result !== 'function') {
-        console.warn(
-          'botframework-webchat: avatarMiddleware should return a function to render the avatar, or return false if avatar should be hidden. Please refer to HOOKS.md for details.'
-        );
-
-        return () => result;
-      }
-
-      return result;
-    },
-    [avatarRenderer, styleOptions]
-  );
-}

package/src/hooks/useDateFormatter.js

@@ -1,13 +0,0 @@
-import { useMemo } from 'react';
-
-import useLocalizedGlobalize from './internal/useLocalizedGlobalize';
-
-export default function useDateFormatter() {
-  const [globalize] = useLocalizedGlobalize();
-
-  const formatDate = useMemo(() => date => globalize.dateFormatter({ skeleton: 'MMMMdhm' })(new Date(date)), [
-    globalize
-  ]);
-
-  return formatDate;
-}

package/src/hooks/useGetSendTimeoutForActivity.js

@@ -1,18 +0,0 @@
-import { useMemo } from 'react';
-
-import useStyleOptions from './useStyleOptions';
-
-export default function useGetSendTimeoutForActivity() {
-  const [{ sendTimeout, sendTimeoutForAttachments }] = useStyleOptions();
-
-  return useMemo(
-    () => ({ activity }) => {
-      if (typeof sendTimeout === 'function') {
-        return sendTimeout(activity);
-      }
-
-      return activity.attachments && activity.attachments.length ? sendTimeoutForAttachments : sendTimeout;
-    },
-    [sendTimeout, sendTimeoutForAttachments]
-  );
-}

package/src/hooks/useGroupActivities.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useGroupActivities() {
-  return useWebChatAPIContext().groupActivities;
-}

package/src/hooks/usePerformCardAction.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function usePerformCardAction() {
-  return useWebChatAPIContext().onCardAction;
-}

package/src/hooks/usePostActivity.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function usePostActivity() {
-  return useWebChatAPIContext().postActivity;
-}

package/src/hooks/useRenderTypingIndicator.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useRenderTypingIndicator() {
-  return useWebChatAPIContext().typingIndicatorRenderer;
-}

package/src/hooks/useSendMessage.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useSendMessage() {
-  return useWebChatAPIContext().sendMessage;
-}

package/src/hooks/useSetNotification.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useSetNotification() {
-  return useWebChatAPIContext().setNotification;
-}

package/src/hooks/useStyleOptions.js

@@ -1,5 +0,0 @@
-import useWebChatAPIContext from './internal/useWebChatAPIContext';
-
-export default function useStyleOptions() {
-  return [useWebChatAPIContext().styleOptions];
-}

package/src/hooks/useTimeoutForSend.js

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

package/src/hooks/utils/singleToArray.js

@@ -1,3 +0,0 @@
-export default function singleToArray(singleOrArray) {
-  return singleOrArray ? (Array.isArray(singleOrArray) ? singleOrArray : [singleOrArray]) : [];
-}

package/src/index.js

@@ -1,10 +0,0 @@
-// IMPORTANT: To export anything from this file, add it to index.tsx, which is the .d.ts for this file.
-
-import * as hooks from './hooks';
-import Composer from './hooks/Composer';
-import concatMiddleware from './hooks/middleware/concatMiddleware';
-import defaultStyleOptions from './defaultStyleOptions';
-import Localize, { localize } from './localization/Localize';
-import normalizeStyleOptions from './normalizeStyleOptions';
-
-export { Composer, concatMiddleware, defaultStyleOptions, hooks, Localize, localize, normalizeStyleOptions };

package/src/index.tsx

@@ -1,10 +0,0 @@
-import StyleOptions, { StrictStyleOptions } from './StyleOptions';
-
-declare const defaultStyleOptions: Required<StyleOptions>;
-
-// TODO: [P2] ESLint of DLSpeech SDK should ignore this file since its from API.
-// eslint-disable-next-line no-unused-vars
-declare function normalizeStyleOptions(styleOptions: StyleOptions): StrictStyleOptions;
-
-export type { StrictStyleOptions, StyleOptions };
-export { defaultStyleOptions, normalizeStyleOptions };

package/src/localization/mergeLocalizedStrings.js

@@ -1,10 +0,0 @@
-export default function mergeLocalizedStrings(...args) {
-  const merged = {};
-  const languages = args.reduce((keys, arg) => [...keys, ...Object.keys(arg)], []);
-
-  for (const language of new Set(languages)) {
-    merged[language] = args.reduce((merged, arg) => ({ ...merged, ...arg[language] }), {});
-  }
-
-  return merged;
-}

package/src/utils/createCustomEvent.js

@@ -1,17 +0,0 @@
-export default function createCustomEvent(name, eventInitDict) {
-  let event;
-
-  if (typeof CustomEvent === 'function') {
-    event = new CustomEvent(name);
-  } else {
-    event = document.createEvent('Event');
-
-    event.initEvent(name, true, true);
-  }
-
-  Object.entries(eventInitDict).forEach(([key, value]) => {
-    event[key] = value;
-  });
-
-  return event;
-}

package/src/utils/mapMap.js

@@ -1,7 +0,0 @@
-export default function mapMap(map, mapper) {
-  return Object.entries(map).reduce((result, [key, value]) => {
-    result[key] = mapper(value, key);
-
-    return result;
-  }, {});
-}