@zwerm/bot-configs-schema - npm Package Compare versions

Comparing version 2.1.0 to 2.2.0

bot.schema.d.ts

@@ -22,3 +22,3 @@ export declare namespace BotsSchema {
      */
-    export type AwsRegionLex = 'us-east-1' | 'eu-west-1';
+    export type AwsRegionLex = 'us-east-1' | 'us-west-2' | 'eu-west-1';
     /**
@@ -116,3 +116,4 @@ * This interface was referenced by `BotConfig`'s JSON-Schema
         | FacebookChannel
-        | KikChannel;
+        | KikChannel
+        | SlackChannel;
     /**
@@ -255,2 +256,4 @@ * This interface was referenced by `BotConfig`'s JSON-Schema
         defaultConversationLifetime?: number;
+        icon?: string | null;
+        supportedSystemEvents?: string[];
         awsVoice?: AwsPollyVoice;
@@ -358,2 +361,20 @@ awsRegion?: AwsRegionPolly;
      * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "slack-channel".
+     */
+    export interface SlackChannel {
+        service: 'slack';
+        label?: AdapterLabel;
+        hidden?: boolean;
+        settings: SlackChannelSettings;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "slack-channel-settings".
+     */
+    export interface SlackChannelSettings {
+        botUserToken: string;
+        signingSecret: string;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
      * via the `definition` "bots".
@@ -360,0 +381,0 @@ */

bot.schema.json

@@ -305,3 +305,3 @@ {
         "kik-channel-settings": {
-            "$comment": "settings for the botsocket channel",
+            "$comment": "settings for the kik channel",
             "type": "object",
@@ -322,2 +322,24 @@ "properties": {
         },
+        "slack-channel": {
+            "$comment": "bot channel powered by Slack",
+            "type": "object",
+            "properties": {
+                "service": { "enum": [ "slack" ] },
+                "label": { "$ref": "#/definitions/adapter-label" },
+                "hidden": { "type": "boolean" },
+                "settings": { "$ref": "#/definitions/slack-channel-settings" }
+            },
+            "required": [ "service", "settings" ],
+            "additionalProperties": false
+        },
+        "slack-channel-settings": {
+            "$comment": "settings for the Slack channel",
+            "type": "object",
+            "properties": {
+                "botUserToken": { "type": "string" },
+                "signingSecret": { "type": "string" }
+            },
+            "required": [ "botUserToken", "signingSecret" ],
+            "additionalProperties": false
+        },
         "bot-engines": {
@@ -355,2 +377,7 @@ "$comment": "the possible engines a bot can have",
                 },
+                "icon": { "type": [ "string", "null" ] },
+                "supportedSystemEvents": {
+                    "type": [ "array", "null" ],
+                    "items": { "type": "string" }
+                },
                 "awsVoice": { "$ref": "#/definitions/aws-polly-voice" },
@@ -374,3 +401,4 @@ "awsRegion": { "$ref": "#/definitions/aws-region-polly" },
                 { "$ref": "#/definitions/facebook-channel" },
-                { "$ref": "#/definitions/kik-channel" }
+                { "$ref": "#/definitions/kik-channel" },
+                { "$ref": "#/definitions/slack-channel" }
             ]
@@ -384,3 +412,5 @@ },
                 { "$ref": "#/definitions/webchat-channel-settings" },
-                { "$ref": "#/definitions/facebook-channel-settings" }
+                { "$ref": "#/definitions/facebook-channel-settings" },
+                { "$ref": "#/definitions/kik-channel-settings" },
+                { "$ref": "#/definitions/slack-channel-settings" }
             ]
@@ -387,0 +417,0 @@ },

CHANGELOG.md

@@ -9,2 +9,9 @@ # Changelog
 
+## [2.2.0] - 2018-09-03
+
+### Added
+ - Optional `'icon'` property to `options` object property.
+ - Optional `'supportedSystemEvents'` property to `options` object property.
+ - Slack configuration support
+
 ## [2.1.0] - 2018-07-17
@@ -11,0 +18,0 @@

composer.json

@@ -5,3 +5,3 @@ {
     "homepage": "https://github.com/zwerm/bot-configs-schema#readme",
-    "time": "2018-07-17",
+    "time": "2018-09-03",
     "license": "MIT",
@@ -16,3 +16,3 @@ "authors": [
         "branch-alias": {
-            "dev-master": "2.0.x-dev"
+            "dev-master": "2.2.x-dev"
         }
@@ -19,0 +19,0 @@ },

package.json

 {
     "name": "@zwerm/bot-configs-schema",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "Zwerm schema for bot configurations",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/zwerm/bot-configs-schema#readme",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47970

increased by4.7%

Lines of code

1146

increased by4.66%

No dependency changes