/*
 * Copyright (C)  2021-2022 Kristóf Marussy <kristof@marussy.com>
 *
 * This file is part of Sophie.
 *
 * Sophie is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import type { Action } from '@sophie/shared';
import { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';

export default interface RendererEnv {
  dispatchMainAction(action: Action): void;
}

/**
 * Gets a well-typed environment from `model`.
 *
 * Only useable inside state trees created by `createAndConnectRootStore`.
 *
 * @param model The state tree node.
 */
export function getEnv(model: IAnyStateTreeNode): RendererEnv {
  return getAnyEnv<RendererEnv>(model);
}