@unif/react-native-hms-scan 0.1.0

package/android/src/main/java/com/unif/reactnativehmsscan/HmsScanView.kt

@@ -0,0 +1,257 @@
+package com.unif.reactnativehmsscan
+
+import android.app.Activity
+import android.content.Context
+import android.os.Bundle
+import android.widget.FrameLayout
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.LifecycleEventListener
+import com.facebook.react.bridge.WritableMap
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.UIManagerHelper
+import com.facebook.react.uimanager.events.Event
+import com.huawei.hms.hmsscankit.OnLightVisibleCallBack
+import com.huawei.hms.hmsscankit.OnResultCallback
+import com.huawei.hms.hmsscankit.RemoteView
+import com.huawei.hms.ml.scan.HmsScan
+
+/**
+ * Fabric view "HmsScanView". A FrameLayout that hosts HUAWEI Scan Kit's
+ * [RemoteView] (a blank camera preview). Scanning UI (viewfinder, torch button,
+ * etc.) is drawn on top by the JS layer; this view only renders the preview and
+ * emits scan/torch/error events.
+ *
+ * RemoteView is built lazily on first attach (so all initial props are known) and
+ * rebuilt when its build-time props (formatsCsv / continuous) change. Lifecycle is
+ * forwarded both from the View attach/detach callbacks and from the host
+ * Activity's lifecycle via [LifecycleEventListener].
+ */
+class HmsScanView(context: Context) :
+  FrameLayout(context), LifecycleEventListener {
+
+  private val themedReactContext: ThemedReactContext = context as ThemedReactContext
+
+  private var remoteView: RemoteView? = null
+
+  // Build-time props (require a RemoteView rebuild when changed).
+  private var formatsCsv: String = ""
+  private var continuous: Boolean = true
+
+  // Runtime props (applied to the live RemoteView; stashed until it exists).
+  private var paused: Boolean = false
+  private var torch: Boolean = false
+
+  // True while this view is between onAttachedToWindow and onDetachedFromWindow.
+  private var attached: Boolean = false
+
+  init {
+    themedReactContext.addLifecycleEventListener(this)
+  }
+
+  // ── Props (called from the ViewManager) ───────────────────────────────────
+
+  fun setFormatsCsv(value: String?) {
+    val next = value ?: ""
+    if (next == formatsCsv && remoteView != null) return
+    formatsCsv = next
+    rebuildIfAttached()
+  }
+
+  fun setContinuous(value: Boolean) {
+    if (value == continuous && remoteView != null) return
+    continuous = value
+    rebuildIfAttached()
+  }
+
+  fun setPaused(value: Boolean) {
+    paused = value
+    applyPaused()
+  }
+
+  fun setTorch(value: Boolean) {
+    torch = value
+    applyTorch()
+  }
+
+  // ── View lifecycle ────────────────────────────────────────────────────────
+
+  override fun onAttachedToWindow() {
+    super.onAttachedToWindow()
+    attached = true
+    if (remoteView == null) {
+      buildRemoteView()
+    }
+    remoteView?.let {
+      it.onStart()
+      it.onResume()
+    }
+  }
+
+  override fun onDetachedFromWindow() {
+    super.onDetachedFromWindow()
+    attached = false
+    teardownRemoteView()
+  }
+
+  // ── Host (Activity) lifecycle ─────────────────────────────────────────────
+
+  override fun onHostResume() {
+    if (attached) {
+      remoteView?.onResume()
+    }
+  }
+
+  override fun onHostPause() {
+    remoteView?.onPause()
+  }
+
+  override fun onHostDestroy() {
+    teardownRemoteView()
+    themedReactContext.removeLifecycleEventListener(this)
+  }
+
+  // ── RemoteView build / teardown ───────────────────────────────────────────
+
+  private fun buildRemoteView() {
+    val activity = resolveActivity()
+    if (activity == null) {
+      emitError(
+        "E_CAMERA_INIT",
+        "Cannot start camera: no host Activity available for RemoteView"
+      )
+      return
+    }
+
+    try {
+      val builder = RemoteView.Builder()
+        .setContext(activity)
+        .setContinuouslyScan(continuous)
+
+      val types = HmsScanResultMapper.parseFormatsCsv(formatsCsv)
+      if (types != null && types.isNotEmpty()) {
+        val first = types.first()
+        val rest = if (types.size > 1) types.copyOfRange(1, types.size) else IntArray(0)
+        builder.setFormat(first, *rest)
+      } else {
+        builder.setFormat(HmsScan.ALL_SCAN_TYPE)
+      }
+
+      val view = builder.build()
+
+      view.setOnResultCallback(OnResultCallback { result -> onScanResult(result) })
+      view.setOnLightVisibleCallback(
+        OnLightVisibleCallBack { visible -> onTorchVisible(visible) }
+      )
+
+      // onCreate must run after build() and before addView (per HMS docs/demo).
+      view.onCreate(Bundle())
+      addView(
+        view,
+        LayoutParams(LayoutParams.MATCH_PARENT, LayoutParams.MATCH_PARENT)
+      )
+
+      remoteView = view
+
+      // Apply runtime props that may have arrived before the view existed.
+      applyPaused()
+      applyTorch()
+    } catch (e: Throwable) {
+      emitError("E_CAMERA_INIT", e.message ?: "Failed to initialize camera")
+    }
+  }
+
+  private fun teardownRemoteView() {
+    val view = remoteView ?: return
+    try {
+      view.onPause()
+      view.onStop()
+      view.onDestroy()
+    } catch (_: Throwable) {
+      // Defensive: never let teardown crash the host.
+    }
+    removeView(view)
+    remoteView = null
+  }
+
+  /** Rebuild the RemoteView in place to honour a changed build-time prop. */
+  private fun rebuildIfAttached() {
+    if (!attached) return
+    teardownRemoteView()
+    buildRemoteView()
+    remoteView?.let {
+      it.onStart()
+      it.onResume()
+    }
+  }
+
+  private fun applyPaused() {
+    val view = remoteView ?: return
+    try {
+      if (paused) {
+        view.pauseContinuouslyScan()
+      } else {
+        view.resumeContinuouslyScan()
+      }
+    } catch (_: Throwable) {
+      // Ignore: only meaningful in continuous mode.
+    }
+  }
+
+  private fun applyTorch() {
+    val view = remoteView ?: return
+    try {
+      // switchLight() toggles; only flip when the current state differs from target.
+      if (view.lightStatus != torch) {
+        view.switchLight()
+      }
+    } catch (_: Throwable) {
+      // Ignore: device may have no flash.
+    }
+  }
+
+  /** Resolve the hosting Activity required by RemoteView.Builder.setContext(). */
+  private fun resolveActivity(): Activity? = themedReactContext.currentActivity
+
+  // ── Scan Kit callbacks → Fabric events ────────────────────────────────────
+
+  private fun onScanResult(result: Array<HmsScan?>?) {
+    // Drop empty callbacks (continuous mode can fire with nothing useful).
+    if (result == null || result.isEmpty()) return
+    val json = HmsScanResultMapper.toJson(result)
+    // toJson skips value-less hits; avoid emitting an empty "[]" event.
+    if (json == "[]") return
+    emitEvent("topScanResult", Arguments.createMap().apply {
+      putString("resultsJson", json)
+    })
+  }
+
+  private fun onTorchVisible(visible: Boolean) {
+    // Keep our cached torch flag in sync with the actual hardware state.
+    val on = remoteView?.lightStatus ?: torch
+    torch = on
+    emitEvent("topTorchStatus", Arguments.createMap().apply {
+      putBoolean("available", visible)
+      putBoolean("on", on)
+    })
+  }
+
+  private fun emitError(code: String, message: String) {
+    emitEvent("topScanError", Arguments.createMap().apply {
+      putString("code", code)
+      putString("message", message)
+    })
+  }
+
+  // ── Fabric event dispatch ──────────────────────────────────────────────────
+
+  private fun emitEvent(eventName: String, payload: WritableMap) {
+    val reactTag = id
+    val dispatcher =
+      UIManagerHelper.getEventDispatcherForReactTag(themedReactContext, reactTag)
+    val surfaceId = themedReactContext.surfaceId
+    dispatcher?.dispatchEvent(object : Event<Event<*>>(surfaceId, reactTag) {
+      override fun getEventName(): String = eventName
+      override fun getEventData(): WritableMap = payload
+    })
+  }
+}

