@imagowave/vision-ocr 0.0.1 → 0.0.2

package/README.md

@@ -1,38 +1,5 @@
-# react-native-nitro-template
+# @imagowave/vision-ocr
 
-This is a template for Nitro Modules.
+Inspired by @bear-block/vision-camera-ocr but updated to work with Vision Camera 5. (as a nitro module)
 
-## Usage
-
-Clone this repo, and change all `$$*$$` names according to your `nitro.json` file.
-
-## Contributing
-
-Contribute a change to this template to update it for newer React Native versions.
-
-## Structure
-
-- [`android/`](android): All your `android`-specific implementations.
-  - [`build.gradle`](android/build.gradle): The gradle build file. This contains four important pieces:
-    1. Standard react-native library boilerplate code
-    2. Configures Kotlin (`apply plugin: 'org.jetbrains.kotlin.android'`)
-    3. Adds all Nitrogen files (`apply from: '.../NitroVisionOcr+autolinking.gradle'`)
-    4. Triggers the native C++ build (via CMake/`externalNativeBuild`)
-  - [`CMakeLists.txt`](android/CMakeLists.txt): The CMake build file to build C++ code. This contains four important pieces:
-    1. Creates a library called `NitroVisionOcr` (same as in `nitro.json`)
-    2. Adds all Nitrogen files (`include(.../NitroVisionOcr+autolinking.cmake)`)
-    3. Adds all custom C++ files (only `HybridTestObjectCpp.cpp`)
-    4. Adds a `cpp-adapter.cpp` file, which autolinks all C++ HybridObjects (only `HybridTestObjectCpp`)
-  - [`src/main/java/com/margelo/nitro/visionocr/`](android/src/main/java/com/margelo/nitro/visionocr/): All Kotlin implementations.
-    - [`NitroVisionOcrPackage.kt`](android/src/main/java/com/margelo/nitro/visionocr/NitroVisionOcrPackage.kt): The react-native package. You need this because the react-native CLI only adds libraries if they have a `*Package.kt` file. In here, you can autolink all Kotlin HybridObjects.
-- [`cpp/`](cpp): All your cross-platform implementations. (only `HybridTestObjectCpp.cpp`)
-- [`ios/`](ios): All your iOS-specific implementations.
-- [`nitrogen/`](nitrogen): All files generated by nitrogen. You should commit this folder to git.
-- [`src/`](src): The TypeScript codebase. This defines all HybridObjects and loads them at runtime.
-  - [`specs/`](src/specs): All HybridObject types. Nitrogen will run on all `*.nitro.ts` files.
-- [`nitro.json`](nitro.json): The configuration file for nitrogen. This will define all native namespaces, as well as the library name.
-- [`NitroVisionOcr.podspec`](NitroVisionOcr.podspec): The iOS podspec build file to build the iOS code. This contains three important pieces:
-  1. Specifies the Pod's name. This must be identical to the name specified in `nitro.json`.
-  2. Adds all of your `.swift` or `.cpp` files (implementations).
-  3. Adds all Nitrogen files (`add_nitrogen_files(s)`)
-- [`package.json`](package.json): The npm package.json file. `react-native-nitro-modules` should be a `peerDependency`.
+Android side has not been tested.

package/android/src/main/java/com/margelo/nitro/visionocr/{VisionOcr.kt → HybridVisionOCR.kt}

@@ -16,7 +16,7 @@ import com.mrousavy.camera.frameprocessors.FrameProcessorPlugin
 import com.mrousavy.camera.frameprocessors.VisionCameraProxy
 import java.util.HashMap
 
