@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: 'Interface: IAnalyticsUser'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Interface: IAnalyticsUser
|
|
7
8
|
|
|
8
9
|
Defined in: [models/IAnalyticsUser.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L6)
|
|
@@ -21,7 +22,7 @@ Defined in: [models/IAnalyticsUser.ts:15](https://github.com/RueDeRennes/archipe
|
|
|
21
22
|
|
|
22
23
|
Optional e-mail address.
|
|
23
24
|
|
|
24
|
-
|
|
25
|
+
---
|
|
25
26
|
|
|
26
27
|
### id
|
|
27
28
|
|
|
@@ -33,7 +34,7 @@ Defined in: [models/IAnalyticsUser.ts:10](https://github.com/RueDeRennes/archipe
|
|
|
33
34
|
|
|
34
35
|
Unique user identifier.
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
---
|
|
37
38
|
|
|
38
39
|
### traits?
|
|
39
40
|
|
|
@@ -45,7 +46,7 @@ Defined in: [models/IAnalyticsUser.ts:25](https://github.com/RueDeRennes/archipe
|
|
|
45
46
|
|
|
46
47
|
Additional user traits.
|
|
47
48
|
|
|
48
|
-
|
|
49
|
+
---
|
|
49
50
|
|
|
50
51
|
### username?
|
|
51
52
|
|
|
@@ -3,10 +3,11 @@ title: 'Type Alias: AnalyticsLevel'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Type Alias: AnalyticsLevel
|
|
7
8
|
|
|
8
9
|
```ts
|
|
9
|
-
type AnalyticsLevel =
|
|
10
|
+
type AnalyticsLevel = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Defined in: [models/AnalyticsLevel.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/AnalyticsLevel.ts#L6)
|
|
@@ -3,10 +3,11 @@ title: 'Variable: APPINSIGHTS\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
# Variable: APPINSIGHTS_CONFIG_ENTRIES
|
|
7
8
|
|
|
8
9
|
```ts
|
|
9
|
-
const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
10
|
+
const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Defined in: [application-insights/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L19)
|
package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md
CHANGED
|
@@ -3,7 +3,8 @@ title: 'Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
# Variable: APPLICATIONINSIGHTS_CONNECTION_STRING
|
|
7
8
|
|
|
8
9
|
```ts
|
|
9
10
|
const APPLICATIONINSIGHTS_CONNECTION_STRING: IConfigKey<string>;
|
|
@@ -3,10 +3,11 @@ title: 'Variable: DATADOG\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
# Variable: DATADOG_CONFIG_ENTRIES
|
|
7
8
|
|
|
8
9
|
```ts
|
|
9
|
-
const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
10
|
+
const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Defined in: [datadog/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L22)
|
|
@@ -3,10 +3,11 @@ title: 'Variable: SENTRY\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
6
|
+
|
|
7
|
+
# Variable: SENTRY_CONFIG_ENTRIES
|
|
7
8
|
|
|
8
9
|
```ts
|
|
9
|
-
const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
10
|
+
const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
Defined in: [sentry/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L22)
|
|
@@ -3,42 +3,43 @@ title: '@breadstone/archipel-platform-analytics'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# @breadstone/archipel-platform-analytics
|
|
7
8
|
|
|
8
9
|
## Classes
|
|
9
10
|
|
|
10
|
-
| Class
|
|
11
|
-
|
|
|
12
|
-
| [AnalyticsClientPort](Class.AnalyticsClientPort)
|
|
13
|
-
| [AnalyticsModule](Class.AnalyticsModule)
|
|
14
|
-
| [AppInsightsAnalyticsClient](Class.AppInsightsAnalyticsClient) | Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `applicationinsights` SDK for error tracking and analytics.
|
|
15
|
-
| [DatadogAnalyticsClient](Class.DatadogAnalyticsClient)
|
|
16
|
-
| [NoopAnalyticsClient](Class.NoopAnalyticsClient)
|
|
17
|
-
| [SentryAnalyticsClient](Class.SentryAnalyticsClient)
|
|
11
|
+
| Class | Description |
|
|
12
|
+
| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| [AnalyticsClientPort](Class.AnalyticsClientPort) | Abstract port for analytics and error tracking clients. Each provider (Sentry, Application Insights, Datadog) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
14
|
+
| [AnalyticsModule](Class.AnalyticsModule) | NestJS module providing generic analytics and error tracking infrastructure. The specific analytics provider (Sentry, Application Insights, Datadog) is selected via the options. |
|
|
15
|
+
| [AppInsightsAnalyticsClient](Class.AppInsightsAnalyticsClient) | Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `applicationinsights` SDK for error tracking and analytics. |
|
|
16
|
+
| [DatadogAnalyticsClient](Class.DatadogAnalyticsClient) | Datadog implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `dd-trace` SDK for error tracking and analytics. |
|
|
17
|
+
| [NoopAnalyticsClient](Class.NoopAnalyticsClient) | No-op implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Suitable for development, testing, or environments where analytics is disabled. |
|
|
18
|
+
| [SentryAnalyticsClient](Class.SentryAnalyticsClient) | Sentry implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the official `@sentry/node` SDK for error tracking and analytics. |
|
|
18
19
|
|
|
19
20
|
## Interfaces
|
|
20
21
|
|
|
21
|
-
| Interface
|
|
22
|
-
|
|
|
23
|
-
| [IAnalyticsBreadcrumb](Interface.IAnalyticsBreadcrumb)
|
|
24
|
-
| [IAnalyticsModuleOptions](Interface.IAnalyticsModuleOptions) | Configuration options for the `AnalyticsModule`.
|
|
25
|
-
| [IAnalyticsUser](Interface.IAnalyticsUser)
|
|
22
|
+
| Interface | Description |
|
|
23
|
+
| ------------------------------------------------------------ | -------------------------------------------------- |
|
|
24
|
+
| [IAnalyticsBreadcrumb](Interface.IAnalyticsBreadcrumb) | Represents a breadcrumb entry for analytics trail. |
|
|
25
|
+
| [IAnalyticsModuleOptions](Interface.IAnalyticsModuleOptions) | Configuration options for the `AnalyticsModule`. |
|
|
26
|
+
| [IAnalyticsUser](Interface.IAnalyticsUser) | Represents user context for analytics tracking. |
|
|
26
27
|
|
|
27
28
|
## Type Aliases
|
|
28
29
|
|
|
29
|
-
| Type Alias
|
|
30
|
-
|
|
|
30
|
+
| Type Alias | Description |
|
|
31
|
+
| ------------------------------------------ | -------------------------------------- |
|
|
31
32
|
| [AnalyticsLevel](TypeAlias.AnalyticsLevel) | Severity level for analytics messages. |
|
|
32
33
|
|
|
33
34
|
## Variables
|
|
34
35
|
|
|
35
|
-
| Variable
|
|
36
|
-
|
|
|
37
|
-
| [
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
36
|
+
| Variable | Description |
|
|
37
|
+
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
|
|
38
|
+
| [APPINSIGHTS_CONFIG_ENTRIES](Variable.APPINSIGHTS_CONFIG_ENTRIES) | Configuration entries required by the Application Insights analytics provider. |
|
|
39
|
+
| [APPLICATIONINSIGHTS_CONNECTION_STRING](Variable.APPLICATIONINSIGHTS_CONNECTION_STRING) | Application Insights connection string. |
|
|
40
|
+
| [DATADOG_CONFIG_ENTRIES](Variable.DATADOG_CONFIG_ENTRIES) | Configuration entries required by the Datadog analytics provider. |
|
|
41
|
+
| [DD_ENV](Variable.DD_ENV) | Datadog environment identifier (e.g. `production`, `staging`). |
|
|
42
|
+
| [DD_SERVICE](Variable.DD_SERVICE) | Datadog service name. |
|
|
43
|
+
| [SENTRY_CONFIG_ENTRIES](Variable.SENTRY_CONFIG_ENTRIES) | Configuration entries required by the Sentry analytics provider. |
|
|
44
|
+
| [SENTRY_DSN](Variable.SENTRY_DSN) | Sentry DSN for error tracking. |
|
|
45
|
+
| [SENTRY_ENVIRONMENT](Variable.SENTRY_ENVIRONMENT) | Sentry environment identifier (e.g. `production`, `staging`). |
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: platform-analytics
|
|
3
|
+
description: Provider-agnostic analytics and error tracking with pluggable clients.
|
|
4
|
+
order: 14
|
|
5
|
+
tags: [analytics, error-tracking, sentry, application-insights, datadog, observability, providers]
|
|
6
|
+
package: '@breadstone/archipel-platform-analytics'
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# platform-analytics
|
|
10
|
+
|
|
11
|
+
Provider-agnostic analytics and error tracking module supporting multiple backends. Ships with Sentry, Azure Application Insights, and Datadog clients out of the box, plus a no-op fallback for environments where analytics is disabled.
|
|
12
|
+
|
|
13
|
+
**Package:** `@breadstone/archipel-platform-analytics`
|
|
14
|
+
|
|
15
|
+
## Quick Start
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { Module } from '@nestjs/common';
|
|
19
|
+
import { AnalyticsModule } from '@breadstone/archipel-platform-analytics';
|
|
20
|
+
import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
|
|
21
|
+
|
|
22
|
+
@Module({
|
|
23
|
+
imports: [
|
|
24
|
+
AnalyticsModule.register({
|
|
25
|
+
analyticsClient: SentryAnalyticsClient,
|
|
26
|
+
configEntries: SENTRY_CONFIG_ENTRIES,
|
|
27
|
+
isGlobal: true,
|
|
28
|
+
}),
|
|
29
|
+
],
|
|
30
|
+
})
|
|
31
|
+
export class AppModule {}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Module Configuration
|
|
37
|
+
|
|
38
|
+
### IAnalyticsModuleOptions
|
|
39
|
+
|
|
40
|
+
| Property | Type | Required | Default | Description |
|
|
41
|
+
| ----------------- | ------------------------------------- | -------- | ------- | ---------------------------------------- |
|
|
42
|
+
| `analyticsClient` | `Type<AnalyticsClientPort>` | Yes | — | Concrete analytics client implementation |
|
|
43
|
+
| `configEntries` | `ReadonlyArray<IConfigRegistryEntry>` | No | `[]` | Provider-specific configuration entries |
|
|
44
|
+
| `isGlobal` | `boolean` | No | `false` | Register as a global module |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## AnalyticsClientPort API
|
|
49
|
+
|
|
50
|
+
The abstract port that all analytics clients implement. Inject it anywhere:
|
|
51
|
+
|
|
52
|
+
```typescript
|
|
53
|
+
import { AnalyticsClientPort } from '@breadstone/archipel-platform-analytics';
|
|
54
|
+
|
|
55
|
+
@Injectable()
|
|
56
|
+
export class PaymentService {
|
|
57
|
+
constructor(private readonly _analytics: AnalyticsClientPort) {}
|
|
58
|
+
|
|
59
|
+
public async processPayment(): Promise<void> {
|
|
60
|
+
try {
|
|
61
|
+
// ... payment logic
|
|
62
|
+
} catch (error) {
|
|
63
|
+
this._analytics.captureException(error as Error, { feature: 'payments' });
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Methods
|
|
70
|
+
|
|
71
|
+
| Method | Signature | Description |
|
|
72
|
+
| ------------------ | ------------------------------------------------------------------------------------- | --------------------------------------- |
|
|
73
|
+
| `captureException` | `(error: Error, context?: Record<string, unknown>) => void` | Capture an error with optional context |
|
|
74
|
+
| `captureMessage` | `(message: string, level: AnalyticsLevel, context?: Record<string, unknown>) => void` | Capture a message at a severity level |
|
|
75
|
+
| `setUser` | `(user: IAnalyticsUser) => void` | Set the current user context |
|
|
76
|
+
| `clearUser` | `() => void` | Clear the current user context |
|
|
77
|
+
| `addBreadcrumb` | `(breadcrumb: IAnalyticsBreadcrumb) => void` | Add a breadcrumb to the analytics trail |
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## Built-in Providers
|
|
82
|
+
|
|
83
|
+
### SentryAnalyticsClient
|
|
84
|
+
|
|
85
|
+
Error tracking and performance monitoring via Sentry.
|
|
86
|
+
|
|
87
|
+
```typescript
|
|
88
|
+
import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
|
|
89
|
+
|
|
90
|
+
AnalyticsModule.register({
|
|
91
|
+
analyticsClient: SentryAnalyticsClient,
|
|
92
|
+
configEntries: SENTRY_CONFIG_ENTRIES,
|
|
93
|
+
});
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**Environment variables:** `SENTRY_DSN`, `SENTRY_ENVIRONMENT`
|
|
97
|
+
|
|
98
|
+
### AppInsightsAnalyticsClient
|
|
99
|
+
|
|
100
|
+
Azure Application Insights integration.
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
import {
|
|
104
|
+
AppInsightsAnalyticsClient,
|
|
105
|
+
APPINSIGHTS_CONFIG_ENTRIES,
|
|
106
|
+
} from '@breadstone/archipel-platform-analytics/appinsights';
|
|
107
|
+
|
|
108
|
+
AnalyticsModule.register({
|
|
109
|
+
analyticsClient: AppInsightsAnalyticsClient,
|
|
110
|
+
configEntries: APPINSIGHTS_CONFIG_ENTRIES,
|
|
111
|
+
});
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Environment variables:** `APPLICATIONINSIGHTS_CONNECTION_STRING`
|
|
115
|
+
|
|
116
|
+
### DatadogAnalyticsClient
|
|
117
|
+
|
|
118
|
+
Datadog APM and error tracking.
|
|
119
|
+
|
|
120
|
+
```typescript
|
|
121
|
+
import { DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/datadog';
|
|
122
|
+
|
|
123
|
+
AnalyticsModule.register({
|
|
124
|
+
analyticsClient: DatadogAnalyticsClient,
|
|
125
|
+
configEntries: DATADOG_CONFIG_ENTRIES,
|
|
126
|
+
});
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
**Environment variables:** `DD_SERVICE`, `DD_ENV`
|
|
130
|
+
|
|
131
|
+
### NoopAnalyticsClient
|
|
132
|
+
|
|
133
|
+
Silent no-op client for environments where analytics is disabled:
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import { NoopAnalyticsClient } from '@breadstone/archipel-platform-analytics';
|
|
137
|
+
|
|
138
|
+
AnalyticsModule.register({
|
|
139
|
+
analyticsClient: NoopAnalyticsClient,
|
|
140
|
+
});
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## Sub-path Imports
|
|
146
|
+
|
|
147
|
+
Each provider is tree-shakeable via sub-path imports:
|
|
148
|
+
|
|
149
|
+
| Import Path | Contents |
|
|
150
|
+
| ----------------------------------------------------- | ------------------------------------------------------ |
|
|
151
|
+
| `@breadstone/archipel-platform-analytics` | Core module, port, models, NoopAnalyticsClient |
|
|
152
|
+
| `@breadstone/archipel-platform-analytics/sentry` | SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES |
|
|
153
|
+
| `@breadstone/archipel-platform-analytics/appinsights` | AppInsightsAnalyticsClient, APPINSIGHTS_CONFIG_ENTRIES |
|
|
154
|
+
| `@breadstone/archipel-platform-analytics/datadog` | DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES |
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Exports Summary
|
|
159
|
+
|
|
160
|
+
| Export | Type | Description |
|
|
161
|
+
| ---------------------------- | ------------- | ---------------------------------------------- |
|
|
162
|
+
| `AnalyticsModule` | NestJS Module | Main module with `register()` |
|
|
163
|
+
| `AnalyticsClientPort` | Port | Abstract analytics contract |
|
|
164
|
+
| `NoopAnalyticsClient` | Client | No-op fallback implementation |
|
|
165
|
+
| `SentryAnalyticsClient` | Client | Sentry provider (sub-path) |
|
|
166
|
+
| `AppInsightsAnalyticsClient` | Client | Azure Application Insights provider (sub-path) |
|
|
167
|
+
| `DatadogAnalyticsClient` | Client | Datadog provider (sub-path) |
|
|
168
|
+
| `AnalyticsLevel` | Type | Severity level union |
|
|
169
|
+
| `IAnalyticsBreadcrumb` | Interface | Breadcrumb entry model |
|
|
170
|
+
| `IAnalyticsUser` | Interface | User context model |
|
|
@@ -3,6 +3,7 @@ title: 'Class: AnonymousAuthGuard'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: AnonymousAuthGuard
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/guards/AnonymousAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/AnonymousAuthGuard.ts#L14)
|
|
@@ -21,12 +22,12 @@ The `AnonymousAuthGuard` protects routes using anonymous authentication.
|
|
|
21
22
|
new AnonymousAuthGuard(...args): AnonymousAuthGuard;
|
|
22
23
|
```
|
|
23
24
|
|
|
24
|
-
Defined in:
|
|
25
|
+
Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
28
|
-
| Parameter | Type
|
|
29
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| --------- | ------- |
|
|
30
31
|
| ...`args` | `any`[] |
|
|
31
32
|
|
|
32
33
|
#### Returns
|
|
@@ -36,5 +37,5 @@ Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
|
|
|
36
37
|
#### Inherited from
|
|
37
38
|
|
|
38
39
|
```ts
|
|
39
|
-
AuthGuard('anonymous').constructor
|
|
40
|
+
AuthGuard('anonymous').constructor;
|
|
40
41
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Class: AppleStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: AppleStrategy
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/strategies/AppleStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/AppleStrategy.ts#L21)
|
|
@@ -27,10 +28,10 @@ Initializes a new instance of the `AppleStrategy` class.
|
|
|
27
28
|
|
|
28
29
|
#### Parameters
|
|
29
30
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
32
|
-
| `socialAuth`
|
|
33
|
-
| `configService` | `ConfigService`
|
|
31
|
+
| Parameter | Type | Description |
|
|
32
|
+
| --------------- | ---------------------------------------- | ------------------------------- |
|
|
33
|
+
| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
|
|
34
|
+
| `configService` | `ConfigService` | Configuration service instance. |
|
|
34
35
|
|
|
35
36
|
#### Returns
|
|
36
37
|
|
|
@@ -39,7 +40,7 @@ Initializes a new instance of the `AppleStrategy` class.
|
|
|
39
40
|
#### Overrides
|
|
40
41
|
|
|
41
42
|
```ts
|
|
42
|
-
PassportStrategy(Strategy, 'apple').constructor
|
|
43
|
+
PassportStrategy(Strategy, 'apple').constructor;
|
|
43
44
|
```
|
|
44
45
|
|
|
45
46
|
## Methods
|
|
@@ -48,9 +49,9 @@ PassportStrategy(Strategy, 'apple').constructor
|
|
|
48
49
|
|
|
49
50
|
```ts
|
|
50
51
|
validate(
|
|
51
|
-
accessToken,
|
|
52
|
-
refreshToken,
|
|
53
|
-
idToken,
|
|
52
|
+
accessToken,
|
|
53
|
+
refreshToken,
|
|
54
|
+
idToken,
|
|
54
55
|
profile): Promise<IAuthSubject>;
|
|
55
56
|
```
|
|
56
57
|
|
|
@@ -60,12 +61,12 @@ Validates the Apple authentication payload.
|
|
|
60
61
|
|
|
61
62
|
#### Parameters
|
|
62
63
|
|
|
63
|
-
| Parameter
|
|
64
|
-
|
|
|
65
|
-
| `accessToken`
|
|
66
|
-
| `refreshToken` | `string`
|
|
67
|
-
| `idToken`
|
|
68
|
-
| `profile`
|
|
64
|
+
| Parameter | Type | Description |
|
|
65
|
+
| -------------- | --------------- | --------------------- |
|
|
66
|
+
| `accessToken` | `string` | OAuth access token. |
|
|
67
|
+
| `refreshToken` | `string` | OAuth refresh token. |
|
|
68
|
+
| `idToken` | `string` | Apple identity token. |
|
|
69
|
+
| `profile` | `IAppleProfile` | Apple profile data. |
|
|
69
70
|
|
|
70
71
|
#### Returns
|
|
71
72
|
|
|
@@ -76,5 +77,5 @@ The authenticated user.
|
|
|
76
77
|
#### Overrides
|
|
77
78
|
|
|
78
79
|
```ts
|
|
79
|
-
PassportStrategy(Strategy, 'apple').validate
|
|
80
|
+
PassportStrategy(Strategy, 'apple').validate;
|
|
80
81
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Class: AuthModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: AuthModule
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/AuthModule.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L116)
|
|
@@ -34,15 +35,15 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:225](https://github.
|
|
|
34
35
|
|
|
35
36
|
#### Parameters
|
|
36
37
|
|
|
37
|
-
| Parameter
|
|
38
|
-
|
|
|
38
|
+
| Parameter | Type |
|
|
39
|
+
| ---------- | -------------------- |
|
|
39
40
|
| `consumer` | `MiddlewareConsumer` |
|
|
40
41
|
|
|
41
42
|
#### Returns
|
|
42
43
|
|
|
43
44
|
`void`
|
|
44
45
|
|
|
45
|
-
|
|
46
|
+
---
|
|
46
47
|
|
|
47
48
|
### register()
|
|
48
49
|
|
|
@@ -56,8 +57,8 @@ Registers the auth module with the provided port implementations.
|
|
|
56
57
|
|
|
57
58
|
#### Parameters
|
|
58
59
|
|
|
59
|
-
| Parameter | Type
|
|
60
|
-
|
|
|
60
|
+
| Parameter | Type | Description |
|
|
61
|
+
| --------- | ---------------------------------------------------- | ----------------------------------------- |
|
|
61
62
|
| `options` | [`IAuthModuleOptions`](Interface.IAuthModuleOptions) | Port implementations for the auth module. |
|
|
62
63
|
|
|
63
64
|
#### Returns
|
|
@@ -3,6 +3,7 @@ title: 'Abstract Class: AuthSubjectPort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Abstract Class: AuthSubjectPort
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/contracts/AuthSubjectPort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/AuthSubjectPort.ts#L13)
|
|
@@ -36,8 +37,8 @@ Find the anonymous / seed subject by user name.
|
|
|
36
37
|
|
|
37
38
|
#### Parameters
|
|
38
39
|
|
|
39
|
-
| Parameter
|
|
40
|
-
|
|
|
40
|
+
| Parameter | Type | Description |
|
|
41
|
+
| ---------- | -------- | ------------------------ |
|
|
41
42
|
| `userName` | `string` | The anonymous user name. |
|
|
42
43
|
|
|
43
44
|
#### Returns
|
|
@@ -46,7 +47,7 @@ Find the anonymous / seed subject by user name.
|
|
|
46
47
|
|
|
47
48
|
The subject or `null`.
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
---
|
|
50
51
|
|
|
51
52
|
### findById()
|
|
52
53
|
|
|
@@ -60,9 +61,9 @@ Find a subject by its unique identifier.
|
|
|
60
61
|
|
|
61
62
|
#### Parameters
|
|
62
63
|
|
|
63
|
-
| Parameter | Type
|
|
64
|
-
|
|
|
65
|
-
| `id`
|
|
64
|
+
| Parameter | Type | Description |
|
|
65
|
+
| --------- | -------- | ----------------------- |
|
|
66
|
+
| `id` | `string` | The subject identifier. |
|
|
66
67
|
|
|
67
68
|
#### Returns
|
|
68
69
|
|
|
@@ -70,7 +71,7 @@ Find a subject by its unique identifier.
|
|
|
70
71
|
|
|
71
72
|
The subject or `null`.
|
|
72
73
|
|
|
73
|
-
|
|
74
|
+
---
|
|
74
75
|
|
|
75
76
|
### findByLogin()
|
|
76
77
|
|
|
@@ -84,9 +85,9 @@ Find a subject by its login name (user name or email).
|
|
|
84
85
|
|
|
85
86
|
#### Parameters
|
|
86
87
|
|
|
87
|
-
| Parameter | Type
|
|
88
|
-
|
|
|
89
|
-
| `login`
|
|
88
|
+
| Parameter | Type | Description |
|
|
89
|
+
| --------- | -------- | --------------------- |
|
|
90
|
+
| `login` | `string` | The login identifier. |
|
|
90
91
|
|
|
91
92
|
#### Returns
|
|
92
93
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: AuthTokenService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: AuthTokenService
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/services/AuthTokenService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/AuthTokenService.ts#L18)
|
|
@@ -25,9 +26,9 @@ Constructs a new instance of the `AuthTokenService` class.
|
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
28
|
-
| Parameter
|
|
29
|
-
|
|
|
30
|
-
| `jwtService`
|
|
29
|
+
| Parameter | Type | Description |
|
|
30
|
+
| --------------- | -------------------------------------------------------- | ----------------------------- |
|
|
31
|
+
| `jwtService` | `JwtService` | The NestJS JWT service. |
|
|
31
32
|
| `tokenEnricher` | [`TokenEnricherPort`](Class.TokenEnricherPort) \| `null` | Optional token enricher port. |
|
|
32
33
|
|
|
33
34
|
#### Returns
|
|
@@ -48,8 +49,8 @@ Creates a signed JWT for the given subject.
|
|
|
48
49
|
|
|
49
50
|
#### Parameters
|
|
50
51
|
|
|
51
|
-
| Parameter | Type
|
|
52
|
-
|
|
|
52
|
+
| Parameter | Type | Description |
|
|
53
|
+
| --------- | ---------------------------------------- | -------------------------- |
|
|
53
54
|
| `subject` | [`IAuthSubject`](Interface.IAuthSubject) | The authenticated subject. |
|
|
54
55
|
|
|
55
56
|
#### Returns
|