joist-codegen 2.3.0 → 2.4.0

package/build/pgMetadata.js

@@ -0,0 +1,320 @@
+import pluralize from "pluralize";
+//#region src/pgMetadata.ts
+/** The small part of PostgreSQL's catalog model used by Joist codegen. */
+var Items = class extends Array {
+	byName;
+	/** Looks up a column by name without scanning the table on every call. */
+	get(name) {
+		this.byName ??= new Map(this.map((item) => [item.name, item]));
+		const item = this.byName.get(name);
+		if (!item) throw new Error(`No item named ${name}`);
+		return item;
+	}
+	/** Keep the name index current if more catalog rows arrive after a lookup. */
+	push(...items) {
+		const length = super.push(...items);
+		if (this.byName) for (const item of items) this.byName.set(item.name, item);
+		return length;
+	}
+};
+var EnumType = class {
+	name;
+	values;
+	shortName;
+	constructor(name, values) {
+		this.name = name;
+		this.values = values;
+	}
+};
+var Column = class {
+	name;
+	type;
+	notNull;
+	defaultValue;
+	isGenerated;
+	arrayDimension;
+	comment;
+	foreignKeys = [];
+	uniqueIndexes = [];
+	isPrimaryKey = false;
+	constructor(name, type, notNull, defaultValue, isGenerated, arrayDimension, comment) {
+		this.name = name;
+		this.type = type;
+		this.notNull = notNull;
+		this.defaultValue = defaultValue;
+		this.isGenerated = isGenerated;
+		this.arrayDimension = arrayDimension;
+		this.comment = comment;
+	}
+	get isForeignKey() {
+		return this.foreignKeys.length > 0;
+	}
+	get default() {
+		return this.defaultValue?.replace(/^('.*?')::.+$/, "$1") ?? null;
+	}
+	get commentData() {
+		const data = this.comment?.match(/\[pg-structure\]([\s\S]*?)\[\/pg-structure\]/)?.[1];
+		return data ? JSON.parse(data) : void 0;
+	}
+};
+var Index = class {
+	name;
+	columns;
+	isUnique;
+	isPartial;
+	constructor(name, columns, isUnique, isPartial) {
+		this.name = name;
+		this.columns = columns;
+		this.isUnique = isUnique;
+		this.isPartial = isPartial;
+	}
+};
+var ForeignKey = class {
+	name;
+	table;
+	referencedTable;
+	columns;
+	isDeferred;
+	isDeferrable;
+	onDelete;
+	constructor(name, table, referencedTable, columns, isDeferred, isDeferrable, onDelete) {
+		this.name = name;
+		this.table = table;
+		this.referencedTable = referencedTable;
+		this.columns = columns;
+		this.isDeferred = isDeferred;
+		this.isDeferrable = isDeferrable;
+		this.onDelete = onDelete;
+	}
+};
+var M2ORelation = class {
+	foreignKey;
+	type = "m2o";
+	constructor(foreignKey) {
+		this.foreignKey = foreignKey;
+	}
+	get sourceTable() {
+		return this.foreignKey.table;
+	}
+	get targetTable() {
+		return this.foreignKey.referencedTable;
+	}
+	/** Uses the old short relation name so M2O metadata keeps its factory evaluation order. */
+	get name() {
+		const { foreignKey, sourceTable, targetTable } = this;
+		const hasOtherIncomingFKs = sourceTable.foreignKeys.some((fk) => fk !== foreignKey && fk.referencedTable === targetTable);
+		return pluralize.singular(hasOtherIncomingFKs ? foreignKey.columns[0].name.replace(/_id$/, "") : targetTable.name);
+	}
+};
+var O2MRelation = class {
+	foreignKey;
+	type = "o2m";
+	constructor(foreignKey) {
+		this.foreignKey = foreignKey;
+	}
+	get sourceTable() {
+		return this.foreignKey.referencedTable;
+	}
+	get targetTable() {
+		return this.foreignKey.table;
+	}
+	/** Keeps inverse relations in the same short-name order as pg-structure. */
+	get name() {
+		const { foreignKey, sourceTable, targetTable } = this;
+		if (!targetTable.foreignKeys.some((fk) => fk !== foreignKey && fk.referencedTable === sourceTable)) return pluralize.plural(targetTable.name);
+		const columnName = foreignKey.columns[0].name.replace(/_id$/, "");
+		const sourceName = pluralize.singular(sourceTable.name);
+		const adjective = columnName.endsWith(`_${sourceName}`) ? columnName.slice(0, -sourceName.length - 1) : "";
+		if (sourceTable === targetTable) return pluralize.plural(adjective || targetTable.name);
+		return pluralize.plural(`${adjective || sourceTable.name}_${targetTable.name}`);
+	}
+};
+var M2MRelation = class {
+	foreignKey;
+	targetForeignKey;
+	type = "m2m";
+	constructor(foreignKey, targetForeignKey) {
+		this.foreignKey = foreignKey;
+		this.targetForeignKey = targetForeignKey;
+	}
+	get sourceTable() {
+		return this.foreignKey.referencedTable;
+	}
+	get targetTable() {
+		return this.targetForeignKey.referencedTable;
+	}
+	get joinTable() {
+		return this.foreignKey.table;
+	}
+	/** Adds the join-table qualifier when more than one join path reaches the same target. */
+	get name() {
+		const { sourceTable, joinTable, targetTable } = this;
+		const joinTables = new Set(sourceTable.foreignKeysToThis.filter((fk) => fk.table.foreignKeys.some((other) => other !== fk && other.referencedTable === targetTable)).map((fk) => fk.table));
+		const targetName = pluralize.plural(targetTable.name);
+		if (joinTables.size < 2) return targetName;
+		return `${joinTable.name.replace(sourceTable.name, "").replace(targetTable.name, "").replace(/^_+|_+$/g, "")}_${targetName}`;
+	}
+};
+var Table = class {
+	name;
+	schema;
+	columns = new Items();
+	indexes = new Items();
+	foreignKeys = [];
+	foreignKeysToThis = [];
+	uniqueConstraints = [];
+	primaryKey;
+	constructor(name, schema) {
+		this.name = name;
+		this.schema = schema;
+	}
+	get m2oRelations() {
+		return this.foreignKeys.map((fk) => new M2ORelation(fk)).sort((a, b) => compareNames(a.name, b.name));
+	}
+	get o2mRelations() {
+		return this.foreignKeysToThis.map((fk) => new O2MRelation(fk)).sort((a, b) => compareNames(a.name.toUpperCase(), b.name.toUpperCase()));
+	}
+	get m2mRelations() {
+		return this.foreignKeysToThis.flatMap((fk) => fk.table.foreignKeys.filter((other) => other !== fk).map((other) => new M2MRelation(fk, other))).sort((a, b) => compareNames(a.name.toUpperCase(), b.name.toUpperCase()));
+	}
+};
+/**
+* Reads only the PostgreSQL catalog data used by codegen.
+*
+* Load tables and columns before constraints so each foreign key can link the same Table and Column
+* objects used by entity fields. For example, books.author_id and authors.id are joined through
+* the foreign key, while a trigger calling cyanaudit in another schema is irrelevant to codegen.
+*/
+async function loadPgMetadata(client) {
+	const tables = new Items();
+	const byOid = /* @__PURE__ */ new Map();
+	const columns = /* @__PURE__ */ new Map();
+	const tableRows = await client.query(`
+    SELECT c.oid, c.relname AS name, n.nspname AS schema
+    FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
+    WHERE c.relkind IN ('r', 'p') AND n.nspname <> 'information_schema'
+      AND n.nspname NOT LIKE 'pg_%' AND NOT pg_is_other_temp_schema(n.oid)
+    ORDER BY n.nspname, c.relname
+  `);
+	for (const row of tableRows.rows) {
+		const table = new Table(row.name, { name: row.schema });
+		tables.push(table);
+		byOid.set(row.oid, table);
+		columns.set(row.oid, /* @__PURE__ */ new Map());
+	}
+	const enumRows = await client.query(`
+    SELECT t.oid, t.typname AS name, e.enumlabel AS value
+    FROM pg_type t JOIN pg_enum e ON e.enumtypid = t.oid
+    JOIN pg_namespace n ON n.oid = t.typnamespace
+    WHERE n.nspname <> 'information_schema' AND n.nspname NOT LIKE 'pg_%'
+    ORDER BY t.oid, e.enumsortorder
+  `);
+	const enums = /* @__PURE__ */ new Map();
+	for (const row of enumRows.rows) {
+		if (!enums.has(row.oid)) enums.set(row.oid, new EnumType(row.name, []));
+		enums.get(row.oid).values.push(row.value);
+	}
+	const columnRows = await client.query(`
+    SELECT a.attrelid AS "tableOid", a.attnum AS position, a.attname AS name,
+      COALESCE(NULLIF(t.typelem, 0), t.oid) AS "typeOid",
+      base.typname AS "typeName", a.attnotnull AS "notNull",
+      pg_get_expr(d.adbin, d.adrelid) AS "defaultValue", a.attgenerated AS generated,
+      a.attndims AS "arrayDimension", col_description(a.attrelid, a.attnum) AS comment
+    FROM pg_attribute a JOIN pg_type t ON t.oid = a.atttypid
+    JOIN pg_type base ON base.oid = COALESCE(NULLIF(t.typelem, 0), t.oid)
+    LEFT JOIN pg_attrdef d ON d.adrelid = a.attrelid AND d.adnum = a.attnum
+    WHERE a.attrelid = ANY($1::oid[]) AND a.attnum > 0 AND NOT a.attisdropped
+    ORDER BY a.attrelid, a.attnum
+  `, [Array.from(byOid.keys())]);
+	for (const row of columnRows.rows) {
+		const type = enums.get(row.typeOid) ?? sqlType(row.typeName);
+		const column = new Column(row.name, type, row.notNull, row.defaultValue, row.generated !== "", row.arrayDimension, row.comment);
+		byOid.get(row.tableOid).columns.push(column);
+		columns.get(row.tableOid).set(row.position, column);
+	}
+	const indexRows = await client.query(`
+    SELECT i.indrelid AS "tableOid", i.indexrelid AS "indexOid", c.relname AS name,
+      i.indkey::int2[] AS positions, i.indisunique AS unique, i.indpred IS NOT NULL AS partial
+    FROM pg_index i JOIN pg_class c ON c.oid = i.indexrelid
+    WHERE i.indrelid = ANY($1::oid[])
+  `, [Array.from(byOid.keys())]);
+	const indexes = /* @__PURE__ */ new Map();
+	for (const row of indexRows.rows) {
+		const table = byOid.get(row.tableOid);
+		const index = new Index(row.name, row.positions.flatMap((pos) => columns.get(row.tableOid).get(pos) ?? []), row.unique, row.partial);
+		table.indexes.push(index);
+		indexes.set(row.indexOid, index);
+		if (row.unique) for (const column of index.columns) column.uniqueIndexes.push(index);
+	}
+	const constraintRows = await client.query(`
+    SELECT conrelid AS "tableOid", confrelid AS "targetOid", conindid AS "indexOid",
+      conname AS name, contype AS kind, conkey AS positions,
+      condeferred AS deferred, condeferrable AS deferrable, confdeltype AS "onDelete"
+    FROM pg_constraint WHERE conrelid = ANY($1::oid[]) AND contype IN ('p', 'u', 'f')
+    ORDER BY conrelid, conname
+  `, [Array.from(byOid.keys())]);
+	for (const row of constraintRows.rows) {
+		const table = byOid.get(row.tableOid);
+		const keys = (row.positions ?? []).map((pos) => columns.get(row.tableOid).get(pos));
+		if (row.kind === "p") {
+			table.primaryKey = { columns: keys };
+			for (const column of keys) column.isPrimaryKey = true;
+		} else if (row.kind === "u") table.uniqueConstraints.push({
+			columns: keys,
+			index: indexes.get(row.indexOid)
+		});
+		else {
+			const target = byOid.get(row.targetOid);
+			if (!target) continue;
+			const fk = new ForeignKey(row.name, table, target, keys, row.deferred, row.deferrable, deleteAction(row.onDelete));
+			table.foreignKeys.push(fk);
+			target.foreignKeysToThis.push(fk);
+			for (const column of keys) column.foreignKeys.push(fk);
+		}
+	}
+	return {
+		tables,
+		types: Array.from(enums.values())
+	};
+}
+/** Matches the type names codegen expects from PostgreSQL's builtin aliases. */
+function sqlType(name) {
+	switch (name) {
+		case "int2": return { name: "smallint" };
+		case "int4": return {
+			name: "integer",
+			shortName: "int"
+		};
+		case "int8": return { name: "bigint" };
+		case "bool": return { name: "boolean" };
+		case "float4": return { name: "real" };
+		case "float8": return { name: "double precision" };
+		case "varchar": return { name: "character varying" };
+		case "timestamptz": return { name: "timestamp with time zone" };
+		case "timestamp": return { name: "timestamp without time zone" };
+		case "time": return { name: "time without time zone" };
+		default: return {
+			name,
+			shortName: name
+		};
+	}
+}
+/** Decodes the pg_constraint foreign-key delete action. */
+function deleteAction(code) {
+	switch (code) {
+		case "a": return "NO ACTION";
+		case "r": return "RESTRICT";
+		case "c": return "CASCADE";
+		case "n": return "SET NULL";
+		case "d": return "SET DEFAULT";
+		default: throw new Error(`Unknown PostgreSQL delete action: ${code}`);
+	}
+}
+/** Compares PostgreSQL relation names by code point, independent of the host locale. */
+function compareNames(a, b) {
+	return a < b ? -1 : a > b ? 1 : 0;
+}
+//#endregion
+export { Column, EnumType, ForeignKey, Index, Items, M2MRelation, M2ORelation, O2MRelation, Table, loadPgMetadata };
+
+//# sourceMappingURL=pgMetadata.js.map

