@suss/contract-prisma 0.34.0 → 0.35.0

package/README.md

@@ -17,15 +17,37 @@ One `library`-kind summary per `model` and per `view`, with a storage boundary b
 The behavior is in `metadata.storageContract`:
 
 - `fieldSet: "exhaustive"`. A Prisma model declares every column its table has, so a column the code touches that is missing from this list is unknown, and not merely unlisted.
-- `fields`, one entry per column, with the Prisma type, whether the field is optional (`nullable`), and `primary` / `unique` from the `@id` and `@unique` field attributes. Scalar fields (`Int`, `BigInt`, `Float`, `Decimal`, `String`, `Boolean`, `DateTime`, `Json`, `Bytes`) and enum fields are columns.
+- `fields`, one entry per column. Scalar fields (`Int`, `BigInt`, `Float`, `Decimal`, `String`, `Boolean`, `DateTime`, `Json`, `Bytes`), enum fields, and lists of either are columns. Each column has:
+  - `name`, the field name the client uses, and `column`, the name `@map("...")` gives the column in the database, when that is different.
+  - `type`, the Prisma type, or the native type when the field has one, such as `@db.VarChar` for `String @db.VarChar(255)`. The length is left out. Every enum field has the type `enum`, and a list adds `[]`, as in `String[]`.
+  - `nullable`, from whether the field is optional. A list works differently, as described below.
+  - `primary` from `@id`, or from being listed in the model's `@@id([...])`, and `unique` from `@unique`.
+  - `default`, whether the database fills the column when a create leaves it out. See below.
+  - `foreignKey`, the table of the model a relation reaches, on each column its `@relation(fields: [...])` lists. The table is the target's `@@map` name, or the model name when it has none.
 - Relation fields appear too, marked `derived`, because the Prisma client accepts them in an `include` or a `select` even though no column of that name exists. Leaving them out of a contract marked exhaustive would report working code as reading an undeclared field. When the model stores the foreign key, the columns listed in `@relation(fields: [...])` are included as `relationKey`. Prisma only allows that argument on one side of a relation, so the other side, and every implicit many-to-many, has no key.
 - A many-to-many relation with no explicit join model gets a `joinContainer` entry instead, which gives the table Prisma manages for it. See below.
 - A model with any relation also gets a derived `_count` entry, since the client exposes relation counts under that name.
 - `indexes`, from `@@index([...])` (not unique), `@@unique([...])` and `@@id([...])` (both unique).
 - `physicalTable`, when `@@map("...")` gives the table a SQL name different from the model name. That lets it pair with code that uses SQL names directly, such as Drizzle's `pgTable("users")` or a raw query.
+- `origin: "migrations"`, when a folder next to the schema has Prisma Migrate's `migration_lock.toml` in it. For a schema split over a folder, suss looks in the folder above it too. It means Prisma's own migrations made the tables. When another declaration of the same table disagrees with this one, the comparison takes this schema as the provider, unless the other one is a dump of the database.
 
 These summaries have no inputs and no transitions. A table is a set of columns the code has to agree with, and it does not return anything the way a function does. Confidence is `declared` at `high`, since the schema states all of this explicitly.
 
+### Defaults, and who fills them
+
+`@default(...)` means different things depending on what it calls. Prisma's migrations turn some of them into a database default, and the client fills some of them in itself before it sends the insert:
+
+| `@default` | In the migration SQL | Sent by the client on create | `default` |
+|---|---|---|---|
+| `autoincrement()`, `dbgenerated(...)` | `SERIAL`, `DEFAULT <expression>` | no | `true` |
+| `uuid()`, `cuid()`, `nanoid()`, `ulid()` | nothing | yes | `false` |
+| `now()`, a literal such as `false` or `"pending"` | `DEFAULT CURRENT_TIMESTAMP`, `DEFAULT false` | yes | `true` with migrations, otherwise left out |
+| none, or only `@updatedAt` | nothing | `@updatedAt` only | `false` |
+
+A literal or `now()` is a database default only when Prisma's migrations made the table. In a schema written to match a database something else manages, the client sends the value on every create, so the schema says nothing about whether the database has a default there. The reader leaves `default` out on those columns, and a comparison skips it.
+
+A scalar list has the same problem with `nullable`. Prisma's migrations make a list column nullable, and the client reads a NULL there as an empty list. So a list column has `nullable: true` when Prisma's migrations made the table, and no `nullable` otherwise.
+
 ### Implicit many-to-many join tables
 
 When two list fields point at each other and neither side declares `@relation(fields: [...])`, that is Prisma's implicit many-to-many. Prisma creates and manages the join table itself, and the schema never declares a model for it. This reader produces a summary for that table too, with the boundary Prisma would create. The container is `_Name` when the fields have `@relation("Name")`, and otherwise `_FirstToSecond`, with the two model names in alphabetical order. The table has two columns, `A` and `B`, keyed to whichever model sorts first and second. Each side of the relation gets `joinContainer` set to that table's container name, so a `connect`, `disconnect` or `set` through the field counts as a write there and is not lost.
@@ -36,8 +58,9 @@ An explicit join model, the kind written out by hand to add extra columns, alrea
 
 - **Non-relational providers.** A MongoDB schema comes back empty. Document storage is separate work.
 - **Composite types and unsupported field types.** A field whose type is not a scalar, an enum or another model is skipped, so the reader never guesses. That covers `Unsupported(...)`, a Mongo composite type, and a typo.