package/android/src/main/java/com/unif/reactnativehmsscan/HmsScanViewManager.kt

@@ -0,0 +1,66 @@
+package com.unif.reactnativehmsscan
+
+import com.facebook.react.module.annotations.ReactModule
+import com.facebook.react.uimanager.SimpleViewManager
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.ViewManagerDelegate
+import com.facebook.react.uimanager.annotations.ReactProp
+import com.facebook.react.viewmanagers.HmsScanViewManagerInterface
+import com.facebook.react.viewmanagers.HmsScanViewManagerDelegate
+
+/**
+ * Fabric ViewManager for "HmsScanView". Delegates prop dispatch to the
+ * codegen-generated [HmsScanViewManagerDelegate] and forwards each prop to the
+ * underlying [HmsScanView].
+ */
+@ReactModule(name = HmsScanViewManager.NAME)
+class HmsScanViewManager :
+  SimpleViewManager<HmsScanView>(),
+  HmsScanViewManagerInterface<HmsScanView> {
+
+  private val mDelegate: ViewManagerDelegate<HmsScanView> =
+    HmsScanViewManagerDelegate(this)
+
+  override fun getDelegate(): ViewManagerDelegate<HmsScanView> = mDelegate
+
+  override fun getName(): String = NAME
+
+  public override fun createViewInstance(context: ThemedReactContext): HmsScanView =
+    HmsScanView(context)
+
+  @ReactProp(name = "formatsCsv")
+  override fun setFormatsCsv(view: HmsScanView?, value: String?) {
+    view?.setFormatsCsv(value)
+  }
+
+  @ReactProp(name = "continuous", defaultBoolean = true)
+  override fun setContinuous(view: HmsScanView?, value: Boolean) {
+    view?.setContinuous(value)
+  }
+
+  @ReactProp(name = "paused", defaultBoolean = false)
+  override fun setPaused(view: HmsScanView?, value: Boolean) {
+    view?.setPaused(value)
+  }
+
+  @ReactProp(name = "torch", defaultBoolean = false)
+  override fun setTorch(view: HmsScanView?, value: Boolean) {
+    view?.setTorch(value)
+  }
+
+  /**
+   * Map internal Fabric event names to the JS prop callback names declared in
+   * HmsScanViewNativeComponent.ts.
+   */
+  override fun getExportedCustomDirectEventTypeConstants(): Map<String, Any> {
+    return mapOf(
+      "topScanResult" to mapOf("registrationName" to "onScanResult"),
+      "topScanError" to mapOf("registrationName" to "onScanError"),
+      "topTorchStatus" to mapOf("registrationName" to "onTorchStatus")
+    )
+  }
+
+  companion object {
+    const val NAME = "HmsScanView"
+  }
+}

