@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,79 @@
1
+ ---
2
+ title: 'Class: MicrosoftStrategy'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Class: MicrosoftStrategy
8
+
9
+ Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L19)
10
+
11
+ The `MicrosoftStrategy` integrates Microsoft OAuth authentication.
12
+
13
+ ## Extends
14
+
15
+ - `Strategy`\<`this`\> & `PassportStrategyMixin`\<`unknown`, `this`\>
16
+
17
+ ## Constructors
18
+
19
+ ### Constructor
20
+
21
+ ```ts
22
+ new MicrosoftStrategy(socialAuth, configService): MicrosoftStrategy;
23
+ ```
24
+
25
+ Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L35)
26
+
27
+ Initializes a new instance of the `MicrosoftStrategy` 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
+ `MicrosoftStrategy`
39
+
40
+ #### Overrides
41
+
42
+ ```ts
43
+ PassportStrategy(Strategy, 'microsoft').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/MicrosoftStrategy.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L61)
58
+
59
+ Validates the Microsoft 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` | Microsoft 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, 'microsoft').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: RolesGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.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: SessionMappingProfile
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L39)
@@ -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: SessionPersistencePort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.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: SessionResponse
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.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: SessionService
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/SessionService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/SessionService.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: SocialAuthGuard
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L10)
@@ -21,16 +17,16 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:10](http
21
17
  ### Constructor
22
18
 
23
19
  ```ts
24
- new SocialAuthGuard(_provider): SocialAuthGuard;
20
+ new SocialAuthGuard(routeParam): SocialAuthGuard;
25
21
  ```
26
22
 
27
- Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L21)
23
+ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L20)
28
24
 
29
25
  #### Parameters
30
26
 
31
- | Parameter | Type |
32
- | ----------- | -------- |
33
- | `_provider` | `string` |
27
+ | Parameter | Type |
28
+ | ------------ | -------- |
29
+ | `routeParam` | `string` |
34
30
 
35
31
  #### Returns
36
32
 
@@ -44,7 +40,7 @@ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:21](http
44
40
  canActivate(context): boolean | Promise<boolean> | Observable<boolean>;
45
41
  ```
46
42
 
47
- Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L29)
43
+ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L28)
48
44
 
49
45
  #### Parameters
50
46
 
@@ -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: SocialAuthPort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/SocialAuthPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SocialAuthPort.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: TokenEnricherPort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/TokenEnricherPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/TokenEnricherPort.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: VerificationService
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/VerificationService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L17)
@@ -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: VerificationSubjectPort
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/VerificationSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/VerificationSubjectPort.ts#L13)
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: 'Function: Token()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Function: Token()
8
+
9
+ ```ts
10
+ function Token(): Function;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/decorators/TokenDecorator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/TokenDecorator.ts#L14)
14
+
15
+ Represents the `Token` decorator.
16
+
17
+ ## Returns
18
+
19
+ `Function`
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: 'Function: UseRoles()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Function: UseRoles()
8
+
9
+ ```ts
10
+ function UseRoles(...roles): Function;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/decorators/RolesDecorator.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/decorators/RolesDecorator.ts#L20)
14
+
15
+ Represents the `UseRoles` decorator.
16
+
17
+ ## Parameters
18
+
19
+ | Parameter | Type |
20
+ | ---------- | ---------- |
21
+ | ...`roles` | `string`[] |
22
+
23
+ ## Returns
24
+
25
+ `Function`
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: 'Function: socialAuthGuardFactory()'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Function: socialAuthGuardFactory()
8
+
9
+ ```ts
10
+ function socialAuthGuardFactory(routeParam): SocialAuthGuard;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/guards/SocialAuthGuard.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/SocialAuthGuard.ts#L43)
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type |
18
+ | ------------ | -------- |
19
+ | `routeParam` | `string` |
20
+
21
+ ## Returns
22
+
23
+ [`SocialAuthGuard`](Class.SocialAuthGuard)
@@ -4,25 +4,35 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IAuthModuleOptions
12
8
 
13
- Defined in: [libs/platform-authentication/src/AuthModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L62)
9
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L59)
14
10
 
15
11
  Options for configuring the `AuthModule`.
16
12
 
17
13
  ## Properties
18
14
 
15
+ ### additionalConfigEntries?
16
+
17
+ ```ts
18
+ optional additionalConfigEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
19
+ ```
20
+
21
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L99)
22
+
23
+ Optional additional configuration entries to register (e.g. provider-specific OAuth keys).
24
+ Import them from the provider-specific sub-paths
25
+ (e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/apple`).
26
+
27
+ ---
28
+
19
29
  ### authSubject
20
30
 
21
31
  ```ts
22
32
  authSubject: Type<AuthSubjectPort>;
23
33
  ```
24
34
 
25
- Defined in: [libs/platform-authentication/src/AuthModule.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L66)
35
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L63)
26
36
 
27
37
  Implementation of the auth subject port (user lookup for JWT/Local/Anonymous strategies).
28
38
 
@@ -34,7 +44,7 @@ Implementation of the auth subject port (user lookup for JWT/Local/Anonymous str
34
44
  mfaSubject: Type<MfaSubjectPort>;
35
45
  ```
36
46
 
37
- Defined in: [libs/platform-authentication/src/AuthModule.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L71)
47
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L68)
38
48
 
39
49
  Implementation of the MFA subject port (MFA state persistence).
40
50
 
