@breadstone/archipel-mcp 0.0.11 → 0.0.14

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

@@ -1,67 +0,0 @@
----
-title: 'Class: AuthModule'
-generated: true
-editUrl: false
----
-# Class: AuthModule
-
-Defined in: [libs/platform-authentication/src/AuthModule.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L129)
-
-The `AuthModule` handles JWT-based authentication,
-including token creation and validation.
-
-## Constructors
-
-### Constructor
-
-```ts
-new AuthModule(): AuthModule;
-```
-
-#### Returns
-
-`AuthModule`
-
-## Methods
-
-### configure()
-
-```ts
-configure(consumer): void;
-```
-
-Defined in: [libs/platform-authentication/src/AuthModule.ts:232](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L232)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `consumer` | `MiddlewareConsumer` |
-
-#### Returns
-
-`void`
-
-***
-
-### register()
-
-```ts
-static register(options): DynamicModule;
-```
-
-Defined in: [libs/platform-authentication/src/AuthModule.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L139)
-
-Registers the auth module with the provided port implementations.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `options` | [`IAuthModuleOptions`](Interface.IAuthModuleOptions) | Port implementations for the auth module. |
-
-#### Returns
-
-`DynamicModule`
-
-The configured dynamic module.

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

@@ -1,95 +0,0 @@
----
-title: 'Abstract Class: AuthSubjectPort'
-generated: true
-editUrl: false
----
-# 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)
-
-Abstract port for resolving authentication subjects by identity.
-Used by the JWT, Local, and Anonymous strategies.
-
-## Constructors
-
-### Constructor
-
-```ts
-new AuthSubjectPort(): AuthSubjectPort;
-```
-
-#### Returns
-
-`AuthSubjectPort`
-
-## Methods
-
-### findAnonymous()
-
-```ts
-abstract findAnonymous(userName): Promise<IAuthSubject | null>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L41)
-
-Find the anonymous / seed subject by user name.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `userName` | `string` | The anonymous user name. |
-
-#### Returns
-
-`Promise`\<[`IAuthSubject`](Interface.IAuthSubject) \| `null`\>
-
-The subject or `null`.
-
-***
-
-### findById()
-
-```ts
-abstract findById(id): Promise<IAuthSubject | null>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L23)
-
-Find a subject by its unique identifier.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The subject identifier. |
-
-#### Returns
-
-`Promise`\<[`IAuthSubject`](Interface.IAuthSubject) \| `null`\>
-
-The subject or `null`.
-
-***
-
-### findByLogin()
-
-```ts
-abstract findByLogin(login): Promise<IAuthSubject | null>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L32)
-
-Find a subject by its login name (user name or email).
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `login` | `string` | The login identifier. |
-
-#### Returns
-
-`Promise`\<[`IAuthSubject`](Interface.IAuthSubject) \| `null`\>
-
-The subject or `null`.

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

@@ -1,59 +0,0 @@
----
-title: 'Class: AuthTokenService'
-generated: true
-editUrl: false
----
-# 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)
-
-Generic service responsible for creating JWT access tokens.
-Builds a base payload from [IAuthSubject](Interface.IAuthSubject) and optionally enriches it
-via the [TokenEnricherPort](Class.TokenEnricherPort) with product-specific claims.
-
-## Constructors
-
-### Constructor
-
-```ts
-new AuthTokenService(jwtService, tokenEnricher): AuthTokenService;
-```
-
-Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L35)
-
-Constructs a new instance of the `AuthTokenService` class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `jwtService` | `JwtService` | The NestJS JWT service. |
-| `tokenEnricher` | [`TokenEnricherPort`](Class.TokenEnricherPort) \| `null` | Optional token enricher port. |
-
-#### Returns
-
-`AuthTokenService`
-
-## Methods
-
-### createAccessToken()
-
-```ts
-createAccessToken(subject): Promise<string>;
-```
-
-Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L51)
-
-Creates a signed JWT for the given subject.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `subject` | [`IAuthSubject`](Interface.IAuthSubject) | The authenticated subject. |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-The signed JWT access token.

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

@@ -1,131 +0,0 @@
----
-title: 'Class: ChallengeService'
-generated: true
-editUrl: false
----
-# Class: ChallengeService
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L30)
-
-Stores and validates MFA login challenges.
-
-## Constructors
-
-### Constructor
-
-```ts
-new ChallengeService(configService): ChallengeService;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L41)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `configService` | `ConfigService` |
-
-#### Returns
-
-`ChallengeService`
-
-## Methods
-
-### create()
-
-```ts
-create(
-   userId, 
-   methods, 
-   preferredMethod?, 
-   ipAddress?, 
-   userAgent?, 
-   location?, 
-clientName?): Promise<IMfaChallengeState>;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L54)
-
-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` |
-
-#### Returns
-
-`Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
-
-***
-
-### get()
-
-```ts
-get(challengeId): Promise<IMfaChallengeState>;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L86)
-
-Retrieves an active challenge, throwing if invalid or expired.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `challengeId` | `string` |
-
-#### Returns
-
-`Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
-
-***
-
-### incrementAttempts()
-
-```ts
-incrementAttempts(challengeId): Promise<IMfaChallengeState>;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L103)
-
-Increments failed attempts and optionally invalidates the challenge.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `challengeId` | `string` |
-
-#### Returns
-
-`Promise`\<[`IMfaChallengeState`](Interface.IMfaChallengeState)\>
-
-***
-
-### invalidate()
-
-```ts
-invalidate(challengeId): Promise<void>;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L124)
-
-Invalidates a challenge after successful verification.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `challengeId` | `string` |
-
-#### Returns
-
-`Promise`\<`void`\>

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

@@ -1,40 +0,0 @@
----
-title: 'Class: GithubAuthGuard'
-generated: true
-editUrl: false
----
-# 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)
-
-The `GithubAuthGuard` protects routes using GitHub authentication.
-
-## Extends
-
-- `IAuthGuard`
-
-## Constructors
-
-### Constructor
-
-```ts
-new GithubAuthGuard(...args): GithubAuthGuard;
-```
-
-Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| ...`args` | `any`[] |
-
-#### Returns
-
-`GithubAuthGuard`
-
-#### Inherited from
-
-```ts
-AuthGuard('github').constructor
-```

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

@@ -1,78 +0,0 @@
----
-title: 'Class: GithubConnector'
-generated: true
-editUrl: false
----
-# Class: GithubConnector
-
-Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GithubConnector.ts#L14)
-
-## Extends
-
-- `_ConnectorBase`\<*typeof* `Strategy`, `this`\>
-
-## Indexable
-
-```ts
-[key: string]: any
-```
-
-## Constructors
-
-### Constructor
-
-```ts
-new GithubConnector(socialAuth, configService): GithubConnector;
-```
-
-Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GithubConnector.ts#L30)
-
-Constructs a new instance of the `GithubConnector` class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
-| `configService` | `ConfigService` | Configuration service instance. |
-
-#### Returns
-
-`GithubConnector`
-
-#### Overrides
-
-```ts
-ConnectorBase(Strategy, 'github').constructor
-```
-
-## Methods
-
-### validate()
-
-```ts
-validate(
-   _accessToken, 
-   _refreshToken, 
-profile): Promise<IAuthSubject>;
-```
-
-Defined in: [libs/platform-authentication/src/connectors/GithubConnector.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GithubConnector.ts#L54)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `_accessToken` | `string` |
-| `_refreshToken` | `string` |
-| `profile` | `Profile` |
-
-#### Returns
-
-`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
-
-#### Overrides
-
-```ts
-ConnectorBase(Strategy, 'github').validate
-```

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

