@breadstone/archipel-mcp 0.0.14 → 0.0.16

package/data/packages/platform-cryptography/index.md

@@ -0,0 +1,132 @@
+---
+title: platform-cryptography
+description: Bcrypt password hashing, prefixed UUID generation, and TOTP multi-factor authentication.
+order: 17
+tags: [cryptography, bcrypt, uuid, totp, otp, mfa, hashing]
+package: '@breadstone/archipel-platform-cryptography'
+---
+
+# platform-cryptography
+
+Cryptographic building blocks for NestJS applications: bcrypt password hashing, prefixed UUID generation, and TOTP-based multi-factor authentication. All services are `@Injectable()` and ready for constructor injection.
+
+**Package:** `@breadstone/archipel-platform-cryptography`
+
+## Quick Start
+
+```typescript
+import {
+  BcryptService,
+  CryptoService,
+  OtpService,
+  OTP_SERVICE_TOKEN,
+} from '@breadstone/archipel-platform-cryptography';
+```
+
+---
+
+## Password Hashing (BcryptService)
+
+Secure password hashing with auto-generated salts.
+
+```typescript
+import { Injectable } from '@nestjs/common';
+import { BcryptService } from '@breadstone/archipel-platform-cryptography';
+
+@Injectable()
+export class AccountService {
+  constructor(private readonly _bcrypt: BcryptService) {}
+
+  async createAccount(password: string): Promise<void> {
+    const hashed = await this._bcrypt.hash(password);
+    // store hashed password
+  }
+
+  async verifyPassword(password: string, hash: string): Promise<boolean> {
+    return this._bcrypt.compare(password, hash);
+  }
+}
+```
+
+| Method                     | Description                                   |
+| -------------------------- | --------------------------------------------- |
+| `hash(data)`               | Hashes a string with a generated bcrypt salt. |
+| `compare(data, encrypted)` | Compares plain text against a bcrypt hash.    |
+
+---
+
+## Prefixed UUIDs (CryptoService)
+
+Generates random UUIDs prefixed with a domain identifier for readable, collision-free identifiers.
+
+```typescript
+import { CryptoService } from '@breadstone/archipel-platform-cryptography';
+
+const crypto = new CryptoService();
+
+crypto.getRandomGuid('usr'); // → 'usr-a1b2c3d4-...'
+crypto.getRandomGuid('ord'); // → 'ord-e5f6a7b8-...'
+crypto.getRandomGuid('inv'); // → 'inv-c9d0e1f2-...'
+```
+
+| Method                  | Description                                           |
+| ----------------------- | ----------------------------------------------------- |
+| `getRandomGuid(prefix)` | Returns `{prefix}-{uuid}`. Throws if prefix is empty. |
+
+---
+
+## TOTP Multi-Factor Authentication (OtpService)
+
+TOTP enrollment and verification backed by otplib v13, injected via the `OTP_SERVICE_TOKEN` symbol.
+
+### Injection Setup
+
+```typescript
+import { Module } from '@nestjs/common';
+import { OtpService, OTP_SERVICE_TOKEN } from '@breadstone/archipel-platform-cryptography';
+
+@Module({
+  providers: [{ provide: OTP_SERVICE_TOKEN, useClass: OtpService }],
+  exports: [OTP_SERVICE_TOKEN],
+})
+export class SecurityModule {}
+```
+
+### Usage
+
+```typescript
+import { Inject, Injectable } from '@nestjs/common';
+import { OTP_SERVICE_TOKEN, IOtpService } from '@breadstone/archipel-platform-cryptography';
+
+@Injectable()
+export class MfaService {
+  constructor(@Inject(OTP_SERVICE_TOKEN) private readonly _otp: IOtpService) {}
+
+  enroll(issuer: string, label: string) {
+    const secret = this._otp.generateSecret();
+    const uri = this._otp.generateUri({ issuer, label, secret });
+    return { secret, uri }; // uri → QR code
+  }
+
+  verify(token: string, secret: string): boolean {
+    return this._otp.verify(token, secret);
+  }
+}
+```
+
+### Tolerance
+
+The default `TOTP_EPOCH_TOLERANCE` is 30 seconds (±1 time step):
+
+| `epochTolerance` | Accepted range    |
+| ---------------- | ----------------- |
+| 0                | Current step only |
+| 30               | ±1 step (±30 s)   |
+| 60               | ±2 steps (±60 s)  |
+| 90               | ±3 steps (±90 s)  |
+
+---
+
+## API Reference
+
+See the full [API documentation](./api/) for all exported types and classes.

package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md

