common-plugin/dev.akif.tapik.plugin

Package-level declarations

Types

data class GeneratedQueryParameterTypeInfo(val nonNullableType: String, val renderedType: String, val hasDefault: Boolean, val hasNonNullDefault: Boolean)

Shared type information used when generators expose query parameters as Kotlin method arguments.

GeneratorConfiguration

data class GeneratorConfiguration(val clientSuffix: String = "Client", val serverSuffix: String = "Server")

Generator-specific configuration shared across Tapik plugin frontends.

KotlinEndpointGenerationContext

data class KotlinEndpointGenerationContext(val contractTypeName: String, val endpointReference: String, val methodName: String, val summaryLines: List<String>, val detailLines: List<String>, val response: KotlinEndpointResponseModel)

Shared naming and response-shape information exposed to Kotlin endpoint generators.

KotlinEndpointMemberContribution

data class KotlinEndpointMemberContribution(val endpointPropertyName: String, val content: String)

Nested content that should be inserted into one generated endpoint contract interface.

KotlinEndpointResponseModel

data class KotlinEndpointResponseModel(val typeName: String, val variants: List<KotlinEndpointResponseModel.Variant>)

Describes the generated public response type for a Kotlin endpoint contract.

KotlinSourceFileContribution

data class KotlinSourceFileContribution(val packageName: String, val sourcePackageName: String, val sourceFile: String, val aggregateInterfaceName: String, val nestedInterfaceName: String, val imports: Set<String> = emptySet(), val endpointMembers: List<KotlinEndpointMemberContribution>, val topLevelDeclarations: List<String> = emptyList())

Integration-specific content for one generated Kotlin source file.

MarkdownDocumentationGenerator

class MarkdownDocumentationGenerator : TapikDirectGenerator

A generator that creates Markdown documentation from tapik endpoint definitions.

TapikCodeGenerationConfiguration

data class TapikCodeGenerationConfiguration(val outputDirectory: File, val generatedSourcesDirectory: File, val generatedPackageName: String = "generated", val endpointsSuffix: String = "Endpoints", val basePackage: String, val compiledClassesDirectory: File, val additionalClasspathDirectories: List<File>, val generatorConfigurations: Map<String, GeneratorConfiguration>)

Shared configuration for the Tapik code-generation engine.

TapikCodeGenerationEngine

class TapikCodeGenerationEngine(config: TapikCodeGenerationConfiguration, logger: TapikLogger)

Shared code-generation engine used by plugin frontends such as Gradle and Maven integrations.

TapikDirectGenerator

interface TapikDirectGenerator : TapikGenerator

Contract implemented by generators that directly emit artefacts during invocation.

TapikGenerator

interface TapikGenerator

Marker contract implemented by Tapik generators loaded at runtime.

TapikGeneratorContext

data class TapikGeneratorContext(val outputDirectory: File, val generatedSourcesDirectory: File, val generatedPackageName: String = "generated", val endpointsSuffix: String = "Endpoints", val logger: TapikLogger, val generatorConfiguration: GeneratorConfiguration)

Carries directories and logging utilities that Tapik generators rely on.

TapikKotlinContribution

data class TapikKotlinContribution(val sourceFiles: List<KotlinSourceFileContribution> = emptyList())

Contribution set emitted by a TapikKotlinEndpointGenerator.

TapikKotlinEndpointGenerator

interface TapikKotlinEndpointGenerator : TapikGenerator

Specialised Tapik generator that contributes nested Kotlin members to shared endpoint contract files.

TapikLogger

interface TapikLogger

Logging callbacks used by the shared Tapik code-generation engine.

Functions

appendGeneratedKdoc

fun StringBuilder.appendGeneratedKdoc(summaryLines: List<String>, detailLines: List<String>, indentation: String)

Appends a KDoc block when summary or detail lines are available.

buildKotlinSourceFileContributions

fun buildKotlinSourceFileContributions(endpoints: List<HttpEndpointMetadata>, endpointsSuffix: String, generatedPackageName: String, aggregateInterfaceName: (sourceFile: String) -> String, nestedInterfaceName: String, imports: (endpointsInFile: List<HttpEndpointMetadata>) -> Set<String> = { emptySet() }, endpointMemberContent: (endpoint: HttpEndpointMetadata, context: KotlinEndpointGenerationContext) -> String, topLevelDeclarations: (sourceFile: String, aggregateInterfaceName: String, endpointContexts: List<Pair<HttpEndpointMetadata, KotlinEndpointGenerationContext>>) -> List<String> = { _, _, _ -> emptyList() }): List<KotlinSourceFileContribution>

Builds source-file contribution DTOs for Kotlin generators from shared endpoint metadata.

contributeKotlinSourceFiles

fun contributeKotlinSourceFiles(endpoints: List<HttpEndpointMetadata>, context: TapikGeneratorContext, emptyMessage: String, generatingMessage: String, sourceFiles: () -> List<KotlinSourceFileContribution>): TapikKotlinContribution

Creates a Kotlin contribution result while handling the common empty-endpoint fast path and logging.

escapeForAnnotation

fun String.escapeForAnnotation(): String

Escapes quotes and path separators so that the string can be safely embedded inside annotation arguments.

escapeForKdoc

fun String.escapeForKdoc(): String

Escapes terminator sequences that would prematurely end a KDoc block.

render

fun TypeMetadata.render(): String

Renders the receiver type as a Kotlin type literal, including generics and nullability information.

renderValueType

fun BodyMetadata.renderValueType(): String

Returns the Kotlin value type exposed by generated code for the receiver body metadata.

sanitizeIdentifier

fun sanitizeIdentifier(rawName: String?, fallback: String): String

Sanitises an arbitrary identifier so that it is safe to use as a Kotlin name.

simpleName

fun TypeMetadata.simpleName(): String

Resolves the simple, unqualified name of the receiver type.

toGeneratedPackageName

fun String.toGeneratedPackageName(generatedPackageName: String): String

Appends generatedPackageName to the receiver package unless the receiver is blank.

toGeneratedTypeInfo

fun QueryParameterMetadata.toGeneratedTypeInfo(): GeneratedQueryParameterTypeInfo

Resolves the Kotlin argument type information used by generated clients/controllers for a query parameter.

uniqueName

fun uniqueName(base: String, used: MutableSet<String>): String

Generates a unique identifier by applying numeric suffixes until an unused variant is discovered.

writeMergedKotlinSourceFiles

fun writeMergedKotlinSourceFiles(endpoints: List<HttpEndpointMetadata>, sourceFiles: List<KotlinSourceFileContribution>, generatedSourcesDirectory: File, endpointsSuffix: String = "Endpoints", logWarn: (String, Throwable?) -> Unit = { _, _ -> }): Set<File>

Writes merged Kotlin endpoint contract files to generatedSourcesDirectory.