@metaobjectsdev/runtime-ts 0.6.0 → 0.7.0-rc.10

package/src/hono/index.ts

@@ -0,0 +1,237 @@
+// Drizzle-direct Hono adapter — Hono parallel of the drizzle-fastify mount
+// helpers. Aimed at Workers / Bun / Node consumers running Hono on top of
+// a Drizzle instance.
+//
+// Wire-format-identical to the Fastify flavor:
+//
+//   GET    {path}      list with ?filter / ?sort / ?limit / ?offset / ?withCount=1
+//   GET    {path}/:id  findById, 404 if missing
+//   POST   {path}      create, 400 on Zod validation error, 201 on success
+//   PATCH  {path}/:id  update (default), 400 / 404 envelopes
+//   PUT    {path}/:id  update (when updateMethod === "put")
+//   DELETE {path}/:id  delete, 204 on success, 404 if missing
+//
+// Filter / sort / withCount semantics are shared with drizzle-fastify via
+// parseFilterParams and parseHonoFilterParams (qs.parse on the raw URL),
+// so the two flavors emit byte-identical wire responses for the cross-port
+// API-contract corpus.
+
+import type { Hono, Context } from "hono";
+import type { ZodTypeAny } from "zod";
+import { eq, count, and } from "drizzle-orm";
+import qs from "qs";
+import {
+  parseFilterParams,
+  FilterParseError,
+  type ParseFilterResult,
+} from "../drizzle-fastify/filter-parser.js";
+import type {
+  FilterAllowlist,
+  SortAllowlist,
+} from "../drizzle-fastify/filter-allowlist.js";
+export type {
+  FilterAllowlist,
+  SortAllowlist,
+} from "../drizzle-fastify/filter-allowlist.js";
+import { isTruthyFlag } from "../drizzle-fastify/util.js";
+
+// ---------------------------------------------------------------------------
+// Loose types — we don't bind to a specific Drizzle backend so the helper
+// works across libsql / better-sqlite3 / D1 / pg / etc.
+// ---------------------------------------------------------------------------
+
+// biome-ignore lint/suspicious/noExplicitAny: dynamic dispatch over user's Drizzle instance
+type AnyDrizzle = any;
+// biome-ignore lint/suspicious/noExplicitAny: dynamic dispatch over user's Drizzle table
+type AnyTable = any;
+// biome-ignore lint/suspicious/noExplicitAny: generic Hono app — bindings/variables are the consumer's
+type AnyHono = Hono<any, any, any>;
+
+export type CrudVerb = "list" | "get" | "create" | "update" | "delete";
+
+export interface CrudRoutesOptions {
+  /** Hono app instance. Bindings type is the consumer's — kept generic here. */
+  app: AnyHono;
+  /** REST resource path, e.g. "/subscribers". */
+  path: string;
+  /** User's Drizzle instance. */
+  db: AnyDrizzle;
+  /** Drizzle table const. Must expose an `id` column. */
+  table: AnyTable;
+  /** Zod schema for create payloads (typically `<Entity>InsertSchema`). */
+  insertSchema: ZodTypeAny;
+  /** Zod schema for update payloads (typically `<Entity>UpdateSchema`). */
+  updateSchema: ZodTypeAny;
+  /** Limit which verbs are mounted. Defaults to all five. */
+  expose?: readonly CrudVerb[];
+  /**
+   * HTTP method for the update verb. Defaults to "patch". Set to "put" to
+   * preserve a legacy API contract that already uses PUT for updates.
+   */
+  updateMethod?: "patch" | "put";
+  filterAllowlist?: FilterAllowlist;
+  sortAllowlist?:   SortAllowlist;
+  /** Dialect — required if filterAllowlist or sortAllowlist is set (for like/ilike dispatch). */
+  dialect?: "sqlite" | "postgres";
+}
+
+const ALL_VERBS: readonly CrudVerb[] = ["list", "get", "create", "update", "delete"];
+
+export function mountCrudRoutes(opts: CrudRoutesOptions): void {
+  const verbs = new Set<CrudVerb>(opts.expose ?? ALL_VERBS);
+  if (verbs.has("list"))   mountListRoute(opts);
+  if (verbs.has("get"))    mountGetRoute(opts);
+  if (verbs.has("create")) mountCreateRoute(opts);
+  if (verbs.has("update")) mountUpdateRoute(opts);
+  if (verbs.has("delete")) mountDeleteRoute(opts);
+}
+
+type VerbOptions = Omit<CrudRoutesOptions, "expose">;
+
+// ---------------------------------------------------------------------------
+// Hono-flavored qs.parse — analogue of Fastify's qs.parse(req.raw.url ...).
+//
+// Hono exposes the raw URL via c.req.url; we strip the prefix and feed the
+// raw query string to qs so the bracketed filter notation (filter[a][eq]=...)
+// is recognised. The plain c.req.query() helper drops bracket structure, so
+// it can't replace this.
+// ---------------------------------------------------------------------------
+
+export function parseHonoFilterParams(c: Context): Record<string, unknown> {
+  const url = c.req.url;
+  const qIdx = url.indexOf("?");
+  const queryString = qIdx >= 0 ? url.slice(qIdx + 1) : "";
+  return qs.parse(queryString) as Record<string, unknown>;
+}
+
+export function mountListRoute(opts: VerbOptions): void {
+  opts.app.get(opts.path, async (c) => {
+    try {
+      let q = opts.db.select().from(opts.table).$dynamic();
+      const qsParsed = parseHonoFilterParams(c);
+      const withCount = isTruthyFlag(qsParsed.withCount);
+
+      let where: ParseFilterResult["where"];
+      if (opts.filterAllowlist && opts.sortAllowlist) {
+        const parsed = parseFilterParams({
+          query: qsParsed,
+          table: opts.table,
+          allowlist: opts.filterAllowlist,
+          sortAllowlist: opts.sortAllowlist,
+          dialect: opts.dialect ?? "sqlite",
+        });
+        const combinedWhere = parsed.where && parsed.searchWhere
+          ? and(parsed.where, parsed.searchWhere)
+          : (parsed.where ?? parsed.searchWhere);
+        if (combinedWhere) { q = q.where(combinedWhere); where = combinedWhere; }
+        if (parsed.orderBy) q = q.orderBy(...parsed.orderBy);
+        if (parsed.limit  !== undefined) q = q.limit(parsed.limit);
+        if (parsed.offset !== undefined) q = q.offset(parsed.offset);
+      } else {
+        // No allowlists configured. Only limit/offset.
+        const flat = c.req.query();
+        if (flat.limit  !== undefined) q = q.limit(Number(flat.limit));
+        if (flat.offset !== undefined) q = q.offset(Number(flat.offset));
+      }
+
+      const rows = await q.all();
+
+      if (!withCount) return c.json(rows);
+
+      // Count query: same WHERE, no limit/offset/orderBy.
+      let cq = opts.db.select({ c: count() }).from(opts.table).$dynamic();
+      if (where) cq = cq.where(where);
+      const countRow = (await cq.all())[0] as { c: number } | undefined;
+      const total = countRow?.c ?? 0;
+      return c.json({ rows, total });
+    } catch (err) {
+      if (err instanceof FilterParseError) {
+        return c.json({ error: err.code, ...(err.details ?? {}) }, 400);
+      }
+      throw err;
+    }
+  });
+}
+
+export function mountGetRoute(opts: VerbOptions): void {
+  opts.app.get(`${opts.path}/:id`, async (c) => {
+    const id = c.req.param("id") ?? "";
+    const row = await opts.db
+      .select()
+      .from(opts.table)
+      .where(eq(opts.table.id, parseId(id)))
+      .get();
+    return row ? c.json(row) : c.json({ error: "not_found" }, 404);
+  });
+}
+
+export function mountCreateRoute(opts: VerbOptions): void {
+  opts.app.post(opts.path, async (c) => {
+    const body = await c.req.json().catch(() => undefined);
+    const parsed = opts.insertSchema.safeParse(body);
+    if (!parsed.success) {
+      return c.json({ error: "validation", issues: parsed.error.issues }, 400);
+    }
+    const result = await opts.db.insert(opts.table).values(parsed.data).returning();
+    const row = (result as unknown[])[0];
+    return c.json(row, 201);
+  });
+}
+
+export function mountUpdateRoute(opts: VerbOptions): void {
+  const handler = async (c: Context) => {
+    const id = c.req.param("id") ?? "";
+    const body = await c.req.json().catch(() => undefined);
+    const parsed = opts.updateSchema.safeParse(body);
+    if (!parsed.success) {
+      return c.json({ error: "validation", issues: parsed.error.issues }, 400);
+    }
+    const result = await opts.db
+      .update(opts.table)
+      .set(parsed.data)
+      .where(eq(opts.table.id, parseId(id)))
+      .returning();
+    const row = (result as unknown[])[0];
+    return row ? c.json(row) : c.json({ error: "not_found" }, 404);
+  };
+  const path = `${opts.path}/:id`;
+  if (opts.updateMethod === "put") {
+    opts.app.put(path, handler);
+  } else {
+    opts.app.patch(path, handler);
+  }
+}
+
+export function mountDeleteRoute(opts: VerbOptions): void {
+  opts.app.delete(`${opts.path}/:id`, async (c) => {
+    const id = c.req.param("id") ?? "";
+    const result = await opts.db
+      .delete(opts.table)
+      .where(eq(opts.table.id, parseId(id)));
+    const affected = extractRowCount(result);
+    if (affected > 0) {
+      // 204 No Content — body must be empty.
+      return c.body(null, 204);
+    }
+    return c.json({ error: "not_found" }, 404);
+  });
+}
+
+function extractRowCount(result: unknown): number {
+  if (typeof result === "number") return result;
+  if (Array.isArray(result)) return result.length;
+  if (result && typeof result === "object") {
+    const obj = result as { rowsAffected?: number | bigint; rowCount?: number };
+    if (typeof obj.rowsAffected === "number") return obj.rowsAffected;
+    if (typeof obj.rowsAffected === "bigint") return Number(obj.rowsAffected);
+    if (typeof obj.rowCount === "number") return obj.rowCount;
+  }
+  return 0;
+}
+
+export function parseId(raw: string): number | string {
+  const n = Number(raw);
+  return Number.isFinite(n) && raw.trim() !== "" ? n : raw;
+}
+
+export { mountReadOnlyCrudRoutes, type MountReadOnlyOptions } from "./mount-read-only.js";

