joist-codegen 2.3.0 → 2.4.0

package/build/tsdoc.d.cts

@@ -0,0 +1,15 @@
+//#region src/tsdoc.d.ts
+declare const tsdocComments: {
+  entity: {
+    setPartial: string;
+    setDeepPartial: string;
+    changes: string;
+    load: string;
+    populate: string;
+    isLoaded: string;
+    toJSON: string;
+  };
+};
+//#endregion
+export { tsdocComments };
+//# sourceMappingURL=tsdoc.d.cts.map

package/build/tsdoc.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsdoc.d.cts","names":[],"sources":["../src/tsdoc.ts"],"mappings":";cAIa;EACX;IACE;IAmBA;IAoBA;IAKA;IAKA;IAKA;IAMA"}

package/build/tsdoc.d.mts

@@ -0,0 +1,15 @@
+//#region src/tsdoc.d.ts
+declare const tsdocComments: {
+  entity: {
+    setPartial: string;
+    setDeepPartial: string;
+    changes: string;
+    load: string;
+    populate: string;
+    isLoaded: string;
+    toJSON: string;
+  };
+};
+//#endregion
+export { tsdocComments };
+//# sourceMappingURL=tsdoc.d.mts.map

package/build/tsdoc.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tsdoc.d.mts","names":[],"sources":["../src/tsdoc.ts"],"mappings":";cAIa;EACX;IACE;IAmBA;IAoBA;IAKA;IAKA;IAKA;IAMA"}

package/build/tsdoc.js

@@ -1,18 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tsdocComments = void 0;
+//#region src/tsdoc.ts
 function makeTsDocComment(...lines) {
-    return ["/**", ...lines.map((l) => `* ${l}`), "*/"].join("\n");
+	return [
+		"/**",
+		...lines.map((l) => `* ${l}`),
+		"*/"
+	].join("\n");
 }
-exports.tsdocComments = {
-    entity: {
-        setPartial: makeTsDocComment("Partial update taking any subset of the entities fields.", "", 'Unlike `set`, null is used as a marker to mean "unset this field", and undefined', "is left as untouched.", "", "Collections are exhaustively set to the new values, however,", "{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. ", "", "@example", "```", "entity.setPartial({", "  firstName: 'foo' // updated", "  lastName: undefined // do nothing", "  age: null // unset, (i.e. set it as undefined)", "});", "```", "@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs "),
-        setDeepPartial: makeTsDocComment("Partial update taking any nested subset of the entities fields.", "", 'Unlike `set`, null is used as a marker to mean "unset this field", and undefined', "is left as untouched.", "", "Collections are exhaustively set to the new values, however,", "{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. ", "", "@example", "```", "entity.setDeepPartial({", "  firstName: 'foo' // updated", "  lastName: undefined // do nothing", "  age: null // unset, (i.e. set it as undefined)", '  books: [{ title: "b1" }], // create a child book', "});", "```", "@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs "),
-        changes: makeTsDocComment("Details the field changes of the entity within the current unit of work.", "", "@see {@link https://joist-orm.io/features/changed-fields | Changed Fields} on the Joist docs "),
-        load: makeTsDocComment("Traverse from this entity using a lens, and load the result.", "", "@see {@link https://joist-orm.io/advanced/lenses | Lens Traversal} on the Joist docs"),
-        populate: makeTsDocComment("Hydrate this entity using a load hint", "", "@see {@link https://joist-orm.io/features/loading-entities#1-object-graph-navigation | Loading entities} on the Joist docs"),
-        isLoaded: makeTsDocComment("Given a load hint, checks if it is loaded within the unit of work.", "", "Type Guarded via Loaded<>", ""),
-        toJSON: makeTsDocComment("Build a type-safe, loadable and relation aware POJO from this entity, given a hint.", "", "Note: As the hint might load, this returns a Promise", "", "@example", "```", "const payload = await a.toJSON({", "  id: true,", "  books: { id: true, reviews: { rating: true } }", "});", "```", "@see {@link https://joist-orm.io/advanced/json-payloads | Json Payloads} on the Joist docs"),
-    },
-};
+const tsdocComments = { entity: {
+	setPartial: makeTsDocComment("Partial update taking any subset of the entities fields.", "", "Unlike `set`, null is used as a marker to mean \"unset this field\", and undefined", "is left as untouched.", "", "Collections are exhaustively set to the new values, however,", "{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. ", "", "@example", "```", "entity.setPartial({", "  firstName: 'foo' // updated", "  lastName: undefined // do nothing", "  age: null // unset, (i.e. set it as undefined)", "});", "```", "@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs "),
+	setDeepPartial: makeTsDocComment("Partial update taking any nested subset of the entities fields.", "", "Unlike `set`, null is used as a marker to mean \"unset this field\", and undefined", "is left as untouched.", "", "Collections are exhaustively set to the new values, however,", "{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. ", "", "@example", "```", "entity.setDeepPartial({", "  firstName: 'foo' // updated", "  lastName: undefined // do nothing", "  age: null // unset, (i.e. set it as undefined)", "  books: [{ title: \"b1\" }], // create a child book", "});", "```", "@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs "),
+	changes: makeTsDocComment("Details the field changes of the entity within the current unit of work.", "", "@see {@link https://joist-orm.io/features/changed-fields | Changed Fields} on the Joist docs "),
+	load: makeTsDocComment("Traverse from this entity using a lens, and load the result.", "", "@see {@link https://joist-orm.io/advanced/lenses | Lens Traversal} on the Joist docs"),
+	populate: makeTsDocComment("Hydrate this entity using a load hint", "", "@see {@link https://joist-orm.io/features/loading-entities#1-object-graph-navigation | Loading entities} on the Joist docs"),
+	isLoaded: makeTsDocComment("Given a load hint, checks if it is loaded within the unit of work.", "", "Type Guarded via Loaded<>", ""),
+	toJSON: makeTsDocComment("Build a type-safe, loadable and relation aware POJO from this entity, given a hint.", "", "Note: As the hint might load, this returns a Promise", "", "@example", "```", "const payload = await a.toJSON({", "  id: true,", "  books: { id: true, reviews: { rating: true } }", "});", "```", "@see {@link https://joist-orm.io/advanced/json-payloads | Json Payloads} on the Joist docs")
+} };
+//#endregion
+export { tsdocComments };
+
 //# sourceMappingURL=tsdoc.js.map

