@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,241 +3,61 @@ title: '@breadstone/archipel-platform-payments'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
[**@breadstone/archipel-platform-payments**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
6
|
# @breadstone/archipel-platform-payments
|
|
12
7
|
|
|
13
8
|
## Classes
|
|
14
9
|
|
|
15
|
-
| Class
|
|
16
|
-
|
|
|
17
|
-
| [FeatureAccessPort](Class.FeatureAccessPort)
|
|
18
|
-
| [FeatureGuard](Class.FeatureGuard)
|
|
19
|
-
| [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort).
|
|
20
|
-
| [LemonSqueezyClient](Class.LemonSqueezyClient)
|
|
21
|
-
| [MollieClient](Class.MollieClient)
|
|
22
|
-
| [PaddleClient](Class.PaddleClient)
|
|
23
|
-
| [PaymentClientPort](Class.PaymentClientPort)
|
|
24
|
-
| [PaymentModule](Class.PaymentModule)
|
|
25
|
-
| [StripeClient](Class.StripeClient)
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [FeatureAccessPort](Class.FeatureAccessPort) | Abstract port for checking and recording feature usage. Consuming projects must provide a concrete implementation (e.g. backed by Prisma with subscription + usage tables) and register it via `PaymentModule.register()`. |
|
|
13
|
+
| [FeatureGuard](Class.FeatureGuard) | Guard that checks if the user has access to a specific feature by delegating to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
|
|
14
|
+
| [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
|
|
15
|
+
| [LemonSqueezyClient](Class.LemonSqueezyClient) | LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK. |
|
|
16
|
+
| [MollieClient](Class.MollieClient) | Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@mollie/api-client` to interact with the Mollie API. |
|
|
17
|
+
| [PaddleClient](Class.PaddleClient) | Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API. |
|
|
18
|
+
| [PaymentClientPort](Class.PaymentClientPort) | Abstract port for payment provider clients. Each provider (Stripe, Paddle, LemonSqueezy, Mollie) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
19
|
+
| [PaymentModule](Class.PaymentModule) | NestJS module providing generic payment infrastructure. Exposes a configurable payment client, a feature-gating guard, and a usage-tracking interceptor. The specific payment provider (Stripe, Paddle, LemonSqueezy, Mollie) is selected via the options. |
|
|
20
|
+
| [StripeClient](Class.StripeClient) | Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort). All Stripe-specific types and logic are encapsulated here. |
|
|
26
21
|
|
|
27
22
|
## Interfaces
|
|
28
23
|
|
|
29
|
-
| Interface
|
|
30
|
-
|
|
|
31
|
-
| [IFeatureAccessResult](Interface.IFeatureAccessResult)
|
|
32
|
-
| [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session.
|
|
33
|
-
| [INormalizedPrice](Interface.INormalizedPrice)
|
|
34
|
-
| [INormalizedSubscription](Interface.INormalizedSubscription)
|
|
35
|
-
| [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent)
|
|
36
|
-
| [IPaymentModuleOptions](Interface.IPaymentModuleOptions)
|
|
24
|
+
| Interface | Description |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| [IFeatureAccessResult](Interface.IFeatureAccessResult) | Result of a feature access check. |
|
|
27
|
+
| [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session. |
|
|
28
|
+
| [INormalizedPrice](Interface.INormalizedPrice) | Normalized price information. |
|
|
29
|
+
| [INormalizedSubscription](Interface.INormalizedSubscription) | Normalized subscription. |
|
|
30
|
+
| [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent) | Normalized webhook event. |
|
|
31
|
+
| [IPaymentModuleOptions](Interface.IPaymentModuleOptions) | Configuration options for the `PaymentModule`. |
|
|
37
32
|
|
|
38
33
|
## Type Aliases
|
|
39
34
|
|
|
40
|
-
| Type Alias
|
|
41
|
-
|
|
|
35
|
+
| Type Alias | Description |
|
|
36
|
+
| ------ | ------ |
|
|
42
37
|
| [SubscriptionStatus](TypeAlias.SubscriptionStatus) | Normalized subscription status values. |
|
|
43
38
|
|
|
44
39
|
## Variables
|
|
45
40
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
LemonSqueezy API key.
|
|
65
|
-
|
|
66
|
-
---
|
|
67
|
-
|
|
68
|
-
### LEMONSQUEEZY_CONFIG_ENTRIES
|
|
69
|
-
|
|
70
|
-
```ts
|
|
71
|
-
const LEMONSQUEEZY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Defined in: [lemonsqueezy/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L25)
|
|
75
|
-
|
|
76
|
-
Configuration entries required by the LemonSqueezy payment provider.
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
### LEMONSQUEEZY_STORE_ID
|
|
81
|
-
|
|
82
|
-
```ts
|
|
83
|
-
const LEMONSQUEEZY_STORE_ID: IConfigKey<string>;
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
Defined in: [lemonsqueezy/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L18)
|
|
87
|
-
|
|
88
|
-
LemonSqueezy store ID.
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
### LEMONSQUEEZY_WEBHOOK_SECRET
|
|
93
|
-
|
|
94
|
-
```ts
|
|
95
|
-
const LEMONSQUEEZY_WEBHOOK_SECRET: IConfigKey<string>;
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Defined in: [lemonsqueezy/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L15)
|
|
99
|
-
|
|
100
|
-
LemonSqueezy webhook signing secret.
|
|
101
|
-
|
|
102
|
-
---
|
|
103
|
-
|
|
104
|
-
### MOLLIE_API_KEY
|
|
105
|
-
|
|
106
|
-
```ts
|
|
107
|
-
const MOLLIE_API_KEY: IConfigKey<string>;
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
Defined in: [mollie/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L12)
|
|
111
|
-
|
|
112
|
-
Mollie API key.
|
|
113
|
-
|
|
114
|
-
---
|
|
115
|
-
|
|
116
|
-
### MOLLIE_CONFIG_ENTRIES
|
|
117
|
-
|
|
118
|
-
```ts
|
|
119
|
-
const MOLLIE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
120
|
-
```
|
|
121
|
-
|
|
122
|
-
Defined in: [mollie/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L22)
|
|
123
|
-
|
|
124
|
-
Configuration entries required by the Mollie payment provider.
|
|
125
|
-
|
|
126
|
-
---
|
|
127
|
-
|
|
128
|
-
### MOLLIE_WEBHOOK_SECRET
|
|
129
|
-
|
|
130
|
-
```ts
|
|
131
|
-
const MOLLIE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
Defined in: [mollie/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L15)
|
|
135
|
-
|
|
136
|
-
Mollie webhook secret for verifying webhook payloads.
|
|
137
|
-
|
|
138
|
-
---
|
|
139
|
-
|
|
140
|
-
### PADDLE_API_KEY
|
|
141
|
-
|
|
142
|
-
```ts
|
|
143
|
-
const PADDLE_API_KEY: IConfigKey<string>;
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
Defined in: [paddle/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L12)
|
|
147
|
-
|
|
148
|
-
Paddle API key.
|
|
149
|
-
|
|
150
|
-
---
|
|
151
|
-
|
|
152
|
-
### PADDLE_CONFIG_ENTRIES
|
|
153
|
-
|
|
154
|
-
```ts
|
|
155
|
-
const PADDLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
Defined in: [paddle/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L25)
|
|
159
|
-
|
|
160
|
-
Configuration entries required by the Paddle payment provider.
|
|
161
|
-
|
|
162
|
-
---
|
|
163
|
-
|
|
164
|
-
### PADDLE_ENVIRONMENT
|
|
165
|
-
|
|
166
|
-
```ts
|
|
167
|
-
const PADDLE_ENVIRONMENT: IConfigKey<string>;
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
Defined in: [paddle/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L18)
|
|
171
|
-
|
|
172
|
-
Paddle environment (`production` or `sandbox`). Defaults to `production`.
|
|
173
|
-
|
|
174
|
-
---
|
|
175
|
-
|
|
176
|
-
### PADDLE_WEBHOOK_SECRET
|
|
177
|
-
|
|
178
|
-
```ts
|
|
179
|
-
const PADDLE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
Defined in: [paddle/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L15)
|
|
183
|
-
|
|
184
|
-
Paddle webhook secret key.
|
|
185
|
-
|
|
186
|
-
---
|
|
187
|
-
|
|
188
|
-
### STRIPE_API_KEY
|
|
189
|
-
|
|
190
|
-
```ts
|
|
191
|
-
const STRIPE_API_KEY: IConfigKey<string>;
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
Defined in: [stripe/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L12)
|
|
195
|
-
|
|
196
|
-
Stripe secret API key.
|
|
197
|
-
|
|
198
|
-
---
|
|
199
|
-
|
|
200
|
-
### STRIPE_CONFIG_ENTRIES
|
|
201
|
-
|
|
202
|
-
```ts
|
|
203
|
-
const STRIPE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
Defined in: [stripe/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L22)
|
|
207
|
-
|
|
208
|
-
Configuration entries required by the Stripe payment provider.
|
|
209
|
-
|
|
210
|
-
---
|
|
211
|
-
|
|
212
|
-
### STRIPE_WEBHOOK_SECRET
|
|
213
|
-
|
|
214
|
-
```ts
|
|
215
|
-
const STRIPE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
Defined in: [stripe/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L15)
|
|
219
|
-
|
|
220
|
-
Stripe webhook signing secret.
|
|
41
|
+
| Variable | Description |
|
|
42
|
+
| ------ | ------ |
|
|
43
|
+
| [FEATURE\_KEY\_METADATA](Variable.FEATURE_KEY_METADATA) | - |
|
|
44
|
+
| [LEMONSQUEEZY\_API\_KEY](Variable.LEMONSQUEEZY_API_KEY) | LemonSqueezy API key. |
|
|
45
|
+
| [LEMONSQUEEZY\_CONFIG\_ENTRIES](Variable.LEMONSQUEEZY_CONFIG_ENTRIES) | Configuration entries required by the LemonSqueezy payment provider. |
|
|
46
|
+
| [LEMONSQUEEZY\_STORE\_ID](Variable.LEMONSQUEEZY_STORE_ID) | LemonSqueezy store ID. |
|
|
47
|
+
| [LEMONSQUEEZY\_WEBHOOK\_SECRET](Variable.LEMONSQUEEZY_WEBHOOK_SECRET) | LemonSqueezy webhook signing secret. |
|
|
48
|
+
| [MOLLIE\_API\_KEY](Variable.MOLLIE_API_KEY) | Mollie API key. |
|
|
49
|
+
| [MOLLIE\_CONFIG\_ENTRIES](Variable.MOLLIE_CONFIG_ENTRIES) | Configuration entries required by the Mollie payment provider. |
|
|
50
|
+
| [MOLLIE\_WEBHOOK\_SECRET](Variable.MOLLIE_WEBHOOK_SECRET) | Mollie webhook secret for verifying webhook payloads. |
|
|
51
|
+
| [PADDLE\_API\_KEY](Variable.PADDLE_API_KEY) | Paddle API key. |
|
|
52
|
+
| [PADDLE\_CONFIG\_ENTRIES](Variable.PADDLE_CONFIG_ENTRIES) | Configuration entries required by the Paddle payment provider. |
|
|
53
|
+
| [PADDLE\_ENVIRONMENT](Variable.PADDLE_ENVIRONMENT) | Paddle environment (`production` or `sandbox`). Defaults to `production`. |
|
|
54
|
+
| [PADDLE\_WEBHOOK\_SECRET](Variable.PADDLE_WEBHOOK_SECRET) | Paddle webhook secret key. |
|
|
55
|
+
| [STRIPE\_API\_KEY](Variable.STRIPE_API_KEY) | Stripe secret API key. |
|
|
56
|
+
| [STRIPE\_CONFIG\_ENTRIES](Variable.STRIPE_CONFIG_ENTRIES) | Configuration entries required by the Stripe payment provider. |
|
|
57
|
+
| [STRIPE\_WEBHOOK\_SECRET](Variable.STRIPE_WEBHOOK_SECRET) | Stripe webhook signing secret. |
|
|
221
58
|
|
|
222
59
|
## Functions
|
|
223
60
|
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
function RequiresFeature(featureKey): CustomDecorator<string>;
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
Defined in: [guards/FeatureGuard.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L17)
|
|
231
|
-
|
|
232
|
-
Decorator to mark endpoints that require feature access check.
|
|
233
|
-
The `featureKey` is a free-form string defined by the consuming project.
|
|
234
|
-
|
|
235
|
-
#### Parameters
|
|
236
|
-
|
|
237
|
-
| Parameter | Type |
|
|
238
|
-
| ------------ | -------- |
|
|
239
|
-
| `featureKey` | `string` |
|
|
240
|
-
|
|
241
|
-
#### Returns
|
|
242
|
-
|
|
243
|
-
`CustomDecorator`\<`string`\>
|
|
61
|
+
| Function | Description |
|
|
62
|
+
| ------ | ------ |
|
|
63
|
+
| [RequiresFeature](Function.RequiresFeature) | Decorator to mark endpoints that require feature access check. The `featureKey` is a free-form string defined by the consuming project. |
|
|
@@ -3,7 +3,6 @@ title: 'Class: ReportingContributorRegistry'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ReportingContributorRegistry
|
|
8
7
|
|
|
9
8
|
Defined in: [core/ReportingContributorRegistry.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L12)
|
|
@@ -36,7 +35,7 @@ Defined in: [core/ReportingContributorRegistry.ts:31](https://github.com/RueDeRe
|
|
|
36
35
|
|
|
37
36
|
readonly [`IReportingContributor`](Interface.IReportingContributor)[]
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
***
|
|
40
39
|
|
|
41
40
|
### register()
|
|
42
41
|
|
|
@@ -48,8 +47,8 @@ Defined in: [core/ReportingContributorRegistry.ts:23](https://github.com/RueDeRe
|
|
|
48
47
|
|
|
49
48
|
#### Parameters
|
|
50
49
|
|
|
51
|
-
| Parameter
|
|
52
|
-
|
|
|
50
|
+
| Parameter | Type |
|
|
51
|
+
| ------ | ------ |
|
|
53
52
|
| `contributor` | [`IReportingContributor`](Interface.IReportingContributor) |
|
|
54
53
|
|
|
55
54
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Class: ReportingDatasetNotFoundError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ReportingDatasetNotFoundError
|
|
8
7
|
|
|
9
8
|
Defined in: [models/errors/ReportingDatasetNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingDatasetNotFoundError.ts#L6)
|
|
@@ -26,8 +25,8 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
|
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
31
30
|
| `datasetId` | `string` |
|
|
32
31
|
|
|
33
32
|
#### Returns
|
|
@@ -37,5 +36,5 @@ Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.c
|
|
|
37
36
|
#### Overrides
|
|
38
37
|
|
|
39
38
|
```ts
|
|
40
|
-
Error.constructor
|
|
39
|
+
Error.constructor
|
|
41
40
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Class: ReportingFacade'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ReportingFacade
|
|
8
7
|
|
|
9
8
|
Defined in: [core/ReportingFacade.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingFacade.ts#L19)
|
|
@@ -22,8 +21,8 @@ Defined in: [core/ReportingFacade.ts:31](https://github.com/RueDeRennes/archipel
|
|
|
22
21
|
|
|
23
22
|
#### Parameters
|
|
24
23
|
|
|
25
|
-
| Parameter
|
|
26
|
-
|
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
27
26
|
| `registry` | [`ReportingContributorRegistry`](Class.ReportingContributorRegistry) |
|
|
28
27
|
|
|
29
28
|
#### Returns
|
|
@@ -42,15 +41,15 @@ Defined in: [core/ReportingFacade.ts:52](https://github.com/RueDeRennes/archipel
|
|
|
42
41
|
|
|
43
42
|
#### Parameters
|
|
44
43
|
|
|
45
|
-
| Parameter | Type
|
|
46
|
-
|
|
|
44
|
+
| Parameter | Type |
|
|
45
|
+
| ------ | ------ |
|
|
47
46
|
| `request` | [`IReportingQuery`](Interface.IReportingQuery) |
|
|
48
47
|
|
|
49
48
|
#### Returns
|
|
50
49
|
|
|
51
50
|
`Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
***
|
|
54
53
|
|
|
55
54
|
### getCatalog()
|
|
56
55
|
|
|
@@ -64,7 +63,7 @@ Defined in: [core/ReportingFacade.ts:39](https://github.com/RueDeRennes/archipel
|
|
|
64
63
|
|
|
65
64
|
`Promise`\<readonly [`IReportingDataset`](Interface.IReportingDataset)[]\>
|
|
66
65
|
|
|
67
|
-
|
|
66
|
+
***
|
|
68
67
|
|
|
69
68
|
### getDataset()
|
|
70
69
|
|
|
@@ -76,8 +75,8 @@ Defined in: [core/ReportingFacade.ts:47](https://github.com/RueDeRennes/archipel
|
|
|
76
75
|
|
|
77
76
|
#### Parameters
|
|
78
77
|
|
|
79
|
-
| Parameter
|
|
80
|
-
|
|
|
78
|
+
| Parameter | Type |
|
|
79
|
+
| ------ | ------ |
|
|
81
80
|
| `datasetId` | `string` |
|
|
82
81
|
|
|
83
82
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingContributor'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingContributor
|
|
8
7
|
|
|
9
8
|
Defined in: [core/ReportingContributor.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributor.ts#L12)
|
|
@@ -36,16 +35,16 @@ Executes the dataset query defined by the given request.
|
|
|
36
35
|
|
|
37
36
|
#### Parameters
|
|
38
37
|
|
|
39
|
-
| Parameter
|
|
40
|
-
|
|
|
38
|
+
| Parameter | Type |
|
|
39
|
+
| ------ | ------ |
|
|
41
40
|
| `_dataset` | [`IReportingDataset`](Interface.IReportingDataset) |
|
|
42
|
-
| `_request` | [`IReportingQuery`](Interface.IReportingQuery)
|
|
41
|
+
| `_request` | [`IReportingQuery`](Interface.IReportingQuery) |
|
|
43
42
|
|
|
44
43
|
#### Returns
|
|
45
44
|
|
|
46
45
|
`Promise`\<[`IReportingQueryResult`](Interface.IReportingQueryResult)\>
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
***
|
|
49
48
|
|
|
50
49
|
### listDatasets()
|
|
51
50
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingDataset'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingDataset
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingDataset.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDataset.ts#L12)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ReportingDataset.ts:17](https://github.com/RueDeRennes/archi
|
|
|
22
21
|
|
|
23
22
|
Fully qualified dataset identifier (`<feature>.<dataset>`).
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### datasetKey
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ReportingDataset.ts:27](https://github.com/RueDeRennes/archi
|
|
|
34
33
|
|
|
35
34
|
Dataset key within the feature namespace.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### description?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ReportingDataset.ts:37](https://github.com/RueDeRennes/archi
|
|
|
46
45
|
|
|
47
46
|
Optional dataset description presented to consumers.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### featureKey
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ReportingDataset.ts:22](https://github.com/RueDeRennes/archi
|
|
|
58
57
|
|
|
59
58
|
Feature namespace owning the dataset.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### fields
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ReportingDataset.ts:42](https://github.com/RueDeRennes/archi
|
|
|
70
69
|
|
|
71
70
|
Fields exposed by the dataset.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### name
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingDatasetField'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingDatasetField
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingDatasetField.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingDatasetField.ts#L25)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ReportingDatasetField.ts:50](https://github.com/RueDeRennes/
|
|
|
22
21
|
|
|
23
22
|
Optional documentation describing the semantic meaning of the field.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### fieldId
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ReportingDatasetField.ts:30](https://github.com/RueDeRennes/
|
|
|
34
33
|
|
|
35
34
|
Unique identifier of the field within the dataset.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### isNullable
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ReportingDatasetField.ts:45](https://github.com/RueDeRennes/
|
|
|
46
45
|
|
|
47
46
|
Indicates whether the field can contain null values.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### label
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ReportingDatasetField.ts:35](https://github.com/RueDeRennes/
|
|
|
58
57
|
|
|
59
58
|
Human readable name of the field.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### type
|
|
64
63
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQuery'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingQuery
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingQuery.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L45)
|
|
@@ -20,7 +19,7 @@ readonly datasetId: string;
|
|
|
20
19
|
|
|
21
20
|
Defined in: [models/ReportingQuery.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L46)
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
***
|
|
24
23
|
|
|
25
24
|
### filters?
|
|
26
25
|
|
|
@@ -30,7 +29,7 @@ readonly optional filters?: readonly IReportingQueryFilter[];
|
|
|
30
29
|
|
|
31
30
|
Defined in: [models/ReportingQuery.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L47)
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
***
|
|
34
33
|
|
|
35
34
|
### limit?
|
|
36
35
|
|
|
@@ -40,7 +39,7 @@ readonly optional limit?: number;
|
|
|
40
39
|
|
|
41
40
|
Defined in: [models/ReportingQuery.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L49)
|
|
42
41
|
|
|
43
|
-
|
|
42
|
+
***
|
|
44
43
|
|
|
45
44
|
### offset?
|
|
46
45
|
|
|
@@ -50,7 +49,7 @@ readonly optional offset?: number;
|
|
|
50
49
|
|
|
51
50
|
Defined in: [models/ReportingQuery.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L50)
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
***
|
|
54
53
|
|
|
55
54
|
### sorts?
|
|
56
55
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQueryFilter'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingQueryFilter
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingQuery.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L24)
|
|
@@ -20,7 +19,7 @@ readonly fieldId: string;
|
|
|
20
19
|
|
|
21
20
|
Defined in: [models/ReportingQuery.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L25)
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
***
|
|
24
23
|
|
|
25
24
|
### operator
|
|
26
25
|
|
|
@@ -30,7 +29,7 @@ readonly operator: ReportingFilterOperator;
|
|
|
30
29
|
|
|
31
30
|
Defined in: [models/ReportingQuery.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L26)
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
***
|
|
34
33
|
|
|
35
34
|
### value
|
|
36
35
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQueryResult'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingQueryResult
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingQueryResult.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L19)
|
|
@@ -20,7 +19,7 @@ readonly datasetId: string;
|
|
|
20
19
|
|
|
21
20
|
Defined in: [models/ReportingQueryResult.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L20)
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
***
|
|
24
23
|
|
|
25
24
|
### fields
|
|
26
25
|
|
|
@@ -30,7 +29,7 @@ readonly fields: readonly IReportingDatasetField[];
|
|
|
30
29
|
|
|
31
30
|
Defined in: [models/ReportingQueryResult.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L21)
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
***
|
|
34
33
|
|
|
35
34
|
### generatedAt
|
|
36
35
|
|
|
@@ -40,7 +39,7 @@ readonly generatedAt: Date;
|
|
|
40
39
|
|
|
41
40
|
Defined in: [models/ReportingQueryResult.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L24)
|
|
42
41
|
|
|
43
|
-
|
|
42
|
+
***
|
|
44
43
|
|
|
45
44
|
### rows
|
|
46
45
|
|
|
@@ -50,7 +49,7 @@ readonly rows: readonly ReportingQueryResultRow[];
|
|
|
50
49
|
|
|
51
50
|
Defined in: [models/ReportingQueryResult.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQueryResult.ts#L22)
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
***
|
|
54
53
|
|
|
55
54
|
### totalCount
|
|
56
55
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IReportingQuerySort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IReportingQuerySort
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ReportingQuery.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L35)
|
|
@@ -20,7 +19,7 @@ readonly direction: "asc" | "desc";
|
|
|
20
19
|
|
|
21
20
|
Defined in: [models/ReportingQuery.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/ReportingQuery.ts#L37)
|
|
22
21
|
|
|
23
|
-
|
|
22
|
+
***
|
|
24
23
|
|
|
25
24
|
### fieldId
|
|
26
25
|
|