@capturebridge/sdk 0.38.1 → 0.39.0

package/README.md

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

package/Version.js

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

package/Webcam.js

@@ -0,0 +1,45 @@
+import CaptureBridge from './CaptureBridge.js'
+import Camera from './Camera.js'
+import { BASE_URL } from './Common.js'
+
+/**
+ * Webcam
+ * @classdesc Convenience class for instantiating a Webcam Object.
+ * Inherits all methods on the {@link Camera} class.
+ * @extends Camera
+ * @see {@link Camera}
+ */
+class Webcam extends Camera {
+  /**
+   * Instantiate a Webcam
+   * @constructor
+   * @param {string} pluginId - The Id of the desired plugin to use for this
+   * webcam instance. The plugin must support the `start_feed`, `stop_feed`,
+   * `devices`, and `capture` methods.
+   * @param {string} [baseURL] - Protocol, domain, and port for the service.
+   * @example
+   * const webcam = new Webcam('capture_webcam_windows')
+   */
+  constructor (pluginId, baseUrl = BASE_URL) {
+    super(pluginId, baseUrl)
+  }
+}
+
+export default Webcam
+
+/**
+ * Instantiate this Capture Bridge instance's Webcam plugin
+ * @constructor
+ * @param {string} [baseURL] - Protocol, domain, and port for the service.
+ * @example
+ * const webcam = await WebcamFactory()
+ */
+export const WebcamFactory = async (baseUrl = BASE_URL) => {
+  const cb = new CaptureBridge(baseUrl)
+  const plugins = await cb.plugins()
+  const plugin = plugins.find(p => p.id.includes('capture_webcam_'))
+  if (!plugin) {
+    throw new Error('No webcam plugin found')
+  }
+  return new Webcam(plugin, baseUrl)
+}

package/package.json

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

package/types.d.ts

@@ -164,6 +164,11 @@ declare module '@capturebridge/sdk/TextInput' {
   export default TextInput;
 }
 
+declare module '@capturebridge/sdk/Webcam' {
+  const Webcam: any;
+  export default Webcam;
+}
+
 declare module '@capturebridge/sdk/WindowsScanner' {
   const WindowsScanner: any;
   export default WindowsScanner;