@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,11 +3,6 @@ title: 'Class: AnonymousAuthGuard'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: AnonymousAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/AnonymousAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/AnonymousAuthGuard.ts#L14)
@@ -26,12 +21,12 @@ The `AnonymousAuthGuard` protects routes using anonymous authentication.
 new AnonymousAuthGuard(...args): AnonymousAuthGuard;
 ```
 
-Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 
 #### Parameters
 
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 
 #### Returns
@@ -41,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('anonymous').constructor;
+AuthGuard('anonymous').constructor
 ```

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

@@ -0,0 +1,80 @@
+---
+title: 'Class: AppleStrategy'
+generated: true
+editUrl: false
+---
+# Class: AppleStrategy
+
+Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L21)
+
+The `AppleStrategy` integrates Apple Sign In authentication.
+
+## Extends
+
+- `AppleStrategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new AppleStrategy(socialAuth, configService): AppleStrategy;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L37)
+
+Initializes a new instance of the `AppleStrategy` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
+
+#### Returns
+
+`AppleStrategy`
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'apple').constructor
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(
+   accessToken, 
+   refreshToken, 
+   idToken, 
+profile): Promise<IAuthSubject>;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L68)
+
+Validates the Apple authentication payload.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `accessToken` | `string` | OAuth access token. |
+| `refreshToken` | `string` | OAuth refresh token. |
+| `idToken` | `string` | Apple identity token. |
+| `profile` | `IAppleProfile` | Apple profile data. |
+
+#### Returns
+
+`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
+
+The authenticated user.
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'apple').validate
+```

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

@@ -3,14 +3,9 @@ title: 'Class: AuthModule'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: AuthModule
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L104)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L116)
 
 The `AuthModule` handles JWT-based authentication,
 including token creation and validation.
@@ -35,19 +30,19 @@ new AuthModule(): AuthModule;
 configure(consumer): void;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:208](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L208)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:225](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L225)
 
 #### Parameters
 
-| Parameter  | Type                 |
-| ---------- | -------------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `consumer` | `MiddlewareConsumer` |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### register()
 
@@ -55,14 +50,14 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:208](https://github.
 static register(options): DynamicModule;
 ```
 
-Defined in: [libs/platform-authentication/src/AuthModule.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L114)
+Defined in: [libs/platform-authentication/src/AuthModule.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L126)
 
 Registers the auth module with the provided port implementations.
 
 #### Parameters
 
-| Parameter | Type                                                 | Description                               |
-| --------- | ---------------------------------------------------- | ----------------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `options` | [`IAuthModuleOptions`](Interface.IAuthModuleOptions) | Port implementations for the auth module. |
 
 #### Returns

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

@@ -3,11 +3,6 @@ title: 'Abstract Class: AuthSubjectPort'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Abstract Class: AuthSubjectPort
 
 Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L13)
@@ -41,8 +36,8 @@ Find the anonymous / seed subject by user name.
 
 #### Parameters
 
-| Parameter  | Type     | Description              |
-| ---------- | -------- | ------------------------ |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `userName` | `string` | The anonymous user name. |
 
 #### Returns
@@ -51,7 +46,7 @@ Find the anonymous / seed subject by user name.
 
 The subject or `null`.
 
----
+***
 
 ### findById()
 
@@ -65,9 +60,9 @@ Find a subject by its unique identifier.
 
 #### Parameters
 
-| Parameter | Type     | Description             |
-| --------- | -------- | ----------------------- |
-| `id`      | `string` | The subject identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The subject identifier. |
 
 #### Returns
 
@@ -75,7 +70,7 @@ Find a subject by its unique identifier.
 
 The subject or `null`.
 
----
+***
 
 ### findByLogin()
 
@@ -89,9 +84,9 @@ Find a subject by its login name (user name or email).
 
 #### Parameters
 
-| Parameter | Type     | Description           |
-| --------- | -------- | --------------------- |
-| `login`   | `string` | The login identifier. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `login` | `string` | The login identifier. |
 
 #### Returns
 

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

@@ -3,11 +3,6 @@ title: 'Class: AuthTokenService'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: AuthTokenService
 
 Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L18)
@@ -30,9 +25,9 @@ Constructs a new instance of the `AuthTokenService` class.
 
 #### Parameters
 
