@breadstone/archipel-mcp 0.0.13 → 0.0.14

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

@@ -1,60 +0,0 @@
----
-title: 'Class: RolesGuard'
-generated: true
-editUrl: false
----
-# 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

@@ -1,60 +0,0 @@
----
-title: 'Class: SessionMappingProfile'
-generated: true
-editUrl: false
----
-# 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
-```

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

@@ -1,165 +0,0 @@
----
-title: 'Abstract Class: SessionPersistencePort'
-generated: true
-editUrl: false
----
-# Abstract Class: SessionPersistencePort
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L14)
-
-Abstract port for persisting and querying sessions.
-Used by the SessionService and LastActiveMiddleware.
-
-## Constructors
-
-### Constructor
-
-```ts
-new SessionPersistencePort(): SessionPersistencePort;
-```
-
-#### Returns
-
-`SessionPersistencePort`
-
-## Methods
-
-### findAllByUserId()
-
-```ts
-abstract findAllByUserId(userId): Promise<readonly ISessionRecord[]>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L41)
-
-Find all sessions for a given user.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `userId` | `string` | The user identifier. |
-
-#### Returns
-
-`Promise`\<readonly [`ISessionRecord`](Interface.ISessionRecord)[]\>
-
-Sessions ordered by last activity descending.
-
-***
-
-### findByToken()
-
-```ts
-abstract findByToken(token): Promise<ISessionRecord | null>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L32)
-
-Find a session by its token.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-
-#### Returns
-
-`Promise`\<[`ISessionRecord`](Interface.ISessionRecord) \| `null`\>
-
-The session record or `null`.
-
-***
-
-### invalidate()
-
-```ts
-abstract invalidate(token): Promise<boolean>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L59)
-
-Invalidate (delete) a session by its token.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-`true` if a session was invalidated.
-
-***
-
-### invalidateById()
-
-```ts
-abstract invalidateById(id, userId): Promise<boolean>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L69)
-
-Invalidate (delete) a session by its record id and owning user id.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The session record identifier. |
-| `userId` | `string` | The owning user identifier. |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-`true` if a session was invalidated.
-
-***
-
-### store()
-
-```ts
-abstract store(args): Promise<void>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L23)
-
-Store or update a session.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `args` | [`IStoreSessionArgs`](Interface.IStoreSessionArgs) | The session data to store. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### updateLastActive()
-
-```ts
-abstract updateLastActive(token, date): Promise<void>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L50)
-
-Update the last-active timestamp for a session.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-| `date` | `Date` | The new last-active date. |
-
-#### Returns
-
-`Promise`\<`void`\>

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

@@ -1,152 +0,0 @@
----
-title: 'Class: SessionResponse'
-generated: true
-editUrl: false
----
-# Class: SessionResponse
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L14)
-
-The `SessionResponse` class.
-
-## Constructors
-
-### Constructor
-
-```ts
-new SessionResponse(): SessionResponse;
-```
-
-#### Returns
-
-`SessionResponse`
-
-## Properties
-
-### browserName
-
-```ts
-browserName: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L55)
-
-***
-
-### browserVersion
-
-```ts
-browserVersion: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L65)
-
-***
-
-### clientName
-
-```ts
-clientName: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L105)
-
-***
-
-### createdAt
-
-```ts
-createdAt: Date;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L129)
-
-***
-
-### deviceName
-
-```ts
-deviceName: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L45)
-
-***
-
-### deviceType
-
-```ts
-deviceType: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L35)
-
-***
-
-### id
-
-```ts
-id: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L25)
-
-***
-
-### ipAddress
-
-```ts
-ipAddress: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L113)
-
-***
-
-### isCurrent
-
-```ts
-isCurrent: boolean;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L137)
-
-***
-
-### lastActive
-
-```ts
-lastActive: Date;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L121)
-
-***
-
-### location
-
-```ts
-location: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L95)
-
-***
-
-### osName
-
-```ts
-osName: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L75)
-
-***
-
-### osVersion
-
-```ts
-osVersion: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L85)

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

