@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
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: ResponseReturn\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [models/ResponseReturn.ts:
|
|
9
|
+
Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L14)
|
|
10
10
|
|
|
11
11
|
## Type Parameters
|
|
12
12
|
|
|
@@ -34,7 +34,7 @@ new ResponseReturn<T>(): ResponseReturn<T>;
|
|
|
34
34
|
optional data?: T;
|
|
35
35
|
```
|
|
36
36
|
|
|
37
|
-
Defined in: [models/ResponseReturn.ts:
|
|
37
|
+
Defined in: [models/ResponseReturn.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L34)
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ Defined in: [models/ResponseReturn.ts:38](https://github.com/RueDeRennes/archipe
|
|
|
44
44
|
optional details?: unknown;
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
Defined in: [models/ResponseReturn.ts:
|
|
47
|
+
Defined in: [models/ResponseReturn.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L44)
|
|
48
48
|
|
|
49
49
|
---
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ Defined in: [models/ResponseReturn.ts:48](https://github.com/RueDeRennes/archipe
|
|
|
54
54
|
optional error?: string;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [models/ResponseReturn.ts:
|
|
57
|
+
Defined in: [models/ResponseReturn.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L39)
|
|
58
58
|
|
|
59
59
|
---
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ Defined in: [models/ResponseReturn.ts:43](https://github.com/RueDeRennes/archipe
|
|
|
64
64
|
status: number;
|
|
65
65
|
```
|
|
66
66
|
|
|
67
|
-
Defined in: [models/ResponseReturn.ts:
|
|
67
|
+
Defined in: [models/ResponseReturn.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L29)
|
|
68
68
|
|
|
69
69
|
---
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ Defined in: [models/ResponseReturn.ts:33](https://github.com/RueDeRennes/archipe
|
|
|
74
74
|
success: boolean;
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
Defined in: [models/ResponseReturn.ts:
|
|
77
|
+
Defined in: [models/ResponseReturn.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L22)
|
|
78
78
|
|
|
79
79
|
---
|
|
80
80
|
|
|
@@ -84,7 +84,7 @@ Defined in: [models/ResponseReturn.ts:26](https://github.com/RueDeRennes/archipe
|
|
|
84
84
|
timestamp: string;
|
|
85
85
|
```
|
|
86
86
|
|
|
87
|
-
Defined in: [models/ResponseReturn.ts:
|
|
87
|
+
Defined in: [models/ResponseReturn.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L51)
|
|
88
88
|
|
|
89
89
|
## Methods
|
|
90
90
|
|
|
@@ -96,7 +96,7 @@ Defined in: [models/ResponseReturn.ts:55](https://github.com/RueDeRennes/archipe
|
|
|
96
96
|
static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [models/ResponseReturn.ts:
|
|
99
|
+
Defined in: [models/ResponseReturn.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L96)
|
|
100
100
|
|
|
101
101
|
Creates an accepted response.
|
|
102
102
|
|
|
@@ -124,7 +124,7 @@ Creates an accepted response.
|
|
|
124
124
|
static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
|
|
125
125
|
```
|
|
126
126
|
|
|
127
|
-
Defined in: [models/ResponseReturn.ts:
|
|
127
|
+
Defined in: [models/ResponseReturn.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L97)
|
|
128
128
|
|
|
129
129
|
Creates an accepted response.
|
|
130
130
|
|
|
@@ -154,7 +154,7 @@ Creates an accepted response.
|
|
|
154
154
|
static badRequest<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
-
Defined in: [models/ResponseReturn.ts:
|
|
157
|
+
Defined in: [models/ResponseReturn.ts:127](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L127)
|
|
158
158
|
|
|
159
159
|
Creates a bad request response.
|
|
160
160
|
|
|
@@ -185,7 +185,7 @@ Bad request response
|
|
|
185
185
|
static conflict<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
186
186
|
```
|
|
187
187
|
|
|
188
|
-
Defined in: [models/ResponseReturn.ts:
|
|
188
|
+
Defined in: [models/ResponseReturn.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L175)
|
|
189
189
|
|
|
190
190
|
Creates a conflict response.
|
|
191
191
|
|
|
@@ -218,7 +218,7 @@ Conflict response
|
|
|
218
218
|
static created<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
|
|
219
219
|
```
|
|
220
220
|
|
|
221
|
-
Defined in: [models/ResponseReturn.ts:
|
|
221
|
+
Defined in: [models/ResponseReturn.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L80)
|
|
222
222
|
|
|
223
223
|
Creates a resource created response.
|
|
224
224
|
|
|
@@ -246,7 +246,7 @@ Creates a resource created response.
|
|
|
246
246
|
static created<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
|
|
247
247
|
```
|
|
248
248
|
|
|
249
|
-
Defined in: [models/ResponseReturn.ts:
|
|
249
|
+
Defined in: [models/ResponseReturn.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L81)
|
|
250
250
|
|
|
251
251
|
Creates a resource created response.
|
|
252
252
|
|
|
@@ -276,7 +276,7 @@ Creates a resource created response.
|
|
|
276
276
|
static error<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
277
277
|
```
|
|
278
278
|
|
|
279
|
-
Defined in: [models/ResponseReturn.ts:
|
|
279
|
+
Defined in: [models/ResponseReturn.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L182)
|
|
280
280
|
|
|
281
281
|
Generic server error (500). Prefer attaching a safe `details` object (no stack traces in prod).
|
|
282
282
|
|
|
@@ -305,7 +305,7 @@ Generic server error (500). Prefer attaching a safe `details` object (no stack t
|
|
|
305
305
|
static forbidden<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
306
306
|
```
|
|
307
307
|
|
|
308
|
-
Defined in: [models/ResponseReturn.ts:
|
|
308
|
+
Defined in: [models/ResponseReturn.ts:151](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L151)
|
|
309
309
|
|
|
310
310
|
Creates a forbidden response.
|
|
311
311
|
|
|
@@ -336,7 +336,7 @@ Forbidden response
|
|
|
336
336
|
static fromError<TReturn>(err, defaultStatus?): ResponseReturn<TReturn>;
|
|
337
337
|
```
|
|
338
338
|
|
|
339
|
-
Defined in: [models/ResponseReturn.ts:
|
|
339
|
+
Defined in: [models/ResponseReturn.ts:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L190)
|
|
340
340
|
|
|
341
341
|
Converts an arbitrary error into a ResponseReturn.
|
|
342
342
|
|
|
@@ -367,7 +367,7 @@ Converts an arbitrary error into a ResponseReturn.
|
|
|
367
367
|
static noContent<TReturn>(): ResponseReturn<TReturn>;
|
|
368
368
|
```
|
|
369
369
|
|
|
370
|
-
Defined in: [models/ResponseReturn.ts:
|
|
370
|
+
Defined in: [models/ResponseReturn.ts:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L110)
|
|
371
371
|
|
|
372
372
|
No content variant (204). `data` is undefined by contract.
|
|
373
373
|
|
|
@@ -389,7 +389,7 @@ No content variant (204). `data` is undefined by contract.
|
|
|
389
389
|
static notFound<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
390
390
|
```
|
|
391
391
|
|
|
392
|
-
Defined in: [models/ResponseReturn.ts:
|
|
392
|
+
Defined in: [models/ResponseReturn.ts:163](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L163)
|
|
393
393
|
|
|
394
394
|
Creates a not found response.
|
|
395
395
|
|
|
@@ -422,7 +422,7 @@ Not found response
|
|
|
422
422
|
static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
|
|
423
423
|
```
|
|
424
424
|
|
|
425
|
-
Defined in: [models/ResponseReturn.ts:
|
|
425
|
+
Defined in: [models/ResponseReturn.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L64)
|
|
426
426
|
|
|
427
427
|
Creates a successful response.
|
|
428
428
|
|
|
@@ -450,7 +450,7 @@ Creates a successful response.
|
|
|
450
450
|
static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
|
|
451
451
|
```
|
|
452
452
|
|
|
453
|
-
Defined in: [models/ResponseReturn.ts:
|
|
453
|
+
Defined in: [models/ResponseReturn.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L65)
|
|
454
454
|
|
|
455
455
|
Creates a successful response.
|
|
456
456
|
|
|
@@ -480,7 +480,7 @@ Creates a successful response.
|
|
|
480
480
|
static unauthorized<TReturn>(message?, details?): ResponseReturn<TReturn>;
|
|
481
481
|
```
|
|
482
482
|
|
|
483
|
-
Defined in: [models/ResponseReturn.ts:
|
|
483
|
+
Defined in: [models/ResponseReturn.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L139)
|
|
484
484
|
|
|
485
485
|
Creates an unauthorized response.
|
|
486
486
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: Public()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: Public()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function Public(): CustomDecorator;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [decorators/Public.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L14)
|
|
14
|
+
|
|
15
|
+
The `Public` decorator.
|
|
16
|
+
|
|
17
|
+
## Returns
|
|
18
|
+
|
|
19
|
+
`CustomDecorator`
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: createConfigKey()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: createConfigKey()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createConfigKey<TType>(key): IConfigKey<TType>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [config/ConfigKey.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L74)
|
|
14
|
+
|
|
15
|
+
Creates a type-safe config key.
|
|
16
|
+
|
|
17
|
+
Use this factory function to define all configuration keys in your application.
|
|
18
|
+
This ensures you don’t scatter raw strings and you assign a type to each key.
|
|
19
|
+
|
|
20
|
+
## Type Parameters
|
|
21
|
+
|
|
22
|
+
| Type Parameter | Default type |
|
|
23
|
+
| -------------- | ------------ |
|
|
24
|
+
| `TType` | `unknown` |
|
|
25
|
+
|
|
26
|
+
## Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type | Description |
|
|
29
|
+
| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
|
|
30
|
+
| `key` | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
|
|
31
|
+
|
|
32
|
+
## Returns
|
|
33
|
+
|
|
34
|
+
[`IConfigKey`](Interface.IConfigKey)\<`TType`\>
|
|
35
|
+
|
|
36
|
+
A branded config key of type `IConfigKey<TType>` where `TType` is
|
|
37
|
+
inferred (or specified) as the expected type of the value.
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
// In some config-keys file
|
|
43
|
+
export const DATABASE_URL = createConfigKey<string>('DATABASE_URL');
|
|
44
|
+
export const MAX_TIMEOUT_MS = createConfigKey<number>('MAX_TIMEOUT_MS');
|
|
45
|
+
export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Then, when fetching:
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
const url = configService.get(DATABASE_URL); // typed as string
|
|
52
|
+
const timeout = configService.get(MAX_TIMEOUT_MS); // typed as number
|
|
53
|
+
const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Remarks
|
|
57
|
+
|
|
58
|
+
At runtime the returned object is minimal (just `{ key: string }`) so there is
|
|
59
|
+
virtually no overhead. The generic `TType` is only used by TypeScript for stronger
|
|
60
|
+
compile-time checking — enabling you to avoid magic strings and untyped fetches.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: createEventKey()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: createEventKey()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createEventKey<TEvents, TKey>(eventName): IEventKey<TEvents, TKey>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [events/EventKey.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L26)
|
|
14
|
+
|
|
15
|
+
Creates a branded event key for the [EventHub](Class.EventHub).
|
|
16
|
+
|
|
17
|
+
## Type Parameters
|
|
18
|
+
|
|
19
|
+
| Type Parameter |
|
|
20
|
+
| ------------------------------------------------------ |
|
|
21
|
+
| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
|
|
22
|
+
| `TKey` _extends_ `string` \| `number` \| `symbol` |
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| ----------- | ------ | ----------------------------- |
|
|
28
|
+
| `eventName` | `TKey` | The unique name of the event. |
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
[`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\>
|
|
33
|
+
|
|
34
|
+
The branded event key encoding the payload type.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: createMappingKey()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: createMappingKey()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [mapping/types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L28)
|
|
14
|
+
|
|
15
|
+
Creates a type-safe mapping key.
|
|
16
|
+
|
|
17
|
+
## Type Parameters
|
|
18
|
+
|
|
19
|
+
| Type Parameter |
|
|
20
|
+
| -------------- |
|
|
21
|
+
| `TInput` |
|
|
22
|
+
| `TOutput` |
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| --------- | -------- | --------------------------------------------- |
|
|
28
|
+
| `key` | `string` | The unique string identifier for the mapping. |
|
|
29
|
+
|
|
30
|
+
## Returns
|
|
31
|
+
|
|
32
|
+
[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
|
|
33
|
+
|
|
34
|
+
A branded mapping key that encodes the input and output types.
|
|
35
|
+
|
|
36
|
+
## Example
|
|
37
|
+
|
|
38
|
+
```typescript
|
|
39
|
+
export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
|
|
40
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: env()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: env()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function env(strings, ...values): string;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [utils/EnvUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/EnvUtils.ts#L7)
|
|
14
|
+
|
|
15
|
+
Marker function for environment strings.
|
|
16
|
+
|
|
17
|
+
It behaves like a normal template literal but allows you to
|
|
18
|
+
later search/grep all `env` usages in the codebase.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
| Parameter | Type |
|
|
23
|
+
| ----------- | ---------------------- |
|
|
24
|
+
| `strings` | `TemplateStringsArray` |
|
|
25
|
+
| ...`values` | `unknown`[] |
|
|
26
|
+
|
|
27
|
+
## Returns
|
|
28
|
+
|
|
29
|
+
`string`
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: getMimeTypeByFileNameOrExtension()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: getMimeTypeByFileNameOrExtension()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function getMimeTypeByFileNameOrExtension(...args): string | false;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [mime/mimeTypes.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mime/mimeTypes.ts#L14)
|
|
14
|
+
|
|
15
|
+
Get MIME type by file name or extension.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --------- | ------------ | ------------------------------- |
|
|
21
|
+
| ...`args` | \[`string`\] | Arguments for mime-types lookup |
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
`string` \| `false`
|
|
26
|
+
|
|
27
|
+
MIME type or false if not found
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: isActionId()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Function: isActionId()
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
function isActionId(key, action): boolean;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [sse/services/interfaces/ISseEventData.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L34)
|
|
14
|
+
|
|
15
|
+
Checks if the action id is valid.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type | Description |
|
|
20
|
+
| --------- | -------- | -------------------- |
|
|
21
|
+
| `key` | `string` | The key to check. |
|
|
22
|
+
| `action` | `string` | The action to check. |
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`boolean`
|
|
27
|
+
|
|
28
|
+
- Returns true if the action id is valid, false otherwise.
|
|
@@ -10,25 +10,6 @@ Represents the data of a Server-Sent Event.
|
|
|
10
10
|
|
|
11
11
|
## Functions
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
function isActionId(key, action): boolean;
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Defined in: [sse/services/interfaces/ISseEventData.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L34)
|
|
20
|
-
|
|
21
|
-
Checks if the action id is valid.
|
|
22
|
-
|
|
23
|
-
#### Parameters
|
|
24
|
-
|
|
25
|
-
| Parameter | Type | Description |
|
|
26
|
-
| --------- | -------- | -------------------- |
|
|
27
|
-
| `key` | `string` | The key to check. |
|
|
28
|
-
| `action` | `string` | The action to check. |
|
|
29
|
-
|
|
30
|
-
#### Returns
|
|
31
|
-
|
|
32
|
-
`boolean`
|
|
33
|
-
|
|
34
|
-
- Returns true if the action id is valid, false otherwise.
|
|
13
|
+
| Function | Description |
|
|
14
|
+
| ----------------------------------------------- | --------------------------------- |
|
|
15
|
+
| [isActionId](ISseEventData.Function.isActionId) | Checks if the action id is valid. |
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: APP\_PORT'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: APP_PORT
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const APP_PORT: IConfigKey<number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L16)
|
|
14
|
+
|
|
15
|
+
HTTP port the application listens on.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: APP\_URL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: APP_URL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const APP_URL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L13)
|
|
14
|
+
|
|
15
|
+
Base URL the application is served from (e.g. `https://example.com`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: APP\_VERSION'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: APP_VERSION
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const APP_VERSION: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L19)
|
|
14
|
+
|
|
15
|
+
Semantic version of the running application (e.g. `1.2.3`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: HEALTH\_INDICATORS\_TOKEN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: HEALTH_INDICATORS_TOKEN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const HEALTH_INDICATORS_TOKEN: typeof HEALTH_INDICATORS_TOKEN;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [health/HealthTokens.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/health/HealthTokens.ts#L2)
|
|
14
|
+
|
|
15
|
+
Injection token for registered health indicators
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: ID\_GENERATOR\_TOKEN'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: ID_GENERATOR_TOKEN
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const ID_GENERATOR_TOKEN: typeof ID_GENERATOR_TOKEN;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [identifiers/IdentifierTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierTokens.ts#L6)
|
|
14
|
+
|
|
15
|
+
Interface for ID generators
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: INTELLIGENCE\_MAX\_OUTPUT\_TOKENS'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: INTELLIGENCE_MAX_OUTPUT_TOKENS
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const INTELLIGENCE_MAX_OUTPUT_TOKENS: IConfigKey<number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L38)
|
|
14
|
+
|
|
15
|
+
Maximum number of output tokens for the AI model.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: INTELLIGENCE\_MODEL'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: INTELLIGENCE_MODEL
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const INTELLIGENCE_MODEL: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L29)
|
|
14
|
+
|
|
15
|
+
AI model identifier to use for text generation.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: INTELLIGENCE\_TEMPERATURE'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: INTELLIGENCE_TEMPERATURE
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const INTELLIGENCE_TEMPERATURE: IConfigKey<number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L32)
|
|
14
|
+
|
|
15
|
+
Sampling temperature for the AI model.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: INTELLIGENCE\_TOP\_P'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: INTELLIGENCE_TOP_P
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const INTELLIGENCE_TOP_P: IConfigKey<number>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [env.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/env.ts#L35)
|
|
14
|
+
|
|
15
|
+
Top-p (nucleus sampling) for the AI model.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: IS\_PUBLIC\_KEY'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: IS_PUBLIC_KEY
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const IS_PUBLIC_KEY: 'isPublic' = 'isPublic';
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [decorators/Public.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L7)
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: IntelligenceConversationMessageRoles'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: IntelligenceConversationMessageRoles
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const IntelligenceConversationMessageRoles: {
|
|
11
|
+
Assistant: 'assistant';
|
|
12
|
+
System: 'system';
|
|
13
|
+
User: 'user';
|
|
14
|
+
};
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [intelligence/contracts/IntelligenceConversationMessageRoles.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L4)
|
|
18
|
+
|
|
19
|
+
Enumerates the conversation roles used for contextual snapshots and messages.
|
|
20
|
+
|
|
21
|
+
## Type Declaration
|
|
22
|
+
|
|
23
|
+
| Name | Type | Default value | Defined in |
|
|
24
|
+
| ------------------------------------------- | ------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
|
+
| <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) |
|
|
26
|
+
| <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) |
|
|
27
|
+
| <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) |
|