Files
nearle_pos/lib/presentation/payment/providers/payment_controller.dart
Suriya fdd90f28d9 Open the cash drawer for real, and persist the back-office route
Cash drawer
- openCashDrawer was a debugPrint. The drawer never opened.
- It cannot go through the PDF pipeline: a PDF is rendered by the platform
  driver, which will not pass raw ESC/POS bytes to the device. So it goes over
  a socket instead — nearly every network thermal printer listens on 9100 and
  forwards whatever arrives straight to the print head, which makes the whole
  protocol five bytes.
- Printer IP and port are configurable in Settings with a Test button that
  saves and fires immediately, because a drawer that does not open is
  indistinguishable from one that is not wired up.
- Every failure explains itself: unreachable, refused, or simply not
  configured — which is the honest state for a USB printer, since there is no
  raw path to one from Flutter.
- Now fires only on a cash tender. A card-only sale that pops the drawer is a
  shrinkage risk, and it is the first thing a shop notices.

Back-office route
- Host, port, TLS and transport persist to the database; username, password
  and API key go to the platform keystore (Keychain / Credential Manager /
  Android Keystore). Writing credentials into SQLite would put them in the
  same file as the bills, on a machine behind a shop counter.
- Loaded at startup. Previously the dialog wrote settings that were silently
  ignored on the next launch, which reads exactly like they never saved — and
  credentials retyped every morning end up on a sticky note instead.
- A saved route never overwrites the terminal's store or terminal id. Those
  belong to the device, and re-pointing a till at a different broker must not
  change who it is, or its bills and presence records stop lining up.

Tests: 168 -> 176. The drawer test stands up a real socket server and asserts
the exact bytes arrive. The config test asserts no credential appears anywhere
in the meta table while the non-secret settings do.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-01 13:18:56 +05:30

245 lines
7.9 KiB
Dart

