@breadstone/archipel-mcp 0.0.1 → 0.0.3
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/packages/index.md +9 -6
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +142 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +48 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +162 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +170 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +59 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +48 -0
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +59 -0
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +15 -0
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +15 -0
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +15 -0
- package/data/packages/platform-analytics/api/index.md +45 -0
- package/data/packages/platform-analytics/index.md +170 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +81 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -7
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -4
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +73 -0
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +25 -4
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -4
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaService.md +0 -4
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +79 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -4
- package/data/packages/platform-authentication/api/Class.SessionService.md +0 -4
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +6 -10
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -4
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -4
- package/data/packages/platform-authentication/api/Function.Token.md +19 -0
- package/data/packages/platform-authentication/api/Function.UseRoles.md +25 -0
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +23 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +37 -12
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -4
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -4
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -4
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +15 -0
- package/data/packages/platform-authentication/api/Variable.User.md +25 -0
- package/data/packages/platform-authentication/api/index.md +48 -450
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +197 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -6
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -4
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +69 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +39 -0
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +29 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +4 -8
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -10
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +14 -18
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +7 -11
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +5 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +10 -14
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -4
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -7
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +1 -5
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +6 -6
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +13 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +27 -0
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-blob-storage/api/index.md +14 -65
- package/data/packages/platform-blob-storage/index.md +77 -22
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +2 -2
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +16 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +2 -2
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +1 -3
- package/data/packages/platform-core/api/Class.IdentifierModule.md +2 -2
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +55 -1
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +10 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +21 -21
- package/data/packages/platform-core/api/Function.Public.md +19 -0
- package/data/packages/platform-core/api/Function.createConfigKey.md +60 -0
- package/data/packages/platform-core/api/Function.createEventKey.md +34 -0
- package/data/packages/platform-core/api/Function.createMappingKey.md +40 -0
- package/data/packages/platform-core/api/Function.env.md +29 -0
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +27 -0
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +28 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +3 -22
- package/data/packages/platform-core/api/Variable.APP_PORT.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_URL.md +15 -0
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +15 -0
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +13 -0
- package/data/packages/platform-core/api/Variable.IntelligenceConversationMessageRoles.md +27 -0
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-core/api/Variable.IpAddress.md +32 -0
- package/data/packages/platform-core/api/Variable.Lang.md +30 -0
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +15 -0
- package/data/packages/platform-core/api/Variable.OTP_SERVICE_TOKEN.md +15 -0
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-core/api/Variable.TOTP_EPOCH_TOLERANCE.md +24 -0
- package/data/packages/platform-core/api/Variable.UserAgent.md +25 -0
- package/data/packages/platform-core/api/index.md +29 -488
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -4
- package/data/packages/platform-database/api/Class.DatabaseService.md +0 -4
- package/data/packages/platform-database/api/Class.PrismaService.md +0 -4
- package/data/packages/platform-database/api/Class.RepositoryBase.md +65 -4
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -4
- package/data/packages/platform-database/api/Function.pageable.md +32 -0
- package/data/packages/platform-database/api/Function.paginator.md +23 -0
- package/data/packages/platform-database/api/Function.query.md +35 -0
- package/data/packages/platform-database/api/Function.skip.md +34 -0
- package/data/packages/platform-database/api/Function.transactionalQuery.md +32 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -4
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -4
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -4
- package/data/packages/platform-database/api/index.md +7 -142
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +180 -4
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -4
- package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -4
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -4
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -4
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -4
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +15 -0
- package/data/packages/platform-documents/api/index.md +6 -49
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +185 -0
- package/data/packages/platform-esigning/api/Class.EsigningError.md +66 -0
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +49 -0
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +91 -0
- package/data/packages/platform-esigning/api/Class.EsigningService.md +199 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +250 -0
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +102 -0
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +79 -0
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +61 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +95 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +59 -0
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +47 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +61 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigner.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +83 -0
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +143 -0
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +71 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +15 -0
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +13 -0
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +31 -0
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +33 -0
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +39 -0
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +37 -0
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +39 -0
- package/data/packages/platform-esigning/api/index.md +85 -0
- package/data/packages/platform-esigning/index.md +691 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -4
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +15 -0
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-logging/api/index.md +7 -29
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +19 -7
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +1 -7
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +16 -4
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -4
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -4
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -4
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +13 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +17 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +15 -0
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +15 -0
- package/data/packages/platform-mailing/api/index.md +32 -361
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpResource.md +29 -0
- package/data/packages/platform-mcp/api/Function.McpTool.md +29 -0
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +15 -0
- package/data/packages/platform-mcp/api/index.md +8 -84
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -4
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -4
- package/data/packages/platform-openapi/api/Function.Api.md +36 -0
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +43 -0
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +19 -0
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +26 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -4
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -4
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +15 -0
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +15 -0
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +13 -0
- package/data/packages/platform-openapi/api/index.md +14 -180
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -4
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -4
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -4
- package/data/packages/platform-payments/api/Class.MollieClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -4
- package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -4
- package/data/packages/platform-payments/api/Class.StripeClient.md +0 -4
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +26 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -4
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -4
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -4
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +13 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +15 -0
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +15 -0
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +15 -0
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +15 -0
- package/data/packages/platform-payments/api/index.md +20 -199
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +31 -0
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +29 -0
- package/data/packages/platform-reporting/api/index.md +4 -51
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -4
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -4
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +13 -0
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +13 -0
- package/data/packages/platform-telemetry/api/index.md +7 -51
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +0 -151
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +0 -113
|
@@ -152,494 +152,35 @@ editUrl: false
|
|
|
152
152
|
|
|
153
153
|
## Variables
|
|
154
154
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
### APP_VERSION
|
|
180
|
-
|
|
181
|
-
```ts
|
|
182
|
-
const APP_VERSION: IConfigKey<string>;
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L19)
|
|
186
|
-
|
|
187
|
-
Semantic version of the running application (e.g. `1.2.3`).
|
|
188
|
-
|
|
189
|
-
---
|
|
190
|
-
|
|
191
|
-
### HEALTH_INDICATORS_TOKEN
|
|
192
|
-
|
|
193
|
-
```ts
|
|
194
|
-
const HEALTH_INDICATORS_TOKEN: typeof HEALTH_INDICATORS_TOKEN;
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
Defined in: [health/HealthTokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthTokens.ts#L2)
|
|
198
|
-
|
|
199
|
-
Injection token for registered health indicators
|
|
200
|
-
|
|
201
|
-
---
|
|
202
|
-
|
|
203
|
-
### ID_GENERATOR_TOKEN
|
|
204
|
-
|
|
205
|
-
```ts
|
|
206
|
-
const ID_GENERATOR_TOKEN: typeof ID_GENERATOR_TOKEN;
|
|
207
|
-
```
|
|
208
|
-
|
|
209
|
-
Defined in: [identifiers/IdentifierTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierTokens.ts#L6)
|
|
210
|
-
|
|
211
|
-
Interface for ID generators
|
|
212
|
-
|
|
213
|
-
---
|
|
214
|
-
|
|
215
|
-
### INTELLIGENCE_MAX_OUTPUT_TOKENS
|
|
216
|
-
|
|
217
|
-
```ts
|
|
218
|
-
const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
Defined in: [env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L38)
|
|
222
|
-
|
|
223
|
-
Maximum number of output tokens for the AI model.
|
|
224
|
-
|
|
225
|
-
---
|
|
226
|
-
|
|
227
|
-
### INTELLIGENCE_MODEL
|
|
228
|
-
|
|
229
|
-
```ts
|
|
230
|
-
const INTELLIGENCE_MODEL: IConfigKey<string>;
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
Defined in: [env.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L29)
|
|
234
|
-
|
|
235
|
-
AI model identifier to use for text generation.
|
|
236
|
-
|
|
237
|
-
---
|
|
238
|
-
|
|
239
|
-
### INTELLIGENCE_TEMPERATURE
|
|
240
|
-
|
|
241
|
-
```ts
|
|
242
|
-
const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
Defined in: [env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L32)
|
|
246
|
-
|
|
247
|
-
Sampling temperature for the AI model.
|
|
248
|
-
|
|
249
|
-
---
|
|
250
|
-
|
|
251
|
-
### INTELLIGENCE_TOP_P
|
|
252
|
-
|
|
253
|
-
```ts
|
|
254
|
-
const INTELLIGENCE_TOP_P: IConfigKey<number>;
|
|
255
|
-
```
|
|
256
|
-
|
|
257
|
-
Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L35)
|
|
258
|
-
|
|
259
|
-
Top-p (nucleus sampling) for the AI model.
|
|
260
|
-
|
|
261
|
-
---
|
|
262
|
-
|
|
263
|
-
### IntelligenceConversationMessageRoles
|
|
264
|
-
|
|
265
|
-
```ts
|
|
266
|
-
const IntelligenceConversationMessageRoles: {
|
|
267
|
-
Assistant: 'assistant';
|
|
268
|
-
System: 'system';
|
|
269
|
-
User: 'user';
|
|
270
|
-
};
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
Defined in: [intelligence/contracts/IntelligenceConversationMessageRoles.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L4)
|
|
274
|
-
|
|
275
|
-
Enumerates the conversation roles used for contextual snapshots and messages.
|
|
276
|
-
|
|
277
|
-
#### Type Declaration
|
|
278
|
-
|
|
279
|
-
| Name | Type | Default value | Defined in |
|
|
280
|
-
| ------------------------------------------- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
281
|
-
| <a id="property-assistant"></a> `Assistant` | `"assistant"` | `'assistant'` | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L6) |
|
|
282
|
-
| <a id="property-system"></a> `System` | `"system"` | `'system'` | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L7) |
|
|
283
|
-
| <a id="property-user"></a> `User` | `"user"` | `'user'` | [intelligence/contracts/IntelligenceConversationMessageRoles.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L5) |
|
|
284
|
-
|
|
285
|
-
---
|
|
286
|
-
|
|
287
|
-
### IntelligenceProviderNames
|
|
288
|
-
|
|
289
|
-
```ts
|
|
290
|
-
const IntelligenceProviderNames: {
|
|
291
|
-
Anthropic: 'anthropic';
|
|
292
|
-
Google: 'google';
|
|
293
|
-
Grok: 'grok';
|
|
294
|
-
OpenAI: 'openai';
|
|
295
|
-
};
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
Defined in: [intelligence/contracts/IntelligenceProviderNames.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L4)
|
|
299
|
-
|
|
300
|
-
Enumerates the supported model providers powering the intelligence pipeline.
|
|
301
|
-
|
|
302
|
-
#### Type Declaration
|
|
303
|
-
|
|
304
|
-
| Name | Type | Default value | Defined in |
|
|
305
|
-
| ------------------------------------------- | ------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
306
|
-
| <a id="property-anthropic"></a> `Anthropic` | `"anthropic"` | `'anthropic'` | [intelligence/contracts/IntelligenceProviderNames.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L6) |
|
|
307
|
-
| <a id="property-google"></a> `Google` | `"google"` | `'google'` | [intelligence/contracts/IntelligenceProviderNames.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L7) |
|
|
308
|
-
| <a id="property-grok"></a> `Grok` | `"grok"` | `'grok'` | [intelligence/contracts/IntelligenceProviderNames.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L8) |
|
|
309
|
-
| <a id="property-openai"></a> `OpenAI` | `"openai"` | `'openai'` | [intelligence/contracts/IntelligenceProviderNames.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L5) |
|
|
310
|
-
|
|
311
|
-
---
|
|
312
|
-
|
|
313
|
-
### IpAddress
|
|
314
|
-
|
|
315
|
-
```ts
|
|
316
|
-
const IpAddress: (...dataOrPipes) => ParameterDecorator;
|
|
317
|
-
```
|
|
318
|
-
|
|
319
|
-
Defined in: [decorators/IpAddress.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/IpAddress.ts#L15)
|
|
320
|
-
|
|
321
|
-
Extracts the client IP address from the current HTTP request.
|
|
322
|
-
Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output.
|
|
323
|
-
|
|
324
|
-
Examples:
|
|
325
|
-
"192.168.0.5" -> "192.168.0.5"
|
|
326
|
-
"::ffff:127.0.0.1" -> "127.0.0.1"
|
|
327
|
-
"::1" / "127.0.0.1" -> "localhost"
|
|
328
|
-
undefined / "" -> undefined
|
|
329
|
-
|
|
330
|
-
#### Parameters
|
|
331
|
-
|
|
332
|
-
| Parameter | Type |
|
|
333
|
-
| ---------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
334
|
-
| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
|
|
335
|
-
|
|
336
|
-
#### Returns
|
|
337
|
-
|
|
338
|
-
`ParameterDecorator`
|
|
339
|
-
|
|
340
|
-
---
|
|
341
|
-
|
|
342
|
-
### IS_PUBLIC_KEY
|
|
343
|
-
|
|
344
|
-
```ts
|
|
345
|
-
const IS_PUBLIC_KEY: 'isPublic' = 'isPublic';
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
Defined in: [decorators/Public.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L7)
|
|
349
|
-
|
|
350
|
-
---
|
|
351
|
-
|
|
352
|
-
### Lang
|
|
353
|
-
|
|
354
|
-
```ts
|
|
355
|
-
const Lang: (...dataOrPipes) => ParameterDecorator;
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
Defined in: [decorators/Lang.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Lang.ts#L13)
|
|
359
|
-
|
|
360
|
-
Extracts the first language token from the Accept-Language header.
|
|
361
|
-
|
|
362
|
-
Examples:
|
|
363
|
-
"da, en-gb;q=0.8, en;q=0.7" -> "da"
|
|
364
|
-
"en-US,en;q=0.9" -> "en-US"
|
|
365
|
-
undefined / "" -> undefined
|
|
366
|
-
|
|
367
|
-
#### Parameters
|
|
368
|
-
|
|
369
|
-
| Parameter | Type |
|
|
370
|
-
| ---------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
371
|
-
| ...`dataOrPipes` | ( \| `string` \| `PipeTransform`\<`any`, `any`\> \| `Type`\<`PipeTransform`\<`any`, `any`\>\> \| `undefined`)[] |
|
|
372
|
-
|
|
373
|
-
#### Returns
|
|
374
|
-
|
|
375
|
-
`ParameterDecorator`
|
|
376
|
-
|
|
377
|
-
---
|
|
378
|
-
|
|
379
|
-
### NODE_ENV
|
|
380
|
-
|
|
381
|
-
```ts
|
|
382
|
-
const NODE_ENV: IConfigKey<string>;
|
|
383
|
-
```
|
|
384
|
-
|
|
385
|
-
Defined in: [env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L22)
|
|
386
|
-
|
|
387
|
-
The current Node.js environment (`development`, `production`, etc.).
|
|
388
|
-
|
|
389
|
-
---
|
|
390
|
-
|
|
391
|
-
### OTP_SERVICE_TOKEN
|
|
392
|
-
|
|
393
|
-
```ts
|
|
394
|
-
const OTP_SERVICE_TOKEN: typeof OTP_SERVICE_TOKEN;
|
|
395
|
-
```
|
|
396
|
-
|
|
397
|
-
Defined in: [services/OtpService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L14)
|
|
398
|
-
|
|
399
|
-
Injection token for [IOtpService](Interface.IOtpService).
|
|
400
|
-
|
|
401
|
-
---
|
|
402
|
-
|
|
403
|
-
### PLATFORM_CORE_CONFIG_ENTRIES
|
|
404
|
-
|
|
405
|
-
```ts
|
|
406
|
-
const PLATFORM_CORE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
407
|
-
```
|
|
408
|
-
|
|
409
|
-
Defined in: [env.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L45)
|
|
410
|
-
|
|
411
|
-
All configuration entries required by `platform-core`.
|
|
412
|
-
|
|
413
|
-
---
|
|
414
|
-
|
|
415
|
-
### TOTP_EPOCH_TOLERANCE
|
|
416
|
-
|
|
417
|
-
```ts
|
|
418
|
-
const TOTP_EPOCH_TOLERANCE: 30 = 30;
|
|
419
|
-
```
|
|
420
|
-
|
|
421
|
-
Defined in: [services/OtpService.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L30)
|
|
422
|
-
|
|
423
|
-
TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`).
|
|
424
|
-
|
|
425
|
-
Each time step equals 30 seconds by default (RFC 6238).
|
|
426
|
-
|
|
427
|
-
| `epochTolerance` | Accepted range |
|
|
428
|
-
| ---------------- | ----------------- |
|
|
429
|
-
| 0 | current step only |
|
|
430
|
-
| 30 | ±1 step (±30 s) |
|
|
431
|
-
| 60 | ±2 steps (±60 s) |
|
|
432
|
-
| 90 | ±3 steps (±90 s) |
|
|
433
|
-
|
|
434
|
-
---
|
|
435
|
-
|
|
436
|
-
### UserAgent
|
|
437
|
-
|
|
438
|
-
```ts
|
|
439
|
-
const UserAgent: (...dataOrPipes) => ParameterDecorator;
|
|
440
|
-
```
|
|
441
|
-
|
|
442
|
-
Defined in: [decorators/UserAgent.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/UserAgent.ts#L8)
|
|
443
|
-
|
|
444
|
-
Extracts the User-Agent header from the incoming HTTP request.
|
|
445
|
-
|
|
446
|
-
#### Parameters
|
|
447
|
-
|
|
448
|
-
| Parameter | Type |
|
|
449
|
-
| ---------------- | ----------- |
|
|
450
|
-
| ...`dataOrPipes` | `unknown`[] |
|
|
451
|
-
|
|
452
|
-
#### Returns
|
|
453
|
-
|
|
454
|
-
`ParameterDecorator`
|
|
155
|
+
| Variable | Description |
|
|
156
|
+
| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
157
|
+
| [APP_PORT](Variable.APP_PORT) | HTTP port the application listens on. |
|
|
158
|
+
| [APP_URL](Variable.APP_URL) | Base URL the application is served from (e.g. `https://example.com`). |
|
|
159
|
+
| [APP_VERSION](Variable.APP_VERSION) | Semantic version of the running application (e.g. `1.2.3`). |
|
|
160
|
+
| [HEALTH_INDICATORS_TOKEN](Variable.HEALTH_INDICATORS_TOKEN) | Injection token for registered health indicators |
|
|
161
|
+
| [ID_GENERATOR_TOKEN](Variable.ID_GENERATOR_TOKEN) | Interface for ID generators |
|
|
162
|
+
| [INTELLIGENCE_MAX_OUTPUT_TOKENS](Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS) | Maximum number of output tokens for the AI model. |
|
|
163
|
+
| [INTELLIGENCE_MODEL](Variable.INTELLIGENCE_MODEL) | AI model identifier to use for text generation. |
|
|
164
|
+
| [INTELLIGENCE_TEMPERATURE](Variable.INTELLIGENCE_TEMPERATURE) | Sampling temperature for the AI model. |
|
|
165
|
+
| [INTELLIGENCE_TOP_P](Variable.INTELLIGENCE_TOP_P) | Top-p (nucleus sampling) for the AI model. |
|
|
166
|
+
| [IntelligenceConversationMessageRoles](Variable.IntelligenceConversationMessageRoles) | Enumerates the conversation roles used for contextual snapshots and messages. |
|
|
167
|
+
| [IntelligenceProviderNames](Variable.IntelligenceProviderNames) | Enumerates the supported model providers powering the intelligence pipeline. |
|
|
168
|
+
| [IpAddress](Variable.IpAddress) | Extracts the client IP address from the current HTTP request. Handles IPv6 (::1), proxy headers (X-Forwarded-For), and normalizes the output. |
|
|
169
|
+
| [IS_PUBLIC_KEY](Variable.IS_PUBLIC_KEY) | - |
|
|
170
|
+
| [Lang](Variable.Lang) | Extracts the first language token from the Accept-Language header. |
|
|
171
|
+
| [NODE_ENV](Variable.NODE_ENV) | The current Node.js environment (`development`, `production`, etc.). |
|
|
172
|
+
| [OTP_SERVICE_TOKEN](Variable.OTP_SERVICE_TOKEN) | Injection token for [IOtpService](Interface.IOtpService). |
|
|
173
|
+
| [PLATFORM_CORE_CONFIG_ENTRIES](Variable.PLATFORM_CORE_CONFIG_ENTRIES) | All configuration entries required by `platform-core`. |
|
|
174
|
+
| [TOTP_EPOCH_TOLERANCE](Variable.TOTP_EPOCH_TOLERANCE) | TOTP verification tolerance expressed in **seconds** (otplib v13 `epochTolerance`). |
|
|
175
|
+
| [UserAgent](Variable.UserAgent) | Extracts the User-Agent header from the incoming HTTP request. |
|
|
455
176
|
|
|
456
177
|
## Functions
|
|
457
178
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
Creates a type-safe config key.
|
|
467
|
-
|
|
468
|
-
Use this factory function to define all configuration keys in your application.
|
|
469
|
-
This ensures you don’t scatter raw strings and you assign a type to each key.
|
|
470
|
-
|
|
471
|
-
#### Type Parameters
|
|
472
|
-
|
|
473
|
-
| Type Parameter | Default type |
|
|
474
|
-
| -------------- | ------------ |
|
|
475
|
-
| `TType` | `unknown` |
|
|
476
|
-
|
|
477
|
-
#### Parameters
|
|
478
|
-
|
|
479
|
-
| Parameter | Type | Description |
|
|
480
|
-
| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
481
|
-
| `key` | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
|
|
482
|
-
|
|
483
|
-
#### Returns
|
|
484
|
-
|
|
485
|
-
[`IConfigKey`](Interface.IConfigKey)\<`TType`\>
|
|
486
|
-
|
|
487
|
-
A branded config key of type `IConfigKey<TType>` where `TType` is
|
|
488
|
-
inferred (or specified) as the expected type of the value.
|
|
489
|
-
|
|
490
|
-
#### Example
|
|
491
|
-
|
|
492
|
-
```typescript
|
|
493
|
-
// In some config-keys file
|
|
494
|
-
export const DATABASE_URL = createConfigKey<string>('DATABASE_URL');
|
|
495
|
-
export const MAX_TIMEOUT_MS = createConfigKey<number>('MAX_TIMEOUT_MS');
|
|
496
|
-
export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
Then, when fetching:
|
|
500
|
-
|
|
501
|
-
```ts
|
|
502
|
-
const url = configService.get(DATABASE_URL); // typed as string
|
|
503
|
-
const timeout = configService.get(MAX_TIMEOUT_MS); // typed as number
|
|
504
|
-
const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
|
|
505
|
-
```
|
|
506
|
-
|
|
507
|
-
#### Remarks
|
|
508
|
-
|
|
509
|
-
At runtime the returned object is minimal (just `{ key: string }`) so there is
|
|
510
|
-
virtually no overhead. The generic `TType` is only used by TypeScript for stronger
|
|
511
|
-
compile-time checking — enabling you to avoid magic strings and untyped fetches.
|
|
512
|
-
|
|
513
|
-
---
|
|
514
|
-
|
|
515
|
-
### createEventKey()
|
|
516
|
-
|
|
517
|
-
```ts
|
|
518
|
-
function createEventKey<TEvents, TKey>(eventName): IEventKey<TEvents, TKey>;
|
|
519
|
-
```
|
|
520
|
-
|
|
521
|
-
Defined in: [events/EventKey.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L26)
|
|
522
|
-
|
|
523
|
-
Creates a branded event key for the [EventHub](Class.EventHub).
|
|
524
|
-
|
|
525
|
-
#### Type Parameters
|
|
526
|
-
|
|
527
|
-
| Type Parameter |
|
|
528
|
-
| ------------------------------------------------------ |
|
|
529
|
-
| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
|
|
530
|
-
| `TKey` _extends_ `string` \| `number` \| `symbol` |
|
|
531
|
-
|
|
532
|
-
#### Parameters
|
|
533
|
-
|
|
534
|
-
| Parameter | Type | Description |
|
|
535
|
-
| ----------- | ------ | ----------------------------- |
|
|
536
|
-
| `eventName` | `TKey` | The unique name of the event. |
|
|
537
|
-
|
|
538
|
-
#### Returns
|
|
539
|
-
|
|
540
|
-
[`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\>
|
|
541
|
-
|
|
542
|
-
The branded event key encoding the payload type.
|
|
543
|
-
|
|
544
|
-
---
|
|
545
|
-
|
|
546
|
-
### createMappingKey()
|
|
547
|
-
|
|
548
|
-
```ts
|
|
549
|
-
function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
|
|
550
|
-
```
|
|
551
|
-
|
|
552
|
-
Defined in: [mapping/types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L28)
|
|
553
|
-
|
|
554
|
-
Creates a type-safe mapping key.
|
|
555
|
-
|
|
556
|
-
#### Type Parameters
|
|
557
|
-
|
|
558
|
-
| Type Parameter |
|
|
559
|
-
| -------------- |
|
|
560
|
-
| `TInput` |
|
|
561
|
-
| `TOutput` |
|
|
562
|
-
|
|
563
|
-
#### Parameters
|
|
564
|
-
|
|
565
|
-
| Parameter | Type | Description |
|
|
566
|
-
| --------- | -------- | --------------------------------------------- |
|
|
567
|
-
| `key` | `string` | The unique string identifier for the mapping. |
|
|
568
|
-
|
|
569
|
-
#### Returns
|
|
570
|
-
|
|
571
|
-
[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
|
|
572
|
-
|
|
573
|
-
A branded mapping key that encodes the input and output types.
|
|
574
|
-
|
|
575
|
-
#### Example
|
|
576
|
-
|
|
577
|
-
```typescript
|
|
578
|
-
export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
|
|
579
|
-
```
|
|
580
|
-
|
|
581
|
-
---
|
|
582
|
-
|
|
583
|
-
### env()
|
|
584
|
-
|
|
585
|
-
```ts
|
|
586
|
-
function env(strings, ...values): string;
|
|
587
|
-
```
|
|
588
|
-
|
|
589
|
-
Defined in: [utils/EnvUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/EnvUtils.ts#L7)
|
|
590
|
-
|
|
591
|
-
Marker function for environment strings.
|
|
592
|
-
|
|
593
|
-
It behaves like a normal template literal but allows you to
|
|
594
|
-
later search/grep all `env` usages in the codebase.
|
|
595
|
-
|
|
596
|
-
#### Parameters
|
|
597
|
-
|
|
598
|
-
| Parameter | Type |
|
|
599
|
-
| ----------- | ---------------------- |
|
|
600
|
-
| `strings` | `TemplateStringsArray` |
|
|
601
|
-
| ...`values` | `unknown`[] |
|
|
602
|
-
|
|
603
|
-
#### Returns
|
|
604
|
-
|
|
605
|
-
`string`
|
|
606
|
-
|
|
607
|
-
---
|
|
608
|
-
|
|
609
|
-
### getMimeTypeByFileNameOrExtension()
|
|
610
|
-
|
|
611
|
-
```ts
|
|
612
|
-
function getMimeTypeByFileNameOrExtension(...args): string | false;
|
|
613
|
-
```
|
|
614
|
-
|
|
615
|
-
Defined in: [mime/mimeTypes.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mime/mimeTypes.ts#L14)
|
|
616
|
-
|
|
617
|
-
Get MIME type by file name or extension.
|
|
618
|
-
|
|
619
|
-
#### Parameters
|
|
620
|
-
|
|
621
|
-
| Parameter | Type | Description |
|
|
622
|
-
| --------- | ------------ | ------------------------------- |
|
|
623
|
-
| ...`args` | \[`string`\] | Arguments for mime-types lookup |
|
|
624
|
-
|
|
625
|
-
#### Returns
|
|
626
|
-
|
|
627
|
-
`string` \| `false`
|
|
628
|
-
|
|
629
|
-
MIME type or false if not found
|
|
630
|
-
|
|
631
|
-
---
|
|
632
|
-
|
|
633
|
-
### Public()
|
|
634
|
-
|
|
635
|
-
```ts
|
|
636
|
-
function Public(): CustomDecorator;
|
|
637
|
-
```
|
|
638
|
-
|
|
639
|
-
Defined in: [decorators/Public.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L14)
|
|
640
|
-
|
|
641
|
-
The `Public` decorator.
|
|
642
|
-
|
|
643
|
-
#### Returns
|
|
644
|
-
|
|
645
|
-
`CustomDecorator`
|
|
179
|
+
| Function | Description |
|
|
180
|
+
| ----------------------------------------------------------------------------- | --------------------------------------------------------------- |
|
|
181
|
+
| [createConfigKey](Function.createConfigKey) | Creates a type-safe config key. |
|
|
182
|
+
| [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
|
|
183
|
+
| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |
|
|
184
|
+
| [env](Function.env) | Marker function for environment strings. |
|
|
185
|
+
| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
|
|
186
|
+
| [Public](Function.Public) | The `Public` decorator. |
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Class: DatabaseHealthIndicator
|
|
12
8
|
|
|
13
9
|
Defined in: [terminus/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/terminus/DatabaseHealthIndicator.ts#L16)
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Class: DatabaseModule
|
|
12
8
|
|
|
13
9
|
Defined in: [DatabaseModule.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L48)
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Class: DatabaseService
|
|
12
8
|
|
|
13
9
|
Defined in: [services/DatabaseService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/DatabaseService.ts#L16)
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Class: PrismaService
|
|
12
8
|
|
|
13
9
|
Defined in: [services/PrismaService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/services/PrismaService.ts#L20)
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>
|
|
12
8
|
|
|
13
9
|
Defined in: [repositories/abstracts/RepositoryBase.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L27)
|
|
@@ -44,6 +40,41 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:44](https://github.com/Rue
|
|
|
44
40
|
|
|
45
41
|
`RepositoryBase`\<`TDelegate`, `TArgs`, `TReturn`, `TEntity`\>
|
|
46
42
|
|
|
43
|
+
## Accessors
|
|
44
|
+
|
|
45
|
+
### database
|
|
46
|
+
|
|
47
|
+
#### Get Signature
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
get protected database(): DatabaseService;
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L67)
|
|
54
|
+
|
|
55
|
+
Provides access to the underlying DatabaseService for derived repositories.
|
|
56
|
+
Only to be used for transactional orchestration that spans multiple models.
|
|
57
|
+
|
|
58
|
+
##### Returns
|
|
59
|
+
|
|
60
|
+
[`DatabaseService`](Class.DatabaseService)
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
### model
|
|
65
|
+
|
|
66
|
+
#### Get Signature
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
get protected model(): TDelegate;
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L57)
|
|
73
|
+
|
|
74
|
+
##### Returns
|
|
75
|
+
|
|
76
|
+
`TDelegate`
|
|
77
|
+
|
|
47
78
|
## Methods
|
|
48
79
|
|
|
49
80
|
### aggregate()
|
|
@@ -437,6 +468,36 @@ The merged data.
|
|
|
437
468
|
|
|
438
469
|
---
|
|
439
470
|
|
|
471
|
+
### tryCatch()
|
|
472
|
+
|
|
473
|
+
```ts
|
|
474
|
+
protected tryCatch<T>(promise): Promise<T>;
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:302](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L302)
|
|
478
|
+
|
|
479
|
+
Wraps a promise in a try-catch block to handle errors uniformly.
|
|
480
|
+
|
|
481
|
+
#### Type Parameters
|
|
482
|
+
|
|
483
|
+
| Type Parameter |
|
|
484
|
+
| -------------- |
|
|
485
|
+
| `T` |
|
|
486
|
+
|
|
487
|
+
#### Parameters
|
|
488
|
+
|
|
489
|
+
| Parameter | Type | Description |
|
|
490
|
+
| --------- | ---------------- | -------------------- |
|
|
491
|
+
| `promise` | `Promise`\<`T`\> | The promise to wrap. |
|
|
492
|
+
|
|
493
|
+
#### Returns
|
|
494
|
+
|
|
495
|
+
`Promise`\<`T`\>
|
|
496
|
+
|
|
497
|
+
The result of the promise or throws an error.
|
|
498
|
+
|
|
499
|
+
---
|
|
500
|
+
|
|
440
501
|
### update()
|
|
441
502
|
|
|
442
503
|
```ts
|
|
@@ -4,10 +4,6 @@ generated: true
|
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
[**@breadstone/archipel-platform-database**](../)
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
7
|
# Class: RepositoryExceptionFilter
|
|
12
8
|
|
|
13
9
|
Defined in: [filters/RepositoryExceptionFilter.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/filters/RepositoryExceptionFilter.ts#L15)
|