@repogo/plugins 0.1.25 → 0.1.27

package/README.md

@@ -10,6 +10,7 @@ import { definePlugin, method, z } from "@repogo/plugins";
 
 export default definePlugin({
   description: "Notes for this project",
+  db: "myproject.notes",
   collections: { notes: z.object({ text: z.string() }) },
   methods: {
     search: method(z.object({ text: z.string() }), async ({ text }, ctx) =>
@@ -21,6 +22,12 @@ export default definePlugin({
 });
 ```
 
+`db` names the SQLite file the collections live in, `~/.repogo/plugin-data/<db>.db`
+on the environment; left out, it is the plugin's folder name. Name a project's own
+data `<project>.<name>`. A bare name (`todos`) is shared by every plugin that
+names it, in any project, so they must agree on their collections' schemas.
+Data stays in place when the project moves. A plugin without collections has no file.
+
 Add it to `.repogo/plugins/package.json` (`bun add @repogo/plugins`) for types
 and editor help. The RepoGo host runs plugins with its own copy of this
 package, the version it shipped with, so a plugin always matches the host.

package/dist/collections.d.ts

@@ -20,11 +20,12 @@ export declare class Collection<S extends z.ZodObject> {
     private schema;
     private table;
     readonly tag: string;
-    /** Writes run one at a time, so an update's read and write can't interleave with another's. */
+    /** This Worker's writes run one at a time; the transaction holds off other Workers. */
     private writes;
-    constructor(sql: SQL, events: EventBus, plugin: string, name: string, schema: S);
+    constructor(sql: SQL, events: EventBus, plugin: string, db: string, name: string, schema: S);
     setup(): Promise<void>;
     private serial;
+    private transaction;
     create(input: z.input<S>): Promise<Record_<z.infer<S>>>;
     get(id: string): Promise<Record_<z.infer<S>> | null>;
     update(id: string, patch: Partial<z.input<S>>): Promise<Record_<z.infer<S>>>;

package/dist/define.d.ts

@@ -24,6 +24,12 @@ export type Handler = (payload: any, ctx: Context) => unknown | Promise<unknown>
 export type PluginDefinition = {
     /** One line, shown to the agent in the index of plugins. */
     description?: string;
+    /**
+     * The data file the collections live in, `<db>.db` in the data dir; the
+     * plugin's folder name when left out. A project's own data is `<project>.<name>`
+     * (`repogo.plans`); a bare name (`todos`) is shared by every plugin that names it.
+     */
+    db?: string;
     collections?: Collections;
     methods?: Record<string, Method<any, any>>;
     on?: Record<string, Handler>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repogo/plugins",
-  "version": "0.1.25",
+  "version": "0.1.27",
   "description": "Write RepoGo plugins: collections and methods over SQLite that agents and cards call",
   "type": "module",
   "exports": {