/********************************************************************************
 * Copyright (c) 2021-2026 STMicroelectronics and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/
import { RequestAction, ResponseAction } from './base-protocol';
import { Args, EditorContext, LabeledAction } from './types';
/**
 * The `RequestContextActions` is sent from the client to the server to request the available actions for the context with id contextId.
 * The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
 * and creating new `RequestContextActions`.
 */
export interface RequestContextActions extends RequestAction<SetContextActions> {
    kind: typeof RequestContextActions.KIND;
    /**
     * The identifier for the context.
     */
    contextId: string;
    editorContext: EditorContext;
}
export declare namespace RequestContextActions {
    const KIND = "requestContextActions";
    function is(object: unknown): object is RequestContextActions;
    function create(options: {
        contextId: string;
        editorContext: EditorContext;
        requestId?: string;
    }): RequestContextActions;
}
/**
 * The `SetContextActions` is the response to a {@link RequestContextActions} containing all actions for the queried context.
 * The corresponding namespace declares the action kind as constant and offers helper functions for type guard checks
 * and creating new `SetContextsActions`.
 */
export interface SetContextActions extends ResponseAction {
    kind: typeof SetContextActions.KIND;
    /**
     * The actions available in the queried context.
     */
    readonly actions: LabeledAction[];
    /**
     * Custom arguments.
     */
    args?: Args;
}
export declare namespace SetContextActions {
    const KIND = "setContextActions";
    function is(object: unknown): object is SetContextActions;
    function create(actions: LabeledAction[], options?: {
        args?: Args;
        responseId?: string;
    }): SetContextActions;
}
/**
 * Sent from the server to the client to request the current {@link EditorContext}. This is the server-initiated
 * counterpart to the `editorContext` parameter that is included in many client-to-server requests.
 *
 * All fields in the response represent a snapshot of the client state at the time the response is generated.
 * There is no guarantee that the state has not changed by the time the server processes the response.
 *
 * If you only need a subset of the editor context, consider using a more specific action instead:
 * - For selected elements only, use `GetSelectionAction`.
 * - For viewport and canvas bounds only, use `GetViewportAction`.
 */
export interface GetEditorContextAction extends RequestAction<EditorContextResult> {
    kind: typeof GetEditorContextAction.KIND;
}
export declare namespace GetEditorContextAction {
    const KIND = "getEditorContext";
    function is(object: unknown): object is GetEditorContextAction;
    function create(options?: {
        requestId?: string;
        timeout?: number;
    }): GetEditorContextAction;
}
/**
 * Response to a {@link GetEditorContextAction} containing a snapshot of the client-side editor state.
 *
 * All fields in the {@link EditorContext} reflect the state at the time of response generation.
 * The server should not assume that these values are still current when processing the response,
 * as the client state may have changed in the meantime.
 */
export interface EditorContextResult extends ResponseAction {
    kind: typeof EditorContextResult.KIND;
    /**
     * The editor context snapshot.
     */
    readonly editorContext: EditorContext;
}
export declare namespace EditorContextResult {
    const KIND = "editorContextResult";
    function is(object: unknown): object is EditorContextResult;
    function create(editorContext: EditorContext, options?: {
        responseId?: string;
    }): EditorContextResult;
}
//# sourceMappingURL=contexts.d.ts.map