@breadstone/archipel-mcp 0.0.1
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/README.md +80 -0
- package/data/packages/index.md +42 -0
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +72 -0
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +100 -0
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +64 -0
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +136 -0
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +116 -0
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +76 -0
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +45 -0
- package/data/packages/platform-authentication/api/Class.MfaService.md +257 -0
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +75 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +65 -0
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +65 -0
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +170 -0
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +157 -0
- package/data/packages/platform-authentication/api/Class.SessionService.md +167 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +66 -0
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +53 -0
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +52 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +159 -0
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +121 -0
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +89 -0
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +112 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +87 -0
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +123 -0
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +27 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +63 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +136 -0
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +96 -0
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +165 -0
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +87 -0
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +63 -0
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +75 -0
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +76 -0
- package/data/packages/platform-authentication/api/_media/ENVIRONMENT_VARIABLES.md +151 -0
- package/data/packages/platform-authentication/api/index.md +508 -0
- package/data/packages/platform-authentication/index.md +635 -0
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +84 -0
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +54 -0
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +80 -0
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +253 -0
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +56 -0
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +202 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +43 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +69 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +143 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +119 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +53 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +103 -0
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +33 -0
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +33 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +73 -0
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +33 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +17 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +17 -0
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +17 -0
- package/data/packages/platform-blob-storage/api/index.md +111 -0
- package/data/packages/platform-blob-storage/index.md +280 -0
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +51 -0
- package/data/packages/platform-core/api/Class.BcryptService.md +69 -0
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +196 -0
- package/data/packages/platform-core/api/Class.BooleanUtils.md +83 -0
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +121 -0
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +84 -0
- package/data/packages/platform-core/api/Class.CatchUtils.md +94 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +70 -0
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +116 -0
- package/data/packages/platform-core/api/Class.ConfigService.md +139 -0
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +110 -0
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +64 -0
- package/data/packages/platform-core/api/Class.CryptoService.md +50 -0
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +102 -0
- package/data/packages/platform-core/api/Class.DeviceParserService.md +53 -0
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +216 -0
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +144 -0
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +110 -0
- package/data/packages/platform-core/api/Class.EventHub.md +164 -0
- package/data/packages/platform-core/api/Class.EventModule.md +23 -0
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +150 -0
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +193 -0
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +86 -0
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +67 -0
- package/data/packages/platform-core/api/Class.HealthModule.md +43 -0
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +65 -0
- package/data/packages/platform-core/api/Class.HostModule.md +33 -0
- package/data/packages/platform-core/api/Class.HostService.md +150 -0
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +60 -0
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +88 -0
- package/data/packages/platform-core/api/Class.IdentifierModule.md +41 -0
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md +39 -0
- package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md +103 -0
- package/data/packages/platform-core/api/Class.IntelligenceModule.md +23 -0
- package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md +82 -0
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +60 -0
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +43 -0
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +43 -0
- package/data/packages/platform-core/api/Class.MappingBuilder.md +111 -0
- package/data/packages/platform-core/api/Class.MappingModule.md +47 -0
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +57 -0
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +53 -0
- package/data/packages/platform-core/api/Class.MappingService.md +285 -0
- package/data/packages/platform-core/api/Class.MemoryLayeredCache.md +251 -0
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +157 -0
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +149 -0
- package/data/packages/platform-core/api/Class.OtpService.md +106 -0
- package/data/packages/platform-core/api/Class.PageableRequest.md +43 -0
- package/data/packages/platform-core/api/Class.PageableResponse.md +63 -0
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +62 -0
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +85 -0
- package/data/packages/platform-core/api/Class.QuantityResponse.md +43 -0
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +275 -0
- package/data/packages/platform-core/api/Class.ResourceManager.md +566 -0
- package/data/packages/platform-core/api/Class.ResourceModule.md +47 -0
- package/data/packages/platform-core/api/Class.ResponseReturn.md +504 -0
- package/data/packages/platform-core/api/Class.SseHub.md +184 -0
- package/data/packages/platform-core/api/Class.SseModule.md +43 -0
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +43 -0
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +58 -0
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +86 -0
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +48 -0
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +65 -0
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +29 -0
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +41 -0
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +121 -0
- package/data/packages/platform-core/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-core/api/Interface.IConfigKey.md +64 -0
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +41 -0
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +80 -0
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +81 -0
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +154 -0
- package/data/packages/platform-core/api/Interface.IEventKey.md +58 -0
- package/data/packages/platform-core/api/Interface.IEventMap.md +17 -0
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +73 -0
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +47 -0
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +42 -0
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +233 -0
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +58 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +62 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +69 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +63 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +32 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +51 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +61 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +81 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +31 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +53 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +41 -0
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +46 -0
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +194 -0
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +71 -0
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +77 -0
- package/data/packages/platform-core/api/Interface.IMappingKey.md +59 -0
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +33 -0
- package/data/packages/platform-core/api/Interface.IOtpService.md +78 -0
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +108 -0
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +72 -0
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +95 -0
- package/data/packages/platform-core/api/Interface.IResourceResult.md +35 -0
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +135 -0
- package/data/packages/platform-core/api/Interface.ISseEventData.md +37 -0
- package/data/packages/platform-core/api/Interface.ISseHub.md +92 -0
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +34 -0
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +19 -0
- package/data/packages/platform-core/api/TypeAlias.IntelligenceConversationMessageRole.md +16 -0
- package/data/packages/platform-core/api/TypeAlias.IntelligenceProviderName.md +15 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +29 -0
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +26 -0
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +22 -0
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +13 -0
- package/data/packages/platform-core/api/index.md +645 -0
- package/data/packages/platform-core/index.md +483 -0
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +80 -0
- package/data/packages/platform-database/api/Class.DatabaseModule.md +75 -0
- package/data/packages/platform-database/api/Class.DatabaseService.md +165 -0
- package/data/packages/platform-database/api/Class.PrismaService.md +116 -0
- package/data/packages/platform-database/api/Class.RepositoryBase.md +526 -0
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +60 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +27 -0
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +33 -0
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +82 -0
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +56 -0
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +55 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +23 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +23 -0
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +36 -0
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +32 -0
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +31 -0
- package/data/packages/platform-database/api/index.md +183 -0
- package/data/packages/platform-database/index.md +300 -0
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +103 -0
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +85 -0
- package/data/packages/platform-documents/api/Class.DocumentModule.md +52 -0
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +136 -0
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +100 -0
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +75 -0
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +123 -0
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +52 -0
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +63 -0
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +100 -0
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +69 -0
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +63 -0
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +19 -0
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +19 -0
- package/data/packages/platform-documents/api/index.md +91 -0
- package/data/packages/platform-documents/index.md +219 -0
- package/data/packages/platform-logging/api/Class.AnalyticsService.md +113 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +25 -0
- package/data/packages/platform-logging/api/index.md +42 -0
- package/data/packages/platform-logging/index.md +92 -0
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +67 -0
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +55 -0
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +65 -0
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +83 -0
- package/data/packages/platform-mailing/api/Class.MailModule.md +27 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +101 -0
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +98 -0
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +90 -0
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +82 -0
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +42 -0
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +71 -0
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +35 -0
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +19 -0
- package/data/packages/platform-mailing/api/index.md +404 -0
- package/data/packages/platform-mailing/index.md +335 -0
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +65 -0
- package/data/packages/platform-mcp/api/Class.McpModule.md +83 -0
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +147 -0
- package/data/packages/platform-mcp/api/Class.McpServerService.md +197 -0
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +47 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +76 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +126 -0
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +28 -0
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +59 -0
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +73 -0
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +83 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +41 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +41 -0
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +41 -0
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +23 -0
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +39 -0
- package/data/packages/platform-mcp/api/index.md +123 -0
- package/data/packages/platform-mcp/index.md +299 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +71 -0
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +104 -0
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +82 -0
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +51 -0
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +73 -0
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +73 -0
- package/data/packages/platform-openapi/api/index.md +209 -0
- package/data/packages/platform-openapi/index.md +170 -0
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +79 -0
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +73 -0
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +74 -0
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +168 -0
- package/data/packages/platform-payments/api/Class.MollieClient.md +168 -0
- package/data/packages/platform-payments/api/Class.PaddleClient.md +168 -0
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +147 -0
- package/data/packages/platform-payments/api/Class.PaymentModule.md +53 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +168 -0
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +75 -0
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +75 -0
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +85 -0
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +105 -0
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +89 -0
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +65 -0
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +27 -0
- package/data/packages/platform-payments/api/index.md +243 -0
- package/data/packages/platform-payments/index.md +532 -0
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +57 -0
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +41 -0
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +85 -0
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +23 -0
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +62 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +83 -0
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +71 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +61 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +41 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +61 -0
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +31 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +13 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +13 -0
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +15 -0
- package/data/packages/platform-reporting/api/index.md +90 -0
- package/data/packages/platform-reporting/index.md +229 -0
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +118 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +180 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +132 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +231 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +45 -0
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +53 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +90 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +43 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +141 -0
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +43 -0
- package/data/packages/platform-telemetry/api/index.md +81 -0
- package/data/packages/platform-telemetry/index.md +234 -0
- package/package.json +39 -0
- package/src/DocsLoader.d.ts +14 -0
- package/src/DocsLoader.js +103 -0
- package/src/knowledge/configPattern.d.ts +5 -0
- package/src/knowledge/configPattern.js +211 -0
- package/src/knowledge/dtoPattern.d.ts +5 -0
- package/src/knowledge/dtoPattern.js +286 -0
- package/src/knowledge/errorHandlingPattern.d.ts +5 -0
- package/src/knowledge/errorHandlingPattern.js +219 -0
- package/src/knowledge/guardPattern.d.ts +5 -0
- package/src/knowledge/guardPattern.js +256 -0
- package/src/knowledge/mappingPattern.d.ts +6 -0
- package/src/knowledge/mappingPattern.js +322 -0
- package/src/knowledge/modulePattern.d.ts +6 -0
- package/src/knowledge/modulePattern.js +283 -0
- package/src/knowledge/queryPattern.d.ts +6 -0
- package/src/knowledge/queryPattern.js +215 -0
- package/src/knowledge/repositoryPattern.d.ts +6 -0
- package/src/knowledge/repositoryPattern.js +367 -0
- package/src/knowledge/testingPattern.d.ts +5 -0
- package/src/knowledge/testingPattern.js +356 -0
- package/src/main.d.ts +2 -0
- package/src/main.js +226 -0
- package/src/models/IPackageDoc.d.ts +19 -0
- package/src/models/IPackageDoc.js +3 -0
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceManagerConfig'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IResourceManagerConfig
|
|
8
|
+
|
|
9
|
+
Defined in: [resources/ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L16)
|
|
10
|
+
|
|
11
|
+
Configuration for the ResourceManager.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### cache?
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
optional cache?: ILayeredCache<string, IResourceResult>;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [resources/ResourceManager.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L27)
|
|
22
|
+
|
|
23
|
+
Optional cache for loaded resources.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### cacheTtl?
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
optional cacheTtl?: number;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [resources/ResourceManager.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L33)
|
|
34
|
+
|
|
35
|
+
Cache TTL in seconds.
|
|
36
|
+
|
|
37
|
+
#### Default
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
3600 (1 hour)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
### debug?
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
optional debug?: boolean;
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Defined in: [resources/ResourceManager.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L39)
|
|
52
|
+
|
|
53
|
+
Enable debug logging.
|
|
54
|
+
|
|
55
|
+
#### Default
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
false;
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### strategies
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
strategies: IResourceStrategy[];
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: [resources/ResourceManager.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L22)
|
|
70
|
+
|
|
71
|
+
Resource loading strategies in priority order.
|
|
72
|
+
First strategy that finds the resource wins.
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceMetadata'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IResourceMetadata
|
|
8
|
+
|
|
9
|
+
Defined in: [resources/types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L6)
|
|
10
|
+
|
|
11
|
+
Metadata about a resource.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### cachedAt?
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
optional cachedAt?: Date;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [resources/types/IResourceMetadata.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L41)
|
|
22
|
+
|
|
23
|
+
When this resource was cached (if applicable).
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### encoding?
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
optional encoding?: BufferEncoding;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [resources/types/IResourceMetadata.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L31)
|
|
34
|
+
|
|
35
|
+
The encoding of the resource (if applicable).
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
### key
|
|
40
|
+
|
|
41
|
+
```ts
|
|
42
|
+
key: string;
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Defined in: [resources/types/IResourceMetadata.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L11)
|
|
46
|
+
|
|
47
|
+
The resource key/identifier.
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### mimeType
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
mimeType: string;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Defined in: [resources/types/IResourceMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L21)
|
|
58
|
+
|
|
59
|
+
The MIME type of the resource.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
### path
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
path: string;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: [resources/types/IResourceMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L16)
|
|
70
|
+
|
|
71
|
+
The full path of the resource.
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### size
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
size: number;
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Defined in: [resources/types/IResourceMetadata.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L26)
|
|
82
|
+
|
|
83
|
+
The size of the resource in bytes.
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
### source
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
source: string;
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Defined in: [resources/types/IResourceMetadata.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L36)
|
|
94
|
+
|
|
95
|
+
The source strategy that resolved this resource.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceResult'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IResourceResult
|
|
8
|
+
|
|
9
|
+
Defined in: [resources/types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L8)
|
|
10
|
+
|
|
11
|
+
Result of loading a resource.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### content
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
content: Buffer;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [resources/types/IResourceResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L13)
|
|
22
|
+
|
|
23
|
+
The resource content as a Buffer.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
### metadata
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
metadata: IResourceMetadata;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [resources/types/IResourceResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L18)
|
|
34
|
+
|
|
35
|
+
Metadata about the resource.
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IResourceStrategy'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: IResourceStrategy
|
|
8
|
+
|
|
9
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L8)
|
|
10
|
+
|
|
11
|
+
Strategy for loading resources from a specific source.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### name
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
readonly name: string;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L13)
|
|
22
|
+
|
|
23
|
+
The unique name of this strategy.
|
|
24
|
+
|
|
25
|
+
## Methods
|
|
26
|
+
|
|
27
|
+
### exists()
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
exists(key): boolean;
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L37)
|
|
34
|
+
|
|
35
|
+
Checks if a resource exists without loading it.
|
|
36
|
+
|
|
37
|
+
#### Parameters
|
|
38
|
+
|
|
39
|
+
| Parameter | Type | Description |
|
|
40
|
+
| --------- | -------- | --------------------------- |
|
|
41
|
+
| `key` | `string` | The resource key/identifier |
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`boolean`
|
|
46
|
+
|
|
47
|
+
True if the resource exists
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
### existsAsync()
|
|
52
|
+
|
|
53
|
+
```ts
|
|
54
|
+
existsAsync(key): Promise<boolean>;
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L45)
|
|
58
|
+
|
|
59
|
+
Checks if a resource exists without loading it (asynchronous).
|
|
60
|
+
|
|
61
|
+
#### Parameters
|
|
62
|
+
|
|
63
|
+
| Parameter | Type | Description |
|
|
64
|
+
| --------- | -------- | --------------------------- |
|
|
65
|
+
| `key` | `string` | The resource key/identifier |
|
|
66
|
+
|
|
67
|
+
#### Returns
|
|
68
|
+
|
|
69
|
+
`Promise`\<`boolean`\>
|
|
70
|
+
|
|
71
|
+
Promise resolving to true if the resource exists
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
### load()
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
load(key): IResourceResult | undefined;
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L21)
|
|
82
|
+
|
|
83
|
+
Loads a resource by its key.
|
|
84
|
+
|
|
85
|
+
#### Parameters
|
|
86
|
+
|
|
87
|
+
| Parameter | Type | Description |
|
|
88
|
+
| --------- | -------- | --------------------------- |
|
|
89
|
+
| `key` | `string` | The resource key/identifier |
|
|
90
|
+
|
|
91
|
+
#### Returns
|
|
92
|
+
|
|
93
|
+
[`IResourceResult`](Interface.IResourceResult) \| `undefined`
|
|
94
|
+
|
|
95
|
+
The resource result or undefined if not found
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
### loadAsync()
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
loadAsync(key): Promise<IResourceResult | undefined>;
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L29)
|
|
106
|
+
|
|
107
|
+
Loads a resource by its key (asynchronous).
|
|
108
|
+
|
|
109
|
+
#### Parameters
|
|
110
|
+
|
|
111
|
+
| Parameter | Type | Description |
|
|
112
|
+
| --------- | -------- | --------------------------- |
|
|
113
|
+
| `key` | `string` | The resource key/identifier |
|
|
114
|
+
|
|
115
|
+
#### Returns
|
|
116
|
+
|
|
117
|
+
`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
|
|
118
|
+
|
|
119
|
+
Promise resolving to the resource result or undefined if not found
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
### whatDoIHave()
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
whatDoIHave(): void;
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Defined in: [resources/strategies/abstracts/IResourceStrategy.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/abstracts/IResourceStrategy.ts#L50)
|
|
130
|
+
|
|
131
|
+
List all files and folders in the base paths for debugging purposes.
|
|
132
|
+
|
|
133
|
+
#### Returns
|
|
134
|
+
|
|
135
|
+
`void`
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: ISseEventData\<TData\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: ISseEventData\<TData\>
|
|
8
|
+
|
|
9
|
+
Defined in: [sse/services/interfaces/ISseEventData.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L7)
|
|
10
|
+
|
|
11
|
+
Represents the data of a Server-Sent Event.
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
| Type Parameter | Default type |
|
|
16
|
+
| -------------- | ------------ |
|
|
17
|
+
| `TData` | `unknown` |
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### action
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
readonly action: `${string}:${string}`;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [sse/services/interfaces/ISseEventData.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L11)
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
### payload
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
readonly payload: TData;
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Defined in: [sse/services/interfaces/ISseEventData.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L13)
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: ISseHub'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Interface: ISseHub
|
|
8
|
+
|
|
9
|
+
Defined in: [sse/services/interfaces/ISseHub.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseHub.ts#L13)
|
|
10
|
+
|
|
11
|
+
Represents a server-sent event service.
|
|
12
|
+
|
|
13
|
+
## Methods
|
|
14
|
+
|
|
15
|
+
### clearEvent()
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
clearEvent(id): void;
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Defined in: [sse/services/interfaces/ISseHub.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseHub.ts#L19)
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
| Parameter | Type |
|
|
26
|
+
| --------- | -------- |
|
|
27
|
+
| `id` | `string` |
|
|
28
|
+
|
|
29
|
+
#### Returns
|
|
30
|
+
|
|
31
|
+
`void`
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
### emitEvent()
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
emitEvent(id, data): void;
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Defined in: [sse/services/interfaces/ISseHub.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseHub.ts#L17)
|
|
42
|
+
|
|
43
|
+
#### Parameters
|
|
44
|
+
|
|
45
|
+
| Parameter | Type |
|
|
46
|
+
| --------- | ------------------------------------------ |
|
|
47
|
+
| `id` | `string` |
|
|
48
|
+
| `data` | [`ISseEventData`](Interface.ISseEventData) |
|
|
49
|
+
|
|
50
|
+
#### Returns
|
|
51
|
+
|
|
52
|
+
`void`
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
### getObservable()
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
getObservable(id): Observable<ISseEventData<unknown>>;
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Defined in: [sse/services/interfaces/ISseHub.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseHub.ts#L23)
|
|
63
|
+
|
|
64
|
+
#### Parameters
|
|
65
|
+
|
|
66
|
+
| Parameter | Type |
|
|
67
|
+
| --------- | -------- |
|
|
68
|
+
| `id` | `string` |
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
`Observable`\<[`ISseEventData`](Interface.ISseEventData)\<`unknown`\>\>
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
### isEventActive()
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
isEventActive(id): boolean;
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Defined in: [sse/services/interfaces/ISseHub.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseHub.ts#L21)
|
|
83
|
+
|
|
84
|
+
#### Parameters
|
|
85
|
+
|
|
86
|
+
| Parameter | Type |
|
|
87
|
+
| --------- | -------- |
|
|
88
|
+
| `id` | `string` |
|
|
89
|
+
|
|
90
|
+
#### Returns
|
|
91
|
+
|
|
92
|
+
`boolean`
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ISseEventData
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# ISseEventData
|
|
8
|
+
|
|
9
|
+
Represents the data of a Server-Sent Event.
|
|
10
|
+
|
|
11
|
+
## Functions
|
|
12
|
+
|
|
13
|
+
### isActionId()
|
|
14
|
+
|
|
15
|
+
```ts
|
|
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.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: CamelCase\<T\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: CamelCase\<T\>
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type CamelCase<T> = { [K in keyof T as SnakeToCamel<K & string>]: T[K] extends object ? CamelCase<T[K]> : T[K] };
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [types/Case.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/types/Case.ts#L6)
|
|
14
|
+
|
|
15
|
+
## Type Parameters
|
|
16
|
+
|
|
17
|
+
| Type Parameter |
|
|
18
|
+
| -------------- |
|
|
19
|
+
| `T` |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceConversationMessageRole'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: IntelligenceConversationMessageRole
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IntelligenceConversationMessageRole =
|
|
11
|
+
(typeof IntelligenceConversationMessageRoles)[keyof typeof IntelligenceConversationMessageRoles];
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Defined in: [intelligence/contracts/IntelligenceConversationMessageRoles.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceConversationMessageRoles.ts#L13)
|
|
15
|
+
|
|
16
|
+
Represents the union of supported conversation message roles.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: IntelligenceProviderName'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: IntelligenceProviderName
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type IntelligenceProviderName = (typeof IntelligenceProviderNames)[keyof typeof IntelligenceProviderNames];
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [intelligence/contracts/IntelligenceProviderNames.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/contracts/IntelligenceProviderNames.ts#L14)
|
|
14
|
+
|
|
15
|
+
Represents the union of supported intelligence provider identifiers.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: ProblemDetail'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: ProblemDetail
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ProblemDetail = {
|
|
11
|
+
detail: string;
|
|
12
|
+
instance?: string;
|
|
13
|
+
title: string;
|
|
14
|
+
type?: string;
|
|
15
|
+
} & Record<string, string | number | string[] | number[]>;
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Defined in: [filters/ProblemDetailExceptionFilter.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L12)
|
|
19
|
+
|
|
20
|
+
A Problem Detail object as per RFC 7807.
|
|
21
|
+
|
|
22
|
+
## Type Declaration
|
|
23
|
+
|
|
24
|
+
| Name | Type | Defined in |
|
|
25
|
+
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
26
|
+
| `detail` | `string` | [filters/ProblemDetailExceptionFilter.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L15) |
|
|
27
|
+
| `instance?` | `string` | [filters/ProblemDetailExceptionFilter.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L16) |
|
|
28
|
+
| `title` | `string` | [filters/ProblemDetailExceptionFilter.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L14) |
|
|
29
|
+
| `type?` | `string` | [filters/ProblemDetailExceptionFilter.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L13) |
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: ProblemDetailTypeUrlResolver'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: ProblemDetailTypeUrlResolver
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type ProblemDetailTypeUrlResolver = (code, title) => string;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [filters/ProblemDetailExceptionFilter.ts:202](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L202)
|
|
14
|
+
|
|
15
|
+
A function that resolves a type URL for a given HTTP status code and title.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
| Parameter | Type |
|
|
20
|
+
| --------- | -------- |
|
|
21
|
+
| `code` | `number` |
|
|
22
|
+
| `title` | `string` |
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
`string`
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: SetOptional\<T, K\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: SetOptional\<T, K\>
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type SetOptional<T, K> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [types/SetOptional.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/types/SetOptional.ts#L7)
|
|
14
|
+
|
|
15
|
+
Sets the specified keys of T as optional.
|
|
16
|
+
|
|
17
|
+
## Type Parameters
|
|
18
|
+
|
|
19
|
+
| Type Parameter | Description |
|
|
20
|
+
| ----------------------- | ----------------------- |
|
|
21
|
+
| `T` | Original type |
|
|
22
|
+
| `K` _extends_ keyof `T` | Keys to set as optional |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: StringValue'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Type Alias: StringValue
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
type StringValue = `${number}` | `${number}${UnitAnyCase}` | `${number} ${UnitAnyCase}`;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [utils/DateTimeUtils.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L13)
|