botframework-webchat-core 4.18.1 → 4.19.0

package/src/actions/stopVoiceRecording.ts

@@ -0,0 +1,17 @@
+const VOICE_STOP_RECORDING = 'WEB_CHAT/VOICE_STOP_RECORDING' as const;
+
+type VoiceStopRecordingAction = {
+  type: typeof VOICE_STOP_RECORDING;
+};
+
+function stopVoiceRecording(): VoiceStopRecordingAction {
+  return {
+    type: VOICE_STOP_RECORDING
+  };
+}
+
+export default stopVoiceRecording;
+
+export { VOICE_STOP_RECORDING };
+
+export type { VoiceStopRecordingAction };

package/src/actions/{submitSendBox.js → submitSendBox.ts}

@@ -1,6 +1,6 @@
 const SUBMIT_SEND_BOX = 'WEB_CHAT/SUBMIT_SEND_BOX';
 
-export default function submitSendBox(method = 'keyboard', { channelData } = {}) {
+export default function submitSendBox(method = 'keyboard', { channelData } = { channelData: undefined }) {
   return {
     type: SUBMIT_SEND_BOX,
     payload: { channelData, method }

package/src/actions/unmuteVoiceRecording.ts

@@ -0,0 +1,17 @@
+const VOICE_UNMUTE_RECORDING = 'WEB_CHAT/VOICE_UNMUTE_RECORDING' as const;
+
+type VoiceUnmuteRecordingAction = {
+  type: typeof VOICE_UNMUTE_RECORDING;
+};
+
+function unmuteVoiceRecording(): VoiceUnmuteRecordingAction {
+  return {
+    type: VOICE_UNMUTE_RECORDING
+  };
+}
+
+export default unmuteVoiceRecording;
+
+export { VOICE_UNMUTE_RECORDING };
+
+export type { VoiceUnmuteRecordingAction };

package/src/actions/unregisterActionSink.ts

@@ -0,0 +1,29 @@
+import { type Action } from 'redux';
+import { custom, function_, is, literal, object, pipe, readonly, type InferOutput } from 'valibot';
+
+const UNREGISTER_ACTION_SINK = 'WEB_CHAT_INTERNAL/UNREGISTER_ACTION_SINK' as const;
+
+const unregisterActionSinkActionSchema = pipe(
+  object({
+    payload: pipe(
+      object({
+        sink: custom<(action: Action) => void>(value => is(function_(), value))
+      }),
+      readonly()
+    ),
+    type: literal(UNREGISTER_ACTION_SINK)
+  }),
+  readonly()
+);
+
+type UnregisterActionSinkAction = InferOutput<typeof unregisterActionSinkActionSchema>;
+
+function unregisterActionSink(sink: (action: Action) => void): UnregisterActionSinkAction {
+  return {
+    payload: { sink },
+    type: UNREGISTER_ACTION_SINK
+  };
+}
+
+export default unregisterActionSink;
+export { UNREGISTER_ACTION_SINK, unregisterActionSinkActionSchema, type UnregisterActionSinkAction };

package/src/actions/unregisterVoiceHandler.ts

@@ -0,0 +1,19 @@
+const VOICE_UNREGISTER_HANDLER = 'WEB_CHAT/VOICE_UNREGISTER_HANDLER' as const;
+
+type VoiceUnregisterHandlerAction = {
+  type: typeof VOICE_UNREGISTER_HANDLER;
+  payload: { id: string };
+};
+
+function unregisterVoiceHandler(id: string): VoiceUnregisterHandlerAction {
+  return {
+    type: VOICE_UNREGISTER_HANDLER,
+    payload: { id }
+  };
+}
+
+export default unregisterVoiceHandler;
+
+export { VOICE_UNREGISTER_HANDLER };
+
+export type { VoiceUnregisterHandlerAction };

package/src/boot/activity.ts

@@ -0,0 +1,19 @@
+export { getLocalIdFromActivity, LocalIdSchema, type LocalId } from '../reducers/activities/sort/property/LocalId';
+export {
+  getPositionFromActivity,
+  PositionSchema,
+  queryPositionFromActivity,
+  type Position
+} from '../reducers/activities/sort/property/Position';
+export {
+  getReceivedAtFromActivity,
+  queryReceivedAtFromActivity,
+  ReceivedAtSchema,
+  type ReceivedAt
+} from '../reducers/activities/sort/property/ReceivedAt';
+export {
+  getSendStatusFromOutgoingActivity,
+  querySendStatusFromOutgoingActivity,
+  SendStatusSchema,
+  type SendStatus
+} from '../reducers/activities/sort/property/SendStatus';

package/src/boot/graph.ts

@@ -0,0 +1,18 @@
+export {
+  IdentifierSchema,
+  isOfType,
+  MessageNodeSchema,
+  SlantGraph,
+  SlantNodeSchema,
+  type GraphMiddleware,
+  type GraphNode,
+  type GraphState,
+  type GraphSubscriber,
+  type GraphSubscriberRecord,
+  type Identifier,
+  type MessageNode,
+  type ReadableGraph,
+  type SlantNode,
+  type WritableGraph
+} from '@msinternal/botframework-webchat-core-graph';
+export { default as createGraphFromStore } from '../graph/createGraphFromStore';

package/src/boot/internal.ts

@@ -0,0 +1,11 @@
+export {
+  SET_RAW_STATE,
+  default as setRawState,
+  setRawStateActionSchema,
+  type SetRawStateAction
+} from '../internal/actions/setRawState';
+
+export { default as StoreDebugAPIRegistry } from '../internal/StoreDebugAPIRegistry';
+export { type StoreDebugAPI } from '../types/StoreDebugAPI';
+
+export { RestrictedDebugAPI, type InferPublic } from '@msinternal/botframework-webchat-core-debug-api';

package/src/boot/json-ld.ts

@@ -0,0 +1,6 @@
+export { isOfType } from '@msinternal/botframework-webchat-core-json-ld';
+export {
+  jsonLinkedDataSchema,
+  type JSONLinkedDataInput,
+  type JSONLinkedDataOutput
+} from '@msinternal/botframework-webchat-core-json-ld';

package/src/boot/org-schema.ts

@@ -0,0 +1,29 @@
+export {
+  orgSchemaActionSchema,
+  orgSchemaClaimSchema,
+  orgSchemaCreativeWorkSchema,
+  orgSchemaDefinedTermSchema,
+  orgSchemaPersonSchema,
+  orgSchemaProjectSchema,
+  orgSchemaSoftwareSourceCodeSchema,
+  orgSchemaThingSchema,
+  orgSchemaUserReviewSchema,
+  orgSchemaVoteActionSchema,
+  parseAction,
+  parseClaim,
+  parseCreativeWork,
+  parseDefinedTerm,
+  parseProject,
+  parseThing,
+  parseVoteAction,
+  type OrgSchemaAction,
+  type OrgSchemaClaim,
+  type OrgSchemaCreativeWork,
+  type OrgSchemaDefinedTerm,
+  type OrgSchemaPerson,
+  type OrgSchemaProject,
+  type OrgSchemaSoftwareSourceCode,
+  type OrgSchemaThing,
+  type OrgSchemaUserReview,
+  type OrgSchemaVoteAction
+} from '@msinternal/botframework-webchat-core-json-ld';

package/src/buildInfo.ts

@@ -0,0 +1,9 @@
+import { createBuildInfo } from '@msinternal/botframework-webchat-base/utils';
+
+const buildInfo = createBuildInfo('botframework-webchat:core');
+
+buildInfo.set('buildTool', globalThis.WEB_CHAT_BUILD_INFO_BUILD_TOOL);
+buildInfo.set('moduleFormat', globalThis.WEB_CHAT_BUILD_INFO_MODULE_FORMAT);
+buildInfo.set('version', globalThis.WEB_CHAT_BUILD_INFO_VERSION);
+
+export default buildInfo;

package/src/constants/{ActivityClientState.js → ActivityClientState.ts}

@@ -1,8 +1,8 @@
 /** @deprecated This constant is being deprecated, please use string literal instead. Will be remove on or after 2024-07-31. */
-const SEND_FAILED = 'send failed';
+const SEND_FAILED = 'send failed' as const;
 /** @deprecated This constant is being deprecated, please use string literal instead. Will be remove on or after 2024-07-31. */
-const SENDING = 'sending';
+const SENDING = 'sending' as const;
 /** @deprecated This constant is being deprecated, please use string literal instead. Will be remove on or after 2024-07-31. */
-const SENT = 'sent';
+const SENT = 'sent' as const;
 
 export { SEND_FAILED, SENDING, SENT };

package/src/constants/DictateState.ts

@@ -0,0 +1,10 @@
+const IDLE = 0 as const;
+const WILL_START = 1 as const;
+// eslint-disable-next-line no-magic-numbers
+const STARTING = 2 as const;
+// eslint-disable-next-line no-magic-numbers
+const DICTATING = 3 as const;
+// eslint-disable-next-line no-magic-numbers
+const STOPPING = 4 as const;
+
+export { DICTATING, IDLE, STARTING, STOPPING, WILL_START };

package/src/createPromiseQueue.js

@@ -1,14 +1,14 @@
-import createDeferred from 'p-defer-es5';
+import { withResolvers } from '@msinternal/botframework-webchat-base/utils';
 
 export default function createPromiseQueue() {
-  let deferred;
+  let promiseWithResolvers;
   const queue = [];
 
   const push = value => {
-    if (deferred) {
-      const { resolve } = deferred;
+    if (promiseWithResolvers) {
+      const { resolve } = promiseWithResolvers;
 
-      deferred = null;
+      promiseWithResolvers = null;
       resolve(value);
     } else {
       queue.push(value);
@@ -16,7 +16,9 @@ export default function createPromiseQueue() {
   };
 
   const shift = () =>
-    queue.length ? Promise.resolve(queue.shift()) : (deferred || (deferred = createDeferred())).promise;
+    queue.length
+      ? Promise.resolve(queue.shift())
+      : (promiseWithResolvers || (promiseWithResolvers = withResolvers())).promise;
 
   return {
     push,

package/src/createReducer.ts

@@ -1,7 +1,7 @@
 import { combineReducers } from 'redux';
 
+import combineActivitiesReducer from './reducers/activities/combineActivitiesReducer';
 import connectivityStatus from './reducers/connectivityStatus';
-import createActivitiesReducer from './reducers/createActivitiesReducer';
 import createInternalReducer from './reducers/createInternalReducer';
 import createNotificationsReducer from './reducers/createNotificationsReducer';
 import createTypingReducer from './reducers/createTypingReducer';
@@ -16,26 +16,34 @@ import sendTimeout from './reducers/sendTimeout';
 import sendTypingIndicator from './reducers/sendTypingIndicator';
 import shouldSpeakIncomingActivity from './reducers/shouldSpeakIncomingActivity';
 import suggestedActions from './reducers/suggestedActions';
+import suggestedActionsOriginActivity from './reducers/suggestedActionsOriginActivity';
+import voiceActivity from './reducers/voiceActivity';
 
 import type { GlobalScopePonyfill } from './types/GlobalScopePonyfill';
+import type { RestrictedStoreDebugAPI } from './types/StoreDebugAPI';
 
-export default function createReducer(ponyfill: GlobalScopePonyfill) {
-  return combineReducers({
-    activities: createActivitiesReducer(ponyfill),
-    connectivityStatus,
-    dictateInterims,
-    dictateState,
-    internal: createInternalReducer(ponyfill),
-    language,
-    notifications: createNotificationsReducer(ponyfill),
-    readyState,
-    referenceGrammarID,
-    sendBoxAttachments,
-    sendBoxValue,
-    sendTimeout,
-    sendTypingIndicator,
-    shouldSpeakIncomingActivity,
-    suggestedActions,
-    typing: createTypingReducer(ponyfill)
-  });
+export default function createReducer(ponyfill: GlobalScopePonyfill, restrictedStoreDebugAPI: RestrictedStoreDebugAPI) {
+  return combineActivitiesReducer(
+    ponyfill,
+    restrictedStoreDebugAPI,
+    combineReducers({
+      connectivityStatus,
+      dictateInterims,
+      dictateState,
+      internal: createInternalReducer(ponyfill),
+      language,
+      notifications: createNotificationsReducer(ponyfill),
+      readyState,
+      referenceGrammarID,
+      sendBoxAttachments,
+      sendBoxValue,
+      sendTimeout,
+      sendTypingIndicator,
+      shouldSpeakIncomingActivity,
+      suggestedActions,
+      suggestedActionsOriginActivity,
+      typing: createTypingReducer(ponyfill),
+      voice: voiceActivity
+    })
+  );
 }

package/src/createSagas.ts

@@ -1,5 +1,7 @@
+import { type Saga } from 'redux-saga';
 import { fork } from 'redux-saga/effects';
 
+import actionSinkSaga from './sagas/actionSinkSaga';
 import clearSuggestedActionsOnPostActivitySaga from './sagas/clearSuggestedActionsOnPostActivitySaga';
 import connectionStatusToNotificationSaga from './sagas/connectionStatusToNotificationSaga';
 import connectionStatusUpdateSaga from './sagas/connectionStatusUpdateSaga';
@@ -22,9 +24,8 @@ import startSpeakActivityOnPostActivitySaga from './sagas/startSpeakActivityOnPo
 import stopDictateOnCardActionSaga from './sagas/stopDictateOnCardActionSaga';
 import stopSpeakingActivityOnInputSaga from './sagas/stopSpeakingActivityOnInputSaga';
 import submitSendBoxSaga from './sagas/submitSendBoxSaga';
-
-import type { GlobalScopePonyfill } from './types/GlobalScopePonyfill';
-import type { Saga } from 'redux-saga';
+import postVoiceActivitySaga from './sagas/postVoiceActivitySaga';
+import { type GlobalScopePonyfill } from './types/GlobalScopePonyfill';
 
 type CreateSagasOptions = {
   ponyfill: GlobalScopePonyfill;
@@ -34,6 +35,7 @@ export default function createSagas({ ponyfill }: CreateSagasOptions): Saga {
   return function* () {
     // TODO: [P2] Since fork() silently catches all exceptions, we need to find a way to console.error them out.
 
+    yield fork(actionSinkSaga);
     yield fork(clearSuggestedActionsOnPostActivitySaga);
     yield fork(connectionStatusToNotificationSaga);
     yield fork(connectionStatusUpdateSaga);
@@ -43,6 +45,7 @@ export default function createSagas({ ponyfill }: CreateSagasOptions): Saga {
     yield fork(markAllAsSpokenOnStopSpeakActivitySaga);
     yield fork(observeActivitySaga);
     yield fork(postActivitySaga, ponyfill);
+    yield fork(postVoiceActivitySaga, ponyfill);
     yield fork(queueIncomingActivitySaga, ponyfill);
     yield fork(sendEventToPostActivitySaga);
     yield fork(sendFilesToPostActivitySaga);

package/src/createStore.ts

@@ -1,12 +1,14 @@
-import { applyMiddleware, createStore as createReduxStore, type Store } from 'redux';
-import { composeWithDevTools } from 'redux-devtools-extension';
+import { composeWithDevTools } from '@redux-devtools/extension';
+import { applyMiddleware, createStore as createReduxStore, type Middleware, type Store } from 'redux';
 import createSagaMiddleware from 'redux-saga';
 
+import sagaError from './actions/sagaError';
 import createReducer from './createReducer';
 import createSagas from './createSagas';
-import sagaError from './actions/sagaError';
+import { RestrictedStoreDebugAPI } from './types/StoreDebugAPI';
 
 import type { GlobalScopePonyfill } from './types/GlobalScopePonyfill';
+import StoreDebugAPIRegistry from './internal/StoreDebugAPIRegistry';
 
 type CreateStoreOptions = {
   /**
@@ -29,7 +31,7 @@ type CreateStoreOptions = {
   ponyfill?: Partial<GlobalScopePonyfill>;
 };
 
-function createEnhancerAndSagaMiddleware(getStore, ...middlewares) {
+function createEnhancerAndSagaMiddleware(getStore: () => any, ...middlewares: readonly Middleware[]) {
   const sagaMiddleware = createSagaMiddleware({
     onError: (...args) => {
       const [err] = args;
@@ -56,7 +58,11 @@ function createEnhancerAndSagaMiddleware(getStore, ...middlewares) {
 
 // The complexity is introduced by the check of ponyfill.
 // eslint-disable-next-line complexity
-export function withOptions(options: CreateStoreOptions, initialState?, ...middlewares): Store {
+export function withOptions(
+  options: CreateStoreOptions,
+  initialState?: any | undefined,
+  ...middlewares: readonly Middleware[]
+): Store {
   // IE Mode does not have `globalThis`.
   const globalThisOrWindow = typeof globalThis === 'undefined' ? window : globalThis;
   const ponyfillFromOptions: Partial<GlobalScopePonyfill> = options.ponyfill || {};
@@ -108,15 +114,25 @@ export function withOptions(options: CreateStoreOptions, initialState?, ...middl
       (typeof setTimeout === 'function' ? setTimeout.bind(globalThisOrWindow) : undefined)
   };
 
+  // We are doing lazy init and cyclic dependencies.
+  // eslint-disable-next-line prefer-const
+  let store: Store | undefined;
+
+  const restrictedStoreDebugAPI = new RestrictedStoreDebugAPI(() => store?.getState().activities);
+
   // We are sure the "getStore" (first argument) is not called on "createEnhancerAndSagaMiddleware()".
-  // eslint-disable-next-line @typescript-eslint/no-use-before-define
   const { enhancer, sagaMiddleware } = createEnhancerAndSagaMiddleware(() => store, ...middlewares);
-  const store = createReduxStore(
-    createReducer(ponyfill),
+
+  store = createReduxStore(
+    createReducer(ponyfill, restrictedStoreDebugAPI),
     initialState || {},
     options.devTools ? composeWithDevTools(enhancer) : enhancer
   );
 
+  // TODO: [P1] When we redesign the store and chat adapter, we should have the Debug API stored somewhere else.
+  StoreDebugAPIRegistry.set(store, restrictedStoreDebugAPI.toPublic());
+
+  // TODO: [P1] When we redesign the store and chat adapter, we shoulstore.getState().activities
   sagaMiddleware.run(createSagas({ ponyfill }));
 
   return store;
@@ -127,7 +143,7 @@ export function withOptions(options: CreateStoreOptions, initialState?, ...middl
  *
  * This store is critical for Web Chat business logics to operate, please use with cautions.
  */
-export default function createStore(initialState?, ...middlewares): Store {
+export default function createStore(initialState?: any, ...middlewares: readonly Middleware[]): Store {
   return withOptions({}, initialState, ...middlewares);
 }
 
@@ -138,6 +154,6 @@ export default function createStore(initialState?, ...middlewares): Store {
  *
  * @deprecated Use `withOptions` instead and pass `{ devTools: true }`
  */
-export function withDevTools(initialState?, ...middlewares): Store {
+export function withDevTools(initialState?: any, ...middlewares: readonly Middleware[]): Store {
   return withOptions({ devTools: true }, initialState, ...middlewares);
 }

package/src/env.d.ts

@@ -0,0 +1,12 @@
+// For adding things to `globalThis`, TypeScript need `var`, not `const` or `let`.
+/* eslint-disable no-var */
+declare global {
+  const clearImmediate: ((timeout: number) => void) | undefined;
+  const setImmediate: ((fn: () => void) => number) | undefined;
+
+  var WEB_CHAT_BUILD_INFO_BUILD_TOOL: string | undefined;
+  var WEB_CHAT_BUILD_INFO_MODULE_FORMAT: string | undefined;
+  var WEB_CHAT_BUILD_INFO_VERSION: string | undefined;
+}
+
+export {};

package/src/graph/createGraphFromStore.ts

@@ -0,0 +1,121 @@
+import { SlantGraph, SlantNodeSchema } from '@msinternal/botframework-webchat-core-graph';
+import { parse } from 'valibot';
+import type createStore from '../createStore';
+import { getLocalIdFromActivity } from '../reducers/activities/sort/property/LocalId';
+import { getPositionFromActivity } from '../reducers/activities/sort/property/Position';
+import type { Activity } from '../reducers/activities/sort/types';
+
+function createGraphFromStore(store: ReturnType<typeof createStore>): SlantGraph {
+  const graph = new SlantGraph();
+  let prevActivities: readonly Activity[] | undefined;
+
+  // TODO: [P0] Except channel audience, we should be specific about all audience, e.g. name.
+  const channelAudience = parse(SlantNodeSchema, {
+    '@context': 'https://schema.org',
+    '@id': '_:audience/channel',
+    '@type': ['Audience'],
+    audienceType: ['channel']
+  });
+
+  const othersAudience = parse(SlantNodeSchema, {
+    '@context': 'https://schema.org',
+    '@id': '_:audience/others',
+    '@type': ['Audience'],
+    audienceType: ['others']
+  });
+
+  const selfAudience = parse(SlantNodeSchema, {
+    '@context': 'https://schema.org',
+    '@id': '_:audience/user',
+    '@type': ['Audience'],
+    audienceType: ['self']
+  });
+
+  graph.act(graph => graph.upsert(othersAudience, channelAudience, selfAudience));
+
+  store.subscribe(() => {
+    const { activities }: { activities: readonly Activity[] } = store.getState();
+
+    if (Object.is(activities, prevActivities)) {
+      return;
+    }
+
+    const activitySet = new Set(activities);
+    const prevActivitySet = new Set(prevActivities);
+
+    // TODO: [P*] Supports deleting node from the graph.
+    const addedActivities = activitySet.difference(prevActivitySet);
+
+    graph.act(graph => {
+      for (const activity of addedActivities) {
+        const {
+          from: { role }
+        } = activity;
+
+        const localId = getLocalIdFromActivity(activity);
+        const position = getPositionFromActivity(activity);
+
+        // TODO: Should use Person and more specific than just "Others".
+        const sender =
+          role === 'bot'
+            ? { '@id': othersAudience['@id'] }
+            : role === 'user'
+              ? { '@id': selfAudience['@id'] }
+              : role === 'channel'
+                ? { '@id': channelAudience['@id'] }
+                : undefined;
+
+        if (activity.type === 'message' || activity.type === 'typing') {
+          // TODO: [P*] If this is livestreaming, add isPartOf to indicate the livestream head.
+          graph.upsert({
+            '@context': 'https://schema.org',
+
+            '@id': localId,
+            '@type': ['Message', `urn:microsoft:webchat:direct-line-activity`],
+
+            encodingFormat:
+              'textFormat' in activity && activity.textFormat !== 'markdown' ? 'text/plain' : 'text/markdown',
+
+            // TODO: [P0] activity.id could be null here.
+            // TODO: [P0] Not sure if we need client activity ID here as we already have permanent ID.
+            identifier: [
+              ...(activity.id ? [`urn:microsoft:webchat:direct-line-activity:id:${activity.id}`] : []),
+              ...(typeof activity.channelData.clientActivityID === 'string'
+                ? [`urn:microsoft:webchat:client-activity-id:${activity.channelData.clientActivityID}`]
+                : [])
+            ],
+
+            position,
+            sender,
+            text: ('text' in activity && typeof activity.text === 'string' && activity.text) || undefined,
+
+            'urn:microsoft:webchat:direct-line-activity:raw-json': { '@type': '@json', '@value': activity },
+            'urn:microsoft:webchat:direct-line-activity:type': activity.type
+          });
+        } else if (typeof activity.type === 'string') {
+          graph.upsert({
+            '@context': 'https://schema.org',
+            '@id': localId,
+            '@type': Object.freeze(['urn:microsoft:webchat:direct-line-activity']),
+            identifier: activity.id && `urn:microsoft:webchat:direct-line-activity:id:${activity.id}`,
+            position,
+            sender,
+            'urn:microsoft:webchat:direct-line-activity:raw-json': { '@type': '@json', '@value': activity },
+            'urn:microsoft:webchat:direct-line-activity:type': activity.type
+          });
+        } else {
+          console.warn(
+            `botframework-webchat: Activity must have "type" with value of string, ignoring activity without proper "type" field.`,
+            { activity }
+          );
+        }
+      }
+    });
+
+    prevActivities = activities;
+  });
+
+  return graph;
+}
+
+export default createGraphFromStore;