@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md

@@ -0,0 +1,116 @@
+---
+title: 'Abstract Class: JwtPayloadBase'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Abstract Class: JwtPayloadBase
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L8)
+
+Abstract base class for JWT payloads.
+Products extend this to add their own claims (e.g. `profileId`, `isPro`).
+Used as both a serialization contract and NestJS injection token.
+
+## Properties
+
+### email
+
+```ts
+readonly email: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L19)
+
+Email address.
+
+---
+
+### exp?
+
+```ts
+readonly optional exp?: number;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L34)
+
+Expiration timestamp (set by JWT library).
+
+---
+
+### iat?
+
+```ts
+readonly optional iat?: number;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L29)
+
+Issued-at timestamp (set by JWT library).
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L14)
+
+Subject identifier.
+
+---
+
+### roles
+
+```ts
+readonly roles: readonly string[];
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L24)
+
+Assigned roles.
+
+## Methods
+
+### fromJSON()
+
+```ts
+static fromJSON(raw): JwtPayloadBase;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L70)
+
+Creates an instance from a decoded JWT payload object.
+Subclasses **must** override this static-like factory on a per-product basis.
+
+#### Parameters
+
+| Parameter | Type                            | Description                  |
+| --------- | ------------------------------- | ---------------------------- |
+| `raw`     | `Record`\<`string`, `unknown`\> | The raw decoded JWT payload. |
+
+#### Returns
+
+`JwtPayloadBase`
+
+---
+
+### toJSON()
+
+```ts
+toJSON(): Record<string, unknown>;
+```
+
+Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L55)
+
+Serializes this payload to a plain object suitable for `JwtService.signAsync()`.
+
+#### Returns
+
+`Record`\<`string`, `unknown`\>

package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md

@@ -0,0 +1,76 @@
+---
+title: 'Class: LastActiveMiddleware'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: LastActiveMiddleware
+
+Defined in: [libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts#L16)
+
+Middleware to automatically update the lastActive timestamp for authenticated sessions.
+Extracts the JWT token from the Authorization header and updates the session asynchronously.
+
+## Implements
+
+- `NestMiddleware`
+
+## Constructors
+
+### Constructor
+
+```ts
+new LastActiveMiddleware(sessionService): LastActiveMiddleware;
+```
+
+Defined in: [libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts#L32)
+
+Constructs a new instance of the `LastActiveMiddleware` class.
+
+#### Parameters
+
+| Parameter        | Type                                     | Description              |
+| ---------------- | ---------------------------------------- | ------------------------ |
+| `sessionService` | [`SessionService`](Class.SessionService) | Session service instance |
+
+#### Returns
+
+`LastActiveMiddleware`
+
+## Methods
+
+### use()
+
+```ts
+use(
+   req,
+   _res,
+   next): void;
+```
+
+Defined in: [libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts#L49)
+
+Middleware execution method.
+Extracts token from Authorization header and updates lastActive timestamp asynchronously.
+
+#### Parameters
+
+| Parameter | Type           | Description                      |
+| --------- | -------------- | -------------------------------- |
+| `req`     | `Request`      | Express request object           |
+| `_res`    | `Response`     | Express response object (unused) |
+| `next`    | `NextFunction` | Next middleware function         |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+NestMiddleware.use;
+```

package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md

