@breadstone/archipel-mcp 0.0.8 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
- package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +28 -29
- package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
- package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
- package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
- package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
- package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
- package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
- package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
- package/data/packages/platform-analytics/api/index.md +25 -26
- package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.AppleConnector.md +86 -0
- package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
- package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
- package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +32 -33
- package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +78 -0
- package/data/packages/platform-authentication/api/Class.GoogleConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
- package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
- package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
- package/data/packages/platform-authentication/api/Class.MfaService.md +65 -66
- package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
- package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +84 -0
- package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
- package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
- package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
- package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
- package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
- package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +144 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +36 -37
- package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
- package/data/packages/platform-authentication/api/Function.Token.md +0 -1
- package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
- package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +54 -25
- package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +22 -23
- package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
- package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
- package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
- package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
- package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
- package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
- package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
- package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +14 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
- package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
- package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +29 -0
- package/data/packages/platform-authentication/api/Variable.User.md +2 -3
- package/data/packages/platform-authentication/api/index.md +94 -92
- package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +4 -5
- package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
- package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
- package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
- package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
- package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
- package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
- package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +5 -6
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
- package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +2 -3
- package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
- package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
- package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
- package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-blob-storage/api/index.md +41 -42
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +47 -48
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +24 -25
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +47 -48
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +24 -25
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +9 -10
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +42 -43
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +9 -10
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +22 -23
- package/data/packages/platform-caching/api/index.md +12 -13
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
- package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
- package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
- package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
- package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
- package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
- package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
- package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
- package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
- package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
- package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
- package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
- package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
- package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
- package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
- package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +19 -20
- package/data/packages/platform-core/api/Class.EventHub.md +25 -26
- package/data/packages/platform-core/api/Class.EventModule.md +0 -1
- package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
- package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
- package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
- package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
- package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
- package/data/packages/platform-core/api/Class.HostModule.md +0 -2
- package/data/packages/platform-core/api/Class.HostService.md +21 -22
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
- package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
- package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
- package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
- package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
- package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
- package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
- package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
- package/data/packages/platform-core/api/Class.MappingService.md +52 -53
- package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
- package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
- package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
- package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
- package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
- package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
- package/data/packages/platform-core/api/Class.ResourceManager.md +107 -108
- package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
- package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
- package/data/packages/platform-core/api/Class.SseHub.md +23 -24
- package/data/packages/platform-core/api/Class.SseModule.md +3 -4
- package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
- package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
- package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
- package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
- package/data/packages/platform-core/api/Function.Public.md +0 -1
- package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
- package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
- package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
- package/data/packages/platform-core/api/Function.env.md +4 -5
- package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
- package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
- package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
- package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
- package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
- package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
- package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
- package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +11 -12
- package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
- package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
- package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
- package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +14 -15
- package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
- package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
- package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +8 -9
- package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
- package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
- package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
- package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
- package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
- package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
- package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
- package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
- package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
- package/data/packages/platform-core/api/Variable.APP_NAME.md +14 -0
- package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
- package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +14 -0
- package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +2 -3
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +2 -3
- package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
- package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
- package/data/packages/platform-core/api/Variable.Lang.md +5 -6
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +2 -3
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +3 -4
- package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
- package/data/packages/platform-core/api/index.md +116 -114
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +9 -10
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +5 -6
- package/data/packages/platform-cryptography/api/Class.OtpService.md +12 -13
- package/data/packages/platform-cryptography/api/Interface.IOtpService.md +12 -13
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +6 -7
- package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +2 -3
- package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +8 -9
- package/data/packages/platform-cryptography/api/index.md +11 -12
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
- package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
- package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
- package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
- package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
- package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
- package/data/packages/platform-database/api/Function.pageable.md +13 -10
- package/data/packages/platform-database/api/Function.paginator.md +2 -3
- package/data/packages/platform-database/api/Function.query.md +7 -8
- package/data/packages/platform-database/api/Function.skip.md +5 -6
- package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
- package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
- package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
- package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
- package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
- package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
- package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
- package/data/packages/platform-database/api/index.md +27 -28
- package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
- package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
- package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
- package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
- package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
- package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
- package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
- package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
- package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
- package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
- package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
- package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
- package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
- package/data/packages/platform-documents/api/index.md +28 -29
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
- package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
- package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
- package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
- package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
- package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
- package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
- package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
- package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
- package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
- package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
- package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
- package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
- package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
- package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
- package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
- package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
- package/data/packages/platform-esigning/api/index.md +65 -66
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +8 -9
- package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +13 -14
- package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +1 -2
- package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +13 -14
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +10 -11
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +4 -5
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +7 -8
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +9 -10
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +13 -14
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +3 -4
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +8 -9
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +5 -6
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +6 -7
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
- package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
- package/data/packages/platform-intelligence/api/index.md +46 -47
- package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
- package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
- package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-logging/api/index.md +7 -8
- package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
- package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
- package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
- package/data/packages/platform-mailing/api/Class.MailService.md +31 -32
- package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +18 -19
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +16 -17
- package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
- package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
- package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
- package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
- package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
- package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
- package/data/packages/platform-mailing/api/index.md +54 -55
- package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
- package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
- package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
- package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
- package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
- package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
- package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
- package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
- package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
- package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
- package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
- package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
- package/data/packages/platform-mcp/api/index.md +26 -27
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
- package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
- package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
- package/data/packages/platform-openapi/api/Function.Api.md +13 -14
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +5 -6
- package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
- package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
- package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
- package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
- package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
- package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
- package/data/packages/platform-openapi/api/index.md +24 -25
- package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
- package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
- package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +30 -31
- package/data/packages/platform-payments/api/Class.MollieClient.md +30 -31
- package/data/packages/platform-payments/api/Class.PaddleClient.md +30 -31
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
- package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
- package/data/packages/platform-payments/api/Class.StripeClient.md +30 -31
- package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
- package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
- package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
- package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
- package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
- package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
- package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
- package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
- package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
- package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
- package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
- package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
- package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
- package/data/packages/platform-payments/api/index.md +40 -41
- package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
- package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
- package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
- package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
- package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
- package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
- package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
- package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
- package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
- package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
- package/data/packages/platform-reporting/api/index.md +23 -24
- package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
- package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
- package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
- package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
- package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
- package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
- package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
- package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
- package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
- package/data/packages/platform-telemetry/api/index.md +20 -21
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.AppleStrategy.md +0 -81
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
- package/data/packages/platform-authentication/api/Class.GoogleStrategy.md +0 -79
- package/data/packages/platform-authentication/api/Class.MicrosoftStrategy.md +0 -79
|
@@ -3,7 +3,6 @@ title: 'Class: ProblemDetailExceptionFilter'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ProblemDetailExceptionFilter
|
|
8
7
|
|
|
9
8
|
Defined in: [filters/ProblemDetailExceptionFilter.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L44)
|
|
@@ -27,8 +26,8 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:54](https://github.com/RueD
|
|
|
27
26
|
|
|
28
27
|
#### Parameters
|
|
29
28
|
|
|
30
|
-
| Parameter
|
|
31
|
-
|
|
|
29
|
+
| Parameter | Type |
|
|
30
|
+
| ------ | ------ |
|
|
32
31
|
| `urlResolver?` | [`ProblemDetailTypeUrlResolver`](TypeAlias.ProblemDetailTypeUrlResolver) |
|
|
33
32
|
|
|
34
33
|
#### Returns
|
|
@@ -59,10 +58,10 @@ Method to implement a custom exception filter.
|
|
|
59
58
|
|
|
60
59
|
#### Parameters
|
|
61
60
|
|
|
62
|
-
| Parameter
|
|
63
|
-
|
|
|
64
|
-
| `exception` | `Error`
|
|
65
|
-
| `host`
|
|
61
|
+
| Parameter | Type | Description |
|
|
62
|
+
| ------ | ------ | ------ |
|
|
63
|
+
| `exception` | `Error` | the class of the exception being handled |
|
|
64
|
+
| `host` | `ArgumentsHost` | used to access an array of arguments for the in-flight request |
|
|
66
65
|
|
|
67
66
|
#### Returns
|
|
68
67
|
|
|
@@ -71,10 +70,10 @@ Method to implement a custom exception filter.
|
|
|
71
70
|
#### Implementation of
|
|
72
71
|
|
|
73
72
|
```ts
|
|
74
|
-
ExceptionFilter.catch
|
|
73
|
+
ExceptionFilter.catch
|
|
75
74
|
```
|
|
76
75
|
|
|
77
|
-
|
|
76
|
+
***
|
|
78
77
|
|
|
79
78
|
### setLogger()
|
|
80
79
|
|
|
@@ -86,9 +85,9 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:76](https://github.com/RueD
|
|
|
86
85
|
|
|
87
86
|
#### Parameters
|
|
88
87
|
|
|
89
|
-
| Parameter | Type
|
|
90
|
-
|
|
|
91
|
-
| `logger`
|
|
88
|
+
| Parameter | Type |
|
|
89
|
+
| ------ | ------ |
|
|
90
|
+
| `logger` | `LoggerService` |
|
|
92
91
|
|
|
93
92
|
#### Returns
|
|
94
93
|
|
|
@@ -3,7 +3,6 @@ title: 'Class: QuantityResponse'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: QuantityResponse
|
|
8
7
|
|
|
9
8
|
Defined in: [models/response/QuantityResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/QuantityResponse.ts#L14)
|
|
@@ -32,7 +31,7 @@ unit: string;
|
|
|
32
31
|
|
|
33
32
|
Defined in: [models/response/QuantityResponse.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/QuantityResponse.ts#L22)
|
|
34
33
|
|
|
35
|
-
|
|
34
|
+
***
|
|
36
35
|
|
|
37
36
|
### value
|
|
38
37
|
|
|
@@ -3,10 +3,9 @@ title: 'Class: ResourceManager'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ResourceManager
|
|
8
7
|
|
|
9
|
-
Defined in: [resources/ResourceManager.ts:
|
|
8
|
+
Defined in: [resources/ResourceManager.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L68)
|
|
10
9
|
|
|
11
10
|
Central manager for loading resources from various sources.
|
|
12
11
|
Supports multiple strategies (file, blob, embedded) with caching.
|
|
@@ -23,15 +22,15 @@ Supports multiple strategies (file, blob, embedded) with caching.
|
|
|
23
22
|
new ResourceManager(config): ResourceManager;
|
|
24
23
|
```
|
|
25
24
|
|
|
26
|
-
Defined in: [resources/ResourceManager.ts:
|
|
25
|
+
Defined in: [resources/ResourceManager.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L85)
|
|
27
26
|
|
|
28
27
|
Constructs a new instance of the `ResourceManager` class.
|
|
29
28
|
|
|
30
29
|
#### Parameters
|
|
31
30
|
|
|
32
|
-
| Parameter | Type
|
|
33
|
-
|
|
|
34
|
-
| `config`
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------ | ------ |
|
|
33
|
+
| `config` | [`IResourceManagerConfig`](Interface.IResourceManagerConfig) |
|
|
35
34
|
|
|
36
35
|
#### Returns
|
|
37
36
|
|
|
@@ -45,15 +44,15 @@ Constructs a new instance of the `ResourceManager` class.
|
|
|
45
44
|
exists(key): boolean;
|
|
46
45
|
```
|
|
47
46
|
|
|
48
|
-
Defined in: [resources/ResourceManager.ts:
|
|
47
|
+
Defined in: [resources/ResourceManager.ts:359](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L359)
|
|
49
48
|
|
|
50
49
|
Checks if a resource exists.
|
|
51
50
|
|
|
52
51
|
#### Parameters
|
|
53
52
|
|
|
54
|
-
| Parameter | Type
|
|
55
|
-
|
|
|
56
|
-
| `key`
|
|
53
|
+
| Parameter | Type | Description |
|
|
54
|
+
| ------ | ------ | ------ |
|
|
55
|
+
| `key` | `string` | The resource key |
|
|
57
56
|
|
|
58
57
|
#### Returns
|
|
59
58
|
|
|
@@ -64,10 +63,10 @@ True if the resource exists in any strategy
|
|
|
64
63
|
#### Implementation of
|
|
65
64
|
|
|
66
65
|
```ts
|
|
67
|
-
IResourceManager.exists
|
|
66
|
+
IResourceManager.exists
|
|
68
67
|
```
|
|
69
68
|
|
|
70
|
-
|
|
69
|
+
***
|
|
71
70
|
|
|
72
71
|
### existsAsync()
|
|
73
72
|
|
|
@@ -75,15 +74,15 @@ IResourceManager.exists;
|
|
|
75
74
|
existsAsync(key): Promise<boolean>;
|
|
76
75
|
```
|
|
77
76
|
|
|
78
|
-
Defined in: [resources/ResourceManager.ts:
|
|
77
|
+
Defined in: [resources/ResourceManager.ts:376](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L376)
|
|
79
78
|
|
|
80
79
|
Checks if a resource exists (asynchronous).
|
|
81
80
|
|
|
82
81
|
#### Parameters
|
|
83
82
|
|
|
84
|
-
| Parameter | Type
|
|
85
|
-
|
|
|
86
|
-
| `key`
|
|
83
|
+
| Parameter | Type | Description |
|
|
84
|
+
| ------ | ------ | ------ |
|
|
85
|
+
| `key` | `string` | The resource key |
|
|
87
86
|
|
|
88
87
|
#### Returns
|
|
89
88
|
|
|
@@ -94,10 +93,10 @@ Promise resolving to true if the resource exists in any strategy
|
|
|
94
93
|
#### Implementation of
|
|
95
94
|
|
|
96
95
|
```ts
|
|
97
|
-
IResourceManager.existsAsync
|
|
96
|
+
IResourceManager.existsAsync
|
|
98
97
|
```
|
|
99
98
|
|
|
100
|
-
|
|
99
|
+
***
|
|
101
100
|
|
|
102
101
|
### invalidate()
|
|
103
102
|
|
|
@@ -105,15 +104,15 @@ IResourceManager.existsAsync;
|
|
|
105
104
|
invalidate(key): void;
|
|
106
105
|
```
|
|
107
106
|
|
|
108
|
-
Defined in: [resources/ResourceManager.ts:
|
|
107
|
+
Defined in: [resources/ResourceManager.ts:392](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L392)
|
|
109
108
|
|
|
110
109
|
Invalidates cached resource.
|
|
111
110
|
|
|
112
111
|
#### Parameters
|
|
113
112
|
|
|
114
|
-
| Parameter | Type
|
|
115
|
-
|
|
|
116
|
-
| `key`
|
|
113
|
+
| Parameter | Type | Description |
|
|
114
|
+
| ------ | ------ | ------ |
|
|
115
|
+
| `key` | `string` | The resource key |
|
|
117
116
|
|
|
118
117
|
#### Returns
|
|
119
118
|
|
|
@@ -122,10 +121,10 @@ Invalidates cached resource.
|
|
|
122
121
|
#### Implementation of
|
|
123
122
|
|
|
124
123
|
```ts
|
|
125
|
-
IResourceManager.invalidate
|
|
124
|
+
IResourceManager.invalidate
|
|
126
125
|
```
|
|
127
126
|
|
|
128
|
-
|
|
127
|
+
***
|
|
129
128
|
|
|
130
129
|
### invalidateAsync()
|
|
131
130
|
|
|
@@ -133,15 +132,15 @@ IResourceManager.invalidate;
|
|
|
133
132
|
invalidateAsync(key): Promise<void>;
|
|
134
133
|
```
|
|
135
134
|
|
|
136
|
-
Defined in: [resources/ResourceManager.ts:
|
|
135
|
+
Defined in: [resources/ResourceManager.ts:406](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L406)
|
|
137
136
|
|
|
138
137
|
Invalidates cached resource (asynchronous).
|
|
139
138
|
|
|
140
139
|
#### Parameters
|
|
141
140
|
|
|
142
|
-
| Parameter | Type
|
|
143
|
-
|
|
|
144
|
-
| `key`
|
|
141
|
+
| Parameter | Type | Description |
|
|
142
|
+
| ------ | ------ | ------ |
|
|
143
|
+
| `key` | `string` | The resource key |
|
|
145
144
|
|
|
146
145
|
#### Returns
|
|
147
146
|
|
|
@@ -152,10 +151,10 @@ Promise that resolves when the cache is invalidated
|
|
|
152
151
|
#### Implementation of
|
|
153
152
|
|
|
154
153
|
```ts
|
|
155
|
-
IResourceManager.invalidateAsync
|
|
154
|
+
IResourceManager.invalidateAsync
|
|
156
155
|
```
|
|
157
156
|
|
|
158
|
-
|
|
157
|
+
***
|
|
159
158
|
|
|
160
159
|
### load()
|
|
161
160
|
|
|
@@ -163,15 +162,15 @@ IResourceManager.invalidateAsync;
|
|
|
163
162
|
load(key): IResourceResult;
|
|
164
163
|
```
|
|
165
164
|
|
|
166
|
-
Defined in: [resources/ResourceManager.ts:
|
|
165
|
+
Defined in: [resources/ResourceManager.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L107)
|
|
167
166
|
|
|
168
167
|
Loads a resource by its key.
|
|
169
168
|
|
|
170
169
|
#### Parameters
|
|
171
170
|
|
|
172
|
-
| Parameter | Type
|
|
173
|
-
|
|
|
174
|
-
| `key`
|
|
171
|
+
| Parameter | Type | Description |
|
|
172
|
+
| ------ | ------ | ------ |
|
|
173
|
+
| `key` | `string` | The resource key |
|
|
175
174
|
|
|
176
175
|
#### Returns
|
|
177
176
|
|
|
@@ -186,10 +185,10 @@ Error if resource not found
|
|
|
186
185
|
#### Implementation of
|
|
187
186
|
|
|
188
187
|
```ts
|
|
189
|
-
IResourceManager.load
|
|
188
|
+
IResourceManager.load
|
|
190
189
|
```
|
|
191
190
|
|
|
192
|
-
|
|
191
|
+
***
|
|
193
192
|
|
|
194
193
|
### loadAsBuffer()
|
|
195
194
|
|
|
@@ -197,15 +196,15 @@ IResourceManager.load;
|
|
|
197
196
|
loadAsBuffer(key): Buffer;
|
|
198
197
|
```
|
|
199
198
|
|
|
200
|
-
Defined in: [resources/ResourceManager.ts:
|
|
199
|
+
Defined in: [resources/ResourceManager.ts:300](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L300)
|
|
201
200
|
|
|
202
201
|
Loads a resource as a Buffer.
|
|
203
202
|
|
|
204
203
|
#### Parameters
|
|
205
204
|
|
|
206
|
-
| Parameter | Type
|
|
207
|
-
|
|
|
208
|
-
| `key`
|
|
205
|
+
| Parameter | Type | Description |
|
|
206
|
+
| ------ | ------ | ------ |
|
|
207
|
+
| `key` | `string` | The resource key |
|
|
209
208
|
|
|
210
209
|
#### Returns
|
|
211
210
|
|
|
@@ -220,10 +219,10 @@ Error if resource not found
|
|
|
220
219
|
#### Implementation of
|
|
221
220
|
|
|
222
221
|
```ts
|
|
223
|
-
IResourceManager.loadAsBuffer
|
|
222
|
+
IResourceManager.loadAsBuffer
|
|
224
223
|
```
|
|
225
224
|
|
|
226
|
-
|
|
225
|
+
***
|
|
227
226
|
|
|
228
227
|
### loadAsBufferAsync()
|
|
229
228
|
|
|
@@ -231,15 +230,15 @@ IResourceManager.loadAsBuffer;
|
|
|
231
230
|
loadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike>>;
|
|
232
231
|
```
|
|
233
232
|
|
|
234
|
-
Defined in: [resources/ResourceManager.ts:
|
|
233
|
+
Defined in: [resources/ResourceManager.ts:330](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L330)
|
|
235
234
|
|
|
236
235
|
Loads a resource as a Buffer (asynchronous).
|
|
237
236
|
|
|
238
237
|
#### Parameters
|
|
239
238
|
|
|
240
|
-
| Parameter | Type
|
|
241
|
-
|
|
|
242
|
-
| `key`
|
|
239
|
+
| Parameter | Type | Description |
|
|
240
|
+
| ------ | ------ | ------ |
|
|
241
|
+
| `key` | `string` | The resource key |
|
|
243
242
|
|
|
244
243
|
#### Returns
|
|
245
244
|
|
|
@@ -254,10 +253,10 @@ Error if resource not found
|
|
|
254
253
|
#### Implementation of
|
|
255
254
|
|
|
256
255
|
```ts
|
|
257
|
-
IResourceManager.loadAsBufferAsync
|
|
256
|
+
IResourceManager.loadAsBufferAsync
|
|
258
257
|
```
|
|
259
258
|
|
|
260
|
-
|
|
259
|
+
***
|
|
261
260
|
|
|
262
261
|
### loadAsString()
|
|
263
262
|
|
|
@@ -265,16 +264,16 @@ IResourceManager.loadAsBufferAsync;
|
|
|
265
264
|
loadAsString(key, encoding?): string;
|
|
266
265
|
```
|
|
267
266
|
|
|
268
|
-
Defined in: [resources/ResourceManager.ts:
|
|
267
|
+
Defined in: [resources/ResourceManager.ts:224](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L224)
|
|
269
268
|
|
|
270
269
|
Loads a resource as a string.
|
|
271
270
|
|
|
272
271
|
#### Parameters
|
|
273
272
|
|
|
274
|
-
| Parameter
|
|
275
|
-
|
|
|
276
|
-
| `key`
|
|
277
|
-
| `encoding` | `BufferEncoding` | `'utf-8'`
|
|
273
|
+
| Parameter | Type | Default value | Description |
|
|
274
|
+
| ------ | ------ | ------ | ------ |
|
|
275
|
+
| `key` | `string` | `undefined` | The resource key |
|
|
276
|
+
| `encoding` | `BufferEncoding` | `'utf-8'` | The encoding to use (default: 'utf-8') |
|
|
278
277
|
|
|
279
278
|
#### Returns
|
|
280
279
|
|
|
@@ -289,10 +288,10 @@ Error if resource not found
|
|
|
289
288
|
#### Implementation of
|
|
290
289
|
|
|
291
290
|
```ts
|
|
292
|
-
IResourceManager.loadAsString
|
|
291
|
+
IResourceManager.loadAsString
|
|
293
292
|
```
|
|
294
293
|
|
|
295
|
-
|
|
294
|
+
***
|
|
296
295
|
|
|
297
296
|
### loadAsStringAsync()
|
|
298
297
|
|
|
@@ -300,16 +299,16 @@ IResourceManager.loadAsString;
|
|
|
300
299
|
loadAsStringAsync(key, encoding?): Promise<string>;
|
|
301
300
|
```
|
|
302
301
|
|
|
303
|
-
Defined in: [resources/ResourceManager.ts:
|
|
302
|
+
Defined in: [resources/ResourceManager.ts:261](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L261)
|
|
304
303
|
|
|
305
304
|
Loads a resource as a string (asynchronous).
|
|
306
305
|
|
|
307
306
|
#### Parameters
|
|
308
307
|
|
|
309
|
-
| Parameter
|
|
310
|
-
|
|
|
311
|
-
| `key`
|
|
312
|
-
| `encoding` | `BufferEncoding` | `'utf-8'`
|
|
308
|
+
| Parameter | Type | Default value | Description |
|
|
309
|
+
| ------ | ------ | ------ | ------ |
|
|
310
|
+
| `key` | `string` | `undefined` | The resource key |
|
|
311
|
+
| `encoding` | `BufferEncoding` | `'utf-8'` | The encoding to use (default: 'utf-8') |
|
|
313
312
|
|
|
314
313
|
#### Returns
|
|
315
314
|
|
|
@@ -324,10 +323,10 @@ Error if resource not found
|
|
|
324
323
|
#### Implementation of
|
|
325
324
|
|
|
326
325
|
```ts
|
|
327
|
-
IResourceManager.loadAsStringAsync
|
|
326
|
+
IResourceManager.loadAsStringAsync
|
|
328
327
|
```
|
|
329
328
|
|
|
330
|
-
|
|
329
|
+
***
|
|
331
330
|
|
|
332
331
|
### loadAsync()
|
|
333
332
|
|
|
@@ -335,15 +334,15 @@ IResourceManager.loadAsStringAsync;
|
|
|
335
334
|
loadAsync(key): Promise<IResourceResult>;
|
|
336
335
|
```
|
|
337
336
|
|
|
338
|
-
Defined in: [resources/ResourceManager.ts:
|
|
337
|
+
Defined in: [resources/ResourceManager.ts:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L165)
|
|
339
338
|
|
|
340
339
|
Loads a resource by its key (asynchronous).
|
|
341
340
|
|
|
342
341
|
#### Parameters
|
|
343
342
|
|
|
344
|
-
| Parameter | Type
|
|
345
|
-
|
|
|
346
|
-
| `key`
|
|
343
|
+
| Parameter | Type | Description |
|
|
344
|
+
| ------ | ------ | ------ |
|
|
345
|
+
| `key` | `string` | The resource key |
|
|
347
346
|
|
|
348
347
|
#### Returns
|
|
349
348
|
|
|
@@ -358,10 +357,10 @@ Error if resource not found
|
|
|
358
357
|
#### Implementation of
|
|
359
358
|
|
|
360
359
|
```ts
|
|
361
|
-
IResourceManager.loadAsync
|
|
360
|
+
IResourceManager.loadAsync
|
|
362
361
|
```
|
|
363
362
|
|
|
364
|
-
|
|
363
|
+
***
|
|
365
364
|
|
|
366
365
|
### tryLoad()
|
|
367
366
|
|
|
@@ -369,15 +368,15 @@ IResourceManager.loadAsync;
|
|
|
369
368
|
tryLoad(key): IResourceResult | undefined;
|
|
370
369
|
```
|
|
371
370
|
|
|
372
|
-
Defined in: [resources/ResourceManager.ts:
|
|
371
|
+
Defined in: [resources/ResourceManager.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L124)
|
|
373
372
|
|
|
374
373
|
Tries to load a resource by its key.
|
|
375
374
|
|
|
376
375
|
#### Parameters
|
|
377
376
|
|
|
378
|
-
| Parameter | Type
|
|
379
|
-
|
|
|
380
|
-
| `key`
|
|
377
|
+
| Parameter | Type | Description |
|
|
378
|
+
| ------ | ------ | ------ |
|
|
379
|
+
| `key` | `string` | The resource key |
|
|
381
380
|
|
|
382
381
|
#### Returns
|
|
383
382
|
|
|
@@ -388,10 +387,10 @@ The resource result or undefined if not found
|
|
|
388
387
|
#### Implementation of
|
|
389
388
|
|
|
390
389
|
```ts
|
|
391
|
-
IResourceManager.tryLoad
|
|
390
|
+
IResourceManager.tryLoad
|
|
392
391
|
```
|
|
393
392
|
|
|
394
|
-
|
|
393
|
+
***
|
|
395
394
|
|
|
396
395
|
### tryLoadAsBuffer()
|
|
397
396
|
|
|
@@ -399,15 +398,15 @@ IResourceManager.tryLoad;
|
|
|
399
398
|
tryLoadAsBuffer(key): Buffer<ArrayBufferLike> | undefined;
|
|
400
399
|
```
|
|
401
400
|
|
|
402
|
-
Defined in: [resources/ResourceManager.ts:
|
|
401
|
+
Defined in: [resources/ResourceManager.ts:317](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L317)
|
|
403
402
|
|
|
404
403
|
Tries to load a resource as a Buffer.
|
|
405
404
|
|
|
406
405
|
#### Parameters
|
|
407
406
|
|
|
408
|
-
| Parameter | Type
|
|
409
|
-
|
|
|
410
|
-
| `key`
|
|
407
|
+
| Parameter | Type | Description |
|
|
408
|
+
| ------ | ------ | ------ |
|
|
409
|
+
| `key` | `string` | The resource key |
|
|
411
410
|
|
|
412
411
|
#### Returns
|
|
413
412
|
|
|
@@ -418,10 +417,10 @@ The resource content as a Buffer or undefined if not found
|
|
|
418
417
|
#### Implementation of
|
|
419
418
|
|
|
420
419
|
```ts
|
|
421
|
-
IResourceManager.tryLoadAsBuffer
|
|
420
|
+
IResourceManager.tryLoadAsBuffer
|
|
422
421
|
```
|
|
423
422
|
|
|
424
|
-
|
|
423
|
+
***
|
|
425
424
|
|
|
426
425
|
### tryLoadAsBufferAsync()
|
|
427
426
|
|
|
@@ -429,15 +428,15 @@ IResourceManager.tryLoadAsBuffer;
|
|
|
429
428
|
tryLoadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike> | undefined>;
|
|
430
429
|
```
|
|
431
430
|
|
|
432
|
-
Defined in: [resources/ResourceManager.ts:
|
|
431
|
+
Defined in: [resources/ResourceManager.ts:347](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L347)
|
|
433
432
|
|
|
434
433
|
Tries to load a resource as a Buffer (asynchronous).
|
|
435
434
|
|
|
436
435
|
#### Parameters
|
|
437
436
|
|
|
438
|
-
| Parameter | Type
|
|
439
|
-
|
|
|
440
|
-
| `key`
|
|
437
|
+
| Parameter | Type | Description |
|
|
438
|
+
| ------ | ------ | ------ |
|
|
439
|
+
| `key` | `string` | The resource key |
|
|
441
440
|
|
|
442
441
|
#### Returns
|
|
443
442
|
|
|
@@ -448,10 +447,10 @@ Promise resolving to the resource content as a Buffer or undefined if not found
|
|
|
448
447
|
#### Implementation of
|
|
449
448
|
|
|
450
449
|
```ts
|
|
451
|
-
IResourceManager.tryLoadAsBufferAsync
|
|
450
|
+
IResourceManager.tryLoadAsBufferAsync
|
|
452
451
|
```
|
|
453
452
|
|
|
454
|
-
|
|
453
|
+
***
|
|
455
454
|
|
|
456
455
|
### tryLoadAsString()
|
|
457
456
|
|
|
@@ -459,16 +458,16 @@ IResourceManager.tryLoadAsBufferAsync;
|
|
|
459
458
|
tryLoadAsString(key, encoding?): string | undefined;
|
|
460
459
|
```
|
|
461
460
|
|
|
462
|
-
Defined in: [resources/ResourceManager.ts:
|
|
461
|
+
Defined in: [resources/ResourceManager.ts:242](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L242)
|
|
463
462
|
|
|
464
463
|
Tries to load a resource as a string.
|
|
465
464
|
|
|
466
465
|
#### Parameters
|
|
467
466
|
|
|
468
|
-
| Parameter
|
|
469
|
-
|
|
|
470
|
-
| `key`
|
|
471
|
-
| `encoding` | `BufferEncoding` | `'utf-8'`
|
|
467
|
+
| Parameter | Type | Default value | Description |
|
|
468
|
+
| ------ | ------ | ------ | ------ |
|
|
469
|
+
| `key` | `string` | `undefined` | The resource key |
|
|
470
|
+
| `encoding` | `BufferEncoding` | `'utf-8'` | The encoding to use (default: 'utf-8') |
|
|
472
471
|
|
|
473
472
|
#### Returns
|
|
474
473
|
|
|
@@ -479,10 +478,10 @@ The resource content as a string or undefined if not found
|
|
|
479
478
|
#### Implementation of
|
|
480
479
|
|
|
481
480
|
```ts
|
|
482
|
-
IResourceManager.tryLoadAsString
|
|
481
|
+
IResourceManager.tryLoadAsString
|
|
483
482
|
```
|
|
484
483
|
|
|
485
|
-
|
|
484
|
+
***
|
|
486
485
|
|
|
487
486
|
### tryLoadAsStringAsync()
|
|
488
487
|
|
|
@@ -490,16 +489,16 @@ IResourceManager.tryLoadAsString;
|
|
|
490
489
|
tryLoadAsStringAsync(key, encoding?): Promise<string | undefined>;
|
|
491
490
|
```
|
|
492
491
|
|
|
493
|
-
Defined in: [resources/ResourceManager.ts:
|
|
492
|
+
Defined in: [resources/ResourceManager.ts:279](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L279)
|
|
494
493
|
|
|
495
494
|
Tries to load a resource as a string (asynchronous).
|
|
496
495
|
|
|
497
496
|
#### Parameters
|
|
498
497
|
|
|
499
|
-
| Parameter
|
|
500
|
-
|
|
|
501
|
-
| `key`
|
|
502
|
-
| `encoding` | `BufferEncoding` | `'utf-8'`
|
|
498
|
+
| Parameter | Type | Default value | Description |
|
|
499
|
+
| ------ | ------ | ------ | ------ |
|
|
500
|
+
| `key` | `string` | `undefined` | The resource key |
|
|
501
|
+
| `encoding` | `BufferEncoding` | `'utf-8'` | The encoding to use (default: 'utf-8') |
|
|
503
502
|
|
|
504
503
|
#### Returns
|
|
505
504
|
|
|
@@ -510,10 +509,10 @@ Promise resolving to the resource content as a string or undefined if not found
|
|
|
510
509
|
#### Implementation of
|
|
511
510
|
|
|
512
511
|
```ts
|
|
513
|
-
IResourceManager.tryLoadAsStringAsync
|
|
512
|
+
IResourceManager.tryLoadAsStringAsync
|
|
514
513
|
```
|
|
515
514
|
|
|
516
|
-
|
|
515
|
+
***
|
|
517
516
|
|
|
518
517
|
### tryLoadAsync()
|
|
519
518
|
|
|
@@ -521,15 +520,15 @@ IResourceManager.tryLoadAsStringAsync;
|
|
|
521
520
|
tryLoadAsync(key): Promise<IResourceResult | undefined>;
|
|
522
521
|
```
|
|
523
522
|
|
|
524
|
-
Defined in: [resources/ResourceManager.ts:
|
|
523
|
+
Defined in: [resources/ResourceManager.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L182)
|
|
525
524
|
|
|
526
525
|
Tries to load a resource by its key (asynchronous).
|
|
527
526
|
|
|
528
527
|
#### Parameters
|
|
529
528
|
|
|
530
|
-
| Parameter | Type
|
|
531
|
-
|
|
|
532
|
-
| `key`
|
|
529
|
+
| Parameter | Type | Description |
|
|
530
|
+
| ------ | ------ | ------ |
|
|
531
|
+
| `key` | `string` | The resource key |
|
|
533
532
|
|
|
534
533
|
#### Returns
|
|
535
534
|
|
|
@@ -540,10 +539,10 @@ Promise resolving to the resource result or undefined if not found
|
|
|
540
539
|
#### Implementation of
|
|
541
540
|
|
|
542
541
|
```ts
|
|
543
|
-
IResourceManager.tryLoadAsync
|
|
542
|
+
IResourceManager.tryLoadAsync
|
|
544
543
|
```
|
|
545
544
|
|
|
546
|
-
|
|
545
|
+
***
|
|
547
546
|
|
|
548
547
|
### whatDoIHave()
|
|
549
548
|
|
|
@@ -551,7 +550,7 @@ IResourceManager.tryLoadAsync;
|
|
|
551
550
|
whatDoIHave(): void;
|
|
552
551
|
```
|
|
553
552
|
|
|
554
|
-
Defined in: [resources/ResourceManager.ts:
|
|
553
|
+
Defined in: [resources/ResourceManager.ts:418](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L418)
|
|
555
554
|
|
|
556
555
|
List all files and folders in the base paths for debugging purposes.
|
|
557
556
|
|
|
@@ -562,5 +561,5 @@ List all files and folders in the base paths for debugging purposes.
|
|
|
562
561
|
#### Implementation of
|
|
563
562
|
|
|
564
563
|
```ts
|
|
565
|
-
IResourceManager.whatDoIHave
|
|
564
|
+
IResourceManager.whatDoIHave
|
|
566
565
|
```
|
|
@@ -3,7 +3,6 @@ title: 'Class: ResourceModule'
|
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
|
|
7
6
|
# Class: ResourceModule
|
|
8
7
|
|
|
9
8
|
Defined in: [resources/ResourceModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceModule.ts#L15)
|
|
@@ -36,9 +35,9 @@ Registers the ResourceManager with the provided configuration.
|
|
|
36
35
|
|
|
37
36
|
#### Parameters
|
|
38
37
|
|
|
39
|
-
| Parameter | Type
|
|
40
|
-
|
|
|
41
|
-
| `config`
|
|
38
|
+
| Parameter | Type | Description |
|
|
39
|
+
| ------ | ------ | ------ |
|
|
40
|
+
| `config` | [`IResourceManagerConfig`](Interface.IResourceManagerConfig) | The resource manager configuration |
|
|
42
41
|
|
|
43
42
|
#### Returns
|
|
44
43
|
|