package/build/tsdoc.js.map

@@ -1 +1 @@
-{"version":3,"file":"tsdoc.js","sourceRoot":"","sources":["../src/tsdoc.ts"],"names":[],"mappings":";;;AAAA,SAAS,gBAAgB,CAAC,GAAG,KAAe;IAC1C,OAAO,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACjE,CAAC;AAEY,QAAA,aAAa,GAAG;IAC3B,MAAM,EAAE;QACN,UAAU,EAAE,gBAAgB,CAC1B,0DAA0D,EAC1D,EAAE,EACF,kFAAkF,EAClF,uBAAuB,EACvB,EAAE,EACF,8DAA8D,EAC9D,2IAA2I,EAC3I,EAAE,EACF,UAAU,EACV,KAAK,EACL,qBAAqB,EACrB,+BAA+B,EAC/B,qCAAqC,EACrC,kDAAkD,EAClD,KAAK,EACL,KAAK,EACL,yGAAyG,CAC1G;QACD,cAAc,EAAE,gBAAgB,CAC9B,iEAAiE,EACjE,EAAE,EACF,kFAAkF,EAClF,uBAAuB,EACvB,EAAE,EACF,8DAA8D,EAC9D,2IAA2I,EAC3I,EAAE,EACF,UAAU,EACV,KAAK,EACL,yBAAyB,EACzB,+BAA+B,EAC/B,qCAAqC,EACrC,kDAAkD,EAClD,oDAAoD,EACpD,KAAK,EACL,KAAK,EACL,yGAAyG,CAC1G;QACD,OAAO,EAAE,gBAAgB,CACvB,0EAA0E,EAC1E,EAAE,EACF,+FAA+F,CAChG;QACD,IAAI,EAAE,gBAAgB,CACpB,8DAA8D,EAC9D,EAAE,EACF,sFAAsF,CACvF;QACD,QAAQ,EAAE,gBAAgB,CACxB,uCAAuC,EACvC,EAAE,EACF,4HAA4H,CAC7H;QACD,QAAQ,EAAE,gBAAgB,CACxB,oEAAoE,EACpE,EAAE,EACF,2BAA2B,EAC3B,EAAE,CACH;QACD,MAAM,EAAE,gBAAgB,CACtB,qFAAqF,EACrF,EAAE,EACF,sDAAsD,EACtD,EAAE,EACF,UAAU,EACV,KAAK,EACL,kCAAkC,EAClC,aAAa,EACb,kDAAkD,EAClD,KAAK,EACL,KAAK,EACL,4FAA4F,CAC7F;KACF;CACF,CAAC"}
+{"version":3,"file":"tsdoc.js","names":[],"sources":["../src/tsdoc.ts"],"sourcesContent":["function makeTsDocComment(...lines: string[]): string {\n  return [\"/**\", ...lines.map((l) => `* ${l}`), \"*/\"].join(\"\\n\");\n}\n\nexport const tsdocComments = {\n  entity: {\n    setPartial: makeTsDocComment(\n      \"Partial update taking any subset of the entities fields.\",\n      \"\",\n      'Unlike `set`, null is used as a marker to mean \"unset this field\", and undefined',\n      \"is left as untouched.\",\n      \"\",\n      \"Collections are exhaustively set to the new values, however,\",\n      \"{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. \",\n      \"\",\n      \"@example\",\n      \"```\",\n      \"entity.setPartial({\",\n      \"  firstName: 'foo' // updated\",\n      \"  lastName: undefined // do nothing\",\n      \"  age: null // unset, (i.e. set it as undefined)\",\n      \"});\",\n      \"```\",\n      \"@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs \",\n    ),\n    setDeepPartial: makeTsDocComment(\n      \"Partial update taking any nested subset of the entities fields.\",\n      \"\",\n      'Unlike `set`, null is used as a marker to mean \"unset this field\", and undefined',\n      \"is left as untouched.\",\n      \"\",\n      \"Collections are exhaustively set to the new values, however,\",\n      \"{@link https://joist-orm.io/features/partial-update-apis#incremental-collection-updates | Incremental collection updates} are supported. \",\n      \"\",\n      \"@example\",\n      \"```\",\n      \"entity.setDeepPartial({\",\n      \"  firstName: 'foo' // updated\",\n      \"  lastName: undefined // do nothing\",\n      \"  age: null // unset, (i.e. set it as undefined)\",\n      '  books: [{ title: \"b1\" }], // create a child book',\n      \"});\",\n      \"```\",\n      \"@see {@link https://joist-orm.io/features/partial-update-apis | Partial Update APIs} on the Joist docs \",\n    ),\n    changes: makeTsDocComment(\n      \"Details the field changes of the entity within the current unit of work.\",\n      \"\",\n      \"@see {@link https://joist-orm.io/features/changed-fields | Changed Fields} on the Joist docs \",\n    ),\n    load: makeTsDocComment(\n      \"Traverse from this entity using a lens, and load the result.\",\n      \"\",\n      \"@see {@link https://joist-orm.io/advanced/lenses | Lens Traversal} on the Joist docs\",\n    ),\n    populate: makeTsDocComment(\n      \"Hydrate this entity using a load hint\",\n      \"\",\n      \"@see {@link https://joist-orm.io/features/loading-entities#1-object-graph-navigation | Loading entities} on the Joist docs\",\n    ),\n    isLoaded: makeTsDocComment(\n      \"Given a load hint, checks if it is loaded within the unit of work.\",\n      \"\",\n      \"Type Guarded via Loaded<>\",\n      \"\",\n    ),\n    toJSON: makeTsDocComment(\n      \"Build a type-safe, loadable and relation aware POJO from this entity, given a hint.\",\n      \"\",\n      \"Note: As the hint might load, this returns a Promise\",\n      \"\",\n      \"@example\",\n      \"```\",\n      \"const payload = await a.toJSON({\",\n      \"  id: true,\",\n      \"  books: { id: true, reviews: { rating: true } }\",\n      \"});\",\n      \"```\",\n      \"@see {@link https://joist-orm.io/advanced/json-payloads | Json Payloads} on the Joist docs\",\n    ),\n  },\n};\n"],"mappings":";AAAA,SAAS,iBAAiB,GAAG,OAAyB;CACpD,OAAO;EAAC;EAAO,GAAG,MAAM,KAAK,MAAM,KAAK,GAAG;EAAG;CAAI,CAAC,CAAC,KAAK,IAAI;AAC/D;AAEA,MAAa,gBAAgB,EAC3B,QAAQ;CACN,YAAY,iBACV,4DACA,IACA,sFACA,yBACA,IACA,gEACA,6IACA,IACA,YACA,OACA,uBACA,iCACA,uCACA,oDACA,OACA,OACA,yGACF;CACA,gBAAgB,iBACd,mEACA,IACA,sFACA,yBACA,IACA,gEACA,6IACA,IACA,YACA,OACA,2BACA,iCACA,uCACA,oDACA,wDACA,OACA,OACA,yGACF;CACA,SAAS,iBACP,4EACA,IACA,+FACF;CACA,MAAM,iBACJ,gEACA,IACA,sFACF;CACA,UAAU,iBACR,yCACA,IACA,4HACF;CACA,UAAU,iBACR,sEACA,IACA,6BACA,EACF;CACA,QAAQ,iBACN,uFACA,IACA,wDACA,IACA,YACA,OACA,oCACA,eACA,oDACA,OACA,OACA,4FACF;AACF,EACF"}

