super-productivity/packages/plugin-dev/boilerplate-solid-js/src/plugin.ts

import { PluginInterface, Task, Project } from '@super-productivity/plugin-api';

declare const plugin: PluginAPI;

// Plugin initialization
plugin.log('Solid.js Boilerplate Plugin loaded');

// Example: Register a header button
plugin.registerHeaderButton({
  icon: 'rocket',
  tooltip: 'Open Boilerplate Plugin',
  action: () => {
    plugin.showIndexHtmlAsView();
  },
});

// Example: Register a menu entry
plugin.registerMenuEntry({
  label: 'Boilerplate Plugin',
  icon: 'rocket',
  onClick: () => {
    plugin.showIndexHtmlAsView();
  },
});

// Example: Register keyboard shortcut
plugin.registerShortcut({
  keys: 'ctrl+shift+b',
  label: 'Open Boilerplate Plugin',
  action: () => {
    plugin.showIndexHtmlAsView();
  },
});

// Example: Hook into task completion
plugin.on('taskComplete', async (task: Task) => {
  plugin.log('Task completed:', task.title);

  // Example: Show notification
  plugin.showSnack({
    msg: `Great job! You completed: ${task.title}`,
    type: 'SUCCESS',
  });
});

// Example: Hook into task updates
plugin.on('taskUpdate', async (task: Task) => {
  plugin.log('Task updated:', task.title);
});

// Example: Hook into context changes
plugin.on('contextChange', async (context: { projectId?: string; tagId?: string }) => {
  plugin.log('Context changed:', context);

  if (context.projectId) {
    const projects = await plugin.getAllProjects();
    const currentProject = projects.find((p) => p.id === context.projectId);
    if (currentProject) {
      plugin.log('Switched to project:', currentProject.title);
    }
  }
});

// Example: Custom command handler
plugin.onMessage('getStats', async () => {
  const tasks = await plugin.getTasks();
  const completedToday = tasks.filter(
    (t) => t.isDone && new Date(t.doneOn!).toDateString() === new Date().toDateString(),
  );

  return {
    totalTasks: tasks.length,
    completedToday: completedToday.length,
    pendingTasks: tasks.filter((t) => !t.isDone).length,
  };
});

// Example: Handle custom actions from iframe
plugin.onMessage('createTask', async (data: { title: string; projectId?: string }) => {
  const newTask = await plugin.addTask({
    title: data.title,
    projectId: data.projectId,
  });

  plugin.showSnack({
    msg: `Task "${newTask.title}" created!`,
    type: 'SUCCESS',
  });

  return newTask;
});

// Forward API calls from iframe to plugin API
plugin.onMessage('getTasks', async () => {
  return await plugin.getTasks();
});

plugin.onMessage('getAllProjects', async () => {
  return await plugin.getAllProjects();
});

// Example: Persist plugin data
plugin.onMessage('saveSettings', async (settings: any) => {
  await plugin.persistDataSynced('settings', settings);
  return { success: true };
});

// Example: Load plugin data
plugin.onMessage('loadSettings', async () => {
  const settings = await plugin.loadSyncedData('settings');
  return settings || {};
});

// Plugin cleanup (if needed)
plugin.onDestroy(() => {
  plugin.log('Boilerplate plugin is being destroyed');
});