@breadstone/archipel-mcp 0.0.6 → 0.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/index.md +13 -6
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +1 -1
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +9 -9
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +1 -1
- package/data/packages/platform-authentication/api/index.md +4 -0
- package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
- package/data/packages/platform-caching/api/index.md +25 -0
- package/data/packages/platform-caching/index.md +116 -0
- package/data/packages/platform-core/api/index.md +104 -150
- package/data/packages/platform-core/index.md +5 -3
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
- package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +29 -0
- package/data/packages/platform-cryptography/index.md +132 -0
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-intelligence/api/index.md +70 -0
- package/data/packages/platform-intelligence/index.md +131 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
- package/package.json +1 -1
- package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
- package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
package/data/packages/index.md
CHANGED
|
@@ -5,16 +5,17 @@ description: All Archipel platform packages with their primary capabilities.
|
|
|
5
5
|
|
|
6
6
|
# Packages
|
|
7
7
|
|
|
8
|
-
Archipel is organized into
|
|
8
|
+
Archipel is organized into 17 independent NestJS modules. Each package can be installed and used on its own — you only pull in what you need.
|
|
9
9
|
|
|
10
10
|
Every package follows the same structure: a dynamic NestJS module with `register()` configuration, abstract ports for contracts you implement, and concrete services you consume.
|
|
11
11
|
|
|
12
12
|
## Foundation
|
|
13
13
|
|
|
14
|
-
| Package
|
|
15
|
-
|
|
|
16
|
-
| [`platform-core`](./platform-core/)
|
|
17
|
-
| [`platform-
|
|
14
|
+
| Package | Description |
|
|
15
|
+
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
16
|
+
| [`platform-core`](./platform-core/) | Configuration, mapping, templates, event pub/sub, and shared utilities. Every other package depends on this. |
|
|
17
|
+
| [`platform-cryptography`](./platform-cryptography/) | Bcrypt password hashing, prefixed UUID generation, and TOTP multi-factor authentication. |
|
|
18
|
+
| [`platform-database`](./platform-database/) | Prisma + PostgreSQL integration with the repository/query pattern and transactional support. |
|
|
18
19
|
|
|
19
20
|
## Identity & Access
|
|
20
21
|
|
|
@@ -28,6 +29,7 @@ Every package follows the same structure: a dynamic NestJS module with `register
|
|
|
28
29
|
| Package | Description |
|
|
29
30
|
| --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
|
|
30
31
|
| [`platform-blob-storage`](./platform-blob-storage/) | Provider-agnostic blob storage (Vercel, Azure, AWS S3) with metadata tracking and image variant support. |
|
|
32
|
+
| [`platform-caching`](./platform-caching/) | Layered caching with in-memory LRU and Redis-backed implementations, TTL, stale-while-revalidate, and metrics. |
|
|
31
33
|
| [`platform-esigning`](./platform-esigning/) | Provider-agnostic e-signing with support for DocuSign, Adobe Sign, Dropbox Sign, signNow, and a built-in internal provider. |
|
|
32
34
|
| [`platform-mailing`](./platform-mailing/) | Multi-strategy email delivery (SMTP, Postmark, Resend, Plunk, Log) with template rendering and verification flows. |
|
|
33
35
|
| [`platform-documents`](./platform-documents/) | Document generation with pluggable renderers for DOCX, PDF, and image processing. |
|
|
@@ -40,6 +42,11 @@ Every package follows the same structure: a dynamic NestJS module with `register
|
|
|
40
42
|
| [`platform-logging`](./platform-logging/) | Sentry integration for structured error tracking and analytics. |
|
|
41
43
|
| [`platform-telemetry`](./platform-telemetry/) | OpenTelemetry tracing, metrics, a rule engine for conditional recording, and graceful noop fallback. |
|
|
42
44
|
| [`platform-analytics`](./platform-analytics/) | Provider-agnostic analytics and error tracking (Sentry, Application Insights, Datadog) with no-op fallback. |
|
|
43
|
-
| [`platform-analytics`](./platform-analytics/) | Provider-agnostic analytics and error tracking (Sentry, Application Insights, Datadog) with no-op fallback. |
|
|
44
45
|
| [`platform-reporting`](./platform-reporting/) | Contributor-based reporting engine with dataset registration and query execution. |
|
|
45
46
|
| [`platform-mcp`](./platform-mcp/) | Decorator-driven MCP (Model Context Protocol) server module with auto-discovery and multi-transport support. |
|
|
47
|
+
|
|
48
|
+
## AI & Extensibility
|
|
49
|
+
|
|
50
|
+
| Package | Description |
|
|
51
|
+
| --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
|
|
52
|
+
| [`platform-intelligence`](./platform-intelligence/) | Multi-provider AI text generation (OpenAI, Anthropic, Google, Grok) with capability registry and intent orchestration. |
|
|
@@ -55,7 +55,7 @@ validate(
|
|
|
55
55
|
profile): Promise<IAuthSubject>;
|
|
56
56
|
```
|
|
57
57
|
|
|
58
|
-
Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:
|
|
58
|
+
Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L73)
|
|
59
59
|
|
|
60
60
|
Validates the Apple authentication payload.
|
|
61
61
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: AuthModule
|
|
8
8
|
|
|
9
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
9
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L102)
|
|
10
10
|
|
|
11
11
|
The `AuthModule` handles JWT-based authentication,
|
|
12
12
|
including token creation and validation.
|
|
@@ -31,7 +31,7 @@ new AuthModule(): AuthModule;
|
|
|
31
31
|
configure(consumer): void;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
34
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:213](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L213)
|
|
35
35
|
|
|
36
36
|
#### Parameters
|
|
37
37
|
|
|
@@ -51,7 +51,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:227](https://github.
|
|
|
51
51
|
static register(options): DynamicModule;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
54
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L112)
|
|
55
55
|
|
|
56
56
|
Registers the auth module with the provided port implementations.
|
|
57
57
|
|
|
@@ -52,7 +52,7 @@ validate(
|
|
|
52
52
|
profile): Promise<IAuthSubject>;
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:
|
|
55
|
+
Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L53)
|
|
56
56
|
|
|
57
57
|
#### Parameters
|
|
58
58
|
|
|
@@ -54,7 +54,7 @@ validate(
|
|
|
54
54
|
profile): Promise<IAuthSubject>;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:
|
|
57
|
+
Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L65)
|
|
58
58
|
|
|
59
59
|
Validates the Google authentication payload.
|
|
60
60
|
|
|
@@ -54,7 +54,7 @@ validate(
|
|
|
54
54
|
profile): Promise<IAuthSubject>;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:
|
|
57
|
+
Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L67)
|
|
58
58
|
|
|
59
59
|
Validates the Microsoft authentication payload.
|
|
60
60
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IAuthModuleOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
9
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L45)
|
|
10
10
|
|
|
11
11
|
Options for configuring the `AuthModule`.
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Options for configuring the `AuthModule`.
|
|
|
18
18
|
optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
21
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L85)
|
|
22
22
|
|
|
23
23
|
Optional additional configuration entries to register (e.g. provider-specific OAuth keys).
|
|
24
24
|
Import them from the provider-specific sub-paths
|
|
@@ -32,7 +32,7 @@ Import them from the provider-specific sub-paths
|
|
|
32
32
|
authSubject: Type<AuthSubjectPort>;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
35
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L49)
|
|
36
36
|
|
|
37
37
|
Implementation of the auth subject port (user lookup for JWT/Local/Anonymous strategies).
|
|
38
38
|
|
|
@@ -44,7 +44,7 @@ Implementation of the auth subject port (user lookup for JWT/Local/Anonymous str
|
|
|
44
44
|
mfaSubject: Type<MfaSubjectPort>;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
47
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L54)
|
|
48
48
|
|
|
49
49
|
Implementation of the MFA subject port (MFA state persistence).
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Implementation of the MFA subject port (MFA state persistence).
|
|
|
56
56
|
sessionPersistence: Type<SessionPersistencePort>;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
59
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L59)
|
|
60
60
|
|
|
61
61
|
Implementation of the session persistence port.
|
|
62
62
|
|
|
@@ -68,7 +68,7 @@ Implementation of the session persistence port.
|
|
|
68
68
|
optional socialAuth?: Type<SocialAuthPort>;
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
71
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L70)
|
|
72
72
|
|
|
73
73
|
Optional implementation of the social auth port (OAuth strategies).
|
|
74
74
|
When provided together with `socialStrategies`, the social auth flow is enabled.
|
|
@@ -81,7 +81,7 @@ When provided together with `socialStrategies`, the social auth flow is enabled.
|
|
|
81
81
|
optional socialStrategies?: Type<any>[];
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
84
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L78)
|
|
85
85
|
|
|
86
86
|
Optional array of social strategy types to register (e.g. `AppleStrategy`, `GithubStrategy`).
|
|
87
87
|
Import them from the provider-specific sub-paths
|
|
@@ -96,7 +96,7 @@ Requires `socialAuth` to be set.
|
|
|
96
96
|
optional tokenEnricher?: Type<TokenEnricherPort>;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
99
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L91)
|
|
100
100
|
|
|
101
101
|
Optional implementation of the token enricher port.
|
|
102
102
|
When provided, additional claims are added to JWT tokens.
|
|
@@ -109,6 +109,6 @@ When provided, additional claims are added to JWT tokens.
|
|
|
109
109
|
verificationSubject: Type<VerificationSubjectPort>;
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
Defined in: [libs/platform-authentication/src/AuthModule.ts:
|
|
112
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L64)
|
|
113
113
|
|
|
114
114
|
Implementation of the verification subject port (email/pin verification).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const APPLE_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/apple/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/apple/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/apple/env.ts#L16)
|
|
14
14
|
|
|
15
15
|
Configuration entries required by Apple Sign-In authentication.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L115)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L106)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In client (service) ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_KEY_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L112)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In key ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_PRIVATE_KEY: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L103)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In private key (PEM string).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_APPLE\_SCOPE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_APPLE_SCOPE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_APPLE_SCOPE: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L118)
|
|
14
|
+
|
|
15
|
+
Comma-separated list of Apple Sign-In scopes (e.g. `'name,email'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_TEAM_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L109)
|
|
14
14
|
|
|
15
15
|
Apple developer team ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L131)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L125)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth client ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CLIENT_SECRET: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L128)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth client secret.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GITHUB\_SCOPE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GITHUB_SCOPE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GITHUB_SCOPE: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L134)
|
|
14
|
+
|
|
15
|
+
Comma-separated list of GitHub OAuth scopes (e.g. `'user:email,read:user'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_GOOGLE\_SCOPE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_GOOGLE_SCOPE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_GOOGLE_SCOPE: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L77)
|
|
14
|
+
|
|
15
|
+
Comma-separated list of Google OAuth scopes (e.g. `'email,profile'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MICROSOFT_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L90)
|
|
14
14
|
|
|
15
15
|
Microsoft OAuth2 callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MICROSOFT_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L84)
|
|
14
14
|
|
|
15
15
|
Microsoft OAuth2 client ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MICROSOFT_CLIENT_SECRET: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L87)
|
|
14
14
|
|
|
15
15
|
Microsoft OAuth2 client secret.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MICROSOFT\_SCOPE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MICROSOFT_SCOPE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MICROSOFT_SCOPE: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L96)
|
|
14
|
+
|
|
15
|
+
Comma-separated list of Microsoft OAuth scopes (e.g. `'user.read,mail.read'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MICROSOFT_TENANT: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L93)
|
|
14
14
|
|
|
15
15
|
Microsoft tenant ID or `'common'` for multi-tenant.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const MICROSOFT_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/microsoft/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/microsoft/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/microsoft/env.ts#L15)
|
|
14
14
|
|
|
15
15
|
Configuration entries required by Microsoft OAuth authentication.
|
package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md
CHANGED
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const PLATFORM_AUTHENTICATION_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:148](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L148)
|
|
14
14
|
|
|
15
15
|
Core configuration entries required by `platform-authentication`.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const SEED_ANONYMOUS_USERNAME: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L141)
|
|
14
14
|
|
|
15
15
|
Username used for the anonymous seed user.
|
|
@@ -64,13 +64,16 @@ editUrl: false
|
|
|
64
64
|
| [AUTH_APPLE_CLIENT_ID](Variable.AUTH_APPLE_CLIENT_ID) | Apple Sign-In client (service) ID. |
|
|
65
65
|
| [AUTH_APPLE_KEY_ID](Variable.AUTH_APPLE_KEY_ID) | Apple Sign-In key ID. |
|
|
66
66
|
| [AUTH_APPLE_PRIVATE_KEY](Variable.AUTH_APPLE_PRIVATE_KEY) | Apple Sign-In private key (PEM string). |
|
|
67
|
+
| [AUTH_APPLE_SCOPE](Variable.AUTH_APPLE_SCOPE) | Comma-separated list of Apple Sign-In scopes (e.g. `'name,email'`). |
|
|
67
68
|
| [AUTH_APPLE_TEAM_ID](Variable.AUTH_APPLE_TEAM_ID) | Apple developer team ID. |
|
|
68
69
|
| [AUTH_GITHUB_CALLBACK_URL](Variable.AUTH_GITHUB_CALLBACK_URL) | GitHub OAuth callback URL. |
|
|
69
70
|
| [AUTH_GITHUB_CLIENT_ID](Variable.AUTH_GITHUB_CLIENT_ID) | GitHub OAuth client ID. |
|
|
70
71
|
| [AUTH_GITHUB_CLIENT_SECRET](Variable.AUTH_GITHUB_CLIENT_SECRET) | GitHub OAuth client secret. |
|
|
72
|
+
| [AUTH_GITHUB_SCOPE](Variable.AUTH_GITHUB_SCOPE) | Comma-separated list of GitHub OAuth scopes (e.g. `'user:email,read:user'`). |
|
|
71
73
|
| [AUTH_GOOGLE_CALLBACK_URL](Variable.AUTH_GOOGLE_CALLBACK_URL) | Google OAuth2 callback URL. |
|
|
72
74
|
| [AUTH_GOOGLE_CLIENT_ID](Variable.AUTH_GOOGLE_CLIENT_ID) | Google OAuth2 client ID. |
|
|
73
75
|
| [AUTH_GOOGLE_CLIENT_SECRET](Variable.AUTH_GOOGLE_CLIENT_SECRET) | Google OAuth2 client secret. |
|
|
76
|
+
| [AUTH_GOOGLE_SCOPE](Variable.AUTH_GOOGLE_SCOPE) | Comma-separated list of Google OAuth scopes (e.g. `'email,profile'`). |
|
|
74
77
|
| [AUTH_JWT_EXPIRES_IN](Variable.AUTH_JWT_EXPIRES_IN) | Lifetime of access tokens (e.g. `'15m'`, `'1h'`). |
|
|
75
78
|
| [AUTH_JWT_SECRET](Variable.AUTH_JWT_SECRET) | Secret used to sign JWTs. |
|
|
76
79
|
| [AUTH_MFA_CHALLENGE_EXPIRES_IN](Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN) | How long an MFA challenge stays valid (e.g. `'5m'`). |
|
|
@@ -85,6 +88,7 @@ editUrl: false
|
|
|
85
88
|
| [AUTH_MICROSOFT_CALLBACK_URL](Variable.AUTH_MICROSOFT_CALLBACK_URL) | Microsoft OAuth2 callback URL. |
|
|
86
89
|
| [AUTH_MICROSOFT_CLIENT_ID](Variable.AUTH_MICROSOFT_CLIENT_ID) | Microsoft OAuth2 client ID. |
|
|
87
90
|
| [AUTH_MICROSOFT_CLIENT_SECRET](Variable.AUTH_MICROSOFT_CLIENT_SECRET) | Microsoft OAuth2 client secret. |
|
|
91
|
+
| [AUTH_MICROSOFT_SCOPE](Variable.AUTH_MICROSOFT_SCOPE) | Comma-separated list of Microsoft OAuth scopes (e.g. `'user.read,mail.read'`). |
|
|
88
92
|
| [AUTH_MICROSOFT_TENANT](Variable.AUTH_MICROSOFT_TENANT) | Microsoft tenant ID or `'common'` for multi-tenant. |
|
|
89
93
|
| [AUTH_VERIFY_JWT_EXPIRES_IN](Variable.AUTH_VERIFY_JWT_EXPIRES_IN) | Lifetime of email-verification JWTs. |
|
|
90
94
|
| [GITHUB_AUTH_CONFIG_ENTRIES](Variable.GITHUB_AUTH_CONFIG_ENTRIES) | Configuration entries required by GitHub OAuth authentication. |
|