Ordering

A clean-architecture based ordering domain package for Dart. This package contains pure business logic for handling orders, independent of UI, frameworks, or infrastructure.

It is designed to be:

Framework-agnostic

Highly testable

Easy to integrate into any backend or Flutter app

Stable and reusable across projects

✨ Features

Pure domain models (Order, OrderItem, Money, TimeSlot, etc.)

Clear order lifecycle (created → confirmed → completed / cancelled)

Port-based design for external dependencies (Inventory, Pricing, Loyalty)

Strong validation and rule enforcement

60+ unit tests covering domain & service behavior

No runtime dependencies

🧠 Architecture Philosophy

This package follows Clean Architecture / Hexagonal Architecture principles.

Separation of concerns:

Domain → Business rules & entities

Ports → External contracts (interfaces)

Services → Use-case orchestration

No framework, database, or API logic is included here by design.

📁 Project Structure lib/ ├── domain/ │ ├── order.dart │ ├── order_item.dart │ ├── order_status.dart │ ├── money.dart │ ├── subscription.dart │ └── time_slot.dart │ ├── ports/ │ ├── inventory_port.dart │ ├── pricing_port.dart │ └── loyalty_port.dart │ ├── services/ │ ├── order_service.dart │ ├── order_repo.dart │ └── order_req.dart │ └── ordering.dart // Public entry point

Consumers should import only:

import 'package:ordering/ordering.dart';

🚀 Installation

Add the dependency:

dependencies: ordering: ^1.0.0

Then run:

dart pub get

🧩 Usage Example Implement required ports class InventoryAdapter implements InventoryPort { @override bool isAvailable(Order order) { return true; } }

class PricingAdapter implements PricingPort { @override Money calculatePrice(Order order) { return Money(500); } }

class LoyaltyAdapter implements LoyaltyPort { @override void reward(Order order) {} }

Create OrderService final orderService = OrderService( inventoryPort: InventoryAdapter(), pricingPort: PricingAdapter(), loyaltyPort: LoyaltyAdapter(), orderRepository: MyOrderRepository(), );

Use the service orderService.confirm(order); orderService.markDelivered(order);

Business rules are enforced automatically.

🧪 Testing

This package is heavily tested.

Run all tests:

dart test

Tests cover:

Domain invariants

Order lifecycle rules

Failure scenarios

Port interactions

🔒 Stability & Versioning

This package follows Semantic Versioning.

PATCH → Bug fixes

MINOR → Backward-compatible features

MAJOR → Breaking changes

Public APIs are intentionally minimal to keep them stable.

❌ What This Package Does NOT Do

No database access

No HTTP / API logic

No Flutter UI

No framework coupling

These belong in adapter layers, not in the domain.

📜 License

MIT License © 2026 Shivam Gupta

🧭 Intended Audience

This package is ideal for:

Backend systems

Flutter apps with serious business logic

Developers practicing Clean Architecture

Teams that want long-term maintainability