@breadstone/archipel-mcp 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/index.md +7 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +141 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +47 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +161 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +58 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +47 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +58 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +14 -0
- package/data/packages/platform-analytics/api/index.md +44 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +80 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -13
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -15
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -10
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -31
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +72 -0
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +78 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +33 -13
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -15
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -9
- package/data/packages/platform-authentication/api/Class.MfaService.md +54 -59
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -13
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +78 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -10
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -9
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -30
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -17
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -38
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -10
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -7
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -7
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -34
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -21
- package/data/packages/platform-authentication/api/Function.Token.md +18 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +24 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +22 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +42 -18
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -12
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -10
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -15
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -5
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -8
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -14
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -12
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -19
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -10
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -8
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -10
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -9
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.User.md +24 -0
- package/data/packages/platform-authentication/api/index.md +86 -490
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -10
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -9
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -17
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -50
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -12
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -23
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +68 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +38 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +6 -11
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +12 -17
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +26 -31
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +21 -26
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +8 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +18 -23
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +4 -9
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -10
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -10
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -10
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +2 -7
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -6
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -7
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/index.md +41 -93
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +2 -3
- package/data/packages/platform-core/api/Class.BcryptService.md +7 -8
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
- package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +12 -13
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
- package/data/packages/platform-core/api/Class.ConfigService.md +26 -27
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +33 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +6 -7
- package/data/packages/platform-core/api/Class.CryptoService.md +3 -4
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
- package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +18 -21
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +15 -16
- package/data/packages/platform-core/api/Class.EventHub.md +25 -26
- package/data/packages/platform-core/api/Class.EventModule.md +0 -1
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +20 -23
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
- package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
- package/data/packages/platform-core/api/Class.HostModule.md +0 -2
- package/data/packages/platform-core/api/Class.HostService.md +13 -14
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
- package/data/packages/platform-core/api/Class.IdentifierModule.md +5 -6
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +56 -3
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +0 -1
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +6 -7
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
- package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
- package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
- package/data/packages/platform-core/api/Class.MappingService.md +52 -53
- package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +37 -38
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.OtpService.md +8 -9
- package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
- package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +21 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +39 -40
- package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +123 -125
- package/data/packages/platform-core/api/Class.SseHub.md +23 -24
- package/data/packages/platform-core/api/Class.SseModule.md +3 -4
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Function.Public.md +18 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +58 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +33 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +39 -0
- package/data/packages/platform-core/api/Function.env.md +28 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +26 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +27 -0
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-core/api/Interface.ICacheStats.md +4 -5
- package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -11
- package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +8 -9
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +4 -5
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +4 -5
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
- package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
- package/data/packages/platform-core/api/Interface.IOtpService.md +8 -9
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +14 -15
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
- package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
- package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
- package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -23
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
- package/data/packages/platform-core/api/Variable.APP_PORT.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +14 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +14 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +12 -0
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +26 -0
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +28 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +31 -0
- package/data/packages/platform-core/api/Variable.Lang.md +29 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +14 -0
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +23 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +24 -0
- package/data/packages/platform-core/api/index.md +160 -620
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -11
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -10
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -24
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -12
- package/data/packages/platform-database/api/Class.RepositoryBase.md +185 -125
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -10
- package/data/packages/platform-database/api/Function.pageable.md +35 -0
- package/data/packages/platform-database/api/Function.paginator.md +22 -0
- package/data/packages/platform-database/api/Function.query.md +34 -0
- package/data/packages/platform-database/api/Function.skip.md +33 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +31 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -5
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -6
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -9
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -12
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -10
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -7
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -7
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -12
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -8
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -8
- package/data/packages/platform-database/api/index.md +27 -163
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +194 -20
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -12
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -7
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -26
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -11
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -10
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -13
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -7
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -8
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -23
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -8
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -8
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -6
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -6
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/index.md +28 -72
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +184 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +65 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +48 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +90 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +198 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +249 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +101 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +78 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +60 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +94 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +46 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +60 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +70 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +30 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +32 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +38 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +36 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +38 -0
- package/data/packages/platform-esigning/api/index.md +84 -0
- package/data/packages/platform-esigning/index.md +691 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -5
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +14 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-logging/api/index.md +7 -30
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +3 -10
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +30 -19
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +3 -10
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -9
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -5
- package/data/packages/platform-mailing/api/Class.MailService.md +27 -32
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -17
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -19
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +14 -21
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +18 -7
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -5
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -6
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -6
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +12 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +16 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +14 -0
- package/data/packages/platform-mailing/api/index.md +54 -384
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
- package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +28 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +28 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +28 -0
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +14 -0
- package/data/packages/platform-mcp/api/index.md +27 -104
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -10
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -10
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +16 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -7
- package/data/packages/platform-openapi/api/Function.Api.md +35 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +42 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +18 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +27 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -10
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -10
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +12 -0
- package/data/packages/platform-openapi/api/index.md +24 -191
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -12
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -11
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -12
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -29
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -29
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -29
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -30
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -7
- package/data/packages/platform-payments/api/Class.StripeClient.md +24 -29
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +25 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -9
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -10
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -11
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -13
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -7
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -8
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -14
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +12 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/index.md +41 -221
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +30 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +28 -0
- package/data/packages/platform-reporting/api/index.md +23 -71
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -31
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -28
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -40
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -7
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -27
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -7
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -13
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -7
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +12 -0
- package/data/packages/platform-telemetry/api/index.md +20 -65
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
|
@@ -3,7 +3,6 @@ title: 'Interface: IIntelligenceTextGenerator'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IIntelligenceTextGenerator
|
|
8
7
|
|
|
9
8
|
Defined in: [intelligence/IIntelligenceTextGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IIntelligenceTextGenerator.ts#L15)
|
|
@@ -22,16 +21,16 @@ Defined in: [intelligence/IIntelligenceTextGenerator.ts:19](https://github.com/R
|
|
|
22
21
|
|
|
23
22
|
#### Parameters
|
|
24
23
|
|
|
25
|
-
| Parameter
|
|
26
|
-
|
|
|
27
|
-
| `prompt`
|
|
24
|
+
| Parameter | Type |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) |
|
|
28
27
|
| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) |
|
|
29
28
|
|
|
30
29
|
#### Returns
|
|
31
30
|
|
|
32
31
|
`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
|
|
33
32
|
|
|
34
|
-
|
|
33
|
+
***
|
|
35
34
|
|
|
36
35
|
### getConfiguration()
|
|
37
36
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ILayeredCache\<TKey, TValue\>'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ILayeredCache\<TKey, TValue\>
|
|
8
7
|
|
|
9
8
|
Defined in: [cache/ILayeredCache.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L14)
|
|
@@ -12,10 +11,10 @@ Generic layered cache contract (DB first, then memory, then external fetcher).
|
|
|
12
11
|
|
|
13
12
|
## Type Parameters
|
|
14
13
|
|
|
15
|
-
| Type Parameter | Description
|
|
16
|
-
|
|
|
17
|
-
| `TKey`
|
|
18
|
-
| `TValue`
|
|
14
|
+
| Type Parameter | Description |
|
|
15
|
+
| ------ | ------ |
|
|
16
|
+
| `TKey` | The type of the cache keys. |
|
|
17
|
+
| `TValue` | The type of the cache values. |
|
|
19
18
|
|
|
20
19
|
## Methods
|
|
21
20
|
|
|
@@ -31,15 +30,15 @@ Retrieves a value from the cache.
|
|
|
31
30
|
|
|
32
31
|
#### Parameters
|
|
33
32
|
|
|
34
|
-
| Parameter | Type
|
|
35
|
-
|
|
|
36
|
-
| `key`
|
|
33
|
+
| Parameter | Type | Description |
|
|
34
|
+
| ------ | ------ | ------ |
|
|
35
|
+
| `key` | `TKey` | The key to retrieve. |
|
|
37
36
|
|
|
38
37
|
#### Returns
|
|
39
38
|
|
|
40
39
|
`TValue` \| `undefined`
|
|
41
40
|
|
|
42
|
-
|
|
41
|
+
***
|
|
43
42
|
|
|
44
43
|
### getAsync()
|
|
45
44
|
|
|
@@ -53,15 +52,15 @@ Retrieves a value from the cache (asynchronous).
|
|
|
53
52
|
|
|
54
53
|
#### Parameters
|
|
55
54
|
|
|
56
|
-
| Parameter | Type
|
|
57
|
-
|
|
|
58
|
-
| `key`
|
|
55
|
+
| Parameter | Type | Description |
|
|
56
|
+
| ------ | ------ | ------ |
|
|
57
|
+
| `key` | `TKey` | The key to retrieve. |
|
|
59
58
|
|
|
60
59
|
#### Returns
|
|
61
60
|
|
|
62
61
|
`Promise`\<`TValue` \| `undefined`\>
|
|
63
62
|
|
|
64
|
-
|
|
63
|
+
***
|
|
65
64
|
|
|
66
65
|
### invalidate()
|
|
67
66
|
|
|
@@ -75,15 +74,15 @@ Invalidates a key in the cache.
|
|
|
75
74
|
|
|
76
75
|
#### Parameters
|
|
77
76
|
|
|
78
|
-
| Parameter | Type
|
|
79
|
-
|
|
|
80
|
-
| `key`
|
|
77
|
+
| Parameter | Type | Description |
|
|
78
|
+
| ------ | ------ | ------ |
|
|
79
|
+
| `key` | `TKey` | The key to invalidate. |
|
|
81
80
|
|
|
82
81
|
#### Returns
|
|
83
82
|
|
|
84
83
|
`void`
|
|
85
84
|
|
|
86
|
-
|
|
85
|
+
***
|
|
87
86
|
|
|
88
87
|
### invalidateAsync()
|
|
89
88
|
|
|
@@ -97,15 +96,15 @@ Invalidates a key in the cache (asynchronous).
|
|
|
97
96
|
|
|
98
97
|
#### Parameters
|
|
99
98
|
|
|
100
|
-
| Parameter | Type
|
|
101
|
-
|
|
|
102
|
-
| `key`
|
|
99
|
+
| Parameter | Type | Description |
|
|
100
|
+
| ------ | ------ | ------ |
|
|
101
|
+
| `key` | `TKey` | The key to invalidate. |
|
|
103
102
|
|
|
104
103
|
#### Returns
|
|
105
104
|
|
|
106
105
|
`Promise`\<`void`\>
|
|
107
106
|
|
|
108
|
-
|
|
107
|
+
***
|
|
109
108
|
|
|
110
109
|
### set()
|
|
111
110
|
|
|
@@ -119,16 +118,16 @@ Sets a value in the cache.
|
|
|
119
118
|
|
|
120
119
|
#### Parameters
|
|
121
120
|
|
|
122
|
-
| Parameter | Type
|
|
123
|
-
|
|
|
124
|
-
| `key`
|
|
125
|
-
| `value`
|
|
121
|
+
| Parameter | Type | Description |
|
|
122
|
+
| ------ | ------ | ------ |
|
|
123
|
+
| `key` | `TKey` | The key to set. |
|
|
124
|
+
| `value` | `TValue` | The value to set. |
|
|
126
125
|
|
|
127
126
|
#### Returns
|
|
128
127
|
|
|
129
128
|
`void`
|
|
130
129
|
|
|
131
|
-
|
|
130
|
+
***
|
|
132
131
|
|
|
133
132
|
### setAsync()
|
|
134
133
|
|
|
@@ -142,16 +141,16 @@ Sets a value in the cache (asynchronous).
|
|
|
142
141
|
|
|
143
142
|
#### Parameters
|
|
144
143
|
|
|
145
|
-
| Parameter | Type
|
|
146
|
-
|
|
|
147
|
-
| `key`
|
|
148
|
-
| `value`
|
|
144
|
+
| Parameter | Type | Description |
|
|
145
|
+
| ------ | ------ | ------ |
|
|
146
|
+
| `key` | `TKey` | The key to set. |
|
|
147
|
+
| `value` | `TValue` | The value to set. |
|
|
149
148
|
|
|
150
149
|
#### Returns
|
|
151
150
|
|
|
152
151
|
`Promise`\<`void`\>
|
|
153
152
|
|
|
154
|
-
|
|
153
|
+
***
|
|
155
154
|
|
|
156
155
|
### stats()?
|
|
157
156
|
|
|
@@ -169,7 +168,7 @@ Retrieves cache statistics.
|
|
|
169
168
|
|
|
170
169
|
The cache statistics.
|
|
171
170
|
|
|
172
|
-
|
|
171
|
+
***
|
|
173
172
|
|
|
174
173
|
### warm()?
|
|
175
174
|
|
|
@@ -183,9 +182,9 @@ Proactively warms the cache for a given key (optional).
|
|
|
183
182
|
|
|
184
183
|
#### Parameters
|
|
185
184
|
|
|
186
|
-
| Parameter | Type
|
|
187
|
-
|
|
|
188
|
-
| `key`
|
|
185
|
+
| Parameter | Type | Description |
|
|
186
|
+
| ------ | ------ | ------ |
|
|
187
|
+
| `key` | `TKey` | The key to warm. |
|
|
189
188
|
|
|
190
189
|
#### Returns
|
|
191
190
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ILayeredCacheOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ILayeredCacheOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [cache/MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L16)
|
|
@@ -22,7 +21,7 @@ Defined in: [cache/MemoryLayeredCache.ts:53](https://github.com/RueDeRennes/arch
|
|
|
22
21
|
|
|
23
22
|
An optional name/label for the cache, used in metrics (default: 'memory').
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### maxEntries?
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [cache/MemoryLayeredCache.ts:39](https://github.com/RueDeRennes/arch
|
|
|
34
33
|
|
|
35
34
|
Maximum number of entries in the cache (optional, default: infinite).
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### metricsRecorder?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [cache/MemoryLayeredCache.ts:46](https://github.com/RueDeRennes/arch
|
|
|
46
45
|
|
|
47
46
|
Metrics recorder for cache statistics (optional, default: NoopCacheMetricsRecorder).
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### staleWhileRevalidate?
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [cache/MemoryLayeredCache.ts:32](https://github.com/RueDeRennes/arch
|
|
|
58
57
|
|
|
59
58
|
Whether to serve stale content while revalidating (optional, default: false).
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### ttlMs?
|
|
64
63
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IMappingBuilder'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IMappingBuilder
|
|
8
7
|
|
|
9
8
|
Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L18)
|
|
@@ -26,29 +25,29 @@ The mapping key encodes both input and output types at compile time.
|
|
|
26
25
|
#### Type Parameters
|
|
27
26
|
|
|
28
27
|
| Type Parameter |
|
|
29
|
-
|
|
|
30
|
-
| `TInput`
|
|
31
|
-
| `TOutput`
|
|
28
|
+
| ------ |
|
|
29
|
+
| `TInput` |
|
|
30
|
+
| `TOutput` |
|
|
32
31
|
|
|
33
32
|
#### Parameters
|
|
34
33
|
|
|
35
|
-
| Parameter | Type
|
|
36
|
-
|
|
|
37
|
-
| `key`
|
|
38
|
-
| `fn`
|
|
34
|
+
| Parameter | Type | Description |
|
|
35
|
+
| ------ | ------ | ------ |
|
|
36
|
+
| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
|
|
37
|
+
| `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
|
|
39
38
|
|
|
40
39
|
#### Returns
|
|
41
40
|
|
|
42
41
|
`this`
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
***
|
|
45
44
|
|
|
46
45
|
### createMap()
|
|
47
46
|
|
|
48
47
|
```ts
|
|
49
48
|
createMap<TSource, TDestination>(
|
|
50
|
-
source,
|
|
51
|
-
destination,
|
|
49
|
+
source,
|
|
50
|
+
destination,
|
|
52
51
|
fn): this;
|
|
53
52
|
```
|
|
54
53
|
|
|
@@ -60,17 +59,17 @@ Ensures compile-time type compatibility between source and destination.
|
|
|
60
59
|
#### Type Parameters
|
|
61
60
|
|
|
62
61
|
| Type Parameter |
|
|
63
|
-
|
|
|
64
|
-
| `TSource`
|
|
62
|
+
| ------ |
|
|
63
|
+
| `TSource` |
|
|
65
64
|
| `TDestination` |
|
|
66
65
|
|
|
67
66
|
#### Parameters
|
|
68
67
|
|
|
69
|
-
| Parameter
|
|
70
|
-
|
|
|
71
|
-
| `source`
|
|
72
|
-
| `destination` | `Constructor`\<`TDestination`\>
|
|
73
|
-
| `fn`
|
|
68
|
+
| Parameter | Type | Description |
|
|
69
|
+
| ------ | ------ | ------ |
|
|
70
|
+
| `source` | `Constructor`\<`TSource`\> | The source type. |
|
|
71
|
+
| `destination` | `Constructor`\<`TDestination`\> | The destination type. |
|
|
72
|
+
| `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
|
|
74
73
|
|
|
75
74
|
#### Returns
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IMappingKey\<TInput, TOutput\>'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IMappingKey\<TInput, TOutput\>
|
|
8
7
|
|
|
9
8
|
Defined in: [mapping/types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L9)
|
|
@@ -13,10 +12,10 @@ This ensures compile-time type safety when using the mapping service.
|
|
|
13
12
|
|
|
14
13
|
## Type Parameters
|
|
15
14
|
|
|
16
|
-
| Type Parameter | Description
|
|
17
|
-
|
|
|
18
|
-
| `TInput`
|
|
19
|
-
| `TOutput`
|
|
15
|
+
| Type Parameter | Description |
|
|
16
|
+
| ------ | ------ |
|
|
17
|
+
| `TInput` | The input type for the mapping. |
|
|
18
|
+
| `TOutput` | The output type for the mapping. |
|
|
20
19
|
|
|
21
20
|
## Properties
|
|
22
21
|
|
|
@@ -28,7 +27,7 @@ readonly _brand: "MappingKey";
|
|
|
28
27
|
|
|
29
28
|
Defined in: [mapping/types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L10)
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
***
|
|
32
31
|
|
|
33
32
|
### \_input
|
|
34
33
|
|
|
@@ -38,7 +37,7 @@ readonly _input: TInput;
|
|
|
38
37
|
|
|
39
38
|
Defined in: [mapping/types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L11)
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
***
|
|
42
41
|
|
|
43
42
|
### \_output
|
|
44
43
|
|
|
@@ -48,7 +47,7 @@ readonly _output: TOutput;
|
|
|
48
47
|
|
|
49
48
|
Defined in: [mapping/types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L12)
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
***
|
|
52
51
|
|
|
53
52
|
### key
|
|
54
53
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IMappingProfile'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IMappingProfile
|
|
8
7
|
|
|
9
8
|
Defined in: [mapping/profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L12)
|
|
@@ -24,8 +23,8 @@ Configures the mapping profile.
|
|
|
24
23
|
|
|
25
24
|
#### Parameters
|
|
26
25
|
|
|
27
|
-
| Parameter | Type
|
|
28
|
-
|
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| ------ | ------ | ------ |
|
|
29
28
|
| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
|
|
30
29
|
|
|
31
30
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IOtpService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IOtpService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/IOtpService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L33)
|
|
@@ -30,7 +29,7 @@ Generates a cryptographically random secret suitable for TOTP.
|
|
|
30
29
|
|
|
31
30
|
`string`
|
|
32
31
|
|
|
33
|
-
|
|
32
|
+
***
|
|
34
33
|
|
|
35
34
|
### generateUri()
|
|
36
35
|
|
|
@@ -44,15 +43,15 @@ Generates an `otpauth://` URI for QR code enrollment.
|
|
|
44
43
|
|
|
45
44
|
#### Parameters
|
|
46
45
|
|
|
47
|
-
| Parameter | Type
|
|
48
|
-
|
|
|
46
|
+
| Parameter | Type | Description |
|
|
47
|
+
| ------ | ------ | ------ |
|
|
49
48
|
| `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
|
|
50
49
|
|
|
51
50
|
#### Returns
|
|
52
51
|
|
|
53
52
|
`string`
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
***
|
|
56
55
|
|
|
57
56
|
### verify()
|
|
58
57
|
|
|
@@ -66,10 +65,10 @@ Verifies a TOTP token against the given secret.
|
|
|
66
65
|
|
|
67
66
|
#### Parameters
|
|
68
67
|
|
|
69
|
-
| Parameter | Type
|
|
70
|
-
|
|
|
71
|
-
| `token`
|
|
72
|
-
| `secret`
|
|
68
|
+
| Parameter | Type | Description |
|
|
69
|
+
| ------ | ------ | ------ |
|
|
70
|
+
| `token` | `string` | The one-time password to verify. |
|
|
71
|
+
| `secret` | `string` | The shared secret. |
|
|
73
72
|
|
|
74
73
|
#### Returns
|
|
75
74
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IOtpUriOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IOtpUriOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [services/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [services/IOtpService.ts:11](https://github.com/RueDeRennes/archipel
|
|
|
22
21
|
|
|
23
22
|
The issuer name displayed in the authenticator app.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### label
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [services/IOtpService.ts:16](https://github.com/RueDeRennes/archipel
|
|
|
34
33
|
|
|
35
34
|
The account label (e.g. email or username) shown in the authenticator app.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### secret
|
|
40
39
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IRedisLayeredCacheOptions\<TValue\>'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IRedisLayeredCacheOptions\<TValue\>
|
|
8
7
|
|
|
9
8
|
Defined in: [cache/RedisLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L16)
|
|
@@ -14,8 +13,8 @@ Provides same contract as in-memory layered cache; currently delegates to provid
|
|
|
14
13
|
## Type Parameters
|
|
15
14
|
|
|
16
15
|
| Type Parameter |
|
|
17
|
-
|
|
|
18
|
-
| `TValue`
|
|
16
|
+
| ------ |
|
|
17
|
+
| `TValue` |
|
|
19
18
|
|
|
20
19
|
## Properties
|
|
21
20
|
|
|
@@ -27,7 +26,7 @@ optional cacheName?: string;
|
|
|
27
26
|
|
|
28
27
|
Defined in: [cache/RedisLayeredCache.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L23)
|
|
29
28
|
|
|
30
|
-
|
|
29
|
+
***
|
|
31
30
|
|
|
32
31
|
### deserialize?
|
|
33
32
|
|
|
@@ -39,15 +38,15 @@ Defined in: [cache/RedisLayeredCache.ts:21](https://github.com/RueDeRennes/archi
|
|
|
39
38
|
|
|
40
39
|
#### Parameters
|
|
41
40
|
|
|
42
|
-
| Parameter | Type
|
|
43
|
-
|
|
|
44
|
-
| `raw`
|
|
41
|
+
| Parameter | Type |
|
|
42
|
+
| ------ | ------ |
|
|
43
|
+
| `raw` | `string` |
|
|
45
44
|
|
|
46
45
|
#### Returns
|
|
47
46
|
|
|
48
47
|
`TValue`
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
***
|
|
51
50
|
|
|
52
51
|
### keyPrefix
|
|
53
52
|
|
|
@@ -57,7 +56,7 @@ keyPrefix: string;
|
|
|
57
56
|
|
|
58
57
|
Defined in: [cache/RedisLayeredCache.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L18)
|
|
59
58
|
|
|
60
|
-
|
|
59
|
+
***
|
|
61
60
|
|
|
62
61
|
### metricsRecorder?
|
|
63
62
|
|
|
@@ -67,7 +66,7 @@ optional metricsRecorder?: ICacheMetricsRecorder;
|
|
|
67
66
|
|
|
68
67
|
Defined in: [cache/RedisLayeredCache.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L22)
|
|
69
68
|
|
|
70
|
-
|
|
69
|
+
***
|
|
71
70
|
|
|
72
71
|
### serialize?
|
|
73
72
|
|
|
@@ -79,15 +78,15 @@ Defined in: [cache/RedisLayeredCache.ts:20](https://github.com/RueDeRennes/archi
|
|
|
79
78
|
|
|
80
79
|
#### Parameters
|
|
81
80
|
|
|
82
|
-
| Parameter | Type
|
|
83
|
-
|
|
|
84
|
-
| `value`
|
|
81
|
+
| Parameter | Type |
|
|
82
|
+
| ------ | ------ |
|
|
83
|
+
| `value` | `TValue` |
|
|
85
84
|
|
|
86
85
|
#### Returns
|
|
87
86
|
|
|
88
87
|
`string`
|
|
89
88
|
|
|
90
|
-
|
|
89
|
+
***
|
|
91
90
|
|
|
92
91
|
### ttlSeconds?
|
|
93
92
|
|
|
@@ -97,7 +96,7 @@ optional ttlSeconds?: number;
|
|
|
97
96
|
|
|
98
97
|
Defined in: [cache/RedisLayeredCache.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L19)
|
|
99
98
|
|
|
100
|
-
|
|
99
|
+
***
|
|
101
100
|
|
|
102
101
|
### url
|
|
103
102
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IResourceManagerConfig'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IResourceManagerConfig
|
|
8
7
|
|
|
9
8
|
Defined in: [resources/ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L16)
|
|
@@ -22,7 +21,7 @@ Defined in: [resources/ResourceManager.ts:27](https://github.com/RueDeRennes/arc
|
|
|
22
21
|
|
|
23
22
|
Optional cache for loaded resources.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### cacheTtl?
|
|
28
27
|
|
|
@@ -40,7 +39,7 @@ Cache TTL in seconds.
|
|
|
40
39
|
3600 (1 hour)
|
|
41
40
|
```
|
|
42
41
|
|
|
43
|
-
|
|
42
|
+
***
|
|
44
43
|
|
|
45
44
|
### debug?
|
|
46
45
|
|
|
@@ -55,10 +54,10 @@ Enable debug logging.
|
|
|
55
54
|
#### Default
|
|
56
55
|
|
|
57
56
|
```ts
|
|
58
|
-
false
|
|
57
|
+
false
|
|
59
58
|
```
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### strategies
|
|
64
63
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IResourceMetadata'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IResourceMetadata
|
|
8
7
|
|
|
9
8
|
Defined in: [resources/types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [resources/types/IResourceMetadata.ts:41](https://github.com/RueDeRe
|
|
|
22
21
|
|
|
23
22
|
When this resource was cached (if applicable).
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### encoding?
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [resources/types/IResourceMetadata.ts:31](https://github.com/RueDeRe
|
|
|
34
33
|
|
|
35
34
|
The encoding of the resource (if applicable).
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### key
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [resources/types/IResourceMetadata.ts:11](https://github.com/RueDeRe
|
|
|
46
45
|
|
|
47
46
|
The resource key/identifier.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### mimeType
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [resources/types/IResourceMetadata.ts:21](https://github.com/RueDeRe
|
|
|
58
57
|
|
|
59
58
|
The MIME type of the resource.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### path
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [resources/types/IResourceMetadata.ts:16](https://github.com/RueDeRe
|
|
|
70
69
|
|
|
71
70
|
The full path of the resource.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### size
|
|
76
75
|
|
|
@@ -82,7 +81,7 @@ Defined in: [resources/types/IResourceMetadata.ts:26](https://github.com/RueDeRe
|
|
|
82
81
|
|
|
83
82
|
The size of the resource in bytes.
|
|
84
83
|
|
|
85
|
-
|
|
84
|
+
***
|
|
86
85
|
|
|
87
86
|
### source
|
|
88
87
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IResourceResult'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IResourceResult
|
|
8
7
|
|
|
9
8
|
Defined in: [resources/types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L8)
|
|
@@ -22,7 +21,7 @@ Defined in: [resources/types/IResourceResult.ts:13](https://github.com/RueDeRenn
|
|
|
22
21
|
|
|
23
22
|
The resource content as a Buffer.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### metadata
|
|
28
27
|
|