botframework-webchat-core 4.13.0 → 4.14.2

package/src/types/external/DirectLineCardAction.ts

@@ -0,0 +1,128 @@
+type CardActionWithImageAndTitle =
+  | { image: string }
+  | { title: string }
+  | {
+      image: string;
+      title: string;
+    };
+
+/**
+ * A `call` action represents a telephone number that may be called.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#call
+ */
+type CallCardAction = CardActionWithImageAndTitle & {
+  type: 'call';
+  value: string;
+};
+
+/**
+ * A `downloadFile` action represents a hyperlink to be downloaded.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#download-file-actions
+ */
+type DownloadFileCardAction = CardActionWithImageAndTitle & {
+  type: 'downloadFile';
+  value: string;
+};
+
+/**
+ * An `imBack` action represents a text response that is added to the chat feed.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#im-back
+ */
+type IMBackCardAction = CardActionWithImageAndTitle & {
+  type: 'imBack';
+  value: string;
+};
+
+/**
+ * A `messageBack` action represents a text response to be sent via the chat system.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#message-back
+ */
+type MessageBackCardAction = CardActionWithImageAndTitle & {
+  displayText?: string;
+  text?: string;
+  type: 'messageBack';
+  value?: { [key: string]: any };
+};
+
+/**
+ * An `openUrl` action represents a hyperlink to be handled by the client.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#open-url-actions
+ */
+type OpenURLCardAction = CardActionWithImageAndTitle & {
+  type: 'openUrl';
+  value: string;
+};
+
+/**
+ * A `playAudio` action represents audio media that may be played.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#play-audio
+ */
+type PlayAudioCardAction = CardActionWithImageAndTitle & {
+  type: 'playAudio';
+  value: string;
+};
+
+/**
+ * A `playVideo` action represents video media that may be played.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#play-video
+ */
+type PlayVideoCardAction = CardActionWithImageAndTitle & {
+  type: 'playVideo';
+  value: string;
+};
+
+/**
+ * A `postBack` action represents a text response that is not added to the chat feed.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#post-back
+ */
+type PostBackCardAction = CardActionWithImageAndTitle & {
+  type: 'postBack';
+  value: any; // For legacy reason, postBack support any.
+};
+
+/**
+ * A `showImage` action represents an image that may be displayed.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#show-image-file-actions
+ */
+type ShowImageCardAction = CardActionWithImageAndTitle & {
+  type: 'showImage';
+  value: string;
+};
+
+/**
+ * A `signin` action represents a hyperlink to be handled by the client's signin system.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#signin
+ */
+type SignInCardAction = CardActionWithImageAndTitle & {
+  type: 'signin';
+  value: string;
+};
+
+/**
+ * A card action represents a clickable or interactive button for use within cards or as suggested actions. They are used to solicit input from users. Despite their name, card actions are not limited to use solely on cards.
+ *
+ * https://github.com/Microsoft/botframework-sdk/blob/main/specs/botframework-activity/botframework-activity.md#card-action
+ */
+type DirectLineCardAction =
+  | CallCardAction
+  | DownloadFileCardAction
+  | IMBackCardAction
+  | MessageBackCardAction
+  | OpenURLCardAction
+  | PlayAudioCardAction
+  | PlayVideoCardAction
+  | PostBackCardAction
+  | ShowImageCardAction
+  | SignInCardAction;
+
+export default DirectLineCardAction;

package/src/types/external/DirectLineHeroCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineHeroCard = any;
+
+export default DirectLineHeroCard;

package/src/types/external/DirectLineJSBotConnection.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineJSBotConnection = any;
+
+export default DirectLineJSBotConnection;

package/src/types/external/DirectLineOAuthCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineOAuthCard = any;
+
+export default DirectLineOAuthCard;

package/src/types/external/DirectLineReceiptCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineReceiptCard = any;
+
+export default DirectLineReceiptCard;

package/src/types/external/DirectLineSignInCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineSignInCard = any;
+
+export default DirectLineSignInCard;

package/src/types/external/DirectLineSuggestedAction.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineSuggestedAction = any;
+
+export default DirectLineSuggestedAction;

package/src/types/external/DirectLineThumbnailCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineThumbnailCard = any;
+
+export default DirectLineThumbnailCard;

package/src/types/external/DirectLineVideoCard.ts

@@ -0,0 +1,6 @@
+// TODO: [P1] #3953 We should fully type it out.
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type DirectLineVideoCard = any;
+
+export default DirectLineVideoCard;

package/src/utils/dateToLocaleISOString.chatham.spec.js

