tenant-api/viaduct.api

Package-level declarations

This is the main package for the Viaduct Tenant API, containing the core interfaces and classes that tenants will use to implement their GraphQL schema behavior.

Types

DynamicOutputValueBuilder

interface DynamicOutputValueBuilder<T>

Builder interface for dynamic output values.

FieldValue

sealed interface FieldValue<out T>

Represents the value of a resolved GraphQL object field

Resolver

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Resolver(val objectValueFragment: String = "", val queryValueFragment: String = "", val variables: Array<Variable> = [])

Annotation to mark a class as a resolver for a field or object in a GraphQL schema which requires custom resolution logic rather than simple property access.

TenantModule

interface TenantModule

ValueMapper

interface ValueMapper<D : Any>

Provides a custom implementation for mapping a data type to a Viaduct object type. Implementations should be registered using the service loader mechanism.

Variable

annotation class Variable(val name: String, val fromObjectField: String = UNSET_STRING_VALUE, val fromQueryField: String = UNSET_STRING_VALUE, val fromArgument: String = UNSET_STRING_VALUE)

Variables

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Variables(val types: String)

VariablesProvider

fun interface VariablesProvider<T : Arguments>

A base interface for dynamic provisioning of variable values. All implementations of VariablesProvider must be annotated with Variables.

ViaductFrameworkException

class ViaductFrameworkException : Exception

Used in the tenant API and dependencies to indicate that an error is due to framework code and shouldn't be attributed to tenant code

ViaductTenantException

interface ViaductTenantException

Marker interface for exceptions that should be attributed to tenant code

ViaductTenantResolverException

class ViaductTenantResolverException(val cause: Throwable, val resolver: String) : Exception, ViaductTenantException

Used to wrap non-framework exceptions that are thrown while executing tenant resolver code. This is tied to a specific tenant-written resolver.

ViaductTenantUsageException

class ViaductTenantUsageException(message: String, cause: Throwable? = null) : Exception, ViaductTenantException

Used in framework code to indicate that an error is due to invalid usage of the tenant API by tenant code.

Functions

wrapResolveException

suspend fun wrapResolveException(resolverId: String, resolveFn: suspend () -> Any?): Any?

Catches any exception thrown by resolveFn (which must be called via reflection) and wraps it in ViaductTenantResolverException unless it's a ViaductFrameworkException.