package/build/utils.cjs

@@ -0,0 +1,175 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_runtime = require("./_virtual/_rolldown/runtime.cjs");
+require("./pgMetadata.cjs");
+const require_config = require("./config.cjs");
+require("./EntityDbMetadata.cjs");
+let change_case = require("change-case");
+let joist_utils = require("joist-utils");
+let pluralize = require("pluralize");
+pluralize = require_runtime.__toESM(pluralize, 1);
+let ts_poet = require("ts-poet");
+//#region src/utils.ts
+function assertNever(x) {
+	throw new Error("Unexpected object: " + x);
+}
+function isEntityTable(config, t) {
+	if (isIgnored(config, t) || isJoinTable(config, t)) return false;
+	const columnNames = t.columns.map((c) => c.name);
+	const { updatedAtConf, createdAtConf } = require_config.getTimestampConfig(config);
+	const hasCreatedAt = createdAtConf.names.some((c) => columnNames.includes(c));
+	const hasUpdatedAt = updatedAtConf.names.some((c) => columnNames.includes(c));
+	const hasIdColumn = columnNames.includes("id");
+	if (!hasIdColumn) return false;
+	if (hasIdColumn && !hasCreatedAt && !hasUpdatedAt) {
+		if (["name", "code"].every((c) => columnNames.includes(c))) return false;
+	}
+	if (isSubClassTable(t)) return true;
+	return hasIdColumn && (hasCreatedAt || !createdAtConf.required) && (hasUpdatedAt || !updatedAtConf.required);
+}
+function isSubClassTable(t) {
+	return t.columns.get("id").foreignKeys.length === 1;
+}
+function isEnumTable(config, t) {
+	if (isIgnored(config, t)) return false;
+	const columnNames = t.columns.map((c) => c.name);
+	return [
+		"id",
+		"code",
+		"name"
+	].every((c) => columnNames.includes(c)) && !isEntityTable(config, t);
+}
+const joinTables = /* @__PURE__ */ new Map();
+function isJoinTable(config, t) {
+	if (isIgnored(config, t)) return false;
+	return getOrElse(joinTables, t.name, () => {
+		const { columns } = t;
+		const fks = columns.filter((c) => c.isForeignKey);
+		const pks = columns.filter((c) => c.isPrimaryKey);
+		if (fks.length !== 2) return false;
+		if (!joinTableHasId(t) && !(pks.length === 2 && pks.every((c) => c.isForeignKey))) return false;
+		const others = columns.length - fks.length - (joinTableHasId(t) ? 1 : 0);
+		const createdAts = columns.filter((c) => c.name === "created_at" || c.name === "createdAt").length;
+		return others === 0 || others === 1 && createdAts === 1;
+	});
+}
+/** Whether a join table has a surrogate `id` primary key (vs. an id-less FK-pair composite PK). */
+function joinTableHasId(t) {
+	const pks = t.columns.filter((c) => c.isPrimaryKey);
+	return pks.length === 1 && !pks[0].isForeignKey;
+}
+function getOrElse(map, key, fn) {
+	let value = map.get(key);
+	if (value === void 0) {
+		value = fn();
+		map.set(key, value);
+	}
+	return value;
+}
+/** Converts `projects` to `Project`. */
+function tableToEntityName(config, table) {
+	let entityName = config.__tableToEntityName?.[table.name];
+	if (!entityName) {
+		entityName = Object.entries(config.entities).filter(([, conf]) => conf.tableName === table.name).map(([entityName]) => entityName)[0] || (0, change_case.pascalCase)(pluralize.default.singular(table.name));
+		(config.__tableToEntityName ??= {})[table.name] = entityName;
+	}
+	return entityName;
+}
+const dateCode = ts_poet.code`Date`;
+const plainDateCode = ts_poet.code`${(0, ts_poet.imp)("Temporal@joist-orm")}.PlainDate`;
+const plainTimeCode = ts_poet.code`${(0, ts_poet.imp)("Temporal@joist-orm")}.PlainTime`;
+const plainDateTimeCode = ts_poet.code`${(0, ts_poet.imp)("Temporal@joist-orm")}.PlainDateTime`;
+const zonedDateTimeCode = ts_poet.code`${(0, ts_poet.imp)("Temporal@joist-orm")}.ZonedDateTime`;
+/** Maps db types, i.e. `int`, to JS types, i.e. `number`. */
+function mapSimpleDbTypeToTypescriptType(config, dbType) {
+	switch (dbType) {
+		case "boolean": return "boolean";
+		case "int":
+		case "numeric":
+		case "smallint":
+		case "integer":
+		case "decimal":
+		case "real":
+		case "smallserial":
+		case "serial":
+		case "double precision": return "number";
+		case "bigserial":
+		case "bigint": return "bigint";
+		case "text":
+		case "citext":
+		case "character varying":
+		case "varchar":
+		case "uuid":
+		case "tsvector":
+		case "tstzrange": return "string";
+		case "time without time zone": return config.temporal ? plainTimeCode : fail("Joist doesn't support 'time without time zone' unless temporal is enabled");
+		case "timestamp with time zone": return config.temporal ? zonedDateTimeCode : dateCode;
+		case "timestamp without time zone": return config.temporal ? plainDateTimeCode : dateCode;
+		case "date": return config.temporal ? plainDateCode : dateCode;
+		case "jsonb": return "Object";
+		case "bytea": return "Uint8Array";
+		default: assertNever(dbType);
+	}
+}
+function merge(a, b) {
+	return [...a, ...b];
+}
+/** Returns true if `p` is resolved, otherwise false if it is rejected. */
+async function trueIfResolved(p) {
+	return p.then(() => true, () => false);
+}
+function fail(message) {
+	throw new Error(message || "Failed");
+}
+function sortKeys(o) {
+	return Object.keys(o).sort().reduce((acc, key) => {
+		const value = o[key];
+		acc[key] = typeof value === "object" && (0, joist_utils.isPlainObject)(value) ? sortKeys(value) : value;
+		return acc;
+	}, {});
+}
+function parseOrder(order) {
+	if (!order) return;
+	const [field, direction = "ASC"] = order.split(" ");
+	if (direction !== "ASC" && direction !== "DESC") throw new Error(`Invalid direction: ${direction} (must be "ASC" or "DESC")`);
+	return {
+		field,
+		direction
+	};
+}
+function q(s) {
+	return s === void 0 ? "undefined" : `"${s}"`;
+}
+function uncapitalize(s) {
+	return s.charAt(0).toLowerCase() + s.slice(1);
+}
+function isIgnored(config, t) {
+	return (config.ignoredTables || ["migrations", "pgmigrations"]).includes(t.name) || !shouldIncludeSchema(config, t);
+}
+/** Uses the same schema selection for metadata and test database cleanup. */
+function shouldIncludeSchema(config, t) {
+	return config.schemas ? config.schemas.includes(t.schema.name) : t.schema.name === "public";
+}
+//#endregion
+exports.assertNever = assertNever;
+exports.dateCode = dateCode;
+exports.fail = fail;
+exports.isEntityTable = isEntityTable;
+exports.isEnumTable = isEnumTable;
+exports.isJoinTable = isJoinTable;
+exports.isSubClassTable = isSubClassTable;
+exports.joinTableHasId = joinTableHasId;
+exports.mapSimpleDbTypeToTypescriptType = mapSimpleDbTypeToTypescriptType;
+exports.merge = merge;
+exports.parseOrder = parseOrder;
+exports.plainDateCode = plainDateCode;
+exports.plainDateTimeCode = plainDateTimeCode;
+exports.plainTimeCode = plainTimeCode;
+exports.q = q;
+exports.shouldIncludeSchema = shouldIncludeSchema;
+exports.sortKeys = sortKeys;
+exports.tableToEntityName = tableToEntityName;
+exports.trueIfResolved = trueIfResolved;
+exports.uncapitalize = uncapitalize;
+exports.zonedDateTimeCode = zonedDateTimeCode;
+
+//# sourceMappingURL=utils.cjs.map

