@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
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: RedisLayeredCache\<TKey, TValue\>
|
|
8
8
|
|
|
9
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
9
|
+
Defined in: [redis/RedisLayeredCache.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L83)
|
|
10
10
|
|
|
11
11
|
Redis-backed layered cache implementation. Falls back to an asynchronous
|
|
12
12
|
loader function when the requested key is not present in Redis.
|
|
@@ -36,7 +36,7 @@ is inherently asynchronous. Use the `*Async` variants instead.
|
|
|
36
36
|
new RedisLayeredCache<TKey, TValue>(loadFn, options): RedisLayeredCache<TKey, TValue>;
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
39
|
+
Defined in: [redis/RedisLayeredCache.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L107)
|
|
40
40
|
|
|
41
41
|
Initializes a new instance of the RedisLayeredCache class.
|
|
42
42
|
|
|
@@ -59,7 +59,7 @@ Initializes a new instance of the RedisLayeredCache class.
|
|
|
59
59
|
get(key): TValue | undefined;
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
62
|
+
Defined in: [redis/RedisLayeredCache.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L124)
|
|
63
63
|
|
|
64
64
|
Not supported — Redis is inherently asynchronous.
|
|
65
65
|
|
|
@@ -89,7 +89,7 @@ Always throws. Use [getAsync](#getasync) instead.
|
|
|
89
89
|
getAsync(key): Promise<TValue | undefined>;
|
|
90
90
|
```
|
|
91
91
|
|
|
92
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
92
|
+
Defined in: [redis/RedisLayeredCache.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L129)
|
|
93
93
|
|
|
94
94
|
Retrieves a value from the cache asynchronously.
|
|
95
95
|
|
|
@@ -117,7 +117,7 @@ A promise resolving to the cached value or `undefined` on a miss.
|
|
|
117
117
|
invalidate(key): void;
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
120
|
+
Defined in: [redis/RedisLayeredCache.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L186)
|
|
121
121
|
|
|
122
122
|
Not supported — Redis is inherently asynchronous.
|
|
123
123
|
|
|
@@ -195,7 +195,7 @@ OnModuleDestroy.onModuleDestroy;
|
|
|
195
195
|
set(key, value): void;
|
|
196
196
|
```
|
|
197
197
|
|
|
198
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
198
|
+
Defined in: [redis/RedisLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L160)
|
|
199
199
|
|
|
200
200
|
Not supported — Redis is inherently asynchronous.
|
|
201
201
|
|
|
@@ -226,7 +226,7 @@ Always throws. Use [setAsync](#setasync) instead.
|
|
|
226
226
|
setAsync(key, value): Promise<void>;
|
|
227
227
|
```
|
|
228
228
|
|
|
229
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
229
|
+
Defined in: [redis/RedisLayeredCache.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L165)
|
|
230
230
|
|
|
231
231
|
Stores a value in the cache asynchronously.
|
|
232
232
|
|
|
@@ -275,7 +275,7 @@ The cache statistics snapshot.
|
|
|
275
275
|
warm(key): Promise<TValue | undefined>;
|
|
276
276
|
```
|
|
277
277
|
|
|
278
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
278
|
+
Defined in: [redis/RedisLayeredCache.ts:177](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L177)
|
|
279
279
|
|
|
280
280
|
Proactively warms the cache for a given key.
|
|
281
281
|
|
|
@@ -19,7 +19,7 @@ measurements to Prometheus, OpenTelemetry, or any other backend.
|
|
|
19
19
|
optional recordEviction(cache): void;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [ICacheMetricsRecorder.ts:
|
|
22
|
+
Defined in: [ICacheMetricsRecorder.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L48)
|
|
23
23
|
|
|
24
24
|
Records a cache eviction.
|
|
25
25
|
|
|
@@ -41,7 +41,7 @@ Records a cache eviction.
|
|
|
41
41
|
recordHit(cache): void;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [ICacheMetricsRecorder.ts:
|
|
44
|
+
Defined in: [ICacheMetricsRecorder.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L16)
|
|
45
45
|
|
|
46
46
|
Records a cache hit.
|
|
47
47
|
|
|
@@ -63,7 +63,7 @@ Records a cache hit.
|
|
|
63
63
|
recordLoadError(cache): void;
|
|
64
64
|
```
|
|
65
65
|
|
|
66
|
-
Defined in: [ICacheMetricsRecorder.ts:
|
|
66
|
+
Defined in: [ICacheMetricsRecorder.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L40)
|
|
67
67
|
|
|
68
68
|
Records a failed cache load.
|
|
69
69
|
|
|
@@ -85,7 +85,7 @@ Records a failed cache load.
|
|
|
85
85
|
recordLoadSuccess(cache): void;
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
Defined in: [ICacheMetricsRecorder.ts:
|
|
88
|
+
Defined in: [ICacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L32)
|
|
89
89
|
|
|
90
90
|
Records a successful cache load.
|
|
91
91
|
|
|
@@ -107,7 +107,7 @@ Records a successful cache load.
|
|
|
107
107
|
recordMiss(cache): void;
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
Defined in: [ICacheMetricsRecorder.ts:
|
|
110
|
+
Defined in: [ICacheMetricsRecorder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheMetricsRecorder.ts#L24)
|
|
111
111
|
|
|
112
112
|
Records a cache miss.
|
|
113
113
|
|
|
@@ -18,7 +18,7 @@ Cache statistics snapshot returned by cache implementations.
|
|
|
18
18
|
optional evictions?: number;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [ICacheStats.ts:
|
|
21
|
+
Defined in: [ICacheStats.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L42)
|
|
22
22
|
|
|
23
23
|
Number of cache evictions (if supported).
|
|
24
24
|
|
|
@@ -30,7 +30,7 @@ Number of cache evictions (if supported).
|
|
|
30
30
|
hits: number;
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [ICacheStats.ts:
|
|
33
|
+
Defined in: [ICacheStats.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L14)
|
|
34
34
|
|
|
35
35
|
Number of cache hits.
|
|
36
36
|
|
|
@@ -42,7 +42,7 @@ Number of cache hits.
|
|
|
42
42
|
loadErrors: number;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [ICacheStats.ts:
|
|
45
|
+
Defined in: [ICacheStats.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L35)
|
|
46
46
|
|
|
47
47
|
Number of failed cache loads.
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ Number of failed cache loads.
|
|
|
54
54
|
loads: number;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [ICacheStats.ts:
|
|
57
|
+
Defined in: [ICacheStats.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L28)
|
|
58
58
|
|
|
59
59
|
Number of successful cache loads.
|
|
60
60
|
|
|
@@ -66,6 +66,6 @@ Number of successful cache loads.
|
|
|
66
66
|
misses: number;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [ICacheStats.ts:
|
|
69
|
+
Defined in: [ICacheStats.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ICacheStats.ts#L21)
|
|
70
70
|
|
|
71
71
|
Number of cache misses.
|
|
@@ -26,7 +26,7 @@ access patterns with optional warm-up and statistics.
|
|
|
26
26
|
get(key): TValue | undefined;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [ILayeredCache.ts:
|
|
29
|
+
Defined in: [ILayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L25)
|
|
30
30
|
|
|
31
31
|
Retrieves a value from the cache synchronously.
|
|
32
32
|
|
|
@@ -50,7 +50,7 @@ The cached value or `undefined` on a miss.
|
|
|
50
50
|
getAsync(key): Promise<TValue | undefined>;
|
|
51
51
|
```
|
|
52
52
|
|
|
53
|
-
Defined in: [ILayeredCache.ts:
|
|
53
|
+
Defined in: [ILayeredCache.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L34)
|
|
54
54
|
|
|
55
55
|
Retrieves a value from the cache asynchronously.
|
|
56
56
|
|
|
@@ -74,7 +74,7 @@ A promise resolving to the cached value or `undefined` on a miss.
|
|
|
74
74
|
invalidate(key): void;
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
Defined in: [ILayeredCache.ts:
|
|
77
|
+
Defined in: [ILayeredCache.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L69)
|
|
78
78
|
|
|
79
79
|
Invalidates a key in the cache synchronously.
|
|
80
80
|
|
|
@@ -96,7 +96,7 @@ Invalidates a key in the cache synchronously.
|
|
|
96
96
|
invalidateAsync(key): Promise<void>;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [ILayeredCache.ts:
|
|
99
|
+
Defined in: [ILayeredCache.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L77)
|
|
100
100
|
|
|
101
101
|
Invalidates a key in the cache asynchronously.
|
|
102
102
|
|
|
@@ -118,7 +118,7 @@ Invalidates a key in the cache asynchronously.
|
|
|
118
118
|
set(key, value): void;
|
|
119
119
|
```
|
|
120
120
|
|
|
121
|
-
Defined in: [ILayeredCache.ts:
|
|
121
|
+
Defined in: [ILayeredCache.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L43)
|
|
122
122
|
|
|
123
123
|
Stores a value in the cache synchronously.
|
|
124
124
|
|
|
@@ -141,7 +141,7 @@ Stores a value in the cache synchronously.
|
|
|
141
141
|
setAsync(key, value): Promise<void>;
|
|
142
142
|
```
|
|
143
143
|
|
|
144
|
-
Defined in: [ILayeredCache.ts:
|
|
144
|
+
Defined in: [ILayeredCache.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L52)
|
|
145
145
|
|
|
146
146
|
Stores a value in the cache asynchronously.
|
|
147
147
|
|
|
@@ -164,7 +164,7 @@ Stores a value in the cache asynchronously.
|
|
|
164
164
|
optional stats(): ICacheStats;
|
|
165
165
|
```
|
|
166
166
|
|
|
167
|
-
Defined in: [ILayeredCache.ts:
|
|
167
|
+
Defined in: [ILayeredCache.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L85)
|
|
168
168
|
|
|
169
169
|
Returns current cache statistics.
|
|
170
170
|
|
|
@@ -182,7 +182,7 @@ The cache statistics snapshot.
|
|
|
182
182
|
optional warm(key): Promise<TValue | undefined>;
|
|
183
183
|
```
|
|
184
184
|
|
|
185
|
-
Defined in: [ILayeredCache.ts:
|
|
185
|
+
Defined in: [ILayeredCache.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/ILayeredCache.ts#L61)
|
|
186
186
|
|
|
187
187
|
Proactively warms the cache for a given key.
|
|
188
188
|
|
|
@@ -18,7 +18,7 @@ Configuration options for [MemoryLayeredCache](Class.MemoryLayeredCache).
|
|
|
18
18
|
optional cacheName?: string;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
21
|
+
Defined in: [MemoryLayeredCache.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L57)
|
|
22
22
|
|
|
23
23
|
An optional name / label for the cache instance, used in metrics.
|
|
24
24
|
Defaults to `'memory'`.
|
|
@@ -31,7 +31,7 @@ Defaults to `'memory'`.
|
|
|
31
31
|
optional maxEntries?: number;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
34
|
+
Defined in: [MemoryLayeredCache.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L41)
|
|
35
35
|
|
|
36
36
|
Maximum number of entries retained in the cache. Oldest entries are
|
|
37
37
|
evicted first (LRU). Defaults to infinite.
|
|
@@ -44,7 +44,7 @@ evicted first (LRU). Defaults to infinite.
|
|
|
44
44
|
optional metricsRecorder?: ICacheMetricsRecorder;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
47
|
+
Defined in: [MemoryLayeredCache.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L49)
|
|
48
48
|
|
|
49
49
|
Optional metrics recorder forwarded cache operation statistics.
|
|
50
50
|
Falls back to [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) when omitted.
|
|
@@ -57,7 +57,7 @@ Falls back to [NoopCacheMetricsRecorder](Class.NoopCacheMetricsRecorder) when om
|
|
|
57
57
|
optional staleWhileRevalidate?: boolean;
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
60
|
+
Defined in: [MemoryLayeredCache.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L33)
|
|
61
61
|
|
|
62
62
|
When `true`, expired entries are served immediately while a background
|
|
63
63
|
refresh is triggered. Defaults to `false`.
|
|
@@ -70,7 +70,7 @@ refresh is triggered. Defaults to `false`.
|
|
|
70
70
|
optional ttlMs?: number;
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
Defined in: [MemoryLayeredCache.ts:
|
|
73
|
+
Defined in: [MemoryLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L25)
|
|
74
74
|
|
|
75
75
|
Time to live in milliseconds. Entries older than this are considered expired.
|
|
76
76
|
Defaults to infinite (no expiration).
|
|
@@ -24,7 +24,7 @@ Configuration options for [RedisLayeredCache](Class.RedisLayeredCache).
|
|
|
24
24
|
optional cacheName?: string;
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
27
|
+
Defined in: [redis/RedisLayeredCache.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L67)
|
|
28
28
|
|
|
29
29
|
An optional name / label for the cache instance, used in metrics.
|
|
30
30
|
Defaults to `'redis'`.
|
|
@@ -37,7 +37,7 @@ Defaults to `'redis'`.
|
|
|
37
37
|
optional deserialize?: (raw) => TValue;
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
40
|
+
Defined in: [redis/RedisLayeredCache.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L52)
|
|
41
41
|
|
|
42
42
|
Custom deserialization function. Defaults to `JSON.parse`.
|
|
43
43
|
|
|
@@ -59,7 +59,7 @@ Custom deserialization function. Defaults to `JSON.parse`.
|
|
|
59
59
|
keyPrefix: string;
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
62
|
+
Defined in: [redis/RedisLayeredCache.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L31)
|
|
63
63
|
|
|
64
64
|
Key prefix applied to all Redis keys managed by this cache instance.
|
|
65
65
|
|
|
@@ -71,7 +71,7 @@ Key prefix applied to all Redis keys managed by this cache instance.
|
|
|
71
71
|
optional metricsRecorder?: ICacheMetricsRecorder;
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
74
|
+
Defined in: [redis/RedisLayeredCache.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L59)
|
|
75
75
|
|
|
76
76
|
Optional metrics recorder forwarded cache operation statistics.
|
|
77
77
|
|
|
@@ -83,7 +83,7 @@ Optional metrics recorder forwarded cache operation statistics.
|
|
|
83
83
|
optional serialize?: (value) => string;
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
86
|
+
Defined in: [redis/RedisLayeredCache.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L45)
|
|
87
87
|
|
|
88
88
|
Custom serialization function. Defaults to `JSON.stringify`.
|
|
89
89
|
|
|
@@ -105,7 +105,7 @@ Custom serialization function. Defaults to `JSON.stringify`.
|
|
|
105
105
|
optional ttlSeconds?: number;
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
108
|
+
Defined in: [redis/RedisLayeredCache.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L38)
|
|
109
109
|
|
|
110
110
|
Optional TTL in seconds applied to every stored entry.
|
|
111
111
|
|
|
@@ -117,6 +117,6 @@ Optional TTL in seconds applied to every stored entry.
|
|
|
117
117
|
url: string;
|
|
118
118
|
```
|
|
119
119
|
|
|
120
|
-
Defined in: [redis/RedisLayeredCache.ts:
|
|
120
|
+
Defined in: [redis/RedisLayeredCache.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/redis/RedisLayeredCache.ts#L24)
|
|
121
121
|
|
|
122
122
|
Redis connection URL (e.g. `redis://localhost:6379`).
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: AppHealthIndicator
|
|
8
8
|
|
|
9
|
-
Defined in: [terminus/AppHealthIndicator.ts:
|
|
9
|
+
Defined in: [terminus/AppHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L16)
|
|
10
10
|
|
|
11
11
|
Health indicator for the application.
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Health indicator for the application.
|
|
|
18
18
|
new AppHealthIndicator(configService): AppHealthIndicator;
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
Defined in: [terminus/AppHealthIndicator.ts:
|
|
21
|
+
Defined in: [terminus/AppHealthIndicator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L31)
|
|
22
22
|
|
|
23
23
|
Constructs a new instance of the `AppHealthIndicator` class.
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Constructs a new instance of the `AppHealthIndicator` class.
|
|
|
40
40
|
isHealthy(): HealthIndicatorResult<"app">;
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Defined in: [terminus/AppHealthIndicator.ts:
|
|
43
|
+
Defined in: [terminus/AppHealthIndicator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L47)
|
|
44
44
|
|
|
45
45
|
Checks if the Open Food Facts API is reachable.
|
|
46
46
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: ErrorTemplateService
|
|
8
8
|
|
|
9
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
9
|
+
Defined in: [services/ErrorTemplateService.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L82)
|
|
10
10
|
|
|
11
11
|
Service for rendering error page templates.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ new ErrorTemplateService(
|
|
|
21
21
|
resourceManager): ErrorTemplateService;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
24
|
+
Defined in: [services/ErrorTemplateService.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L99)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `ErrorTemplateService` class.
|
|
27
27
|
|
|
@@ -45,7 +45,7 @@ Constructs a new instance of the `ErrorTemplateService` class.
|
|
|
45
45
|
getErrorMessage(statusCode): string;
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
48
|
+
Defined in: [services/ErrorTemplateService.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L185)
|
|
49
49
|
|
|
50
50
|
Gets a human-readable error message based on status code.
|
|
51
51
|
|
|
@@ -69,7 +69,7 @@ The error message.
|
|
|
69
69
|
getErrorPageContent(params): Promise<string>;
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
72
|
+
Defined in: [services/ErrorTemplateService.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L120)
|
|
73
73
|
|
|
74
74
|
Retrieves the error page HTML content.
|
|
75
75
|
|
|
@@ -93,7 +93,7 @@ The rendered HTML content.
|
|
|
93
93
|
getErrorTitle(statusCode): string;
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
96
|
+
Defined in: [services/ErrorTemplateService.ts:156](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L156)
|
|
97
97
|
|
|
98
98
|
Gets a human-readable error title based on status code.
|
|
99
99
|
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: HostService
|
|
8
8
|
|
|
9
|
-
Defined in: [services/HostService.ts:
|
|
9
|
+
Defined in: [services/HostService.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L143)
|
|
10
10
|
|
|
11
11
|
The `HostService` class.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ new HostService(
|
|
|
21
21
|
resourceManager): HostService;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [services/HostService.ts:
|
|
24
|
+
Defined in: [services/HostService.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L160)
|
|
25
25
|
|
|
26
26
|
Constructs a new instance of the `HostService` class.
|
|
27
27
|
|
|
@@ -47,7 +47,7 @@ Constructs a new instance of the `HostService` class.
|
|
|
47
47
|
get host(): string;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: [services/HostService.ts:
|
|
50
|
+
Defined in: [services/HostService.ts:196](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L196)
|
|
51
51
|
|
|
52
52
|
The full host (URL + port in development).
|
|
53
53
|
|
|
@@ -65,7 +65,7 @@ The full host (URL + port in development).
|
|
|
65
65
|
get port(): number;
|
|
66
66
|
```
|
|
67
67
|
|
|
68
|
-
Defined in: [services/HostService.ts:
|
|
68
|
+
Defined in: [services/HostService.ts:186](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L186)
|
|
69
69
|
|
|
70
70
|
The port of the host.
|
|
71
71
|
|
|
@@ -83,7 +83,7 @@ The port of the host.
|
|
|
83
83
|
get stage(): "unknown" | "local" | "development" | "preview" | "production";
|
|
84
84
|
```
|
|
85
85
|
|
|
86
|
-
Defined in: [services/HostService.ts:
|
|
86
|
+
Defined in: [services/HostService.ts:208](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L208)
|
|
87
87
|
|
|
88
88
|
The current stage of the application.
|
|
89
89
|
|
|
@@ -101,7 +101,7 @@ The current stage of the application.
|
|
|
101
101
|
get url(): string;
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
Defined in: [services/HostService.ts:
|
|
104
|
+
Defined in: [services/HostService.ts:176](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L176)
|
|
105
105
|
|
|
106
106
|
The URL of the host.
|
|
107
107
|
|
|
@@ -119,7 +119,7 @@ The URL of the host.
|
|
|
119
119
|
get version(): string;
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
Defined in: [services/HostService.ts:
|
|
122
|
+
Defined in: [services/HostService.ts:229](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L229)
|
|
123
123
|
|
|
124
124
|
The application version.
|
|
125
125
|
|
|
@@ -135,7 +135,7 @@ The application version.
|
|
|
135
135
|
getHostContent(params): Promise<string>;
|
|
136
136
|
```
|
|
137
137
|
|
|
138
|
-
Defined in: [services/HostService.ts:
|
|
138
|
+
Defined in: [services/HostService.ts:241](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L241)
|
|
139
139
|
|
|
140
140
|
Retrieves the host content
|
|
141
141
|
|