@breadstone/archipel-mcp 0.0.1 → 0.0.3

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 (407) hide show
  1. package/data/packages/index.md +9 -6
  2. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +142 -0
  3. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +48 -0
  4. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +170 -0
  5. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +170 -0
  6. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +162 -0
  7. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +170 -0
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +59 -0
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +48 -0
  10. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +59 -0
  11. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +15 -0
  12. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +15 -0
  13. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +15 -0
  14. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +15 -0
  15. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +15 -0
  16. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +15 -0
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +15 -0
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +15 -0
  19. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +15 -0
  20. package/data/packages/platform-analytics/api/index.md +45 -0
  21. package/data/packages/platform-analytics/index.md +170 -0
  22. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -4
  23. package/data/packages/platform-authentication/api/Class.AppleStrategy.md +81 -0
  24. package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -7
  25. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -4
  26. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -4
  27. package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -4
  28. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -4
  29. package/data/packages/platform-authentication/api/Class.GithubStrategy.md +73 -0
  30. package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +79 -0
  31. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -4
  32. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +25 -4
  33. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -4
  34. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -4
  35. package/data/packages/platform-authentication/api/Class.MfaService.md +0 -4
  36. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -4
  37. package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +79 -0
  38. package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -4
  39. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -4
  40. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -4
  41. package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -4
  42. package/data/packages/platform-authentication/api/Class.SessionService.md +0 -4
  43. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +6 -10
  44. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -4
  45. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -4
  46. package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -4
  47. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -4
  48. package/data/packages/platform-authentication/api/Function.Token.md +19 -0
  49. package/data/packages/platform-authentication/api/Function.UseRoles.md +25 -0
  50. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +23 -0
  51. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +37 -12
  52. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -4
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -4
  54. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -4
  55. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -4
  56. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -4
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -4
  58. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -4
  59. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -4
  60. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -4
  61. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -4
  62. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -4
  63. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -4
  64. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +15 -0
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +15 -0
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +15 -0
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +15 -0
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +15 -0
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +15 -0
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +15 -0
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +15 -0
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +15 -0
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +15 -0
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +15 -0
  76. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +15 -0
  77. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +15 -0
  78. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +15 -0
  79. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +15 -0
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +15 -0
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +15 -0
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +15 -0
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +15 -0
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +15 -0
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +15 -0
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +15 -0
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +15 -0
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +15 -0
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +15 -0
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +15 -0
  91. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +15 -0
  92. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +15 -0
  93. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +15 -0
  94. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +15 -0
  95. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +15 -0
  96. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +15 -0
  97. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +15 -0
  98. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +15 -0
  99. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +15 -0
  100. package/data/packages/platform-authentication/api/Variable.User.md +25 -0
  101. package/data/packages/platform-authentication/api/index.md +48 -450
  102. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +197 -0
  103. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +197 -0
  104. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -4
  105. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -6
  106. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -4
  107. package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -4
  108. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -4
  109. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -4
  110. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +29 -0
  111. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +69 -0
  112. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +39 -0
  113. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +29 -0
  114. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -8
  115. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -9
  116. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -10
  117. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -9
  118. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -18
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +7 -11
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -9
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -14
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -7
  123. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -7
  124. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -4
  125. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -7
  126. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -5
  127. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -5
  128. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -6
  129. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +13 -0
  130. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +13 -0
  131. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +13 -0
  132. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +27 -0
  133. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +27 -0
  134. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +13 -0
  135. package/data/packages/platform-blob-storage/api/index.md +14 -65
  136. package/data/packages/platform-blob-storage/index.md +77 -22
  137. package/data/packages/platform-core/api/Class.CasingInterceptor.md +2 -2
  138. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +16 -0
  139. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +2 -2
  140. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +1 -3
  141. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +1 -3
  142. package/data/packages/platform-core/api/Class.IdentifierModule.md +2 -2
  143. package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +55 -1
  144. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +10 -0
  145. package/data/packages/platform-core/api/Class.ResponseReturn.md +21 -21
  146. package/data/packages/platform-core/api/Function.Public.md +19 -0
  147. package/data/packages/platform-core/api/Function.createConfigKey.md +60 -0
  148. package/data/packages/platform-core/api/Function.createEventKey.md +34 -0
  149. package/data/packages/platform-core/api/Function.createMappingKey.md +40 -0
  150. package/data/packages/platform-core/api/Function.env.md +29 -0
  151. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +27 -0
  152. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +28 -0
  153. package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -22
  154. package/data/packages/platform-core/api/Variable.APP_PORT.md +15 -0
  155. package/data/packages/platform-core/api/Variable.APP_URL.md +15 -0
  156. package/data/packages/platform-core/api/Variable.APP_VERSION.md +15 -0
  157. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +15 -0
  158. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +15 -0
  159. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +15 -0
  160. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +15 -0
  161. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +15 -0
  162. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +15 -0
  163. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +13 -0
  164. package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +27 -0
  165. package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +29 -0
  166. package/data/packages/platform-core/api/Variable.IpAddress.md +32 -0
  167. package/data/packages/platform-core/api/Variable.Lang.md +30 -0
  168. package/data/packages/platform-core/api/Variable.NODE_ENV.md +15 -0
  169. package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +15 -0
  170. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +15 -0
  171. package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +24 -0
  172. package/data/packages/platform-core/api/Variable.UserAgent.md +25 -0
  173. package/data/packages/platform-core/api/index.md +29 -488
  174. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -4
  175. package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -4
  176. package/data/packages/platform-database/api/Class.DatabaseService.md +0 -4
  177. package/data/packages/platform-database/api/Class.PrismaService.md +0 -4
  178. package/data/packages/platform-database/api/Class.RepositoryBase.md +65 -4
  179. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -4
  180. package/data/packages/platform-database/api/Function.pageable.md +32 -0
  181. package/data/packages/platform-database/api/Function.paginator.md +23 -0
  182. package/data/packages/platform-database/api/Function.query.md +35 -0
  183. package/data/packages/platform-database/api/Function.skip.md +34 -0
  184. package/data/packages/platform-database/api/Function.transactionalQuery.md +32 -0
  185. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -4
  186. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -4
  187. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -4
  188. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -4
  189. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -4
  190. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -4
  191. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -4
  192. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -4
  193. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -4
  194. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -4
  195. package/data/packages/platform-database/api/index.md +7 -142
  196. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +180 -4
  197. package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -4
  198. package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -4
  199. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -4
  200. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -4
  201. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -4
  202. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -4
  203. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -4
  204. package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -4
  205. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -4
  206. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -4
  207. package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -4
  208. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -4
  209. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -4
  210. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -4
  211. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -4
  212. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -4
  213. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +15 -0
  214. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +15 -0
  215. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +15 -0
  216. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +15 -0
  217. package/data/packages/platform-documents/api/index.md +6 -49
  218. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +185 -0
  219. package/data/packages/platform-esigning/api/Class.EsigningError.md +66 -0
  220. package/data/packages/platform-esigning/api/Class.EsigningModule.md +49 -0
  221. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +91 -0
  222. package/data/packages/platform-esigning/api/Class.EsigningService.md +199 -0
  223. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +250 -0
  224. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +102 -0
  225. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +79 -0
  226. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +61 -0
  227. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +95 -0
  228. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +59 -0
  229. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +59 -0
  230. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +47 -0
  231. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +61 -0
  232. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +83 -0
  233. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +83 -0
  234. package/data/packages/platform-esigning/api/Interface.ISigner.md +83 -0
  235. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +83 -0
  236. package/data/packages/platform-esigning/api/Interface.ISigningField.md +143 -0
  237. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +143 -0
  238. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +71 -0
  239. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +15 -0
  240. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +15 -0
  241. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +15 -0
  242. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +15 -0
  243. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +15 -0
  244. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +15 -0
  245. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +15 -0
  246. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +15 -0
  247. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +15 -0
  248. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +15 -0
  249. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +15 -0
  250. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +15 -0
  251. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +15 -0
  252. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +15 -0
  253. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +15 -0
  254. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +15 -0
  255. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +15 -0
  256. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +15 -0
  257. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +15 -0
  258. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +15 -0
  259. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +15 -0
  260. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +15 -0
  261. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +13 -0
  262. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +13 -0
  263. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +15 -0
  264. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +15 -0
  265. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +15 -0
  266. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +15 -0
  267. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +15 -0
  268. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +15 -0
  269. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +15 -0
  270. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +15 -0
  271. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +31 -0
  272. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +33 -0
  273. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +39 -0
  274. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +37 -0
  275. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +39 -0
  276. package/data/packages/platform-esigning/api/index.md +85 -0
  277. package/data/packages/platform-esigning/index.md +691 -0
  278. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -4
  279. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +15 -0
  280. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +15 -0
  281. package/data/packages/platform-logging/api/index.md +7 -29
  282. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +1 -7
  283. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +19 -7
  284. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +1 -7
  285. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +1 -7
  286. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -4
  287. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -4
  288. package/data/packages/platform-mailing/api/Class.MailService.md +0 -4
  289. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -4
  290. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -4
  291. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +1 -7
  292. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +1 -7
  293. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +1 -7
  294. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +1 -7
  295. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +1 -7
  296. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +16 -4
  297. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -4
  298. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -4
  299. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -4
  300. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +15 -0
  301. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +15 -0
  302. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +15 -0
  303. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +15 -0
  304. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +13 -0
  305. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +15 -0
  306. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +15 -0
  307. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +15 -0
  308. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +15 -0
  309. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +15 -0
  310. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +15 -0
  311. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +15 -0
  312. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +15 -0
  313. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +15 -0
  314. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +15 -0
  315. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +15 -0
  316. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +15 -0
  317. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +15 -0
  318. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +15 -0
  319. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +17 -0
  320. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +15 -0
  321. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +15 -0
  322. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +15 -0
  323. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +15 -0
  324. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +15 -0
  325. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +15 -0
  326. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +15 -0
  327. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +15 -0
  328. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +15 -0
  329. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +15 -0
  330. package/data/packages/platform-mailing/api/index.md +32 -361
  331. package/data/packages/platform-mcp/api/Function.McpPrompt.md +29 -0
  332. package/data/packages/platform-mcp/api/Function.McpResource.md +29 -0
  333. package/data/packages/platform-mcp/api/Function.McpTool.md +29 -0
  334. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +15 -0
  335. package/data/packages/platform-mcp/api/index.md +8 -84
  336. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -4
  337. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -4
  338. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -4
  339. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -4
  340. package/data/packages/platform-openapi/api/Function.Api.md +36 -0
  341. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +43 -0
  342. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +19 -0
  343. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +26 -0
  344. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -4
  345. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -4
  346. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +15 -0
  347. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +15 -0
  348. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +15 -0
  349. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +15 -0
  350. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +15 -0
  351. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +13 -0
  352. package/data/packages/platform-openapi/api/index.md +14 -180
  353. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -4
  354. package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -4
  355. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -4
  356. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -4
  357. package/data/packages/platform-payments/api/Class.MollieClient.md +0 -4
  358. package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -4
  359. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -4
  360. package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -4
  361. package/data/packages/platform-payments/api/Class.StripeClient.md +0 -4
  362. package/data/packages/platform-payments/api/Function.RequiresFeature.md +26 -0
  363. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -4
  364. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -4
  365. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -4
  366. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -4
  367. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -4
  368. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -4
  369. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -4
  370. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +13 -0
  371. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +15 -0
  372. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +15 -0
  373. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +15 -0
  374. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +15 -0
  375. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +15 -0
  376. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +15 -0
  377. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +15 -0
  378. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +15 -0
  379. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +15 -0
  380. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +15 -0
  381. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +15 -0
  382. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +15 -0
  383. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +15 -0
  384. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +15 -0
  385. package/data/packages/platform-payments/api/index.md +20 -199
  386. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +31 -0
  387. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +29 -0
  388. package/data/packages/platform-reporting/api/index.md +4 -51
  389. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -4
  390. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -4
  391. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -4
  392. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -4
  393. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -4
  394. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -4
  395. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -4
  396. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -4
  397. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -4
  398. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -4
  399. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +13 -0
  400. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +13 -0
  401. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +13 -0
  402. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +13 -0
  403. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +13 -0
  404. package/data/packages/platform-telemetry/api/index.md +7 -51
  405. package/package.json +1 -1
  406. package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
  407. package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
