validator: company

flatfilers/sandbox/src/index.ts

@@ -1,30 +1,50 @@
-import type { FlatfileEvent, FlatfileListener } from '@flatfile/listener'
-import { automap } from '@flatfile/plugin-automap'
-import { DelimiterExtractor } from '@flatfile/plugin-delimiter-extractor'
-import { ExcelExtractor } from '@flatfile/plugin-xlsx-extractor'
+import type { FlatfileListener } from '@flatfile/listener'
+import { companyValidationPlugin } from '@flatfile/plugin-company-validator'
+import { configureSpace } from '@flatfile/plugin-space-configure'
 
 export default async function (listener: FlatfileListener) {
   listener.use(
-    ExcelExtractor({
-      skipEmptyLines: true,
+    companyValidationPlugin({
+      sheetSlug: 'companies',
+      validateAddress: true,
+      validateEIN: true,
     })
   )
   listener.use(
-    DelimiterExtractor('txt', { delimiter: ',', skipEmptyLines: true })
-  )
-
-  listener.use(
-    automap({
-      accuracy: 'confident',
-      defaultTargetSheet: 'contacts',
-      matchFilename: /test/,
-      debug: true,
-      onFailure: (event: FlatfileEvent) => {
-        // send an SMS, an email, post to an endpoint, etc.
-        console.error(
-          `Please visit https://spaces.flatfile.com/space/${event.context.spaceId}/files?mode=import to manually import file.`
-        )
-      },
+    configureSpace({
+      workbooks: [
+        {
+          name: 'Sandbox',
+          sheets: [
+            {
+              name: 'Companies',
+              slug: 'companies',
+              fields: [
+                {
+                  key: 'company_name',
+                  type: 'string',
+                  label: 'Name',
+                },
+                {
+                  key: 'company_website',
+                  type: 'string',
+                  label: 'Website',
+                },
+                {
+                  key: 'company_address',
+                  type: 'string',
+                  label: 'Address',
+                },
+                {
+                  key: 'company_ein',
+                  type: 'string',
+                  label: 'EIN',
+                },
+              ],
+            },
+          ],
+        },
+      ],
     })
   )
 }

validators/company-validator/README.MD

@@ -0,0 +1,75 @@
+<!-- START_INFOCARD -->
+
+# @flatfile/plugin-company-validator
+**Validate company information including name, website, address, and EIN.**
+
+The `@flatfile/plugin-company-validator` plugin is a validator that will validate company information including name, website, address, and EIN.
+
+**Event Type:**
+`listener.on('commit:created')`
+
+<!-- END_INFOCARD -->
+
+
+The plugin performs the following validations:
+
+1. Company Name: Checks if the name is longer than 1 character
+2. Company Website: Validates the website format using a regex pattern
+3. Company Address (optional): Uses Google Maps API to verify the address
+4. EIN (optional): Verifies the EIN using the EIN Verification API
+
+For each invalid field, the plugin adds an error message to the record. The record is then returned, allowing Flatfile to display the errors to the user.
+
+Note: Address and EIN validations are performed only if the respective configuration options are set to true.
+
+
+## Parameters
+
+#### `sheetSlug` - `string` - (required)
+
+The `sheetSlug` parameter indicates the slug name of the sheet you want to monitor.
+
+#### `googleMapsApiKey` - `string` - (optional)
+
+The `googleMapsApiKey` parameter allows you to specify your Google Maps API key for address validation.
+
+#### `einVerificationApiKey` - `string` - (optional)
+
+The `einVerificationApiKey` parameter allows you to specify your EIN Verification API key.
+
+#### `validateAddress` - `boolean` - (optional)
+
+The `validateAddress` parameter allows you to specify if the plugin should validate company addresses.
+
+#### `validateEIN` - `boolean` - (optional)
+
+The `validateEIN` parameter allows you to specify if the plugin should validate EINs.
+
+
+## Usage
+
+**Environment Variables**
+
+Add the following environment variables to your space:
+
+- `GOOGLE_MAPS_API_KEY`
+- `EIN_VERIFICATION_API_KEY`
+
+**install**
+```bash
+npm install @flatfile/plugin-company-validation
+```
+
+**import**
+```js
+import { companyValidationPlugin } from "@flatfile/plugin-company-validation";
+```
+
+**listener.js**
+```js 
+listener.use(companyValidationPlugin({
+    sheetSlug: "companies",
+    validateAddress: true,
+    validateEIN: true,
+}));
+```