fix: throw correct error code for unimplemented methods (#316)

Author: robingenz

.changeset/huge-monkeys-return.md

@@ -0,0 +1,8 @@
+---
+'@capacitor-mlkit/face-mesh-detection': major
+'@capacitor-mlkit/selfie-segmentation': major
+'@capacitor-mlkit/barcode-scanning': major
+'@capacitor-mlkit/face-detection': major
+---
+
+fix: throw correct error code for unimplemented methods

packages/barcode-scanning/BREAKING.md

@@ -15,6 +15,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 This plugin now supports **Capacitor 8**. The minimum Android SDK version is **36**. Ensure your project meets these requirements before upgrading.
 
+### Error codes
+
+On **Web**, unimplemented methods now throw an error with code `Unimplemented` instead of `Unavailable`.
+
 ### Variables
 
 - On Android, the `androidxCameraCamera2Version` variable has been updated to `1.5.2`.

packages/barcode-scanning/src/web.ts

@@ -40,7 +40,7 @@ export class BarcodeScannerWeb
 
   async startScan(options?: StartScanOptions): Promise<void> {
     if (!this._isSupported) {
-      throw this.createUnavailableException();
+      throw this.createUnimplementedException();
     }
     if (!options?.videoElement) {
       throw new Error(this.errorVideoElementMissing);
@@ -73,7 +73,7 @@ export class BarcodeScannerWeb
 
   async stopScan(): Promise<void> {
     if (!this._isSupported) {
-      throw this.createUnavailableException();
+      throw this.createUnimplementedException();
     }
     if (this.intervalId) {
       clearInterval(this.intervalId);
@@ -92,63 +92,63 @@ export class BarcodeScannerWeb
   async readBarcodesFromImage(
     _options: ReadBarcodesFromImageOptions,
   ): Promise<ReadBarcodesFromImageResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async scan(): Promise<ScanResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async isSupported(): Promise<IsSupportedResult> {
     return { supported: this._isSupported };
   }
 
   async enableTorch(): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async disableTorch(): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async toggleTorch(): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async isTorchEnabled(): Promise<IsTorchEnabledResult> {
-    throw this.createUnavailableException;
+    throw this.createUnimplementedException();
   }
 
   async isTorchAvailable(): Promise<IsTorchAvailableResult> {
     return { available: false };
   }
 
   async setZoomRatio(_options: SetZoomRatioOptions): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async getZoomRatio(): Promise<GetZoomRatioResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async getMinZoomRatio(): Promise<GetMinZoomRatioResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async getMaxZoomRatio(): Promise<GetMaxZoomRatioResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async openSettings(): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async isGoogleBarcodeScannerModuleAvailable(): Promise<IsGoogleBarcodeScannerModuleAvailableResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async installGoogleBarcodeScannerModule(): Promise<void> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
   async checkPermissions(): Promise<PermissionStatus> {
@@ -180,10 +180,10 @@ export class BarcodeScannerWeb
     }
   }
 
-  private createUnavailableException(): CapacitorException {
+  private createUnimplementedException(): CapacitorException {
     return new CapacitorException(
-      'This plugin method is not available on this platform.',
-      ExceptionCode.Unavailable,
+      'This method is not implemented on web.',
+      ExceptionCode.Unimplemented,
     );
   }
 

packages/face-detection/BREAKING.md

@@ -14,6 +14,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 This plugin now supports **Capacitor 8**. The minimum Android SDK version is **36**. Ensure your project meets these requirements before upgrading.
 
+### Error codes
+
+On **Web**, unimplemented methods now throw an error with code `Unimplemented` instead of `Unavailable`.
+
 ## Version 7.x.x
 
 ### Variables

packages/face-detection/src/web.ts

@@ -10,13 +10,13 @@ export class FaceDetectionWeb extends WebPlugin implements FaceDetectionPlugin {
   public async processImage(
     _options: ProcessImageOptions,
   ): Promise<ProcessImageResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
-  private createUnavailableException(): CapacitorException {
+  private createUnimplementedException(): CapacitorException {
     return new CapacitorException(
-      'This Face Detection plugin method is not available on this platform.',
-      ExceptionCode.Unavailable,
+      'This method is not implemented on web.',
+      ExceptionCode.Unimplemented,
     );
   }
 }

packages/face-mesh-detection/BREAKING.md

@@ -13,6 +13,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 This plugin now supports **Capacitor 8**. The minimum Android SDK version is **36**. Ensure your project meets these requirements before upgrading.
 
+### Error codes
+
+On **Web**, unimplemented methods now throw an error with code `Unimplemented` instead of `Unavailable`.
+
 ## Version 6.x.x
 
 ### Variables

packages/face-mesh-detection/src/web.ts

@@ -13,13 +13,13 @@ export class FaceMeshDetectionWeb
   public async processImage(
     _options: ProcessImageOptions,
   ): Promise<ProcessImageResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
-  private createUnavailableException(): CapacitorException {
+  private createUnimplementedException(): CapacitorException {
     return new CapacitorException(
-      'This Face Mesh Detection plugin method is not available on this platform.',
-      ExceptionCode.Unavailable,
+      'This method is not implemented on web.',
+      ExceptionCode.Unimplemented,
     );
   }
 }

packages/selfie-segmentation/BREAKING.md

@@ -14,6 +14,10 @@ This is a comprehensive list of the breaking changes introduced in the major ver
 
 This plugin now supports **Capacitor 8**. The minimum Android SDK version is **36**. Ensure your project meets these requirements before upgrading.
 
+### Error codes
+
+On **Web**, unimplemented methods now throw an error with code `Unimplemented` instead of `Unavailable`.
+
 ## Version 7.x.x
 
 ### Variables

packages/selfie-segmentation/src/web.ts

@@ -13,13 +13,13 @@ export class SelfieSegmentationWeb
   public async processImage(
     _options: ProcessImageOptions,
   ): Promise<ProcessImageResult> {
-    throw this.createUnavailableException();
+    throw this.createUnimplementedException();
   }
 
-  private createUnavailableException(): CapacitorException {
+  private createUnimplementedException(): CapacitorException {
     return new CapacitorException(
-      'This Selfie Segmentation plugin method is not available on this platform.',
-      ExceptionCode.Unavailable,
+      'This method is not implemented on web.',
+      ExceptionCode.Unimplemented,
     );
   }
 }