@breadstone/archipel-mcp 0.0.7 → 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.
Files changed (181) hide show
  1. package/data/packages/index.md +13 -6
  2. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +7 -7
  3. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +7 -7
  4. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +7 -7
  5. package/data/packages/platform-authentication/api/{Class.AppleStrategy.md → Class.AppleConnector.md} +18 -12
  6. package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
  7. package/data/packages/platform-authentication/api/Class.ChallengeService.md +6 -6
  8. package/data/packages/platform-authentication/api/Class.GithubConnector.md +79 -0
  9. package/data/packages/platform-authentication/api/{Class.GoogleStrategy.md → Class.GoogleConnector.md} +18 -12
  10. package/data/packages/platform-authentication/api/Class.MfaService.md +11 -11
  11. package/data/packages/platform-authentication/api/{Class.MicrosoftStrategy.md → Class.MicrosoftConnector.md} +18 -12
  12. package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +145 -0
  13. package/data/packages/platform-authentication/api/Class.VerificationService.md +7 -7
  14. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +38 -8
  15. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +12 -12
  16. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +1 -1
  17. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +1 -1
  18. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +1 -1
  19. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +1 -1
  20. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +1 -1
  21. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +1 -1
  22. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +1 -1
  23. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +1 -1
  24. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +1 -1
  25. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +1 -1
  26. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +1 -1
  27. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +1 -1
  28. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +1 -1
  29. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +1 -1
  30. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +1 -1
  31. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +1 -1
  32. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +1 -1
  33. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +15 -0
  34. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +1 -1
  35. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +1 -1
  36. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +1 -1
  37. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +1 -1
  38. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +1 -1
  39. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +1 -1
  40. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +1 -1
  41. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +1 -1
  42. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
  43. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +1 -1
  44. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +1 -1
  45. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +1 -1
  46. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +1 -1
  47. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +1 -1
  48. package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +30 -0
  49. package/data/packages/platform-authentication/api/index.md +7 -4
  50. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
  51. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
  52. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
  53. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
  54. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
  55. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
  56. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
  57. package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
  58. package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
  59. package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
  60. package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
  61. package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
  62. package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
  63. package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
  64. package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
  65. package/data/packages/platform-caching/api/index.md +25 -0
  66. package/data/packages/platform-caching/index.md +116 -0
  67. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -3
  68. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +5 -5
  69. package/data/packages/platform-core/api/Class.HostService.md +8 -8
  70. package/data/packages/platform-core/api/Class.ResourceManager.md +19 -19
  71. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -10
  72. package/data/packages/platform-core/api/Interface.IHostContentParams.md +10 -10
  73. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -4
  74. package/data/packages/platform-core/api/Variable.APP_NAME.md +15 -0
  75. package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +15 -0
  76. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
  77. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -1
  78. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
  79. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
  80. package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -1
  81. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +1 -1
  82. package/data/packages/platform-core/api/index.md +106 -150
  83. package/data/packages/platform-core/index.md +5 -3
  84. package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
  85. package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
  86. package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
  87. package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
  88. package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
  89. package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
  90. package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
  91. package/data/packages/platform-cryptography/api/index.md +29 -0
  92. package/data/packages/platform-cryptography/index.md +132 -0
  93. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
  94. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
  95. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
  96. package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
  97. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
  98. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
  99. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
  100. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
  101. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
  102. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
  103. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
  104. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
  105. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
  106. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
  107. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
  108. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
  109. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
  110. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
  111. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
  112. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
  113. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
  114. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
  115. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
  116. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
  117. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
  118. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
  119. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
  120. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
  121. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
  122. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
  123. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
  124. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
  125. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
  126. package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
  127. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
  128. package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
  129. package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
  130. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
  131. package/data/packages/platform-intelligence/api/index.md +70 -0
  132. package/data/packages/platform-intelligence/index.md +131 -0
  133. package/data/packages/platform-mailing/api/Class.MailService.md +4 -4
  134. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +4 -4
  135. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
  136. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
  137. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
  138. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
  139. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
  140. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +1 -1
  141. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
  142. package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
  143. package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
  144. package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
  145. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
  146. package/package.json +1 -1
  147. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
  148. package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
  149. package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
  150. package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
  151. package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
  152. package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
  153. package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
  154. package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
  155. package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
  156. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
  157. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
  158. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
  159. package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
  160. package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
  161. package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
  162. package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
  163. package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
  164. package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
  165. package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
  166. package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
  167. package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
  168. package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
  169. package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
  170. package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
  171. package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
  172. package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
  173. package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
  174. package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
  175. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
  176. package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
  177. package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
  178. package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
  179. package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
  180. package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
  181. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
