@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,80 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: INormalizedPrice'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: INormalizedPrice
|
|
7
|
+
|
|
8
|
+
Defined in: [models/INormalizedPrice.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L6)
|
|
9
|
+
|
|
10
|
+
Normalized price information.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### active
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly active: boolean;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [models/INormalizedPrice.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L13)
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### amount
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly amount: number;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: [models/INormalizedPrice.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L9)
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### currency
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly currency: string;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: [models/INormalizedPrice.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L10)
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### id
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly id: string;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [models/INormalizedPrice.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L7)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### interval
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
readonly interval: "week" | "month" | "quarter" | "year" | null;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [models/INormalizedPrice.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L11)
|
|
61
|
+
|
|
62
|
+
***
|
|
63
|
+
|
|
64
|
+
### intervalCount
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
readonly intervalCount: number;
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Defined in: [models/INormalizedPrice.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L12)
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### productId
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
readonly productId: string;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [models/INormalizedPrice.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedPrice.ts#L8)
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: INormalizedSubscription'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: INormalizedSubscription
|
|
7
|
+
|
|
8
|
+
Defined in: [models/INormalizedSubscription.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L12)
|
|
9
|
+
|
|
10
|
+
Normalized subscription.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### cancelAtPeriodEnd
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly cancelAtPeriodEnd: boolean;
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [models/INormalizedSubscription.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L19)
|
|
21
|
+
|
|
22
|
+
***
|
|
23
|
+
|
|
24
|
+
### currentPeriodEnd
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
readonly currentPeriodEnd: Date;
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Defined in: [models/INormalizedSubscription.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L18)
|
|
31
|
+
|
|
32
|
+
***
|
|
33
|
+
|
|
34
|
+
### currentPeriodStart
|
|
35
|
+
|
|
36
|
+
```ts
|
|
37
|
+
readonly currentPeriodStart: Date;
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Defined in: [models/INormalizedSubscription.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L17)
|
|
41
|
+
|
|
42
|
+
***
|
|
43
|
+
|
|
44
|
+
### customerId
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly customerId: string;
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [models/INormalizedSubscription.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L14)
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### id
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
readonly id: string;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [models/INormalizedSubscription.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L13)
|
|
61
|
+
|
|
62
|
+
***
|
|
63
|
+
|
|
64
|
+
### priceId
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
readonly priceId: string;
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Defined in: [models/INormalizedSubscription.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L16)
|
|
71
|
+
|
|
72
|
+
***
|
|
73
|
+
|
|
74
|
+
### status
|
|
75
|
+
|
|
76
|
+
```ts
|
|
77
|
+
readonly status: SubscriptionStatus;
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Defined in: [models/INormalizedSubscription.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L15)
|
|
81
|
+
|
|
82
|
+
***
|
|
83
|
+
|
|
84
|
+
### trialEnd
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
readonly trialEnd: Date | null;
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Defined in: [models/INormalizedSubscription.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L21)
|
|
91
|
+
|
|
92
|
+
***
|
|
93
|
+
|
|
94
|
+
### trialStart
|
|
95
|
+
|
|
96
|
+
```ts
|
|
97
|
+
readonly trialStart: Date | null;
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Defined in: [models/INormalizedSubscription.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedSubscription.ts#L20)
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: INormalizedWebhookEvent'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: INormalizedWebhookEvent
|
|
7
|
+
|
|
8
|
+
Defined in: [models/INormalizedWebhookEvent.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L13)
|
|
9
|
+
|
|
10
|
+
Normalized webhook event.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### data
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
readonly data: {
|
|
18
|
+
checkoutSession?: INormalizedCheckoutSession;
|
|
19
|
+
invoice?: {
|
|
20
|
+
id: string;
|
|
21
|
+
status: "paid" | "draft" | "open" | "uncollectible" | "void";
|
|
22
|
+
subscriptionId: string | null;
|
|
23
|
+
};
|
|
24
|
+
subscription?: INormalizedSubscription;
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Defined in: [models/INormalizedWebhookEvent.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L21)
|
|
29
|
+
|
|
30
|
+
#### checkoutSession?
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
readonly optional checkoutSession?: INormalizedCheckoutSession;
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
#### invoice?
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
readonly optional invoice?: {
|
|
40
|
+
id: string;
|
|
41
|
+
status: "paid" | "draft" | "open" | "uncollectible" | "void";
|
|
42
|
+
subscriptionId: string | null;
|
|
43
|
+
};
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
##### invoice.id
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
readonly id: string;
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
##### invoice.status
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
readonly status: "paid" | "draft" | "open" | "uncollectible" | "void";
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
##### invoice.subscriptionId
|
|
59
|
+
|
|
60
|
+
```ts
|
|
61
|
+
readonly subscriptionId: string | null;
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
#### subscription?
|
|
65
|
+
|
|
66
|
+
```ts
|
|
67
|
+
readonly optional subscription?: INormalizedSubscription;
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
***
|
|
71
|
+
|
|
72
|
+
### type
|
|
73
|
+
|
|
74
|
+
```ts
|
|
75
|
+
readonly type:
|
|
76
|
+
| "checkout.session.completed"
|
|
77
|
+
| "subscription.updated"
|
|
78
|
+
| "subscription.deleted"
|
|
79
|
+
| "invoice.payment_failed"
|
|
80
|
+
| "invoice.payment_succeeded"
|
|
81
|
+
| "unknown";
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Defined in: [models/INormalizedWebhookEvent.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/INormalizedWebhookEvent.ts#L14)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IPaymentModuleOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IPaymentModuleOptions
|
|
7
|
+
|
|
8
|
+
Defined in: [PaymentModule.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L19)
|
|
9
|
+
|
|
10
|
+
Configuration options for the `PaymentModule`.
|
|
11
|
+
|
|
12
|
+
## Properties
|
|
13
|
+
|
|
14
|
+
### configEntries?
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [PaymentModule.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L29)
|
|
21
|
+
|
|
22
|
+
Provider-specific configuration entries to register with the config module.
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### featureAccess?
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
optional featureAccess?: Type<FeatureAccessPort>;
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Defined in: [PaymentModule.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L35)
|
|
33
|
+
|
|
34
|
+
Concrete implementation of the [FeatureAccessPort](Class.FeatureAccessPort).
|
|
35
|
+
Required when using `FeatureGuard` or `FeatureUsageInterceptor`.
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
39
|
+
### isGlobal?
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
optional isGlobal?: boolean;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [PaymentModule.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L40)
|
|
46
|
+
|
|
47
|
+
When `true` the module is registered globally.
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### paymentClient
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
paymentClient: Type<PaymentClientPort>;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Defined in: [PaymentModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/PaymentModule.ts#L24)
|
|
58
|
+
|
|
59
|
+
Concrete implementation of the [PaymentClientPort](Class.PaymentClientPort).
|
|
60
|
+
For example, `StripeClient`, `PaddleClient`, `LemonSqueezyClient`, or `MollieClient`.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: SubscriptionStatus'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: SubscriptionStatus
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type SubscriptionStatus =
|
|
10
|
+
| "active"
|
|
11
|
+
| "canceled"
|
|
12
|
+
| "incomplete"
|
|
13
|
+
| "incompleteExpired"
|
|
14
|
+
| "pastDue"
|
|
15
|
+
| "trialing"
|
|
16
|
+
| "unpaid"
|
|
17
|
+
| "paused";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
Defined in: [models/SubscriptionStatus.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/models/SubscriptionStatus.ts#L6)
|
|
21
|
+
|
|
22
|
+
Normalized subscription status values.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: FEATURE\_KEY\_METADATA'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: FEATURE\_KEY\_METADATA
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const FEATURE_KEY_METADATA: "feature_key" = 'feature_key';
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [guards/FeatureGuard.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L9)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: LEMONSQUEEZY\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: LEMONSQUEEZY\_API\_KEY
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const LEMONSQUEEZY_API_KEY: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [lemonsqueezy/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L12)
|
|
13
|
+
|
|
14
|
+
LemonSqueezy API key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: LEMONSQUEEZY\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: LEMONSQUEEZY\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const LEMONSQUEEZY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [lemonsqueezy/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L25)
|
|
13
|
+
|
|
14
|
+
Configuration entries required by the LemonSqueezy payment provider.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: LEMONSQUEEZY\_STORE\_ID'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: LEMONSQUEEZY\_STORE\_ID
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const LEMONSQUEEZY_STORE_ID: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [lemonsqueezy/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L18)
|
|
13
|
+
|
|
14
|
+
LemonSqueezy store ID.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: LEMONSQUEEZY\_WEBHOOK\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: LEMONSQUEEZY\_WEBHOOK\_SECRET
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const LEMONSQUEEZY_WEBHOOK_SECRET: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [lemonsqueezy/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/env.ts#L15)
|
|
13
|
+
|
|
14
|
+
LemonSqueezy webhook signing secret.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MOLLIE\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: MOLLIE\_API\_KEY
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const MOLLIE_API_KEY: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [mollie/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L12)
|
|
13
|
+
|
|
14
|
+
Mollie API key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MOLLIE\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: MOLLIE\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const MOLLIE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [mollie/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L22)
|
|
13
|
+
|
|
14
|
+
Configuration entries required by the Mollie payment provider.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: MOLLIE\_WEBHOOK\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: MOLLIE\_WEBHOOK\_SECRET
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const MOLLIE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [mollie/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/mollie/env.ts#L15)
|
|
13
|
+
|
|
14
|
+
Mollie webhook secret for verifying webhook payloads.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PADDLE\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: PADDLE\_API\_KEY
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const PADDLE_API_KEY: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [paddle/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L12)
|
|
13
|
+
|
|
14
|
+
Paddle API key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PADDLE\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: PADDLE\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const PADDLE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [paddle/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L25)
|
|
13
|
+
|
|
14
|
+
Configuration entries required by the Paddle payment provider.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PADDLE\_ENVIRONMENT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: PADDLE\_ENVIRONMENT
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const PADDLE_ENVIRONMENT: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [paddle/env.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L18)
|
|
13
|
+
|
|
14
|
+
Paddle environment (`production` or `sandbox`). Defaults to `production`.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: PADDLE\_WEBHOOK\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: PADDLE\_WEBHOOK\_SECRET
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const PADDLE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [paddle/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/paddle/env.ts#L15)
|
|
13
|
+
|
|
14
|
+
Paddle webhook secret key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: STRIPE\_API\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: STRIPE\_API\_KEY
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const STRIPE_API_KEY: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [stripe/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L12)
|
|
13
|
+
|
|
14
|
+
Stripe secret API key.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: STRIPE\_CONFIG\_ENTRIES'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: STRIPE\_CONFIG\_ENTRIES
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const STRIPE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [stripe/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L22)
|
|
13
|
+
|
|
14
|
+
Configuration entries required by the Stripe payment provider.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: STRIPE\_WEBHOOK\_SECRET'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Variable: STRIPE\_WEBHOOK\_SECRET
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
const STRIPE_WEBHOOK_SECRET: IConfigKey<string>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [stripe/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/stripe/env.ts#L15)
|
|
13
|
+
|
|
14
|
+
Stripe webhook signing secret.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: '@breadstone/archipel-platform-payments'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# @breadstone/archipel-platform-payments
|
|
7
|
+
|
|
8
|
+
## Classes
|
|
9
|
+
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [FeatureAccessPort](Class.FeatureAccessPort) | Abstract port for checking and recording feature usage. Consuming projects must provide a concrete implementation (e.g. backed by Prisma with subscription + usage tables) and register it via `PaymentModule.register()`. |
|
|
13
|
+
| [FeatureGuard](Class.FeatureGuard) | Guard that checks if the user has access to a specific feature by delegating to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
|
|
14
|
+
| [FeatureUsageInterceptor](Class.FeatureUsageInterceptor) | Interceptor that records feature usage after successful request handling. Delegates recording to the registered [FeatureAccessPort](Class.FeatureAccessPort). |
|
|
15
|
+
| [LemonSqueezyClient](Class.LemonSqueezyClient) | LemonSqueezy implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@lemonsqueezy/lemonsqueezy.js` SDK. |
|
|
16
|
+
| [MollieClient](Class.MollieClient) | Mollie implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@mollie/api-client` to interact with the Mollie API. |
|
|
17
|
+
| [PaddleClient](Class.PaddleClient) | Paddle implementation of the [PaymentClientPort](Class.PaymentClientPort). Uses the official `@paddle/paddle-node-sdk` to interact with the Paddle Billing API. |
|
|
18
|
+
| [PaymentClientPort](Class.PaymentClientPort) | Abstract port for payment provider clients. Each provider (Stripe, Paddle, LemonSqueezy, Mollie) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
19
|
+
| [PaymentModule](Class.PaymentModule) | NestJS module providing generic payment infrastructure. Exposes a configurable payment client, a feature-gating guard, and a usage-tracking interceptor. The specific payment provider (Stripe, Paddle, LemonSqueezy, Mollie) is selected via the options. |
|
|
20
|
+
| [StripeClient](Class.StripeClient) | Stripe implementation of the [PaymentClientPort](Class.PaymentClientPort). All Stripe-specific types and logic are encapsulated here. |
|
|
21
|
+
|
|
22
|
+
## Interfaces
|
|
23
|
+
|
|
24
|
+
| Interface | Description |
|
|
25
|
+
| ------ | ------ |
|
|
26
|
+
| [IFeatureAccessResult](Interface.IFeatureAccessResult) | Result of a feature access check. |
|
|
27
|
+
| [INormalizedCheckoutSession](Interface.INormalizedCheckoutSession) | Normalized checkout session. |
|
|
28
|
+
| [INormalizedPrice](Interface.INormalizedPrice) | Normalized price information. |
|
|
29
|
+
| [INormalizedSubscription](Interface.INormalizedSubscription) | Normalized subscription. |
|
|
30
|
+
| [INormalizedWebhookEvent](Interface.INormalizedWebhookEvent) | Normalized webhook event. |
|
|
31
|
+
| [IPaymentModuleOptions](Interface.IPaymentModuleOptions) | Configuration options for the `PaymentModule`. |
|
|
32
|
+
|
|
33
|
+
## Type Aliases
|
|
34
|
+
|
|
35
|
+
| Type Alias | Description |
|
|
36
|
+
| ------ | ------ |
|
|
37
|
+
| [SubscriptionStatus](TypeAlias.SubscriptionStatus) | Normalized subscription status values. |
|
|
38
|
+
|
|
39
|
+
## Variables
|
|
40
|
+
|
|
41
|
+
| Variable | Description |
|
|
42
|
+
| ------ | ------ |
|
|
43
|
+
| [FEATURE\_KEY\_METADATA](Variable.FEATURE_KEY_METADATA) | - |
|
|
44
|
+
| [LEMONSQUEEZY\_API\_KEY](Variable.LEMONSQUEEZY_API_KEY) | LemonSqueezy API key. |
|
|
45
|
+
| [LEMONSQUEEZY\_CONFIG\_ENTRIES](Variable.LEMONSQUEEZY_CONFIG_ENTRIES) | Configuration entries required by the LemonSqueezy payment provider. |
|
|
46
|
+
| [LEMONSQUEEZY\_STORE\_ID](Variable.LEMONSQUEEZY_STORE_ID) | LemonSqueezy store ID. |
|
|
47
|
+
| [LEMONSQUEEZY\_WEBHOOK\_SECRET](Variable.LEMONSQUEEZY_WEBHOOK_SECRET) | LemonSqueezy webhook signing secret. |
|
|
48
|
+
| [MOLLIE\_API\_KEY](Variable.MOLLIE_API_KEY) | Mollie API key. |
|
|
49
|
+
| [MOLLIE\_CONFIG\_ENTRIES](Variable.MOLLIE_CONFIG_ENTRIES) | Configuration entries required by the Mollie payment provider. |
|
|
50
|
+
| [MOLLIE\_WEBHOOK\_SECRET](Variable.MOLLIE_WEBHOOK_SECRET) | Mollie webhook secret for verifying webhook payloads. |
|
|
51
|
+
| [PADDLE\_API\_KEY](Variable.PADDLE_API_KEY) | Paddle API key. |
|
|
52
|
+
| [PADDLE\_CONFIG\_ENTRIES](Variable.PADDLE_CONFIG_ENTRIES) | Configuration entries required by the Paddle payment provider. |
|
|
53
|
+
| [PADDLE\_ENVIRONMENT](Variable.PADDLE_ENVIRONMENT) | Paddle environment (`production` or `sandbox`). Defaults to `production`. |
|
|
54
|
+
| [PADDLE\_WEBHOOK\_SECRET](Variable.PADDLE_WEBHOOK_SECRET) | Paddle webhook secret key. |
|
|
55
|
+
| [STRIPE\_API\_KEY](Variable.STRIPE_API_KEY) | Stripe secret API key. |
|
|
56
|
+
| [STRIPE\_CONFIG\_ENTRIES](Variable.STRIPE_CONFIG_ENTRIES) | Configuration entries required by the Stripe payment provider. |
|
|
57
|
+
| [STRIPE\_WEBHOOK\_SECRET](Variable.STRIPE_WEBHOOK_SECRET) | Stripe webhook signing secret. |
|
|
58
|
+
|
|
59
|
+
## Functions
|
|
60
|
+
|
|
61
|
+
| Function | Description |
|
|
62
|
+
| ------ | ------ |
|
|
63
|
+
| [RequiresFeature](Function.RequiresFeature) | Decorator to mark endpoints that require feature access check. The `featureKey` is a free-form string defined by the consuming project. |
|