@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,75 @@
+---
+title: 'Interface: IStoreSessionArgs'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IStoreSessionArgs
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L12)
+
+Arguments for storing a new session.
+
+## Properties
+
+### clientName?
+
+```ts
+readonly optional clientName?: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L20)
+
+---
+
+### deviceInfo?
+
+```ts
+readonly optional deviceInfo?: IDeviceInfo;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L18)
+
+---
+
+### ipAddress
+
+```ts
+readonly ipAddress: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L17)
+
+---
+
+### location?
+
+```ts
+readonly optional location?: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L19)
+
+---
+
+### token
+
+```ts
+readonly token: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L15)
+
+---
+
+### userId
+
+```ts
+readonly userId: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L16)

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

@@ -0,0 +1,76 @@
+---
+title: 'Interface: IVerifiableSubject'
+generated: true
+editUrl: false
+---
+
+[**@breadstone/archipel-platform-authentication**](../)
+
+---
+
+# Interface: IVerifiableSubject
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L7)
+
+Represents a verifiable authentication subject.
+Used by the [VerificationService](Class.VerificationService) to verify email / PIN.
+
+## Properties
+
+### email
+
+```ts
+readonly email: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L18)
+
+Email address.
+
+---
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L13)
+
+Unique identifier.
+
+---
+
+### isVerified
+
+```ts
+readonly isVerified: boolean;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L28)
+
+Whether the account has already been verified.
+
+---
+
+### userName
+
+```ts
+readonly userName: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L23)
+
+User / login name.
+
+---
+
+### verificationToken
+
+```ts
+readonly verificationToken: string | null;
+```
+
+Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L33)
+
+Current verification token stored on the entity.

package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md

@@ -0,0 +1,151 @@
+---
+title: Environment Variables Reference
+generated: true
+editUrl: false
+---
+
+# Environment Variables Reference
+
+This document lists environment variables used across all Archipel platform packages.
+
+## @breadstone/archipel-platform-core
+
+| Variable                         | Required | Default       | Description                             |
+| -------------------------------- | -------- | ------------- | --------------------------------------- |
+| `APP_URL`                        | yes      | -             | Base URL the application is served from |
+| `APP_PORT`                       | yes      | -             | HTTP port the application listens on    |
+| `APP_VERSION`                    | yes      | -             | Semantic application version            |
+| `NODE_ENV`                       | no       | `development` | Runtime environment name                |
+| `INTELLIGENCE_MODEL`             | no       | -             | AI model identifier                     |
+| `INTELLIGENCE_TEMPERATURE`       | no       | `0.7`         | AI model sampling temperature           |
+| `INTELLIGENCE_TOP_P`             | no       | `1`           | AI model top-p value                    |
+| `INTELLIGENCE_MAX_OUTPUT_TOKENS` | no       | `1024`        | Max generated output tokens             |
+
+## @breadstone/archipel-platform-authentication
+
+| Variable                        | Required | Default                    | Description                               |
+| ------------------------------- | -------- | -------------------------- | ----------------------------------------- |
+| `AUTH_JWT_SECRET`               | yes      | -                          | JWT signing secret                        |
+| `AUTH_JWT_EXPIRES_IN`           | yes      | -                          | Access token lifetime (for example `15m`) |
+| `AUTH_VERIFY_JWT_EXPIRES_IN`    | yes      | -                          | Verification token lifetime               |
+| `AUTH_MFA_ENCRYPTION_KEY`       | no       | `''`                       | MFA secret encryption key                 |
+| `AUTH_MFA_CHALLENGE_EXPIRES_IN` | no       | `5m`                       | MFA challenge validity                    |
+| `AUTH_MFA_MAX_ATTEMPTS`         | no       | `5`                        | Maximum MFA attempts                      |
+| `AUTH_MFA_SMS_CODE_TTL`         | no       | `10m`                      | SMS OTP validity                          |
+| `AUTH_MFA_SMS_MIN_RESEND`       | no       | `30s`                      | SMS resend cooldown                       |
+| `AUTH_MFA_EMAIL_CODE_TTL`       | no       | `10m`                      | Email OTP validity                        |
+| `AUTH_MFA_EMAIL_MIN_RESEND`     | no       | `30s`                      | Email resend cooldown                     |
+| `AUTH_MFA_PUSH_CODE_TTL`        | no       | `10m`                      | Push OTP validity                         |
+| `AUTH_MFA_PUSH_MIN_RESEND`      | no       | `30s`                      | Push resend cooldown                      |
+| `AUTH_GOOGLE_CLIENT_ID`         | yes      | -                          | Google OAuth client ID                    |
+| `AUTH_GOOGLE_CLIENT_SECRET`     | yes      | -                          | Google OAuth client secret                |
+| `AUTH_GOOGLE_CALLBACK_URL`      | no       | `/auth/google/callback`    | Google OAuth callback URL                 |
+| `AUTH_MICROSOFT_CLIENT_ID`      | yes      | -                          | Microsoft OAuth client ID                 |
+| `AUTH_MICROSOFT_CLIENT_SECRET`  | yes      | -                          | Microsoft OAuth client secret             |
+| `AUTH_MICROSOFT_CALLBACK_URL`   | no       | `/auth/microsoft/callback` | Microsoft OAuth callback URL              |
+| `AUTH_MICROSOFT_TENANT`         | no       | `common`                   | Microsoft tenant ID                       |
+| `AUTH_APPLE_PRIVATE_KEY`        | yes      | -                          | Apple Sign-In private key                 |
+| `AUTH_APPLE_CLIENT_ID`          | yes      | -                          | Apple Sign-In client ID                   |
+| `AUTH_APPLE_TEAM_ID`            | yes      | -                          | Apple developer team ID                   |
+| `AUTH_APPLE_KEY_ID`             | yes      | -                          | Apple Sign-In key ID                      |
+| `AUTH_APPLE_CALLBACK_URL`       | no       | `/auth/apple/callback`     | Apple callback URL                        |
+| `AUTH_GITHUB_CLIENT_ID`         | yes      | -                          | GitHub OAuth client ID                    |
+| `AUTH_GITHUB_CLIENT_SECRET`     | yes      | -                          | GitHub OAuth client secret                |
+| `SEED_ANONYMOUS_USERNAME`       | yes      | -                          | Anonymous seed username                   |
+
+## @breadstone/archipel-platform-blob-storage
+
+| Variable                       | Required                                | Default                                | Description                  |
+| ------------------------------ | --------------------------------------- | -------------------------------------- | ---------------------------- |
+| `VERCEL_BLOB_URL`              | no                                      | `https://blob.vercel-storage.com`      | Vercel Blob API base URL     |
+| `VERCEL_BLOB_READ_WRITE_TOKEN` | yes (unless provided in module options) | -                                      | Access token for Vercel Blob |
+| `VERCEL_BLOB_BUCKET`           | no                                      | `''`                                   | Default bucket               |
+| `VERCEL_BLOB_REGION`           | no                                      | `''`                                   | Region metadata value        |
+| `VERCEL_BLOB_PUBLIC_URL`       | no                                      | `''` (falls back to `VERCEL_BLOB_URL`) | Public URL base              |
+
+## @breadstone/archipel-platform-mailing
+
+| Variable                      | Required    | Default     | Description                                   |
+| ----------------------------- | ----------- | ----------- | --------------------------------------------- |
+| `MAIL_TEMPLATE_STRATEGY`      | yes         | -           | Template strategy (`file` or `blob`)          |
+| `MAIL_DELIVERY_STRATEGY`      | yes         | -           | Delivery strategy (`log`, `smtp`, `postmark`) |
+| `MAIL_SENDER_EMAIL`           | yes         | -           | Sender email address                          |
+| `MAIL_TEMPLATE_ENGINE_FORMAT` | yes         | -           | Template engine format                        |
+| `MAIL_POSTMARK_API_KEY`       | conditional | -           | Required for `postmark` delivery strategy     |
+| `MAIL_SMTP_HOST`              | no          | `localhost` | SMTP host                                     |
+| `MAIL_SMTP_PORT`              | no          | `587`       | SMTP port                                     |
+| `MAIL_SMTP_SECURE`            | no          | `false`     | SMTP TLS usage                                |
+| `MAIL_SMTP_USER`              | no          | `''`        | SMTP username                                 |
+| `MAIL_SMTP_PASSWORD`          | no          | `''`        | SMTP password                                 |
+| `MAIL_HOST`                   | no          | `''`        | Health check host                             |
+| `MAIL_USER`                   | no          | `''`        | Health check user                             |
+| `MAIL_PORT`                   | no          | `0`         | Health check port                             |
+
+## @breadstone/archipel-platform-payments
+
+### Stripe
+
+| Variable                | Required | Default | Description           |
+| ----------------------- | -------- | ------- | --------------------- |
+| `STRIPE_API_KEY`        | yes      | -       | Stripe API key        |
+| `STRIPE_WEBHOOK_SECRET` | yes      | -       | Stripe webhook secret |
+
+### Paddle
+
+| Variable                | Required | Default      | Description           |
+| ----------------------- | -------- | ------------ | --------------------- |
+| `PADDLE_API_KEY`        | yes      | -            | Paddle API key        |
+| `PADDLE_WEBHOOK_SECRET` | yes      | -            | Paddle webhook secret |
+| `PADDLE_ENVIRONMENT`    | no       | `production` | Paddle environment    |
+
+### LemonSqueezy
+
+| Variable                      | Required | Default | Description                 |
+| ----------------------------- | -------- | ------- | --------------------------- |
+| `LEMONSQUEEZY_API_KEY`        | yes      | -       | LemonSqueezy API key        |
+| `LEMONSQUEEZY_WEBHOOK_SECRET` | yes      | -       | LemonSqueezy webhook secret |
+| `LEMONSQUEEZY_STORE_ID`       | yes      | -       | LemonSqueezy store ID       |
+
+### Mollie
+
+| Variable                | Required | Default | Description                        |
+| ----------------------- | -------- | ------- | ---------------------------------- |
+| `MOLLIE_API_KEY`        | yes      | -       | Mollie API key                     |
+| `MOLLIE_WEBHOOK_SECRET` | no       | -       | Mollie webhook verification secret |
+
+## @breadstone/archipel-platform-openapi
+
+| Variable                | Required | Default | Description                  |
+| ----------------------- | -------- | ------- | ---------------------------- |
+| `APP_VERSION`           | yes      | -       | App version shown in Swagger |
+| `SWAGGER_CONTACT_NAME`  | yes      | -       | Swagger contact name         |
+| `SWAGGER_CONTACT_URL`   | yes      | -       | Swagger contact URL          |
+| `SWAGGER_CONTACT_EMAIL` | yes      | -       | Swagger contact email        |
+
+## @breadstone/archipel-platform-logging
+
+| Variable        | Required         | Default | Description                                   |
+| --------------- | ---------------- | ------- | --------------------------------------------- |
+| `APP_LOG_LEVEL` | no               | `warn`  | Application log level                         |
+| `SENTRY_DSN`    | optional runtime | -       | Sentry DSN used by `AnalyticsService`         |
+| `NODE_ENV`      | optional runtime | -       | Sentry environment used by `AnalyticsService` |
+
+## @breadstone/archipel-platform-database
+
+No package-level environment variables are declared in this library.
+
+## @breadstone/archipel-platform-documents
+
+No package-level environment variables are declared in this library.
+
+## @breadstone/archipel-platform-reporting
+
+No package-level environment variables are declared in this library.
+
+## @breadstone/archipel-platform-telemetry
+
+No package-level environment variables are declared in this library.
+
+## @breadstone/archipel-platform-mcp
+
+No package-level environment variables are declared in this library.