@@ -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:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L58)
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:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L61)
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:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L38)
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:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L41)
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:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L90)
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:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L84)
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:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L87)
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:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L96)
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:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L93)
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.
@@ -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:148](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L148)
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:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L141)
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
- | [AppleStrategy](Class.AppleStrategy) | The `AppleStrategy` integrates Apple Sign In authentication. |
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
- | [GithubStrategy](Class.GithubStrategy) | - |
21
- | [GoogleStrategy](Class.GoogleStrategy) | The `GoogleStrategy` integrates Google OAuth authentication. |
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
- | [MicrosoftStrategy](Class.MicrosoftStrategy) | The `MicrosoftStrategy` integrates Microsoft OAuth authentication. |
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:89](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L89)
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:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L100)
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:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L44)
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:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L45)
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:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L46)
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:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L39)
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:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L40)
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:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L41)
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:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L27)
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:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L31)
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](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L29)
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:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L28)
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:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L30)
49
+ Defined in: [BlobModule.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L39)
@@ -6,7 +6,7 @@ editUrl: false
6
6
 
7
7
  # Interface: ICustomBlobProviderRegistration
8
8
 
9
- Defined in: [BlobModule.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L49)
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:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L50)
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:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L51)
29
+ Defined in: [BlobModule.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L60)
@@ -6,7 +6,7 @@ editUrl: false
6
6
 
7
7
  # Interface: IVercelBlobProviderRegistration
8
8
 