package/build/pgMetadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pgMetadata.js","names":[],"sources":["../src/pgMetadata.ts"],"sourcesContent":["import type { Client } from \"pg\";\nimport pluralize from \"pluralize\";\n\n/** The small part of PostgreSQL's catalog model used by Joist codegen. */\nexport class Items<T extends { name: string }> extends Array<T> {\n  private byName?: Map<string, T>;\n\n  /** Looks up a column by name without scanning the table on every call. */\n  get(name: string): T {\n    // Catalog rows are appended before codegen reads them. Build the index on first lookup\n    // so derived arrays from filter/map can still be indexed without special handling.\n    this.byName ??= new Map(this.map((item) => [item.name, item]));\n    const item = this.byName.get(name);\n    if (!item) throw new Error(`No item named ${name}`);\n    return item;\n  }\n\n  /** Keep the name index current if more catalog rows arrive after a lookup. */\n  push(...items: T[]): number {\n    const length = super.push(...items);\n    if (this.byName) for (const item of items) this.byName.set(item.name, item);\n    return length;\n  }\n}\n\nexport type Action = \"NO ACTION\" | \"RESTRICT\" | \"CASCADE\" | \"SET NULL\" | \"SET DEFAULT\";\nexport type JSONData = string | number | boolean | null | JSONData[] | { [key: string]: JSONData };\n\nexport class EnumType {\n  readonly shortName?: string;\n  constructor(\n    public name: string,\n    public values: string[],\n  ) {}\n}\n\nexport class Column {\n  readonly foreignKeys: ForeignKey[] = [];\n  readonly uniqueIndexes: Index[] = [];\n  isPrimaryKey = false;\n\n  constructor(\n    public name: string,\n    public type: { name: string; shortName?: string } | EnumType,\n    public notNull: boolean,\n    public defaultValue: string | null,\n    public isGenerated: boolean,\n    public arrayDimension: number,\n    public comment: string | null,\n  ) {}\n\n  get isForeignKey(): boolean {\n    return this.foreignKeys.length > 0;\n  }\n\n  get default(): string | null {\n    return this.defaultValue?.replace(/^('.*?')::.+$/, \"$1\") ?? null;\n  }\n\n  get commentData(): JSONData | undefined {\n    const data = this.comment?.match(/\\[pg-structure\\]([\\s\\S]*?)\\[\\/pg-structure\\]/)?.[1];\n    return data ? (JSON.parse(data) as JSONData) : undefined;\n  }\n}\n\nexport class Index {\n  constructor(\n    public name: string,\n    public columns: Column[],\n    public isUnique: boolean,\n    public isPartial: boolean,\n  ) {}\n}\n\nexport class ForeignKey {\n  constructor(\n    public name: string,\n    public table: Table,\n    public referencedTable: Table,\n    public columns: Column[],\n    public isDeferred: boolean,\n    public isDeferrable: boolean,\n    public onDelete: Action,\n  ) {}\n}\n\nexport class M2ORelation {\n  readonly type = \"m2o\";\n\n  constructor(public foreignKey: ForeignKey) {}\n\n  get sourceTable(): Table {\n    return this.foreignKey.table;\n  }\n\n  get targetTable(): Table {\n    return this.foreignKey.referencedTable;\n  }\n\n  /** Uses the old short relation name so M2O metadata keeps its factory evaluation order. */\n  get name(): string {\n    const { foreignKey, sourceTable, targetTable } = this;\n    // I.e. books.author_id and books.reviewer_id both target authors, so sort them as author and reviewer.\n    const hasOtherIncomingFKs = sourceTable.foreignKeys.some(\n      (fk) => fk !== foreignKey && fk.referencedTable === targetTable,\n    );\n\n    return pluralize.singular(hasOtherIncomingFKs ? foreignKey.columns[0].name.replace(/_id$/, \"\") : targetTable.name);\n  }\n}\n\nexport class O2MRelation {\n  readonly type = \"o2m\";\n\n  constructor(public foreignKey: ForeignKey) {}\n\n  get sourceTable(): Table {\n    return this.foreignKey.referencedTable;\n  }\n\n  get targetTable(): Table {\n    return this.foreignKey.table;\n  }\n\n  /** Keeps inverse relations in the same short-name order as pg-structure. */\n  get name(): string {\n    const { foreignKey, sourceTable, targetTable } = this;\n    // I.e. books.author_id and books.reviewer_id are both incoming FKs to authors.\n    const hasOtherIncomingFKs = targetTable.foreignKeys.some(\n      (fk) => fk !== foreignKey && fk.referencedTable === sourceTable,\n    );\n    if (!hasOtherIncomingFKs) return pluralize.plural(targetTable.name);\n\n    const columnName = foreignKey.columns[0].name.replace(/_id$/, \"\");\n    const sourceName = pluralize.singular(sourceTable.name);\n    const adjective = columnName.endsWith(`_${sourceName}`) ? columnName.slice(0, -sourceName.length - 1) : \"\";\n\n    if (sourceTable === targetTable) return pluralize.plural(adjective || targetTable.name);\n    return pluralize.plural(`${adjective || sourceTable.name}_${targetTable.name}`);\n  }\n}\n\nexport class M2MRelation {\n  readonly type = \"m2m\";\n\n  constructor(\n    public foreignKey: ForeignKey,\n    public targetForeignKey: ForeignKey,\n  ) {}\n\n  get sourceTable(): Table {\n    return this.foreignKey.referencedTable;\n  }\n\n  get targetTable(): Table {\n    return this.targetForeignKey.referencedTable;\n  }\n\n  get joinTable(): Table {\n    return this.foreignKey.table;\n  }\n\n  /** Adds the join-table qualifier when more than one join path reaches the same target. */\n  get name(): string {\n    const { sourceTable, joinTable, targetTable } = this;\n    const joinTables = new Set(\n      sourceTable.foreignKeysToThis\n        .filter((fk) => fk.table.foreignKeys.some((other) => other !== fk && other.referencedTable === targetTable))\n        .map((fk) => fk.table),\n    );\n\n    const targetName = pluralize.plural(targetTable.name);\n    if (joinTables.size < 2) return targetName;\n\n    const qualifier = joinTable.name\n      .replace(sourceTable.name, \"\")\n      .replace(targetTable.name, \"\")\n      .replace(/^_+|_+$/g, \"\");\n    return `${qualifier}_${targetName}`;\n  }\n}\n\nexport class Table {\n  readonly columns = new Items<Column>();\n  readonly indexes = new Items<Index>();\n  readonly foreignKeys: ForeignKey[] = [];\n  readonly foreignKeysToThis: ForeignKey[] = [];\n  readonly uniqueConstraints: { columns: Column[]; index: Index }[] = [];\n  primaryKey?: { columns: Column[] };\n\n  constructor(\n    public name: string,\n    public schema: { name: string },\n  ) {}\n\n  get m2oRelations(): M2ORelation[] {\n    return this.foreignKeys.map((fk) => new M2ORelation(fk)).sort((a, b) => compareNames(a.name, b.name));\n  }\n\n  get o2mRelations(): O2MRelation[] {\n    return this.foreignKeysToThis\n      .map((fk) => new O2MRelation(fk))\n      .sort((a, b) => compareNames(a.name.toUpperCase(), b.name.toUpperCase()));\n  }\n\n  get m2mRelations(): M2MRelation[] {\n    return this.foreignKeysToThis\n      .flatMap((fk) => fk.table.foreignKeys.filter((other) => other !== fk).map((other) => new M2MRelation(fk, other)))\n      .sort((a, b) => compareNames(a.name.toUpperCase(), b.name.toUpperCase()));\n  }\n}\n\nexport type Db = { tables: Items<Table>; types: EnumType[] };\n\n/**\n * Reads only the PostgreSQL catalog data used by codegen.\n *\n * Load tables and columns before constraints so each foreign key can link the same Table and Column\n * objects used by entity fields. For example, books.author_id and authors.id are joined through\n * the foreign key, while a trigger calling cyanaudit in another schema is irrelevant to codegen.\n */\nexport async function loadPgMetadata(client: Client): Promise<Db> {\n  const tables = new Items<Table>();\n  const byOid = new Map<number, Table>();\n  const columns = new Map<number, Map<number, Column>>();\n\n  const tableRows = await client.query<{ oid: number; name: string; schema: string }>(`\n    SELECT c.oid, c.relname AS name, n.nspname AS schema\n    FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace\n    WHERE c.relkind IN ('r', 'p') AND n.nspname <> 'information_schema'\n      AND n.nspname NOT LIKE 'pg_%' AND NOT pg_is_other_temp_schema(n.oid)\n    ORDER BY n.nspname, c.relname\n  `);\n  for (const row of tableRows.rows) {\n    const table = new Table(row.name, { name: row.schema });\n    tables.push(table);\n    byOid.set(row.oid, table);\n    columns.set(row.oid, new Map());\n  }\n\n  const enumRows = await client.query<{ oid: number; name: string; value: string }>(`\n    SELECT t.oid, t.typname AS name, e.enumlabel AS value\n    FROM pg_type t JOIN pg_enum e ON e.enumtypid = t.oid\n    JOIN pg_namespace n ON n.oid = t.typnamespace\n    WHERE n.nspname <> 'information_schema' AND n.nspname NOT LIKE 'pg_%'\n    ORDER BY t.oid, e.enumsortorder\n  `);\n  const enums = new Map<number, EnumType>();\n  for (const row of enumRows.rows) {\n    if (!enums.has(row.oid)) enums.set(row.oid, new EnumType(row.name, []));\n    enums.get(row.oid)!.values.push(row.value);\n  }\n\n  const columnRows = await client.query<{\n    tableOid: number;\n    position: number;\n    name: string;\n    typeOid: number;\n    typeName: string;\n    notNull: boolean;\n    defaultValue: string | null;\n    generated: string;\n    arrayDimension: number;\n    comment: string | null;\n  }>(\n    `\n    SELECT a.attrelid AS \"tableOid\", a.attnum AS position, a.attname AS name,\n      COALESCE(NULLIF(t.typelem, 0), t.oid) AS \"typeOid\",\n      base.typname AS \"typeName\", a.attnotnull AS \"notNull\",\n      pg_get_expr(d.adbin, d.adrelid) AS \"defaultValue\", a.attgenerated AS generated,\n      a.attndims AS \"arrayDimension\", col_description(a.attrelid, a.attnum) AS comment\n    FROM pg_attribute a JOIN pg_type t ON t.oid = a.atttypid\n    JOIN pg_type base ON base.oid = COALESCE(NULLIF(t.typelem, 0), t.oid)\n    LEFT JOIN pg_attrdef d ON d.adrelid = a.attrelid AND d.adnum = a.attnum\n    WHERE a.attrelid = ANY($1::oid[]) AND a.attnum > 0 AND NOT a.attisdropped\n    ORDER BY a.attrelid, a.attnum\n  `,\n    [Array.from(byOid.keys())],\n  );\n  for (const row of columnRows.rows) {\n    const type = enums.get(row.typeOid) ?? sqlType(row.typeName);\n    const column = new Column(\n      row.name,\n      type,\n      row.notNull,\n      row.defaultValue,\n      row.generated !== \"\",\n      row.arrayDimension,\n      row.comment,\n    );\n    byOid.get(row.tableOid)!.columns.push(column);\n    columns.get(row.tableOid)!.set(row.position, column);\n  }\n\n  const indexRows = await client.query<{\n    tableOid: number;\n    indexOid: number;\n    name: string;\n    positions: number[];\n    unique: boolean;\n    partial: boolean;\n  }>(\n    `\n    SELECT i.indrelid AS \"tableOid\", i.indexrelid AS \"indexOid\", c.relname AS name,\n      i.indkey::int2[] AS positions, i.indisunique AS unique, i.indpred IS NOT NULL AS partial\n    FROM pg_index i JOIN pg_class c ON c.oid = i.indexrelid\n    WHERE i.indrelid = ANY($1::oid[])\n  `,\n    [Array.from(byOid.keys())],\n  );\n  const indexes = new Map<number, Index>();\n  for (const row of indexRows.rows) {\n    const table = byOid.get(row.tableOid)!;\n    const index = new Index(\n      row.name,\n      row.positions.flatMap((pos) => columns.get(row.tableOid)!.get(pos) ?? []),\n      row.unique,\n      row.partial,\n    );\n    table.indexes.push(index);\n    indexes.set(row.indexOid, index);\n    if (row.unique) for (const column of index.columns) column.uniqueIndexes.push(index);\n  }\n\n  const constraintRows = await client.query<{\n    tableOid: number;\n    targetOid: number;\n    indexOid: number;\n    name: string;\n    kind: string;\n    positions: number[] | null;\n    deferred: boolean;\n    deferrable: boolean;\n    onDelete: string;\n  }>(\n    `\n    SELECT conrelid AS \"tableOid\", confrelid AS \"targetOid\", conindid AS \"indexOid\",\n      conname AS name, contype AS kind, conkey AS positions,\n      condeferred AS deferred, condeferrable AS deferrable, confdeltype AS \"onDelete\"\n    FROM pg_constraint WHERE conrelid = ANY($1::oid[]) AND contype IN ('p', 'u', 'f')\n    ORDER BY conrelid, conname\n  `,\n    [Array.from(byOid.keys())],\n  );\n  for (const row of constraintRows.rows) {\n    const table = byOid.get(row.tableOid)!;\n    const keys = (row.positions ?? []).map((pos) => columns.get(row.tableOid)!.get(pos)!);\n    if (row.kind === \"p\") {\n      table.primaryKey = { columns: keys };\n      for (const column of keys) column.isPrimaryKey = true;\n    } else if (row.kind === \"u\") {\n      table.uniqueConstraints.push({ columns: keys, index: indexes.get(row.indexOid)! });\n    } else {\n      const target = byOid.get(row.targetOid);\n      if (!target) continue;\n      const fk = new ForeignKey(\n        row.name,\n        table,\n        target,\n        keys,\n        row.deferred,\n        row.deferrable,\n        deleteAction(row.onDelete),\n      );\n      table.foreignKeys.push(fk);\n      target.foreignKeysToThis.push(fk);\n      for (const column of keys) column.foreignKeys.push(fk);\n    }\n  }\n\n  return { tables, types: Array.from(enums.values()) };\n}\n\n/** Matches the type names codegen expects from PostgreSQL's builtin aliases. */\nfunction sqlType(name: string): { name: string; shortName?: string } {\n  switch (name) {\n    case \"int2\":\n      return { name: \"smallint\" };\n    case \"int4\":\n      return { name: \"integer\", shortName: \"int\" };\n    case \"int8\":\n      return { name: \"bigint\" };\n    case \"bool\":\n      return { name: \"boolean\" };\n    case \"float4\":\n      return { name: \"real\" };\n    case \"float8\":\n      return { name: \"double precision\" };\n    case \"varchar\":\n      return { name: \"character varying\" };\n    case \"timestamptz\":\n      return { name: \"timestamp with time zone\" };\n    case \"timestamp\":\n      return { name: \"timestamp without time zone\" };\n    case \"time\":\n      return { name: \"time without time zone\" };\n    default:\n      // Foreign-key serdes need shortName even for types with no PostgreSQL alias, such as uuid.\n      return { name, shortName: name };\n  }\n}\n\n/** Decodes the pg_constraint foreign-key delete action. */\nfunction deleteAction(code: string): Action {\n  switch (code) {\n    case \"a\":\n      return \"NO ACTION\";\n    case \"r\":\n      return \"RESTRICT\";\n    case \"c\":\n      return \"CASCADE\";\n    case \"n\":\n      return \"SET NULL\";\n    case \"d\":\n      return \"SET DEFAULT\";\n    default:\n      throw new Error(`Unknown PostgreSQL delete action: ${code}`);\n  }\n}\n\n/** Compares PostgreSQL relation names by code point, independent of the host locale. */\nfunction compareNames(a: string, b: string): number {\n  return a < b ? -1 : a > b ? 1 : 0;\n}\n"],"mappings":";;;AAIA,IAAa,QAAb,cAAuD,MAAS;CAC9D;;CAGA,IAAI,MAAiB;EAGnB,KAAK,WAAW,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC,KAAK,MAAM,IAAI,CAAC,CAAC;EAC7D,MAAM,OAAO,KAAK,OAAO,IAAI,IAAI;EACjC,IAAI,CAAC,MAAM,MAAM,IAAI,MAAM,iBAAiB,MAAM;EAClD,OAAO;CACT;;CAGA,KAAK,GAAG,OAAoB;EAC1B,MAAM,SAAS,MAAM,KAAK,GAAG,KAAK;EAClC,IAAI,KAAK,QAAQ,KAAK,MAAM,QAAQ,OAAO,KAAK,OAAO,IAAI,KAAK,MAAM,IAAI;EAC1E,OAAO;CACT;AACF;AAKA,IAAa,WAAb,MAAsB;CAGX;CACA;CAHT;CACA,YACE,MACA,QACA;EAFO,KAAA,OAAA;EACA,KAAA,SAAA;CACN;AACL;AAEA,IAAa,SAAb,MAAoB;CAMT;CACA;CACA;CACA;CACA;CACA;CACA;CAXT,cAAqC,CAAC;CACtC,gBAAkC,CAAC;CACnC,eAAe;CAEf,YACE,MACA,MACA,SACA,cACA,aACA,gBACA,SACA;EAPO,KAAA,OAAA;EACA,KAAA,OAAA;EACA,KAAA,UAAA;EACA,KAAA,eAAA;EACA,KAAA,cAAA;EACA,KAAA,iBAAA;EACA,KAAA,UAAA;CACN;CAEH,IAAI,eAAwB;EAC1B,OAAO,KAAK,YAAY,SAAS;CACnC;CAEA,IAAI,UAAyB;EAC3B,OAAO,KAAK,cAAc,QAAQ,iBAAiB,IAAI,KAAK;CAC9D;CAEA,IAAI,cAAoC;EACtC,MAAM,OAAO,KAAK,SAAS,MAAM,8CAA8C,CAAC,GAAG;EACnF,OAAO,OAAQ,KAAK,MAAM,IAAI,IAAiB,KAAA;CACjD;AACF;AAEA,IAAa,QAAb,MAAmB;CAER;CACA;CACA;CACA;CAJT,YACE,MACA,SACA,UACA,WACA;EAJO,KAAA,OAAA;EACA,KAAA,UAAA;EACA,KAAA,WAAA;EACA,KAAA,YAAA;CACN;AACL;AAEA,IAAa,aAAb,MAAwB;CAEb;CACA;CACA;CACA;CACA;CACA;CACA;CAPT,YACE,MACA,OACA,iBACA,SACA,YACA,cACA,UACA;EAPO,KAAA,OAAA;EACA,KAAA,QAAA;EACA,KAAA,kBAAA;EACA,KAAA,UAAA;EACA,KAAA,aAAA;EACA,KAAA,eAAA;EACA,KAAA,WAAA;CACN;AACL;AAEA,IAAa,cAAb,MAAyB;CAGJ;CAFnB,OAAgB;CAEhB,YAAY,YAA+B;EAAxB,KAAA,aAAA;CAAyB;CAE5C,IAAI,cAAqB;EACvB,OAAO,KAAK,WAAW;CACzB;CAEA,IAAI,cAAqB;EACvB,OAAO,KAAK,WAAW;CACzB;;CAGA,IAAI,OAAe;EACjB,MAAM,EAAE,YAAY,aAAa,gBAAgB;EAEjD,MAAM,sBAAsB,YAAY,YAAY,MACjD,OAAO,OAAO,cAAc,GAAG,oBAAoB,WACtD;EAEA,OAAO,UAAU,SAAS,sBAAsB,WAAW,QAAQ,EAAE,CAAC,KAAK,QAAQ,QAAQ,EAAE,IAAI,YAAY,IAAI;CACnH;AACF;AAEA,IAAa,cAAb,MAAyB;CAGJ;CAFnB,OAAgB;CAEhB,YAAY,YAA+B;EAAxB,KAAA,aAAA;CAAyB;CAE5C,IAAI,cAAqB;EACvB,OAAO,KAAK,WAAW;CACzB;CAEA,IAAI,cAAqB;EACvB,OAAO,KAAK,WAAW;CACzB;;CAGA,IAAI,OAAe;EACjB,MAAM,EAAE,YAAY,aAAa,gBAAgB;EAKjD,IAAI,CAHwB,YAAY,YAAY,MACjD,OAAO,OAAO,cAAc,GAAG,oBAAoB,WAE/B,GAAG,OAAO,UAAU,OAAO,YAAY,IAAI;EAElE,MAAM,aAAa,WAAW,QAAQ,EAAE,CAAC,KAAK,QAAQ,QAAQ,EAAE;EAChE,MAAM,aAAa,UAAU,SAAS,YAAY,IAAI;EACtD,MAAM,YAAY,WAAW,SAAS,IAAI,YAAY,IAAI,WAAW,MAAM,GAAG,CAAC,WAAW,SAAS,CAAC,IAAI;EAExG,IAAI,gBAAgB,aAAa,OAAO,UAAU,OAAO,aAAa,YAAY,IAAI;EACtF,OAAO,UAAU,OAAO,GAAG,aAAa,YAAY,KAAK,GAAG,YAAY,MAAM;CAChF;AACF;AAEA,IAAa,cAAb,MAAyB;CAId;CACA;CAJT,OAAgB;CAEhB,YACE,YACA,kBACA;EAFO,KAAA,aAAA;EACA,KAAA,mBAAA;CACN;CAEH,IAAI,cAAqB;EACvB,OAAO,KAAK,WAAW;CACzB;CAEA,IAAI,cAAqB;EACvB,OAAO,KAAK,iBAAiB;CAC/B;CAEA,IAAI,YAAmB;EACrB,OAAO,KAAK,WAAW;CACzB;;CAGA,IAAI,OAAe;EACjB,MAAM,EAAE,aAAa,WAAW,gBAAgB;EAChD,MAAM,aAAa,IAAI,IACrB,YAAY,kBACT,QAAQ,OAAO,GAAG,MAAM,YAAY,MAAM,UAAU,UAAU,MAAM,MAAM,oBAAoB,WAAW,CAAC,CAAC,CAC3G,KAAK,OAAO,GAAG,KAAK,CACzB;EAEA,MAAM,aAAa,UAAU,OAAO,YAAY,IAAI;EACpD,IAAI,WAAW,OAAO,GAAG,OAAO;EAMhC,OAAO,GAJW,UAAU,KACzB,QAAQ,YAAY,MAAM,EAAE,CAAC,CAC7B,QAAQ,YAAY,MAAM,EAAE,CAAC,CAC7B,QAAQ,YAAY,EACL,EAAE,GAAG;CACzB;AACF;AAEA,IAAa,QAAb,MAAmB;CASR;CACA;CATT,UAAmB,IAAI,MAAc;CACrC,UAAmB,IAAI,MAAa;CACpC,cAAqC,CAAC;CACtC,oBAA2C,CAAC;CAC5C,oBAAoE,CAAC;CACrE;CAEA,YACE,MACA,QACA;EAFO,KAAA,OAAA;EACA,KAAA,SAAA;CACN;CAEH,IAAI,eAA8B;EAChC,OAAO,KAAK,YAAY,KAAK,OAAO,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,MAAM,aAAa,EAAE,MAAM,EAAE,IAAI,CAAC;CACtG;CAEA,IAAI,eAA8B;EAChC,OAAO,KAAK,kBACT,KAAK,OAAO,IAAI,YAAY,EAAE,CAAC,CAAC,CAChC,MAAM,GAAG,MAAM,aAAa,EAAE,KAAK,YAAY,GAAG,EAAE,KAAK,YAAY,CAAC,CAAC;CAC5E;CAEA,IAAI,eAA8B;EAChC,OAAO,KAAK,kBACT,SAAS,OAAO,GAAG,MAAM,YAAY,QAAQ,UAAU,UAAU,EAAE,CAAC,CAAC,KAAK,UAAU,IAAI,YAAY,IAAI,KAAK,CAAC,CAAC,CAAC,CAChH,MAAM,GAAG,MAAM,aAAa,EAAE,KAAK,YAAY,GAAG,EAAE,KAAK,YAAY,CAAC,CAAC;CAC5E;AACF;;;;;;;;AAWA,eAAsB,eAAe,QAA6B;CAChE,MAAM,SAAS,IAAI,MAAa;CAChC,MAAM,wBAAQ,IAAI,IAAmB;CACrC,MAAM,0BAAU,IAAI,IAAiC;CAErD,MAAM,YAAY,MAAM,OAAO,MAAqD;;;;;;GAMnF;CACD,KAAK,MAAM,OAAO,UAAU,MAAM;EAChC,MAAM,QAAQ,IAAI,MAAM,IAAI,MAAM,EAAE,MAAM,IAAI,OAAO,CAAC;EACtD,OAAO,KAAK,KAAK;EACjB,MAAM,IAAI,IAAI,KAAK,KAAK;EACxB,QAAQ,IAAI,IAAI,qBAAK,IAAI,IAAI,CAAC;CAChC;CAEA,MAAM,WAAW,MAAM,OAAO,MAAoD;;;;;;GAMjF;CACD,MAAM,wBAAQ,IAAI,IAAsB;CACxC,KAAK,MAAM,OAAO,SAAS,MAAM;EAC/B,IAAI,CAAC,MAAM,IAAI,IAAI,GAAG,GAAG,MAAM,IAAI,IAAI,KAAK,IAAI,SAAS,IAAI,MAAM,CAAC,CAAC,CAAC;EACtE,MAAM,IAAI,IAAI,GAAG,CAAC,CAAE,OAAO,KAAK,IAAI,KAAK;CAC3C;CAEA,MAAM,aAAa,MAAM,OAAO,MAY9B;;;;;;;;;;;KAYA,CAAC,MAAM,KAAK,MAAM,KAAK,CAAC,CAAC,CAC3B;CACA,KAAK,MAAM,OAAO,WAAW,MAAM;EACjC,MAAM,OAAO,MAAM,IAAI,IAAI,OAAO,KAAK,QAAQ,IAAI,QAAQ;EAC3D,MAAM,SAAS,IAAI,OACjB,IAAI,MACJ,MACA,IAAI,SACJ,IAAI,cACJ,IAAI,cAAc,IAClB,IAAI,gBACJ,IAAI,OACN;EACA,MAAM,IAAI,IAAI,QAAQ,CAAC,CAAE,QAAQ,KAAK,MAAM;EAC5C,QAAQ,IAAI,IAAI,QAAQ,CAAC,CAAE,IAAI,IAAI,UAAU,MAAM;CACrD;CAEA,MAAM,YAAY,MAAM,OAAO,MAQ7B;;;;;KAMA,CAAC,MAAM,KAAK,MAAM,KAAK,CAAC,CAAC,CAC3B;CACA,MAAM,0BAAU,IAAI,IAAmB;CACvC,KAAK,MAAM,OAAO,UAAU,MAAM;EAChC,MAAM,QAAQ,MAAM,IAAI,IAAI,QAAQ;EACpC,MAAM,QAAQ,IAAI,MAChB,IAAI,MACJ,IAAI,UAAU,SAAS,QAAQ,QAAQ,IAAI,IAAI,QAAQ,CAAC,CAAE,IAAI,GAAG,KAAK,CAAC,CAAC,GACxE,IAAI,QACJ,IAAI,OACN;EACA,MAAM,QAAQ,KAAK,KAAK;EACxB,QAAQ,IAAI,IAAI,UAAU,KAAK;EAC/B,IAAI,IAAI,QAAQ,KAAK,MAAM,UAAU,MAAM,SAAS,OAAO,cAAc,KAAK,KAAK;CACrF;CAEA,MAAM,iBAAiB,MAAM,OAAO,MAWlC;;;;;;KAOA,CAAC,MAAM,KAAK,MAAM,KAAK,CAAC,CAAC,CAC3B;CACA,KAAK,MAAM,OAAO,eAAe,MAAM;EACrC,MAAM,QAAQ,MAAM,IAAI,IAAI,QAAQ;EACpC,MAAM,QAAQ,IAAI,aAAa,CAAC,EAAA,CAAG,KAAK,QAAQ,QAAQ,IAAI,IAAI,QAAQ,CAAC,CAAE,IAAI,GAAG,CAAE;EACpF,IAAI,IAAI,SAAS,KAAK;GACpB,MAAM,aAAa,EAAE,SAAS,KAAK;GACnC,KAAK,MAAM,UAAU,MAAM,OAAO,eAAe;EACnD,OAAO,IAAI,IAAI,SAAS,KACtB,MAAM,kBAAkB,KAAK;GAAE,SAAS;GAAM,OAAO,QAAQ,IAAI,IAAI,QAAQ;EAAG,CAAC;OAC5E;GACL,MAAM,SAAS,MAAM,IAAI,IAAI,SAAS;GACtC,IAAI,CAAC,QAAQ;GACb,MAAM,KAAK,IAAI,WACb,IAAI,MACJ,OACA,QACA,MACA,IAAI,UACJ,IAAI,YACJ,aAAa,IAAI,QAAQ,CAC3B;GACA,MAAM,YAAY,KAAK,EAAE;GACzB,OAAO,kBAAkB,KAAK,EAAE;GAChC,KAAK,MAAM,UAAU,MAAM,OAAO,YAAY,KAAK,EAAE;EACvD;CACF;CAEA,OAAO;EAAE;EAAQ,OAAO,MAAM,KAAK,MAAM,OAAO,CAAC;CAAE;AACrD;;AAGA,SAAS,QAAQ,MAAoD;CACnE,QAAQ,MAAR;EACE,KAAK,QACH,OAAO,EAAE,MAAM,WAAW;EAC5B,KAAK,QACH,OAAO;GAAE,MAAM;GAAW,WAAW;EAAM;EAC7C,KAAK,QACH,OAAO,EAAE,MAAM,SAAS;EAC1B,KAAK,QACH,OAAO,EAAE,MAAM,UAAU;EAC3B,KAAK,UACH,OAAO,EAAE,MAAM,OAAO;EACxB,KAAK,UACH,OAAO,EAAE,MAAM,mBAAmB;EACpC,KAAK,WACH,OAAO,EAAE,MAAM,oBAAoB;EACrC,KAAK,eACH,OAAO,EAAE,MAAM,2BAA2B;EAC5C,KAAK,aACH,OAAO,EAAE,MAAM,8BAA8B;EAC/C,KAAK,QACH,OAAO,EAAE,MAAM,yBAAyB;EAC1C,SAEE,OAAO;GAAE;GAAM,WAAW;EAAK;CACnC;AACF;;AAGA,SAAS,aAAa,MAAsB;CAC1C,QAAQ,MAAR;EACE,KAAK,KACH,OAAO;EACT,KAAK,KACH,OAAO;EACT,KAAK,KACH,OAAO;EACT,KAAK,KACH,OAAO;EACT,KAAK,KACH,OAAO;EACT,SACE,MAAM,IAAI,MAAM,qCAAqC,MAAM;CAC/D;AACF;;AAGA,SAAS,aAAa,GAAW,GAAmB;CAClD,OAAO,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI;AAClC"}

