mintable/src/integrations/plaid/setup.ts

Automate your personal finances – for free, with no ads, and no data collection.

import { PlaidEnvironmentType, PlaidConfig, defaultPlaidConfig } from '../../types/integrations/plaid'
import { updateConfig } from '../../common/config'
import { IntegrationId } from '../../types/integrations'
import prompts from 'prompts'
import { logInfo, logError } from '../../common/logging'

export default async () => {
    return new Promise(async (resolve, reject) => {
        try {
            console.log('\nThis script will walk you through setting up the Plaid integration. Follow these steps:')
            console.log('\n\t1. Visit https://plaid.com')
            console.log("\t2. Click 'Get API Keys'")
            console.log('\t3. Fill out the form and wait a few days')
            console.log('\t4. Once approved, visit https://dashboard.plaid.com/team/keys')
            console.log('\t5. Answer the following questions:\n')

            // @types/prompts needs updated to support choice descriptions
            interface ChoiceWithDescription extends prompts.Choice {
                description: string
            }

            const credentials = await prompts([
                {
                    type: 'text',
                    name: 'name',
                    message: 'What would you like to call this integration?',
                    initial: 'Plaid',
                    validate: (s: string) =>
                        1 < s.length && s.length <= 64 ? true : 'Must be between 2 and 64 characters in length.'
                },
                {
                    type: 'select',
                    name: 'environment',
                    message: 'Which Plaid environment would you like to use?',
                    choices: [
                        {
                            title: 'Sandbox',
                            description: 'Test credentials for development purposes (unlimited)',
                            value: PlaidEnvironmentType.Sandbox
                        },
                        {
                            title: 'Development',
                            description: 'Real credentials to financial institutions (limited to 100 Items)',
                            value: PlaidEnvironmentType.Development
                        }
                    ] as ChoiceWithDescription[],
                    initial: 0
                },
                {
                    type: 'password',
                    name: 'clientId',
                    message: 'Client ID',
                    validate: (s: string) => (s.length === 24 ? true : 'Must be 24 characters in length.')
                },
                {
                    type: 'password',
                    name: 'secret',
                    message: "Secret (pick the one corresponding to your 'Environment' choice above)",
                    validate: (s: string) => (s.length === 30 ? true : 'Must be 30 characters in length.')
                }
            ])

            updateConfig(config => {
                let plaidConfig = (config.integrations[IntegrationId.Plaid] as PlaidConfig) || defaultPlaidConfig

                plaidConfig.name = credentials.name
                plaidConfig.environment = credentials.environment
                plaidConfig.credentials.clientId = credentials.clientId
                plaidConfig.credentials.secret = credentials.secret

                config.integrations[IntegrationId.Plaid] = plaidConfig

                return config
            })

            logInfo('Successfully set up Plaid Integration.')
            return resolve()
        } catch (e) {
            logError('Unable to set up Plaid Integration.', e)
            return reject()
        }
    })
}