com.gw2tb.apigen.internal.dsl.SpecBuilder.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-generator Show documentation
A library for generating programs that interface with the official Guild Wars 2 API.
The newest version!
/*
 * Copyright (c) 2019-2024 Leon Linhart
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
@file:OptIn(LowLevelApiGenApi::class)
package com.gw2tb.apigen.internal.dsl

import com.gw2tb.apigen.internal.impl.*
import com.gw2tb.apigen.ir.*
import com.gw2tb.apigen.ir.model.IRAPIQuery
import com.gw2tb.apigen.ir.model.IRAPIType
import com.gw2tb.apigen.model.*
import com.gw2tb.apigen.model.v2.*
import kotlin.time.*

@Suppress("FunctionName")
private fun <
    E,
    Q : IRAPIQuery,
    T : IRAPIType,
    S : SpecBuilderImplBase
> GW2APISpec(builder: S, block: S.() -> Unit): S =
    builder.also(block)

@Suppress("FunctionName")
internal fun GW2APISpecV1(block: SpecBuilderV1.() -> Unit): SpecBuilderV1Impl =
    GW2APISpec(SpecBuilderV1Impl(), block)

@Suppress("FunctionName")
internal fun GW2APISpecV2(block: SpecBuilderV2.() -> Unit): SpecBuilderV2Impl =
    GW2APISpec(SpecBuilderV2Impl(), block)

@APIGenDSL
internal interface SpecBuilder {

    fun array(
        items: DeferredPrimitiveType<*>,
        description: String,
        nullableItems: Boolean = false
    ): DeferredType =
        DeferredSchemaType { typeRegistry, isTopLevel ->
            items.get(typeRegistry, interpretationHint = null, isTopLevel).mapData { IRArray(it, nullableItems, description) }
        }

    fun map(
        keys: DeferredPrimitiveType<*>,
        values: DeferredType>,
        description: String,
        nullableValues: Boolean = false
    ): DeferredType =
        DeferredSchemaType { typeRegistry, isTopLevel ->
            values.get(typeRegistry, interpretationHint = null, isTopLevel).mapData { IRMap(keys.getFlat() as IRPrimitiveOrAlias, it, nullableValues, description) }
        }


    fun conditional(
        name: String,
        description: String,
        disambiguationBy: String = "type",
        disambiguationBySideProperty: Boolean = false,
        interpretationInNestedProperty: Boolean = false,
        sharedConfigure: (AbstractSchemaRecordBuilder.() -> Unit)? = null,
        block: SchemaConditionalBuilder.() -> Unit
    ): DeferredSchemaClass =
        conditional(Name.deriveFromTitleCase(name), description, disambiguationBy, disambiguationBySideProperty, interpretationInNestedProperty, sharedConfigure, block)

    fun conditional(
        name: Name,
        description: String,
        disambiguationBy: String = "type",
        disambiguationBySideProperty: Boolean = false,
        interpretationInNestedProperty: Boolean = false,
        sharedConfigure: (AbstractSchemaRecordBuilder.() -> Unit)? = null,
        block: SchemaConditionalBuilder.() -> Unit
    ): DeferredSchemaClass


    fun enum(type: DeferredPrimitiveType<*>, name: String, description: String, block: SchemaEnumBuilder.() -> Unit): DeferredSchemaClass =
        enum(type, Name.deriveFromTitleCase(name), description, block)

    fun enum(type: DeferredPrimitiveType<*>, name: Name, description: String, block: SchemaEnumBuilder.() -> Unit): DeferredSchemaClass


    fun record(name: String, description: String, block: SchemaRecordBuilder.() -> Unit): DeferredSchemaClass =
        record(Name.deriveFromTitleCase(name), description, block)

    fun record(name: Name, description: String, block: SchemaRecordBuilder.() -> Unit): DeferredSchemaClass


    fun tuple(name: String, description: String, block: SchemaTupleBuilder.() -> Unit): DeferredSchemaClass =
        tuple(Name.deriveFromTitleCase(name), description, block)

    fun tuple(name: Name, description: String, block: SchemaTupleBuilder.() -> Unit): DeferredSchemaClass

}

internal interface SpecBuilderV1 : SpecBuilder {

    operator fun APIv1Endpoint.invoke(
        path: String = this.path.toSnakeCase(),
        querySuffix: String? = null,
        summary: String,
        cache: Duration? = null,
        security: Security? = null,
        block: QueriesBuilderV1.() -> Unit
    )

    operator fun APIv1Endpoint.invoke(
        path: String = this.path.toSnakeCase(),
        idTypeKey: String = "id",
        summary: String,
        queryTypes: QueryTypes,
        cache: Duration? = null,
        security: Security? = null,
        block: QueriesBuilderV1.() -> Unit
    )

}

internal interface SpecBuilderV2 : SpecBuilder {

    operator fun APIv2Endpoint.invoke(
        path: String = this.path.toSnakeCase(),
        querySuffix: String? = null,
        summary: String,
        cache: Duration? = null,
        security: Security? = null,
        since: SchemaVersion = SchemaVersion.V2_SCHEMA_CLASSIC,
        until: SchemaVersion? = null,
        block: QueriesBuilderV2.() -> Unit
    )

    operator fun APIv2Endpoint.invoke(
        path: String = this.path.toSnakeCase(),
        idTypeKey: String = "id",
        summary: String,
        queryTypes: QueryTypes,
        cache: Duration? = null,
        security: Security? = null,
        since: SchemaVersion = SchemaVersion.V2_SCHEMA_CLASSIC,
        until: SchemaVersion? = null,
        block: QueriesBuilderV2.() -> Unit
    )

}