@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.
- package/data/packages/index.md +9 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +142 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +48 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +162 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +59 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +48 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +59 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +15 -0
- package/data/packages/platform-analytics/api/index.md +45 -0
- package/data/packages/platform-analytics/index.md +170 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +81 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -7
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -4
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +73 -0
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +25 -4
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -4
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaService.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionService.md +0 -4
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +6 -10
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Function.Token.md +19 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +25 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +23 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +37 -12
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -4
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.User.md +25 -0
- package/data/packages/platform-authentication/api/index.md +48 -450
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -6
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +69 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +39 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -8
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -10
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -18
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +7 -11
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -14
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -6
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/index.md +14 -65
- package/data/packages/platform-blob-storage/index.md +77 -22
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +2 -2
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +16 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +2 -2
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.IdentifierModule.md +2 -2
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +55 -1
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +10 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +21 -21
- package/data/packages/platform-core/api/Function.Public.md +19 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +60 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +34 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +40 -0
- package/data/packages/platform-core/api/Function.env.md +29 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +27 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +28 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -22
- package/data/packages/platform-core/api/Variable.APP_PORT.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +15 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +13 -0
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +27 -0
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +32 -0
- package/data/packages/platform-core/api/Variable.Lang.md +30 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +15 -0
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +24 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +25 -0
- package/data/packages/platform-core/api/index.md +29 -488
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseService.md +0 -4
- package/data/packages/platform-database/api/Class.PrismaService.md +0 -4
- package/data/packages/platform-database/api/Class.RepositoryBase.md +65 -4
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -4
- package/data/packages/platform-database/api/Function.pageable.md +32 -0
- package/data/packages/platform-database/api/Function.paginator.md +23 -0
- package/data/packages/platform-database/api/Function.query.md +35 -0
- package/data/packages/platform-database/api/Function.skip.md +34 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +32 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -4
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -4
- package/data/packages/platform-database/api/index.md +7 -142
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +180 -4
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -4
- package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -4
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -4
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/index.md +6 -49
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +185 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +66 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +49 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +91 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +199 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +250 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +102 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +79 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +61 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +95 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +47 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +61 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +71 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +31 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +33 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +39 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +37 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +39 -0
- package/data/packages/platform-esigning/api/index.md +85 -0
- package/data/packages/platform-esigning/index.md +691 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -4
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +15 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-logging/api/index.md +7 -29
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +19 -7
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +16 -4
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -4
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -4
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -4
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +13 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +17 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +15 -0
- package/data/packages/platform-mailing/api/index.md +32 -361
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +29 -0
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-mcp/api/index.md +8 -84
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -4
- package/data/packages/platform-openapi/api/Function.Api.md +36 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +43 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +19 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +26 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -4
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -4
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +13 -0
- package/data/packages/platform-openapi/api/index.md +14 -180
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -4
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -4
- package/data/packages/platform-payments/api/Class.MollieClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -4
- package/data/packages/platform-payments/api/Class.StripeClient.md +0 -4
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +26 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -4
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -4
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +13 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/index.md +20 -199
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +31 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +29 -0
- package/data/packages/platform-reporting/api/index.md +4 -51
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +13 -0
- package/data/packages/platform-telemetry/api/index.md +7 -51
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_SMTP\_PASSWORD'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_SMTP_PASSWORD
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_SMTP_PASSWORD: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L71)
|
|
14
|
+
|
|
15
|
+
SMTP authentication password.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_SMTP\_PORT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_SMTP_PORT
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_SMTP_PORT: IConfigKey<number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
|
|
14
|
+
|
|
15
|
+
SMTP server port.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_SMTP\_SECURE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_SMTP_SECURE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_SMTP_SECURE: IConfigKey<boolean>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
|
|
14
|
+
|
|
15
|
+
Whether the SMTP connection uses TLS.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_SMTP\_USER'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_SMTP_USER
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_SMTP_USER: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L68)
|
|
14
|
+
|
|
15
|
+
SMTP authentication username.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_TEMPLATE\_ENGINE\_FORMAT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_TEMPLATE_ENGINE_FORMAT
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_TEMPLATE_ENGINE_FORMAT: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L21)
|
|
14
|
+
|
|
15
|
+
Template engine format identifier (e.g. `handlebars`).
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_TEMPLATE\_FETCH\_STRATEGY\_TOKEN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN: typeof MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L9)
|
|
14
|
+
|
|
15
|
+
Central definition of injection tokens used by the mail module.
|
|
16
|
+
Using constants instead of raw string literals prevents accidental typos
|
|
17
|
+
and enables refactors with compile time safety.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_TEMPLATE\_STRATEGY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_TEMPLATE_STRATEGY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_TEMPLATE_STRATEGY: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
|
|
14
|
+
|
|
15
|
+
Which template-fetch strategy to use (e.g. `file`, `blob`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MAIL\_USER'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: MAIL_USER
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const MAIL_USER: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L81)
|
|
14
|
+
|
|
15
|
+
Mail user checked by the health indicator.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PLATFORM\_MAILING\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: PLATFORM_MAILING_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
|
|
14
|
+
|
|
15
|
+
All configuration entries required by `platform-mailing`.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: POSTMARK\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: POSTMARK_API_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const POSTMARK_API_KEY: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L12)
|
|
14
|
+
|
|
15
|
+
API key for the Postmark delivery service.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: POSTMARK\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: POSTMARK_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by the Postmark delivery provider.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: RESEND\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: RESEND_API_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const RESEND_API_KEY: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L12)
|
|
14
|
+
|
|
15
|
+
API key for the Resend delivery service.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: RESEND\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: RESEND_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by the Resend delivery provider.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SENDGRID\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SENDGRID_API_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SENDGRID_API_KEY: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L12)
|
|
14
|
+
|
|
15
|
+
API key for the SendGrid delivery service.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SENDGRID\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SENDGRID_CONFIG_ENTRIES
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
|
|
14
|
+
|
|
15
|
+
Configuration entries required by the SendGrid delivery provider.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: SEND\_MAIL\_EVENT\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: SEND_MAIL_EVENT_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents, 'sendMail'>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [platform-mailing/src/events/MailEventKeys.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/MailEventKeys.ts#L13)
|
|
14
|
+
|
|
15
|
+
Event key registry for the mail domain events.
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-mailing**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# @breadstone/archipel-platform-mailing
|
|
12
8
|
|
|
13
9
|
## Classes
|
|
@@ -45,360 +41,35 @@ editUrl: false
|
|
|
45
41
|
|
|
46
42
|
## Variables
|
|
47
43
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
---
|
|
81
|
-
|
|
82
|
-
### MAIL_MAILGUN_API_KEY
|
|
83
|
-
|
|
84
|
-
```ts
|
|
85
|
-
const MAIL_MAILGUN_API_KEY: IConfigKey<string>;
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
Defined in: [platform-mailing/src/env.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L49)
|
|
89
|
-
|
|
90
|
-
API key for the Mailgun delivery service.
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
### MAIL_MAILGUN_DOMAIN
|
|
95
|
-
|
|
96
|
-
```ts
|
|
97
|
-
const MAIL_MAILGUN_DOMAIN: IConfigKey<string>;
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
Defined in: [platform-mailing/src/env.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L52)
|
|
101
|
-
|
|
102
|
-
Mailgun domain (e.g. `mg.example.com`).
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
### MAIL_PORT
|
|
107
|
-
|
|
108
|
-
```ts
|
|
109
|
-
const MAIL_PORT: IConfigKey<number>;
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
Defined in: [platform-mailing/src/env.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L84)
|
|
113
|
-
|
|
114
|
-
Mail port checked by the health indicator.
|
|
115
|
-
|
|
116
|
-
---
|
|
117
|
-
|
|
118
|
-
### MAIL_POSTMARK_API_KEY
|
|
119
|
-
|
|
120
|
-
```ts
|
|
121
|
-
const MAIL_POSTMARK_API_KEY: IConfigKey<string>;
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
Defined in: [platform-mailing/src/env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L28)
|
|
125
|
-
|
|
126
|
-
API key for the Postmark delivery service.
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
### MAIL_RESEND_API_KEY
|
|
131
|
-
|
|
132
|
-
```ts
|
|
133
|
-
const MAIL_RESEND_API_KEY: IConfigKey<string>;
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
Defined in: [platform-mailing/src/env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L35)
|
|
137
|
-
|
|
138
|
-
API key for the Resend delivery service.
|
|
139
|
-
|
|
140
|
-
---
|
|
141
|
-
|
|
142
|
-
### MAIL_SENDER_EMAIL
|
|
143
|
-
|
|
144
|
-
```ts
|
|
145
|
-
const MAIL_SENDER_EMAIL: IConfigKey<string>;
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
Defined in: [platform-mailing/src/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L18)
|
|
149
|
-
|
|
150
|
-
Sender e-mail address shown in the `From` header.
|
|
151
|
-
|
|
152
|
-
---
|
|
153
|
-
|
|
154
|
-
### MAIL_SENDGRID_API_KEY
|
|
155
|
-
|
|
156
|
-
```ts
|
|
157
|
-
const MAIL_SENDGRID_API_KEY: IConfigKey<string>;
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
Defined in: [platform-mailing/src/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L42)
|
|
161
|
-
|
|
162
|
-
API key for the SendGrid delivery service.
|
|
163
|
-
|
|
164
|
-
---
|
|
165
|
-
|
|
166
|
-
### MAIL_SMTP_HOST
|
|
167
|
-
|
|
168
|
-
```ts
|
|
169
|
-
const MAIL_SMTP_HOST: IConfigKey<string>;
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
Defined in: [platform-mailing/src/env.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L59)
|
|
173
|
-
|
|
174
|
-
SMTP server host.
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
### MAIL_SMTP_PASSWORD
|
|
179
|
-
|
|
180
|
-
```ts
|
|
181
|
-
const MAIL_SMTP_PASSWORD: IConfigKey<string>;
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Defined in: [platform-mailing/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L71)
|
|
185
|
-
|
|
186
|
-
SMTP authentication password.
|
|
187
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
### MAIL_SMTP_PORT
|
|
191
|
-
|
|
192
|
-
```ts
|
|
193
|
-
const MAIL_SMTP_PORT: IConfigKey<number>;
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
Defined in: [platform-mailing/src/env.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L62)
|
|
197
|
-
|
|
198
|
-
SMTP server port.
|
|
199
|
-
|
|
200
|
-
---
|
|
201
|
-
|
|
202
|
-
### MAIL_SMTP_SECURE
|
|
203
|
-
|
|
204
|
-
```ts
|
|
205
|
-
const MAIL_SMTP_SECURE: IConfigKey<boolean>;
|
|
206
|
-
```
|
|
207
|
-
|
|
208
|
-
Defined in: [platform-mailing/src/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L65)
|
|
209
|
-
|
|
210
|
-
Whether the SMTP connection uses TLS.
|
|
211
|
-
|
|
212
|
-
---
|
|
213
|
-
|
|
214
|
-
### MAIL_SMTP_USER
|
|
215
|
-
|
|
216
|
-
```ts
|
|
217
|
-
const MAIL_SMTP_USER: IConfigKey<string>;
|
|
218
|
-
```
|
|
219
|
-
|
|
220
|
-
Defined in: [platform-mailing/src/env.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L68)
|
|
221
|
-
|
|
222
|
-
SMTP authentication username.
|
|
223
|
-
|
|
224
|
-
---
|
|
225
|
-
|
|
226
|
-
### MAIL_TEMPLATE_ENGINE_FORMAT
|
|
227
|
-
|
|
228
|
-
```ts
|
|
229
|
-
const MAIL_TEMPLATE_ENGINE_FORMAT: IConfigKey<string>;
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
Defined in: [platform-mailing/src/env.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L21)
|
|
233
|
-
|
|
234
|
-
Template engine format identifier (e.g. `handlebars`).
|
|
235
|
-
|
|
236
|
-
---
|
|
237
|
-
|
|
238
|
-
### MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN
|
|
239
|
-
|
|
240
|
-
```ts
|
|
241
|
-
const MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN: typeof MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN;
|
|
242
|
-
```
|
|
243
|
-
|
|
244
|
-
Defined in: [platform-mailing/src/MailTokens.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/MailTokens.ts#L9)
|
|
245
|
-
|
|
246
|
-
Central definition of injection tokens used by the mail module.
|
|
247
|
-
Using constants instead of raw string literals prevents accidental typos
|
|
248
|
-
and enables refactors with compile time safety.
|
|
249
|
-
|
|
250
|
-
---
|
|
251
|
-
|
|
252
|
-
### MAIL_TEMPLATE_STRATEGY
|
|
253
|
-
|
|
254
|
-
```ts
|
|
255
|
-
const MAIL_TEMPLATE_STRATEGY: IConfigKey<string>;
|
|
256
|
-
```
|
|
257
|
-
|
|
258
|
-
Defined in: [platform-mailing/src/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L12)
|
|
259
|
-
|
|
260
|
-
Which template-fetch strategy to use (e.g. `file`, `blob`).
|
|
261
|
-
|
|
262
|
-
---
|
|
263
|
-
|
|
264
|
-
### MAIL_USER
|
|
265
|
-
|
|
266
|
-
```ts
|
|
267
|
-
const MAIL_USER: IConfigKey<string>;
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
Defined in: [platform-mailing/src/env.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L81)
|
|
271
|
-
|
|
272
|
-
Mail user checked by the health indicator.
|
|
273
|
-
|
|
274
|
-
---
|
|
275
|
-
|
|
276
|
-
### MAILGUN_API_KEY
|
|
277
|
-
|
|
278
|
-
```ts
|
|
279
|
-
const MAILGUN_API_KEY: IConfigKey<string>;
|
|
280
|
-
```
|
|
281
|
-
|
|
282
|
-
Defined in: [platform-mailing/src/mailgun/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L12)
|
|
283
|
-
|
|
284
|
-
API key for the Mailgun delivery service.
|
|
285
|
-
|
|
286
|
-
---
|
|
287
|
-
|
|
288
|
-
### MAILGUN_CONFIG_ENTRIES
|
|
289
|
-
|
|
290
|
-
```ts
|
|
291
|
-
const MAILGUN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
Defined in: [platform-mailing/src/mailgun/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L22)
|
|
295
|
-
|
|
296
|
-
Configuration entries required by the Mailgun delivery provider.
|
|
297
|
-
|
|
298
|
-
---
|
|
299
|
-
|
|
300
|
-
### MAILGUN_DOMAIN
|
|
301
|
-
|
|
302
|
-
```ts
|
|
303
|
-
const MAILGUN_DOMAIN: IConfigKey<string>;
|
|
304
|
-
```
|
|
305
|
-
|
|
306
|
-
Defined in: [platform-mailing/src/mailgun/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/mailgun/env.ts#L15)
|
|
307
|
-
|
|
308
|
-
Mailgun domain (e.g. `mg.example.com`).
|
|
309
|
-
|
|
310
|
-
---
|
|
311
|
-
|
|
312
|
-
### PLATFORM_MAILING_CONFIG_ENTRIES
|
|
313
|
-
|
|
314
|
-
```ts
|
|
315
|
-
const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
316
|
-
```
|
|
317
|
-
|
|
318
|
-
Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
|
|
319
|
-
|
|
320
|
-
All configuration entries required by `platform-mailing`.
|
|
321
|
-
|
|
322
|
-
---
|
|
323
|
-
|
|
324
|
-
### POSTMARK_API_KEY
|
|
325
|
-
|
|
326
|
-
```ts
|
|
327
|
-
const POSTMARK_API_KEY: IConfigKey<string>;
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
Defined in: [platform-mailing/src/postmark/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L12)
|
|
331
|
-
|
|
332
|
-
API key for the Postmark delivery service.
|
|
333
|
-
|
|
334
|
-
---
|
|
335
|
-
|
|
336
|
-
### POSTMARK_CONFIG_ENTRIES
|
|
337
|
-
|
|
338
|
-
```ts
|
|
339
|
-
const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
340
|
-
```
|
|
341
|
-
|
|
342
|
-
Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
|
|
343
|
-
|
|
344
|
-
Configuration entries required by the Postmark delivery provider.
|
|
345
|
-
|
|
346
|
-
---
|
|
347
|
-
|
|
348
|
-
### RESEND_API_KEY
|
|
349
|
-
|
|
350
|
-
```ts
|
|
351
|
-
const RESEND_API_KEY: IConfigKey<string>;
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
Defined in: [platform-mailing/src/resend/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L12)
|
|
355
|
-
|
|
356
|
-
API key for the Resend delivery service.
|
|
357
|
-
|
|
358
|
-
---
|
|
359
|
-
|
|
360
|
-
### RESEND_CONFIG_ENTRIES
|
|
361
|
-
|
|
362
|
-
```ts
|
|
363
|
-
const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
|
|
367
|
-
|
|
368
|
-
Configuration entries required by the Resend delivery provider.
|
|
369
|
-
|
|
370
|
-
---
|
|
371
|
-
|
|
372
|
-
### SEND_MAIL_EVENT_KEY
|
|
373
|
-
|
|
374
|
-
```ts
|
|
375
|
-
const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents, 'sendMail'>;
|
|
376
|
-
```
|
|
377
|
-
|
|
378
|
-
Defined in: [platform-mailing/src/events/MailEventKeys.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/MailEventKeys.ts#L13)
|
|
379
|
-
|
|
380
|
-
Event key registry for the mail domain events.
|
|
381
|
-
|
|
382
|
-
---
|
|
383
|
-
|
|
384
|
-
### SENDGRID_API_KEY
|
|
385
|
-
|
|
386
|
-
```ts
|
|
387
|
-
const SENDGRID_API_KEY: IConfigKey<string>;
|
|
388
|
-
```
|
|
389
|
-
|
|
390
|
-
Defined in: [platform-mailing/src/sendgrid/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L12)
|
|
391
|
-
|
|
392
|
-
API key for the SendGrid delivery service.
|
|
393
|
-
|
|
394
|
-
---
|
|
395
|
-
|
|
396
|
-
### SENDGRID_CONFIG_ENTRIES
|
|
397
|
-
|
|
398
|
-
```ts
|
|
399
|
-
const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
400
|
-
```
|
|
401
|
-
|
|
402
|
-
Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
|
|
403
|
-
|
|
404
|
-
Configuration entries required by the SendGrid delivery provider.
|
|
44
|
+
| Variable | Description |
|
|
45
|
+
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
46
|
+
| [MAIL_DELIVERY_STRATEGY](Variable.MAIL_DELIVERY_STRATEGY) | Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`). |
|
|
47
|
+
| [MAIL_DELIVERY_STRATEGY_TOKEN](Variable.MAIL_DELIVERY_STRATEGY_TOKEN) | - |
|
|
48
|
+
| [MAIL_HOST](Variable.MAIL_HOST) | Mail host checked by the health indicator. |
|
|
49
|
+
| [MAIL_MAILGUN_API_KEY](Variable.MAIL_MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
|
|
50
|
+
| [MAIL_MAILGUN_DOMAIN](Variable.MAIL_MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
|
|
51
|
+
| [MAIL_PORT](Variable.MAIL_PORT) | Mail port checked by the health indicator. |
|
|
52
|
+
| [MAIL_POSTMARK_API_KEY](Variable.MAIL_POSTMARK_API_KEY) | API key for the Postmark delivery service. |
|
|
53
|
+
| [MAIL_RESEND_API_KEY](Variable.MAIL_RESEND_API_KEY) | API key for the Resend delivery service. |
|
|
54
|
+
| [MAIL_SENDER_EMAIL](Variable.MAIL_SENDER_EMAIL) | Sender e-mail address shown in the `From` header. |
|
|
55
|
+
| [MAIL_SENDGRID_API_KEY](Variable.MAIL_SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
|
|
56
|
+
| [MAIL_SMTP_HOST](Variable.MAIL_SMTP_HOST) | SMTP server host. |
|
|
57
|
+
| [MAIL_SMTP_PASSWORD](Variable.MAIL_SMTP_PASSWORD) | SMTP authentication password. |
|
|
58
|
+
| [MAIL_SMTP_PORT](Variable.MAIL_SMTP_PORT) | SMTP server port. |
|
|
59
|
+
| [MAIL_SMTP_SECURE](Variable.MAIL_SMTP_SECURE) | Whether the SMTP connection uses TLS. |
|
|
60
|
+
| [MAIL_SMTP_USER](Variable.MAIL_SMTP_USER) | SMTP authentication username. |
|
|
61
|
+
| [MAIL_TEMPLATE_ENGINE_FORMAT](Variable.MAIL_TEMPLATE_ENGINE_FORMAT) | Template engine format identifier (e.g. `handlebars`). |
|
|
62
|
+
| [MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN](Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN) | Central definition of injection tokens used by the mail module. Using constants instead of raw string literals prevents accidental typos and enables refactors with compile time safety. |
|
|
63
|
+
| [MAIL_TEMPLATE_STRATEGY](Variable.MAIL_TEMPLATE_STRATEGY) | Which template-fetch strategy to use (e.g. `file`, `blob`). |
|
|
64
|
+
| [MAIL_USER](Variable.MAIL_USER) | Mail user checked by the health indicator. |
|
|
65
|
+
| [MAILGUN_API_KEY](Variable.MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
|
|
66
|
+
| [MAILGUN_CONFIG_ENTRIES](Variable.MAILGUN_CONFIG_ENTRIES) | Configuration entries required by the Mailgun delivery provider. |
|
|
67
|
+
| [MAILGUN_DOMAIN](Variable.MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
|
|
68
|
+
| [PLATFORM_MAILING_CONFIG_ENTRIES](Variable.PLATFORM_MAILING_CONFIG_ENTRIES) | All configuration entries required by `platform-mailing`. |
|
|
69
|
+
| [POSTMARK_API_KEY](Variable.POSTMARK_API_KEY) | API key for the Postmark delivery service. |
|
|
70
|
+
| [POSTMARK_CONFIG_ENTRIES](Variable.POSTMARK_CONFIG_ENTRIES) | Configuration entries required by the Postmark delivery provider. |
|
|
71
|
+
| [RESEND_API_KEY](Variable.RESEND_API_KEY) | API key for the Resend delivery service. |
|
|
72
|
+
| [RESEND_CONFIG_ENTRIES](Variable.RESEND_CONFIG_ENTRIES) | Configuration entries required by the Resend delivery provider. |
|
|
73
|
+
| [SEND_MAIL_EVENT_KEY](Variable.SEND_MAIL_EVENT_KEY) | Event key registry for the mail domain events. |
|
|
74
|
+
| [SENDGRID_API_KEY](Variable.SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
|
|
75
|
+
| [SENDGRID_CONFIG_ENTRIES](Variable.SENDGRID_CONFIG_ENTRIES) | Configuration entries required by the SendGrid delivery provider. |
|