@angular-architects/ddd
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.0 • Public • Published

    @angular-architects/ddd -- DDD Plugin for Nx

    This plugin installs some schematics which automate slicing your Nx workspace into domains and layers according to Nrwl's best practices and our ideas about client-side DDD with Angular:

    domains and layers

    The generated access restrictions prevent unwanted access between libraries respecting layers and domains:

    access restrictions

    Features

    • 🗺️ Generating domains with domain libraries including a facades, models, and data services
    • ⚙️ Generating feature libraries including a feature components using the facades
    • 🙅‍♂️ Adding linting rules for access restrictions between domains as proposed by Nrwl
    • 🙅‍♀️ Adding linting rules for access restrictions between layers as proposed by Nrwl (supports tslint and eslint)
    • 🔥 Optionally generates skeleton for NGRX and integrates it into the DDD design (--ngrx switch)

    Features Overview Video

    Screenshot of Overview Video

    Usage

    Add this plugin to an Nx workspace:

    ng add @angular-architects/ddd
    

    Add domains and features manually:

    ng g @angular-architects/ddd:domain booking --addApp
    ng g @angular-architects/ddd:domain boarding --addApp
    ng g @angular-architects/ddd:feature search --domain booking --entity flight
    ng g @angular-architects/ddd:feature cancel --domain booking
    ng g @angular-architects/ddd:feature manage --domain boarding
    

    For NGRX support, just add the --ngrx switch:

    ng g @angular-architects/ddd:domain luggage --addApp --ngrx
    ng g @angular-architects/ddd:feature checkin --domain luggage --entity luggage-list --ngrx
    [...]
    

    This example assumes that you have an app flight-app in place.

    These schematics also wire up the individual libs. To see the result, create a dependency graph:

    npm run dep-graph
    

    dependency graph

    To see that the skeleton works end-to-end, call the generated feature component in your app.component.html:

    <booking-search></booking-search>

    You don't need any TypeScript or Angular imports. The plugin already took care about that. After running the example, you should see something like this:

    Result proving that the generated skeleton works end-to-end

    Generated Structure

    The included schematics generate a folder for each domain. This folder contains feature libs as well as a library with the domain logic:

    Folder per Domain

    The domain layer is subdivided into three parts:

    Structured Domain Layer

    Generated Structure for Domain Library

    • application: Contains application services. This is a DDD term for what we call facades in Angular nowadays. They orchestrate everything for a use case given so that a feature component only needs to communicate with one such facade. Also, it hides details for state management. While the generates facades just use a BehaviorSubject, feel free to add a library like NGRX underneath. As such a modifications changes nothing from the component's perspective, you can use facades to introduce NGRX later on demand.
    • entities: Client-side data model including logic operating on it (like validations).
    • infrastructure: Services for communicating with the backend.

    Consider Automatically Checking Access Restrictions

    As the access restrictions defined with Nx use linting, you can check against them at the command line too. Hence, you might consider including this into your automated build process.

    Access restrictions via linting

    Example Application

    see https://github.com/angular-architects/ddd-demo

    Credits

    More

    Keywords

    none

    Install

    npm i @angular-architects/ddd

    DownloadsWeekly Downloads

    1,689

    Version

    1.4.0

    License

    MIT

    Unpacked Size

    432 kB

    Total Files

    159

    Last publish

    Collaborators

    • manfred.steyer