silverbullet/packages/web/hooks/command.ts

import { Hook, Manifest } from "@plugos/plugos/types";
import { System } from "@plugos/plugos/system";
import { EventEmitter } from "@plugos/plugos/event";
import { ActionButton } from "../types";

export type CommandDef = {
  name: string;

  contexts?: string[];

  // Bind to keyboard shortcut
  key?: string;
  mac?: string;

  // Action button
  button?: ButtonDef;
};

export type ButtonDef = {
  label: string;
  tooltip?: string;
};

export type AppCommand = {
  command: CommandDef;
  run: () => Promise<void>;
};

export type CommandHookT = {
  command?: CommandDef;
};

export type CommandHookEvents = {
  commandsUpdated(
    commandMap: Map<string, AppCommand>,
    appButtons: ActionButton[]
  ): void;
};

export class CommandHook
  extends EventEmitter<CommandHookEvents>
  implements Hook<CommandHookT>
{
  editorCommands = new Map<string, AppCommand>();
  actionButtons: ActionButton[] = [];

  buildAllCommands(system: System<CommandHookT>) {
    this.editorCommands.clear();
    this.actionButtons = [];
    for (let plug of system.loadedPlugs.values()) {
      for (const [name, functionDef] of Object.entries(
        plug.manifest!.functions
      )) {
        if (!functionDef.command) {
          continue;
        }
        const cmd = functionDef.command;
        this.editorCommands.set(cmd.name, {
          command: cmd,
          run: () => {
            return plug.invoke(name, []);
          },
        });
        if (cmd.button) {
          this.actionButtons.push({
            label: cmd.button.label,
            tooltip: cmd.button.tooltip,
            run: () => {
              return plug.invoke(name, []);
            },
          });
        }
      }
    }
    this.emit("commandsUpdated", this.editorCommands, this.actionButtons);
  }

  apply(system: System<CommandHookT>): void {
    this.buildAllCommands(system);
    system.on({
      plugLoaded: () => {
        this.buildAllCommands(system);
      },
    });
  }

  validateManifest(manifest: Manifest<CommandHookT>): string[] {
    let errors = [];
    for (const [name, functionDef] of Object.entries(manifest.functions)) {
      if (!functionDef.command) {
        continue;
      }
      const cmd = functionDef.command;
      if (!cmd.name) {
        errors.push(`Function ${name} has a command but no name`);
      }
    }
    return [];
  }
}