@vibeorm/schema 2.0.0 → 2.1.0

package/dist/index.js

@@ -16,14 +16,75 @@ function providerToDialect(params) {
 function isEnumType(fieldType) {
   return typeof fieldType === "object" && "enum" in fieldType;
 }
+function fieldTypeIdentity(params) {
+  const { type } = params;
+  return isEnumType(type) ? `enum:${type.enum}` : type;
+}
 var ENUM_STORAGES = ["database", "string"];
 function enumStorageOf(params) {
   return params.enumDef.storage ?? "database";
 }
+// packages/schema/src/predicate.ts
+var PREDICATE_COMPARISON_OPS = [
+  "eq",
+  "ne",
+  "gt",
+  "gte",
+  "lt",
+  "lte"
+];
+function isPredicateFieldRef(operand) {
+  return operand.kind === "field";
+}
+function predicateFieldNames(params) {
+  const seen = new Set;
+  const walk = (node) => {
+    switch (node.kind) {
+      case "compare":
+        seen.add(node.left.name);
+        if (isPredicateFieldRef(node.right))
+          seen.add(node.right.name);
+        return;
+      case "inList":
+      case "isNull":
+        seen.add(node.field.name);
+        return;
+      case "and":
+      case "or":
+        for (const operand of node.operands)
+          walk(operand);
+        return;
+      case "not":
+        walk(node.operand);
+        return;
+    }
+  };
+  walk(params.predicate);
+  return [...seen];
+}
+function predicateKey(params) {
+  const encode = (node) => {
+    switch (node.kind) {
+      case "compare":
+        return `cmp(${node.op},${node.left.name},${isPredicateFieldRef(node.right) ? `f:${node.right.name}` : `v:${typeof node.right.value}:${String(node.right.value)}`})`;
+      case "inList":
+        return `in${node.negate === true ? "!" : ""}(${node.field.name},[${node.values.map((entry) => `${typeof entry.value}:${String(entry.value)}`).join("|")}])`;
+      case "isNull":
+        return `null${node.negate === true ? "!" : ""}(${node.field.name})`;
+      case "and":
+      case "or":
+        return `${node.kind}(${node.operands.map(encode).join(",")})`;
+      case "not":
+        return `not(${encode(node.operand)})`;
+    }
+  };
+  return encode(params.predicate);
+}
 // packages/schema/src/errors.ts
 var VIBE_ERROR_CODES = [
   "VIBE_NOT_FOUND",
   "VIBE_UNIQUE_VIOLATION",
+  "VIBE_EXCLUSION_VIOLATION",
   "VIBE_FK_VIOLATION",
   "VIBE_VALIDATION",
   "VIBE_DATA_INVALID",
@@ -33,7 +94,9 @@ var VIBE_ERROR_CODES = [
   "VIBE_CONFIG",
   "VIBE_MIGRATION",
   "VIBE_TRANSACTION",
+  "VIBE_LOCK_NOT_AVAILABLE",
   "VIBE_SCOPED",
+  "VIBE_READ_ONLY",
   "VIBE_RLS_CONTEXT",
   "VIBE_PERMISSION_DENIED",
   "VIBE_ADAPTER",
@@ -137,6 +200,100 @@ class ScopedQueryError extends VibeError {
     this.reason = params.reason;
   }
 }
+var READ_ONLY_REFUSAL_REASONS = [
+  "write",
+  "raw",
+  "control",
+  "unclassified",
+  "foreign_operation"
+];
+
+class ReadOnlyClientError extends VibeError {
+  path;
+  reason;
+  constructor(params) {
+    super({
+      code: "VIBE_READ_ONLY",
+      message: params.message,
+      meta: { ...params.meta, path: params.path, reason: params.reason }
+    });
+    this.name = "ReadOnlyClientError";
+    this.path = params.path;
+    this.reason = params.reason;
+  }
+}
+
+// packages/schema/src/migration-objects.ts
+function sqlObjectKey(params) {
+  const object = params.identity;
+  switch (object.kind) {
+    case "table":
+    case "view":
+    case "sequence":
+    case "postgresExtension":
+      return JSON.stringify([object.kind, object.name.namespace, object.name.name]);
+    case "function":
+      return JSON.stringify([object.kind, object.name.namespace, object.name.name, object.argumentTypes.map((type) => [type.namespace, type.name])]);
+    case "index":
+    case "trigger":
+      return JSON.stringify([object.kind, object.table.namespace, object.table.name, object.name]);
+    case "constraint":
+      return JSON.stringify([object.kind, object.table.namespace, object.table.name, object.name, object.constraintType]);
+    case "column":
+    case "columnDefault":
+    case "generatedColumn":
+      return JSON.stringify([object.kind, object.table.namespace, object.table.name, object.column]);
+  }
+}
+function record(value) {
+  return value !== null && typeof value === "object" && !Array.isArray(value);
+}
+function name(value) {
+  return record(value) && typeof value.namespace === "string" && value.namespace.length > 0 && typeof value.name === "string" && value.name.length > 0;
+}
+function isSqlObjectIdentity(value) {
+  if (!record(value))
+    return false;
+  switch (value.kind) {
+    case "table":
+    case "view":
+    case "sequence":
+    case "postgresExtension":
+      return name(value.name);
+    case "function":
+      return name(value.name) && Array.isArray(value.argumentTypes) && value.argumentTypes.every(name);
+    case "index":
+    case "trigger":
+      return name(value.table) && typeof value.name === "string" && value.name.length > 0;
+    case "constraint":
+      return name(value.table) && typeof value.name === "string" && value.name.length > 0 && ["check", "foreignKey", "exclusion", "unique", "primaryKey"].includes(String(value.constraintType));
+    case "column":
+    case "columnDefault":
+    case "generatedColumn":
+      return name(value.table) && typeof value.column === "string" && value.column.length > 0;
+    default:
+      return false;
+  }
+}
+function isSqlObjectDefinition(value) {
+  return record(value) && value.format === "catalog-v1" && isSqlObjectIdentity(value.identity) && record(value.facts) && Object.keys(value.facts).length > 0 && Object.values(value.facts).every((fact) => fact === null || typeof fact === "string" || typeof fact === "boolean" || typeof fact === "number" && Number.isFinite(fact) || Array.isArray(fact) && fact.every((entry) => typeof entry === "string")) && Array.isArray(value.dependencies) && value.dependencies.every(isSqlObjectIdentity);
+}
+function assertMigrationObjects(params) {
+  if (!Array.isArray(params.objects))
+    throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "migrationObjects must be an array" });
+  const ids = new Set;
+  const owners = new Set;
+  for (const object of params.objects) {
+    if (!record(object) || typeof object.id !== "string" || object.id.length === 0 || !["postgres", "sqlite", "mysql"].includes(String(object.dialect)) || !isSqlObjectIdentity(object.identity) || !Array.isArray(object.create) || !object.create.every((sql) => typeof sql === "string") || !Array.isArray(object.drop) || !object.drop.every((sql) => typeof sql === "string") || !Array.isArray(object.dependsOn) || !object.dependsOn.every(isSqlObjectIdentity) || object.expected !== undefined && (!isSqlObjectDefinition(object.expected) || sqlObjectKey({ identity: object.expected.identity }) !== sqlObjectKey({ identity: object.identity }))) {
+      throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Invalid migration-only object declaration" });
+    }
+    const key = sqlObjectKey({ identity: object.identity });
+    if (ids.has(object.id) || owners.has(key))
+      throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Duplicate migration object identity or id", meta: { id: object.id, key } });
+    ids.add(object.id);
+    owners.add(key);
+  }
+}
 // packages/schema/src/prisma-literal.ts
 var STRING_ESCAPES = {
   '"': '"',
@@ -255,6 +412,8 @@ var RESERVED_CLIENT_NAMES = [
   "$connect",
   "$disconnect",
   "$transaction",
+  "$querySql",
+  "$executeSql",
   "$queryRaw",
   "$queryRawUnsafe",
   "$executeRaw",
@@ -264,7 +423,8 @@ var RESERVED_CLIENT_NAMES = [
   "$defineView",
   "$withPolicy",
   "$bypassPolicy",
-  "$scoped"
+  "$scoped",
+  "$readOnly"
 ];
 var RESERVED_COLUMN_PREFIX = "__vibe_";
 function isReservedDelegateName(params) {
@@ -302,26 +462,26 @@ function extensionManifestEntry(params) {
 }
 var EXTENSION_NAME_PATTERN = /^[a-z][a-zA-Z0-9]*$/;
 function defineExtension(extension) {
-  const { name } = extension;
-  if (!EXTENSION_NAME_PATTERN.test(name)) {
+  const { name: name2 } = extension;
+  if (!EXTENSION_NAME_PATTERN.test(name2)) {
     throw new VibeError({
       code: "VIBE_CONFIG",
-      message: `extension name "${name}" is invalid \u2014 must match ${EXTENSION_NAME_PATTERN} (it becomes a client identifier)`,
-      meta: { name }
+      message: `extension name "${name2}" is invalid \u2014 must match ${EXTENSION_NAME_PATTERN} (it becomes a client identifier)`,
+      meta: { name: name2 }
     });
   }
-  if (RESERVED_DELEGATE_NAMES.includes(name)) {
+  if (RESERVED_DELEGATE_NAMES.includes(name2)) {
     throw new VibeError({
       code: "VIBE_CONFIG",
-      message: `extension name "${name}" collides with a core delegate method`,
-      meta: { name }
+      message: `extension name "${name2}" collides with a core delegate method`,
+      meta: { name: name2 }
     });
   }
-  if (RESERVED_CLIENT_NAMES.includes(`$${name}`)) {
+  if (RESERVED_CLIENT_NAMES.includes(`$${name2}`)) {
     throw new VibeError({
       code: "VIBE_CONFIG",
-      message: `extension name "${name}" collides with the core client method "$${name}"`,
-      meta: { name }
+      message: `extension name "${name2}" collides with the core client method "$${name2}"`,
+      meta: { name: name2 }
     });
   }
   return Object.freeze(extension);
@@ -545,6 +705,9 @@ function scalarListDefault(params) {
 
 // packages/schema/src/capabilities.ts
 var POSTGRES_CAPABILITIES = Object.freeze({
+  exclusionConstraints: true,
+  exclusionExtensions: Object.freeze(["btree_gist"]),
+  checkNormalization: "rollback",
   nativeRowLevelSecurity: true,
   returning: true,
   scalarArrays: true,
@@ -558,9 +721,15 @@ var POSTGRES_CAPABILITIES = Object.freeze({
   createManyAndReturn: true,
   jsonColumnType: true,
   orderByNulls: true,
-  fullTextEngines: Object.freeze(["bm25", "tsvector"])
+  fullTextEngines: Object.freeze(["bm25", "tsvector"]),
+  rowLockStrengths: Object.freeze(["update", "noKeyUpdate", "share", "keyShare"]),
+  rowLockWaitPolicies: Object.freeze(["wait", "nowait", "skipLocked"]),
+  advisoryLocks: true
 });
 var SQLITE_CAPABILITIES = Object.freeze({
+  exclusionConstraints: false,
+  exclusionExtensions: Object.freeze([]),
+  checkNormalization: "sourceText",
   nativeRowLevelSecurity: false,
   returning: true,
   scalarArrays: false,
@@ -574,9 +743,15 @@ var SQLITE_CAPABILITIES = Object.freeze({
   createManyAndReturn: true,
   jsonColumnType: false,
   orderByNulls: true,
-  fullTextEngines: Object.freeze(["fts5"])
+  fullTextEngines: Object.freeze(["fts5"]),
+  rowLockStrengths: Object.freeze([]),
+  rowLockWaitPolicies: Object.freeze([]),
+  advisoryLocks: false
 });
 var MYSQL_CAPABILITIES = Object.freeze({
+  exclusionConstraints: false,
+  exclusionExtensions: Object.freeze([]),
+  checkNormalization: "temporary",
   nativeRowLevelSecurity: false,
   returning: false,
   scalarArrays: false,
@@ -590,7 +765,10 @@ var MYSQL_CAPABILITIES = Object.freeze({
   createManyAndReturn: false,
   jsonColumnType: true,
   orderByNulls: false,
-  fullTextEngines: Object.freeze(["fulltext"])
+  fullTextEngines: Object.freeze(["fulltext"]),
+  rowLockStrengths: Object.freeze(["update", "share"]),
+  rowLockWaitPolicies: Object.freeze(["wait", "nowait", "skipLocked"]),
+  advisoryLocks: false
 });
 var DIALECT_CAPABILITIES = Object.freeze({
   postgres: POSTGRES_CAPABILITIES,
@@ -600,6 +778,15 @@ var DIALECT_CAPABILITIES = Object.freeze({
 
 // packages/schema/src/validate.ts
 var RESERVED_ENUM_NAMES = [
+  "sql",
+  "decode",
+  "sqlProjection",
+  "sqlModels",
+  "createSqlModel",
+  "SqlColumn",
+  "SqlFragment",
+  "ResultDecoder",
+  "ExtendedDateTime",
   "enumValidators",
   "enumValidator",
   "OmittedKeys",
@@ -641,6 +828,7 @@ var RESERVED_ENUM_NAMES = [
   "SortOrderWithNulls",
   "KeysetToken",
   "KeysetOptions",
+  "RowLockRequest",
   "JsonValue",
   "InputJsonValue",
   "InputJsonArray",
@@ -653,6 +841,9 @@ var RESERVED_ENUM_NAMES = [
   "ScopedClientInstance",
   "ScopedModelsConfig",
   "ScopedNestedMode",
+  "VibeTransactionClientInstance",
+  "ScopedTransactionClientInstance",
+  "ReadOnlyClientInstance",
   "ViewClient",
   "ViewDefinitionInput",
   "ViewRow",
@@ -662,6 +853,7 @@ var RESERVED_ENUM_NAMES = [
   "QueryEvent",
   "Skip",
   "TransactionOptions",
+  "AdvisoryLockOptions",
   "SchemaIR",
   "VibeExtension",
   "ComputedConfig",
@@ -695,6 +887,9 @@ var GENERATED_TYPE_NAMES = {
     "WhereInput",
     "WhereUniqueInput",
     "OrderByInput",
+    "ScalarOrderByInput",
+    "RelationOrderByInput",
+    "RelationFindManyArgs",
     "CreateInput",
     "UncheckedCreateInput",
     "CreateManyInput",
@@ -750,7 +945,8 @@ var GENERATED_TYPE_NAMES = {
     "ViewRelationResult",
     "ViewIncludeResult",
     "ViewResult",
-    "ViewDelegate"
+    "ViewDelegate",
+    "ReadOnlyDelegate"
   ],
   nestedPrefixes: [
     "Create",
@@ -769,10 +965,11 @@ var GENERATED_TYPE_NAMES = {
 };
 function validateGeneratedNames(params) {
   const { schema, issues } = params;
-  const owners = new Map(RESERVED_ENUM_NAMES.map((name) => [name, "generated client"]));
+  const owners = new Map(RESERVED_ENUM_NAMES.map((name2) => [name2, "generated client"]));
   if (schema.rls !== undefined) {
     owners.set("RlsContext", "native RLS client");
     owners.set("BoundVibeClientInstance", "native RLS client");
+    owners.set("BoundVibeTransactionClientInstance", "native RLS client");
   }
   const register = (params2) => {
     const previous = owners.get(params2.name);
@@ -1157,6 +1354,15 @@ function validateModel(params) {
       });
     }
     checkNames.add(check.name);
+    if (check.predicate !== undefined) {
+      validatePredicateFields({
+        predicate: check.predicate,
+        model,
+        fieldNames,
+        site: `CHECK "${check.name}"`,
+        issues
+      });
+    }
   }
   for (const index of model.indexes) {
     for (const indexField of index.fields) {
@@ -1169,10 +1375,66 @@ function validateModel(params) {
         });
       }
     }
+    if (index.wherePredicate !== undefined) {
+      validatePredicateFields({
+        predicate: index.wherePredicate,
+        model,
+        fieldNames,
+        site: `partial index on [${index.fields.map((entry) => entry.name).join(", ")}]`,
+        issues
+      });
+    }
+  }
+}
+function validatePredicateFields(params) {
+  const { predicate, model, fieldNames, site, issues } = params;
+  for (const name2 of predicateFieldNames({ predicate })) {
+    if (!fieldNames.has(name2)) {
+      issues.push({
+        rule: "predicate-unknown-field",
+        message: `${site} on "${model.name}" references unknown field "${name2}"`,
+        model: model.name,
+        field: name2
+      });
+      continue;
+    }
+    if (model.fields.find((field) => field.name === name2)?.isList === true) {
+      issues.push({
+        rule: "predicate-list-field",
+        message: `${site} on "${model.name}" compares scalar list "${name2}" \u2014 use a raw expression for array operators`,
+        model: model.name,
+        field: name2
+      });
+    }
   }
 }
 function assertValidSchemaIR(params) {
   const dialect = providerToDialect({ provider: params.schema.datasource.provider });
+  for (const model of params.schema.models) {
+    if (model.exclusions !== undefined && !Array.isArray(model.exclusions))
+      throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Exclusions must be an array", meta: { rule: "exclusion-definition" } });
+    if ((model.exclusions?.length ?? 0) === 0)
+      continue;
+    if (!DIALECT_CAPABILITIES[dialect].exclusionConstraints)
+      throw unsupportedCapability({ dialect, feature: "exclusionConstraints" });
+    const names = new Set;
+    const exclusions = model.exclusions ?? [];
+    for (const exclusion of exclusions) {
+      if (exclusion === null || typeof exclusion !== "object")
+        throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Invalid exclusion declaration", meta: { rule: "exclusion-definition" } });
+      const source = exclusion.source;
+      if (source !== undefined) {
+        const references = [...source.keys.flatMap((key) => ("field" in key) ? [key.field] : key.fields), ...[source.range.lower, source.range.upper].flatMap((endpoint) => ("field" in endpoint) ? [endpoint.field] : []), ...source.where === undefined ? [] : predicateFieldNames({ predicate: source.where })];
+        if (references.some((name2) => !model.fields.some((field) => field.name === name2 && !field.isList)))
+          throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Exclusion references an unknown or list field", meta: { rule: "exclusion-field", model: model.name } });
+      }
+      if (!exclusion.name || names.has(exclusion.name) || typeof exclusion.definition !== "string" || !exclusion.definition.startsWith("EXCLUDE USING ") || !Array.isArray(exclusion.requiredExtensions) || exclusion.requiredExtensions.some((name2) => name2 !== "btree_gist"))
+        throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: "Invalid exclusion declaration", meta: { rule: "exclusion-definition", model: model.name } });
+      names.add(exclusion.name);
+    }
+  }
+  if (params.schema.migrationObjects !== undefined)
+    assertMigrationObjects({ objects: params.schema.migrationObjects });
   if (params.schema.rls !== undefined && !DIALECT_CAPABILITIES[dialect].nativeRowLevelSecurity) {
     throw unsupportedCapability({ dialect, feature: "nativeRowLevelSecurity" });
   }
@@ -1188,8 +1450,8 @@ function assertValidSchemaIR(params) {
           throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: `List default on non-list field ${model.name}.${field.name}` });
         scalarListDefault({ type: field.type, values: field.default.values });
         if (isEnumType(field.type)) {
-          const name = field.type.enum;
-          const members = params.schema.enums.find((entry) => entry.name === name)?.values ?? [];
+          const name2 = field.type.enum;
+          const members = params.schema.enums.find((entry) => entry.name === name2)?.values ?? [];
           if (field.default.values.some((value) => typeof value !== "string" || !members.includes(value)))
             throw new VibeError({ code: "VIBE_SCHEMA_INVALID", message: `Invalid enum-list default on ${model.name}.${field.name}` });
         }
@@ -1289,10 +1551,10 @@ function validateNativeRls(params) {
     tables.add(table);
     const columns = new Set;
     for (const field of model.fields) {
-      const name = field.dbName ?? field.name;
-      if (columns.has(name))
-        add({ rule: "rls-duplicate-column", message: `RLS model ${model.name} repeats physical column ${name}`, field: field.name });
-      columns.add(name);
+      const name2 = field.dbName ?? field.name;
+      if (columns.has(name2))
+        add({ rule: "rls-duplicate-column", message: `RLS model ${model.name} repeats physical column ${name2}`, field: field.name });
+      columns.add(name2);
     }
     if (model.policy !== undefined)
       add({ rule: "rls-policy-conflict", message: "Native RLS cannot combine with application-level ModelIR.policy" });
@@ -1345,7 +1607,7 @@ function validateNativeRls(params) {
         add({ rule: "rls-invalid-through", message: "Native RLS through requires a to-one relation with an actual, complete foreign key on this model" });
         continue;
       }
-      if (relation.isOptional || relation.fields?.some((name) => model.fields.find((field) => field.name === name)?.isOptional)) {
+      if (relation.isOptional || relation.fields?.some((name2) => model.fields.find((field) => field.name === name2)?.isOptional)) {
         add({ rule: "rls-nullable-through", message: "Native RLS through requires a non-nullable parent relation and foreign key; NULL parent links cannot satisfy WITH CHECK. Make the link required or use a direct ownership rule", field: relation.name });
         continue;
       }
@@ -1377,8 +1639,8 @@ function validRlsForeignKey(params) {
   const refs = relation.references;
   if (fields === undefined || refs === undefined || fields.length === 0 || fields.length !== refs.length || new Set(fields).size !== fields.length || new Set(refs).size !== refs.length)
     return false;
-  const validFields = fields.every((name, index) => {
-    const field = model.fields.find((f) => f.name === name);
+  const validFields = fields.every((name2, index) => {
+    const field = model.fields.find((f) => f.name === name2);
     const ref = target.fields.find((f) => f.name === refs[index]);
     return field !== undefined && ref !== undefined && !field.isList && !ref.isList && !field.isUnsupported && !ref.isUnsupported && (field.type === ref.type || isEnumType(field.type) && isEnumType(ref.type) && field.type.enum === ref.type.enum);
   });
@@ -1387,7 +1649,7 @@ function validRlsForeignKey(params) {
     ...target.primaryKey === undefined ? [] : [target.primaryKey.fields],
     ...target.indexes.filter((index) => index.kind === "unique" && index.where === undefined).map((index) => index.fields.map((f) => f.name))
   ];
-  return validFields && uniqueSets.some((set) => set.length === refs.length && set.every((name) => refs.includes(name)));
+  return validFields && uniqueSets.some((set) => set.length === refs.length && set.every((name2) => refs.includes(name2)));
 }
 // packages/schema/src/m2m.ts
 function implicitJoinTable(params) {
@@ -1408,17 +1670,24 @@ export {
   validateRlsContextIR,
   validateComputedConfig,
   unsupportedCapability,
+  sqlObjectKey,
   serializeJsonDefault,
   scalarListDefault,
   providerToDialect,
+  predicateKey,
+  predicateFieldNames,
   mergeExtensionDeclarations,
+  isSqlObjectIdentity,
+  isSqlObjectDefinition,
   isReservedDelegateName,
   isReservedClientName,
+  isPredicateFieldRef,
   isImplicitManyToManyRelation,
   isEnumType,
   invalidStoredData,
   internalError,
   implicitJoinTable,
+  fieldTypeIdentity,
   extensionOptionsHash,
   extensionManifestEntry,
   extensionDeclarations,
@@ -1430,16 +1699,20 @@ export {
   buildExtensionRegistry,
   buildComputedManifest,
   assertValidSchemaIR,
+  assertMigrationObjects,
   VibeError,
   VIBE_ERROR_CODES,
   ScopedQueryError,
   SQLITE_CAPABILITIES,
   SCOPED_REFUSAL_REASONS,
   RlsContextError,
+  ReadOnlyClientError,
   RLS_CONTEXT_REASONS,
   RESERVED_ENUM_NAMES,
   RESERVED_DELEGATE_NAMES,
   RESERVED_CLIENT_NAMES,
+  READ_ONLY_REFUSAL_REASONS,
+  PREDICATE_COMPARISON_OPS,
   POSTGRES_CAPABILITIES,
   MYSQL_CAPABILITIES,
   ENUM_STORAGES,
@@ -1448,4 +1721,4 @@ export {
   DIALECTS
 };
 
-//# debugId=E40659BCEBFDD98E64756E2164756E21
+//# debugId=D5526EF61FB41A9D64756E2164756E21