package/src/hono/mount-read-only.ts

@@ -0,0 +1,189 @@
+// Hono read-only mount — projection (view-backed) entities. GET list +
+// GET :id only. POST/PATCH/DELETE return 405. Mirrors the drizzle-fastify
+// equivalent so the cross-port API contract holds for projection endpoints.
+
+import type { Hono } from "hono";
+import { sql, eq, and, count } from "drizzle-orm";
+import qs from "qs";
+import { parseFilterParams, FilterParseError } from "../drizzle-fastify/filter-parser.js";
+import type {
+  FilterAllowlist,
+  SortAllowlist,
+} from "../drizzle-fastify/filter-allowlist.js";
+import { isTruthyFlag } from "../drizzle-fastify/util.js";
+
+// biome-ignore lint/suspicious/noExplicitAny: dynamic dispatch over user-supplied views
+type AnyView = any;
+// biome-ignore lint/suspicious/noExplicitAny: generic Hono app
+type AnyHono = Hono<any, any, any>;
+
+/**
+ * Drizzle v0.45 stores view config under this well-known Symbol. Mirrors
+ * the same workaround the Fastify mount uses — accessing `view._` on a
+ * proxy-wrapped view throws.
+ */
+const VIEW_BASE_CONFIG = Symbol.for("drizzle:ViewBaseConfig");
+
+export interface MountReadOnlyOptions {
+  readonly app: AnyHono;
+  readonly path: string;
+  // biome-ignore lint/suspicious/noExplicitAny: dynamic Drizzle client
+  readonly db: any;
+  readonly view: AnyView;
+  readonly filterAllowlist: FilterAllowlist;
+  readonly sortAllowlist: SortAllowlist;
+  readonly dialect: "postgres" | "sqlite";
+  /** Override default ID column name (defaults to "id"). */
+  readonly idColumn?: string;
+}
+
+function getViewConfig(view: AnyView): Record<string, unknown> | undefined {
+  try {
+    const cfg = (view as Record<symbol, unknown>)[VIEW_BASE_CONFIG];
+    if (cfg && typeof cfg === "object") return cfg as Record<string, unknown>;
+  } catch {
+    // ignore — proxy handler may throw on unexpected shapes
+  }
+  return undefined;
+}
+
+function resolveViewName(view: AnyView): string | undefined {
+  const cfg = getViewConfig(view);
+  if (cfg) {
+    if (typeof cfg["name"] === "string") return cfg["name"] as string;
+  }
+  const v = view as Record<string, unknown>;
+  return (
+    (typeof v["__tableName"] === "string" ? v["__tableName"] as string : undefined) ??
+    (typeof v["_name"] === "string" ? v["_name"] as string : undefined)
+  );
+}
+
+function isEmptyColumnView(view: AnyView): boolean {
+  const cfg = getViewConfig(view);
+  if (cfg) {
+    const fields = cfg["selectedFields"] as Record<string, unknown> | undefined;
+    return fields !== undefined && Object.keys(fields).length === 0;
+  }
+  return false;
+}
+
+function snakeToCamel(s: string): string {
+  return s.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
+}
+
+function camelizeRow(row: Record<string, unknown>): Record<string, unknown> {
+  const out: Record<string, unknown> = {};
+  for (const [k, v] of Object.entries(row)) {
+    out[snakeToCamel(k)] = v;
+  }
+  return out;
+}
+
+export function mountReadOnlyCrudRoutes(opts: MountReadOnlyOptions): void {
+  const { app, path, db, view, filterAllowlist, sortAllowlist, dialect } = opts;
+  const idCol = opts.idColumn ?? "id";
+
+  const viewName = resolveViewName(view);
+  const useRawSql = isEmptyColumnView(view) && !!viewName;
+
+  // ── List ──────────────────────────────────────────────────────────────────
+  app.get(path, async (c) => {
+    try {
+      if (useRawSql) {
+        const url = c.req.url;
+        const qIdx = url.indexOf("?");
+        const queryString = qIdx >= 0 ? url.slice(qIdx + 1) : "";
+        const parsed = qs.parse(queryString) as Record<string, unknown>;
+        const limitVal = Math.min(
+          1000,
+          Math.max(1, Number(typeof parsed["limit"] === "string" ? parsed["limit"] : 1000)),
+        );
+        const offsetVal = Math.max(
+          0,
+          Number(typeof parsed["offset"] === "string" ? parsed["offset"] : 0),
+        );
+        const withCount = isTruthyFlag(parsed["withCount"]);
+        // biome-ignore lint/suspicious/noExplicitAny: dynamic raw result
+        const rows = (await db.all(sql.raw(`SELECT * FROM "${viewName}" LIMIT ${limitVal} OFFSET ${offsetVal}`))) as any[];
+        const camelRows = rows.map((r: Record<string, unknown>) => camelizeRow(r));
+        if (!withCount) return c.json(camelRows);
+        // biome-ignore lint/suspicious/noExplicitAny: dynamic raw result
+        const countRows = (await db.all(sql.raw(`SELECT COUNT(*) AS c FROM "${viewName}"`))) as any[];
+        const total: number = Number(countRows[0]?.c ?? 0);
+        return c.json({ rows: camelRows, total });
+      }
+
+      const url = c.req.url;
+      const qIdx = url.indexOf("?");
+      const queryString = qIdx >= 0 ? url.slice(qIdx + 1) : "";
+      const parsed = qs.parse(queryString) as Record<string, unknown>;
+      const withCount = isTruthyFlag(parsed["withCount"]);
+      const result = parseFilterParams({
+        query: parsed,
+        table: view,
+        allowlist: filterAllowlist,
+        sortAllowlist,
+        dialect,
+      });
+      const combinedWhere = result.where && result.searchWhere
+        ? and(result.where, result.searchWhere)
+        : (result.where ?? result.searchWhere);
+      let q = db.select().from(view);
+      if (combinedWhere) q = q.where(combinedWhere);
+      if (result.orderBy) q = q.orderBy(...result.orderBy);
+      if (result.limit !== undefined) q = q.limit(result.limit);
+      if (result.offset !== undefined) q = q.offset(result.offset);
+      const rows = await q.all();
+
+      if (!withCount) return c.json(rows);
+
+      let cq = db.select({ c: count() }).from(view);
+      if (combinedWhere) cq = cq.where(combinedWhere);
+      const countRow = (await cq.all())[0] as { c: number } | undefined;
+      const total = countRow?.c ?? 0;
+      return c.json({ rows, total });
+    } catch (err) {
+      if (err instanceof FilterParseError) {
+        return c.json({ error: err.code, message: err.message }, 400);
+      }
+      throw err;
+    }
+  });
+
+  // ── Get by ID ─────────────────────────────────────────────────────────────
+  app.get(`${path}/:id`, async (c) => {
+    const id = c.req.param("id") ?? "";
+    if (useRawSql) {
+      const numericId = Number(id);
+      if (!Number.isFinite(numericId)) {
+        return c.json({ error: "invalid_id" }, 400);
+      }
+      // biome-ignore lint/suspicious/noExplicitAny: dynamic raw result
+      const rows = (await db.all(sql.raw(`SELECT * FROM "${viewName}" WHERE "${idCol}" = ${numericId} LIMIT 1`))) as any[];
+      const row = rows[0] ? camelizeRow(rows[0]) : undefined;
+      return row ? c.json(row) : c.json({ error: "not_found" }, 404);
+    }
+    // biome-ignore lint/suspicious/noExplicitAny: Drizzle view column ref
+    const colRef = (view as any)[idCol];
+    const row = await db
+      .select()
+      .from(view)
+      .where(colRef !== undefined ? eq(colRef, Number(id)) : undefined)
+      .get();
+    return row ? c.json(row) : c.json({ error: "not_found" }, 404);
+  });
+
+  // ── Mutations explicitly rejected (405) ───────────────────────────────────
+  const reject = (c: { req: { method: string }; json: (body: unknown, status: number) => unknown }) =>
+    c.json(
+      { error: "method_not_allowed", message: `${c.req.method} is not supported on a projection (read-only).` },
+      405,
+    );
+  // biome-ignore lint/suspicious/noExplicitAny: cross-version Hono typing
+  app.post(path, reject as any);
+  // biome-ignore lint/suspicious/noExplicitAny: cross-version Hono typing
+  app.patch(`${path}/:id`, reject as any);
+  // biome-ignore lint/suspicious/noExplicitAny: cross-version Hono typing
+  app.delete(`${path}/:id`, reject as any);
+}

