Files
docs/khata-app/wiki/04_domain_resources/index.html

1083 lines
24 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../03_components/">
<link rel="next" href="../05_enrichment/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Domain Resources - Khata App — Wiki</title>
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#domain-resources" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Khata App — Wiki" class="md-header__button md-logo" aria-label="Khata App — Wiki" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11 8c0 2.21-1.79 4-4 4s-4-1.79-4-4 1.79-4 4-4 4 1.79 4 4m0 6.72V20H0v-2c0-2.21 3.13-4 7-4 1.5 0 2.87.27 4 .72M24 20H13V3h11zm-8-8.5a2.5 2.5 0 0 1 5 0 2.5 2.5 0 0 1-5 0M22 7a2 2 0 0 1-2-2h-3c0 1.11-.89 2-2 2v9a2 2 0 0 1 2 2h3c0-1.1.9-2 2-2z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Khata App — Wiki
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Domain Resources
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../01_overview/" class="md-tabs__link">
Overview
</a>
</li>
<li class="md-tabs__item">
<a href="../02_architecture/" class="md-tabs__link">
Architecture
</a>
</li>
<li class="md-tabs__item">
<a href="../03_components/" class="md-tabs__link">
Components
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Domain Resources
</a>
</li>
<li class="md-tabs__item">
<a href="../05_enrichment/" class="md-tabs__link">
Enrichment
</a>
</li>
<li class="md-tabs__item">
<a href="../06_extraction_pipelines/" class="md-tabs__link">
Extraction Pipelines
</a>
</li>
<li class="md-tabs__item">
<a href="../07_fetch_request_workflow/" class="md-tabs__link">
Fetch Request Workflow
</a>
</li>
<li class="md-tabs__item">
<a href="../08_reports_and_caching/" class="md-tabs__link">
Reports & Caching
</a>
</li>
<li class="md-tabs__item">
<a href="../09_running_the_service/" class="md-tabs__link">
Running The Service
</a>
</li>
<li class="md-tabs__item">
<a href="../10_development/" class="md-tabs__link">
Dev Guide
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Khata App — Wiki" class="md-nav__button md-logo" aria-label="Khata App — Wiki" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11 8c0 2.21-1.79 4-4 4s-4-1.79-4-4 1.79-4 4-4 4 1.79 4 4m0 6.72V20H0v-2c0-2.21 3.13-4 7-4 1.5 0 2.87.27 4 .72M24 20H13V3h11zm-8-8.5a2.5 2.5 0 0 1 5 0 2.5 2.5 0 0 1-5 0M22 7a2 2 0 0 1-2-2h-3c0 1.11-.89 2-2 2v9a2 2 0 0 1 2 2h3c0-1.1.9-2 2-2z"/></svg>
</a>
Khata App — Wiki
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../01_overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../02_architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../03_components/" class="md-nav__link">
<span class="md-ellipsis">
Components
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Domain Resources
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Domain Resources
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#users" class="md-nav__link">
<span class="md-ellipsis">
👤 Users
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#entities" class="md-nav__link">
<span class="md-ellipsis">
🏢 Entities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#accounts" class="md-nav__link">
<span class="md-ellipsis">
🏦 Accounts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#expenses" class="md-nav__link">
<span class="md-ellipsis">
🧾 Expenses
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tags" class="md-nav__link">
<span class="md-ellipsis">
🏷 Tags
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#uploads" class="md-nav__link">
<span class="md-ellipsis">
📤 Uploads
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fetch-request" class="md-nav__link">
<span class="md-ellipsis">
📥 Fetch Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#repositories-ports" class="md-nav__link">
<span class="md-ellipsis">
🔁 Repositories (Ports)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related" class="md-nav__link">
<span class="md-ellipsis">
🔗 Related
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../05_enrichment/" class="md-nav__link">
<span class="md-ellipsis">
Enrichment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../06_extraction_pipelines/" class="md-nav__link">
<span class="md-ellipsis">
Extraction Pipelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../07_fetch_request_workflow/" class="md-nav__link">
<span class="md-ellipsis">
Fetch Request Workflow
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../08_reports_and_caching/" class="md-nav__link">
<span class="md-ellipsis">
Reports & Caching
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../09_running_the_service/" class="md-nav__link">
<span class="md-ellipsis">
Running The Service
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_11" >
<div class="md-nav__link md-nav__container">
<a href="../10_development/" class="md-nav__link ">
<span class="md-ellipsis">
Dev Guide
</span>
</a>
<label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_11">
<span class="md-nav__icon md-icon"></span>
Dev Guide
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../10_development/01_environment/" class="md-nav__link">
<span class="md-ellipsis">
Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../10_development/02_testing/" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../10_development/03_gsdfc_docstrings/" class="md-nav__link">
<span class="md-ellipsis">
GSDFC Docstrings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../10_development/04_building_docs/" class="md-nav__link">
<span class="md-ellipsis">
Building Docs
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="domain-resources">📦 Domain Resources</h1>
<p>Each resource group is a domain package with <code>models</code>, <code>ports</code> (abstract repositories/services), and a <code>service</code> implementation — a <strong>facade</strong> over the repo. Everything is defined by GSDFC docstrings and mirrored as <code>.pyi</code> stubs.</p>
<hr />
<h2 id="users">👤 Users</h2>
<ul>
<li><code>User</code> — id, name, email, phone, password hash, avatar.</li>
<li><code>UserActivity</code> — audit trail of user-driven actions.</li>
<li>Service: <code>UserService</code> (create, read, update, delete, activity log). Routes: <code>GET/POST /users</code>, <code>GET/PATCH/DELETE /users/{id}</code>, activity listing under <code>/users/{id}/activities</code>.</li>
</ul>
<hr />
<h2 id="entities">🏢 Entities</h2>
<ul>
<li><code>Entity</code> — canonical payee: name, brands, branch, aliases, classification, type.</li>
<li><code>EntityAccount</code> — an account known to belong to an entity.</li>
<li>Service: <code>EntityService</code> — entity creation, name-based lookup, account linking. Routes: <code>GET/POST /entities</code>, <code>GET/PATCH /entities/{id}</code>, <code>POST /entities/{id}/accounts</code>.</li>
</ul>
<hr />
<h2 id="accounts">🏦 Accounts</h2>
<ul>
<li><code>Account</code> — bank account: name, account number, bank, currency, account type, iban, linked entity.</li>
<li><code>AccountType</code> — savings / current / credit etc.</li>
<li>Service: <code>AccountService</code> — create, read, update, delete, balance helpers. Routes: <code>GET/POST /accounts</code>, <code>GET/PATCH/DELETE /accounts/{id}</code>.</li>
</ul>
<hr />
<h2 id="expenses">🧾 Expenses</h2>
<ul>
<li><code>Expense</code> — the core record: amount, balance, kind (debit/credit/transfer), mcc, memo, date, tag, entity, source.</li>
<li><code>ExpenseTag</code> — tag membership on an expense; <code>ExpenseSource</code> — provenance (upload/fetch-request).</li>
<li>Service: <code>ExpenseService</code> — CRUD plus tag assignment and entity resolution. Routes: <code>GET/POST /expenses</code>, <code>GET/PATCH/DELETE /expenses/{id}</code>, tag/entity mutation sub-routes.</li>
</ul>
<hr />
<h2 id="tags">🏷 Tags</h2>
<ul>
<li><code>Tag</code> — name, color, optional description.</li>
<li><code>TagColor</code> — palette enum for display.</li>
<li>Service: <code>TagService</code> — CRUD. Routes: <code>GET/POST /tags</code>, <code>GET/PATCH/DELETE /tags/{id}</code>.</li>
</ul>
<hr />
<h2 id="uploads">📤 Uploads</h2>
<ul>
<li><code>Upload</code> — records a raw statement upload (file or email) with status.</li>
<li>Service: <code>UploadService</code> — create, read, update status, list. Routes under <code>/uploads</code>.</li>
</ul>
<hr />
<h2 id="fetch-request">📥 Fetch Request</h2>
<ul>
<li><code>FetchRequest</code> — a statement ingestion job: user, account, source (file/email), date range, status, retry count.</li>
<li><code>FileSource</code> — path + optional bank; <code>EmailSource</code> — mailbox + filters; <code>Bank</code> — enum of supported banks.</li>
<li>Service: <code>FetchRequestService</code> — CRUD + status transitions (<code>update_status</code>). Routes: <code>GET/POST /fetch-requests</code>, <code>GET/PATCH /fetch-requests/{id}</code>, <code>POST /fetch-requests/{id}/retry</code>.</li>
</ul>
<hr />
<h2 id="repositories-ports">🔁 Repositories (Ports)</h2>
<p>Every group declares abstract repo ports (<code>Ports</code>: <code>db.py</code>, <code>service.py</code>) in the domain and implements them in <code>infra/repos/</code> with mongo-ops. Repos support:</p>
<ul>
<li><strong>filter-based queries</strong> — <code>search(filter={...}, limit=...)</code></li>
<li><strong>explicit FK population</strong> — <code>x-fk</code> resolves referenced ids via exact filters</li>
<li><strong>cache invalidation</strong> — writes clear the in-memory LRU</li>
</ul>
<p>Shared wiring lives in <code>facades.py</code> (domain) and <code>repositories.py</code> (infra). The service registry keys used in <code>init.py</code> are the string names passed to <code>get_svc(...)</code>.</p>
<hr />
<h2 id="related">🔗 Related</h2>
<p><a href="../03_components/">Components</a> · <a href="../05_enrichment/">Enrichment</a> · <a href="../08_reports_and_caching/">Reports &amp; Caching</a></p>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest", "navigation.tabs", "toc.integrate", "header.autohide", "announce.dismiss", "footer.social", "content.code.select", "content.code.line_numbers", "content.tooltips"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>