@breadstone/archipel-mcp 0.0.9 → 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 +21 -22
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +21 -22
- 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 +19 -20
- 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 +26 -27
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +14 -15
- 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 +54 -55
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +17 -18
- 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 +27 -28
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -30
- 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 +20 -21
- 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 +10 -11
- 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 +2 -3
- 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 +2 -3
- 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 +2 -3
- 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 +1 -2
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -95
- 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 +2 -3
- 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 +2 -3
- 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 +2 -3
- 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 +3 -4
- 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 +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +2 -3
- 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 +1 -2
- 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 +37 -38
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +39 -40
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +4 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +4 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +15 -16
- 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 +18 -19
- 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 +88 -89
- 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 +19 -20
- 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 +17 -18
- 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 +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 +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 +1 -2
- 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 +1 -2
- 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 +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -2
- 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 +1 -2
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -116
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +7 -8
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -4
- package/data/packages/platform-cryptography/api/Class.OtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +7 -8
- 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 +4 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -1
- 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 +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +4 -5
- 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 +27 -28
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -15
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +13 -14
- 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 +4 -5
- 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 +24 -25
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -25
- 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 +28 -29
- 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
|
@@ -3,46 +3,45 @@ title: '@breadstone/archipel-platform-documents'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# @breadstone/archipel-platform-documents
|
|
8
7
|
|
|
9
8
|
## Classes
|
|
10
9
|
|
|
11
|
-
| Class
|
|
12
|
-
|
|
|
13
|
-
| [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing.
|
|
14
|
-
| [DocumentEngine](Class.DocumentEngine)
|
|
15
|
-
| [DocumentModule](Class.DocumentModule)
|
|
16
|
-
| [SharpImageProcessor](Class.SharpImageProcessor)
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing. |
|
|
13
|
+
| [DocumentEngine](Class.DocumentEngine) | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components. |
|
|
14
|
+
| [DocumentModule](Class.DocumentModule) | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
|
|
15
|
+
| [SharpImageProcessor](Class.SharpImageProcessor) | Sharp-based image processor. Handles image resizing and format conversion. |
|
|
17
16
|
|
|
18
17
|
## Interfaces
|
|
19
18
|
|
|
20
|
-
| Interface
|
|
21
|
-
|
|
|
22
|
-
| [IDocumentModuleOptions](Interface.IDocumentModuleOptions)
|
|
23
|
-
| [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report.
|
|
24
|
-
| [IDocumentProbeReport](Interface.IDocumentProbeReport)
|
|
25
|
-
| [IDocumentRenderer](Interface.IDocumentRenderer)
|
|
26
|
-
| [IImagePayload](Interface.IImagePayload)
|
|
27
|
-
| [IImageProcessor](Interface.IImageProcessor)
|
|
28
|
-
| [IRenderOptions](Interface.IRenderOptions)
|
|
29
|
-
| [IRenderResult](Interface.IRenderResult)
|
|
19
|
+
| Interface | Description |
|
|
20
|
+
| ------ | ------ |
|
|
21
|
+
| [IDocumentModuleOptions](Interface.IDocumentModuleOptions) | Configuration options for the DocumentModule. |
|
|
22
|
+
| [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report. |
|
|
23
|
+
| [IDocumentProbeReport](Interface.IDocumentProbeReport) | Document probe report. |
|
|
24
|
+
| [IDocumentRenderer](Interface.IDocumentRenderer) | Base interface for document renderers. Each renderer handles specific document formats. |
|
|
25
|
+
| [IImagePayload](Interface.IImagePayload) | Image payload for templates. |
|
|
26
|
+
| [IImageProcessor](Interface.IImageProcessor) | Base interface for image processors. Handles image manipulation and format conversion. |
|
|
27
|
+
| [IRenderOptions](Interface.IRenderOptions) | Options for rendering a document. |
|
|
28
|
+
| [IRenderResult](Interface.IRenderResult) | Document render result. |
|
|
30
29
|
|
|
31
30
|
## Type Aliases
|
|
32
31
|
|
|
33
|
-
| Type Alias
|
|
34
|
-
|
|
|
35
|
-
| [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types.
|
|
36
|
-
| [EngineType](TypeAlias.EngineType)
|
|
37
|
-
| [ImageMimeType](TypeAlias.ImageMimeType)
|
|
32
|
+
| Type Alias | Description |
|
|
33
|
+
| ------ | ------ |
|
|
34
|
+
| [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types. |
|
|
35
|
+
| [EngineType](TypeAlias.EngineType) | Template engine type. |
|
|
36
|
+
| [ImageMimeType](TypeAlias.ImageMimeType) | Image MIME type. |
|
|
38
37
|
| [TemplateFormat](TypeAlias.TemplateFormat) | Template format type (parser syntax). |
|
|
39
|
-
| [TemplateType](TypeAlias.TemplateType)
|
|
38
|
+
| [TemplateType](TypeAlias.TemplateType) | Template type. |
|
|
40
39
|
|
|
41
40
|
## Variables
|
|
42
41
|
|
|
43
|
-
| Variable
|
|
44
|
-
|
|
|
45
|
-
| [
|
|
46
|
-
| [
|
|
47
|
-
| [
|
|
48
|
-
| [
|
|
42
|
+
| Variable | Description |
|
|
43
|
+
| ------ | ------ |
|
|
44
|
+
| [DOCUMENT\_MODULE\_OPTIONS](Variable.DOCUMENT_MODULE_OPTIONS) | Injection token for DocumentModule options. |
|
|
45
|
+
| [DOCUMENT\_PARSER\_TOKEN](Variable.DOCUMENT_PARSER_TOKEN) | Injection token for IDocumentParser. |
|
|
46
|
+
| [DOCUMENT\_RENDERER\_TOKEN](Variable.DOCUMENT_RENDERER_TOKEN) | Injection token for IDocumentRenderer (multi-provider). |
|
|
47
|
+
| [IMAGE\_PROCESSOR\_TOKEN](Variable.IMAGE_PROCESSOR_TOKEN) | Injection token for IImageProcessor. |
|
|
@@ -3,7 +3,6 @@ title: 'Abstract Class: EsigningClientPort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: EsigningClientPort
|
|
8
7
|
|
|
9
8
|
Defined in: [contracts/EsigningClientPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L19)
|
|
@@ -54,16 +53,16 @@ Cancel an in-progress signing request.
|
|
|
54
53
|
|
|
55
54
|
#### Parameters
|
|
56
55
|
|
|
57
|
-
| Parameter
|
|
58
|
-
|
|
|
56
|
+
| Parameter | Type | Description |
|
|
57
|
+
| ------ | ------ | ------ |
|
|
59
58
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
60
|
-
| `reason?`
|
|
59
|
+
| `reason?` | `string` | Optional reason for cancellation. |
|
|
61
60
|
|
|
62
61
|
#### Returns
|
|
63
62
|
|
|
64
63
|
`Promise`\<`void`\>
|
|
65
64
|
|
|
66
|
-
|
|
65
|
+
***
|
|
67
66
|
|
|
68
67
|
### createSigningRequest()
|
|
69
68
|
|
|
@@ -77,8 +76,8 @@ Create a new signing request (envelope/agreement).
|
|
|
77
76
|
|
|
78
77
|
#### Parameters
|
|
79
78
|
|
|
80
|
-
| Parameter | Type
|
|
81
|
-
|
|
|
79
|
+
| Parameter | Type | Description |
|
|
80
|
+
| ------ | ------ | ------ |
|
|
82
81
|
| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
|
|
83
82
|
|
|
84
83
|
#### Returns
|
|
@@ -87,7 +86,7 @@ Create a new signing request (envelope/agreement).
|
|
|
87
86
|
|
|
88
87
|
The created signing request with provider-assigned identifiers.
|
|
89
88
|
|
|
90
|
-
|
|
89
|
+
***
|
|
91
90
|
|
|
92
91
|
### createSigningSession()
|
|
93
92
|
|
|
@@ -101,8 +100,8 @@ Generate a signing session (signing link/URL) for a specific signer.
|
|
|
101
100
|
|
|
102
101
|
#### Parameters
|
|
103
102
|
|
|
104
|
-
| Parameter | Type
|
|
105
|
-
|
|
|
103
|
+
| Parameter | Type | Description |
|
|
104
|
+
| ------ | ------ | ------ |
|
|
106
105
|
| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
|
|
107
106
|
|
|
108
107
|
#### Returns
|
|
@@ -111,7 +110,7 @@ Generate a signing session (signing link/URL) for a specific signer.
|
|
|
111
110
|
|
|
112
111
|
The signing session with the signing URL.
|
|
113
112
|
|
|
114
|
-
|
|
113
|
+
***
|
|
115
114
|
|
|
116
115
|
### getSignedDocuments()
|
|
117
116
|
|
|
@@ -125,8 +124,8 @@ Retrieve the final signed documents for a completed signing request.
|
|
|
125
124
|
|
|
126
125
|
#### Parameters
|
|
127
126
|
|
|
128
|
-
| Parameter
|
|
129
|
-
|
|
|
127
|
+
| Parameter | Type | Description |
|
|
128
|
+
| ------ | ------ | ------ |
|
|
130
129
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
131
130
|
|
|
132
131
|
#### Returns
|
|
@@ -135,7 +134,7 @@ Retrieve the final signed documents for a completed signing request.
|
|
|
135
134
|
|
|
136
135
|
Array of signed documents with their content.
|
|
137
136
|
|
|
138
|
-
|
|
137
|
+
***
|
|
139
138
|
|
|
140
139
|
### getSigningRequest()
|
|
141
140
|
|
|
@@ -149,8 +148,8 @@ Retrieve the current status and details of a signing request.
|
|
|
149
148
|
|
|
150
149
|
#### Parameters
|
|
151
150
|
|
|
152
|
-
| Parameter
|
|
153
|
-
|
|
|
151
|
+
| Parameter | Type | Description |
|
|
152
|
+
| ------ | ------ | ------ |
|
|
154
153
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
155
154
|
|
|
156
155
|
#### Returns
|
|
@@ -159,7 +158,7 @@ Retrieve the current status and details of a signing request.
|
|
|
159
158
|
|
|
160
159
|
The signing request with current status.
|
|
161
160
|
|
|
162
|
-
|
|
161
|
+
***
|
|
163
162
|
|
|
164
163
|
### verifyWebhook()
|
|
165
164
|
|
|
@@ -173,10 +172,10 @@ Verify a webhook payload signature and return a normalized event.
|
|
|
173
172
|
|
|
174
173
|
#### Parameters
|
|
175
174
|
|
|
176
|
-
| Parameter
|
|
177
|
-
|
|
|
178
|
-
| `payload`
|
|
179
|
-
| `signature` | `string`
|
|
175
|
+
| Parameter | Type | Description |
|
|
176
|
+
| ------ | ------ | ------ |
|
|
177
|
+
| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
|
|
178
|
+
| `signature` | `string` | Webhook signature header value. |
|
|
180
179
|
|
|
181
180
|
#### Returns
|
|
182
181
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: EsigningError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EsigningError
|
|
8
7
|
|
|
9
8
|
Defined in: [errors/EsigningError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L6)
|
|
@@ -32,10 +31,10 @@ Defined in: [errors/EsigningError.ts:15](https://github.com/RueDeRennes/archipel
|
|
|
32
31
|
|
|
33
32
|
#### Parameters
|
|
34
33
|
|
|
35
|
-
| Parameter | Type
|
|
36
|
-
|
|
|
34
|
+
| Parameter | Type |
|
|
35
|
+
| ------ | ------ |
|
|
37
36
|
| `message` | `string` |
|
|
38
|
-
| `code`
|
|
37
|
+
| `code` | `string` |
|
|
39
38
|
|
|
40
39
|
#### Returns
|
|
41
40
|
|
|
@@ -44,7 +43,7 @@ Defined in: [errors/EsigningError.ts:15](https://github.com/RueDeRennes/archipel
|
|
|
44
43
|
#### Overrides
|
|
45
44
|
|
|
46
45
|
```ts
|
|
47
|
-
Error.constructor
|
|
46
|
+
Error.constructor
|
|
48
47
|
```
|
|
49
48
|
|
|
50
49
|
## Accessors
|
|
@@ -3,7 +3,6 @@ title: 'Class: EsigningModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EsigningModule
|
|
8
7
|
|
|
9
8
|
Defined in: [EsigningModule.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L52)
|
|
@@ -38,8 +37,8 @@ Configures the module with the specified options.
|
|
|
38
37
|
|
|
39
38
|
#### Parameters
|
|
40
39
|
|
|
41
|
-
| Parameter | Type
|
|
42
|
-
|
|
|
40
|
+
| Parameter | Type | Description |
|
|
41
|
+
| ------ | ------ | ------ |
|
|
43
42
|
| `options` | [`IEsigningModuleOptions`](Interface.IEsigningModuleOptions) | The module configuration options. |
|
|
44
43
|
|
|
45
44
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Abstract Class: EsigningPersistencePort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: EsigningPersistencePort
|
|
8
7
|
|
|
9
8
|
Defined in: [contracts/EsigningPersistencePort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L13)
|
|
@@ -37,15 +36,15 @@ Update persisted state when a signing request is cancelled.
|
|
|
37
36
|
|
|
38
37
|
#### Parameters
|
|
39
38
|
|
|
40
|
-
| Parameter
|
|
41
|
-
|
|
|
39
|
+
| Parameter | Type | Description |
|
|
40
|
+
| ------ | ------ | ------ |
|
|
42
41
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
43
42
|
|
|
44
43
|
#### Returns
|
|
45
44
|
|
|
46
45
|
`Promise`\<`void`\>
|
|
47
46
|
|
|
48
|
-
|
|
47
|
+
***
|
|
49
48
|
|
|
50
49
|
### onSigningRequestCreated()
|
|
51
50
|
|
|
@@ -59,15 +58,15 @@ Persist a newly created signing request.
|
|
|
59
58
|
|
|
60
59
|
#### Parameters
|
|
61
60
|
|
|
62
|
-
| Parameter
|
|
63
|
-
|
|
|
61
|
+
| Parameter | Type | Description |
|
|
62
|
+
| ------ | ------ | ------ |
|
|
64
63
|
| `signingRequest` | [`ISigningRequest`](Interface.ISigningRequest) | The signing request to persist. |
|
|
65
64
|
|
|
66
65
|
#### Returns
|
|
67
66
|
|
|
68
67
|
`Promise`\<`void`\>
|
|
69
68
|
|
|
70
|
-
|
|
69
|
+
***
|
|
71
70
|
|
|
72
71
|
### onSigningRequestStatusChanged()
|
|
73
72
|
|
|
@@ -81,10 +80,10 @@ Update persisted state when a signing request status changes.
|
|
|
81
80
|
|
|
82
81
|
#### Parameters
|
|
83
82
|
|
|
84
|
-
| Parameter
|
|
85
|
-
|
|
|
83
|
+
| Parameter | Type | Description |
|
|
84
|
+
| ------ | ------ | ------ |
|
|
86
85
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
87
|
-
| `status`
|
|
86
|
+
| `status` | `string` | The new status of the signing request. |
|
|
88
87
|
|
|
89
88
|
#### Returns
|
|
90
89
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: EsigningService'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: EsigningService
|
|
8
7
|
|
|
9
8
|
Defined in: [services/EsigningService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L23)
|
|
@@ -26,9 +25,9 @@ Initializes a new instance of the EsigningService class.
|
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
31
|
-
| `client`
|
|
28
|
+
| Parameter | Type | Description |
|
|
29
|
+
| ------ | ------ | ------ |
|
|
30
|
+
| `client` | [`EsigningClientPort`](Class.EsigningClientPort) | The concrete e-signing provider implementation. |
|
|
32
31
|
| `persistence` | [`EsigningPersistencePort`](Class.EsigningPersistencePort) \| `null` | Optional port for persisting signing request state. |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -67,16 +66,16 @@ Cancel an in-progress signing request.
|
|
|
67
66
|
|
|
68
67
|
#### Parameters
|
|
69
68
|
|
|
70
|
-
| Parameter
|
|
71
|
-
|
|
|
72
|
-
| `signingRequestId` | `string` | The signing request identifier.
|
|
73
|
-
| `reason?`
|
|
69
|
+
| Parameter | Type | Description |
|
|
70
|
+
| ------ | ------ | ------ |
|
|
71
|
+
| `signingRequestId` | `string` | The signing request identifier. |
|
|
72
|
+
| `reason?` | `string` | Optional reason for cancellation. |
|
|
74
73
|
|
|
75
74
|
#### Returns
|
|
76
75
|
|
|
77
76
|
`Promise`\<`void`\>
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
***
|
|
80
79
|
|
|
81
80
|
### createSigningRequest()
|
|
82
81
|
|
|
@@ -90,8 +89,8 @@ Create a new signing request.
|
|
|
90
89
|
|
|
91
90
|
#### Parameters
|
|
92
91
|
|
|
93
|
-
| Parameter | Type
|
|
94
|
-
|
|
|
92
|
+
| Parameter | Type | Description |
|
|
93
|
+
| ------ | ------ | ------ |
|
|
95
94
|
| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
|
|
96
95
|
|
|
97
96
|
#### Returns
|
|
@@ -100,7 +99,7 @@ Create a new signing request.
|
|
|
100
99
|
|
|
101
100
|
The created signing request.
|
|
102
101
|
|
|
103
|
-
|
|
102
|
+
***
|
|
104
103
|
|
|
105
104
|
### createSigningSession()
|
|
106
105
|
|
|
@@ -114,8 +113,8 @@ Generate a signing session (signing link) for a specific signer.
|
|
|
114
113
|
|
|
115
114
|
#### Parameters
|
|
116
115
|
|
|
117
|
-
| Parameter | Type
|
|
118
|
-
|
|
|
116
|
+
| Parameter | Type | Description |
|
|
117
|
+
| ------ | ------ | ------ |
|
|
119
118
|
| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
|
|
120
119
|
|
|
121
120
|
#### Returns
|
|
@@ -124,7 +123,7 @@ Generate a signing session (signing link) for a specific signer.
|
|
|
124
123
|
|
|
125
124
|
The signing session.
|
|
126
125
|
|
|
127
|
-
|
|
126
|
+
***
|
|
128
127
|
|
|
129
128
|
### getSignedDocuments()
|
|
130
129
|
|
|
@@ -138,8 +137,8 @@ Retrieve the final signed documents for a completed signing request.
|
|
|
138
137
|
|
|
139
138
|
#### Parameters
|
|
140
139
|
|
|
141
|
-
| Parameter
|
|
142
|
-
|
|
|
140
|
+
| Parameter | Type | Description |
|
|
141
|
+
| ------ | ------ | ------ |
|
|
143
142
|
| `signingRequestId` | `string` | The signing request identifier. |
|
|
144
143
|
|
|
145
144
|
#### Returns
|
|
@@ -148,7 +147,7 @@ Retrieve the final signed documents for a completed signing request.
|
|
|
148
147
|
|
|
149
148
|
Array of signed documents.
|
|
150
149
|
|
|
151
|
-
|
|
150
|
+
***
|
|
152
151
|
|
|
153
152
|
### getSigningRequest()
|
|
154
153
|
|
|
@@ -162,8 +161,8 @@ Retrieve the current status and details of a signing request.
|
|
|
162
161
|
|
|
163
162
|
#### Parameters
|
|
164
163
|
|
|
165
|
-
| Parameter
|
|
166
|
-
|
|
|
164
|
+
| Parameter | Type | Description |
|
|
165
|
+
| ------ | ------ | ------ |
|
|
167
166
|
| `signingRequestId` | `string` | The signing request identifier. |
|
|
168
167
|
|
|
169
168
|
#### Returns
|
|
@@ -172,7 +171,7 @@ Retrieve the current status and details of a signing request.
|
|
|
172
171
|
|
|
173
172
|
The signing request with current status.
|
|
174
173
|
|
|
175
|
-
|
|
174
|
+
***
|
|
176
175
|
|
|
177
176
|
### verifyWebhook()
|
|
178
177
|
|
|
@@ -187,10 +186,10 @@ Optionally updates persistence if a state change is detected.
|
|
|
187
186
|
|
|
188
187
|
#### Parameters
|
|
189
188
|
|
|
190
|
-
| Parameter
|
|
191
|
-
|
|
|
192
|
-
| `payload`
|
|
193
|
-
| `signature` | `string`
|
|
189
|
+
| Parameter | Type | Description |
|
|
190
|
+
| ------ | ------ | ------ |
|
|
191
|
+
| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
|
|
192
|
+
| `signature` | `string` | Webhook signature header value. |
|
|
194
193
|
|
|
195
194
|
#### Returns
|
|
196
195
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: InternalEsigningProvider'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: InternalEsigningProvider
|
|
8
7
|
|
|
9
8
|
Defined in: [providers/internal/InternalEsigningProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L42)
|
|
@@ -70,10 +69,10 @@ Cancel an in-progress signing request.
|
|
|
70
69
|
|
|
71
70
|
#### Parameters
|
|
72
71
|
|
|
73
|
-
| Parameter
|
|
74
|
-
|
|
|
72
|
+
| Parameter | Type | Description |
|
|
73
|
+
| ------ | ------ | ------ |
|
|
75
74
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
76
|
-
| `_reason?`
|
|
75
|
+
| `_reason?` | `string` | - |
|
|
77
76
|
|
|
78
77
|
#### Returns
|
|
79
78
|
|
|
@@ -83,7 +82,7 @@ Cancel an in-progress signing request.
|
|
|
83
82
|
|
|
84
83
|
[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
|
|
85
84
|
|
|
86
|
-
|
|
85
|
+
***
|
|
87
86
|
|
|
88
87
|
### completeSigner()
|
|
89
88
|
|
|
@@ -99,16 +98,16 @@ application to programmatically complete a signer's step.
|
|
|
99
98
|
|
|
100
99
|
#### Parameters
|
|
101
100
|
|
|
102
|
-
| Parameter
|
|
103
|
-
|
|
|
101
|
+
| Parameter | Type | Description |
|
|
102
|
+
| ------ | ------ | ------ |
|
|
104
103
|
| `signingRequestId` | `string` | The signing request identifier. |
|
|
105
|
-
| `signerId`
|
|
104
|
+
| `signerId` | `string` | The signer identifier. |
|
|
106
105
|
|
|
107
106
|
#### Returns
|
|
108
107
|
|
|
109
108
|
`Promise`\<`void`\>
|
|
110
109
|
|
|
111
|
-
|
|
110
|
+
***
|
|
112
111
|
|
|
113
112
|
### createSigningRequest()
|
|
114
113
|
|
|
@@ -122,8 +121,8 @@ Create a new signing request (envelope/agreement).
|
|
|
122
121
|
|
|
123
122
|
#### Parameters
|
|
124
123
|
|
|
125
|
-
| Parameter | Type
|
|
126
|
-
|
|
|
124
|
+
| Parameter | Type | Description |
|
|
125
|
+
| ------ | ------ | ------ |
|
|
127
126
|
| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
|
|
128
127
|
|
|
129
128
|
#### Returns
|
|
@@ -136,7 +135,7 @@ The created signing request with provider-assigned identifiers.
|
|
|
136
135
|
|
|
137
136
|
[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
|
|
138
137
|
|
|
139
|
-
|
|
138
|
+
***
|
|
140
139
|
|
|
141
140
|
### createSigningSession()
|
|
142
141
|
|
|
@@ -150,8 +149,8 @@ Generate a signing session (signing link/URL) for a specific signer.
|
|
|
150
149
|
|
|
151
150
|
#### Parameters
|
|
152
151
|
|
|
153
|
-
| Parameter | Type
|
|
154
|
-
|
|
|
152
|
+
| Parameter | Type | Description |
|
|
153
|
+
| ------ | ------ | ------ |
|
|
155
154
|
| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
|
|
156
155
|
|
|
157
156
|
#### Returns
|
|
@@ -164,7 +163,7 @@ The signing session with the signing URL.
|
|
|
164
163
|
|
|
165
164
|
[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
|
|
166
165
|
|
|
167
|
-
|
|
166
|
+
***
|
|
168
167
|
|
|
169
168
|
### getSignedDocuments()
|
|
170
169
|
|
|
@@ -178,8 +177,8 @@ Retrieve the final signed documents for a completed signing request.
|
|
|
178
177
|
|
|
179
178
|
#### Parameters
|
|
180
179
|
|
|
181
|
-
| Parameter
|
|
182
|
-
|
|
|
180
|
+
| Parameter | Type | Description |
|
|
181
|
+
| ------ | ------ | ------ |
|
|
183
182
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
184
183
|
|
|
185
184
|
#### Returns
|
|
@@ -192,7 +191,7 @@ Array of signed documents with their content.
|
|
|
192
191
|
|
|
193
192
|
[`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
|
|
194
193
|
|
|
195
|
-
|
|
194
|
+
***
|
|
196
195
|
|
|
197
196
|
### getSigningRequest()
|
|
198
197
|
|
|
@@ -206,8 +205,8 @@ Retrieve the current status and details of a signing request.
|
|
|
206
205
|
|
|
207
206
|
#### Parameters
|
|
208
207
|
|
|
209
|
-
| Parameter
|
|
210
|
-
|
|
|
208
|
+
| Parameter | Type | Description |
|
|
209
|
+
| ------ | ------ | ------ |
|
|
211
210
|
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
212
211
|
|
|
213
212
|
#### Returns
|
|
@@ -220,7 +219,7 @@ The signing request with current status.
|
|
|
220
219
|
|
|
221
220
|
[`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
|
|
222
221
|
|
|
223
|
-
|
|
222
|
+
***
|
|
224
223
|
|
|
225
224
|
### verifyWebhook()
|
|
226
225
|
|
|
@@ -234,10 +233,10 @@ Verify a webhook payload signature and return a normalized event.
|
|
|
234
233
|
|
|
235
234
|
#### Parameters
|
|
236
235
|
|
|
237
|
-
| Parameter
|
|
238
|
-
|
|
|
239
|
-
| `_payload`
|
|
240
|
-
| `_signature` | `string`
|
|
236
|
+
| Parameter | Type |
|
|
237
|
+
| ------ | ------ |
|
|
238
|
+
| `_payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> |
|
|
239
|
+
| `_signature` | `string` |
|
|
241
240
|
|
|
242
241
|
#### Returns
|
|
243
242
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: SigningProviderError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: SigningProviderError
|
|
8
7
|
|
|
9
8
|
Defined in: [errors/SigningProviderError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningProviderError.ts#L12)
|
|
@@ -20,8 +19,8 @@ Thrown when a provider-level operation fails.
|
|
|
20
19
|
|
|
21
20
|
```ts
|
|
22
21
|
new SigningProviderError(
|
|
23
|
-
providerId,
|
|
24
|
-
message,
|
|
22
|
+
providerId,
|
|
23
|
+
message,
|
|
25
24
|
cause?): SigningProviderError;
|
|
26
25
|
```
|
|
27
26
|
|
|
@@ -29,11 +28,11 @@ Defined in: [errors/SigningProviderError.ts:22](https://github.com/RueDeRennes/a
|
|
|
29
28
|
|
|
30
29
|
#### Parameters
|
|
31
30
|
|
|
32
|
-
| Parameter
|
|
33
|
-
|
|
|
34
|
-
| `providerId` | `string`
|
|
35
|
-
| `message`
|
|
36
|
-
| `cause?`
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------ | ------ |
|
|
33
|
+
| `providerId` | `string` |
|
|
34
|
+
| `message` | `string` |
|
|
35
|
+
| `cause?` | `unknown` |
|
|
37
36
|
|
|
38
37
|
#### Returns
|
|
39
38
|
|
|
@@ -65,7 +64,7 @@ Machine-readable error code.
|
|
|
65
64
|
|
|
66
65
|
[`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
***
|
|
69
68
|
|
|
70
69
|
### providerId
|
|
71
70
|
|
|
@@ -83,7 +82,7 @@ Identifier of the provider that failed.
|
|
|
83
82
|
|
|
84
83
|
`string`
|
|
85
84
|
|
|
86
|
-
|
|
85
|
+
***
|
|
87
86
|
|
|
88
87
|
### rootCause
|
|
89
88
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: SigningRequestNotFoundError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: SigningRequestNotFoundError
|
|
8
7
|
|
|
9
8
|
Defined in: [errors/SigningRequestNotFoundError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/SigningRequestNotFoundError.ts#L12)
|
|
@@ -26,8 +25,8 @@ Defined in: [errors/SigningRequestNotFoundError.ts:21](https://github.com/RueDeR
|
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
31
30
|
| `signingRequestId` | `string` |
|
|
32
31
|
|
|
33
32
|
#### Returns
|
|
@@ -60,7 +59,7 @@ Machine-readable error code.
|
|
|
60
59
|
|
|
61
60
|
[`EsigningError`](Class.EsigningError).[`code`](Class.EsigningError#code)
|
|
62
61
|
|
|
63
|
-
|
|
62
|
+
***
|
|
64
63
|
|
|
65
64
|
### signingRequestId
|
|
66
65
|
|