package/src/n2m-resolver.ts

@@ -1,12 +1,13 @@
 // Two-stage N:M: first query the join entity for FK pairs, then query the target entity for the rows.
 // The relationship declares @joinEntity + @joinFields: [sourceJoinField, targetJoinField].
 
-import type { MetaData } from "@metaobjectsdev/metadata";
+import type { ColumnNamingStrategy, MetaData } from "@metaobjectsdev/metadata";
 import {
   TYPE_OBJECT, TYPE_FIELD, TYPE_RELATIONSHIP,
   RELATIONSHIP_ATTR_CARDINALITY, RELATIONSHIP_ATTR_OBJECT_REF,
   RELATIONSHIP_ATTR_JOIN_ENTITY, RELATIONSHIP_ATTR_JOIN_FIELDS,
   CARDINALITY_MANY,
+  DEFAULT_COLUMN_NAMING_STRATEGY,
   resolveColumnName,
 } from "@metaobjectsdev/metadata";
 import { MetadataError } from "./errors.js";
@@ -77,19 +78,20 @@ export function buildN2mLazySpecs(
   desc: N2mDescriptor,
   sourceRecord: Row,
   root: MetaData,
+  strategy: ColumnNamingStrategy = DEFAULT_COLUMN_NAMING_STRATEGY,
 ): N2mLazyOutput {
   const joinEntity = mustGetEntity(root, desc.joinEntityName);
   const targetEntity = mustGetEntity(root, desc.targetEntityName);
   const sourcePkField = resolvePkFields(mustGetEntity(root, desc.sourceEntityName))[0]!;
   const sourcePkValue = sourceRecord[sourcePkField];
 
-  const joinSpec = buildSelectSpec(joinEntity, { [desc.sourceJoinField]: sourcePkValue as PrimitiveValue }, {});
+  const joinSpec = buildSelectSpec(joinEntity, { [desc.sourceJoinField]: sourcePkValue as PrimitiveValue }, {}, undefined, strategy);
 
   const makeTargetSpec = (joinRows: Row[]): SelectSpec | null => {
-    const targetIds = collectTargetIds(joinRows, desc.targetJoinField, joinEntity);
+    const targetIds = collectTargetIds(joinRows, desc.targetJoinField, joinEntity, strategy);
     if (targetIds.length === 0) return null;
     const targetPkField = resolvePkFields(targetEntity)[0]!;
-    return buildSelectSpec(targetEntity, { [targetPkField]: targetIds }, {});
+    return buildSelectSpec(targetEntity, { [targetPkField]: targetIds }, {}, undefined, strategy);
   };
 
   return { joinSpec, makeTargetSpec };
@@ -99,19 +101,20 @@ export function buildN2mBatchSpecs(
   desc: N2mDescriptor,
   sourceRecords: Row[],
   root: MetaData,
+  strategy: ColumnNamingStrategy = DEFAULT_COLUMN_NAMING_STRATEGY,
 ): N2mBatchOutput {
   const joinEntity = mustGetEntity(root, desc.joinEntityName);
   const targetEntity = mustGetEntity(root, desc.targetEntityName);
   const sourcePkField = resolvePkFields(mustGetEntity(root, desc.sourceEntityName))[0]!;
   const sourceIds = collectIds(sourceRecords, sourcePkField);
 
-  const joinSpec = buildSelectSpec(joinEntity, { [desc.sourceJoinField]: sourceIds }, {});
+  const joinSpec = buildSelectSpec(joinEntity, { [desc.sourceJoinField]: sourceIds }, {}, undefined, strategy);
 
   const makeTargetSpec = (joinRows: Row[]): SelectSpec | null => {
-    const targetIds = collectTargetIds(joinRows, desc.targetJoinField, joinEntity);
+    const targetIds = collectTargetIds(joinRows, desc.targetJoinField, joinEntity, strategy);
     if (targetIds.length === 0) return null;
     const targetPkField = resolvePkFields(targetEntity)[0]!;
-    return buildSelectSpec(targetEntity, { [targetPkField]: targetIds }, {});
+    return buildSelectSpec(targetEntity, { [targetPkField]: targetIds }, {}, undefined, strategy);
   };
 
   return { joinSpec, makeTargetSpec };
@@ -133,9 +136,11 @@ function collectIds(records: Row[], pkField: string): (string | number)[] {
   return [...seen] as (string | number)[];
 }
 
-function collectTargetIds(joinRows: Row[], targetJoinField: string, joinEntity: MetaData): (string | number)[] {
+function collectTargetIds(
+  joinRows: Row[], targetJoinField: string, joinEntity: MetaData, strategy: ColumnNamingStrategy,
+): (string | number)[] {
   // joinRows are raw column-keyed (driver hasn't been to-JS-row'd yet); resolve the metadata field name to its DB column.
-  const dbColumn = resolveJoinColumnName(joinEntity, targetJoinField);
+  const dbColumn = resolveJoinColumnName(joinEntity, targetJoinField, strategy);
   const seen = new Set<PrimitiveValue>();
   for (const r of joinRows) {
     const v = r[dbColumn];
@@ -145,8 +150,11 @@ function collectTargetIds(joinRows: Row[], targetJoinField: string, joinEntity:
   return [...seen] as (string | number)[];
 }
 
-export function resolveJoinColumnName(joinEntity: MetaData, fieldName: string): string {
+export function resolveJoinColumnName(
+  joinEntity: MetaData, fieldName: string,
+  strategy: ColumnNamingStrategy = DEFAULT_COLUMN_NAMING_STRATEGY,
+): string {
   const field = joinEntity.ownChildren().find((c) => c.type === TYPE_FIELD && c.name === fieldName);
   if (!field) throw new MetadataError(`Join field '${fieldName}' not on '${joinEntity.name}'`);
-  return resolveColumnName(field);
+  return resolveColumnName(field, strategy);
 }