package/build/scanEntityFiles.cjs

@@ -0,0 +1,46 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./config.cjs");
+require("./EntityDbMetadata.cjs");
+let path = require("path");
+let fs_promises = require("fs/promises");
+//#region src/scanEntityFiles.ts
+const regex = /config\.setDefault\([\s\n]*["'](\w+)["']/g;
+/** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */
+async function scanEntityFiles(config, dbMeta) {
+	await Promise.all(dbMeta.entities.map(async (entity) => {
+		try {
+			const tsCode = (await (0, fs_promises.readFile)((0, path.join)(config.entitiesDirectory, `${entity.name}.ts`))).toString();
+			const defaultableFields = recursiveDefaultableFields(dbMeta, entity);
+			for (const match of tsCode.matchAll(regex)) {
+				const field = defaultableFields.find((f) => f.fieldName === match[1]);
+				if (field) field.hasConfigDefault = true;
+			}
+		} catch (e) {}
+	}));
+}
+/**
+* Traverse the entity inheritance tree to find all fields that can have defaults set on them.
+*
+* I.e. a column defined in a base CTI table like `publishers.foo_bar` having a `config.setDefault` in
+* `SmallPublisher` and/or `LargePublisher`, or the same scenario for an STI table like `tasks.foo_bar`
+* with `TaskNew` and/or `TaskOld`.
+*
+* NOTE: I suspect here could be some edge cases here that will need to be ironed out, but should work
+* for simple inheritance structures. In particular, there may be unexpected side effects if a base
+* class field has a default set in one subtype, but not another.
+*/
+function recursiveDefaultableFields(dbMeta, entity) {
+	if (!entity) return [];
+	return [
+		...entity.primitives,
+		...entity.enums,
+		...entity.pgEnums,
+		...entity.manyToOnes,
+		...entity.polymorphics,
+		...entity.baseClassName ? recursiveDefaultableFields(dbMeta, dbMeta.entitiesByName[entity.baseClassName]) : []
+	];
+}
+//#endregion
+exports.scanEntityFiles = scanEntityFiles;
+
+//# sourceMappingURL=scanEntityFiles.cjs.map

package/build/scanEntityFiles.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanEntityFiles.cjs","names":["readFile","join"],"sources":["../src/scanEntityFiles.ts"],"sourcesContent":["import { readFile } from \"fs/promises\";\nimport { join } from \"path\";\n\nimport { type Config } from \"./config.ts\";\nimport {\n  type DbMetadata,\n  type EntityDbMetadata,\n  type EnumField,\n  type ManyToOneField,\n  type PgEnumField,\n  type PolymorphicField,\n  type PrimitiveField,\n} from \"./EntityDbMetadata.ts\";\n\n// Erg, we need a regex in case the fieldName arg is wrapped onto a new line... :-/\nconst regex = /config\\.setDefault\\([\\s\\n]*[\"'](\\w+)[\"']/g;\n\n/** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */\nexport async function scanEntityFiles(config: Config, dbMeta: DbMetadata): Promise<void> {\n  await Promise.all(\n    dbMeta.entities.map(async (entity) => {\n      try {\n        // load the entity.ts file (as a promise with fs/promises)\n        const tsCode = (await readFile(join(config.entitiesDirectory, `${entity.name}.ts`))).toString();\n        const defaultableFields = recursiveDefaultableFields(dbMeta, entity);\n        for (const match of tsCode.matchAll(regex)) {\n          const field = defaultableFields.find((f) => f.fieldName === match[1]);\n          if (field) {\n            field.hasConfigDefault = true;\n          }\n        }\n      } catch (e) {\n        // Ignore file not existing yet\n      }\n    }),\n  );\n}\n\n/**\n * Traverse the entity inheritance tree to find all fields that can have defaults set on them.\n *\n * I.e. a column defined in a base CTI table like `publishers.foo_bar` having a `config.setDefault` in\n * `SmallPublisher` and/or `LargePublisher`, or the same scenario for an STI table like `tasks.foo_bar`\n * with `TaskNew` and/or `TaskOld`.\n *\n * NOTE: I suspect here could be some edge cases here that will need to be ironed out, but should work\n * for simple inheritance structures. In particular, there may be unexpected side effects if a base\n * class field has a default set in one subtype, but not another.\n */\nfunction recursiveDefaultableFields(\n  dbMeta: DbMetadata,\n  entity: EntityDbMetadata | undefined,\n): Array<PrimitiveField | EnumField | PgEnumField | ManyToOneField | PolymorphicField> {\n  if (!entity) return [];\n  return [\n    ...entity.primitives,\n    ...entity.enums,\n    ...entity.pgEnums,\n    ...entity.manyToOnes,\n    ...entity.polymorphics,\n    ...(entity.baseClassName ? recursiveDefaultableFields(dbMeta, dbMeta.entitiesByName[entity.baseClassName]) : []),\n  ];\n}\n"],"mappings":";;;;;;AAeA,MAAM,QAAQ;;AAGd,eAAsB,gBAAgB,QAAgB,QAAmC;CACvF,MAAM,QAAQ,IACZ,OAAO,SAAS,IAAI,OAAO,WAAW;EACpC,IAAI;GAEF,MAAM,UAAU,OAAA,GAAMA,YAAAA,SAAAA,EAAAA,GAASC,KAAAA,KAAAA,CAAK,OAAO,mBAAmB,GAAG,OAAO,KAAK,IAAI,CAAC,EAAA,CAAG,SAAS;GAC9F,MAAM,oBAAoB,2BAA2B,QAAQ,MAAM;GACnE,KAAK,MAAM,SAAS,OAAO,SAAS,KAAK,GAAG;IAC1C,MAAM,QAAQ,kBAAkB,MAAM,MAAM,EAAE,cAAc,MAAM,EAAE;IACpE,IAAI,OACF,MAAM,mBAAmB;GAE7B;EACF,SAAS,GAAG,CAEZ;CACF,CAAC,CACH;AACF;;;;;;;;;;;;AAaA,SAAS,2BACP,QACA,QACqF;CACrF,IAAI,CAAC,QAAQ,OAAO,CAAC;CACrB,OAAO;EACL,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAI,OAAO,gBAAgB,2BAA2B,QAAQ,OAAO,eAAe,OAAO,cAAc,IAAI,CAAC;CAChH;AACF"}

