@breadstone/archipel-mcp 0.0.15 → 0.0.16
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 +385 -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 +268 -0
- package/data/guides/caching.md +255 -0
- package/data/guides/configuration.md +242 -0
- package/data/guides/cryptography-and-otp.md +240 -0
- package/data/guides/database-setup.md +546 -0
- package/data/guides/document-generation.md +174 -0
- package/data/guides/email-delivery.md +233 -0
- package/data/guides/esigning-integration.md +247 -0
- package/data/guides/getting-started.md +354 -0
- package/data/guides/implementing-ports.md +317 -0
- package/data/guides/index.md +63 -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 +260 -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/index.md +8 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +141 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +47 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +161 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +169 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +58 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +47 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +58 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +14 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +14 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +14 -0
- package/data/packages/platform-analytics/api/index.md +44 -0
- package/data/packages/platform-analytics/index.md +170 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +40 -0
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +86 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +76 -0
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +95 -0
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +59 -0
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +135 -0
- package/data/packages/platform-authentication/api/Class.ChallengeStorePort.md +95 -0
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +40 -0
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +78 -0
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +40 -0
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +136 -0
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +71 -0
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +40 -0
- package/data/packages/platform-authentication/api/Class.MfaService.md +252 -0
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +70 -0
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +60 -0
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +60 -0
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +165 -0
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +152 -0
- package/data/packages/platform-authentication/api/Class.SessionService.md +162 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +61 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +48 -0
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +47 -0
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +144 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +154 -0
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +116 -0
- package/data/packages/platform-authentication/api/Function.Token.md +18 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +24 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +22 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +157 -0
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +107 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +82 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +118 -0
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +22 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +58 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +131 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +91 -0
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +160 -0
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +82 -0
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +58 -0
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +70 -0
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +71 -0
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_STATE.md +16 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_STATE.md +16 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_STATE.md +16 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_STATE.md +16 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +14 -0
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +29 -0
- package/data/packages/platform-authentication/api/Variable.User.md +24 -0
- package/data/packages/platform-authentication/api/index.md +117 -0
- package/data/packages/platform-authentication/index.md +691 -0
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +196 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +79 -0
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +49 -0
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +75 -0
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +248 -0
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +51 -0
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +68 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +48 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +38 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +48 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +64 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +48 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +138 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +114 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +48 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +98 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +80 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +28 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +12 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +12 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +16 -0
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +12 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +26 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-blob-storage/api/index.md +59 -0
- package/data/packages/platform-blob-storage/index.md +353 -0
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +258 -0
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +157 -0
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +295 -0
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +121 -0
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +70 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +198 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +75 -0
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +121 -0
- package/data/packages/platform-caching/api/index.md +24 -0
- package/data/packages/platform-caching/index.md +116 -0
- package/data/packages/platform-configuration/api/Class.ConfigKeyNotFoundError.md +89 -0
- package/data/packages/platform-configuration/api/Class.ConfigModule.md +74 -0
- package/data/packages/platform-configuration/api/Class.ConfigRegistry.md +115 -0
- package/data/packages/platform-configuration/api/Class.ConfigService.md +137 -0
- package/data/packages/platform-configuration/api/Class.ConfigStrategyBase.md +125 -0
- package/data/packages/platform-configuration/api/Class.EnvironmentConfigStrategy.md +141 -0
- package/data/packages/platform-configuration/api/Class.FileConfigStrategy.md +147 -0
- package/data/packages/platform-configuration/api/Function.createConfigKey.md +58 -0
- package/data/packages/platform-configuration/api/Interface.IConfigKey.md +63 -0
- package/data/packages/platform-configuration/api/Interface.IConfigModuleOptions.md +40 -0
- package/data/packages/platform-configuration/api/Interface.IConfigRegistryEntry.md +79 -0
- package/data/packages/platform-configuration/api/index.md +32 -0
- package/data/packages/platform-configuration/index.md +224 -0
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +50 -0
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +195 -0
- package/data/packages/platform-core/api/Class.BooleanUtils.md +82 -0
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +120 -0
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +93 -0
- package/data/packages/platform-core/api/Class.CatchUtils.md +93 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +63 -0
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +101 -0
- package/data/packages/platform-core/api/Class.DeviceParserService.md +52 -0
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +215 -0
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +109 -0
- package/data/packages/platform-core/api/Class.EventHub.md +163 -0
- package/data/packages/platform-core/api/Class.EventModule.md +22 -0
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +192 -0
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +85 -0
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +66 -0
- package/data/packages/platform-core/api/Class.HealthModule.md +42 -0
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +64 -0
- package/data/packages/platform-core/api/Class.HostModule.md +31 -0
- package/data/packages/platform-core/api/Class.HostService.md +149 -0
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +59 -0
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +87 -0
- package/data/packages/platform-core/api/Class.IdentifierModule.md +40 -0
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +59 -0
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +42 -0
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +42 -0
- package/data/packages/platform-core/api/Class.MappingBuilder.md +110 -0
- package/data/packages/platform-core/api/Class.MappingModule.md +46 -0
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +56 -0
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +52 -0
- package/data/packages/platform-core/api/Class.MappingService.md +284 -0
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +148 -0
- package/data/packages/platform-core/api/Class.PageableRequest.md +42 -0
- package/data/packages/platform-core/api/Class.PageableResponse.md +62 -0
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +61 -0
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +94 -0
- package/data/packages/platform-core/api/Class.QuantityResponse.md +42 -0
- package/data/packages/platform-core/api/Class.ResourceManager.md +565 -0
- package/data/packages/platform-core/api/Class.ResourceModule.md +46 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +502 -0
- package/data/packages/platform-core/api/Class.SseHub.md +183 -0
- package/data/packages/platform-core/api/Class.SseModule.md +42 -0
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +42 -0
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +57 -0
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +85 -0
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +52 -0
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +64 -0
- package/data/packages/platform-core/api/Function.Public.md +18 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +33 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +39 -0
- package/data/packages/platform-core/api/Function.env.md +28 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +26 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +27 -0
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +28 -0
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +40 -0
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +80 -0
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +153 -0
- package/data/packages/platform-core/api/Interface.IEventKey.md +57 -0
- package/data/packages/platform-core/api/Interface.IEventMap.md +16 -0
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +72 -0
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +46 -0
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +41 -0
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +232 -0
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +57 -0
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +76 -0
- package/data/packages/platform-core/api/Interface.IMappingKey.md +58 -0
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +32 -0
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +89 -0
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +94 -0
- package/data/packages/platform-core/api/Interface.IResourceResult.md +34 -0
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +134 -0
- package/data/packages/platform-core/api/Interface.ISseEventData.md +36 -0
- package/data/packages/platform-core/api/Interface.ISseHub.md +91 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +14 -0
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +18 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +28 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +25 -0
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +21 -0
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_NAME.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_PORT.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +14 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +14 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +12 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +31 -0
- package/data/packages/platform-core/api/Variable.Lang.md +29 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +14 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +24 -0
- package/data/packages/platform-core/api/index.md +127 -0
- package/data/packages/platform-core/index.md +487 -0
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +95 -0
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +51 -0
- package/data/packages/platform-cryptography/api/Class.CryptographyError.md +56 -0
- package/data/packages/platform-cryptography/api/Class.InvalidOtpError.md +52 -0
- package/data/packages/platform-cryptography/api/Class.OtpService.md +155 -0
- package/data/packages/platform-cryptography/api/Class.WeakPasswordError.md +52 -0
- package/data/packages/platform-cryptography/api/Interface.IBcryptOptions.md +45 -0
- package/data/packages/platform-cryptography/api/Interface.IOtpOptions.md +31 -0
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +113 -0
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +46 -0
- package/data/packages/platform-cryptography/api/Variable.BCRYPT_OPTIONS.md +14 -0
- package/data/packages/platform-cryptography/api/Variable.MAX_BCRYPT_PASSWORD_BYTES.md +14 -0
- package/data/packages/platform-cryptography/api/Variable.MIN_BCRYPT_ROUNDS.md +14 -0
- package/data/packages/platform-cryptography/api/Variable.OTP_OPTIONS.md +14 -0
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +14 -0
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +23 -0
- package/data/packages/platform-cryptography/api/index.md +37 -0
- package/data/packages/platform-cryptography/index.md +132 -0
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +75 -0
- package/data/packages/platform-database/api/Class.DatabaseModule.md +68 -0
- package/data/packages/platform-database/api/Class.DatabaseService.md +143 -0
- package/data/packages/platform-database/api/Class.PrismaService.md +98 -0
- package/data/packages/platform-database/api/Class.RepositoryBase.md +590 -0
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +55 -0
- package/data/packages/platform-database/api/Function.cursorPaginator.md +26 -0
- package/data/packages/platform-database/api/Function.pageable.md +35 -0
- package/data/packages/platform-database/api/Function.paginator.md +22 -0
- package/data/packages/platform-database/api/Function.query.md +34 -0
- package/data/packages/platform-database/api/Function.skip.md +33 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +31 -0
- package/data/packages/platform-database/api/Interface.ICursorPaginateOptions.md +40 -0
- package/data/packages/platform-database/api/Interface.ICursorPaginatedResult.md +65 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +35 -0
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +28 -0
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +77 -0
- package/data/packages/platform-database/api/Interface.IPrismaServiceOptions.md +23 -0
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +51 -0
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +50 -0
- package/data/packages/platform-database/api/TypeAlias.CursorPaginateFunction.md +33 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +18 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +18 -0
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +31 -0
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +27 -0
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +26 -0
- package/data/packages/platform-database/api/Variable.DATABASE_MODULE_CONFIG.md +14 -0
- package/data/packages/platform-database/api/Variable.DB_AUTO_CONNECTION.md +14 -0
- package/data/packages/platform-database/api/Variable.PLATFORM_DATABASE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-database/api/index.md +60 -0
- package/data/packages/platform-database/index.md +323 -0
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +277 -0
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +80 -0
- package/data/packages/platform-documents/api/Class.DocumentModule.md +47 -0
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +131 -0
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +94 -0
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +70 -0
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +118 -0
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +47 -0
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +58 -0
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +95 -0
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +64 -0
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +58 -0
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +14 -0
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +14 -0
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +14 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +14 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +14 -0
- package/data/packages/platform-documents/api/index.md +47 -0
- package/data/packages/platform-documents/index.md +219 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +188 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +65 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +48 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +90 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +202 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +253 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +101 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +78 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +60 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +94 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +58 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +46 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +60 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +82 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +142 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +70 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +14 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +12 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +30 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +32 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +38 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +36 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +38 -0
- package/data/packages/platform-esigning/api/index.md +84 -0
- package/data/packages/platform-esigning/index.md +701 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +94 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +106 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +22 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceProviderError.md +79 -0
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +81 -0
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +26 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +31 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +78 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +58 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +46 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +70 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +94 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +34 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +60 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +59 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +53 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +14 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +24 -0
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.ANTHROPIC_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GEMINI_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GOOGLE_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GOOGLE_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GROK_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.GROK_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_MODEL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_PROVIDER.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TEMPERATURE.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.INTELLIGENCE_TOP_P.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +26 -0
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +28 -0
- package/data/packages/platform-intelligence/api/Variable.OPENAI_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.OPENAI_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.PLATFORM_INTELLIGENCE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.XAI_API_KEY.md +14 -0
- package/data/packages/platform-intelligence/api/Variable.XAI_BASE_URL.md +14 -0
- package/data/packages/platform-intelligence/api/index.md +89 -0
- package/data/packages/platform-intelligence/index.md +155 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +22 -0
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +14 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-logging/api/index.md +19 -0
- package/data/packages/platform-logging/index.md +92 -0
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +60 -0
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +68 -0
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +58 -0
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +71 -0
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +78 -0
- package/data/packages/platform-mailing/api/Class.MailModule.md +22 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +98 -0
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +93 -0
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +92 -0
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +77 -0
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +77 -0
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +77 -0
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +77 -0
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +77 -0
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +53 -0
- package/data/packages/platform-mailing/api/Interface.IMailAttachment.md +46 -0
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +66 -0
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +30 -0
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +14 -0
- package/data/packages/platform-mailing/api/Variable.ALLOWED_ATTACHMENT_MIME_TYPES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +12 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +16 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +14 -0
- package/data/packages/platform-mailing/api/Variable.MAX_ATTACHMENT_SIZE_BYTES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +14 -0
- package/data/packages/platform-mailing/api/index.md +77 -0
- package/data/packages/platform-mailing/index.md +383 -0
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +64 -0
- package/data/packages/platform-mcp/api/Class.McpModule.md +82 -0
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +146 -0
- package/data/packages/platform-mcp/api/Class.McpServerService.md +196 -0
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +28 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +28 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +28 -0
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +46 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +75 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +125 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +27 -0
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +58 -0
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +72 -0
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +94 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +40 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +40 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +40 -0
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +22 -0
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +38 -0
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +14 -0
- package/data/packages/platform-mcp/api/index.md +46 -0
- package/data/packages/platform-mcp/index.md +299 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +70 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +83 -0
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +77 -0
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +46 -0
- package/data/packages/platform-openapi/api/Function.Api.md +35 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +42 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +18 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +27 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +68 -0
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +68 -0
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +14 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +14 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +12 -0
- package/data/packages/platform-openapi/api/index.md +42 -0
- package/data/packages/platform-openapi/index.md +170 -0
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +74 -0
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +68 -0
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +69 -0
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +163 -0
- package/data/packages/platform-payments/api/Class.MollieClient.md +166 -0
- package/data/packages/platform-payments/api/Class.PaddleClient.md +163 -0
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +142 -0
- package/data/packages/platform-payments/api/Class.PaymentModule.md +48 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +163 -0
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +25 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +70 -0
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +70 -0
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +80 -0
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +100 -0
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +84 -0
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +60 -0
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +22 -0
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +12 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +14 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +14 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +14 -0
- package/data/packages/platform-payments/api/index.md +63 -0
- package/data/packages/platform-payments/index.md +534 -0
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +56 -0
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +40 -0
- package/data/packages/platform-reporting/api/Class.ReportingExecutionError.md +67 -0
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +84 -0
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +22 -0
- package/data/packages/platform-reporting/api/Class.ReportingQueryValidationError.md +51 -0
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +61 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +82 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +70 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +60 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +40 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +60 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +30 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +12 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +12 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +14 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +30 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +28 -0
- package/data/packages/platform-reporting/api/index.md +44 -0
- package/data/packages/platform-reporting/index.md +229 -0
- package/data/packages/platform-telemetry/api/Class.MetricsService.md +40 -0
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +113 -0
- package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +73 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +175 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +135 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +226 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +40 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +49 -0
- package/data/packages/platform-telemetry/api/Function.validateTelemetryOptions.md +24 -0
- package/data/packages/platform-telemetry/api/Interface.IMetricInstruments.md +38 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +85 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +38 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +136 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +38 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +12 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +12 -0
- package/data/packages/platform-telemetry/api/index.md +44 -0
- package/data/packages/platform-telemetry/index.md +234 -0
- package/package.json +1 -1
|
@@ -0,0 +1,534 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: platform-payments
|
|
3
|
+
description: Provider-agnostic payment infrastructure with support for Stripe, Paddle, LemonSqueezy, and Mollie.
|
|
4
|
+
order: 4
|
|
5
|
+
tags: [payments, stripe, paddle, lemonsqueezy, mollie, feature-gating, quotas, guards, interceptors, ports-and-adapters]
|
|
6
|
+
package: '@breadstone/archipel-platform-payments'
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# platform-payments
|
|
10
|
+
|
|
11
|
+
Provider-agnostic payment infrastructure for NestJS. Exposes a unified `PaymentClientPort` abstraction with four ready-made implementations (Stripe, Paddle, LemonSqueezy, Mollie), a feature-gating guard, and a usage-tracking interceptor. Feature access checks are fully decoupled via the `FeatureAccessPort`.
|
|
12
|
+
|
|
13
|
+
**Package:** `@breadstone/archipel-platform-payments`
|
|
14
|
+
|
|
15
|
+
## Architecture
|
|
16
|
+
|
|
17
|
+
```mermaid
|
|
18
|
+
graph TD
|
|
19
|
+
Core["@breadstone/archipel-platform-payments<br/><i>Port, models, guard, interceptor, module</i>"]
|
|
20
|
+
Stripe["@breadstone/archipel-platform-payments/stripe<br/><i>StripeClient</i>"]
|
|
21
|
+
Paddle["@breadstone/archipel-platform-payments/paddle<br/><i>PaddleClient</i>"]
|
|
22
|
+
Lemon["@breadstone/archipel-platform-payments/lemonsqueezy<br/><i>LemonSqueezyClient</i>"]
|
|
23
|
+
Mollie["@breadstone/archipel-platform-payments/mollie<br/><i>MollieClient</i>"]
|
|
24
|
+
|
|
25
|
+
Stripe -->|implements| Core
|
|
26
|
+
Paddle -->|implements| Core
|
|
27
|
+
Lemon -->|implements| Core
|
|
28
|
+
Mollie -->|implements| Core
|
|
29
|
+
|
|
30
|
+
Stripe -.-|requires| S["stripe"]
|
|
31
|
+
Paddle -.-|requires| P["@paddle/paddle-node-sdk"]
|
|
32
|
+
Lemon -.-|requires| L["@lemonsqueezy/lemonsqueezy.js"]
|
|
33
|
+
Mollie -.-|requires| M["@mollie/api-client"]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Each provider SDK is an **optional peer dependency**. Install only the one you need.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Quick Start
|
|
41
|
+
|
|
42
|
+
### 1. Install the provider SDK
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Pick one:
|
|
46
|
+
yarn add stripe
|
|
47
|
+
yarn add @paddle/paddle-node-sdk
|
|
48
|
+
yarn add @lemonsqueezy/lemonsqueezy.js
|
|
49
|
+
yarn add @mollie/api-client
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 2. Register the module
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
import { Module } from '@nestjs/common';
|
|
56
|
+
import { PaymentModule } from '@breadstone/archipel-platform-payments';
|
|
57
|
+
import { StripeClient, STRIPE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/stripe';
|
|
58
|
+
|
|
59
|
+
@Module({
|
|
60
|
+
imports: [
|
|
61
|
+
PaymentModule.register({
|
|
62
|
+
paymentClient: StripeClient,
|
|
63
|
+
configEntries: STRIPE_CONFIG_ENTRIES,
|
|
64
|
+
featureAccess: PrismaFeatureAccessAdapter, // optional
|
|
65
|
+
isGlobal: false,
|
|
66
|
+
}),
|
|
67
|
+
],
|
|
68
|
+
})
|
|
69
|
+
export class AppModule {}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Switching providers
|
|
73
|
+
|
|
74
|
+
Replace the imports — no other code change needed:
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import { PaddleClient, PADDLE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/paddle';
|
|
78
|
+
|
|
79
|
+
PaymentModule.register({
|
|
80
|
+
paymentClient: PaddleClient,
|
|
81
|
+
configEntries: PADDLE_CONFIG_ENTRIES,
|
|
82
|
+
});
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Module Configuration
|
|
88
|
+
|
|
89
|
+
### IPaymentModuleOptions
|
|
90
|
+
|
|
91
|
+
| Property | Type | Required | Default | Description |
|
|
92
|
+
| --------------- | ----------------------------------------------------- | -------- | ------- | --------------------------------------------- |
|
|
93
|
+
| `paymentClient` | `Type<PaymentClientPort>` | **Yes** | — | Provider implementation (e.g. `StripeClient`) |
|
|
94
|
+
| `configEntries` | `ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>` | No | `[]` | Provider-specific config entries |
|
|
95
|
+
| `featureAccess` | `Type<FeatureAccessPort>` | No | — | Feature quota checking and usage recording |
|
|
96
|
+
| `isGlobal` | `boolean` | No | `false` | Register as a global module |
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## Payment Providers
|
|
101
|
+
|
|
102
|
+
### Stripe
|
|
103
|
+
|
|
104
|
+
**Subpath:** `@breadstone/archipel-platform-payments/stripe`
|
|
105
|
+
**SDK:** `stripe` ≥ 22.0.0
|
|
106
|
+
|
|
107
|
+
| Variable | Description | Required |
|
|
108
|
+
| ----------------------- | ----------------------------- | -------- |
|
|
109
|
+
| `STRIPE_API_KEY` | Stripe secret API key | Yes |
|
|
110
|
+
| `STRIPE_WEBHOOK_SECRET` | Stripe webhook signing secret | Yes |
|
|
111
|
+
|
|
112
|
+
```typescript
|
|
113
|
+
import { StripeClient, STRIPE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/stripe';
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Paddle
|
|
117
|
+
|
|
118
|
+
**Subpath:** `@breadstone/archipel-platform-payments/paddle`
|
|
119
|
+
**SDK:** `@paddle/paddle-node-sdk` ≥ 3.0.0
|
|
120
|
+
|
|
121
|
+
| Variable | Description | Required | Default |
|
|
122
|
+
| ----------------------- | ------------------------- | -------- | ------------ |
|
|
123
|
+
| `PADDLE_API_KEY` | Paddle API key | Yes | — |
|
|
124
|
+
| `PADDLE_WEBHOOK_SECRET` | Paddle webhook secret key | Yes | — |
|
|
125
|
+
| `PADDLE_ENVIRONMENT` | `production` or `sandbox` | No | `production` |
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
import { PaddleClient, PADDLE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/paddle';
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
### LemonSqueezy
|
|
132
|
+
|
|
133
|
+
**Subpath:** `@breadstone/archipel-platform-payments/lemonsqueezy`
|
|
134
|
+
**SDK:** `@lemonsqueezy/lemonsqueezy.js` ≥ 4.0.0
|
|
135
|
+
|
|
136
|
+
| Variable | Description | Required |
|
|
137
|
+
| ----------------------------- | ----------------------------------- | -------- |
|
|
138
|
+
| `LEMONSQUEEZY_API_KEY` | LemonSqueezy API key | Yes |
|
|
139
|
+
| `LEMONSQUEEZY_WEBHOOK_SECRET` | LemonSqueezy webhook signing secret | Yes |
|
|
140
|
+
| `LEMONSQUEEZY_STORE_ID` | LemonSqueezy store ID | Yes |
|
|
141
|
+
|
|
142
|
+
```typescript
|
|
143
|
+
import { LemonSqueezyClient, LEMONSQUEEZY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/lemonsqueezy';
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Mollie
|
|
147
|
+
|
|
148
|
+
**Subpath:** `@breadstone/archipel-platform-payments/mollie`
|
|
149
|
+
**SDK:** `@mollie/api-client` ≥ 4.0.0
|
|
150
|
+
|
|
151
|
+
| Variable | Description | Required |
|
|
152
|
+
| ----------------------- | -------------------------------------- | -------- |
|
|
153
|
+
| `MOLLIE_API_KEY` | Mollie API key | Yes |
|
|
154
|
+
| `MOLLIE_WEBHOOK_SECRET` | Mollie webhook secret for verification | No |
|
|
155
|
+
|
|
156
|
+
```typescript
|
|
157
|
+
import { MollieClient, MOLLIE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/mollie';
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
::: info Mollie Limitations
|
|
161
|
+
Mollie does not have a native price catalog API. `fetchPrices()` returns an empty array — maintain prices in your local database. `fetchSubscription()` expects the format `"customerId:subscriptionId"`.
|
|
162
|
+
:::
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
## PaymentClientPort
|
|
167
|
+
|
|
168
|
+
All providers implement this abstract contract. Inject `PaymentClientPort` in services to stay provider-agnostic:
|
|
169
|
+
|
|
170
|
+
```typescript
|
|
171
|
+
abstract class PaymentClientPort {
|
|
172
|
+
abstract fetchPrices(productId: string): Promise<INormalizedPrice[]>;
|
|
173
|
+
abstract createCheckoutSession(
|
|
174
|
+
priceId: string,
|
|
175
|
+
successUrl: string,
|
|
176
|
+
cancelUrl: string,
|
|
177
|
+
userId?: string,
|
|
178
|
+
): Promise<INormalizedCheckoutSession>;
|
|
179
|
+
abstract fetchSubscription(subscriptionId: string): Promise<INormalizedSubscription | null>;
|
|
180
|
+
abstract constructWebhookEvent(
|
|
181
|
+
payload: string | Buffer,
|
|
182
|
+
signature: string,
|
|
183
|
+
): Promise<INormalizedWebhookEvent> | INormalizedWebhookEvent;
|
|
184
|
+
}
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Usage in services
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
import { PaymentClientPort } from '@breadstone/archipel-platform-payments';
|
|
191
|
+
|
|
192
|
+
@Injectable()
|
|
193
|
+
export class CheckoutService {
|
|
194
|
+
constructor(private readonly _paymentClient: PaymentClientPort) {}
|
|
195
|
+
|
|
196
|
+
public async createCheckout(priceId: string, userId: string): Promise<string | null> {
|
|
197
|
+
const session = await this._paymentClient.createCheckoutSession(
|
|
198
|
+
priceId,
|
|
199
|
+
'https://app.example.com/success',
|
|
200
|
+
'https://app.example.com/cancel',
|
|
201
|
+
userId,
|
|
202
|
+
);
|
|
203
|
+
return session.url;
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Prices
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
const prices = await this._paymentClient.fetchPrices('prod_ABC123');
|
|
212
|
+
// → INormalizedPrice[]
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
> **Error handling:** `fetchPrices` **throws** on API or network errors instead of returning an empty array. Errors are logged with structured metadata before being re-thrown. Wrap calls in `try/catch` if you need fallback behavior.
|
|
216
|
+
|
|
217
|
+
### Subscriptions
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
const subscription = await this._paymentClient.fetchSubscription('sub_ABC123');
|
|
221
|
+
// → INormalizedSubscription | null
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
### Webhook Events
|
|
225
|
+
|
|
226
|
+
```typescript
|
|
227
|
+
const event = await this._paymentClient.constructWebhookEvent(rawBody, signature);
|
|
228
|
+
// → INormalizedWebhookEvent
|
|
229
|
+
```
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
## Normalized Types
|
|
234
|
+
|
|
235
|
+
All providers map their native API responses into these shared interfaces.
|
|
236
|
+
|
|
237
|
+
### INormalizedPrice
|
|
238
|
+
|
|
239
|
+
| Field | Type | Description |
|
|
240
|
+
| --------------- | -------------------------------------------------- | ------------------------------- |
|
|
241
|
+
| `id` | `string` | Price identifier |
|
|
242
|
+
| `productId` | `string` | Associated product identifier |
|
|
243
|
+
| `amount` | `number` | Price amount (in smallest unit) |
|
|
244
|
+
| `currency` | `string` | ISO 4217 currency code |
|
|
245
|
+
| `interval` | `'week' \| 'month' \| 'quarter' \| 'year' \| null` | Billing interval |
|
|
246
|
+
| `intervalCount` | `number` | Number of intervals per cycle |
|
|
247
|
+
| `active` | `boolean` | Whether the price is active |
|
|
248
|
+
|
|
249
|
+
### INormalizedCheckoutSession
|
|
250
|
+
|
|
251
|
+
| Field | Type | Description |
|
|
252
|
+
| ------------------- | --------------------------------------------- | ------------------------ |
|
|
253
|
+
| `id` | `string` | Session identifier |
|
|
254
|
+
| `url` | `string \| null` | Checkout URL to redirect |
|
|
255
|
+
| `subscriptionId` | `string \| null` | Created subscription ID |
|
|
256
|
+
| `customerId` | `string \| null` | Customer identifier |
|
|
257
|
+
| `clientReferenceId` | `string \| null` | Client-supplied ref |
|
|
258
|
+
| `paymentStatus` | `'paid' \| 'unpaid' \| 'no_payment_required'` | Payment status |
|
|
259
|
+
|
|
260
|
+
### INormalizedSubscription
|
|
261
|
+
|
|
262
|
+
| Field | Type | Description |
|
|
263
|
+
| -------------------- | -------------------- | --------------------------------- |
|
|
264
|
+
| `id` | `string` | Subscription identifier |
|
|
265
|
+
| `customerId` | `string` | Customer identifier |
|
|
266
|
+
| `status` | `SubscriptionStatus` | Current status |
|
|
267
|
+
| `priceId` | `string` | Associated price identifier |
|
|
268
|
+
| `currentPeriodStart` | `Date` | Start of current billing period |
|
|
269
|
+
| `currentPeriodEnd` | `Date` | End of current billing period |
|
|
270
|
+
| `cancelAtPeriodEnd` | `boolean` | Whether cancellation is scheduled |
|
|
271
|
+
| `trialStart` | `Date \| null` | Trial start date |
|
|
272
|
+
| `trialEnd` | `Date \| null` | Trial end date |
|
|
273
|
+
|
|
274
|
+
### SubscriptionStatus
|
|
275
|
+
|
|
276
|
+
```typescript
|
|
277
|
+
type SubscriptionStatus =
|
|
278
|
+
| 'active'
|
|
279
|
+
| 'canceled'
|
|
280
|
+
| 'incomplete'
|
|
281
|
+
| 'incompleteExpired'
|
|
282
|
+
| 'pastDue'
|
|
283
|
+
| 'trialing'
|
|
284
|
+
| 'unpaid'
|
|
285
|
+
| 'paused';
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
### INormalizedWebhookEvent
|
|
289
|
+
|
|
290
|
+
| Field | Type | Description |
|
|
291
|
+
| ------ | --------------------------- | ------------------------------- |
|
|
292
|
+
| `type` | `string` (see values below) | Normalized event type |
|
|
293
|
+
| `data` | `object` | Event payload (see shape below) |
|
|
294
|
+
|
|
295
|
+
**Event types:** `checkout.session.completed`, `subscription.updated`, `subscription.deleted`, `invoice.payment_failed`, `invoice.payment_succeeded`, `unknown`
|
|
296
|
+
|
|
297
|
+
**Data shape:**
|
|
298
|
+
|
|
299
|
+
```typescript
|
|
300
|
+
{
|
|
301
|
+
checkoutSession?: INormalizedCheckoutSession;
|
|
302
|
+
subscription?: INormalizedSubscription;
|
|
303
|
+
invoice?: {
|
|
304
|
+
id: string;
|
|
305
|
+
subscriptionId: string | null;
|
|
306
|
+
status: 'draft' | 'open' | 'paid' | 'uncollectible' | 'void';
|
|
307
|
+
};
|
|
308
|
+
}
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
## FeatureAccessPort
|
|
314
|
+
|
|
315
|
+
Abstract port for checking feature quotas and recording usage. This enables feature-gating with any billing system.
|
|
316
|
+
|
|
317
|
+
```typescript
|
|
318
|
+
abstract class FeatureAccessPort {
|
|
319
|
+
abstract checkAccess(userId: string, featureKey: string): Promise<IFeatureAccessResult>;
|
|
320
|
+
abstract recordUsage(userId: string, featureKey: string): Promise<void>;
|
|
321
|
+
}
|
|
322
|
+
```
|
|
323
|
+
|
|
324
|
+
### IFeatureAccessResult
|
|
325
|
+
|
|
326
|
+
| Field | Type | Description |
|
|
327
|
+
| ----------- | --------- | ---------------------------------------- |
|
|
328
|
+
| `allowed` | `boolean` | Whether the user can use the feature |
|
|
329
|
+
| `used` | `number` | Current usage count in the active period |
|
|
330
|
+
| `limit` | `number` | Maximum allowed (`-1` = unlimited) |
|
|
331
|
+
| `remaining` | `number` | Remaining quota (`-1` = unlimited) |
|
|
332
|
+
| `resetAt` | `Date` | When the usage period resets |
|
|
333
|
+
|
|
334
|
+
### Real-World Adapter: Prisma + Subscription
|
|
335
|
+
|
|
336
|
+
```typescript
|
|
337
|
+
@Injectable()
|
|
338
|
+
export class PrismaFeatureAccessAdapter extends FeatureAccessPort {
|
|
339
|
+
private readonly _prisma: PrismaService;
|
|
340
|
+
|
|
341
|
+
constructor(prisma: PrismaService) {
|
|
342
|
+
super();
|
|
343
|
+
this._prisma = prisma;
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
public async checkAccess(userId: string, featureKey: string): Promise<IFeatureAccessResult> {
|
|
347
|
+
const subscription = await this._prisma.subscription.findFirst({
|
|
348
|
+
where: { userId, status: 'active' },
|
|
349
|
+
include: { plan: { include: { features: true } } },
|
|
350
|
+
});
|
|
351
|
+
|
|
352
|
+
const feature = subscription?.plan.features.find((f) => f.key === featureKey);
|
|
353
|
+
if (!feature) {
|
|
354
|
+
return { allowed: false, used: 0, limit: 0, remaining: 0, resetAt: new Date() };
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
const periodStart = this.getCurrentPeriodStart(subscription.currentPeriodStart);
|
|
358
|
+
const usage = await this._prisma.featureUsage.count({
|
|
359
|
+
where: {
|
|
360
|
+
userId,
|
|
361
|
+
featureKey,
|
|
362
|
+
createdAt: { gte: periodStart },
|
|
363
|
+
},
|
|
364
|
+
});
|
|
365
|
+
|
|
366
|
+
const limit = feature.limit;
|
|
367
|
+
const remaining = limit === -1 ? -1 : Math.max(0, limit - usage);
|
|
368
|
+
|
|
369
|
+
return {
|
|
370
|
+
allowed: limit === -1 || usage < limit,
|
|
371
|
+
used: usage,
|
|
372
|
+
limit,
|
|
373
|
+
remaining,
|
|
374
|
+
resetAt: subscription.currentPeriodEnd,
|
|
375
|
+
};
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
public async recordUsage(userId: string, featureKey: string): Promise<void> {
|
|
379
|
+
const access = await this.checkAccess(userId, featureKey);
|
|
380
|
+
if (!access.allowed) {
|
|
381
|
+
throw new Error(`Feature quota exceeded for ${featureKey}`);
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
await this._prisma.featureUsage.create({
|
|
385
|
+
data: { userId, featureKey },
|
|
386
|
+
});
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
private getCurrentPeriodStart(periodStart: Date): Date {
|
|
390
|
+
return periodStart;
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
```
|
|
394
|
+
|
|
395
|
+
---
|
|
396
|
+
|
|
397
|
+
## Feature Gating
|
|
398
|
+
|
|
399
|
+
### @RequiresFeature Decorator
|
|
400
|
+
|
|
401
|
+
Mark controller endpoints with a feature key:
|
|
402
|
+
|
|
403
|
+
```typescript
|
|
404
|
+
import { RequiresFeature } from '@breadstone/archipel-platform-payments';
|
|
405
|
+
|
|
406
|
+
@Controller('recipes')
|
|
407
|
+
export class RecipeController {
|
|
408
|
+
@Post()
|
|
409
|
+
@RequiresFeature('RECIPE_CREATION')
|
|
410
|
+
public async createRecipe(@Body() body: CreateRecipeDto): Promise<RecipeResponse> {
|
|
411
|
+
// Only executed if user has quota for RECIPE_CREATION
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### FeatureGuard
|
|
417
|
+
|
|
418
|
+
Checks the `@RequiresFeature` metadata against `FeatureAccessPort.checkAccess()`. Apply it globally or per-controller:
|
|
419
|
+
|
|
420
|
+
```typescript
|
|
421
|
+
// Global registration
|
|
422
|
+
app.useGlobalGuards(app.get(FeatureGuard));
|
|
423
|
+
|
|
424
|
+
// Per-controller
|
|
425
|
+
@Controller('recipes')
|
|
426
|
+
@UseGuards(JwtAuthGuard, FeatureGuard)
|
|
427
|
+
export class RecipeController {
|
|
428
|
+
/* ... */
|
|
429
|
+
}
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
The guard attaches the `IFeatureAccessResult` to the request as `request.featureAccess`, enabling downstream access to quota information.
|
|
433
|
+
|
|
434
|
+
### FeatureUsageInterceptor
|
|
435
|
+
|
|
436
|
+
Records feature usage after successful request completion:
|
|
437
|
+
|
|
438
|
+
```typescript
|
|
439
|
+
@Controller('recipes')
|
|
440
|
+
@UseGuards(JwtAuthGuard, FeatureGuard)
|
|
441
|
+
@UseInterceptors(FeatureUsageInterceptor)
|
|
442
|
+
export class RecipeController {
|
|
443
|
+
@Post()
|
|
444
|
+
@RequiresFeature('RECIPE_CREATION')
|
|
445
|
+
public async createRecipe(@Body() body: CreateRecipeDto): Promise<RecipeResponse> {
|
|
446
|
+
// After successful response, FeatureUsageInterceptor calls
|
|
447
|
+
// FeatureAccessPort.recordUsage(userId, 'RECIPE_CREATION')
|
|
448
|
+
}
|
|
449
|
+
}
|
|
450
|
+
```
|
|
451
|
+
|
|
452
|
+
---
|
|
453
|
+
|
|
454
|
+
## End-to-End Example: Feature-Gated API with Stripe
|
|
455
|
+
|
|
456
|
+
```typescript
|
|
457
|
+
// 1. Define feature keys
|
|
458
|
+
export const FEATURES = {
|
|
459
|
+
RECIPE_CREATION: 'RECIPE_CREATION',
|
|
460
|
+
AI_SUGGESTIONS: 'AI_SUGGESTIONS',
|
|
461
|
+
EXPORT_PDF: 'EXPORT_PDF',
|
|
462
|
+
} as const;
|
|
463
|
+
|
|
464
|
+
// 2. Implement the adapter
|
|
465
|
+
@Injectable()
|
|
466
|
+
export class AppFeatureAccessAdapter extends FeatureAccessPort {
|
|
467
|
+
// ... (see Real-World Adapter above)
|
|
468
|
+
}
|
|
469
|
+
|
|
470
|
+
// 3. Register with Stripe
|
|
471
|
+
import { StripeClient, STRIPE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-payments/stripe';
|
|
472
|
+
|
|
473
|
+
@Module({
|
|
474
|
+
imports: [
|
|
475
|
+
PaymentModule.register({
|
|
476
|
+
paymentClient: StripeClient,
|
|
477
|
+
configEntries: STRIPE_CONFIG_ENTRIES,
|
|
478
|
+
featureAccess: AppFeatureAccessAdapter,
|
|
479
|
+
}),
|
|
480
|
+
],
|
|
481
|
+
})
|
|
482
|
+
export class AppModule {}
|
|
483
|
+
|
|
484
|
+
// 4. Use in controllers
|
|
485
|
+
@Controller('recipes')
|
|
486
|
+
@UseGuards(JwtAuthGuard, FeatureGuard)
|
|
487
|
+
@UseInterceptors(FeatureUsageInterceptor)
|
|
488
|
+
export class RecipeController {
|
|
489
|
+
constructor(private readonly _paymentClient: PaymentClientPort) {}
|
|
490
|
+
|
|
491
|
+
@Post()
|
|
492
|
+
@RequiresFeature(FEATURES.RECIPE_CREATION)
|
|
493
|
+
public async create(@Body() body: CreateRecipeDto): Promise<RecipeResponse> {
|
|
494
|
+
return this._recipeService.create(body);
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
@Post(':id/ai-suggestions')
|
|
498
|
+
@RequiresFeature(FEATURES.AI_SUGGESTIONS)
|
|
499
|
+
public async suggest(@Param('id') id: string): Promise<SuggestionResponse> {
|
|
500
|
+
return this._aiService.suggest(id);
|
|
501
|
+
}
|
|
502
|
+
}
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
---
|
|
506
|
+
|
|
507
|
+
## Exports Summary
|
|
508
|
+
|
|
509
|
+
### Core (`@breadstone/archipel-platform-payments`)
|
|
510
|
+
|
|
511
|
+
| Export | Type | Description |
|
|
512
|
+
| ---------------------------- | ------------- | ----------------------------------- |
|
|
513
|
+
| `PaymentModule` | NestJS Module | Main module with `register()` |
|
|
514
|
+
| `PaymentClientPort` | Abstract Port | Provider-agnostic payment contract |
|
|
515
|
+
| `FeatureAccessPort` | Abstract Port | Feature quota checking |
|
|
516
|
+
| `IFeatureAccessResult` | Interface | Quota check result |
|
|
517
|
+
| `FeatureGuard` | Guard | Enforces `@RequiresFeature` |
|
|
518
|
+
| `FeatureUsageInterceptor` | Interceptor | Records feature usage |
|
|
519
|
+
| `RequiresFeature` | Decorator | Marks feature-gated endpoints |
|
|
520
|
+
| `FEATURE_KEY_METADATA` | Constant | Metadata key for feature decorators |
|
|
521
|
+
| `INormalizedPrice` | Interface | Normalized price |
|
|
522
|
+
| `INormalizedCheckoutSession` | Interface | Normalized checkout session |
|
|
523
|
+
| `INormalizedSubscription` | Interface | Normalized subscription |
|
|
524
|
+
| `INormalizedWebhookEvent` | Interface | Normalized webhook event |
|
|
525
|
+
| `SubscriptionStatus` | Type Alias | Subscription status union |
|
|
526
|
+
|
|
527
|
+
### Provider subpaths
|
|
528
|
+
|
|
529
|
+
| Subpath | Exports |
|
|
530
|
+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
|
|
531
|
+
| `/stripe` | `StripeClient`, `STRIPE_API_KEY`, `STRIPE_WEBHOOK_SECRET`, `STRIPE_CONFIG_ENTRIES` |
|
|
532
|
+
| `/paddle` | `PaddleClient`, `PADDLE_API_KEY`, `PADDLE_WEBHOOK_SECRET`, `PADDLE_ENVIRONMENT`, `PADDLE_CONFIG_ENTRIES` |
|
|
533
|
+
| `/lemonsqueezy` | `LemonSqueezyClient`, `LEMONSQUEEZY_API_KEY`, `LEMONSQUEEZY_WEBHOOK_SECRET`, `LEMONSQUEEZY_STORE_ID`, `LEMONSQUEEZY_CONFIG_ENTRIES` |
|
|
534
|
+
| `/mollie` | `MollieClient`, `MOLLIE_API_KEY`, `MOLLIE_WEBHOOK_SECRET`, `MOLLIE_CONFIG_ENTRIES` |
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: ReportingContributorRegistry'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: ReportingContributorRegistry
|
|
7
|
+
|
|
8
|
+
Defined in: [core/ReportingContributorRegistry.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L12)
|
|
9
|
+
|
|
10
|
+
Registry responsible for tracking feature-provided reporting contributors.
|
|
11
|
+
|
|
12
|
+
## Constructors
|
|
13
|
+
|
|
14
|
+
### Constructor
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
new ReportingContributorRegistry(): ReportingContributorRegistry;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
#### Returns
|
|
21
|
+
|
|
22
|
+
`ReportingContributorRegistry`
|
|
23
|
+
|
|
24
|
+
## Methods
|
|
25
|
+
|
|
26
|
+
### getContributors()
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
getContributors(): readonly IReportingContributor[];
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [core/ReportingContributorRegistry.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L31)
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
readonly [`IReportingContributor`](Interface.IReportingContributor)[]
|
|
37
|
+
|
|
38
|
+
***
|
|
39
|
+
|
|
40
|
+
### register()
|
|
41
|
+
|
|
42
|
+
```ts
|
|
43
|
+
register(contributor): void;
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Defined in: [core/ReportingContributorRegistry.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/core/ReportingContributorRegistry.ts#L23)
|
|
47
|
+
|
|
48
|
+
#### Parameters
|
|
49
|
+
|
|
50
|
+
| Parameter | Type |
|
|
51
|
+
| ------ | ------ |
|
|
52
|
+
| `contributor` | [`IReportingContributor`](Interface.IReportingContributor) |
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
`void`
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: ReportingDatasetNotFoundError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: ReportingDatasetNotFoundError
|
|
7
|
+
|
|
8
|
+
Defined in: [models/errors/ReportingDatasetNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingDatasetNotFoundError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Error thrown when a dataset definition could not be resolved.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new ReportingDatasetNotFoundError(datasetId): ReportingDatasetNotFoundError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [models/errors/ReportingDatasetNotFoundError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingDatasetNotFoundError.ts#L10)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `datasetId` | `string` |
|
|
31
|
+
|
|
32
|
+
#### Returns
|
|
33
|
+
|
|
34
|
+
`ReportingDatasetNotFoundError`
|
|
35
|
+
|
|
36
|
+
#### Overrides
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
Error.constructor
|
|
40
|
+
```
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: ReportingExecutionError'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: ReportingExecutionError
|
|
7
|
+
|
|
8
|
+
Defined in: [models/errors/ReportingExecutionError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingExecutionError.ts#L6)
|
|
9
|
+
|
|
10
|
+
Error thrown when a reporting query execution fails unexpectedly.
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Error`
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
### Constructor
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
new ReportingExecutionError(datasetId, cause): ReportingExecutionError;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [models/errors/ReportingExecutionError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingExecutionError.ts#L16)
|
|
25
|
+
|
|
26
|
+
#### Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `datasetId` | `string` |
|
|
31
|
+
| `cause` | `unknown` |
|
|
32
|
+
|
|
33
|
+
#### Returns
|
|
34
|
+
|
|
35
|
+
`ReportingExecutionError`
|
|
36
|
+
|
|
37
|
+
#### Overrides
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
Error.constructor
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Properties
|
|
44
|
+
|
|
45
|
+
### cause
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
readonly cause: unknown;
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Defined in: [models/errors/ReportingExecutionError.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingExecutionError.ts#L10)
|
|
52
|
+
|
|
53
|
+
#### Overrides
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
Error.cause
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### datasetId
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
readonly datasetId: string;
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Defined in: [models/errors/ReportingExecutionError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-reporting/src/models/errors/ReportingExecutionError.ts#L9)
|