@breadstone/archipel-mcp 0.0.13 → 0.0.14

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

@@ -1,107 +0,0 @@
----
-title: 'Interface: IAuthSubject'
-generated: true
-editUrl: false
----
-# Interface: IAuthSubject
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L7)
-
-Generic authentication subject returned by the [AuthSubjectPort](Class.AuthSubjectPort).
-Represents any entity that can authenticate (user, service account, etc.).
-
-## Properties
-
-### email
-
-```ts
-readonly email: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L23)
-
-Email address.
-
-***
-
-### id
-
-```ts
-readonly id: string;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L13)
-
-Unique identifier.
-
-***
-
-### isAnonymous
-
-```ts
-readonly isAnonymous: boolean;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L38)
-
-Whether the account is anonymous.
-
-***
-
-### isVerified
-
-```ts
-readonly isVerified: boolean;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L33)
-
-Whether the account has been verified (e.g. email confirmation).
-
-***
-
-### mfaEnabled
-
-```ts
-readonly mfaEnabled: boolean;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L48)
-
-Whether MFA is enabled for this subject.
-
-***
-
-### password
-
-```ts
-readonly password: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L28)
-
-Hashed password. `null` for social-only accounts.
-
-***
-
-### roles
-
-```ts
-readonly roles: readonly string[];
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L43)
-
-Assigned role strings (e.g. `['user', 'admin']`).
-
-***
-
-### userName
-
-```ts
-readonly userName: string | null;
-```
-
-Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L18)
-
-Login name (user name, email alias, etc.).

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

@@ -1,82 +0,0 @@
----
-title: 'Interface: IMfaChallengePayload'
-generated: true
-editUrl: false
----
-# Interface: IMfaChallengePayload
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L6)
-
-Represents the MFA challenge payload encoded in a challenge token.
-
-## Properties
-
-### clientName?
-
-```ts
-readonly optional clientName?: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L38)
-
-Optional client name associated with the login attempt.
-
-***
-
-### ipAddress
-
-```ts
-readonly ipAddress: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L23)
-
-Captures the originating IP address for the challenge.
-
-***
-
-### location?
-
-```ts
-readonly optional location?: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L33)
-
-Optional location associated with the login attempt.
-
-***
-
-### type
-
-```ts
-readonly type: "mfa";
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L13)
-
-Defines the token discriminator used to validate challenge tokens.
-
-***
-
-### userAgent?
-
-```ts
-readonly optional userAgent?: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L28)
-
-Captures the originating user agent for the challenge.
-
-***
-
-### userId
-
-```ts
-readonly userId: string;
-```
-
-Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L18)
-
-Identifies the authenticated user.

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

@@ -1,118 +0,0 @@
----
-title: 'Interface: IMfaChallengeState'
-generated: true
-editUrl: false
----
-# Interface: IMfaChallengeState
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L10)
-
-## Properties
-
-### allowedMethods
-
-```ts
-allowedMethods: string[];
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L13)
-
-***
-
-### attempts
-
-```ts
-attempts: number;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L21)
-
-***
-
-### clientName?
-
-```ts
-optional clientName?: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L18)
-
-***
-
-### createdAt
-
-```ts
-createdAt: Date;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L19)
-
-***
-
-### expiresAt
-
-```ts
-expiresAt: Date;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L20)
-
-***
-
-### id
-
-```ts
-id: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L11)
-
-***
-
-### ipAddress?
-
-```ts
-optional ipAddress?: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L15)
-
-***
-
-### location?
-
-```ts
-optional location?: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L17)
-
-***
-
-### preferredMethod?
-
-```ts
-optional preferredMethod?: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L14)
-
-***
-
-### userAgent?
-
-```ts
-optional userAgent?: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L16)
-
-***
-
-### userId
-
-```ts
-userId: string;
-```
-
-Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L12)

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

@@ -1,22 +0,0 @@
----
-title: 'Interface: IMfaConfirmation'
-generated: true
-editUrl: false
----
-# 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

@@ -1,58 +0,0 @@
----
-title: 'Interface: IMfaSetup'
-generated: true
-editUrl: false
----
-# 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

@@ -1,131 +0,0 @@
----
-title: 'Interface: IMfaSubject'
-generated: true
-editUrl: false
----
-# 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

@@ -1,91 +0,0 @@
----
-title: 'Interface: IMfaSubjectUpdate'
-generated: true
-editUrl: false
----
-# 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)