@breadstone/archipel-mcp 0.0.9 → 0.0.11
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/guides/ai-text-generation.md +361 -0
- package/data/guides/analytics-and-error-tracking.md +189 -0
- package/data/guides/authentication-and-authorization.md +657 -0
- package/data/guides/blob-storage.md +242 -0
- package/data/guides/caching.md +255 -0
- package/data/guides/cryptography-and-otp.md +240 -0
- package/data/guides/document-generation.md +174 -0
- package/data/guides/email-delivery.md +196 -0
- package/data/guides/esigning-integration.md +231 -0
- package/data/guides/getting-started.md +351 -0
- package/data/guides/implementing-ports.md +317 -0
- package/data/guides/index.md +61 -0
- package/data/guides/mcp-server.md +222 -0
- package/data/guides/openapi-and-feature-discovery.md +266 -0
- package/data/guides/payments-and-feature-gating.md +244 -0
- package/data/guides/resource-management.md +352 -0
- package/data/guides/telemetry-and-observability.md +190 -0
- package/data/guides/testing.md +319 -0
- package/data/guides/tsdoc-guidelines.md +45 -0
- 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 +15 -12
- 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
- package/src/GuidesLoader.d.ts +13 -0
- package/src/GuidesLoader.js +81 -0
- package/src/main.js +36 -198
- package/src/models/IGuideDoc.d.ts +15 -0
- package/src/models/IGuideDoc.js +3 -0
- package/src/tools/registerGetConfigPatternTool.d.ts +5 -0
- package/src/tools/registerGetConfigPatternTool.js +15 -0
- package/src/tools/registerGetDtoPatternTool.d.ts +5 -0
- package/src/tools/registerGetDtoPatternTool.js +15 -0
- package/src/tools/registerGetErrorHandlingPatternTool.d.ts +5 -0
- package/src/tools/registerGetErrorHandlingPatternTool.js +15 -0
- package/src/tools/registerGetGuardPatternTool.d.ts +5 -0
- package/src/tools/registerGetGuardPatternTool.js +15 -0
- package/src/tools/registerGetGuideTool.d.ts +6 -0
- package/src/tools/registerGetGuideTool.js +32 -0
- package/src/tools/registerGetMappingPatternTool.d.ts +5 -0
- package/src/tools/registerGetMappingPatternTool.js +34 -0
- package/src/tools/registerGetModulePatternTool.d.ts +5 -0
- package/src/tools/registerGetModulePatternTool.js +29 -0
- package/src/tools/registerGetPackageDocTool.d.ts +6 -0
- package/src/tools/registerGetPackageDocTool.js +43 -0
- package/src/tools/registerGetQueryPatternTool.d.ts +5 -0
- package/src/tools/registerGetQueryPatternTool.js +29 -0
- package/src/tools/registerGetRepositoryPatternTool.d.ts +5 -0
- package/src/tools/registerGetRepositoryPatternTool.js +29 -0
- package/src/tools/registerGetTestingPatternTool.d.ts +5 -0
- package/src/tools/registerGetTestingPatternTool.js +15 -0
- package/src/tools/registerListGuidesTool.d.ts +6 -0
- package/src/tools/registerListGuidesTool.js +22 -0
- package/src/tools/registerListPackagesTool.d.ts +6 -0
- package/src/tools/registerListPackagesTool.js +20 -0
- package/src/tools/registerSearchDocsTool.d.ts +6 -0
- package/src/tools/registerSearchDocsTool.js +35 -0
- package/src/tools/registerSearchGuidesTool.d.ts +6 -0
- package/src/tools/registerSearchGuidesTool.js +28 -0
|
@@ -3,7 +3,6 @@ title: 'Class: WebhookVerificationError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: WebhookVerificationError
|
|
8
7
|
|
|
9
8
|
Defined in: [errors/WebhookVerificationError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/WebhookVerificationError.ts#L12)
|
|
@@ -26,8 +25,8 @@ Defined in: [errors/WebhookVerificationError.ts:15](https://github.com/RueDeRenn
|
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
31
30
|
| `message?` | `string` |
|
|
32
31
|
|
|
33
32
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ICreateSigningRequest'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ICreateSigningRequest
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ICreateSigningRequest.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L13)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ICreateSigningRequest.ts:21](https://github.com/RueDeRennes/
|
|
|
22
21
|
|
|
23
22
|
Documents to include in the signing request.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### expiresInHours?
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ICreateSigningRequest.ts:30](https://github.com/RueDeRennes/
|
|
|
34
33
|
|
|
35
34
|
Expiration duration in hours, if applicable.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### fields?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ICreateSigningRequest.ts:27](https://github.com/RueDeRennes/
|
|
|
46
45
|
|
|
47
46
|
Fields to place on the documents.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### message?
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ICreateSigningRequest.ts:18](https://github.com/RueDeRennes/
|
|
|
58
57
|
|
|
59
58
|
Optional message for the signers.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### providerOptions?
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ICreateSigningRequest.ts:33](https://github.com/RueDeRennes/
|
|
|
70
69
|
|
|
71
70
|
Provider-specific extra options.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### signers
|
|
76
75
|
|
|
@@ -82,7 +81,7 @@ Defined in: [models/ICreateSigningRequest.ts:24](https://github.com/RueDeRennes/
|
|
|
82
81
|
|
|
83
82
|
Signers to participate in the signing request.
|
|
84
83
|
|
|
85
|
-
|
|
84
|
+
***
|
|
86
85
|
|
|
87
86
|
### subject
|
|
88
87
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ICreateSigningRequestDocument'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ICreateSigningRequestDocument
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ICreateSigningRequest.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L41)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ICreateSigningRequest.ts:49](https://github.com/RueDeRennes/
|
|
|
22
21
|
|
|
23
22
|
Document content as a buffer.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### contentType
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ICreateSigningRequest.ts:46](https://github.com/RueDeRennes/
|
|
|
34
33
|
|
|
35
34
|
MIME type of the document content.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### name
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ICreateSigningRequest.ts:43](https://github.com/RueDeRennes/
|
|
|
46
45
|
|
|
47
46
|
Display name of the document.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### order
|
|
52
51
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ICreateSigningRequestSigner'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ICreateSigningRequestSigner
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ICreateSigningRequest.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningRequest.ts#L60)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ICreateSigningRequest.ts:62](https://github.com/RueDeRennes/
|
|
|
22
21
|
|
|
23
22
|
Email address of the signer.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### name
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ICreateSigningRequest.ts:65](https://github.com/RueDeRennes/
|
|
|
34
33
|
|
|
35
34
|
Display name of the signer.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### order
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ICreateSigningRequest.ts:71](https://github.com/RueDeRennes/
|
|
|
46
45
|
|
|
47
46
|
Routing order determining the signing sequence.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### role
|
|
52
51
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ICreateSigningSessionRequest'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ICreateSigningSessionRequest
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ICreateSigningSessionRequest.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ICreateSigningSessionRequest.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ICreateSigningSessionRequest.ts:14](https://github.com/RueDe
|
|
|
22
21
|
|
|
23
22
|
URL to redirect the signer to after completing the signing.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### signerId
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ICreateSigningSessionRequest.ts:11](https://github.com/RueDe
|
|
|
34
33
|
|
|
35
34
|
Identifier of the signer to generate the session for.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### signingRequestId
|
|
40
39
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IEsigningModuleOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IEsigningModuleOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [EsigningModule.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L18)
|
|
@@ -22,7 +21,7 @@ Defined in: [EsigningModule.ts:28](https://github.com/RueDeRennes/archipel/blob/
|
|
|
22
21
|
|
|
23
22
|
Provider-specific configuration entries to register with the config module.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### isGlobal?
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [EsigningModule.ts:39](https://github.com/RueDeRennes/archipel/blob/
|
|
|
34
33
|
|
|
35
34
|
When `true` the module is registered globally.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### persistence?
|
|
40
39
|
|
|
@@ -47,7 +46,7 @@ Defined in: [EsigningModule.ts:34](https://github.com/RueDeRennes/archipel/blob/
|
|
|
47
46
|
Concrete implementation of the [EsigningPersistencePort](Class.EsigningPersistencePort).
|
|
48
47
|
Required when the application needs to persist signing request state.
|
|
49
48
|
|
|
50
|
-
|
|
49
|
+
***
|
|
51
50
|
|
|
52
51
|
### provider
|
|
53
52
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IEsigningWebhookEvent'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IEsigningWebhookEvent
|
|
8
7
|
|
|
9
8
|
Defined in: [models/IEsigningWebhookEvent.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/IEsigningWebhookEvent.ts#L12)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/IEsigningWebhookEvent.ts:14](https://github.com/RueDeRennes/
|
|
|
22
21
|
|
|
23
22
|
Provider-specific event identifier.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### eventType
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/IEsigningWebhookEvent.ts:17](https://github.com/RueDeRennes/
|
|
|
34
33
|
|
|
35
34
|
Normalized event type.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### occurredAt
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/IEsigningWebhookEvent.ts:26](https://github.com/RueDeRennes/
|
|
|
46
45
|
|
|
47
46
|
Timestamp when the event occurred.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### rawPayload
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/IEsigningWebhookEvent.ts:29](https://github.com/RueDeRennes/
|
|
|
58
57
|
|
|
59
58
|
Provider-specific raw event payload.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### signerId?
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/IEsigningWebhookEvent.ts:23](https://github.com/RueDeRennes/
|
|
|
70
69
|
|
|
71
70
|
Signer the event relates to, if applicable.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### signingRequestId
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISignedDocument'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISignedDocument
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISignedDocument.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISignedDocument.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISignedDocument.ts:20](https://github.com/RueDeRennes/archip
|
|
|
22
21
|
|
|
23
22
|
The signed document content as a buffer.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### contentType
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISignedDocument.ts:17](https://github.com/RueDeRennes/archip
|
|
|
34
33
|
|
|
35
34
|
MIME type of the signed document.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### documentId
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISignedDocument.ts:8](https://github.com/RueDeRennes/archipe
|
|
|
46
45
|
|
|
47
46
|
Provider-specific document identifier.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### name
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISignedDocument.ts:14](https://github.com/RueDeRennes/archip
|
|
|
58
57
|
|
|
59
58
|
Display name of the signed document.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### signingRequestId
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ISignedDocument.ts:11](https://github.com/RueDeRennes/archip
|
|
|
70
69
|
|
|
71
70
|
Signing request this document belongs to.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### sizeInBytes
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISigner'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISigner
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISigner.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigner.ts#L13)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISigner.ts:18](https://github.com/RueDeRennes/archipel/blob/
|
|
|
22
21
|
|
|
23
22
|
Email address of the signer.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### name
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISigner.ts:21](https://github.com/RueDeRennes/archipel/blob/
|
|
|
34
33
|
|
|
35
34
|
Display name of the signer.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### order
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISigner.ts:30](https://github.com/RueDeRennes/archipel/blob/
|
|
|
46
45
|
|
|
47
46
|
Routing order determining the signing sequence.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### role
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISigner.ts:24](https://github.com/RueDeRennes/archipel/blob/
|
|
|
58
57
|
|
|
59
58
|
Role of the signer in the signing process.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### signerId
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ISigner.ts:15](https://github.com/RueDeRennes/archipel/blob/
|
|
|
70
69
|
|
|
71
70
|
Provider-specific signer identifier.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### status
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISigningDocument'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISigningDocument
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISigningDocument.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningDocument.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISigningDocument.ts:14](https://github.com/RueDeRennes/archi
|
|
|
22
21
|
|
|
23
22
|
MIME type of the document.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### documentId
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISigningDocument.ts:8](https://github.com/RueDeRennes/archip
|
|
|
34
33
|
|
|
35
34
|
Provider-specific document identifier.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### name
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISigningDocument.ts:11](https://github.com/RueDeRennes/archi
|
|
|
46
45
|
|
|
47
46
|
Display name of the document.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### order
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISigningDocument.ts:23](https://github.com/RueDeRennes/archi
|
|
|
58
57
|
|
|
59
58
|
Order of the document within the signing request.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### pageCount?
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ISigningDocument.ts:20](https://github.com/RueDeRennes/archi
|
|
|
70
69
|
|
|
71
70
|
Number of pages in the document, if known.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### sizeInBytes?
|
|
76
75
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISigningField'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISigningField
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISigningField.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningField.ts#L12)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISigningField.ts:23](https://github.com/RueDeRennes/archipel
|
|
|
22
21
|
|
|
23
22
|
Identifier of the document this field is placed on.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### fieldId
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISigningField.ts:14](https://github.com/RueDeRennes/archipel
|
|
|
34
33
|
|
|
35
34
|
Provider-specific field identifier.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### height
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISigningField.ts:38](https://github.com/RueDeRennes/archipel
|
|
|
46
45
|
|
|
47
46
|
Height of the field in points.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### pageNumber
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISigningField.ts:26](https://github.com/RueDeRennes/archipel
|
|
|
58
57
|
|
|
59
58
|
Page number where the field is placed (1-based).
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### positionX
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ISigningField.ts:29](https://github.com/RueDeRennes/archipel
|
|
|
70
69
|
|
|
71
70
|
X-coordinate position (points from left).
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### positionY
|
|
76
75
|
|
|
@@ -82,7 +81,7 @@ Defined in: [models/ISigningField.ts:32](https://github.com/RueDeRennes/archipel
|
|
|
82
81
|
|
|
83
82
|
Y-coordinate position (points from top).
|
|
84
83
|
|
|
85
|
-
|
|
84
|
+
***
|
|
86
85
|
|
|
87
86
|
### required
|
|
88
87
|
|
|
@@ -94,7 +93,7 @@ Defined in: [models/ISigningField.ts:41](https://github.com/RueDeRennes/archipel
|
|
|
94
93
|
|
|
95
94
|
Whether the field is required.
|
|
96
95
|
|
|
97
|
-
|
|
96
|
+
***
|
|
98
97
|
|
|
99
98
|
### signerId
|
|
100
99
|
|
|
@@ -106,7 +105,7 @@ Defined in: [models/ISigningField.ts:20](https://github.com/RueDeRennes/archipel
|
|
|
106
105
|
|
|
107
106
|
Identifier of the signer associated with this field.
|
|
108
107
|
|
|
109
|
-
|
|
108
|
+
***
|
|
110
109
|
|
|
111
110
|
### type
|
|
112
111
|
|
|
@@ -118,7 +117,7 @@ Defined in: [models/ISigningField.ts:17](https://github.com/RueDeRennes/archipel
|
|
|
118
117
|
|
|
119
118
|
Type of the field.
|
|
120
119
|
|
|
121
|
-
|
|
120
|
+
***
|
|
122
121
|
|
|
123
122
|
### value?
|
|
124
123
|
|
|
@@ -130,7 +129,7 @@ Defined in: [models/ISigningField.ts:44](https://github.com/RueDeRennes/archipel
|
|
|
130
129
|
|
|
131
130
|
Current value of the field, if filled.
|
|
132
131
|
|
|
133
|
-
|
|
132
|
+
***
|
|
134
133
|
|
|
135
134
|
### width
|
|
136
135
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISigningRequest'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISigningRequest
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISigningRequest.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningRequest.ts#L15)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISigningRequest.ts:38](https://github.com/RueDeRennes/archip
|
|
|
22
21
|
|
|
23
22
|
Timestamp when the signing request was created.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### documents
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISigningRequest.ts:32](https://github.com/RueDeRennes/archip
|
|
|
34
33
|
|
|
35
34
|
Documents included in this request.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### expiresAt?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISigningRequest.ts:44](https://github.com/RueDeRennes/archip
|
|
|
46
45
|
|
|
47
46
|
Timestamp when the signing request expires, if applicable.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### fields
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISigningRequest.ts:35](https://github.com/RueDeRennes/archip
|
|
|
58
57
|
|
|
59
58
|
Fields placed across the documents.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### message?
|
|
64
63
|
|
|
@@ -70,7 +69,7 @@ Defined in: [models/ISigningRequest.ts:26](https://github.com/RueDeRennes/archip
|
|
|
70
69
|
|
|
71
70
|
Optional message included with the signing request.
|
|
72
71
|
|
|
73
|
-
|
|
72
|
+
***
|
|
74
73
|
|
|
75
74
|
### providerMetadata?
|
|
76
75
|
|
|
@@ -82,7 +81,7 @@ Defined in: [models/ISigningRequest.ts:47](https://github.com/RueDeRennes/archip
|
|
|
82
81
|
|
|
83
82
|
Provider-specific raw metadata.
|
|
84
83
|
|
|
85
|
-
|
|
84
|
+
***
|
|
86
85
|
|
|
87
86
|
### signers
|
|
88
87
|
|
|
@@ -94,7 +93,7 @@ Defined in: [models/ISigningRequest.ts:29](https://github.com/RueDeRennes/archip
|
|
|
94
93
|
|
|
95
94
|
Signers participating in this request.
|
|
96
95
|
|
|
97
|
-
|
|
96
|
+
***
|
|
98
97
|
|
|
99
98
|
### signingRequestId
|
|
100
99
|
|
|
@@ -106,7 +105,7 @@ Defined in: [models/ISigningRequest.ts:17](https://github.com/RueDeRennes/archip
|
|
|
106
105
|
|
|
107
106
|
Provider-specific signing request identifier.
|
|
108
107
|
|
|
109
|
-
|
|
108
|
+
***
|
|
110
109
|
|
|
111
110
|
### status
|
|
112
111
|
|
|
@@ -118,7 +117,7 @@ Defined in: [models/ISigningRequest.ts:20](https://github.com/RueDeRennes/archip
|
|
|
118
117
|
|
|
119
118
|
Current status of the signing request.
|
|
120
119
|
|
|
121
|
-
|
|
120
|
+
***
|
|
122
121
|
|
|
123
122
|
### subject
|
|
124
123
|
|
|
@@ -130,7 +129,7 @@ Defined in: [models/ISigningRequest.ts:23](https://github.com/RueDeRennes/archip
|
|
|
130
129
|
|
|
131
130
|
Subject or title of the signing request.
|
|
132
131
|
|
|
133
|
-
|
|
132
|
+
***
|
|
134
133
|
|
|
135
134
|
### updatedAt
|
|
136
135
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISigningSession'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISigningSession
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ISigningSession.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/ISigningSession.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/ISigningSession.ts:20](https://github.com/RueDeRennes/archip
|
|
|
22
21
|
|
|
23
22
|
Timestamp when the session expires.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### sessionId
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/ISigningSession.ts:8](https://github.com/RueDeRennes/archipe
|
|
|
34
33
|
|
|
35
34
|
Provider-specific session identifier.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### signerId
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/ISigningSession.ts:14](https://github.com/RueDeRennes/archip
|
|
|
46
45
|
|
|
47
46
|
Signer this session was created for.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### signingRequestId
|
|
52
51
|
|
|
@@ -58,7 +57,7 @@ Defined in: [models/ISigningSession.ts:11](https://github.com/RueDeRennes/archip
|
|
|
58
57
|
|
|
59
58
|
Signing request this session belongs to.
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### signingUrl
|
|
64
63
|
|
|
@@ -3,11 +3,10 @@ title: 'Type Alias: SignerRole'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Type Alias: SignerRole
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
type SignerRole =
|
|
9
|
+
type SignerRole = typeof SignerRoles[keyof typeof SignerRoles];
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [models/SignerRole.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerRole.ts#L19)
|
|
@@ -3,11 +3,10 @@ title: 'Type Alias: SignerStatus'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Type Alias: SignerStatus
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
type SignerStatus =
|
|
9
|
+
type SignerStatus = typeof SignerStatuses[keyof typeof SignerStatuses];
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [models/SignerStatus.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SignerStatus.ts#L20)
|
|
@@ -3,11 +3,10 @@ title: 'Type Alias: SigningFieldType'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Type Alias: SigningFieldType
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
type SigningFieldType =
|
|
9
|
+
type SigningFieldType = typeof SigningFieldTypes[keyof typeof SigningFieldTypes];
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [models/SigningFieldType.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/SigningFieldType.ts#L23)
|