@breadstone/archipel-mcp 0.0.11 → 0.0.14
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/package.json +1 -1
- package/src/DocsLoader.js +2 -5
- package/src/GuidesLoader.js +2 -5
- package/data/guides/ai-text-generation.md +0 -361
- package/data/guides/analytics-and-error-tracking.md +0 -189
- package/data/guides/authentication-and-authorization.md +0 -657
- package/data/guides/blob-storage.md +0 -242
- package/data/guides/caching.md +0 -255
- package/data/guides/cryptography-and-otp.md +0 -240
- package/data/guides/document-generation.md +0 -174
- package/data/guides/email-delivery.md +0 -196
- package/data/guides/esigning-integration.md +0 -231
- package/data/guides/getting-started.md +0 -351
- package/data/guides/implementing-ports.md +0 -317
- package/data/guides/index.md +0 -61
- package/data/guides/mcp-server.md +0 -222
- package/data/guides/openapi-and-feature-discovery.md +0 -266
- package/data/guides/payments-and-feature-gating.md +0 -244
- package/data/guides/resource-management.md +0 -352
- package/data/guides/telemetry-and-observability.md +0 -190
- package/data/guides/testing.md +0 -319
- package/data/guides/tsdoc-guidelines.md +0 -45
- package/data/packages/index.md +0 -52
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +0 -141
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +0 -47
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +0 -161
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +0 -58
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +0 -47
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +0 -58
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +0 -14
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +0 -14
- package/data/packages/platform-analytics/api/index.md +0 -44
- package/data/packages/platform-analytics/index.md +0 -170
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +0 -86
- package/data/packages/platform-authentication/api/Class.AuthModule.md +0 -67
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -95
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -59
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -131
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +0 -78
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +0 -84
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +0 -136
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -71
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.MfaService.md +0 -252
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -70
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +0 -84
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -60
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -60
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -165
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -152
- package/data/packages/platform-authentication/api/Class.SessionService.md +0 -162
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +0 -61
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -48
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -47
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +0 -144
- package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -154
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -116
- package/data/packages/platform-authentication/api/Function.Token.md +0 -18
- package/data/packages/platform-authentication/api/Function.UseRoles.md +0 -24
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +0 -22
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +0 -143
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -107
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -82
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -118
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -22
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -58
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -131
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -91
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -160
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -82
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -58
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -70
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -71
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +0 -29
- package/data/packages/platform-authentication/api/Variable.User.md +0 -24
- package/data/packages/platform-authentication/api/index.md +0 -112
- package/data/packages/platform-authentication/index.md +0 -635
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -79
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +0 -49
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -75
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -248
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -51
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -197
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +0 -68
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +0 -38
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +0 -38
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +0 -64
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +0 -138
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +0 -114
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +0 -98
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -68
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +0 -12
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -12
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +0 -16
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +0 -26
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +0 -26
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/index.md +0 -59
- package/data/packages/platform-blob-storage/index.md +0 -335
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +0 -258
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +0 -295
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +0 -70
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +0 -198
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +0 -75
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +0 -121
- package/data/packages/platform-caching/api/index.md +0 -24
- package/data/packages/platform-caching/index.md +0 -116
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +0 -50
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
- package/data/packages/platform-core/api/Class.BooleanUtils.md +0 -82
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +0 -120
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +0 -83
- package/data/packages/platform-core/api/Class.CatchUtils.md +0 -93
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +0 -89
- package/data/packages/platform-core/api/Class.ConfigModule.md +0 -69
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +0 -115
- package/data/packages/platform-core/api/Class.ConfigService.md +0 -137
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +0 -125
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +0 -63
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +0 -101
- package/data/packages/platform-core/api/Class.DeviceParserService.md +0 -52
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +0 -141
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +0 -109
- package/data/packages/platform-core/api/Class.EventHub.md +0 -163
- package/data/packages/platform-core/api/Class.EventModule.md +0 -22
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +0 -147
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +0 -85
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +0 -66
- package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
- package/data/packages/platform-core/api/Class.HostModule.md +0 -31
- package/data/packages/platform-core/api/Class.HostService.md +0 -149
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +0 -59
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +0 -87
- package/data/packages/platform-core/api/Class.IdentifierModule.md +0 -40
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +0 -59
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +0 -42
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +0 -42
- package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
- package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
- package/data/packages/platform-core/api/Class.MappingService.md +0 -284
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +0 -148
- package/data/packages/platform-core/api/Class.PageableRequest.md +0 -42
- package/data/packages/platform-core/api/Class.PageableResponse.md +0 -62
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +0 -61
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +0 -94
- package/data/packages/platform-core/api/Class.QuantityResponse.md +0 -42
- package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
- package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
- package/data/packages/platform-core/api/Class.ResponseReturn.md +0 -502
- package/data/packages/platform-core/api/Class.SseHub.md +0 -183
- package/data/packages/platform-core/api/Class.SseModule.md +0 -42
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +0 -42
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +0 -85
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +0 -47
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +0 -64
- package/data/packages/platform-core/api/Function.Public.md +0 -18
- package/data/packages/platform-core/api/Function.createConfigKey.md +0 -58
- package/data/packages/platform-core/api/Function.createEventKey.md +0 -33
- package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
- package/data/packages/platform-core/api/Function.env.md +0 -28
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +0 -26
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +0 -27
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
- package/data/packages/platform-core/api/Interface.IConfigKey.md +0 -63
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +0 -40
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +0 -79
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +0 -80
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +0 -153
- package/data/packages/platform-core/api/Interface.IEventKey.md +0 -57
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -16
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +0 -232
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +0 -57
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
- package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -71
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
- package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
- package/data/packages/platform-core/api/Interface.ISseEventData.md +0 -36
- package/data/packages/platform-core/api/Interface.ISseHub.md +0 -91
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +0 -14
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +0 -18
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +0 -28
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +0 -25
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +0 -21
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +0 -15
- package/data/packages/platform-core/api/Variable.APP_NAME.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_PORT.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_URL.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +0 -14
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +0 -14
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +0 -14
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +0 -12
- package/data/packages/platform-core/api/Variable.IpAddress.md +0 -31
- package/data/packages/platform-core/api/Variable.Lang.md +0 -29
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +0 -14
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-core/api/Variable.UserAgent.md +0 -24
- package/data/packages/platform-core/api/index.md +0 -142
- package/data/packages/platform-core/index.md +0 -485
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +0 -72
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +0 -51
- package/data/packages/platform-cryptography/api/Class.OtpService.md +0 -109
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +0 -81
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +0 -46
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +0 -14
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +0 -23
- package/data/packages/platform-cryptography/api/index.md +0 -28
- package/data/packages/platform-cryptography/index.md +0 -132
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -75
- package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -70
- package/data/packages/platform-database/api/Class.DatabaseService.md +0 -160
- package/data/packages/platform-database/api/Class.PrismaService.md +0 -111
- package/data/packages/platform-database/api/Class.RepositoryBase.md +0 -586
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -55
- package/data/packages/platform-database/api/Function.pageable.md +0 -35
- package/data/packages/platform-database/api/Function.paginator.md +0 -22
- package/data/packages/platform-database/api/Function.query.md +0 -34
- package/data/packages/platform-database/api/Function.skip.md +0 -33
- package/data/packages/platform-database/api/Function.transactionalQuery.md +0 -31
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -22
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -28
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -77
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -51
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -50
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -18
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -18
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -31
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -27
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -26
- package/data/packages/platform-database/api/index.md +0 -47
- package/data/packages/platform-database/index.md +0 -300
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +0 -277
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -80
- package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -47
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -131
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -94
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -70
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -118
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -47
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -58
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -95
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -64
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -58
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/index.md +0 -47
- package/data/packages/platform-documents/index.md +0 -219
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +0 -184
- package/data/packages/platform-esigning/api/Class.EsigningError.md +0 -65
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +0 -48
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +0 -90
- package/data/packages/platform-esigning/api/Class.EsigningService.md +0 -198
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +0 -249
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +0 -101
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +0 -78
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +0 -60
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +0 -94
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +0 -58
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +0 -58
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +0 -46
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +0 -60
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigner.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +0 -142
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +0 -142
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +0 -70
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +0 -30
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +0 -32
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +0 -38
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +0 -36
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +0 -38
- package/data/packages/platform-esigning/api/index.md +0 -84
- package/data/packages/platform-esigning/index.md +0 -691
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -22
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -81
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +0 -94
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -60
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -53
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +0 -14
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +0 -28
- package/data/packages/platform-intelligence/api/index.md +0 -69
- package/data/packages/platform-intelligence/index.md +0 -131
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -20
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +0 -14
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-logging/api/index.md +0 -19
- package/data/packages/platform-logging/index.md +0 -92
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -66
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -78
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -22
- package/data/packages/platform-mailing/api/Class.MailService.md +0 -96
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -93
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -85
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -53
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -66
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -30
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +0 -12
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +0 -16
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +0 -14
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +0 -14
- package/data/packages/platform-mailing/api/index.md +0 -74
- package/data/packages/platform-mailing/index.md +0 -335
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +0 -64
- package/data/packages/platform-mcp/api/Class.McpModule.md +0 -82
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +0 -146
- package/data/packages/platform-mcp/api/Class.McpServerService.md +0 -196
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +0 -28
- package/data/packages/platform-mcp/api/Function.McpResource.md +0 -28
- package/data/packages/platform-mcp/api/Function.McpTool.md +0 -28
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +0 -46
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +0 -75
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +0 -125
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +0 -27
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +0 -58
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +0 -72
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +0 -82
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +0 -40
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +0 -40
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +0 -40
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -22
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +0 -38
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +0 -14
- package/data/packages/platform-mcp/api/index.md +0 -46
- package/data/packages/platform-mcp/index.md +0 -299
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -70
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -99
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -77
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -46
- package/data/packages/platform-openapi/api/Function.Api.md +0 -35
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +0 -42
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -18
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +0 -27
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -68
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -68
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +0 -14
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +0 -12
- package/data/packages/platform-openapi/api/index.md +0 -42
- package/data/packages/platform-openapi/index.md +0 -170
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -74
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -68
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -69
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -163
- package/data/packages/platform-payments/api/Class.MollieClient.md +0 -163
- package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -163
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -142
- package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -48
- package/data/packages/platform-payments/api/Class.StripeClient.md +0 -163
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +0 -25
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -70
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -70
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -80
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -100
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -84
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -60
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -22
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +0 -12
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/index.md +0 -63
- package/data/packages/platform-payments/index.md +0 -532
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +0 -56
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +0 -40
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +0 -84
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -22
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +0 -61
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +0 -82
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +0 -70
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +0 -60
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +0 -40
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +0 -60
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +0 -30
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +0 -12
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +0 -12
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -14
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +0 -30
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +0 -28
- package/data/packages/platform-reporting/api/index.md +0 -42
- package/data/packages/platform-reporting/index.md +0 -229
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -113
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -175
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -127
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -226
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -40
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -48
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -85
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -38
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -136
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -38
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -12
- package/data/packages/platform-telemetry/api/index.md +0 -36
- package/data/packages/platform-telemetry/index.md +0 -234
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IAnalyticsBreadcrumb'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IAnalyticsBreadcrumb
|
|
7
|
-
|
|
8
|
-
Defined in: [models/IAnalyticsBreadcrumb.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L6)
|
|
9
|
-
|
|
10
|
-
Represents a breadcrumb entry for analytics trail.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### category
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly category: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [models/IAnalyticsBreadcrumb.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L10)
|
|
21
|
-
|
|
22
|
-
Category of the breadcrumb (e.g. `http`, `navigation`, `user`).
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### data?
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly optional data?: Record<string, unknown>;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [models/IAnalyticsBreadcrumb.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L25)
|
|
33
|
-
|
|
34
|
-
Additional metadata.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### level?
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly optional level?: "fatal" | "error" | "warning" | "info" | "debug";
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [models/IAnalyticsBreadcrumb.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L20)
|
|
45
|
-
|
|
46
|
-
Severity level.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### message
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
readonly message: string;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [models/IAnalyticsBreadcrumb.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsBreadcrumb.ts#L15)
|
|
57
|
-
|
|
58
|
-
Human-readable message.
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IAnalyticsModuleOptions'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IAnalyticsModuleOptions
|
|
7
|
-
|
|
8
|
-
Defined in: [AnalyticsModule.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L16)
|
|
9
|
-
|
|
10
|
-
Configuration options for the `AnalyticsModule`.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### analyticsClient
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
analyticsClient: Type<AnalyticsClientPort>;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [AnalyticsModule.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L21)
|
|
21
|
-
|
|
22
|
-
Concrete implementation of the [AnalyticsClientPort](Class.AnalyticsClientPort).
|
|
23
|
-
For example, `SentryAnalyticsClient`, `AppInsightsAnalyticsClient`, `DatadogAnalyticsClient`, or `NoopAnalyticsClient`.
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### configEntries?
|
|
28
|
-
|
|
29
|
-
```ts
|
|
30
|
-
optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Defined in: [AnalyticsModule.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L26)
|
|
34
|
-
|
|
35
|
-
Provider-specific configuration entries to register with the config module.
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
|
-
### isGlobal?
|
|
40
|
-
|
|
41
|
-
```ts
|
|
42
|
-
optional isGlobal?: boolean;
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Defined in: [AnalyticsModule.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/AnalyticsModule.ts#L31)
|
|
46
|
-
|
|
47
|
-
When `true` the module is registered globally.
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IAnalyticsUser'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IAnalyticsUser
|
|
7
|
-
|
|
8
|
-
Defined in: [models/IAnalyticsUser.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L6)
|
|
9
|
-
|
|
10
|
-
Represents user context for analytics tracking.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### email?
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
readonly optional email?: string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [models/IAnalyticsUser.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L15)
|
|
21
|
-
|
|
22
|
-
Optional e-mail address.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### id
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
readonly id: string;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [models/IAnalyticsUser.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L10)
|
|
33
|
-
|
|
34
|
-
Unique user identifier.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### traits?
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
readonly optional traits?: Record<string, unknown>;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [models/IAnalyticsUser.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L25)
|
|
45
|
-
|
|
46
|
-
Additional user traits.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### username?
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
readonly optional username?: string;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [models/IAnalyticsUser.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/IAnalyticsUser.ts#L20)
|
|
57
|
-
|
|
58
|
-
Optional display name.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Type Alias: AnalyticsLevel'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Type Alias: AnalyticsLevel
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
type AnalyticsLevel = "fatal" | "error" | "warning" | "info" | "debug";
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [models/AnalyticsLevel.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/models/AnalyticsLevel.ts#L6)
|
|
13
|
-
|
|
14
|
-
Severity level for analytics messages.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: APPINSIGHTS\_CONFIG\_ENTRIES'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: APPINSIGHTS\_CONFIG\_ENTRIES
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const APPINSIGHTS_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [application-insights/env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L19)
|
|
13
|
-
|
|
14
|
-
Configuration entries required by the Application Insights analytics provider.
|
package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md
DELETED
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: APPLICATIONINSIGHTS\_CONNECTION\_STRING
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const APPLICATIONINSIGHTS_CONNECTION_STRING: IConfigKey<string>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [application-insights/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/application-insights/env.ts#L12)
|
|
13
|
-
|
|
14
|
-
Application Insights connection string.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: DATADOG\_CONFIG\_ENTRIES'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: DATADOG\_CONFIG\_ENTRIES
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const DATADOG_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [datadog/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L22)
|
|
13
|
-
|
|
14
|
-
Configuration entries required by the Datadog analytics provider.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: DD\_ENV'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: DD\_ENV
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const DD_ENV: IConfigKey<string>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [datadog/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L15)
|
|
13
|
-
|
|
14
|
-
Datadog environment identifier (e.g. `production`, `staging`).
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: DD\_SERVICE'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: DD\_SERVICE
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const DD_SERVICE: IConfigKey<string>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [datadog/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/datadog/env.ts#L12)
|
|
13
|
-
|
|
14
|
-
Datadog service name.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: SENTRY\_CONFIG\_ENTRIES'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: SENTRY\_CONFIG\_ENTRIES
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const SENTRY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [sentry/env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L22)
|
|
13
|
-
|
|
14
|
-
Configuration entries required by the Sentry analytics provider.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: SENTRY\_DSN'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: SENTRY\_DSN
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const SENTRY_DSN: IConfigKey<string>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [sentry/env.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L12)
|
|
13
|
-
|
|
14
|
-
Sentry DSN for error tracking.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Variable: SENTRY\_ENVIRONMENT'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Variable: SENTRY\_ENVIRONMENT
|
|
7
|
-
|
|
8
|
-
```ts
|
|
9
|
-
const SENTRY_ENVIRONMENT: IConfigKey<string>;
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
Defined in: [sentry/env.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-analytics/src/sentry/env.ts#L15)
|
|
13
|
-
|
|
14
|
-
Sentry environment identifier (e.g. `production`, `staging`).
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: '@breadstone/archipel-platform-analytics'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# @breadstone/archipel-platform-analytics
|
|
7
|
-
|
|
8
|
-
## Classes
|
|
9
|
-
|
|
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. |
|
|
18
|
-
|
|
19
|
-
## Interfaces
|
|
20
|
-
|
|
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. |
|
|
26
|
-
|
|
27
|
-
## Type Aliases
|
|
28
|
-
|
|
29
|
-
| Type Alias | Description |
|
|
30
|
-
| ------ | ------ |
|
|
31
|
-
| [AnalyticsLevel](TypeAlias.AnalyticsLevel) | Severity level for analytics messages. |
|
|
32
|
-
|
|
33
|
-
## Variables
|
|
34
|
-
|
|
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`). |
|
|
@@ -1,170 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: platform-analytics
|
|
3
|
-
description: Provider-agnostic analytics and error tracking with pluggable clients.
|
|
4
|
-
order: 14
|
|
5
|
-
tags: [analytics, error-tracking, sentry, application-insights, datadog, observability, providers]
|
|
6
|
-
package: '@breadstone/archipel-platform-analytics'
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# platform-analytics
|
|
10
|
-
|
|
11
|
-
Provider-agnostic analytics and error tracking module supporting multiple backends. Ships with Sentry, Azure Application Insights, and Datadog clients out of the box, plus a no-op fallback for environments where analytics is disabled.
|
|
12
|
-
|
|
13
|
-
**Package:** `@breadstone/archipel-platform-analytics`
|
|
14
|
-
|
|
15
|
-
## Quick Start
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { Module } from '@nestjs/common';
|
|
19
|
-
import { AnalyticsModule } from '@breadstone/archipel-platform-analytics';
|
|
20
|
-
import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
|
|
21
|
-
|
|
22
|
-
@Module({
|
|
23
|
-
imports: [
|
|
24
|
-
AnalyticsModule.register({
|
|
25
|
-
analyticsClient: SentryAnalyticsClient,
|
|
26
|
-
configEntries: SENTRY_CONFIG_ENTRIES,
|
|
27
|
-
isGlobal: true,
|
|
28
|
-
}),
|
|
29
|
-
],
|
|
30
|
-
})
|
|
31
|
-
export class AppModule {}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
## Module Configuration
|
|
37
|
-
|
|
38
|
-
### IAnalyticsModuleOptions
|
|
39
|
-
|
|
40
|
-
| Property | Type | Required | Default | Description |
|
|
41
|
-
| ----------------- | ------------------------------------- | -------- | ------- | ---------------------------------------- |
|
|
42
|
-
| `analyticsClient` | `Type<AnalyticsClientPort>` | Yes | — | Concrete analytics client implementation |
|
|
43
|
-
| `configEntries` | `ReadonlyArray<IConfigRegistryEntry>` | No | `[]` | Provider-specific configuration entries |
|
|
44
|
-
| `isGlobal` | `boolean` | No | `false` | Register as a global module |
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
## AnalyticsClientPort API
|
|
49
|
-
|
|
50
|
-
The abstract port that all analytics clients implement. Inject it anywhere:
|
|
51
|
-
|
|
52
|
-
```typescript
|
|
53
|
-
import { AnalyticsClientPort } from '@breadstone/archipel-platform-analytics';
|
|
54
|
-
|
|
55
|
-
@Injectable()
|
|
56
|
-
export class PaymentService {
|
|
57
|
-
constructor(private readonly _analytics: AnalyticsClientPort) {}
|
|
58
|
-
|
|
59
|
-
public async processPayment(): Promise<void> {
|
|
60
|
-
try {
|
|
61
|
-
// ... payment logic
|
|
62
|
-
} catch (error) {
|
|
63
|
-
this._analytics.captureException(error as Error, { feature: 'payments' });
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
}
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Methods
|
|
70
|
-
|
|
71
|
-
| Method | Signature | Description |
|
|
72
|
-
| ------------------ | ------------------------------------------------------------------------------------- | --------------------------------------- |
|
|
73
|
-
| `captureException` | `(error: Error, context?: Record<string, unknown>) => void` | Capture an error with optional context |
|
|
74
|
-
| `captureMessage` | `(message: string, level: AnalyticsLevel, context?: Record<string, unknown>) => void` | Capture a message at a severity level |
|
|
75
|
-
| `setUser` | `(user: IAnalyticsUser) => void` | Set the current user context |
|
|
76
|
-
| `clearUser` | `() => void` | Clear the current user context |
|
|
77
|
-
| `addBreadcrumb` | `(breadcrumb: IAnalyticsBreadcrumb) => void` | Add a breadcrumb to the analytics trail |
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## Built-in Providers
|
|
82
|
-
|
|
83
|
-
### SentryAnalyticsClient
|
|
84
|
-
|
|
85
|
-
Error tracking and performance monitoring via Sentry.
|
|
86
|
-
|
|
87
|
-
```typescript
|
|
88
|
-
import { SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/sentry';
|
|
89
|
-
|
|
90
|
-
AnalyticsModule.register({
|
|
91
|
-
analyticsClient: SentryAnalyticsClient,
|
|
92
|
-
configEntries: SENTRY_CONFIG_ENTRIES,
|
|
93
|
-
});
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
**Environment variables:** `SENTRY_DSN`, `SENTRY_ENVIRONMENT`
|
|
97
|
-
|
|
98
|
-
### AppInsightsAnalyticsClient
|
|
99
|
-
|
|
100
|
-
Azure Application Insights integration.
|
|
101
|
-
|
|
102
|
-
```typescript
|
|
103
|
-
import {
|
|
104
|
-
AppInsightsAnalyticsClient,
|
|
105
|
-
APPINSIGHTS_CONFIG_ENTRIES,
|
|
106
|
-
} from '@breadstone/archipel-platform-analytics/appinsights';
|
|
107
|
-
|
|
108
|
-
AnalyticsModule.register({
|
|
109
|
-
analyticsClient: AppInsightsAnalyticsClient,
|
|
110
|
-
configEntries: APPINSIGHTS_CONFIG_ENTRIES,
|
|
111
|
-
});
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
**Environment variables:** `APPLICATIONINSIGHTS_CONNECTION_STRING`
|
|
115
|
-
|
|
116
|
-
### DatadogAnalyticsClient
|
|
117
|
-
|
|
118
|
-
Datadog APM and error tracking.
|
|
119
|
-
|
|
120
|
-
```typescript
|
|
121
|
-
import { DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES } from '@breadstone/archipel-platform-analytics/datadog';
|
|
122
|
-
|
|
123
|
-
AnalyticsModule.register({
|
|
124
|
-
analyticsClient: DatadogAnalyticsClient,
|
|
125
|
-
configEntries: DATADOG_CONFIG_ENTRIES,
|
|
126
|
-
});
|
|
127
|
-
```
|
|
128
|
-
|
|
129
|
-
**Environment variables:** `DD_SERVICE`, `DD_ENV`
|
|
130
|
-
|
|
131
|
-
### NoopAnalyticsClient
|
|
132
|
-
|
|
133
|
-
Silent no-op client for environments where analytics is disabled:
|
|
134
|
-
|
|
135
|
-
```typescript
|
|
136
|
-
import { NoopAnalyticsClient } from '@breadstone/archipel-platform-analytics';
|
|
137
|
-
|
|
138
|
-
AnalyticsModule.register({
|
|
139
|
-
analyticsClient: NoopAnalyticsClient,
|
|
140
|
-
});
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
---
|
|
144
|
-
|
|
145
|
-
## Sub-path Imports
|
|
146
|
-
|
|
147
|
-
Each provider is tree-shakeable via sub-path imports:
|
|
148
|
-
|
|
149
|
-
| Import Path | Contents |
|
|
150
|
-
| ----------------------------------------------------- | ------------------------------------------------------ |
|
|
151
|
-
| `@breadstone/archipel-platform-analytics` | Core module, port, models, NoopAnalyticsClient |
|
|
152
|
-
| `@breadstone/archipel-platform-analytics/sentry` | SentryAnalyticsClient, SENTRY_CONFIG_ENTRIES |
|
|
153
|
-
| `@breadstone/archipel-platform-analytics/appinsights` | AppInsightsAnalyticsClient, APPINSIGHTS_CONFIG_ENTRIES |
|
|
154
|
-
| `@breadstone/archipel-platform-analytics/datadog` | DatadogAnalyticsClient, DATADOG_CONFIG_ENTRIES |
|
|
155
|
-
|
|
156
|
-
---
|
|
157
|
-
|
|
158
|
-
## Exports Summary
|
|
159
|
-
|
|
160
|
-
| Export | Type | Description |
|
|
161
|
-
| ---------------------------- | ------------- | ---------------------------------------------- |
|
|
162
|
-
| `AnalyticsModule` | NestJS Module | Main module with `register()` |
|
|
163
|
-
| `AnalyticsClientPort` | Port | Abstract analytics contract |
|
|
164
|
-
| `NoopAnalyticsClient` | Client | No-op fallback implementation |
|
|
165
|
-
| `SentryAnalyticsClient` | Client | Sentry provider (sub-path) |
|
|
166
|
-
| `AppInsightsAnalyticsClient` | Client | Azure Application Insights provider (sub-path) |
|
|
167
|
-
| `DatadogAnalyticsClient` | Client | Datadog provider (sub-path) |
|
|
168
|
-
| `AnalyticsLevel` | Type | Severity level union |
|
|
169
|
-
| `IAnalyticsBreadcrumb` | Interface | Breadcrumb entry model |
|
|
170
|
-
| `IAnalyticsUser` | Interface | User context model |
|
|
@@ -1,40 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Class: AnonymousAuthGuard'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Class: AnonymousAuthGuard
|
|
7
|
-
|
|
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)
|
|
9
|
-
|
|
10
|
-
The `AnonymousAuthGuard` protects routes using anonymous authentication.
|
|
11
|
-
|
|
12
|
-
## Extends
|
|
13
|
-
|
|
14
|
-
- `IAuthGuard`
|
|
15
|
-
|
|
16
|
-
## Constructors
|
|
17
|
-
|
|
18
|
-
### Constructor
|
|
19
|
-
|
|
20
|
-
```ts
|
|
21
|
-
new AnonymousAuthGuard(...args): AnonymousAuthGuard;
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
|
|
25
|
-
|
|
26
|
-
#### Parameters
|
|
27
|
-
|
|
28
|
-
| Parameter | Type |
|
|
29
|
-
| ------ | ------ |
|
|
30
|
-
| ...`args` | `any`[] |
|
|
31
|
-
|
|
32
|
-
#### Returns
|
|
33
|
-
|
|
34
|
-
`AnonymousAuthGuard`
|
|
35
|
-
|
|
36
|
-
#### Inherited from
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
AuthGuard('anonymous').constructor
|
|
40
|
-
```
|
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Class: AppleConnector'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Class: AppleConnector
|
|
7
|
-
|
|
8
|
-
Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L29)
|
|
9
|
-
|
|
10
|
-
The `AppleConnector` integrates Apple Sign In authentication.
|
|
11
|
-
|
|
12
|
-
## Extends
|
|
13
|
-
|
|
14
|
-
- `_ConnectorBase`\<*typeof* `AppleStrategy`, `this`\>
|
|
15
|
-
|
|
16
|
-
## Indexable
|
|
17
|
-
|
|
18
|
-
```ts
|
|
19
|
-
[key: string]: any
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## Constructors
|
|
23
|
-
|
|
24
|
-
### Constructor
|
|
25
|
-
|
|
26
|
-
```ts
|
|
27
|
-
new AppleConnector(socialAuth, configService): AppleConnector;
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L45)
|
|
31
|
-
|
|
32
|
-
Initializes a new instance of the `AppleConnector` class.
|
|
33
|
-
|
|
34
|
-
#### Parameters
|
|
35
|
-
|
|
36
|
-
| Parameter | Type | Description |
|
|
37
|
-
| ------ | ------ | ------ |
|
|
38
|
-
| `socialAuth` | [`SocialAuthPort`](Class.SocialAuthPort) | Social auth port instance. |
|
|
39
|
-
| `configService` | `ConfigService` | Configuration service instance. |
|
|
40
|
-
|
|
41
|
-
#### Returns
|
|
42
|
-
|
|
43
|
-
`AppleConnector`
|
|
44
|
-
|
|
45
|
-
#### Overrides
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
ConnectorBase(Strategy, 'apple').constructor
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## Methods
|
|
52
|
-
|
|
53
|
-
### validate()
|
|
54
|
-
|
|
55
|
-
```ts
|
|
56
|
-
validate(
|
|
57
|
-
accessToken,
|
|
58
|
-
refreshToken,
|
|
59
|
-
idToken,
|
|
60
|
-
profile): Promise<IAuthSubject>;
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Defined in: [libs/platform-authentication/src/connectors/AppleConnector.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/AppleConnector.ts#L81)
|
|
64
|
-
|
|
65
|
-
Validates the Apple authentication payload.
|
|
66
|
-
|
|
67
|
-
#### Parameters
|
|
68
|
-
|
|
69
|
-
| Parameter | Type | Description |
|
|
70
|
-
| ------ | ------ | ------ |
|
|
71
|
-
| `accessToken` | `string` | OAuth access token. |
|
|
72
|
-
| `refreshToken` | `string` | OAuth refresh token. |
|
|
73
|
-
| `idToken` | `string` | Apple identity token. |
|
|
74
|
-
| `profile` | `IAppleProfile` | Apple profile data. |
|
|
75
|
-
|
|
76
|
-
#### Returns
|
|
77
|
-
|
|
78
|
-
`Promise`\<[`IAuthSubject`](Interface.IAuthSubject)\>
|
|
79
|
-
|
|
80
|
-
The authenticated user.
|
|
81
|
-
|
|
82
|
-
#### Overrides
|
|
83
|
-
|
|
84
|
-
```ts
|
|
85
|
-
ConnectorBase(Strategy, 'apple').validate
|
|
86
|
-
```
|