feat: Updated js runtime to use the latest SDK

extensions/runtimes/src/index.ts

@@ -278,6 +278,30 @@ export default async (composer: any): Promise<void> => {
         // used to read bot project template from source (bundled in plugin)
         const excludeFolder = new Set<string>().add(path.resolve(sourcePath, 'node_modules'));
         await copyDir(sourcePath, localDisk, destPath, project.fileStorage, excludeFolder);
+        const schemaDstPath = path.join(project.dir, 'schemas');
+        const schemaSrcPath = path.join(sourcePath, 'schemas');
+        const customSchemaExists = fs.existsSync(schemaDstPath);
+        const pathsToExclude: Set<string> = new Set();
+        if (customSchemaExists) {
+          const sdkExcludePath = await localDisk.glob('sdk.schema', schemaSrcPath);
+          if (sdkExcludePath.length > 0) {
+            pathsToExclude.add(path.join(schemaSrcPath, sdkExcludePath[0]));
+          }
+        }
+        await copyDir(schemaSrcPath, localDisk, schemaDstPath, project.fileStorage, pathsToExclude);
+        const schemaFolderInRuntime = path.join(destPath, 'schemas');
+        await removeDirAndFiles(schemaFolderInRuntime);
+        // install dev dependencies in production, make sure typescript is installed
+        const { stderr: initErr } = await execAsync('npm install && npm install --only=dev', {
+          cwd: destPath,
+        });
+        if (initErr) {
+          composer.log(initErr);
+        }
+        const { stderr: initErr2 } = await execAsync('npm run build', { cwd: destPath });
+        if (initErr2) {
+          throw new Error(initErr2);
+        }
         return destPath;
       } else {
         throw new Error(`Runtime already exists at ${destPath}`);

runtime/node/__tests__/actions.test.ts

@@ -1,12 +1,10 @@
 import * as path from 'path';
+import { ConversationState, MemoryStorage, TestAdapter, TurnContext, useBotState, UserState } from 'botbuilder';
 import { ResourceExplorer } from 'botbuilder-dialogs-declarative';
-import { AdaptiveDialogComponentRegistration } from 'botbuilder-dialogs-adaptive';
-import { TestAdapter, ConversationState, MemoryStorage, UserState } from 'botbuilder';
+import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
 import { ComposerBot } from '../src/shared/composerBot';
 import { SkillConversationIdFactory } from '../src/shared/skillConversationIdFactory';
 import * as helpers from '../src/shared/helpers';
-import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
-import { TurnContext } from 'botbuilder-core';
 
 const samplesDirectory = path.resolve(__dirname, '../../../extensions/samples/assets/projects', 'ActionsSample');
 
@@ -43,7 +41,6 @@ const getSettings = jest.spyOn(helpers, 'getSettings').mockImplementation((root:
 
 beforeAll(() => {
   resourceExplorer.addFolders(samplesDirectory, ['runtime'], false);
-  resourceExplorer.addComponent(new AdaptiveDialogComponentRegistration(resourceExplorer));
   adapter = new TestAdapter(
     async (context: TurnContext): Promise<any> => {
       // Route activity to bot.
@@ -60,6 +57,8 @@ beforeEach(() => {
   // Create shared user state and conversation state instances.
   const userState = new UserState(memoryStorage);
   const conversationState = new ConversationState(memoryStorage);
+  useBotState(adapter, userState, conversationState);
+
   // Create shared skill conversation id factory instance.
   const skillConversationIdFactory = new SkillConversationIdFactory();
   bot = new ComposerBot(userState, conversationState, skillConversationIdFactory);
@@ -232,6 +231,13 @@ describe('test runtime used ActionsSample', () => {
       basicActiivty,
       true
     );
+    const memoryStorage = new MemoryStorage();
+
+    // Create shared user state and conversation state instances.
+    const userState = new UserState(memoryStorage);
+    const conversationState = new ConversationState(memoryStorage);
+    useBotState(adapter, userState, conversationState);
+
     await adapter
       .send(conversationUpdateActivity)
       .assertReply(

runtime/node/__tests__/controllingConversation.test.ts

@@ -1,10 +1,8 @@
 import * as path from 'path';
 import { ResourceExplorer } from 'botbuilder-dialogs-declarative';
-import { AdaptiveDialogComponentRegistration } from 'botbuilder-dialogs-adaptive';
-import { TestAdapter, ConversationState, MemoryStorage, UserState } from 'botbuilder';
+import { ConversationState, MemoryStorage, TestAdapter, TurnContext, useBotState, UserState } from 'botbuilder';
 import { ComposerBot } from '../src/shared/composerBot';
 import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
-import { TurnContext } from 'botbuilder-core';
 import * as helpers from '../src/shared/helpers';
 import { SkillConversationIdFactory } from '../src/shared/skillConversationIdFactory';
 
@@ -47,7 +45,6 @@ let adapter: TestAdapter;
 
 beforeAll(() => {
   resourceExplorer.addFolders(samplesDirectory, ['runtime'], false);
-  resourceExplorer.addComponent(new AdaptiveDialogComponentRegistration(resourceExplorer));
   adapter = new TestAdapter(
     async (context: TurnContext): Promise<any> => {
       // Route activity to bot.
@@ -62,6 +59,8 @@ beforeAll(() => {
   // Create shared user state and conversation state instances.
   const userState = new UserState(memoryStorage);
   const conversationState = new ConversationState(memoryStorage);
+  useBotState(adapter, userState, conversationState);
+
   // Create shared skill conversation id factory instance.
   const skillConversationIdFactory = new SkillConversationIdFactory();
   bot = new ComposerBot(userState, conversationState, skillConversationIdFactory);

runtime/node/__tests__/inputs.test.ts

@@ -1,10 +1,8 @@
 import * as path from 'path';
 import { ResourceExplorer } from 'botbuilder-dialogs-declarative';
-import { AdaptiveDialogComponentRegistration } from 'botbuilder-dialogs-adaptive';
-import { TestAdapter, ConversationState, MemoryStorage, UserState } from 'botbuilder';
+import { ConversationState, MemoryStorage, TestAdapter, TurnContext, useBotState, UserState } from 'botbuilder';
 import { ComposerBot } from '../src/shared/composerBot';
 import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
-import { TurnContext } from 'botbuilder-core';
 import { SkillConversationIdFactory } from '../src/shared/skillConversationIdFactory';
 import * as helpers from '../src/shared/helpers';
 
@@ -46,7 +44,6 @@ let bot: ComposerBot;
 let adapter: TestAdapter;
 beforeAll(() => {
   resourceExplorer.addFolders(samplesDirectory, ['runtime'], false);
-  resourceExplorer.addComponent(new AdaptiveDialogComponentRegistration(resourceExplorer));
   adapter = new TestAdapter(
     async (context: TurnContext): Promise<any> => {
       // Route activity to bot.
@@ -61,6 +58,8 @@ beforeAll(() => {
   // Create shared user state and conversation state instances.
   const userState = new UserState(memoryStorage);
   const conversationState = new ConversationState(memoryStorage);
+  useBotState(adapter, userState, conversationState);
+
   // Create shared skill conversation id factory instance.
   const skillConversationIdFactory = new SkillConversationIdFactory();
   bot = new ComposerBot(userState, conversationState, skillConversationIdFactory);

runtime/node/__tests__/message.test.ts

@@ -1,10 +1,8 @@
 import * as path from 'path';
+import { ConversationState, MemoryStorage, TestAdapter, TurnContext, useBotState, UserState } from 'botbuilder';
 import { ResourceExplorer } from 'botbuilder-dialogs-declarative';
-import { AdaptiveDialogComponentRegistration } from 'botbuilder-dialogs-adaptive';
-import { TestAdapter, ConversationState, MemoryStorage, UserState } from 'botbuilder';
-import { ComposerBot } from '../src/shared/composerBot';
 import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
-import { TurnContext } from 'botbuilder-core';
+import { ComposerBot } from '../src/shared/composerBot';
 import { SkillConversationIdFactory } from '../src/shared/skillConversationIdFactory';
 import * as helpers from '../src/shared/helpers';
 
@@ -39,7 +37,6 @@ let bot: ComposerBot;
 let adapter: TestAdapter;
 beforeAll(() => {
   resourceExplorer.addFolders(samplesDirectory, ['runtime'], false);
-  resourceExplorer.addComponent(new AdaptiveDialogComponentRegistration(resourceExplorer));
   adapter = new TestAdapter(
     async (context: TurnContext): Promise<any> => {
       // Route activity to bot.
@@ -53,6 +50,8 @@ beforeAll(() => {
   // Create shared user state and conversation state instances.
   const userState = new UserState(memoryStorage);
   const conversationState = new ConversationState(memoryStorage);
+  useBotState(adapter, userState, conversationState);
+
   // Create shared skill conversation id factory instance.
   const skillConversationIdFactory = new SkillConversationIdFactory();
   bot = new ComposerBot(userState, conversationState, skillConversationIdFactory);

runtime/node/__tests__/todobot.test.ts

@@ -1,10 +1,8 @@
 import * as path from 'path';
+import { ConversationState, MemoryStorage, TestAdapter, TurnContext, useBotState, UserState } from 'botbuilder';
 import { ResourceExplorer } from 'botbuilder-dialogs-declarative';
-import { AdaptiveDialogComponentRegistration } from 'botbuilder-dialogs-adaptive';
-import { TestAdapter, ConversationState, MemoryStorage, UserState } from 'botbuilder';
-import { ComposerBot } from '../src/shared/composerBot';
 import { ActivityTypes, Activity, ChannelAccount } from 'botframework-schema';
-import { TurnContext } from 'botbuilder-core';
+import { ComposerBot } from '../src/shared/composerBot';
 import { SkillConversationIdFactory } from '../src/shared/skillConversationIdFactory';
 import * as helpers from '../src/shared/helpers';
 
@@ -35,7 +33,6 @@ let bot: ComposerBot;
 let adapter: TestAdapter;
 beforeAll(() => {
   resourceExplorer.addFolders(samplesDirectory, ['runtime'], false);
-  resourceExplorer.addComponent(new AdaptiveDialogComponentRegistration(resourceExplorer));
   adapter = new TestAdapter(
     async (context: TurnContext): Promise<any> => {
       // Route activity to bot.
@@ -49,6 +46,8 @@ beforeAll(() => {
   // Create shared user state and conversation state instances.
   const userState = new UserState(memoryStorage);
   const conversationState = new ConversationState(memoryStorage);
+  useBotState(adapter, userState, conversationState);
+
   // Create shared skill conversation id factory instance.
   const skillConversationIdFactory = new SkillConversationIdFactory();
   bot = new ComposerBot(userState, conversationState, skillConversationIdFactory);

runtime/node/package.json

@@ -16,10 +16,12 @@
   "license": "ISC",
   "dependencies": {
     "@azure/functions": "^1.2.2",
-    "botbuilder": "4.10.0-rc0",
-    "botbuilder-dialogs": "4.10.0-rc0",
-    "botbuilder-dialogs-adaptive": "4.10.0-rc0-preview",
-    "botbuilder-dialogs-declarative": "4.10.0-rc0-preview",
+    "adaptive-expressions": "4.11.0",
+    "botbuilder": "4.11.0",
+    "botbuilder-ai": "4.11.0",
+    "botbuilder-dialogs": "4.11.0",
+    "botbuilder-dialogs-adaptive": "4.11.0-preview",
+    "botbuilder-dialogs-declarative": "4.11.0-preview",
     "debug": "^4.1.1",
     "lodash": "^4.17.19",
     "minimist": "1.2.5",

runtime/node/schemas/readme.md

@@ -0,0 +1,144 @@
+# How to update the schema file
+
+Once the bot has been setup with Composer and we wish to make changes to the schema, the first step in this process is to eject the runtime through the `Runtime Config` in Composer. The ejected runtime folder will broadly have the following structure
+
+```
+bot
+  /bot.dialog
+  /language-generation
+  /language-understanding
+  /dialogs
+     /customized-dialogs
+  /runtime
+  /schemas
+     sdk.schema
+```
+
+##### Prequisites
+
+Botframework CLI > 4.10
+
+```
+npm i -g @microsoft/botframework-cli
+```
+
+> NOTE: Previous versions of botframework-cli required you to install @microsoft/bf-plugin. You will need to uninstall for 4.10 and above.
+>
+> ```
+> bf plugins:uninstall @microsoft/bf-dialog
+> ```
+
+## Adding Custom Actions to your Composer bot for C#
+
+**NOTE: These steps assume you are using azurewebapp as your deployment solution. Replicating it on azurefunctions would be similar
+**
+
+- In this tutorial, we will be going over the steps to include a custom action `MultiplyDialog` that multiplies two numbers passed as inputs. Note that the ejected runtime should contain a `customaction` folder that has this sample.
+
+- Navigate to the csproj file inside the `runtime` folder (bot/runtime/azurewebapp/Microsoft.BotFramework.Composer.WebApp.csproj) and include a project reference to the customaction project like `<ProjectReference Include="..\customaction\Microsoft.BotFramework.Composer.CustomAction.csproj" />`.
+
+- Then Uncomment line 28 and 139 in azurewebapp/Startup.cs file so as to register this action.
+
+```
+
+using Microsoft.BotFramework.Composer.CustomAction;
+// This is for custom action component registration.
+ComponentRegistration.Add(new CustomActionComponentRegistration());
+
+```
+
+- Run the command `dotnet build` on the azurewebapp project to verify if it passes build after adding custom actions to it.
+
+- Navigate to to the `schemas (bot/schemas)` folder. This folder contains a Powershell script and a bash script. Run either of these scripts `./update-schema.ps1 -runtime azurewebapp` or `sh ./update-schema.sh -runtime azurewebapp`. The runtime `azurewebapp` is chosen by default if no argument is passed.
+
+- Validate that the partial schema (MultiplyDialog.schema inside customaction/Schema) has been appended to the default sdk.schema file to generate one single consolidated sdk.schema file.
+
+The above steps should have generated a new sdk.schema file inside `schemas` folder for Composer to use. Reload the bot and you should be able to include your new custom action!
+
+## Adding Custom Actions to your Composer bot for Node.js
+
+- In this tutorial, we will be going over the steps to include a custom action `MultiplyDialog` that multiplies two numbers passed as inputs. Note that the ejected runtime should contain a `customaction` folder that has this sample.
+
+- Uncomment line 30 and 61 in src/shared/composerBot.ts file so as to register this action.
+
+```
+
+import { CustomActionComponentRegistration } from '../customaction/customActionComponentRegistration';
+// This is for custom action component registration, uncomment this to enable custom action support.
+ComponentRegistration.add(new CustomActionComponentRegistration());
+
+```
+
+- Run the command `npm run build` on the runtime to verify if it passes build after adding custom actions to it.
+
+- Navigate to to the `schemas (bot/schemas)` folder. This folder contains a Powershell script and a bash script. Run either of these scripts `./update-schema.ps1` or `sh ./update-schema.sh`.
+
+- Validate that the partial schema (MultiplyDialog.schema inside customaction) has been appended to the default sdk.schema file to generate one single consolidated sdk.schema file.
+
+The above steps should have generated a new sdk.schema file inside `schemas` folder for Composer to use. Reload the bot and you should be able to include your new custom action!
+
+## Customizing Composer using the UI Schema
+
+Composer's UI can be customized using the UI Schema. You can either customize one of your custom actions or override Composer defaults.
+
+There are 2 ways to do this.
+
+1. **Component UI Schema File**
+
+To customize a specific component, simply create a `.uischema` file inside of the `/schemas` directory with the same name as the component, These files will be merged into a single `.uischema` file when running the `update-schema` script.
+
+Example:
+
+```json
+// Microsoft.SendActivity.uischema
+{
+  "$schema": "https://schemas.botframework.com/schemas/ui/v1.0/ui.schema",
+  "form": {
+    "label": "A custom label"
+  }
+}
+```
+
+2. **UI Schema Override File**
+
+This approach allows you to co-locate all of your UI customizations into a single file. This will not be merged into the `sdk.uischema`, instead it will be loaded by Composer and applied as overrides.
+
+Example:
+
+```json
+{
+  "$schema": "https://schemas.botframework.com/schemas/ui/v1.0/ui.schema",
+  "Microsoft.SendActivity": {
+    "form": {
+      "label": "A custom label"
+    }
+  }
+}
+```
+
+#### UI Customization Options
+
+##### Form
+
+| **Property** | **Description**                                                                        | **Type**            | **Default**          |
+| ------------ | -------------------------------------------------------------------------------------- | ------------------- | -------------------- |
+| description  | Text used in tooltips.                                                                 | `string`            | `schema.description` |
+| helpLink     | URI to component or property documentation. Used in tooltips.                          | `string`            |                      |
+| hidden       | An array of property names to hide in the UI.                                          | `string[]`          |                      |
+| label        | Label override. Can either be a string or false to hide the label.                     | `string` \| `false` | `schema.title`       |
+| order        | Set the order of fields. Use "\_" for all other fields. ex. ["foo", "_", "bar"]        | `string[]`          | `[*]`                |
+| placeholder  | Placeholder override.                                                                  | `string`            | `schema.examples`    |
+| properties   | A map of component property names to UI options with customizations for each property. | `object`            |                      |
+| subtitle     | Subtitle rendered in form title.                                                       | `string`            | `schema.$kind`       |
+| widget       | Override default field widget. See list of widgets below.                              | `enum`              |                      |
+
+###### Widgets
+
+- checkbox
+- date
+- datetime
+- input
+- number
+- radio
+- select
+- textarea