@@ -0,0 +1,45 @@
1
+ ---
2
+ title: '@breadstone/archipel-platform-analytics'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # @breadstone/archipel-platform-analytics
8
+
9
+ ## Classes
10
+
11
+ | Class | Description |
12
+ | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | [AnalyticsClientPort](Class.AnalyticsClientPort) | Abstract port for analytics and error tracking clients. Each provider (Sentry, Application Insights, Datadog) must implement this contract so that the consuming application can switch providers without changing business logic. |
14
+ | [AnalyticsModule](Class.AnalyticsModule) | NestJS module providing generic analytics and error tracking infrastructure. The specific analytics provider (Sentry, Application Insights, Datadog) is selected via the options. |
15
+ | [AppInsightsAnalyticsClient](Class.AppInsightsAnalyticsClient) | Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `applicationinsights` SDK for error tracking and analytics. |
16
+ | [DatadogAnalyticsClient](Class.DatadogAnalyticsClient) | Datadog implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `dd-trace` SDK for error tracking and analytics. |
17
+ | [NoopAnalyticsClient](Class.NoopAnalyticsClient) | No-op implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Suitable for development, testing, or environments where analytics is disabled. |
18
+ | [SentryAnalyticsClient](Class.SentryAnalyticsClient) | Sentry implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the official `@sentry/node` SDK for error tracking and analytics. |
19
+
20
+ ## Interfaces
21
+
22
+ | Interface | Description |
23
+ | ------------------------------------------------------------ | -------------------------------------------------- |
24
+ | [IAnalyticsBreadcrumb](Interface.IAnalyticsBreadcrumb) | Represents a breadcrumb entry for analytics trail. |
25
+ | [IAnalyticsModuleOptions](Interface.IAnalyticsModuleOptions) | Configuration options for the `AnalyticsModule`. |
26
+ | [IAnalyticsUser](Interface.IAnalyticsUser) | Represents user context for analytics tracking. |
27
+
28
+ ## Type Aliases
29
+
30
+ | Type Alias | Description |
31
+ | ------------------------------------------ | -------------------------------------- |
32
+ | [AnalyticsLevel](TypeAlias.AnalyticsLevel) | Severity level for analytics messages. |
33
+
34
+ ## Variables
35
+
36
+ | Variable | Description |
37
+ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
38
+ | [APPINSIGHTS_CONFIG_ENTRIES](Variable.APPINSIGHTS_CONFIG_ENTRIES) | Configuration entries required by the Application Insights analytics provider. |
39
+ | [APPLICATIONINSIGHTS_CONNECTION_STRING](Variable.APPLICATIONINSIGHTS_CONNECTION_STRING) | Application Insights connection string. |
40
+ | [DATADOG_CONFIG_ENTRIES](Variable.DATADOG_CONFIG_ENTRIES) | Configuration entries required by the Datadog analytics provider. |
41
+ | [DD_ENV](Variable.DD_ENV) | Datadog environment identifier (e.g. `production`, `staging`). |
42
+ | [DD_SERVICE](Variable.DD_SERVICE) | Datadog service name. |
43
+ | [SENTRY_CONFIG_ENTRIES](Variable.SENTRY_CONFIG_ENTRIES) | Configuration entries required by the Sentry analytics provider. |
44
+ | [SENTRY_DSN](Variable.SENTRY_DSN) | Sentry DSN for error tracking. |
45
+ | [SENTRY_ENVIRONMENT](Variable.SENTRY_ENVIRONMENT) | Sentry environment identifier (e.g. `production`, `staging`). |
@@ -0,0 +1,170 @@
1
+ ---
2
+ title: platform-analytics
3
+ description: Provider-agnostic analytics and error tracking with pluggable clients.
4
+ order: 14
5
+ tags: [analytics, error-tracking, sentry, application-insights, datadog, observability, providers]
6
+ package: '@breadstone/archipel-platform-analytics'
7
+ ---
8
+
9
+ # platform-analytics
10
+
11
+ Provider-agnostic analytics and error tracking module supporting multiple backends. Ships with Sentry, Azure Application Insights, and Datadog clients out of the box, plus a no-op fallback for environments where analytics is disabled.
12
+
13
+ **Package:** `@breadstone/archipel-platform-analytics`
14
+
15
+ ## Quick Start
16
+
17
+ ```typescript
18
+ import { Module } from '@nestjs/common';
19
+ import { AnalyticsModule } from '@breadstone/archipel-platform-analytics';
20
+ import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
21
+
22
+ @Module({
23
+ imports: [
24
+ AnalyticsModule.register({
25
+ analyticsClient: SentryAnalyticsClient,
26
+ configEntries: SENTRY_CONFIG_ENTRIES,
27
+ isGlobal: true,
28
+ }),
29
+ ],
30
+ })
31
+ export class AppModule {}
32
+ ```
33
+
34
+ ---
35
+
36
+ ## Module Configuration
37
+
38
+ ### IAnalyticsModuleOptions
39
+
40
+ | Property | Type | Required | Default | Description |
41
+ | ----------------- | ------------------------------------- | -------- | ------- | ---------------------------------------- |
42
+ | `analyticsClient` | `Type<AnalyticsClientPort>` | Yes | — | Concrete analytics client implementation |
43
+ | `configEntries` | `ReadonlyArray<IConfigRegistryEntry>` | No | `[]` | Provider-specific configuration entries |
44
+ | `isGlobal` | `boolean` | No | `false` | Register as a global module |
45
+
46
+ ---
47
+
48
+ ## AnalyticsClientPort API
49
+
50
+ The abstract port that all analytics clients implement. Inject it anywhere:
51
+
52
+ ```typescript
53
+ import { AnalyticsClientPort } from '@breadstone/archipel-platform-analytics';
54
+
55
+ @Injectable()
56
+ export class PaymentService {
57
+ constructor(private readonly _analytics: AnalyticsClientPort) {}
58
+
59
+ public async processPayment(): Promise<void> {
60
+ try {
61
+ // ... payment logic
62
+ } catch (error) {
63
+ this._analytics.captureException(error as Error, { feature: 'payments' });
64
+ }
65
+ }
66
+ }
67
+ ```
68
+
69
+ ### Methods
70
+
71
+ | Method | Signature | Description |
72
+ | ------------------ | ------------------------------------------------------------------------------------- | --------------------------------------- |
73
+ | `captureException` | `(error: Error, context?: Record<string, unknown>) => void` | Capture an error with optional context |
74
+ | `captureMessage` | `(message: string, level: AnalyticsLevel, context?: Record<string, unknown>) => void` | Capture a message at a severity level |
75
+ | `setUser` | `(user: IAnalyticsUser) => void` | Set the current user context |
76
+ | `clearUser` | `() => void` | Clear the current user context |
77
+ | `addBreadcrumb` | `(breadcrumb: IAnalyticsBreadcrumb) => void` | Add a breadcrumb to the analytics trail |
78
+
79
+ ---
80
+
81
+ ## Built-in Providers
82
+
83
+ ### SentryAnalyticsClient
84
+
85
+ Error tracking and performance monitoring via Sentry.
86
+
87
+ ```typescript
88
+ import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
89
+
90
+ AnalyticsModule.register({
91
+ analyticsClient: SentryAnalyticsClient,
92
+ configEntries: SENTRY_CONFIG_ENTRIES,
93
+ });
94
+ ```
95
+
96
+ **Environment variables:** `SENTRY_DSN`, `SENTRY_ENVIRONMENT`
97
+
98
+ ### AppInsightsAnalyticsClient
99
+
100
+ Azure Application Insights integration.
101
+
102
+ ```typescript
103
+ import {
104
+ AppInsightsAnalyticsClient,
105
+ APPINSIGHTS_CONFIG_ENTRIES,
106
+ } from '@breadstone/archipel-platform-analytics/appinsights';
107
+
108
+ AnalyticsModule.register({
109
+ analyticsClient: AppInsightsAnalyticsClient,
110
+ configEntries: APPINSIGHTS_CONFIG_ENTRIES,
111
+ });
112
+ ```
113
+
114
+ **Environment variables:** `APPLICATIONINSIGHTS_CONNECTION_STRING`
115
+
116
+ ### DatadogAnalyticsClient
117
+
118
+ Datadog APM and error tracking.
119
+
120
+ ```typescript
121
+ import { DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/datadog';
122
+
123
+ AnalyticsModule.register({
124
+ analyticsClient: DatadogAnalyticsClient,
125
+ configEntries: DATADOG_CONFIG_ENTRIES,
126
+ });
127
+ ```
128
+
129
+ **Environment variables:** `DD_SERVICE`, `DD_ENV`
130
+
131
+ ### NoopAnalyticsClient
132
+
133
+ Silent no-op client for environments where analytics is disabled:
134
+
135
+ ```typescript
136
+ import { NoopAnalyticsClient } from '@breadstone/archipel-platform-analytics';
137
+
138
+ AnalyticsModule.register({
139
+ analyticsClient: NoopAnalyticsClient,
140
+ });
141
+ ```
142
+
143
+ ---
144
+
145
+ ## Sub-path Imports
146
+
147
+ Each provider is tree-shakeable via sub-path imports:
148
+
149
+ | Import Path | Contents |
150
+ | ----------------------------------------------------- | ------------------------------------------------------ |
151
+ | `@breadstone/archipel-platform-analytics` | Core module, port, models, NoopAnalyticsClient |
152
+ | `@breadstone/archipel-platform-analytics/sentry` | SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES |
153
+ | `@breadstone/archipel-platform-analytics/appinsights` | AppInsightsAnalyticsClient, APPINSIGHTS_CONFIG_ENTRIES |
154
+ | `@breadstone/archipel-platform-analytics/datadog` | DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES |
155
+
156
+ ---
157
+
158
+ ## Exports Summary
159
+
160
+ | Export | Type | Description |
161
+ | ---------------------------- | ------------- | ---------------------------------------------- |
162
+ | `AnalyticsModule` | NestJS Module | Main module with `register()` |
163
+ | `AnalyticsClientPort` | Port | Abstract analytics contract |
164
+ | `NoopAnalyticsClient` | Client | No-op fallback implementation |
165
+ | `SentryAnalyticsClient` | Client | Sentry provider (sub-path) |
166
+ | `AppInsightsAnalyticsClient` | Client | Azure Application Insights provider (sub-path) |
167
+ | `DatadogAnalyticsClient` | Client | Datadog provider (sub-path) |
168
+ | `AnalyticsLevel` | Type | Severity level union |
169
+ | `IAnalyticsBreadcrumb` | Interface | Breadcrumb entry model |
170
+ | `IAnalyticsUser` | Interface | User context model |
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: AnonymousAuthGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/AnonymousAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/AnonymousAuthGuard.ts#L14)
@@ -0,0 +1,81 @@
1
+ ---
2
+ title: 'Class: AppleStrategy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: AppleStrategy
8
+
9
+ Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L21)
10
+
11
+ The `AppleStrategy` integrates Apple Sign In authentication.
12
+
13
+ ## Extends
14
+
15
+ - `AppleStrategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
16
+
17
+ ## Constructors
18
+
19
+ ### Constructor
20
+
21
+ ```ts
22
+ new AppleStrategy(socialAuth, configService): AppleStrategy;
23
+ ```
24
+
25
+ Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L37)
26
+
27
+ Initializes a new instance of the `AppleStrategy` class.
28
+
29
+ #### Parameters
30
+
31
+ | Parameter | Type | Description |
32
+ | --------------- | ---------------------------------------- | ------------------------------- |
33
+ | `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
34
+ | `configService` | `ConfigService` | Configuration service instance. |
35
+
36
+ #### Returns
37
+
38
+ `AppleStrategy`
39
+
40
+ #### Overrides
41
+
42
+ ```ts
43
+ PassportStrategy(Strategy, 'apple').constructor;
44
+ ```
45
+
46
+ ## Methods
47
+
48
+ ### validate()
49
+
50
+ ```ts
51
+ validate(
52
+ accessToken,
53
+ refreshToken,
54
+ idToken,
55
+ profile): Promise<IAuthSubject>;
56
+ ```
57
+
58
+ Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L68)
59
+
60
+ Validates the Apple authentication payload.
61
+
62
+ #### Parameters
63
+
64
+ | Parameter | Type | Description |
65
+ | -------------- | --------------- | --------------------- |
66
+ | `accessToken` | `string` | OAuth access token. |
67
+ | `refreshToken` | `string` | OAuth refresh token. |
68
+ | `idToken` | `string` | Apple identity token. |
69
+ | `profile` | `IAppleProfile` | Apple profile data. |
70
+
71
+ #### Returns
72
+
73
+ `Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
74
+
75
+ The authenticated user.
76
+
77
+ #### Overrides
78
+
79
+ ```ts
80
+ PassportStrategy(Strategy, 'apple').validate;
81
+ ```
@@ -4,13 +4,9 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: AuthModule
12
8
 
13
- Defined in: [libs/platform-authentication/src/AuthModule.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L104)
9
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L116)
14
10
 
15
11
  The `AuthModule` handles JWT-based authentication,
16
12
  including token creation and validation.
@@ -35,7 +31,7 @@ new AuthModule(): AuthModule;
35
31
  configure(consumer): void;
36
32
  ```