package/android/src/main/java/com/unif/reactnativehmsscan/ReactNativeHmsScanPackage.kt

@@ -0,0 +1,49 @@
+package com.unif.reactnativehmsscan
+
+import com.facebook.react.BaseReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import com.facebook.react.uimanager.ViewManager
+
+/**
+ * React Native package wiring for @unif/react-native-hms-scan:
+ *   - the "HmsScan" TurboModule ([HmsScanModule]) —— 图片识别 + 相机权限。
+ *   - the "HmsScanView" Fabric 视图 ([HmsScanViewManager]) —— 定制视图扫码。
+ *
+ * 结构对齐官方 create-react-native-library 模板：模块走 getModule /
+ * getReactModuleInfoProvider，视图走 createViewManagers + listOf(ViewManager)。
+ */
+class ReactNativeHmsScanPackage : BaseReactPackage() {
+
+  override fun getModule(
+    name: String,
+    reactContext: ReactApplicationContext
+  ): NativeModule? {
+    return if (name == HmsScanModule.NAME) {
+      HmsScanModule(reactContext)
+    } else {
+      null
+    }
+  }
+
+  override fun getReactModuleInfoProvider() = ReactModuleInfoProvider {
+    mapOf(
+      HmsScanModule.NAME to ReactModuleInfo(
+        name = HmsScanModule.NAME,
+        className = HmsScanModule.NAME,
+        canOverrideExistingModule = false,
+        needsEagerInit = false,
+        isCxxModule = false,
+        isTurboModule = true
+      )
+    )
+  }
+
+  override fun createViewManagers(
+    reactContext: ReactApplicationContext
+  ): List<ViewManager<*, *>> {
+    return listOf(HmsScanViewManager())
+  }
+}

package/ios/HmsScanModule.h

@@ -0,0 +1,20 @@
+//
+//  HmsScanModule.h
+//  @unif/react-native-hms-scan
+//
+//  TurboModule registered under the name "HmsScan". Implements the codegen
+//  protocol NativeHmsScanSpec (generated from src/NativeHmsScan.ts):
+//    - decodeImage:formatsCsv:resolve:reject:
+//    - getCameraPermissionStatus:reject:
+//    - requestCameraPermission:reject:
+//
+
+#import <ReactNativeHmsScanSpec/ReactNativeHmsScanSpec.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface HmsScanModule : NSObject <NativeHmsScanSpec>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/HmsScanModule.mm