@@ -46,7 +56,7 @@ Implementation of the MFA subject port (MFA state persistence).
46
56
  sessionPersistence: Type<SessionPersistencePort>;
47
57
  ```
48
58
 
49
- Defined in: [libs/platform-authentication/src/AuthModule.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L76)
59
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L73)
50
60
 
51
61
  Implementation of the session persistence port.
52
62
 
@@ -58,10 +68,25 @@ Implementation of the session persistence port.
58
68
  optional socialAuth?: Type<SocialAuthPort>;
59
69
  ```
60
70
 
61
- Defined in: [libs/platform-authentication/src/AuthModule.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L87)
71
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L84)
62
72
 
63
73
  Optional implementation of the social auth port (OAuth strategies).
64
- When provided, social strategies (GitHub, Google, Microsoft, Apple) are registered.
74
+ When provided together with `socialStrategies`, the social auth flow is enabled.
75
+
76
+ ---
77
+
78
+ ### socialStrategies?
79
+
80
+ ```ts
81
+ optional socialStrategies?: Type<any>[];
82
+ ```
83
+
84
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L92)
85
+
86
+ Optional array of social strategy types to register (e.g. `AppleStrategy`, `GithubStrategy`).
87
+ Import them from the provider-specific sub-paths
88
+ (e.g. `@breadstone/archipel-platform-authentication/apple`).
89
+ Requires `socialAuth` to be set.
65
90
 
66
91
  ---
67
92
 
@@ -71,7 +96,7 @@ When provided, social strategies (GitHub, Google, Microsoft, Apple) are register
71
96
  optional tokenEnricher?: Type<TokenEnricherPort>;
72
97
  ```
73
98
 
74
- Defined in: [libs/platform-authentication/src/AuthModule.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L93)
99
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L105)
75
100
 
76
101
  Optional implementation of the token enricher port.
77
102
  When provided, additional claims are added to JWT tokens.
@@ -84,6 +109,6 @@ When provided, additional claims are added to JWT tokens.
84
109
  verificationSubject: Type<VerificationSubjectPort>;
85
110
  ```
86
111
 
87
- Defined in: [libs/platform-authentication/src/AuthModule.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L81)
112
+ Defined in: [libs/platform-authentication/src/AuthModule.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L78)
88
113
 
89
114
  Implementation of the verification subject port (email/pin verification).
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IAuthSubject
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/IAuthSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IAuthSubject.ts#L7)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaChallengePayload
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/IMfaChallengePayload.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaChallengePayload.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaChallengeState
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L9)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaConfirmation
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/IMfaConfirmation.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaConfirmation.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaSetup
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/IMfaSetup.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/IMfaSetup.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaSubject
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/IMfaSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubject.ts#L7)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IMfaSubjectUpdate
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IMfaSubjectUpdate.ts#L7)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: ISessionRecord
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/ISessionRecord.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISessionRecord.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: ISignInResult
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/models/ISignInResult.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/ISignInResult.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: ISocialProfile
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/ISocialProfile.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/ISocialProfile.ts#L6)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IStoreSessionArgs
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/IStoreSessionArgs.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IStoreSessionArgs.ts#L12)
@@ -4,10 +4,6 @@ generated: true
4
4
  editUrl: false
5
5
  ---
6
6
 
7
- [**@breadstone/archipel-platform-authentication**](../)
8
-
9
- ---
10
-
11
7
  # Interface: IVerifiableSubject
12
8
 
13
9
  Defined in: [libs/platform-authentication/src/contracts/IVerifiableSubject.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/IVerifiableSubject.ts#L7)
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: APPLE\_AUTH\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: APPLE_AUTH_CONFIG_ENTRIES
8
+
9
+ ```ts
10
+ const APPLE_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/apple/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/apple/env.ts#L15)
14
+
15
+ Configuration entries required by Apple Sign-In authentication.
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: AUTH\_APPLE\_CALLBACK\_URL'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AUTH_APPLE_CALLBACK_URL
8
+
9
+ ```ts
10
+ const AUTH_APPLE_CALLBACK_URL: IConfigKey<string>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/env.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L109)
14
+
15
+ Apple Sign-In callback URL.
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: AUTH\_APPLE\_CLIENT\_ID'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AUTH_APPLE_CLIENT_ID
8
+
9
+ ```ts
10
+ const AUTH_APPLE_CLIENT_ID: IConfigKey<string>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/env.ts:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L100)
14
+
15
+ Apple Sign-In client (service) ID.
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: AUTH\_APPLE\_KEY\_ID'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AUTH_APPLE_KEY_ID
8
+
9
+ ```ts
10
+ const AUTH_APPLE_KEY_ID: IConfigKey<string>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/env.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L106)
14
+
15
+ Apple Sign-In key ID.
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: AUTH\_APPLE\_PRIVATE\_KEY'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AUTH_APPLE_PRIVATE_KEY
8
+
9
+ ```ts
10
+ const AUTH_APPLE_PRIVATE_KEY: IConfigKey<string>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/env.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L97)
14
+
15
+ Apple Sign-In private key (PEM string).
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: 'Variable: AUTH\_APPLE\_TEAM\_ID'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+
7
+ # Variable: AUTH_APPLE_TEAM_ID
8
+
9
+ ```ts
10
+ const AUTH_APPLE_TEAM_ID: IConfigKey<string>;
11
+ ```
12
+
13
+ Defined in: [libs/platform-authentication/src/env.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L103)
14
+
15
+ Apple developer team ID.