package/build/utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.cjs","names":["getTimestampConfig","pascalCase","imp","isPlainObject"],"sources":["../src/utils.ts"],"sourcesContent":["import { pascalCase } from \"change-case\";\nimport { isPlainObject } from \"joist-utils\";\nimport pluralize from \"pluralize\";\nimport { code, imp } from \"ts-poet\";\n\nimport { type Config, getTimestampConfig } from \"./config.ts\";\nimport { type DatabaseColumnType, type PrimitiveTypescriptType } from \"./EntityDbMetadata.ts\";\nimport { type Table } from \"./pgMetadata.ts\";\n\nexport function assertNever(x: never): never {\n  throw new Error(\"Unexpected object: \" + x);\n}\n\nexport function isEntityTable(config: Config, t: Table): boolean {\n  if (isIgnored(config, t) || isJoinTable(config, t)) {\n    return false;\n  }\n\n  // Depending on the config settings, we may/may not require the presence of timestamp\n  // fields to determine whether a table is an entity.\n  const columnNames = t.columns.map((c) => c.name);\n  const { updatedAtConf, createdAtConf } = getTimestampConfig(config);\n  const hasCreatedAt = createdAtConf.names.some((c) => columnNames.includes(c));\n  const hasUpdatedAt = updatedAtConf.names.some((c) => columnNames.includes(c));\n\n  // Entities always require an id column\n  const hasIdColumn = columnNames.includes(\"id\");\n  if (!hasIdColumn) return false;\n\n  // If we have no timestamp columns, but do have `name` and `code`, we're probably an enum.\n  if (hasIdColumn && !hasCreatedAt && !hasUpdatedAt) {\n    if ([\"name\", \"code\"].every((c) => columnNames.includes(c))) {\n      return false;\n    }\n  }\n\n  // If the ID column is a FK then we're a subclass\n  if (isSubClassTable(t)) return true;\n\n  // Otherwise respect the created_at/updated_at required rules\n  return hasIdColumn && (hasCreatedAt || !createdAtConf.required) && (hasUpdatedAt || !updatedAtConf.required);\n}\n\nexport function isSubClassTable(t: Table): boolean {\n  // Note that `.get(\"id\")` will blow up if there is no id column\n  return t.columns.get(\"id\").foreignKeys.length === 1;\n}\n\nexport function isEnumTable(config: Config, t: Table): boolean {\n  if (isIgnored(config, t)) {\n    return false;\n  }\n  const columnNames = t.columns.map((c) => c.name);\n  return [\"id\", \"code\", \"name\"].every((c) => columnNames.includes(c)) && !isEntityTable(config, t);\n}\n\n// Oddly enough isJoinTable showed up as a hot spot, so cache its calculation.\nconst joinTables: Map<string, boolean> = new Map();\n\nexport function isJoinTable(config: Config, t: Table): boolean {\n  if (isIgnored(config, t)) {\n    return false;\n  }\n  return getOrElse(joinTables, t.name, () => {\n    const { columns } = t;\n    const fks = columns.filter((c) => c.isForeignKey);\n    const pks = columns.filter((c) => c.isPrimaryKey);\n    // Every join table is two FKs, plus either a surrogate `id` PK (\"id-ful\") or no surrogate\n    // at all, in which case the two FKs are themselves the composite PK (\"id-less\").\n    if (fks.length !== 2) return false;\n    if (!joinTableHasId(t) && !(pks.length === 2 && pks.every((c) => c.isForeignKey))) return false;\n    // Any column beyond the two FKs and the optional `id` PK must be a single created_at.\n    const others = columns.length - fks.length - (joinTableHasId(t) ? 1 : 0);\n    const createdAts = columns.filter((c) => c.name === \"created_at\" || c.name === \"createdAt\").length;\n    return others === 0 || (others === 1 && createdAts === 1);\n  });\n}\n\n/** Whether a join table has a surrogate `id` primary key (vs. an id-less FK-pair composite PK). */\nexport function joinTableHasId(t: Table): boolean {\n  const pks = t.columns.filter((c) => c.isPrimaryKey);\n  return pks.length === 1 && !pks[0].isForeignKey;\n}\n\nfunction getOrElse<K, V>(map: Map<K, V>, key: K, fn: () => V): V {\n  let value = map.get(key);\n  if (value === undefined) {\n    value = fn();\n    map.set(key, value);\n  }\n  return value;\n}\n\n/** Converts `projects` to `Project`. */\nexport function tableToEntityName(config: Config, table: Table): string {\n  let entityName = config.__tableToEntityName?.[table.name];\n  if (!entityName) {\n    const configEntityName = Object.entries(config.entities)\n      .filter(([, conf]) => conf.tableName === table.name)\n      .map(([entityName]) => entityName)[0];\n    entityName = configEntityName || pascalCase(pluralize.singular(table.name));\n    (config.__tableToEntityName ??= {})[table.name] = entityName;\n  }\n  return entityName;\n}\n\nexport const dateCode = code`Date`;\nexport const plainDateCode = code`${imp(\"Temporal@joist-orm\")}.PlainDate`;\nexport const plainTimeCode = code`${imp(\"Temporal@joist-orm\")}.PlainTime`;\nexport const plainDateTimeCode = code`${imp(\"Temporal@joist-orm\")}.PlainDateTime`;\nexport const zonedDateTimeCode = code`${imp(\"Temporal@joist-orm\")}.ZonedDateTime`;\n\n/** Maps db types, i.e. `int`, to JS types, i.e. `number`. */\nexport function mapSimpleDbTypeToTypescriptType(config: Config, dbType: DatabaseColumnType): PrimitiveTypescriptType {\n  switch (dbType) {\n    case \"boolean\":\n      return \"boolean\";\n    case \"int\":\n    case \"numeric\":\n    case \"smallint\":\n    case \"integer\":\n    case \"decimal\":\n    case \"real\":\n    case \"smallserial\":\n    case \"serial\":\n    case \"double precision\":\n      return \"number\";\n    case \"bigserial\":\n    case \"bigint\":\n      return \"bigint\";\n    case \"text\":\n    case \"citext\":\n    case \"character varying\":\n    case \"varchar\":\n    case \"uuid\":\n    case \"tsvector\":\n    case \"tstzrange\":\n      return \"string\";\n    case \"time without time zone\":\n      return config.temporal\n        ? plainTimeCode\n        : fail(\"Joist doesn't support 'time without time zone' unless temporal is enabled\");\n    case \"timestamp with time zone\":\n      return config.temporal ? zonedDateTimeCode : dateCode;\n    case \"timestamp without time zone\":\n      return config.temporal ? plainDateTimeCode : dateCode;\n    case \"date\":\n      return config.temporal ? plainDateCode : dateCode;\n    case \"jsonb\":\n      return \"Object\";\n    case \"bytea\":\n      return \"Uint8Array\";\n    default:\n      assertNever(dbType);\n  }\n}\n\nexport function merge<T>(a: T[], b: T[]): T[] {\n  return [...a, ...b];\n}\n\n/** Returns true if `p` is resolved, otherwise false if it is rejected. */\nexport async function trueIfResolved(p: Promise<unknown>): Promise<boolean> {\n  return p.then(\n    () => true,\n    () => false,\n  );\n}\n\nexport function fail(message?: string): never {\n  throw new Error(message || \"Failed\");\n}\n\nexport function sortKeys<T extends object>(o: T): T {\n  return Object.keys(o)\n    .sort()\n    .reduce(\n      (acc, key) => {\n        const value = o[key as keyof T];\n        const newValue = typeof value === \"object\" && isPlainObject(value) ? sortKeys(value as any as object) : value;\n        acc[key as keyof T] = newValue as any;\n        return acc;\n      },\n      {} as any as T,\n    );\n}\n\nexport function parseOrder(order: string | undefined): { field: string; direction: \"ASC\" | \"DESC\" } | undefined {\n  if (!order) {\n    return undefined;\n  }\n  const [field, direction = \"ASC\"] = order.split(\" \");\n  if (direction !== \"ASC\" && direction !== \"DESC\") {\n    throw new Error(`Invalid direction: ${direction} (must be \"ASC\" or \"DESC\")`);\n  }\n  return { field, direction };\n}\n\nexport function q(s: string | undefined): string {\n  return s === undefined ? \"undefined\" : `\"${s}\"`;\n}\n\nexport function uncapitalize(s: string): string {\n  return s.charAt(0).toLowerCase() + s.slice(1);\n}\n\nfunction isIgnored(config: Config, t: Table): boolean {\n  return (config.ignoredTables || [\"migrations\", \"pgmigrations\"]).includes(t.name) || !shouldIncludeSchema(config, t);\n}\n\n/** Uses the same schema selection for metadata and test database cleanup. */\nexport function shouldIncludeSchema(config: Config, t: Table): boolean {\n  return config.schemas ? config.schemas.includes(t.schema.name) : t.schema.name === \"public\";\n}\n"],"mappings":";;;;;;;;;;;AASA,SAAgB,YAAY,GAAiB;CAC3C,MAAM,IAAI,MAAM,wBAAwB,CAAC;AAC3C;AAEA,SAAgB,cAAc,QAAgB,GAAmB;CAC/D,IAAI,UAAU,QAAQ,CAAC,KAAK,YAAY,QAAQ,CAAC,GAC/C,OAAO;CAKT,MAAM,cAAc,EAAE,QAAQ,KAAK,MAAM,EAAE,IAAI;CAC/C,MAAM,EAAE,eAAe,kBAAkBA,eAAAA,mBAAmB,MAAM;CAClE,MAAM,eAAe,cAAc,MAAM,MAAM,MAAM,YAAY,SAAS,CAAC,CAAC;CAC5E,MAAM,eAAe,cAAc,MAAM,MAAM,MAAM,YAAY,SAAS,CAAC,CAAC;CAG5E,MAAM,cAAc,YAAY,SAAS,IAAI;CAC7C,IAAI,CAAC,aAAa,OAAO;CAGzB,IAAI,eAAe,CAAC,gBAAgB,CAAC,cAC/B;MAAA,CAAC,QAAQ,MAAM,CAAC,CAAC,OAAO,MAAM,YAAY,SAAS,CAAC,CAAC,GACvD,OAAO;CAAA;CAKX,IAAI,gBAAgB,CAAC,GAAG,OAAO;CAG/B,OAAO,gBAAgB,gBAAgB,CAAC,cAAc,cAAc,gBAAgB,CAAC,cAAc;AACrG;AAEA,SAAgB,gBAAgB,GAAmB;CAEjD,OAAO,EAAE,QAAQ,IAAI,IAAI,CAAC,CAAC,YAAY,WAAW;AACpD;AAEA,SAAgB,YAAY,QAAgB,GAAmB;CAC7D,IAAI,UAAU,QAAQ,CAAC,GACrB,OAAO;CAET,MAAM,cAAc,EAAE,QAAQ,KAAK,MAAM,EAAE,IAAI;CAC/C,OAAO;EAAC;EAAM;EAAQ;CAAM,CAAC,CAAC,OAAO,MAAM,YAAY,SAAS,CAAC,CAAC,KAAK,CAAC,cAAc,QAAQ,CAAC;AACjG;AAGA,MAAM,6BAAmC,IAAI,IAAI;AAEjD,SAAgB,YAAY,QAAgB,GAAmB;CAC7D,IAAI,UAAU,QAAQ,CAAC,GACrB,OAAO;CAET,OAAO,UAAU,YAAY,EAAE,YAAY;EACzC,MAAM,EAAE,YAAY;EACpB,MAAM,MAAM,QAAQ,QAAQ,MAAM,EAAE,YAAY;EAChD,MAAM,MAAM,QAAQ,QAAQ,MAAM,EAAE,YAAY;EAGhD,IAAI,IAAI,WAAW,GAAG,OAAO;EAC7B,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,WAAW,KAAK,IAAI,OAAO,MAAM,EAAE,YAAY,IAAI,OAAO;EAE1F,MAAM,SAAS,QAAQ,SAAS,IAAI,UAAU,eAAe,CAAC,IAAI,IAAI;EACtE,MAAM,aAAa,QAAQ,QAAQ,MAAM,EAAE,SAAS,gBAAgB,EAAE,SAAS,WAAW,CAAC,CAAC;EAC5F,OAAO,WAAW,KAAM,WAAW,KAAK,eAAe;CACzD,CAAC;AACH;;AAGA,SAAgB,eAAe,GAAmB;CAChD,MAAM,MAAM,EAAE,QAAQ,QAAQ,MAAM,EAAE,YAAY;CAClD,OAAO,IAAI,WAAW,KAAK,CAAC,IAAI,EAAE,CAAC;AACrC;AAEA,SAAS,UAAgB,KAAgB,KAAQ,IAAgB;CAC/D,IAAI,QAAQ,IAAI,IAAI,GAAG;CACvB,IAAI,UAAU,KAAA,GAAW;EACvB,QAAQ,GAAG;EACX,IAAI,IAAI,KAAK,KAAK;CACpB;CACA,OAAO;AACT;;AAGA,SAAgB,kBAAkB,QAAgB,OAAsB;CACtE,IAAI,aAAa,OAAO,sBAAsB,MAAM;CACpD,IAAI,CAAC,YAAY;EAIf,aAHyB,OAAO,QAAQ,OAAO,QAAQ,CAAC,CACrD,QAAQ,GAAG,UAAU,KAAK,cAAc,MAAM,IAAI,CAAC,CACnD,KAAK,CAAC,gBAAgB,UAAU,CAAC,CAAC,OAAA,GACJC,YAAAA,WAAAA,CAAW,UAAA,QAAU,SAAS,MAAM,IAAI,CAAC;EAC1E,CAAC,OAAO,wBAAwB,CAAC,EAAA,CAAG,MAAM,QAAQ;CACpD;CACA,OAAO;AACT;AAEA,MAAa,WAAW,QAAA,IAAI;AAC5B,MAAa,gBAAgB,QAAA,IAAI,IAAA,GAAGC,QAAAA,IAAAA,CAAI,oBAAoB,EAAE;AAC9D,MAAa,gBAAgB,QAAA,IAAI,IAAA,GAAGA,QAAAA,IAAAA,CAAI,oBAAoB,EAAE;AAC9D,MAAa,oBAAoB,QAAA,IAAI,IAAA,GAAGA,QAAAA,IAAAA,CAAI,oBAAoB,EAAE;AAClE,MAAa,oBAAoB,QAAA,IAAI,IAAA,GAAGA,QAAAA,IAAAA,CAAI,oBAAoB,EAAE;;AAGlE,SAAgB,gCAAgC,QAAgB,QAAqD;CACnH,QAAQ,QAAR;EACE,KAAK,WACH,OAAO;EACT,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,oBACH,OAAO;EACT,KAAK;EACL,KAAK,UACH,OAAO;EACT,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK;EACL,KAAK,aACH,OAAO;EACT,KAAK,0BACH,OAAO,OAAO,WACV,gBACA,KAAK,2EAA2E;EACtF,KAAK,4BACH,OAAO,OAAO,WAAW,oBAAoB;EAC/C,KAAK,+BACH,OAAO,OAAO,WAAW,oBAAoB;EAC/C,KAAK,QACH,OAAO,OAAO,WAAW,gBAAgB;EAC3C,KAAK,SACH,OAAO;EACT,KAAK,SACH,OAAO;EACT,SACE,YAAY,MAAM;CACtB;AACF;AAEA,SAAgB,MAAS,GAAQ,GAAa;CAC5C,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;AACpB;;AAGA,eAAsB,eAAe,GAAuC;CAC1E,OAAO,EAAE,WACD,YACA,KACR;AACF;AAEA,SAAgB,KAAK,SAAyB;CAC5C,MAAM,IAAI,MAAM,WAAW,QAAQ;AACrC;AAEA,SAAgB,SAA2B,GAAS;CAClD,OAAO,OAAO,KAAK,CAAC,CAAC,CAClB,KAAK,CAAC,CACN,QACE,KAAK,QAAQ;EACZ,MAAM,QAAQ,EAAE;EAEhB,IAAI,OADa,OAAO,UAAU,aAAA,GAAYC,YAAAA,cAAAA,CAAc,KAAK,IAAI,SAAS,KAAsB,IAAI;EAExG,OAAO;CACT,GACA,CAAC,CACH;AACJ;AAEA,SAAgB,WAAW,OAAqF;CAC9G,IAAI,CAAC,OACH;CAEF,MAAM,CAAC,OAAO,YAAY,SAAS,MAAM,MAAM,GAAG;CAClD,IAAI,cAAc,SAAS,cAAc,QACvC,MAAM,IAAI,MAAM,sBAAsB,UAAU,2BAA2B;CAE7E,OAAO;EAAE;EAAO;CAAU;AAC5B;AAEA,SAAgB,EAAE,GAA+B;CAC/C,OAAO,MAAM,KAAA,IAAY,cAAc,IAAI,EAAE;AAC/C;AAEA,SAAgB,aAAa,GAAmB;CAC9C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,MAAM,CAAC;AAC9C;AAEA,SAAS,UAAU,QAAgB,GAAmB;CACpD,QAAQ,OAAO,iBAAiB,CAAC,cAAc,cAAc,EAAA,CAAG,SAAS,EAAE,IAAI,KAAK,CAAC,oBAAoB,QAAQ,CAAC;AACpH;;AAGA,SAAgB,oBAAoB,QAAgB,GAAmB;CACrE,OAAO,OAAO,UAAU,OAAO,QAAQ,SAAS,EAAE,OAAO,IAAI,IAAI,EAAE,OAAO,SAAS;AACrF"}

