fuse-importer 0.25.0 → 0.25.1

package/README.md

@@ -98,8 +98,8 @@ If you don’t have an Importer yet, you can go over [Create Your First Importer
       const importer = new FuseImporter(organizationApiKey, importerId);
 
       importer.onValidateRecord = async (record) => {
-        // return no frontend validation errors
-        return {};
+        // return no frontend validation errors or warnings
+        return { errors: {}, warnings: {} };
       };
 
       importer.onSubmit = async (records) => {
@@ -184,9 +184,8 @@ The `onValidationRecord` hook is called for each row (record) that a customer up
 
 Return values:
 
-- If the record has no errors, we expect you to return an empty object: `return {}`.
-- If the record has validation errors, you can specify them like below.
-- If the record has validation warnings, you can specify them like so:
+- If the record has no errors, we expect you to return an empty object: `return { errors : {}, warnings: {} }`.
+- If the record has validation errors/warnings, you can specify them like below.
 
 ```typescript
 importer.onValidateRecord = async (record) => {
@@ -207,7 +206,11 @@ importer.onValidateRecord = async (record) => {
 };
 ```
 
-`warnings` will still allow you to submit the spreadsheet, unlike `errors`.
+The differences between errors and warnings are:
+
+- `warnings` will still allow you to submit the spreadsheet, unlike `errors`.
+- `errors` have a higher priority than warnings, which means if a record has both, you will not be able to see warnings until you fix errors first.
+- Any `errors` must be fixed before the user submits an importer. The user will not be able to submit without fixing all errors.
 
 #### `formatRecord`