Add TypeScript typings (#67)

* Add typings to options param

* Add response typings

* Add types directly in the options type

* Export types too

* Rename types

* Put everything together

* Export also options type

* Update version

Author: DavideViolante

index.d.ts

@@ -1,3 +1,42 @@
 declare module "ocr-space-api-wrapper" {
-    export function ocrSpace(input: string, options?: any): any;
+  type OcrSpaceLanguages = 'ara' | 'bul' | 'chs' | 'cht' | 'hrv' | 'cze' | 'dan' | 'dut' |
+    'eng' | 'fin' | 'fre' | 'ger' | 'gre' | 'hun' | 'kor' | 'ita' | 'jpn' | 'pol' |
+    'por' | 'rus' | 'slv' | 'spa' | 'swe' | 'tur' |
+    // The following are only supported by OCREngine = '3'
+    'hin' | 'kan' | 'per' | 'tel' | 'tam' | 'tai' | 'vie';
+  type OcrSpaceFileTypes = string | 'PDF' | 'GIF' | 'PNG' | 'JPG' | 'TIF' | 'BMP';
+
+  export type OcrSpaceOptions = {
+    apiKey?: string;
+    ocrUrl?: string;
+    language?: OcrSpaceLanguages;
+    isOverlayRequired?: boolean;
+    filetype?: OcrSpaceFileTypes;
+    detectOrientation?: boolean;
+    isCreateSearchablePdf?: boolean;
+    isSearchablePdfHideTextLayer?: boolean;
+    scale?: boolean;
+    isTable?: boolean;
+    OCREngine?: '1' | '2' | '3';
+  };
+
+  type OcrSpaceResponse = {
+    ErrorMessage: string;
+    ErrorDetails: string;
+    IsErroredOnProcessing: boolean;
+    OCRExitCode: number;
+    ParsedResults: {
+      ErrorMessage: string;
+      ErrorDetails: string;
+      FileParseExitCode: 0 | 1 | -10 | -20 | -30 | -99;
+      HasOverlay: boolean,
+      Message: string;
+      ParsedText: string;
+      TextOverlay: any;
+    }[];
+    ProcessingTimeInMilliseconds: number
+    SearchablePDFURL: string;
+  };
+
+  export function ocrSpace(input: string, options?: OcrSpaceOptions): OcrSpaceResponse;
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ocr-space-api-wrapper",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Node.js wrapper for ocr.space APIs.",
   "main": "index.js",
   "scripts": {
@@ -35,7 +35,7 @@
     "form-data": "^4.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.33.0",
+    "eslint": "^8.42.0",
     "eslint-config-google": "^0.14.0",
     "mocha": "^10.2.0",
     "nyc": "^15.1.0"