-- **Array scalar fields.** `String[]` is dropped along with relation lists, because the walk treats every array field as a relation array.
-- **Native type attributes.** `@db.VarChar(255)` and similar are not recorded. The field's Prisma type is what comes through.
+- **Native type arguments and enum values.** `@db.VarChar(255)` comes through as `@db.VarChar`, and an enum field as `enum`, without its values.
+- **Postgres schemas other than the default.** `@@schema("...")` is not read, so a model in another schema has its bare table name.
+- **`migrations.path` in `prisma.config.ts`.** Only a migrations folder next to the schema sets `origin`.
 - **`generator` blocks, the datasource URL, and relation cardinality** as behavior of their own.
 
 ## Worked example
@@ -64,7 +87,9 @@ suss contract --from prisma prisma/schema.prisma -o summaries/db.json
 suss check summaries/db.json summaries/app.json
 ```
 
-The `User` summary declares `id` (primary), `email` (unique), a nullable `name`, the derived `posts` relation, a derived `_count`, an index on `email`, and `physicalTable: "users"`.
+The `User` summary declares `id` (primary, with a database default), `email` (unique), a nullable `name`, the derived `posts` relation, a derived `_count`, an index on `email`, and `physicalTable: "users"`.
+
+A schema split over several files is read as one, the way Prisma reads it. Pass the folder, and every `.prisma` file below it is read. Pass one file, and when it is the only file in its folder with a datasource, the other `.prisma` files in that folder are read with it, since a file with no datasource cannot be a schema on its own. Each model's summary records the file the model is in, and every model gets the storage system of the one datasource.
 
 Or from code:
 

package/dist/index.cjs

@@ -31,13 +31,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   prismaSchemaFileToSummaries: () => prismaSchemaFileToSummaries,
-  prismaSchemaToSummaries: () => prismaSchemaToSummaries
+  prismaSchemaFiles: () => prismaSchemaFiles,
+  prismaSchemaToSummaries: () => prismaSchemaToSummaries,
+  prismaStorageSystem: () => prismaStorageSystem
 });
 module.exports = __toCommonJS(index_exports);
 var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_prisma_ast = require("@mrleebo/prisma-ast");
 var import_behavioral_ir = require("@suss/behavioral-ir");
+var import_files = require("@suss/behavioral-ir/files");
 var PRISMA_SCALARS = /* @__PURE__ */ new Set([
   "Int",
   "BigInt",
@@ -56,11 +59,23 @@ var PROVIDER_TO_SYSTEM = {
   sqlite: "sqlite"
 };
 function prismaSchemaToSummaries(source, options = {}) {
-  const ast = (0, import_prisma_ast.getSchema)(source);
-  const list = ast.list;
+  return summariesOfSchema(
+    [{ file: options.source ?? "schema.prisma", text: source }],
+    options.scope ?? "default",
+    options.origin
+  );
+}
+function summariesOfSchema(sources, scope, origin) {
+  const nodes = sources.flatMap(
+    ({ file, text }) => (0, import_prisma_ast.getSchema)(text).list.map((node) => ({
+      node,
+      file
+    }))
+  );
+  const list = nodes.map(({ node }) => node);
   const modelNames = /* @__PURE__ */ new Set();
   const enumNames = /* @__PURE__ */ new Set();
-  let storageSystem = null;
+  const storageSystem = storageSystemIn(list);
   for (const node of list) {
     const n = node;
     if (n.type === "model" || n.type === "view") {
@@ -71,24 +86,22 @@ function prismaSchemaToSummaries(source, options = {}) {
       if (typeof n.name === "string") {
         enumNames.add(n.name);
       }
-    } else if (n.type === "datasource") {
-      const ds = node;
-      const provider = readProviderString(ds);
-      if (provider !== null && provider in PROVIDER_TO_SYSTEM) {
-        storageSystem = PROVIDER_TO_SYSTEM[provider];
-      }
     }
   }
   if (storageSystem === null) {
     return [];
   }
-  const sourceFile = options.source ?? "schema.prisma";
-  const scope = options.scope ?? "default";
   const summaries = [];
   const models = list.filter(
     (node) => node.type === "model"
   );
+  const fileOfModel = new Map(
+    nodes.map(({ node, file }) => [node.name, file])
+  );
   const relations = implicitManyToManyRelations(models, modelNames);
+  const tableOfModel = new Map(
+    models.map((model) => [model.name, physicalTableOf(model) ?? model.name])
+  );
   const joinContainerByField = /* @__PURE__ */ new Map();
   for (const relation of relations) {
     joinContainerByField.set(
@@ -100,7 +113,7 @@ function prismaSchemaToSummaries(source, options = {}) {
       relation.joinTable
     );
   }
-  for (const node of list) {
+  for (const { node, file } of nodes) {
     const n = node;
     if (n.type !== "model" && n.type !== "view") {
       continue;
@@ -111,16 +124,25 @@ function prismaSchemaToSummaries(source, options = {}) {
         model,
         modelNames,
         enumNames,
+        tableOfModel,
         storageSystem,
         scope,
-        sourceFile,
+        origin,
+        sourceFile: file,
         joinContainerByField
       })
     );
   }
   for (const relation of relations) {
     summaries.push(
-      buildJoinTableSummary({ relation, storageSystem, scope, sourceFile })
+      buildJoinTableSummary({
+        relation,
+        tableOfModel,
+        storageSystem,
+        scope,
+        origin,
+        sourceFile: fileOfModel.get(relation.leftModel) ?? "schema.prisma"
+      })
     );
   }
   return summaries;
@@ -203,6 +225,14 @@ function buildJoinTableSummary(opts) {
     opts.relation.leftModel,
     opts.relation.rightModel
   ].sort();
+  const keyColumn = (name, model) => ({
+    name,
+    type: model,
+    nullable: false,
+    primary: true,
+    default: false,
+    foreignKey: opts.tableOfModel.get(model) ?? model
+  });
   return {
     kind: "library",
     location: {
@@ -227,14 +257,12 @@ function buildJoinTableSummary(opts) {
     metadata: {
       storageContract: {
         fieldSet: "exhaustive",
-        fields: [
-          { name: "A", type: modelA, nullable: false, primary: true },
-          { name: "B", type: modelB, nullable: false, primary: true }
-        ],
+        fields: [keyColumn("A", modelA), keyColumn("B", modelB)],
         indexes: [
           { fields: ["A", "B"], unique: true },
           { fields: ["B"], unique: false }
-        ]
+        ],
+        ...originOf(opts.origin)
       }
     }
   };
@@ -243,21 +271,94 @@ function prismaSchemaFileToSummaries(schemaPath, options = {}) {
   if (!import_node_fs.default.existsSync(schemaPath)) {
     throw new Error(`Prisma schema not found: ${schemaPath}`);
   }
-  const source = import_node_fs.default.readFileSync(schemaPath, "utf-8");
-  return prismaSchemaToSummaries(source, {
-    ...options,
-    source: options.source ?? import_node_path.default.relative(process.cwd(), schemaPath)
-  });
+  const root = options.projectRoot ?? (0, import_files.defaultProjectRoot)(schemaPath);
+  const files = prismaSchemaFiles(schemaPath);
+  const sources = files.map((file) => ({
+    file: options.source ?? (0, import_files.pathInProject)(file, root),
+    text: import_node_fs.default.readFileSync(file, "utf-8")
+  }));
+  return summariesOfSchema(
+    sources,
+    options.scope ?? "default",
+    options.origin ?? migrationsOriginOf(schemaPath, files)
+  );
+}
+function migrationsOriginOf(schemaPath, files) {
+  const folder = statOf(schemaPath)?.isDirectory() === true;
+  const own = folder ? import_node_path.default.resolve(schemaPath) : import_node_path.default.dirname(import_node_path.default.resolve(schemaPath));
+  const searched = folder || files.length > 1 ? [own, import_node_path.default.dirname(own)] : [own];
+  return searched.some(hasMigrationsFolder) ? "migrations" : void 0;
+}
+function hasMigrationsFolder(dir) {
+  return foldersIn(dir).some(
+    (folder) => import_node_fs.default.existsSync(import_node_path.default.join(dir, folder, "migration_lock.toml"))
+  );
+}
+function foldersIn(dir) {
+  try {
+    return import_node_fs.default.readdirSync(dir, { withFileTypes: true }).filter((entry) => entry.isDirectory()).map((entry) => entry.name);
+  } catch {
+    return [];
+  }
+}
+function originOf(origin) {
+  return origin === void 0 ? {} : { origin };
+}
+function prismaSchemaFiles(schemaPath) {
+  const stat = statOf(schemaPath);
+  if (stat?.isDirectory() === true) {
+    return prismaFilesIn(schemaPath, true);
+  }
+  if (stat?.isFile() !== true) {
+    return [];
+  }
+  const beside = prismaFilesIn(import_node_path.default.dirname(schemaPath), false).flatMap(
+    (file) => {
+      const list = schemaListOf(file);
+      return list === null ? [] : [{ file, list }];
+    }
+  );
+  const datasources = beside.filter(
+    ({ list }) => list.some(isDatasource)
+  ).length;
+  const given = import_node_path.default.resolve(schemaPath);
+  return datasources === 1 && beside.some(({ file }) => import_node_path.default.resolve(file) === given) ? beside.map(({ file }) => file) : [schemaPath];
+}
+function statOf(file) {
+  try {
+    return import_node_fs.default.statSync(file);
+  } catch {
+    return null;
+  }
+}
+function prismaFilesIn(dir, below) {
+  return import_node_fs.default.readdirSync(dir, { recursive: below, encoding: "utf8" }).filter((name) => name.endsWith(".prisma")).map((name) => import_node_path.default.join(dir, name)).filter((file) => statOf(file)?.isFile() === true).sort();
+}
+function schemaListOf(file) {
+  try {
+    return (0, import_prisma_ast.getSchema)(import_node_fs.default.readFileSync(file, "utf8")).list;
+  } catch {
+    return null;
+  }
+}
+function isDatasource(node) {
+  return node.type === "datasource";
 }
 function buildModelSummary(opts) {
   const columns = [];
   const indexes = [];
   const physicalTable = physicalTableOf(opts.model);
+  const context = {
+    enumNames: opts.enumNames,
+    foreignKeys: foreignKeysOf(opts.model, opts.modelNames, opts.tableOfModel),
+    compositeKey: compositeKeyOf(opts.model),
+    migrated: opts.origin === "migrations"
+  };
   let hasRelation = false;
   for (const property of opts.model.properties) {
     if (property.type === "field") {
       const field = property;
-      const column = fieldToColumn(field, opts.modelNames, opts.enumNames);
+      const column = fieldToColumn(field, opts.modelNames, context);
       if (column !== null) {
         columns.push(column);
       }
@@ -311,7 +412,8 @@ function buildModelSummary(opts) {
         fieldSet: "exhaustive",
         fields: columns,
         indexes,
-        ...physicalTable !== null && physicalTable !== opts.model.name ? { physicalTable } : {}
+        ...physicalTable !== null && physicalTable !== opts.model.name ? { physicalTable } : {},
+        ...originOf(opts.origin)
       }
     }
   };
@@ -341,37 +443,110 @@ function relationNameOf(field) {
   const relation = relationAttributeOf(field);
   return relation === void 0 ? null : readStringArg(relation);
 }
-function fieldToColumn(field, modelNames, enumNames) {
-  if (field.array === true) {
-    return null;
-  }
+function fieldToColumn(field, modelNames, context) {
   const ft = field.fieldType;
-  const isScalar = PRISMA_SCALARS.has(ft);
-  const isEnum = enumNames.has(ft);
-  const isRelation = modelNames.has(ft);
-  if (isRelation) {
+  if (modelNames.has(ft)) {
     return null;
   }
-  if (!isScalar && !isEnum) {
+  if (!PRISMA_SCALARS.has(ft) && !context.enumNames.has(ft)) {
     return null;
   }
-  let primary = false;
-  let unique = false;
-  for (const attr of field.attributes ?? []) {
-    if (attr.name === "id") {
-      primary = true;
-    } else if (attr.name === "unique") {
-      unique = true;
-    }
-  }
+  const column = stringArgOf(fieldAttribute(field, "map"));
+  const nullable = nullableOf(field, context.migrated);
+  const databaseDefault = databaseDefaultOf(field, context.migrated);
+  const foreignKey = context.foreignKeys.get(field.name);
+  const primary = fieldAttribute(field, "id") !== void 0 || context.compositeKey.has(field.name);
   return {
     name: field.name,
-    type: ft,
-    nullable: field.optional === true,
+    ...column !== null && column !== field.name ? { column } : {},
+    type: columnTypeOf(field, context.enumNames),
+    ...nullable === void 0 ? {} : { nullable },
     ...primary ? { primary: true } : {},
-    ...unique ? { unique: true } : {}
+    ...fieldAttribute(field, "unique") !== void 0 ? { unique: true } : {},
+    ...databaseDefault === void 0 ? {} : { default: databaseDefault },
+    ...foreignKey === void 0 ? {} : { foreignKey }
   };
 }
+function fieldAttribute(field, name) {
+  return (field.attributes ?? []).find(
+    (attr) => attr.name === name && attr.group === void 0
+  );
+}
+function columnTypeOf(field, enumNames) {
+  const element = elementTypeOf(field, enumNames);
+  return field.array === true ? `${element}[]` : element;
+}
+function elementTypeOf(field, enumNames) {
+  const native = (field.attributes ?? []).find((attr) => attr.group === "db");
+  if (native !== void 0) {
+    return `@db.${native.name}`;
+  }
+  return enumNames.has(field.fieldType) ? "enum" : field.fieldType;
+}
+function nullableOf(field, migrated) {
+  if (field.array === true) {
+    return migrated ? true : void 0;
+  }
+  return field.optional === true;
+}
+var DEFAULT_FUNCTION_FILLERS = {
+  autoincrement: "database",
+  dbgenerated: "database",
+  now: "both",
+  uuid: "client",
+  cuid: "client",
+  nanoid: "client",
+  ulid: "client"
+};
+var DATABASE_DEFAULT = {
+  nobody: () => false,
+  database: () => true,
+  client: () => false,
+  both: (migrated) => migrated ? true : void 0,
+  unknown: () => void 0
+};
+function databaseDefaultOf(field, migrated) {
+  return DATABASE_DEFAULT[defaultFillerOf(field)](migrated);
+}
+function defaultFillerOf(field) {
+  const value = (fieldAttribute(field, "default")?.args ?? []).find(
+    (arg) => arg.value?.type !== "keyValue"
+  )?.value;
+  if (value === void 0) {
+    return "nobody";
+  }
+  const call = value;
+  if (call?.type !== "function") {
+    return "both";
+  }
+  return DEFAULT_FUNCTION_FILLERS[call.name ?? ""] ?? "unknown";
+}
+function foreignKeysOf(model, modelNames, tableOfModel) {
+  const targets = /* @__PURE__ */ new Map();
+  for (const property of model.properties) {
+    if (property.type !== "field") {
+      continue;
+    }
+    const field = property;
+    if (!modelNames.has(field.fieldType)) {
+      continue;
+    }
+    const table = tableOfModel.get(field.fieldType) ?? field.fieldType;
+    for (const column of relationKeyOf(field) ?? []) {
+      targets.set(column, table);
+    }
+  }
+  return targets;
+}
+function compositeKeyOf(model) {
+  for (const property of model.properties) {
+    const attr = property;
+    if (attr.type === "attribute" && attr.name === "id") {
+      return new Set(blockFieldsOf(attr) ?? []);
+    }
+  }
+  return /* @__PURE__ */ new Set();
+}
 function physicalTableOf(model) {
   for (const property of model.properties) {
     if (property.type !== "attribute") {
@@ -381,13 +556,29 @@ function physicalTableOf(model) {
     if (attr.name !== "map") {
       continue;
     }
-    const name = readStringArg(attr);
+    const name = stringArgOf(attr);
     if (name !== null) {
       return name;
     }
   }
   return null;
 }
+function stringArgOf(attr) {
+  if (attr === void 0) {
+    return null;
+  }
+  const positional = readStringArg(attr);
+  if (positional !== null) {
+    return positional;
+  }
+  for (const arg of attr.args ?? []) {
+    const value = arg.value;
+    if (value?.type === "keyValue" && value.key === "name" && typeof value.value === "string") {
+      return value.value.replace(/^"|"$/g, "");
+    }
+  }
+  return null;
+}
 function readStringArg(attr) {
   for (const arg of attr.args ?? []) {
     const value = arg.value;
@@ -401,12 +592,15 @@ function blockAttributeToIndex(attr) {
   if (attr.name !== "index" && attr.name !== "unique" && attr.name !== "id") {
     return null;
   }
-  const fields = readArrayArg(attr);
+  const fields = blockFieldsOf(attr);
   if (fields === null) {
     return null;
   }
   return { fields, unique: attr.name !== "index" };
 }
+function blockFieldsOf(attr) {
+  return readArrayArg(attr) ?? readKeyedArrayArg(attr, "fields");
+}
 function readArrayArg(attr) {
   for (const arg of attr.args ?? []) {
     const names = arrayNames(arg.value);
@@ -441,6 +635,25 @@ function arrayNames(value) {
   }
   return out;
 }
+function prismaStorageSystem(source) {
+  try {
+    return storageSystemIn((0, import_prisma_ast.getSchema)(source).list);
+  } catch {
+    return null;
+  }
+}
+function storageSystemIn(list) {
+  for (const node of list) {
+    if (node.type !== "datasource") {
+      continue;
+    }
+    const provider = readProviderString(node);
+    if (provider !== null && provider in PROVIDER_TO_SYSTEM) {
+      return PROVIDER_TO_SYSTEM[provider];
+    }
+  }
+  return null;
+}
 function readProviderString(ds) {
   for (const a of ds.assignments) {
     if (a.key !== "provider") {
@@ -455,5 +668,7 @@ function readProviderString(ds) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   prismaSchemaFileToSummaries,
-  prismaSchemaToSummaries
+  prismaSchemaFiles,
+  prismaSchemaToSummaries,
+  prismaStorageSystem
 });

package/dist/index.d.cts

@@ -18,6 +18,12 @@ interface PrismaSchemaToSummariesOptions {
      * each its own scope so their pairings stay separate.
      */
     scope?: string;
+    /** `"migrations"` when Prisma's own migrations made the database. */
+    origin?: "migrations";
+}
+interface PrismaSchemaFileToSummariesOptions extends PrismaSchemaToSummariesOptions {
+    /** Absolute. The directory each schema file's path is measured from. */
+    projectRoot?: string;
 }
 /**
  * Converts Prisma schema text into summaries. Returns an empty array when
@@ -25,9 +31,25 @@ interface PrismaSchemaToSummariesOptions {
  */
 declare function prismaSchemaToSummaries(source: string, options?: PrismaSchemaToSummariesOptions): BehavioralSummary[];
 /**
- * Reads a Prisma schema file and converts it. Throws when the file does
- * not exist.
+ * Reads a Prisma schema from disk and converts it: a file, a schema
+ * folder, or one file of a multi-file schema, which brings the rest of
+ * its files with it. Throws when the path does not exist. Unless the
+ * options say otherwise, the origin is `"migrations"` when a Prisma
+ * migrations folder is next to the schema.
+ */
+declare function prismaSchemaFileToSummaries(schemaPath: string, options?: PrismaSchemaFileToSummariesOptions): BehavioralSummary[];
+/**
+ * The files Prisma reads as one schema, given a schema file or folder.
+ * Prisma reads every `.prisma` file below a folder. A file with no
+ * datasource cannot be a schema on its own, so when only one file in a
+ * folder has the datasource, the folder's files are one schema.
+ */
+declare function prismaSchemaFiles(schemaPath: string): string[];
+type PrismaStorageSystem = "postgresql" | "mysql" | "sqlite";
+/**
+ * The storage system the datasource provider says, or null for MongoDB or
+ * a file with no datasource. The client pack binds its calls with this.
  */
-declare function prismaSchemaFileToSummaries(schemaPath: string, options?: PrismaSchemaToSummariesOptions): BehavioralSummary[];
+declare function prismaStorageSystem(source: string): PrismaStorageSystem | null;
 
-export { type PrismaSchemaToSummariesOptions, prismaSchemaFileToSummaries, prismaSchemaToSummaries };
+export { type PrismaSchemaFileToSummariesOptions, type PrismaSchemaToSummariesOptions, type PrismaStorageSystem, prismaSchemaFileToSummaries, prismaSchemaFiles, prismaSchemaToSummaries, prismaStorageSystem };

package/dist/index.d.ts

@@ -18,6 +18,12 @@ interface PrismaSchemaToSummariesOptions {
      * each its own scope so their pairings stay separate.
      */
     scope?: string;
+    /** `"migrations"` when Prisma's own migrations made the database. */
+    origin?: "migrations";
+}
+interface PrismaSchemaFileToSummariesOptions extends PrismaSchemaToSummariesOptions {
+    /** Absolute. The directory each schema file's path is measured from. */
+    projectRoot?: string;
 }
 /**
  * Converts Prisma schema text into summaries. Returns an empty array when
@@ -25,9 +31,25 @@ interface PrismaSchemaToSummariesOptions {
  */
 declare function prismaSchemaToSummaries(source: string, options?: PrismaSchemaToSummariesOptions): BehavioralSummary[];
 /**
- * Reads a Prisma schema file and converts it. Throws when the file does
- * not exist.
+ * Reads a Prisma schema from disk and converts it: a file, a schema
+ * folder, or one file of a multi-file schema, which brings the rest of
+ * its files with it. Throws when the path does not exist. Unless the
+ * options say otherwise, the origin is `"migrations"` when a Prisma
+ * migrations folder is next to the schema.
+ */
+declare function prismaSchemaFileToSummaries(schemaPath: string, options?: PrismaSchemaFileToSummariesOptions): BehavioralSummary[];
+/**
+ * The files Prisma reads as one schema, given a schema file or folder.
+ * Prisma reads every `.prisma` file below a folder. A file with no
+ * datasource cannot be a schema on its own, so when only one file in a
+ * folder has the datasource, the folder's files are one schema.
+ */
+declare function prismaSchemaFiles(schemaPath: string): string[];
+type PrismaStorageSystem = "postgresql" | "mysql" | "sqlite";
+/**
+ * The storage system the datasource provider says, or null for MongoDB or
+ * a file with no datasource. The client pack binds its calls with this.
  */
-declare function prismaSchemaFileToSummaries(schemaPath: string, options?: PrismaSchemaToSummariesOptions): BehavioralSummary[];
+declare function prismaStorageSystem(source: string): PrismaStorageSystem | null;
 
-export { type PrismaSchemaToSummariesOptions, prismaSchemaFileToSummaries, prismaSchemaToSummaries };
+export { type PrismaSchemaFileToSummariesOptions, type PrismaSchemaToSummariesOptions, type PrismaStorageSystem, prismaSchemaFileToSummaries, prismaSchemaFiles, prismaSchemaToSummaries, prismaStorageSystem };

package/dist/index.js

@@ -3,6 +3,7 @@ import fs from "fs";
 import path from "path";
 import { getSchema } from "@mrleebo/prisma-ast";
 import { storageBinding } from "@suss/behavioral-ir";
+import { defaultProjectRoot, pathInProject } from "@suss/behavioral-ir/files";
 var PRISMA_SCALARS = /* @__PURE__ */ new Set([
   "Int",
   "BigInt",
@@ -21,11 +22,23 @@ var PROVIDER_TO_SYSTEM = {
   sqlite: "sqlite"
 };
 function prismaSchemaToSummaries(source, options = {}) {
-  const ast = getSchema(source);
-  const list = ast.list;
+  return summariesOfSchema(
+    [{ file: options.source ?? "schema.prisma", text: source }],
+    options.scope ?? "default",
+    options.origin
+  );
+}
+function summariesOfSchema(sources, scope, origin) {
+  const nodes = sources.flatMap(
+    ({ file, text }) => getSchema(text).list.map((node) => ({
+      node,
+      file
+    }))
+  );
+  const list = nodes.map(({ node }) => node);
   const modelNames = /* @__PURE__ */ new Set();
   const enumNames = /* @__PURE__ */ new Set();
-  let storageSystem = null;
+  const storageSystem = storageSystemIn(list);
   for (const node of list) {
     const n = node;
     if (n.type === "model" || n.type === "view") {
@@ -36,24 +49,22 @@ function prismaSchemaToSummaries(source, options = {}) {
       if (typeof n.name === "string") {
         enumNames.add(n.name);
       }
-    } else if (n.type === "datasource") {
-      const ds = node;
-      const provider = readProviderString(ds);
-      if (provider !== null && provider in PROVIDER_TO_SYSTEM) {
-        storageSystem = PROVIDER_TO_SYSTEM[provider];
-      }
     }
   }
   if (storageSystem === null) {
     return [];
   }
-  const sourceFile = options.source ?? "schema.prisma";
-  const scope = options.scope ?? "default";
   const summaries = [];
   const models = list.filter(
     (node) => node.type === "model"
   );
+  const fileOfModel = new Map(
+    nodes.map(({ node, file }) => [node.name, file])
+  );
   const relations = implicitManyToManyRelations(models, modelNames);
+  const tableOfModel = new Map(
+    models.map((model) => [model.name, physicalTableOf(model) ?? model.name])
+  );
   const joinContainerByField = /* @__PURE__ */ new Map();
   for (const relation of relations) {
     joinContainerByField.set(
@@ -65,7 +76,7 @@ function prismaSchemaToSummaries(source, options = {}) {
       relation.joinTable
     );
   }
-  for (const node of list) {
+  for (const { node, file } of nodes) {
     const n = node;
     if (n.type !== "model" && n.type !== "view") {
       continue;
@@ -76,16 +87,25 @@ function prismaSchemaToSummaries(source, options = {}) {
         model,
         modelNames,
         enumNames,
+        tableOfModel,
         storageSystem,
         scope,
-        sourceFile,
+        origin,
+        sourceFile: file,
         joinContainerByField
       })
     );
   }
   for (const relation of relations) {
     summaries.push(
-      buildJoinTableSummary({ relation, storageSystem, scope, sourceFile })
+      buildJoinTableSummary({
+        relation,
+        tableOfModel,
+        storageSystem,
+        scope,
+        origin,
+        sourceFile: fileOfModel.get(relation.leftModel) ?? "schema.prisma"
+      })
     );
   }
   return summaries;
@@ -168,6 +188,14 @@ function buildJoinTableSummary(opts) {
     opts.relation.leftModel,
     opts.relation.rightModel
   ].sort();
+  const keyColumn = (name, model) => ({
+    name,
+    type: model,
+    nullable: false,
+    primary: true,
+    default: false,
+    foreignKey: opts.tableOfModel.get(model) ?? model
+  });
   return {
     kind: "library",
     location: {
@@ -192,14 +220,12 @@ function buildJoinTableSummary(opts) {
     metadata: {
       storageContract: {
         fieldSet: "exhaustive",
-        fields: [
-          { name: "A", type: modelA, nullable: false, primary: true },
-          { name: "B", type: modelB, nullable: false, primary: true }
-        ],
+        fields: [keyColumn("A", modelA), keyColumn("B", modelB)],
         indexes: [
           { fields: ["A", "B"], unique: true },
           { fields: ["B"], unique: false }
-        ]
+        ],
+        ...originOf(opts.origin)
       }
     }
   };
@@ -208,21 +234,94 @@ function prismaSchemaFileToSummaries(schemaPath, options = {}) {
   if (!fs.existsSync(schemaPath)) {
     throw new Error(`Prisma schema not found: ${schemaPath}`);
   }
-  const source = fs.readFileSync(schemaPath, "utf-8");
-  return prismaSchemaToSummaries(source, {
-    ...options,
-    source: options.source ?? path.relative(process.cwd(), schemaPath)
-  });
+  const root = options.projectRoot ?? defaultProjectRoot(schemaPath);
+  const files = prismaSchemaFiles(schemaPath);
+  const sources = files.map((file) => ({
+    file: options.source ?? pathInProject(file, root),
+    text: fs.readFileSync(file, "utf-8")
+  }));
+  return summariesOfSchema(
+    sources,
+    options.scope ?? "default",
+    options.origin ?? migrationsOriginOf(schemaPath, files)
+  );
+}
+function migrationsOriginOf(schemaPath, files) {
+  const folder = statOf(schemaPath)?.isDirectory() === true;
+  const own = folder ? path.resolve(schemaPath) : path.dirname(path.resolve(schemaPath));
+  const searched = folder || files.length > 1 ? [own, path.dirname(own)] : [own];
+  return searched.some(hasMigrationsFolder) ? "migrations" : void 0;
+}
+function hasMigrationsFolder(dir) {
+  return foldersIn(dir).some(
+    (folder) => fs.existsSync(path.join(dir, folder, "migration_lock.toml"))
+  );
+}
+function foldersIn(dir) {
+  try {
+    return fs.readdirSync(dir, { withFileTypes: true }).filter((entry) => entry.isDirectory()).map((entry) => entry.name);
+  } catch {
+    return [];
+  }
+}
+function originOf(origin) {
+  return origin === void 0 ? {} : { origin };
+}
+function prismaSchemaFiles(schemaPath) {
+  const stat = statOf(schemaPath);
+  if (stat?.isDirectory() === true) {
+    return prismaFilesIn(schemaPath, true);
+  }
+  if (stat?.isFile() !== true) {
+    return [];
+  }
+  const beside = prismaFilesIn(path.dirname(schemaPath), false).flatMap(
+    (file) => {
+      const list = schemaListOf(file);
+      return list === null ? [] : [{ file, list }];
+    }
+  );
+  const datasources = beside.filter(
+    ({ list }) => list.some(isDatasource)
+  ).length;
+  const given = path.resolve(schemaPath);
+  return datasources === 1 && beside.some(({ file }) => path.resolve(file) === given) ? beside.map(({ file }) => file) : [schemaPath];
+}
+function statOf(file) {
+  try {
+    return fs.statSync(file);
+  } catch {
+    return null;
+  }
+}
+function prismaFilesIn(dir, below) {
+  return fs.readdirSync(dir, { recursive: below, encoding: "utf8" }).filter((name) => name.endsWith(".prisma")).map((name) => path.join(dir, name)).filter((file) => statOf(file)?.isFile() === true).sort();
+}
+function schemaListOf(file) {
+  try {
+    return getSchema(fs.readFileSync(file, "utf8")).list;
+  } catch {
+    return null;
+  }
+}
+function isDatasource(node) {
+  return node.type === "datasource";
 }
 function buildModelSummary(opts) {
   const columns = [];
   const indexes = [];
   const physicalTable = physicalTableOf(opts.model);
+  const context = {
+    enumNames: opts.enumNames,
+    foreignKeys: foreignKeysOf(opts.model, opts.modelNames, opts.tableOfModel),
+    compositeKey: compositeKeyOf(opts.model),
+    migrated: opts.origin === "migrations"
+  };
   let hasRelation = false;
   for (const property of opts.model.properties) {
     if (property.type === "field") {
       const field = property;
-      const column = fieldToColumn(field, opts.modelNames, opts.enumNames);
+      const column = fieldToColumn(field, opts.modelNames, context);
       if (column !== null) {
         columns.push(column);
       }
@@ -276,7 +375,8 @@ function buildModelSummary(opts) {
         fieldSet: "exhaustive",
         fields: columns,
         indexes,
-        ...physicalTable !== null && physicalTable !== opts.model.name ? { physicalTable } : {}
+        ...physicalTable !== null && physicalTable !== opts.model.name ? { physicalTable } : {},
+        ...originOf(opts.origin)
       }
     }
   };
@@ -306,37 +406,110 @@ function relationNameOf(field) {
   const relation = relationAttributeOf(field);
   return relation === void 0 ? null : readStringArg(relation);
 }
-function fieldToColumn(field, modelNames, enumNames) {
-  if (field.array === true) {
-    return null;
-  }
+function fieldToColumn(field, modelNames, context) {
   const ft = field.fieldType;
-  const isScalar = PRISMA_SCALARS.has(ft);
-  const isEnum = enumNames.has(ft);
-  const isRelation = modelNames.has(ft);
-  if (isRelation) {
+  if (modelNames.has(ft)) {
     return null;
   }
-  if (!isScalar && !isEnum) {
+  if (!PRISMA_SCALARS.has(ft) && !context.enumNames.has(ft)) {
     return null;
   }
-  let primary = false;
-  let unique = false;
-  for (const attr of field.attributes ?? []) {
-    if (attr.name === "id") {
-      primary = true;
-    } else if (attr.name === "unique") {
-      unique = true;
-    }
-  }
+  const column = stringArgOf(fieldAttribute(field, "map"));
+  const nullable = nullableOf(field, context.migrated);
+  const databaseDefault = databaseDefaultOf(field, context.migrated);
+  const foreignKey = context.foreignKeys.get(field.name);
+  const primary = fieldAttribute(field, "id") !== void 0 || context.compositeKey.has(field.name);
   return {
     name: field.name,
-    type: ft,
-    nullable: field.optional === true,
+    ...column !== null && column !== field.name ? { column } : {},
+    type: columnTypeOf(field, context.enumNames),
+    ...nullable === void 0 ? {} : { nullable },
     ...primary ? { primary: true } : {},
-    ...unique ? { unique: true } : {}
+    ...fieldAttribute(field, "unique") !== void 0 ? { unique: true } : {},
+    ...databaseDefault === void 0 ? {} : { default: databaseDefault },
+    ...foreignKey === void 0 ? {} : { foreignKey }
   };
 }
+function fieldAttribute(field, name) {
+  return (field.attributes ?? []).find(
+    (attr) => attr.name === name && attr.group === void 0
+  );
+}
+function columnTypeOf(field, enumNames) {
+  const element = elementTypeOf(field, enumNames);
+  return field.array === true ? `${element}[]` : element;
+}
+function elementTypeOf(field, enumNames) {
+  const native = (field.attributes ?? []).find((attr) => attr.group === "db");
+  if (native !== void 0) {
+    return `@db.${native.name}`;
+  }
+  return enumNames.has(field.fieldType) ? "enum" : field.fieldType;
+}
+function nullableOf(field, migrated) {
+  if (field.array === true) {
+    return migrated ? true : void 0;
+  }
+  return field.optional === true;
+}
+var DEFAULT_FUNCTION_FILLERS = {
+  autoincrement: "database",
+  dbgenerated: "database",
+  now: "both",
+  uuid: "client",
+  cuid: "client",
+  nanoid: "client",
+  ulid: "client"
+};
+var DATABASE_DEFAULT = {
+  nobody: () => false,
+  database: () => true,
+  client: () => false,
+  both: (migrated) => migrated ? true : void 0,
+  unknown: () => void 0
+};
+function databaseDefaultOf(field, migrated) {
+  return DATABASE_DEFAULT[defaultFillerOf(field)](migrated);
+}
+function defaultFillerOf(field) {
+  const value = (fieldAttribute(field, "default")?.args ?? []).find(
+    (arg) => arg.value?.type !== "keyValue"
+  )?.value;
+  if (value === void 0) {
+    return "nobody";
+  }
+  const call = value;
+  if (call?.type !== "function") {
+    return "both";
+  }
+  return DEFAULT_FUNCTION_FILLERS[call.name ?? ""] ?? "unknown";
+}
+function foreignKeysOf(model, modelNames, tableOfModel) {
+  const targets = /* @__PURE__ */ new Map();
+  for (const property of model.properties) {
+    if (property.type !== "field") {
+      continue;
+    }
+    const field = property;
+    if (!modelNames.has(field.fieldType)) {
+      continue;
+    }
+    const table = tableOfModel.get(field.fieldType) ?? field.fieldType;
+    for (const column of relationKeyOf(field) ?? []) {
+      targets.set(column, table);
+    }
+  }
+  return targets;
+}
+function compositeKeyOf(model) {
+  for (const property of model.properties) {
+    const attr = property;
+    if (attr.type === "attribute" && attr.name === "id") {
+      return new Set(blockFieldsOf(attr) ?? []);
+    }
+  }
+  return /* @__PURE__ */ new Set();
+}
 function physicalTableOf(model) {
   for (const property of model.properties) {
     if (property.type !== "attribute") {
@@ -346,13 +519,29 @@ function physicalTableOf(model) {
     if (attr.name !== "map") {
       continue;
     }
-    const name = readStringArg(attr);
+    const name = stringArgOf(attr);
     if (name !== null) {
       return name;
     }
   }
   return null;
 }
+function stringArgOf(attr) {
+  if (attr === void 0) {
+    return null;
+  }
+  const positional = readStringArg(attr);
+  if (positional !== null) {
+    return positional;
+  }
+  for (const arg of attr.args ?? []) {
+    const value = arg.value;
+    if (value?.type === "keyValue" && value.key === "name" && typeof value.value === "string") {
+      return value.value.replace(/^"|"$/g, "");
+    }
+  }
+  return null;
+}
 function readStringArg(attr) {
   for (const arg of attr.args ?? []) {
     const value = arg.value;
@@ -366,12 +555,15 @@ function blockAttributeToIndex(attr) {
   if (attr.name !== "index" && attr.name !== "unique" && attr.name !== "id") {
     return null;
   }
-  const fields = readArrayArg(attr);
+  const fields = blockFieldsOf(attr);
   if (fields === null) {
     return null;
   }
   return { fields, unique: attr.name !== "index" };
 }
+function blockFieldsOf(attr) {
+  return readArrayArg(attr) ?? readKeyedArrayArg(attr, "fields");
+}
 function readArrayArg(attr) {
   for (const arg of attr.args ?? []) {
     const names = arrayNames(arg.value);
@@ -406,6 +598,25 @@ function arrayNames(value) {
   }
   return out;
 }
+function prismaStorageSystem(source) {
+  try {
+    return storageSystemIn(getSchema(source).list);
+  } catch {
+    return null;
+  }
+}
+function storageSystemIn(list) {
+  for (const node of list) {
+    if (node.type !== "datasource") {
+      continue;
+    }
+    const provider = readProviderString(node);
+    if (provider !== null && provider in PROVIDER_TO_SYSTEM) {
+      return PROVIDER_TO_SYSTEM[provider];
+    }
+  }
+  return null;
+}
 function readProviderString(ds) {
   for (const a of ds.assignments) {
     if (a.key !== "provider") {
@@ -419,5 +630,7 @@ function readProviderString(ds) {
 }
 export {
   prismaSchemaFileToSummaries,
-  prismaSchemaToSummaries
+  prismaSchemaFiles,
+  prismaSchemaToSummaries,
+  prismaStorageSystem
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-prisma",
-  "version": "0.34.0",
+  "version": "0.35.0",
   "type": "module",
   "description": "Turn a Prisma schema into a suss contract and check it against the queries your code runs on those tables.",
   "keywords": [
@@ -48,7 +48,7 @@
   },
   "dependencies": {
     "@mrleebo/prisma-ast": "^0.15.0",
-    "@suss/behavioral-ir": "0.34.0"
+    "@suss/behavioral-ir": "0.35.0"
   },
   "devDependencies": {
     "tsup": "*",