@microsoft/teamsfx 2.2.1-alpha.cc0bf9f6b.0 → 2.2.1-alpha.e2c6fac1b.0

package/README.md

@@ -547,24 +547,94 @@ Also see [TeamsFx class](#teamsfx-class) for furthur description.
 
 From `botbuilder@4.16.0`, `BotFrameworkAdapter` is deprecated, and `CloudAdapter` is recommended to be used instead. You can import `ConversationBot` from `BotBuilderCloudAdapter` to use the latest SDK implemented with `CloudAdapter`.
 
-```ts
-const { BotBuilderCloudAdapter } = require("@microsoft/teamsfx");
-const ConversationBot = BotBuilderCloudAdapter.ConversationBot;
-
-const commandBot = new ConversationBot({
-  // The bot id and password to create CloudAdapter.
-  // See https://aka.ms/about-bot-adapter to learn more about adapters.
-  adapterConfig: {
-    MicrosoftAppId: config.botId,
-    MicrosoftAppPassword: config.botPassword,
-    MicrosoftAppType: "MultiTenant",
-  },
-  command: {
-    enabled: true,
-    commands: [new HelloWorldCommandHandler()],
-  },
-});
-```
+1. Install `@microsoft/teamsfx @^2.2.0`, `botbuilder @^4.18.0`, (and `@types/node @^14.0.0` for TS projects) via `npm install` as follows.
+
+    ```sh
+    npm install @microsoft/teamsfx
+    npm install botbuilder
+    
+    // For TS projects only
+    npm install --save-dev @types/node
+    ```
+
+2. Update the import of `ConversationBot` and create a new `ConversationBot` as follows.
+
+    ```ts
+    import { HelloWorldCommandHandler } from "../helloworldCommandHandler";
+    import { BotBuilderCloudAdapter } from "@microsoft/teamsfx";
+    import ConversationBot = BotBuilderCloudAdapter.ConversationBot;
+    import config from "./config";
+
+    export const commandBot = new ConversationBot({
+      // The bot id and password to create CloudAdapter.
+      // See https://aka.ms/about-bot-adapter to learn more about adapters.
+      adapterConfig: {
+        MicrosoftAppId: config.botId,
+        MicrosoftAppPassword: config.botPassword,
+        MicrosoftAppType: "MultiTenant",
+      },
+      command: {
+        enabled: true,
+        commands: [new HelloWorldCommandHandler()],
+      },
+    });
+    ```
+
+3. If the project is using `restify` to create a server, please add the following line after `restify.createServer()`.
+
+    ```ts
+    server.use(restify.plugins.bodyParser());
+    ```
+
+    The complete code will be like
+
+     ```ts
+     // Create HTTP server.
+     const server = restify.createServer();
+        server.use(restify.plugins.bodyParser());
+        server.listen(process.env.port || process.env.PORT || 3978, () => {
+          console.log(`\nApp Started, ${server.name} listening to ${server.url}`);
+     });
+     ```
+
+4. If the project has `responseWrapper.ts`, please update the class `responseWrapper` to the class below.
+
+    ```ts
+    import { Response } from "botbuilder";
+    
+    // A wrapper to convert Azure Functions Response to Bot Builder's Response.
+    export class ResponseWrapper implements Response {
+      socket: any;
+      originalResponse?: any;
+      headers?: any;
+      body?: any;
+    
+      constructor(functionResponse?: { [key: string]: any }) {
+        this.socket = undefined;
+        this.originalResponse = functionResponse;
+      }
+      
+      end(...args: any[]) {
+        // do nothing since res.end() is deprecated in Azure Functions.
+      }
+    
+      header(name: string, value: any) {
+        this.headers[name] = value;
+      }
+    
+      send(body: any) {
+        // record the body to be returned later.
+        this.body = body;
+        this.originalResponse.body = body;
+      }
+      status(status: number) {
+        // call Azure Functions' res.status().
+        return this.originalResponse?.status(status);
+      }
+    }
+    ```
+
+
 
 ## Next steps
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/teamsfx",
-  "version": "2.2.1-alpha.cc0bf9f6b.0",
+  "version": "2.2.1-alpha.e2c6fac1b.0",
   "description": "Microsoft Teams Framework for Node.js and browser.",
   "main": "dist/index.node.cjs.js",
   "browser": "dist/index.esm2017.js",
@@ -49,7 +49,7 @@
     "@azure/identity": "^2.0.1",
     "@azure/msal-browser": "^2.21.0",
     "@azure/msal-node": "^1.14.6",
-    "@microsoft/adaptivecards-tools": "1.3.1-alpha.cc0bf9f6b.0",
+    "@microsoft/adaptivecards-tools": "1.3.1-alpha.e2c6fac1b.0",
     "@microsoft/microsoft-graph-client": "^3.0.1",
     "axios": "^0.27.2",
     "botbuilder": ">=4.18.0 <5.0.0",
@@ -70,7 +70,7 @@
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
     "@microsoft/api-documenter": "^7.14.1",
     "@microsoft/api-extractor": "^7.19.4",
-    "@microsoft/eslint-plugin-teamsfx": "0.0.2-alpha.cc0bf9f6b.0",
+    "@microsoft/eslint-plugin-teamsfx": "0.0.2-alpha.e2c6fac1b.0",
     "@microsoft/teams-js": "^2.7.1",
     "@rollup/plugin-json": "^4.1.0",
     "@types/chai": "^4.2.22",
@@ -130,7 +130,7 @@
     "webpack": "^5.62.1",
     "yargs": "^17.2.1"
   },
-  "gitHead": "6e519c761f42d45cb12fdf37f32f7b89f3091fd2",
+  "gitHead": "e87fe38e538ed926fcdf171c6e429cd1f36af365",
   "publishConfig": {
     "access": "public"
   },