react-native-text-reader 0.1.1 → 0.2.0

package/README.md

@@ -12,11 +12,11 @@ npm install react-native-text-reader
 
 
 ```js
-import { multiply } from 'react-native-text-reader';
+import { read } from 'react-native-text-reader';
 
 // ...
 
-const result = await multiply(3, 7);
+const result = await read('imageUri');
 ```
 
 

package/ios/TextReader.mm

@@ -1,10 +1,12 @@
 #import <React/RCTBridgeModule.h>
 
-@interface RCT_EXTERN_MODULE(TextReader, NSObject)
+@interface RCT_EXTERN_MODULE (TextReader, NSObject)
 
-RCT_EXTERN_METHOD(multiply:(float)a withB:(float)b
-                 withResolver:(RCTPromiseResolveBlock)resolve
-                 withRejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXTERN_METHOD(read
+                  : (NSString *)imgPath withOptions
+                  : (NSDictionary *)options withResolver
+                  : (RCTPromiseResolveBlock)resolve withRejecter
+                  : (RCTPromiseRejectBlock)reject)
 
 + (BOOL)requiresMainQueueSetup
 {

package/ios/TextReader.swift

@@ -1,8 +1,56 @@
+import Vision
+
+extension String {
+  func stripPrefix(_ prefix: String) -> String {
+    guard hasPrefix(prefix) else { return self }
+    return String(dropFirst(prefix.count))
+  }
+}
+
 @objc(TextReader)
 class TextReader: NSObject {
+  @objc static func requiresMainQueueSetup() -> Bool { return true }
+  @objc(read:withOptions:withResolver:withRejecter:)
+  func read(imgPath: String, options: [String: Float], resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    guard !imgPath.isEmpty else { reject("ERR", "Image path cannot be empty.", nil); return }
+
+    let formattedImgPath = imgPath.stripPrefix("file://")
+    var threshold: Float = 0.0
+
+    if !(options["visionIgnoreThreshold"]?.isZero ?? true) {
+      threshold = options["visionIgnoreThreshold"] ?? 0.0
+    }
+
+    do {
+      let imgData = try Data(contentsOf: URL(fileURLWithPath: formattedImgPath))
+      let image = UIImage(data: imgData)
 
-  @objc(multiply:withB:withResolver:withRejecter:)
-  func multiply(a: Float, b: Float, resolve:RCTPromiseResolveBlock,reject:RCTPromiseRejectBlock) -> Void {
-    resolve(a*b)
+      guard let cgImage = image?.cgImage else { return }
+
+      let requestHandler = VNImageRequestHandler(cgImage: cgImage)
+
+      let ocrRequest = VNRecognizeTextRequest { (request: VNRequest, error: Error?) in
+        self.textReaderHandler(request: request, threshold: threshold, error: error, resolve: resolve, reject: reject)
+      }
+
+      try requestHandler.perform([ocrRequest])
+    } catch {
+      print(error)
+      reject("ERR", error.localizedDescription, nil)
+    }
   }
-}
+
+  func textReaderHandler(request: VNRequest, threshold: Float, error _: Error?, resolve: @escaping RCTPromiseResolveBlock, reject: @escaping RCTPromiseRejectBlock) {
+    guard let observations = request.results as? [VNRecognizedTextObservation] else { reject("ERR", "Failed to read the text.", nil); return }
+
+    let strings = observations.compactMap { observation -> String? in
+      if observation.topCandidates(1).first?.confidence ?? 0 >= threshold {
+        return observation.topCandidates(1).first?.string
+      } else {
+        return nil
+      }
+    }
+    
+    resolve(strings)
+  }
+}

package/lib/commonjs/index.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.multiply = multiply;
+exports.default = void 0;
 var _reactNative = require("react-native");
 const LINKING_ERROR = `The package 'react-native-text-reader' doesn't seem to be linked. Make sure: \n\n` + _reactNative.Platform.select({
   ios: "- You have run 'pod install'\n",
@@ -14,7 +14,17 @@ const TextReader = _reactNative.NativeModules.TextReader ? _reactNative.NativeMo
     throw new Error(LINKING_ERROR);
   }
 });
-function multiply(a, b) {
-  return TextReader.multiply(a, b);
+/**
+ * Extrae texto de una imagen.
+ * @param imagePath - La URI de la imagen de la que se extraerá el texto.
+ * @param options - Opciones adicionales.
+ * @param options.visionIgnoreThreshold - Umbral de ignoración de la visión.
+ * @returns Una promesa que se resuelve con el texto extraído.
+ */
+async function read(imagePath, options) {
+  return await TextReader.read(imagePath, options || {});
 }
+var _default = exports.default = {
+  read
+};
 //# sourceMappingURL=index.js.map

package/lib/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","TextReader","NativeModules","Proxy","get","Error","multiply","a","b"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,MAAMC,aAAa,GACjB,mFAAmF,GACnFC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,UAAU,GAAGC,0BAAa,CAACD,UAAU,GACvCC,0BAAa,CAACD,UAAU,GACxB,IAAIE,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEE,SAASU,QAAQA,CAACC,CAAS,EAAEC,CAAS,EAAmB;EAC9D,OAAOP,UAAU,CAACK,QAAQ,CAACC,CAAC,EAAEC,CAAC,CAAC;AAClC","ignoreList":[]}
+{"version":3,"names":["_reactNative","require","LINKING_ERROR","Platform","select","ios","default","TextReader","NativeModules","Proxy","get","Error","read","imagePath","options","_default","exports"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;;;;;AAAA,IAAAA,YAAA,GAAAC,OAAA;AAEA,MAAMC,aAAa,GACjB,mFAAmF,GACnFC,qBAAQ,CAACC,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,UAAU,GAAGC,0BAAa,CAACD,UAAU,GACvCC,0BAAa,CAACD,UAAU,GACxB,IAAIE,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACT,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAUL;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeU,IAAIA,CACjBC,SAAiB,EACjBC,OAA2B,EACR;EACnB,OAAO,MAAMP,UAAU,CAACK,IAAI,CAACC,SAAS,EAAEC,OAAO,IAAI,CAAC,CAAC,CAAC;AACxD;AAAC,IAAAC,QAAA,GAAAC,OAAA,CAAAV,OAAA,GAEc;EAAEM;AAAK,CAAC","ignoreList":[]}

package/lib/module/index.js

@@ -10,7 +10,17 @@ const TextReader = NativeModules.TextReader ? NativeModules.TextReader : new Pro
     throw new Error(LINKING_ERROR);
   }
 });
