DavideViolante · Oct 26, 2021 · Oct 26, 2021 · Oct 26, 2021 · Oct 26, 2021 · Oct 26, 2021
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -2,15 +2,16 @@
   "env": {
     "commonjs": true,
     "es2021": true,
-    "node": true
+    "node": true,
+    "mocha": true
   },
-  "extends": "google",
+  "extends": ["eslint:recommended", "google"],
   "parserOptions": {
     "ecmaVersion": 12
   },
   "rules": {
     "max-len": [
-      "error", 100
+      "error", 120
     ],
     "object-curly-spacing": [
       "error", "always"

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,20 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '16'
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run lint
+    - run: npm test
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -0,0 +1,23 @@
+name: Test Coveralls
+
+on: ["push", "pull_request"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: '16'
+        cache: 'npm'
+
+    - name: Coverage
+      run: |
+        npm ci
+        npm run coverage
+
+    - name: Coveralls
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/npmpublish.yml b/.github/workflows/npmpublish.yml
@@ -0,0 +1,18 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # OCR.Space Node.js API wrapper
-![npm](https://img.shields.io/npm/dm/ocr-space-api-wrapper) [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)
+[![](https://github.com/davideviolante/ocr-space-api-wrapper/workflows/Node.js%20CI/badge.svg)](https://github.com/DavideViolante/ocr-space-api-wrapper/actions?query=workflow%3A"Node.js+CI") [![Coverage Status](https://coveralls.io/repos/github/DavideViolante/ocr-space-api-wrapper/badge.svg?branch=master)](https://coveralls.io/github/DavideViolante/ocr-space-api-wrapper?branch=master) ![npm](https://img.shields.io/npm/dm/ocr-space-api-wrapper) [![Donate](https://img.shields.io/badge/paypal-donate-179BD7.svg)](https://www.paypal.me/dviolante)
 
 [![NPM](https://nodei.co/npm/ocr-space-api-wrapper.png)](https://nodei.co/npm/ocr-space-api-wrapper/)
 
@@ -10,20 +10,20 @@ Node.js wrapper for [ocr.space APIs](https://ocr.space/ocrapi), a service for ex
 
 ## Usage
 ```js
-const ocrSpace = require('ocr-space-api-wrapper');
+const { ocrSpace } = require('ocr-space-api-wrapper');
 
 async function main () {
   try {
-    // Using the OCR.space default free token + remote file
+    // Using the OCR.space default free API key (max 10reqs in 10mins) + remote file
     const res1 = await ocrSpace('http://dl.a9t9.com/ocrbenchmark/eng.png');
 
-    // Using your personal token + local file
+    // Using your personal API key + local file
     const res2 = await ocrSpace('/path/to/file.pdf', { apiKey: '<API_KEY_HERE>' });
 
-    // Using your personal token + base64 image + custom language
+    // Using your personal API key + base64 image + custom language
     const res3 = await ocrSpace('data:image/png;base64...', { apiKey: '<API_KEY_HERE>', language: 'ita' });
   } catch (error) {
-    console.log(error);
+    console.error(error);
   }
 }
 ```
@@ -37,13 +37,19 @@ The input param specifies the input file (see examples above). It can be _one_ o
 
 ### `options` object
 This param is an object with the following keys:
-- `apiKey`: your API key for [ocr.space APIs](https://ocr.space/ocrapi).
+- `apiKey`: your API key for [ocr.space APIs](https://ocr.space/ocrapi). Default API key has a limit of max 10reqs in 10mins.
 - `ocrUrl`: a different URL for ocr.space APIs, for example when you purchase the PRO plan.
 - All other params as documented in the [official website](https://ocr.space/OCRAPI#PostParameters).
 
 ## Response
 This package does not change the response in any way, please refer to the [official website](https://ocr.space/OCRAPI#Response).
 
+## Run lint
+`npm run lint`
+
+## Run tests
+`npm test`
+
 ## Bug or feedback
 Please open a new issue.
 

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,3 @@
+declare module "ocr-space-api-wrapper" {
+    export function ocrSpace(input: string, options?: any): any;
+}
diff --git a/index.js b/index.js
@@ -17,6 +17,7 @@ function detectInput(input) {
  * Call OCR Space APIs
  * @param {string} input Input file as url, file path or base64 image (required)
  * @param {object} options Options
+ * @return {object} OCR results
  */
 async function ocrSpace(input, options = {}) {
   try {
@@ -28,45 +29,44 @@ async function ocrSpace(input, options = {}) {
       filetype, detectOrientation, isCreateSearchablePdf,
       isSearchablePdfHideTextLayer, scale, isTable, OCREngine,
     } = options;
-    const data = new FormData();
+    const formData = new FormData();
     const detectedInput = detectInput(input);
     switch (detectedInput) {
       case 'file':
-        data.append('file', fs.createReadStream(input));
+        formData.append('file', fs.createReadStream(input));
         break;
       case 'url':
       case 'base64Image':
-        data.append(detectedInput, input);
+        formData.append(detectedInput, input);
         break;
     }
-    data.append('language', String(language || 'eng'));
-    data.append('isOverlayRequired', String(isOverlayRequired || 'false'));
+    formData.append('language', String(language || 'eng'));
+    formData.append('isOverlayRequired', String(isOverlayRequired || 'false'));
     if (filetype) {
-      data.append('filetype', String(filetype));
+      formData.append('filetype', String(filetype));
     }
-    data.append('detectOrientation', String(detectOrientation || 'false'));
-    data.append('isCreateSearchablePdf', String(isCreateSearchablePdf || 'false'));
-    data.append('isSearchablePdfHideTextLayer', String(isSearchablePdfHideTextLayer || 'false'));
-    data.append('scale', String(scale || 'false'));
-    data.append('isTable', String(isTable || 'false'));
-    data.append('OCREngine', String(OCREngine || '1'));
+    formData.append('detectOrientation', String(detectOrientation || 'false'));
+    formData.append('isCreateSearchablePdf', String(isCreateSearchablePdf || 'false'));
+    formData.append('isSearchablePdfHideTextLayer', String(isSearchablePdfHideTextLayer || 'false'));
+    formData.append('scale', String(scale || 'false'));
+    formData.append('isTable', String(isTable || 'false'));
+    formData.append('OCREngine', String(OCREngine || '1'));
     const request = {
       method: 'POST',
       url: String(ocrUrl || 'https://api.ocr.space/parse/image'),
       headers: {
         apikey: String(apiKey || 'helloworld'),
-        ...data.getHeaders(),
+        ...formData.getHeaders(),
       },
-      data,
+      data: formData,
       maxContentLength: Infinity,
       maxBodyLength: Infinity,
     };
-    const response = await axios(request);
-    // console.log(response.data)
-    return response.data;
+    const { data } = await axios(request);
+    return data;
   } catch (error) {
     console.error(error);
   }
 }
 
-module.exports = ocrSpace;
+exports.ocrSpace = ocrSpace;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,11 +1,13 @@
 {
   "name": "ocr-space-api-wrapper",
-  "version": "1.0.7",
+  "version": "2.1.3",
   "description": "Node.js wrapper for ocr.space APIs.",
   "main": "index.js",
   "scripts": {
-    "start": "node index",
-    "lint": "eslint ./"
+    "start": "node index.js",
+    "lint": "eslint ./",
+    "test": "nyc mocha --timeout 60000 --bail",
+    "coverage": "nyc --reporter=lcov --reporter=text mocha --timeout 60000 --bail"
   },
   "repository": {
     "type": "git",
@@ -18,7 +20,9 @@
     "ocr api",
     "wrapper",
     "nodejs",
-    "optical character recognition"
+    "optical character recognition",
+    "pdf",
+    "image"
   ],
   "author": "Davide Violante",
   "license": "MIT",
@@ -27,11 +31,13 @@
   },
   "homepage": "https://github.com/DavideViolante/ocr-space-api-wrapper#readme",
   "dependencies": {
-    "axios": "^0.23.0",
+    "axios": "^1.1.3",
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.0.1",
-    "eslint-config-google": "^0.14.0"
+    "eslint": "^8.12.0",
+    "eslint-config-google": "^0.14.0",
+    "mocha": "^10.0.0",
+    "nyc": "^15.1.0"
   }
 }
diff --git a/test/eng.png b/test/eng.png
diff --git a/test/test.js b/test/test.js