/*
 * Copyright © 2024 Hexastack. All rights reserved.
 *
 * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
 * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
 * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
 */

import { EntityType, Format } from "@/services/types";

import { IBaseSchema, IFormat, OmitPopulate } from "./base.types";

export enum MenuType {
  web_url = "web_url",
  postback = "postback",
  nested = "nested",
}

export interface IMenuItemAttributes {
  type: MenuType;
  url?: string;
  title: string;
  payload?: string;
  parent?: string;
}

export interface IMenuItemStub
  extends IBaseSchema,
    OmitPopulate<IMenuItemAttributes, EntityType.MENU> {}

export interface IMenuItem extends IMenuItemStub, IFormat<Format.BASIC> {
  parent?: string;
}

export interface IMenuItemFull extends IMenuItemStub, IFormat<Format.FULL> {
  parent?: IMenuItem[];
}
