Merge pull request #1 from lelemm/DetectInstallments

Create schedules from csv import

Author: lelemm

packages/api/methods.ts

@@ -82,7 +82,13 @@ export function addTransactions(
 }
 
 export function importTransactions(accountId, transactions) {
-  return send('api/transactions-import', { accountId, transactions });
+  return send('api/transactions-import', {
+    accountId,
+    transactions,
+    detectInstallments: false,
+    updateDetectInstallmentDate: false,
+    ignoreAlreadyDetectedInstallments: false,
+  });
 }
 
 export function getTransactions(accountId, startDate, endDate) {

packages/desktop-client/src/components/modals/ImportTransactions.jsx

@@ -2,6 +2,7 @@ import React, { useState, useEffect, useMemo } from 'react';
 
 import * as d from 'date-fns';
 
+import * as monthUtils from 'loot-core/src/shared/months';
 import { format as formatDate_ } from 'loot-core/src/shared/months';
 import {
   amountToCurrency,
@@ -133,13 +134,24 @@ function getFileType(filepath) {
   return rawType;
 }
 
-function ParsedDate({ parseDateFormat, dateFormat, date }) {
+function ParsedDate({ parseDateFormat, dateFormat, date, installmentParcel }) {
   const parsed =
     date &&
     formatDate(
       parseDateFormat ? parseDate(date, parseDateFormat) : date,
       dateFormat,
     );
+  const overrideDate =
+    parsed != null
+      ? d.format(
+          d.addMonths(
+            monthUtils._parse(parseDate(parsed)),
+            installmentParcel - 1,
+          ),
+          dateFormat,
+        )
+      : null;
+
   return (
     <Text>
       <Text>
@@ -153,6 +165,18 @@ function ParsedDate({ parseDateFormat, dateFormat, date }) {
       <Text style={{ color: parsed ? theme.noticeTextLight : theme.errorText }}>
         {parsed || 'Invalid'}
       </Text>
+      {installmentParcel && (
+        <Text>
+          &rarr;{' '}
+          <Text
+            style={{
+              color: overrideDate ? theme.noticeTextLight : theme.errorText,
+            }}
+          >
+            {overrideDate || 'Invalid'}
+          </Text>
+        </Text>
+      )}
     </Text>
   );
 }
@@ -323,6 +347,17 @@ function parseCategoryFields(trans, categories) {
   return match;
 }
 
+function markInstallment(transaction, mapping) {
+  return (
+    <Checkbox
+      checked={
+        transaction[mapping['notes']]?.match(/\((\d{2})\/(\d{2})\)/) ?? false
+      }
+      readOnly={true}
+    />
+  );
+}
+
 function Transaction({
   transaction: rawTransaction,
   fieldMappings,
@@ -335,6 +370,8 @@ function Transaction({
   flipAmount,
   multiplierAmount,
   categories,
+  detectInstallments,
+  updateDetectedInstallmentDate,
 }) {
   const categoryList = categories.map(category => category.name);
   const transaction = useMemo(
@@ -354,18 +391,33 @@ function Transaction({
     multiplierAmount,
   );
 
+  let installmentParcel = null;
+  if (
+    detectInstallments &&
+    updateDetectedInstallmentDate &&
+    transaction.date !== null &&
+    transaction.date !== undefined
+  ) {
+    const matches =
+      rawTransaction[fieldMappings['notes']]?.match(/\((\d{2})\/(\d{2})\)/);
+    if (matches) {
+      installmentParcel = parseInt(matches[1]);
+    }
+  }
+
   return (
     <Row
       style={{
         backgroundColor: theme.tableBackground,
       }}
     >
-      <Field width={200}>
+      <Field width={updateDetectedInstallmentDate ? 300 : 200}>
         {showParsed ? (
           <ParsedDate
             parseDateFormat={parseDateFormat}
             dateFormat={dateFormat}
             date={transaction.date}
+            installmentParcel={installmentParcel}
           />
         ) : (
           formatDate(transaction.date, dateFormat)
@@ -455,6 +507,18 @@ function Transaction({
           </Field>
         </>
       )}
+      {detectInstallments && (
+        <Field
+          width={90}
+          title="Installment"
+          style={{ display: 'flex', alignItems: 'flex-end' }}
+          contentStyle={{
+            textAlign: 'right',
+          }}
+        >
+          {markInstallment(rawTransaction, fieldMappings)}
+        </Field>
+      )}
     </Row>
   );
 }
@@ -757,6 +821,13 @@ export function ImportTransactions({ modalProps, options }) {
   const [multiplierEnabled, setMultiplierEnabled] = useState(false);
   const [reconcile, setReconcile] = useState(true);
   const { accountId, categories, onImported } = options;
+  const [detectInstallments, setDetectInstallments] = useState(false);
+  const [updateDetectedInstallmentDate, setUpdateDetectedInstallmentDate] =
+    useState(false);
+  const [
+    ignoreAlreadyDetectedInstallments,
+    setIgnoreAlreadyDetectedInstallments,
+  ] = useState(false);
 
   // This cannot be set after parsing the file, because changing it
   // requires re-parsing the file. This is different from the other
@@ -916,10 +987,32 @@ export function ImportTransactions({ modalProps, options }) {
     for (let trans of transactions) {
       trans = fieldMappings ? applyFieldMappings(trans, fieldMappings) : trans;
 
-      const date =
+      let date =
         isOfxFile(filetype) || isCamtFile(filetype)
           ? trans.date
           : parseDate(trans.date, parseDateFormat);
+
+      if (updateDetectedInstallmentDate) {
+        if (
+          detectInstallments &&
+          updateDetectedInstallmentDate &&
+          trans.date !== null &&
+          trans.date !== undefined
+        ) {
+          const matches = trans.notes?.match(/\((\d{2})\/(\d{2})\)/);
+          if (matches) {
+            const installmentParcel = parseInt(matches[1]);
+            date =
+              date != null
+                ? d.format(
+                    d.addMonths(monthUtils._parse(date), installmentParcel - 1),
+                    'yyyy-MM-dd',
+                  )
+                : null;
+          }
+        }
+      }
+
       if (date == null) {
         errorMessage = `Unable to parse date ${
           trans.date || '(empty)'
@@ -984,6 +1077,9 @@ export function ImportTransactions({ modalProps, options }) {
       accountId,
       finalTransactions,
       reconcile,
+      detectInstallments,
+      updateDetectedInstallmentDate,
+      ignoreAlreadyDetectedInstallments,
     );
     if (didChange) {
       await getPayees();
@@ -997,7 +1093,7 @@ export function ImportTransactions({ modalProps, options }) {
   }
 
   const headers = [
-    { name: 'Date', width: 200 },
+    { name: 'Date', width: updateDetectedInstallmentDate ? 300 : 200 },
     { name: 'Payee', width: 'flex' },
     { name: 'Notes', width: 'flex' },
     { name: 'Category', width: 'flex' },
@@ -1013,14 +1109,22 @@ export function ImportTransactions({ modalProps, options }) {
     headers.push({ name: 'Amount', width: 90, style: { textAlign: 'right' } });
   }
 
+  if (detectInstallments) {
+    headers.push({
+      name: 'Installment',
+      width: 90,
+      style: { textAlign: 'right' },
+    });
+  }
+
   return (
     <Modal
       title={
         'Import transactions' + (filetype ? ` (${filetype.toUpperCase()})` : '')
       }
       {...modalProps}
       loading={loadingState === 'parsing'}
-      style={{ width: 800 }}
+      style={{ width: 900 }}
     >
       {error && !error.parsed && (
         <View style={{ alignItems: 'center', marginBottom: 15 }}>
@@ -1072,6 +1176,8 @@ export function ImportTransactions({ modalProps, options }) {
                   flipAmount={flipAmount}
                   multiplierAmount={multiplierAmount}
                   categories={categories.list}
+                  detectInstallments={detectInstallments}
+                  updateDetectedInstallmentDate={updateDetectedInstallmentDate}
                 />
               </View>
             )}
@@ -1222,6 +1328,9 @@ export function ImportTransactions({ modalProps, options }) {
                   checked={reconcile}
                   onChange={() => {
                     setReconcile(state => !state);
+                    setDetectInstallments(false);
+                    setUpdateDetectedInstallmentDate(false);
+                    setIgnoreAlreadyDetectedInstallments(false);
                   }}
                 >
                   Reconcile transactions
@@ -1270,6 +1379,45 @@ export function ImportTransactions({ modalProps, options }) {
                 onChangeAmount={onMultiplierChange}
               />
             </View>
+            <View style={{ marginRight: 25, gap: 5 }}>
+              <SectionLabel title="MISC" />
+              <CheckboxOption
+                id="form_detect_installments"
+                checked={detectInstallments}
+                disabled={!reconcile}
+                onChange={() => {
+                  setDetectInstallments(!detectInstallments);
+                  setUpdateDetectedInstallmentDate(false);
+                  setIgnoreAlreadyDetectedInstallments(false);
+                }}
+              >
+                Detect Installments
+              </CheckboxOption>
+              <CheckboxOption
+                id="form_detect_installments_update_installment_date"
+                checked={updateDetectedInstallmentDate}
+                disabled={!detectInstallments}
+                onChange={() =>
+                  setUpdateDetectedInstallmentDate(
+                    !updateDetectedInstallmentDate,
+                  )
+                }
+              >
+                Update installment parcel to right month date
+              </CheckboxOption>
+              <CheckboxOption
+                id="form_detect_installments_already_detected"
+                checked={ignoreAlreadyDetectedInstallments}
+                disabled={!detectInstallments}
+                onChange={() =>
+                  setIgnoreAlreadyDetectedInstallments(
+                    !ignoreAlreadyDetectedInstallments,
+                  )
+                }
+              >
+                Don&apos;t create installment if already exists
+              </CheckboxOption>
+            </View>
           </Stack>
         </View>
       )}

packages/loot-core/src/client/actions/account.ts

@@ -185,7 +185,14 @@ export function parseTransactions(filepath, options) {
   };
 }
 
-export function importTransactions(id: string, transactions, reconcile = true) {
+export function importTransactions(
+  id: string,
+  transactions,
+  reconcile = true,
+  detectInstallments = false,
+  updateDetectInstallmentDate = false,
+  ignoreAlreadyDetectedInstallments = false,
+) {
   return async (dispatch: Dispatch): Promise<boolean> => {
     if (!reconcile) {
       await send('api/transactions-add', {
@@ -203,6 +210,9 @@ export function importTransactions(id: string, transactions, reconcile = true) {
     } = await send('transactions-import', {
       accountId: id,
       transactions,
+      detectInstallments,
+      updateDetectInstallmentDate,
+      ignoreAlreadyDetectedInstallments,
     });
 
     errors.forEach(error => {