Merge

[carlbrugger]

@flatfile/plugin-connect-via-merge

This PR introduces the @flatfile/plugin-connect-via-merge plugin. This is an alpha release connect plugin for Merge.dev. Using this plugin will enable you to sync data from hundreds of integrations (connected through Merge.dev) with Flatfile.

Before you begin...

1. Email [email protected] to request that the connections flag be enabled for your account.
2. Create a Merge.dev account.
3. Create and configure a Flatfile Space.
4. Create a new secret named MERGE_ACCESS_KEY in your space containing your Merge.dev API key.

Getting started

First, install the plugin:

npm i @flatfile/plugin-connect-via-merge

Now you can create your Flatfile listener:

Javascript:

import mergePlugin from "@flatfile/plugin-connect-via-merge";

export default function (listener) {
  listener.use(mergePlugin());
}

Typescript:

import type { FlatfileListener } from "@flatfile/listener";
import mergePlugin from "@flatfile/plugin-connect-via-merge";

export default function (listener: FlatfileListener) {
  listener.use(mergePlugin());
}

And finally, deploy it to Flatfile:

npx flatfile@latest deploy

With the connections feature flag enabled, you will see a new item in your space's sidebar labeled "Add Connection". Clicking this will open a modal where you can select the Merge.dev integration you want to connect to Flatfile. After you've made your selection, Merge.dev will since your selected integration with their system and your Flatfile listener will create a Workbook with Sheets to match Merge.dev's schema. Once the Merge.dev sync is complete, your Flatfile listener will complete the process by syncing with Merge.dev.

Kitchen sink PR: FlatFilers/flatfile-docs-kitchen-sink#22
Dependent on: https://github.com/FlatFilers/Platform/pull/5417
Closes: https://github.com/FlatFilers/Platform/issues/5390

[socket-security]

New and updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@mergeapi/merge-node-client	0.1.7	None	+0	17 MB	rmkonnur
@flatfile/api	1.5.26...1.5.27	None	+0/-0	3.15 MB	flatfileinfra
axios	1.5.0...1.5.1	None	+0/-0	1.77 MB	jasonsaayman

[ashleygmulligan2]

Can you update the PR description to include which feature flag you need to use this? And that this is an aloha release that won't be public facing yet?

[ashleygmulligan2]

Can you link to the kitchen sink PR in the PR description?

[carlbrugger]

@ashleygmulligan2 description has been updated

[drizco]

lgtm!