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

Comparing version 2.2.0 to 3.0.0

bot.schema.d.ts

@@ -12,3 +12,3 @@ export declare namespace BotsSchema {
      */
-    export type BotEngine = AwsLexEngine | DialogflowEngine;
+    export type BotEngine = AwsLexEngine | DialogflowEngine | WatsonEngine;
     /**
@@ -33,2 +33,9 @@ * This interface was referenced by `BotConfig`'s JSON-Schema
      * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-engine-settings".
+     */
+    export type WatsonEngineSettings =
+        | WatsonEngineSettingsV1
+        | WatsonEngineSettingsV2;
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
      * via the `definition` "aws-polly-voice".
@@ -146,2 +153,7 @@ */
      * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-api-version".
+     */
+    export type WatsonApiVersion = '2018-02-16' | '2018-09-19';
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
      * via the `definition` "bot-engine-settings".
@@ -151,3 +163,4 @@ */
         | AwsLexEngineSettings
-        | DialogflowEngineSettings;
+        | DialogflowEngineSettings
+        | WatsonEngineSettings;
     /**
@@ -160,3 +173,5 @@ * This interface was referenced by `BotConfig`'s JSON-Schema
         | WebchatChannelSettings
-        | FacebookChannelSettings;
+        | FacebookChannelSettings
+        | KikChannelSettings
+        | SlackChannelSettings;
 
@@ -254,2 +269,44 @@ export interface BotConfig {
      * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-engine".
+     */
+    export interface WatsonEngine {
+        service: 'watson';
+        label?: AdapterLabel;
+        hidden?: boolean;
+        settings: WatsonEngineSettings;
+        [k: string]: any;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-engine-settings-v1".
+     */
+    export interface WatsonEngineSettingsV1 {
+        apiVersion: '2018-02-16';
+        watsonCredentials: WatsonCredentials;
+        workspaceId: string;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-credentials".
+     */
+    export interface WatsonCredentials {
+        apikey?: string;
+        iam_apikey_description?: string;
+        iam_apikey_name?: string;
+        iam_role_crn?: string;
+        iam_serviceid_crn?: string;
+        url?: string;
+        [k: string]: any;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
+     * via the `definition` "watson-engine-settings-v2".
+     */
+    export interface WatsonEngineSettingsV2 {
+        apiVersion: '2018-09-19';
+        watsonCredentials: WatsonCredentials;
+        assistantId: string;
+    }
+    /**
+     * This interface was referenced by `BotConfig`'s JSON-Schema
      * via the `definition` "bot-options".
@@ -315,2 +372,3 @@ */
         awsCredentials?: AwsCredentials;
+        icon?: string | null;
     }
@@ -317,0 +375,0 @@ /**

bot.schema.json

@@ -150,2 +150,15 @@ {
         },
+        "watson-credentials": {
+            "$comment": "object containing required settings for using watson services",
+            "type": "object",
+            "properties": {
+                "apikey": { "type": "string" },
+                "iam_apikey_description": { "type": "string" },
+                "iam_apikey_name": { "type": "string" },
+                "iam_role_crn": { "type": "string" },
+                "iam_serviceid_crn": { "type": "string" },
+                "url": { "type": "string" }
+            },
+            "required": [ "apikey", "iam_apikey_description", "iam_apikey_name", "iam_role_crn", "iam_serviceid_crn", "url" ]
+        },
         "dialogflow-api-version": {
@@ -155,2 +168,6 @@ "type": "string",
         },
+        "watson-api-version": {
+            "type": "string",
+            "enum": [ "2018-02-16", "2018-09-19" ]
+        },
         "aws-lex-engine": {
@@ -215,2 +232,41 @@ "$comment": "bot engine powered by the amazon-lex service",
         },
+        "watson-engine": {
+            "$comment": "bot engine powered by the watson service",
+            "type": "object",
+            "properties": {
+                "service": { "enum": [ "watson" ] },
+                "label": { "$ref": "#/definitions/adapter-label" },
+                "hidden": { "type": "boolean", "default": false },
+                "settings": { "$ref": "#/definitions/watson-engine-settings" }
+            },
+            "required": [ "service", "settings" ]
+        },
+        "watson-engine-settings": {
+            "$comment": "settings for the watson engine",
+            "required": [ "apiVersion", "watsonCredentials" ],
+            "oneOf": [
+                { "$ref": "#/definitions/watson-engine-settings-v1" },
+                { "$ref": "#/definitions/watson-engine-settings-v2" }
+            ]
+        },
+        "watson-engine-settings-v1": {
+            "$comment": "settings for the watson engine",
+            "properties": {
+                "apiVersion": { "enum": [ "2018-02-16" ] },
+                "watsonCredentials": { "$ref": "#/definitions/watson-credentials" },
+                "workspaceId": { "type": "string" }
+            },
+            "required": [ "apiVersion", "watsonCredentials", "workspaceId" ],
+            "additionalProperties": false
+        },
+        "watson-engine-settings-v2": {
+            "$comment": "settings for the watson engine",
+            "properties": {
+                "apiVersion": { "enum": [ "2018-09-19" ] },
+                "watsonCredentials": { "$ref": "#/definitions/watson-credentials" },
+                "assistantId": { "type": "string" }
+            },
+            "required": [ "apiVersion", "watsonCredentials", "assistantId" ],
+            "additionalProperties": false
+        },
         "api-channel": {
@@ -265,3 +321,4 @@ "$comment": "bot channel powered by an API (for now, StaMP)",
                 "awsRegion": { "$ref": "#/definitions/aws-region-polly" },
-                "awsCredentials": { "$ref": "#/definitions/aws-credentials" }
+                "awsCredentials": { "$ref": "#/definitions/aws-credentials" },
+                "icon": { "type": [ "string", "null" ] }
             },
@@ -357,3 +414,4 @@ "required": [ "authToken" ],
                 { "$ref": "#/definitions/aws-lex-engine" },
-                { "$ref": "#/definitions/dialogflow-engine" }
+                { "$ref": "#/definitions/dialogflow-engine" },
+                { "$ref": "#/definitions/watson-engine" }
             ]
@@ -366,3 +424,4 @@ },
                 { "$ref": "#/definitions/aws-lex-engine-settings" },
-                { "$ref": "#/definitions/dialogflow-engine-settings" }
+                { "$ref": "#/definitions/dialogflow-engine-settings" },
+                { "$ref": "#/definitions/watson-engine-settings" }
             ]
@@ -369,0 +428,0 @@ },

CHANGELOG.md

@@ -9,2 +9,12 @@ # Changelog
 
+## [3.0.0] - 2018-10-24
+
+### Added
+ - Support for IBM Watson.
+
+## [2.3.0] - 2018-10-19
+
+### Added
+ - Optional `'icon'` property to `webchat-channel-settings` object property.
+
 ## [2.2.0] - 2018-09-03
@@ -11,0 +21,0 @@

composer.json

@@ -5,3 +5,3 @@ {
     "homepage": "https://github.com/zwerm/bot-configs-schema#readme",
-    "time": "2018-09-03",
+    "time": "2018-10-24",
     "license": "MIT",
@@ -8,0 +8,0 @@ "authors": [

package.json

 {
     "name": "@zwerm/bot-configs-schema",
-    "version": "2.2.0",
+    "version": "3.0.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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

52441

increased by9.32%

Lines of code

1263

increased by10.21%

Worsened metrics

Number of package files

17

decreased by-5.56%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes