@breadstone/archipel-mcp 0.0.9 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/ai-text-generation.md +361 -0
- package/data/guides/analytics-and-error-tracking.md +189 -0
- package/data/guides/authentication-and-authorization.md +657 -0
- package/data/guides/blob-storage.md +242 -0
- package/data/guides/caching.md +255 -0
- package/data/guides/cryptography-and-otp.md +240 -0
- package/data/guides/document-generation.md +174 -0
- package/data/guides/email-delivery.md +196 -0
- package/data/guides/esigning-integration.md +231 -0
- package/data/guides/getting-started.md +351 -0
- package/data/guides/implementing-ports.md +317 -0
- package/data/guides/index.md +61 -0
- package/data/guides/mcp-server.md +222 -0
- package/data/guides/openapi-and-feature-discovery.md +266 -0
- package/data/guides/payments-and-feature-gating.md +244 -0
- package/data/guides/resource-management.md +352 -0
- package/data/guides/telemetry-and-observability.md +190 -0
- package/data/guides/testing.md +319 -0
- package/data/guides/tsdoc-guidelines.md +45 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +21 -22
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
- package/data/packages/platform-analytics/api/index.md +25 -26
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +19 -20
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -27
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +14 -15
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.MfaService.md +54 -55
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +17 -18
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +27 -28
- package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -30
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
- package/data/packages/platform-authentication/api/Function.Token.md +0 -1
- package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +20 -21
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -11
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +1 -2
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -95
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -3
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/index.md +41 -42
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +37 -38
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +39 -40
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +19 -20
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +4 -5
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +34 -35
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +4 -5
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +15 -16
- package/data/packages/platform-caching/api/index.md +12 -13
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
- package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
- package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
- package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +18 -19
- package/data/packages/platform-core/api/Class.EventHub.md +25 -26
- package/data/packages/platform-core/api/Class.EventModule.md +0 -1
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
- package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
- package/data/packages/platform-core/api/Class.HostModule.md +0 -2
- package/data/packages/platform-core/api/Class.HostService.md +21 -22
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
- package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
- package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
- package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
- package/data/packages/platform-core/api/Class.MappingService.md +52 -53
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
- package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
- package/data/packages/platform-core/api/Class.SseHub.md +23 -24
- package/data/packages/platform-core/api/Class.SseModule.md +3 -4
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Function.Public.md +0 -1
- package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
- package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
- package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
- package/data/packages/platform-core/api/Function.env.md +4 -5
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
- package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +19 -20
- package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +17 -18
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
- package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
- package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
- package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
- package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
- package/data/packages/platform-core/api/Variable.APP_NAME.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +1 -2
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -2
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
- package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
- package/data/packages/platform-core/api/Variable.Lang.md +5 -6
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -2
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -116
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +7 -8
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -4
- package/data/packages/platform-cryptography/api/Class.OtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +8 -9
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -2
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +7 -8
- package/data/packages/platform-cryptography/api/index.md +11 -12
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
- package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
- package/data/packages/platform-database/api/Function.pageable.md +13 -10
- package/data/packages/platform-database/api/Function.paginator.md +2 -3
- package/data/packages/platform-database/api/Function.query.md +7 -8
- package/data/packages/platform-database/api/Function.skip.md +5 -6
- package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
- package/data/packages/platform-database/api/index.md +27 -28
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/index.md +28 -29
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
- package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
- package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
- package/data/packages/platform-esigning/api/index.md +65 -66
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -5
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -1
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +1 -2
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +4 -5
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
- package/data/packages/platform-intelligence/api/index.md +46 -47
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-logging/api/index.md +7 -8
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailService.md +27 -28
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -15
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
- package/data/packages/platform-mailing/api/index.md +54 -55
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
- package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-mcp/api/index.md +26 -27
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +15 -12
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
- package/data/packages/platform-openapi/api/Function.Api.md +13 -14
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +4 -5
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
- package/data/packages/platform-openapi/api/index.md +24 -25
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -25
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -25
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
- package/data/packages/platform-payments/api/Class.StripeClient.md +28 -29
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/index.md +40 -41
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
- package/data/packages/platform-reporting/api/index.md +23 -24
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
- package/data/packages/platform-telemetry/api/index.md +20 -21
- package/package.json +1 -1
- package/src/GuidesLoader.d.ts +13 -0
- package/src/GuidesLoader.js +81 -0
- package/src/main.js +36 -198
- package/src/models/IGuideDoc.d.ts +15 -0
- package/src/models/IGuideDoc.js +3 -0
- package/src/tools/registerGetConfigPatternTool.d.ts +5 -0
- package/src/tools/registerGetConfigPatternTool.js +15 -0
- package/src/tools/registerGetDtoPatternTool.d.ts +5 -0
- package/src/tools/registerGetDtoPatternTool.js +15 -0
- package/src/tools/registerGetErrorHandlingPatternTool.d.ts +5 -0
- package/src/tools/registerGetErrorHandlingPatternTool.js +15 -0
- package/src/tools/registerGetGuardPatternTool.d.ts +5 -0
- package/src/tools/registerGetGuardPatternTool.js +15 -0
- package/src/tools/registerGetGuideTool.d.ts +6 -0
- package/src/tools/registerGetGuideTool.js +32 -0
- package/src/tools/registerGetMappingPatternTool.d.ts +5 -0
- package/src/tools/registerGetMappingPatternTool.js +34 -0
- package/src/tools/registerGetModulePatternTool.d.ts +5 -0
- package/src/tools/registerGetModulePatternTool.js +29 -0
- package/src/tools/registerGetPackageDocTool.d.ts +6 -0
- package/src/tools/registerGetPackageDocTool.js +43 -0
- package/src/tools/registerGetQueryPatternTool.d.ts +5 -0
- package/src/tools/registerGetQueryPatternTool.js +29 -0
- package/src/tools/registerGetRepositoryPatternTool.d.ts +5 -0
- package/src/tools/registerGetRepositoryPatternTool.js +29 -0
- package/src/tools/registerGetTestingPatternTool.d.ts +5 -0
- package/src/tools/registerGetTestingPatternTool.js +15 -0
- package/src/tools/registerListGuidesTool.d.ts +6 -0
- package/src/tools/registerListGuidesTool.js +22 -0
- package/src/tools/registerListPackagesTool.d.ts +6 -0
- package/src/tools/registerListPackagesTool.js +20 -0
- package/src/tools/registerSearchDocsTool.d.ts +6 -0
- package/src/tools/registerSearchDocsTool.js +35 -0
- package/src/tools/registerSearchGuidesTool.d.ts +6 -0
- package/src/tools/registerSearchGuidesTool.js +28 -0
|
@@ -3,7 +3,6 @@ title: 'Class: DatadogAnalyticsClient'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: DatadogAnalyticsClient
|
|
8
7
|
|
|
9
8
|
Defined in: [datadog/DatadogAnalyticsClient.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/DatadogAnalyticsClient.ts#L21)
|
|
@@ -27,8 +26,8 @@ Defined in: [datadog/DatadogAnalyticsClient.ts:32](https://github.com/RueDeRenne
|
|
|
27
26
|
|
|
28
27
|
#### Parameters
|
|
29
28
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
32
31
|
| `configService` | `ConfigService` |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -53,8 +52,8 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
53
52
|
|
|
54
53
|
#### Parameters
|
|
55
54
|
|
|
56
|
-
| Parameter
|
|
57
|
-
|
|
|
55
|
+
| Parameter | Type | Description |
|
|
56
|
+
| ------ | ------ | ------ |
|
|
58
57
|
| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
|
|
59
58
|
|
|
60
59
|
#### Returns
|
|
@@ -65,7 +64,7 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
65
64
|
|
|
66
65
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
***
|
|
69
68
|
|
|
70
69
|
### captureException()
|
|
71
70
|
|
|
@@ -79,9 +78,9 @@ Capture an exception with optional context.
|
|
|
79
78
|
|
|
80
79
|
#### Parameters
|
|
81
80
|
|
|
82
|
-
| Parameter
|
|
83
|
-
|
|
|
84
|
-
| `error`
|
|
81
|
+
| Parameter | Type | Description |
|
|
82
|
+
| ------ | ------ | ------ |
|
|
83
|
+
| `error` | `Error` | The error to capture. |
|
|
85
84
|
| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
86
85
|
|
|
87
86
|
#### Returns
|
|
@@ -92,14 +91,14 @@ Capture an exception with optional context.
|
|
|
92
91
|
|
|
93
92
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
|
|
94
93
|
|
|
95
|
-
|
|
94
|
+
***
|
|
96
95
|
|
|
97
96
|
### captureMessage()
|
|
98
97
|
|
|
99
98
|
```ts
|
|
100
99
|
captureMessage(
|
|
101
|
-
message,
|
|
102
|
-
level,
|
|
100
|
+
message,
|
|
101
|
+
level,
|
|
103
102
|
context?): void;
|
|
104
103
|
```
|
|
105
104
|
|
|
@@ -109,11 +108,11 @@ Capture a message with a specific severity level.
|
|
|
109
108
|
|
|
110
109
|
#### Parameters
|
|
111
110
|
|
|
112
|
-
| Parameter
|
|
113
|
-
|
|
|
114
|
-
| `message`
|
|
115
|
-
| `level`
|
|
116
|
-
| `context?` | `Record`\<`string`, `unknown`\>
|
|
111
|
+
| Parameter | Type | Description |
|
|
112
|
+
| ------ | ------ | ------ |
|
|
113
|
+
| `message` | `string` | The message to capture. |
|
|
114
|
+
| `level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
|
|
115
|
+
| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
117
116
|
|
|
118
117
|
#### Returns
|
|
119
118
|
|
|
@@ -123,7 +122,7 @@ Capture a message with a specific severity level.
|
|
|
123
122
|
|
|
124
123
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
|
|
125
124
|
|
|
126
|
-
|
|
125
|
+
***
|
|
127
126
|
|
|
128
127
|
### clearUser()
|
|
129
128
|
|
|
@@ -143,7 +142,7 @@ Clear the current user context.
|
|
|
143
142
|
|
|
144
143
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
|
|
145
144
|
|
|
146
|
-
|
|
145
|
+
***
|
|
147
146
|
|
|
148
147
|
### setUser()
|
|
149
148
|
|
|
@@ -157,9 +156,9 @@ Set the current user context for subsequent events.
|
|
|
157
156
|
|
|
158
157
|
#### Parameters
|
|
159
158
|
|
|
160
|
-
| Parameter | Type
|
|
161
|
-
|
|
|
162
|
-
| `user`
|
|
159
|
+
| Parameter | Type | Description |
|
|
160
|
+
| ------ | ------ | ------ |
|
|
161
|
+
| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
|
|
163
162
|
|
|
164
163
|
#### Returns
|
|
165
164
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: NoopAnalyticsClient'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: NoopAnalyticsClient
|
|
8
7
|
|
|
9
8
|
Defined in: [noop/NoopAnalyticsClient.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/noop/NoopAnalyticsClient.ts#L18)
|
|
@@ -45,8 +44,8 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
45
44
|
|
|
46
45
|
#### Parameters
|
|
47
46
|
|
|
48
|
-
| Parameter
|
|
49
|
-
|
|
|
47
|
+
| Parameter | Type | Description |
|
|
48
|
+
| ------ | ------ | ------ |
|
|
50
49
|
| `_breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
|
|
51
50
|
|
|
52
51
|
#### Returns
|
|
@@ -57,7 +56,7 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
57
56
|
|
|
58
57
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
|
|
59
58
|
|
|
60
|
-
|
|
59
|
+
***
|
|
61
60
|
|
|
62
61
|
### captureException()
|
|
63
62
|
|
|
@@ -71,9 +70,9 @@ Capture an exception with optional context.
|
|
|
71
70
|
|
|
72
71
|
#### Parameters
|
|
73
72
|
|
|
74
|
-
| Parameter
|
|
75
|
-
|
|
|
76
|
-
| `_error`
|
|
73
|
+
| Parameter | Type | Description |
|
|
74
|
+
| ------ | ------ | ------ |
|
|
75
|
+
| `_error` | `Error` | The error to capture. |
|
|
77
76
|
| `_context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
78
77
|
|
|
79
78
|
#### Returns
|
|
@@ -84,14 +83,14 @@ Capture an exception with optional context.
|
|
|
84
83
|
|
|
85
84
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
|
|
86
85
|
|
|
87
|
-
|
|
86
|
+
***
|
|
88
87
|
|
|
89
88
|
### captureMessage()
|
|
90
89
|
|
|
91
90
|
```ts
|
|
92
91
|
captureMessage(
|
|
93
|
-
_message,
|
|
94
|
-
_level,
|
|
92
|
+
_message,
|
|
93
|
+
_level,
|
|
95
94
|
_context?): void;
|
|
96
95
|
```
|
|
97
96
|
|
|
@@ -101,11 +100,11 @@ Capture a message with a specific severity level.
|
|
|
101
100
|
|
|
102
101
|
#### Parameters
|
|
103
102
|
|
|
104
|
-
| Parameter
|
|
105
|
-
|
|
|
106
|
-
| `_message`
|
|
107
|
-
| `_level`
|
|
108
|
-
| `_context?` | `Record`\<`string`, `unknown`\>
|
|
103
|
+
| Parameter | Type | Description |
|
|
104
|
+
| ------ | ------ | ------ |
|
|
105
|
+
| `_message` | `string` | The message to capture. |
|
|
106
|
+
| `_level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
|
|
107
|
+
| `_context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
109
108
|
|
|
110
109
|
#### Returns
|
|
111
110
|
|
|
@@ -115,7 +114,7 @@ Capture a message with a specific severity level.
|
|
|
115
114
|
|
|
116
115
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
|
|
117
116
|
|
|
118
|
-
|
|
117
|
+
***
|
|
119
118
|
|
|
120
119
|
### clearUser()
|
|
121
120
|
|
|
@@ -135,7 +134,7 @@ Clear the current user context.
|
|
|
135
134
|
|
|
136
135
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
|
|
137
136
|
|
|
138
|
-
|
|
137
|
+
***
|
|
139
138
|
|
|
140
139
|
### setUser()
|
|
141
140
|
|
|
@@ -149,9 +148,9 @@ Set the current user context for subsequent events.
|
|
|
149
148
|
|
|
150
149
|
#### Parameters
|
|
151
150
|
|
|
152
|
-
| Parameter | Type
|
|
153
|
-
|
|
|
154
|
-
| `_user`
|
|
151
|
+
| Parameter | Type | Description |
|
|
152
|
+
| ------ | ------ | ------ |
|
|
153
|
+
| `_user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
|
|
155
154
|
|
|
156
155
|
#### Returns
|
|
157
156
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: SentryAnalyticsClient'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: SentryAnalyticsClient
|
|
8
7
|
|
|
9
8
|
Defined in: [sentry/SentryAnalyticsClient.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/SentryAnalyticsClient.ts#L21)
|
|
@@ -27,8 +26,8 @@ Defined in: [sentry/SentryAnalyticsClient.ts:30](https://github.com/RueDeRennes/
|
|
|
27
26
|
|
|
28
27
|
#### Parameters
|
|
29
28
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
32
31
|
| `configService` | `ConfigService` |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -53,8 +52,8 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
53
52
|
|
|
54
53
|
#### Parameters
|
|
55
54
|
|
|
56
|
-
| Parameter
|
|
57
|
-
|
|
|
55
|
+
| Parameter | Type | Description |
|
|
56
|
+
| ------ | ------ | ------ |
|
|
58
57
|
| `breadcrumb` | [`IAnalyticsBreadcrumb`](Interface.IAnalyticsBreadcrumb) | The breadcrumb to add. |
|
|
59
58
|
|
|
60
59
|
#### Returns
|
|
@@ -65,7 +64,7 @@ Add a breadcrumb entry to the analytics trail.
|
|
|
65
64
|
|
|
66
65
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`addBreadcrumb`](Class.AnalyticsClientPort#addbreadcrumb)
|
|
67
66
|
|
|
68
|
-
|
|
67
|
+
***
|
|
69
68
|
|
|
70
69
|
### captureException()
|
|
71
70
|
|
|
@@ -79,9 +78,9 @@ Capture an exception with optional context.
|
|
|
79
78
|
|
|
80
79
|
#### Parameters
|
|
81
80
|
|
|
82
|
-
| Parameter
|
|
83
|
-
|
|
|
84
|
-
| `error`
|
|
81
|
+
| Parameter | Type | Description |
|
|
82
|
+
| ------ | ------ | ------ |
|
|
83
|
+
| `error` | `Error` | The error to capture. |
|
|
85
84
|
| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
86
85
|
|
|
87
86
|
#### Returns
|
|
@@ -92,14 +91,14 @@ Capture an exception with optional context.
|
|
|
92
91
|
|
|
93
92
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureException`](Class.AnalyticsClientPort#captureexception)
|
|
94
93
|
|
|
95
|
-
|
|
94
|
+
***
|
|
96
95
|
|
|
97
96
|
### captureMessage()
|
|
98
97
|
|
|
99
98
|
```ts
|
|
100
99
|
captureMessage(
|
|
101
|
-
message,
|
|
102
|
-
level,
|
|
100
|
+
message,
|
|
101
|
+
level,
|
|
103
102
|
context?): void;
|
|
104
103
|
```
|
|
105
104
|
|
|
@@ -109,11 +108,11 @@ Capture a message with a specific severity level.
|
|
|
109
108
|
|
|
110
109
|
#### Parameters
|
|
111
110
|
|
|
112
|
-
| Parameter
|
|
113
|
-
|
|
|
114
|
-
| `message`
|
|
115
|
-
| `level`
|
|
116
|
-
| `context?` | `Record`\<`string`, `unknown`\>
|
|
111
|
+
| Parameter | Type | Description |
|
|
112
|
+
| ------ | ------ | ------ |
|
|
113
|
+
| `message` | `string` | The message to capture. |
|
|
114
|
+
| `level` | [`AnalyticsLevel`](TypeAlias.AnalyticsLevel) | Severity level of the message. |
|
|
115
|
+
| `context?` | `Record`\<`string`, `unknown`\> | Optional additional context metadata. |
|
|
117
116
|
|
|
118
117
|
#### Returns
|
|
119
118
|
|
|
@@ -123,7 +122,7 @@ Capture a message with a specific severity level.
|
|
|
123
122
|
|
|
124
123
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`captureMessage`](Class.AnalyticsClientPort#capturemessage)
|
|
125
124
|
|
|
126
|
-
|
|
125
|
+
***
|
|
127
126
|
|
|
128
127
|
### clearUser()
|
|
129
128
|
|
|
@@ -143,7 +142,7 @@ Clear the current user context.
|
|
|
143
142
|
|
|
144
143
|
[`AnalyticsClientPort`](Class.AnalyticsClientPort).[`clearUser`](Class.AnalyticsClientPort#clearuser)
|
|
145
144
|
|
|
146
|
-
|
|
145
|
+
***
|
|
147
146
|
|
|
148
147
|
### setUser()
|
|
149
148
|
|
|
@@ -157,9 +156,9 @@ Set the current user context for subsequent events.
|
|
|
157
156
|
|
|
158
157
|
#### Parameters
|
|
159
158
|
|
|
160
|
-
| Parameter | Type
|
|
161
|
-
|
|
|
162
|
-
| `user`
|
|
159
|
+
| Parameter | Type | Description |
|
|
160
|
+
| ------ | ------ | ------ |
|
|
161
|
+
| `user` | [`IAnalyticsUser`](Interface.IAnalyticsUser) | The user context to set. |
|
|
163
162
|
|
|
164
163
|
#### Returns
|
|
165
164
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IAnalyticsBreadcrumb'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IAnalyticsBreadcrumb
|
|
8
7
|
|
|
9
8
|
Defined in: [models/IAnalyticsBreadcrumb.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/IAnalyticsBreadcrumb.ts:10](https://github.com/RueDeRennes/a
|
|
|
22
21
|
|
|
23
22
|
Category of the breadcrumb (e.g. `http`, `navigation`, `user`).
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### data?
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/IAnalyticsBreadcrumb.ts:25](https://github.com/RueDeRennes/a
|
|
|
34
33
|
|
|
35
34
|
Additional metadata.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### level?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/IAnalyticsBreadcrumb.ts:20](https://github.com/RueDeRennes/a
|
|
|
46
45
|
|
|
47
46
|
Severity level.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### message
|
|
52
51
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IAnalyticsModuleOptions'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IAnalyticsModuleOptions
|
|
8
7
|
|
|
9
8
|
Defined in: [AnalyticsModule.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L16)
|
|
@@ -23,7 +22,7 @@ Defined in: [AnalyticsModule.ts:21](https://github.com/RueDeRennes/archipel/blob
|
|
|
23
22
|
Concrete implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
|
|
24
23
|
For example, `SentryAnalyticsClient`, `AppInsightsAnalyticsClient`, `DatadogAnalyticsClient`, or `NoopAnalyticsClient`.
|
|
25
24
|
|
|
26
|
-
|
|
25
|
+
***
|
|
27
26
|
|
|
28
27
|
### configEntries?
|
|
29
28
|
|
|
@@ -35,7 +34,7 @@ Defined in: [AnalyticsModule.ts:26](https://github.com/RueDeRennes/archipel/blob
|
|
|
35
34
|
|
|
36
35
|
Provider-specific configuration entries to register with the config module.
|
|
37
36
|
|
|
38
|
-
|
|
37
|
+
***
|
|
39
38
|
|
|
40
39
|
### isGlobal?
|
|
41
40
|
|
|
@@ -3,7 +3,6 @@ title: 'Interface: IAnalyticsUser'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Interface: IAnalyticsUser
|
|
8
7
|
|
|
9
8
|
Defined in: [models/IAnalyticsUser.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L6)
|
|
@@ -22,7 +21,7 @@ Defined in: [models/IAnalyticsUser.ts:15](https://github.com/RueDeRennes/archipe
|
|
|
22
21
|
|
|
23
22
|
Optional e-mail address.
|
|
24
23
|
|
|
25
|
-
|
|
24
|
+
***
|
|
26
25
|
|
|
27
26
|
### id
|
|
28
27
|
|
|
@@ -34,7 +33,7 @@ Defined in: [models/IAnalyticsUser.ts:10](https://github.com/RueDeRennes/archipe
|
|
|
34
33
|
|
|
35
34
|
Unique user identifier.
|
|
36
35
|
|
|
37
|
-
|
|
36
|
+
***
|
|
38
37
|
|
|
39
38
|
### traits?
|
|
40
39
|
|
|
@@ -46,7 +45,7 @@ Defined in: [models/IAnalyticsUser.ts:25](https://github.com/RueDeRennes/archipe
|
|
|
46
45
|
|
|
47
46
|
Additional user traits.
|
|
48
47
|
|
|
49
|
-
|
|
48
|
+
***
|
|
50
49
|
|
|
51
50
|
### username?
|
|
52
51
|
|
|
@@ -3,11 +3,10 @@ title: 'Type Alias: AnalyticsLevel'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Type Alias: AnalyticsLevel
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
type AnalyticsLevel =
|
|
9
|
+
type AnalyticsLevel = "fatal" | "error" | "warning" | "info" | "debug";
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [models/AnalyticsLevel.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/AnalyticsLevel.ts#L6)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: APPINSIGHTS\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: APPINSIGHTS_CONFIG_ENTRIES
|
|
6
|
+
# Variable: APPINSIGHTS\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [application-insights/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L19)
|
package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md
CHANGED
|
@@ -3,8 +3,7 @@ title: 'Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: APPLICATIONINSIGHTS_CONNECTION_STRING
|
|
6
|
+
# Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
9
|
const APPLICATIONINSIGHTS_CONNECTION_STRING: IConfigKey<string>;
|
|
@@ -3,11 +3,10 @@ title: 'Variable: DATADOG\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: DATADOG_CONFIG_ENTRIES
|
|
6
|
+
# Variable: DATADOG\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [datadog/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L22)
|
|
@@ -3,11 +3,10 @@ title: 'Variable: SENTRY\_CONFIG\_ENTRIES'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
|
-
# Variable: SENTRY_CONFIG_ENTRIES
|
|
6
|
+
# Variable: SENTRY\_CONFIG\_ENTRIES
|
|
8
7
|
|
|
9
8
|
```ts
|
|
10
|
-
const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry,
|
|
9
|
+
const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
11
10
|
```
|
|
12
11
|
|
|
13
12
|
Defined in: [sentry/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L22)
|
|
@@ -3,43 +3,42 @@ title: '@breadstone/archipel-platform-analytics'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# @breadstone/archipel-platform-analytics
|
|
8
7
|
|
|
9
8
|
## Classes
|
|
10
9
|
|
|
11
|
-
| Class
|
|
12
|
-
|
|
|
13
|
-
| [AnalyticsClientPort](Class.AnalyticsClientPort)
|
|
14
|
-
| [AnalyticsModule](Class.AnalyticsModule)
|
|
15
|
-
| [AppInsightsAnalyticsClient](Class.AppInsightsAnalyticsClient) | Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `applicationinsights` SDK for error tracking and analytics.
|
|
16
|
-
| [DatadogAnalyticsClient](Class.DatadogAnalyticsClient)
|
|
17
|
-
| [NoopAnalyticsClient](Class.NoopAnalyticsClient)
|
|
18
|
-
| [SentryAnalyticsClient](Class.SentryAnalyticsClient)
|
|
10
|
+
| Class | Description |
|
|
11
|
+
| ------ | ------ |
|
|
12
|
+
| [AnalyticsClientPort](Class.AnalyticsClientPort) | Abstract port for analytics and error tracking clients. Each provider (Sentry, Application Insights, Datadog) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
13
|
+
| [AnalyticsModule](Class.AnalyticsModule) | NestJS module providing generic analytics and error tracking infrastructure. The specific analytics provider (Sentry, Application Insights, Datadog) is selected via the options. |
|
|
14
|
+
| [AppInsightsAnalyticsClient](Class.AppInsightsAnalyticsClient) | Azure Application Insights implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `applicationinsights` SDK for error tracking and analytics. |
|
|
15
|
+
| [DatadogAnalyticsClient](Class.DatadogAnalyticsClient) | Datadog implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the `dd-trace` SDK for error tracking and analytics. |
|
|
16
|
+
| [NoopAnalyticsClient](Class.NoopAnalyticsClient) | No-op implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Suitable for development, testing, or environments where analytics is disabled. |
|
|
17
|
+
| [SentryAnalyticsClient](Class.SentryAnalyticsClient) | Sentry implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort). Uses the official `@sentry/node` SDK for error tracking and analytics. |
|
|
19
18
|
|
|
20
19
|
## Interfaces
|
|
21
20
|
|
|
22
|
-
| Interface
|
|
23
|
-
|
|
|
24
|
-
| [IAnalyticsBreadcrumb](Interface.IAnalyticsBreadcrumb)
|
|
25
|
-
| [IAnalyticsModuleOptions](Interface.IAnalyticsModuleOptions) | Configuration options for the `AnalyticsModule`.
|
|
26
|
-
| [IAnalyticsUser](Interface.IAnalyticsUser)
|
|
21
|
+
| Interface | Description |
|
|
22
|
+
| ------ | ------ |
|
|
23
|
+
| [IAnalyticsBreadcrumb](Interface.IAnalyticsBreadcrumb) | Represents a breadcrumb entry for analytics trail. |
|
|
24
|
+
| [IAnalyticsModuleOptions](Interface.IAnalyticsModuleOptions) | Configuration options for the `AnalyticsModule`. |
|
|
25
|
+
| [IAnalyticsUser](Interface.IAnalyticsUser) | Represents user context for analytics tracking. |
|
|
27
26
|
|
|
28
27
|
## Type Aliases
|
|
29
28
|
|
|
30
|
-
| Type Alias
|
|
31
|
-
|
|
|
29
|
+
| Type Alias | Description |
|
|
30
|
+
| ------ | ------ |
|
|
32
31
|
| [AnalyticsLevel](TypeAlias.AnalyticsLevel) | Severity level for analytics messages. |
|
|
33
32
|
|
|
34
33
|
## Variables
|
|
35
34
|
|
|
36
|
-
| Variable
|
|
37
|
-
|
|
|
38
|
-
| [
|
|
39
|
-
| [
|
|
40
|
-
| [
|
|
41
|
-
| [
|
|
42
|
-
| [
|
|
43
|
-
| [
|
|
44
|
-
| [
|
|
45
|
-
| [
|
|
35
|
+
| Variable | Description |
|
|
36
|
+
| ------ | ------ |
|
|
37
|
+
| [APPINSIGHTS\_CONFIG\_ENTRIES](Variable.APPINSIGHTS_CONFIG_ENTRIES) | Configuration entries required by the Application Insights analytics provider. |
|
|
38
|
+
| [APPLICATIONINSIGHTS\_CONNECTION\_STRING](Variable.APPLICATIONINSIGHTS_CONNECTION_STRING) | Application Insights connection string. |
|
|
39
|
+
| [DATADOG\_CONFIG\_ENTRIES](Variable.DATADOG_CONFIG_ENTRIES) | Configuration entries required by the Datadog analytics provider. |
|
|
40
|
+
| [DD\_ENV](Variable.DD_ENV) | Datadog environment identifier (e.g. `production`, `staging`). |
|
|
41
|
+
| [DD\_SERVICE](Variable.DD_SERVICE) | Datadog service name. |
|
|
42
|
+
| [SENTRY\_CONFIG\_ENTRIES](Variable.SENTRY_CONFIG_ENTRIES) | Configuration entries required by the Sentry analytics provider. |
|
|
43
|
+
| [SENTRY\_DSN](Variable.SENTRY_DSN) | Sentry DSN for error tracking. |
|
|
44
|
+
| [SENTRY\_ENVIRONMENT](Variable.SENTRY_ENVIRONMENT) | Sentry environment identifier (e.g. `production`, `staging`). |
|
|
@@ -3,7 +3,6 @@ title: 'Class: AnonymousAuthGuard'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: AnonymousAuthGuard
|
|
8
7
|
|
|
9
8
|
Defined in: [libs/platform-authentication/src/guards/AnonymousAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/AnonymousAuthGuard.ts#L14)
|
|
@@ -22,12 +21,12 @@ The `AnonymousAuthGuard` protects routes using anonymous authentication.
|
|
|
22
21
|
new AnonymousAuthGuard(...args): AnonymousAuthGuard;
|
|
23
22
|
```
|
|
24
23
|
|
|
25
|
-
Defined in:
|
|
24
|
+
Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
|
|
26
25
|
|
|
27
26
|
#### Parameters
|
|
28
27
|
|
|
29
|
-
| Parameter | Type
|
|
30
|
-
|
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
31
30
|
| ...`args` | `any`[] |
|
|
32
31
|
|
|
33
32
|
#### Returns
|
|
@@ -37,5 +36,5 @@ Defined in: node_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
|
|
|
37
36
|
#### Inherited from
|
|
38
37
|
|
|
39
38
|
```ts
|
|
40
|
-
AuthGuard('anonymous').constructor
|
|
39
|
+
AuthGuard('anonymous').constructor
|
|
41
40
|
```
|