@breadstone/archipel-mcp 0.0.13 → 0.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/DocsLoader.js +2 -5
- package/src/GuidesLoader.js +2 -5
- package/data/guides/ai-text-generation.md +0 -361
- package/data/guides/analytics-and-error-tracking.md +0 -189
- package/data/guides/authentication-and-authorization.md +0 -657
- package/data/guides/blob-storage.md +0 -242
- package/data/guides/caching.md +0 -255
- package/data/guides/cryptography-and-otp.md +0 -240
- package/data/guides/database-setup.md +0 -546
- package/data/guides/document-generation.md +0 -174
- package/data/guides/email-delivery.md +0 -196
- package/data/guides/esigning-integration.md +0 -231
- package/data/guides/getting-started.md +0 -351
- package/data/guides/implementing-ports.md +0 -317
- package/data/guides/index.md +0 -62
- package/data/guides/mcp-server.md +0 -222
- package/data/guides/openapi-and-feature-discovery.md +0 -266
- package/data/guides/payments-and-feature-gating.md +0 -244
- package/data/guides/resource-management.md +0 -352
- package/data/guides/telemetry-and-observability.md +0 -190
- package/data/guides/testing.md +0 -319
- package/data/guides/tsdoc-guidelines.md +0 -45
- package/data/packages/index.md +0 -52
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +0 -141
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +0 -47
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +0 -161
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +0 -169
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +0 -58
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +0 -47
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +0 -58
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +0 -14
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +0 -14
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +0 -14
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +0 -14
- package/data/packages/platform-analytics/api/index.md +0 -44
- package/data/packages/platform-analytics/index.md +0 -170
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +0 -86
- package/data/packages/platform-authentication/api/Class.AuthModule.md +0 -67
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +0 -95
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +0 -59
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +0 -131
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +0 -78
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +0 -84
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +0 -136
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +0 -71
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +0 -40
- package/data/packages/platform-authentication/api/Class.MfaService.md +0 -252
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +0 -70
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +0 -84
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +0 -60
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +0 -60
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +0 -165
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +0 -152
- package/data/packages/platform-authentication/api/Class.SessionService.md +0 -162
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +0 -61
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +0 -48
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +0 -47
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +0 -144
- package/data/packages/platform-authentication/api/Class.VerificationService.md +0 -154
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +0 -116
- package/data/packages/platform-authentication/api/Function.Token.md +0 -18
- package/data/packages/platform-authentication/api/Function.UseRoles.md +0 -24
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +0 -22
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +0 -143
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +0 -107
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +0 -82
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +0 -118
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -22
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +0 -58
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +0 -131
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +0 -91
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +0 -160
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +0 -82
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +0 -58
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +0 -70
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +0 -71
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +0 -14
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +0 -14
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +0 -14
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +0 -29
- package/data/packages/platform-authentication/api/Variable.User.md +0 -24
- package/data/packages/platform-authentication/api/index.md +0 -112
- package/data/packages/platform-authentication/index.md +0 -635
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +0 -196
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +0 -79
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +0 -49
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +0 -75
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +0 -248
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +0 -51
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +0 -197
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +0 -68
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +0 -38
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +0 -38
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +0 -64
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +0 -138
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +0 -114
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +0 -48
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +0 -98
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +0 -68
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +0 -28
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +0 -12
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -12
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +0 -16
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +0 -12
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +0 -26
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +0 -26
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-blob-storage/api/index.md +0 -59
- package/data/packages/platform-blob-storage/index.md +0 -335
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +0 -258
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +0 -295
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +0 -70
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +0 -198
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +0 -75
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +0 -121
- package/data/packages/platform-caching/api/index.md +0 -24
- package/data/packages/platform-caching/index.md +0 -116
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +0 -50
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +0 -195
- package/data/packages/platform-core/api/Class.BooleanUtils.md +0 -82
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +0 -120
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +0 -83
- package/data/packages/platform-core/api/Class.CatchUtils.md +0 -93
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +0 -89
- package/data/packages/platform-core/api/Class.ConfigModule.md +0 -69
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +0 -115
- package/data/packages/platform-core/api/Class.ConfigService.md +0 -137
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +0 -125
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +0 -63
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +0 -101
- package/data/packages/platform-core/api/Class.DeviceParserService.md +0 -52
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +0 -215
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +0 -141
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +0 -109
- package/data/packages/platform-core/api/Class.EventHub.md +0 -163
- package/data/packages/platform-core/api/Class.EventModule.md +0 -22
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +0 -147
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +0 -192
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +0 -85
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +0 -66
- package/data/packages/platform-core/api/Class.HealthModule.md +0 -42
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +0 -64
- package/data/packages/platform-core/api/Class.HostModule.md +0 -31
- package/data/packages/platform-core/api/Class.HostService.md +0 -149
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +0 -59
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +0 -87
- package/data/packages/platform-core/api/Class.IdentifierModule.md +0 -40
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +0 -59
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +0 -42
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +0 -42
- package/data/packages/platform-core/api/Class.MappingBuilder.md +0 -110
- package/data/packages/platform-core/api/Class.MappingModule.md +0 -46
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +0 -56
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +0 -52
- package/data/packages/platform-core/api/Class.MappingService.md +0 -284
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +0 -148
- package/data/packages/platform-core/api/Class.PageableRequest.md +0 -42
- package/data/packages/platform-core/api/Class.PageableResponse.md +0 -62
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +0 -61
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +0 -94
- package/data/packages/platform-core/api/Class.QuantityResponse.md +0 -42
- package/data/packages/platform-core/api/Class.ResourceManager.md +0 -565
- package/data/packages/platform-core/api/Class.ResourceModule.md +0 -46
- package/data/packages/platform-core/api/Class.ResponseReturn.md +0 -502
- package/data/packages/platform-core/api/Class.SseHub.md +0 -183
- package/data/packages/platform-core/api/Class.SseModule.md +0 -42
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +0 -42
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +0 -57
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +0 -85
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +0 -47
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +0 -64
- package/data/packages/platform-core/api/Function.Public.md +0 -18
- package/data/packages/platform-core/api/Function.createConfigKey.md +0 -58
- package/data/packages/platform-core/api/Function.createEventKey.md +0 -33
- package/data/packages/platform-core/api/Function.createMappingKey.md +0 -39
- package/data/packages/platform-core/api/Function.env.md +0 -28
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +0 -26
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +0 -27
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +0 -28
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +0 -40
- package/data/packages/platform-core/api/Interface.IConfigKey.md +0 -63
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +0 -40
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +0 -79
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +0 -80
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +0 -153
- package/data/packages/platform-core/api/Interface.IEventKey.md +0 -57
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -16
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +0 -72
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +0 -46
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +0 -41
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +0 -232
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +0 -57
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +0 -76
- package/data/packages/platform-core/api/Interface.IMappingKey.md +0 -58
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +0 -32
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +0 -71
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +0 -94
- package/data/packages/platform-core/api/Interface.IResourceResult.md +0 -34
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +0 -134
- package/data/packages/platform-core/api/Interface.ISseEventData.md +0 -36
- package/data/packages/platform-core/api/Interface.ISseHub.md +0 -91
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +0 -14
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +0 -18
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +0 -28
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +0 -25
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +0 -21
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +0 -15
- package/data/packages/platform-core/api/Variable.APP_NAME.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_PORT.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_URL.md +0 -14
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +0 -14
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +0 -14
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +0 -14
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +0 -14
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +0 -14
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +0 -12
- package/data/packages/platform-core/api/Variable.IpAddress.md +0 -31
- package/data/packages/platform-core/api/Variable.Lang.md +0 -29
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +0 -14
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-core/api/Variable.UserAgent.md +0 -24
- package/data/packages/platform-core/api/index.md +0 -142
- package/data/packages/platform-core/index.md +0 -485
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +0 -72
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +0 -51
- package/data/packages/platform-cryptography/api/Class.OtpService.md +0 -109
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +0 -81
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +0 -46
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +0 -14
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +0 -23
- package/data/packages/platform-cryptography/api/index.md +0 -28
- package/data/packages/platform-cryptography/index.md +0 -132
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +0 -75
- package/data/packages/platform-database/api/Class.DatabaseModule.md +0 -68
- package/data/packages/platform-database/api/Class.DatabaseService.md +0 -161
- package/data/packages/platform-database/api/Class.PrismaService.md +0 -112
- package/data/packages/platform-database/api/Class.RepositoryBase.md +0 -586
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +0 -55
- package/data/packages/platform-database/api/Function.pageable.md +0 -35
- package/data/packages/platform-database/api/Function.paginator.md +0 -22
- package/data/packages/platform-database/api/Function.query.md +0 -34
- package/data/packages/platform-database/api/Function.skip.md +0 -33
- package/data/packages/platform-database/api/Function.transactionalQuery.md +0 -31
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -34
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +0 -28
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +0 -77
- package/data/packages/platform-database/api/Interface.IPrismaServiceOptions.md +0 -22
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +0 -51
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +0 -50
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +0 -18
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +0 -18
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +0 -31
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +0 -27
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +0 -26
- package/data/packages/platform-database/api/Variable.DATABASE_MODULE_CONFIG.md +0 -14
- package/data/packages/platform-database/api/Variable.DB_ACCELERATE_URL.md +0 -14
- package/data/packages/platform-database/api/Variable.DB_AUTO_CONNECTION.md +0 -14
- package/data/packages/platform-database/api/Variable.DB_OPTIMIZE.md +0 -14
- package/data/packages/platform-database/api/Variable.DB_OPTIMIZE_API_KEY.md +0 -14
- package/data/packages/platform-database/api/Variable.PLATFORM_DATABASE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-database/api/index.md +0 -59
- package/data/packages/platform-database/index.md +0 -323
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +0 -277
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +0 -80
- package/data/packages/platform-documents/api/Class.DocumentModule.md +0 -47
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +0 -131
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +0 -94
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +0 -70
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +0 -118
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +0 -47
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +0 -58
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +0 -95
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +0 -64
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +0 -58
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +0 -14
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +0 -14
- package/data/packages/platform-documents/api/index.md +0 -47
- package/data/packages/platform-documents/index.md +0 -219
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +0 -184
- package/data/packages/platform-esigning/api/Class.EsigningError.md +0 -65
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +0 -48
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +0 -90
- package/data/packages/platform-esigning/api/Class.EsigningService.md +0 -198
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +0 -249
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +0 -101
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +0 -78
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +0 -60
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +0 -94
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +0 -58
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +0 -58
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +0 -46
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +0 -60
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigner.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +0 -82
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +0 -142
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +0 -142
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +0 -70
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +0 -14
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +0 -30
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +0 -32
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +0 -38
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +0 -36
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +0 -38
- package/data/packages/platform-esigning/api/index.md +0 -84
- package/data/packages/platform-esigning/index.md +0 -691
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +0 -94
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +0 -106
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -22
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +0 -81
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +0 -26
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +0 -31
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +0 -71
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +0 -78
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +0 -72
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +0 -35
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +0 -58
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +0 -70
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +0 -94
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +0 -34
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +0 -60
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +0 -46
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +0 -53
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +0 -14
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +0 -24
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +0 -14
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +0 -26
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +0 -28
- package/data/packages/platform-intelligence/api/index.md +0 -69
- package/data/packages/platform-intelligence/index.md +0 -131
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -20
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +0 -14
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-logging/api/index.md +0 -19
- package/data/packages/platform-logging/index.md +0 -92
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +0 -60
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +0 -66
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +0 -58
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +0 -78
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -22
- package/data/packages/platform-mailing/api/Class.MailService.md +0 -96
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +0 -93
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +0 -85
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +0 -75
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +0 -53
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -66
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +0 -30
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +0 -12
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +0 -16
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +0 -14
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +0 -14
- package/data/packages/platform-mailing/api/index.md +0 -74
- package/data/packages/platform-mailing/index.md +0 -335
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +0 -64
- package/data/packages/platform-mcp/api/Class.McpModule.md +0 -82
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +0 -146
- package/data/packages/platform-mcp/api/Class.McpServerService.md +0 -196
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +0 -28
- package/data/packages/platform-mcp/api/Function.McpResource.md +0 -28
- package/data/packages/platform-mcp/api/Function.McpTool.md +0 -28
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +0 -46
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +0 -75
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +0 -125
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +0 -27
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +0 -58
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +0 -72
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +0 -82
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +0 -40
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +0 -40
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +0 -40
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -22
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +0 -38
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +0 -14
- package/data/packages/platform-mcp/api/index.md +0 -46
- package/data/packages/platform-mcp/index.md +0 -299
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +0 -70
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +0 -99
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +0 -77
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +0 -46
- package/data/packages/platform-openapi/api/Function.Api.md +0 -35
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +0 -42
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -18
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +0 -27
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +0 -68
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +0 -68
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +0 -14
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +0 -14
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +0 -12
- package/data/packages/platform-openapi/api/index.md +0 -42
- package/data/packages/platform-openapi/index.md +0 -170
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +0 -74
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +0 -68
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +0 -69
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +0 -163
- package/data/packages/platform-payments/api/Class.MollieClient.md +0 -163
- package/data/packages/platform-payments/api/Class.PaddleClient.md +0 -163
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +0 -142
- package/data/packages/platform-payments/api/Class.PaymentModule.md +0 -48
- package/data/packages/platform-payments/api/Class.StripeClient.md +0 -163
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +0 -25
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +0 -70
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +0 -70
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +0 -80
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +0 -100
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +0 -84
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +0 -60
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +0 -22
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +0 -12
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +0 -14
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +0 -14
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-payments/api/index.md +0 -63
- package/data/packages/platform-payments/index.md +0 -532
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +0 -56
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +0 -40
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +0 -84
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -22
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +0 -61
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +0 -82
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +0 -70
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +0 -60
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +0 -40
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +0 -60
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +0 -30
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +0 -12
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +0 -12
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -14
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +0 -30
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +0 -28
- package/data/packages/platform-reporting/api/index.md +0 -42
- package/data/packages/platform-reporting/index.md +0 -229
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +0 -113
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +0 -175
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +0 -127
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +0 -226
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +0 -40
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +0 -48
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +0 -85
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +0 -38
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +0 -136
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +0 -38
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +0 -12
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -12
- package/data/packages/platform-telemetry/api/index.md +0 -36
- package/data/packages/platform-telemetry/index.md +0 -234
|
@@ -1,232 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IHostContentParams'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IHostContentParams
|
|
7
|
-
|
|
8
|
-
Defined in: [services/HostService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L19)
|
|
9
|
-
|
|
10
|
-
Parameters for generating host content.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### actions?
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
optional actions?: {
|
|
18
|
-
description: string;
|
|
19
|
-
link: string;
|
|
20
|
-
}[];
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Defined in: [services/HostService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L38)
|
|
24
|
-
|
|
25
|
-
Optional array of action buttons (CTAs).
|
|
26
|
-
|
|
27
|
-
#### description
|
|
28
|
-
|
|
29
|
-
```ts
|
|
30
|
-
description: string;
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
The description of the action (used as button text).
|
|
34
|
-
|
|
35
|
-
#### link
|
|
36
|
-
|
|
37
|
-
```ts
|
|
38
|
-
link: string;
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
The link URL for the action.
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### data?
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
optional data?: Record<string, unknown>;
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Defined in: [services/HostService.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L126)
|
|
52
|
-
|
|
53
|
-
Optional additional data to be injected into the template.
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### description
|
|
58
|
-
|
|
59
|
-
```ts
|
|
60
|
-
description: string;
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Defined in: [services/HostService.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L28)
|
|
64
|
-
|
|
65
|
-
The subtitle/description of the page.
|
|
66
|
-
|
|
67
|
-
***
|
|
68
|
-
|
|
69
|
-
### features?
|
|
70
|
-
|
|
71
|
-
```ts
|
|
72
|
-
optional features?: {
|
|
73
|
-
description: string;
|
|
74
|
-
icon?: string;
|
|
75
|
-
link: string;
|
|
76
|
-
title: string;
|
|
77
|
-
}[];
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Defined in: [services/HostService.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L53)
|
|
81
|
-
|
|
82
|
-
Optional array of feature cards.
|
|
83
|
-
|
|
84
|
-
#### description
|
|
85
|
-
|
|
86
|
-
```ts
|
|
87
|
-
description: string;
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
The description of the feature (used as link text).
|
|
91
|
-
|
|
92
|
-
#### icon?
|
|
93
|
-
|
|
94
|
-
```ts
|
|
95
|
-
optional icon?: string;
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Optional icon (emoji or URL).
|
|
99
|
-
|
|
100
|
-
#### link
|
|
101
|
-
|
|
102
|
-
```ts
|
|
103
|
-
link: string;
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
The link URL for the feature.
|
|
107
|
-
|
|
108
|
-
#### title
|
|
109
|
-
|
|
110
|
-
```ts
|
|
111
|
-
title: string;
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
The title of the feature.
|
|
115
|
-
|
|
116
|
-
***
|
|
117
|
-
|
|
118
|
-
### footer?
|
|
119
|
-
|
|
120
|
-
```ts
|
|
121
|
-
optional footer?: {
|
|
122
|
-
copyright: string;
|
|
123
|
-
links?: {
|
|
124
|
-
label: string;
|
|
125
|
-
url: string;
|
|
126
|
-
}[];
|
|
127
|
-
stage?: string;
|
|
128
|
-
version?: string;
|
|
129
|
-
};
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
Defined in: [services/HostService.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L91)
|
|
133
|
-
|
|
134
|
-
Optional footer configuration.
|
|
135
|
-
|
|
136
|
-
#### copyright
|
|
137
|
-
|
|
138
|
-
```ts
|
|
139
|
-
copyright: string;
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
Copyright text (e.g., "© 2025 Company Name. All rights reserved.").
|
|
143
|
-
|
|
144
|
-
#### links?
|
|
145
|
-
|
|
146
|
-
```ts
|
|
147
|
-
optional links?: {
|
|
148
|
-
label: string;
|
|
149
|
-
url: string;
|
|
150
|
-
}[];
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
Optional array of footer links.
|
|
154
|
-
|
|
155
|
-
#### stage?
|
|
156
|
-
|
|
157
|
-
```ts
|
|
158
|
-
optional stage?: string;
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
Optional stage label (e.g., "Beta", "Alpha").
|
|
162
|
-
|
|
163
|
-
#### version?
|
|
164
|
-
|
|
165
|
-
```ts
|
|
166
|
-
optional version?: string;
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
Optional version string.
|
|
170
|
-
|
|
171
|
-
***
|
|
172
|
-
|
|
173
|
-
### health?
|
|
174
|
-
|
|
175
|
-
```ts
|
|
176
|
-
optional health?: IHealthCheckResult[];
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
Defined in: [services/HostService.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L86)
|
|
180
|
-
|
|
181
|
-
Optional health check result to display.
|
|
182
|
-
|
|
183
|
-
***
|
|
184
|
-
|
|
185
|
-
### logo
|
|
186
|
-
|
|
187
|
-
```ts
|
|
188
|
-
logo: string;
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
Defined in: [services/HostService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L33)
|
|
192
|
-
|
|
193
|
-
The logo URL (can be a regular URL or data URL).
|
|
194
|
-
|
|
195
|
-
***
|
|
196
|
-
|
|
197
|
-
### style?
|
|
198
|
-
|
|
199
|
-
```ts
|
|
200
|
-
optional style?: {
|
|
201
|
-
primary: string;
|
|
202
|
-
secondary: string;
|
|
203
|
-
};
|
|
204
|
-
```
|
|
205
|
-
|
|
206
|
-
Defined in: [services/HostService.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L78)
|
|
207
|
-
|
|
208
|
-
Optional style configuration.
|
|
209
|
-
|
|
210
|
-
#### primary
|
|
211
|
-
|
|
212
|
-
```ts
|
|
213
|
-
primary: string;
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
#### secondary
|
|
217
|
-
|
|
218
|
-
```ts
|
|
219
|
-
secondary: string;
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
***
|
|
223
|
-
|
|
224
|
-
### title
|
|
225
|
-
|
|
226
|
-
```ts
|
|
227
|
-
title: string;
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
Defined in: [services/HostService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L23)
|
|
231
|
-
|
|
232
|
-
The title of the page.
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IIdGenerator'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IIdGenerator
|
|
7
|
-
|
|
8
|
-
Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L4)
|
|
9
|
-
|
|
10
|
-
Interface for ID generators
|
|
11
|
-
|
|
12
|
-
## Methods
|
|
13
|
-
|
|
14
|
-
### generate()
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
generate(prefix?, postfix?): string;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L15)
|
|
21
|
-
|
|
22
|
-
Generates a new ID
|
|
23
|
-
|
|
24
|
-
#### Parameters
|
|
25
|
-
|
|
26
|
-
| Parameter | Type | Description |
|
|
27
|
-
| ------ | ------ | ------ |
|
|
28
|
-
| `prefix?` | `string` | Optional prefix to prepend to the ID |
|
|
29
|
-
| `postfix?` | `string` | Optional postfix to append to the ID |
|
|
30
|
-
|
|
31
|
-
#### Returns
|
|
32
|
-
|
|
33
|
-
`string`
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### isValid()
|
|
38
|
-
|
|
39
|
-
```ts
|
|
40
|
-
isValid(id): boolean;
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Defined in: [identifiers/generators/interfaces/IIdGenerator.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/interfaces/IIdGenerator.ts#L24)
|
|
44
|
-
|
|
45
|
-
Validates if the given ID conforms to the expected format
|
|
46
|
-
|
|
47
|
-
#### Parameters
|
|
48
|
-
|
|
49
|
-
| Parameter | Type | Description |
|
|
50
|
-
| ------ | ------ | ------ |
|
|
51
|
-
| `id` | `string` | The ID to validate |
|
|
52
|
-
|
|
53
|
-
#### Returns
|
|
54
|
-
|
|
55
|
-
`boolean`
|
|
56
|
-
|
|
57
|
-
True if the ID is valid, otherwise false
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IMappingBuilder'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IMappingBuilder
|
|
7
|
-
|
|
8
|
-
Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L18)
|
|
9
|
-
|
|
10
|
-
Defines the interface for a mapping builder.
|
|
11
|
-
|
|
12
|
-
## Methods
|
|
13
|
-
|
|
14
|
-
### createKeyedMap()
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
createKeyedMap<TInput, TOutput>(key, fn): this;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L45)
|
|
21
|
-
|
|
22
|
-
Creates a keyed mapping between two types with full type safety.
|
|
23
|
-
The mapping key encodes both input and output types at compile time.
|
|
24
|
-
|
|
25
|
-
#### Type Parameters
|
|
26
|
-
|
|
27
|
-
| Type Parameter |
|
|
28
|
-
| ------ |
|
|
29
|
-
| `TInput` |
|
|
30
|
-
| `TOutput` |
|
|
31
|
-
|
|
32
|
-
#### Parameters
|
|
33
|
-
|
|
34
|
-
| Parameter | Type | Description |
|
|
35
|
-
| ------ | ------ | ------ |
|
|
36
|
-
| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
|
|
37
|
-
| `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
|
|
38
|
-
|
|
39
|
-
#### Returns
|
|
40
|
-
|
|
41
|
-
`this`
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### createMap()
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
createMap<TSource, TDestination>(
|
|
49
|
-
source,
|
|
50
|
-
destination,
|
|
51
|
-
fn): this;
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L31)
|
|
55
|
-
|
|
56
|
-
Creates a mapping between two types.
|
|
57
|
-
Ensures compile-time type compatibility between source and destination.
|
|
58
|
-
|
|
59
|
-
#### Type Parameters
|
|
60
|
-
|
|
61
|
-
| Type Parameter |
|
|
62
|
-
| ------ |
|
|
63
|
-
| `TSource` |
|
|
64
|
-
| `TDestination` |
|
|
65
|
-
|
|
66
|
-
#### Parameters
|
|
67
|
-
|
|
68
|
-
| Parameter | Type | Description |
|
|
69
|
-
| ------ | ------ | ------ |
|
|
70
|
-
| `source` | `Constructor`\<`TSource`\> | The source type. |
|
|
71
|
-
| `destination` | `Constructor`\<`TDestination`\> | The destination type. |
|
|
72
|
-
| `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
|
|
73
|
-
|
|
74
|
-
#### Returns
|
|
75
|
-
|
|
76
|
-
`this`
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IMappingKey\<TInput, TOutput\>'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IMappingKey\<TInput, TOutput\>
|
|
7
|
-
|
|
8
|
-
Defined in: [mapping/types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L9)
|
|
9
|
-
|
|
10
|
-
Type-safe mapping key that encodes both input and output types.
|
|
11
|
-
This ensures compile-time type safety when using the mapping service.
|
|
12
|
-
|
|
13
|
-
## Type Parameters
|
|
14
|
-
|
|
15
|
-
| Type Parameter | Description |
|
|
16
|
-
| ------ | ------ |
|
|
17
|
-
| `TInput` | The input type for the mapping. |
|
|
18
|
-
| `TOutput` | The output type for the mapping. |
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### \_brand
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
readonly _brand: "MappingKey";
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Defined in: [mapping/types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L10)
|
|
29
|
-
|
|
30
|
-
***
|
|
31
|
-
|
|
32
|
-
### \_input
|
|
33
|
-
|
|
34
|
-
```ts
|
|
35
|
-
readonly _input: TInput;
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
Defined in: [mapping/types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L11)
|
|
39
|
-
|
|
40
|
-
***
|
|
41
|
-
|
|
42
|
-
### \_output
|
|
43
|
-
|
|
44
|
-
```ts
|
|
45
|
-
readonly _output: TOutput;
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
Defined in: [mapping/types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L12)
|
|
49
|
-
|
|
50
|
-
***
|
|
51
|
-
|
|
52
|
-
### key
|
|
53
|
-
|
|
54
|
-
```ts
|
|
55
|
-
readonly key: string;
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
Defined in: [mapping/types/MappingKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L13)
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IMappingProfile'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IMappingProfile
|
|
7
|
-
|
|
8
|
-
Defined in: [mapping/profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L12)
|
|
9
|
-
|
|
10
|
-
Defines the interface for a mapping profile.
|
|
11
|
-
|
|
12
|
-
## Methods
|
|
13
|
-
|
|
14
|
-
### configure()
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
configure(builder): void;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [mapping/profile/interfaces/IMappingProfile.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L22)
|
|
21
|
-
|
|
22
|
-
Configures the mapping profile.
|
|
23
|
-
|
|
24
|
-
#### Parameters
|
|
25
|
-
|
|
26
|
-
| Parameter | Type | Description |
|
|
27
|
-
| ------ | ------ | ------ |
|
|
28
|
-
| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
|
|
29
|
-
|
|
30
|
-
#### Returns
|
|
31
|
-
|
|
32
|
-
`void`
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IResourceManagerConfig'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IResourceManagerConfig
|
|
7
|
-
|
|
8
|
-
Defined in: [resources/ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L16)
|
|
9
|
-
|
|
10
|
-
Configuration for the ResourceManager.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### cache?
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
optional cache?: ILayeredCache<string, IResourceResult>;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [resources/ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L26)
|
|
21
|
-
|
|
22
|
-
Optional cache for loaded resources.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### cacheTtl?
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
optional cacheTtl?: number;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [resources/ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L32)
|
|
33
|
-
|
|
34
|
-
Cache TTL in seconds.
|
|
35
|
-
|
|
36
|
-
#### Default
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
3600 (1 hour)
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
***
|
|
43
|
-
|
|
44
|
-
### debug?
|
|
45
|
-
|
|
46
|
-
```ts
|
|
47
|
-
optional debug?: boolean;
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
Defined in: [resources/ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L38)
|
|
51
|
-
|
|
52
|
-
Enable debug logging.
|
|
53
|
-
|
|
54
|
-
#### Default
|
|
55
|
-
|
|
56
|
-
```ts
|
|
57
|
-
false
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### strategies
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
strategies: IResourceStrategy[];
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Defined in: [resources/ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L21)
|
|
69
|
-
|
|
70
|
-
Resource loading strategies in priority order.
|
|
71
|
-
First strategy that finds the resource wins.
|
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IResourceMetadata'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IResourceMetadata
|
|
7
|
-
|
|
8
|
-
Defined in: [resources/types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L6)
|
|
9
|
-
|
|
10
|
-
Metadata about a resource.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### cachedAt?
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
optional cachedAt?: Date;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [resources/types/IResourceMetadata.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L41)
|
|
21
|
-
|
|
22
|
-
When this resource was cached (if applicable).
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### encoding?
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
optional encoding?: BufferEncoding;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [resources/types/IResourceMetadata.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L31)
|
|
33
|
-
|
|
34
|
-
The encoding of the resource (if applicable).
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### key
|
|
39
|
-
|
|
40
|
-
```ts
|
|
41
|
-
key: string;
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
Defined in: [resources/types/IResourceMetadata.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L11)
|
|
45
|
-
|
|
46
|
-
The resource key/identifier.
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### mimeType
|
|
51
|
-
|
|
52
|
-
```ts
|
|
53
|
-
mimeType: string;
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
Defined in: [resources/types/IResourceMetadata.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L21)
|
|
57
|
-
|
|
58
|
-
The MIME type of the resource.
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### path
|
|
63
|
-
|
|
64
|
-
```ts
|
|
65
|
-
path: string;
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Defined in: [resources/types/IResourceMetadata.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L16)
|
|
69
|
-
|
|
70
|
-
The full path of the resource.
|
|
71
|
-
|
|
72
|
-
***
|
|
73
|
-
|
|
74
|
-
### size
|
|
75
|
-
|
|
76
|
-
```ts
|
|
77
|
-
size: number;
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Defined in: [resources/types/IResourceMetadata.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L26)
|
|
81
|
-
|
|
82
|
-
The size of the resource in bytes.
|
|
83
|
-
|
|
84
|
-
***
|
|
85
|
-
|
|
86
|
-
### source
|
|
87
|
-
|
|
88
|
-
```ts
|
|
89
|
-
source: string;
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
Defined in: [resources/types/IResourceMetadata.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceMetadata.ts#L36)
|
|
93
|
-
|
|
94
|
-
The source strategy that resolved this resource.
|
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: 'Interface: IResourceResult'
|
|
3
|
-
generated: true
|
|
4
|
-
editUrl: false
|
|
5
|
-
---
|
|
6
|
-
# Interface: IResourceResult
|
|
7
|
-
|
|
8
|
-
Defined in: [resources/types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L8)
|
|
9
|
-
|
|
10
|
-
Result of loading a resource.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### content
|
|
15
|
-
|
|
16
|
-
```ts
|
|
17
|
-
content: Buffer;
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Defined in: [resources/types/IResourceResult.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L13)
|
|
21
|
-
|
|
22
|
-
The resource content as a Buffer.
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### metadata
|
|
27
|
-
|
|
28
|
-
```ts
|
|
29
|
-
metadata: IResourceMetadata;
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
Defined in: [resources/types/IResourceResult.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/types/IResourceResult.ts#L18)
|
|
33
|
-
|
|
34
|
-
Metadata about the resource.
|