Chore/deprecate PSV/TSV extractors (#226)

* Deprecate PSV/TSV extractors

* Use specific version

* chore: changeset

* feat: remove pipe & tab delimiters & add messages

* Update good-bobcats-tease.md

* chore: update package-lock.json

* fix: return listener that console.logs deprecation message

.changeset/good-bobcats-tease.md

@@ -0,0 +1,7 @@
+---
+'@flatfile/plugin-delimiter-extractor': minor
+'@flatfile/plugin-psv-extractor': minor
+'@flatfile/plugin-tsv-extractor': minor
+---
+
+Deprecate PSV/TSV extractors since PSV/TSV files are now natively supported by the Flatfile Platform.

plugins/delimiter-extractor/ref/test-basic.pound

@@ -0,0 +1,4 @@
+"Code*"#"Details"#"BranchName"#"Tenant"
+"Personal Care"#"Personal Care"#"Department"#"notdata"
+Hospital#Hospital#Department
+Home Nursing#Home Nursing#Department#false

plugins/delimiter-extractor/ref/test-complex.pound

@@ -0,0 +1,13 @@
+
+
+
+hello
+
+
+
+"Code*"#"Details"#"BranchName"#"Tenant"
+"Personal Care"#"Personal Care"#"Department"#"notdata"
+
+
+Hospital#Hospital#Department
+Home Nursing#Home Nursing#Department#false

plugins/delimiter-extractor/src/index.ts

@@ -3,8 +3,6 @@ import { Extractor } from '@flatfile/util-extractor'
 import { parseBuffer } from './parser'
 
 const delimiterMap = {
-  '\t': 'tsv',
-  '|': 'pipe',
   ',': 'csv',
   ';': 'ssv',
   ':': 'dsv',

plugins/delimiter-extractor/src/parser.spec.ts

@@ -1,18 +1,18 @@
-import { parseBuffer } from './parser'
-import * as path from 'path'
 import * as fs from 'fs'
+import * as path from 'path'
+import { parseBuffer } from './parser'
 
 describe('parser', () => {
-  const psvBasicBuffer: Buffer = fs.readFileSync(
-    path.join(__dirname, '../ref/test-basic.psv')
+  const colonBasicBuffer: Buffer = fs.readFileSync(
+    path.join(__dirname, '../ref/test-basic.pound')
   )
 
-  const psvComplexBuffer: Buffer = fs.readFileSync(
-    path.join(__dirname, '../ref/test-complex.psv')
+  const colonComplexBuffer: Buffer = fs.readFileSync(
+    path.join(__dirname, '../ref/test-complex.pound')
   )
 
-  test('PSV to WorkbookCapture', () => {
-    expect(parseBuffer(psvBasicBuffer, { delimiter: '|' })).toEqual({
+  test('colon to WorkbookCapture', () => {
+    expect(parseBuffer(colonBasicBuffer, { delimiter: '#' })).toEqual({
       Sheet1: {
         headers: ['Code', 'Details', 'BranchName', 'Tenant'],
         required: {
@@ -44,13 +44,13 @@ describe('parser', () => {
     })
   })
   it('has headers', () => {
-    const headers = parseBuffer(psvBasicBuffer, { delimiter: '|' }).Sheet1
+    const headers = parseBuffer(colonBasicBuffer, { delimiter: '#' }).Sheet1
       .headers
     expect(headers).toEqual(['Code', 'Details', 'BranchName', 'Tenant'])
   })
   test('transform', () => {
-    const data = parseBuffer(psvBasicBuffer, {
-      delimiter: '|',
+    const data = parseBuffer(colonBasicBuffer, {
+      delimiter: '#',
       transform: (v: string) => {
         return v.toUpperCase()
       },
@@ -76,8 +76,8 @@ describe('parser', () => {
     ])
   })
   test('dynamicTyping', () => {
-    const data = parseBuffer(psvBasicBuffer, {
-      delimiter: '|',
+    const data = parseBuffer(colonBasicBuffer, {
+      delimiter: '#',
       dynamicTyping: true,
     }).Sheet1.data
     expect(data).toEqual([
@@ -101,8 +101,8 @@ describe('parser', () => {
     ])
   })
   test('skipEmptyLines', () => {
-    const data = parseBuffer(psvBasicBuffer, {
-      delimiter: '|',
+    const data = parseBuffer(colonBasicBuffer, {
+      delimiter: '#',
       skipEmptyLines: true,
     }).Sheet1.data
     expect(data).toEqual([
@@ -128,13 +128,13 @@ describe('parser', () => {
   test('empty buffer', () => {
     const emptyBuffer = Buffer.from('', 'utf8')
     const logSpy = jest.spyOn(global.console, 'log')
-    parseBuffer(emptyBuffer, { delimiter: '|' })
+    parseBuffer(emptyBuffer, { delimiter: '#' })
     expect(logSpy).toHaveBeenCalledWith('No data found in the file')
-    expect(parseBuffer(emptyBuffer, { delimiter: '|' })).toEqual({})
+    expect(parseBuffer(emptyBuffer, { delimiter: '#' })).toEqual({})
   })
   test('parsing of basic equals parsing of complex', () => {
-    expect(parseBuffer(psvComplexBuffer, { delimiter: '|' })).toEqual(
-      parseBuffer(psvBasicBuffer, { delimiter: '|' })
+    expect(parseBuffer(colonComplexBuffer, { delimiter: '#' })).toEqual(
+      parseBuffer(colonBasicBuffer, { delimiter: '#' })
     )
   })
 })

plugins/psv-extractor/README.md

@@ -1,9 +1,3 @@
 # @flatfile/plugin-psv-extractor
 
-This plugin parses a PSV file and extracts it into Flatfile.
-
-`npm i @flatfile/plugin-psv-extractor`
-
-## Get Started
-
-Follow [this guide](https://flatfile.com/docs/plugins/extractors/psv-extractor) to learn how to use the plugin.
+This plugin has been deprecated. PSV extraction is now natively supported by the Flatfile Platform.

plugins/psv-extractor/package.json

@@ -27,7 +27,6 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@flatfile/api": "^1.5.13",
-    "@flatfile/plugin-delimiter-extractor": "^0.6.0"
+    "@flatfile/api": "^1.5.13"
   }
 }

plugins/psv-extractor/src/index.ts

@@ -1,6 +1,9 @@
 import { Flatfile } from '@flatfile/api'
-import { DelimiterExtractor } from '@flatfile/plugin-delimiter-extractor'
+import { FlatfileListener } from '@flatfile/listener'
 
+/*
+ * @deprecated
+ */
 export const PSVExtractor = (options?: {
   dynamicTyping?: boolean
   skipEmptyLines?: boolean | 'greedy'
@@ -9,10 +12,14 @@ export const PSVExtractor = (options?: {
   parallel?: number
   debug?: boolean
 }) => {
-  return DelimiterExtractor('.psv', { delimiter: '|', ...options })
+  return (listener: FlatfileListener) => {
+    console.log(
+      'The PSVExtractor plugin is deprecated. PSV extraction is now natively supported by the Flatfile Platform.'
+    )
+  }
 }
 
 /*
- * @deprecated use `PSVExtractor` instead
+ * @deprecated
  */
 export const psvExtractorPlugin = PSVExtractor

plugins/tsv-extractor/README.md

@@ -0,0 +1,3 @@
+# @flatfile/plugin-tsv-extractor
+
+This plugin has been deprecated. TSV extraction is now natively supported by the Flatfile Platform.

plugins/tsv-extractor/package.json

@@ -27,7 +27,6 @@
   },
   "license": "ISC",
   "dependencies": {
-    "@flatfile/api": "^1.5.13",
-    "@flatfile/plugin-delimiter-extractor": "^0.6.0"
+    "@flatfile/api": "^1.5.13"
   }
 }

plugins/tsv-extractor/src/index.ts

@@ -1,6 +1,9 @@
 import { Flatfile } from '@flatfile/api'
-import { DelimiterExtractor } from '@flatfile/plugin-delimiter-extractor'
+import { FlatfileListener } from '@flatfile/listener'
 
+/*
+ * @deprecated
+ */
 export const TSVExtractor = (options?: {
   dynamicTyping?: boolean
   skipEmptyLines?: boolean | 'greedy'
@@ -9,5 +12,9 @@ export const TSVExtractor = (options?: {
   parallel?: number
   debug?: boolean
 }) => {
-  return DelimiterExtractor('.tsv', { delimiter: '\t', ...options })
+  return (listener: FlatfileListener) => {
+    console.log(
+      'The TSVExtractor plugin is deprecated. TSV extraction is now natively supported by the Flatfile Platform.'
+    )
+  }
 }