@breadstone/archipel-mcp 0.0.1 → 0.0.2
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 +7 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +141 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +47 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +161 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +58 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +47 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +58 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +14 -0
- package/data/packages/platform-analytics/api/index.md +44 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +80 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -13
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -15
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -10
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -31
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +72 -0
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +78 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +33 -13
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -15
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.MfaService.md +54 -59
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -13
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +78 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -10
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -9
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -30
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -17
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -38
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -10
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -7
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -7
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -34
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -21
- package/data/packages/platform-authentication/api/Function.Token.md +18 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +24 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +22 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +42 -18
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -12
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -10
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -15
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -5
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -8
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -14
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -12
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -19
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -10
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -8
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -10
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -9
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.User.md +24 -0
- package/data/packages/platform-authentication/api/index.md +86 -490
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -10
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -9
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -17
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -50
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -12
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -23
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +68 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +38 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +6 -11
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +12 -17
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +26 -31
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +21 -26
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +18 -23
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +4 -9
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -10
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -10
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -10
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -7
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -6
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -7
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/index.md +41 -93
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +2 -3
- package/data/packages/platform-core/api/Class.BcryptService.md +7 -8
- 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 +12 -13
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- 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 +26 -27
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +33 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +6 -7
- package/data/packages/platform-core/api/Class.CryptoService.md +3 -4
- 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 +18 -21
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +15 -16
- 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 +20 -23
- 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 +13 -14
- 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 +5 -6
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +56 -3
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +0 -1
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +6 -7
- 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.MemoryLayeredCache.md +37 -38
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.OtpService.md +8 -9
- 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 +21 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +39 -40
- 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 +123 -125
- 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 +18 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +58 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +33 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +39 -0
- package/data/packages/platform-core/api/Function.env.md +28 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +26 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +27 -0
- 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.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-core/api/Interface.ICacheStats.md +4 -5
- 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 +10 -11
- 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 +8 -9
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +4 -5
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +4 -5
- 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.IOtpService.md +8 -9
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +14 -15
- 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 +3 -23
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +1 -2
- 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_PORT.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +14 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +12 -0
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +26 -0
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +28 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +31 -0
- package/data/packages/platform-core/api/Variable.Lang.md +29 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +14 -0
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +23 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +24 -0
- package/data/packages/platform-core/api/index.md +160 -620
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -11
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -10
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -24
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -12
- package/data/packages/platform-database/api/Class.RepositoryBase.md +185 -125
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -10
- package/data/packages/platform-database/api/Function.pageable.md +35 -0
- package/data/packages/platform-database/api/Function.paginator.md +22 -0
- package/data/packages/platform-database/api/Function.query.md +34 -0
- package/data/packages/platform-database/api/Function.skip.md +33 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +31 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -5
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -6
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -9
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -12
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -10
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -7
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -7
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -12
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -8
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -8
- package/data/packages/platform-database/api/index.md +27 -163
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +194 -20
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -12
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -7
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -26
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -11
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -10
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -13
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -7
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -8
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -23
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -8
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -8
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -6
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/index.md +28 -72
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +184 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +65 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +48 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +90 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +198 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +249 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +101 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +78 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +60 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +94 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +46 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +60 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +70 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +30 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +32 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +38 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +36 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +38 -0
- package/data/packages/platform-esigning/api/index.md +84 -0
- package/data/packages/platform-esigning/index.md +691 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -5
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +14 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-logging/api/index.md +7 -30
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -10
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +30 -19
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -10
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -9
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -5
- package/data/packages/platform-mailing/api/Class.MailService.md +27 -32
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -17
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -19
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +18 -7
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -5
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -6
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -6
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +12 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +16 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +14 -0
- package/data/packages/platform-mailing/api/index.md +54 -384
- 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 +28 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +28 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +28 -0
- 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 +14 -0
- package/data/packages/platform-mcp/api/index.md +27 -104
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -10
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -10
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +16 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -7
- package/data/packages/platform-openapi/api/Function.Api.md +35 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +42 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +18 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +27 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -10
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -10
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +12 -0
- package/data/packages/platform-openapi/api/index.md +24 -191
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -12
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -11
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -12
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -29
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -29
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -29
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -30
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -7
- package/data/packages/platform-payments/api/Class.StripeClient.md +24 -29
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +25 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -9
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -10
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -11
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -13
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -7
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -8
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -14
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +12 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/index.md +41 -221
- 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 +30 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +28 -0
- package/data/packages/platform-reporting/api/index.md +23 -71
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -31
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -28
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -40
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -7
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -27
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -7
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -13
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -7
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +12 -0
- package/data/packages/platform-telemetry/api/index.md +20 -65
- 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
|
@@ -3,7 +3,6 @@ title: 'Interface: IRegisteredTool'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IRegisteredTool
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpRegistryService.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpRegistryService.ts#L9)
|
|
@@ -22,15 +21,15 @@ Defined in: [services/McpRegistryService.ts:11](https://github.com/RueDeRennes/a
|
|
|
22
21
|
|
|
23
22
|
#### Parameters
|
|
24
23
|
|
|
25
|
-
| Parameter | Type
|
|
26
|
-
|
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
27
26
|
| ...`args` | `unknown`[] |
|
|
28
27
|
|
|
29
28
|
#### Returns
|
|
30
29
|
|
|
31
30
|
`unknown`
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
***
|
|
34
33
|
|
|
35
34
|
### metadata
|
|
36
35
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISseTransportOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISseTransportOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpServerService.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L26)
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IStreamableHttpTransportOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IStreamableHttpTransportOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [services/McpServerService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/services/McpServerService.ts#L15)
|
|
@@ -22,7 +21,7 @@ Defined in: [services/McpServerService.ts:20](https://github.com/RueDeRennes/arc
|
|
|
22
21
|
|
|
23
22
|
Whether to enable JSON-only response mode (no SSE).
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### sessionIdGenerator?
|
|
28
27
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MCP\_MODULE\_OPTIONS'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: MCP\_MODULE\_OPTIONS
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const MCP_MODULE_OPTIONS: typeof MCP_MODULE_OPTIONS;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [constants/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/constants/McpTokens.ts#L4)
|
|
13
|
+
|
|
14
|
+
Injection tokens used by the MCP module.
|
|
@@ -3,121 +3,44 @@ title: '@breadstone/archipel-platform-mcp'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# @breadstone/archipel-platform-mcp
|
|
8
7
|
|
|
9
8
|
## Classes
|
|
10
9
|
|
|
11
|
-
| Class
|
|
12
|
-
|
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
13
12
|
| [McpDiscoveryService](Class.McpDiscoveryService) | Discovers all NestJS providers that have methods decorated with `@McpTool`, `@McpResource`, or `@McpPrompt` and registers them in the [McpRegistryService](Class.McpRegistryService). |
|
|
14
|
-
| [McpModule](Class.McpModule)
|
|
15
|
-
| [McpRegistryService](Class.McpRegistryService)
|
|
16
|
-
| [McpServerService](Class.McpServerService)
|
|
13
|
+
| [McpModule](Class.McpModule) | NestJS dynamic module that bootstraps an MCP server. |
|
|
14
|
+
| [McpRegistryService](Class.McpRegistryService) | Central registry that stores all MCP tool, resource, and prompt handlers discovered from NestJS providers. |
|
|
15
|
+
| [McpServerService](Class.McpServerService) | Manages the MCP server lifecycle. Creates the `McpServer` instance, registers all discovered handlers from the registry, and provides methods to connect various transports. |
|
|
17
16
|
|
|
18
17
|
## Interfaces
|
|
19
18
|
|
|
20
|
-
| Interface
|
|
21
|
-
|
|
|
22
|
-
| [IMcpHandlerMetadata](Interface.IMcpHandlerMetadata)
|
|
23
|
-
| [IMcpModuleAsyncOptions](Interface.IMcpModuleAsyncOptions)
|
|
24
|
-
| [IMcpModuleOptions](Interface.IMcpModuleOptions)
|
|
25
|
-
| [IMcpModuleOptionsFactory](Interface.IMcpModuleOptionsFactory)
|
|
26
|
-
| [IMcpPromptMetadata](Interface.IMcpPromptMetadata)
|
|
27
|
-
| [IMcpResourceMetadata](Interface.IMcpResourceMetadata)
|
|
28
|
-
| [IMcpToolMetadata](Interface.IMcpToolMetadata)
|
|
29
|
-
| [IRegisteredPrompt](Interface.IRegisteredPrompt)
|
|
30
|
-
| [IRegisteredResource](Interface.IRegisteredResource)
|
|
31
|
-
| [IRegisteredTool](Interface.IRegisteredTool)
|
|
32
|
-
| [ISseTransportOptions](Interface.ISseTransportOptions)
|
|
33
|
-
| [IStreamableHttpTransportOptions](Interface.IStreamableHttpTransportOptions) | Options for creating a Streamable HTTP transport.
|
|
19
|
+
| Interface | Description |
|
|
20
|
+
| ------ | ------ |
|
|
21
|
+
| [IMcpHandlerMetadata](Interface.IMcpHandlerMetadata) | Internal metadata stored for each decorated handler method. |
|
|
22
|
+
| [IMcpModuleAsyncOptions](Interface.IMcpModuleAsyncOptions) | Async options for configuring the MCP module via a factory. |
|
|
23
|
+
| [IMcpModuleOptions](Interface.IMcpModuleOptions) | Options for configuring the MCP module. |
|
|
24
|
+
| [IMcpModuleOptionsFactory](Interface.IMcpModuleOptionsFactory) | Factory interface for creating MCP module options. |
|
|
25
|
+
| [IMcpPromptMetadata](Interface.IMcpPromptMetadata) | Metadata describing an MCP prompt registration. |
|
|
26
|
+
| [IMcpResourceMetadata](Interface.IMcpResourceMetadata) | Metadata describing an MCP resource registration. |
|
|
27
|
+
| [IMcpToolMetadata](Interface.IMcpToolMetadata) | Metadata describing an MCP tool registration. |
|
|
28
|
+
| [IRegisteredPrompt](Interface.IRegisteredPrompt) | Entry for a registered prompt handler. |
|
|
29
|
+
| [IRegisteredResource](Interface.IRegisteredResource) | Entry for a registered resource handler. |
|
|
30
|
+
| [IRegisteredTool](Interface.IRegisteredTool) | Entry for a registered tool handler. |
|
|
31
|
+
| [ISseTransportOptions](Interface.ISseTransportOptions) | Options for creating an SSE transport. |
|
|
32
|
+
| [IStreamableHttpTransportOptions](Interface.IStreamableHttpTransportOptions) | Options for creating a Streamable HTTP transport. |
|
|
34
33
|
|
|
35
34
|
## Variables
|
|
36
35
|
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
const MCP_MODULE_OPTIONS: typeof MCP_MODULE_OPTIONS;
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Defined in: [constants/McpTokens.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/constants/McpTokens.ts#L4)
|
|
44
|
-
|
|
45
|
-
Injection tokens used by the MCP module.
|
|
36
|
+
| Variable | Description |
|
|
37
|
+
| ------ | ------ |
|
|
38
|
+
| [MCP\_MODULE\_OPTIONS](Variable.MCP_MODULE_OPTIONS) | Injection tokens used by the MCP module. |
|
|
46
39
|
|
|
47
40
|
## Functions
|
|
48
41
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
Defined in: [decorators/McpPrompt.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpPrompt.ts#L15)
|
|
56
|
-
|
|
57
|
-
Marks a method as an MCP prompt handler.
|
|
58
|
-
|
|
59
|
-
The decorated method will be discovered at module initialization and registered
|
|
60
|
-
with the MCP server. The method receives the parsed prompt arguments and
|
|
61
|
-
should return an `MCP GetPromptResult`.
|
|
62
|
-
|
|
63
|
-
#### Parameters
|
|
64
|
-
|
|
65
|
-
| Parameter | Type | Description |
|
|
66
|
-
| --------- | ---------------------------------------------------- | ----------------------------- |
|
|
67
|
-
| `options` | [`IMcpPromptMetadata`](Interface.IMcpPromptMetadata) | Prompt registration metadata. |
|
|
68
|
-
|
|
69
|
-
#### Returns
|
|
70
|
-
|
|
71
|
-
`MethodDecorator`
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
### McpResource()
|
|
76
|
-
|
|
77
|
-
```ts
|
|
78
|
-
function McpResource(options): MethodDecorator;
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Defined in: [decorators/McpResource.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpResource.ts#L15)
|
|
82
|
-
|
|
83
|
-
Marks a method as an MCP resource handler.
|
|
84
|
-
|
|
85
|
-
The decorated method will be discovered at module initialization and registered
|
|
86
|
-
with the MCP server. The method receives the URI and parsed template parameters
|
|
87
|
-
as arguments and should return an `MCP ReadResourceResult`.
|
|
88
|
-
|
|
89
|
-
#### Parameters
|
|
90
|
-
|
|
91
|
-
| Parameter | Type | Description |
|
|
92
|
-
| --------- | -------------------------------------------------------- | ------------------------------- |
|
|
93
|
-
| `options` | [`IMcpResourceMetadata`](Interface.IMcpResourceMetadata) | Resource registration metadata. |
|
|
94
|
-
|
|
95
|
-
#### Returns
|
|
96
|
-
|
|
97
|
-
`MethodDecorator`
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
### McpTool()
|
|
102
|
-
|
|
103
|
-
```ts
|
|
104
|
-
function McpTool(options): MethodDecorator;
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Defined in: [decorators/McpTool.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mcp/src/decorators/McpTool.ts#L15)
|
|
108
|
-
|
|
109
|
-
Marks a method as an MCP tool handler.
|
|
110
|
-
|
|
111
|
-
The decorated method will be discovered at module initialization and registered
|
|
112
|
-
with the MCP server. The method receives the parsed input as its first argument
|
|
113
|
-
and should return an `MCP CallToolResult`.
|
|
114
|
-
|
|
115
|
-
#### Parameters
|
|
116
|
-
|
|
117
|
-
| Parameter | Type | Description |
|
|
118
|
-
| --------- | ------------------------------------------------ | --------------------------- |
|
|
119
|
-
| `options` | [`IMcpToolMetadata`](Interface.IMcpToolMetadata) | Tool registration metadata. |
|
|
120
|
-
|
|
121
|
-
#### Returns
|
|
122
|
-
|
|
123
|
-
`MethodDecorator`
|
|
42
|
+
| Function | Description |
|
|
43
|
+
| ------ | ------ |
|
|
44
|
+
| [McpPrompt](Function.McpPrompt) | Marks a method as an MCP prompt handler. |
|
|
45
|
+
| [McpResource](Function.McpResource) | Marks a method as an MCP resource handler. |
|
|
46
|
+
| [McpTool](Function.McpTool) | Marks a method as an MCP tool handler. |
|
|
@@ -3,11 +3,6 @@ title: 'Class: SwaggerFeatureDiscovery'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Class: SwaggerFeatureDiscovery
|
|
12
7
|
|
|
13
8
|
Defined in: [discovery/SwaggerFeatureDiscovery.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/discovery/SwaggerFeatureDiscovery.ts#L13)
|
|
@@ -40,15 +35,15 @@ Registers the default composite Swagger documents that aggregate the complete AP
|
|
|
40
35
|
|
|
41
36
|
#### Parameters
|
|
42
37
|
|
|
43
|
-
| Parameter
|
|
44
|
-
|
|
|
38
|
+
| Parameter | Type | Description |
|
|
39
|
+
| ------ | ------ | ------ |
|
|
45
40
|
| `featureRegistry` | [`SwaggerFeatureRegistry`](Class.SwaggerFeatureRegistry) | The registry that collects Swagger feature information. |
|
|
46
41
|
|
|
47
42
|
#### Returns
|
|
48
43
|
|
|
49
44
|
`void`
|
|
50
45
|
|
|
51
|
-
|
|
46
|
+
***
|
|
52
47
|
|
|
53
48
|
### registerDiscoveredFeatures()
|
|
54
49
|
|
|
@@ -62,8 +57,8 @@ Registers all discovered feature modules in the provided Swagger registry.
|
|
|
62
57
|
|
|
63
58
|
#### Parameters
|
|
64
59
|
|
|
65
|
-
| Parameter
|
|
66
|
-
|
|
|
60
|
+
| Parameter | Type | Description |
|
|
61
|
+
| ------ | ------ | ------ |
|
|
67
62
|
| `featureRegistry` | [`SwaggerFeatureRegistry`](Class.SwaggerFeatureRegistry) | The registry that collects Swagger feature information. |
|
|
68
63
|
|
|
69
64
|
#### Returns
|
|
@@ -3,11 +3,6 @@ title: 'Class: SwaggerFeatureRegistry'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Class: SwaggerFeatureRegistry
|
|
12
7
|
|
|
13
8
|
Defined in: [registry/SwaggerFeatureRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/SwaggerFeatureRegistry.ts#L15)
|
|
@@ -49,7 +44,7 @@ Finalize feature registration and prepare for use
|
|
|
49
44
|
|
|
50
45
|
`void`
|
|
51
46
|
|
|
52
|
-
|
|
47
|
+
***
|
|
53
48
|
|
|
54
49
|
### getFeatures()
|
|
55
50
|
|
|
@@ -65,7 +60,7 @@ Get all registered features
|
|
|
65
60
|
|
|
66
61
|
[`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig)[]
|
|
67
62
|
|
|
68
|
-
|
|
63
|
+
***
|
|
69
64
|
|
|
70
65
|
### getInstance()
|
|
71
66
|
|
|
@@ -81,7 +76,7 @@ Get the singleton instance of the registry service
|
|
|
81
76
|
|
|
82
77
|
`SwaggerFeatureRegistry` \| `null`
|
|
83
78
|
|
|
84
|
-
|
|
79
|
+
***
|
|
85
80
|
|
|
86
81
|
### registerFeature()
|
|
87
82
|
|
|
@@ -95,8 +90,8 @@ Register a new feature for Swagger documentation
|
|
|
95
90
|
|
|
96
91
|
#### Parameters
|
|
97
92
|
|
|
98
|
-
| Parameter | Type
|
|
99
|
-
|
|
|
93
|
+
| Parameter | Type | Description |
|
|
94
|
+
| ------ | ------ | ------ |
|
|
100
95
|
| `feature` | [`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig) | The feature configuration |
|
|
101
96
|
|
|
102
97
|
#### Returns
|
|
@@ -3,11 +3,6 @@ title: 'Class: SwaggerMultiDocumentService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Class: SwaggerMultiDocumentService
|
|
12
7
|
|
|
13
8
|
Defined in: [services/SwaggerMultiDocumentService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/services/SwaggerMultiDocumentService.ts#L13)
|
|
@@ -18,11 +13,11 @@ Defined in: [services/SwaggerMultiDocumentService.ts:13](https://github.com/RueD
|
|
|
18
13
|
|
|
19
14
|
```ts
|
|
20
15
|
new SwaggerMultiDocumentService(
|
|
21
|
-
app,
|
|
22
|
-
configService,
|
|
23
|
-
hostService,
|
|
24
|
-
featureRegistry,
|
|
25
|
-
resourceManager,
|
|
16
|
+
app,
|
|
17
|
+
configService,
|
|
18
|
+
hostService,
|
|
19
|
+
featureRegistry,
|
|
20
|
+
resourceManager,
|
|
26
21
|
contentTemplateEngine): SwaggerMultiDocumentService;
|
|
27
22
|
```
|
|
28
23
|
|
|
@@ -30,14 +25,14 @@ Defined in: [services/SwaggerMultiDocumentService.ts:29](https://github.com/RueD
|
|
|
30
25
|
|
|
31
26
|
#### Parameters
|
|
32
27
|
|
|
33
|
-
| Parameter
|
|
34
|
-
|
|
|
35
|
-
| `app`
|
|
36
|
-
| `configService`
|
|
37
|
-
| `hostService`
|
|
38
|
-
| `featureRegistry`
|
|
39
|
-
| `resourceManager`
|
|
40
|
-
| `contentTemplateEngine` | `ContentTemplateEngine`
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `app` | `INestApplication` |
|
|
31
|
+
| `configService` | `ConfigService` |
|
|
32
|
+
| `hostService` | `HostService` |
|
|
33
|
+
| `featureRegistry` | [`SwaggerFeatureRegistry`](Class.SwaggerFeatureRegistry) |
|
|
34
|
+
| `resourceManager` | `ResourceManager` |
|
|
35
|
+
| `contentTemplateEngine` | `ContentTemplateEngine` |
|
|
41
36
|
|
|
42
37
|
#### Returns
|
|
43
38
|
|
|
@@ -61,11 +56,11 @@ Generates OpenAPI documents for every registered feature without wiring HTTP rou
|
|
|
61
56
|
#### Returns
|
|
62
57
|
|
|
63
58
|
\{
|
|
64
|
-
`document`: `OpenAPIObject`;
|
|
65
|
-
`feature`: [`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig);
|
|
59
|
+
`document`: `OpenAPIObject`;
|
|
60
|
+
`feature`: [`IFeatureSwaggerConfig`](Interface.IFeatureSwaggerConfig);
|
|
66
61
|
\}[]
|
|
67
62
|
|
|
68
|
-
|
|
63
|
+
***
|
|
69
64
|
|
|
70
65
|
### setupMultipleSwaggerDocuments()
|
|
71
66
|
|
|
@@ -3,11 +3,6 @@ title: 'Class: SwaggerTheme'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Class: SwaggerTheme
|
|
12
7
|
|
|
13
8
|
Defined in: [SwaggerTheme.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/SwaggerTheme.ts#L14)
|
|
@@ -28,8 +23,8 @@ Constructs a new instance of the `SwaggerTheme` class.
|
|
|
28
23
|
|
|
29
24
|
#### Parameters
|
|
30
25
|
|
|
31
|
-
| Parameter
|
|
32
|
-
|
|
|
26
|
+
| Parameter | Type |
|
|
27
|
+
| ------ | ------ |
|
|
33
28
|
| `resourceManager` | `ResourceManager` |
|
|
34
29
|
|
|
35
30
|
#### Returns
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: Api()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: Api()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function Api(options): ClassDecorator & MethodDecorator & PropertyDecorator;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [decorators/Api.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/Api.ts#L21)
|
|
13
|
+
|
|
14
|
+
Custom Swagger Decorator
|
|
15
|
+
This decorator wraps all necessary Swagger decorators into one.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| ------ | ------ | ------ |
|
|
21
|
+
| `options` | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators. |
|
|
22
|
+
| `options.auth?` | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"` | - |
|
|
23
|
+
| `options.body?` | `ApiBodyOptions` | Options for the ApiBody decorator. |
|
|
24
|
+
| `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | - |
|
|
25
|
+
| `options.headers?` | `ApiHeaderOptions`[] | Options for the ApiHeaders decorator. |
|
|
26
|
+
| `options.operation?` | `Partial`\<`OperationObject`\> | Options for the ApiOperation decorator. |
|
|
27
|
+
| `options.params?` | `ApiParamOptions` \| `ApiParamOptions`[] | Options for the ApiParam decorator. |
|
|
28
|
+
| `options.query?` | `ApiQueryOptions` \| `ApiQueryOptions`[] | Options for the ApiQuery decorator (can be an array or single query). |
|
|
29
|
+
| `options.responses?` | `ApiResponseOptions` \| `ApiResponseOptions`[] | - |
|
|
30
|
+
| `options.scopes?` | `string`[] | - |
|
|
31
|
+
| `options.tags?` | `string` \| `string`[] | Options for the ApiTags decorator (can be an array or single tag). |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`ClassDecorator` & `MethodDecorator` & `PropertyDecorator`
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: SwaggerFeature()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: SwaggerFeature()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function SwaggerFeature(metadata): (target) => any;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [decorators/SwaggerFeature.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L94)
|
|
13
|
+
|
|
14
|
+
Decorator to register a module as a Swagger feature.
|
|
15
|
+
This allows the SwaggerMultiDocumentService to automatically discover and create documentation.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| ------ | ------ | ------ |
|
|
21
|
+
| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
(`target`) => `any`
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```typescript
|
|
30
|
+
@SwaggerFeature({
|
|
31
|
+
name: 'tip',
|
|
32
|
+
title: 'Strivio API - Tips',
|
|
33
|
+
description: 'API endpoints for tip management',
|
|
34
|
+
tag: 'Tip'
|
|
35
|
+
})
|
|
36
|
+
@Module({
|
|
37
|
+
controllers: [TipController],
|
|
38
|
+
providers: [TipService],
|
|
39
|
+
exports: [TipService]
|
|
40
|
+
})
|
|
41
|
+
export class TipModule {}
|
|
42
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: getRegisteredSwaggerFeatures()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: getRegisteredSwaggerFeatures()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function getRegisteredSwaggerFeatures(): ISwaggerFeatureMetadata[];
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [decorators/SwaggerFeature.ts:122](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L122)
|
|
13
|
+
|
|
14
|
+
Retrieves all Swagger features that have been registered through the decorator.
|
|
15
|
+
|
|
16
|
+
## Returns
|
|
17
|
+
|
|
18
|
+
[`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)[]
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: getSwaggerFeatureMetadata()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: getSwaggerFeatureMetadata()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function getSwaggerFeatureMetadata(target):
|
|
10
|
+
| ISwaggerFeatureMetadata
|
|
11
|
+
| undefined;
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Defined in: [decorators/SwaggerFeature.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L115)
|
|
15
|
+
|
|
16
|
+
Get the Swagger feature metadata from a module class
|
|
17
|
+
|
|
18
|
+
## Parameters
|
|
19
|
+
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `target` | `any` |
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
\| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
|
|
27
|
+
\| `undefined`
|
|
@@ -3,11 +3,6 @@ title: 'Interface: IFeatureSwaggerConfig'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Interface: IFeatureSwaggerConfig
|
|
12
7
|
|
|
13
8
|
Defined in: [registry/IFeatureSwaggerConfig.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L1)
|
|
@@ -22,7 +17,7 @@ readonly description: string;
|
|
|
22
17
|
|
|
23
18
|
Defined in: [registry/IFeatureSwaggerConfig.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L4)
|
|
24
19
|
|
|
25
|
-
|
|
20
|
+
***
|
|
26
21
|
|
|
27
22
|
### name
|
|
28
23
|
|
|
@@ -32,7 +27,7 @@ readonly name: string;
|
|
|
32
27
|
|
|
33
28
|
Defined in: [registry/IFeatureSwaggerConfig.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L2)
|
|
34
29
|
|
|
35
|
-
|
|
30
|
+
***
|
|
36
31
|
|
|
37
32
|
### path
|
|
38
33
|
|
|
@@ -42,7 +37,7 @@ readonly path: string;
|
|
|
42
37
|
|
|
43
38
|
Defined in: [registry/IFeatureSwaggerConfig.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L7)
|
|
44
39
|
|
|
45
|
-
|
|
40
|
+
***
|
|
46
41
|
|
|
47
42
|
### tag
|
|
48
43
|
|
|
@@ -52,7 +47,7 @@ readonly tag: string;
|
|
|
52
47
|
|
|
53
48
|
Defined in: [registry/IFeatureSwaggerConfig.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L5)
|
|
54
49
|
|
|
55
|
-
|
|
50
|
+
***
|
|
56
51
|
|
|
57
52
|
### tags
|
|
58
53
|
|
|
@@ -62,7 +57,7 @@ readonly tags: string[];
|
|
|
62
57
|
|
|
63
58
|
Defined in: [registry/IFeatureSwaggerConfig.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L6)
|
|
64
59
|
|
|
65
|
-
|
|
60
|
+
***
|
|
66
61
|
|
|
67
62
|
### title
|
|
68
63
|
|
|
@@ -3,11 +3,6 @@ title: 'Interface: ISwaggerFeatureMetadata'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-openapi**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# Interface: ISwaggerFeatureMetadata
|
|
12
7
|
|
|
13
8
|
Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)
|
|
@@ -22,7 +17,7 @@ readonly description: string;
|
|
|
22
17
|
|
|
23
18
|
Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L21)
|
|
24
19
|
|
|
25
|
-
|
|
20
|
+
***
|
|
26
21
|
|
|
27
22
|
### name
|
|
28
23
|
|
|
@@ -32,7 +27,7 @@ readonly name: string;
|
|
|
32
27
|
|
|
33
28
|
Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L19)
|
|
34
29
|
|
|
35
|
-
|
|
30
|
+
***
|
|
36
31
|
|
|
37
32
|
### path?
|
|
38
33
|
|
|
@@ -42,7 +37,7 @@ readonly optional path?: string;
|
|
|
42
37
|
|
|
43
38
|
Defined in: [decorators/SwaggerFeature.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L24)
|
|
44
39
|
|
|
45
|
-
|
|
40
|
+
***
|
|
46
41
|
|
|
47
42
|
### tag
|
|
48
43
|
|
|
@@ -52,7 +47,7 @@ readonly tag: string;
|
|
|
52
47
|
|
|
53
48
|
Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L22)
|
|
54
49
|
|
|
55
|
-
|
|
50
|
+
***
|
|
56
51
|
|
|
57
52
|
### tags
|
|
58
53
|
|
|
@@ -62,7 +57,7 @@ readonly tags: string[];
|
|
|
62
57
|
|
|
63
58
|
Defined in: [decorators/SwaggerFeature.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L23)
|
|
64
59
|
|
|
65
|
-
|
|
60
|
+
***
|
|
66
61
|
|
|
67
62
|
### title
|
|
68
63
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: APP\_VERSION'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: APP\_VERSION
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const APP_VERSION: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L12)
|
|
13
|
+
|
|
14
|
+
Application version shown in the Swagger document.
|