@@ -1,84 +0,0 @@
----
-title: 'Class: GoogleConnector'
-generated: true
-editUrl: false
----
-# Class: GoogleConnector
-
-Defined in: [libs/platform-authentication/src/connectors/GoogleConnector.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GoogleConnector.ts#L19)
-
-The `GoogleConnector` integrates Google OAuth authentication.
-
-## Extends
-
-- `_ConnectorBase`\<*typeof* `Strategy`, `this`\>
-
-## Indexable
-
-```ts
-[key: string]: any
-```
-
-## Constructors
-
-### Constructor
-
-```ts
-new GoogleConnector(socialAuth, configService): GoogleConnector;
-```
-
-Defined in: [libs/platform-authentication/src/connectors/GoogleConnector.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GoogleConnector.ts#L35)
-
-Initializes a new instance of the `GoogleConnector` class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
-| `configService` | `ConfigService` | Configuration service instance. |
-
-#### Returns
-
-`GoogleConnector`
-
-#### Overrides
-
-```ts
-ConnectorBase(Strategy, 'google').constructor
-```
-
-## Methods
-
-### validate()
-
-```ts
-validate(
-   accessToken, 
-   refreshToken, 
-profile): Promise<IAuthSubject>;
-```
-
-Defined in: [libs/platform-authentication/src/connectors/GoogleConnector.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/GoogleConnector.ts#L66)
-
-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
-ConnectorBase(Strategy, 'google').validate
-```

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

@@ -1,40 +0,0 @@
----
-title: 'Class: JwtAuthGuard'
-generated: true
-editUrl: false
----
-# 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)
-
-The `JwtAuthGuard` protects routes using JWT-based authentication.
-
-## Extends
-
-- `IAuthGuard`
-
-## Constructors
-
-### Constructor
-
-```ts
-new JwtAuthGuard(...args): JwtAuthGuard;
-```
-
-Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| ...`args` | `any`[] |
-
-#### Returns
-
-`JwtAuthGuard`
-
-#### Inherited from
-
-```ts
-AuthGuard('jwt').constructor
-```