@@ -1,162 +0,0 @@
----
-title: 'Class: SessionService'
-generated: true
-editUrl: false
----
-# Class: SessionService
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L18)
-
-Manages user sessions via the [SessionPersistencePort](Class.SessionPersistencePort).
-
-## Constructors
-
-### Constructor
-
-```ts
-new SessionService(sessionPersistence, mappingService): SessionService;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L35)
-
-Constructs a new instance of the `SessionService` class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `sessionPersistence` | [`SessionPersistencePort`](Class.SessionPersistencePort) | The session persistence port. |
-| `mappingService` | `MappingService` | The mapping service. |
-
-#### Returns
-
-`SessionService`
-
-## Methods
-
-### invalidate()
-
-```ts
-invalidate(token): Promise<boolean>;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L125)
-
-Invalidates a session by its token.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-`true` if a session was invalidated.
-
-***
-
-### invalidateById()
-
-```ts
-invalidateById(sessionId, userId): Promise<boolean>;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L114)
-
-Invalidates a session by its record id.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `sessionId` | `string` | The session record identifier. |
-| `userId` | `string` | The owning user identifier. |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-`true` if a session was invalidated.
-
-***
-
-### listSessions()
-
-```ts
-listSessions(userId, token): Promise<SessionResponse[]>;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L95)
-
-Lists all sessions for a user, marking the current one.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `userId` | `string` | The user identifier. |
-| `token` | `string` | The current session token. |
-
-#### Returns
-
-`Promise`\<[`SessionResponse`](Class.SessionResponse)[]\>
-
-Array of session responses.
-
-***
-
-### store()
-
-```ts
-store(
-   token, 
-   userId, 
-   ipAddress, 
-   deviceInfo?, 
-   location?, 
-clientName?): Promise<void>;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L55)
-
-Stores or updates a session.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-| `userId` | `string` | The user identifier. |
-| `ipAddress` | `string` | The client IP address. |
-| `deviceInfo?` | `IDeviceInfo` | Optional device information. |
-| `location?` | `string` | Optional geolocation string. |
-| `clientName?` | `string` | Optional client application name. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### updateLastActive()
-
-```ts
-updateLastActive(token): Promise<void>;
-```
-
-Defined in: [libs/platform-authentication/src/services/SessionService.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.ts#L79)
-
-Updates the last-active timestamp for a session.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `token` | `string` | The session token. |
-
-#### Returns
-
-`Promise`\<`void`\>

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

@@ -1,61 +0,0 @@
----
-title: 'Class: SocialAuthGuard'
-generated: true
-editUrl: false
----
-# Class: SocialAuthGuard
-
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L10)
-
-## Implements
-
-- `CanActivate`
-
-## Constructors
-
-### Constructor
-
-```ts
-new SocialAuthGuard(routeParam): SocialAuthGuard;
-```
-
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L20)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `routeParam` | `string` |
-
-#### Returns
-
-`SocialAuthGuard`
-
-## Methods
-
-### canActivate()
-
-```ts
-canActivate(context): boolean | Promise<boolean> | Observable<boolean>;
-```
-
-Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L28)
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `context` | `ExecutionContext` | Current execution context. Provides access to details about the current request pipeline. |
-
-#### Returns
-
-`boolean` \| `Promise`\<`boolean`\> \| `Observable`\<`boolean`\>
-
-Value indicating whether or not the current request is allowed to
-proceed.
-
-#### Implementation of
-
-```ts
-CanActivate.canActivate
-```

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

@@ -1,48 +0,0 @@
----
-title: 'Abstract Class: SocialAuthPort'
-generated: true
-editUrl: false
----
-# Abstract Class: SocialAuthPort
-
-Defined in: [libs/platform-authentication/src/contracts/SocialAuthPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SocialAuthPort.ts#L14)
-
-Abstract port for resolving or creating subjects from social / OAuth profiles.
-Used by all social strategies (GitHub, Google, Microsoft, Apple).
-
-## Constructors
-
-### Constructor
-
-```ts
-new SocialAuthPort(): SocialAuthPort;
-```
-
-#### Returns
-
-`SocialAuthPort`
-
-## Methods
-
-### findOrCreateByProfile()
-
-```ts
-abstract findOrCreateByProfile(profile): Promise<IAuthSubject>;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/SocialAuthPort.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SocialAuthPort.ts#L25)
-
-Find an existing subject matching the social profile,
-or create a new one if none exists.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `profile` | [`ISocialProfile`](Interface.ISocialProfile) | The normalized social profile. |
-
-#### Returns
-
-`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
-
-The existing or newly created subject.