@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md

@@ -0,0 +1,27 @@
+---
+title: 'Interface: IMfaConfirmation'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IMfaConfirmation
+
+Defined in: [libs/platform-authentication/src/models/IMfaConfirmation.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaConfirmation.ts#L6)
+
+Represents the activation result for multi-factor authentication.
+
+## Properties
+
+### backupCodes
+
+```ts
+readonly backupCodes: readonly string[];
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaConfirmation.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaConfirmation.ts#L13)
+
+Contains one-time recovery codes presented to the user.

package/data/packages/platform-authentication/api/Interface.IMfaSetup.md

@@ -0,0 +1,63 @@
+---
+title: 'Interface: IMfaSetup'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IMfaSetup
+
+Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L6)
+
+Represents the data required to onboard a multi-factor authenticator.
+
+## Properties
+
+### method
+
+```ts
+readonly method: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L18)
+
+Identifies the MFA method being provisioned.
+
+---
+
+### otpauthUrl?
+
+```ts
+readonly optional otpauthUrl?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L23)
+
+Contains the provisioning URI compatible with authenticator applications.
+
+---
+
+### quickResponseCodeDataUrl?
+
+```ts
+readonly optional quickResponseCodeDataUrl?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L28)
+
+Provides a pre-rendered QR code in data URL form.
+
+---
+
+### secret?
+
+```ts
+readonly optional secret?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L13)
+
+Contains the shared secret in Base32 format.

package/data/packages/platform-authentication/api/Interface.IMfaSubject.md

@@ -0,0 +1,136 @@
+---
+title: 'Interface: IMfaSubject'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IMfaSubject
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L7)
+
+Represents an MFA-enabled subject. Contains the data the MFA subsystem
+needs to read and write MFA state on the underlying user-like entity.
+
+## Properties
+
+### email
+
+```ts
+readonly email: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L18)
+
+Email address, used by the email OTP channel.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L13)
+
+Unique identifier.
+
+---
+
+### mfaBackupCodes
+
+```ts
+readonly mfaBackupCodes: readonly string[];
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L38)
+
+Hashed backup codes.
+
+---
+
+### mfaChannels
+
+```ts
+readonly mfaChannels: unknown;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L53)
+
+Serialized per-channel MFA state (JSON object).
+
+---
+
+### mfaEnabled
+
+```ts
+readonly mfaEnabled: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L28)
+
+Whether MFA is currently enabled.
+
+---
+
+### mfaPreferredMethod
+
+```ts
+readonly mfaPreferredMethod: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L43)
+
+Preferred MFA method.
+
+---
+
+### mfaSecret
+
+```ts
+readonly mfaSecret: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L33)
+
+Legacy TOTP secret (plain text). Used for migration to channel-based state.
+
+---
+
+### mfaVerifiedAt
+
+```ts
+readonly mfaVerifiedAt: Date | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L48)
+
+Last time MFA was verified.
+
+---
+
+### phoneNumber
+
+```ts
+readonly phoneNumber: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L58)
+
+Phone number, used by the SMS channel.
+
+---
+
+### userName
+
+```ts
+readonly userName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L23)
+
+User name, used as TOTP account label.

package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md

@@ -0,0 +1,96 @@
+---
+title: 'Interface: IMfaSubjectUpdate'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IMfaSubjectUpdate
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L7)
+
+Data payload for updating MFA state on the underlying entity.
+All properties are optional — only the provided ones are applied.
+
+## Properties
+
+### mfaBackupCodes?
+
+```ts
+readonly optional mfaBackupCodes?: string[];
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L12)
+
+---
+
+### mfaChannels?
+
+```ts
+readonly optional mfaChannels?: unknown;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L16)
+
+---
+
+### mfaEnabled?
+
+```ts
+readonly optional mfaEnabled?: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L10)
+
+---
+
+### mfaPreferredMethod?
+
+```ts
+readonly optional mfaPreferredMethod?: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L13)
+
+---
+
+### mfaSecret?
+
+```ts
+readonly optional mfaSecret?: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L11)
+
+---
+
+### mfaUpdatedAt?
+
+```ts
+readonly optional mfaUpdatedAt?: Date;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L15)
+
+---
+
+### mfaVerifiedAt?
+
+```ts
+readonly optional mfaVerifiedAt?: Date | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L14)
+
+---
+
+### phoneNumber?
+
+```ts
+readonly optional phoneNumber?: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L17)