package/build/scanEntityFiles.d.cts

@@ -0,0 +1,8 @@
+import { Config } from "./config.cjs";
+import { DbMetadata } from "./EntityDbMetadata.cjs";
+//#region src/scanEntityFiles.d.ts
+/** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */
+declare function scanEntityFiles(config: Config, dbMeta: DbMetadata): Promise<void>;
+//#endregion
+export { scanEntityFiles };
+//# sourceMappingURL=scanEntityFiles.d.cts.map

package/build/scanEntityFiles.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanEntityFiles.d.cts","names":[],"sources":["../src/scanEntityFiles.ts"],"mappings":";;;;iBAkBsB,gBAAgB,QAAQ,QAAQ,QAAQ,aAAa"}

package/build/scanEntityFiles.d.mts

@@ -0,0 +1,8 @@
+import { Config } from "./config.mjs";
+import { DbMetadata } from "./EntityDbMetadata.mjs";
+//#region src/scanEntityFiles.d.ts
+/** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */
+declare function scanEntityFiles(config: Config, dbMeta: DbMetadata): Promise<void>;
+//#endregion
+export { scanEntityFiles };
+//# sourceMappingURL=scanEntityFiles.d.mts.map

package/build/scanEntityFiles.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scanEntityFiles.d.mts","names":[],"sources":["../src/scanEntityFiles.ts"],"mappings":";;;;iBAkBsB,gBAAgB,QAAQ,QAAQ,QAAQ,aAAa"}

