engine.user.UserTimelineDAO.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017/2021 e-voyageurs technologies
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ai.tock.bot.engine.user

import ai.tock.bot.definition.BotDefinition
import ai.tock.bot.definition.StoryDefinition
import ai.tock.bot.engine.action.Action
import ai.tock.bot.engine.dialog.ArchivedEntityValue
import ai.tock.bot.engine.dialog.Dialog
import ai.tock.bot.engine.dialog.EntityStateValue
import ai.tock.bot.engine.dialog.Snapshot
import org.litote.kmongo.Id
import java.time.Instant

/**
 * To access [UserTimeline]s.
 */
interface UserTimelineDAO {

    /**
     * Saves the timeline.
     *
     * @param userTimeline the timeline to save
     * @param botDefinition the bot definition (in order to add stats about the bot)
     * @param asynchronousProcess boolean to disable/enable asynchronous saving
     */
    fun save(userTimeline: UserTimeline, botDefinition: BotDefinition, asynchronousProcess: Boolean = true)

    /**
     * Saves the timeline.
     *
     * @param userTimeline the timeline to save
     * @param namespace the namespace of the current bot
     */
    fun save(userTimeline: UserTimeline, namespace: String)

    /**
     * Update playerId for dialog and user timelines.
     */
    fun updatePlayerId(namespace: String, oldPlayerId: PlayerId, newPlayerId: PlayerId)

    /**
     * Loads with last dialog. If no timeline exists, creates a new one.
     *
     * @param namespace the namespace of the bot
     * @param userId the user id of the last message
     * @param priorUserId not null if this user has an other id before
     * @param groupId not null if this is a conversation group
     * @param storyDefinitionProvider provides [StoryDefinition] from story ids.
     */
    fun loadWithLastValidDialog(
        namespace: String,
        userId: PlayerId,
        priorUserId: PlayerId? = null,
        groupId: String? = null,
        storyDefinitionProvider: (String) -> StoryDefinition
    ): UserTimeline

    /**
     * Loads without the dialogs. If no timeline, create a new one.
     */
    fun loadWithoutDialogs(namespace: String, userId: PlayerId): UserTimeline

    /**
     * Loads without the dialogs.
     */
    fun loadByTemporaryIdsWithoutDialogs(namespace: String, temporaryIds: List): List

    /**
     * Remove the timeline and the associated dialogs.
     */
    fun remove(namespace: String, playerId: PlayerId)

    /**
     * Remove all timelines and associated dialogs of a client.
     */
    fun removeClient(namespace: String, clientId: String)

    /**
     * Returns the dialogs of specified client id.
     */
    fun getClientDialogs(
        namespace: String,
        clientId: String,
        storyDefinitionProvider: (String) -> StoryDefinition
    ): List

    /**
     * Returns all dialogs updated after the specified Instant.
     */
    fun getDialogsUpdatedFrom(
        namespace: String,
        from: Instant,
        storyDefinitionProvider: (String) -> StoryDefinition
    ): List

    /**
     * Gets the snapshots of a dialog.
     */
    fun getSnapshots(dialogId: Id): List

    /**
     * Returns the last story id of the specified user, if any.
     */
    fun getLastStoryId(namespace: String, playerId: PlayerId): String?

    /**
     * Returns the archived values for the state id.
     *
     * @param stateValueId the state id
     * @param oldActionsMap the option action map in order to retrieve the action of archived entity values.
     */
    fun getArchivedEntityValues(
        stateValueId: Id,
        oldActionsMap: Map, Action> = emptyMap()
    ): List
}