@breadstone/archipel-mcp 0.0.9 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
- package/data/packages/platform-analytics/api/index.md +25 -26
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +19 -20
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -27
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.MfaService.md +54 -55
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +17 -18
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +27 -28
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -30
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
- package/data/packages/platform-authentication/api/Function.Token.md +0 -1
- package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +20 -21
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -11
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +1 -2
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -95
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -3
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/index.md +41 -42
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +37 -38
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +39 -40
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +4 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +4 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +15 -16
- package/data/packages/platform-caching/api/index.md +12 -13
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
- package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
- package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
- package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +18 -19
- package/data/packages/platform-core/api/Class.EventHub.md +25 -26
- package/data/packages/platform-core/api/Class.EventModule.md +0 -1
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
- package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
- package/data/packages/platform-core/api/Class.HostModule.md +0 -2
- package/data/packages/platform-core/api/Class.HostService.md +21 -22
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
- package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
- package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
- package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
- package/data/packages/platform-core/api/Class.MappingService.md +52 -53
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
- package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
- package/data/packages/platform-core/api/Class.SseHub.md +23 -24
- package/data/packages/platform-core/api/Class.SseModule.md +3 -4
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Function.Public.md +0 -1
- package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
- package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
- package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
- package/data/packages/platform-core/api/Function.env.md +4 -5
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
- package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +19 -20
- package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +17 -18
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
- package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
- package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
- package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
- package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
- package/data/packages/platform-core/api/Variable.APP_NAME.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +1 -2
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -2
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
- package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
- package/data/packages/platform-core/api/Variable.Lang.md +5 -6
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -2
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -116
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +7 -8
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -4
- package/data/packages/platform-cryptography/api/Class.OtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +7 -8
- package/data/packages/platform-cryptography/api/index.md +11 -12
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
- package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
- package/data/packages/platform-database/api/Function.pageable.md +13 -10
- package/data/packages/platform-database/api/Function.paginator.md +2 -3
- package/data/packages/platform-database/api/Function.query.md +7 -8
- package/data/packages/platform-database/api/Function.skip.md +5 -6
- package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
- package/data/packages/platform-database/api/index.md +27 -28
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/index.md +28 -29
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
- package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
- package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
- package/data/packages/platform-esigning/api/index.md +65 -66
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +4 -5
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
- package/data/packages/platform-intelligence/api/index.md +46 -47
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-logging/api/index.md +7 -8
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailService.md +27 -28
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -15
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
- package/data/packages/platform-mailing/api/index.md +54 -55
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
- package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-mcp/api/index.md +26 -27
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
- package/data/packages/platform-openapi/api/Function.Api.md +13 -14
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +4 -5
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
- package/data/packages/platform-openapi/api/index.md +24 -25
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -25
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
- package/data/packages/platform-payments/api/Class.StripeClient.md +28 -29
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/index.md +40 -41
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
- package/data/packages/platform-reporting/api/index.md +23 -24
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
- package/data/packages/platform-telemetry/api/index.md +20 -21
- package/package.json +1 -1
|
@@ -3,11 +3,10 @@ title: 'Variable: PLATFORM\_MAILING\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: PLATFORM_MAILING_CONFIG_ENTRIES
|
|
6
|
+
# Variable: PLATFORM\_MAILING\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const PLATFORM_MAILING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [platform-mailing/src/env.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/env.ts#L91)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: POSTMARK\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: POSTMARK_CONFIG_ENTRIES
|
|
6
|
+
# Variable: POSTMARK\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const POSTMARK_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [platform-mailing/src/postmark/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/postmark/env.ts#L19)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: RESEND\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: RESEND_CONFIG_ENTRIES
|
|
6
|
+
# Variable: RESEND\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const RESEND_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [platform-mailing/src/resend/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/resend/env.ts#L19)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: SENDGRID\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: SENDGRID_CONFIG_ENTRIES
|
|
6
|
+
# Variable: SENDGRID\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const SENDGRID_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [platform-mailing/src/sendgrid/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/sendgrid/env.ts#L19)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: SEND\_MAIL\_EVENT\_KEY'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: SEND_MAIL_EVENT_KEY
|
|
6
|
+
# Variable: SEND\_MAIL\_EVENT\_KEY
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents,
|
|
9
|
+
const SEND_MAIL_EVENT_KEY: IEventKey<IMailEvents, "sendMail">;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [platform-mailing/src/events/MailEventKeys.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mailing/src/events/MailEventKeys.ts#L13)
|
|
@@ -3,73 +3,72 @@ title: '@breadstone/archipel-platform-mailing'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# @breadstone/archipel-platform-mailing
|
|
8
7
|
|
|
9
8
|
## Classes
|
|
10
9
|
|
|
11
|
-
| Class
|
|
12
|
-
|
|
|
13
|
-
| [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class.
|
|
14
|
-
| [DeliveryStrategyBase](Class.DeliveryStrategyBase)
|
|
15
|
-
| [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class.
|
|
16
|
-
| [LogDeliveryStrategy](Class.LogDeliveryStrategy)
|
|
17
|
-
| [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy)
|
|
18
|
-
| [MailHealthIndicator](Class.MailHealthIndicator)
|
|
19
|
-
| [MailModule](Class.MailModule)
|
|
20
|
-
| [MailService](Class.MailService)
|
|
21
|
-
| [MailTemplateEngine](Class.MailTemplateEngine)
|
|
22
|
-
| [MailVerificationService](Class.MailVerificationService)
|
|
23
|
-
| [PostmarkDeliveryStrategy](Class.PostmarkDeliveryStrategy)
|
|
24
|
-
| [ResendDeliveryStrategy](Class.ResendDeliveryStrategy)
|
|
25
|
-
| [SendGridDeliveryStrategy](Class.SendGridDeliveryStrategy)
|
|
26
|
-
| [SmtpDeliveryStrategy](Class.SmtpDeliveryStrategy)
|
|
27
|
-
| [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) | Represents the base class for template fetch strategies.
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [BlobTemplateFetchStrategy](Class.BlobTemplateFetchStrategy) | The `BlobTemplateFetchStrategy` class. |
|
|
13
|
+
| [DeliveryStrategyBase](Class.DeliveryStrategyBase) | Represents the base class for all email delivery strategies. |
|
|
14
|
+
| [FileTemplateFetchStrategy](Class.FileTemplateFetchStrategy) | The `FileTemplateFetchStrategy` class. |
|
|
15
|
+
| [LogDeliveryStrategy](Class.LogDeliveryStrategy) | The `LogDeliveryStrategy` class. |
|
|
16
|
+
| [MailgunDeliveryStrategy](Class.MailgunDeliveryStrategy) | Delivers emails via the Mailgun API. |
|
|
17
|
+
| [MailHealthIndicator](Class.MailHealthIndicator) | Health indicator for mail service. |
|
|
18
|
+
| [MailModule](Class.MailModule) | Represents the mail module. |
|
|
19
|
+
| [MailService](Class.MailService) | Represents the `MailService` class. |
|
|
20
|
+
| [MailTemplateEngine](Class.MailTemplateEngine) | The `MailTemplateEngine` class. |
|
|
21
|
+
| [MailVerificationService](Class.MailVerificationService) | Represents the `MailVerificationService` class. |
|
|
22
|
+
| [PostmarkDeliveryStrategy](Class.PostmarkDeliveryStrategy) | The `PostmarkDeliveryStrategy` class. |
|
|
23
|
+
| [ResendDeliveryStrategy](Class.ResendDeliveryStrategy) | Delivers emails via the Resend API. |
|
|
24
|
+
| [SendGridDeliveryStrategy](Class.SendGridDeliveryStrategy) | Delivers emails via the SendGrid API. |
|
|
25
|
+
| [SmtpDeliveryStrategy](Class.SmtpDeliveryStrategy) | The `SmtpDeliveryStrategy` class. |
|
|
26
|
+
| [TemplateFetchStrategyBase](Class.TemplateFetchStrategyBase) | Represents the base class for template fetch strategies. |
|
|
28
27
|
|
|
29
28
|
## Interfaces
|
|
30
29
|
|
|
31
|
-
| Interface
|
|
32
|
-
|
|
|
33
|
-
| [IMailEvents](Interface.IMailEvents)
|
|
30
|
+
| Interface | Description |
|
|
31
|
+
| ------ | ------ |
|
|
32
|
+
| [IMailEvents](Interface.IMailEvents) | Represents the contract of events emitted by the mail domain. |
|
|
34
33
|
| [IMailTemplateVariants](Interface.IMailTemplateVariants) | Represents the in-memory structure for a single template (multiple formats). |
|
|
35
34
|
|
|
36
35
|
## Type Aliases
|
|
37
36
|
|
|
38
|
-
| Type Alias
|
|
39
|
-
|
|
|
37
|
+
| Type Alias | Description |
|
|
38
|
+
| ------ | ------ |
|
|
40
39
|
| [MailTemplateFormat](TypeAlias.MailTemplateFormat) | Union type of all supported template formats. |
|
|
41
40
|
|
|
42
41
|
## Variables
|
|
43
42
|
|
|
44
|
-
| Variable
|
|
45
|
-
|
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
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
|
-
| [
|
|
43
|
+
| Variable | Description |
|
|
44
|
+
| ------ | ------ |
|
|
45
|
+
| [MAIL\_DELIVERY\_STRATEGY](Variable.MAIL_DELIVERY_STRATEGY) | Which delivery strategy to use (e.g. `smtp`, `postmark`, `resend`, `sendgrid`, `mailgun`, `log`). |
|
|
46
|
+
| [MAIL\_DELIVERY\_STRATEGY\_TOKEN](Variable.MAIL_DELIVERY_STRATEGY_TOKEN) | - |
|
|
47
|
+
| [MAIL\_HOST](Variable.MAIL_HOST) | Mail host checked by the health indicator. |
|
|
48
|
+
| [MAIL\_MAILGUN\_API\_KEY](Variable.MAIL_MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
|
|
49
|
+
| [MAIL\_MAILGUN\_DOMAIN](Variable.MAIL_MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
|
|
50
|
+
| [MAIL\_PORT](Variable.MAIL_PORT) | Mail port checked by the health indicator. |
|
|
51
|
+
| [MAIL\_POSTMARK\_API\_KEY](Variable.MAIL_POSTMARK_API_KEY) | API key for the Postmark delivery service. |
|
|
52
|
+
| [MAIL\_RESEND\_API\_KEY](Variable.MAIL_RESEND_API_KEY) | API key for the Resend delivery service. |
|
|
53
|
+
| [MAIL\_SENDER\_EMAIL](Variable.MAIL_SENDER_EMAIL) | Sender e-mail address shown in the `From` header. |
|
|
54
|
+
| [MAIL\_SENDGRID\_API\_KEY](Variable.MAIL_SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
|
|
55
|
+
| [MAIL\_SMTP\_HOST](Variable.MAIL_SMTP_HOST) | SMTP server host. |
|
|
56
|
+
| [MAIL\_SMTP\_PASSWORD](Variable.MAIL_SMTP_PASSWORD) | SMTP authentication password. |
|
|
57
|
+
| [MAIL\_SMTP\_PORT](Variable.MAIL_SMTP_PORT) | SMTP server port. |
|
|
58
|
+
| [MAIL\_SMTP\_SECURE](Variable.MAIL_SMTP_SECURE) | Whether the SMTP connection uses TLS. |
|
|
59
|
+
| [MAIL\_SMTP\_USER](Variable.MAIL_SMTP_USER) | SMTP authentication username. |
|
|
60
|
+
| [MAIL\_TEMPLATE\_ENGINE\_FORMAT](Variable.MAIL_TEMPLATE_ENGINE_FORMAT) | Template engine format identifier (e.g. `handlebars`). |
|
|
61
|
+
| [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. |
|
|
62
|
+
| [MAIL\_TEMPLATE\_STRATEGY](Variable.MAIL_TEMPLATE_STRATEGY) | Which template-fetch strategy to use (e.g. `file`, `blob`). |
|
|
63
|
+
| [MAIL\_USER](Variable.MAIL_USER) | Mail user checked by the health indicator. |
|
|
64
|
+
| [MAILGUN\_API\_KEY](Variable.MAILGUN_API_KEY) | API key for the Mailgun delivery service. |
|
|
65
|
+
| [MAILGUN\_CONFIG\_ENTRIES](Variable.MAILGUN_CONFIG_ENTRIES) | Configuration entries required by the Mailgun delivery provider. |
|
|
66
|
+
| [MAILGUN\_DOMAIN](Variable.MAILGUN_DOMAIN) | Mailgun domain (e.g. `mg.example.com`). |
|
|
67
|
+
| [PLATFORM\_MAILING\_CONFIG\_ENTRIES](Variable.PLATFORM_MAILING_CONFIG_ENTRIES) | All configuration entries required by `platform-mailing`. |
|
|
68
|
+
| [POSTMARK\_API\_KEY](Variable.POSTMARK_API_KEY) | API key for the Postmark delivery service. |
|
|
69
|
+
| [POSTMARK\_CONFIG\_ENTRIES](Variable.POSTMARK_CONFIG_ENTRIES) | Configuration entries required by the Postmark delivery provider. |
|
|
70
|
+
| [RESEND\_API\_KEY](Variable.RESEND_API_KEY) | API key for the Resend delivery service. |
|
|
71
|
+
| [RESEND\_CONFIG\_ENTRIES](Variable.RESEND_CONFIG_ENTRIES) | Configuration entries required by the Resend delivery provider. |
|
|
72
|
+
| [SEND\_MAIL\_EVENT\_KEY](Variable.SEND_MAIL_EVENT_KEY) | Event key registry for the mail domain events. |
|
|
73
|
+
| [SENDGRID\_API\_KEY](Variable.SENDGRID_API_KEY) | API key for the SendGrid delivery service. |
|
|
74
|
+
| [SENDGRID\_CONFIG\_ENTRIES](Variable.SENDGRID_CONFIG_ENTRIES) | Configuration entries required by the SendGrid delivery provider. |
|
|
@@ -3,7 +3,6 @@ title: 'Class: McpDiscoveryService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: McpDiscoveryService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpDiscoveryService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpDiscoveryService.ts#L16)
|
|
@@ -22,8 +21,8 @@ in the [McpRegistryService](Class.McpRegistryService).
|
|
|
22
21
|
|
|
23
22
|
```ts
|
|
24
23
|
new McpDiscoveryService(
|
|
25
|
-
_discoveryService,
|
|
26
|
-
_metadataScanner,
|
|
24
|
+
_discoveryService,
|
|
25
|
+
_metadataScanner,
|
|
27
26
|
_registry): McpDiscoveryService;
|
|
28
27
|
```
|
|
29
28
|
|
|
@@ -31,11 +30,11 @@ Defined in: [services/McpDiscoveryService.ts:25](https://github.com/RueDeRennes/
|
|
|
31
30
|
|
|
32
31
|
#### Parameters
|
|
33
32
|
|
|
34
|
-
| Parameter
|
|
35
|
-
|
|
|
36
|
-
| `_discoveryService` | `DiscoveryService`
|
|
37
|
-
| `_metadataScanner`
|
|
38
|
-
| `_registry`
|
|
33
|
+
| Parameter | Type |
|
|
34
|
+
| ------ | ------ |
|
|
35
|
+
| `_discoveryService` | `DiscoveryService` |
|
|
36
|
+
| `_metadataScanner` | `MetadataScanner` |
|
|
37
|
+
| `_registry` | [`McpRegistryService`](Class.McpRegistryService) |
|
|
39
38
|
|
|
40
39
|
#### Returns
|
|
41
40
|
|
|
@@ -61,5 +60,5 @@ Scans all providers and registers discovered MCP handlers.
|
|
|
61
60
|
#### Implementation of
|
|
62
61
|
|
|
63
62
|
```ts
|
|
64
|
-
OnModuleInit.onModuleInit
|
|
63
|
+
OnModuleInit.onModuleInit
|
|
65
64
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Class: McpModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: McpModule
|
|
8
7
|
|
|
9
8
|
Defined in: [module/McpModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/module/McpModule.ts#L28)
|
|
@@ -17,9 +16,9 @@ or `McpModule.registerAsync()` for factory-based configuration.
|
|
|
17
16
|
|
|
18
17
|
```typescript
|
|
19
18
|
McpModule.register({
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
})
|
|
19
|
+
name: 'my-mcp-server',
|
|
20
|
+
version: '1.0.0',
|
|
21
|
+
})
|
|
23
22
|
```
|
|
24
23
|
|
|
25
24
|
## Constructors
|
|
@@ -48,8 +47,8 @@ Registers the MCP module with synchronous options.
|
|
|
48
47
|
|
|
49
48
|
#### Parameters
|
|
50
49
|
|
|
51
|
-
| Parameter | Type
|
|
52
|
-
|
|
|
50
|
+
| Parameter | Type | Description |
|
|
51
|
+
| ------ | ------ | ------ |
|
|
53
52
|
| `options` | [`IMcpModuleOptions`](Interface.IMcpModuleOptions) | MCP server configuration. |
|
|
54
53
|
|
|
55
54
|
#### Returns
|
|
@@ -58,7 +57,7 @@ Registers the MCP module with synchronous options.
|
|
|
58
57
|
|
|
59
58
|
A configured dynamic module.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### registerAsync()
|
|
64
63
|
|
|
@@ -72,8 +71,8 @@ Registers the MCP module with asynchronous options.
|
|
|
72
71
|
|
|
73
72
|
#### Parameters
|
|
74
73
|
|
|
75
|
-
| Parameter | Type
|
|
76
|
-
|
|
|
74
|
+
| Parameter | Type | Description |
|
|
75
|
+
| ------ | ------ | ------ |
|
|
77
76
|
| `options` | [`IMcpModuleAsyncOptions`](Interface.IMcpModuleAsyncOptions) | Async MCP server configuration. |
|
|
78
77
|
|
|
79
78
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Class: McpRegistryService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: McpRegistryService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpRegistryService.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpRegistryService.ts#L35)
|
|
@@ -41,7 +40,7 @@ Returns all registered prompts.
|
|
|
41
40
|
|
|
42
41
|
`ReadonlyMap`\<`string`, [`IRegisteredPrompt`](Interface.IRegisteredPrompt)\>
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
***
|
|
45
44
|
|
|
46
45
|
### resources
|
|
47
46
|
|
|
@@ -59,7 +58,7 @@ Returns all registered resources.
|
|
|
59
58
|
|
|
60
59
|
`ReadonlyMap`\<`string`, [`IRegisteredResource`](Interface.IRegisteredResource)\>
|
|
61
60
|
|
|
62
|
-
|
|
61
|
+
***
|
|
63
62
|
|
|
64
63
|
### tools
|
|
65
64
|
|
|
@@ -91,16 +90,16 @@ Registers a prompt handler.
|
|
|
91
90
|
|
|
92
91
|
#### Parameters
|
|
93
92
|
|
|
94
|
-
| Parameter
|
|
95
|
-
|
|
|
96
|
-
| `metadata` | [`IMcpPromptMetadata`](Interface.IMcpPromptMetadata) | Prompt metadata from the decorator.
|
|
97
|
-
| `handler`
|
|
93
|
+
| Parameter | Type | Description |
|
|
94
|
+
| ------ | ------ | ------ |
|
|
95
|
+
| `metadata` | [`IMcpPromptMetadata`](Interface.IMcpPromptMetadata) | Prompt metadata from the decorator. |
|
|
96
|
+
| `handler` | (...`args`) => `unknown` | Bound method that handles the prompt generation. |
|
|
98
97
|
|
|
99
98
|
#### Returns
|
|
100
99
|
|
|
101
100
|
`void`
|
|
102
101
|
|
|
103
|
-
|
|
102
|
+
***
|
|
104
103
|
|
|
105
104
|
### registerResource()
|
|
106
105
|
|
|
@@ -114,16 +113,16 @@ Registers a resource handler.
|
|
|
114
113
|
|
|
115
114
|
#### Parameters
|
|
116
115
|
|
|
117
|
-
| Parameter
|
|
118
|
-
|
|
|
119
|
-
| `metadata` | [`IMcpResourceMetadata`](Interface.IMcpResourceMetadata) | Resource metadata from the decorator.
|
|
120
|
-
| `handler`
|
|
116
|
+
| Parameter | Type | Description |
|
|
117
|
+
| ------ | ------ | ------ |
|
|
118
|
+
| `metadata` | [`IMcpResourceMetadata`](Interface.IMcpResourceMetadata) | Resource metadata from the decorator. |
|
|
119
|
+
| `handler` | (...`args`) => `unknown` | Bound method that handles the resource read. |
|
|
121
120
|
|
|
122
121
|
#### Returns
|
|
123
122
|
|
|
124
123
|
`void`
|
|
125
124
|
|
|
126
|
-
|
|
125
|
+
***
|
|
127
126
|
|
|
128
127
|
### registerTool()
|
|
129
128
|
|
|
@@ -137,10 +136,10 @@ Registers a tool handler.
|
|
|
137
136
|
|
|
138
137
|
#### Parameters
|
|
139
138
|
|
|
140
|
-
| Parameter
|
|
141
|
-
|
|
|
142
|
-
| `metadata` | [`IMcpToolMetadata`](Interface.IMcpToolMetadata) | Tool metadata from the decorator.
|
|
143
|
-
| `handler`
|
|
139
|
+
| Parameter | Type | Description |
|
|
140
|
+
| ------ | ------ | ------ |
|
|
141
|
+
| `metadata` | [`IMcpToolMetadata`](Interface.IMcpToolMetadata) | Tool metadata from the decorator. |
|
|
142
|
+
| `handler` | (...`args`) => `unknown` | Bound method that handles the tool invocation. |
|
|
144
143
|
|
|
145
144
|
#### Returns
|
|
146
145
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: McpServerService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: McpServerService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpServerService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L37)
|
|
@@ -29,10 +28,10 @@ Defined in: [services/McpServerService.ts:48](https://github.com/RueDeRennes/arc
|
|
|
29
28
|
|
|
30
29
|
#### Parameters
|
|
31
30
|
|
|
32
|
-
| Parameter
|
|
33
|
-
|
|
|
34
|
-
| `_options`
|
|
35
|
-
| `_registry` | [`McpRegistryService`](Class.McpRegistryService)
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------ | ------ |
|
|
33
|
+
| `_options` | [`IMcpModuleOptions`](Interface.IMcpModuleOptions) |
|
|
34
|
+
| `_registry` | [`McpRegistryService`](Class.McpRegistryService) |
|
|
36
35
|
|
|
37
36
|
#### Returns
|
|
38
37
|
|
|
@@ -77,7 +76,7 @@ Suitable for local, process-spawned integrations.
|
|
|
77
76
|
|
|
78
77
|
`Promise`\<`StdioServerTransport`\>
|
|
79
78
|
|
|
80
|
-
|
|
79
|
+
***
|
|
81
80
|
|
|
82
81
|
### connectTransport()
|
|
83
82
|
|
|
@@ -91,15 +90,15 @@ Connects a custom transport to the MCP server.
|
|
|
91
90
|
|
|
92
91
|
#### Parameters
|
|
93
92
|
|
|
94
|
-
| Parameter
|
|
95
|
-
|
|
|
93
|
+
| Parameter | Type | Description |
|
|
94
|
+
| ------ | ------ | ------ |
|
|
96
95
|
| `transport` | `Transport` | Any transport implementing the MCP Transport interface. |
|
|
97
96
|
|
|
98
97
|
#### Returns
|
|
99
98
|
|
|
100
99
|
`Promise`\<`void`\>
|
|
101
100
|
|
|
102
|
-
|
|
101
|
+
***
|
|
103
102
|
|
|
104
103
|
### createSseTransport()
|
|
105
104
|
|
|
@@ -114,10 +113,10 @@ The caller is responsible for wiring the returned transport to Express routes.
|
|
|
114
113
|
|
|
115
114
|
#### Parameters
|
|
116
115
|
|
|
117
|
-
| Parameter
|
|
118
|
-
|
|
|
119
|
-
| `options`
|
|
120
|
-
| `response` | `Response`
|
|
116
|
+
| Parameter | Type | Description |
|
|
117
|
+
| ------ | ------ | ------ |
|
|
118
|
+
| `options` | [`ISseTransportOptions`](Interface.ISseTransportOptions) | SSE transport configuration. |
|
|
119
|
+
| `response` | `Response` | The Express response object for the SSE connection. |
|
|
121
120
|
|
|
122
121
|
#### Returns
|
|
123
122
|
|
|
@@ -125,7 +124,7 @@ The caller is responsible for wiring the returned transport to Express routes.
|
|
|
125
124
|
|
|
126
125
|
The configured SSE transport instance.
|
|
127
126
|
|
|
128
|
-
|
|
127
|
+
***
|
|
129
128
|
|
|
130
129
|
### createStreamableHttpTransport()
|
|
131
130
|
|
|
@@ -141,8 +140,8 @@ method to the appropriate Express routes.
|
|
|
141
140
|
|
|
142
141
|
#### Parameters
|
|
143
142
|
|
|
144
|
-
| Parameter
|
|
145
|
-
|
|
|
143
|
+
| Parameter | Type | Description |
|
|
144
|
+
| ------ | ------ | ------ |
|
|
146
145
|
| `options?` | [`IStreamableHttpTransportOptions`](Interface.IStreamableHttpTransportOptions) | Transport configuration options. |
|
|
147
146
|
|
|
148
147
|
#### Returns
|
|
@@ -151,7 +150,7 @@ method to the appropriate Express routes.
|
|
|
151
150
|
|
|
152
151
|
The configured transport instance.
|
|
153
152
|
|
|
154
|
-
|
|
153
|
+
***
|
|
155
154
|
|
|
156
155
|
### onModuleDestroy()
|
|
157
156
|
|
|
@@ -170,10 +169,10 @@ Cleans up all active transports when the module is destroyed.
|
|
|
170
169
|
#### Implementation of
|
|
171
170
|
|
|
172
171
|
```ts
|
|
173
|
-
OnModuleDestroy.onModuleDestroy
|
|
172
|
+
OnModuleDestroy.onModuleDestroy
|
|
174
173
|
```
|
|
175
174
|
|
|
176
|
-
|
|
175
|
+
***
|
|
177
176
|
|
|
178
177
|
### onModuleInit()
|
|
179
178
|
|
|
@@ -193,5 +192,5 @@ from the registry.
|
|
|
193
192
|
#### Implementation of
|
|
194
193
|
|
|
195
194
|
```ts
|
|
196
|
-
OnModuleInit.onModuleInit
|
|
195
|
+
OnModuleInit.onModuleInit
|
|
197
196
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Function: McpPrompt()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: McpPrompt()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
@@ -20,8 +19,8 @@ should return an `MCP GetPromptResult`.
|
|
|
20
19
|
|
|
21
20
|
## Parameters
|
|
22
21
|
|
|
23
|
-
| Parameter | Type
|
|
24
|
-
|
|
|
22
|
+
| Parameter | Type | Description |
|
|
23
|
+
| ------ | ------ | ------ |
|
|
25
24
|
| `options` | [`IMcpPromptMetadata`](Interface.IMcpPromptMetadata) | Prompt registration metadata. |
|
|
26
25
|
|
|
27
26
|
## Returns
|
|
@@ -3,7 +3,6 @@ title: 'Function: McpResource()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: McpResource()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
@@ -20,8 +19,8 @@ as arguments and should return an `MCP ReadResourceResult`.
|
|
|
20
19
|
|
|
21
20
|
## Parameters
|
|
22
21
|
|
|
23
|
-
| Parameter | Type
|
|
24
|
-
|
|
|
22
|
+
| Parameter | Type | Description |
|
|
23
|
+
| ------ | ------ | ------ |
|
|
25
24
|
| `options` | [`IMcpResourceMetadata`](Interface.IMcpResourceMetadata) | Resource registration metadata. |
|
|
26
25
|
|
|
27
26
|
## Returns
|
|
@@ -3,7 +3,6 @@ title: 'Function: McpTool()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: McpTool()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
@@ -20,8 +19,8 @@ and should return an `MCP CallToolResult`.
|
|
|
20
19
|
|
|
21
20
|
## Parameters
|
|
22
21
|
|
|
23
|
-
| Parameter | Type
|
|
24
|
-
|
|
|
22
|
+
| Parameter | Type | Description |
|
|
23
|
+
| ------ | ------ | ------ |
|
|
25
24
|
| `options` | [`IMcpToolMetadata`](Interface.IMcpToolMetadata) | Tool registration metadata. |
|
|
26
25
|
|
|
27
26
|
## Returns
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IMcpHandlerMetadata'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IMcpHandlerMetadata
|
|
8
7
|
|
|
9
8
|
Defined in: [interfaces/IMcpHandlerMetadata.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/interfaces/IMcpHandlerMetadata.ts#L4)
|
|
@@ -22,7 +21,7 @@ Defined in: [interfaces/IMcpHandlerMetadata.ts:12](https://github.com/RueDeRenne
|
|
|
22
21
|
|
|
23
22
|
The metadata associated with the registration.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### methodName
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [interfaces/IMcpHandlerMetadata.ts:9](https://github.com/RueDeRennes
|
|
|
34
33
|
|
|
35
34
|
The method name on the provider class.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### type
|
|
40
39
|
|