@capturebridge/sdk 0.12.1 → 0.14.2

package/Plugin.js

@@ -1,299 +1,299 @@
-import Device from './Device.js'
-
-import { BASE_URL, DELETE, checkResponse, asyncToCallback } from './Common.js'
-
-/**
- * @classdesc CaptureBridge utilizes a plugin system for interacting with
- * hardware devices and vendor SDKs. Clients will interact with plugins via the
- * REST API using their unique plugin ID. This class provides basic methods
- * for working with these plugins such as obtaining a list of compatible devices
- * and managing the plugin's configuration.
- *
- * @see {@link CaptureBridge#plugins} Get all installed plugin.
- * @see {@link CaptureBridge#plugin} Get a single plugin by ID.
- */
-class Plugin {
-/**
- * @property {string} id - ID of the plugin, used when building REST endpoint paths.
- * @property {string} name - Human friendly name for the plugin.
- * @property {string} description - Human friendly description of plugin.
- * @property {string} version - {@link https://semver.org/|Semantic version} version of the plugin.
- * @property {string[]} methods - A plugin's list of supported RPC methods.
- * @property {boolean} ready - True if plugin has been loaded into memory and is ready to receive requests.
- * @property {object} defaultDevice - Default device to use for the plugin.
- * @property {string[]} configMethods - Methods required to implement configuration.
- */
-  baseUrl
-  id
-  name
-  description
-  version
-  methods = []
-  ready = false
-  defaultDevice = null
-  configMethods = ['config_schema', 'get_config', 'set_config']
-
-  /**
-   * Instantiate a plugin.
-   * @constructor
-   * @param {object|string} plugin - plugin object as received from the API or a plugin ID string.
-   * @param {string} plugin.id - ID of the plugin, used when building endpoint paths to call methods on the plugin.
-   * @param {string} plugin.name - Human friendly name of plugin.
-   * @param {string} plugin.description - Human friendly description of plugin.
-   * @param {string} plugin.version - {@link https://semver.org/|Semantic version} version of the plugin.
-   * @param {string[]} plugin.methods - plugin's capabilities.
-   * @param {boolean} plugin.ready - True if plugin has been loaded into memory and is ready.
-   * @param {string} [baseURL=BASE_URL] - Override the default protocol, domain, and port for the service.
-   * @throws Will throw an Error the plugin argument is not a plugin ID (String) or an object.
-   */
-  constructor (plugin, baseUrl = BASE_URL) {
-    this.baseUrl = baseUrl
-    if (typeof plugin === 'string') {
-      this.id = plugin
-    } else if (typeof plugin === 'object') {
-      Object.assign(this, {}, plugin)
-    } else {
-      throw new Error('Invalid properties supplied to Plugin constructor')
-    }
-  }
-
-  /**
-   * Get all devices for this plugin
-   *
-   * @method
-   * @async
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @returns {object[]} Array of {@link Device} objects.
-   * @example
-   * const plugin = await captureBridge.plugin('capture_camera_canon')
-   * const devices = await plugin.devices()
-   */
-  async devices () {
-    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/device`)
-    await checkResponse(response)
-    const devices = await response.json()
-    return devices.map(d => new Device(d, this, this.baseUrl))
-  }
-
-  /**
-   * Get all Devices for this plugin
-   *
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * an Array of {@link Device} objects. If no devices are available the second
-   * argument will be an empty Array.
-   * @example
-   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
-   *   plugin.devicesHandler((error, devices) => console.log(devices))
-   * })
-   */
-  devicesHandler (callback) {
-    asyncToCallback(this, this.devices, callback)
-  }
-
-  /**
-   * Get a device by ID for this plugin
-   *
-   * @method
-   * @async
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @param {string} id - Device ID
-   * @returns {object?} Requested {@link Device} or null
-   * @example
-   * const plugin = await captureBridge.plugin('capture_camera_canon')
-   * const device = await plugin.device('AWOOO56709')
-   */
-  async device (id) {
-    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/device`)
-    const devices = await response.json()
-    const device = devices.find(d => d.id === id)
-    return device ? new Device(device, this, this.baseUrl) : null
-  }
-
-  /**
-   * Get a Device by ID for this plugin
-   * @method
-   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
-   * @param {string} id - Device ID
-   * @param {function} callback - Invoked with two arguments. The first argument
-   * is an Error object (if an error occurred) or null. The second argument is
-   * a {@link Device} object. If the requested device is not available the
-   * second argument will be null.
-   * @example
-   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
-   *   plugin.deviceHandler('AWOOO56709', (error, device) => console.log(device))
-   * })
-   */
-  deviceHandler (id, callback) {
-    asyncToCallback(this, this.device, callback, id)
-  }
-
-  async configSchema () {
-    if (!await this.supportsConfig()) {
-      throw new Error('Plugin does not support config')
-    }
-    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/config/schema`)
-    return await response.json()
-  }
-
-  configSchemaHandler (callback) {
-    asyncToCallback(this, this.configSchema, callback)
-  }
-
-  async config () {
-    if (!await this.supportsConfig()) {
-      throw new Error('Plugin does not support config')
-    }
-    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/config`)
-    return await response.json()
-  }
-
-  configHandler (callback) {
-    asyncToCallback(this, this.config, callback)
-  }
-
-  async saveConfig (config) {
-    if (!await this.supportsConfig()) {
-      throw new Error('Plugin does not support config')
-    }
-    const options = {
-      method: 'POST',
-      mode: 'cors',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(config)
-    }
-    const url = `${this.baseUrl}/plugin/${this.id}/config`
-    const response = await fetch(url, options)
-    return await response.json()
-  }
-
-  async saveConfigHandler (config, callback) {
-    asyncToCallback(this, this.saveConfig, callback, config)
-  }
-
-  async supportsConfig () {
-    await this.update()
-    return this.configMethods.every(m => this.methods.includes(m))
-  }
-
-  supportsConfigHandler (callback) {
-    asyncToCallback(this, this.configHandler, callback)
-  }
-
-  async shutdown () {
-    const url = `${this.baseUrl}/plugin/${this.id}`
-    const response = await fetch(url, DELETE)
-    return await response.json()
-  }
-
-  shutdownHandler (callback) {
-    asyncToCallback(this, this.shutdown, callback)
-  }
-
-  async startup () {
-    // See: ValidRD/wa_capture_bridge/issues/48
-    // We need an explicit endpoint for this instead
-    const devices = await this.devices()
-    if (devices) {
-      await this.update(true)
-      return { status: 'starting' }
-    }
-    return { status: 'failed' }
-  }
-
-  startupHandler (callback) {
-    asyncToCallback(this, this.startup, callback)
-  }
-
-  /**
-   * This class can be instantiated from either a plugin ID or a full plugin
-   * object from an API request.
-   * Because constructors cannot be async we use this method to hydrate the
-   * plugin properties if needed.
-   *
-   * @private
-   * @method
-   */
-  async update (force = false) {
-    if (force || this.methods.length === 0) {
-      const response = await fetch(`${this.baseUrl}/plugin`)
-      const plugins = await response.json()
-      const plugin = plugins.find(p => p.id === this.id)
-      Object.assign(this, plugin)
-    }
-  }
-
-  updateHandler (force = false, callback) {
-    asyncToCallback(this, this.update, callback, force)
-  }
-
-  async rpc (request) {
-    const options = {
-      method: 'POST',
-      mode: 'cors',
-      headers: {
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify(request)
-    }
-    const url = `${this.baseUrl}/plugin/${this.id}/rpc`
-    const response = await fetch(url, options)
-    return await response.json()
-  }
-
-  rpcHandler (request, callback) {
-    asyncToCallback(this, this.rpc, callback, request)
-  }
-
-  async ping () {
-    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/ping`)
-    return await response.json()
-  }
-
-  pingHandler (callback) {
-    asyncToCallback(this, this.ping, callback)
-  }
-
-  /**
-   * Classes that extend this one will add their own methods to perform
-   * operations on a device. They will call this method first to get a device
-   * object to use for making calls to the appropriate endpoint.
-   *
-   * This method really should be "protected" in classical OOP terms but
-   * Javascript does not currently have support for such scopes, and it's not
-   * marked using the ES6 private modifier so that it can be inherited by it's
-   * children.
-   * @private
-   * @method
-   */
-  async setupDevice (deviceOpt) {
-    await this.update()
-
-    if (deviceOpt instanceof Device) {
-      this.defaultDevice = deviceOpt
-      return this.defaultDevice
-    }
-
-    if (typeof deviceOpt === 'string') {
-      this.defaultDevice = this.device(deviceOpt)
-      return this.defaultDevice
-    }
-
-    if (!this.defaultDevice) {
-      const devices = await this.devices()
-      if (!devices.length) {
-        throw new Error('No devices found for the plugin')
-      }
-      this.defaultDevice = devices[0]
-      return this.defaultDevice
-    }
-
-    return this.defaultDevice
-  }
-}
-
-export default Plugin
+import Device from './Device.js'
+
+import { BASE_URL, DELETE, checkResponse, asyncToCallback } from './Common.js'
+
+/**
+ * @classdesc CaptureBridge utilizes a plugin system for interacting with
+ * hardware devices and vendor SDKs. Clients will interact with plugins via the
+ * REST API using their unique plugin ID. This class provides basic methods
+ * for working with these plugins such as obtaining a list of compatible devices
+ * and managing the plugin's configuration.
+ *
+ * @see {@link CaptureBridge#plugins} Get all installed plugin.
+ * @see {@link CaptureBridge#plugin} Get a single plugin by ID.
+ */
+class Plugin {
+/**
+ * @property {string} id - ID of the plugin, used when building REST endpoint paths.
+ * @property {string} name - Human friendly name for the plugin.
+ * @property {string} description - Human friendly description of plugin.
+ * @property {string} version - {@link https://semver.org/|Semantic version} version of the plugin.
+ * @property {string[]} methods - A plugin's list of supported RPC methods.
+ * @property {boolean} ready - True if plugin has been loaded into memory and is ready to receive requests.
+ * @property {object} defaultDevice - Default device to use for the plugin.
+ * @property {string[]} configMethods - Methods required to implement configuration.
+ */
+  baseUrl
+  id
+  name
+  description
+  version
+  methods = []
+  ready = false
+  defaultDevice = null
+  configMethods = ['config_schema', 'get_config', 'set_config']
+
+  /**
+   * Instantiate a plugin.
+   * @constructor
+   * @param {object|string} plugin - plugin object as received from the API or a plugin ID string.
+   * @param {string} plugin.id - ID of the plugin, used when building endpoint paths to call methods on the plugin.
+   * @param {string} plugin.name - Human friendly name of plugin.
+   * @param {string} plugin.description - Human friendly description of plugin.
+   * @param {string} plugin.version - {@link https://semver.org/|Semantic version} version of the plugin.
+   * @param {string[]} plugin.methods - plugin's capabilities.
+   * @param {boolean} plugin.ready - True if plugin has been loaded into memory and is ready.
+   * @param {string} [baseURL=BASE_URL] - Override the default protocol, domain, and port for the service.
+   * @throws Will throw an Error the plugin argument is not a plugin ID (String) or an object.
+   */
+  constructor (plugin, baseUrl = BASE_URL) {
+    this.baseUrl = baseUrl
+    if (typeof plugin === 'string') {
+      this.id = plugin
+    } else if (typeof plugin === 'object') {
+      Object.assign(this, {}, plugin)
+    } else {
+      throw new Error('Invalid properties supplied to Plugin constructor')
+    }
+  }
+
+  /**
+   * Get all devices for this plugin
+   *
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
+   * @returns {object[]} Array of {@link Device} objects.
+   * @example
+   * const plugin = await captureBridge.plugin('capture_camera_canon')
+   * const devices = await plugin.devices()
+   */
+  async devices () {
+    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/device`)
+    await checkResponse(response)
+    const devices = await response.json()
+    return devices.map(d => new Device(d, this, this.baseUrl))
+  }
+
+  /**
+   * Get all Devices for this plugin
+   *
+   * @method
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
+   * @param {function} callback - Invoked with two arguments. The first argument
+   * is an Error object (if an error occurred) or null. The second argument is
+   * an Array of {@link Device} objects. If no devices are available the second
+   * argument will be an empty Array.
+   * @example
+   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
+   *   plugin.devicesHandler((error, devices) => console.log(devices))
+   * })
+   */
+  devicesHandler (callback) {
+    asyncToCallback(this, this.devices, callback)
+  }
+
+  /**
+   * Get a device by ID for this plugin
+   *
+   * @method
+   * @async
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
+   * @param {string} id - Device ID
+   * @returns {object?} Requested {@link Device} or null
+   * @example
+   * const plugin = await captureBridge.plugin('capture_camera_canon')
+   * const device = await plugin.device('AWOOO56709')
+   */
+  async device (id) {
+    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/device`)
+    const devices = await response.json()
+    const device = devices.find(d => d.id === id)
+    return device ? new Device(device, this, this.baseUrl) : null
+  }
+
+  /**
+   * Get a Device by ID for this plugin
+   * @method
+   * @see {@link https://local.capturebridge.net:9001/doc/#api-Plugin-GetPluginDevices|API Endpoint (/plugin/:pluginId/device)}
+   * @param {string} id - Device ID
+   * @param {function} callback - Invoked with two arguments. The first argument
+   * is an Error object (if an error occurred) or null. The second argument is
+   * a {@link Device} object. If the requested device is not available the
+   * second argument will be null.
+   * @example
+   * captureBridge.pluginHandler('capture_camera_canon', (error, plugin) => {
+   *   plugin.deviceHandler('AWOOO56709', (error, device) => console.log(device))
+   * })
+   */
+  deviceHandler (id, callback) {
+    asyncToCallback(this, this.device, callback, id)
+  }
+
+  async configSchema () {
+    if (!await this.supportsConfig()) {
+      throw new Error('Plugin does not support config')
+    }
+    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/config/schema`)
+    return await response.json()
+  }
+
+  configSchemaHandler (callback) {
+    asyncToCallback(this, this.configSchema, callback)
+  }
+
+  async config () {
+    if (!await this.supportsConfig()) {
+      throw new Error('Plugin does not support config')
+    }
+    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/config`)
+    return await response.json()
+  }
+
+  configHandler (callback) {
+    asyncToCallback(this, this.config, callback)
+  }
+
+  async saveConfig (config) {
+    if (!await this.supportsConfig()) {
+      throw new Error('Plugin does not support config')
+    }
+    const options = {
+      method: 'POST',
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(config)
+    }
+    const url = `${this.baseUrl}/plugin/${this.id}/config`
+    const response = await fetch(url, options)
+    return await response.json()
+  }
+
+  async saveConfigHandler (config, callback) {
+    asyncToCallback(this, this.saveConfig, callback, config)
+  }
+
+  async supportsConfig () {
+    await this.update()
+    return this.configMethods.every(m => this.methods.includes(m))
+  }
+
+  supportsConfigHandler (callback) {
+    asyncToCallback(this, this.configHandler, callback)
+  }
+
+  async shutdown () {
+    const url = `${this.baseUrl}/plugin/${this.id}`
+    const response = await fetch(url, DELETE)
+    return await response.json()
+  }
+
+  shutdownHandler (callback) {
+    asyncToCallback(this, this.shutdown, callback)
+  }
+
+  async startup () {
+    // See: ValidRD/wa_capture_bridge/issues/48
+    // We need an explicit endpoint for this instead
+    const devices = await this.devices()
+    if (devices) {
+      await this.update(true)
+      return { status: 'starting' }
+    }
+    return { status: 'failed' }
+  }
+
+  startupHandler (callback) {
+    asyncToCallback(this, this.startup, callback)
+  }
+
+  /**
+   * This class can be instantiated from either a plugin ID or a full plugin
+   * object from an API request.
+   * Because constructors cannot be async we use this method to hydrate the
+   * plugin properties if needed.
+   *
+   * @private
+   * @method
+   */
+  async update (force = false) {
+    if (force || this.methods.length === 0) {
+      const response = await fetch(`${this.baseUrl}/plugin`)
+      const plugins = await response.json()
+      const plugin = plugins.find(p => p.id === this.id)
+      Object.assign(this, plugin)
+    }
+  }
+
+  updateHandler (force = false, callback) {
+    asyncToCallback(this, this.update, callback, force)
+  }
+
+  async rpc (request) {
+    const options = {
+      method: 'POST',
+      mode: 'cors',
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(request)
+    }
+    const url = `${this.baseUrl}/plugin/${this.id}/rpc`
+    const response = await fetch(url, options)
+    return await response.json()
+  }
+
+  rpcHandler (request, callback) {
+    asyncToCallback(this, this.rpc, callback, request)
+  }
+
+  async ping () {
+    const response = await fetch(`${this.baseUrl}/plugin/${this.id}/ping`)
+    return await response.json()
+  }
+
+  pingHandler (callback) {
+    asyncToCallback(this, this.ping, callback)
+  }
+
+  /**
+   * Classes that extend this one will add their own methods to perform
+   * operations on a device. They will call this method first to get a device
+   * object to use for making calls to the appropriate endpoint.
+   *
+   * This method really should be "protected" in classical OOP terms but
+   * Javascript does not currently have support for such scopes, and it's not
+   * marked using the ES6 private modifier so that it can be inherited by it's
+   * children.
+   * @private
+   * @method
+   */
+  async setupDevice (deviceOpt) {
+    await this.update()
+
+    if (deviceOpt instanceof Device) {
+      this.defaultDevice = deviceOpt
+      return this.defaultDevice
+    }
+
+    if (typeof deviceOpt === 'string') {
+      this.defaultDevice = this.device(deviceOpt)
+      return this.defaultDevice
+    }
+
+    if (!this.defaultDevice) {
+      const devices = await this.devices()
+      if (!devices.length) {
+        throw new Error('No devices found for the plugin')
+      }
+      this.defaultDevice = devices[0]
+      return this.defaultDevice
+    }
+
+    return this.defaultDevice
+  }
+}
+
+export default Plugin

package/README.md

@@ -1,3 +1,3 @@
-# Capture Bridge JavaScript SDK
-
-See `CHANGELOG.md` for new features and breaking changes.
+# Capture Bridge JavaScript SDK
+
+See `CHANGELOG.md` for new features and breaking changes.