9
- Defined in: [BlobModule.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L34)
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:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L35)
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:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L36)
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:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L54)
17
+ Defined in: [BlobModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-blob-storage/src/BlobModule.ts#L63)
@@ -6,9 +6,11 @@ editUrl: false
6
6
 
7
7
  # Class: MemoryLayeredCache\<TKey, TValue\>
8
8
 
9
- Defined in: [cache/MemoryLayeredCache.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L66)
9
+ Defined in: [MemoryLayeredCache.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L72)
10
10
 
11
- In-memory layered cache implementation.
11
+ In-memory layered cache with LRU eviction, TTL expiration and
12
+ optional stale-while-revalidate support. Falls back to an
13
+ asynchronous loader function on cache misses.
12
14
 
13
15
  ## Type Parameters
14
16
 
@@ -29,14 +31,16 @@ In-memory layered cache implementation.
29
31
  new MemoryLayeredCache<TKey, TValue>(loadFn, options?): MemoryLayeredCache<TKey, TValue>;
30
32
  ```
31
33
 
32
- Defined in: [cache/MemoryLayeredCache.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L87)
34
+ Defined in: [MemoryLayeredCache.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L97)
35
+
36
+ Initializes a new instance of the MemoryLayeredCache class.
33
37
 
34
38
  #### Parameters
35
39
 
36
- | Parameter | Type |
37
- | ---------- | -------------------------------------------------------- |
38
- | `loadFn` | (`key`) => `Promise`\<`TValue` \| `undefined`\> |
39
- | `options?` | [`ILayeredCacheOptions`](Interface.ILayeredCacheOptions) |
40
+ | Parameter | Type | Description |
41
+ | ---------- | -------------------------------------------------------- | ------------------------------------------------ |
42
+ | `loadFn` | (`key`) => `Promise`\<`TValue` \| `undefined`\> | Async loader invoked on cache misses. |
43
+ | `options?` | [`ILayeredCacheOptions`](Interface.ILayeredCacheOptions) | Optional configuration for TTL, LRU and metrics. |
40
44
 
41
45
  #### Returns
42
46
 
@@ -50,9 +54,9 @@ Defined in: [cache/MemoryLayeredCache.ts:87](https://github.com/RueDeRennes/arch
50
54
  get(key): TValue | undefined;
51
55
  ```
52
56
 
53
- Defined in: [cache/MemoryLayeredCache.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L107)
57
+ Defined in: [MemoryLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L109)
54
58
 
55
- Retrieves a value from the cache.
59
+ Retrieves a value from the cache synchronously.
56
60
 
57
61
  #### Parameters
58
62
 
@@ -64,6 +68,8 @@ Retrieves a value from the cache.
64
68
 
65
69
  `TValue` \| `undefined`
66
70
 
71
+ The cached value or `undefined` on a miss.
72
+
67
73
  #### Implementation of
68
74
 
69
75
  [`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
@@ -76,9 +82,9 @@ Retrieves a value from the cache.
76
82
  getAsync(key): Promise<TValue | undefined>;
77
83
  ```
78
84
 
79
- Defined in: [cache/MemoryLayeredCache.ts:133](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L133)
85
+ Defined in: [MemoryLayeredCache.ts:130](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L130)
80
86
 
81
- Retrieves a value from the cache (asynchronous).
87
+ Retrieves a value from the cache asynchronously.
82
88
 
83
89
  #### Parameters
84
90
 
@@ -90,6 +96,8 @@ Retrieves a value from the cache (asynchronous).
90
96
 
91
97
  `Promise`\<`TValue` \| `undefined`\>
92
98
 
99
+ A promise resolving to the cached value or `undefined` on a miss.
100
+
93
101
  #### Implementation of
94
102
 
95
103
  [`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
@@ -102,9 +110,9 @@ Retrieves a value from the cache (asynchronous).
102
110
  invalidate(key): void;
103
111
  ```
104
112
 
105
- Defined in: [cache/MemoryLayeredCache.ts:193](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L193)
113
+ Defined in: [MemoryLayeredCache.ts:174](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L174)
106
114
 
107
- Invalidates a key in the cache.
115
+ Invalidates a key in the cache synchronously.
108
116
 
109
117
  #### Parameters
110
118
 
@@ -128,9 +136,9 @@ Invalidates a key in the cache.
128
136
  invalidateAsync(key): Promise<void>;
129
137
  ```
130
138
 
131
- Defined in: [cache/MemoryLayeredCache.ts:203](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L203)
139
+ Defined in: [MemoryLayeredCache.ts:179](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L179)
132
140
 
133
- Invalidates a key in the cache (asynchronous).
141
+ Invalidates a key in the cache asynchronously.
134
142
 
135
143
  #### Parameters
136
144
 
@@ -154,16 +162,16 @@ Invalidates a key in the cache (asynchronous).
154
162
  set(key, value): void;
155
163
  ```
156
164
 
157
- Defined in: [cache/MemoryLayeredCache.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L161)
165
+ Defined in: [MemoryLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L152)
158
166
 
159
- Sets a value in the cache.
167
+ Stores a value in the cache synchronously.
160
168
 
161
169
  #### Parameters
162
170
 
163
- | Parameter | Type | Description |
164
- | --------- | -------- | ----------------- |
165
- | `key` | `TKey` | The key to set. |
166
- | `value` | `TValue` | The value to set. |
171
+ | Parameter | Type | Description |
172
+ | --------- | -------- | ------------------- |
173
+ | `key` | `TKey` | The key to store. |
174
+ | `value` | `TValue` | The value to store. |
167
175
 
168
176
  #### Returns
169
177
 
@@ -181,16 +189,16 @@ Sets a value in the cache.
181
189
  setAsync(key, value): Promise<void>;
182
190
  ```
183
191
 
184
- Defined in: [cache/MemoryLayeredCache.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L175)
192
+ Defined in: [MemoryLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L160)
185
193
 
186
- Sets a value in the cache (asynchronous).
194
+ Stores a value in the cache asynchronously.
187
195
 
188
196
  #### Parameters
189
197
 
190
- | Parameter | Type | Description |
191
- | --------- | -------- | ----------------- |
192
- | `key` | `TKey` | The key to set. |
193
- | `value` | `TValue` | The value to set. |
198
+ | Parameter | Type | Description |
199
+ | --------- | -------- | ------------------- |
200
+ | `key` | `TKey` | The key to store. |
201
+ | `value` | `TValue` | The value to store. |
194
202
 
195
203
  #### Returns
196
204
 
@@ -208,15 +216,15 @@ Sets a value in the cache (asynchronous).
208
216
  stats(): ICacheStats;
209
217
  ```
210
218
 
211
- Defined in: [cache/MemoryLayeredCache.ts:207](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L207)
219
+ Defined in: [MemoryLayeredCache.ts:184](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L184)
212
220
 
213
- Retrieves cache statistics.
221
+ Returns current cache statistics.
214
222
 
215
223
  #### Returns
216
224
 
217
225
  [`ICacheStats`](Interface.ICacheStats)
218
226
 
219
- The cache statistics.
227
+ The cache statistics snapshot.
220
228
 
221
229
  #### Implementation of
222
230
 
@@ -230,9 +238,9 @@ The cache statistics.
230
238
  warm(key): Promise<TValue | undefined>;
231
239
  ```
232
240
 
233
- Defined in: [cache/MemoryLayeredCache.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L182)
241
+ Defined in: [MemoryLayeredCache.ts:168](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-caching/src/MemoryLayeredCache.ts#L168)
234
242
 
235
- Proactively warms the cache for a given key (optional).
243
+ Proactively warms the cache for a given key.
236
244
 
237
245
  #### Parameters
238
246
 
@@ -244,7 +252,7 @@ Proactively warms the cache for a given key (optional).
244
252
 
245
253
  `Promise`\<`TValue` \| `undefined`\>
246
254
 
247
- The value that was loaded and cached, or undefined if not found.
255
+ The value that was loaded and cached, or `undefined` if not found.
248
256
 
249
257
  #### Implementation of
250
258