@breadstone/archipel-mcp 0.0.8 → 0.0.9
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/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +7 -7
- package/data/packages/platform-authentication/api/{Class.AppleStrategy.md → Class.AppleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +6 -6
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +79 -0
- package/data/packages/platform-authentication/api/{Class.GoogleStrategy.md → Class.GoogleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.MfaService.md +11 -11
- package/data/packages/platform-authentication/api/{Class.MicrosoftStrategy.md → Class.MicrosoftConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +145 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +7 -7
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +47 -17
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +12 -12
- 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 +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +1 -1
- 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 +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.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/Variable.TOTP_MFA_PROVIDERS.md +30 -0
- package/data/packages/platform-authentication/api/index.md +7 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +5 -5
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +5 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +8 -8
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +5 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +7 -7
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -3
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +5 -5
- package/data/packages/platform-core/api/Class.HostService.md +8 -8
- package/data/packages/platform-core/api/Class.ResourceManager.md +19 -19
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -4
- package/data/packages/platform-core/api/Variable.APP_NAME.md +15 -0
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-core/api/index.md +2 -0
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +2 -2
- package/data/packages/platform-cryptography/api/Class.OtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +4 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +4 -4
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -4
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +1 -1
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +5 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +7 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +2 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +3 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +2 -2
- package/data/packages/platform-mailing/api/Class.MailService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_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:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L74)
|
|
14
14
|
|
|
15
15
|
Google OAuth2 client secret.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_SCOPE: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L80)
|
|
14
14
|
|
|
15
15
|
Comma-separated list of Google OAuth scopes (e.g. `'email,profile'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_EMAIL_CODE_TTL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L51)
|
|
14
14
|
|
|
15
15
|
Time-to-live for email OTP codes (e.g. `'10m'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_EMAIL_MIN_RESEND: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L54)
|
|
14
14
|
|
|
15
15
|
Minimum interval between email OTP resend requests (e.g. `'30s'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_ISSUER'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_ISSUER
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_ISSUER: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L34)
|
|
14
|
+
|
|
15
|
+
Issuer name shown in authenticator apps for TOTP MFA.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_PUSH_CODE_TTL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L61)
|
|
14
14
|
|
|
15
15
|
Time-to-live for push OTP codes (e.g. `'10m'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_PUSH_MIN_RESEND: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L64)
|
|
14
14
|
|
|
15
15
|
Minimum interval between push OTP resend requests (e.g. `'30s'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_SMS_CODE_TTL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L41)
|
|
14
14
|
|
|
15
15
|
Time-to-live for SMS OTP codes (e.g. `'10m'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_SMS_MIN_RESEND: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L44)
|
|
14
14
|
|
|
15
15
|
Minimum interval between SMS resend requests (e.g. `'30s'`).
|
|
@@ -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:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L93)
|
|
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:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L87)
|
|
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:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L90)
|
|
14
14
|
|
|
15
15
|
Microsoft OAuth2 client secret.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MICROSOFT_SCOPE: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L99)
|
|
14
14
|
|
|
15
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:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L96)
|
|
14
14
|
|
|
15
15
|
Microsoft tenant ID or `'common'` for multi-tenant.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const GITHUB_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/github/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/github/env.ts#L9)
|
|
13
|
+
Defined in: [libs/platform-authentication/src/connectors/github/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/github/env.ts#L9)
|
|
14
14
|
|
|
15
15
|
Configuration entries required by GitHub OAuth authentication.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const GOOGLE_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/google/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/google/env.ts#L9)
|
|
13
|
+
Defined in: [libs/platform-authentication/src/connectors/google/env.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/google/env.ts#L9)
|
|
14
14
|
|
|
15
15
|
Configuration entries required by Google OAuth authentication.
|
|
@@ -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:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/microsoft/env.ts#L15)
|
|
13
|
+
Defined in: [libs/platform-authentication/src/connectors/microsoft/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/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:151](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L151)
|
|
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:144](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L144)
|
|
14
14
|
|
|
15
15
|
Username used for the anonymous seed user.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: TOTP\_MFA\_PROVIDERS'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: TOTP_MFA_PROVIDERS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const TOTP_MFA_PROVIDERS: ReadonlyArray<Provider>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/mfa/totp/index.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/totp/index.ts#L27)
|
|
14
|
+
|
|
15
|
+
Providers required by the [TotpMfaChannel](Class.TotpMfaChannel).
|
|
16
|
+
|
|
17
|
+
Spread these into the `additionalProviders` option of `AuthModule.register()`
|
|
18
|
+
when enabling TOTP-based MFA.
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { TotpMfaChannel, TOTP_MFA_PROVIDERS } from '@breadstone/archipel-platform-authentication/mfa/totp';
|
|
24
|
+
|
|
25
|
+
AuthModule.register({
|
|
26
|
+
mfaChannels: [TotpMfaChannel],
|
|
27
|
+
additionalProviders: [...TOTP_MFA_PROVIDERS],
|
|
28
|
+
// ...
|
|
29
|
+
});
|
|
30
|
+
```
|
|
@@ -11,21 +11,21 @@ editUrl: false
|
|
|
11
11
|
| Class | Description |
|
|
12
12
|
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
13
|
| [AnonymousAuthGuard](Class.AnonymousAuthGuard) | The `AnonymousAuthGuard` protects routes using anonymous authentication. |
|
|
14
|
-
| [
|
|
14
|
+
| [AppleConnector](Class.AppleConnector) | The `AppleConnector` integrates Apple Sign In authentication. |
|
|
15
15
|
| [AuthModule](Class.AuthModule) | The `AuthModule` handles JWT-based authentication, including token creation and validation. |
|
|
16
16
|
| [AuthSubjectPort](Class.AuthSubjectPort) | Abstract port for resolving authentication subjects by identity. Used by the JWT, Local, and Anonymous strategies. |
|
|
17
17
|
| [AuthTokenService](Class.AuthTokenService) | Generic service responsible for creating JWT access tokens. Builds a base payload from [IAuthSubject](Interface.IAuthSubject) and optionally enriches it via the [TokenEnricherPort](Class.TokenEnricherPort) with product-specific claims. |
|
|
18
18
|
| [ChallengeService](Class.ChallengeService) | Stores and validates MFA login challenges. |
|
|
19
19
|
| [GithubAuthGuard](Class.GithubAuthGuard) | The `GithubAuthGuard` protects routes using GitHub authentication. |
|
|
20
|
-
| [
|
|
21
|
-
| [
|
|
20
|
+
| [GithubConnector](Class.GithubConnector) | - |
|
|
21
|
+
| [GoogleConnector](Class.GoogleConnector) | The `GoogleConnector` integrates Google OAuth authentication. |
|
|
22
22
|
| [JwtAuthGuard](Class.JwtAuthGuard) | The `JwtAuthGuard` protects routes using JWT-based authentication. |
|
|
23
23
|
| [JwtPayloadBase](Class.JwtPayloadBase) | Abstract base class for JWT payloads. Products extend this to add their own claims (e.g. `profileId`, `isPro`). Used as both a serialization contract and NestJS injection token. |
|
|
24
24
|
| [LastActiveMiddleware](Class.LastActiveMiddleware) | Middleware to automatically update the lastActive timestamp for authenticated sessions. Extracts the JWT token from the Authorization header and updates the session asynchronously. |
|
|
25
25
|
| [LocalAuthGuard](Class.LocalAuthGuard) | The `LocalAuthGuard` protects routes using local authentication. |
|
|
26
26
|
| [MfaService](Class.MfaService) | Orchestrates MFA channels, backup codes, and user preferences. |
|
|
27
27
|
| [MfaSubjectPort](Class.MfaSubjectPort) | Abstract port for reading and writing MFA state on the underlying subject entity. Used by the MfaService and all MFA channel implementations. |
|
|
28
|
-
| [
|
|
28
|
+
| [MicrosoftConnector](Class.MicrosoftConnector) | The `MicrosoftConnector` integrates Microsoft OAuth authentication. |
|
|
29
29
|
| [RolesGuard](Class.RolesGuard) | - |
|
|
30
30
|
| [SessionMappingProfile](Class.SessionMappingProfile) | Mapping profile for Session entity to response transformations. |
|
|
31
31
|
| [SessionPersistencePort](Class.SessionPersistencePort) | Abstract port for persisting and querying sessions. Used by the SessionService and LastActiveMiddleware. |
|
|
@@ -34,6 +34,7 @@ editUrl: false
|
|
|
34
34
|
| [SocialAuthGuard](Class.SocialAuthGuard) | - |
|
|
35
35
|
| [SocialAuthPort](Class.SocialAuthPort) | Abstract port for resolving or creating subjects from social / OAuth profiles. Used by all social strategies (GitHub, Google, Microsoft, Apple). |
|
|
36
36
|
| [TokenEnricherPort](Class.TokenEnricherPort) | Abstract port for enriching JWT claims with product-specific data. This is an optional port: when not provided, the token contains only base claims. |
|
|
37
|
+
| [TotpMfaChannel](Class.TotpMfaChannel) | - |
|
|
37
38
|
| [VerificationService](Class.VerificationService) | Manages email / PIN verification tokens via the [VerificationSubjectPort](Class.VerificationSubjectPort). |
|
|
38
39
|
| [VerificationSubjectPort](Class.VerificationSubjectPort) | Abstract port for verifiable subject persistence. Used by the VerificationService to manage email/PIN verification. |
|
|
39
40
|
|
|
@@ -80,6 +81,7 @@ editUrl: false
|
|
|
80
81
|
| [AUTH_MFA_EMAIL_CODE_TTL](Variable.AUTH_MFA_EMAIL_CODE_TTL) | Time-to-live for email OTP codes (e.g. `'10m'`). |
|
|
81
82
|
| [AUTH_MFA_EMAIL_MIN_RESEND](Variable.AUTH_MFA_EMAIL_MIN_RESEND) | Minimum interval between email OTP resend requests (e.g. `'30s'`). |
|
|
82
83
|
| [AUTH_MFA_ENCRYPTION_KEY](Variable.AUTH_MFA_ENCRYPTION_KEY) | AES encryption key used to encrypt MFA secrets at rest. |
|
|
84
|
+
| [AUTH_MFA_ISSUER](Variable.AUTH_MFA_ISSUER) | Issuer name shown in authenticator apps for TOTP MFA. |
|
|
83
85
|
| [AUTH_MFA_MAX_ATTEMPTS](Variable.AUTH_MFA_MAX_ATTEMPTS) | Maximum number of failed MFA attempts before lockout. |
|
|
84
86
|
| [AUTH_MFA_PUSH_CODE_TTL](Variable.AUTH_MFA_PUSH_CODE_TTL) | Time-to-live for push OTP codes (e.g. `'10m'`). |
|
|
85
87
|
| [AUTH_MFA_PUSH_MIN_RESEND](Variable.AUTH_MFA_PUSH_MIN_RESEND) | Minimum interval between push OTP resend requests (e.g. `'30s'`). |
|
|
@@ -99,6 +101,7 @@ editUrl: false
|
|
|
99
101
|
| [SEED_ANONYMOUS_USERNAME](Variable.SEED_ANONYMOUS_USERNAME) | Username used for the anonymous seed user. |
|
|
100
102
|
| [SESSION_LIST_MAPPING_KEY](Variable.SESSION_LIST_MAPPING_KEY) | Type-safe mapping key for Session entity list to response list transformation. |
|
|
101
103
|
| [SESSION_MAPPING_KEY](Variable.SESSION_MAPPING_KEY) | Type-safe mapping key for Session entity to response transformation. |
|
|
104
|
+
| [TOTP_MFA_PROVIDERS](Variable.TOTP_MFA_PROVIDERS) | Providers required by the [TotpMfaChannel](Class.TotpMfaChannel). |
|
|
102
105
|
| [User](Variable.User) | Represents the `User` decorator. |
|
|
103
106
|
|
|
104
107
|
## Functions
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: BlobModule
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L98)
|
|
10
10
|
|
|
11
11
|
NestJS module responsible for providing blob storage services.
|
|
12
12
|
|
|
@@ -30,7 +30,7 @@ new BlobModule(): BlobModule;
|
|
|
30
30
|
static forRoot(options?): DynamicModule;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [BlobModule.ts:
|
|
33
|
+
Defined in: [BlobModule.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L109)
|
|
34
34
|
|
|
35
35
|
Configures the module with the specified options.
|
|
36
36
|
When `objectPersistence` / `variantPersistence` are provided the
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IAwsS3BlobProviderRegistration
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L53)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [BlobModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
16
16
|
kind: 'aws-s3';
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [BlobModule.ts:
|
|
19
|
+
Defined in: [BlobModule.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L54)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,4 +26,4 @@ Defined in: [BlobModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
26
26
|
optional options?: Partial<IAwsS3ProviderOptions>;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [BlobModule.ts:
|
|
29
|
+
Defined in: [BlobModule.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L55)
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IAzureBlobProviderRegistration
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L48)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [BlobModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
16
16
|
kind: 'azure';
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [BlobModule.ts:
|
|
19
|
+
Defined in: [BlobModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L49)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,4 +26,4 @@ Defined in: [BlobModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
26
26
|
optional options?: Partial<IAzureBlobProviderOptions>;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [BlobModule.ts:
|
|
29
|
+
Defined in: [BlobModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L50)
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IBlobModuleOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L36)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [BlobModule.ts:27](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
16
16
|
optional isGlobal?: boolean;
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [BlobModule.ts:
|
|
19
|
+
Defined in: [BlobModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L40)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Defined in: [BlobModule.ts:31](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
26
26
|
optional objectPersistence?: Type<BlobObjectPersistencePort>;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [BlobModule.ts:
|
|
29
|
+
Defined in: [BlobModule.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L38)
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Defined in: [BlobModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
36
36
|
optional provider?: IBlobProviderRegistration;
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Defined in: [BlobModule.ts:
|
|
39
|
+
Defined in: [BlobModule.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L37)
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
@@ -46,4 +46,4 @@ Defined in: [BlobModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
46
46
|
optional variantPersistence?: Type<BlobVariantPersistencePort>;
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Defined in: [BlobModule.ts:
|
|
49
|
+
Defined in: [BlobModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L39)
|
package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md
CHANGED
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: ICustomBlobProviderRegistration
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L58)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [BlobModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
16
16
|
kind: 'custom';
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [BlobModule.ts:
|
|
19
|
+
Defined in: [BlobModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L59)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,4 +26,4 @@ Defined in: [BlobModule.ts:50](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
26
26
|
useClass: Type<IBlobProvider>;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [BlobModule.ts:
|
|
29
|
+
Defined in: [BlobModule.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L60)
|
package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md
CHANGED
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IVercelBlobProviderRegistration
|
|
8
8
|
|
|
9
|
-
Defined in: [BlobModule.ts:
|
|
9
|
+
Defined in: [BlobModule.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L43)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
16
16
|
kind: 'vercel';
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [BlobModule.ts:
|
|
19
|
+
Defined in: [BlobModule.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L44)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,4 +26,4 @@ Defined in: [BlobModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main
|
|
|
26
26
|
optional options?: Partial<IVercelBlobProviderOptions>;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [BlobModule.ts:
|
|
29
|
+
Defined in: [BlobModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L45)
|
|
@@ -14,4 +14,4 @@ type IBlobProviderRegistration =
|
|
|
14
14
|
| ICustomBlobProviderRegistration;
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [BlobModule.ts:
|
|
17
|
+
Defined in: [BlobModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L63)
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: MemoryLayeredCache\<TKey, TValue\>
|
|
8
8
|
|
|
9
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
9
|
+
Defined in: [MemoryLayeredCache.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L72)
|
|
10
10
|
|
|
11
11
|
In-memory layered cache with LRU eviction, TTL expiration and
|
|
12
12
|
optional stale-while-revalidate support. Falls back to an
|
|
@@ -31,7 +31,7 @@ asynchronous loader function on cache misses.
|
|
|
31
31
|
new MemoryLayeredCache<TKey, TValue>(loadFn, options?): MemoryLayeredCache<TKey, TValue>;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
34
|
+
Defined in: [MemoryLayeredCache.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L97)
|
|
35
35
|
|
|
36
36
|
Initializes a new instance of the MemoryLayeredCache class.
|
|
37
37
|
|
|
@@ -54,7 +54,7 @@ Initializes a new instance of the MemoryLayeredCache class.
|
|
|
54
54
|
get(key): TValue | undefined;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
57
|
+
Defined in: [MemoryLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L109)
|
|
58
58
|
|
|
59
59
|
Retrieves a value from the cache synchronously.
|
|
60
60
|
|
|
@@ -82,7 +82,7 @@ The cached value or `undefined` on a miss.
|
|
|
82
82
|
getAsync(key): Promise<TValue | undefined>;
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
85
|
+
Defined in: [MemoryLayeredCache.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L130)
|
|
86
86
|
|
|
87
87
|
Retrieves a value from the cache asynchronously.
|
|
88
88
|
|
|
@@ -110,7 +110,7 @@ A promise resolving to the cached value or `undefined` on a miss.
|
|
|
110
110
|
invalidate(key): void;
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
113
|
+
Defined in: [MemoryLayeredCache.ts:174](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L174)
|
|
114
114
|
|
|
115
115
|
Invalidates a key in the cache synchronously.
|
|
116
116
|
|
|
@@ -136,7 +136,7 @@ Invalidates a key in the cache synchronously.
|
|
|
136
136
|
invalidateAsync(key): Promise<void>;
|
|
137
137
|
```
|
|
138
138
|
|
|
139
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
139
|
+
Defined in: [MemoryLayeredCache.ts:179](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L179)
|
|
140
140
|
|
|
141
141
|
Invalidates a key in the cache asynchronously.
|
|
142
142
|
|
|
@@ -162,7 +162,7 @@ Invalidates a key in the cache asynchronously.
|
|
|
162
162
|
set(key, value): void;
|
|
163
163
|
```
|
|
164
164
|
|
|
165
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
165
|
+
Defined in: [MemoryLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L152)
|
|
166
166
|
|
|
167
167
|
Stores a value in the cache synchronously.
|
|
168
168
|
|
|
@@ -189,7 +189,7 @@ Stores a value in the cache synchronously.
|
|
|
189
189
|
setAsync(key, value): Promise<void>;
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
192
|
+
Defined in: [MemoryLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L160)
|
|
193
193
|
|
|
194
194
|
Stores a value in the cache asynchronously.
|
|
195
195
|
|
|
@@ -216,7 +216,7 @@ Stores a value in the cache asynchronously.
|
|
|
216
216
|
stats(): ICacheStats;
|
|
217
217
|
```
|
|
218
218
|
|
|
219
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
219
|
+
Defined in: [MemoryLayeredCache.ts:184](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L184)
|
|
220
220
|
|
|
221
221
|
Returns current cache statistics.
|
|
222
222
|
|
|
@@ -238,7 +238,7 @@ The cache statistics snapshot.
|
|
|
238
238
|
warm(key): Promise<TValue | undefined>;
|
|
239
239
|
```
|
|
240
240
|
|
|
241
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
241
|
+
Defined in: [MemoryLayeredCache.ts:168](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L168)
|
|
242
242
|
|
|
243
243
|
Proactively warms the cache for a given key.
|
|
244
244
|
|
|
@@ -35,7 +35,7 @@ new NoopCacheMetricsRecorder(): NoopCacheMetricsRecorder;
|
|
|
35
35
|
optional recordEviction(_cache): void;
|
|
36
36
|
```
|
|
37
37
|
|
|
38
|
-
Defined in: [NoopCacheMetricsRecorder.ts:
|
|
38
|
+
Defined in: [NoopCacheMetricsRecorder.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L37)
|
|
39
39
|
|
|
40
40
|
Records a cache eviction.
|
|
41
41
|
|
|
@@ -61,7 +61,7 @@ Records a cache eviction.
|
|
|
61
61
|
recordHit(_cache): void;
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
Defined in: [NoopCacheMetricsRecorder.ts:
|
|
64
|
+
Defined in: [NoopCacheMetricsRecorder.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L17)
|
|
65
65
|
|
|
66
66
|
Records a cache hit.
|
|
67
67
|
|
|
@@ -87,7 +87,7 @@ Records a cache hit.
|
|
|
87
87
|
recordLoadError(_cache): void;
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
Defined in: [NoopCacheMetricsRecorder.ts:
|
|
90
|
+
Defined in: [NoopCacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L32)
|
|
91
91
|
|
|
92
92
|
Records a failed cache load.
|
|
93
93
|
|
|
@@ -113,7 +113,7 @@ Records a failed cache load.
|
|
|
113
113
|
recordLoadSuccess(_cache): void;
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
Defined in: [NoopCacheMetricsRecorder.ts:
|
|
116
|
+
Defined in: [NoopCacheMetricsRecorder.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L27)
|
|
117
117
|
|
|
118
118
|
Records a successful cache load.
|
|
119
119
|
|
|
@@ -139,7 +139,7 @@ Records a successful cache load.
|
|
|
139
139
|
recordMiss(_cache): void;
|
|
140
140
|
```
|
|
141
141
|
|
|
142
|
-
Defined in: [NoopCacheMetricsRecorder.ts:
|
|
142
|
+
Defined in: [NoopCacheMetricsRecorder.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/NoopCacheMetricsRecorder.ts#L22)
|
|
143
143
|
|
|
144
144
|
Records a cache miss.
|
|
145
145
|
|