package/build/utils.d.cts

@@ -0,0 +1,36 @@
+import { Config } from "./config.cjs";
+import { Table } from "./pgMetadata.cjs";
+import { DatabaseColumnType, PrimitiveTypescriptType } from "./EntityDbMetadata.cjs";
+//#region src/utils.d.ts
+declare function assertNever(x: never): never;
+declare function isEntityTable(config: Config, t: Table): boolean;
+declare function isSubClassTable(t: Table): boolean;
+declare function isEnumTable(config: Config, t: Table): boolean;
+declare function isJoinTable(config: Config, t: Table): boolean;
+/** Whether a join table has a surrogate `id` primary key (vs. an id-less FK-pair composite PK). */
+declare function joinTableHasId(t: Table): boolean;
+/** Converts `projects` to `Project`. */
+declare function tableToEntityName(config: Config, table: Table): string;
+declare const dateCode: import("ts-poet").Code;
+declare const plainDateCode: import("ts-poet").Code;
+declare const plainTimeCode: import("ts-poet").Code;
+declare const plainDateTimeCode: import("ts-poet").Code;
+declare const zonedDateTimeCode: import("ts-poet").Code;
+/** Maps db types, i.e. `int`, to JS types, i.e. `number`. */
+declare function mapSimpleDbTypeToTypescriptType(config: Config, dbType: DatabaseColumnType): PrimitiveTypescriptType;
+declare function merge<T>(a: T[], b: T[]): T[];
+/** Returns true if `p` is resolved, otherwise false if it is rejected. */
+declare function trueIfResolved(p: Promise<unknown>): Promise<boolean>;
+declare function fail(message?: string): never;
+declare function sortKeys<T extends object>(o: T): T;
+declare function parseOrder(order: string | undefined): {
+  field: string;
+  direction: "ASC" | "DESC";
+} | undefined;
+declare function q(s: string | undefined): string;
+declare function uncapitalize(s: string): string;
+/** Uses the same schema selection for metadata and test database cleanup. */
+declare function shouldIncludeSchema(config: Config, t: Table): boolean;
+//#endregion
+export { assertNever, dateCode, fail, isEntityTable, isEnumTable, isJoinTable, isSubClassTable, joinTableHasId, mapSimpleDbTypeToTypescriptType, merge, parseOrder, plainDateCode, plainDateTimeCode, plainTimeCode, q, shouldIncludeSchema, sortKeys, tableToEntityName, trueIfResolved, uncapitalize, zonedDateTimeCode };
+//# sourceMappingURL=utils.d.cts.map