package/data/packages/platform-authentication/api/Interface.ISessionRecord.md

@@ -0,0 +1,165 @@
+---
+title: 'Interface: ISessionRecord'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: ISessionRecord
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L6)
+
+Represents a persisted session record.
+
+## Properties
+
+### browserName
+
+```ts
+readonly browserName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L16)
+
+---
+
+### browserVersion
+
+```ts
+readonly browserVersion: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L17)
+
+---
+
+### clientName
+
+```ts
+readonly clientName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L21)
+
+---
+
+### createdAt
+
+```ts
+readonly createdAt: Date;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L23)
+
+---
+
+### deviceName
+
+```ts
+readonly deviceName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L15)
+
+---
+
+### deviceType
+
+```ts
+readonly deviceType: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L14)
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L9)
+
+---
+
+### ipAddress
+
+```ts
+readonly ipAddress: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L12)
+
+---
+
+### lastActive
+
+```ts
+readonly lastActive: Date;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L22)
+
+---
+
+### location
+
+```ts
+readonly location: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L20)
+
+---
+
+### osName
+
+```ts
+readonly osName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L18)
+
+---
+
+### osVersion
+
+```ts
+readonly osVersion: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L19)
+
+---
+
+### token
+
+```ts
+readonly token: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L10)
+
+---
+
+### userAgent
+
+```ts
+readonly userAgent: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L13)
+
+---
+
+### userId
+
+```ts
+readonly userId: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L11)

package/data/packages/platform-authentication/api/Interface.ISignInResult.md

@@ -0,0 +1,87 @@
+---
+title: 'Interface: ISignInResult'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: ISignInResult
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L6)
+
+Represents the outcome of a sign-in attempt.
+
+## Properties
+
+### accessToken?
+
+```ts
+readonly optional accessToken?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L23)
+
+Contains the issued access token when MFA is not required.
+
+---
+
+### challengeId?
+
+```ts
+readonly optional challengeId?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L28)
+
+Contains the challenge identifier required to complete MFA.
+
+---
+
+### methods?
+
+```ts
+readonly optional methods?: readonly string[];
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L33)
+
+Lists enabled MFA methods available for the challenge.
+
+---
+
+### mfaRequired
+
+```ts
+readonly mfaRequired: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L13)
+
+Indicates whether a multi-factor token is required.
+
+---
+
+### preferredMethod?
+
+```ts
+readonly optional preferredMethod?: string;
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L38)
+
+Indicates the preferred MFA method.
+
+---
+
+### verificationRequired?
+
+```ts
+readonly optional verificationRequired?: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L18)
+
+Indicates whether email verification is required.

package/data/packages/platform-authentication/api/Interface.ISocialProfile.md

@@ -0,0 +1,63 @@
+---
+title: 'Interface: ISocialProfile'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: ISocialProfile
+
+Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L6)
+
+Profile data received from a social / OAuth provider.
+
+## Properties
+
+### displayName
+
+```ts
+readonly displayName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L27)
+
+Display name.
+
+---
+
+### email
+
+```ts
+readonly email: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L22)
+
+Email address as reported by the provider.
+
+---
+
+### provider
+
+```ts
+readonly provider: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L12)
+
+The OAuth provider name (e.g. 'github', 'google', 'microsoft', 'apple').
+
+---
+
+### userName
+
+```ts
+readonly userName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L17)
+
+User name as reported by the provider.