@veryfi/veryfi-sdk 1.1.4 → 1.2.0

package/README.md

@@ -41,7 +41,7 @@ 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/>
 
 Below is a sample script using **Veryfi** for OCR and extracting data from a document:
 
@@ -251,4 +251,4 @@ If you found a bug in this library or would like new features added, then open a
 
 ## Tutorial Video
 
-[![Veryfi Tutorial](https://img.youtube.com/vi/PcJdgnvyfBc/maxresdefault.jpg)](https://www.youtube.com/watch?v=PcJdgnvyfBc)
+[![Veryfi Tutorial](https://img.youtube.com/vi/PcJdgnvyfBc/maxresdefault.jpg)](https://www.youtube.com/watch?v=PcJdgnvyfBc)

package/lib/main.js

@@ -2,7 +2,6 @@ const {createHmac} = require('crypto');
 const axios = require('axios').default;
 const path = require('path');
 const fs = require('fs');
-const VeryfiClientError = require('./errors');
 
 /**
  * Create instance of a Client
@@ -11,18 +10,18 @@ const VeryfiClientError = require('./errors');
  * @param {string} client_secret Your Veryfi client secret
  * @param {string} username Your Veryfi username
  * @param {string} api_key Your Veryfi API key
- * @param {string} base_url 
- * @param {string} api_version 
- * @param {Number} timeout 
+ * @param {string} base_url
+ * @param {string} api_version
+ * @param {Number} timeout
  */
 function Client(
-        client_id,
-        client_secret,
-        username,
-        api_key,
-        base_url="https://api.veryfi.com/api/",
-        api_version="v7",
-        timeout=120,) {
+    client_id,
+    client_secret,
+    username,
+    api_key,
+    base_url = "https://api.veryfi.com/",
+    api_version = "v8",
+    timeout = 120,) {
     this.client_id = client_id;
     this.client_secret = client_secret;
     this.username = username;
@@ -48,6 +47,14 @@ function Client(
     ];
 }
 
+/**
+ * Check api version for w2 documents
+ * @private
+ * @throws if api_version is different to v8
+ */
+Client.prototype._check_w2_version = function () {
+    if (this.api_version !== "v8") throw Error("w2 is only supported on v8")
+}
 
 /**
  * Prepares the headers needed for a request.
@@ -55,15 +62,15 @@ function Client(
  * @param {Boolean} has_files Are there any files to be submitted as binary
  * @return {Object} Dictionary with headers
  */
-Client.prototype._get_headers = function (has_files=false){
+Client.prototype._get_headers = function (has_files = false) {
     let final_headers = {
-        "User-Agent": "Node.js Veryfi-Nodejs/1.1.4",
+        "User-Agent": "Node.js Veryfi-Nodejs/1.2.0",
         "Accept": "application/json",
         "Content-Type": "application/json",
         "Client-Id": this.client_id,
         "Authorization": `apikey ${this.username}:${this.api_key}`,
     };
-    if (has_files){
+    if (has_files) {
         final_headers["Content-Type"] = "application/x-www-form-urlencoded";
     }
     return final_headers;
@@ -74,8 +81,8 @@ Client.prototype._get_headers = function (has_files=false){
  * @private
  * @returns {string} Base URL to Veryfi API
  */
-Client.prototype._get_url = function (){
-    return this.base_url + this.api_version;
+Client.prototype._get_url = function () {
+    return this.base_url + "api/" + this.api_version;
 }
 
 /**
@@ -85,9 +92,9 @@ Client.prototype._get_url = function (){
  * @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){
+Client.prototype._generate_signature = function (payload_params, timestamp) {
     let payload = `timestamp:${timestamp}`;
-    for (let i=0; i<Object.keys(payload_params).length; i++){
+    for (let i = 0; i < Object.keys(payload_params).length; i++) {
         let key = Object.keys(payload_params)[i];
         let value = payload_params[key];
         payload = `${payload},${key}:${value}`;
@@ -112,22 +119,24 @@ Client.prototype._generate_signature = function (payload_params, timestamp){
  * @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){
+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);
     let api_url = `${this._get_url()}/partner${endpoint_name}`;
 
-    if (this.client_secret){
+    if (this.client_secret) {
         let timestamp = Date.now();
         let signature = this._generate_signature(request_arguments, timestamp);
-        headers = Object.assign(headers,{"X-Veryfi-Request-Timestamp": timestamp,
-                                        "X-Veryfi-Request-Signature": signature});
+        headers = Object.assign(headers, {
+            "X-Veryfi-Request-Timestamp": timestamp,
+            "X-Veryfi-Request-Signature": signature
+        });
     }
 
     if (has_files === false) {
         request_arguments = JSON.stringify(request_arguments);
     } else {
-        Object.assign(headers,{...request_arguments});
+        Object.assign(headers, {...request_arguments});
     }
 
     try {
@@ -139,9 +148,9 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
             timeout: this.timeout * 1000
         });
     } catch (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']);
+        let errorStatus = response['response']['status'];
+        let errorInfo = response['response']['data']['error'];
+        throw new Error(errorStatus + errorInfo);
     }
 }
 
@@ -151,12 +160,12 @@ Client.prototype._request = async function (http_verb, endpoint_name, request_ar
  * @memberof Client
  * @returns {JSON} JSON object of previously processed documents
  */
-Client.prototype.get_documents = async function (){
+Client.prototype.get_documents = async function () {
     let endpoint_name = "/documents/";
     let request_arguments = {};
     let documents = await this._request("GET", endpoint_name, request_arguments);
-    if ("data" in documents){
-        return documents["data"];
+    if ("data" in documents) {
+        documents = documents["data"];
     }
     return documents;
 }
@@ -178,10 +187,10 @@ Client.prototype.get_document = async function (document_id) {
  * Process a document and extract all the fields from it
  * @example
  * veryfi_client.process_document('file/path',
- *                                ['Entertainment','Food'], 
- *                                true, 
+ *                                ['Entertainment','Food'],
+ *                                true,
  *                                {"extra":"parameters"})
- * 
+ *
  * @memberof Client
  * @param {String} file_path Path on disk to a file to submit for data extraction
  * @param {Array} categories List of categories Veryfi can use to categorize the document
@@ -190,14 +199,14 @@ Client.prototype.get_document = async function (document_id) {
  * @returns {JSON} Data extracted from the document
  */
 Client.prototype.process_document = async function (
-        file_path,
-        categories = null,
-        delete_after_processing = false,
-        {...kwargs} = {}
-    ) {
-    
+    file_path,
+    categories = null,
+    delete_after_processing = false,
+    {...kwargs} = {}
+) {
+
     let endpoint_name = "/documents/";
-    if (!categories){
+    if (!categories) {
         categories = this.CATEGORIES;
     }
     let file_name = path.basename(file_path)
@@ -209,7 +218,7 @@ Client.prototype.process_document = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments,kwargs)
+    request_arguments = Object.assign(request_arguments, kwargs)
     let document = await this._request("POST", endpoint_name, request_arguments)
     return document['data'];
 }
@@ -219,10 +228,10 @@ Client.prototype.process_document = async function (
  * @example
  * veryfi_client.process_document_buffer('base64_encoded_string',
  *                                'receipt.png',
- *                                ['Entertainment','Food'], 
- *                                true, 
+ *                                ['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
@@ -232,15 +241,15 @@ Client.prototype.process_document = async function (
  * @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} = {}
-    ) {
-    
+    base64_encoded_string,
+    file_name,
+    categories = null,
+    delete_after_processing = false,
+    {...kwargs} = {}
+) {
+
     let endpoint_name = "/documents/";
-    if (!categories){
+    if (!categories) {
         categories = this.CATEGORIES;
     }
     let request_arguments = {
@@ -249,7 +258,7 @@ Client.prototype.process_document_buffer = async function (
         "categories": categories,
         "auto_delete": delete_after_processing,
     };
-    request_arguments = Object.assign(request_arguments,kwargs)
+    request_arguments = Object.assign(request_arguments, kwargs)
     let document = await this._request("POST", endpoint_name, request_arguments)
     return document['data'];
 }
@@ -271,17 +280,17 @@ Client.prototype.process_document_buffer = async function (
  * @return {JSON} Data extracted from the document.
  */
 Client.prototype.process_document_url = async function (
-        file_url = "",
-        file_urls = null,
-        categories = null,
-        delete_after_processing = false,
-        boost_mode = 0,
-        external_id = "",
-        max_pages_to_process = 1,
-        {...kwargs} = {},
-    ) {
+    file_url = "",
+    file_urls = null,
+    categories = null,
+    delete_after_processing = false,
+    boost_mode = 0,
+    external_id = "",
+    max_pages_to_process = 1,
+    {...kwargs} = {},
+) {
     let endpoint_name = "/documents/";
-    if (!categories){
+    if (!categories) {
         categories = this.CATEGORIES;
     }
     let request_arguments = {
@@ -293,40 +302,158 @@ Client.prototype.process_document_url = async function (
         "file_urls": file_urls,
         "max_pages_to_process": max_pages_to_process,
     };
-    request_arguments = Object.assign(request_arguments,kwargs)
+    request_arguments = Object.assign(request_arguments, kwargs)
     let response = await this._request("POST", endpoint_name, request_arguments);
     return response['data'];
 }
 
 /**
  * Delete document from Veryfi
- * 
+ *
  * @memberof Client
  * @param {string} document_id ID of the document you'd like to delete
  */
-Client.prototype.delete_document = async function (document_id){
+Client.prototype.delete_document = async function (document_id) {
     let endpoint_name = `/documents/${document_id}/`;
     let request_arguments = {"id": document_id};
-    let response = await this._request("DELETE", endpoint_name, request_arguments);
-    return response;
+    return this._request("DELETE", endpoint_name, request_arguments);
 }
 
 /**
  * Update data for a previously processed document, including almost any field like `vendor`, `date`, `notes` and etc.
  * @example
  * veryfi_client.update_document(id, {date:"2021-01-01", notes:"look what I did"})
- * 
+ *
  * @memberof Client
  * @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.
  */
-Client.prototype.update_document = async function (document_id, {...kwargs} = {}){
+Client.prototype.update_document = async function (document_id, {...kwargs} = {}) {
     let endpoint_name = `/documents/${document_id}/`;
     let response = await this._request("PUT", endpoint_name, kwargs);
     return response['data'];
 }
 
+/**
+ * Get all w2 documents.
+ * @memberOf Client
+ * @return {Array} An array of JSON with all w2 documents.
+ */
+Client.prototype.get_w2_documents = async function () {
+    this._check_w2_version()
+    let endpoint_name = "/w2s/"
+    let request_arguments = {}
+    let response = await this._request("GET", endpoint_name, request_arguments)
+    return response['data']['results']
+}
+
+/**
+ * Get a w2 document
+ * @memberOf Client
+ * @param {string} document_id ID of the document you'd like to retrieve
+ * @returns {JSON} Data extracted from the Document
+ */
+Client.prototype.get_w2_document = async function (
+    document_id,
+) {
+    this._check_w2_version()
+    let endpoint_name = `/w2s/${document_id}/`
+    let request_arguments = {"id": document_id}
+    let response = await this._request("GET", endpoint_name, request_arguments)
+    return response['data']
+}
+
+/**
+ * Upload a document from a buffer.
+ * @memberOf Client
+ * @param {String} file_name The file name including the extension
+ * @param {String} file_buffer Buffer of a file to submit for data extraction
+ * @param {boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+ * @param {int} max_pages_to_process When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_document_from_buffer = async function (
+    file_name,
+    file_buffer,
+    delete_after_processing = null,
+    max_pages_to_process = null,
+    {...kwargs} = {}
+) {
+    this._check_w2_version()
+    let endpoint_name = "/w2s/"
+    let request_arguments = {
+        "file_name": file_name,
+        "file_data": file_buffer,
+        "auto_delete": delete_after_processing,
+        "max_pages_to_process": max_pages_to_process,
+    }
+    request_arguments = Object.assign(request_arguments, kwargs)
+    let response = await this._request("POST", endpoint_name, request_arguments)
+    return response['data']
+}
+
+/**
+ * Upload a document from a file path
+ * @param {String} file_path Path on disk to a file to submit for data extraction
+ * @param {boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+ * @param {int} max_pages_to_process When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_document = async function (
+    file_path,
+    delete_after_processing = false,
+    max_pages_to_process = 1,
+    {...kwargs} = {}
+) {
+    const file_name = path.basename(file_path)
+    const image_file = fs.readFileSync(file_path, {encoding: 'base64'})
+    const base64_encoded_string = Buffer.from(image_file).toString('utf-8')
+    return this.process_w2_document_from_buffer(
+        file_name,
+        base64_encoded_string,
+        delete_after_processing,
+        max_pages_to_process,
+        kwargs
+    )
+}
+
+/**
+ * Process a w2 document from an url.
+ * @memberOf Client
+ * @param {String} file_name The file name including the extension
+ * @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"]
+ * @param {boolean} delete_after_processing Delete this document from Veryfi after data has been extracted
+ * @param {int} max_pages_to_process When sending a long document to Veryfi for processing, this parameter controls how many pages of the document will be read and processed, starting from page 1.
+ * @param {Object} kwargs Additional request parameters
+ * @return {JSON} Data extracted from the document.
+ */
+Client.prototype.process_w2_document_from_url = async function (
+    file_name,
+    file_url,
+    file_urls = null,
+    delete_after_processing = false,
+    max_pages_to_process = 1,
+    {...kwargs} = {}
+) {
+    this._check_w2_version()
+    let endpoint_name = "/w2s/"
+    let request_arguments = {
+        "file_name": file_name,
+        "auto_delete": delete_after_processing,
+        "file_url": file_url,
+        "file_urls": file_urls,
+        "max_pages_to_process": max_pages_to_process
+    }
+    request_arguments = Object.assign(request_arguments, kwargs)
+    let response = await this._request("POST", endpoint_name, request_arguments)
+    return response['data']
+}
+
 // Exports
 
 module.exports = Client;

package/{types → lib/types}/main.d.ts

@@ -40,6 +40,7 @@ export declare type VeryfiDocument = {
   notes?: null | string;
   ocr_text?: null | string;
   order_date?: null | string;
+  payment?: null | Payment;
   payment_display_name?: null | string;
   payment_terms?: null | string;
   payment_type?: null | string;
@@ -114,6 +115,13 @@ declare type Vendor = {
   web?: null | string;
 };
 
+declare type Payment = {
+  card_number?: null | string;
+  display_name?: null | string;
+  terms?: null | number;
+  type?: null | string;
+};
+
 export declare class Client {
   /**
    * Create instance of a Client

package/package.json

@@ -1,29 +1,41 @@
 {
   "name": "@veryfi/veryfi-sdk",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "Node.js module for communicating with the Veryfi OCR API",
   "main": "lib/main.js",
+  "typings": "types/main.d.ts",
   "scripts": {
     "test": "jest",
     "doc": "jsdoc -d docs --configure jsconf.json main.js",
-    "generate-docs": "jsdoc --configure .jsdoc.json --verbose"
+    "generate-docs": "jsdoc --configure jsdoc.json --verbose"
   },
   "author": "Veryfi <support@veryfi.com> (https://www.veryfi.com)",
   "homepage": "https://veryfi.github.io/veryfi-nodejs/",
   "contributors": [
-    "Matthew Eng <matthew@veryfi.com>"
+    "Matthew Eng <matthew@veryfi.com>",
+    "Alejandro Uribe <alejandro@veryfi.com>"
   ],
   "license": "MIT",
+  "files": [
+    "lib",
+    "lib/types"
+  ],
   "directories": {
     "lib": "lib",
     "test": "test"
   },
   "devDependencies": {
-    "jest": "^27.0.5",
-    "jsdoc": "^3.6.7"
+    "jest": "^29.0.0",
+    "jsdoc": "^3.6.7",
+    "minami": "^1.2.3",
+    "ts-jest": "^29.0.1",
+    "typescript": "^4.8.3"
   },
   "dependencies": {
-    "axios": "^0.21.1"
+    "@jest/globals": "^29.0.3",
+    "axios": "^0.21.1",
+    "docdash": "^1.2.0",
+    "jest-config": "^29.0.3"
   },
   "repository": {
     "type": "git",

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

@@ -1,31 +0,0 @@
-# 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/lib/errors.js

@@ -1,36 +0,0 @@
-let VeryfiClientError = function (raw_response, error_info) {
-    this.raw_response = raw_response['response'];
-    this.status = this.raw_response['status'];
-    this.error_info = error_info['error']
-}
-
-        
-/** Veryfi API returns error messages with a json body
- * like:
- * {
- *     'status': 'fail',
- *     'error': 'Human readable error description.'
- * }
- */
-VeryfiClientError.prototype.from_response = function (raw_response){
-    try{
-        error_cls = _error_map[this.status]
-    } catch (KeyError) {
-        console.error(
-            "Unknown error Please contact customer support at support@veryfi.com."
-        )
-    }
-    
-    return {'status':error_cls, 'error':this.error_info}
-}
-
-_error_map = {
-    400: 'BadRequest',
-    401: 'UnauthorizedAccessToken',
-    404: 'NotFound',
-    405: 'UnexpectedHTTPMethod',
-    409: 'AccessLimitReached',
-    500: 'InternalError',
-}
-
-module.exports = VeryfiClientError;

package/test/deleteDocument.json

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