@@ -0,0 +1,75 @@
+---
+title: 'Class: DatabaseHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: DatabaseHealthIndicator
+
+Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
+
+Health indicator for database connectivity.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new DatabaseHealthIndicator(prismaHealthIndicator, databaseService): DatabaseHealthIndicator;
+```
+
+Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L26)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `prismaHealthIndicator` | `PrismaHealthIndicator` |
+| `databaseService` | [`DatabaseService`](Class.DatabaseService) |
+
+#### Returns
+
+`DatabaseHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: "database" = 'database';
+```
+
+Defined in: [terminus/DatabaseHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L35)
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): Promise<HealthIndicatorResult<"database">>;
+```
+
+Defined in: [terminus/DatabaseHealthIndicator.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L41)
+
+Performs the health check and returns a result keyed by the indicator key
+
+#### Returns
+
+`Promise`\<`HealthIndicatorResult`\<`"database"`\>\>
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check
+```

package/data/packages/platform-database/api/Class.DatabaseModule.md

@@ -0,0 +1,68 @@
+---
+title: 'Class: DatabaseModule'
+generated: true
+editUrl: false
+---
+# Class: DatabaseModule
+
+Defined in: [DatabaseModule.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L66)
+
+## Constructors
+
+### Constructor
+
+```ts
+new DatabaseModule(): DatabaseModule;
+```
+
+#### Returns
+
+`DatabaseModule`
+
+## Methods
+
+### forRoot()
+
+```ts
+static forRoot(config?): DynamicModule;
+```
+
+Defined in: [DatabaseModule.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L75)
+
+Registers the `DatabaseModule` with global middlewares.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
+
+#### Returns
+
+`DynamicModule`
+
+A `DynamicModule` that can be imported globally
+
+***
+
+### register()
+
+```ts
+static register(config?): DynamicModule;
+```
+
+Defined in: [DatabaseModule.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L95)
+
+Registers the `DatabaseModule` with dynamic middlewares.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `config?` | [`IDatabaseModuleConfig`](Interface.IDatabaseModuleConfig) | The database module configuration |
+
+#### Returns
+
+`DynamicModule`
+
+A `DynamicModule` that can be imported with middlewares

package/data/packages/platform-database/api/Class.DatabaseService.md

@@ -0,0 +1,143 @@
+---
+title: 'Class: DatabaseService'
+generated: true
+editUrl: false
+---
+# Class: DatabaseService
+
+Defined in: [services/DatabaseService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L16)
+
+Represents the database service.
+
+## Extends
+
+- [`PrismaService`](Class.PrismaService)
+
+## Indexable
+
+```ts
+[key: string]: any
+```
+
+## Constructors
+
+### Constructor
+
+```ts
+new DatabaseService(configService, options?): DatabaseService;
+```
+
+Defined in: [services/DatabaseService.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L24)
+
+Constructs a new instance of the `DatabaseService` class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+| `options?` | [`IPrismaServiceOptions`](Interface.IPrismaServiceOptions) |
+
+#### Returns
+
+`DatabaseService`
+
+#### Overrides
+
+[`PrismaService`](Class.PrismaService).[`constructor`](Class.PrismaService#constructor)
+
+## Methods
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [services/PrismaService.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L69)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`PrismaService`](Class.PrismaService).[`onModuleDestroy`](Class.PrismaService#onmoduledestroy)
+
+***
+
+### onModuleInit()
+
+```ts
+onModuleInit(): Promise<void>;
+```
+
+Defined in: [services/PrismaService.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L58)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`PrismaService`](Class.PrismaService).[`onModuleInit`](Class.PrismaService#onmoduleinit)
+
+***
+
+### transaction()
+
+```ts
+transaction<P>(arg, options?): any;
+```
+
+Defined in: [services/DatabaseService.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L40)
+
+Creates a new transaction.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `P` *extends* `PrismaPromise`\<`unknown`\>[] |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `arg` | \[`...P[]`\] | The argument. |
+| `options?` | `unknown` | The options. |
+
+#### Returns
+
+`any`
+
+Returns the result of the transaction.
+
+***
+
+### transactionCallback()
+
+```ts
+transactionCallback<T>(fn, options?): Promise<T>;
+```
+
+Defined in: [services/DatabaseService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L55)
+
+Executes a transactional callback (extended overload missing in base typing wrapper).
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `fn` | (`tx`) => `Promise`\<`T`\> |
+| `options?` | `unknown` |
+
+#### Returns
+
+`Promise`\<`T`\>

package/data/packages/platform-database/api/Class.PrismaService.md

@@ -0,0 +1,98 @@
+---
+title: 'Class: PrismaService'
+generated: true
+editUrl: false
+---
+# Class: PrismaService
+
+Defined in: [services/PrismaService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L29)
+
+Represents the prisma service.
+
+## Extends
+
+- `PrismaClient`
+
+## Extended by
+
+- [`DatabaseService`](Class.DatabaseService)
+
+## Implements
+
+- `OnModuleInit`
+- `OnModuleDestroy`
+
+## Indexable
+
+```ts
+[key: string]: any
+```
+
+## Constructors
+
+### Constructor
+
+```ts
+new PrismaService(configService, options?): PrismaService;
+```
+
+Defined in: [services/PrismaService.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L43)
+
+Constructs a new instance of the `PrismaService` class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `configService` | `ConfigService` |
+| `options?` | [`IPrismaServiceOptions`](Interface.IPrismaServiceOptions) |
+
+#### Returns
+
+`PrismaService`
+
+#### Overrides
+
+```ts
+PrismaClient.constructor
+```
+
+## Methods
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [services/PrismaService.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L69)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```
+
+***
+
+### onModuleInit()
+
+```ts
+onModuleInit(): Promise<void>;
+```
+
+Defined in: [services/PrismaService.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L58)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit
+```