okmodel 0.5.1 → 0.7.0

package/dist/shared/{51mvgj8w.js → 63qtkrca.js}

@@ -1,7 +1,7 @@
 import {
   isConnectionSqlstate,
   isConnectionFailure
-} from "./pf0d8f77.js";
+} from "./cnkky55j.js";
 import {
   OkmError2,
   stripRowValues,
@@ -14,10 +14,13 @@ function mapPostgresError(error, options) {
     return error;
   if (!isDriverError(error))
     return OkmError2.from(error);
+  const search = searchInputError(error);
+  if (search !== undefined)
+    return search;
   const kind = kindOf(error);
   const columns = columnsOf(error);
   const hint = hintOf(error, kind);
-  const fieldReason = hint?.reason ?? (kind === "not_null" ? "not_null" : reasonOf(kind, error.table, error.constraint));
+  const fieldReason = hint?.reason ?? (kind === "not_null" ? "not_null" : reasonOf(kind, error.table, error.constraint, columns, options?.schema));
   const values = options?.includeValues === true ? valuesOf(error.detail, columns) : undefined;
   const code = kind === "outcome_unknown" ? "OKM1401" : kind;
   return new OkmError2(code, summaryOf(kind, error, columns, fieldReason), {
@@ -45,6 +48,36 @@ function isDriverError(error) {
     return false;
   return "batchIndex" in error;
 }
+function searchQuery(error) {
+  const cause = error.cause;
+  if (typeof cause !== "object" || cause === null)
+    return false;
+  const query = Reflect.get(cause, "query");
+  return typeof query === "string" && query.includes("to_tsquery");
+}
+function searchInputError(error) {
+  const sqlstate = error.sqlstate;
+  const message = error.message;
+  if (sqlstate === "42601" && (message.includes("tsquery") || searchQuery(error))) {
+    return new OkmError2("OKM1120", `Search input is not valid. ${stripRowValues(message)}`, {
+      kind: "invalid",
+      sqlstate,
+      cause: error.cause ?? error,
+      fix: { summary: "Fix the advanced search text, or use natural, all-words, or phrase." }
+    });
+  }
+  if (sqlstate === "42704" && message.includes("text search configuration") && message.includes("does not exist")) {
+    return new OkmError2("OKM1122", stripRowValues(message), {
+      kind: "invalid",
+      sqlstate,
+      cause: error.cause ?? error,
+      fix: {
+        summary: "Use a text search configuration that exists, such as english, or omit language."
+      }
+    });
+  }
+  return;
+}
 function kindOf(error) {
   if (error.kind === "timeout" || error.kind === "cancelled" || error.kind === "outcome_unknown") {
     return error.kind;
@@ -70,11 +103,39 @@ function hintOf(error, kind) {
     return { reason: "undefined_table", fix: MIGRATE_FIX };
   if (error.sqlstate === "42703")
     return { reason: "undefined_column", fix: MIGRATE_FIX };
+  const refresh = refreshHint(error);
+  if (refresh !== undefined)
+    return refresh;
   if (kind === "unavailable" && error.sqlstate === undefined && isTlsFailure(error)) {
     return { reason: "tls", fix: TLS_FIX };
   }
   return;
 }
+function refreshHint(error) {
+  if (error.sqlstate === "0A000" && error.message.includes("materialized view is not populated")) {
+    return {
+      reason: "not_populated",
+      fix: { summary: "Refresh once without CONCURRENTLY so the view is populated." }
+    };
+  }
+  if (error.sqlstate === "55000" && error.message.includes("cannot refresh materialized view") && error.message.includes("concurrently")) {
+    return {
+      reason: "no_unique_index",
+      fix: {
+        summary: "Add a unique index with no WHERE clause, or refresh without CONCURRENTLY."
+      }
+    };
+  }
+  if (error.sqlstate === "42501" && error.message.includes("materialized view")) {
+    return {
+      reason: "not_owner",
+      fix: {
+        summary: "Refresh runs as the owner, the migration role. Connect as that role and call refresh(), or run REFRESH MATERIALIZED VIEW as that role. The application role is not the owner."
+      }
+    };
+  }
+  return;
+}
 function kindFromSqlstate(sqlstate) {
   switch (sqlstate) {
     case "23505":
@@ -112,7 +173,15 @@ function kindFromSqlstate(sqlstate) {
       return;
   }
 }
-function reasonOf(kind, table, constraint) {
+function reasonOf(kind, table, constraint, columns, schema) {
+  if (schema !== undefined && schema.catalog !== undefined && table !== undefined) {
+    const matched = matchObject(schema.catalog, table, constraint, columns);
+    if (matched !== undefined)
+      return reasonFromObject(schema, table, matched, columns);
+  }
+  return reasonFromName(kind, table, constraint);
+}
+function reasonFromName(kind, table, constraint) {
   if (constraint === undefined || constraint.length === 0)
     return kind;
   if (table !== undefined) {
@@ -128,6 +197,61 @@ function reasonOf(kind, table, constraint) {
   }
   return constraint;
 }
+function matchObject(catalog, table, constraint, columns) {
+  const rows = [];
+  for (const object of catalog.objects) {
+    if (object.kind !== "constraint" && object.kind !== "index")
+      continue;
+    if (object.identity.parent.name !== table)
+      continue;
+    rows.push(object);
+  }
+  if (columns.length > 0) {
+    const key = columns.join(",");
+    const hits = rows.filter((object) => object.definition.columns.join(",") === key);
+    if (constraint !== undefined) {
+      const named = hits.find((object) => object.identity.name === constraint);
+      if (named !== undefined)
+        return named;
+    }
+    const only = hits.length === 1 ? hits[0] : undefined;
+    if (only !== undefined)
+      return only;
+  }
+  if (constraint === undefined)
+    return;
+  return rows.find((object) => object.identity.name === constraint);
+}
+function reasonFromObject(schema, table, object, columns) {
+  if (object.kind === "index")
+    return object.identity.name;
+  const nameKey = object.definition.nameKey;
+  if (columns.length === 0)
+    return nameKey;
+  const sqlKey = object.definition.columns.join("_");
+  if (nameKey !== sqlKey || object.definition.columns.length < 2)
+    return nameKey;
+  return fieldKey(schema, table, object.definition.columns) ?? nameKey;
+}
+function fieldKey(schema, table, columns) {
+  let model;
+  for (const item of Object.values(schema.model)) {
+    if (item.sql === table) {
+      model = item;
+      break;
+    }
+  }
+  if (model === undefined)
+    return;
+  const fields = [];
+  for (const column of columns) {
+    const found = model.columns.find((item) => item.sql === column);
+    if (found === undefined)
+      return;
+    fields.push(found.field);
+  }
+  return fields.join("_");
+}
 function nameKeyOf(rest) {
   const tags = ["_fkey", "_check", "_key"];
   for (const tag of tags) {
@@ -212,6 +336,9 @@ function unquote(name) {
 }
 function summaryOf(kind, error, columns, fieldReason) {
   const label = labelOf(kind);
+  if (kind === "driver" && fieldReason === "not_owner") {
+    return "The application role cannot refresh a materialized view. Refresh runs as the owner, the migration role.";
+  }
   if (kind === "driver")
     return stripRowValues(error.message);
   const where = place(error.table, columns);

package/dist/shared/{gbtcc2d7.js → 67txcrcw.js}

@@ -41,6 +41,7 @@ var FIND_OPTIONS = [
   "include",
   "limit",
   "orderBy",
+  "search",
   "select",
   "route",
   "signal",
@@ -56,12 +57,15 @@ var ONE_OPTIONS = [
   "timeout",
   "where"
 ];
+var COUNT_OPTIONS = ["route", "search", "signal", "timeout", "where"];
 var FILTER_OPTIONS = ["route", "signal", "timeout", "where"];
 function readOptionNames(op) {
   if (op === "find")
     return FIND_OPTIONS;
   if (op === "one")
     return ONE_OPTIONS;
+  if (op === "count")
+    return COUNT_OPTIONS;
   return FILTER_OPTIONS;
 }
 var BASE_RULES = [
@@ -78,7 +82,19 @@ function readNeedsOperatorSql(schema, call) {
   if (operatorEmit !== undefined)
     return false;
   const table = indexes(schema).get(call.table);
-  return table !== undefined && needsOperatorSql(table, call.where);
+  if (table === undefined)
+    return false;
+  return needsOperatorSql(table, call.where) || orderHasRelevance(call.orderBy);
+}
+function orderHasRelevance(orderBy) {
+  if (!isRecord(orderBy))
+    return false;
+  for (const key of Object.keys(orderBy)) {
+    const value = orderBy[key];
+    if (isOperator(value) && operatorName(value) === "relevance")
+      return true;
+  }
+  return false;
 }
 function emitRelationFrom(schema, relation, child, sink, parent, alias, depth) {
   if (relation.through !== undefined) {
@@ -122,12 +138,12 @@ function needsOperatorSql(table, value, key) {
 function isTextColumn(dataType) {
   return dataType === "text" || dataType === "citext" || dataType.startsWith("varchar(") || dataType.startsWith("char(") || dataType.startsWith("character");
 }
-function emitLazy(column, ref, name, value, sink) {
+function emitLazy(column, ref, name, value, sink, order) {
   const emit = operatorEmit;
   if (emit === undefined) {
-    fail("OKM1121", `Operator ${name} on ${column.field} is not loaded.`);
+    fail2("OKM1121", `Operator ${name} on ${column.field} is not loaded.`);
   }
-  emit(column, ref, name, value, sink);
+  emit(column, ref, name, value, sink, order);
 }
 function verifyRead(schema, call) {
   if (!safetyInstalled())
@@ -208,7 +224,7 @@ function logicalIntent(call) {
     table: call.table,
     where: plain(call.where),
     select: call.select,
-    orderBy: call.orderBy,
+    orderBy: plain(call.orderBy),
     limit: call.limit,
     include: plain(call.include),
     all: call.all
@@ -261,7 +277,7 @@ function emitRead(schema, call, sink, outputs, hooks) {
     throwNamed2("OKM1120", call.table, [...indexes(schema).keys()], `Table ${call.table} is not in the schema. Accepted names: ${list([...indexes(schema).keys()])}.`);
   }
   if (call.build !== undefined) {
-    call.build(schema, table, sink, outputs, call);
+    call.build(schema, table, sink, outputs, call, hooks);
     return;
   }
   rejectOptions(call);
@@ -296,7 +312,7 @@ function emitRead(schema, call, sink, outputs, hooks) {
     column += 1;
   }
   if (call.include !== undefined && hooks === undefined) {
-    fail("OKM1120", "An include needs the include planner.");
+    fail2("OKM1120", "An include needs the include planner.");
   }
   const includes = hooks === undefined || call.include === undefined ? [] : hooks.read(schema, table, call.include, call.all);
   if (selected.length === 0 && includes.length === 0)
@@ -375,7 +391,7 @@ function emitWhere(schema, table, where, sink, alias, depth, appended = false, e
       continue;
     const joined = isOperator(part);
     if (!joined && !isRecord(part))
-      fail("OKM1121", WHERE_FIELDS);
+      fail2("OKM1121", WHERE_FIELDS);
     if (!joined && Object.keys(part).length === 0)
       continue;
     sink.text(started ? " and " : " where ");
@@ -389,7 +405,7 @@ function emitWhere(schema, table, where, sink, alias, depth, appended = false, e
 var WHERE_FIELDS = "where must be an object of fields. Wrap an object value with eq.";
 function emitAnd(schema, table, where, sink, alias, depth) {
   if (!isRecord(where)) {
-    fail("OKM1121", WHERE_FIELDS);
+    fail2("OKM1121", WHERE_FIELDS);
   }
   const keys = Object.keys(where);
   let wrote = false;
@@ -416,6 +432,7 @@ function emitPredicate(schema, table, key, value, sink, alias, depth) {
   if (column === undefined) {
     throwNamed2("OKM1120", key, table.names, `Field ${key} is not on ${table.model.name}. Accepted names: ${list(table.names)}.`);
   }
+  refuseHidden(column);
   sink.mark(`w:${key}`);
   emitOperand(schema, table, column, value, sink, alias, depth);
 }
@@ -445,7 +462,7 @@ function emitOperator(schema, table, column, ref, name, value, sink, alias, dept
     return;
   }
   if (column === undefined) {
-    fail("OKM1121", "That operator needs a field.");
+    fail2("OKM1121", "That operator needs a field.");
   }
   if (name === "not") {
     emitNot(schema, table, column, ref, value, sink, alias, depth);
@@ -463,7 +480,7 @@ function emitOperator(schema, table, column, ref, name, value, sink, alias, dept
   }
   if (name === "between") {
     if (!Array.isArray(value) || value.length !== 2) {
-      fail("OKM1121", `between on ${column.field} needs two values.`);
+      fail2("OKM1121", `between on ${column.field} needs two values.`);
     }
     sink.text(ref);
     sink.text(" between ");
@@ -478,7 +495,7 @@ function emitOperator(schema, table, column, ref, name, value, sink, alias, dept
   }
   if (TEXT_OPERATORS.includes(`,${name},`) && isTextColumn(column.dataType)) {
     if (typeof value !== "string") {
-      fail("OKM1121", `${name} on ${column.field} needs a string.`);
+      fail2("OKM1121", `${name} on ${column.field} needs a string.`);
     }
     sink.text(ref);
     if (name === "like" || name === "ilike") {
@@ -488,7 +505,7 @@ function emitOperator(schema, table, column, ref, name, value, sink, alias, dept
     }
     sink.text(" like ");
     if (name !== "startsWith" && name !== "endsWith" && name !== "contains") {
-      fail("OKM1121", `${name} on ${column.field} needs a string.`);
+      fail2("OKM1121", `${name} on ${column.field} needs a string.`);
     }
     sink.param(literalPattern(value, name));
     sink.text(" escape E'\\\\'");
@@ -516,7 +533,7 @@ function emitNot(schema, table, column, ref, value, sink, alias, depth) {
 }
 function emitIn(column, ref, name, value, sink) {
   if (!Array.isArray(value)) {
-    fail("OKM1121", `${name} on ${column.field} needs a list.`);
+    fail2("OKM1121", `${name} on ${column.field} needs a list.`);
   }
   sink.mark(`:${String(value.length)}`);
   if (value.length === 0) {
@@ -548,7 +565,7 @@ function emitOr(schema, table, value, sink, alias, depth) {
       sink.text(" or ");
     sink.text("(");
     if (!isRecord(branch)) {
-      fail("OKM1121", "or() branches must be where objects.");
+      fail2("OKM1121", "or() branches must be where objects.");
     }
     let wrote = false;
     for (const key of Object.keys(branch)) {
@@ -568,15 +585,15 @@ function emitOr(schema, table, value, sink, alias, depth) {
 }
 function emitRelationFilter(schema, relation, value, sink, alias, depth) {
   if (!isOperator(value)) {
-    fail("OKM1121", `Relation ${relation.name} needs has, none, or every.`);
+    fail2("OKM1121", `Relation ${relation.name} needs has, none, or every.`);
   }
   const name = operatorName(value);
   if (name !== "has" && name !== "none" && name !== "every") {
-    fail("OKM1121", `Relation ${relation.name} needs has, none, or every.`);
+    fail2("OKM1121", `Relation ${relation.name} needs has, none, or every.`);
   }
   const child = indexes(schema).get(relation.table);
   if (child === undefined) {
-    fail("OKM1120", `Relation ${relation.name} names ${relation.table}, which is not in the schema.`);
+    fail2("OKM1120", `Relation ${relation.name} names ${relation.table}, which is not in the schema.`);
   }
   const childAlias = `r${String(depth)}_${relation.name}`;
   sink.mark(`rel:${relation.name}:${name}`);
@@ -600,7 +617,7 @@ function emitOrder(table, orderBy, sink, alias) {
   if (orderBy === undefined)
     return;
   if (!isRecord(orderBy)) {
-    fail("OKM1120", "orderBy must be an object of fields.");
+    fail2("OKM1120", "orderBy must be an object of fields.");
   }
   const keys = Object.keys(orderBy);
   if (keys.length === 0)
@@ -614,9 +631,15 @@ function emitOrder(table, orderBy, sink, alias) {
     if (column === undefined) {
       throwNamed2("OKM1120", key, table.names, `Field ${key} is not on ${table.model.name}. Accepted names: ${list(table.names)}.`);
     }
-    const parsed = parseOrder(key, orderBy[key]);
+    refuseHidden(column);
+    const value = orderBy[key];
     if (index > 0)
       sink.text(", ");
+    if (isOperator(value) && operatorName(value) === "relevance") {
+      emitLazy(column, `${alias}.${quote(column.sql)}`, "relevance", operatorValue(value), sink, true);
+      continue;
+    }
+    const parsed = parseOrder(key, value);
     sink.text(alias);
     sink.text(".");
     sink.text(quote(column.sql));
@@ -642,6 +665,11 @@ function emitPrimaryOrder(table, sink, alias) {
     sink.text(" asc");
   }
 }
+function refuseHidden(column) {
+  if (column.hidden !== true)
+    return;
+  fail2("OKM1120", `Field ${column.field} is hidden.`, "Call hidden({ filterable: true }).");
+}
 function emitLimit(call, sink) {
   if (call.op === "one") {
     const ordered = call.orderBy !== undefined && isRecord(call.orderBy) && Object.keys(call.orderBy).length > 0;
@@ -653,7 +681,7 @@ function emitLimit(call, sink) {
     return;
   if (call.all !== undefined) {
     if (call.all.length === 0) {
-      fail("OKM1101", "find() .all needs a reason.");
+      fail2("OKM1101", "find() .all needs a reason.");
     }
     sink.mark(`all:${call.all}`);
     if (call.limit !== undefined) {
@@ -665,7 +693,7 @@ function emitLimit(call, sink) {
     return;
   }
   if (call.limit === undefined) {
-    fail("OKM1101", "find() needs a limit, or .all(reason) when the full set is intentional.");
+    fail2("OKM1101", "find() needs a limit, or .all(reason) when the full set is intentional.");
   }
   const limit = readLimit(call.limit);
   sink.text(" limit ");
@@ -682,12 +710,12 @@ function selectedColumns(table, select) {
     return columns;
   }
   if (!Array.isArray(select)) {
-    fail("OKM1120", "select must be a list of field names.");
+    fail2("OKM1120", "select must be a list of field names.");
   }
   const columns = [];
   for (const name of select) {
     if (typeof name !== "string") {
-      fail("OKM1120", "select must be a list of field names.");
+      fail2("OKM1120", "select must be a list of field names.");
     }
     const column = table.columns.get(name);
     if (column === undefined) {
@@ -705,17 +733,17 @@ function parseOrder(field, value) {
   if (isRecord(value)) {
     const dir = value.dir ?? value.direction;
     if (dir !== "asc" && dir !== "desc") {
-      fail("OKM1120", `orderBy ${field} must be asc or desc.`);
+      fail2("OKM1120", `orderBy ${field} must be asc or desc.`);
     }
     const nulls = value.nulls;
     if (nulls === undefined)
       return { dir, nulls: dir === "asc" ? "last" : "first" };
     if (nulls !== "first" && nulls !== "last") {
-      fail("OKM1120", `orderBy ${field} nulls must be first or last.`);
+      fail2("OKM1120", `orderBy ${field} nulls must be first or last.`);
     }
     return { dir, nulls };
   }
-  fail("OKM1120", `orderBy ${field} must be asc or desc.`);
+  fail2("OKM1120", `orderBy ${field} must be asc or desc.`);
 }
 function rejectOptions(call) {
   const accepted = readOptionNames(call.op);
@@ -732,11 +760,11 @@ function rejectOptions(call) {
     present.include = call.include;
   rejectKeys(present, accepted, call.op);
 }
-function rejectKeys(value, accepted, where) {
+function rejectKeys(value, accepted, where, search) {
   for (const key of Object.keys(value)) {
     if (accepted.includes(key))
       continue;
-    throwNamed2("OKM1120", key, accepted, `Option ${key} is not accepted by ${where}. Accepted options: ${list(accepted)}.`);
+    throwNamed2("OKM1120", key, accepted, key === "search" && search === true ? `${where}() does not take search. Pass search to find or count.` : `Option ${key} is not accepted by ${where}. Accepted options: ${list(accepted)}.`);
   }
 }
 function readLimit(value) {
@@ -747,7 +775,7 @@ function readLimit(value) {
 }
 function requireValue(column, value) {
   if (value === undefined || value === null) {
-    fail("OKM1121", `Field ${column.field} needs a value.`);
+    fail2("OKM1121", `Field ${column.field} needs a value.`);
   }
   if (typeof value === "object")
     takeObject(column, value);
@@ -755,7 +783,7 @@ function requireValue(column, value) {
 }
 function takeObject(column, value, bare = false) {
   if (bare || !column.accepts?.includes({}.toString.call(value).slice(8, -1))) {
-    fail("OKM1121", `Field ${column.field} rejects that object.`);
+    fail2("OKM1121", `Field ${column.field} rejects that object.`);
   }
 }
 function projectExpr(sql, dataType) {
@@ -846,38 +874,6 @@ function list(names) {
 function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value) && !isOperator(value);
 }
-function effectivePredicate(where) {
-  if (where === undefined)
-    return false;
-  if (isOperator(where)) {
-    const name = operatorName(where);
-    const value = operatorValue(where);
-    if (name === "or") {
-      if (!Array.isArray(value))
-        orFail(false);
-      if (value.length === 0)
-        return true;
-      for (const branch of value) {
-        if (!effectivePredicate(branch))
-          orFail(true);
-      }
-      return true;
-    }
-    if (name === "and") {
-      return Array.isArray(value) && value.some((part) => effectivePredicate(part));
-    }
-    if (name === "not")
-      return effectivePredicate(value);
-    return true;
-  }
-  if (!isRecord(where))
-    return true;
-  for (const key of Object.keys(where)) {
-    if (where[key] !== undefined)
-      return true;
-  }
-  return false;
-}
 function orFail(empty) {
   throw new OkmError2("OKM1121", empty ? "or() branch is empty." : "Pass an array: or([a, b]).", {
     fix: {
@@ -892,8 +888,8 @@ var FAIL_FIX = {
 function registerFailFix(code, summary) {
   FAIL_FIX[code] = summary;
 }
-function fail(code, message) {
-  const summary = FAIL_FIX[code];
+function fail2(code, message, fix) {
+  const summary = fix ?? FAIL_FIX[code];
   throw new OkmError2(code, message, summary === undefined ? undefined : { fix: { summary } });
 }
 function plain(value) {
@@ -916,4 +912,4 @@ function hasMany(include) {
   return Object.keys(include).length > 0;
 }
 
-export { withRowFilters, installArchiveInspect, archiveRules, readOptionNames, installOperatorSql, readNeedsOperatorSql, emitRelationFrom, bindCall, compileCall, decodeResult, logicalIntent, appliedRules, emitJoin, emitWhere, emitOrder, emitPrimaryOrder, selectedColumns, parseOrder, rejectKeys, readLimit, takeObject, projectExpr, jsonExpr, decodeRow, cell, indexes, quote, list, isRecord, effectivePredicate, registerFailFix, fail };
+export { withRowFilters, installArchiveInspect, archiveRules, readOptionNames, installOperatorSql, readNeedsOperatorSql, orderHasRelevance, emitRelationFrom, needsOperatorSql, bindCall, compileCall, decodeResult, logicalIntent, appliedRules, emitJoin, emitWhere, emitOrder, emitPrimaryOrder, refuseHidden, emitLimit, selectedColumns, parseOrder, rejectKeys, readLimit, takeObject, projectExpr, jsonExpr, decodeRow, cell, indexes, quote, list, isRecord, orFail, registerFailFix, fail2 };

package/dist/shared/79dt02vc.js

@@ -0,0 +1,12 @@
+import {
+  rejectUncancellable
+} from "./kb2sdhfb.js";
+
+// src/adapters/pg/no-inflight-timeout.ts
+function noTimeout(options) {
+  if ((options?.timeout ?? 0) <= 0)
+    return;
+  return rejectUncancellable();
+}
+
+export { noTimeout };