@veryfi/veryfi-sdk 1.1.1 → 1.1.4

package/.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/README.md

@@ -1,7 +1,7 @@
 # Veryfi SDK for Node.js
 
-[![Node.js - version](https://img.shields.io/badge/node-%3E%3D%206.0.0-brightgreen)](https://pypi.python.org/pypi/veryfi/)
-[![npm](https://img.shields.io/badge/npm-v7.0.0-blue)](https://pypi.python.org/pypi/veryfi)
+[![Node.js - version](https://img.shields.io/badge/node-%3E%3D%206.0.0-brightgreen)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
+[![npm](https://img.shields.io/badge/npm-v7.0.0-blue)](https://www.npmjs.com/package/@veryfi/veryfi-sdk)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
 ![Veryfi Logo](https://cdn.veryfi.com/logos/veryfi-logo-wide-github.png)
@@ -18,21 +18,20 @@
     - [Response](#response)
     - [Updating a document](#updating-a-document)
   - [Need help?](#need-help)
+    - [Learn more at our blog](#learn-more-at-our-blog)
+  - [Tutorial Video](#tutorial-video)
 
 **veryfi-nodejs** is a Node.js module for communicating with the [Veryfi OCR API](https://veryfi.com/api/)
 
 ## Installation
 
-Install from [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), a
-package manager for Javascript.
-
-Install the package from npm:
+Install from [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm), a package manager for Javascript.
 
 ```bash
 npm i @veryfi/veryfi-sdk
 ```
 
-You may need to run the above commands with `sudo`.
+You may need to run the above command with `sudo`.
 
 ## Getting Started
 
@@ -42,21 +41,21 @@ If you don't have an account with Veryfi, please go ahead and register here: [ht
 
 ### Node.js API Client Library
 
-The **veryfi** library can be used to communicate with Veryfi API. All available functionality is described here <https://veryfi.github.io/veryfi-nodejs/Client.html>
+The **veryfi** library can be used to communicate with Veryfi API. All available functionality is described here: <https://veryfi.github.io/veryfi-nodejs/Client.html>
 
-Below is the sample script using **veryfi** to OCR and extract data from a document:
+Below is a sample script using **Veryfi** for OCR and extracting data from a document:
 
 ### Extracting Data
 
 ```js
-const Client = require('veryfi-sdk');
+const Client = require('@veryfi/veryfi-sdk');
 const client_id = 'your_client_id';
 const client_secret = 'your_client_secret';
 const username = 'your_username';
 const api_key = 'your_password';
 
-const categories = ['Grocery', 'Utilities', 'Travel']
-const file_path = './test/receipt.png'
+const categories = ['Grocery', 'Utilities', 'Travel'];
+const file_path = './test/receipt.png';
 ```
 
 This submits a document for processing (3-5 seconds for a response)
@@ -231,9 +230,9 @@ console.log(response);
 ### Updating a document
 
 ```js
-let = new_vendor = {"name": "Starbucks", "address": "123 Easy Str, San Francisco, CA 94158"}
-let category = "Meals & Entertainment"
-let new_total = 11.23
+let new_vendor = {"name": "Starbucks", "address": "123 Easy Str, San Francisco, CA 94158"};
+let category = "Meals & Entertainment";
+let new_total = 11.23;
 veryfi_client.update_document(id=12345,
     {
         'vendor': new_vendor,
@@ -248,4 +247,8 @@ If you run into any issue or need help installing or using the library, please c
 
 If you found a bug in this library or would like new features added, then open an issue or pull requests against this repo!
 
-To learn more about Veryfi visit <https://www.veryfi.com/>
+### [Learn more at our blog](https://www.veryfi.com/nodejs/)
+
+## Tutorial Video
+
+[![Veryfi Tutorial](https://img.youtube.com/vi/PcJdgnvyfBc/maxresdefault.jpg)](https://www.youtube.com/watch?v=PcJdgnvyfBc)

package/lib/main.js

@@ -28,10 +28,8 @@ function Client(
     this.username = username;
     this.api_key = api_key;
     this.base_url = base_url;
-    this.timeout = timeout;
     this.api_version = api_version;
-    this.headers = {};
-    CATEGORIES = [
+    this.CATEGORIES = [
         "Advertising & Marketing",
         "Automotive",
         "Bank Charges & Fees",
@@ -47,7 +45,7 @@ function Client(
         "Utilities",
         "Job Supplies",
         "Grocery",
-        ];
+    ];
 }
 
 
@@ -59,7 +57,7 @@ function Client(
  */
 Client.prototype._get_headers = function (has_files=false){
     let final_headers = {
-        "User-Agent": "Nodejs Veryfi-Nodejs/1.0.0",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.1.4",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
@@ -83,12 +81,12 @@ Client.prototype._get_url = function (){
 /**
  * Generate unique signature for payload params.
  * @private
- * @param {JSON} payload_params JSON params to be sent to API request
+ * @param {{}} payload_params JSON params to be sent to API request
  * @param {Number} timestamp Unix Long timestamp
  * @returns {string} Unique signature generated using the client_secret and the payload
  */
 Client.prototype._generate_signature = function (payload_params, timestamp){
-    var payload = `timestamp:${timestamp}`;
+    let payload = `timestamp:${timestamp}`;
     for (let i=0; i<Object.keys(payload_params).length; i++){
         let key = Object.keys(payload_params)[i];
         let value = payload_params[key];
@@ -98,8 +96,8 @@ Client.prototype._generate_signature = function (payload_params, timestamp){
     const payload_bytes = encodeURI(payload);
     let hmac = createHmac('sha256', secret_bytes);
     hmac.update(payload_bytes);
-    let tmp_signature = hmac.digest('sha256');
-    var base64_signature = Buffer.from(tmp_signature).toString('base64');
+    let tmp_signature = hmac.digest();
+    let base64_signature = Buffer.from(tmp_signature).toString('base64');
     base64_signature = Buffer.from(base64_signature).toString('utf-8').trim();
 
     return base64_signature;
@@ -110,41 +108,40 @@ Client.prototype._generate_signature = function (payload_params, timestamp){
  * @private
  * @param {string} http_verb HTTP Method
  * @param {string} endpoint_name Endpoint name such as 'documents', 'users', etc.
- * @param {JSON} request_arguments JSON payload to send to Veryfi
+ * @param {{}} request_arguments JSON payload to send to Veryfi
+ * @param file_stream file stream of the document
  * @returns {JSON} A JSON of the response data.
  */
 Client.prototype._request = async function (http_verb, endpoint_name, request_arguments, file_stream=null){
     let has_files = (Boolean(file_stream));
-    let headers = this._get_headers(has_files=has_files);
+    let headers = this._get_headers(has_files);
     let api_url = `${this._get_url()}/partner${endpoint_name}`;
 
     if (this.client_secret){
         let timestamp = Date.now();
-        let signature = this._generate_signature(request_arguments, timestamp=timestamp);
+        let signature = this._generate_signature(request_arguments, timestamp);
         headers = Object.assign(headers,{"X-Veryfi-Request-Timestamp": timestamp,
                                         "X-Veryfi-Request-Signature": signature});
     }
 
-    if (has_files==false) {
+    if (has_files === false) {
         request_arguments = JSON.stringify(request_arguments);
     } else {
-        Object.assign(headers,{...request_arguments.getHeaders()});
+        Object.assign(headers,{...request_arguments});
     }
 
     try {
-        const response = await axios.request({
-            method : http_verb,
-            url : api_url,
-            headers : headers,
-            data : request_arguments,
-            timeout : this.timeout * 1000
+        return await axios.request({
+            method: http_verb,
+            url: api_url,
+            headers: headers,
+            data: request_arguments,
+            timeout: this.timeout * 1000
         });
-        return response;
     } catch (response) {
-        console.log(response);
         let Err = new VeryfiClientError(response,response['response']['data']);
         let err_msg = Err.from_response(response['response']);
-        throw new Error(err_msg['status'],err_msg['error']);
+        throw new Error(err_msg['status'] + err_msg['error']);
     }
 }
 
@@ -167,7 +164,7 @@ Client.prototype.get_documents = async function (){
 /**
  * Retrieve document by ID
  * @memberof Client
- * @param {Number} document_id ID of the document you'd like to retrieve
+ * @param {string} document_id ID of the document you'd like to retrieve
  * @returns {JSON} Data extracted from the Document
  */
 Client.prototype.get_document = async function (document_id) {
@@ -201,17 +198,57 @@ Client.prototype.process_document = async function (
     
     let endpoint_name = "/documents/";
     if (!categories){
-        categories = CATEGORIES;
+        categories = this.CATEGORIES;
     }
     let file_name = path.basename(file_path)
     const image_file = fs.readFileSync(file_path, {encoding: 'base64'});
-    var base64_encoded_string = Buffer.from(image_file).toString('utf-8');
-    var request_arguments = {
+    const base64_encoded_string = Buffer.from(image_file).toString('utf-8');
+    let request_arguments = {
         "file_name": file_name,
         "file_data": base64_encoded_string,
         "categories": categories,
         "auto_delete": delete_after_processing,
+    };
+    request_arguments = Object.assign(request_arguments,kwargs)
+    let document = await this._request("POST", endpoint_name, request_arguments)
+    return document['data'];
+}
+
+/**
+ * Process a document and extract all the fields from it
+ * @example
+ * veryfi_client.process_document_buffer('base64_encoded_string',
+ *                                'receipt.png',
+ *                                ['Entertainment','Food'], 
+ *                                true, 
+ *                                {'extra': 'parameters'})
+ * 
+ * @memberof Client
+ * @param {String} base64_encoded_string Buffer of a file to submit for data extraction
+ * @param {String} file_name The file name including the extension
+ * @param {Array} categories List of categories Veryfi can use to categorize the document
+ * @param {Boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+ * @param {Object} kwargs Additional request parameters
+ * @returns {JSON} Data extracted from the document
+ */
+Client.prototype.process_document_buffer = async function (
+        base64_encoded_string,
+        file_name,
+        categories = null,
+        delete_after_processing = false,
+        {...kwargs} = {}
+    ) {
+    
+    let endpoint_name = "/documents/";
+    if (!categories){
+        categories = this.CATEGORIES;
     }
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": base64_encoded_string,
+        "categories": categories,
+        "auto_delete": delete_after_processing,
+    };
     request_arguments = Object.assign(request_arguments,kwargs)
     let document = await this._request("POST", endpoint_name, request_arguments)
     return document['data'];
@@ -219,6 +256,9 @@ Client.prototype.process_document = async function (
 
 /**
  * Process document from url and extract all the fields from it.
+ * @example
+ * veryfi_client.process_document_url('https://cdn.example.com/receipt.jpg')
+ *
  * @memberof Client
  * @param {string} file_url Required if file_urls isn't specified. Publicly accessible URL to a file, e.g. "https://cdn.example.com/receipt.jpg".
  * @param {Array} file_urls Required if file_url isn't specified. List of publicly accessible URLs to multiple files, e.g. ["https://cdn.example.com/receipt1.jpg", "https://cdn.example.com/receipt2.jpg"]
@@ -231,17 +271,20 @@ Client.prototype.process_document = async function (
  * @return {JSON} Data extracted from the document.
  */
 Client.prototype.process_document_url = async function (
-        file_url = null,
+        file_url = "",
+        file_urls = null,
         categories = null,
         delete_after_processing = false,
         boost_mode = 0,
-        external_id = null,
-        max_pages_to_process = null,
-        file_urls = null,
+        external_id = "",
+        max_pages_to_process = 1,
         {...kwargs} = {},
     ) {
     let endpoint_name = "/documents/";
-    var request_arguments = {
+    if (!categories){
+        categories = this.CATEGORIES;
+    }
+    let request_arguments = {
         "auto_delete": delete_after_processing,
         "boost_mode": boost_mode,
         "categories": categories,
@@ -259,13 +302,13 @@ Client.prototype.process_document_url = async function (
  * Delete document from Veryfi
  * 
  * @memberof Client
- * @param {Number} document_id ID of the document you'd like to delete
+ * @param {string} document_id ID of the document you'd like to delete
  */
 Client.prototype.delete_document = async function (document_id){
-    
     let endpoint_name = `/documents/${document_id}/`;
     let request_arguments = {"id": document_id};
-    await this._request("DELETE", endpoint_name, request_arguments);
+    let response = await this._request("DELETE", endpoint_name, request_arguments);
+    return response;
 }
 
 /**
@@ -274,7 +317,7 @@ Client.prototype.delete_document = async function (document_id){
  * veryfi_client.update_document(id, {date:"2021-01-01", notes:"look what I did"})
  * 
  * @memberof Client
- * @param {Number} document_id ID of the document you'd like to update
+ * @param {string} document_id ID of the document you'd like to update
  * @param {Object} kwargs fields to update
  * @return {JSON} A document json with updated fields, if fields are writable. Otherwise a document with unchanged fields.
  */
@@ -286,4 +329,4 @@ Client.prototype.update_document = async function (document_id, {...kwargs} = {}
 
 // Exports
 
-module.exports = Client;
+module.exports = Client;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.1.1",
+  "version": "1.1.4",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/main.js",
   "scripts": {

package/test/deleteDocument.json

@@ -0,0 +1,4 @@
+{
+  "status":"ok",
+  "message":"Document has been deleted"
+}

package/test/getDocument.json

@@ -0,0 +1,111 @@
+{
+  "abn_number":"",
+  "account_number":"",
+  "barcodes":[
+
+  ],
+  "bill_to_address":"",
+  "bill_to_name":"",
+  "card_number":"",
+  "category":"Meals",
+  "created":"2021-02-04 00:19:07",
+  "currency_code":"COP",
+  "date":"2021-01-24 19:40:00",
+  "delivery_date":"",
+  "discount":0.0,
+  "document_title":"",
+  "document_type":"receipt",
+  "due_date":"",
+  "external_id":"",
+  "id":31727276,
+  "img_file_name":"c55c3a43-06ca-4da7-b780-60768d7f6155.jpg",
+  "img_thumbnail_url":"https://scdn.veryfi.com/receipts/c55c3a43-06ca-4da7-b780-60768d7f6155_1_t.jpg?Expires=1626052133&Signature=bQfb8nYHxKeQzaibhQv6lznNTM980DXxicImi9PFbb-iP9yejag4mgzacCcaOIoXEQms-L-EzmpHzpI6Y6q8pzfy5vhS8x2KjqZ2N2iGRadolKTsHTfuQCZdC2tassH~0faTnJ9L2NDrPlU97mnc06Nqa6graAj1zJ7uKOITeF4ONhVWVrj1cRM~lOFqwq9Gk5Xf9-uRVQPan0d7gpAbdx1sZE25ImphkzQen5IaduEvd6k4vhlHeqeOfj911Z8ReAXz2MWEgPuRcgj7H9DwHATiQMR6M4ft40d7zBd2TjyKRuSgH~fDfq8CFLLAtxoo6mhaawi-HIZi~4kwFDRQKg__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+  "img_url":"https://scdn.veryfi.com/receipts/c55c3a43-06ca-4da7-b780-60768d7f6155.jpg?Expires=1626052133&Signature=bi4gQP2IOjPy1IsFk4apCdBOQLOOwxWZIM3xPTs-Ojzz7gJEQ5Jt6oc5gcR898rA8FrNJ-1RjzzxMiW5p3lPNcnXyeiWj8IH9HG45cb0M0-TK~YUsFjFRVXpflSN9PB5Xb3R56Mq1HPN2xTCE~o2lhnJyQEK52u--n4nyX4dg7aMQc7DLBuidqFZoB4eNrvPZ7q1uDpT~hcrD5x4i26g7owfiGTKsh60OwpljIcQV61vNqJxcyyVD6Dlk9pl-5MJZGQxUKWeuwY76fg6zUtuUqgRL1he2DKjOSLwNGbLTmFGcNq6R0AvHs45gtyMNKn5SdttvWnQJagHZl4tG8DF7g__&Key-Pair-Id=APKAJCILBXEJFZF4DCHQ",
+  "incoterms":"",
+  "insurance":"",
+  "invoice_number":"1381884",
+  "is_document":1,
+  "is_money_in":0,
+  "line_items":[
+    {
+      "date":"",
+      "description":"MimVaiCucManiChoco",
+      "discount":0.0,
+      "id":32895461,
+      "order":0,
+      "price":0.0,
+      "quantity":10.0,
+      "reference":"",
+      "section":"",
+      "sku":"",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":5900.0,
+      "type":"food",
+      "unit_of_measure":"",
+      "weight":""
+    },
+    {
+      "date":"",
+      "description":"",
+      "discount":0.0,
+      "id":32895462,
+      "order":1,
+      "price":0.0,
+      "quantity":10.0,
+      "reference":"",
+      "section":"",
+      "sku":"",
+      "tax":0.0,
+      "tax_rate":0.0,
+      "total":5900.0,
+      "type":"",
+      "unit_of_measure":"",
+      "weight":""
+    }
+  ],
+  "notes":"",
+  "ocr_text":"\nSomos Regimen Comun\nNo Somos Retenedores del IVA\nP.C.A PRODUCTORA Y COMERCIALIZADORA DE\nALIMENTOS S.A.S\nDG 51 35 12 CC PUERTA DEL NORTE\nNIT:890,912,221-4\nFactura de Venta Nro. 859 1381884\nNeg Pto Ter Fecha\tCajero\n001 859 001 24/01/2021 19:40 859\nDescripcion\tCant Valor\nMimVaiCucManiChoco 1.0 5,900.\n* Subtotal *\t\t5,900.\nCantidad Bolsas(*)\t\t0\nImpuesto Bolsas(*)\t\t0\n** T O T A L **\t5,900.\nEFECTIVO\t\t\t20,000.\nCAMBIO\t\t\t14,100.\n%\tBase Imp.\tTotal\n0\t5,900.\t0. 5,900.\nMIMO'S EXITO BELLO TEL 481 05 06\nResolucion Facturacion DIAN Nro\n18763003974691 Feb 4 2020\nAutorizacion Rango 859-1142814 al 859-138\n2856 Vigencia 12 Meses\n",
+  "order_date":"",
+  "payment_display_name":"Cash",
+  "payment_terms":"",
+  "payment_type":"cash",
+  "phone_number":"",
+  "purchase_order_number":"",
+  "reference_number":"VBDHC-7276",
+  "service_end_date":"",
+  "service_start_date":"",
+  "ship_date":"",
+  "shipping":0.0,
+  "subtotal":5900.0,
+  "tags":[
+
+  ],
+  "tax":0,
+  "tax_lines":[
+
+  ],
+  "tip":0.0,
+  "total":0.0,
+  "total_weight":"",
+  "tracking_number":"",
+  "updated":"2021-02-04 00:19:10",
+  "vat_number":"890,912,221-4",
+  "vendor":{
+    "address":"DG 51 35 12 CC PUERTA DEL NORTE",
+    "fax_number":"",
+    "name":"P.c.a Productora Y Comercializadora De",
+    "phone_number":"",
+    "raw_name":"P.C.A PRODUCTORA Y COMERCIALIZADORA DE",
+    "vendor_logo":"https://cdn.veryfi.com/logos/tmp/397947509.png",
+    "vendor_type":""
+  },
+  "vendor_account_number":"",
+  "vendor_bank_name":"",
+  "vendor_bank_number":"",
+  "vendor_bank_swift":"",
+  "vendor_iban":"",
+  "warnings":[
+
+  ]
+}