mirror of
https://github.com/frappe/erpnext.git
synced 2026-08-23 20:16:40 +00:00
feat: new banking module (#54720)
* feat: initial SPA setup for banking * wip: bring over new banking module * feat: added Espresso design tokens * feat: button styles * fix: add all ink colors * wip: espresso design system changes * feat: button and badge espresso components * fix: button styling for reconcile * feat: Espresso progress bar * feat: Espresso toggle switch * feat: Espresso tabs design * fix: vertical tab support * fix: button sizing across modals * feat: Espresso style table layout * feat: Espresso tooltip * feat: Espresso elevations and checkbox * feat: Dialog with Espresso styles * feat: Espresso textarea * fix: input styles * fix: colors on bank picker * fix: breadcrumb styling * fix: bank picker styling * feat: create doctypes and fields for bank reconciliation * feat: APIs for banking * fix: use date format parser * fix: font styling to match Espresso * wip: settings modal * feat: settings dialog component * fix: icons and invalid requests * feat: preferences tab * fix: adjust icon stroke width to 1.5 * feat: rule configuration in settings * fix: remove sheet component * feat: alert and error banner component * feat: dropdown in Espresso * feat: popover and select in Espresso * fix: cleanup more styles * fix: match size of link fields * feat: command styling * fix: remove unused style tokens * fix: styles for global date picker dropdown * fix: styles for match and reconcile * feat: table Espresso component * feat: remove all other design tokens * fix: remove unused tokens * fix: form elements * fix: remove unused styles and fix filters in bank transaction list * feat: fetch bank rec doctypes for filtering * fix: record payment modal * feat: support for dark mode switching * fix: move bank logos to public folder * feat: add support for RTL * feat: support for RTL * chore: send layout direction in dev boot * fix: make checkbox work in RTL * feat: dark mode support * fix: dark mode style * feat: bank logos in dark mode * feat: dark mode bank logos * chore: use dark mode bank logos everywhere * chore: move rule evaluation to controller * chore: add tests for bank transaction rules * fix: move deps to fix actions errors * fix: move tw-animate-css to deps * fix: remove shadcn * fix: do not open modal if no transactions selected * fix: add translation strings * feat: add banner on existing bank reconciliation tool * feat: bank statement import * fix: translations and layout directions * fix: validation for transaction matching rule * fix: styles * fix: show conflicting transactions in alert * fix: show help text for new banking module forms * feat: show total debits and credits * fix: dark mode colors in automatic config * feat: add keyboard shortcuts help * feat: added keyboard shortcut for settings * fix: decrease size of progress bar * chore: bump packages * feat: add tests for statement import * fix: settings dialog * fix: show banner on small screens * fix: show banner when no bank account set
This commit is contained in:
Nikhil Kothari
314
banking/src/components/features/Settings/Rules/RuleList.tsx
Normal file
314
banking/src/components/features/Settings/Rules/RuleList.tsx
Normal file
@@ -0,0 +1,314 @@
|
||||
import { Button } from "@/components/ui/button"
|
||||
import ErrorBanner from "@/components/ui/error-banner"
|
||||
import { Skeleton } from "@/components/ui/skeleton"
|
||||
import { Badge } from "@/components/ui/badge"
|
||||
import _ from "@/lib/translate"
|
||||
import { BankTransactionRule } from "@/types/Accounts/BankTransactionRule"
|
||||
import { FrappeConfig, FrappeContext, useFrappeGetCall, useFrappeGetDocList, useFrappePostCall } from "frappe-react-sdk"
|
||||
import { ArrowDownRight, ArrowDownUp, ArrowUpRight, MoreVertical, Trash2, GripVertical, Play, RefreshCw, ZapIcon, CalendarSyncIcon } from "lucide-react"
|
||||
import { useContext, useState } from "react"
|
||||
import { toast } from "sonner"
|
||||
import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger, DropdownMenuSeparator, DropdownMenuCheckboxItem } from "@/components/ui/dropdown-menu"
|
||||
import {
|
||||
DndContext,
|
||||
closestCenter,
|
||||
KeyboardSensor,
|
||||
PointerSensor,
|
||||
useSensor,
|
||||
useSensors,
|
||||
DragEndEvent,
|
||||
} from '@dnd-kit/core'
|
||||
import {
|
||||
arrayMove,
|
||||
SortableContext,
|
||||
sortableKeyboardCoordinates,
|
||||
verticalListSortingStrategy,
|
||||
} from '@dnd-kit/sortable'
|
||||
import {
|
||||
useSortable,
|
||||
} from '@dnd-kit/sortable'
|
||||
import { CSS } from '@dnd-kit/utilities'
|
||||
import { Empty, EmptyDescription, EmptyHeader, EmptyMedia, EmptyTitle } from "@/components/ui/empty"
|
||||
import { cn } from "@/lib/utils"
|
||||
|
||||
const useGetRuleList = () => {
|
||||
return useFrappeGetDocList<BankTransactionRule>("Bank Transaction Rule", {
|
||||
fields: ["name", "rule_name", "rule_description", "transaction_type", "priority"],
|
||||
orderBy: {
|
||||
field: 'priority',
|
||||
order: 'asc'
|
||||
},
|
||||
limit: 100
|
||||
})
|
||||
}
|
||||
|
||||
export const RunRulesButton = () => {
|
||||
|
||||
const { data } = useGetRuleList()
|
||||
|
||||
const { call: runRuleEvaluation, loading: isRunningRules } = useFrappePostCall('erpnext.accounts.doctype.bank_transaction_rule.bank_transaction_rule.run_rule_evaluation')
|
||||
|
||||
const handleRunRules = async (forceEvaluate: boolean = false) => {
|
||||
try {
|
||||
await runRuleEvaluation({
|
||||
force_evaluate: forceEvaluate
|
||||
})
|
||||
toast.success(forceEvaluate ? _("Rules evaluation started") : _("Rules evaluation completed"))
|
||||
} catch (error) {
|
||||
toast.error(_("Failed to run rules evaluation"))
|
||||
console.error("Error running rules evaluation:", error)
|
||||
}
|
||||
}
|
||||
|
||||
if (!data || data.length === 0) {
|
||||
return null
|
||||
}
|
||||
|
||||
return <DropdownMenu>
|
||||
<DropdownMenuTrigger asChild>
|
||||
<Button variant="outline" size="sm" disabled={isRunningRules}>
|
||||
{isRunningRules ? (
|
||||
<RefreshCw className="animate-spin" />
|
||||
) : (
|
||||
<Play />
|
||||
)}
|
||||
{isRunningRules ? _("Running...") : _("Run Rules")}
|
||||
</Button>
|
||||
</DropdownMenuTrigger>
|
||||
<DropdownMenuContent align="start">
|
||||
<DropdownMenuItem onClick={() => handleRunRules(false)} disabled={isRunningRules} title={_("Run rules on unreconciled transactions that haven't been evaluated yet")}>
|
||||
<Play />
|
||||
{_("Run on new transactions")}
|
||||
</DropdownMenuItem>
|
||||
<DropdownMenuItem onClick={() => handleRunRules(true)} disabled={isRunningRules} title={_("Force re-evaluate all unreconciled transactions, even if they were previously evaluated")}>
|
||||
<RefreshCw />
|
||||
{_("Force evaluate all")}
|
||||
</DropdownMenuItem>
|
||||
<DropdownMenuSeparator />
|
||||
<AutoRunRuleItem />
|
||||
</DropdownMenuContent>
|
||||
</DropdownMenu>
|
||||
}
|
||||
|
||||
const AutoRunRuleItem = () => {
|
||||
|
||||
const { db } = useContext(FrappeContext) as FrappeConfig
|
||||
|
||||
const { data: accountsSetting, mutate: setAutomaticallyRunRulesOnUnreconciledTransactions } = useFrappeGetCall("frappe.client.get_single_value", {
|
||||
"doctype": "Accounts Settings",
|
||||
"field": "automatically_run_rules_on_unreconciled_transactions"
|
||||
})
|
||||
|
||||
const automaticallyRunRulesOnUnreconciledTransactions = accountsSetting?.message ? true : false
|
||||
|
||||
const onAutoClassifyTransactions = (checked: boolean) => {
|
||||
toast.promise(db.setValue("Accounts Settings", "Accounts Settings", "automatically_run_rules_on_unreconciled_transactions", checked ? 1 : 0).then(() => {
|
||||
setAutomaticallyRunRulesOnUnreconciledTransactions({
|
||||
message: {
|
||||
automatically_run_rules_on_unreconciled_transactions: checked ? 1 : 0,
|
||||
}
|
||||
}, {
|
||||
revalidate: false
|
||||
})
|
||||
}), {
|
||||
loading: _("Updating..."),
|
||||
success: checked ? _("Scheduled job enabled. Transactions will be auto classified.") : _("Scheduled job disabled. Transactions will not be auto classified."),
|
||||
error: _("Failed to update auto classify transactions settings")
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
return <DropdownMenuCheckboxItem
|
||||
checked={automaticallyRunRulesOnUnreconciledTransactions}
|
||||
onCheckedChange={onAutoClassifyTransactions}>
|
||||
<CalendarSyncIcon />
|
||||
{_("Run rules automatically")}
|
||||
</DropdownMenuCheckboxItem>
|
||||
}
|
||||
|
||||
|
||||
|
||||
const RuleList = ({ setSelectedRule }: { setSelectedRule: (rule: string) => void }) => {
|
||||
|
||||
const { data, error, isLoading, mutate } = useGetRuleList()
|
||||
|
||||
const { db } = useContext(FrappeContext) as FrappeConfig
|
||||
|
||||
const sensors = useSensors(
|
||||
useSensor(PointerSensor),
|
||||
useSensor(KeyboardSensor, {
|
||||
coordinateGetter: sortableKeyboardCoordinates,
|
||||
})
|
||||
)
|
||||
|
||||
const onDeleteRule = (ruleID: string) => {
|
||||
toast.promise(db.deleteDoc("Bank Transaction Rule", ruleID).then(() => {
|
||||
mutate()
|
||||
}), {
|
||||
loading: _("Deleting rule..."),
|
||||
success: _("Rule deleted."),
|
||||
error: _("Failed to delete rule.")
|
||||
})
|
||||
}
|
||||
|
||||
const handleDragEnd = async (event: DragEndEvent) => {
|
||||
const { active, over } = event
|
||||
|
||||
if (active.id !== over?.id && data) {
|
||||
const oldIndex = data.findIndex((rule) => rule.name === active.id)
|
||||
const newIndex = data.findIndex((rule) => rule.name === over?.id)
|
||||
|
||||
const newData = arrayMove(data, oldIndex, newIndex)
|
||||
|
||||
// Update priorities based on new order
|
||||
const updatePromises = newData.map((rule, index) => {
|
||||
const newPriority = index + 1
|
||||
if (rule.priority !== newPriority) {
|
||||
return db.setValue("Bank Transaction Rule", rule.name, "priority", newPriority)
|
||||
}
|
||||
return Promise.resolve()
|
||||
})
|
||||
|
||||
try {
|
||||
await Promise.all(updatePromises)
|
||||
toast.success(_("Rule priorities updated"))
|
||||
mutate() // Refresh the data
|
||||
} catch (error) {
|
||||
toast.error(_("Failed to update rule priorities"))
|
||||
console.error("Error updating priorities:", error)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<>
|
||||
<div className="overflow-y-auto">
|
||||
{isLoading && <div className="flex flex-col gap-2">
|
||||
<Skeleton className="w-full h-10" />
|
||||
<Skeleton className="w-full h-10" />
|
||||
<Skeleton className="w-full h-10" />
|
||||
<Skeleton className="w-full h-10" />
|
||||
<Skeleton className="w-full h-10" />
|
||||
</div>}
|
||||
|
||||
{error && <ErrorBanner error={error} />}
|
||||
|
||||
{data && data.length === 0 && <Empty className="h-96">
|
||||
<EmptyMedia>
|
||||
<ZapIcon />
|
||||
</EmptyMedia>
|
||||
<EmptyHeader>
|
||||
<EmptyTitle>{_("No rules setup yet")}</EmptyTitle>
|
||||
<EmptyDescription>{_("Configure rules to save time when reconciling transactions.")}</EmptyDescription>
|
||||
</EmptyHeader>
|
||||
|
||||
</Empty>}
|
||||
|
||||
{data && data.length > 0 && (
|
||||
<DndContext
|
||||
sensors={sensors}
|
||||
collisionDetection={closestCenter}
|
||||
onDragEnd={handleDragEnd}
|
||||
>
|
||||
<SortableContext
|
||||
items={data.map(rule => rule.name)}
|
||||
strategy={verticalListSortingStrategy}
|
||||
>
|
||||
<ul className="space-2 divide-y divide-outline-gray-modals">
|
||||
{data?.map((rule) => (
|
||||
<SortableRuleItem
|
||||
key={rule.name}
|
||||
rule={rule}
|
||||
setSelectedRule={setSelectedRule}
|
||||
onDeleteRule={onDeleteRule}
|
||||
/>
|
||||
))}
|
||||
</ul>
|
||||
</SortableContext>
|
||||
</DndContext>
|
||||
)}
|
||||
</div>
|
||||
</>
|
||||
)
|
||||
}
|
||||
const SortableRuleItem = ({
|
||||
rule,
|
||||
setSelectedRule,
|
||||
onDeleteRule
|
||||
}: {
|
||||
rule: BankTransactionRule
|
||||
setSelectedRule: (rule: string) => void
|
||||
onDeleteRule: (ruleID: string) => void
|
||||
}) => {
|
||||
const {
|
||||
attributes,
|
||||
listeners,
|
||||
setNodeRef,
|
||||
transform,
|
||||
transition,
|
||||
isDragging,
|
||||
} = useSortable({ id: rule.name })
|
||||
|
||||
const style = {
|
||||
transform: CSS.Transform.toString(transform),
|
||||
transition,
|
||||
opacity: isDragging ? 0.5 : 1,
|
||||
}
|
||||
|
||||
const [isDropdownOpen, setIsDropdownOpen] = useState(false)
|
||||
|
||||
return (
|
||||
<li ref={setNodeRef} style={style}>
|
||||
<div className={cn("flex justify-between items-center py-2 my-0.5 h-full hover:bg-surface-gray-1 pe-2 rounded", isDropdownOpen && "bg-surface-gray-1")}>
|
||||
<div className="flex items-center gap-2">
|
||||
<div
|
||||
{...attributes}
|
||||
{...listeners}
|
||||
className="cursor-grab active:cursor-grabbing p-1 rounded"
|
||||
title={_("Drag to reorder")}
|
||||
>
|
||||
<GripVertical className="w-4 h-4 text-ink-gray-5" />
|
||||
</div>
|
||||
<Badge theme="gray" className="font-numeric tabular-nums">
|
||||
{rule.priority}
|
||||
</Badge>
|
||||
<div className="flex flex-col gap-1">
|
||||
<div className="flex items-center gap-2">
|
||||
<Button
|
||||
variant='link'
|
||||
size='sm'
|
||||
className="p-0 h-fit text-start cursor-pointer no-underline hover:underline"
|
||||
onClick={() => setSelectedRule(rule.name)}>
|
||||
{rule.rule_name}
|
||||
</Button>
|
||||
<div title={rule.transaction_type === "Any" ? _("Applies to withdrawals and deposits") : rule.transaction_type === "Withdrawal" ? _("Applies to withdrawals") : _("Applies to deposits")}>
|
||||
{rule.transaction_type === "Any" ? <ArrowDownUp className="text-ink-gray-5 w-4 h-4" /> : rule.transaction_type === "Withdrawal" ? <ArrowUpRight className="text-ink-red-3 w-5 h-5" /> : <ArrowDownRight className="text-ink-green-3 w-5 h-5" />}
|
||||
</div>
|
||||
</div>
|
||||
<span className="text-sm text-ink-gray-5">
|
||||
{rule.rule_description}
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="flex items-center gap-2 h-full justify-center">
|
||||
<DropdownMenu open={isDropdownOpen} onOpenChange={setIsDropdownOpen}>
|
||||
<DropdownMenuTrigger asChild>
|
||||
<Button variant='ghost' isIconButton className="hover:bg-transparent">
|
||||
<MoreVertical />
|
||||
</Button>
|
||||
</DropdownMenuTrigger>
|
||||
<DropdownMenuContent align="end">
|
||||
<DropdownMenuItem onClick={() => onDeleteRule(rule.name)}>
|
||||
<Trash2 />
|
||||
{_("Delete")}
|
||||
</DropdownMenuItem>
|
||||
</DropdownMenuContent>
|
||||
</DropdownMenu>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
)
|
||||
}
|
||||
|
||||
export default RuleList
|
||||
Reference in New Issue
Block a user