plugin system
This commit is contained in:
nicwands
@@ -1,40 +1,84 @@
|
||||
"use strict";
|
||||
const utils = require("@electron-toolkit/utils");
|
||||
const electron = require("electron");
|
||||
const fs = require("fs/promises");
|
||||
const path = require("path");
|
||||
const fs = require("fs/promises");
|
||||
const matter = require("gray-matter");
|
||||
const flexsearch = require("flexsearch");
|
||||
const crypto = require("crypto");
|
||||
class NotesAPI {
|
||||
class PluginRegistry {
|
||||
constructor() {
|
||||
this.notesDir = path.join(electron.app.getPath("userData"), "notes");
|
||||
this.notesCache = /* @__PURE__ */ new Map();
|
||||
this.index = new flexsearch.Index({
|
||||
tokenize: "tolerant",
|
||||
resolution: 9
|
||||
});
|
||||
this.plugins = /* @__PURE__ */ new Map();
|
||||
}
|
||||
register(plugin) {
|
||||
if (!plugin.id) {
|
||||
throw new Error("Plugin must have an id");
|
||||
}
|
||||
this.plugins.set(plugin.id, plugin);
|
||||
}
|
||||
get(id) {
|
||||
return this.plugins.get(id);
|
||||
}
|
||||
list() {
|
||||
return Array.from(this.plugins.values());
|
||||
}
|
||||
}
|
||||
class BaseNotesAdapter {
|
||||
constructor(config = {}) {
|
||||
this.config = config;
|
||||
}
|
||||
async init() {
|
||||
throw new Error("init() not implemented");
|
||||
}
|
||||
async getAll() {
|
||||
throw new Error("getAll() not implemented");
|
||||
}
|
||||
async create(note) {
|
||||
throw new Error("create() not implemented");
|
||||
}
|
||||
async update(note) {
|
||||
throw new Error("update() not implemented");
|
||||
}
|
||||
async delete(id) {
|
||||
throw new Error("delete() not implemented");
|
||||
}
|
||||
}
|
||||
class FileSystemNotesAdapter extends BaseNotesAdapter {
|
||||
constructor(config) {
|
||||
super();
|
||||
for (const field in config) {
|
||||
this[field] = config[field];
|
||||
}
|
||||
}
|
||||
async init() {
|
||||
await fs.mkdir(this.notesDir, { recursive: true });
|
||||
await this._loadAllNotes();
|
||||
}
|
||||
async _loadAllNotes() {
|
||||
async getAll() {
|
||||
const files = await fs.readdir(this.notesDir);
|
||||
const notes = [];
|
||||
for (const file of files) {
|
||||
if (!file.endsWith(".md")) continue;
|
||||
const fullPath = path.join(this.notesDir, file);
|
||||
const raw = await fs.readFile(fullPath, "utf8");
|
||||
const parsed = matter(raw);
|
||||
const note = {
|
||||
notes.push({
|
||||
...parsed.data,
|
||||
content: parsed.content
|
||||
};
|
||||
this.notesCache.set(note.id, note);
|
||||
this.index.add(note.id, note.title + note.content);
|
||||
});
|
||||
}
|
||||
return notes;
|
||||
}
|
||||
async _writeNoteFile(note) {
|
||||
async create(note) {
|
||||
await this._write(note);
|
||||
}
|
||||
async update(note) {
|
||||
await this._write(note);
|
||||
}
|
||||
async delete(id) {
|
||||
const filePath = path.join(this.notesDir, `${id}.md`);
|
||||
await fs.unlink(filePath);
|
||||
}
|
||||
async _write(note) {
|
||||
const filePath = path.join(this.notesDir, `${note.id}.md`);
|
||||
const fileContent = matter.stringify(note.content, {
|
||||
id: note.id,
|
||||
@@ -45,9 +89,84 @@ class NotesAPI {
|
||||
});
|
||||
await fs.writeFile(filePath, fileContent, "utf8");
|
||||
}
|
||||
}
|
||||
const filesystemPlugin = {
|
||||
id: "filesystem",
|
||||
name: "Local Filesystem",
|
||||
description: "Stores notes as markdown files locally.",
|
||||
version: "1.0.0",
|
||||
configSchema: [
|
||||
{
|
||||
key: "notesDir",
|
||||
label: "Notes Directory",
|
||||
type: "directory",
|
||||
default: path.join(electron.app.getPath("userData"), "notes"),
|
||||
required: true
|
||||
}
|
||||
],
|
||||
createAdapter(config) {
|
||||
return new FileSystemNotesAdapter(config);
|
||||
}
|
||||
};
|
||||
class PluginConfig {
|
||||
constructor(defaultPlugin) {
|
||||
this.defaultPlugin = defaultPlugin;
|
||||
this.configPath = path.join(electron.app.getPath("userData"), "config.json");
|
||||
}
|
||||
async load() {
|
||||
let parsed;
|
||||
try {
|
||||
const raw = await fs.readFile(this.configPath, "utf8");
|
||||
parsed = JSON.parse(raw);
|
||||
} catch (err) {
|
||||
parsed = null;
|
||||
}
|
||||
if (!parsed || !parsed.activeAdapter) {
|
||||
const defaultConfig = {};
|
||||
for (const field of this.defaultPlugin.configSchema) {
|
||||
defaultConfig[field.key] = field.default ?? null;
|
||||
}
|
||||
parsed = {
|
||||
activeAdapter: this.defaultPlugin.id,
|
||||
adapterConfig: defaultConfig
|
||||
};
|
||||
await this.write(parsed);
|
||||
}
|
||||
return parsed;
|
||||
}
|
||||
async write(configObject) {
|
||||
const dir = path.dirname(this.configPath);
|
||||
await fs.mkdir(dir, { recursive: true });
|
||||
await fs.writeFile(
|
||||
this.configPath,
|
||||
JSON.stringify(configObject, null, 2),
|
||||
"utf8"
|
||||
);
|
||||
}
|
||||
}
|
||||
class NotesAPI {
|
||||
constructor(adapter) {
|
||||
if (!adapter) {
|
||||
throw new Error("NotesAPI requires a storage adapter");
|
||||
}
|
||||
this.adapter = adapter;
|
||||
this.notesCache = /* @__PURE__ */ new Map();
|
||||
this.index = new flexsearch.Index({
|
||||
tokenize: "tolerant",
|
||||
resolution: 9
|
||||
});
|
||||
}
|
||||
async init() {
|
||||
await this.adapter.init();
|
||||
const notes = await this.adapter.getAll();
|
||||
for (const note of notes) {
|
||||
this.notesCache.set(note.id, note);
|
||||
this.index.add(note.id, note.title + "\n" + note.content);
|
||||
}
|
||||
}
|
||||
/* -----------------------
|
||||
Public API
|
||||
------------------------*/
|
||||
Public API
|
||||
------------------------*/
|
||||
getCategories() {
|
||||
const categories = /* @__PURE__ */ new Set();
|
||||
for (const note of this.notesCache.values()) {
|
||||
@@ -74,15 +193,13 @@ class NotesAPI {
|
||||
updatedAt: now,
|
||||
content
|
||||
};
|
||||
console.log(note);
|
||||
this.notesCache.set(id, note);
|
||||
this.index.add(id, note.title + "\n" + content);
|
||||
await this._writeNoteFile(note);
|
||||
await this.adapter.create(note);
|
||||
return note;
|
||||
}
|
||||
async deleteNote(id) {
|
||||
const filePath = path.join(this.notesDir, `${id}.md`);
|
||||
await fs.unlink(filePath);
|
||||
await this.adapter.delete(id);
|
||||
this.notesCache.delete(id);
|
||||
this.index.remove(id);
|
||||
}
|
||||
@@ -92,7 +209,7 @@ class NotesAPI {
|
||||
note.content = content;
|
||||
note.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
|
||||
this.index.update(id, note.title + "\n" + content);
|
||||
await this._writeNoteFile(note);
|
||||
await this.adapter.update(note);
|
||||
return note;
|
||||
}
|
||||
async updateNoteMetadata(id, updates = {}) {
|
||||
@@ -112,7 +229,7 @@ class NotesAPI {
|
||||
}
|
||||
note.updatedAt = (/* @__PURE__ */ new Date()).toISOString();
|
||||
this.index.update(id, note.title + "\n" + note.content);
|
||||
await this._writeNoteFile(note);
|
||||
await this.adapter.update(note);
|
||||
return note;
|
||||
}
|
||||
search(query) {
|
||||
@@ -167,7 +284,7 @@ function createNoteWindow(noteId) {
|
||||
});
|
||||
}
|
||||
}
|
||||
electron.app.whenReady().then(() => {
|
||||
electron.app.whenReady().then(async () => {
|
||||
utils.electronApp.setAppUserModelId("com.electron");
|
||||
electron.app.on("browser-window-created", (_, window) => {
|
||||
utils.optimizer.watchWindowShortcuts(window);
|
||||
@@ -179,8 +296,13 @@ electron.app.whenReady().then(() => {
|
||||
electron.ipcMain.on("open-note-window", (_, noteId) => {
|
||||
createNoteWindow(noteId);
|
||||
});
|
||||
const notesAPI = new NotesAPI();
|
||||
notesAPI.init();
|
||||
const registry = new PluginRegistry();
|
||||
registry.register(filesystemPlugin);
|
||||
const config = await new PluginConfig(filesystemPlugin).load();
|
||||
const plugin = registry.get(config.activeAdapter);
|
||||
const adapter = plugin.createAdapter(config.adapterConfig);
|
||||
const notesAPI = new NotesAPI(adapter);
|
||||
await notesAPI.init();
|
||||
electron.ipcMain.handle("notesAPI:call", (_, method, args) => {
|
||||
if (!notesAPI[method]) {
|
||||
throw new Error("Invalid method");
|
||||
|
||||
Reference in New Issue
Block a user