Added processing support for V-Card files GH-50

#vcard

lib/package.json

@@ -13,7 +13,8 @@
     "papaparse": "^5.3.1",
     "pretty": "^2.0.0",
     "snake-case": "^3.0.4",
-    "ua-parser-js": "^1.0.2"
+    "ua-parser-js": "^1.0.2",
+    "vcard4-ts": "^0.4.1"
   },
   "devDependencies": {
     "@types/node": "^17.0.12",

lib/postProcessing/postProcessingCategoriser.ts

@@ -18,7 +18,10 @@ import {
   TwitterTweetsPostProcess
 } from './postProcessors/twitter'
 import { TextPostProcess } from './postProcessors/genericFallbacks/text'
-import { ContactsCsvPostProcess } from './postProcessors/contacts'
+import {
+  ContactsCsvPostProcess,
+  ContactsVcfPostProcess
+} from './postProcessors/contacts'
 import {
   KeyValuePostProcess,
   NestedArrayPostProcess,
@@ -57,6 +60,7 @@ const postProcessors = {
   TwitterFallbackPostProcess,
   TwitterManifestPostProcess,
   ContactsCsvPostProcess,
+  ContactsVcfPostProcess,
   YouTubeWatchHistoryPostProcess,
   YouTubeSearchHistoryPostProcess,
   DefaultHtmlPostProcess,

lib/postProcessing/postProcessors/contacts.ts

@@ -1,5 +1,6 @@
 import { PostProcess } from '../../typedefs/PostProcess'
 import { processContacts } from '../../vendors/google/Contacts'
+import { processVCardContacts } from '../../vendors/google/VCardContacts'
 
 export const ContactsCsvPostProcess: PostProcess = {
   name: 'Contacts',
@@ -15,3 +16,16 @@ export const ContactsCsvPostProcess: PostProcess = {
   component: 'VaadinGrid',
   postProcessingFunction: processContacts
 }
+
+export const ContactsVcfPostProcess: PostProcess = {
+  name: 'Contacts',
+  code: 'contacts-vcf',
+  classifier: {
+    topLevelIsArray: true,
+    filenameRegex: /^.+\.vcf$/,
+    preProcessingCategory: 'vcard',
+    itemCriteria: {}
+  },
+  component: 'VaadinGrid',
+  postProcessingFunction: processVCardContacts
+}

lib/preProcessing/preProcessingCategoriser.ts

@@ -46,6 +46,11 @@ const preProcessingTesters: PreProcessingTester[] = [
     filenameRegex: /\.html$/,
     fileTypes: ['text/html'],
     preProcessingCategory: 'html'
+  },
+  {
+    filenameRegex: /\.vcf$/,
+    fileTypes: ['text/x-vcard'],
+    preProcessingCategory: 'vcard'
   }
 ]
 

lib/preProcessing/preProcessorMap.ts

@@ -7,6 +7,7 @@ import { twitterJsPreProcessor } from './preProcessors/twitterJs'
 import { videoPreProcessor } from './preProcessors/video'
 import { imagePreProcessor } from './preProcessors/image'
 import { htmlPreProcessor } from './preProcessors/html'
+import { vcardPreProcessor } from './preProcessors/vcard'
 
 export const preProcessorMap: { [key in PreProcessingCategory]: PreProcessor } =
   {
@@ -17,5 +18,6 @@ export const preProcessorMap: { [key in PreProcessingCategory]: PreProcessor } =
     twitterJs: twitterJsPreProcessor,
     image: imagePreProcessor,
     video: videoPreProcessor,
-    html: htmlPreProcessor
+    html: htmlPreProcessor,
+    vcard: vcardPreProcessor
   }

lib/preProcessing/preProcessors/vcard.ts

@@ -0,0 +1,16 @@
+import { PreProcessor } from '../../typedefs/PreProcess'
+import { ParsedVCards, parseVCards, sortByPREF } from 'vcard4-ts'
+
+export const vcardPreProcessor: PreProcessor<ParsedVCards['vCards']> = ({
+  filename,
+  fileType,
+  fileContent
+}) => {
+  const { nags, vCards } = parseVCards(fileContent, true)
+  const { length } = vCards
+  return {
+    data: vCards,
+    title: filename,
+    metadata: { length, nags }
+  }
+}

lib/typedefs/PreProcess.ts

@@ -7,6 +7,7 @@ export type PreProcessingCategory =
   | 'image'
   | 'video'
   | 'html'
+  | 'vcard'
 export type PreProcessingTester = {
   // tests
   filenameRegex?: RegExp

lib/vendors/google/Contacts.ts

@@ -87,7 +87,6 @@ export const processContacts: PostProcessor<CsvContacts, Contact[]> = ({
   preProcessedOutput: { data, metadata }
 }) => {
   const { fields } = metadata
-  console.log(data)
   const contacts: Contact[] = []
   for (const contact of data) {
     contacts.push({
@@ -122,7 +121,7 @@ export const processContacts: PostProcessor<CsvContacts, Contact[]> = ({
   }
 }
 
-function generateContacts(qty = 10): CsvContacts {
+function generateCsvContacts(qty = 10): CsvContacts {
   const contacts = new Set<CsvContacts[number]>()
   for (let i = 0; i < qty; i++) {
     const Name = getRandomFullName()
@@ -141,6 +140,6 @@ function generateContacts(qty = 10): CsvContacts {
 }
 
 export function generateContactsFile(qty = 10): string {
-  const contacts = generateContacts(qty)
+  const contacts = generateCsvContacts(qty)
   return Papa.unparse(contacts)
 }

lib/vendors/google/VCardContacts.ts

@@ -0,0 +1,35 @@
+import { ParsedVCards } from 'vcard4-ts'
+import { PostProcessor } from '../../typedefs/PostProcess'
+import { Contact, CsvContacts } from './Contacts'
+
+export const processVCardContacts: PostProcessor<
+  ParsedVCards['vCards'],
+  Contact[]
+> = ({ preProcessedOutput: { data, metadata, title } }) => {
+  const contacts: Contact[] = []
+  for (const contact of data) {
+    contacts.push({
+      address: contact.ADR?.[0]
+        ? {
+            postCode: contact.ADR[0].value.postalCode?.[0],
+            streetAddress: contact.ADR[0].value.streetAddress?.[0]
+          }
+        : null,
+      emailAddresses: contact.EMAIL?.map((t) => ({
+        label: t.parameters?.TYPE?.at(0),
+        emailAddress: t.value
+      })),
+      firstName: contact.N?.value.givenNames.join(' '),
+      fullName: contact.FN[0]?.value,
+      lastName: contact.N?.value.familyNames.join(' '),
+      organisation: contact.ORG?.[0]?.value[0],
+      otherDetails: contact.x,
+      phoneNumbers: contact.TEL?.map((t) => ({
+        label: t.parameters?.TYPE?.[0],
+        phoneNumber: t.value
+      })),
+      profilePictureUrl: contact.PHOTO?.[0]?.value
+    })
+  }
+  return { data: contacts, metadata, title }
+}