-| Parameter       | Type                                                     | Description                   |
-| --------------- | -------------------------------------------------------- | ----------------------------- |
-| `jwtService`    | `JwtService`                                             | The NestJS JWT service.       |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jwtService` | `JwtService` | The NestJS JWT service. |
 | `tokenEnricher` | [`TokenEnricherPort`](Class.TokenEnricherPort) \| `null` | Optional token enricher port. |
 
 #### Returns
@@ -53,8 +48,8 @@ Creates a signed JWT for the given subject.
 
 #### Parameters
 
-| Parameter | Type                                     | Description                |
-| --------- | ---------------------------------------- | -------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `subject` | [`IAuthSubject`](Interface.IAuthSubject) | The authenticated subject. |
 
 #### Returns

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

@@ -3,11 +3,6 @@ title: 'Class: ChallengeService'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: ChallengeService
 
 Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L29)
@@ -26,8 +21,8 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:40](h
 
 #### Parameters
 
-| Parameter       | Type            |
-| --------------- | --------------- |
+| Parameter | Type |
+| ------ | ------ |
 | `configService` | `ConfigService` |
 
 #### Returns
@@ -40,12 +35,12 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:40](h
 
 ```ts
 create(
-   userId,
-   methods,
-   preferredMethod?,
-   ipAddress?,
-   userAgent?,
-   location?,
+   userId, 
+   methods, 
+   preferredMethod?, 
+   ipAddress?, 
+   userAgent?, 
+   location?, 
 clientName?): Promise<IMfaChallengeState>;
 ```
 
@@ -55,21 +50,21 @@ Issues a new MFA challenge for a user.
 
 #### Parameters
 
-| Parameter          | Type       |
-| ------------------ | ---------- |
-| `userId`           | `string`   |
-| `methods`          | `string`[] |
-| `preferredMethod?` | `string`   |
-| `ipAddress?`       | `string`   |
-| `userAgent?`       | `string`   |
-| `location?`        | `string`   |
-| `clientName?`      | `string`   |
+| Parameter | Type |
+| ------ | ------ |
+| `userId` | `string` |
+| `methods` | `string`[] |
+| `preferredMethod?` | `string` |
+| `ipAddress?` | `string` |
+| `userAgent?` | `string` |
+| `location?` | `string` |
+| `clientName?` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### get()
 
@@ -83,15 +78,15 @@ Retrieves an active challenge, throwing if invalid or expired.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### incrementAttempts()
 
@@ -105,15 +100,15 @@ Increments failed attempts and optionally invalidates the challenge.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns
 
 `Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
 
----
+***
 
 ### invalidate()
 
@@ -127,8 +122,8 @@ Invalidates a challenge after successful verification.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
+| Parameter | Type |
+| ------ | ------ |
 | `challengeId` | `string` |
 
 #### Returns

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

@@ -3,11 +3,6 @@ title: 'Class: GithubAuthGuard'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: GithubAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/GithubAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/GithubAuthGuard.ts#L14)
@@ -26,12 +21,12 @@ The `GithubAuthGuard` protects routes using GitHub authentication.
 new GithubAuthGuard(...args): GithubAuthGuard;
 ```
 
-Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 
 #### Parameters
 
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 
 #### Returns
@@ -41,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('github').constructor;
+AuthGuard('github').constructor
 ```

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

@@ -0,0 +1,72 @@
+---
+title: 'Class: GithubStrategy'
+generated: true
+editUrl: false
+---
+# Class: GithubStrategy
+
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L18)
+
+## Extends
+
+- `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new GithubStrategy(socialAuth, configService): GithubStrategy;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L35)
+
+Constructs a new instance of the `GithubStrategy` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
+
+#### Returns
+
+`GithubStrategy`
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'github').constructor
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(
+   _accessToken, 
+   _refreshToken, 
+profile): Promise<IAuthSubject>;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L55)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `_accessToken` | `string` |
+| `_refreshToken` | `string` |
+| `profile` | `Profile` |
+
+#### Returns
+
+`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'github').validate
+```

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

@@ -0,0 +1,78 @@
+---
+title: 'Class: GoogleStrategy'
+generated: true
+editUrl: false
+---
+# Class: GoogleStrategy
+
+Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L18)
+
+The `GoogleStrategy` integrates Google OAuth authentication.
+
+## Extends
+
+- `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new GoogleStrategy(socialAuth, configService): GoogleStrategy;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L34)
+
+Initializes a new instance of the `GoogleStrategy` class.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
+| `configService` | `ConfigService` | Configuration service instance. |
+
+#### Returns
+
+`GoogleStrategy`
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'google').constructor
+```
+
+## Methods
+
+### validate()
+
+```ts
+validate(
+   accessToken, 
+   refreshToken, 
+profile): Promise<IAuthSubject>;
+```
+
+Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L59)
+
+Validates the Google authentication payload.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `accessToken` | `string` | OAuth access token. |
+| `refreshToken` | `string` | OAuth refresh token. |
+| `profile` | `Profile` | Google profile data. |
+
+#### Returns
+
+`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
+
+The authenticated user.
+
+#### Overrides
+
+```ts
+PassportStrategy(Strategy, 'google').validate
+```

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

@@ -3,11 +3,6 @@ title: 'Class: JwtAuthGuard'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-authentication**](../)
-
----
-
 # Class: JwtAuthGuard
 
 Defined in: [libs/platform-authentication/src/guards/JwtAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/JwtAuthGuard.ts#L14)
@@ -26,12 +21,12 @@ The `JwtAuthGuard` protects routes using JWT-based authentication.
 new JwtAuthGuard(...args): JwtAuthGuard;
 ```
 
-Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
+Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 
 #### Parameters
 
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 
 #### Returns
@@ -41,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
 #### Inherited from
 
 ```ts
-AuthGuard('jwt').constructor;
+AuthGuard('jwt').constructor
 ```