@capturebridge/sdk 0.33.0 → 0.34.0

package/Plugin.js

@@ -94,6 +94,14 @@ class Plugin {
     return device ? new Device(device, this, this.baseUrl) : null
   }
 
+  /**
+   * Obtain the JSON schema for a plugin's configuration
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginConfigSchema|GetPluginConfigSchema Endpoint (/plugin/:pluginId/config/schema)}
+   * @example
+   * let schema = await plugin.configSchema()
+   */
   async configSchema () {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -102,6 +110,15 @@ class Plugin {
     return await response.json()
   }
 
+  /**
+   * Obtain a plugin's configuration
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginConfig|GetPluginConfig Endpoint (/plugin/:pluginId/config)}
+   * @returns {object} config - Plugin configuration object
+   * @example
+   * let config = await plugin.config()
+   */
   async config () {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -110,6 +127,18 @@ class Plugin {
     return await response.json()
   }
 
+  /**
+   * Update a plugin's configuration
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-SetPluginConfig|SetPluginConfig Endpoint (/plugin/:pluginId/config)}
+   * @param {object} config - Plugin configuration object
+   * @returns {object} The updated configuration
+   * @example
+   * let config = await plugin.config()
+   * config.knob = 1000
+   * config = await plugin.saveConfig(config)
+   */
   async saveConfig (config) {
     if (!await this.supportsConfig()) {
       throw new Error('Plugin does not support config')
@@ -124,6 +153,7 @@ class Plugin {
     }
     const url = `${this.baseUrl}/plugin/${this.id}/config`
     const response = await fetch(url, options)
+    await checkResponse(response)
     return await response.json()
   }
 

package/README.md

@@ -1,4 +1,4 @@
 # Capture Bridge JavaScript Client SDK
 
-- [SDK Documentation for v0.33.0](https://docs.capturebridge.net/client/sdk/javascript/0.33.0/index.html)
-- [SDK CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.33.0/CHANGELOG.html)
+- [SDK Documentation for v0.34.0](https://docs.capturebridge.net/client/sdk/javascript/0.34.0/index.html)
+- [SDK CHANGELOG](https://docs.capturebridge.net/client/sdk/javascript/0.34.0/CHANGELOG.html)

package/Version.js

@@ -4,5 +4,5 @@
  * @constant
  * @type {string}
  */
-const VERSION = '0.33.0'
+const VERSION = '0.34.0'
 export default VERSION

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Capture Bridge JavaScript client SDK",
   "type": "module",
   "types": "types.d.ts",