-export function multiply(a, b) {
-  return TextReader.multiply(a, b);
+/**
+ * Extrae texto de una imagen.
+ * @param imagePath - La URI de la imagen de la que se extraerá el texto.
+ * @param options - Opciones adicionales.
+ * @param options.visionIgnoreThreshold - Umbral de ignoración de la visión.
+ * @returns Una promesa que se resuelve con el texto extraído.
+ */
+async function read(imagePath, options) {
+  return await TextReader.read(imagePath, options || {});
 }
+export default {
+  read
+};
 //# sourceMappingURL=index.js.map

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","TextReader","Proxy","get","Error","multiply","a","b"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GACjB,mFAAmF,GACnFD,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,UAAU,GAAGN,aAAa,CAACM,UAAU,GACvCN,aAAa,CAACM,UAAU,GACxB,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEL,OAAO,SAASQ,QAAQA,CAACC,CAAS,EAAEC,CAAS,EAAmB;EAC9D,OAAON,UAAU,CAACI,QAAQ,CAACC,CAAC,EAAEC,CAAC,CAAC;AAClC","ignoreList":[]}
+{"version":3,"names":["NativeModules","Platform","LINKING_ERROR","select","ios","default","TextReader","Proxy","get","Error","read","imagePath","options"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":";;AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAEtD,MAAMC,aAAa,GACjB,mFAAmF,GACnFD,QAAQ,CAACE,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,UAAU,GAAGN,aAAa,CAACM,UAAU,GACvCN,aAAa,CAACM,UAAU,GACxB,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAUL;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAeQ,IAAIA,CACjBC,SAAiB,EACjBC,OAA2B,EACR;EACnB,OAAO,MAAMN,UAAU,CAACI,IAAI,CAACC,SAAS,EAAEC,OAAO,IAAI,CAAC,CAAC,CAAC;AACxD;AAEA,eAAe;EAAEF;AAAK,CAAC","ignoreList":[]}

package/lib/typescript/commonjs/src/index.d.ts

@@ -1,2 +1,9 @@
-export declare function multiply(a: number, b: number): Promise<number>;
+export type TextReaderOptions = {
+    visionIgnoreThreshold?: number;
+};
+type TextReaderType = {
+    read(imagePath: string, options?: TextReaderOptions): Promise<string[]>;
+};
+declare const _default: TextReaderType;
+export default _default;
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/commonjs/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAmBA,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAE9D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAmBA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACzE,CAAC;wBAgByB,cAAc;AAAzC,wBAA0C"}

package/lib/typescript/module/src/index.d.ts

@@ -1,2 +1,9 @@
-export declare function multiply(a: number, b: number): Promise<number>;
+export type TextReaderOptions = {
+    visionIgnoreThreshold?: number;
+};
+type TextReaderType = {
+    read(imagePath: string, options?: TextReaderOptions): Promise<string[]>;
+};
+declare const _default: TextReaderType;
+export default _default;
 //# sourceMappingURL=index.d.ts.map

package/lib/typescript/module/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAmBA,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAE9D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/index.tsx"],"names":[],"mappings":"AAmBA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,KAAK,cAAc,GAAG;IACpB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;CACzE,CAAC;wBAgByB,cAAc;AAAzC,wBAA0C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-text-reader",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A React Native library for OCR (Optical Character Recognition) using Vision Framework on iOS and Firebase ML Kit on Android.",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",

package/src/index.tsx

@@ -17,6 +17,26 @@ const TextReader = NativeModules.TextReader
       }
     );
 
-export function multiply(a: number, b: number): Promise<number> {
-  return TextReader.multiply(a, b);
+export type TextReaderOptions = {
+  visionIgnoreThreshold?: number;
+};
+
+type TextReaderType = {
+  read(imagePath: string, options?: TextReaderOptions): Promise<string[]>;
+};
+
+/**
+ * Extrae texto de una imagen.
+ * @param imagePath - La URI de la imagen de la que se extraerá el texto.
+ * @param options - Opciones adicionales.
+ * @param options.visionIgnoreThreshold - Umbral de ignoración de la visión.
+ * @returns Una promesa que se resuelve con el texto extraído.
+ */
+async function read(
+  imagePath: string,
+  options?: TextReaderOptions
+): Promise<string[]> {
+  return await TextReader.read(imagePath, options || {});
 }
+
+export default { read } as TextReaderType;