flatfile.com home pagelight logo
Migrations
@flatfile/plugin-dxp-configure

@flatfile/plugin-record-hook

currently v0.0.3


Author
David Boskovic


Last updated
May 11, 2023

​
Overview

This plugin lets you easily attach your implementation of the class-based schema configuration library @flatfile/configure to @flatfile/listener.

INSTALL
npm i @flatfile/plugin-dxp-configure

​
Import

import { dxpConfigure } from '@flatfile/plugin-dxp-configure'

​
Usage

You can simply attach any existing workbook configuration you have to a listener and it’ll automatically apply to your next space.

listener.js

import { MyWorkbook } from './my-dxp-workbook.js'
import { dxpConfigure } from '@flatfile/plugin-dxp-configure'

export default (listener) => {
  listener.use(dxpConfigure(MyWorkbook))
}

my-dxp-workbook.js

import { Sheet, TextField, Workbook } from '@flatfile/configure'

export const MyWorkbook = new Workbook({
  name: 'My Workbook',
  namespace: 'test',
  sheets: {
    mySheet: new Sheet('Test', {
      name: TextField('Full Name'),
      email: TextField({
        name: 'Email Address',
        compute: (val) => {
          return val.toLowerCase()
        },
      }),
    }),
  },
})