feat!: move message interfaces into the toolkit

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+### Changed
+
+- **BREAKING** Moved the `Message`, `Command`, `Query`, and `IntegrationEvent` interfaces to the `Toolkit\Messages`
+  namespace. This is to make it clearer that these are part of the toolkit, not the application or infrastructure
+  layers. It matches the `Result` and `Error` interfaces that are already in the `Toolkit\Result` namespace. I.e.
+  now the toolkit contains both the input and output interfaces.
+
 ## [2.0.0] - 2024-12-07
 
 ### Changed

docs/guide/application/commands.md

@@ -18,8 +18,8 @@ For example:
 ```php
 namespace App\Modules\EventManagement\Application\UseCases\Commands\CancelAttendeeTicket;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use VendorName\EventManagement\Shared\Enums\CancellationReasonEnum;
 
 final readonly class CancelAttendeeTicketCommand implements Command
@@ -353,8 +353,7 @@ class CancellationController extends Controller
 ```
 
 To allow commands to be queued, you **must** provide a queue factory to the command bus when creating it. This topic is
-covered in the [Asynchronous Processing](../infrastructure/queues#external-queuing) chapter, with specific examples
-in the _External Queuing_ section.
+covered in the [Queues chapter](../infrastructure/queues.md#queue-port).
 
 ## Middleware
 
@@ -541,9 +540,9 @@ that has sensitive customer data on it that you do not want to end up in your lo
 implement the `ContextProvider` interface on your command message:
 
 ```php
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
 use CloudCreativity\Modules\Contracts\Toolkit\Loggable\ContextProvider;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 
 final readonly class CancelAttendeeTicketCommand implements
   Command,
@@ -575,7 +574,7 @@ namespace App\Modules\EventManagement\Application\Bus\Middleware;
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class MyMiddleware implements CommandMiddleware
@@ -617,8 +616,8 @@ namespace App\Modules\EventManagement\Application\Bus\Middleware;
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\BusMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 class MyBusMiddleware implements BusMiddleware

docs/guide/application/integration-events.md

@@ -36,8 +36,8 @@ For example:
 ```php
 namespace VendorName\EventManagement\Shared\IntegrationEvents\V1;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Toolkit\Identifiers\Uuid;
 use VendorName\EventManagement\Shared\Enums\CancellationReasonEnum;
 
@@ -97,7 +97,7 @@ This can be expressed via an interface. To illustrate the point, a JSON serializ
 ```php
 namespace VendorName\Ordering\Shared\IntegrationEvents\V1\Serializers;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 interface JsonSerializer
 {
@@ -540,7 +540,7 @@ Here is an example controller from a Laravel application to demonstrate the patt
 namespace App\Http\Controllers\Api\PubSub;
 
 use App\Modules\EventManagement\Application\Ports\Driving\InboundEventBus;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use VendorName\Ordering\Shared\IntegrationEvents\V1\Serializers\JsonSerializer;
 
 class InboundEventController extends Controller
@@ -648,7 +648,7 @@ example:
 ```php
 namespace App\Modules\EventManagement\Application\Ports\Driving;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 interface Inbox
 {
@@ -663,7 +663,7 @@ might look like this:
 ```php
 namespace App\Modules\EventManagement\Application\Ports\Driven\Inbox;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 interface InboxRepository
 {
@@ -683,7 +683,7 @@ This means we can now update the previous controller example to use the inbox in
 namespace App\Http\Controllers\Api\PubSub;
 
 use App\Modules\EventManagement\Application\Ports\Driving\InboundEvents\Inbox;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use VendorName\Ordering\Shared\IntegrationEvents\V1\Serializers\JsonSerializer;
 
 class InboundEventController extends Controller
@@ -890,7 +890,7 @@ namespace App\Modules\EventManagement\Application\Bus\Middleware;
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\InboundEventBus\InboundEventMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 final class MyMiddleware implements InboundEventMiddleware
 {

docs/guide/application/queries.md

@@ -18,8 +18,8 @@ For example:
 ```php
 namespace App\Modules\EventManagement\Application\UseCases\Queries\GetAttendeeTickets;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Identifiers\Identifier;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 
 final readonly class GetAttendeeTicketsQuery implements Query
 {
@@ -401,7 +401,7 @@ namespace App\Modules\EventManagement\Application\Bus\Middleware;
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\QueryMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class MyMiddleware implements QueryMiddleware
@@ -443,8 +443,8 @@ namespace App\Modules\EventManagement\Application\Bus\Middleware;
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\BusMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 class MyBusMiddleware implements BusMiddleware

docs/guide/infrastructure/outbox.md

@@ -62,7 +62,7 @@ Our recommended approach is to first place these events into an outbox. This mea
 ```php
 namespace App\Modules\EventManagement\Application\Ports\Driven\OutboundEvents;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 interface Outbox
 {

docs/guide/infrastructure/publishing-events.md

@@ -64,7 +64,7 @@ namespace App\Modules\EventManagement\Infrastructure\OutboundEventBus;
 use App\Modules\EventManagement\Application\Ports\Driven\OutboundEventBus\OutboundEventBus;
 use App\Modules\EventManagement\Infrastructure\GooglePubSub\EventSerializer;
 use App\Modules\EventManagement\Infrastructure\GooglePubSub\SecureTopicFactory;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Infrastructure\OutboundEventBus\Middleware\LogOutboundEvent;
 use CloudCreativity\Modules\Toolkit\Pipeline\PipeContainer;
 use Psr\Log\LoggerInterface;
@@ -262,7 +262,7 @@ implement the following interface that was extended by the driven port:
 ```php
 namespace CloudCreativity\Modules\Application\Ports\Driven\OutboundEventBus;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 interface EventPublisher
 {
@@ -321,8 +321,8 @@ following signature:
 namespace App\Modules\EventManagement\Application\Adapters\Middleware;
 
 use Closure;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Contracts\Infrastructure\OutboundEventBus\OutboundEventMiddleware;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 final class MyMiddleware implements OutboundEventMiddleware
 {

docs/guide/infrastructure/queues.md

@@ -97,7 +97,7 @@ Then you can create the adapter by providing it with the default closure for que
 namespace App\Modules\EventManagement\Infrastructure\Queue;
 
 use App\Modules\EventManagement\Application\Ports\Driven\Queue\Queue;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Infrastructure\Queue\Middleware\LogPushedToQueue;
 use CloudCreativity\Modules\Toolkit\Pipeline\PipeContainer;
 
@@ -237,7 +237,7 @@ example:
 ```php
 namespace App\Modules\EventManagement\Infrastructure\Queue;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 
 final class DefaultEnqueuer
 {
@@ -264,7 +264,7 @@ implements the port interface that is extended in your application layer:
 ```php
 namespace CloudCreativity\Modules\Application\Ports\Driven\Queue;
 
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 
 interface Queue
 {
@@ -300,7 +300,7 @@ For example, a default Laravel job for queuing and dispatching commands would be
 namespace App\Modules\EventManagement\Infrastructure\Queue;
 
 use App\Modules\EventManagement\Application\Ports\Driving\CommandBus;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Toolkit\Result\FailedResultException;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
@@ -481,8 +481,8 @@ following signature:
 namespace App\Modules\Shared\Infrastructure\Queue\Middleware;
 
 use Closure;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Infrastructure\Queue\QueueMiddleware;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 
 final class MyQueueMiddleware implements QueueMiddleware
 {

src/Application/Bus/CommandDispatcher.php

@@ -14,9 +14,9 @@
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandHandlerContainer;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Application\Ports\Driven\Queue;
 use CloudCreativity\Modules\Contracts\Application\Ports\Driving\CommandDispatcher as ICommandDispatcher;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Pipeline\PipeContainer;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 use CloudCreativity\Modules\Toolkit\Pipeline\MiddlewareProcessor;

src/Application/Bus/CommandHandler.php

@@ -13,8 +13,8 @@
 namespace CloudCreativity\Modules\Application\Bus;
 
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandHandler as ICommandHandler;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Application\Messages\DispatchThroughMiddleware;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class CommandHandler implements ICommandHandler

src/Application/Bus/Middleware/ExecuteInUnitOfWork.php

@@ -15,8 +15,8 @@
 use Closure;
 use CloudCreativity\Modules\Application\Bus\Exceptions\AbortOnFailureException;
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
 use CloudCreativity\Modules\Contracts\Application\UnitOfWork\UnitOfWorkManager;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class ExecuteInUnitOfWork implements CommandMiddleware

src/Application/Bus/Middleware/FlushDeferredEvents.php

@@ -15,7 +15,7 @@
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandMiddleware;
 use CloudCreativity\Modules\Contracts\Application\DomainEventDispatching\DeferredDispatcher;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 use Throwable;
 

src/Application/Bus/Middleware/LogMessageDispatch.php

@@ -14,8 +14,8 @@
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\BusMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 use CloudCreativity\Modules\Toolkit\Loggable\ObjectContext;
 use CloudCreativity\Modules\Toolkit\Loggable\ResultContext;

src/Application/Bus/Middleware/SetupBeforeDispatch.php

@@ -14,8 +14,8 @@
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\BusMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class SetupBeforeDispatch implements BusMiddleware

src/Application/Bus/Middleware/TearDownAfterDispatch.php

@@ -14,8 +14,8 @@
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\BusMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class TearDownAfterDispatch implements BusMiddleware

src/Application/Bus/Middleware/ValidateCommand.php

@@ -15,7 +15,7 @@
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\CommandMiddleware;
 use CloudCreativity\Modules\Contracts\Application\Bus\Validator;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result as IResult;
 use CloudCreativity\Modules\Toolkit\Result\Result;
 

src/Application/Bus/Middleware/ValidateQuery.php

@@ -15,7 +15,7 @@
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\Bus\QueryMiddleware;
 use CloudCreativity\Modules\Contracts\Application\Bus\Validator;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result as IResult;
 use CloudCreativity\Modules\Toolkit\Result\Result;
 

src/Application/Bus/QueryDispatcher.php

@@ -13,8 +13,8 @@
 namespace CloudCreativity\Modules\Application\Bus;
 
 use CloudCreativity\Modules\Contracts\Application\Bus\QueryHandlerContainer;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
 use CloudCreativity\Modules\Contracts\Application\Ports\Driving\QueryDispatcher as IQueryDispatcher;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Pipeline\PipeContainer;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 use CloudCreativity\Modules\Toolkit\Pipeline\MiddlewareProcessor;

src/Application/Bus/QueryHandler.php

@@ -14,7 +14,7 @@
 
 use CloudCreativity\Modules\Contracts\Application\Bus\QueryHandler as IQueryHandler;
 use CloudCreativity\Modules\Contracts\Application\Messages\DispatchThroughMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\Result;
 
 final class QueryHandler implements IQueryHandler

src/Application/Bus/Validator.php

@@ -13,8 +13,8 @@
 namespace CloudCreativity\Modules\Application\Bus;
 
 use CloudCreativity\Modules\Contracts\Application\Bus\Validator as IValidator;
-use CloudCreativity\Modules\Contracts\Application\Messages\Command;
-use CloudCreativity\Modules\Contracts\Application\Messages\Query;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Command;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\Query;
 use CloudCreativity\Modules\Contracts\Toolkit\Pipeline\PipeContainer;
 use CloudCreativity\Modules\Contracts\Toolkit\Pipeline\Pipeline;
 use CloudCreativity\Modules\Contracts\Toolkit\Result\ListOfErrors as IListOfErrors;

src/Application/InboundEventBus/EventHandler.php

@@ -14,7 +14,7 @@
 
 use CloudCreativity\Modules\Contracts\Application\InboundEventBus\EventHandler as IEventHandler;
 use CloudCreativity\Modules\Contracts\Application\Messages\DispatchThroughMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 
 final class EventHandler implements IEventHandler
 {

src/Application/InboundEventBus/EventHandlerContainer.php

@@ -14,7 +14,7 @@
 
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\InboundEventBus\EventHandlerContainer as IEventHandlerContainer;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use RuntimeException;
 
 final class EventHandlerContainer implements IEventHandlerContainer

src/Application/InboundEventBus/InboundEventDispatcher.php

@@ -13,8 +13,8 @@
 namespace CloudCreativity\Modules\Application\InboundEventBus;
 
 use CloudCreativity\Modules\Contracts\Application\InboundEventBus\EventHandlerContainer;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Contracts\Application\Ports\Driving\InboundEventDispatcher as IInboundEventDispatcher;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use CloudCreativity\Modules\Contracts\Toolkit\Pipeline\PipeContainer;
 use CloudCreativity\Modules\Toolkit\Pipeline\MiddlewareProcessor;
 use CloudCreativity\Modules\Toolkit\Pipeline\PipelineBuilder;

src/Application/InboundEventBus/Middleware/FlushDeferredEvents.php

@@ -15,7 +15,7 @@
 use Closure;
 use CloudCreativity\Modules\Contracts\Application\DomainEventDispatching\DeferredDispatcher;
 use CloudCreativity\Modules\Contracts\Application\InboundEventBus\InboundEventMiddleware;
-use CloudCreativity\Modules\Contracts\Application\Messages\IntegrationEvent;
+use CloudCreativity\Modules\Contracts\Toolkit\Messages\IntegrationEvent;
 use Throwable;
 
 final class FlushDeferredEvents implements InboundEventMiddleware