@kieler/klighd-core/src/options/actions.ts

Core KLighD diagram visualization with Sprotty

/*
 * KIELER - Kiel Integrated Environment for Layout Eclipse RichClient
 *
 * http://rtsys.informatik.uni-kiel.de/kieler
 *
 * Copyright 2021 by
 * + Kiel University
 *   + Department of Computer Science
 *     + Real-Time and Embedded Systems Group
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0
 */
// We follow Sprotty's way of redeclaring the interface and its create function, so disable this lint check for this file.
/* eslint-disable no-redeclare */

import { Action } from 'sprotty-protocol'
import {
    DisplayedActionData,
    LayoutOptionUIData,
    LayoutOptionValue,
    PreferenceValue,
    SynthesisOption,
    ValuedSynthesisOption,
} from './option-models'

/** Request message from the server to update the diagram options widget on the client. */
export interface UpdateOptionsAction extends Action {
    kind: typeof UpdateOptionsAction.KIND
    valuedSynthesisOptions: ValuedSynthesisOption[]
    layoutOptions: LayoutOptionUIData[]
    actions: DisplayedActionData[]
    modelUri: string
}

export namespace UpdateOptionsAction {
    export const KIND = 'updateOptions'

    export function create(
        valuedSynthesisOptions: ValuedSynthesisOption[],
        layoutOptions: LayoutOptionUIData[],
        actions: DisplayedActionData[],
        modelUri: string
    ): UpdateOptionsAction {
        return {
            kind: KIND,
            valuedSynthesisOptions,
            layoutOptions,
            actions,
            modelUri,
        }
    }

    export function isThisAction(action: Action): action is UpdateOptionsAction {
        return action.kind === UpdateOptionsAction.KIND
    }
}

/**
 * Triggers a action from the options that should be performed.
 * Do not confuse this with PerformActionAction!
 */
export interface PerformOptionsActionAction extends Action {
    kind: typeof PerformOptionsActionAction.KIND
    actionId: string
}

export namespace PerformOptionsActionAction {
    export const KIND = 'performOptionsAction'

    export function create(actionId: string): PerformOptionsActionAction {
        return {
            kind: KIND,
            actionId,
        }
    }

    export function isThisAction(action: Action): action is PerformOptionsActionAction {
        return action.kind === PerformOptionsActionAction.KIND
    }
}

/** Change the user preferences stored in the `klighd-core` container. */
export interface SetPreferencesAction extends Action {
    kind: typeof SetPreferencesAction.KIND
    options: PreferenceValue[]
}

export namespace SetPreferencesAction {
    export const KIND = 'setPreferences'

    export function create(options: PreferenceValue[]): SetPreferencesAction {
        return {
            kind: KIND,
            options,
        }
    }

    export function isThisAction(action: Action): action is SetPreferencesAction {
        return action.kind === SetPreferencesAction.KIND
    }
}

/** Resets all render options to default. */
export interface ResetPreferencesAction extends Action {
    kind: typeof ResetPreferencesAction.KIND
}

export namespace ResetPreferencesAction {
    export const KIND = 'resetPreferences'

    export function create(): ResetPreferencesAction {
        return {
            kind: KIND,
        }
    }

    export function isThisAction(action: Action): action is ResetPreferencesAction {
        return action.kind === ResetPreferencesAction.KIND
    }
}

/** Change the value of one or multiple synthesis options. */
export interface SetSynthesisOptionsAction extends Action {
    kind: typeof SetSynthesisOptionsAction.KIND
    options: SynthesisOption[]
    /** Boolean indicating whether the options should be sent to the server. */
    sendToServer: boolean
}

export namespace SetSynthesisOptionsAction {
    export const KIND = 'setSynthesisOptions'

    export function create(options: SynthesisOption[], sendToServer = true): SetSynthesisOptionsAction {
        return {
            kind: KIND,
            sendToServer,
            options,
        }
    }

    export function isThisAction(action: Action): action is SetSynthesisOptionsAction {
        return action.kind === SetSynthesisOptionsAction.KIND
    }
}

/** Resets all synthesis options to default for both server and client. */
export interface ResetSynthesisOptionsAction extends Action {
    kind: typeof ResetSynthesisOptionsAction.KIND
    /** Boolean indicating whether the options should be sent to the server. */
    sendToServer: boolean
}

export namespace ResetSynthesisOptionsAction {
    export const KIND = 'resetSynthesisOptions'

    export function create(sendToServer = true): ResetSynthesisOptionsAction {
        return {
            kind: KIND,
            sendToServer,
        }
    }

    export function isThisAction(action: Action): action is ResetSynthesisOptionsAction {
        return action.kind === ResetSynthesisOptionsAction.KIND
    }
}

/** Change the value of one or multiple layout options. */
export interface SetLayoutOptionsAction extends Action {
    kind: typeof SetLayoutOptionsAction.KIND
    options: LayoutOptionValue[]
    /** Boolean indicating whether the options should be sent to the server. */
    sendToServer: boolean
}

export namespace SetLayoutOptionsAction {
    export const KIND = 'setLayoutOptions'

    export function create(options: LayoutOptionValue[], sendToServer = true): SetLayoutOptionsAction {
        return {
            kind: KIND,
            sendToServer,
            options,
        }
    }

    export function isThisAction(action: Action): action is SetLayoutOptionsAction {
        return action.kind === SetLayoutOptionsAction.KIND
    }
}

/** Resets all layout options to default for both server and client. */
export interface ResetLayoutOptionsAction extends Action {
    kind: typeof ResetLayoutOptionsAction.KIND
    /** Boolean indicating whether the options should be sent to the server. */
    sendToServer: boolean
}

export namespace ResetLayoutOptionsAction {
    export const KIND = 'resetLayoutOptions'

    export function create(sendToServer = true): ResetLayoutOptionsAction {
        return {
            kind: KIND,
            sendToServer,
        }
    }

    export function isThisAction(action: Action): action is ResetLayoutOptionsAction {
        return action.kind === ResetLayoutOptionsAction.KIND
    }
}

/** Change the value of one or multiple render options. */
export interface SetRenderOptionAction extends Action {
    kind: typeof SetRenderOptionAction.KIND
    id: string
    value: unknown
}

export namespace SetRenderOptionAction {
    export const KIND = 'setRenderOption'

    export function create(id: string, value: unknown): SetRenderOptionAction {
        return {
            kind: KIND,
            id,
            value,
        }
    }

    export function isThisAction(action: Action): action is SetRenderOptionAction {
        return action.kind === SetRenderOptionAction.KIND
    }
}

/** Resets all render options to default. */
export interface ResetRenderOptionsAction extends Action {
    kind: typeof ResetRenderOptionsAction.KIND
}

export namespace ResetRenderOptionsAction {
    export const KIND = 'resetRenderOptions'

    export function create(): ResetRenderOptionsAction {
        return {
            kind: KIND,
        }
    }

    export function isThisAction(action: Action): action is ResetRenderOptionsAction {
        return action.kind === ResetRenderOptionsAction.KIND
    }
}