n8n-nodes-deep-ocr 0.1.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +25 -28
  2. package/dist/credentials/DeepOcrApi.credentials.d.ts.map +1 -1
  3. package/dist/credentials/DeepOcrApi.credentials.js +1 -1
  4. package/dist/credentials/DeepOcrApi.credentials.js.map +1 -1
  5. package/dist/nodes/DeepOcr/DeepOcr.node.json +1 -1
  6. package/package.json +14 -30
package/README.md CHANGED
@@ -1,14 +1,14 @@
1
1
  # n8n-nodes-deep-ocr
2
2
 
3
- N8N Community Node for the [Deep-OCR Service](https://deep-ocr.com) - Extract text and structured data from documents using AI-powered OCR.
3
+ N8N Community Node for the [Deep-OCR Service](https://deep-ocr.com) - Extract structured data from documents using AI-powered OCR.
4
4
 
5
5
  [![npm version](https://badge.fury.io/js/n8n-nodes-deep-ocr.svg)](https://www.npmjs.com/package/n8n-nodes-deep-ocr)
6
6
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7
7
 
8
8
  ## 🚀 Features
9
9
 
10
- - **Full Text Extraction**: Extract complete text content from documents
11
- - **Structured Data Extraction**: Specify fields to extract and receive JSON with those values
10
+ - **Structured Data Extraction**: Receive a structured JSON object with the fields relevant to the document type
11
+ - **7 Document Types**: Invoice, Receipt, Contract, Delivery Note, ID Document, Handwriting, Generic
12
12
  - **Multiple Format Support**: PDF, PNG, JPG, JPEG, WebP (up to 10MB)
13
13
  - **Secure Authentication**: API key stored securely using n8n credentials
14
14
 
@@ -31,31 +31,31 @@ npm install n8n-nodes-deep-ocr
31
31
 
32
32
  ### Setting Up Credentials
33
33
 
34
- 1. Get your API key from [Deep-OCR Dashboard](https://app.deep-ocr.com)
34
+ 1. Get your API key from [Deep-OCR Dashboard](https://deep-ocr.com)
35
35
  2. In n8n, go to **Credentials** → **Add Credential**
36
36
  3. Search for "Deep-OCR API"
37
37
  4. Enter your API key and save
38
38
 
39
39
  ## 📖 Usage
40
40
 
41
- ### Extract Full Text
42
-
43
41
  1. Add the **Deep-OCR** node to your workflow
44
42
  2. Connect a node that provides binary data (e.g., Read Binary File, HTTP Request)
45
43
  3. Configure:
46
- - **Binary Property**: Name of the property containing your document (default: `data`)
47
- - **Output Format**: Select `Text`
48
- 4. Execute to receive the extracted text
49
-
50
- ### Extract Structured Data
51
-
52
- 1. Add the **Deep-OCR** node to your workflow
53
- 2. Connect a node that provides binary data
54
- 3. Configure:
55
- - **Binary Property**: Name of the property containing your document
56
- - **Output Format**: Select `Structured`
57
- - **Fields**: Comma-separated list of fields to extract (e.g., `sender, amount, date`)
58
- 4. Execute to receive a JSON object with the extracted fields
44
+ - **Binary Property**: Name of the binary property containing your document (default: `data`)
45
+ - **Document Type**: Select the type that matches your document
46
+ 4. Execute — the node outputs a JSON object with the extracted fields
47
+
48
+ ### Document Types
49
+
50
+ | Type | Description |
51
+ |---|---|
52
+ | `invoice` | Vendor, line items, totals, payment terms |
53
+ | `receipt` | Merchant, items purchased, totals, payment method |
54
+ | `contract` | Parties, dates, key clauses |
55
+ | `delivery_note` | Sender, recipient, items, quantities |
56
+ | `id_document` | Name, date of birth, document number, expiry |
57
+ | `handwriting` | Transcription of handwritten text |
58
+ | `generic` | General extraction for any document type |
59
59
 
60
60
  ## 📋 Example Workflow
61
61
 
@@ -74,8 +74,7 @@ npm install n8n-nodes-deep-ocr
74
74
  "type": "n8n-nodes-deep-ocr.deepOcr",
75
75
  "parameters": {
76
76
  "binaryPropertyName": "data",
77
- "outputFormat": "structured",
78
- "fields": "sender, recipient, amount, date, invoice_number"
77
+ "documentType": "invoice"
79
78
  }
80
79
  }
81
80
  ]
@@ -93,18 +92,16 @@ npm install n8n-nodes-deep-ocr
93
92
 
94
93
  ## 🛠️ Development
95
94
 
96
- This project was developed using [GitHub Spec-kit](https://github.com/github/spec-kit) (Spec-Driven Development).
97
-
98
95
  ### Prerequisites
99
96
 
100
- - Node.js 18.10+
97
+ - Node.js 22+
101
98
  - pnpm 9.1+
102
99
 
103
100
  ### Setup
104
101
 
105
102
  ```bash
106
103
  # Clone the repository
107
- git clone https://github.com/h-teske/deep-ocr-n8n.git
104
+ git clone https://github.com/Heey-Global/deep-ocr-n8n.git
108
105
  cd deep-ocr-n8n
109
106
 
110
107
  # Install dependencies
@@ -141,9 +138,9 @@ MIT
141
138
 
142
139
  ## 🤝 Contributing
143
140
 
144
- Contributions are welcome! Please read our contributing guidelines and submit pull requests to our repository.
141
+ Contributions are welcome! Please submit pull requests to our [repository](https://github.com/Heey-Global/deep-ocr-n8n).
145
142
 
146
143
  ## 📞 Support
147
144
 
148
- - [GitHub Issues](https://github.com/h-teske/deep-ocr-n8n/issues)
149
- - [Deep-OCR Documentation](https://docs.deep-ocr.com)
145
+ - [GitHub Issues](https://github.com/Heey-Global/deep-ocr-n8n/issues)
146
+ - [Deep-OCR Documentation](https://deep-ocr.com)
package/dist/credentials/DeepOcrApi.credentials.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"DeepOcrApi.credentials.d.ts","sourceRoot":"","sources":["../../src/credentials/DeepOcrApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AAEtB;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,eAAe;IAChD,IAAI,SAAgB;IACpB,WAAW,SAAkB;IAC7B,gBAAgB,SAA+B;IAE/C,UAAU,EAAE,eAAe,EAAE,CAY3B;IAEF,YAAY,EAAE,oBAAoB,CAOhC;IAEF,IAAI,EAAE,sBAAsB,CAM1B;CACH"}
1
+ {"version":3,"file":"DeepOcrApi.credentials.d.ts","sourceRoot":"","sources":["../../src/credentials/DeepOcrApi.credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,cAAc,CAAC;AAEtB;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,eAAe;IAChD,IAAI,SAAgB;IACpB,WAAW,SAAkB;IAC7B,gBAAgB,SAA0B;IAE1C,UAAU,EAAE,eAAe,EAAE,CAY3B;IAEF,YAAY,EAAE,oBAAoB,CAOhC;IAEF,IAAI,EAAE,sBAAsB,CAM1B;CACH"}
package/dist/credentials/DeepOcrApi.credentials.js CHANGED
@@ -10,7 +10,7 @@ exports.DeepOcrApi = void 0;
10
10
  class DeepOcrApi {
11
11
  name = 'deepOcrApi';
12
12
  displayName = 'Deep-OCR API';
13
- documentationUrl = 'https://docs.deep-ocr.com';
13
+ documentationUrl = 'https://deep-ocr.com';
14
14
  properties = [
15
15
  {
16
16
  displayName: 'API Key',
package/dist/credentials/DeepOcrApi.credentials.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"DeepOcrApi.credentials.js","sourceRoot":"","sources":["../../src/credentials/DeepOcrApi.credentials.ts"],"names":[],"mappings":";;;AAOA;;;;;GAKG;AACH,MAAa,UAAU;IACrB,IAAI,GAAG,YAAY,CAAC;IACpB,WAAW,GAAG,cAAc,CAAC;IAC7B,gBAAgB,GAAG,2BAA2B,CAAC;IAE/C,UAAU,GAAsB;QAC9B;YACE,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;aACf;YACD,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sDAAsD;SACpE;KACF,CAAC;IAEF,YAAY,GAAyB;QACnC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,aAAa,EAAE,iCAAiC;aACjD;SACF;KACF,CAAC;IAEF,IAAI,GAA2B;QAC7B,OAAO,EAAE;YACP,OAAO,EAAE,0BAA0B;YACnC,GAAG,EAAE,SAAS;YACd,MAAM,EAAE,KAAK;SACd;KACF,CAAC;CACH;AAnCD,gCAmCC"}
1
+ {"version":3,"file":"DeepOcrApi.credentials.js","sourceRoot":"","sources":["../../src/credentials/DeepOcrApi.credentials.ts"],"names":[],"mappings":";;;AAOA;;;;;GAKG;AACH,MAAa,UAAU;IACrB,IAAI,GAAG,YAAY,CAAC;IACpB,WAAW,GAAG,cAAc,CAAC;IAC7B,gBAAgB,GAAG,sBAAsB,CAAC;IAE1C,UAAU,GAAsB;QAC9B;YACE,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;aACf;YACD,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sDAAsD;SACpE;KACF,CAAC;IAEF,YAAY,GAAyB;QACnC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACV,OAAO,EAAE;gBACP,aAAa,EAAE,iCAAiC;aACjD;SACF;KACF,CAAC;IAEF,IAAI,GAA2B;QAC7B,OAAO,EAAE;YACP,OAAO,EAAE,0BAA0B;YACnC,GAAG,EAAE,SAAS;YACd,MAAM,EAAE,KAAK;SACd;KACF,CAAC;CACH;AAnCD,gCAmCC"}
package/dist/nodes/DeepOcr/DeepOcr.node.json CHANGED
@@ -7,7 +7,7 @@
7
7
  "resources": {
8
8
  "primaryDocumentation": [
9
9
  {
10
- "url": "https://docs.deep-ocr.com"
10
+ "url": "https://deep-ocr.com"
11
11
  }
12
12
  ]
13
13
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "n8n-nodes-deep-ocr",
3
- "version": "0.1.0",
3
+ "version": "1.1.0",
4
4
  "description": "n8n community node for Deep-OCR document processing API",
5
5
  "keywords": [
6
6
  "n8n-community-node-package",
@@ -12,33 +12,20 @@
12
12
  "structured-data"
13
13
  ],
14
14
  "license": "MIT",
15
- "homepage": "https://github.com/h-teske/deep-ocr-n8n",
15
+ "homepage": "https://github.com/Heey-Global/deep-ocr-n8n",
16
16
  "author": {
17
- "name": "Deep-OCR n8n Node Contributors"
17
+ "name": "Heey"
18
18
  },
19
19
  "repository": {
20
20
  "type": "git",
21
- "url": "https://github.com/h-teske/deep-ocr-n8n.git"
21
+ "url": "git+https://github.com/Heey-Global/deep-ocr-n8n.git"
22
22
  },
23
23
  "engines": {
24
24
  "node": ">=22.0",
25
25
  "pnpm": ">=9.1"
26
26
  },
27
- "packageManager": "pnpm@10.32.1",
28
27
  "main": "dist/index.js",
29
28
  "types": "dist/index.d.ts",
30
- "scripts": {
31
- "build": "tsc && gulp build:icons && gulp build:codex",
32
- "dev": "tsc --watch",
33
- "format": "prettier --write \"src/**/*.ts\"",
34
- "lint": "eslint src",
35
- "lint:fix": "eslint src --fix",
36
- "lint:n8n": "npx @n8n/scan-community-package ./dist",
37
- "test": "jest",
38
- "test:watch": "jest --watch",
39
- "test:coverage": "jest --coverage",
40
- "prepublishOnly": "pnpm run build"
41
- },
42
29
  "files": [
43
30
  "dist"
44
31
  ],
@@ -72,18 +59,15 @@
72
59
  "peerDependencies": {
73
60
  "n8n-workflow": "^1.0.0 || ^2.0.0"
74
61
  },
75
- "pnpm": {
76
- "overrides": {
77
- "form-data": ">=4.0.4",
78
- "fast-xml-parser": ">=4.5.4",
79
- "minimatch": ">=3.1.4 <11.0.0",
80
- "braces": ">=3.0.3",
81
- "micromatch": ">=4.0.8",
82
- "axios": ">=1.13.6",
83
- "ajv": ">=6.14.0 <9.0.0",
84
- "jws": ">=3.2.3",
85
- "qs": ">=6.14.1",
86
- "lodash": ">=4.17.23"
87
- }
62
+ "scripts": {
63
+ "build": "tsc && gulp build:icons && gulp build:codex",
64
+ "dev": "tsc --watch",
65
+ "format": "prettier --write \"src/**/*.ts\"",
66
+ "lint": "eslint src",
67
+ "lint:fix": "eslint src --fix",
68
+ "lint:n8n": "npx @n8n/scan-community-package ./dist",
69
+ "test": "jest",
70
+ "test:watch": "jest --watch",
71
+ "test:coverage": "jest --coverage"
88
72
  }
89
73
  }