fix: Use correct types in signatures of before,after and postMessage (#185)

Use correct types in signatures of before,after and postMessage

Author: germanattanasio

lib/index.d.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import Botkit = require('botkit');
-import AssistantV1 = require('ibm-watson/assistant/v1');
+import { MessageParams, MessageResponse } from 'ibm-watson/assistant/v1';
 import { Context } from 'ibm-watson/assistant/v1';
 import { BotkitMessage } from 'botkit';
 export interface WatsonMiddlewareConfig {
@@ -32,11 +32,12 @@ export interface WatsonMiddlewareConfig {
     iam_url?: string;
     minimum_confidence?: number;
 }
-export interface Payload extends AssistantV1.MessageRequest {
-    workspace_id: string;
-}
+/**
+ * @deprecated please use AssistantV1.MessageParams instead
+ */
+export declare type Payload = MessageParams;
 export declare type BotkitWatsonMessage = BotkitMessage & {
-    watsonData?: Payload;
+    watsonData?: MessageResponse;
     watsonError?: string;
 };
 export interface ContextDelta {
@@ -50,8 +51,8 @@ export declare class WatsonMiddleware {
     private readonly ignoreType;
     constructor(config: WatsonMiddlewareConfig);
     hear(patterns: string[], message: Botkit.BotkitMessage): boolean;
-    before(message: Botkit.BotkitMessage, payload: Payload): Promise<Payload>;
-    after(message: Botkit.BotkitMessage, response: any): Promise<any>;
+    before(message: Botkit.BotkitMessage, payload: MessageParams): Promise<MessageParams>;
+    after(message: Botkit.BotkitMessage, response: MessageResponse): Promise<MessageResponse>;
     sendToWatson(bot: Botkit.BotWorker, message: Botkit.BotkitMessage, contextDelta: ContextDelta): Promise<void>;
     receive(bot: Botkit.BotWorker, message: Botkit.BotkitMessage): Promise<void>;
     interpret(bot: Botkit.BotWorker, message: Botkit.BotkitMessage): Promise<void>;

lib/index.js.map

@@ -15,12 +15,11 @@
  */
 import { Storage } from 'botbuilder';
 import AssistantV1 = require('ibm-watson/assistant/v1');
-import { Context } from 'ibm-watson/assistant/v1';
-import { Payload } from './index';
+import { Context, MessageParams, MessageResponse } from 'ibm-watson/assistant/v1';
 export declare function readContext(userId: string, storage: Storage): Promise<Context | null>;
 export declare function updateContext(userId: string, storage: Storage, watsonResponse: {
     context: Context;
 }): Promise<{
     context: Context;
 }>;
-export declare function postMessage(conversation: AssistantV1, payload: Payload): Promise<AssistantV1.MessageResponse>;
+export declare function postMessage(conversation: AssistantV1, payload: MessageParams): Promise<MessageResponse>;

lib/utils.d.ts

@@ -18,6 +18,7 @@
 const debug = require('debug')('watson-middleware:index');
 import Botkit = require('botkit');
 import AssistantV1 = require('ibm-watson/assistant/v1');
+import { MessageParams, MessageResponse } from 'ibm-watson/assistant/v1';
 import { Context } from 'ibm-watson/assistant/v1';
 import { Storage } from 'botbuilder';
 import { readContext, updateContext, postMessage } from './utils';
@@ -40,12 +41,13 @@ export interface WatsonMiddlewareConfig {
   minimum_confidence?: number;
 }
 
-export interface Payload extends AssistantV1.MessageRequest {
-  workspace_id: string;
-}
+/**
+ * @deprecated please use AssistantV1.MessageParams instead
+ */
+export type Payload = MessageParams;
 
 export type BotkitWatsonMessage = BotkitMessage & {
-  watsonData?: Payload;
+  watsonData?: MessageResponse;
   watsonError?: string;
 };
 
@@ -86,12 +88,15 @@ export class WatsonMiddleware {
 
   public before(
     message: Botkit.BotkitMessage,
-    payload: Payload,
-  ): Promise<Payload> {
+    payload: MessageParams,
+  ): Promise<MessageParams> {
     return Promise.resolve(payload);
   }
 
-  public after(message: Botkit.BotkitMessage, response: any): Promise<any> {
+  public after(
+    message: Botkit.BotkitMessage,
+    response: MessageResponse,
+  ): Promise<MessageResponse> {
     return Promise.resolve(response);
   }
 
@@ -128,7 +133,7 @@ export class WatsonMiddleware {
     try {
       const userContext = await readContext(message.user, this.storage);
 
-      const payload: Payload = {
+      const payload: MessageParams = {
         // eslint-disable-next-line @typescript-eslint/camelcase
         workspace_id: this.config.workspace_id,
       };

lib/utils.js.map

@@ -18,8 +18,11 @@
 const debug = require('debug')('watson-middleware:utils');
 import { Storage } from 'botbuilder';
 import AssistantV1 = require('ibm-watson/assistant/v1');
-import { Context } from 'ibm-watson/assistant/v1';
-import { Payload } from './index';
+import {
+  Context,
+  MessageParams,
+  MessageResponse,
+} from 'ibm-watson/assistant/v1';
 
 const storagePrefix = 'user.';
 
@@ -78,8 +81,8 @@ export async function updateContext(
 
 export async function postMessage(
   conversation: AssistantV1,
-  payload: Payload,
-): Promise<AssistantV1.MessageResponse> {
+  payload: MessageParams,
+): Promise<MessageResponse> {
   debug('Assistant Request: %s', JSON.stringify(payload, null, 2));
   const response = await conversation.message(payload);
   debug('Assistant Response: %s', JSON.stringify(response, null, 2));