-class VisionOCR : HybridVisionOCRSpec() {
+class HybridVisionOCR : HybridVisionOCRSpec() {
   private val recognizer = TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS)
 
   override fun call(frame: Frame, arguments: Map<String, Any>?): HashMap<String, Any>? {

package/ios/{VisionOCR.swift → HybridVisionOCR.swift}

@@ -5,7 +5,7 @@ import ImageIO
 import Vision
 import VisionCamera
 
-class VisionOCR : HybridVisionOCRSpec {
+class HybridVisionOCR : HybridVisionOCRSpec {
   func call(frame: (any HybridFrameSpec), options: OcrOptions?) throws -> OcrResult? {
     let includeBoxes = options?.includeBoxes ?? false
     let includeConfidence = options?.includeConfidence ?? false

package/nitro.json

@@ -1,19 +1,24 @@
 {
-  "$schema": "https://nitro.margelo.com/nitro.schema.json",
-  "cxxNamespace": [
-    "visionocr"
-  ],
-  "ios": {
-    "iosModuleName": "NitroVisionOcr"
-  },
-  "android": {
-    "androidNamespace": [
-      "visionocr"
-    ],
-    "androidCxxLibName": "NitroVisionOcr"
-  },
-  "autolinking": {},
-  "ignorePaths": [
-    "**/node_modules"
-  ]
+	"$schema": "https://nitro.margelo.com/nitro.schema.json",
+	"cxxNamespace": ["visionocr"],
+	"ios": {
+		"iosModuleName": "NitroVisionOcr"
+	},
+	"android": {
+		"androidNamespace": ["visionocr"],
+		"androidCxxLibName": "NitroVisionOcr"
+	},
+	"autolinking": {
+		"NitroVisionOcr": {
+			"ios": {
+				"language": "swift",
+				"implementationClassName": "HybridVisionOCR"
+			},
+			"android": {
+				"language": "kotlin",
+				"implementationClassName": "HybridVisionOCR"
+			}
+		}
+	},
+	"ignorePaths": ["**/node_modules"]
 }

package/nitrogen/generated/android/NitroVisionOcrOnLoad.cpp

@@ -16,6 +16,8 @@
 #include <NitroModules/HybridObjectRegistry.hpp>
 
 #include "JHybridVisionOCRSpec.hpp"
+#include "JHybridNitroVisionOcrSpec.hpp"
+#include <NitroModules/DefaultConstructableObject.hpp>
 
 namespace margelo::nitro::visionocr {
 
@@ -25,7 +27,14 @@ int initialize(JavaVM* vm) {
   });
 }
 
-
+struct JHybridNitroVisionOcrSpecImpl: public jni::JavaClass<JHybridNitroVisionOcrSpecImpl, JHybridNitroVisionOcrSpec::JavaPart> {
+  static constexpr auto kJavaDescriptor = "Lcom/margelo/nitro/visionocr/HybridVisionOCR;";
+  static std::shared_ptr<JHybridNitroVisionOcrSpec> create() {
+    static const auto constructorFn = javaClassStatic()->getConstructor<JHybridNitroVisionOcrSpecImpl::javaobject()>();
+    jni::local_ref<JHybridNitroVisionOcrSpec::JavaPart> javaPart = javaClassStatic()->newObject(constructorFn);
+    return javaPart->getJHybridNitroVisionOcrSpec();
+  }
+};
 
 void registerAllNatives() {
   using namespace margelo::nitro;
@@ -35,7 +44,12 @@ void registerAllNatives() {
   margelo::nitro::visionocr::JHybridVisionOCRSpec::CxxPart::registerNatives();
 
   // Register Nitro Hybrid Objects
-  
+  HybridObjectRegistry::registerHybridObjectConstructor(
+    "NitroVisionOcr",
+    []() -> std::shared_ptr<HybridObject> {
+      return JHybridNitroVisionOcrSpecImpl::create();
+    }
+  );
 }
 
 } // namespace margelo::nitro::visionocr

package/nitrogen/generated/ios/NitroVisionOcrAutolinking.mm

@@ -0,0 +1,33 @@
+///
+/// NitroVisionOcrAutolinking.mm
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#import <Foundation/Foundation.h>
+#import <NitroModules/HybridObjectRegistry.hpp>
+#import "NitroVisionOcr-Swift-Cxx-Umbrella.hpp"
+#import <type_traits>
+
+#include "HybridNitroVisionOcrSpecSwift.hpp"
+
+@interface NitroVisionOcrAutolinking : NSObject
+@end
+
+@implementation NitroVisionOcrAutolinking
+
++ (void) load {
+  using namespace margelo::nitro;
+  using namespace margelo::nitro::visionocr;
+
+  HybridObjectRegistry::registerHybridObjectConstructor(
+    "NitroVisionOcr",
+    []() -> std::shared_ptr<HybridObject> {
+      std::shared_ptr<HybridNitroVisionOcrSpec> hybridObject = NitroVisionOcr::NitroVisionOcrAutolinking::createNitroVisionOcr();
+      return hybridObject;
+    }
+  );
+}
+
+@end

package/nitrogen/generated/ios/NitroVisionOcrAutolinking.swift

@@ -0,0 +1,26 @@
+///
+/// NitroVisionOcrAutolinking.swift
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+import NitroModules
+
+// TODO: Use empty enums once Swift supports exporting them as namespaces
+//       See: https://github.com/swiftlang/swift/pull/83616
+public final class NitroVisionOcrAutolinking {
+  public typealias bridge = margelo.nitro.visionocr.bridge.swift
+
+  public static func createNitroVisionOcr() -> bridge.std__shared_ptr_HybridNitroVisionOcrSpec_ {
+    let hybridObject = HybridVisionOCR()
+    return { () -> bridge.std__shared_ptr_HybridNitroVisionOcrSpec_ in
+      let __cxxWrapped = hybridObject.getCxxWrapper()
+      return __cxxWrapped.getCxxPart()
+    }()
+  }
+  
+  public static func isNitroVisionOcrRecyclable() -> Bool {
+    return HybridVisionOCR.self is any RecyclableView.Type
+  }
+}

package/package.json

@@ -1,12 +1,8 @@
 {
 	"name": "@imagowave/vision-ocr",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "A React Native module for performing OCR using the Vision framework on iOS and ML Kit on Android.",
-	"main": "lib/index",
-	"module": "lib/index",
-	"types": "lib/types.ts",
-	"react-native": "src/index",
-	"source": "src/index",
+	"main": "src/index",
 	"files": [
 		"src",
 		"react-native.config.js",
@@ -33,7 +29,6 @@
 		"clean": "rm -rf android/build node_modules/**/android/build lib",
 		"lint": "eslint \"**/*.{js,ts,tsx}\" --fix",
 		"lint-ci": "eslint \"**/*.{js,ts,tsx}\" -f @jamesacarr/github-actions",
-		"typescript": "tsc",
 		"specs": "tsc --noEmit false && nitrogen --logLevel=\"debug\""
 	},
 	"keywords": [

package/src/index.ts

@@ -6,7 +6,7 @@ import type { OcrOptions, OcrResult } from "./types";
 
 export * from "./types";
 
-const plugin = NitroModules.createHybridObject<VisionOCR>("VisionOCR");
+const plugin = NitroModules.createHybridObject<VisionOCR>("NitroVisionOcr");
 
 export default plugin;