commonMain.io.komune.im.f2.space.domain.command.SpaceDefineCommandDTO.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of im-space-domain-jvm Show documentation

Identity Management

There is a newer version: 0.20.0

package io.komune.im.f2.space.domain.command

import io.komune.im.commons.model.SpaceIdentifier
import f2.dsl.cqrs.Command
import f2.dsl.cqrs.Event
import f2.dsl.fnc.F2Function
import kotlin.js.JsExport
import kotlinx.serialization.Serializable

/**
 * Create or update a space.
 * @d2 function
 * @parent [io.komune.im.f2.space.domain.D2SpacePage]
 * @order 10
 */
typealias SpaceDefineFunction = F2Function

/**
 * @d2 command
 * @parent [SpaceDefineFunction]
 */
@JsExport
interface SpaceDefineCommandDTO: Command {
    /**
     * Identifier of the space to create.
     */
    val identifier: SpaceIdentifier

    /**
     * Name of the theme to use for the space.
     * @example "im"
     */
    val theme: String?

    /**
     * SMTP is a variable that represents the configuration of the Simple Mail Transfer Protocol (SMTP) settings as a map.
     *
     */
    val smtp: Map?

    /**
     * List of supported locales.
     * @example [["en", "fr"]]
     */
    val locales: List?
}

/**
 * @d2 inherit
 */
@Serializable
data class SpaceDefineCommand(
    override val identifier: String,
    override val theme: String?,
    override val smtp: Map?,
    override val locales: List?
): SpaceDefineCommandDTO

/**
 * @d2 event
 * @parent [SpaceDefineFunction]
 */
@JsExport
interface SpaceDefinedEventDTO: Event {
    /**
     * Identifier of the defined space.
     */
    val identifier: SpaceIdentifier
}

/**
 * @d2 inherit
 */
@Serializable
data class SpaceDefinedEvent(
    override val identifier: SpaceIdentifier,
): SpaceDefinedEventDTO