package/build/utils.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","names":[],"sources":["../src/utils.ts"],"mappings":";;;;iBASgB,YAAY;iBAIZ,cAAc,QAAQ,QAAQ,GAAG;iBA8BjC,gBAAgB,GAAG;iBAKnB,YAAY,QAAQ,QAAQ,GAAG;iBAW/B,YAAY,QAAQ,QAAQ,GAAG;;iBAoB/B,eAAe,GAAG;;iBAelB,kBAAkB,QAAQ,QAAQ,OAAO;cAY5C,4BAAQ;cACR,iCAAa;cACb,iCAAa;cACb,qCAAiB;cACjB,qCAAiB;;iBAGd,gCAAgC,QAAQ,QAAQ,QAAQ,qBAAqB;iBA4C7E,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM;;iBAKpB,eAAe,GAAG,mBAAmB;iBAO3C,KAAK;iBAIL,SAAS,kBAAkB,GAAG,IAAI;iBAclC,WAAW;EAA8B;EAAe;;iBAWxD,EAAE;iBAIF,aAAa;;iBASb,oBAAoB,QAAQ,QAAQ,GAAG"}

package/build/utils.d.mts

@@ -0,0 +1,36 @@
+import { Config } from "./config.mjs";
+import { Table } from "./pgMetadata.mjs";
+import { DatabaseColumnType, PrimitiveTypescriptType } from "./EntityDbMetadata.mjs";
+//#region src/utils.d.ts
+declare function assertNever(x: never): never;
+declare function isEntityTable(config: Config, t: Table): boolean;
+declare function isSubClassTable(t: Table): boolean;
+declare function isEnumTable(config: Config, t: Table): boolean;
+declare function isJoinTable(config: Config, t: Table): boolean;
+/** Whether a join table has a surrogate `id` primary key (vs. an id-less FK-pair composite PK). */
+declare function joinTableHasId(t: Table): boolean;
+/** Converts `projects` to `Project`. */
+declare function tableToEntityName(config: Config, table: Table): string;
+declare const dateCode: import("ts-poet").Code;
+declare const plainDateCode: import("ts-poet").Code;
+declare const plainTimeCode: import("ts-poet").Code;
+declare const plainDateTimeCode: import("ts-poet").Code;
+declare const zonedDateTimeCode: import("ts-poet").Code;
+/** Maps db types, i.e. `int`, to JS types, i.e. `number`. */
+declare function mapSimpleDbTypeToTypescriptType(config: Config, dbType: DatabaseColumnType): PrimitiveTypescriptType;
+declare function merge<T>(a: T[], b: T[]): T[];
+/** Returns true if `p` is resolved, otherwise false if it is rejected. */
+declare function trueIfResolved(p: Promise<unknown>): Promise<boolean>;
+declare function fail(message?: string): never;
+declare function sortKeys<T extends object>(o: T): T;
+declare function parseOrder(order: string | undefined): {
+  field: string;
+  direction: "ASC" | "DESC";
+} | undefined;
+declare function q(s: string | undefined): string;
+declare function uncapitalize(s: string): string;
+/** Uses the same schema selection for metadata and test database cleanup. */
+declare function shouldIncludeSchema(config: Config, t: Table): boolean;
+//#endregion
+export { assertNever, dateCode, fail, isEntityTable, isEnumTable, isJoinTable, isSubClassTable, joinTableHasId, mapSimpleDbTypeToTypescriptType, merge, parseOrder, plainDateCode, plainDateTimeCode, plainTimeCode, q, shouldIncludeSchema, sortKeys, tableToEntityName, trueIfResolved, uncapitalize, zonedDateTimeCode };
+//# sourceMappingURL=utils.d.mts.map

package/build/utils.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.mts","names":[],"sources":["../src/utils.ts"],"mappings":";;;;iBASgB,YAAY;iBAIZ,cAAc,QAAQ,QAAQ,GAAG;iBA8BjC,gBAAgB,GAAG;iBAKnB,YAAY,QAAQ,QAAQ,GAAG;iBAW/B,YAAY,QAAQ,QAAQ,GAAG;;iBAoB/B,eAAe,GAAG;;iBAelB,kBAAkB,QAAQ,QAAQ,OAAO;cAY5C,4BAAQ;cACR,iCAAa;cACb,iCAAa;cACb,qCAAiB;cACjB,qCAAiB;;iBAGd,gCAAgC,QAAQ,QAAQ,QAAQ,qBAAqB;iBA4C7E,MAAM,GAAG,GAAG,KAAK,GAAG,MAAM;;iBAKpB,eAAe,GAAG,mBAAmB;iBAO3C,KAAK;iBAIL,SAAS,kBAAkB,GAAG,IAAI;iBAclC,WAAW;EAA8B;EAAe;;iBAWxD,EAAE;iBAIF,aAAa;;iBASb,oBAAoB,QAAQ,QAAQ,GAAG"}