@@ -0,0 +1,13 @@
+/**
+ * @jest-environment ../../../__tests__/setup/jestNodeEnvironmentWithTimezone.js
+ * @timezone Pacific/Chatham
+ */
+
+import dateToLocaleISOString from './dateToLocaleISOString';
+
+test('formatting a time in Chatham Islands timezone', () => {
+  const date = new Date(Date.UTC(2000, 0, 1, 0, 12, 34, 567));
+  const actual = dateToLocaleISOString(date);
+
+  expect(actual).toMatchInlineSnapshot(`"2000-01-01T13:57:34.567+13:45"`);
+});

package/src/utils/dateToLocaleISOString.japan.spec.js

@@ -0,0 +1,13 @@
+/**
+ * @jest-environment ../../../__tests__/setup/jestNodeEnvironmentWithTimezone.js
+ * @timezone Asia/Tokyo
+ */
+
+import dateToLocaleISOString from './dateToLocaleISOString';
+
+test('formatting a time in Japan timezone', () => {
+  const date = new Date(Date.UTC(2000, 0, 1, 0, 12, 34, 567));
+  const actual = dateToLocaleISOString(date);
+
+  expect(actual).toMatchInlineSnapshot(`"2000-01-01T09:12:34.567+09:00"`);
+});

package/src/utils/dateToLocaleISOString.js

@@ -0,0 +1,34 @@
+/* eslint no-magic-numbers: ["off", { "ignore": [1, 2, 3, 60] }] */
+
+function pad(value, count = 2) {
+  if (typeof value !== 'number') {
+    throw new Error('First argument must be a number');
+  }
+
+  value += '';
+
+  while (value.length < count) {
+    value = '0' + value;
+  }
+
+  return value;
+}
+
+// Adopted from https://stackoverflow.com/questions/17415579/how-to-iso-8601-format-a-date-with-timezone-offset-in-javascript.
+export default function dateToLocaleISOString(date) {
+  if (!(date instanceof Date)) {
+    throw new Error('First argument must be a Date object');
+  }
+
+  const timezoneOffset = -date.getTimezoneOffset();
+  const timezoneSign = timezoneOffset < 0 ? '-' : '+';
+
+  // "yyyy-MM-DDTHH:mm:ss.fff+08:00" for GMT+08
+  // "yyyy-MM-DDTHH:mm:ss.fffZ" for UTC
+
+  return `${date.getFullYear()}-${pad(date.getMonth() + 1)}-${pad(date.getDate())}T${pad(date.getHours())}:${pad(
+    date.getMinutes()
+  )}:${pad(date.getSeconds())}.${pad(date.getMilliseconds(), 3)}${
+    timezoneOffset ? `${timezoneSign}${pad(~~(Math.abs(timezoneOffset) / 60))}:${pad(timezoneOffset % 60)}` : 'Z'
+  }`;
+}

package/src/utils/dateToLocaleISOString.pacific.spec.js

@@ -0,0 +1,13 @@
+/**
+ * @jest-environment ../../../__tests__/setup/jestNodeEnvironmentWithTimezone.js
+ * @timezone America/Los_Angeles
+ */
+
+import dateToLocaleISOString from './dateToLocaleISOString';
+
+test('formatting a time in Pacific Standard Time timezone', () => {
+  const date = new Date(Date.UTC(2000, 0, 1, 0, 12, 34, 567));
+  const actual = dateToLocaleISOString(date);
+
+  expect(actual).toMatchInlineSnapshot(`"1999-12-31T16:12:34.567-08:00"`);
+});

package/src/utils/dateToLocaleISOString.utc.spec.js

@@ -0,0 +1,20 @@
+/**
+ * @jest-environment ../../../__tests__/setup/jestNodeEnvironmentWithTimezone.js
+ * @timezone Etc/UTC
+ */
+
+import dateToLocaleISOString from './dateToLocaleISOString';
+
+test('formatting a time in UTC timezone', () => {
+  const date = new Date(Date.UTC(2000, 0, 1, 0, 12, 34, 567));
+  const actual = dateToLocaleISOString(date);
+
+  expect(actual).toMatchInlineSnapshot(`"2000-01-01T00:12:34.567Z"`);
+});
+
+test('formatting a time in UTC timezone with zero milliseconds', () => {
+  const date = new Date(Date.UTC(2000, 0, 1, 0, 12, 34, 0));
+  const actual = dateToLocaleISOString(date);
+
+  expect(actual).toMatchInlineSnapshot(`"2000-01-01T00:12:34.000Z"`);
+});

package/src/utils/once.ts

@@ -0,0 +1,10 @@
+export default function once(fn: () => void): () => void {
+  let done;
+
+  return () => {
+    if (!done) {
+      fn();
+      done = 1;
+    }
+  };
+}

package/src/utils/singleToArray.ts

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

package/src/utils/warnOnce.ts

@@ -0,0 +1,5 @@
+import once from './once';
+
+export default function warnOnce(message: string): () => void {
+  return once(() => console.warn(`botframework-webchat: ${message}.`));
+}