flaschengeist-types/src/plugin.d.ts

import { RouteLocationRaw, RouteRecordRaw, RouteRecordName } from 'vue-router';
import { Component } from 'vue';

declare namespace FG_Plugin {
  /**
   * Interface defining a Flaschengeist plugin
   */
  interface Plugin {
    name: string;
    version: string;
    widgets: Widget[];
    /** Pther frontend modules needed for this plugin to work correctly */
    requiredModules: string[];
    /** Backend modules needed for this plugin to work correctly */
    requiredBackendModules: string[];
    /** Menu entries for authenticated users */
    innerRoutes?: MenuRoute[];
    /** Public menu entries (without authentification) */
    outerRoutes?: MenuRoute[];
    /** Routes without menu links, for internal usage */
    internalRoutes?: NamedRouteRecordRaw[];
    /** Handle notifications, defaults to boot/plugins.ts:translateNotification() */
    notification?(msg: FG.Notification): FG_Plugin.Notification;
  }

  /**
   * Defines the loaded state of the Flaschengeist
   */
  interface Flaschengeist {
    /** All loaded plugins */
    plugins: LoadedPlugin[];
    /** All routes, combined from all plugins */
    routes: RouteRecordRaw[];
    /** All menu entries */
    menuLinks: MenuLink[];
    /** All inner shortcuts */
    shortcuts: Shortcut[];
    /** All outer shortcuts */
    outerShortcuts: Shortcut[];
    /** All widgets */
    widgets: Widget[];
  }

  /**
   * Interface for a frontend notification
   */
  interface Notification extends FG.Notification {
    /** If set a button for accepting will be shown, this function will get called before deleting the notification */
    accept?(): Promise<void>;
    /** If set this function is called before the notification gets deleted */
    reject?(): Promise<void>;
    /** If set the notification text is interpreted as a link to this location */
    link?: RouteLocationRaw;
    /** If set this icon is used */
    icon?: string;
  }

  /**
   * Loaded Flaschengeist plugin
   */
  interface LoadedPlugin {
    name: string;
    version: string;
    notification(msg: FG.Notification): FG_Plugin.Notification;
  }

  /**
   * Defines a shortcut link
   */
  interface Shortcut {
    link: RouteRecordName;
    icon: string;
    permissions?: string[];
  }

  /**
   * Defines a main menu entry along with the route
   * Used when defining a plugin
   */
  interface MenuRoute extends MenuEntry {
    route: NamedRouteRecordRaw;
    shortcut?: boolean;
    children?: this[];
  }

  type NamedRouteRecordRaw = RouteRecordRaw & {
    name: RouteRecordName;
  };

  /**
   * Defines a menu entry in the main menu
   */
  interface MenuLink extends MenuEntry {
    /** Name of the target route */
    link: RouteRecordName;
  }

  /**
   * Base interface for internal use
   */
  interface MenuEntry {
    title: string | (() => string);
    icon: string;
    permissions?: string[];
    children?: this[];
  }

  /**
   * Widget object for the dashboard
   */
  interface Widget {
    name: string;
    priority: number;
    permissions: FG.Permission[];
    widget: Component;
  }
}