@@ -0,0 +1,161 @@
+//
+//  HmsScanModule.mm
+//  @unif/react-native-hms-scan
+//
+
+#import "HmsScanModule.h"
+#import "HmsScanResultMapper.h"
+
+#import <AVFoundation/AVFoundation.h>
+#import <UIKit/UIKit.h>
+
+#import <ScanKitFrameWork/ScanKitFrameWork.h>
+
+// Error codes mirror HmsScanErrorCode in src/types.ts.
+static NSString *const kErrImageLoadFailed = @"E_IMAGE_LOAD_FAILED";
+static NSString *const kErrDecodeFailed = @"E_DECODE_FAILED";
+
+@implementation HmsScanModule
+
+// Export under the JS-visible name "HmsScan" (TurboModuleRegistry.getEnforcing<Spec>('HmsScan')).
+RCT_EXPORT_MODULE(HmsScan)
+
+#pragma mark - Permission status mapping
+
+// AVAuthorizationStatus -> our CameraPermissionStatus string.
+// authorized -> granted; notDetermined -> undetermined; denied/restricted -> blocked.
++ (NSString *)stringForAuthorizationStatus:(AVAuthorizationStatus)status
+{
+  switch (status) {
+    case AVAuthorizationStatusAuthorized:
+      return @"granted";
+    case AVAuthorizationStatusNotDetermined:
+      return @"undetermined";
+    case AVAuthorizationStatusDenied:
+    case AVAuthorizationStatusRestricted:
+      return @"blocked";
+    default:
+      return @"undetermined";
+  }
+}
+
+- (void)getCameraPermissionStatus:(RCTPromiseResolveBlock)resolve
+                           reject:(RCTPromiseRejectBlock)reject
+{
+  AVAuthorizationStatus status =
+      [AVCaptureDevice authorizationStatusForMediaType:AVMediaTypeVideo];
+  resolve([HmsScanModule stringForAuthorizationStatus:status]);
+}
+
+- (void)requestCameraPermission:(RCTPromiseResolveBlock)resolve
+                         reject:(RCTPromiseRejectBlock)reject
+{
+  AVAuthorizationStatus current =
+      [AVCaptureDevice authorizationStatusForMediaType:AVMediaTypeVideo];
+
+  // Only notDetermined can present the system prompt. For an already-resolved
+  // state, return it directly (requestAccess would still call back immediately,
+  // but this avoids any ambiguity and keeps the mapping exact).
+  if (current != AVAuthorizationStatusNotDetermined) {
+    resolve([HmsScanModule stringForAuthorizationStatus:current]);
+    return;
+  }
+
+  [AVCaptureDevice requestAccessForMediaType:AVMediaTypeVideo
+                           completionHandler:^(BOOL granted) {
+    // Re-read the authoritative status rather than inferring from `granted`,
+    // so restricted/denied are reported correctly.
+    AVAuthorizationStatus updated =
+        [AVCaptureDevice authorizationStatusForMediaType:AVMediaTypeVideo];
+    resolve([HmsScanModule stringForAuthorizationStatus:updated]);
+  }];
+}
+
+#pragma mark - Image loading
+
+// Load a UIImage from a local URI: file:// , an absolute/relative file path,
+// or a data: URI. Remote URLs and Photos (ph:// / assets-library://) are not
+// supported here -> returns nil so the caller rejects E_IMAGE_LOAD_FAILED.
++ (nullable UIImage *)imageForURI:(NSString *)uri
+{
+  if (uri.length == 0) {
+    return nil;
+  }
+
+  NSURL *url = [NSURL URLWithString:uri];
+  NSString *scheme = url.scheme.lowercaseString;
+
+  // data: URI (base64 or otherwise) -> decode bytes directly.
+  if ([scheme isEqualToString:@"data"]) {
+    NSData *data = [NSData dataWithContentsOfURL:url];
+    return data ? [UIImage imageWithData:data] : nil;
+  }
+
+  // file:// URI -> use its filesystem path.
+  if ([scheme isEqualToString:@"file"]) {
+    NSString *path = url.path;
+    return path ? [UIImage imageWithContentsOfFile:path] : nil;
+  }
+
+  // No scheme (or a Windows-like drive letter is irrelevant on iOS): treat the
+  // whole string as a filesystem path. Also strip a leading file path that may
+  // have arrived percent-encoded.
+  if (scheme == nil || scheme.length == 0) {
+    UIImage *image = [UIImage imageWithContentsOfFile:uri];
+    if (image == nil) {
+      NSString *decoded = [uri stringByRemovingPercentEncoding];
+      if (decoded != nil && ![decoded isEqualToString:uri]) {
+        image = [UIImage imageWithContentsOfFile:decoded];
+      }
+    }
+    return image;
+  }
+
+  // ph:// , assets-library:// , http(s):// , content:// (Android-only) etc. are
+  // intentionally unsupported on iOS in this bridge.
+  return nil;
+}
+
+#pragma mark - decodeImage
+
+- (void)decodeImage:(NSString *)uri
+         formatsCsv:(NSString *)formatsCsv
+            resolve:(RCTPromiseResolveBlock)resolve
+             reject:(RCTPromiseRejectBlock)reject
+{
+  UIImage *image = [HmsScanModule imageForURI:uri];
+  if (image == nil) {
+    reject(kErrImageLoadFailed,
+           [NSString stringWithFormat:@"无法从 URI 加载图片（仅支持 file:// / 绝对路径 / data:）：%@",
+            uri ?: @"(nil)"],
+           nil);
+    return;
+  }
+
+  @try {
+    unsigned int formatType = [HmsScanResultMapper scanFormatTypeFromCsv:formatsCsv];
+    // photoMode/Photo=YES: still-image (album) decode path, per HUAWEI guidance.
+    HmsScanOptions *options =
+        [[HmsScanOptions alloc] initWithScanFormatType:formatType Photo:YES];
+
+    NSArray *raw = [HmsBitMap multiDecodeBitMapForImage:image withOptions:options];
+    NSString *json = [HmsScanResultMapper jsonStringFromHuaweiArray:raw];
+    // Always resolve a JSON array string (may be "[]" when nothing was found);
+    // JS parseResultsJson handles the empty case.
+    resolve(json);
+  } @catch (NSException *exception) {
+    reject(kErrDecodeFailed,
+           exception.reason ?: @"HUAWEI Scan Kit 解码图片时发生异常",
+           nil);
+  }
+}
+
+#pragma mark - TurboModule
+
+- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
+    (const facebook::react::ObjCTurboModule::InitParams &)params
+{
+  return std::make_shared<facebook::react::NativeHmsScanSpecJSI>(params);
+}
+
+@end

