feat: add custom validator callbacks

Author: dboskovic

.tool-versions

@@ -1 +1 @@
-nodejs 4.8.0
+nodejs 10.16.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "flatfile-csv-importer",
-  "version": "0.1.16",
+  "version": "0.1.17",
   "description": "A simple adapter for elegantly importing CSV files via flatfile.io (Typescript, ES6, Browser)",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",
@@ -33,6 +33,7 @@
     "send-coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
     "docs": "yarn docs:html && opn build/docs/index.html",
     "docs:html": "typedoc src/index.ts --excludePrivate --mode file --theme default --out build/docs --includeDeclarations --excludeExternals",
+    "docs:md": "typedoc src --readme none --theme markdown --excludePrivate --mode file --out ../Developers/docs/sdk --includeDeclarations --excludeExternals --platform docusaurus",
     "docs:json": "typedoc --mode file --json build/docs/typedoc.json src/index.ts",
     "docs:publish": "yarn docs:html && gh-pages -d build/docs",
     "changelog": "standard-version",
@@ -81,7 +82,8 @@
     "trash-cli": "^1.4.0",
     "tslint": "^5.4.3",
     "tslint-config-standard": "^6.0.1",
-    "typedoc": "^0.8.0",
+    "typedoc": "^0.15.0",
+    "typedoc-plugin-markdown": "^2.1.0",
     "typescript": "^2.4.1",
     "uglify-js": "^3.3.4"
   },

src/index.ts

@@ -10,6 +10,7 @@ import Meta from './obj.meta'
 import RecordObject from './obj.record'
 import CustomerObject from './obj.customer'
 import LoadOptionsObject from './obj.load-options'
+import IValidationResponse from './obj.validation-response'
 
 export default class FlatfileImporter extends EventEmitter {
 
@@ -30,6 +31,7 @@ export default class FlatfileImporter extends EventEmitter {
 
   private $resolver: (data: any) => any
   private $rejecter: (err: any) => any
+  private $validatorCallback?: (row: {[key: string]: string | number}) => Array<IValidationResponse> | Promise<Array<IValidationResponse>>
 
   constructor (apiKey: string, options: object, customer?: CustomerObject) {
     super()
@@ -175,6 +177,16 @@ export default class FlatfileImporter extends EventEmitter {
     })
   }
 
+  /**
+   * Set the customer information for this import
+   */
+  registerValidatorCallback (callback: FlatfileImporter['$validatorCallback']): void {
+    this.$validatorCallback = callback
+    this.$ready.then((child) => {
+      child.parentHasValidator()
+    })
+  }
+
   /**
    * Call close() from the parent window in order to hide the importer. You can do this after
    * handling the import callback so your users don't have to click the confirmation button
@@ -230,9 +242,15 @@ export default class FlatfileImporter extends EventEmitter {
           this.emit('close')
           this.handleClose()
         },
+        validatorCallback: (row) => {
+          return this.$validatorCallback ? this.$validatorCallback(row) : undefined
+        },
         ready: () => {
           this.handshake.promise.then((child) => {
             this.$resolver(child)
+            if (this.customer) {
+              child.setUser(this.customer)
+            }
           }).catch((err) => {
             console.error(err)
           })

src/obj.validation-response.ts

@@ -0,0 +1,16 @@
+export default interface IValidationResponse {
+  /**
+   * A string referencing the key affected by the problem
+   */
+  key: string
+
+  /**
+   * The validation error message
+   */
+  message: string
+
+  /**
+   * The type of validation response - currently only 'error' is supported
+   */
+  level?: 'error'
+}