37
33
 
38
- Defined in: [libs/platform-authentication/src/AuthModule.ts:208](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L208)
34
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:225](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L225)
39
35
 
40
36
  #### Parameters
41
37
 
@@ -55,7 +51,7 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:208](https://github.
55
51
  static register(options): DynamicModule;
56
52
  ```
57
53
 
58
- Defined in: [libs/platform-authentication/src/AuthModule.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L114)
54
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L126)
59
55
 
60
56
  Registers the auth module with the provided port implementations.
61
57
 
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Abstract Class: AuthSubjectPort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L13)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: AuthTokenService
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L18)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: ChallengeService
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L29)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: GithubAuthGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/GithubAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/GithubAuthGuard.ts#L14)
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: 'Class: GithubStrategy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: GithubStrategy
8
+
9
+ Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L13)
10
+
11
+ ## Extends
12
+
13
+ - `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
14
+
15
+ ## Constructors
16
+
17
+ ### Constructor
18
+
19
+ ```ts
20
+ new GithubStrategy(socialAuth, configService): GithubStrategy;
21
+ ```
22
+
23
+ Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L29)
24
+
25
+ Constructs a new instance of the `GithubStrategy` class.
26
+
27
+ #### Parameters
28
+
29
+ | Parameter | Type | Description |
30
+ | --------------- | ---------------------------------------- | ------------------------------- |
31
+ | `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
32
+ | `configService` | `ConfigService` | Configuration service instance. |
33
+
34
+ #### Returns
35
+
36
+ `GithubStrategy`
37
+
38
+ #### Overrides
39
+
40
+ ```ts
41
+ PassportStrategy(Strategy, 'github').constructor;
42
+ ```
43
+
44
+ ## Methods
45
+
46
+ ### validate()
47
+
48
+ ```ts
49
+ validate(
50
+ _accessToken,
51
+ _refreshToken,
52
+ profile): Promise<IAuthSubject>;
53
+ ```
54
+
55
+ Defined in: [libs/platform-authentication/src/strategies/GithubStrategy.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GithubStrategy.ts#L46)
56
+
57
+ #### Parameters
58
+
59
+ | Parameter | Type |
60
+ | --------------- | --------- |
61
+ | `_accessToken` | `string` |
62
+ | `_refreshToken` | `string` |
63
+ | `profile` | `Profile` |
64
+
65
+ #### Returns
66
+
67
+ `Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
68
+
69
+ #### Overrides
70
+
71
+ ```ts
72
+ PassportStrategy(Strategy, 'github').validate;
73
+ ```
@@ -0,0 +1,79 @@
1
+ ---
2
+ title: 'Class: GoogleStrategy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: GoogleStrategy
8
+
9
+ Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L18)
10
+
11
+ The `GoogleStrategy` integrates Google OAuth authentication.
12
+
13
+ ## Extends
14
+
15
+ - `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
16
+
17
+ ## Constructors
18
+
19
+ ### Constructor
20
+
21
+ ```ts
22
+ new GoogleStrategy(socialAuth, configService): GoogleStrategy;
23
+ ```
24
+
25
+ Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L34)
26
+
27
+ Initializes a new instance of the `GoogleStrategy` class.
28
+
29
+ #### Parameters
30
+
31
+ | Parameter | Type | Description |
32
+ | --------------- | ---------------------------------------- | ------------------------------- |
33
+ | `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
34
+ | `configService` | `ConfigService` | Configuration service instance. |
35
+
36
+ #### Returns
37
+
38
+ `GoogleStrategy`
39
+
40
+ #### Overrides
41
+
42
+ ```ts
43
+ PassportStrategy(Strategy, 'google').constructor;
44
+ ```
45
+
46
+ ## Methods
47
+
48
+ ### validate()
49
+
50
+ ```ts
51
+ validate(
52
+ accessToken,
53
+ refreshToken,
54
+ profile): Promise<IAuthSubject>;
55
+ ```
56
+
57
+ Defined in: [libs/platform-authentication/src/strategies/GoogleStrategy.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/GoogleStrategy.ts#L59)
58
+
59
+ Validates the Google authentication payload.
60
+
61
+ #### Parameters
62
+
63
+ | Parameter | Type | Description |
64
+ | -------------- | --------- | -------------------- |
65
+ | `accessToken` | `string` | OAuth access token. |
66
+ | `refreshToken` | `string` | OAuth refresh token. |
67
+ | `profile` | `Profile` | Google profile data. |
68
+
69
+ #### Returns
70
+
71
+ `Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
72
+
73
+ The authenticated user.
74
+
75
+ #### Overrides
76
+
77
+ ```ts
78
+ PassportStrategy(Strategy, 'google').validate;
79
+ ```
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: JwtAuthGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/JwtAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/JwtAuthGuard.ts#L14)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Abstract Class: JwtPayloadBase
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L8)
@@ -16,6 +12,31 @@ Abstract base class for JWT payloads.
16
12
  Products extend this to add their own claims (e.g. `profileId`, `isPro`).
17
13
  Used as both a serialization contract and NestJS injection token.
18
14
 
15
+ ## Constructors
16
+
17
+ ### Constructor
18
+
19
+ ```ts
20
+ protected new JwtPayloadBase(
21
+ id,
22
+ email,
23
+ roles): JwtPayloadBase;
24
+ ```
25
+
26
+ Defined in: [libs/platform-authentication/src/models/JwtPayloadBase.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/JwtPayloadBase.ts#L40)
27
+
28
+ #### Parameters
29
+
30
+ | Parameter | Type |
31
+ | --------- | ------------------- |
32
+ | `id` | `string` |
33
+ | `email` | `string` \| `null` |
34
+ | `roles` | readonly `string`[] |
35
+
36
+ #### Returns
37
+
38
+ `JwtPayloadBase`
39
+
19
40
  ## Properties
20
41
 
21
42
  ### email
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: LastActiveMiddleware
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/middlewares/LastActiveMiddleware.ts#L16)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: LocalAuthGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/LocalAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/LocalAuthGuard.ts#L14)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Class: MfaService
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/MfaService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L22)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Abstract Class: MfaSubjectPort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L14)