///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2023, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

import { IViewer } from "./IViewer";

export interface ICommandService {
  executeCommand(id: string, ...args: any[]): any;
}

export type ICommandsMap = Map<string, ICommand>;

export interface ICommandHandler {
  (viewer: any, ...args: any[]): any;
}

export interface ICommand {
  id: string;
  handler: ICommandHandler;
  thisArg?: any;
  description?: ICommandDescription;
}

export interface ICommandDescription {
  readonly description: string;
}

export interface ICommands {
  registerCommand(id: string, handler: ICommandHandler, description?: ICommandDescription, thisArg?: any): void;
  registerCommandAlias(id: string, alias: string): void;
  getCommands(): ICommandsMap;
  getCommand(id: string): ICommand | undefined;
  executeCommand(id: string, viewer: IViewer, ...args: any[]): any;
}