package/ios/HmsScanResultMapper.h

@@ -0,0 +1,45 @@
+//
+//  HmsScanResultMapper.h
+//  @unif/react-native-hms-scan
+//
+//  Converts HUAWEI Scan Kit result dictionaries into the library's stable
+//  ScanResult[] JSON contract (shared by the TurboModule's decodeImage and the
+//  Fabric view's onScanResult event). The JSON shape is:
+//
+//    [{"value":"...","format":"EAN_13","contentType":"ARTICLE",
+//      "cornerPoints":[{"x":10,"y":20}]}]
+//
+//  Only `value` and `format` are guaranteed; `contentType` / `cornerPoints` are
+//  emitted only when derivable. See README of NativeHmsScan.ts for the contract.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface HmsScanResultMapper : NSObject
+
+/// Parse a comma-separated list of our BarcodeFormat strings into the
+/// `HmsScanOptions.scanFormatType` bitmask (HMSScanFormatTypeCode OR-ed).
+/// An empty/whitespace-only string means "all formats".
++ (unsigned int)scanFormatTypeFromCsv:(nullable NSString *)csv;
+
+/// Map a single HUAWEI result dictionary (keys: text / formatValue / sceneType /
+/// ResultPoint ...) into one ScanResult dictionary, or nil when there is no
+/// usable `text`. Returned dictionary is JSON-serializable.
++ (nullable NSDictionary *)scanResultFromHuaweiDict:(nullable NSDictionary *)dict;
+
+/// Map an array of HUAWEI result dictionaries into an array of ScanResult
+/// dictionaries (dropping entries without a usable value).
++ (NSArray<NSDictionary *> *)scanResultsFromHuaweiArray:(nullable NSArray *)array;
+
+/// Serialize an array of ScanResult dictionaries to a JSON string.
+/// Never returns nil: on failure it returns "[]".
++ (NSString *)jsonStringFromScanResults:(nullable NSArray<NSDictionary *> *)results;
+
+/// Convenience: HUAWEI multi-decode array -> ScanResult[] JSON string.
++ (NSString *)jsonStringFromHuaweiArray:(nullable NSArray *)array;
+
+@end
+
+NS_ASSUME_NONNULL_END