Files
GroundedHelper/frontend/bricks/api_endpoint/README.md
alvocool 16bff634b5 Initial commit: Grounded Flutter frontend
A to-do app that doesn't believe you — an enforcement layer rather than a
neutral ledger.

Architecture ported from Autoreceptives/Frontend/Receptive: stacked MVVM with
the mandatory 4-file screen pattern, one ParentViewModel owning the loading /
network / error overlays and the handleError decision tree, one AppDataManager
gateway, dio comms carrying the three identity headers, secure storage with
random-suffixed keys, and a single-chokepoint Navigator. Package root and Dart
package name are both Grounded; org is nya.

The enforcement engine, one unit per formula in utils/:

- DebtEngine      w(class) x severity(d) x decay(t), sublinear severity so old
                  misses cannot swamp the score; abandonment 2x with 30-day
                  decay immunity; late complete retains 30%
- StandingEngine  Good -> Warned -> Grounded -> Lockdown, derived not set;
                  Grounded replaces home with the overdue queue
- CapacityEngine  blocks over-scheduling against p50 of historically completed
                  minutes, with a learned per-category estimation multiplier
- IntegrityEngine session integrity, weekly volume, plyometric contact ceiling
                  and enforced recovery gaps
- ExcuseAnalyser  on-device excuse clustering plus the confrontation copy
- GuardrailEngine distress detection and rationed amnesty
- ToneEngine      all enforcement copy, so the tone cap lives in one place

CommitmentEvent is append-only and is the source of truth rather than the
status field, which is what makes honest history and excuse analysis possible.

Goals contain commitments via parentId, and a task can be run from a
full-screen runner that derives elapsed time from wall-clock so screen-off
cannot lose time. Backgrounding pauses the clock and is counted. The runner is
mirrored into an ongoing notification, with alarm-class full-screen intents
reserved for non-negotiables.

Design language, fonts, icon and native splash are in place; Mason bricks are
retargeted to this project and verified end-to-end.

flutter analyze lib/ reports no errors.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Mfu2gQLSFN21YRBcU2NrTt
2026-07-27 09:11:17 +03:00

84 lines
2.3 KiB
Markdown

## 📄 README.md
### 🚀 API Endpoint Mason Brick
A smart, synchronized generator that appends API logic across `Comms`, `ConnectComms`, and `AppDataManager` while handling auto-imports and optional formatting.
### 🛠 1. First-Time Setup
Run these commands to ensure Mason and the Dart hooks are ready to go:
```bash
# 1. Install Mason CLI (if you haven't)
dart pub global activate mason_cli
# 2. Initialize Mason in project root
mason init
# 3. Install Hook dependencies
cd bricks/api_endpoint/hooks
dart pub get
cd ../../../
# 4. Register the brick
mason get
```
### 🔃 2. How to Refresh (When logic or prompts change)
If you update the `brick.yaml` or the `post_gen.dart` hook, Mason might use a cached version. Use this "Hard Refresh" command:
```bash
rm -rf .mason && mason get
```
### 🏃 3. Running the Generator
To add a new endpoint, simply run:
```bash
mason make api_endpoint
```
**Interaction Flow:**
1. **Endpoint Path:** e.g., `orders/confirm`
2. **Function Name:** e.g., `confirmOrder`
3. **Method:** Choose `get` or `post`.
4. **Request Body:** * **Mandatory for POST**: e.g., `OrderDetails`.
* **Optional for GET**: Leave empty or provide a type like `String`.
5. **Auto-Import**: The brick scans `lib/` for your Body type and adds the `import` statement automatically.
6. **Format**: Choose `y` to run `dart format` on all 4 modified files.
---
## 🐚 setup_brick.sh
Create this file in your project root to allow one-click setup or refreshing for your team.
```bash
#!/bin/bash
# setup_brick.sh
echo "🧹 Cleaning old Mason cache..."
rm -rf .mason
echo "📦 Fetching Hook dependencies..."
if [ -d "bricks/api_endpoint/hooks" ]; then
cd bricks/api_endpoint/hooks
dart pub get
cd ../../../
else
echo "❌ Error: bricks/api_endpoint/hooks directory not found!"
exit 1
fi
echo "🧱 Registering Mason Brick..."
mason get
echo "✅ Setup Complete! Run 'mason make api_endpoint' to start."
```
### To use the script:
1. Create the file: `touch setup_brick.sh`
2. Give it permission: `chmod +x setup_brick.sh`
3. Run it: `./setup_brick.sh`
---
### 💡 Pro-Tip: Project Name Detection
In your `post_gen.dart` hook, ensure you have updated the `package:your_project_name` string to match your real project name from `pubspec.yaml`, otherwise the auto-imports will show a red error in VS Code.