@breadstone/archipel-mcp 0.0.9 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/ai-text-generation.md +361 -0
- package/data/guides/analytics-and-error-tracking.md +189 -0
- package/data/guides/authentication-and-authorization.md +657 -0
- package/data/guides/blob-storage.md +242 -0
- package/data/guides/caching.md +255 -0
- package/data/guides/cryptography-and-otp.md +240 -0
- package/data/guides/document-generation.md +174 -0
- package/data/guides/email-delivery.md +196 -0
- package/data/guides/esigning-integration.md +231 -0
- package/data/guides/getting-started.md +351 -0
- package/data/guides/implementing-ports.md +317 -0
- package/data/guides/index.md +61 -0
- package/data/guides/mcp-server.md +222 -0
- package/data/guides/openapi-and-feature-discovery.md +266 -0
- package/data/guides/payments-and-feature-gating.md +244 -0
- package/data/guides/resource-management.md +352 -0
- package/data/guides/telemetry-and-observability.md +190 -0
- package/data/guides/testing.md +319 -0
- package/data/guides/tsdoc-guidelines.md +45 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
- package/data/packages/platform-analytics/api/index.md +25 -26
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +19 -20
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -27
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.MfaService.md +54 -55
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +17 -18
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +27 -28
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -30
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
- package/data/packages/platform-authentication/api/Function.Token.md +0 -1
- package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +20 -21
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -11
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +1 -2
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -95
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -3
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/index.md +41 -42
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +37 -38
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +39 -40
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +4 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +4 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +15 -16
- package/data/packages/platform-caching/api/index.md +12 -13
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
- package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
- package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
- package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +18 -19
- package/data/packages/platform-core/api/Class.EventHub.md +25 -26
- package/data/packages/platform-core/api/Class.EventModule.md +0 -1
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
- package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
- package/data/packages/platform-core/api/Class.HostModule.md +0 -2
- package/data/packages/platform-core/api/Class.HostService.md +21 -22
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
- package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
- package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
- package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
- package/data/packages/platform-core/api/Class.MappingService.md +52 -53
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
- package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
- package/data/packages/platform-core/api/Class.SseHub.md +23 -24
- package/data/packages/platform-core/api/Class.SseModule.md +3 -4
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Function.Public.md +0 -1
- package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
- package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
- package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
- package/data/packages/platform-core/api/Function.env.md +4 -5
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
- package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +19 -20
- package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +17 -18
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
- package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
- package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
- package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
- package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
- package/data/packages/platform-core/api/Variable.APP_NAME.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +1 -2
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -2
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
- package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
- package/data/packages/platform-core/api/Variable.Lang.md +5 -6
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -2
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -116
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +7 -8
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -4
- package/data/packages/platform-cryptography/api/Class.OtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +7 -8
- package/data/packages/platform-cryptography/api/index.md +11 -12
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
- package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
- package/data/packages/platform-database/api/Function.pageable.md +13 -10
- package/data/packages/platform-database/api/Function.paginator.md +2 -3
- package/data/packages/platform-database/api/Function.query.md +7 -8
- package/data/packages/platform-database/api/Function.skip.md +5 -6
- package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
- package/data/packages/platform-database/api/index.md +27 -28
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/index.md +28 -29
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
- package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
- package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
- package/data/packages/platform-esigning/api/index.md +65 -66
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +4 -5
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
- package/data/packages/platform-intelligence/api/index.md +46 -47
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-logging/api/index.md +7 -8
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailService.md +27 -28
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -15
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
- package/data/packages/platform-mailing/api/index.md +54 -55
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
- package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-mcp/api/index.md +26 -27
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +15 -12
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
- package/data/packages/platform-openapi/api/Function.Api.md +13 -14
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +4 -5
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
- package/data/packages/platform-openapi/api/index.md +24 -25
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -25
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
- package/data/packages/platform-payments/api/Class.StripeClient.md +28 -29
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/index.md +40 -41
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
- package/data/packages/platform-reporting/api/index.md +23 -24
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
- package/data/packages/platform-telemetry/api/index.md +20 -21
- package/package.json +1 -1
- package/src/GuidesLoader.d.ts +13 -0
- package/src/GuidesLoader.js +81 -0
- package/src/main.js +36 -198
- package/src/models/IGuideDoc.d.ts +15 -0
- package/src/models/IGuideDoc.js +3 -0
- package/src/tools/registerGetConfigPatternTool.d.ts +5 -0
- package/src/tools/registerGetConfigPatternTool.js +15 -0
- package/src/tools/registerGetDtoPatternTool.d.ts +5 -0
- package/src/tools/registerGetDtoPatternTool.js +15 -0
- package/src/tools/registerGetErrorHandlingPatternTool.d.ts +5 -0
- package/src/tools/registerGetErrorHandlingPatternTool.js +15 -0
- package/src/tools/registerGetGuardPatternTool.d.ts +5 -0
- package/src/tools/registerGetGuardPatternTool.js +15 -0
- package/src/tools/registerGetGuideTool.d.ts +6 -0
- package/src/tools/registerGetGuideTool.js +32 -0
- package/src/tools/registerGetMappingPatternTool.d.ts +5 -0
- package/src/tools/registerGetMappingPatternTool.js +34 -0
- package/src/tools/registerGetModulePatternTool.d.ts +5 -0
- package/src/tools/registerGetModulePatternTool.js +29 -0
- package/src/tools/registerGetPackageDocTool.d.ts +6 -0
- package/src/tools/registerGetPackageDocTool.js +43 -0
- package/src/tools/registerGetQueryPatternTool.d.ts +5 -0
- package/src/tools/registerGetQueryPatternTool.js +29 -0
- package/src/tools/registerGetRepositoryPatternTool.d.ts +5 -0
- package/src/tools/registerGetRepositoryPatternTool.js +29 -0
- package/src/tools/registerGetTestingPatternTool.d.ts +5 -0
- package/src/tools/registerGetTestingPatternTool.js +15 -0
- package/src/tools/registerListGuidesTool.d.ts +6 -0
- package/src/tools/registerListGuidesTool.js +22 -0
- package/src/tools/registerListPackagesTool.d.ts +6 -0
- package/src/tools/registerListPackagesTool.js +20 -0
- package/src/tools/registerSearchDocsTool.d.ts +6 -0
- package/src/tools/registerSearchDocsTool.js +35 -0
- package/src/tools/registerSearchGuidesTool.d.ts +6 -0
- package/src/tools/registerSearchGuidesTool.js +28 -0
|
@@ -3,7 +3,6 @@ title: 'Function: Api()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: Api()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
@@ -17,19 +16,19 @@ This decorator wraps all necessary Swagger decorators into one.
|
|
|
17
16
|
|
|
18
17
|
## Parameters
|
|
19
18
|
|
|
20
|
-
| Parameter
|
|
21
|
-
|
|
|
22
|
-
| `options`
|
|
23
|
-
| `options.auth?`
|
|
24
|
-
| `options.body?`
|
|
25
|
-
| `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\>
|
|
26
|
-
| `options.headers?`
|
|
27
|
-
| `options.operation?`
|
|
28
|
-
| `options.params?`
|
|
29
|
-
| `options.query?`
|
|
30
|
-
| `options.responses?`
|
|
31
|
-
| `options.scopes?`
|
|
32
|
-
| `options.tags?`
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| ------ | ------ | ------ |
|
|
21
|
+
| `options` | \{ `auth?`: `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"`; `body?`: `ApiBodyOptions`; `extensions?`: `Record`\<`string`, `string` \| `number` \| `boolean`\>; `headers?`: `ApiHeaderOptions`[]; `operation?`: `Partial`\<`OperationObject`\>; `params?`: `ApiParamOptions` \| `ApiParamOptions`[]; `query?`: `ApiQueryOptions` \| `ApiQueryOptions`[]; `responses?`: `ApiResponseOptions` \| `ApiResponseOptions`[]; `scopes?`: `string`[]; `tags?`: `string` \| `string`[]; \} | Configuration for the Swagger decorators. |
|
|
22
|
+
| `options.auth?` | `"bearer"` \| `"basic"` \| `"oauth2"` \| `"cookie"` | - |
|
|
23
|
+
| `options.body?` | `ApiBodyOptions` | Options for the ApiBody decorator. |
|
|
24
|
+
| `options.extensions?` | `Record`\<`string`, `string` \| `number` \| `boolean`\> | - |
|
|
25
|
+
| `options.headers?` | `ApiHeaderOptions`[] | Options for the ApiHeaders decorator. |
|
|
26
|
+
| `options.operation?` | `Partial`\<`OperationObject`\> | Options for the ApiOperation decorator. |
|
|
27
|
+
| `options.params?` | `ApiParamOptions` \| `ApiParamOptions`[] | Options for the ApiParam decorator. |
|
|
28
|
+
| `options.query?` | `ApiQueryOptions` \| `ApiQueryOptions`[] | Options for the ApiQuery decorator (can be an array or single query). |
|
|
29
|
+
| `options.responses?` | `ApiResponseOptions` \| `ApiResponseOptions`[] | - |
|
|
30
|
+
| `options.scopes?` | `string`[] | - |
|
|
31
|
+
| `options.tags?` | `string` \| `string`[] | Options for the ApiTags decorator (can be an array or single tag). |
|
|
33
32
|
|
|
34
33
|
## Returns
|
|
35
34
|
|
|
@@ -3,7 +3,6 @@ title: 'Function: SwaggerFeature()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: SwaggerFeature()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
@@ -17,8 +16,8 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
|
|
|
17
16
|
|
|
18
17
|
## Parameters
|
|
19
18
|
|
|
20
|
-
| Parameter
|
|
21
|
-
|
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| ------ | ------ | ------ |
|
|
22
21
|
| `metadata` | [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata) | The feature configuration for Swagger documentation |
|
|
23
22
|
|
|
24
23
|
## Returns
|
|
@@ -32,12 +31,12 @@ This allows the SwaggerMultiDocumentService to automatically discover and create
|
|
|
32
31
|
name: 'tip',
|
|
33
32
|
title: 'My App API - Tips',
|
|
34
33
|
description: 'API endpoints for tip management',
|
|
35
|
-
tag: 'Tip'
|
|
34
|
+
tag: 'Tip'
|
|
36
35
|
})
|
|
37
36
|
@Module({
|
|
38
37
|
controllers: [TipController],
|
|
39
38
|
providers: [TipService],
|
|
40
|
-
exports: [TipService]
|
|
39
|
+
exports: [TipService]
|
|
41
40
|
})
|
|
42
41
|
export class TipModule {}
|
|
43
42
|
```
|
|
@@ -3,11 +3,12 @@ title: 'Function: getSwaggerFeatureMetadata()'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Function: getSwaggerFeatureMetadata()
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
function getSwaggerFeatureMetadata(target):
|
|
9
|
+
function getSwaggerFeatureMetadata(target):
|
|
10
|
+
| ISwaggerFeatureMetadata
|
|
11
|
+
| undefined;
|
|
11
12
|
```
|
|
12
13
|
|
|
13
14
|
Defined in: [decorators/SwaggerFeature.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L115)
|
|
@@ -16,11 +17,11 @@ Get the Swagger feature metadata from a module class
|
|
|
16
17
|
|
|
17
18
|
## Parameters
|
|
18
19
|
|
|
19
|
-
| Parameter | Type
|
|
20
|
-
|
|
|
21
|
-
| `target`
|
|
20
|
+
| Parameter | Type |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `target` | `any` |
|
|
22
23
|
|
|
23
24
|
## Returns
|
|
24
25
|
|
|
25
|
-
\| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
|
|
26
|
-
\| `undefined`
|
|
26
|
+
\| [`ISwaggerFeatureMetadata`](Interface.ISwaggerFeatureMetadata)
|
|
27
|
+
\| `undefined`
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IFeatureSwaggerConfig'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IFeatureSwaggerConfig
|
|
8
7
|
|
|
9
8
|
Defined in: [registry/IFeatureSwaggerConfig.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L1)
|
|
@@ -18,7 +17,7 @@ readonly description: string;
|
|
|
18
17
|
|
|
19
18
|
Defined in: [registry/IFeatureSwaggerConfig.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L4)
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
***
|
|
22
21
|
|
|
23
22
|
### name
|
|
24
23
|
|
|
@@ -28,7 +27,7 @@ readonly name: string;
|
|
|
28
27
|
|
|
29
28
|
Defined in: [registry/IFeatureSwaggerConfig.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L2)
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
***
|
|
32
31
|
|
|
33
32
|
### path
|
|
34
33
|
|
|
@@ -38,7 +37,7 @@ readonly path: string;
|
|
|
38
37
|
|
|
39
38
|
Defined in: [registry/IFeatureSwaggerConfig.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L7)
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
***
|
|
42
41
|
|
|
43
42
|
### tag
|
|
44
43
|
|
|
@@ -48,7 +47,7 @@ readonly tag: string;
|
|
|
48
47
|
|
|
49
48
|
Defined in: [registry/IFeatureSwaggerConfig.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L5)
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
***
|
|
52
51
|
|
|
53
52
|
### tags
|
|
54
53
|
|
|
@@ -58,7 +57,7 @@ readonly tags: string[];
|
|
|
58
57
|
|
|
59
58
|
Defined in: [registry/IFeatureSwaggerConfig.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/registry/IFeatureSwaggerConfig.ts#L6)
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### title
|
|
64
63
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: ISwaggerFeatureMetadata'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: ISwaggerFeatureMetadata
|
|
8
7
|
|
|
9
8
|
Defined in: [decorators/SwaggerFeature.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L18)
|
|
@@ -18,7 +17,7 @@ readonly description: string;
|
|
|
18
17
|
|
|
19
18
|
Defined in: [decorators/SwaggerFeature.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L21)
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
***
|
|
22
21
|
|
|
23
22
|
### name
|
|
24
23
|
|
|
@@ -28,7 +27,7 @@ readonly name: string;
|
|
|
28
27
|
|
|
29
28
|
Defined in: [decorators/SwaggerFeature.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L19)
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
***
|
|
32
31
|
|
|
33
32
|
### path?
|
|
34
33
|
|
|
@@ -38,7 +37,7 @@ readonly optional path?: string;
|
|
|
38
37
|
|
|
39
38
|
Defined in: [decorators/SwaggerFeature.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L24)
|
|
40
39
|
|
|
41
|
-
|
|
40
|
+
***
|
|
42
41
|
|
|
43
42
|
### tag
|
|
44
43
|
|
|
@@ -48,7 +47,7 @@ readonly tag: string;
|
|
|
48
47
|
|
|
49
48
|
Defined in: [decorators/SwaggerFeature.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L22)
|
|
50
49
|
|
|
51
|
-
|
|
50
|
+
***
|
|
52
51
|
|
|
53
52
|
### tags
|
|
54
53
|
|
|
@@ -58,7 +57,7 @@ readonly tags: string[];
|
|
|
58
57
|
|
|
59
58
|
Defined in: [decorators/SwaggerFeature.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L23)
|
|
60
59
|
|
|
61
|
-
|
|
60
|
+
***
|
|
62
61
|
|
|
63
62
|
### title
|
|
64
63
|
|
|
@@ -3,11 +3,10 @@ title: 'Variable: PLATFORM\_OPENAPI\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: PLATFORM_OPENAPI_CONFIG_ENTRIES
|
|
6
|
+
# Variable: PLATFORM\_OPENAPI\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const PLATFORM_OPENAPI_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [env.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/env.ts#L28)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: SWAGGER\_FEATURE\_METADATA\_KEY'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: SWAGGER_FEATURE_METADATA_KEY
|
|
6
|
+
# Variable: SWAGGER\_FEATURE\_METADATA\_KEY
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const SWAGGER_FEATURE_METADATA_KEY:
|
|
9
|
+
const SWAGGER_FEATURE_METADATA_KEY: "swagger:feature" = 'swagger:feature';
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [decorators/SwaggerFeature.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/SwaggerFeature.ts#L9)
|
|
@@ -3,41 +3,40 @@ title: '@breadstone/archipel-platform-openapi'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# @breadstone/archipel-platform-openapi
|
|
8
7
|
|
|
9
8
|
## Classes
|
|
10
9
|
|
|
11
|
-
| Class
|
|
12
|
-
|
|
|
13
|
-
| [SwaggerFeatureDiscovery](Class.SwaggerFeatureDiscovery)
|
|
14
|
-
| [SwaggerFeatureRegistry](Class.SwaggerFeatureRegistry)
|
|
15
|
-
| [SwaggerMultiDocumentService](Class.SwaggerMultiDocumentService) | -
|
|
16
|
-
| [SwaggerTheme](Class.SwaggerTheme)
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [SwaggerFeatureDiscovery](Class.SwaggerFeatureDiscovery) | Centralizes the discovery of Swagger features declared across backend modules. |
|
|
13
|
+
| [SwaggerFeatureRegistry](Class.SwaggerFeatureRegistry) | Registry service for dynamically discovered Swagger features. Collects feature configurations from |
|
|
14
|
+
| [SwaggerMultiDocumentService](Class.SwaggerMultiDocumentService) | - |
|
|
15
|
+
| [SwaggerTheme](Class.SwaggerTheme) | The swagger theme class |
|
|
17
16
|
|
|
18
17
|
## Interfaces
|
|
19
18
|
|
|
20
|
-
| Interface
|
|
21
|
-
|
|
|
22
|
-
| [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig)
|
|
23
|
-
| [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | -
|
|
19
|
+
| Interface | Description |
|
|
20
|
+
| ------ | ------ |
|
|
21
|
+
| [IFeatureSwaggerConfig](Interface.IFeatureSwaggerConfig) | - |
|
|
22
|
+
| [ISwaggerFeatureMetadata](Interface.ISwaggerFeatureMetadata) | - |
|
|
24
23
|
|
|
25
24
|
## Variables
|
|
26
25
|
|
|
27
|
-
| Variable
|
|
28
|
-
|
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
| [
|
|
33
|
-
| [
|
|
34
|
-
| [
|
|
26
|
+
| Variable | Description |
|
|
27
|
+
| ------ | ------ |
|
|
28
|
+
| [APP\_VERSION](Variable.APP_VERSION) | Application version shown in the Swagger document. |
|
|
29
|
+
| [PLATFORM\_OPENAPI\_CONFIG\_ENTRIES](Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES) | All configuration entries required by `platform-openapi`. |
|
|
30
|
+
| [SWAGGER\_CONTACT\_EMAIL](Variable.SWAGGER_CONTACT_EMAIL) | Contact e-mail displayed in the Swagger document. |
|
|
31
|
+
| [SWAGGER\_CONTACT\_NAME](Variable.SWAGGER_CONTACT_NAME) | Contact name displayed in the Swagger document. |
|
|
32
|
+
| [SWAGGER\_CONTACT\_URL](Variable.SWAGGER_CONTACT_URL) | Contact URL displayed in the Swagger document. |
|
|
33
|
+
| [SWAGGER\_FEATURE\_METADATA\_KEY](Variable.SWAGGER_FEATURE_METADATA_KEY) | - |
|
|
35
34
|
|
|
36
35
|
## Functions
|
|
37
36
|
|
|
38
|
-
| Function
|
|
39
|
-
|
|
|
40
|
-
| [Api](Function.Api)
|
|
41
|
-
| [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator.
|
|
42
|
-
| [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata)
|
|
43
|
-
| [SwaggerFeature](Function.SwaggerFeature)
|
|
37
|
+
| Function | Description |
|
|
38
|
+
| ------ | ------ |
|
|
39
|
+
| [Api](Function.Api) | Custom Swagger Decorator This decorator wraps all necessary Swagger decorators into one. |
|
|
40
|
+
| [getRegisteredSwaggerFeatures](Function.getRegisteredSwaggerFeatures) | Retrieves all Swagger features that have been registered through the decorator. |
|
|
41
|
+
| [getSwaggerFeatureMetadata](Function.getSwaggerFeatureMetadata) | Get the Swagger feature metadata from a module class |
|
|
42
|
+
| [SwaggerFeature](Function.SwaggerFeature) | Decorator to register a module as a Swagger feature. This allows the SwaggerMultiDocumentService to automatically discover and create documentation. |
|
|
@@ -3,7 +3,6 @@ title: 'Abstract Class: FeatureAccessPort'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: FeatureAccessPort
|
|
8
7
|
|
|
9
8
|
Defined in: [contracts/FeatureAccessPort.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/contracts/FeatureAccessPort.ts#L14)
|
|
@@ -39,9 +38,9 @@ without incrementing usage.
|
|
|
39
38
|
|
|
40
39
|
#### Parameters
|
|
41
40
|
|
|
42
|
-
| Parameter
|
|
43
|
-
|
|
|
44
|
-
| `userId`
|
|
41
|
+
| Parameter | Type | Description |
|
|
42
|
+
| ------ | ------ | ------ |
|
|
43
|
+
| `userId` | `string` | The user identifier. |
|
|
45
44
|
| `featureKey` | `string` | The feature key to check. |
|
|
46
45
|
|
|
47
46
|
#### Returns
|
|
@@ -50,7 +49,7 @@ without incrementing usage.
|
|
|
50
49
|
|
|
51
50
|
The access check result including quota information.
|
|
52
51
|
|
|
53
|
-
|
|
52
|
+
***
|
|
54
53
|
|
|
55
54
|
### recordUsage()
|
|
56
55
|
|
|
@@ -65,9 +64,9 @@ throw if the quota has been exceeded.
|
|
|
65
64
|
|
|
66
65
|
#### Parameters
|
|
67
66
|
|
|
68
|
-
| Parameter
|
|
69
|
-
|
|
|
70
|
-
| `userId`
|
|
67
|
+
| Parameter | Type | Description |
|
|
68
|
+
| ------ | ------ | ------ |
|
|
69
|
+
| `userId` | `string` | The user identifier. |
|
|
71
70
|
| `featureKey` | `string` | The feature key to record usage for. |
|
|
72
71
|
|
|
73
72
|
#### Returns
|
|
@@ -3,7 +3,6 @@ title: 'Class: FeatureGuard'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: FeatureGuard
|
|
8
7
|
|
|
9
8
|
Defined in: [guards/FeatureGuard.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/guards/FeatureGuard.ts#L26)
|
|
@@ -29,10 +28,10 @@ Constructs a new instance of the `FeatureGuard` class.
|
|
|
29
28
|
|
|
30
29
|
#### Parameters
|
|
31
30
|
|
|
32
|
-
| Parameter
|
|
33
|
-
|
|
|
31
|
+
| Parameter | Type | Description |
|
|
32
|
+
| ------ | ------ | ------ |
|
|
34
33
|
| `featureAccessPort` | [`FeatureAccessPort`](Class.FeatureAccessPort) | The feature access port. |
|
|
35
|
-
| `reflector`
|
|
34
|
+
| `reflector` | `Reflector` | The NestJS reflector. |
|
|
36
35
|
|
|
37
36
|
#### Returns
|
|
38
37
|
|
|
@@ -52,8 +51,8 @@ Determines whether the current user has access to the guarded feature.
|
|
|
52
51
|
|
|
53
52
|
#### Parameters
|
|
54
53
|
|
|
55
|
-
| Parameter | Type
|
|
56
|
-
|
|
|
54
|
+
| Parameter | Type | Description |
|
|
55
|
+
| ------ | ------ | ------ |
|
|
57
56
|
| `context` | `ExecutionContext` | The execution context. |
|
|
58
57
|
|
|
59
58
|
#### Returns
|
|
@@ -65,5 +64,5 @@ Determines whether the current user has access to the guarded feature.
|
|
|
65
64
|
#### Implementation of
|
|
66
65
|
|
|
67
66
|
```ts
|
|
68
|
-
CanActivate.canActivate
|
|
67
|
+
CanActivate.canActivate
|
|
69
68
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Class: FeatureUsageInterceptor'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: FeatureUsageInterceptor
|
|
8
7
|
|
|
9
8
|
Defined in: [interceptors/FeatureUsageInterceptor.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/interceptors/FeatureUsageInterceptor.ts#L19)
|
|
@@ -29,10 +28,10 @@ Constructs a new instance of the `FeatureUsageInterceptor` class.
|
|
|
29
28
|
|
|
30
29
|
#### Parameters
|
|
31
30
|
|
|
32
|
-
| Parameter
|
|
33
|
-
|
|
|
31
|
+
| Parameter | Type | Description |
|
|
32
|
+
| ------ | ------ | ------ |
|
|
34
33
|
| `featureAccessPort` | [`FeatureAccessPort`](Class.FeatureAccessPort) | The feature access port. |
|
|
35
|
-
| `reflector`
|
|
34
|
+
| `reflector` | `Reflector` | The NestJS reflector. |
|
|
36
35
|
|
|
37
36
|
#### Returns
|
|
38
37
|
|
|
@@ -52,10 +51,10 @@ Records feature usage after the request handler completes successfully.
|
|
|
52
51
|
|
|
53
52
|
#### Parameters
|
|
54
53
|
|
|
55
|
-
| Parameter | Type
|
|
56
|
-
|
|
|
54
|
+
| Parameter | Type | Description |
|
|
55
|
+
| ------ | ------ | ------ |
|
|
57
56
|
| `context` | `ExecutionContext` | The execution context. |
|
|
58
|
-
| `next`
|
|
57
|
+
| `next` | `CallHandler` | The call handler. |
|
|
59
58
|
|
|
60
59
|
#### Returns
|
|
61
60
|
|
|
@@ -66,5 +65,5 @@ The observable response stream.
|
|
|
66
65
|
#### Implementation of
|
|
67
66
|
|
|
68
67
|
```ts
|
|
69
|
-
NestInterceptor.intercept
|
|
68
|
+
NestInterceptor.intercept
|
|
70
69
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Class: LemonSqueezyClient'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: LemonSqueezyClient
|
|
8
7
|
|
|
9
8
|
Defined in: [lemonsqueezy/LemonSqueezyClient.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-payments/src/lemonsqueezy/LemonSqueezyClient.ts#L30)
|
|
@@ -27,8 +26,8 @@ Defined in: [lemonsqueezy/LemonSqueezyClient.ts:40](https://github.com/RueDeRenn
|
|
|
27
26
|
|
|
28
27
|
#### Parameters
|
|
29
28
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
32
31
|
| `configService` | `ConfigService` |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -53,10 +52,10 @@ Construct and normalize a webhook event from raw payload.
|
|
|
53
52
|
|
|
54
53
|
#### Parameters
|
|
55
54
|
|
|
56
|
-
| Parameter
|
|
57
|
-
|
|
|
58
|
-
| `payload`
|
|
59
|
-
| `signature` | `string`
|
|
55
|
+
| Parameter | Type | Description |
|
|
56
|
+
| ------ | ------ | ------ |
|
|
57
|
+
| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
|
|
58
|
+
| `signature` | `string` | Webhook signature header. |
|
|
60
59
|
|
|
61
60
|
#### Returns
|
|
62
61
|
|
|
@@ -68,15 +67,15 @@ Normalized webhook event.
|
|
|
68
67
|
|
|
69
68
|
[`PaymentClientPort`](Class.PaymentClientPort).[`constructWebhookEvent`](Class.PaymentClientPort#constructwebhookevent)
|
|
70
69
|
|
|
71
|
-
|
|
70
|
+
***
|
|
72
71
|
|
|
73
72
|
### createCheckoutSession()
|
|
74
73
|
|
|
75
74
|
```ts
|
|
76
75
|
createCheckoutSession(
|
|
77
|
-
priceId,
|
|
78
|
-
successUrl,
|
|
79
|
-
_cancelUrl,
|
|
76
|
+
priceId,
|
|
77
|
+
successUrl,
|
|
78
|
+
_cancelUrl,
|
|
80
79
|
userId?): Promise<INormalizedCheckoutSession>;
|
|
81
80
|
```
|
|
82
81
|
|
|
@@ -86,12 +85,12 @@ Create a checkout session.
|
|
|
86
85
|
|
|
87
86
|
#### Parameters
|
|
88
87
|
|
|
89
|
-
| Parameter
|
|
90
|
-
|
|
|
91
|
-
| `priceId`
|
|
92
|
-
| `successUrl` | `string` | Success redirect URL.
|
|
93
|
-
| `_cancelUrl` | `string` | Cancel redirect URL.
|
|
94
|
-
| `userId?`
|
|
88
|
+
| Parameter | Type | Description |
|
|
89
|
+
| ------ | ------ | ------ |
|
|
90
|
+
| `priceId` | `string` | Price identifier. |
|
|
91
|
+
| `successUrl` | `string` | Success redirect URL. |
|
|
92
|
+
| `_cancelUrl` | `string` | Cancel redirect URL. |
|
|
93
|
+
| `userId?` | `string` | Optional user reference. |
|
|
95
94
|
|
|
96
95
|
#### Returns
|
|
97
96
|
|
|
@@ -103,7 +102,7 @@ Normalized checkout session.
|
|
|
103
102
|
|
|
104
103
|
[`PaymentClientPort`](Class.PaymentClientPort).[`createCheckoutSession`](Class.PaymentClientPort#createcheckoutsession)
|
|
105
104
|
|
|
106
|
-
|
|
105
|
+
***
|
|
107
106
|
|
|
108
107
|
### fetchPrices()
|
|
109
108
|
|
|
@@ -117,8 +116,8 @@ Fetch all active prices for a product.
|
|
|
117
116
|
|
|
118
117
|
#### Parameters
|
|
119
118
|
|
|
120
|
-
| Parameter
|
|
121
|
-
|
|
|
119
|
+
| Parameter | Type | Description |
|
|
120
|
+
| ------ | ------ | ------ |
|
|
122
121
|
| `productId` | `string` | External product identifier. |
|
|
123
122
|
|
|
124
123
|
#### Returns
|
|
@@ -131,7 +130,7 @@ Array of normalized prices.
|
|
|
131
130
|
|
|
132
131
|
[`PaymentClientPort`](Class.PaymentClientPort).[`fetchPrices`](Class.PaymentClientPort#fetchprices)
|
|
133
132
|
|
|
134
|
-
|
|
133
|
+
***
|
|
135
134
|
|
|
136
135
|
### fetchSubscription()
|
|
137
136
|
|
|
@@ -147,15 +146,15 @@ Retrieve subscription details.
|
|
|
147
146
|
|
|
148
147
|
#### Parameters
|
|
149
148
|
|
|
150
|
-
| Parameter
|
|
151
|
-
|
|
|
149
|
+
| Parameter | Type | Description |
|
|
150
|
+
| ------ | ------ | ------ |
|
|
152
151
|
| `subscriptionId` | `string` | Subscription identifier. |
|
|
153
152
|
|
|
154
153
|
#### Returns
|
|
155
154
|
|
|
156
155
|
`Promise`\<
|
|
157
|
-
\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
|
|
158
|
-
\| `null`\>
|
|
156
|
+
\| [`INormalizedSubscription`](Interface.INormalizedSubscription)
|
|
157
|
+
\| `null`\>
|
|
159
158
|
|
|
160
159
|
Normalized subscription or `null` if not found.
|
|
161
160
|
|