@capturebridge/sdk 0.14.1 → 0.15.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.15.0] - 2024-09-25
+
+### Added
+
+- Add `Plugin.hasMethod()` method for checking if a plugin has a specific RPC
+  method.
+- Add suppport for transcoding captured images to gif.
+
 ## [0.14.0] - 2024-09-17
 
 ### Added

package/Common.js

@@ -90,6 +90,7 @@ export const DEFAULT_STREAM_OPT = {
  *
  *  - `jpg`
  *  - `tiff`
+ *  - `gif`
  *
  * If not provided, a plugin or device-specific format will be returned.
  *
@@ -140,6 +141,14 @@ export const DATAURL_JPEG = 'data:image/jpeg;base64,'
  */
 export const DATAURL_PNG = 'data:image/png;base64,'
 
+/**
+ * @summary `data:` prefix for GIF
+ * {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs|Data URLs}
+ * @constant
+ * @type {string}
+ */
+export const DATAURL_GIF = 'data:image/gif;base64,'
+
 /**
  * @summary For a given base64 string, convert it to the appropriate Data URL
  * @constant
@@ -162,6 +171,11 @@ export const base64ToDataURL = base64 => {
     return DATAURL_PNG + base64
   }
 
+  // Check for GIF magic number (47 49 46 38)
+  if (byteArray[0] === 0x47 && byteArray[1] === 0x49 && byteArray[2] === 0x46 && byteArray[3] === 0x38) {
+    return DATAURL_GIF + base64
+  }
+
   throw new Error('Unknown image format provided in Base64 string')
 }
 

package/Plugin.js

@@ -231,6 +231,20 @@ class Plugin {
     asyncToCallback(this, this.update, callback, force)
   }
 
+  /**
+   * Check if a plugin has an RPC method
+   *
+   * @param {string} method - An RPC method
+   * @returns {boolean} Return true if plugin has the provided method.
+   * @example
+   * const canCapture = await plugin.hasMethod('capture')
+   * @method
+   */
+  async hasMethod (method) {
+    await this.update()
+    return this.methods.includes(method)
+  }
+
   async rpc (request) {
     const options = {
       method: 'POST',

package/Version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capturebridge/sdk",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "Capture Bridge JavaScript SDK for web applications",
   "type": "module",
   "types": "types.d.ts",