@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: 'Abstract Class: ResponseReturn\<T\>'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: ResponseReturn\<T\>
|
|
8
7
|
|
|
9
8
|
Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L14)
|
|
@@ -11,8 +10,8 @@ Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipe
|
|
|
11
10
|
## Type Parameters
|
|
12
11
|
|
|
13
12
|
| Type Parameter |
|
|
14
|
-
|
|
|
15
|
-
| `T`
|
|
13
|
+
| ------ |
|
|
14
|
+
| `T` |
|
|
16
15
|
|
|
17
16
|
## Constructors
|
|
18
17
|
|
|
@@ -36,7 +35,7 @@ optional data?: T;
|
|
|
36
35
|
|
|
37
36
|
Defined in: [models/ResponseReturn.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L34)
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
***
|
|
40
39
|
|
|
41
40
|
### details?
|
|
42
41
|
|
|
@@ -46,7 +45,7 @@ optional details?: unknown;
|
|
|
46
45
|
|
|
47
46
|
Defined in: [models/ResponseReturn.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L44)
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### error?
|
|
52
51
|
|
|
@@ -56,7 +55,7 @@ optional error?: string;
|
|
|
56
55
|
|
|
57
56
|
Defined in: [models/ResponseReturn.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L39)
|
|
58
57
|
|
|
59
|
-
|
|
58
|
+
***
|
|
60
59
|
|
|
61
60
|
### status
|
|
62
61
|
|
|
@@ -66,7 +65,7 @@ status: number;
|
|
|
66
65
|
|
|
67
66
|
Defined in: [models/ResponseReturn.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L29)
|
|
68
67
|
|
|
69
|
-
|
|
68
|
+
***
|
|
70
69
|
|
|
71
70
|
### success
|
|
72
71
|
|
|
@@ -76,7 +75,7 @@ success: boolean;
|
|
|
76
75
|
|
|
77
76
|
Defined in: [models/ResponseReturn.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L22)
|
|
78
77
|
|
|
79
|
-
|
|
78
|
+
***
|
|
80
79
|
|
|
81
80
|
### timestamp
|
|
82
81
|
|
|
@@ -103,16 +102,16 @@ Creates an accepted response.
|
|
|
103
102
|
##### Type Parameters
|
|
104
103
|
|
|
105
104
|
| Type Parameter |
|
|
106
|
-
|
|
|
107
|
-
| `TReturn`
|
|
108
|
-
| `TIn`
|
|
105
|
+
| ------ |
|
|
106
|
+
| `TReturn` |
|
|
107
|
+
| `TIn` |
|
|
109
108
|
|
|
110
109
|
##### Parameters
|
|
111
110
|
|
|
112
|
-
| Parameter | Type
|
|
113
|
-
|
|
|
114
|
-
| `type`
|
|
115
|
-
| `data`
|
|
111
|
+
| Parameter | Type | Description |
|
|
112
|
+
| ------ | ------ | ------ |
|
|
113
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
114
|
+
| `data` | `TIn` | The response data |
|
|
116
115
|
|
|
117
116
|
##### Returns
|
|
118
117
|
|
|
@@ -131,22 +130,22 @@ Creates an accepted response.
|
|
|
131
130
|
##### Type Parameters
|
|
132
131
|
|
|
133
132
|
| Type Parameter |
|
|
134
|
-
|
|
|
135
|
-
| `TReturn`
|
|
136
|
-
| `TIn`
|
|
133
|
+
| ------ |
|
|
134
|
+
| `TReturn` |
|
|
135
|
+
| `TIn` |
|
|
137
136
|
|
|
138
137
|
##### Parameters
|
|
139
138
|
|
|
140
|
-
| Parameter | Type
|
|
141
|
-
|
|
|
142
|
-
| `type`
|
|
143
|
-
| `data`
|
|
139
|
+
| Parameter | Type | Description |
|
|
140
|
+
| ------ | ------ | ------ |
|
|
141
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
142
|
+
| `data` | `TIn`[] | The response data |
|
|
144
143
|
|
|
145
144
|
##### Returns
|
|
146
145
|
|
|
147
146
|
`ResponseReturn`\<`TReturn`[]\>
|
|
148
147
|
|
|
149
|
-
|
|
148
|
+
***
|
|
150
149
|
|
|
151
150
|
### badRequest()
|
|
152
151
|
|
|
@@ -161,15 +160,15 @@ Creates a bad request response.
|
|
|
161
160
|
#### Type Parameters
|
|
162
161
|
|
|
163
162
|
| Type Parameter |
|
|
164
|
-
|
|
|
165
|
-
| `TReturn`
|
|
163
|
+
| ------ |
|
|
164
|
+
| `TReturn` |
|
|
166
165
|
|
|
167
166
|
#### Parameters
|
|
168
167
|
|
|
169
|
-
| Parameter
|
|
170
|
-
|
|
|
171
|
-
| `message`
|
|
172
|
-
| `details?` | `unknown` | `undefined`
|
|
168
|
+
| Parameter | Type | Default value | Description |
|
|
169
|
+
| ------ | ------ | ------ | ------ |
|
|
170
|
+
| `message` | `string` | `'Bad Request'` | Human-readable error message |
|
|
171
|
+
| `details?` | `unknown` | `undefined` | Optional error details |
|
|
173
172
|
|
|
174
173
|
#### Returns
|
|
175
174
|
|
|
@@ -177,7 +176,7 @@ Creates a bad request response.
|
|
|
177
176
|
|
|
178
177
|
Bad request response
|
|
179
178
|
|
|
180
|
-
|
|
179
|
+
***
|
|
181
180
|
|
|
182
181
|
### conflict()
|
|
183
182
|
|
|
@@ -192,15 +191,15 @@ Creates a conflict response.
|
|
|
192
191
|
#### Type Parameters
|
|
193
192
|
|
|
194
193
|
| Type Parameter |
|
|
195
|
-
|
|
|
196
|
-
| `TReturn`
|
|
194
|
+
| ------ |
|
|
195
|
+
| `TReturn` |
|
|
197
196
|
|
|
198
197
|
#### Parameters
|
|
199
198
|
|
|
200
|
-
| Parameter
|
|
201
|
-
|
|
|
202
|
-
| `message`
|
|
203
|
-
| `details?` | `unknown` | `undefined`
|
|
199
|
+
| Parameter | Type | Default value | Description |
|
|
200
|
+
| ------ | ------ | ------ | ------ |
|
|
201
|
+
| `message` | `string` | `'Conflict'` | Human-readable error message |
|
|
202
|
+
| `details?` | `unknown` | `undefined` | Optional error details |
|
|
204
203
|
|
|
205
204
|
#### Returns
|
|
206
205
|
|
|
@@ -208,7 +207,7 @@ Creates a conflict response.
|
|
|
208
207
|
|
|
209
208
|
Conflict response
|
|
210
209
|
|
|
211
|
-
|
|
210
|
+
***
|
|
212
211
|
|
|
213
212
|
### created()
|
|
214
213
|
|
|
@@ -225,16 +224,16 @@ Creates a resource created response.
|
|
|
225
224
|
##### Type Parameters
|
|
226
225
|
|
|
227
226
|
| Type Parameter |
|
|
228
|
-
|
|
|
229
|
-
| `TReturn`
|
|
230
|
-
| `TIn`
|
|
227
|
+
| ------ |
|
|
228
|
+
| `TReturn` |
|
|
229
|
+
| `TIn` |
|
|
231
230
|
|
|
232
231
|
##### Parameters
|
|
233
232
|
|
|
234
|
-
| Parameter | Type
|
|
235
|
-
|
|
|
236
|
-
| `type`
|
|
237
|
-
| `data`
|
|
233
|
+
| Parameter | Type | Description |
|
|
234
|
+
| ------ | ------ | ------ |
|
|
235
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
236
|
+
| `data` | `TIn` | The response data |
|
|
238
237
|
|
|
239
238
|
##### Returns
|
|
240
239
|
|
|
@@ -253,22 +252,22 @@ Creates a resource created response.
|
|
|
253
252
|
##### Type Parameters
|
|
254
253
|
|
|
255
254
|
| Type Parameter |
|
|
256
|
-
|
|
|
257
|
-
| `TReturn`
|
|
258
|
-
| `TIn`
|
|
255
|
+
| ------ |
|
|
256
|
+
| `TReturn` |
|
|
257
|
+
| `TIn` |
|
|
259
258
|
|
|
260
259
|
##### Parameters
|
|
261
260
|
|
|
262
|
-
| Parameter | Type
|
|
263
|
-
|
|
|
264
|
-
| `type`
|
|
265
|
-
| `data`
|
|
261
|
+
| Parameter | Type | Description |
|
|
262
|
+
| ------ | ------ | ------ |
|
|
263
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
264
|
+
| `data` | `TIn`[] | The response data |
|
|
266
265
|
|
|
267
266
|
##### Returns
|
|
268
267
|
|
|
269
268
|
`ResponseReturn`\<`TReturn`[]\>
|
|
270
269
|
|
|
271
|
-
|
|
270
|
+
***
|
|
272
271
|
|
|
273
272
|
### error()
|
|
274
273
|
|
|
@@ -283,21 +282,21 @@ Generic server error (500). Prefer attaching a safe `details` object (no stack t
|
|
|
283
282
|
#### Type Parameters
|
|
284
283
|
|
|
285
284
|
| Type Parameter |
|
|
286
|
-
|
|
|
287
|
-
| `TReturn`
|
|
285
|
+
| ------ |
|
|
286
|
+
| `TReturn` |
|
|
288
287
|
|
|
289
288
|
#### Parameters
|
|
290
289
|
|
|
291
|
-
| Parameter
|
|
292
|
-
|
|
|
293
|
-
| `message`
|
|
294
|
-
| `details?` | `unknown` | `undefined`
|
|
290
|
+
| Parameter | Type | Default value |
|
|
291
|
+
| ------ | ------ | ------ |
|
|
292
|
+
| `message` | `string` | `'Internal Server Error'` |
|
|
293
|
+
| `details?` | `unknown` | `undefined` |
|
|
295
294
|
|
|
296
295
|
#### Returns
|
|
297
296
|
|
|
298
297
|
`ResponseReturn`\<`TReturn`\>
|
|
299
298
|
|
|
300
|
-
|
|
299
|
+
***
|
|
301
300
|
|
|
302
301
|
### forbidden()
|
|
303
302
|
|
|
@@ -312,15 +311,15 @@ Creates a forbidden response.
|
|
|
312
311
|
#### Type Parameters
|
|
313
312
|
|
|
314
313
|
| Type Parameter |
|
|
315
|
-
|
|
|
316
|
-
| `TReturn`
|
|
314
|
+
| ------ |
|
|
315
|
+
| `TReturn` |
|
|
317
316
|
|
|
318
317
|
#### Parameters
|
|
319
318
|
|
|
320
|
-
| Parameter
|
|
321
|
-
|
|
|
322
|
-
| `message`
|
|
323
|
-
| `details?` | `unknown` | `undefined`
|
|
319
|
+
| Parameter | Type | Default value | Description |
|
|
320
|
+
| ------ | ------ | ------ | ------ |
|
|
321
|
+
| `message` | `string` | `'Forbidden'` | Human-readable error message |
|
|
322
|
+
| `details?` | `unknown` | `undefined` | Optional error details |
|
|
324
323
|
|
|
325
324
|
#### Returns
|
|
326
325
|
|
|
@@ -328,7 +327,7 @@ Creates a forbidden response.
|
|
|
328
327
|
|
|
329
328
|
Forbidden response
|
|
330
329
|
|
|
331
|
-
|
|
330
|
+
***
|
|
332
331
|
|
|
333
332
|
### fromError()
|
|
334
333
|
|
|
@@ -339,27 +338,26 @@ static fromError<TReturn>(err, defaultStatus?): ResponseReturn<TReturn>;
|
|
|
339
338
|
Defined in: [models/ResponseReturn.ts:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L190)
|
|
340
339
|
|
|
341
340
|
Converts an arbitrary error into a ResponseReturn.
|
|
342
|
-
|
|
343
341
|
- If you pass a Nest `HttpException`, consider extracting status/message first.
|
|
344
342
|
|
|
345
343
|
#### Type Parameters
|
|
346
344
|
|
|
347
345
|
| Type Parameter |
|
|
348
|
-
|
|
|
349
|
-
| `TReturn`
|
|
346
|
+
| ------ |
|
|
347
|
+
| `TReturn` |
|
|
350
348
|
|
|
351
349
|
#### Parameters
|
|
352
350
|
|
|
353
|
-
| Parameter
|
|
354
|
-
|
|
|
355
|
-
| `err`
|
|
351
|
+
| Parameter | Type | Default value |
|
|
352
|
+
| ------ | ------ | ------ |
|
|
353
|
+
| `err` | `unknown` | `undefined` |
|
|
356
354
|
| `defaultStatus` | `HttpStatus` | `HttpStatus.INTERNAL_SERVER_ERROR` |
|
|
357
355
|
|
|
358
356
|
#### Returns
|
|
359
357
|
|
|
360
358
|
`ResponseReturn`\<`TReturn`\>
|
|
361
359
|
|
|
362
|
-
|
|
360
|
+
***
|
|
363
361
|
|
|
364
362
|
### noContent()
|
|
365
363
|
|
|
@@ -374,14 +372,14 @@ No content variant (204). `data` is undefined by contract.
|
|
|
374
372
|
#### Type Parameters
|
|
375
373
|
|
|
376
374
|
| Type Parameter |
|
|
377
|
-
|
|
|
378
|
-
| `TReturn`
|
|
375
|
+
| ------ |
|
|
376
|
+
| `TReturn` |
|
|
379
377
|
|
|
380
378
|
#### Returns
|
|
381
379
|
|
|
382
380
|
`ResponseReturn`\<`TReturn`\>
|
|
383
381
|
|
|
384
|
-
|
|
382
|
+
***
|
|
385
383
|
|
|
386
384
|
### notFound()
|
|
387
385
|
|
|
@@ -396,15 +394,15 @@ Creates a not found response.
|
|
|
396
394
|
#### Type Parameters
|
|
397
395
|
|
|
398
396
|
| Type Parameter |
|
|
399
|
-
|
|
|
400
|
-
| `TReturn`
|
|
397
|
+
| ------ |
|
|
398
|
+
| `TReturn` |
|
|
401
399
|
|
|
402
400
|
#### Parameters
|
|
403
401
|
|
|
404
|
-
| Parameter
|
|
405
|
-
|
|
|
406
|
-
| `message`
|
|
407
|
-
| `details?` | `unknown` | `undefined`
|
|
402
|
+
| Parameter | Type | Default value | Description |
|
|
403
|
+
| ------ | ------ | ------ | ------ |
|
|
404
|
+
| `message` | `string` | `'Not Found'` | Human-readable error message |
|
|
405
|
+
| `details?` | `unknown` | `undefined` | Optional error details |
|
|
408
406
|
|
|
409
407
|
#### Returns
|
|
410
408
|
|
|
@@ -412,7 +410,7 @@ Creates a not found response.
|
|
|
412
410
|
|
|
413
411
|
Not found response
|
|
414
412
|
|
|
415
|
-
|
|
413
|
+
***
|
|
416
414
|
|
|
417
415
|
### ok()
|
|
418
416
|
|
|
@@ -429,16 +427,16 @@ Creates a successful response.
|
|
|
429
427
|
##### Type Parameters
|
|
430
428
|
|
|
431
429
|
| Type Parameter |
|
|
432
|
-
|
|
|
433
|
-
| `TReturn`
|
|
434
|
-
| `TIn`
|
|
430
|
+
| ------ |
|
|
431
|
+
| `TReturn` |
|
|
432
|
+
| `TIn` |
|
|
435
433
|
|
|
436
434
|
##### Parameters
|
|
437
435
|
|
|
438
|
-
| Parameter | Type
|
|
439
|
-
|
|
|
440
|
-
| `type`
|
|
441
|
-
| `data`
|
|
436
|
+
| Parameter | Type | Description |
|
|
437
|
+
| ------ | ------ | ------ |
|
|
438
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
439
|
+
| `data` | `TIn` | The response data |
|
|
442
440
|
|
|
443
441
|
##### Returns
|
|
444
442
|
|
|
@@ -457,22 +455,22 @@ Creates a successful response.
|
|
|
457
455
|
##### Type Parameters
|
|
458
456
|
|
|
459
457
|
| Type Parameter |
|
|
460
|
-
|
|
|
461
|
-
| `TReturn`
|
|
462
|
-
| `TIn`
|
|
458
|
+
| ------ |
|
|
459
|
+
| `TReturn` |
|
|
460
|
+
| `TIn` |
|
|
463
461
|
|
|
464
462
|
##### Parameters
|
|
465
463
|
|
|
466
|
-
| Parameter | Type
|
|
467
|
-
|
|
|
468
|
-
| `type`
|
|
469
|
-
| `data`
|
|
464
|
+
| Parameter | Type | Description |
|
|
465
|
+
| ------ | ------ | ------ |
|
|
466
|
+
| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
|
|
467
|
+
| `data` | `TIn`[] | The response data |
|
|
470
468
|
|
|
471
469
|
##### Returns
|
|
472
470
|
|
|
473
471
|
`ResponseReturn`\<`TReturn`[]\>
|
|
474
472
|
|
|
475
|
-
|
|
473
|
+
***
|
|
476
474
|
|
|
477
475
|
### unauthorized()
|
|
478
476
|
|
|
@@ -487,15 +485,15 @@ Creates an unauthorized response.
|
|
|
487
485
|
#### Type Parameters
|
|
488
486
|
|
|
489
487
|
| Type Parameter |
|
|
490
|
-
|
|
|
491
|
-
| `TReturn`
|
|
488
|
+
| ------ |
|
|
489
|
+
| `TReturn` |
|
|
492
490
|
|
|
493
491
|
#### Parameters
|
|
494
492
|
|
|
495
|
-
| Parameter
|
|
496
|
-
|
|
|
497
|
-
| `message`
|
|
498
|
-
| `details?` | `unknown` | `undefined`
|
|
493
|
+
| Parameter | Type | Default value | Description |
|
|
494
|
+
| ------ | ------ | ------ | ------ |
|
|
495
|
+
| `message` | `string` | `'Unauthorized'` | Human-readable error message |
|
|
496
|
+
| `details?` | `unknown` | `undefined` | Optional error details |
|
|
499
497
|
|
|
500
498
|
#### Returns
|
|
501
499
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: SseHub'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: SseHub
|
|
8
7
|
|
|
9
8
|
Defined in: [sse/services/SseHub.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L16)
|
|
@@ -44,9 +43,9 @@ Clears the event with the specified ID.
|
|
|
44
43
|
|
|
45
44
|
#### Parameters
|
|
46
45
|
|
|
47
|
-
| Parameter | Type
|
|
48
|
-
|
|
|
49
|
-
| `id`
|
|
46
|
+
| Parameter | Type | Description |
|
|
47
|
+
| ------ | ------ | ------ |
|
|
48
|
+
| `id` | `string` | The ID of the event. |
|
|
50
49
|
|
|
51
50
|
#### Returns
|
|
52
51
|
|
|
@@ -56,7 +55,7 @@ Clears the event with the specified ID.
|
|
|
56
55
|
|
|
57
56
|
[`ISseHub`](Interface.ISseHub).[`clearEvent`](Interface.ISseHub#clearevent)
|
|
58
57
|
|
|
59
|
-
|
|
58
|
+
***
|
|
60
59
|
|
|
61
60
|
### emitEvent()
|
|
62
61
|
|
|
@@ -70,10 +69,10 @@ Emits an event with the specified ID and data.
|
|
|
70
69
|
|
|
71
70
|
#### Parameters
|
|
72
71
|
|
|
73
|
-
| Parameter | Type
|
|
74
|
-
|
|
|
75
|
-
| `id`
|
|
76
|
-
| `data`
|
|
72
|
+
| Parameter | Type | Description |
|
|
73
|
+
| ------ | ------ | ------ |
|
|
74
|
+
| `id` | `string` | The ID of the event. |
|
|
75
|
+
| `data` | [`ISseEventData`](Interface.ISseEventData) | The data of the event. |
|
|
77
76
|
|
|
78
77
|
#### Returns
|
|
79
78
|
|
|
@@ -83,7 +82,7 @@ Emits an event with the specified ID and data.
|
|
|
83
82
|
|
|
84
83
|
[`ISseHub`](Interface.ISseHub).[`emitEvent`](Interface.ISseHub#emitevent)
|
|
85
84
|
|
|
86
|
-
|
|
85
|
+
***
|
|
87
86
|
|
|
88
87
|
### getObservable()
|
|
89
88
|
|
|
@@ -97,8 +96,8 @@ Gets an observable for the event with the specified ID.
|
|
|
97
96
|
|
|
98
97
|
#### Parameters
|
|
99
98
|
|
|
100
|
-
| Parameter | Type
|
|
101
|
-
|
|
|
99
|
+
| Parameter | Type | Description |
|
|
100
|
+
| ------ | ------ | ------ |
|
|
102
101
|
| `eventId` | `string` | The ID of the event. |
|
|
103
102
|
|
|
104
103
|
#### Returns
|
|
@@ -111,7 +110,7 @@ An observable for the event.
|
|
|
111
110
|
|
|
112
111
|
[`ISseHub`](Interface.ISseHub).[`getObservable`](Interface.ISseHub#getobservable)
|
|
113
112
|
|
|
114
|
-
|
|
113
|
+
***
|
|
115
114
|
|
|
116
115
|
### isEventActive()
|
|
117
116
|
|
|
@@ -125,9 +124,9 @@ Determines whether the event with the specified ID is active.
|
|
|
125
124
|
|
|
126
125
|
#### Parameters
|
|
127
126
|
|
|
128
|
-
| Parameter | Type
|
|
129
|
-
|
|
|
130
|
-
| `id`
|
|
127
|
+
| Parameter | Type | Description |
|
|
128
|
+
| ------ | ------ | ------ |
|
|
129
|
+
| `id` | `string` | The ID of the event. |
|
|
131
130
|
|
|
132
131
|
#### Returns
|
|
133
132
|
|
|
@@ -139,7 +138,7 @@ Determines whether the event with the specified ID is active.
|
|
|
139
138
|
|
|
140
139
|
[`ISseHub`](Interface.ISseHub).[`isEventActive`](Interface.ISseHub#iseventactive)
|
|
141
140
|
|
|
142
|
-
|
|
141
|
+
***
|
|
143
142
|
|
|
144
143
|
### registerEvent()
|
|
145
144
|
|
|
@@ -153,15 +152,15 @@ Registers an event with the specified ID.
|
|
|
153
152
|
|
|
154
153
|
#### Parameters
|
|
155
154
|
|
|
156
|
-
| Parameter | Type
|
|
157
|
-
|
|
|
158
|
-
| `id`
|
|
155
|
+
| Parameter | Type | Description |
|
|
156
|
+
| ------ | ------ | ------ |
|
|
157
|
+
| `id` | `string` | The ID of the event. |
|
|
159
158
|
|
|
160
159
|
#### Returns
|
|
161
160
|
|
|
162
161
|
`void`
|
|
163
162
|
|
|
164
|
-
|
|
163
|
+
***
|
|
165
164
|
|
|
166
165
|
### unregisterEvent()
|
|
167
166
|
|
|
@@ -175,9 +174,9 @@ Unregisters an event with the specified ID.
|
|
|
175
174
|
|
|
176
175
|
#### Parameters
|
|
177
176
|
|
|
178
|
-
| Parameter | Type
|
|
179
|
-
|
|
|
180
|
-
| `id`
|
|
177
|
+
| Parameter | Type | Description |
|
|
178
|
+
| ------ | ------ | ------ |
|
|
179
|
+
| `id` | `string` | The ID of the event. |
|
|
181
180
|
|
|
182
181
|
#### Returns
|
|
183
182
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: SseModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: SseModule
|
|
8
7
|
|
|
9
8
|
Defined in: [sse/SseModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/SseModule.ts#L41)
|
|
@@ -34,9 +33,9 @@ Defined in: [sse/SseModule.ts:45](https://github.com/RueDeRennes/archipel/blob/m
|
|
|
34
33
|
|
|
35
34
|
#### Parameters
|
|
36
35
|
|
|
37
|
-
| Parameter | Type
|
|
38
|
-
|
|
|
39
|
-
| `config`
|
|
36
|
+
| Parameter | Type |
|
|
37
|
+
| ------ | ------ |
|
|
38
|
+
| `config` | `ISseModuleConfig` |
|
|
40
39
|
|
|
41
40
|
#### Returns
|
|
42
41
|
|
|
@@ -3,7 +3,6 @@ title: 'Abstract Class: TimeStampResponse'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Abstract Class: TimeStampResponse
|
|
8
7
|
|
|
9
8
|
Defined in: [models/response/TimeStampResponse.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L15)
|
|
@@ -32,7 +31,7 @@ createdAt: Date;
|
|
|
32
31
|
|
|
33
32
|
Defined in: [models/response/TimeStampResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L25)
|
|
34
33
|
|
|
35
|
-
|
|
34
|
+
***
|
|
36
35
|
|
|
37
36
|
### updatedAt
|
|
38
37
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: TypeMappingNotRegisteredError'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: TypeMappingNotRegisteredError
|
|
8
7
|
|
|
9
8
|
Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/TypeMappingNotRegisteredError.ts#L12)
|
|
@@ -26,9 +25,9 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
|
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter
|
|
30
|
-
|
|
|
31
|
-
| `source`
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `source` | `string` |
|
|
32
31
|
| `destination` | `string` |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -38,7 +37,7 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
|
|
|
38
37
|
#### Overrides
|
|
39
38
|
|
|
40
39
|
```ts
|
|
41
|
-
MappingError.constructor
|
|
40
|
+
MappingError.constructor
|
|
42
41
|
```
|
|
43
42
|
|
|
44
43
|
## Properties
|
|
@@ -54,5 +53,5 @@ Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/a
|
|
|
54
53
|
#### Inherited from
|
|
55
54
|
|
|
56
55
|
```ts
|
|
57
|
-
MappingError.code
|
|
56
|
+
MappingError.code
|
|
58
57
|
```
|