@bakery-framework/plugin-db-explorer 2.0.0-alpha.9 → 2.0.0-rc.2

package/src/shared/csv.ts

@@ -1,7 +1,7 @@
 /**
  * CSV, RFC 4180-ish, with the delimiter sniffed rather than assumed.
  *
- * **Pure** — see the note at the top of `coerce.ts` — and, unlike the rest of
+ * **Pure**. See the note at the top of `coerce.ts`, and, unlike the rest of
  * `shared/`, **browser-only**. It was written when the server re-parsed the
  * text it was sent; `endpoints/import.ts` takes records that are already mapped
  * and coerced, so no CSV text ever reaches it. `client/csv-model.ts` is the
@@ -19,7 +19,7 @@
  *    `if (c === '"') inQuotes = true` with no check that the field is empty.
  *    RFC 4180 only gives `"` meaning at the start of a field.
  * 2. **No BOM handling.** A file saved by Excel begins ``, so the first
- *    header comes back as `id` and matches no column — the single most
+ *    header comes back as `id` and matches no column: the single most
  *    common import failure there is.
  * 3. Comma only. A European export is `;`-delimited and a database dump is
  *    often tab-delimited; both parse as one column per row and then fail with
@@ -28,7 +28,7 @@
  *    (`row.length === 1 && row[0] === ''`), which also drops a legitimate
  *    single-column row whose value is empty.
  *
- * Fixing it in place would change `importCSV`'s behaviour for every existing
+ * Fixing it in place would change `importCSV`'s behavior for every existing
  * caller of the ORM, which is a separate decision from adding an importer to
  * the explorer. This parser is the explorer's; if the ORM's is ever replaced,
  * this is the implementation to move.
@@ -112,7 +112,7 @@ function countPerLine(text: string, delimiter: string, max: number): number[] {
  * No trimming and no type guessing: `"01"` and `01` are both the three-, then
  * two-character strings they look like, and turning either into a number is
  * `coerce.ts`'s job once a column is known. A field is only ever `''` when the
- * file said so — this parser has no concept of NULL.
+ * file said so: this parser has no concept of NULL.
  */
 export function parseCSVRows(text: string, delimiter = ','): string[][] {
   const csv = stripBOM(text)
@@ -137,7 +137,7 @@ export function parseCSVRows(text: string, delimiter = ','): string[][] {
     endField()
     // A blank line is not a row: it is what a trailing newline, or a stray one
     // in the middle of a file, leaves behind. One field, empty, and never
-    // quoted is the only shape it can take — a line reading `""` is a real row
+    // quoted is the only shape it can take: a line reading `""` is a real row
     // holding one empty value, which is why `rowQuoted` is tracked.
     const blank = row.length === 1 && row[0] === '' && !rowQuoted
     if (!blank) rows.push(row)

package/src/shared/filters.ts

@@ -1,7 +1,7 @@
 /**
  * The filter vocabulary, written once and read by both halves.
  *
- * **Pure, and deliberately in `shared/`** — the client builds filters and the
+ * **Pure, and deliberately in `shared/`**: the client builds filters and the
  * endpoint validates them, and a vocabulary that lived on only one side would
  * drift. Like the rest of `shared/`, this is compiled into the browser bundle,
  * so it imports nothing from `@bakery-framework/*` (see `client/safety.test.ts`).
@@ -14,7 +14,7 @@
  *
  * This is that caller. Validating matters more than it looks: a *dropped*
  * filter widens the result set, so a typo'd operator would silently show more
- * rows than were asked for — and the explorer's Delete acts on a selection made
+ * rows than were asked for, and the explorer's Delete acts on a selection made
  * from exactly that view. Failing the request is the only safe direction
  * (convention 2).
  */
@@ -51,7 +51,7 @@ export const FILTER_OPS: readonly FilterOp[] = [
  * The two operators that bind nothing.
  *
  * `IS NULL` has no parameter, which is the whole reason a filter cannot be
- * modelled as a plain column/value pair — the value input is *hidden* for
+ * modeled as a plain column/value pair: the value input is *hidden* for
  * these rather than ignored, because an input whose contents do nothing is a
  * lie about what the query will do.
  */
@@ -107,7 +107,7 @@ export function filter(
 /**
  * Filters as `getData` wants them: keyed by column.
  *
- * **The wire shape is a record, so a column can carry only one filter** — the
+ * **The wire shape is a record, so a column can carry only one filter**: the
  * ORM iterates `Object.entries(options.filters)`. Two chips on one column
  * therefore cannot both be sent, and the last one wins rather than the first,
  * because the last is the one the user just touched. `duplicateColumns` exists
@@ -132,7 +132,7 @@ export function toWire(filters: readonly Filter[]): Record<string, WireFilter> {
   return wire
 }
 
-/** Columns named by more than one filter — the ones the wire cannot carry. */
+/** Columns named by more than one filter: the ones the wire cannot carry. */
 export function duplicateColumns(filters: readonly Filter[]): string[] {
   const seen = new Set<string>()
   const twice = new Set<string>()
@@ -189,7 +189,7 @@ function parseOne(
   const { op, value: operand } = value as { op?: unknown; value?: unknown }
   if (!isFilterOp(op)) {
     return {
-      error: `unknown filter operator ${JSON.stringify(op)} on ${column} — expected one of ${FILTER_OPS.join(', ')}`,
+      error: `unknown filter operator ${JSON.stringify(op)} on ${column}: expected one of ${FILTER_OPS.join(', ')}`,
     }
   }
   if (!opTakesValue(op)) return { filter: { op } }

package/src/shared/plan.ts

@@ -2,7 +2,7 @@
  * Turning a spreadsheet into statements: which CSV column feeds which database
  * column, what stops an import before it starts, and what one row edit changes.
  *
- * **Pure** — see the note at the top of `coerce.ts`. The import dialog runs
+ * **Pure**. See the note at the top of `coerce.ts`. The import dialog runs
  * `autoMap` and `blockingIssues` in the browser to show the mapping before
  * anything is sent, and the server runs the same two functions on what arrives,
  * because a client-side check is a convenience and never a guarantee.
@@ -27,7 +27,7 @@ export type ColumnMapping = Record<string, string | null>
  * Nothing fuzzier: a near-miss that silently loads the wrong column is worse
  * than an unmapped one the dialog can ask about.
  *
- * A database column is claimed at most once. Two headers that normalise to the
+ * A database column is claimed at most once. Two headers that normalize to the
  * same name would otherwise both map to it, and the second would quietly win.
  */
 export function autoMap(
@@ -42,7 +42,7 @@ export function autoMap(
   for (const c of dbColumns) {
     const key = normalize(c)
     // First declaration wins, so the mapping does not depend on column order
-    // among columns that normalise alike.
+    // among columns that normalize alike.
     if (!byNormal.has(key)) byNormal.set(key, c)
   }
 
@@ -76,7 +76,7 @@ export interface PlanIssue {
 /**
  * What makes this mapping unrunnable, as opposed to merely lossy.
  *
- * A column left out of the mapping is fine when the database can fill it in —
+ * A column left out of the mapping is fine when the database can fill it in:
  * an auto-increment key, a default, or a nullable column. A NOT NULL column
  * with no default and no mapping is not: every row would fail at the database,
  * one at a time, after the import had already started.
@@ -123,7 +123,7 @@ export function blockingIssues(
 export interface UpdatePlanInput {
   /** The row as the editor last saw it, keyed by raw column name. */
   original: Record<string, unknown>
-  /** Edited values. **An absent key means unchanged** — see `coerce.ts`. */
+  /** Edited values. **An absent key means unchanged**. See `coerce.ts`. */
   edits: Record<string, unknown>
   /** The identity columns, from `describeIdentity`. */
   identity: readonly string[]
@@ -136,7 +136,7 @@ export interface UpdatePlanResult {
   where: Record<string, unknown>
   /** Edited keys that matched what was already there. */
   unchanged: string[]
-  /** Identity columns `original` does not carry — the plan is unusable. */
+  /** Identity columns `original` does not carry: the plan is unusable. */
   missingIdentity: string[]
 }
 
@@ -148,7 +148,7 @@ export interface UpdatePlanResult {
  * and set the new one, and a plan built from the edited row would look for a
  * row that does not exist yet.
  *
- * Unchanged columns are dropped from `set`. That is not only economy — a `set`
+ * Unchanged columns are dropped from `set`. That is not only economy: a `set`
  * carrying every column makes two people editing different columns of the same
  * row collide, and the whole reason to send a narrow statement is that they
  * should not.

package/src/shell.ts

@@ -6,7 +6,7 @@
  * stylesheet in the middle of it is a route table nobody reads. `setup.ts`
  * keeps the routing and the CSRF policy; this keeps the paint.
  *
- * There is **no markup generated from data here** — the body is an empty
+ * There is **no markup generated from data here**: the body is an empty
  * `#app` and a module script. Every value the user sees is written by
  * `client/dom.ts` through `textContent`, which is why this plugin has no XSS
  * surface even though it renders arbitrary row contents.
@@ -53,7 +53,7 @@ const CSS = `
   .tab-new { font: inherit; background: none; border: 0; color: var(--dim); cursor: pointer; padding: .3rem .8rem; }
   .tab-new:hover { color: var(--accent-text); }
 
-  /* Data / Structure / Relations — one level of nesting, and only one. */
+  /* Data / Structure / Relations: one level of nesting, and only one. */
   .viewtabs { display: flex; gap: .2rem; padding: .3rem .8rem 0; border-bottom: 1px solid var(--line); background: var(--bg); }
   .viewtab { font: inherit; font-size: .8rem; background: none; border: 0; border-bottom: 2px solid transparent; color: var(--dim); padding: .3rem .7rem; cursor: pointer; }
   .viewtab:hover { color: var(--text); }
@@ -140,7 +140,7 @@ const CSS = `
   dialog h4 { margin: .8rem 0 .3rem; font-size: .85rem; color: var(--dim); }
   .sel { font: inherit; background: var(--bg); color: var(--text); border: 1px solid var(--line); border-radius: 4px; padding: .15rem .3rem; }
 
-  /* The row side panel — where JSON, long text and both graph directions live. */
+  /* The row side panel: where JSON, long text and both graph directions live. */
   .panel { position: fixed; top: 0; right: 0; width: min(38rem, 100vw); height: 100vh; overflow-y: auto; background: var(--panel); border-left: 1px solid var(--line); padding: 1rem; z-index: 30; }
   .panel-head { display: flex; justify-content: space-between; align-items: flex-start; gap: 1rem; }
   .panel-title h3 { margin: 0; font-family: ui-monospace, monospace; }

package/src/validate.ts

@@ -4,7 +4,7 @@
  *
  * Two rules run through every function here.
  *
- * **Errors accumulate.** A 400 names every bad field, not the first one — a
+ * **Errors accumulate.** A 400 names every bad field, not the first one: a
  * fifty-row paste fixed one error per round trip is fifty round trips, and the
  * user cannot see the shape of their mistake.
  *
@@ -55,7 +55,7 @@ const error = (
 /**
  * Resolve a wire column name against the table.
  *
- * Accepts the raw database name, and the camel spelling as a courtesy — the
+ * Accepts the raw database name, and the camel spelling as a courtesy: the
  * grid renders raw names, but a script written against a typed schema has camel
  * ones and the two are the same column. Anything else is `unknown_column`.
  */
@@ -85,7 +85,7 @@ function coerceInto(
  * is fine when the database can fill it in (auto-increment, a default, or
  * nullable) and is a `required` error otherwise. Refusing here rather than at
  * the database is what keeps a 1,000-row insert from failing on row 700 with
- * 699 rows already written — the whole statement is known to be well-formed
+ * 699 rows already written: the whole statement is known to be well-formed
  * before any of it runs.
  */
 export function validateInsertRow(
@@ -135,8 +135,8 @@ export interface PartialOptions {
    * Whether a `json` or `buffer` column may appear.
    *
    * `false` for `expect`, where the answer is not "be careful" but "this cannot
-   * be expressed": those two kinds have no portable equality predicate — see
-   * `comparableKind` — so an `expect` over one is a condition that never
+   * be expressed": those two kinds have no portable equality predicate (see
+   * `comparableKind`), so an `expect` over one is a condition that never
    * matches, which reads to the caller as a permanent conflict.
    */
   allowUncomparable: boolean
@@ -145,7 +145,7 @@ export interface PartialOptions {
 }
 
 /**
- * A partial row — the `set` of an update, or the `expect` it is guarded by.
+ * A partial row: the `set` of an update, or the `expect` it is guarded by.
  *
  * Absent keys are absent, and that is the point: this function has no concept
  * of a default, because "the caller did not mention this column" means "leave
@@ -197,7 +197,7 @@ export function validatePartial(
  * The columns of `set` that may only be written with `force`.
  *
  * A `json` or `buffer` column cannot appear in `expect`, so an edit to one is
- * unguarded by construction — it overwrites whatever is there, including
+ * unguarded by construction: it overwrites whatever is there, including
  * whatever somebody else wrote a moment ago. `force` is how the caller says
  * they know that. It is not a permission; it is an acknowledgement.
  */
@@ -220,15 +220,15 @@ export interface ValidatedKey {
 /**
  * A wire key, against the table's identity.
  *
- * **The column set must be exactly equal** — not a subset, not a superset. A
+ * **The column set must be exactly equal**, not a subset, not a superset. A
  * subset is a predicate that matches more than one row, which for a composite
  * key is precisely the dashboard's bug (its MySQL path addresses rows by the
  * *first* primary-key column, so one edit rewrites every row sharing it). A
  * superset is a caller who believes the key contains something it does not, and
  * silently ignoring the extra column would confirm that belief.
  *
- * The key is transparent by design — `{ col: value }` rather than an opaque
- * token — so there is no server-side key cache to keep, and nothing that can go
+ * The key is transparent by design (`{ col: value }` rather than an opaque
+ * token), so there is no server-side key cache to keep, and nothing that can go
  * stale between rendering a page and saving a row (convention 6).
  */
 export function validateKey(