riviere-extract-conventions

Decorators for marking architectural components in TypeScript code.

Installation

npm install @living-architecture/riviere-extract-conventions

Usage

import {
  APIContainer,
  APIEndpoint,
  UseCase,
  Event,
  DomainOp,
  Ignore,
} from '@living-architecture/riviere-extract-conventions'

// Container decorator - all public methods are API endpoints
@APIContainer
class OrderController {
  @APIEndpoint
  getOrders(): Order[] { /* ... */ }

  @Ignore
  healthCheck(): boolean { return true }
}

// Class-as-component
@UseCase
class CreateOrderUseCase {
  execute(command: CreateOrderCommand): Order { /* ... */ }
}

@Event
class OrderCreated {
  constructor(readonly orderId: string) {}
}

Decorators

| Decorator | Target | Description | |-----------|--------|-------------| | @DomainOpContainer | Class | All public methods are domain operations | | @APIContainer | Class | All public methods are API endpoints | | @EventHandlerContainer | Class | All public methods are event handlers | | @UseCase | Class | Class is a use case | | @Event | Class | Class is a domain event | | @UI | Class | Class is a UI component | | @DomainOp | Method | Method is a domain operation | | @APIEndpoint | Method | Method is an API endpoint | | @EventHandler | Method | Method is an event handler | | @Custom(type) | Class/Method | Custom component type | | @Ignore | Class/Method | Exclude from analysis |

Building

nx build riviere-extract-conventions

Documentation

• CLAUDE.md - Package principles and design decisions