import 'dart:async';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import '../../../app/providers.dart';
import '../../../core/utils/extensions.dart';
import '../../../data/sync/sync_engine.dart';
import '../../../domain/entities/transaction.dart';
import '../../../domain/usecases/checkout_sale.dart';
import '../../auth/providers/auth_controller.dart';
import '../../pos/providers/cart_controller.dart';
import '../../modules/providers/printer_settings.dart';
import '../../pos/providers/catalog_providers.dart';
import '../../sync/providers/sync_controller.dart';
/// UI state for the payment screen.
class PaymentState {
const PaymentState({
this.splits = const [],
this.activeMethod = PaymentMethod.cash,
this.cashTendered = 0,
this.reference = '',
this.isProcessing = false,
this.error,
this.result,
});
final List<PaymentSplit> splits;
final PaymentMethod activeMethod;
final double cashTendered;
final String reference;
final bool isProcessing;
final String? error;
final CheckoutResult? result;
double get settled =>
splits.fold(0.0, (sum, s) => sum + s.amount).asMoney;
bool get isComplete => result != null;
PaymentState copyWith({
List<PaymentSplit>? splits,
PaymentMethod? activeMethod,
double? cashTendered,
String? reference,
bool? isProcessing,
String? error,
bool clearError = false,
CheckoutResult? result,
bool clearResult = false,
}) {
return PaymentState(
splits: splits ?? this.splits,
activeMethod: activeMethod ?? this.activeMethod,
cashTendered: cashTendered ?? this.cashTendered,
reference: reference ?? this.reference,
isProcessing: isProcessing ?? this.isProcessing,
error: clearError ? null : (error ?? this.error),
result: clearResult ? null : (result ?? this.result),
);
}
}
class PaymentController extends StateNotifier<PaymentState> {
PaymentController(this._ref) : super(const PaymentState());
final Ref _ref;
double get _billTotal => _ref.read(cartControllerProvider).grandTotal;
/// Amount still outstanding after the tenders recorded so far.
double get balanceDue =>
(_billTotal - state.settled).clamp(0, double.infinity);
double get changeDue {
if (!state.activeMethod.needsChange) return 0;
final diff = state.cashTendered - balanceDue;
return diff > 0 ? diff.asMoney : 0;
}
/// Whether Complete Sale should be enabled.
///
/// Cash is the strict case: the drawer cannot be reconciled and no change can
/// be calculated unless the cashier states what was handed over. Card, UPI
/// and wallet settle on the external terminal, so they need no amount here.
bool get canConfirm {
if (_billTotal <= 0) return false;
// Staged splits already cover the bill.
if (balanceDue <= 0.01) return true;
if (state.activeMethod.needsChange) {
return state.cashTendered >= balanceDue;
}
return true;
}
/// Why the button is disabled, for display next to it.
String? get blockedReason {
if (_billTotal <= 0) return 'Add at least one item before charging.';
if (canConfirm) return null;
if (state.activeMethod.needsChange) {
return 'Enter the cash received, or tap Exact.';
}
return null;
}
void selectMethod(PaymentMethod method) {
state = state.copyWith(
activeMethod: method,
cashTendered: 0,
reference: '',
clearError: true,
);
}
void setCashTendered(double amount) =>
state = state.copyWith(cashTendered: amount, clearError: true);
/// Adds to the tendered amount — powers the quick-cash denomination chips.
void addCash(double amount) => setCashTendered(state.cashTendered + amount);
/// Fills the exact balance, the most common cash case.
void tenderExact() => setCashTendered(balanceDue);
void setReference(String value) =>
state = state.copyWith(reference: value, clearError: true);
/// Records the active tender. For a split payment, call this once per part.
void addSplit({double? amount}) {
final value = (amount ?? balanceDue).clamp(0, balanceDue).toDouble();
if (value <= 0) return;
final split = PaymentSplit(
method: state.activeMethod,
amount: value.asMoney,
tendered: state.activeMethod.needsChange
? (state.cashTendered > 0 ? state.cashTendered : value)
: null,
reference: state.reference.trim().isEmpty ? null : state.reference.trim(),
);
state = state.copyWith(
splits: [...state.splits, split],
cashTendered: 0,
reference: '',
clearError: true,
);
}
void removeSplit(int index) {
final next = [...state.splits]..removeAt(index);
state = state.copyWith(splits: next);
}
void clearSplits() => state = state.copyWith(splits: const []);
/// Finalises the sale. On success the caller navigates to the receipt.
Future<CheckoutResult?> confirm() async {
if (state.isProcessing) return null;
// A single-tender sale needn't be staged first — fold it in automatically.
// Remembered so it can be rolled back if the sale is rejected, otherwise a
// retry starts with a phantom tender already staged.
final stagedSplits = state.splits;
var splits = stagedSplits;
if (splits.isEmpty || balanceDue > 0.01) {
addSplit();
splits = state.splits;
}
state = state.copyWith(isProcessing: true, clearError: true);
try {
final cart = _ref.read(cartControllerProvider);
final session = _ref.read(cashierSessionProvider);
// The signed-in operator owns the bill. Falling back to the seed session
// stamped every sale with the same name, so a bill could not be traced to
// whoever actually rang it.
final user = _ref.read(currentUserProvider);
final result = await _ref.read(checkoutSaleProvider)(
cart: cart,
payments: splits,
cashierName: user?.name ?? session.name,
terminalId: session.terminalId,
);
state = state.copyWith(isProcessing: false, result: result);
// No auto-print: with no roll printer attached this silently failed and
// looked like a bug. The receipt screen shows the bill on the terminal
// and offers Print, WhatsApp and Share explicitly.
// Only for cash. A card-only sale that pops the drawer is a shrinkage
// risk, and it is what a shop notices first.
final printer = _ref.read(printerSettingsProvider);
final tookCash = splits.any((p) => p.method == PaymentMethod.cash);
if (printer.openDrawer && printer.hasDrawer && tookCash) {
unawaited(
_ref.read(receiptServiceProvider).openCashDrawer(
host: printer.drawerHost,
port: printer.drawerPort,
),
);
}
unawaited(_ref.read(soundServiceProvider).saleComplete());
// Stock changed, so the grid must refresh; the new order changes the
// unsynced tally and today's totals.
_ref.invalidate(allProductsProvider);
_ref.invalidate(visibleProductsProvider);
_ref.read(orderVersionProvider.notifier).state++;
// The bill is safely on disk; getting it to the back office is the
// engine's problem now. Deliberately not awaited — the cashier must
// reach the receipt screen at network speed of zero.
_ref.read(syncEngineProvider).nudge(SyncTrigger.saleCommitted);
return result;
} on CheckoutFailure catch (e) {
state = state.copyWith(
isProcessing: false,
error: e.message,
splits: stagedSplits,
);
return null;
} catch (e) {
state = state.copyWith(
isProcessing: false,
error: 'Could not complete the sale. $e',
splits: stagedSplits,
);
return null;
}
}
void reset() => state = const PaymentState();
}
final paymentControllerProvider =
StateNotifierProvider.autoDispose<PaymentController, PaymentState>(
(ref) => PaymentController(ref),
);