Add "save as default splitting options" feature (#120)

* Add "save as default splitting options" feature

* Fix type issue

* Run autoformatter

Dockerfile

@@ -10,12 +10,13 @@ COPY ./package.json \
      ./postcss.config.js ./
 COPY ./scripts ./scripts
 COPY ./prisma ./prisma
-COPY ./src ./src
 
 RUN apk add --no-cache openssl && \
     npm ci --ignore-scripts && \
     npx prisma generate
 
+COPY ./src ./src
+
 ENV NEXT_TELEMETRY_DISABLED=1
 
 COPY scripts/build.env .env

package.json

@@ -9,6 +9,7 @@
     "lint": "next lint",
     "check-types": "tsc --noEmit",
     "check-formatting": "prettier -c src",
+    "prettier": "prettier -w src",
     "postinstall": "prisma migrate deploy && prisma generate",
     "build-image": "./scripts/build-image.sh",
     "start-container": "docker compose --env-file container.env up"

src/app/groups/[groupId]/expenses/expense-list.tsx

@@ -19,6 +19,7 @@ type Props = {
 }
 
 const EXPENSE_GROUPS = {
+  UPCOMING: 'Upcoming',
   THIS_WEEK: 'This week',
   EARLIER_THIS_MONTH: 'Earlier this month',
   LAST_MONTH: 'Last month',
@@ -28,7 +29,9 @@ const EXPENSE_GROUPS = {
 }
 
 function getExpenseGroup(date: Dayjs, today: Dayjs) {
-  if (today.isSame(date, 'week')) {
+  if (today.isBefore(date)) {
+    return EXPENSE_GROUPS.UPCOMING
+  } else if (today.isSame(date, 'week')) {
     return EXPENSE_GROUPS.THIS_WEEK
   } else if (today.isSame(date, 'month')) {
     return EXPENSE_GROUPS.EARLIER_THIS_MONTH

src/app/groups/[groupId]/group-tabs.tsx

@@ -23,6 +23,7 @@ export function GroupTabs({ groupId }: Props) {
       <TabsList>
         <TabsTrigger value="expenses">Expenses</TabsTrigger>
         <TabsTrigger value="balances">Balances</TabsTrigger>
+        <TabsTrigger value="stats">Stats</TabsTrigger>
         <TabsTrigger value="edit">Settings</TabsTrigger>
       </TabsList>
     </Tabs>

src/app/groups/[groupId]/stats/page.tsx

@@ -0,0 +1,49 @@
+import { cached } from '@/app/cached-functions'
+import { Totals } from '@/app/groups/[groupId]/stats/totals'
+import {
+  Card,
+  CardContent,
+  CardDescription,
+  CardHeader,
+  CardTitle,
+} from '@/components/ui/card'
+import { getGroupExpenses } from '@/lib/api'
+import { getTotalGroupSpending } from '@/lib/totals'
+import { Metadata } from 'next'
+import { notFound } from 'next/navigation'
+
+export const metadata: Metadata = {
+  title: 'Totals',
+}
+
+export default async function TotalsPage({
+  params: { groupId },
+}: {
+  params: { groupId: string }
+}) {
+  const group = await cached.getGroup(groupId)
+  if (!group) notFound()
+
+  const expenses = await getGroupExpenses(groupId)
+  const totalGroupSpendings = getTotalGroupSpending(expenses)
+
+  return (
+    <>
+      <Card className="mb-4">
+        <CardHeader>
+          <CardTitle>Totals</CardTitle>
+          <CardDescription>
+            Spending summary of the entire group.
+          </CardDescription>
+        </CardHeader>
+        <CardContent className="flex flex-col space-y-4">
+          <Totals
+            group={group}
+            expenses={expenses}
+            totalGroupSpendings={totalGroupSpendings}
+          />
+        </CardContent>
+      </Card>
+    </>
+  )
+}

src/app/groups/[groupId]/stats/totals-group-spending.tsx

@@ -0,0 +1,17 @@
+import { formatCurrency } from '@/lib/utils'
+
+type Props = {
+  totalGroupSpendings: number
+  currency: string
+}
+
+export function TotalsGroupSpending({ totalGroupSpendings, currency }: Props) {
+  return (
+    <div>
+      <div className="text-muted-foreground">Total group spendings</div>
+      <div className="text-lg">
+        {formatCurrency(currency, totalGroupSpendings)}
+      </div>
+    </div>
+  )
+}

src/app/groups/[groupId]/stats/totals-your-share.tsx

@@ -0,0 +1,34 @@
+'use client'
+import { getGroup, getGroupExpenses } from '@/lib/api'
+import { getTotalActiveUserShare } from '@/lib/totals'
+import { formatCurrency } from '@/lib/utils'
+import { useEffect, useState } from 'react'
+
+type Props = {
+  group: NonNullable<Awaited<ReturnType<typeof getGroup>>>
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>
+}
+
+export function TotalsYourShare({ group, expenses }: Props) {
+  const [activeUser, setActiveUser] = useState('')
+
+  useEffect(() => {
+    const activeUser = localStorage.getItem(`${group.id}-activeUser`)
+    if (activeUser) setActiveUser(activeUser)
+  }, [group, expenses])
+
+  const totalActiveUserShare =
+    activeUser === '' || activeUser === 'None'
+      ? 0
+      : getTotalActiveUserShare(activeUser, expenses)
+  const currency = group.currency
+
+  return (
+    <div>
+      <div className="text-muted-foreground">Your total share</div>
+      <div className="text-lg">
+        {formatCurrency(currency, totalActiveUserShare)}
+      </div>
+    </div>
+  )
+}

src/app/groups/[groupId]/stats/totals-your-spending.tsx

@@ -0,0 +1,30 @@
+'use client'
+import { getGroup, getGroupExpenses } from '@/lib/api'
+import { useActiveUser } from '@/lib/hooks'
+import { getTotalActiveUserPaidFor } from '@/lib/totals'
+import { formatCurrency } from '@/lib/utils'
+
+type Props = {
+  group: NonNullable<Awaited<ReturnType<typeof getGroup>>>
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>
+}
+
+export function TotalsYourSpendings({ group, expenses }: Props) {
+  const activeUser = useActiveUser(group.id)
+
+  const totalYourSpendings =
+    activeUser === '' || activeUser === 'None'
+      ? 0
+      : getTotalActiveUserPaidFor(activeUser, expenses)
+  const currency = group.currency
+
+  return (
+    <div>
+      <div className="text-muted-foreground">Total you paid for</div>
+
+      <div className="text-lg">
+        {formatCurrency(currency, totalYourSpendings)}
+      </div>
+    </div>
+  )
+}

src/app/groups/[groupId]/stats/totals.tsx

@@ -0,0 +1,34 @@
+'use client'
+import { TotalsGroupSpending } from '@/app/groups/[groupId]/stats/totals-group-spending'
+import { TotalsYourShare } from '@/app/groups/[groupId]/stats/totals-your-share'
+import { TotalsYourSpendings } from '@/app/groups/[groupId]/stats/totals-your-spending'
+import { getGroup, getGroupExpenses } from '@/lib/api'
+import { useActiveUser } from '@/lib/hooks'
+
+export function Totals({
+  group,
+  expenses,
+  totalGroupSpendings,
+}: {
+  group: NonNullable<Awaited<ReturnType<typeof getGroup>>>
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>
+  totalGroupSpendings: number
+}) {
+  const activeUser = useActiveUser(group.id)
+  console.log('activeUser', activeUser)
+
+  return (
+    <>
+      <TotalsGroupSpending
+        totalGroupSpendings={totalGroupSpendings}
+        currency={group.currency}
+      />
+      {activeUser && activeUser !== 'None' && (
+        <>
+          <TotalsYourSpendings group={group} expenses={expenses} />
+          <TotalsYourShare group={group} expenses={expenses} />
+        </>
+      )}
+    </>
+  )
+}

src/components/delete-popup.tsx

@@ -0,0 +1,47 @@
+'use client'
+
+import { Trash2 } from 'lucide-react'
+import { AsyncButton } from './async-button'
+import { Button } from './ui/button'
+import {
+  Dialog,
+  DialogClose,
+  DialogContent,
+  DialogDescription,
+  DialogFooter,
+  DialogTitle,
+  DialogTrigger,
+} from './ui/dialog'
+
+export function DeletePopup({ onDelete }: { onDelete: () => Promise<void> }) {
+  return (
+    <Dialog>
+      <DialogTrigger asChild>
+        <Button variant="destructive">
+          <Trash2 className="w-4 h-4 mr-2" />
+          Delete
+        </Button>
+      </DialogTrigger>
+      <DialogContent>
+        <DialogTitle>Delete this expense?</DialogTitle>
+        <DialogDescription>
+          Do you really want to delete this expense? This action is
+          irreversible.
+        </DialogDescription>
+        <DialogFooter className="flex flex-col gap-2">
+          <AsyncButton
+            type="button"
+            variant="destructive"
+            loadingContent="Deleting…"
+            action={onDelete}
+          >
+            Yes
+          </AsyncButton>
+          <DialogClose asChild>
+            <Button variant={'secondary'}>Cancel</Button>
+          </DialogClose>
+        </DialogFooter>
+      </DialogContent>
+    </Dialog>
+  )
+}

src/components/expense-form.tsx

@@ -1,5 +1,4 @@
 'use client'
-import { AsyncButton } from '@/components/async-button'
 import { CategorySelector } from '@/components/category-selector'
 import { ExpenseDocumentsInput } from '@/components/expense-documents-input'
 import { SubmitButton } from '@/components/submit-button'
@@ -36,15 +35,20 @@ import {
 } from '@/components/ui/select'
 import { getCategories, getExpense, getGroup, randomId } from '@/lib/api'
 import { RuntimeFeatureFlags } from '@/lib/featureFlags'
-import { ExpenseFormValues, expenseFormSchema } from '@/lib/schemas'
+import {
+  ExpenseFormValues,
+  SplittingOptions,
+  expenseFormSchema,
+} from '@/lib/schemas'
 import { cn } from '@/lib/utils'
 import { zodResolver } from '@hookform/resolvers/zod'
-import { Save, Trash2 } from 'lucide-react'
+import { Save } from 'lucide-react'
 import Link from 'next/link'
 import { useSearchParams } from 'next/navigation'
 import { useState } from 'react'
 import { useForm } from 'react-hook-form'
 import { match } from 'ts-pattern'
+import { DeletePopup } from './delete-popup'
 import { extractCategoryFromTitle } from './expense-form-actions'
 
 export type Props = {
@@ -56,6 +60,89 @@ export type Props = {
   runtimeFeatureFlags: RuntimeFeatureFlags
 }
 
+const enforceCurrencyPattern = (value: string) =>
+  value
+    // replace first comma with #
+    .replace(/[.,]/, '#')
+    // remove all other commas
+    .replace(/[.,]/g, '')
+    // change back # to dot
+    .replace(/#/, '.')
+    // remove all non-numeric and non-dot characters
+    .replace(/[^\d.]/g, '')
+
+const getDefaultSplittingOptions = (group: Props['group']) => {
+  const defaultValue = {
+    splitMode: 'EVENLY' as const,
+    paidFor: group.participants.map(({ id }) => ({
+      participant: id,
+      shares: '1' as unknown as number,
+    })),
+  }
+
+  if (typeof localStorage === 'undefined') return defaultValue
+  const defaultSplitMode = localStorage.getItem(
+    `${group.id}-defaultSplittingOptions`,
+  )
+  if (defaultSplitMode === null) return defaultValue
+  const parsedDefaultSplitMode = JSON.parse(
+    defaultSplitMode,
+  ) as SplittingOptions
+
+  if (parsedDefaultSplitMode.paidFor === null) {
+    parsedDefaultSplitMode.paidFor = defaultValue.paidFor
+  }
+
+  // if there is a participant in the default options that does not exist anymore,
+  // remove the stale default splitting options
+  for (const parsedPaidFor of parsedDefaultSplitMode.paidFor) {
+    if (
+      !group.participants.some(({ id }) => id === parsedPaidFor.participant)
+    ) {
+      localStorage.removeItem(`${group.id}-defaultSplittingOptions`)
+      return defaultValue
+    }
+  }
+
+  return {
+    splitMode: parsedDefaultSplitMode.splitMode,
+    paidFor: parsedDefaultSplitMode.paidFor.map((paidFor) => ({
+      participant: paidFor.participant,
+      shares: String(paidFor.shares / 100) as unknown as number,
+    })),
+  }
+}
+
+async function persistDefaultSplittingOptions(
+  groupId: string,
+  expenseFormValues: ExpenseFormValues,
+) {
+  if (localStorage && expenseFormValues.saveDefaultSplittingOptions) {
+    const computePaidFor = (): SplittingOptions['paidFor'] => {
+      if (expenseFormValues.splitMode === 'EVENLY') {
+        return expenseFormValues.paidFor.map(({ participant }) => ({
+          participant,
+          shares: '100' as unknown as number,
+        }))
+      } else if (expenseFormValues.splitMode === 'BY_AMOUNT') {
+        return null
+      } else {
+        return expenseFormValues.paidFor
+      }
+    }
+
+    const splittingOptions = {
+      splitMode: expenseFormValues.splitMode,
+      paidFor: computePaidFor(),
+    } satisfies SplittingOptions
+
+    localStorage.setItem(
+      `${groupId}-defaultSplittingOptions`,
+      JSON.stringify(splittingOptions),
+    )
+  }
+}
+
 export function ExpenseForm({
   group,
   expense,
@@ -75,6 +162,7 @@ export function ExpenseForm({
     }
     return field?.value
   }
+  const defaultSplittingOptions = getDefaultSplittingOptions(group)
   const form = useForm<ExpenseFormValues>({
     resolver: zodResolver(expenseFormSchema),
     defaultValues: expense
@@ -89,6 +177,7 @@ export function ExpenseForm({
             shares: String(shares / 100) as unknown as number,
           })),
           splitMode: expense.splitMode,
+          saveDefaultSplittingOptions: false,
           isReimbursement: expense.isReimbursement,
           documents: expense.documents,
         }
@@ -103,11 +192,15 @@ export function ExpenseForm({
           paidBy: searchParams.get('from') ?? undefined,
           paidFor: [
             searchParams.get('to')
-              ? { participant: searchParams.get('to')!, shares: 1 }
+              ? {
+                  participant: searchParams.get('to')!,
+                  shares: '1' as unknown as number,
+                }
               : undefined,
           ],
           isReimbursement: true,
-          splitMode: 'EVENLY',
+          splitMode: defaultSplittingOptions.splitMode,
+          saveDefaultSplittingOptions: false,
           documents: [],
         }
       : {
@@ -120,13 +213,11 @@ export function ExpenseForm({
             ? Number(searchParams.get('categoryId'))
             : 0, // category with Id 0 is General
           // paid for all, split evenly
-          paidFor: group.participants.map(({ id }) => ({
+          paidFor: defaultSplittingOptions.paidFor,
-            participant: id,
-            shares: 1,
-          })),
           paidBy: getSelectedPayer(),
           isReimbursement: false,
-          splitMode: 'EVENLY',
+          splitMode: defaultSplittingOptions.splitMode,
+          saveDefaultSplittingOptions: false,
           documents: searchParams.get('imageUrl')
             ? [
                 {
@@ -141,9 +232,14 @@ export function ExpenseForm({
   })
   const [isCategoryLoading, setCategoryLoading] = useState(false)
 
+  const submit = async (values: ExpenseFormValues) => {
+    await persistDefaultSplittingOptions(group.id, values)
+    return onSubmit(values)
+  }
+
   return (
     <Form {...form}>
-      <form onSubmit={form.handleSubmit((values) => onSubmit(values))}>
+      <form onSubmit={form.handleSubmit(submit)}>
         <Card>
           <CardHeader>
             <CardTitle>
@@ -210,18 +306,23 @@ export function ExpenseForm({
             <FormField
               control={form.control}
               name="amount"
-              render={({ field }) => (
+              render={({ field: { onChange, ...field } }) => (
                 <FormItem className="sm:order-3">
                   <FormLabel>Amount</FormLabel>
                   <div className="flex items-baseline gap-2">
                     <span>{group.currency}</span>
                     <FormControl>
                       <Input
+                        {...field}
                         className="text-base max-w-[120px]"
-                        type="number"
+                        type="text"
                         inputMode="decimal"
                         step={0.01}
                         placeholder="0.00"
+                        onChange={(event) =>
+                          onChange(enforceCurrencyPattern(event.target.value))
+                        }
+                        onClick={(e) => e.currentTarget.select()}
                         {...field}
                       />
                     </FormControl>
@@ -427,7 +528,7 @@ export function ExpenseForm({
                                               ),
                                             )}
                                             className="text-base w-[80px] -my-2"
-                                            type="number"
+                                            type="text"
                                             disabled={
                                               !field.value?.some(
                                                 ({ participant }) =>
@@ -447,7 +548,9 @@ export function ExpenseForm({
                                                     ? {
                                                         participant: id,
                                                         shares:
-                                                          event.target.value,
+                                                          enforceCurrencyPattern(
+                                                            event.target.value,
+                                                          ),
                                                       }
                                                     : p,
                                                 ),
@@ -490,7 +593,10 @@ export function ExpenseForm({
               )}
             />
 
-            <Collapsible className="mt-5">
+            <Collapsible
+              className="mt-5"
+              defaultOpen={form.getValues().splitMode !== 'EVENLY'}
+            >
               <CollapsibleTrigger asChild>
                 <Button variant="link" className="-mx-4">
                   Advanced splitting options…
@@ -502,7 +608,7 @@ export function ExpenseForm({
                     control={form.control}
                     name="splitMode"
                     render={({ field }) => (
-                      <FormItem className="sm:order-2">
+                      <FormItem>
                         <FormLabel>Split mode</FormLabel>
                         <FormControl>
                           <Select
@@ -538,6 +644,25 @@ export function ExpenseForm({
                       </FormItem>
                     )}
                   />
+                  <FormField
+                    control={form.control}
+                    name="saveDefaultSplittingOptions"
+                    render={({ field }) => (
+                      <FormItem className="flex flex-row gap-2 items-center space-y-0 pt-2">
+                        <FormControl>
+                          <Checkbox
+                            checked={field.value}
+                            onCheckedChange={field.onChange}
+                          />
+                        </FormControl>
+                        <div>
+                          <FormLabel>
+                            Save as default splitting options
+                          </FormLabel>
+                        </div>
+                      </FormItem>
+                    )}
+                  />
                 </div>
               </CollapsibleContent>
             </Collapsible>
@@ -577,15 +702,7 @@ export function ExpenseForm({
             {isCreate ? <>Create</> : <>Save</>}
           </SubmitButton>
           {!isCreate && onDelete && (
-            <AsyncButton
+            <DeletePopup onDelete={onDelete}></DeletePopup>
-              type="button"
-              variant="destructive"
-              loadingContent="Deleting…"
-              action={onDelete}
-            >
-              <Trash2 className="w-4 h-4 mr-2" />
-              Delete
-            </AsyncButton>
           )}
           <Button variant="ghost" asChild>
             <Link href={`/groups/${group.id}`}>Cancel</Link>

src/lib/hooks.ts

@@ -48,3 +48,17 @@ export function useBaseUrl() {
   }, [])
   return baseUrl
 }
+
+/**
+ * @returns The active user, or `null` until it is fetched from local storage
+ */
+export function useActiveUser(groupId: string) {
+  const [activeUser, setActiveUser] = useState<string | null>(null)
+
+  useEffect(() => {
+    const activeUser = localStorage.getItem(`${groupId}-activeUser`)
+    if (activeUser) setActiveUser(activeUser)
+  }, [groupId])
+
+  return activeUser
+}

src/lib/schemas.ts

@@ -51,8 +51,7 @@ export const expenseFormSchema = z
         [
           z.number(),
           z.string().transform((value, ctx) => {
-            const normalizedValue = value.replace(/,/g, '.')
+            const valueAsNumber = Number(value)
-            const valueAsNumber = Number(normalizedValue)
             if (Number.isNaN(valueAsNumber))
               ctx.addIssue({
                 code: z.ZodIssueCode.custom,
@@ -106,6 +105,7 @@ export const expenseFormSchema = z
         Object.values(SplitMode) as any,
       )
       .default('EVENLY'),
+    saveDefaultSplittingOptions: z.boolean(),
     isReimbursement: z.boolean(),
     documents: z
       .array(
@@ -161,3 +161,9 @@ export const expenseFormSchema = z
   })
 
 export type ExpenseFormValues = z.infer<typeof expenseFormSchema>
+
+export type SplittingOptions = {
+  // Used for saving default splitting options in localStorage
+  splitMode: SplitMode
+  paidFor: ExpenseFormValues['paidFor'] | null
+}

src/lib/totals.ts

@@ -0,0 +1,70 @@
+import { getGroupExpenses } from '@/lib/api'
+
+export function getTotalGroupSpending(
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>,
+): number {
+  return expenses.reduce(
+    (total, expense) =>
+      expense.isReimbursement ? total : total + expense.amount,
+    0,
+  )
+}
+
+export function getTotalActiveUserPaidFor(
+  activeUserId: string | null,
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>,
+): number {
+  return expenses.reduce(
+    (total, expense) =>
+      expense.paidBy.id === activeUserId && !expense.isReimbursement
+        ? total + expense.amount
+        : total,
+    0,
+  )
+}
+
+export function getTotalActiveUserShare(
+  activeUserId: string | null,
+  expenses: NonNullable<Awaited<ReturnType<typeof getGroupExpenses>>>,
+): number {
+  let total = 0
+
+  expenses.forEach((expense) => {
+    if (expense.isReimbursement) return
+
+    const paidFors = expense.paidFor
+    const userPaidFor = paidFors.find(
+      (paidFor) => paidFor.participantId === activeUserId,
+    )
+
+    if (!userPaidFor) {
+      // If the active user is not involved in the expense, skip it
+      return
+    }
+
+    switch (expense.splitMode) {
+      case 'EVENLY':
+        // Divide the total expense evenly among all participants
+        total += expense.amount / paidFors.length
+        break
+      case 'BY_AMOUNT':
+        // Directly add the user's share if the split mode is BY_AMOUNT
+        total += userPaidFor.shares
+        break
+      case 'BY_PERCENTAGE':
+        // Calculate the user's share based on their percentage of the total expense
+        total += (expense.amount * userPaidFor.shares) / 10000 // Assuming shares are out of 10000 for percentage
+        break
+      case 'BY_SHARES':
+        // Calculate the user's share based on their shares relative to the total shares
+        const totalShares = paidFors.reduce(
+          (sum, paidFor) => sum + paidFor.shares,
+          0,
+        )
+        total += (expense.amount * userPaidFor.shares) / totalShares
+        break
+    }
+  })
+
+  return parseFloat(total.toFixed(2))
+}