@bakery-framework/plugin-db-explorer 2.2.1 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bakery-framework/plugin-db-explorer",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Bakery database explorer plugin: browse and edit rows, no raw SQL, no DDL.",
   "keywords": [
     "bakery",
@@ -33,8 +33,8 @@
     "!src/tests"
   ],
   "dependencies": {
-    "@bakery-framework/core": "^2.2.1",
-    "@bakery-framework/orm": "^2.2.1"
+    "@bakery-framework/core": "^2.3.0",
+    "@bakery-framework/orm": "^2.3.0"
   },
   "engines": {
     "bun": ">=1.4.0"

package/src/endpoints/common.ts

@@ -19,6 +19,7 @@ import { errorMsg, pluginLog } from '@bakery-framework/core/logger'
 import { Case, Try } from '@bakery-framework/core/utils'
 import type { JsonResponseData } from '@bakery-framework/core/utils/common'
 import { response } from '@bakery-framework/core/utils/http'
+import { DB } from '@bakery-framework/orm/orm'
 import { currentCanWrite } from '../access'
 import { introspect, type TableFacts } from '../identity'
 import type { FieldError } from '../validate'
@@ -29,6 +30,27 @@ export type WriteStart =
   | { ok: true; table: TableFacts; body: Record<string, unknown> }
   | { ok: false; response: Envelope }
 
+/**
+ * `DB`'s three writers, for a table named at runtime.
+ *
+ * The explorer writes to whatever the database holds, by names it reads from
+ * the database. An app that registers its schema narrows `DB.Insert.into`,
+ * `DB.Update.table` and `DB.Delete.from`, and their columns, to its own names,
+ * which are not the explorer's to know: every write here failed such an app's
+ * typecheck (11 errors in rows.ts and import.ts, 2.1.2 through 2.2.1), while
+ * this repo's gates compiled the explorer against no schema at all.
+ *
+ * `any` is the one table type that gives the builders back their unregistered
+ * shape (`never` makes the row `never`), and the ORM's own executables default
+ * to it for the same reason. What a schema would have checked, the row against
+ * the table, `validate.ts` checks against the live table instead.
+ */
+export const byName = {
+  insert: (table: string) => DB.Insert.into<any>(table),
+  update: (table: string) => DB.Update.table<any>(table),
+  delete: (table: string) => DB.Delete.from<any>(table),
+}
+
 /** A 400 carrying every field error, never only the first. */
 export function invalid(errors: FieldError[]): Envelope {
   return response.json.error(400, 'Invalid request', { errors })

package/src/endpoints/import.ts

@@ -19,7 +19,7 @@ import { DB } from '@bakery-framework/orm/orm'
 import { overLimit } from '../policy'
 import { isRollbackSignal, previewRollback } from '../preview'
 import { type FieldError, validateInsertRow } from '../validate'
-import { beginWrite, invalid, refuse } from './common'
+import { beginWrite, byName, invalid, refuse } from './common'
 
 export type OnBadRow = 'stop' | 'skip'
 
@@ -70,7 +70,7 @@ export async function handleImport(
   return await Try.return(
     async () =>
       await DB.transaction(async () => {
-        const result = await DB.Insert.into(table.name).values(records).run()
+        const result = await byName.insert(table.name).values(records).run()
         const report = {
           inserted: Number(result.changes ?? 0),
           skipped,

package/src/endpoints/rows.ts

@@ -32,7 +32,13 @@ import {
   validateKey,
   validatePartial,
 } from '../validate'
-import { beginWrite, type Envelope, invalid, refuse } from './common'
+import {
+  beginWrite,
+  byName,
+  type Envelope,
+  invalid,
+  refuse,
+} from './common'
 
 /**
  * A conflict, as the caller sees it: which edit, which row, and what the row
@@ -150,7 +156,7 @@ export async function handleInsertRows(
       // wraps multiple batches in one transaction, so there is nothing to add
       // here, which is exactly why the insert goes through it rather than
       // through the adapter's own `insert()`.
-      const insert = DB.Insert.into(table.name).values(records)
+      const insert = byName.insert(table.name).values(records)
       if (!returning) {
         const result = await insert.run()
         return response.json.success('inserted', {
@@ -225,7 +231,7 @@ export async function handleUpdateRow(
         const predicate = { ...key.where, ...expect.values }
         const result = await chain(
           (column, value) =>
-            DB.Update.table(table.name).set(set.values).where(column, value),
+            byName.update(table.name).set(set.values).where(column, value),
           predicate,
         ).run()
 
@@ -404,7 +410,7 @@ async function applyCollapsedGroup(
       continue
     }
 
-    let statement = DB.Update.table(table.name)
+    let statement = byName.update(table.name)
       .set(group.set)
       .where(group.column, DB.inList(chunk.map(m => m.value)))
     for (const [column, value] of Object.entries(group.expect)) {
@@ -523,7 +529,7 @@ export async function handleBulkEdit(
           const predicate = { ...edit.key, ...edit.expect }
           const result = await chain(
             (column, value) =>
-              DB.Update.table(table.name).set(edit.set).where(column, value),
+              byName.update(table.name).set(edit.set).where(column, value),
             predicate,
           ).run()
 
@@ -612,7 +618,7 @@ export async function handleDeleteRows(
           const target = prepared[index]!
           const predicate = { ...target.key, ...target.expect }
           const result = await chain(
-            (column, value) => DB.Delete.from(table.name).where(column, value),
+            (column, value) => byName.delete(table.name).where(column, value),
             predicate,
           ).run()