@beaver-notes/plugin-sdk

TypeScript types and runtime constants for Beaver Notes plugin development.

npm i -D @beaver-notes/plugin-sdk

Quick Start

import type { BeaverNotes } from '@beaver-notes/plugin-sdk';
import { PERMISSIONS, APP_EVENTS } from '@beaver-notes/plugin-sdk';

export function setup(beaverNotes: BeaverNotes) {
  beaverNotes.app?.commands.register({
    id: 'hello',
    title: 'Hello',
    icon: 'riStarLine',
    handler() {
      beaverNotes.ui.notify('Hello!');
    },
  });

  beaverNotes.app?.on(APP_EVENTS.NOTE_SAVED, (noteId) => {
    console.log('Saved:', noteId);
  });
}

Exports

Types

BeaverNotes | PluginManifest | Plane | Permission | AppPlane | EditorPlane | UIPlane | NotesAPI | FoldersAPI | LabelsAPI | SettingsAPI | CommandsAPI | NetworkAPI | PluginStorage | NoteSummary | Note | Folder | Label | SlashCommand | ToolbarItem | AppCommand | TiptapConstructors | TiptapExtension | DialogAPI | SettingField | StringSetting | BooleanSetting | NumberSetting | SelectSetting

Constants

PERMISSIONS | APP_EVENTS | SETTING_KEYS | BEAVER_MIN_VERSION | PACKAGE_NAME

License

MIT