@breadstone/archipel-mcp 0.0.8 → 0.0.10
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/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
- package/data/packages/platform-analytics/api/index.md +25 -26
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +86 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +32 -33
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +78 -0
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.MfaService.md +65 -66
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +144 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +36 -37
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
- package/data/packages/platform-authentication/api/Function.Token.md +0 -1
- package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +54 -25
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +22 -23
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +29 -0
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -92
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -5
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/index.md +41 -42
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +47 -48
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +24 -25
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +47 -48
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +24 -25
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +9 -10
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +42 -43
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +9 -10
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +22 -23
- package/data/packages/platform-caching/api/index.md +12 -13
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
- 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 +10 -11
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
- 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 +30 -32
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
- 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 +19 -20
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +19 -20
- 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 +21 -22
- 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 +21 -22
- 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 +3 -4
- 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.NormalizedUtils.md +20 -21
- 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 +11 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.ResourceManager.md +107 -108
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
- 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 +0 -1
- package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
- package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
- package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
- package/data/packages/platform-core/api/Function.env.md +4 -5
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
- 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.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 +11 -12
- 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 +14 -15
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- 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.IResourceManagerConfig.md +8 -9
- 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 +2 -3
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- 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_NAME.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +14 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -3
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
- package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
- package/data/packages/platform-core/api/Variable.Lang.md +5 -6
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -3
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -114
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +9 -10
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +5 -6
- package/data/packages/platform-cryptography/api/Class.OtpService.md +12 -13
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +12 -13
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +6 -7
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -9
- package/data/packages/platform-cryptography/api/index.md +11 -12
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
- package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
- package/data/packages/platform-database/api/Function.pageable.md +13 -10
- package/data/packages/platform-database/api/Function.paginator.md +2 -3
- package/data/packages/platform-database/api/Function.query.md +7 -8
- package/data/packages/platform-database/api/Function.skip.md +5 -6
- package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
- package/data/packages/platform-database/api/index.md +27 -28
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/index.md +28 -29
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
- package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
- package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
- package/data/packages/platform-esigning/api/index.md +65 -66
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +8 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +13 -14
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +13 -14
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +7 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +13 -14
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +8 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +6 -7
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
- package/data/packages/platform-intelligence/api/index.md +46 -47
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-logging/api/index.md +7 -8
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailService.md +31 -32
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +18 -19
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
- package/data/packages/platform-mailing/api/index.md +54 -55
- 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 +2 -3
- package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
- 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 +1 -2
- package/data/packages/platform-mcp/api/index.md +26 -27
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
- package/data/packages/platform-openapi/api/Function.Api.md +13 -14
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -6
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
- package/data/packages/platform-openapi/api/index.md +24 -25
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +30 -31
- package/data/packages/platform-payments/api/Class.MollieClient.md +30 -31
- package/data/packages/platform-payments/api/Class.PaddleClient.md +30 -31
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
- package/data/packages/platform-payments/api/Class.StripeClient.md +30 -31
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/index.md +40 -41
- 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 +12 -13
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
- package/data/packages/platform-reporting/api/index.md +23 -24
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
- package/data/packages/platform-telemetry/api/index.md +20 -21
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +0 -81
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +0 -79
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +0 -79
|
@@ -3,7 +3,6 @@ title: 'Abstract Class: ConfigStrategyBase'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: ConfigStrategyBase
|
|
8
7
|
|
|
9
8
|
Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L8)
|
|
@@ -44,15 +43,15 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:38](https://githu
|
|
|
44
43
|
|
|
45
44
|
#### Parameters
|
|
46
45
|
|
|
47
|
-
| Parameter | Type
|
|
48
|
-
|
|
|
49
|
-
| `key`
|
|
46
|
+
| Parameter | Type |
|
|
47
|
+
| ------ | ------ |
|
|
48
|
+
| `key` | `string` |
|
|
50
49
|
|
|
51
50
|
#### Returns
|
|
52
51
|
|
|
53
52
|
`boolean`
|
|
54
53
|
|
|
55
|
-
|
|
54
|
+
***
|
|
56
55
|
|
|
57
56
|
### initialize()
|
|
58
57
|
|
|
@@ -68,7 +67,7 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:26](https://githu
|
|
|
68
67
|
|
|
69
68
|
`void`
|
|
70
69
|
|
|
71
|
-
|
|
70
|
+
***
|
|
72
71
|
|
|
73
72
|
### resolve()
|
|
74
73
|
|
|
@@ -83,14 +82,14 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:34](https://githu
|
|
|
83
82
|
#### Type Parameters
|
|
84
83
|
|
|
85
84
|
| Type Parameter |
|
|
86
|
-
|
|
|
87
|
-
| `T`
|
|
85
|
+
| ------ |
|
|
86
|
+
| `T` |
|
|
88
87
|
|
|
89
88
|
#### Parameters
|
|
90
89
|
|
|
91
|
-
| Parameter | Type
|
|
92
|
-
|
|
|
93
|
-
| `key`
|
|
90
|
+
| Parameter | Type | Description |
|
|
91
|
+
| ------ | ------ | ------ |
|
|
92
|
+
| `key` | `string` | The key to resolve. |
|
|
94
93
|
|
|
95
94
|
#### Returns
|
|
96
95
|
|
|
@@ -98,7 +97,7 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:34](https://githu
|
|
|
98
97
|
|
|
99
98
|
The resolved configuration value.
|
|
100
99
|
|
|
101
|
-
|
|
100
|
+
***
|
|
102
101
|
|
|
103
102
|
### tryResolve()
|
|
104
103
|
|
|
@@ -111,15 +110,15 @@ Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:36](https://githu
|
|
|
111
110
|
#### Type Parameters
|
|
112
111
|
|
|
113
112
|
| Type Parameter |
|
|
114
|
-
|
|
|
115
|
-
| `T`
|
|
113
|
+
| ------ |
|
|
114
|
+
| `T` |
|
|
116
115
|
|
|
117
116
|
#### Parameters
|
|
118
117
|
|
|
119
|
-
| Parameter
|
|
120
|
-
|
|
|
121
|
-
| `key`
|
|
122
|
-
| `fallback` | `T`
|
|
118
|
+
| Parameter | Type |
|
|
119
|
+
| ------ | ------ |
|
|
120
|
+
| `key` | `string` |
|
|
121
|
+
| `fallback` | `T` |
|
|
123
122
|
|
|
124
123
|
#### Returns
|
|
125
124
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: ContentTemplateEngine'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ContentTemplateEngine
|
|
8
7
|
|
|
9
8
|
Defined in: [templates/ContentTemplateEngine.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L17)
|
|
@@ -40,10 +39,10 @@ Compiles a template by replacing placeholders with the provided parameters.
|
|
|
40
39
|
|
|
41
40
|
#### Parameters
|
|
42
41
|
|
|
43
|
-
| Parameter | Type
|
|
44
|
-
|
|
|
45
|
-
| `content` | `string`
|
|
46
|
-
| `params`
|
|
42
|
+
| Parameter | Type | Description |
|
|
43
|
+
| ------ | ------ | ------ |
|
|
44
|
+
| `content` | `string` | The content of the template to compile. |
|
|
45
|
+
| `params` | `Record`\<`string`, `unknown`\> | The parameters to insert into the template. |
|
|
47
46
|
|
|
48
47
|
#### Returns
|
|
49
48
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: DateTimeUtils'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: DateTimeUtils
|
|
8
7
|
|
|
9
8
|
Defined in: [utils/DateTimeUtils.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L28)
|
|
@@ -37,10 +36,10 @@ Converts a time span value (string or number) to milliseconds or a formatted str
|
|
|
37
36
|
|
|
38
37
|
#### Parameters
|
|
39
38
|
|
|
40
|
-
| Parameter
|
|
41
|
-
|
|
|
42
|
-
| `value`
|
|
43
|
-
| `options?` | `Options`
|
|
39
|
+
| Parameter | Type | Description |
|
|
40
|
+
| ------ | ------ | ------ |
|
|
41
|
+
| `value` | `number` \| [`StringValue`](TypeAlias.StringValue) | The time span value to convert |
|
|
42
|
+
| `options?` | `Options` | Options for formatting the output |
|
|
44
43
|
|
|
45
44
|
#### Returns
|
|
46
45
|
|
|
@@ -48,7 +47,7 @@ Converts a time span value (string or number) to milliseconds or a formatted str
|
|
|
48
47
|
|
|
49
48
|
The parsed time in milliseconds or formatted time string
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
***
|
|
52
51
|
|
|
53
52
|
### format()
|
|
54
53
|
|
|
@@ -62,9 +61,9 @@ Formats a number of milliseconds into a string representation.
|
|
|
62
61
|
|
|
63
62
|
#### Parameters
|
|
64
63
|
|
|
65
|
-
| Parameter
|
|
66
|
-
|
|
|
67
|
-
| `ms`
|
|
64
|
+
| Parameter | Type | Description |
|
|
65
|
+
| ------ | ------ | ------ |
|
|
66
|
+
| `ms` | `number` | The milliseconds to format |
|
|
68
67
|
| `options?` | `Options` | Options for formatting the output |
|
|
69
68
|
|
|
70
69
|
#### Returns
|
|
@@ -73,7 +72,7 @@ Formats a number of milliseconds into a string representation.
|
|
|
73
72
|
|
|
74
73
|
The formatted time span string
|
|
75
74
|
|
|
76
|
-
|
|
75
|
+
***
|
|
77
76
|
|
|
78
77
|
### parse()
|
|
79
78
|
|
|
@@ -87,9 +86,9 @@ Parses a time span string to milliseconds.
|
|
|
87
86
|
|
|
88
87
|
#### Parameters
|
|
89
88
|
|
|
90
|
-
| Parameter | Type
|
|
91
|
-
|
|
|
92
|
-
| `value`
|
|
89
|
+
| Parameter | Type | Description |
|
|
90
|
+
| ------ | ------ | ------ |
|
|
91
|
+
| `value` | [`StringValue`](TypeAlias.StringValue) | The time span string to parse |
|
|
93
92
|
|
|
94
93
|
#### Returns
|
|
95
94
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: DeviceParserService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: DeviceParserService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/DeviceParserService.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L31)
|
|
@@ -42,8 +41,8 @@ Parse User-Agent string and extract device information
|
|
|
42
41
|
|
|
43
42
|
#### Parameters
|
|
44
43
|
|
|
45
|
-
| Parameter
|
|
46
|
-
|
|
|
44
|
+
| Parameter | Type | Description |
|
|
45
|
+
| ------ | ------ | ------ |
|
|
47
46
|
| `userAgent` | `string` | The User-Agent header string |
|
|
48
47
|
|
|
49
48
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Class: EmbeddedResourceStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EmbeddedResourceStrategy
|
|
8
7
|
|
|
9
8
|
Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L14)
|
|
@@ -28,8 +27,8 @@ Constructs a new instance of the `EmbeddedResourceStrategy` class.
|
|
|
28
27
|
|
|
29
28
|
#### Parameters
|
|
30
29
|
|
|
31
|
-
| Parameter
|
|
32
|
-
|
|
|
30
|
+
| Parameter | Type |
|
|
31
|
+
| ------ | ------ |
|
|
33
32
|
| `resources` | `Record`\<`string`, `string`\> |
|
|
34
33
|
|
|
35
34
|
#### Returns
|
|
@@ -74,9 +73,9 @@ Checks if a resource exists without loading it.
|
|
|
74
73
|
|
|
75
74
|
#### Parameters
|
|
76
75
|
|
|
77
|
-
| Parameter | Type
|
|
78
|
-
|
|
|
79
|
-
| `key`
|
|
76
|
+
| Parameter | Type | Description |
|
|
77
|
+
| ------ | ------ | ------ |
|
|
78
|
+
| `key` | `string` | The resource key |
|
|
80
79
|
|
|
81
80
|
#### Returns
|
|
82
81
|
|
|
@@ -88,7 +87,7 @@ True if the resource exists
|
|
|
88
87
|
|
|
89
88
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
|
|
90
89
|
|
|
91
|
-
|
|
90
|
+
***
|
|
92
91
|
|
|
93
92
|
### existsAsync()
|
|
94
93
|
|
|
@@ -102,9 +101,9 @@ Checks if a resource exists without loading it (asynchronous).
|
|
|
102
101
|
|
|
103
102
|
#### Parameters
|
|
104
103
|
|
|
105
|
-
| Parameter | Type
|
|
106
|
-
|
|
|
107
|
-
| `key`
|
|
104
|
+
| Parameter | Type | Description |
|
|
105
|
+
| ------ | ------ | ------ |
|
|
106
|
+
| `key` | `string` | The resource key |
|
|
108
107
|
|
|
109
108
|
#### Returns
|
|
110
109
|
|
|
@@ -116,7 +115,7 @@ Promise resolving to true if the resource exists
|
|
|
116
115
|
|
|
117
116
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
|
|
118
117
|
|
|
119
|
-
|
|
118
|
+
***
|
|
120
119
|
|
|
121
120
|
### load()
|
|
122
121
|
|
|
@@ -130,9 +129,9 @@ Loads a resource by its key.
|
|
|
130
129
|
|
|
131
130
|
#### Parameters
|
|
132
131
|
|
|
133
|
-
| Parameter | Type
|
|
134
|
-
|
|
|
135
|
-
| `key`
|
|
132
|
+
| Parameter | Type | Description |
|
|
133
|
+
| ------ | ------ | ------ |
|
|
134
|
+
| `key` | `string` | The resource key |
|
|
136
135
|
|
|
137
136
|
#### Returns
|
|
138
137
|
|
|
@@ -144,7 +143,7 @@ The resource result or undefined if not found
|
|
|
144
143
|
|
|
145
144
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
|
|
146
145
|
|
|
147
|
-
|
|
146
|
+
***
|
|
148
147
|
|
|
149
148
|
### loadAsync()
|
|
150
149
|
|
|
@@ -158,9 +157,9 @@ Loads a resource by its key (asynchronous).
|
|
|
158
157
|
|
|
159
158
|
#### Parameters
|
|
160
159
|
|
|
161
|
-
| Parameter | Type
|
|
162
|
-
|
|
|
163
|
-
| `key`
|
|
160
|
+
| Parameter | Type | Description |
|
|
161
|
+
| ------ | ------ | ------ |
|
|
162
|
+
| `key` | `string` | The resource key |
|
|
164
163
|
|
|
165
164
|
#### Returns
|
|
166
165
|
|
|
@@ -172,7 +171,7 @@ Promise resolving to the resource result or undefined if not found
|
|
|
172
171
|
|
|
173
172
|
[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
|
|
174
173
|
|
|
175
|
-
|
|
174
|
+
***
|
|
176
175
|
|
|
177
176
|
### register()
|
|
178
177
|
|
|
@@ -186,16 +185,16 @@ Registers a new embedded resource.
|
|
|
186
185
|
|
|
187
186
|
#### Parameters
|
|
188
187
|
|
|
189
|
-
| Parameter | Type
|
|
190
|
-
|
|
|
191
|
-
| `key`
|
|
188
|
+
| Parameter | Type | Description |
|
|
189
|
+
| ------ | ------ | ------ |
|
|
190
|
+
| `key` | `string` | The resource key |
|
|
192
191
|
| `content` | `string` | The resource content |
|
|
193
192
|
|
|
194
193
|
#### Returns
|
|
195
194
|
|
|
196
195
|
`void`
|
|
197
196
|
|
|
198
|
-
|
|
197
|
+
***
|
|
199
198
|
|
|
200
199
|
### whatDoIHave()
|
|
201
200
|
|
|
@@ -3,10 +3,9 @@ title: 'Class: EnvironmentConfigStrategy'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EnvironmentConfigStrategy
|
|
8
7
|
|
|
9
|
-
Defined in: [config/strategies/EnvironmentConfigStrategy.ts:
|
|
8
|
+
Defined in: [config/strategies/EnvironmentConfigStrategy.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L15)
|
|
10
9
|
|
|
11
10
|
The `EnvironmentConfigStrategy` class.
|
|
12
11
|
|
|
@@ -40,13 +39,13 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:24](https://github.c
|
|
|
40
39
|
has(key): boolean;
|
|
41
40
|
```
|
|
42
41
|
|
|
43
|
-
Defined in: [config/strategies/EnvironmentConfigStrategy.ts:
|
|
42
|
+
Defined in: [config/strategies/EnvironmentConfigStrategy.ts:61](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/EnvironmentConfigStrategy.ts#L61)
|
|
44
43
|
|
|
45
44
|
#### Parameters
|
|
46
45
|
|
|
47
|
-
| Parameter | Type
|
|
48
|
-
|
|
|
49
|
-
| `key`
|
|
46
|
+
| Parameter | Type |
|
|
47
|
+
| ------ | ------ |
|
|
48
|
+
| `key` | `string` |
|
|
50
49
|
|
|
51
50
|
#### Returns
|
|
52
51
|
|
|
@@ -56,7 +55,7 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:58](https://github.c
|
|
|
56
55
|
|
|
57
56
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`has`](Class.ConfigStrategyBase#has)
|
|
58
57
|
|
|
59
|
-
|
|
58
|
+
***
|
|
60
59
|
|
|
61
60
|
### initialize()
|
|
62
61
|
|
|
@@ -76,7 +75,7 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:33](https://github.c
|
|
|
76
75
|
|
|
77
76
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`initialize`](Class.ConfigStrategyBase#initialize)
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
***
|
|
80
79
|
|
|
81
80
|
### resolve()
|
|
82
81
|
|
|
@@ -91,14 +90,14 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:37](https://github.c
|
|
|
91
90
|
#### Type Parameters
|
|
92
91
|
|
|
93
92
|
| Type Parameter |
|
|
94
|
-
|
|
|
95
|
-
| `T`
|
|
93
|
+
| ------ |
|
|
94
|
+
| `T` |
|
|
96
95
|
|
|
97
96
|
#### Parameters
|
|
98
97
|
|
|
99
|
-
| Parameter | Type
|
|
100
|
-
|
|
|
101
|
-
| `key`
|
|
98
|
+
| Parameter | Type | Description |
|
|
99
|
+
| ------ | ------ | ------ |
|
|
100
|
+
| `key` | `string` | The key to resolve. |
|
|
102
101
|
|
|
103
102
|
#### Returns
|
|
104
103
|
|
|
@@ -110,7 +109,7 @@ The resolved configuration value.
|
|
|
110
109
|
|
|
111
110
|
[`ConfigStrategyBase`](Class.ConfigStrategyBase).[`resolve`](Class.ConfigStrategyBase#resolve)
|
|
112
111
|
|
|
113
|
-
|
|
112
|
+
***
|
|
114
113
|
|
|
115
114
|
### tryResolve()
|
|
116
115
|
|
|
@@ -123,15 +122,15 @@ Defined in: [config/strategies/EnvironmentConfigStrategy.ts:47](https://github.c
|
|
|
123
122
|
#### Type Parameters
|
|
124
123
|
|
|
125
124
|
| Type Parameter |
|
|
126
|
-
|
|
|
127
|
-
| `T`
|
|
125
|
+
| ------ |
|
|
126
|
+
| `T` |
|
|
128
127
|
|
|
129
128
|
#### Parameters
|
|
130
129
|
|
|
131
|
-
| Parameter
|
|
132
|
-
|
|
|
133
|
-
| `key`
|
|
134
|
-
| `fallback` | `T`
|
|
130
|
+
| Parameter | Type |
|
|
131
|
+
| ------ | ------ |
|
|
132
|
+
| `key` | `string` |
|
|
133
|
+
| `fallback` | `T` |
|
|
135
134
|
|
|
136
135
|
#### Returns
|
|
137
136
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: ErrorTemplateService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ErrorTemplateService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/ErrorTemplateService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L81)
|
|
@@ -16,22 +15,22 @@ Service for rendering error page templates.
|
|
|
16
15
|
|
|
17
16
|
```ts
|
|
18
17
|
new ErrorTemplateService(
|
|
19
|
-
configService,
|
|
20
|
-
contentTemplateEngine,
|
|
18
|
+
configService,
|
|
19
|
+
contentTemplateEngine,
|
|
21
20
|
resourceManager): ErrorTemplateService;
|
|
22
21
|
```
|
|
23
22
|
|
|
24
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
23
|
+
Defined in: [services/ErrorTemplateService.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L97)
|
|
25
24
|
|
|
26
25
|
Constructs a new instance of the `ErrorTemplateService` class.
|
|
27
26
|
|
|
28
27
|
#### Parameters
|
|
29
28
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
32
|
-
| `configService`
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
31
|
+
| `configService` | [`ConfigService`](Class.ConfigService) |
|
|
33
32
|
| `contentTemplateEngine` | [`ContentTemplateEngine`](Class.ContentTemplateEngine) |
|
|
34
|
-
| `resourceManager`
|
|
33
|
+
| `resourceManager` | [`ResourceManager`](Class.ResourceManager) |
|
|
35
34
|
|
|
36
35
|
#### Returns
|
|
37
36
|
|
|
@@ -45,14 +44,14 @@ Constructs a new instance of the `ErrorTemplateService` class.
|
|
|
45
44
|
getErrorMessage(statusCode): string;
|
|
46
45
|
```
|
|
47
46
|
|
|
48
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
47
|
+
Defined in: [services/ErrorTemplateService.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L185)
|
|
49
48
|
|
|
50
49
|
Gets a human-readable error message based on status code.
|
|
51
50
|
|
|
52
51
|
#### Parameters
|
|
53
52
|
|
|
54
|
-
| Parameter
|
|
55
|
-
|
|
|
53
|
+
| Parameter | Type | Description |
|
|
54
|
+
| ------ | ------ | ------ |
|
|
56
55
|
| `statusCode` | `number` | The HTTP status code. |
|
|
57
56
|
|
|
58
57
|
#### Returns
|
|
@@ -61,7 +60,7 @@ Gets a human-readable error message based on status code.
|
|
|
61
60
|
|
|
62
61
|
The error message.
|
|
63
62
|
|
|
64
|
-
|
|
63
|
+
***
|
|
65
64
|
|
|
66
65
|
### getErrorPageContent()
|
|
67
66
|
|
|
@@ -69,15 +68,15 @@ The error message.
|
|
|
69
68
|
getErrorPageContent(params): Promise<string>;
|
|
70
69
|
```
|
|
71
70
|
|
|
72
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
71
|
+
Defined in: [services/ErrorTemplateService.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L118)
|
|
73
72
|
|
|
74
73
|
Retrieves the error page HTML content.
|
|
75
74
|
|
|
76
75
|
#### Parameters
|
|
77
76
|
|
|
78
|
-
| Parameter | Type
|
|
79
|
-
|
|
|
80
|
-
| `params`
|
|
77
|
+
| Parameter | Type | Description |
|
|
78
|
+
| ------ | ------ | ------ |
|
|
79
|
+
| `params` | [`IErrorPageParams`](Interface.IErrorPageParams) | The error page parameters. |
|
|
81
80
|
|
|
82
81
|
#### Returns
|
|
83
82
|
|
|
@@ -85,7 +84,7 @@ Retrieves the error page HTML content.
|
|
|
85
84
|
|
|
86
85
|
The rendered HTML content.
|
|
87
86
|
|
|
88
|
-
|
|
87
|
+
***
|
|
89
88
|
|
|
90
89
|
### getErrorTitle()
|
|
91
90
|
|
|
@@ -93,14 +92,14 @@ The rendered HTML content.
|
|
|
93
92
|
getErrorTitle(statusCode): string;
|
|
94
93
|
```
|
|
95
94
|
|
|
96
|
-
Defined in: [services/ErrorTemplateService.ts:
|
|
95
|
+
Defined in: [services/ErrorTemplateService.ts:156](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/ErrorTemplateService.ts#L156)
|
|
97
96
|
|
|
98
97
|
Gets a human-readable error title based on status code.
|
|
99
98
|
|
|
100
99
|
#### Parameters
|
|
101
100
|
|
|
102
|
-
| Parameter
|
|
103
|
-
|
|
|
101
|
+
| Parameter | Type | Description |
|
|
102
|
+
| ------ | ------ | ------ |
|
|
104
103
|
| `statusCode` | `number` | The HTTP status code. |
|
|
105
104
|
|
|
106
105
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Class: EventHub'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EventHub
|
|
8
7
|
|
|
9
8
|
Defined in: [events/EventHub.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventHub.ts#L38)
|
|
@@ -62,15 +61,15 @@ Returns an observable that emits payloads for the specified event.
|
|
|
62
61
|
|
|
63
62
|
#### Type Parameters
|
|
64
63
|
|
|
65
|
-
| Type Parameter
|
|
66
|
-
|
|
|
67
|
-
| `TEvents`
|
|
68
|
-
| `TKey`
|
|
64
|
+
| Type Parameter |
|
|
65
|
+
| ------ |
|
|
66
|
+
| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
|
|
67
|
+
| `TKey` *extends* `string` \| `number` \| `symbol` |
|
|
69
68
|
|
|
70
69
|
#### Parameters
|
|
71
70
|
|
|
72
|
-
| Parameter
|
|
73
|
-
|
|
|
71
|
+
| Parameter | Type | Description |
|
|
72
|
+
| ------ | ------ | ------ |
|
|
74
73
|
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to observe |
|
|
75
74
|
|
|
76
75
|
#### Returns
|
|
@@ -79,7 +78,7 @@ Returns an observable that emits payloads for the specified event.
|
|
|
79
78
|
|
|
80
79
|
An observable sequence that emits payloads of the specified event
|
|
81
80
|
|
|
82
|
-
|
|
81
|
+
***
|
|
83
82
|
|
|
84
83
|
### onModuleDestroy()
|
|
85
84
|
|
|
@@ -98,10 +97,10 @@ Completes the event stream when the module is destroyed.
|
|
|
98
97
|
#### Implementation of
|
|
99
98
|
|
|
100
99
|
```ts
|
|
101
|
-
OnModuleDestroy.onModuleDestroy
|
|
100
|
+
OnModuleDestroy.onModuleDestroy
|
|
102
101
|
```
|
|
103
102
|
|
|
104
|
-
|
|
103
|
+
***
|
|
105
104
|
|
|
106
105
|
### publish()
|
|
107
106
|
|
|
@@ -115,23 +114,23 @@ Publishes an event with the specified payload to all subscribers.
|
|
|
115
114
|
|
|
116
115
|
#### Type Parameters
|
|
117
116
|
|
|
118
|
-
| Type Parameter
|
|
119
|
-
|
|
|
120
|
-
| `TEvents`
|
|
121
|
-
| `TKey`
|
|
117
|
+
| Type Parameter |
|
|
118
|
+
| ------ |
|
|
119
|
+
| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
|
|
120
|
+
| `TKey` *extends* `string` \| `number` \| `symbol` |
|
|
122
121
|
|
|
123
122
|
#### Parameters
|
|
124
123
|
|
|
125
|
-
| Parameter
|
|
126
|
-
|
|
|
124
|
+
| Parameter | Type | Description |
|
|
125
|
+
| ------ | ------ | ------ |
|
|
127
126
|
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key identifying the target event |
|
|
128
|
-
| `payload`
|
|
127
|
+
| `payload` | `TEvents`\[`TKey`\] | The payload associated with the event |
|
|
129
128
|
|
|
130
129
|
#### Returns
|
|
131
130
|
|
|
132
131
|
`void`
|
|
133
132
|
|
|
134
|
-
|
|
133
|
+
***
|
|
135
134
|
|
|
136
135
|
### subscribe()
|
|
137
136
|
|
|
@@ -145,17 +144,17 @@ Subscribes to the specified event and invokes the handler whenever the event is
|
|
|
145
144
|
|
|
146
145
|
#### Type Parameters
|
|
147
146
|
|
|
148
|
-
| Type Parameter
|
|
149
|
-
|
|
|
150
|
-
| `TEvents`
|
|
151
|
-
| `TKey`
|
|
147
|
+
| Type Parameter |
|
|
148
|
+
| ------ |
|
|
149
|
+
| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
|
|
150
|
+
| `TKey` *extends* `string` \| `number` \| `symbol` |
|
|
152
151
|
|
|
153
152
|
#### Parameters
|
|
154
153
|
|
|
155
|
-
| Parameter
|
|
156
|
-
|
|
|
157
|
-
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to subscribe to
|
|
158
|
-
| `handler`
|
|
154
|
+
| Parameter | Type | Description |
|
|
155
|
+
| ------ | ------ | ------ |
|
|
156
|
+
| `eventKey` | [`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\> | The event key to subscribe to |
|
|
157
|
+
| `handler` | (`payload`) => `void` | The handler that is invoked when the event is emitted |
|
|
159
158
|
|
|
160
159
|
#### Returns
|
|
161
160
|
|