@breadstone/archipel-mcp 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/index.md +4 -2
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +20 -19
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +3 -2
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +22 -21
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +22 -21
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +20 -19
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +22 -21
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +4 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +3 -2
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +4 -3
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +2 -1
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +2 -1
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +2 -1
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +2 -1
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +2 -1
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +2 -1
- package/data/packages/platform-analytics/api/index.md +26 -25
- package/data/packages/platform-analytics/index.md +170 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +5 -4
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +16 -15
- package/data/packages/platform-authentication/api/Class.AuthModule.md +6 -5
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +11 -10
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +6 -5
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +27 -26
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +5 -4
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +17 -16
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +14 -13
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +5 -4
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +16 -15
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +11 -10
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +5 -4
- package/data/packages/platform-authentication/api/Class.MfaService.md +55 -54
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +9 -8
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +14 -13
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +6 -5
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +5 -4
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +26 -25
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +13 -12
- package/data/packages/platform-authentication/api/Class.SessionService.md +34 -33
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +10 -9
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +3 -2
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +3 -2
- package/data/packages/platform-authentication/api/Class.VerificationService.md +30 -29
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +17 -16
- package/data/packages/platform-authentication/api/Function.Token.md +1 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +3 -2
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +6 -5
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +8 -7
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +8 -7
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +6 -5
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +11 -10
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +1 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +4 -3
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +10 -9
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +8 -7
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +15 -14
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +6 -5
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +4 -3
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +6 -5
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +5 -4
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -1
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +4 -3
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +3 -2
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +3 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +2 -1
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +2 -1
- package/data/packages/platform-authentication/api/Variable.User.md +3 -2
- package/data/packages/platform-authentication/api/index.md +88 -86
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +24 -23
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +19 -18
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +6 -5
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +5 -4
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +13 -12
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +46 -45
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +8 -7
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +19 -18
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +6 -5
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +6 -5
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +3 -2
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +6 -5
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +3 -2
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +4 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +7 -6
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +9 -8
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +13 -12
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +15 -14
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +4 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +9 -8
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +2 -1
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +6 -5
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +6 -5
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +6 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +3 -2
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +2 -1
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +2 -1
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +2 -1
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +10 -9
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +11 -10
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +2 -1
- package/data/packages/platform-blob-storage/api/index.md +42 -41
- package/data/packages/platform-blob-storage/index.md +77 -22
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -2
- package/data/packages/platform-core/api/Class.BcryptService.md +8 -7
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +21 -20
- package/data/packages/platform-core/api/Class.BooleanUtils.md +13 -12
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +18 -17
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +11 -10
- package/data/packages/platform-core/api/Class.CatchUtils.md +16 -15
- package/data/packages/platform-core/api/Class.ConfigModule.md +8 -7
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +9 -8
- package/data/packages/platform-core/api/Class.ConfigService.md +27 -26
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +18 -17
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +5 -4
- package/data/packages/platform-core/api/Class.CryptoService.md +4 -3
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +13 -12
- package/data/packages/platform-core/api/Class.DeviceParserService.md +3 -2
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +23 -22
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -17
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +16 -15
- package/data/packages/platform-core/api/Class.EventHub.md +26 -25
- package/data/packages/platform-core/api/Class.EventModule.md +1 -0
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -19
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +20 -19
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +8 -7
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +8 -7
- package/data/packages/platform-core/api/Class.HealthModule.md +3 -2
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +4 -3
- package/data/packages/platform-core/api/Class.HostModule.md +2 -0
- package/data/packages/platform-core/api/Class.HostService.md +14 -13
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +9 -8
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +8 -7
- package/data/packages/platform-core/api/Class.IdentifierModule.md +4 -3
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +5 -4
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +11 -10
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +1 -0
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +7 -6
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +9 -8
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +2 -1
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +2 -1
- package/data/packages/platform-core/api/Class.MappingBuilder.md +19 -18
- package/data/packages/platform-core/api/Class.MappingModule.md +3 -2
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +6 -5
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +3 -2
- package/data/packages/platform-core/api/Class.MappingService.md +53 -52
- package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +38 -37
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +20 -19
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +21 -20
- package/data/packages/platform-core/api/Class.OtpService.md +9 -8
- package/data/packages/platform-core/api/Class.PageableRequest.md +2 -1
- package/data/packages/platform-core/api/Class.PageableResponse.md +4 -3
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +7 -6
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +12 -11
- package/data/packages/platform-core/api/Class.QuantityResponse.md +2 -1
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +40 -39
- package/data/packages/platform-core/api/Class.ResourceManager.md +89 -88
- package/data/packages/platform-core/api/Class.ResourceModule.md +4 -3
- package/data/packages/platform-core/api/Class.ResponseReturn.md +104 -102
- package/data/packages/platform-core/api/Class.SseHub.md +24 -23
- package/data/packages/platform-core/api/Class.SseModule.md +4 -3
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +2 -1
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +6 -5
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +8 -7
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +5 -4
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +5 -4
- package/data/packages/platform-core/api/Function.Public.md +1 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +9 -7
- package/data/packages/platform-core/api/Function.createEventKey.md +7 -6
- package/data/packages/platform-core/api/Function.createMappingKey.md +7 -6
- package/data/packages/platform-core/api/Function.env.md +5 -4
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +3 -2
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +5 -4
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +2 -1
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +6 -5
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +20 -19
- package/data/packages/platform-core/api/Interface.ICacheStats.md +5 -4
- package/data/packages/platform-core/api/Interface.IConfigKey.md +17 -16
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +4 -3
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +7 -6
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +7 -6
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -10
- package/data/packages/platform-core/api/Interface.IEventKey.md +8 -7
- package/data/packages/platform-core/api/Interface.IEventMap.md +1 -0
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +6 -5
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +4 -3
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +4 -3
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +9 -8
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +8 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +7 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +11 -10
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +6 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +4 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +4 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +7 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +5 -4
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +35 -34
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +5 -4
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +18 -17
- package/data/packages/platform-core/api/Interface.IMappingKey.md +8 -7
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +3 -2
- package/data/packages/platform-core/api/Interface.IOtpService.md +9 -8
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +3 -2
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +15 -14
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +5 -4
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +7 -6
- package/data/packages/platform-core/api/Interface.IResourceResult.md +2 -1
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +17 -16
- package/data/packages/platform-core/api/Interface.ISseEventData.md +4 -3
- package/data/packages/platform-core/api/Interface.ISseHub.md +17 -16
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -2
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +3 -2
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +3 -1
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +2 -1
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +6 -5
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +5 -4
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +5 -4
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +2 -4
- package/data/packages/platform-core/api/Variable.APP_PORT.md +2 -1
- package/data/packages/platform-core/api/Variable.APP_URL.md +2 -1
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +2 -1
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -1
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +3 -2
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +8 -7
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +10 -9
- package/data/packages/platform-core/api/Variable.IpAddress.md +7 -6
- package/data/packages/platform-core/api/Variable.Lang.md +6 -5
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -1
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -7
- package/data/packages/platform-core/api/Variable.UserAgent.md +3 -2
- package/data/packages/platform-core/api/index.md +161 -160
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +7 -6
- package/data/packages/platform-database/api/Class.DatabaseModule.md +6 -5
- package/data/packages/platform-database/api/Class.DatabaseService.md +20 -19
- package/data/packages/platform-database/api/Class.PrismaService.md +8 -7
- package/data/packages/platform-database/api/Class.RepositoryBase.md +127 -126
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +6 -5
- package/data/packages/platform-database/api/Function.pageable.md +10 -13
- package/data/packages/platform-database/api/Function.paginator.md +3 -2
- package/data/packages/platform-database/api/Function.query.md +8 -7
- package/data/packages/platform-database/api/Function.skip.md +6 -5
- package/data/packages/platform-database/api/Function.transactionalQuery.md +7 -6
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +1 -0
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +2 -1
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +5 -4
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +8 -7
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +6 -5
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +3 -2
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +3 -2
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +8 -7
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +4 -3
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +4 -3
- package/data/packages/platform-database/api/index.md +28 -27
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +33 -31
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +8 -7
- package/data/packages/platform-documents/api/Class.DocumentModule.md +3 -2
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +22 -21
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +7 -5
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +6 -5
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +9 -8
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +3 -2
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +4 -3
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +19 -18
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +4 -3
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +4 -3
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/index.md +29 -28
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +21 -20
- package/data/packages/platform-esigning/api/Class.EsigningError.md +5 -4
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +3 -2
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +10 -9
- package/data/packages/platform-esigning/api/Class.EsigningService.md +25 -24
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +25 -24
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +10 -9
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +4 -3
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +3 -2
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +7 -6
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +4 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +4 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +3 -2
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +4 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigner.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +11 -10
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +11 -10
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +5 -4
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +13 -12
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +15 -14
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +21 -20
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +19 -18
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +21 -20
- package/data/packages/platform-esigning/api/index.md +66 -65
- package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -0
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +2 -1
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-logging/api/index.md +8 -7
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -2
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +12 -11
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -2
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -4
- package/data/packages/platform-mailing/api/Class.MailModule.md +1 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +28 -27
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +13 -12
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +15 -14
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +3 -2
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +1 -0
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +2 -1
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +2 -1
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +3 -2
- package/data/packages/platform-mailing/api/index.md +55 -54
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +9 -8
- package/data/packages/platform-mcp/api/Class.McpModule.md +9 -8
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +17 -16
- package/data/packages/platform-mcp/api/Class.McpServerService.md +20 -19
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +3 -2
- package/data/packages/platform-mcp/api/Function.McpResource.md +3 -2
- package/data/packages/platform-mcp/api/Function.McpTool.md +3 -2
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +3 -2
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +9 -8
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +5 -4
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +6 -5
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +4 -3
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +1 -0
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +2 -1
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +2 -1
- package/data/packages/platform-mcp/api/index.md +27 -26
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +6 -5
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +6 -5
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +17 -16
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +3 -2
- package/data/packages/platform-openapi/api/Function.Api.md +14 -13
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -4
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +1 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +7 -8
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +6 -5
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +6 -5
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +2 -1
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +3 -2
- package/data/packages/platform-openapi/api/index.md +25 -24
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +8 -7
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +7 -6
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +8 -7
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +25 -24
- package/data/packages/platform-payments/api/Class.MollieClient.md +25 -24
- package/data/packages/platform-payments/api/Class.PaddleClient.md +25 -24
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +26 -25
- package/data/packages/platform-payments/api/Class.PaymentModule.md +3 -2
- package/data/packages/platform-payments/api/Class.StripeClient.md +25 -24
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +3 -2
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +5 -4
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +6 -5
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +7 -6
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +9 -8
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +3 -2
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +4 -3
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +10 -9
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +3 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +2 -1
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/index.md +41 -40
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +4 -3
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +4 -3
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +9 -8
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +1 -0
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +6 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +3 -2
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +1 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +13 -12
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +11 -10
- package/data/packages/platform-reporting/api/index.md +24 -23
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +23 -22
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +27 -26
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +24 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +36 -35
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +3 -2
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +5 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +23 -22
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +3 -2
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +9 -8
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +3 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +1 -0
- package/data/packages/platform-telemetry/api/index.md +21 -20
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ title: 'Class: EnvironmentConfigStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: EnvironmentConfigStrategy
|
|
7
8
|
|
|
8
9
|
Defined in: [config/strategies/EnvironmentConfigStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L14)
|
|
@@ -43,9 +44,9 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:58](https://github.c
|
|
|
43
44
|
|
|
44
45
|
#### Parameters
|
|
45
46
|
|
|
46
|
-
| Parameter | Type
|
|
47
|
-
|
|
|
48
|
-
| `key`
|
|
47
|
+
| Parameter | Type |
|
|
48
|
+
| --------- | -------- |
|
|
49
|
+
| `key` | `string` |
|
|
49
50
|
|
|
50
51
|
#### Returns
|
|
51
52
|
|
|
@@ -55,7 +56,7 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:58](https://github.c
|
|
|
55
56
|
|
|
56
57
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
|
|
57
58
|
|
|
58
|
-
|
|
59
|
+
---
|
|
59
60
|
|
|
60
61
|
### initialize()
|
|
61
62
|
|
|
@@ -75,7 +76,7 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:33](https://github.c
|
|
|
75
76
|
|
|
76
77
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
|
|
77
78
|
|
|
78
|
-
|
|
79
|
+
---
|
|
79
80
|
|
|
80
81
|
### resolve()
|
|
81
82
|
|
|
@@ -90,14 +91,14 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:37](https://github.c
|
|
|
90
91
|
#### Type Parameters
|
|
91
92
|
|
|
92
93
|
| Type Parameter |
|
|
93
|
-
|
|
|
94
|
-
| `T`
|
|
94
|
+
| -------------- |
|
|
95
|
+
| `T` |
|
|
95
96
|
|
|
96
97
|
#### Parameters
|
|
97
98
|
|
|
98
|
-
| Parameter | Type
|
|
99
|
-
|
|
|
100
|
-
| `key`
|
|
99
|
+
| Parameter | Type | Description |
|
|
100
|
+
| --------- | -------- | ------------------- |
|
|
101
|
+
| `key` | `string` | The key to resolve. |
|
|
101
102
|
|
|
102
103
|
#### Returns
|
|
103
104
|
|
|
@@ -109,7 +110,7 @@ The resolved configuration value.
|
|
|
109
110
|
|
|
110
111
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`resolve`](Class.ConfigStrategyBase#resolve)
|
|
111
112
|
|
|
112
|
-
|
|
113
|
+
---
|
|
113
114
|
|
|
114
115
|
### tryResolve()
|
|
115
116
|
|
|
@@ -122,15 +123,15 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:47](https://github.c
|
|
|
122
123
|
#### Type Parameters
|
|
123
124
|
|
|
124
125
|
| Type Parameter |
|
|
125
|
-
|
|
|
126
|
-
| `T`
|
|
126
|
+
| -------------- |
|
|
127
|
+
| `T` |
|
|
127
128
|
|
|
128
129
|
#### Parameters
|
|
129
130
|
|
|
130
|
-
| Parameter
|
|
131
|
-
|
|
|
132
|
-
| `key`
|
|
133
|
-
| `fallback` | `T`
|
|
131
|
+
| Parameter | Type |
|
|
132
|
+
| ---------- | -------- |
|
|
133
|
+
| `key` | `string` |
|
|
134
|
+
| `fallback` | `T` |
|
|
134
135
|
|
|
135
136
|
#### Returns
|
|
136
137
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: ErrorTemplateService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: ErrorTemplateService
|
|
7
8
|
|
|
8
9
|
Defined in: [services/ErrorTemplateService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L81)
|
|
@@ -15,8 +16,8 @@ Service for rendering error page templates.
|
|
|
15
16
|
|
|
16
17
|
```ts
|
|
17
18
|
new ErrorTemplateService(
|
|
18
|
-
configService,
|
|
19
|
-
contentTemplateEngine,
|
|
19
|
+
configService,
|
|
20
|
+
contentTemplateEngine,
|
|
20
21
|
resourceManager): ErrorTemplateService;
|
|
21
22
|
```
|
|
22
23
|
|
|
@@ -26,11 +27,11 @@ Constructs a new instance of the `ErrorTemplateService` class.
|
|
|
26
27
|
|
|
27
28
|
#### Parameters
|
|
28
29
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
31
|
-
| `configService`
|
|
30
|
+
| Parameter | Type |
|
|
31
|
+
| ----------------------- | ------------------------------------------------------ |
|
|
32
|
+
| `configService` | [`ConfigService`](Class.ConfigService) |
|
|
32
33
|
| `contentTemplateEngine` | [`ContentTemplateEngine`](Class.ContentTemplateEngine) |
|
|
33
|
-
| `resourceManager`
|
|
34
|
+
| `resourceManager` | [`ResourceManager`](Class.ResourceManager) |
|
|
34
35
|
|
|
35
36
|
#### Returns
|
|
36
37
|
|
|
@@ -50,8 +51,8 @@ Gets a human-readable error message based on status code.
|
|
|
50
51
|
|
|
51
52
|
#### Parameters
|
|
52
53
|
|
|
53
|
-
| Parameter
|
|
54
|
-
|
|
|
54
|
+
| Parameter | Type | Description |
|
|
55
|
+
| ------------ | -------- | --------------------- |
|
|
55
56
|
| `statusCode` | `number` | The HTTP status code. |
|
|
56
57
|
|
|
57
58
|
#### Returns
|
|
@@ -60,7 +61,7 @@ Gets a human-readable error message based on status code.
|
|
|
60
61
|
|
|
61
62
|
The error message.
|
|
62
63
|
|
|
63
|
-
|
|
64
|
+
---
|
|
64
65
|
|
|
65
66
|
### getErrorPageContent()
|
|
66
67
|
|
|
@@ -74,9 +75,9 @@ Retrieves the error page HTML content.
|
|
|
74
75
|
|
|
75
76
|
#### Parameters
|
|
76
77
|
|
|
77
|
-
| Parameter | Type
|
|
78
|
-
|
|
|
79
|
-
| `params`
|
|
78
|
+
| Parameter | Type | Description |
|
|
79
|
+
| --------- | ------------------------------------------------ | -------------------------- |
|
|
80
|
+
| `params` | [`IErrorPageParams`](Interface.IErrorPageParams) | The error page parameters. |
|
|
80
81
|
|
|
81
82
|
#### Returns
|
|
82
83
|
|
|
@@ -84,7 +85,7 @@ Retrieves the error page HTML content.
|
|
|
84
85
|
|
|
85
86
|
The rendered HTML content.
|
|
86
87
|
|
|
87
|
-
|
|
88
|
+
---
|
|
88
89
|
|
|
89
90
|
### getErrorTitle()
|
|
90
91
|
|
|
@@ -98,8 +99,8 @@ Gets a human-readable error title based on status code.
|
|
|
98
99
|
|
|
99
100
|
#### Parameters
|
|
100
101
|
|
|
101
|
-
| Parameter
|
|
102
|
-
|
|
|
102
|
+
| Parameter | Type | Description |
|
|
103
|
+
| ------------ | -------- | --------------------- |
|
|
103
104
|
| `statusCode` | `number` | The HTTP status code. |
|
|
104
105
|
|
|
105
106
|
#### Returns
|
|
@@ -3,6 +3,7 @@ title: 'Class: EventHub'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: EventHub
|
|
7
8
|
|
|
8
9
|
Defined in: [events/EventHub.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L38)
|
|
@@ -61,15 +62,15 @@ Returns an observable that emits payloads for the specified event.
|
|
|
61
62
|
|
|
62
63
|
#### Type Parameters
|
|
63
64
|
|
|
64
|
-
| Type Parameter
|
|
65
|
-
|
|
|
66
|
-
| `TEvents`
|
|
67
|
-
| `TKey`
|
|
65
|
+
| Type Parameter |
|
|
66
|
+
| ------------------------------------------------------ |
|
|
67
|
+
| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
|
|
68
|
+
| `TKey` _extends_ `string` \| `number` \| `symbol` |
|
|
68
69
|
|
|
69
70
|
#### Parameters
|
|
70
71
|
|
|
71
|
-
| Parameter
|
|
72
|
-
|
|
|
72
|
+
| Parameter | Type | Description |
|
|
73
|
+
| ---------- | ------------------------------------------------------- | ------------------------ |
|
|
73
74
|
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to observe |
|
|
74
75
|
|
|
75
76
|
#### Returns
|
|
@@ -78,7 +79,7 @@ Returns an observable that emits payloads for the specified event.
|
|
|
78
79
|
|
|
79
80
|
An observable sequence that emits payloads of the specified event
|
|
80
81
|
|
|
81
|
-
|
|
82
|
+
---
|
|
82
83
|
|
|
83
84
|
### onModuleDestroy()
|
|
84
85
|
|
|
@@ -97,10 +98,10 @@ Completes the event stream when the module is destroyed.
|
|
|
97
98
|
#### Implementation of
|
|
98
99
|
|
|
99
100
|
```ts
|
|
100
|
-
OnModuleDestroy.onModuleDestroy
|
|
101
|
+
OnModuleDestroy.onModuleDestroy;
|
|
101
102
|
```
|
|
102
103
|
|
|
103
|
-
|
|
104
|
+
---
|
|
104
105
|
|
|
105
106
|
### publish()
|
|
106
107
|
|
|
@@ -114,23 +115,23 @@ Publishes an event with the specified payload to all subscribers.
|
|
|
114
115
|
|
|
115
116
|
#### Type Parameters
|
|
116
117
|
|
|
117
|
-
| Type Parameter
|
|
118
|
-
|
|
|
119
|
-
| `TEvents`
|
|
120
|
-
| `TKey`
|
|
118
|
+
| Type Parameter |
|
|
119
|
+
| ------------------------------------------------------ |
|
|
120
|
+
| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
|
|
121
|
+
| `TKey` _extends_ `string` \| `number` \| `symbol` |
|
|
121
122
|
|
|
122
123
|
#### Parameters
|
|
123
124
|
|
|
124
|
-
| Parameter
|
|
125
|
-
|
|
|
125
|
+
| Parameter | Type | Description |
|
|
126
|
+
| ---------- | ------------------------------------------------------- | ------------------------------------------ |
|
|
126
127
|
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key identifying the target event |
|
|
127
|
-
| `payload`
|
|
128
|
+
| `payload` | `TEvents`\[`TKey`\] | The payload associated with the event |
|
|
128
129
|
|
|
129
130
|
#### Returns
|
|
130
131
|
|
|
131
132
|
`void`
|
|
132
133
|
|
|
133
|
-
|
|
134
|
+
---
|
|
134
135
|
|
|
135
136
|
### subscribe()
|
|
136
137
|
|
|
@@ -144,17 +145,17 @@ Subscribes to the specified event and invokes the handler whenever the event is
|
|
|
144
145
|
|
|
145
146
|
#### Type Parameters
|
|
146
147
|
|
|
147
|
-
| Type Parameter
|
|
148
|
-
|
|
|
149
|
-
| `TEvents`
|
|
150
|
-
| `TKey`
|
|
148
|
+
| Type Parameter |
|
|
149
|
+
| ------------------------------------------------------ |
|
|
150
|
+
| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
|
|
151
|
+
| `TKey` _extends_ `string` \| `number` \| `symbol` |
|
|
151
152
|
|
|
152
153
|
#### Parameters
|
|
153
154
|
|
|
154
|
-
| Parameter
|
|
155
|
-
|
|
|
156
|
-
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to subscribe to
|
|
157
|
-
| `handler`
|
|
155
|
+
| Parameter | Type | Description |
|
|
156
|
+
| ---------- | ------------------------------------------------------- | ----------------------------------------------------- |
|
|
157
|
+
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to subscribe to |
|
|
158
|
+
| `handler` | (`payload`) => `void` | The handler that is invoked when the event is emitted |
|
|
158
159
|
|
|
159
160
|
#### Returns
|
|
160
161
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: FileConfigStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: FileConfigStrategy
|
|
7
8
|
|
|
8
9
|
Defined in: [config/strategies/FileConfigStrategy.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/FileConfigStrategy.ts#L16)
|
|
@@ -25,8 +26,8 @@ Defined in: [config/strategies/FileConfigStrategy.ts:27](https://github.com/RueD
|
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
28
|
-
| Parameter | Type
|
|
29
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| --------- | -------- |
|
|
30
31
|
| `envFile` | `string` |
|
|
31
32
|
|
|
32
33
|
#### Returns
|
|
@@ -49,9 +50,9 @@ Defined in: [config/strategies/FileConfigStrategy.ts:64](https://github.com/RueD
|
|
|
49
50
|
|
|
50
51
|
#### Parameters
|
|
51
52
|
|
|
52
|
-
| Parameter | Type
|
|
53
|
-
|
|
|
54
|
-
| `key`
|
|
53
|
+
| Parameter | Type |
|
|
54
|
+
| --------- | -------- |
|
|
55
|
+
| `key` | `string` |
|
|
55
56
|
|
|
56
57
|
#### Returns
|
|
57
58
|
|
|
@@ -61,7 +62,7 @@ Defined in: [config/strategies/FileConfigStrategy.ts:64](https://github.com/RueD
|
|
|
61
62
|
|
|
62
63
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
|
|
63
64
|
|
|
64
|
-
|
|
65
|
+
---
|
|
65
66
|
|
|
66
67
|
### initialize()
|
|
67
68
|
|
|
@@ -81,7 +82,7 @@ Defined in: [config/strategies/FileConfigStrategy.ts:37](https://github.com/RueD
|
|
|
81
82
|
|
|
82
83
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
|
|
83
84
|
|
|
84
|
-
|
|
85
|
+
---
|
|
85
86
|
|
|
86
87
|
### resolve()
|
|
87
88
|
|
|
@@ -96,14 +97,14 @@ Defined in: [config/strategies/FileConfigStrategy.ts:43](https://github.com/RueD
|
|
|
96
97
|
#### Type Parameters
|
|
97
98
|
|
|
98
99
|
| Type Parameter |
|
|
99
|
-
|
|
|
100
|
-
| `T`
|
|
100
|
+
| -------------- |
|
|
101
|
+
| `T` |
|
|
101
102
|
|
|
102
103
|
#### Parameters
|
|
103
104
|
|
|
104
|
-
| Parameter | Type
|
|
105
|
-
|
|
|
106
|
-
| `key`
|
|
105
|
+
| Parameter | Type | Description |
|
|
106
|
+
| --------- | -------- | ------------------- |
|
|
107
|
+
| `key` | `string` | The key to resolve. |
|
|
107
108
|
|
|
108
109
|
#### Returns
|
|
109
110
|
|
|
@@ -115,7 +116,7 @@ The resolved configuration value.
|
|
|
115
116
|
|
|
116
117
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`resolve`](Class.ConfigStrategyBase#resolve)
|
|
117
118
|
|
|
118
|
-
|
|
119
|
+
---
|
|
119
120
|
|
|
120
121
|
### tryResolve()
|
|
121
122
|
|
|
@@ -128,15 +129,15 @@ Defined in: [config/strategies/FileConfigStrategy.ts:53](https://github.com/RueD
|
|
|
128
129
|
#### Type Parameters
|
|
129
130
|
|
|
130
131
|
| Type Parameter |
|
|
131
|
-
|
|
|
132
|
-
| `T`
|
|
132
|
+
| -------------- |
|
|
133
|
+
| `T` |
|
|
133
134
|
|
|
134
135
|
#### Parameters
|
|
135
136
|
|
|
136
|
-
| Parameter
|
|
137
|
-
|
|
|
138
|
-
| `key`
|
|
139
|
-
| `fallback` | `T`
|
|
137
|
+
| Parameter | Type |
|
|
138
|
+
| ---------- | -------- |
|
|
139
|
+
| `key` | `string` |
|
|
140
|
+
| `fallback` | `T` |
|
|
140
141
|
|
|
141
142
|
#### Returns
|
|
142
143
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: FileResourceStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: FileResourceStrategy
|
|
7
8
|
|
|
8
9
|
Defined in: [resources/strategies/FileResourceStrategy.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/FileResourceStrategy.ts#L47)
|
|
@@ -27,9 +28,9 @@ Constructs a new instance of the `FileResourceStrategy` class.
|
|
|
27
28
|
|
|
28
29
|
#### Parameters
|
|
29
30
|
|
|
30
|
-
| Parameter | Type
|
|
31
|
-
|
|
|
32
|
-
| `config`
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| --------- | ---------------------------------------------------------------------- |
|
|
33
|
+
| `config` | [`IFileResourceStrategyConfig`](Interface.IFileResourceStrategyConfig) |
|
|
33
34
|
|
|
34
35
|
#### Returns
|
|
35
36
|
|
|
@@ -73,9 +74,9 @@ Checks if a resource exists without loading it.
|
|
|
73
74
|
|
|
74
75
|
#### Parameters
|
|
75
76
|
|
|
76
|
-
| Parameter | Type
|
|
77
|
-
|
|
|
78
|
-
| `key`
|
|
77
|
+
| Parameter | Type | Description |
|
|
78
|
+
| --------- | -------- | ---------------- |
|
|
79
|
+
| `key` | `string` | The resource key |
|
|
79
80
|
|
|
80
81
|
#### Returns
|
|
81
82
|
|
|
@@ -87,7 +88,7 @@ True if the resource exists
|
|
|
87
88
|
|
|
88
89
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
|
|
89
90
|
|
|
90
|
-
|
|
91
|
+
---
|
|
91
92
|
|
|
92
93
|
### existsAsync()
|
|
93
94
|
|
|
@@ -101,9 +102,9 @@ Checks if a resource exists without loading it (asynchronous).
|
|
|
101
102
|
|
|
102
103
|
#### Parameters
|
|
103
104
|
|
|
104
|
-
| Parameter | Type
|
|
105
|
-
|
|
|
106
|
-
| `key`
|
|
105
|
+
| Parameter | Type | Description |
|
|
106
|
+
| --------- | -------- | ---------------- |
|
|
107
|
+
| `key` | `string` | The resource key |
|
|
107
108
|
|
|
108
109
|
#### Returns
|
|
109
110
|
|
|
@@ -115,7 +116,7 @@ Promise resolving to true if the resource exists
|
|
|
115
116
|
|
|
116
117
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
|
|
117
118
|
|
|
118
|
-
|
|
119
|
+
---
|
|
119
120
|
|
|
120
121
|
### load()
|
|
121
122
|
|
|
@@ -129,9 +130,9 @@ Loads a resource by its key.
|
|
|
129
130
|
|
|
130
131
|
#### Parameters
|
|
131
132
|
|
|
132
|
-
| Parameter | Type
|
|
133
|
-
|
|
|
134
|
-
| `key`
|
|
133
|
+
| Parameter | Type | Description |
|
|
134
|
+
| --------- | -------- | ---------------- |
|
|
135
|
+
| `key` | `string` | The resource key |
|
|
135
136
|
|
|
136
137
|
#### Returns
|
|
137
138
|
|
|
@@ -143,7 +144,7 @@ The resource result or undefined if not found
|
|
|
143
144
|
|
|
144
145
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
|
|
145
146
|
|
|
146
|
-
|
|
147
|
+
---
|
|
147
148
|
|
|
148
149
|
### loadAsync()
|
|
149
150
|
|
|
@@ -157,9 +158,9 @@ Loads a resource by its key (asynchronous).
|
|
|
157
158
|
|
|
158
159
|
#### Parameters
|
|
159
160
|
|
|
160
|
-
| Parameter | Type
|
|
161
|
-
|
|
|
162
|
-
| `key`
|
|
161
|
+
| Parameter | Type | Description |
|
|
162
|
+
| --------- | -------- | ---------------- |
|
|
163
|
+
| `key` | `string` | The resource key |
|
|
163
164
|
|
|
164
165
|
#### Returns
|
|
165
166
|
|
|
@@ -171,7 +172,7 @@ Promise resolving to the resource result or undefined if not found
|
|
|
171
172
|
|
|
172
173
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
|
|
173
174
|
|
|
174
|
-
|
|
175
|
+
---
|
|
175
176
|
|
|
176
177
|
### whatDoIHave()
|
|
177
178
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: GUIDGenerator'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: GUIDGenerator
|
|
7
8
|
|
|
8
9
|
Defined in: [identifiers/generators/GUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/GUIDGenerator.ts#L14)
|
|
@@ -43,9 +44,9 @@ Generates a GUID (variant of UUID)
|
|
|
43
44
|
|
|
44
45
|
#### Parameters
|
|
45
46
|
|
|
46
|
-
| Parameter
|
|
47
|
-
|
|
|
48
|
-
| `prefix?`
|
|
47
|
+
| Parameter | Type | Description |
|
|
48
|
+
| ---------- | -------- | ------------------------------------ |
|
|
49
|
+
| `prefix?` | `string` | Optional prefix to prepend to the ID |
|
|
49
50
|
| `postfix?` | `string` | Optional postfix to append to the ID |
|
|
50
51
|
|
|
51
52
|
#### Returns
|
|
@@ -56,7 +57,7 @@ Generates a GUID (variant of UUID)
|
|
|
56
57
|
|
|
57
58
|
[`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
|
|
58
59
|
|
|
59
|
-
|
|
60
|
+
---
|
|
60
61
|
|
|
61
62
|
### isValid()
|
|
62
63
|
|
|
@@ -70,9 +71,9 @@ Validates if the provided string is a valid GUID
|
|
|
70
71
|
|
|
71
72
|
#### Parameters
|
|
72
73
|
|
|
73
|
-
| Parameter | Type
|
|
74
|
-
|
|
|
75
|
-
| `id`
|
|
74
|
+
| Parameter | Type | Description |
|
|
75
|
+
| --------- | -------- | ------------------ |
|
|
76
|
+
| `id` | `string` | The ID to validate |
|
|
76
77
|
|
|
77
78
|
#### Returns
|
|
78
79
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: GlobalExceptionFilter'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: GlobalExceptionFilter
|
|
7
8
|
|
|
8
9
|
Defined in: [filters/GlobalExceptionFilter.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/GlobalExceptionFilter.ts#L17)
|
|
@@ -28,8 +29,8 @@ Constructs a new instance of the `GlobalExceptionFilter` class.
|
|
|
28
29
|
|
|
29
30
|
#### Parameters
|
|
30
31
|
|
|
31
|
-
| Parameter
|
|
32
|
-
|
|
|
32
|
+
| Parameter | Type | Description |
|
|
33
|
+
| ----------------------- | ---------------------------------------------------- | --------------------------------------------------- |
|
|
33
34
|
| `errorTemplateService?` | [`ErrorTemplateService`](Class.ErrorTemplateService) | Optional error template service for HTML rendering. |
|
|
34
35
|
|
|
35
36
|
#### Returns
|
|
@@ -50,10 +51,10 @@ Catches the exception and formats the response.
|
|
|
50
51
|
|
|
51
52
|
#### Parameters
|
|
52
53
|
|
|
53
|
-
| Parameter
|
|
54
|
-
|
|
|
55
|
-
| `exception` | `unknown`
|
|
56
|
-
| `host`
|
|
54
|
+
| Parameter | Type | Description |
|
|
55
|
+
| ----------- | --------------- | --------------------- |
|
|
56
|
+
| `exception` | `unknown` | The caught exception. |
|
|
57
|
+
| `host` | `ArgumentsHost` | The arguments host. |
|
|
57
58
|
|
|
58
59
|
#### Returns
|
|
59
60
|
|
|
@@ -62,5 +63,5 @@ Catches the exception and formats the response.
|
|
|
62
63
|
#### Implementation of
|
|
63
64
|
|
|
64
65
|
```ts
|
|
65
|
-
ExceptionFilter.catch
|
|
66
|
+
ExceptionFilter.catch;
|
|
66
67
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Class: HealthModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: HealthModule
|
|
7
8
|
|
|
8
9
|
Defined in: [health/HealthModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthModule.ts#L21)
|
|
@@ -33,8 +34,8 @@ Registers additional health indicators.
|
|
|
33
34
|
|
|
34
35
|
#### Parameters
|
|
35
36
|
|
|
36
|
-
| Parameter
|
|
37
|
-
|
|
|
37
|
+
| Parameter | Type | Description |
|
|
38
|
+
| ------------ | ------------------------------------------------------------ | -------------------------------------------------------- |
|
|
38
39
|
| `indicators` | `Type`\<[`IHealthIndicator`](Interface.IHealthIndicator)\>[] | Array of indicator classes implementing IHealthIndicator |
|
|
39
40
|
|
|
40
41
|
#### Returns
|
|
@@ -3,6 +3,7 @@ title: 'Class: HealthOrchestrator'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: HealthOrchestrator
|
|
7
8
|
|
|
8
9
|
Defined in: [health/HealthOrchestrator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthOrchestrator.ts#L15)
|
|
@@ -41,7 +42,7 @@ Executes all registered health indicators and aggregates their results.
|
|
|
41
42
|
|
|
42
43
|
The aggregated health check results.
|
|
43
44
|
|
|
44
|
-
|
|
45
|
+
---
|
|
45
46
|
|
|
46
47
|
### registerIndicator()
|
|
47
48
|
|
|
@@ -55,8 +56,8 @@ Registers a health indicator.
|
|
|
55
56
|
|
|
56
57
|
#### Parameters
|
|
57
58
|
|
|
58
|
-
| Parameter
|
|
59
|
-
|
|
|
59
|
+
| Parameter | Type | Description |
|
|
60
|
+
| ----------- | ------------------------------------------------ | --------------------------------- |
|
|
60
61
|
| `indicator` | [`IHealthIndicator`](Interface.IHealthIndicator) | The health indicator to register. |
|
|
61
62
|
|
|
62
63
|
#### Returns
|
|
@@ -3,6 +3,7 @@ title: 'Class: HostModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: HostModule
|
|
7
8
|
|
|
8
9
|
Defined in: [host/HostModule.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/host/HostModule.ts#L33)
|
|
@@ -10,6 +11,7 @@ Defined in: [host/HostModule.ts:33](https://github.com/RueDeRennes/archipel/blob
|
|
|
10
11
|
The `HostModule` provides host-related services globally.
|
|
11
12
|
|
|
12
13
|
This module exports:
|
|
14
|
+
|
|
13
15
|
- `HostService`: Provides access to host configuration (host URL, stage, version, etc.)
|
|
14
16
|
- `ContentTemplateEngine`: Template engine for rendering dynamic content
|
|
15
17
|
|