package/build/scanEntityFiles.js

@@ -1,50 +1,45 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.scanEntityFiles = scanEntityFiles;
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-// Erg, we need a regex in case the fieldName arg is wrapped onto a new line... :-/
+import "./config.js";
+import "./EntityDbMetadata.js";
+import { join } from "path";
+import { readFile } from "fs/promises";
+//#region src/scanEntityFiles.ts
 const regex = /config\.setDefault\([\s\n]*["'](\w+)["']/g;
 /** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */
 async function scanEntityFiles(config, dbMeta) {
-    await Promise.all(dbMeta.entities.map(async (entity) => {
-        try {
-            // load the entity.ts file (as a promise with fs/promises)
-            const tsCode = (await (0, promises_1.readFile)((0, path_1.join)(config.entitiesDirectory, `${entity.name}.ts`))).toString();
-            const defaultableFields = recursiveDefaultableFields(dbMeta, entity);
-            for (const match of tsCode.matchAll(regex)) {
-                const field = defaultableFields.find((f) => f.fieldName === match[1]);
-                if (field) {
-                    field.hasConfigDefault = true;
-                }
-            }
-        }
-        catch (e) {
-            // Ignore file not existing yet
-        }
-    }));
+	await Promise.all(dbMeta.entities.map(async (entity) => {
+		try {
+			const tsCode = (await readFile(join(config.entitiesDirectory, `${entity.name}.ts`))).toString();
+			const defaultableFields = recursiveDefaultableFields(dbMeta, entity);
+			for (const match of tsCode.matchAll(regex)) {
+				const field = defaultableFields.find((f) => f.fieldName === match[1]);
+				if (field) field.hasConfigDefault = true;
+			}
+		} catch (e) {}
+	}));
 }
 /**
- * Traverse the entity inheritance tree to find all fields that can have defaults set on them.
- *
- * I.e. a column defined in a base CTI table like `publishers.foo_bar` having a `config.setDefault` in
- * `SmallPublisher` and/or `LargePublisher`, or the same scenario for an STI table like `tasks.foo_bar`
- * with `TaskNew` and/or `TaskOld`.
- *
- * NOTE: I suspect here could be some edge cases here that will need to be ironed out, but should work
- * for simple inheritance structures. In particular, there may be unexpected side effects if a base
- * class field has a default set in one subtype, but not another.
- */
+* Traverse the entity inheritance tree to find all fields that can have defaults set on them.
+*
+* I.e. a column defined in a base CTI table like `publishers.foo_bar` having a `config.setDefault` in
+* `SmallPublisher` and/or `LargePublisher`, or the same scenario for an STI table like `tasks.foo_bar`
+* with `TaskNew` and/or `TaskOld`.
+*
+* NOTE: I suspect here could be some edge cases here that will need to be ironed out, but should work
+* for simple inheritance structures. In particular, there may be unexpected side effects if a base
+* class field has a default set in one subtype, but not another.
+*/
 function recursiveDefaultableFields(dbMeta, entity) {
-    if (!entity)
-        return [];
-    return [
-        ...entity.primitives,
-        ...entity.enums,
-        ...entity.pgEnums,
-        ...entity.manyToOnes,
-        ...entity.polymorphics,
-        ...(entity.baseClassName ? recursiveDefaultableFields(dbMeta, dbMeta.entitiesByName[entity.baseClassName]) : []),
-    ];
+	if (!entity) return [];
+	return [
+		...entity.primitives,
+		...entity.enums,
+		...entity.pgEnums,
+		...entity.manyToOnes,
+		...entity.polymorphics,
+		...entity.baseClassName ? recursiveDefaultableFields(dbMeta, dbMeta.entitiesByName[entity.baseClassName]) : []
+	];
 }
+//#endregion
+export { scanEntityFiles };
+
 //# sourceMappingURL=scanEntityFiles.js.map

package/build/scanEntityFiles.js.map

@@ -1 +1 @@
-{"version":3,"file":"scanEntityFiles.js","sourceRoot":"","sources":["../src/scanEntityFiles.ts"],"names":[],"mappings":";;AAiBA,0CAkBC;AAnCD,0CAAuC;AACvC,+BAA4B;AAY5B,mFAAmF;AACnF,MAAM,KAAK,GAAG,2CAA2C,CAAC;AAE1D,+GAA+G;AACxG,KAAK,UAAU,eAAe,CAAC,MAAc,EAAE,MAAkB;IACtE,MAAM,OAAO,CAAC,GAAG,CACf,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;QACnC,IAAI,CAAC;YACH,0DAA0D;YAC1D,MAAM,MAAM,GAAG,CAAC,MAAM,IAAA,mBAAQ,EAAC,IAAA,WAAI,EAAC,MAAM,CAAC,iBAAiB,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;YAChG,MAAM,iBAAiB,GAAG,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrE,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACtE,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,CAAC,gBAAgB,GAAG,IAAI,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,+BAA+B;QACjC,CAAC;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,0BAA0B,CACjC,MAAkB,EAClB,MAAoC;IAEpC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IACvB,OAAO;QACL,GAAG,MAAM,CAAC,UAAU;QACpB,GAAG,MAAM,CAAC,KAAK;QACf,GAAG,MAAM,CAAC,OAAO;QACjB,GAAG,MAAM,CAAC,UAAU;QACpB,GAAG,MAAM,CAAC,YAAY;QACtB,GAAG,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,0BAA0B,CAAC,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACjH,CAAC;AACJ,CAAC"}
+{"version":3,"file":"scanEntityFiles.js","names":[],"sources":["../src/scanEntityFiles.ts"],"sourcesContent":["import { readFile } from \"fs/promises\";\nimport { join } from \"path\";\n\nimport { type Config } from \"./config.ts\";\nimport {\n  type DbMetadata,\n  type EntityDbMetadata,\n  type EnumField,\n  type ManyToOneField,\n  type PgEnumField,\n  type PolymorphicField,\n  type PrimitiveField,\n} from \"./EntityDbMetadata.ts\";\n\n// Erg, we need a regex in case the fieldName arg is wrapped onto a new line... :-/\nconst regex = /config\\.setDefault\\([\\s\\n]*[\"'](\\w+)[\"']/g;\n\n/** Scans the entity files themselves for usage hints (like `setDefault` calls) to drive our codegen output. */\nexport async function scanEntityFiles(config: Config, dbMeta: DbMetadata): Promise<void> {\n  await Promise.all(\n    dbMeta.entities.map(async (entity) => {\n      try {\n        // load the entity.ts file (as a promise with fs/promises)\n        const tsCode = (await readFile(join(config.entitiesDirectory, `${entity.name}.ts`))).toString();\n        const defaultableFields = recursiveDefaultableFields(dbMeta, entity);\n        for (const match of tsCode.matchAll(regex)) {\n          const field = defaultableFields.find((f) => f.fieldName === match[1]);\n          if (field) {\n            field.hasConfigDefault = true;\n          }\n        }\n      } catch (e) {\n        // Ignore file not existing yet\n      }\n    }),\n  );\n}\n\n/**\n * Traverse the entity inheritance tree to find all fields that can have defaults set on them.\n *\n * I.e. a column defined in a base CTI table like `publishers.foo_bar` having a `config.setDefault` in\n * `SmallPublisher` and/or `LargePublisher`, or the same scenario for an STI table like `tasks.foo_bar`\n * with `TaskNew` and/or `TaskOld`.\n *\n * NOTE: I suspect here could be some edge cases here that will need to be ironed out, but should work\n * for simple inheritance structures. In particular, there may be unexpected side effects if a base\n * class field has a default set in one subtype, but not another.\n */\nfunction recursiveDefaultableFields(\n  dbMeta: DbMetadata,\n  entity: EntityDbMetadata | undefined,\n): Array<PrimitiveField | EnumField | PgEnumField | ManyToOneField | PolymorphicField> {\n  if (!entity) return [];\n  return [\n    ...entity.primitives,\n    ...entity.enums,\n    ...entity.pgEnums,\n    ...entity.manyToOnes,\n    ...entity.polymorphics,\n    ...(entity.baseClassName ? recursiveDefaultableFields(dbMeta, dbMeta.entitiesByName[entity.baseClassName]) : []),\n  ];\n}\n"],"mappings":";;;;;AAeA,MAAM,QAAQ;;AAGd,eAAsB,gBAAgB,QAAgB,QAAmC;CACvF,MAAM,QAAQ,IACZ,OAAO,SAAS,IAAI,OAAO,WAAW;EACpC,IAAI;GAEF,MAAM,UAAU,MAAM,SAAS,KAAK,OAAO,mBAAmB,GAAG,OAAO,KAAK,IAAI,CAAC,EAAA,CAAG,SAAS;GAC9F,MAAM,oBAAoB,2BAA2B,QAAQ,MAAM;GACnE,KAAK,MAAM,SAAS,OAAO,SAAS,KAAK,GAAG;IAC1C,MAAM,QAAQ,kBAAkB,MAAM,MAAM,EAAE,cAAc,MAAM,EAAE;IACpE,IAAI,OACF,MAAM,mBAAmB;GAE7B;EACF,SAAS,GAAG,CAEZ;CACF,CAAC,CACH;AACF;;;;;;;;;;;;AAaA,SAAS,2BACP,QACA,QACqF;CACrF,IAAI,CAAC,QAAQ,OAAO,CAAC;CACrB,OAAO;EACL,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAG,OAAO;EACV,GAAI,OAAO,gBAAgB,2BAA2B,QAAQ,OAAO,eAAe,OAAO,cAAc,IAAI,CAAC;CAChH;AACF"}

package/build/sortForeignKeys.cjs

@@ -0,0 +1,99 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("./EntityDbMetadata.cjs");
+//#region src/sortForeignKeys.ts
+/**
+* Sorts entities by non-deferred foreign key order.
+*
+* Ideally databases/schemas will support/enable deferred FKs, which let us insert/delete rows
+* in any arbitrary order, and the FK checks will not be applied until txn commit.
+*
+* However, if not enabled/support, we have to worry about two things:
+*
+* 1. Inserting "parents" before their children
+*    - And if the parent has a circular reference to not-yet-inserted cycle
+* 2. Deleting "children" before their parents
+*    - Again if the parent has a circular reference to the child
+*
+* For both of these, we can just look at the FK ordering to "put the parent first",
+* but run into two problems:
+*
+* - If there is a cycle for not-null FKs, that breaks both INSERTs and DELETEs, so we
+* must warn the user about these to fix.
+* - If there is a cycle with nullable FKs, we can work around that by using NULL as a
+* transient/dummy value, for the initial insert, do the 2nd insert, and then "fixup" the
+* first insert with a UPDATE to the actual column value.
+*
+* Given ^, we set the `entity.nonDeferredFkOrder` of each entity, and then also return
+* two arrays of all soft-cycle (nullable, fixup-able) and hard-cycle (not-nullable, blocking)
+* keys.
+*/
+function sortByNonDeferredForeignKeys(entities) {
+	const graph = Object.fromEntries(entities.map((e) => [e.name, {
+		entity: e,
+		upstreamFks: /* @__PURE__ */ new Set(),
+		downstreamFks: /* @__PURE__ */ new Set()
+	}]));
+	const nullableCycles = [];
+	const notNullCycles = [];
+	entities.forEach((entity) => {
+		entity.nonDeferredFks.filter((m2o) => m2o.notNull).forEach((m2o) => {
+			const added = addDependency(graph, entity, m2o);
+			if (Array.isArray(added)) notNullCycles.push(added.join(" -> "));
+		});
+	});
+	entities.forEach((entity) => {
+		entity.nonDeferredFks.filter((m2o) => !m2o.notNull).forEach((m2o) => {
+			const added = addDependency(graph, entity, m2o);
+			if (Array.isArray(added)) nullableCycles.push(added.join(" -> "));
+		});
+	});
+	let queue = Object.values(graph).filter((n) => n.upstreamFks.size === 0);
+	let level = 1;
+	while (queue.length > 0) {
+		const nextLevel = [];
+		for (const current of queue) {
+			current.entity.nonDeferredFkOrder = level;
+			current.downstreamFks.forEach((node) => {
+				if (node.upstreamFks.delete(current) && node.upstreamFks.size === 0) nextLevel.push(node);
+			});
+		}
+		queue = nextLevel;
+		level++;
+	}
+	entities.filter((e) => e.nonDeferredFkOrder === -1).forEach((e) => e.nonDeferredFkOrder = 1e5);
+	return {
+		nullableCycles,
+		notNullCycles
+	};
+}
+function addDependency(graph, entity, m2o) {
+	const from = graph[entity.name];
+	const to = graph[m2o.otherEntity.name];
+	const cycle = willCreateCycle(graph, from, to);
+	if (cycle) return cycle;
+	from.upstreamFks.add(to);
+	to.downstreamFks.add(from);
+	return true;
+}
+function willCreateCycle(graph, from, to) {
+	return dfs(graph, /* @__PURE__ */ new Set(), /* @__PURE__ */ new Set(), [], from, to);
+}
+function dfs(graph, visited, stack, path, current, target) {
+	visited.add(current);
+	stack.add(current);
+	path.push(current);
+	for (const neighbor of current.downstreamFks) {
+		if (neighbor === target) return [...path, neighbor].map((n) => n.entity.name);
+		if (!visited.has(neighbor)) {
+			const cycle = dfs(graph, visited, stack, path, neighbor, target);
+			if (cycle) return cycle;
+		}
+	}
+	stack.delete(current);
+	path.pop();
+	return false;
+}
+//#endregion
+exports.sortByNonDeferredForeignKeys = sortByNonDeferredForeignKeys;
+
+//# sourceMappingURL=sortForeignKeys.cjs.map