Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions PACKAGE_GENERATOR.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ established structure and configuration standards.
### Option 1: Using npm script (Recommended)

```bash
pnpm generate:package <package-name> [description]
pnpm g:pkg <package-name> [description]
```

### Option 2: Using Node.js directly
Expand All @@ -28,19 +28,19 @@ node scripts/generate-package.mjs <package-name> [description]
### Create a basic package

```bash
pnpm generate:package validation
pnpm g:pkg validation
```

### Create a package with description

```bash
pnpm generate:package validation "Input validation utilities"
pnpm g:pkg validation "Input validation utilities"
```

### Create a more complex package

```bash
pnpm generate:package cache-manager "Redis and in-memory cache management"
pnpm g:pkg cache-manager "Redis and in-memory cache management"
```

## What Gets Generated
Expand Down
46 changes: 29 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,21 +107,20 @@ For in-depth guidance, examples, and best practices, see the
Objects, Entities, Aggregates, Events
- 🔧 [Complete API Reference](./packages/ddd/README.md#api-reference) - All
classes, interfaces, and methods
- 💡 [Real-World Examples](./packages/ddd/README.md#examples) - Full order
management system implementation
- ✅ [Best Practices](./packages/ddd/README.md#best-practices) - FAANG-level
patterns and principles
- 🚨 [Error Handling](./packages/ddd/README.md#error-handling) - Proper error
management strategies
- 💡 [Examples](./packages/ddd/README.md#examples) - Order aggregate and
integration patterns
- ✅ [Best Practices](./packages/ddd/README.md#best-practices) - DDD patterns
and principles
- 🚨 [Error Handling](./packages/ddd/README.md#error-handling) - Registry-backed
domain errors and Result
- 🤝 [Contributing Guide](./packages/ddd/README.md#contributing) - Development
setup and guidelines

#### Included Value Objects

- `AggregateId` - Unique identifier for aggregates
- `Email` - Email address validation
- `IPAddress` - IPv4/IPv6 validation
- `URL` - Web URL validation
- `UserAgent` - User agent string parsing

---

Expand Down Expand Up @@ -254,11 +253,14 @@ multiple authentication methods.

- **Domain-Driven Design** - Built on `@rineex/ddd` for maintainable
authentication logic
- **Extensible Architecture** - Support for OTP, passwordless, and social login
methods
- **Extensible Architecture** - OTP and passwordless method packages;
`AuthMethodPort` plugin model
- **Type-Safe** - Full TypeScript support with strict typing
- **Framework Agnostic** - Core domain logic independent of framework specifics

See [Architecture.md](./packages/authentication/core/Architecture.md) for what
is implemented vs in-tree.

For complete documentation, see the
[@rineex/auth-core README](./packages/authentication/core/README.md).

Expand Down Expand Up @@ -354,11 +356,8 @@ TypeScript compiler settings.
│ ├── pg-slonik/ # PostgreSQL adapter using Slonik
│ ├── libs/ # Utility libraries
│ ├── authentication/ # Authentication packages
│ │ ├── core/ # Core authentication abstractions
│ │ ├── methods/ # Authentication methods (OTP, passwordless)
│ │ ├── adapters/ # Framework adapters
│ │ ├── orchestration/ # Authentication orchestration
│ │ └── policies/ # Authentication policies
│ │ ├── core/ # @rineex/auth-core
│ │ └── methods/ # OTP, passwordless method packages
│ ├── nest/ # NestJS middleware modules
│ │ ├── helmet-middleware-module/
│ │ ├── cors-middleware-module/
Expand All @@ -377,8 +376,8 @@ TypeScript compiler settings.

### Prerequisites

- **Node.js**: 18.0 or higher
- **pnpm**: 8.0 or higher (npm/yarn supported but not recommended)
- **Node.js**: 18.0 or higher (Volta pins Node 24 in this repo)
- **pnpm**: 10.0 or higher (workspace uses pnpm 10.22)
- **TypeScript**: 5.9 or higher

### Getting Started
Expand Down Expand Up @@ -489,6 +488,19 @@ pnpm g:pkg <package-name> [description]

For more details, see [PACKAGE_GENERATOR.md](./PACKAGE_GENERATOR.md).

## Documentation Map

| Package / area | Primary docs |
| ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Monorepo | [README.md](./README.md), [PACKAGE_GENERATOR.md](./PACKAGE_GENERATOR.md) |
| `@rineex/ddd` | [packages/ddd/README.md](./packages/ddd/README.md) |
| `@rineex/auth-core` | [packages/authentication/core/README.md](./packages/authentication/core/README.md), [Architecture.md](./packages/authentication/core/Architecture.md) |
| Auth methods | [passwordless README](./packages/authentication/methods/passwordless/README.md), [OTP README](./packages/authentication/methods/otp/README.md) |
| `@rineex/pg-slonik` | [README](./packages/pg-slonik/README.md), [API](./packages/pg-slonik/docs/API.md) |
| `@rineex/ioredis` | [README](./packages/ioredis/README.md) |
| Nest middleware | `packages/nest/*/README.md` |
| Domain sub-docs | [auth errors](./packages/authentication/core/src/domain/errors/README.md), [auth VOs](./packages/authentication/core/src/domain/value-objects/README.md) |

## License

This project is licensed under the Apache License 2.0 - see the
Expand Down
Loading
Loading