feat: upgrade to response-rejection plugin

[carlbrugger]

Guide update: FlatFilers/Guides#955
Kitchen Sink update: FlatFilers/flatfile-docs-kitchen-sink#34

This PR adds better handling of submission status to the @flatfile/util-response-rejection plugin by providing webhook with 2 options:
- Option 1: Delete all successful records and leave only rejections
- Option 2 (default): Create new (readonly) submission status column that marks each record as "submitted" or "rejected"

Also, the webhook is given the option to set a response message.

Preview video

Future updates:

• Next URL will open in a new tab. Will be fixed soon.
• Forced page refresh when column is added. Will be fixed soon.

Example

Clone https://github.com/carlbrugger/bun-webhook

Run:

bun
bun start

This will start a webhook server on localhost:1234.

Paste in listener.ts:

import type { FlatfileListener } from '@flatfile/listener'
import { configureSpace } from '@flatfile/plugin-space-configure'
import { webhookEgress } from '@flatfile/plugin-webhook-egress'

export default function (listener: FlatfileListener) {
  listener.use(
    webhookEgress(
      'workbook:submitActionFg',
      'http://localhost:1234/reject-non-flatfile-emails'
    )
  )

  listener.use(
    configureSpace({
      workbooks: [
        {
          name: 'Playground',
          sheets: [
            {
              name: 'Contacts',
              slug: 'contacts',
              allowAdditionalFields: true,
              fields: [
                {
                  key: 'firstName',
                  type: 'string',
                  label: 'First Name',
                },
                {
                  key: 'lastName',
                  type: 'string',
                  label: 'Last Name',
                },
                {
                  key: 'email',
                  type: 'string',
                  label: 'Email',
                },
              ],
            },
          ],
          actions: [
            {
              operation: 'submitActionFg',
              mode: 'foreground',
              label: 'Submit data',
              type: 'string',
              description: 'Submit this data to a webhook.',
              primary: true,
            },
          ],
        },
      ],
    })
  )
}

[socket-security]

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@flatfile/api	1.6.0...1.6.2	None	+0/-0	4.04 MB	flatfileinfra

[ashleygmulligan2]

concern of this being a breaking change in the utl. Types names have changed. Also, the rejection handler now returns a job response object rather than a total number of rejections as before. This should be a major release. Since the plugin itself isn't impacted in that way, patch seems fine. Tho this is more than a patch/fix, and introduces new functionality, so maybe minor is better here.

[bangarang]

Awesome work!

[bangarang]

Should we remove this field from the sheet when submitting? I'm sure they could strip it out if they wanted but could be nice if it was cleaned up as an option

outdated