packages/shared/lib/interfaces/contacts/Import.ts

   1 import type { ImportContactError } from '../../contacts/errors/ImportContactError';
   2 import type { ImportFatalError } from '../../contacts/errors/ImportFatalError';
   3 import type { ImportFileError } from '../../contacts/errors/ImportFileError';
   4 import type { ContactCard, ContactGroup, ContactValue } from './Contact';
   5 import type { VCardContact, VCardKey } from './VCard';
   6
   7 export enum IMPORT_STEPS {
   8     ATTACHING,
   9     ATTACHED,
  10     IMPORT_CSV,
  11     WARNING,
  12     IMPORTING,
  13     SUMMARY,
  14     IMPORT_GROUPS,
  15 }
  16
  17 export enum IMPORT_GROUPS_ACTION {
  18     MERGE,
  19     CREATE,
  20     IGNORE,
  21 }
  22
  23 export enum EXTENSION {
  24     CSV = 'csv',
  25     VCF = 'vcf',
  26 }
  27
  28 export type ACCEPTED_EXTENSIONS = EXTENSION.CSV | EXTENSION.VCF;
  29
  30 export interface ParsedCsvContacts {
  31     headers: string[];
  32     contacts: string[][];
  33 }
  34
  35 export interface ImportCategories {
  36     name: string;
  37     totalContacts: number;
  38     contactIDs: string[];
  39     contactEmailIDs: string[];
  40     action: IMPORT_GROUPS_ACTION;
  41     targetGroup: ContactGroup;
  42     targetName: string;
  43     error?: string;
  44 }
  45
  46 export interface ImportContactsModel {
  47     step: IMPORT_STEPS;
  48     fileAttached?: File;
  49     extension?: ACCEPTED_EXTENSIONS;
  50     preVcardsContacts?: PreVcardsContact[];
  51     parsedVcardContacts: VCardContact[];
  52     importedContacts: ImportedContact[];
  53     totalEncrypted: number;
  54     totalImported: number;
  55     errors: ImportContactError[];
  56     failure?: ImportFatalError | ImportFileError | Error;
  57     loading: boolean;
  58     contactGroups?: ContactGroup[];
  59     categories: ImportCategories[];
  60 }
  61
  62 export interface SimpleEncryptedContact {
  63     contact: { Cards: ContactCard[]; error?: Error };
  64     contactId: string;
  65 }
  66
  67 export interface EncryptedContact extends SimpleEncryptedContact {
  68     contactEmails: { email: string; group?: string }[];
  69     categories: { name: string; group?: string }[];
  70 }
  71
  72 export interface ImportedContact {
  73     contactID: string;
  74     contactEmailIDs: string[];
  75     categories: { name: string; contactEmailIDs?: string[] }[];
  76 }
  77
  78 export interface Combine {
  79     [key: string]: (preVcards: PreVcardsProperty) => any;
  80 }
  81
  82 export interface Display {
  83     [key: string]: (preVcards: PreVcardsProperty) => string;
  84 }
  85
  86 export interface PreVcardProperty {
  87     header: string;
  88     checked: boolean;
  89     pref?: number;
  90     field: string;
  91     type?: VCardKey;
  92     value: ContactValue;
  93     combineInto?: string;
  94     combineIndex?: number;
  95     custom?: boolean;
  96 }
  97
  98 export type PreVcardsProperty = PreVcardProperty[];
  99
 100 export type PreVcardsContact = PreVcardsProperty[];