@mushinjs/plugin-database 0.0.0-stage → 0.2.0-next.20261113103537

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Setobox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { Context, z } from "@mushinjs/core";
+import { Database, Driver, Field, Model, Query, Selection, Tables, Types } from "minato";
+export declare const name = "database";
+export declare const inject: string[];
+export declare const Config: z.ZodObject<{
+  driver: z.ZodDefault<z.ZodEnum<{
+    sqlite: "sqlite";
+    memory: "memory";
+  }>>;
+  path: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+export type Config = z.infer<typeof Config>;
+export interface ColumnInfo {
+  name: string;
+  type: string;
+  primary: boolean;
+  nullable: boolean;
+}
+export interface TableInfo {
+  name: string;
+  /** The part of the name before the first underscore, which by convention names the plugin. */
+  group: string;
+  primary: string[];
+  columns: ColumnInfo[];
+  count: number;
+}
+export declare function toCsv(columns: string[], rows: Record<string, unknown>[]): string;
+/**
+ * The database service (`ctx.database`, from minato) and the actions behind the Database page.
+ * Plugins declare tables with `ctx.model.extend()` in a context that injects both `model` and
+ * `database`; by convention a table's name starts with the plugin's name and an underscore.
+ */
+export declare function apply(ctx: Context, config: Config): void;
+export type { Database, Driver, Field, Model, Query, Selection, Tables, Types };

package/dist/index.js

@@ -0,0 +1,269 @@
+import { mkdir, stat } from "node:fs/promises";
+import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
+import { pathToFileURL } from "node:url";
+import { MushinError, field, z } from "@mushinjs/core";
+import MemoryDriver from "@minatojs/driver-memory";
+import SQLiteDriver from "@minatojs/driver-sqlite";
+import { $, Database } from "minato";
+// src/index.ts
+const name = "database";
+const inject = ["actions"];
+const Config = z.object({
+	driver: z.enum(["sqlite", "memory"]).default("sqlite").meta(field("Driver", "sqlite keeps everything in one file; memory loses the data when Mushin.js stops (for trying things out)", { "zh-CN": {
+		title: "驱动",
+		description: "sqlite 把数据存在一个文件里；memory 在 Mushin.js 停止时丢失数据（用于试用）"
+	} })),
+	path: z.string().trim().min(1).default("data/mushin.db").meta(field("Database file", "For SQLite; relative to the instance directory", { "zh-CN": {
+		title: "数据库文件",
+		description: "SQLite 使用；相对于实例目录"
+	} }))
+});
+var SQLite = class extends SQLiteDriver {
+	static inject = ["model"];
+};
+var Memory = class extends MemoryDriver {
+	static inject = ["model"];
+};
+const PAGE_LIMIT = 500;
+const EXPORT_LIMIT = 1e5;
+/** Rows as JSON can carry them: dates as ISO text, binary as a note, big integers as text. */
+function plain(value) {
+	if (value instanceof Date) return value.toISOString();
+	if (typeof value === "bigint") return value.toString();
+	if (value instanceof ArrayBuffer || ArrayBuffer.isView(value)) return `<binary ${value.byteLength} bytes>`;
+	if (Array.isArray(value)) return value.map(plain);
+	if (value && typeof value === "object") return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, plain(item)]));
+	return value;
+}
+function csvCell(value) {
+	if (value === void 0 || value === null) return "";
+	const text = typeof value === "object" ? JSON.stringify(value) : String(value);
+	return /[",\r\n]/.test(text) ? `"${text.replace(/"/g, "\"\"")}"` : text;
+}
+function toCsv(columns, rows) {
+	return [columns.map(csvCell).join(","), ...rows.map((row) => columns.map((column) => csvCell(row[column])).join(","))].join("\r\n") + "\r\n";
+}
+const numeric = /* @__PURE__ */ new Set([
+	"integer",
+	"unsigned",
+	"float",
+	"double",
+	"decimal",
+	"bigint"
+]);
+const textual = /* @__PURE__ */ new Set([
+	"char",
+	"string",
+	"text"
+]);
+const escapeRegExp = (text) => text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+const Filter = z.record(z.string(), z.string()).optional().describe("Column → text. Text columns match when they contain the text; numbers and booleans must be equal.");
+/**
+* The database service (`ctx.database`, from minato) and the actions behind the Database page.
+* Plugins declare tables with `ctx.model.extend()` in a context that injects both `model` and
+* `database`; by convention a table's name starts with the plugin's name and an underscore.
+*/
+function apply(ctx, config) {
+	const baseDir = ctx.baseDir ?? process.cwd();
+	const file = config.driver === "sqlite" ? isAbsolute(config.path) ? config.path : resolve(baseDir, config.path) : void 0;
+	ctx.plugin(Database);
+	if (file) ctx.inject(["model"], async (ctx) => {
+		await mkdir(dirname(file), { recursive: true });
+		ctx.plugin(SQLite, { path: pathToFileURL(file).href });
+	});
+	else ctx.plugin(Memory, {});
+	ctx.inject(["model", "database"], (ctx) => {
+		const tableOf = (name) => {
+			const model = ctx.model.tables[name];
+			if (!model) throw new MushinError("not_found", `No table named "${name}"`);
+			return model;
+		};
+		const primaryOf = (model) => Array.isArray(model.primary) ? model.primary : [model.primary];
+		const columnsOf = (model) => {
+			const primary = primaryOf(model);
+			return Object.entries(model.fields).filter(([, item]) => item && !item.deprecated && !item.relation && !item.expr).map(([name, item]) => ({
+				name,
+				type: String(item.deftype ?? item.type?.type ?? ""),
+				primary: primary.includes(name),
+				nullable: !!item.nullable
+			}));
+		};
+		const queryOf = (model, filter) => {
+			const query = {};
+			const columns = new Map(columnsOf(model).map((column) => [column.name, column]));
+			for (const [name, text] of Object.entries(filter ?? {})) {
+				if (text === "") continue;
+				const column = columns.get(name);
+				if (!column) throw new MushinError("invalid_input", `Table "${model.name}" has no column "${name}"`);
+				if (numeric.has(column.type)) {
+					const value = Number(text);
+					if (!Number.isFinite(value)) throw new MushinError("invalid_input", `"${text}" is not a number`);
+					query[name] = value;
+				} else if (column.type === "boolean") query[name] = text === "true" || text === "1";
+				else if (textual.has(column.type)) query[name] = { $regex: new RegExp(escapeRegExp(text), "i") };
+				else throw new MushinError("invalid_input", `Column "${name}" (${column.type}) cannot be filtered`);
+			}
+			return query;
+		};
+		const keyQuery = (model, key) => {
+			const query = {};
+			for (const name of primaryOf(model)) {
+				if (!(name in key)) throw new MushinError("invalid_input", `The key needs "${name}"`);
+				query[name] = key[name];
+			}
+			return query;
+		};
+		const status = async () => {
+			const size = file ? (await stat(file).catch(() => void 0))?.size ?? 0 : void 0;
+			return {
+				driver: config.driver,
+				...file ? {
+					path: relative(baseDir, file).split(sep).join("/"),
+					size
+				} : {},
+				tables: Object.keys(ctx.model.tables).length
+			};
+		};
+		const countRows = async (table, model, query) => {
+			const key = primaryOf(model)[0] ?? columnsOf(model)[0]?.name;
+			return Number(await ctx.database.select(table, query).execute((row) => $.count(row[key]))) || 0;
+		};
+		const tables = async () => {
+			const list = [];
+			for (const [name, model] of Object.entries(ctx.model.tables)) {
+				const count = await countRows(name, model, {});
+				list.push({
+					name,
+					group: name.split("_")[0],
+					primary: primaryOf(model),
+					columns: columnsOf(model),
+					count: Number(count) || 0
+				});
+			}
+			return list.sort((a, b) => a.name.localeCompare(b.name));
+		};
+		ctx.actions.define({
+			name: "database.status",
+			description: "Which database driver runs, the SQLite file and its size, and how many tables exist.",
+			risk: "read",
+			input: z.object({}),
+			handler: status
+		});
+		ctx.actions.define({
+			name: "database.tables",
+			description: "Every table in the database with its columns, primary key and row count. Tables are grouped by the plugin name before the first underscore, e.g. flows_var.",
+			risk: "read",
+			input: z.object({}),
+			handler: tables
+		});
+		ctx.actions.define({
+			name: "database.rows",
+			description: "A page of rows from one table, read-only: optional sort and filters. Returns the rows and the total that match.",
+			risk: "read",
+			input: z.object({
+				table: z.string(),
+				offset: z.number().int().min(0).default(0),
+				limit: z.number().int().min(1).max(PAGE_LIMIT).default(50),
+				sort: z.object({
+					column: z.string(),
+					order: z.enum(["asc", "desc"]).default("asc")
+				}).optional(),
+				filter: Filter
+			}),
+			handler: async ({ table, offset, limit, sort, filter }) => {
+				const model = tableOf(table);
+				const query = queryOf(model, filter);
+				let selection = ctx.database.select(table, query);
+				if (sort) {
+					if (!columnsOf(model).some((column) => column.name === sort.column)) throw new MushinError("invalid_input", `Table "${table}" has no column "${sort.column}"`);
+					selection = selection.orderBy(sort.column, sort.order);
+				}
+				const [rows, total] = await Promise.all([selection.offset(offset).limit(limit).execute(), countRows(table, model, query)]);
+				return {
+					rows: rows.map((row) => plain(row)),
+					total
+				};
+			}
+		});
+		ctx.actions.define({
+			name: "database.update",
+			description: "Changes columns of one row, found by its primary key. Writes to plugin data directly, so the change takes effect without any checks the plugin would make.",
+			risk: "dangerous",
+			input: z.object({
+				table: z.string(),
+				key: z.record(z.string(), z.unknown()),
+				data: z.record(z.string(), z.unknown())
+			}),
+			handler: async ({ table, key, data }) => {
+				const model = tableOf(table);
+				const columns = new Set(columnsOf(model).map((column) => column.name));
+				for (const name of Object.keys(data)) {
+					if (!columns.has(name)) throw new MushinError("invalid_input", `Table "${table}" has no column "${name}"`);
+					if (primaryOf(model).includes(name)) throw new MushinError("invalid_input", `"${name}" is part of the primary key and cannot be changed`);
+				}
+				const result = await ctx.database.set(table, keyQuery(model, key), data);
+				if (!result.matched) throw new MushinError("not_found", "No row has that key");
+				return { updated: result.modified ?? result.matched };
+			}
+		});
+		ctx.actions.define({
+			name: "database.remove",
+			description: "Deletes rows from a table by their primary keys. Cannot be undone; make a backup first if unsure.",
+			risk: "dangerous",
+			input: z.object({
+				table: z.string(),
+				keys: z.array(z.record(z.string(), z.unknown())).min(1).max(PAGE_LIMIT)
+			}),
+			handler: async ({ table, keys }) => {
+				const model = tableOf(table);
+				let removed = 0;
+				for (const key of keys) removed += (await ctx.database.remove(table, keyQuery(model, key))).removed ?? 0;
+				return { removed };
+			}
+		});
+		ctx.actions.define({
+			name: "database.export",
+			description: "The rows of a table (matching optional filters) as CSV or JSON text, for downloading.",
+			risk: "read",
+			input: z.object({
+				table: z.string(),
+				format: z.enum(["csv", "json"]).default("csv"),
+				filter: Filter
+			}),
+			handler: async ({ table, format, filter }) => {
+				const model = tableOf(table);
+				const rows = (await ctx.database.select(table, queryOf(model, filter)).limit(EXPORT_LIMIT).execute()).map((row) => plain(row));
+				const columns = columnsOf(model).map((column) => column.name);
+				const content = format === "csv" ? "" + toCsv(columns, rows) : JSON.stringify(rows, null, 2);
+				return {
+					filename: `${table}.${format}`,
+					content,
+					rows: rows.length,
+					truncated: rows.length >= EXPORT_LIMIT
+				};
+			}
+		});
+		ctx.actions.define({
+			name: "database.backup",
+			description: "Copies the SQLite database to data/backups/ under a dated name while Mushin.js keeps running. Returns the backup's path.",
+			risk: "write",
+			input: z.object({}),
+			handler: async () => {
+				const driver = ctx.database._driver;
+				if (!file || !driver?.db) throw new MushinError("unavailable", "Backups need the SQLite driver");
+				const stamp = (/* @__PURE__ */ new Date()).toISOString().replace(/[-:]/g, "").replace("T", "-").slice(0, 15);
+				const target = join(dirname(file), "backups", `mushin-${stamp}.db`);
+				await mkdir(dirname(target), { recursive: true });
+				driver.db.exec(`VACUUM INTO '${target.replace(/'/g, "''")}'`);
+				const size = (await stat(target)).size;
+				return {
+					path: relative(baseDir, target).split(sep).join("/"),
+					size
+				};
+			}
+		});
+	});
+}
+export { Config, apply, inject, name, toCsv };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { mkdir, stat } from 'node:fs/promises'\nimport { dirname, isAbsolute, join, relative, resolve, sep } from 'node:path'\nimport { pathToFileURL } from 'node:url'\nimport { type Context, field, MushinError, z } from '@mushinjs/core'\nimport MemoryDriver from '@minatojs/driver-memory'\nimport SQLiteDriver from '@minatojs/driver-sqlite'\nimport { $, Database, type Field, type Model } from 'minato'\n\nexport type { Database, Driver, Field, Model, Query, Selection, Tables, Types } from 'minato'\n\nexport const name = 'database'\nexport const inject = ['actions']\n\nexport const Config = z.object({\n  driver: z.enum(['sqlite', 'memory']).default('sqlite').meta(field('Driver', 'sqlite keeps everything in one file; memory loses the data when Mushin.js stops (for trying things out)', {\n    'zh-CN': { title: '驱动', description: 'sqlite 把数据存在一个文件里；memory 在 Mushin.js 停止时丢失数据（用于试用）' },\n  })),\n  path: z.string().trim().min(1).default('data/mushin.db').meta(field('Database file', 'For SQLite; relative to the instance directory', {\n    'zh-CN': { title: '数据库文件', description: 'SQLite 使用；相对于实例目录' },\n  })),\n})\n\nexport type Config = z.infer<typeof Config>\n\n// The drivers inject a `logger` service that Cordis 4 keeps as a built-in property instead, so\n// they would wait for it forever. They only call `ctx.logger?.info()` and the like, which the\n// built-in logger answers, so only the model is injected here.\nclass SQLite extends (SQLiteDriver as any) {\n  static inject = ['model']\n}\n\nclass Memory extends (MemoryDriver as any) {\n  static inject = ['model']\n}\n\nconst PAGE_LIMIT = 500\nconst EXPORT_LIMIT = 100_000\n\nexport interface ColumnInfo {\n  name: string\n  type: string\n  primary: boolean\n  nullable: boolean\n}\n\nexport interface TableInfo {\n  name: string\n  /** The part of the name before the first underscore, which by convention names the plugin. */\n  group: string\n  primary: string[]\n  columns: ColumnInfo[]\n  count: number\n}\n\n/** Rows as JSON can carry them: dates as ISO text, binary as a note, big integers as text. */\nfunction plain(value: unknown): unknown {\n  if (value instanceof Date) return value.toISOString()\n  if (typeof value === 'bigint') return value.toString()\n  if (value instanceof ArrayBuffer || ArrayBuffer.isView(value)) return `<binary ${(value as ArrayBuffer).byteLength} bytes>`\n  if (Array.isArray(value)) return value.map(plain)\n  if (value && typeof value === 'object') return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, plain(item)]))\n  return value\n}\n\nfunction csvCell(value: unknown) {\n  if (value === undefined || value === null) return ''\n  const text = typeof value === 'object' ? JSON.stringify(value) : String(value)\n  return /[\",\\r\\n]/.test(text) ? `\"${text.replace(/\"/g, '\"\"')}\"` : text\n}\n\nexport function toCsv(columns: string[], rows: Record<string, unknown>[]) {\n  return [columns.map(csvCell).join(','), ...rows.map((row) => columns.map((column) => csvCell(row[column])).join(','))].join('\\r\\n') + '\\r\\n'\n}\n\nconst numeric = new Set(['integer', 'unsigned', 'float', 'double', 'decimal', 'bigint'])\nconst textual = new Set(['char', 'string', 'text'])\n\nconst escapeRegExp = (text: string) => text.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&')\n\nconst Filter = z.record(z.string(), z.string()).optional().describe('Column → text. Text columns match when they contain the text; numbers and booleans must be equal.')\n\n/**\n * The database service (`ctx.database`, from minato) and the actions behind the Database page.\n * Plugins declare tables with `ctx.model.extend()` in a context that injects both `model` and\n * `database`; by convention a table's name starts with the plugin's name and an underscore.\n */\nexport function apply(ctx: Context, config: Config) {\n  const baseDir = ctx.baseDir ?? process.cwd()\n  const file = config.driver === 'sqlite' ? (isAbsolute(config.path) ? config.path : resolve(baseDir, config.path)) : undefined\n\n  ctx.plugin(Database)\n  if (file) {\n    ctx.inject(['model'], async (ctx) => {\n      await mkdir(dirname(file), { recursive: true })\n      // The driver resolves the path against `ctx.baseUrl`; a file URL resolves to itself.\n      ctx.plugin(SQLite as any, { path: pathToFileURL(file).href })\n    })\n  } else {\n    ctx.plugin(Memory as any, {})\n  }\n\n  ctx.inject(['model', 'database'], (ctx) => {\n    const tableOf = (name: string): Model => {\n      const model = ctx.model.tables[name]\n      if (!model) throw new MushinError('not_found', `No table named \"${name}\"`)\n      return model\n    }\n    const primaryOf = (model: Model) => (Array.isArray(model.primary) ? model.primary : [model.primary]) as string[]\n    const columnsOf = (model: Model): ColumnInfo[] => {\n      const primary = primaryOf(model)\n      return Object.entries(model.fields as Record<string, Field | undefined>)\n        .filter(([, item]) => item && !item.deprecated && !item.relation && !item.expr)\n        .map(([name, item]) => ({ name, type: String(item!.deftype ?? item!.type?.type ?? ''), primary: primary.includes(name), nullable: !!item!.nullable }))\n    }\n    const queryOf = (model: Model, filter: Record<string, string> | undefined) => {\n      const query: Record<string, unknown> = {}\n      const columns = new Map(columnsOf(model).map((column) => [column.name, column]))\n      for (const [name, text] of Object.entries(filter ?? {})) {\n        if (text === '') continue\n        const column = columns.get(name)\n        if (!column) throw new MushinError('invalid_input', `Table \"${model.name}\" has no column \"${name}\"`)\n        if (numeric.has(column.type)) {\n          const value = Number(text)\n          if (!Number.isFinite(value)) throw new MushinError('invalid_input', `\"${text}\" is not a number`)\n          query[name] = value\n        } else if (column.type === 'boolean') {\n          query[name] = text === 'true' || text === '1'\n        } else if (textual.has(column.type)) {\n          query[name] = { $regex: new RegExp(escapeRegExp(text), 'i') }\n        } else {\n          throw new MushinError('invalid_input', `Column \"${name}\" (${column.type}) cannot be filtered`)\n        }\n      }\n      return query\n    }\n    const keyQuery = (model: Model, key: Record<string, unknown>) => {\n      const query: Record<string, unknown> = {}\n      for (const name of primaryOf(model)) {\n        if (!(name in key)) throw new MushinError('invalid_input', `The key needs \"${name}\"`)\n        query[name] = key[name]\n      }\n      return query\n    }\n\n    const status = async () => {\n      const size = file ? (await stat(file).catch(() => undefined))?.size ?? 0 : undefined\n      return {\n        driver: config.driver,\n        ...(file ? { path: relative(baseDir, file).split(sep).join('/'), size } : {}),\n        tables: Object.keys(ctx.model.tables).length,\n      }\n    }\n\n    const countRows = async (table: string, model: Model, query: Record<string, unknown>) => {\n      const key = primaryOf(model)[0] ?? columnsOf(model)[0]?.name\n      return Number(await ctx.database.select(table as any, query as any).execute((row: any) => $.count(row[key]))) || 0\n    }\n\n    const tables = async (): Promise<TableInfo[]> => {\n      const list: TableInfo[] = []\n      for (const [name, model] of Object.entries(ctx.model.tables)) {\n        const count = await countRows(name, model, {})\n        list.push({ name, group: name.split('_')[0], primary: primaryOf(model), columns: columnsOf(model), count: Number(count) || 0 })\n      }\n      return list.sort((a, b) => a.name.localeCompare(b.name))\n    }\n\n    ctx.actions.define({\n      name: 'database.status',\n      description: 'Which database driver runs, the SQLite file and its size, and how many tables exist.',\n      risk: 'read',\n      input: z.object({}),\n      handler: status,\n    })\n\n    ctx.actions.define({\n      name: 'database.tables',\n      description: 'Every table in the database with its columns, primary key and row count. Tables are grouped by the plugin name before the first underscore, e.g. flows_var.',\n      risk: 'read',\n      input: z.object({}),\n      handler: tables,\n    })\n\n    ctx.actions.define({\n      name: 'database.rows',\n      description: 'A page of rows from one table, read-only: optional sort and filters. Returns the rows and the total that match.',\n      risk: 'read',\n      input: z.object({\n        table: z.string(),\n        offset: z.number().int().min(0).default(0),\n        limit: z.number().int().min(1).max(PAGE_LIMIT).default(50),\n        sort: z.object({ column: z.string(), order: z.enum(['asc', 'desc']).default('asc') }).optional(),\n        filter: Filter,\n      }),\n      handler: async ({ table, offset, limit, sort, filter }) => {\n        const model = tableOf(table)\n        const query = queryOf(model, filter)\n        let selection = ctx.database.select(table as any, query as any)\n        if (sort) {\n          if (!columnsOf(model).some((column) => column.name === sort.column)) throw new MushinError('invalid_input', `Table \"${table}\" has no column \"${sort.column}\"`)\n          selection = selection.orderBy(sort.column as any, sort.order)\n        }\n        const [rows, total] = await Promise.all([\n          selection.offset(offset).limit(limit).execute(),\n          countRows(table, model, query),\n        ])\n        return { rows: rows.map((row) => plain(row)), total }\n      },\n    })\n\n    ctx.actions.define({\n      name: 'database.update',\n      description: 'Changes columns of one row, found by its primary key. Writes to plugin data directly, so the change takes effect without any checks the plugin would make.',\n      risk: 'dangerous',\n      input: z.object({ table: z.string(), key: z.record(z.string(), z.unknown()), data: z.record(z.string(), z.unknown()) }),\n      handler: async ({ table, key, data }) => {\n        const model = tableOf(table)\n        const columns = new Set(columnsOf(model).map((column) => column.name))\n        for (const name of Object.keys(data)) {\n          if (!columns.has(name)) throw new MushinError('invalid_input', `Table \"${table}\" has no column \"${name}\"`)\n          if (primaryOf(model).includes(name)) throw new MushinError('invalid_input', `\"${name}\" is part of the primary key and cannot be changed`)\n        }\n        const result = await ctx.database.set(table as any, keyQuery(model, key) as any, data as any)\n        if (!result.matched) throw new MushinError('not_found', 'No row has that key')\n        return { updated: result.modified ?? result.matched }\n      },\n    })\n\n    ctx.actions.define({\n      name: 'database.remove',\n      description: 'Deletes rows from a table by their primary keys. Cannot be undone; make a backup first if unsure.',\n      risk: 'dangerous',\n      input: z.object({ table: z.string(), keys: z.array(z.record(z.string(), z.unknown())).min(1).max(PAGE_LIMIT) }),\n      handler: async ({ table, keys }) => {\n        const model = tableOf(table)\n        let removed = 0\n        for (const key of keys) removed += (await ctx.database.remove(table as any, keyQuery(model, key) as any)).removed ?? 0\n        return { removed }\n      },\n    })\n\n    ctx.actions.define({\n      name: 'database.export',\n      description: 'The rows of a table (matching optional filters) as CSV or JSON text, for downloading.',\n      risk: 'read',\n      input: z.object({ table: z.string(), format: z.enum(['csv', 'json']).default('csv'), filter: Filter }),\n      handler: async ({ table, format, filter }) => {\n        const model = tableOf(table)\n        const rows = (await ctx.database.select(table as any, queryOf(model, filter) as any).limit(EXPORT_LIMIT).execute()).map((row) => plain(row) as Record<string, unknown>)\n        const columns = columnsOf(model).map((column) => column.name)\n        const content = format === 'csv' ? '' + toCsv(columns, rows) : JSON.stringify(rows, null, 2)\n        return { filename: `${table}.${format}`, content, rows: rows.length, truncated: rows.length >= EXPORT_LIMIT }\n      },\n    })\n\n    ctx.actions.define({\n      name: 'database.backup',\n      description: 'Copies the SQLite database to data/backups/ under a dated name while Mushin.js keeps running. Returns the backup\\'s path.',\n      risk: 'write',\n      input: z.object({}),\n      handler: async () => {\n        const driver = (ctx.database as any)._driver\n        if (!file || !driver?.db) throw new MushinError('unavailable', 'Backups need the SQLite driver')\n        const stamp = new Date().toISOString().replace(/[-:]/g, '').replace('T', '-').slice(0, 15)\n        const target = join(dirname(file), 'backups', `mushin-${stamp}.db`)\n        await mkdir(dirname(target), { recursive: true })\n        driver.db.exec(`VACUUM INTO '${target.replace(/'/g, \"''\")}'`)\n        const size = (await stat(target)).size\n        return { path: relative(baseDir, target).split(sep).join('/'), size }\n      },\n    })\n  })\n}\n"],"mappings":";;;;;;;;AAUA,MAAa,OAAO;AACpB,MAAa,SAAS,CAAC,SAAS;AAEhC,MAAa,SAAS,EAAE,OAAO;CAC7B,QAAQ,EAAE,KAAK,CAAC,UAAU,QAAQ,CAAC,CAAC,CAAC,QAAQ,QAAQ,CAAC,CAAC,KAAK,MAAM,UAAU,2GAA2G,EACrL,SAAS;EAAE,OAAO;EAAM,aAAa;CAAqD,EAC5F,CAAC,CAAC;CACF,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,gBAAgB,CAAC,CAAC,KAAK,MAAM,iBAAiB,kDAAkD,EACrI,SAAS;EAAE,OAAO;EAAS,aAAa;CAAoB,EAC9D,CAAC,CAAC;AACJ,CAAC;AAOD,IAAM,SAAN,cAAsB,aAAqB;CACzC,OAAO,SAAS,CAAC,OAAO;AAC1B;AAEA,IAAM,SAAN,cAAsB,aAAqB;CACzC,OAAO,SAAS,CAAC,OAAO;AAC1B;AAEA,MAAM,aAAa;AACnB,MAAM,eAAe;;AAmBrB,SAAS,MAAM,OAAyB;CACtC,IAAI,iBAAiB,MAAM,OAAO,MAAM,YAAY;CACpD,IAAI,OAAO,UAAU,UAAU,OAAO,MAAM,SAAS;CACrD,IAAI,iBAAiB,eAAe,YAAY,OAAO,KAAK,GAAG,OAAO,WAAY,MAAsB,WAAW;CACnH,IAAI,MAAM,QAAQ,KAAK,GAAG,OAAO,MAAM,IAAI,KAAK;CAChD,IAAI,SAAS,OAAO,UAAU,UAAU,OAAO,OAAO,YAAY,OAAO,QAAQ,KAAK,CAAC,CAAC,KAAK,CAAC,KAAK,UAAU,CAAC,KAAK,MAAM,IAAI,CAAC,CAAC,CAAC;CAChI,OAAO;AACT;AAEA,SAAS,QAAQ,OAAgB;CAC/B,IAAI,UAAU,KAAA,KAAa,UAAU,MAAM,OAAO;CAClD,MAAM,OAAO,OAAO,UAAU,WAAW,KAAK,UAAU,KAAK,IAAI,OAAO,KAAK;CAC7E,OAAO,WAAW,KAAK,IAAI,IAAI,IAAI,KAAK,QAAQ,MAAM,MAAI,EAAE,KAAK;AACnE;AAEA,SAAgB,MAAM,SAAmB,MAAiC;CACxE,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,CAAC,KAAK,GAAG,GAAG,GAAG,KAAK,KAAK,QAAQ,QAAQ,KAAK,WAAW,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI;AACxI;AAEA,MAAM,0BAAU,IAAI,IAAI;CAAC;CAAW;CAAY;CAAS;CAAU;CAAW;AAAQ,CAAC;AACvF,MAAM,0BAAU,IAAI,IAAI;CAAC;CAAQ;CAAU;AAAM,CAAC;AAElD,MAAM,gBAAgB,SAAiB,KAAK,QAAQ,uBAAuB,MAAM;AAEjF,MAAM,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,mGAAmG;;;;;;AAOvK,SAAgB,MAAM,KAAc,QAAgB;CAClD,MAAM,UAAU,IAAI,WAAW,QAAQ,IAAI;CAC3C,MAAM,OAAO,OAAO,WAAW,WAAY,WAAW,OAAO,IAAI,IAAI,OAAO,OAAO,QAAQ,SAAS,OAAO,IAAI,IAAK,KAAA;CAEpH,IAAI,OAAO,QAAQ;CACnB,IAAI,MACF,IAAI,OAAO,CAAC,OAAO,GAAG,OAAO,QAAQ;EACnC,MAAM,MAAM,QAAQ,IAAI,GAAG,EAAE,WAAW,KAAK,CAAC;EAE9C,IAAI,OAAO,QAAe,EAAE,MAAM,cAAc,IAAI,CAAC,CAAC,KAAK,CAAC;CAC9D,CAAC;MAED,IAAI,OAAO,QAAe,CAAC,CAAC;CAG9B,IAAI,OAAO,CAAC,SAAS,UAAU,IAAI,QAAQ;EACzC,MAAM,WAAW,SAAwB;GACvC,MAAM,QAAQ,IAAI,MAAM,OAAO;GAC/B,IAAI,CAAC,OAAO,MAAM,IAAI,YAAY,aAAa,mBAAmB,KAAK,EAAE;GACzE,OAAO;EACT;EACA,MAAM,aAAa,UAAkB,MAAM,QAAQ,MAAM,OAAO,IAAI,MAAM,UAAU,CAAC,MAAM,OAAO;EAClG,MAAM,aAAa,UAA+B;GAChD,MAAM,UAAU,UAAU,KAAK;GAC/B,OAAO,OAAO,QAAQ,MAAM,MAA2C,CAAC,CACrE,QAAQ,GAAG,UAAU,QAAQ,CAAC,KAAK,cAAc,CAAC,KAAK,YAAY,CAAC,KAAK,IAAI,CAAC,CAC9E,KAAK,CAAC,MAAM,WAAW;IAAE;IAAM,MAAM,OAAO,KAAM,WAAW,KAAM,MAAM,QAAQ,EAAE;IAAG,SAAS,QAAQ,SAAS,IAAI;IAAG,UAAU,CAAC,CAAC,KAAM;GAAS,EAAE;EACzJ;EACA,MAAM,WAAW,OAAc,WAA+C;GAC5E,MAAM,QAAiC,CAAC;GACxC,MAAM,UAAU,IAAI,IAAI,UAAU,KAAK,CAAC,CAAC,KAAK,WAAW,CAAC,OAAO,MAAM,MAAM,CAAC,CAAC;GAC/E,KAAK,MAAM,CAAC,MAAM,SAAS,OAAO,QAAQ,UAAU,CAAC,CAAC,GAAG;IACvD,IAAI,SAAS,IAAI;IACjB,MAAM,SAAS,QAAQ,IAAI,IAAI;IAC/B,IAAI,CAAC,QAAQ,MAAM,IAAI,YAAY,iBAAiB,UAAU,MAAM,KAAK,mBAAmB,KAAK,EAAE;IACnG,IAAI,QAAQ,IAAI,OAAO,IAAI,GAAG;KAC5B,MAAM,QAAQ,OAAO,IAAI;KACzB,IAAI,CAAC,OAAO,SAAS,KAAK,GAAG,MAAM,IAAI,YAAY,iBAAiB,IAAI,KAAK,kBAAkB;KAC/F,MAAM,QAAQ;IAChB,OAAO,IAAI,OAAO,SAAS,WACzB,MAAM,QAAQ,SAAS,UAAU,SAAS;SACrC,IAAI,QAAQ,IAAI,OAAO,IAAI,GAChC,MAAM,QAAQ,EAAE,QAAQ,IAAI,OAAO,aAAa,IAAI,GAAG,GAAG,EAAE;SAE5D,MAAM,IAAI,YAAY,iBAAiB,WAAW,KAAK,KAAK,OAAO,KAAK,qBAAqB;GAEjG;GACA,OAAO;EACT;EACA,MAAM,YAAY,OAAc,QAAiC;GAC/D,MAAM,QAAiC,CAAC;GACxC,KAAK,MAAM,QAAQ,UAAU,KAAK,GAAG;IACnC,IAAI,EAAE,QAAQ,MAAM,MAAM,IAAI,YAAY,iBAAiB,kBAAkB,KAAK,EAAE;IACpF,MAAM,QAAQ,IAAI;GACpB;GACA,OAAO;EACT;EAEA,MAAM,SAAS,YAAY;GACzB,MAAM,OAAO,QAAQ,MAAM,KAAK,IAAI,CAAC,CAAC,YAAY,KAAA,CAAS,EAAA,EAAI,QAAQ,IAAI,KAAA;GAC3E,OAAO;IACL,QAAQ,OAAO;IACf,GAAI,OAAO;KAAE,MAAM,SAAS,SAAS,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG;KAAG;IAAK,IAAI,CAAC;IAC3E,QAAQ,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC,CAAC;GACxC;EACF;EAEA,MAAM,YAAY,OAAO,OAAe,OAAc,UAAmC;GACvF,MAAM,MAAM,UAAU,KAAK,CAAC,CAAC,MAAM,UAAU,KAAK,CAAC,CAAC,EAAE,EAAE;GACxD,OAAO,OAAO,MAAM,IAAI,SAAS,OAAO,OAAc,KAAY,CAAC,CAAC,SAAS,QAAa,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,KAAK;EACnH;EAEA,MAAM,SAAS,YAAkC;GAC/C,MAAM,OAAoB,CAAC;GAC3B,KAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,IAAI,MAAM,MAAM,GAAG;IAC5D,MAAM,QAAQ,MAAM,UAAU,MAAM,OAAO,CAAC,CAAC;IAC7C,KAAK,KAAK;KAAE;KAAM,OAAO,KAAK,MAAM,GAAG,CAAC,CAAC;KAAI,SAAS,UAAU,KAAK;KAAG,SAAS,UAAU,KAAK;KAAG,OAAO,OAAO,KAAK,KAAK;IAAE,CAAC;GAChI;GACA,OAAO,KAAK,MAAM,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC;EACzD;EAEA,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO,CAAC,CAAC;GAClB,SAAS;EACX,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO,CAAC,CAAC;GAClB,SAAS;EACX,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC;IACzC,OAAO,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,QAAQ,EAAE;IACzD,MAAM,EAAE,OAAO;KAAE,QAAQ,EAAE,OAAO;KAAG,OAAO,EAAE,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,KAAK;IAAE,CAAC,CAAC,CAAC,SAAS;IAC/F,QAAQ;GACV,CAAC;GACD,SAAS,OAAO,EAAE,OAAO,QAAQ,OAAO,MAAM,aAAa;IACzD,MAAM,QAAQ,QAAQ,KAAK;IAC3B,MAAM,QAAQ,QAAQ,OAAO,MAAM;IACnC,IAAI,YAAY,IAAI,SAAS,OAAO,OAAc,KAAY;IAC9D,IAAI,MAAM;KACR,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,MAAM,WAAW,OAAO,SAAS,KAAK,MAAM,GAAG,MAAM,IAAI,YAAY,iBAAiB,UAAU,MAAM,mBAAmB,KAAK,OAAO,EAAE;KAC7J,YAAY,UAAU,QAAQ,KAAK,QAAe,KAAK,KAAK;IAC9D;IACA,MAAM,CAAC,MAAM,SAAS,MAAM,QAAQ,IAAI,CACtC,UAAU,OAAO,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,QAAQ,GAC9C,UAAU,OAAO,OAAO,KAAK,CAC/B,CAAC;IACD,OAAO;KAAE,MAAM,KAAK,KAAK,QAAQ,MAAM,GAAG,CAAC;KAAG;IAAM;GACtD;EACF,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO;IAAE,OAAO,EAAE,OAAO;IAAG,KAAK,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;IAAG,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC;GAAE,CAAC;GACtH,SAAS,OAAO,EAAE,OAAO,KAAK,WAAW;IACvC,MAAM,QAAQ,QAAQ,KAAK;IAC3B,MAAM,UAAU,IAAI,IAAI,UAAU,KAAK,CAAC,CAAC,KAAK,WAAW,OAAO,IAAI,CAAC;IACrE,KAAK,MAAM,QAAQ,OAAO,KAAK,IAAI,GAAG;KACpC,IAAI,CAAC,QAAQ,IAAI,IAAI,GAAG,MAAM,IAAI,YAAY,iBAAiB,UAAU,MAAM,mBAAmB,KAAK,EAAE;KACzG,IAAI,UAAU,KAAK,CAAC,CAAC,SAAS,IAAI,GAAG,MAAM,IAAI,YAAY,iBAAiB,IAAI,KAAK,mDAAmD;IAC1I;IACA,MAAM,SAAS,MAAM,IAAI,SAAS,IAAI,OAAc,SAAS,OAAO,GAAG,GAAU,IAAW;IAC5F,IAAI,CAAC,OAAO,SAAS,MAAM,IAAI,YAAY,aAAa,qBAAqB;IAC7E,OAAO,EAAE,SAAS,OAAO,YAAY,OAAO,QAAQ;GACtD;EACF,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO;IAAE,OAAO,EAAE,OAAO;IAAG,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU;GAAE,CAAC;GAC9G,SAAS,OAAO,EAAE,OAAO,WAAW;IAClC,MAAM,QAAQ,QAAQ,KAAK;IAC3B,IAAI,UAAU;IACd,KAAK,MAAM,OAAO,MAAM,YAAY,MAAM,IAAI,SAAS,OAAO,OAAc,SAAS,OAAO,GAAG,CAAQ,EAAA,CAAG,WAAW;IACrH,OAAO,EAAE,QAAQ;GACnB;EACF,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO;IAAE,OAAO,EAAE,OAAO;IAAG,QAAQ,EAAE,KAAK,CAAC,OAAO,MAAM,CAAC,CAAC,CAAC,QAAQ,KAAK;IAAG,QAAQ;GAAO,CAAC;GACrG,SAAS,OAAO,EAAE,OAAO,QAAQ,aAAa;IAC5C,MAAM,QAAQ,QAAQ,KAAK;IAC3B,MAAM,QAAQ,MAAM,IAAI,SAAS,OAAO,OAAc,QAAQ,OAAO,MAAM,CAAQ,CAAC,CAAC,MAAM,YAAY,CAAC,CAAC,QAAQ,EAAA,CAAG,KAAK,QAAQ,MAAM,GAAG,CAA4B;IACtK,MAAM,UAAU,UAAU,KAAK,CAAC,CAAC,KAAK,WAAW,OAAO,IAAI;IAC5D,MAAM,UAAU,WAAW,QAAQ,MAAM,MAAM,SAAS,IAAI,IAAI,KAAK,UAAU,MAAM,MAAM,CAAC;IAC5F,OAAO;KAAE,UAAU,GAAG,MAAM,GAAG;KAAU;KAAS,MAAM,KAAK;KAAQ,WAAW,KAAK,UAAU;IAAa;GAC9G;EACF,CAAC;EAED,IAAI,QAAQ,OAAO;GACjB,MAAM;GACN,aAAa;GACb,MAAM;GACN,OAAO,EAAE,OAAO,CAAC,CAAC;GAClB,SAAS,YAAY;IACnB,MAAM,SAAU,IAAI,SAAiB;IACrC,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,MAAM,IAAI,YAAY,eAAe,gCAAgC;IAC/F,MAAM,yBAAQ,IAAI,KAAK,EAAA,CAAE,YAAY,CAAC,CAAC,QAAQ,SAAS,EAAE,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,MAAM,GAAG,EAAE;IACzF,MAAM,SAAS,KAAK,QAAQ,IAAI,GAAG,WAAW,UAAU,MAAM,IAAI;IAClE,MAAM,MAAM,QAAQ,MAAM,GAAG,EAAE,WAAW,KAAK,CAAC;IAChD,OAAO,GAAG,KAAK,gBAAgB,OAAO,QAAQ,MAAM,IAAI,EAAE,EAAE;IAC5D,MAAM,QAAQ,MAAM,KAAK,MAAM,EAAA,CAAG;IAClC,OAAO;KAAE,MAAM,SAAS,SAAS,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG;KAAG;IAAK;GACtE;EACF,CAAC;CACH,CAAC;AACH"}

package/package.json

@@ -1,6 +1,53 @@
 {
   "name": "@mushinjs/plugin-database",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.0-next.20261113103537",
+  "description": "A database for plugins, SQLite by default",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mushinjs/mushin.git",
+    "directory": "packages/plugin-database"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "mushin-plugin"
+  ],
+  "mushin": {
+    "kind": "app",
+    "displayName": {
+      "en": "Database",
+      "zh-CN": "数据库"
+    },
+    "description": {
+      "en": "Keeps flow variables, messages and other plugins' tables in a database (SQLite by default), with a page to browse them",
+      "zh-CN": "把流程变量、消息和其他插件的数据表存进数据库（默认 SQLite），并提供浏览页面"
+    },
+    "provides": [
+      "database",
+      "model"
+    ],
+    "requires": {
+      "mushin": ">=0.1.0"
+    }
+  },
+  "dependencies": {
+    "@minatojs/driver-memory": "4.0.0",
+    "@minatojs/driver-sqlite": "5.0.3",
+    "@mushinjs/core": "0.2.0-next.20261113103537",
+    "cordis": "4.0.0-rc.11",
+    "minato": "4.0.1"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.