@@ -0,0 +1,45 @@
+---
+title: 'Class: LocalAuthGuard'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: LocalAuthGuard
+
+Defined in: [libs/platform-authentication/src/guards/LocalAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/LocalAuthGuard.ts#L14)
+
+The `LocalAuthGuard` protects routes using local authentication.
+
+## Extends
+
+- `IAuthGuard`
+
+## Constructors
+
+### Constructor
+
+```ts
+new LocalAuthGuard(...args): LocalAuthGuard;
+```
+
+Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+
+#### Parameters
+
+| Parameter | Type    |
+| --------- | ------- |
+| ...`args` | `any`[] |
+
+#### Returns
+
+`LocalAuthGuard`
+
+#### Inherited from
+
+```ts
+AuthGuard('local').constructor;
+```

package/data/packages/platform-authentication/api/Class.MfaService.md

@@ -0,0 +1,257 @@
+---
+title: 'Class: MfaService'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: MfaService
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L22)
+
+Orchestrates MFA channels, backup codes, and user preferences.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MfaService(
+   bcryptService,
+   mfaSubject,
+   encryptionService,
+   channels): MfaService;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L35)
+
+#### Parameters
+
+| Parameter           | Type                                     |
+| ------------------- | ---------------------------------------- |
+| `bcryptService`     | `BcryptService`                          |
+| `mfaSubject`        | [`MfaSubjectPort`](Class.MfaSubjectPort) |
+| `encryptionService` | `MfaEncryptionService`                   |
+| `channels`          | `IMfaChannel`[]                          |
+
+#### Returns
+
+`MfaService`
+
+## Accessors
+
+### registeredMethods
+
+#### Get Signature
+
+```ts
+get registeredMethods(): string[];
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:249](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L249)
+
+##### Returns
+
+`string`[]
+
+## Methods
+
+### disable()
+
+```ts
+disable(userId): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:237](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L237)
+
+Disables MFA for a user and clears channel secrets.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### getEnabledMethods()
+
+```ts
+getEnabledMethods(userId): Promise<{
+  methods: string[];
+  preferredMethod?: string;
+}>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L146)
+
+Returns enabled methods and preferred method for a user.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+
+#### Returns
+
+`Promise`\<\{
+`methods`: `string`[];
+`preferredMethod?`: `string`;
+\}\>
+
+---
+
+### initSetup()
+
+```ts
+initSetup(
+   userId,
+   method,
+context?): Promise<IMfaSetup>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L55)
+
+Initializes setup for a specific MFA method.
+
+#### Parameters
+
+| Parameter  | Type               |
+| ---------- | ------------------ |
+| `userId`   | `string`           |
+| `method`   | `string`           |
+| `context?` | `IMfaSetupContext` |
+
+#### Returns
+
+`Promise`\<[`IMfaSetup`](Interface.IMfaSetup)\>
+
+---
+
+### issueChallenges()
+
+```ts
+issueChallenges(userId, methods): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L183)
+
+Issues out-of-band challenge codes for login flows for applicable channels.
+
+#### Parameters
+
+| Parameter | Type                |
+| --------- | ------------------- |
+| `userId`  | `string`            |
+| `methods` | readonly `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### regenerateBackupCodes()
+
+```ts
+regenerateBackupCodes(userId): Promise<readonly string[]>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:219](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L219)
+
+Regenerates backup codes.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+
+#### Returns
+
+`Promise`\<readonly `string`[]\>
+
+---
+
+### setPreferredMethod()
+
+```ts
+setPreferredMethod(userId, method): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:199](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L199)
+
+Updates the preferred MFA method.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+| `method`  | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### verifyChallenge()
+
+```ts
+verifyChallenge(
+   userId,
+   method,
+code): Promise<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L103)
+
+Verifies a login challenge using the selected method or backup code.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+| `method`  | `string` |
+| `code`    | `string` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+---
+
+### verifySetup()
+
+```ts
+verifySetup(
+   userId,
+   method,
+code): Promise<IMfaConfirmation>;
+```
+
+Defined in: [libs/platform-authentication/src/services/MfaService.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L73)
+
+Verifies the initial code for a method and issues backup codes.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `userId`  | `string` |
+| `method`  | `string` |
+| `code`    | `string` |
+
+#### Returns
+
+`Promise`\<[`IMfaConfirmation`](Interface.IMfaConfirmation)\>

package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md

@@ -0,0 +1,75 @@
+---
+title: 'Abstract Class: MfaSubjectPort'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Abstract Class: MfaSubjectPort
+
+Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L14)
+
+Abstract port for reading and writing MFA state on the underlying subject entity.
+Used by the MfaService and all MFA channel implementations.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MfaSubjectPort(): MfaSubjectPort;
+```
+
+#### Returns
+
+`MfaSubjectPort`
+
+## Methods
+
+### findById()
+
+```ts
+abstract findById(id): Promise<IMfaSubject | null>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L24)
+
+Find an MFA subject by its unique identifier.
+
+#### Parameters
+
+| Parameter | Type     | Description             |
+| --------- | -------- | ----------------------- |
+| `id`      | `string` | The subject identifier. |
+
+#### Returns
+
+`Promise`\<[`IMfaSubject`](Interface.IMfaSubject) \| `null`\>
+
+The MFA subject or `null`.
+
+---
+
+### updateMfaState()
+
+```ts
+abstract updateMfaState(id, data): Promise<void>;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L33)
+
+Update MFA-related fields on the subject.
+
+#### Parameters
+
+| Parameter | Type                                               | Description                 |
+| --------- | -------------------------------------------------- | --------------------------- |
+| `id`      | `string`                                           | The subject identifier.     |
+| `data`    | [`IMfaSubjectUpdate`](Interface.IMfaSubjectUpdate) | The partial update payload. |
+
+#### Returns
+
+`Promise`\<`void`\>

package/data/packages/platform-authentication/api/Class.RolesGuard.md

@@ -0,0 +1,65 @@
+---
+title: 'Class: RolesGuard'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: RolesGuard
+
+Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.ts#L13)
+
+## Implements
+
+- `CanActivate`
+
+## Constructors
+
+### Constructor
+
+```ts
+new RolesGuard(reflector): RolesGuard;
+```
+
+Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.ts#L27)
+
+Constructs a new instance of the `RolesGuard` class.
+
+#### Parameters
+
+| Parameter   | Type        |
+| ----------- | ----------- |
+| `reflector` | `Reflector` |
+
+#### Returns
+
+`RolesGuard`
+
+## Methods
+
+### canActivate()
+
+```ts
+canActivate(context): boolean | Promise<boolean> | Observable<boolean>;
+```
+
+Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.ts#L38)
+
+#### Parameters
+
+| Parameter | Type               |
+| --------- | ------------------ |
+| `context` | `ExecutionContext` |
+
+#### Returns
+
+`boolean` \| `Promise`\<`boolean`\> \| `Observable`\<`boolean`\>
+
+#### Implementation of
+
+```ts
+CanActivate.canActivate;
+```

package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md

@@ -0,0 +1,65 @@
+---
+title: 'Class: SessionMappingProfile'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Class: SessionMappingProfile
+
+Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L39)
+
+Mapping profile for Session entity to response transformations.
+
+## Extends
+
+- `MappingProfileBase`
+
+## Constructors
+
+### Constructor
+
+```ts
+new SessionMappingProfile(): SessionMappingProfile;
+```
+
+#### Returns
+
+`SessionMappingProfile`
+
+#### Inherited from
+
+```ts
+MappingProfileBase.constructor;
+```
+
+## Methods
+
+### configure()
+
+```ts
+configure(builder): void;
+```
+
+Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L48)
+
+Configure mappings for Session entity.
+
+#### Parameters
+
+| Parameter | Type              | Description         |
+| --------- | ----------------- | ------------------- |
+| `builder` | `IMappingBuilder` | The mapping builder |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+```ts
+MappingProfileBase.configure;
+```