mirror of
https://github.com/Tria-plc/edr-platform.git
synced 2026-08-27 22:30:55 +00:00
60 lines
1.3 KiB
Markdown
60 lines
1.3 KiB
Markdown
# @tria-plc/iamapi-common
|
|
|
|
Standalone IAM NestJS module extracted from the Smart Office monorepo. Provides authentication, user management, organization structure, and record elements functionality as a reusable package for Tria PLC platform services.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install @tria-plc/iamapi-common --registry=https://npm.pkg.github.com
|
|
```
|
|
|
|
Or with a project-level `.npmrc`:
|
|
|
|
```
|
|
@tria-plc:registry=https://npm.pkg.github.com
|
|
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
|
|
```
|
|
## Usage
|
|
|
|
```typescript
|
|
import { IamModule } from '@tria-plc/iamapi-common';
|
|
|
|
@Module({
|
|
imports: [IamModule],
|
|
})
|
|
export class AppModule {}
|
|
```
|
|
|
|
The `IamModule` registers all sub-modules: `AuthModule`, `UserModule`, `OrganizationStructureModule`, and `RecordElementModule`.
|
|
|
|
Database configuration, migrations, and seeding remain the responsibility of the consuming application.
|
|
|
|
## Peer Dependencies
|
|
|
|
- `@nestjs/common` ^11
|
|
- `@nestjs/core` ^11
|
|
- `@nestjs/jwt` ^11
|
|
- `@nestjs/passport` ^11
|
|
- `@nestjs/typeorm` ^11
|
|
- `@smart-office/be` ^1.0.0
|
|
- `reflect-metadata` ^0.2
|
|
- `rxjs` ^7.8
|
|
- `typeorm` ^0.3
|
|
|
|
## Publishing
|
|
|
|
Releases are published automatically to GitHub Packages when a version tag (`v*`) is pushed:
|
|
|
|
```bash
|
|
git tag v1.0.1
|
|
git push origin v1.0.1
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
pnpm install
|
|
pnpm build
|
|
```
|
|
|