@exium/core 1.0.0-rc.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Exium Framework
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+# Exium
+
+Opinionated NestJS-based framework for building DDD, hexagonal, modular-monolith-first microservices.
+
+Exium is built primarily for Exium-based services. It is public so applications can install it from the npm registry, but it remains an opinionated platform framework rather than a generic NestJS replacement.
+
+Published package:
+
+```bash
+npm install @exium/core
+```
+
+CLI package:
+
+```bash
+npm install -g @exium/cli
+exium new order-management
+```
+
+Exium is designed as an internal platform framework. It intentionally ships with the infrastructure choices this codebase standardizes on:
+
+- NestJS runtime
+- Express HTTP adapter
+- MikroORM persistence
+- PostgreSQL and MongoDB persistence drivers
+- Kysely read-side query engine
+- RabbitMQ integration messaging
+- Redis cache and idempotency adapters
+
+## Layers
+
+```text
+src/foundation      Result and failure primitives
+src/domain          DDD building blocks
+src/application     CQRS, middleware, ports, read contracts
+src/infrastructure  Persistence, messaging, Redis, cache, idempotency adapters
+src/http            External/internal HTTP contracts, responses, filters, interceptors
+src/runtime         Outermost Nest runtime and Exium bootstrap
+```
+
+## HTTP Model
+
+HTTP endpoints can be marked as external or internal contracts.
+
+External APIs are the public contract exposed through a gateway:
+
+```ts
+@Controller('orders')
+@ExternalApi({ name: 'orders', owner: 'order-management' })
+export class OrderController {}
+```
+
+Internal APIs are module/service-to-module/service contracts. Internal calls can resolve locally in a modular monolith or remotely over HTTP after extraction:
+
+```ts
+@Controller('orders/internal')
+@InternalApi({ name: 'orders-internal', mode: 'auto' })
+export class InternalOrderController {}
+```
+
+## Application Model
+
+Commands and queries return `Result`.
+
+```ts
+@Transactional()
+export class CreateOrderCommand extends Command<string> {}
+
+@HandleCommand(CreateOrderCommand)
+export class CreateOrderCommandHandler extends CommandHandler<CreateOrderCommand> {
+  async handle(command: CreateOrderCommand): Promise<ResultType<string>> {
+    return Result.ok('order-id');
+  }
+}
+```
+
+Transactional commands commit only on `Result.ok(...)`. `Result.fail(...)` rolls back.
+
+## Exception vs Result
+
+Exium follows a strict policy:
+
+- **Thrown exceptions = unexpected failures.** Programmer errors, infrastructure
+  faults, broken invariants. The exception filter logs them and surfaces a
+  generic HTTP 500 — internal details never leak to clients.
+- **`Result.fail(Failure...)` = expected business failures.** Validation,
+  not-found, business rule violations, conflicts, authentication/authorization
+  denials. The response interceptor maps each `Failure.kind` to the appropriate
+  4xx status.
+
+```ts
+// Expected — return as Result
+async handle(command: CreateOrderCommand): Promise<ResultType<string>> {
+  if (await this.repo.exists(command.id)) {
+    return Result.fail(
+      Failure.conflict('ORDER_ALREADY_EXISTS', 'Order already exists.', {
+        orderId: command.id,
+      }),
+    );
+  }
+  return Result.ok(command.id);
+}
+
+// Unexpected — let it throw, filter turns it into 500
+if (!this.connection.isOpen) {
+  throw new Error('Database connection is closed.');
+}
+```
+
+`HttpException` is the only exception type that keeps its original status —
+preserved for compatibility with NestJS pipes (e.g. `ValidationPipe`).
+
+## Release Gate
+
+Start the test databases first:
+
+```bash
+npm run test:db:up
+```
+
+Run the v1 gate:
+
+```bash
+npm test
+```
+
+The root test gate includes domain, config, infrastructure, application, core, HTTP, e2e, CLI workspace, and example build checks.
+
+The CLI workspace smoke test also verifies that `exium new order-management --skip-install` creates a default `Order` aggregate project that typechecks. The CLI package is kept separate from `@exium/core`.
+
+## ADRs
+
+Architecture decisions live in [docs/adr](./docs/adr).
+
+Start with:
+
+- [ADR-0000: Expected Failures as Result](./docs/adr/adr-0000-expected-failures-as-result.md)
+- [ADR-0009: Application Middleware Pipeline and Priority](./docs/adr/adr-0009-application-middleware-pipeline-and-priority.md)
+- [ADR-0011: Unit of Work as Application Transaction Port](./docs/adr/adr-0011-unit-of-work-as-application-transaction-port.md)
+- [ADR-0017: HTTP Layer API Exposure and Internal Calls](./docs/adr/adr-0017-http-layer-api-exposure-and-internal-calls.md)