@breadstone/archipel-mcp 0.0.2 → 0.0.4
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 +7 -6
- 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 +11 -10
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +9 -8
- package/data/packages/platform-core/api/Class.ConfigService.md +27 -26
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +18 -17
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +5 -4
- package/data/packages/platform-core/api/Class.CryptoService.md +4 -3
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +13 -12
- package/data/packages/platform-core/api/Class.DeviceParserService.md +3 -2
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +23 -22
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -17
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +16 -15
- package/data/packages/platform-core/api/Class.EventHub.md +26 -25
- package/data/packages/platform-core/api/Class.EventModule.md +1 -0
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -19
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +20 -19
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +8 -7
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +8 -7
- package/data/packages/platform-core/api/Class.HealthModule.md +3 -2
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +4 -3
- package/data/packages/platform-core/api/Class.HostModule.md +2 -0
- package/data/packages/platform-core/api/Class.HostService.md +14 -13
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +9 -8
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +8 -7
- package/data/packages/platform-core/api/Class.IdentifierModule.md +4 -3
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +5 -4
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +11 -10
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +1 -0
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +7 -6
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +9 -8
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +2 -1
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +2 -1
- package/data/packages/platform-core/api/Class.MappingBuilder.md +19 -18
- package/data/packages/platform-core/api/Class.MappingModule.md +3 -2
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +6 -5
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +3 -2
- package/data/packages/platform-core/api/Class.MappingService.md +53 -52
- package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +38 -37
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +20 -19
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +21 -20
- package/data/packages/platform-core/api/Class.OtpService.md +9 -8
- package/data/packages/platform-core/api/Class.PageableRequest.md +2 -1
- package/data/packages/platform-core/api/Class.PageableResponse.md +4 -3
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +7 -6
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +12 -11
- package/data/packages/platform-core/api/Class.QuantityResponse.md +2 -1
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +40 -39
- package/data/packages/platform-core/api/Class.ResourceManager.md +89 -88
- package/data/packages/platform-core/api/Class.ResourceModule.md +4 -3
- package/data/packages/platform-core/api/Class.ResponseReturn.md +104 -102
- package/data/packages/platform-core/api/Class.SseHub.md +24 -23
- package/data/packages/platform-core/api/Class.SseModule.md +4 -3
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +2 -1
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +6 -5
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +8 -7
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +5 -4
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +5 -4
- package/data/packages/platform-core/api/Function.Public.md +1 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +9 -7
- package/data/packages/platform-core/api/Function.createEventKey.md +7 -6
- package/data/packages/platform-core/api/Function.createMappingKey.md +7 -6
- package/data/packages/platform-core/api/Function.env.md +5 -4
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +3 -2
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +5 -4
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +2 -1
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +6 -5
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +20 -19
- package/data/packages/platform-core/api/Interface.ICacheStats.md +5 -4
- package/data/packages/platform-core/api/Interface.IConfigKey.md +17 -16
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +4 -3
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +7 -6
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +7 -6
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -10
- package/data/packages/platform-core/api/Interface.IEventKey.md +8 -7
- package/data/packages/platform-core/api/Interface.IEventMap.md +1 -0
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +6 -5
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +4 -3
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +4 -3
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +9 -8
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +8 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +7 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +11 -10
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +6 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +4 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +4 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +7 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +2 -1
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +5 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +3 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +5 -4
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +35 -34
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +5 -4
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +18 -17
- package/data/packages/platform-core/api/Interface.IMappingKey.md +8 -7
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +3 -2
- package/data/packages/platform-core/api/Interface.IOtpService.md +9 -8
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +3 -2
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +15 -14
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +5 -4
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +7 -6
- package/data/packages/platform-core/api/Interface.IResourceResult.md +2 -1
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +17 -16
- package/data/packages/platform-core/api/Interface.ISseEventData.md +4 -3
- package/data/packages/platform-core/api/Interface.ISseHub.md +17 -16
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -2
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +3 -2
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +3 -1
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +2 -1
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +6 -5
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +5 -4
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +5 -4
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +2 -4
- package/data/packages/platform-core/api/Variable.APP_PORT.md +2 -1
- package/data/packages/platform-core/api/Variable.APP_URL.md +2 -1
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +2 -1
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -1
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +3 -2
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +8 -7
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +10 -9
- package/data/packages/platform-core/api/Variable.IpAddress.md +7 -6
- package/data/packages/platform-core/api/Variable.Lang.md +6 -5
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -1
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +2 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -7
- package/data/packages/platform-core/api/Variable.UserAgent.md +3 -2
- package/data/packages/platform-core/api/index.md +161 -160
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +7 -6
- package/data/packages/platform-database/api/Class.DatabaseModule.md +6 -5
- package/data/packages/platform-database/api/Class.DatabaseService.md +20 -19
- package/data/packages/platform-database/api/Class.PrismaService.md +8 -7
- package/data/packages/platform-database/api/Class.RepositoryBase.md +127 -126
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +6 -5
- package/data/packages/platform-database/api/Function.pageable.md +10 -13
- package/data/packages/platform-database/api/Function.paginator.md +3 -2
- package/data/packages/platform-database/api/Function.query.md +8 -7
- package/data/packages/platform-database/api/Function.skip.md +6 -5
- package/data/packages/platform-database/api/Function.transactionalQuery.md +7 -6
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +1 -0
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +2 -1
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +5 -4
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +8 -7
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +6 -5
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +3 -2
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +3 -2
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +8 -7
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +4 -3
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +4 -3
- package/data/packages/platform-database/api/index.md +28 -27
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +33 -31
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +8 -7
- package/data/packages/platform-documents/api/Class.DocumentModule.md +3 -2
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +22 -21
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +7 -5
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +6 -5
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +9 -8
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +3 -2
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +4 -3
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +19 -18
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +4 -3
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +4 -3
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +2 -1
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +2 -1
- package/data/packages/platform-documents/api/index.md +29 -28
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +21 -20
- package/data/packages/platform-esigning/api/Class.EsigningError.md +5 -4
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +3 -2
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +10 -9
- package/data/packages/platform-esigning/api/Class.EsigningService.md +25 -24
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +25 -24
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +10 -9
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +4 -3
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +3 -2
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +7 -6
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +4 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +4 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +3 -2
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +4 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigner.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +6 -5
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +11 -10
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +11 -10
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +5 -4
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +2 -1
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +2 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +13 -12
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +15 -14
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +21 -20
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +19 -18
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +21 -20
- package/data/packages/platform-esigning/api/index.md +66 -65
- package/data/packages/platform-logging/api/Class.LoggerModule.md +1 -0
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +2 -1
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-logging/api/index.md +8 -7
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -2
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +12 -11
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -2
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -4
- package/data/packages/platform-mailing/api/Class.MailModule.md +1 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +28 -27
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +13 -12
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +15 -14
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -13
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +3 -2
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +1 -0
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +2 -1
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +2 -1
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +2 -1
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +3 -2
- package/data/packages/platform-mailing/api/index.md +55 -54
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +9 -8
- package/data/packages/platform-mcp/api/Class.McpModule.md +9 -8
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +17 -16
- package/data/packages/platform-mcp/api/Class.McpServerService.md +20 -19
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +3 -2
- package/data/packages/platform-mcp/api/Function.McpResource.md +3 -2
- package/data/packages/platform-mcp/api/Function.McpTool.md +3 -2
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +3 -2
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +9 -8
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +5 -4
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +6 -5
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +4 -3
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +4 -3
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +1 -0
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +2 -1
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +2 -1
- package/data/packages/platform-mcp/api/index.md +27 -26
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +6 -5
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +6 -5
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +17 -16
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +3 -2
- package/data/packages/platform-openapi/api/Function.Api.md +14 -13
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -4
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +1 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +7 -8
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +6 -5
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +6 -5
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +2 -1
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +2 -1
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +3 -2
- package/data/packages/platform-openapi/api/index.md +25 -24
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +8 -7
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +7 -6
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +8 -7
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +25 -24
- package/data/packages/platform-payments/api/Class.MollieClient.md +25 -24
- package/data/packages/platform-payments/api/Class.PaddleClient.md +25 -24
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +26 -25
- package/data/packages/platform-payments/api/Class.PaymentModule.md +3 -2
- package/data/packages/platform-payments/api/Class.StripeClient.md +25 -24
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +3 -2
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +5 -4
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +6 -5
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +7 -6
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +9 -8
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +3 -2
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +4 -3
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +10 -9
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +3 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +2 -1
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +2 -1
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +2 -1
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +3 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +2 -1
- package/data/packages/platform-payments/api/index.md +41 -40
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +4 -3
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +4 -3
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +9 -8
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +1 -0
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +6 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +3 -2
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +5 -4
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +2 -1
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +1 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +13 -12
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +11 -10
- package/data/packages/platform-reporting/api/index.md +24 -23
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +23 -22
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +27 -26
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +24 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +36 -35
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +3 -2
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +5 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +23 -22
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +3 -2
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +9 -8
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +3 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +2 -1
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +1 -0
- package/data/packages/platform-telemetry/api/index.md +21 -20
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ title: 'Class: MfaService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: MfaService
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/services/MfaService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/MfaService.ts#L22)
|
|
@@ -15,9 +16,9 @@ Orchestrates MFA channels, backup codes, and user preferences.
|
|
|
15
16
|
|
|
16
17
|
```ts
|
|
17
18
|
new MfaService(
|
|
18
|
-
bcryptService,
|
|
19
|
-
mfaSubject,
|
|
20
|
-
encryptionService,
|
|
19
|
+
bcryptService,
|
|
20
|
+
mfaSubject,
|
|
21
|
+
encryptionService,
|
|
21
22
|
channels): MfaService;
|
|
22
23
|
```
|
|
23
24
|
|
|
@@ -25,12 +26,12 @@ Defined in: [libs/platform-authentication/src/services/MfaService.ts:35](https:/
|
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
28
|
-
| Parameter
|
|
29
|
-
|
|
|
30
|
-
| `bcryptService`
|
|
31
|
-
| `mfaSubject`
|
|
32
|
-
| `encryptionService` | `MfaEncryptionService`
|
|
33
|
-
| `channels`
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------------------- | ---------------------------------------- |
|
|
31
|
+
| `bcryptService` | `BcryptService` |
|
|
32
|
+
| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
|
|
33
|
+
| `encryptionService` | `MfaEncryptionService` |
|
|
34
|
+
| `channels` | `IMfaChannel`[] |
|
|
34
35
|
|
|
35
36
|
#### Returns
|
|
36
37
|
|
|
@@ -66,15 +67,15 @@ Disables MFA for a user and clears channel secrets.
|
|
|
66
67
|
|
|
67
68
|
#### Parameters
|
|
68
69
|
|
|
69
|
-
| Parameter | Type
|
|
70
|
-
|
|
|
71
|
-
| `userId`
|
|
70
|
+
| Parameter | Type |
|
|
71
|
+
| --------- | -------- |
|
|
72
|
+
| `userId` | `string` |
|
|
72
73
|
|
|
73
74
|
#### Returns
|
|
74
75
|
|
|
75
76
|
`Promise`\<`void`\>
|
|
76
77
|
|
|
77
|
-
|
|
78
|
+
---
|
|
78
79
|
|
|
79
80
|
### getEnabledMethods()
|
|
80
81
|
|
|
@@ -91,25 +92,25 @@ Returns enabled methods and preferred method for a user.
|
|
|
91
92
|
|
|
92
93
|
#### Parameters
|
|
93
94
|
|
|
94
|
-
| Parameter | Type
|
|
95
|
-
|
|
|
96
|
-
| `userId`
|
|
95
|
+
| Parameter | Type |
|
|
96
|
+
| --------- | -------- |
|
|
97
|
+
| `userId` | `string` |
|
|
97
98
|
|
|
98
99
|
#### Returns
|
|
99
100
|
|
|
100
101
|
`Promise`\<\{
|
|
101
|
-
|
|
102
|
-
|
|
102
|
+
`methods`: `string`[];
|
|
103
|
+
`preferredMethod?`: `string`;
|
|
103
104
|
\}\>
|
|
104
105
|
|
|
105
|
-
|
|
106
|
+
---
|
|
106
107
|
|
|
107
108
|
### initSetup()
|
|
108
109
|
|
|
109
110
|
```ts
|
|
110
111
|
initSetup(
|
|
111
|
-
userId,
|
|
112
|
-
method,
|
|
112
|
+
userId,
|
|
113
|
+
method,
|
|
113
114
|
context?): Promise<IMfaSetup>;
|
|
114
115
|
```
|
|
115
116
|
|
|
@@ -119,17 +120,17 @@ Initializes setup for a specific MFA method.
|
|
|
119
120
|
|
|
120
121
|
#### Parameters
|
|
121
122
|
|
|
122
|
-
| Parameter
|
|
123
|
-
|
|
|
124
|
-
| `userId`
|
|
125
|
-
| `method`
|
|
123
|
+
| Parameter | Type |
|
|
124
|
+
| ---------- | ------------------ |
|
|
125
|
+
| `userId` | `string` |
|
|
126
|
+
| `method` | `string` |
|
|
126
127
|
| `context?` | `IMfaSetupContext` |
|
|
127
128
|
|
|
128
129
|
#### Returns
|
|
129
130
|
|
|
130
131
|
`Promise`\<[`IMfaSetup`](Interface.IMfaSetup)\>
|
|
131
132
|
|
|
132
|
-
|
|
133
|
+
---
|
|
133
134
|
|
|
134
135
|
### issueChallenges()
|
|
135
136
|
|
|
@@ -143,16 +144,16 @@ Issues out-of-band challenge codes for login flows for applicable channels.
|
|
|
143
144
|
|
|
144
145
|
#### Parameters
|
|
145
146
|
|
|
146
|
-
| Parameter | Type
|
|
147
|
-
|
|
|
148
|
-
| `userId`
|
|
147
|
+
| Parameter | Type |
|
|
148
|
+
| --------- | ------------------- |
|
|
149
|
+
| `userId` | `string` |
|
|
149
150
|
| `methods` | readonly `string`[] |
|
|
150
151
|
|
|
151
152
|
#### Returns
|
|
152
153
|
|
|
153
154
|
`Promise`\<`void`\>
|
|
154
155
|
|
|
155
|
-
|
|
156
|
+
---
|
|
156
157
|
|
|
157
158
|
### regenerateBackupCodes()
|
|
158
159
|
|
|
@@ -166,15 +167,15 @@ Regenerates backup codes.
|
|
|
166
167
|
|
|
167
168
|
#### Parameters
|
|
168
169
|
|
|
169
|
-
| Parameter | Type
|
|
170
|
-
|
|
|
171
|
-
| `userId`
|
|
170
|
+
| Parameter | Type |
|
|
171
|
+
| --------- | -------- |
|
|
172
|
+
| `userId` | `string` |
|
|
172
173
|
|
|
173
174
|
#### Returns
|
|
174
175
|
|
|
175
176
|
`Promise`\<readonly `string`[]\>
|
|
176
177
|
|
|
177
|
-
|
|
178
|
+
---
|
|
178
179
|
|
|
179
180
|
### setPreferredMethod()
|
|
180
181
|
|
|
@@ -188,23 +189,23 @@ Updates the preferred MFA method.
|
|
|
188
189
|
|
|
189
190
|
#### Parameters
|
|
190
191
|
|
|
191
|
-
| Parameter | Type
|
|
192
|
-
|
|
|
193
|
-
| `userId`
|
|
194
|
-
| `method`
|
|
192
|
+
| Parameter | Type |
|
|
193
|
+
| --------- | -------- |
|
|
194
|
+
| `userId` | `string` |
|
|
195
|
+
| `method` | `string` |
|
|
195
196
|
|
|
196
197
|
#### Returns
|
|
197
198
|
|
|
198
199
|
`Promise`\<`void`\>
|
|
199
200
|
|
|
200
|
-
|
|
201
|
+
---
|
|
201
202
|
|
|
202
203
|
### verifyChallenge()
|
|
203
204
|
|
|
204
205
|
```ts
|
|
205
206
|
verifyChallenge(
|
|
206
|
-
userId,
|
|
207
|
-
method,
|
|
207
|
+
userId,
|
|
208
|
+
method,
|
|
208
209
|
code): Promise<boolean>;
|
|
209
210
|
```
|
|
210
211
|
|
|
@@ -214,24 +215,24 @@ Verifies a login challenge using the selected method or backup code.
|
|
|
214
215
|
|
|
215
216
|
#### Parameters
|
|
216
217
|
|
|
217
|
-
| Parameter | Type
|
|
218
|
-
|
|
|
219
|
-
| `userId`
|
|
220
|
-
| `method`
|
|
221
|
-
| `code`
|
|
218
|
+
| Parameter | Type |
|
|
219
|
+
| --------- | -------- |
|
|
220
|
+
| `userId` | `string` |
|
|
221
|
+
| `method` | `string` |
|
|
222
|
+
| `code` | `string` |
|
|
222
223
|
|
|
223
224
|
#### Returns
|
|
224
225
|
|
|
225
226
|
`Promise`\<`boolean`\>
|
|
226
227
|
|
|
227
|
-
|
|
228
|
+
---
|
|
228
229
|
|
|
229
230
|
### verifySetup()
|
|
230
231
|
|
|
231
232
|
```ts
|
|
232
233
|
verifySetup(
|
|
233
|
-
userId,
|
|
234
|
-
method,
|
|
234
|
+
userId,
|
|
235
|
+
method,
|
|
235
236
|
code): Promise<IMfaConfirmation>;
|
|
236
237
|
```
|
|
237
238
|
|
|
@@ -241,11 +242,11 @@ Verifies the initial code for a method and issues backup codes.
|
|
|
241
242
|
|
|
242
243
|
#### Parameters
|
|
243
244
|
|
|
244
|
-
| Parameter | Type
|
|
245
|
-
|
|
|
246
|
-
| `userId`
|
|
247
|
-
| `method`
|
|
248
|
-
| `code`
|
|
245
|
+
| Parameter | Type |
|
|
246
|
+
| --------- | -------- |
|
|
247
|
+
| `userId` | `string` |
|
|
248
|
+
| `method` | `string` |
|
|
249
|
+
| `code` | `string` |
|
|
249
250
|
|
|
250
251
|
#### Returns
|
|
251
252
|
|
|
@@ -3,6 +3,7 @@ title: 'Abstract Class: MfaSubjectPort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Abstract Class: MfaSubjectPort
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/contracts/MfaSubjectPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/MfaSubjectPort.ts#L14)
|
|
@@ -36,9 +37,9 @@ Find an MFA subject by its unique identifier.
|
|
|
36
37
|
|
|
37
38
|
#### Parameters
|
|
38
39
|
|
|
39
|
-
| Parameter | Type
|
|
40
|
-
|
|
|
41
|
-
| `id`
|
|
40
|
+
| Parameter | Type | Description |
|
|
41
|
+
| --------- | -------- | ----------------------- |
|
|
42
|
+
| `id` | `string` | The subject identifier. |
|
|
42
43
|
|
|
43
44
|
#### Returns
|
|
44
45
|
|
|
@@ -46,7 +47,7 @@ Find an MFA subject by its unique identifier.
|
|
|
46
47
|
|
|
47
48
|
The MFA subject or `null`.
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
---
|
|
50
51
|
|
|
51
52
|
### updateMfaState()
|
|
52
53
|
|
|
@@ -60,10 +61,10 @@ Update MFA-related fields on the subject.
|
|
|
60
61
|
|
|
61
62
|
#### Parameters
|
|
62
63
|
|
|
63
|
-
| Parameter | Type
|
|
64
|
-
|
|
|
65
|
-
| `id`
|
|
66
|
-
| `data`
|
|
64
|
+
| Parameter | Type | Description |
|
|
65
|
+
| --------- | -------------------------------------------------- | --------------------------- |
|
|
66
|
+
| `id` | `string` | The subject identifier. |
|
|
67
|
+
| `data` | [`IMfaSubjectUpdate`](Interface.IMfaSubjectUpdate) | The partial update payload. |
|
|
67
68
|
|
|
68
69
|
#### Returns
|
|
69
70
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: MicrosoftStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: MicrosoftStrategy
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/strategies/MicrosoftStrategy.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/strategies/MicrosoftStrategy.ts#L19)
|
|
@@ -27,10 +28,10 @@ Initializes a new instance of the `MicrosoftStrategy` 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 `MicrosoftStrategy` class.
|
|
|
39
40
|
#### Overrides
|
|
40
41
|
|
|
41
42
|
```ts
|
|
42
|
-
PassportStrategy(Strategy, 'microsoft').constructor
|
|
43
|
+
PassportStrategy(Strategy, 'microsoft').constructor;
|
|
43
44
|
```
|
|
44
45
|
|
|
45
46
|
## Methods
|
|
@@ -48,8 +49,8 @@ PassportStrategy(Strategy, 'microsoft').constructor
|
|
|
48
49
|
|
|
49
50
|
```ts
|
|
50
51
|
validate(
|
|
51
|
-
accessToken,
|
|
52
|
-
refreshToken,
|
|
52
|
+
accessToken,
|
|
53
|
+
refreshToken,
|
|
53
54
|
profile): Promise<IAuthSubject>;
|
|
54
55
|
```
|
|
55
56
|
|
|
@@ -59,11 +60,11 @@ Validates the Microsoft authentication payload.
|
|
|
59
60
|
|
|
60
61
|
#### Parameters
|
|
61
62
|
|
|
62
|
-
| Parameter
|
|
63
|
-
|
|
|
64
|
-
| `accessToken`
|
|
65
|
-
| `refreshToken` | `string`
|
|
66
|
-
| `profile`
|
|
63
|
+
| Parameter | Type | Description |
|
|
64
|
+
| -------------- | --------- | ----------------------- |
|
|
65
|
+
| `accessToken` | `string` | OAuth access token. |
|
|
66
|
+
| `refreshToken` | `string` | OAuth refresh token. |
|
|
67
|
+
| `profile` | `Profile` | Microsoft profile data. |
|
|
67
68
|
|
|
68
69
|
#### Returns
|
|
69
70
|
|
|
@@ -74,5 +75,5 @@ The authenticated user.
|
|
|
74
75
|
#### Overrides
|
|
75
76
|
|
|
76
77
|
```ts
|
|
77
|
-
PassportStrategy(Strategy, 'microsoft').validate
|
|
78
|
+
PassportStrategy(Strategy, 'microsoft').validate;
|
|
78
79
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Class: RolesGuard'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: RolesGuard
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/RolesGuard.ts#L13)
|
|
@@ -25,8 +26,8 @@ Constructs a new instance of the `RolesGuard` class.
|
|
|
25
26
|
|
|
26
27
|
#### Parameters
|
|
27
28
|
|
|
28
|
-
| Parameter
|
|
29
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ----------- | ----------- |
|
|
30
31
|
| `reflector` | `Reflector` |
|
|
31
32
|
|
|
32
33
|
#### Returns
|
|
@@ -45,8 +46,8 @@ Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://g
|
|
|
45
46
|
|
|
46
47
|
#### Parameters
|
|
47
48
|
|
|
48
|
-
| Parameter | Type
|
|
49
|
-
|
|
|
49
|
+
| Parameter | Type |
|
|
50
|
+
| --------- | ------------------ |
|
|
50
51
|
| `context` | `ExecutionContext` |
|
|
51
52
|
|
|
52
53
|
#### Returns
|
|
@@ -56,5 +57,5 @@ Defined in: [libs/platform-authentication/src/guards/RolesGuard.ts:38](https://g
|
|
|
56
57
|
#### Implementation of
|
|
57
58
|
|
|
58
59
|
```ts
|
|
59
|
-
CanActivate.canActivate
|
|
60
|
+
CanActivate.canActivate;
|
|
60
61
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Class: SessionMappingProfile'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: SessionMappingProfile
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/mappers/SessionMappingProfile.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mappers/SessionMappingProfile.ts#L39)
|
|
@@ -28,7 +29,7 @@ new SessionMappingProfile(): SessionMappingProfile;
|
|
|
28
29
|
#### Inherited from
|
|
29
30
|
|
|
30
31
|
```ts
|
|
31
|
-
MappingProfileBase.constructor
|
|
32
|
+
MappingProfileBase.constructor;
|
|
32
33
|
```
|
|
33
34
|
|
|
34
35
|
## Methods
|
|
@@ -45,8 +46,8 @@ Configure mappings for Session entity.
|
|
|
45
46
|
|
|
46
47
|
#### Parameters
|
|
47
48
|
|
|
48
|
-
| Parameter | Type
|
|
49
|
-
|
|
|
49
|
+
| Parameter | Type | Description |
|
|
50
|
+
| --------- | ----------------- | ------------------- |
|
|
50
51
|
| `builder` | `IMappingBuilder` | The mapping builder |
|
|
51
52
|
|
|
52
53
|
#### Returns
|
|
@@ -56,5 +57,5 @@ Configure mappings for Session entity.
|
|
|
56
57
|
#### Overrides
|
|
57
58
|
|
|
58
59
|
```ts
|
|
59
|
-
MappingProfileBase.configure
|
|
60
|
+
MappingProfileBase.configure;
|
|
60
61
|
```
|
|
@@ -3,6 +3,7 @@ title: 'Abstract Class: SessionPersistencePort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Abstract Class: SessionPersistencePort
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/contracts/SessionPersistencePort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/contracts/SessionPersistencePort.ts#L14)
|
|
@@ -36,9 +37,9 @@ Find all sessions for a given user.
|
|
|
36
37
|
|
|
37
38
|
#### Parameters
|
|
38
39
|
|
|
39
|
-
| Parameter | Type
|
|
40
|
-
|
|
|
41
|
-
| `userId`
|
|
40
|
+
| Parameter | Type | Description |
|
|
41
|
+
| --------- | -------- | -------------------- |
|
|
42
|
+
| `userId` | `string` | The user identifier. |
|
|
42
43
|
|
|
43
44
|
#### Returns
|
|
44
45
|
|
|
@@ -46,7 +47,7 @@ Find all sessions for a given user.
|
|
|
46
47
|
|
|
47
48
|
Sessions ordered by last activity descending.
|
|
48
49
|
|
|
49
|
-
|
|
50
|
+
---
|
|
50
51
|
|
|
51
52
|
### findByToken()
|
|
52
53
|
|
|
@@ -60,9 +61,9 @@ Find a session by its token.
|
|
|
60
61
|
|
|
61
62
|
#### Parameters
|
|
62
63
|
|
|
63
|
-
| Parameter | Type
|
|
64
|
-
|
|
|
65
|
-
| `token`
|
|
64
|
+
| Parameter | Type | Description |
|
|
65
|
+
| --------- | -------- | ------------------ |
|
|
66
|
+
| `token` | `string` | The session token. |
|
|
66
67
|
|
|
67
68
|
#### Returns
|
|
68
69
|
|
|
@@ -70,7 +71,7 @@ Find a session by its token.
|
|
|
70
71
|
|
|
71
72
|
The session record or `null`.
|
|
72
73
|
|
|
73
|
-
|
|
74
|
+
---
|
|
74
75
|
|
|
75
76
|
### invalidate()
|
|
76
77
|
|
|
@@ -84,9 +85,9 @@ Invalidate (delete) a session by its token.
|
|
|
84
85
|
|
|
85
86
|
#### Parameters
|
|
86
87
|
|
|
87
|
-
| Parameter | Type
|
|
88
|
-
|
|
|
89
|
-
| `token`
|
|
88
|
+
| Parameter | Type | Description |
|
|
89
|
+
| --------- | -------- | ------------------ |
|
|
90
|
+
| `token` | `string` | The session token. |
|
|
90
91
|
|
|
91
92
|
#### Returns
|
|
92
93
|
|
|
@@ -94,7 +95,7 @@ Invalidate (delete) a session by its token.
|
|
|
94
95
|
|
|
95
96
|
`true` if a session was invalidated.
|
|
96
97
|
|
|
97
|
-
|
|
98
|
+
---
|
|
98
99
|
|
|
99
100
|
### invalidateById()
|
|
100
101
|
|
|
@@ -108,10 +109,10 @@ Invalidate (delete) a session by its record id and owning user id.
|
|
|
108
109
|
|
|
109
110
|
#### Parameters
|
|
110
111
|
|
|
111
|
-
| Parameter | Type
|
|
112
|
-
|
|
|
113
|
-
| `id`
|
|
114
|
-
| `userId`
|
|
112
|
+
| Parameter | Type | Description |
|
|
113
|
+
| --------- | -------- | ------------------------------ |
|
|
114
|
+
| `id` | `string` | The session record identifier. |
|
|
115
|
+
| `userId` | `string` | The owning user identifier. |
|
|
115
116
|
|
|
116
117
|
#### Returns
|
|
117
118
|
|
|
@@ -119,7 +120,7 @@ Invalidate (delete) a session by its record id and owning user id.
|
|
|
119
120
|
|
|
120
121
|
`true` if a session was invalidated.
|
|
121
122
|
|
|
122
|
-
|
|
123
|
+
---
|
|
123
124
|
|
|
124
125
|
### store()
|
|
125
126
|
|
|
@@ -133,15 +134,15 @@ Store or update a session.
|
|
|
133
134
|
|
|
134
135
|
#### Parameters
|
|
135
136
|
|
|
136
|
-
| Parameter | Type
|
|
137
|
-
|
|
|
138
|
-
| `args`
|
|
137
|
+
| Parameter | Type | Description |
|
|
138
|
+
| --------- | -------------------------------------------------- | -------------------------- |
|
|
139
|
+
| `args` | [`IStoreSessionArgs`](Interface.IStoreSessionArgs) | The session data to store. |
|
|
139
140
|
|
|
140
141
|
#### Returns
|
|
141
142
|
|
|
142
143
|
`Promise`\<`void`\>
|
|
143
144
|
|
|
144
|
-
|
|
145
|
+
---
|
|
145
146
|
|
|
146
147
|
### updateLastActive()
|
|
147
148
|
|
|
@@ -155,10 +156,10 @@ Update the last-active timestamp for a session.
|
|
|
155
156
|
|
|
156
157
|
#### Parameters
|
|
157
158
|
|
|
158
|
-
| Parameter | Type
|
|
159
|
-
|
|
|
160
|
-
| `token`
|
|
161
|
-
| `date`
|
|
159
|
+
| Parameter | Type | Description |
|
|
160
|
+
| --------- | -------- | ------------------------- |
|
|
161
|
+
| `token` | `string` | The session token. |
|
|
162
|
+
| `date` | `Date` | The new last-active date. |
|
|
162
163
|
|
|
163
164
|
#### Returns
|
|
164
165
|
|
|
@@ -3,6 +3,7 @@ title: 'Class: SessionResponse'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
+
|
|
6
7
|
# Class: SessionResponse
|
|
7
8
|
|
|
8
9
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L14)
|
|
@@ -31,7 +32,7 @@ browserName: string | null;
|
|
|
31
32
|
|
|
32
33
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L55)
|
|
33
34
|
|
|
34
|
-
|
|
35
|
+
---
|
|
35
36
|
|
|
36
37
|
### browserVersion
|
|
37
38
|
|
|
@@ -41,7 +42,7 @@ browserVersion: string | null;
|
|
|
41
42
|
|
|
42
43
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L65)
|
|
43
44
|
|
|
44
|
-
|
|
45
|
+
---
|
|
45
46
|
|
|
46
47
|
### clientName
|
|
47
48
|
|
|
@@ -51,7 +52,7 @@ clientName: string | null;
|
|
|
51
52
|
|
|
52
53
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L105)
|
|
53
54
|
|
|
54
|
-
|
|
55
|
+
---
|
|
55
56
|
|
|
56
57
|
### createdAt
|
|
57
58
|
|
|
@@ -61,7 +62,7 @@ createdAt: Date;
|
|
|
61
62
|
|
|
62
63
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L129)
|
|
63
64
|
|
|
64
|
-
|
|
65
|
+
---
|
|
65
66
|
|
|
66
67
|
### deviceName
|
|
67
68
|
|
|
@@ -71,7 +72,7 @@ deviceName: string | null;
|
|
|
71
72
|
|
|
72
73
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L45)
|
|
73
74
|
|
|
74
|
-
|
|
75
|
+
---
|
|
75
76
|
|
|
76
77
|
### deviceType
|
|
77
78
|
|
|
@@ -81,7 +82,7 @@ deviceType: string | null;
|
|
|
81
82
|
|
|
82
83
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L35)
|
|
83
84
|
|
|
84
|
-
|
|
85
|
+
---
|
|
85
86
|
|
|
86
87
|
### id
|
|
87
88
|
|
|
@@ -91,7 +92,7 @@ id: string;
|
|
|
91
92
|
|
|
92
93
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L25)
|
|
93
94
|
|
|
94
|
-
|
|
95
|
+
---
|
|
95
96
|
|
|
96
97
|
### ipAddress
|
|
97
98
|
|
|
@@ -101,7 +102,7 @@ ipAddress: string;
|
|
|
101
102
|
|
|
102
103
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L113)
|
|
103
104
|
|
|
104
|
-
|
|
105
|
+
---
|
|
105
106
|
|
|
106
107
|
### isCurrent
|
|
107
108
|
|
|
@@ -111,7 +112,7 @@ isCurrent: boolean;
|
|
|
111
112
|
|
|
112
113
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L137)
|
|
113
114
|
|
|
114
|
-
|
|
115
|
+
---
|
|
115
116
|
|
|
116
117
|
### lastActive
|
|
117
118
|
|
|
@@ -121,7 +122,7 @@ lastActive: Date;
|
|
|
121
122
|
|
|
122
123
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L121)
|
|
123
124
|
|
|
124
|
-
|
|
125
|
+
---
|
|
125
126
|
|
|
126
127
|
### location
|
|
127
128
|
|
|
@@ -131,7 +132,7 @@ location: string | null;
|
|
|
131
132
|
|
|
132
133
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:95](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L95)
|
|
133
134
|
|
|
134
|
-
|
|
135
|
+
---
|
|
135
136
|
|
|
136
137
|
### osName
|
|
137
138
|
|
|
@@ -141,7 +142,7 @@ osName: string | null;
|
|
|
141
142
|
|
|
142
143
|
Defined in: [libs/platform-authentication/src/models/responses/SessionResponse.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/models/responses/SessionResponse.ts#L75)
|
|
143
144
|
|
|
144
|
-
|
|
145
|
+
---
|
|
145
146
|
|
|
146
147
|
### osVersion
|
|
147
148
|
|