com.gw2tb.apigen.internal.dsl.QueriesBuilder.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.
 */
package com.gw2tb.apigen.internal.dsl

import com.gw2tb.apigen.ir.*
import com.gw2tb.apigen.ir.model.*
import com.gw2tb.apigen.model.Name
import com.gw2tb.apigen.model.v2.*

@APIGenDSL
@OptIn(LowLevelApiGenApi::class)
internal interface QueriesBuilder {

    fun pathParameter(
        name: String,
        type: DeferredPrimitiveType<*>,
        description: String,
        key: String = Name.deriveFromTitleCase(name).toSnakeCase(),
        camelCase: String? = null
    )

    fun queryParameter(
        name: String,
        type: DeferredPrimitiveType<*>,
        description: String,
        key: String = Name.deriveFromTitleCase(name).toSnakeCase(),
        camelCase: String? = null,
        isOptional: Boolean = false
    )

    fun schema(schema: DeferredType>)

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

    fun map(
        keys: DeferredType,
        values: DeferredType>,
        description: String,
        nullableValues: Boolean = false
    ): DeferredType =
        DeferredSchemaType { typeRegistry, isTopLevel ->
            values.get(typeRegistry, interpretationHint = null, isTopLevel).mapData { IRMap(keys.getFlat(), 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

}

/** A builder for one or more V1 queries. */
@OptIn(LowLevelApiGenApi::class)
internal interface QueriesBuilderV1 : QueriesBuilder

/** A builder for one or more V2 queries. */
@OptIn(LowLevelApiGenApi::class)
internal interface QueriesBuilderV2 : QueriesBuilder {

    fun schema(vararg schemas: Pair>>)

}