Sibling $ref required removed from definition. (#944)

* Sibling $ref required removed from definition.

* Update readme.

Author: Chris McConnell

.vscode/launch.json

@@ -194,12 +194,14 @@
             ],
             "args": [
                 "dialog:merge",
-                "schemas/*.schema",
+                "libraries/**/*.schema",
+                "tests/**/*.schema",
                 "-o",
-                "schemas/app.schema"
+                "tests/tests.schema",
+                "--verbose"
             ],
             "internalConsoleOptions": "openOnSessionStart",
-            "cwd": "${workspaceFolder}/packages/dialog/test/commands/dialog"
+            "cwd": "${workspaceFolder}/../botbuilder-dotnet/"
         },
         {
             "type": "node",

packages/dialog/src/commands/dialog/merge.ts

@@ -7,7 +7,7 @@ import {Command, flags} from '@microsoft/bf-cli-command'
 import SchemaMerger from '../../library/schemaMerger'
 
 export default class DialogMerge extends Command {
-    static description = 'Merge <kind>.schema and <kind>[.<locale>].uischema definitions from a project and its dependencies into a single .schema for describing .dialog files and a per locale .uischema for describing how Composer shows them.  For C#, ensures all nuget declarative resources are included in the same location.'
+    static description = 'Merge `<kind>.schema` and `<kind>[.<locale>].uischema` definitions from a project and its dependencies into a single .schema for describing .dialog files and a per locale .uischema for describing how Composer shows them.  For C#, ensures all nuget declarative resources are included in the same location.'
 
     static args = [
         {name: 'patterns', required: true, description: 'Any number of glob regex patterns to match .csproj, .nuspec or package.json files.'},

packages/dialog/src/library/schemaMerger.ts

@@ -1349,6 +1349,8 @@ export default class SchemaMerger {
 
     // Bundle remote references into schema while pruning to minimally needed definitions.
     // Remote references will be found under definitions/<pathBasename> which must be unique.
+    // There is special code to handle requires siblings to $ref where we remove the requires from
+    // the bundled definition.  This is similar to what JSON schema 8 does.
     private async bundle(schema: any): Promise<void> {
         const current = this.currentFile
         let sources: string[] = []
@@ -1390,6 +1392,11 @@ export default class SchemaMerger {
                             } else if (!elt.$bundled) {
                                 elt.$ref = ref
                                 elt.$bundled = true
+                                if (elt.required) {
+                                    // Strip required from destination
+                                    // This is to support a required sibling to $ref
+                                    delete definition.required
+                                }
                                 if (!definition.$bundled) {
                                     // First outside reference mark it to keep and follow internal $ref
                                     definition.$bundled = true

packages/dialog/test/commands/dialog/nuget/nuget3/1.0.0/Microsoft.Ask.schema

@@ -0,0 +1,34 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
+    "$role": [ "implements(Microsoft.IDialog)", "extends(Microsoft.SendActivity)" ],
+    "title": "Send Activity to Ask a question",
+    "description": "This is an action which sends an activity to the user when a response is expected",
+    "type": "object",
+    "properties": {
+        "expectedProperties": {
+            "$ref": "schema:#/definitions/arrayExpression",
+            "title": "Expected Properties",
+            "description": "Properties expected from the user.",
+            "items": {
+                "type": "string",
+                "title": "Name",
+                "description": "Name of the property"
+            },
+            "examples": [
+                [
+                    "age",
+                    "name"
+                ]
+            ]
+        },
+        "defaultOperation": {
+            "$ref": "schema:#/definitions/stringExpression",
+            "title": "Default Operation",
+            "description": "Sets the default operation that will be used when no operation is recognized in the response to this Ask.",
+            "examples": [
+                "Add()",
+                "Remove()"
+            ]
+        }
+    }
+}

packages/dialog/test/commands/dialog/nuget/nuget3/1.0.0/Microsoft.IActivityTemplate.schema

@@ -0,0 +1,17 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
+    "title": "Microsoft ActivityTemplates",
+    "description": "Components which are ActivityTemplate, which is string template, an activity, or a implementation of ActivityTemplate",
+    "$role": "interface",
+    "oneOf": [
+        {
+            "type": "string"
+        },
+        {
+            "$ref": "https://schemas.botframework.com/schemas/protocol/botframework.json#/definitions/Activity",
+            "required": [
+                "type"
+            ]
+        }
+    ]
+}

packages/dialog/test/commands/dialog/nuget/nuget3/1.0.0/Microsoft.SendActivity.schema

@@ -0,0 +1,27 @@
+{
+    "$schema": "https://schemas.botframework.com/schemas/component/v1.0/component.schema",
+    "$role": "implements(Microsoft.IDialog)",
+    "title": "Send an activity",
+    "description": "Respond with an activity.",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "title": "Id",
+            "description": "Optional id for the dialog"
+        },
+        "disabled": {
+            "$ref": "schema:#/definitions/stringExpression",
+            "title": "Disabled",
+            "description": "Optional condition which if true will disable this action.",
+            "examples": [
+                "user.age > 3"
+            ]
+        },
+        "activity": {
+            "$kind": "Microsoft.IActivityTemplate",
+            "title": "Activity",
+            "description": "Activity to send."
+        }
+    }
+}