orchid-orm 1.76.5 → 1.77.0

package/dist/migrations/index.mjs

@@ -1,5 +1,5 @@
-import { astToMigration, concatSchemaAndName, createMigrationInterface, dbColumnToAst, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getDbVersion, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeStructureToAstCtx, migrate, migrateAndClose, promptSelect, rakeDbCommands, saveMigratedVersion, structureToAst, tableToAst, writeMigrationFile } from "rake-db";
-import { ArrayColumn, DomainColumn, EnumColumn, RawSql, UnknownColumn, VirtualColumn, addCode, codeToString, colors, columnsShapeToCode, deepCompare, emptyArray, emptyObject, exhaustive, getColumnBaseType, getDriverErrorCode, getFreeSetAlias, getImportPath, getQuerySchema, getSupportedDefaultPrivileges, pathToLog, pluralize, pushTableDataCode, queryToSql, quoteObjectKey, raw, rawSqlToSql, singleQuote, sqlToRawSql, toArray, toCamelCase, toPascalCase, toSnakeCase } from "pqb/internal";
+import { astToMigration, concatSchemaAndName, createMigrationInterface, dbColumnToAst, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getDbVersion, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, getTableFactoryConfig, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeStructureToAstCtx, migrate, migrateAndClose, promptSelect, rakeDbCommands, saveMigratedVersion, structureToAst, tableToAst, writeMigrationFile } from "rake-db";
+import { ArrayColumn, DomainColumn, EnumColumn, RawSql, UnknownColumn, VirtualColumn, addCode, codeToString, colors, columnsShapeToCode, constraintToCode, deepCompare, emptyArray, emptyObject, excludeToCode, exhaustive, getColumnBaseType, getDriverErrorCode, getForeignKeyTableInstance, getFreeSetAlias, getImportPath, getQuerySchema, getSupportedDefaultPrivileges, indexToCode, pathToLog, pluralize, primaryKeyInnerToCode, queryToSql, quoteObjectKey, raw, rawSqlToSql, singleQuote, sqlToRawSql, toArray, toCamelCase, toPascalCase, toSnakeCase } from "pqb/internal";
 import path from "node:path";
 import { pathToFileURL } from "node:url";
 import fs from "node:fs/promises";
@@ -1279,7 +1279,7 @@ const collectCodeFkeys = (config, { codeTable, changeTableAst: { shape } }, curr
 };
 const fnOrTableToString = (fnOrTable) => {
 	if (typeof fnOrTable !== "string") {
-		const { schema, table, nameInDb } = new (fnOrTable())();
+		const { schema, table, nameInDb } = getForeignKeyTableInstance(fnOrTable());
 		const name = nameInDb || table;
 		if (!name) throw new Error("Referenced table is missing table property");
 		fnOrTable = concatSchemaAndName({
@@ -3136,7 +3136,7 @@ const formatPolicyChangeDefinition = (policy) => {
 var AbortSignal = class extends Error {};
 const generate = async (adapters, config, args, afterPull) => {
 	let { dbPath } = config;
-	if (!dbPath || !config.baseTable) throw invalidConfig(config);
+	if (!dbPath || !getTableFactoryConfig(config)) throw invalidConfig(config);
 	if (!adapters.length) throw new Error(`Database options must not be empty`);
 	if (!dbPath.endsWith(".ts")) dbPath += ".ts";
 	let migrationName = args[0] ?? "generated";
@@ -3206,7 +3206,7 @@ const generate = async (adapters, config, args, afterPull) => {
 	if (up) for (const adapter of adapters) await migrateAndClose(adapter, config);
 	else if (!afterPull) await closeAdapters(adapters);
 };
-const invalidConfig = (config) => /* @__PURE__ */ new Error(`\`${config.dbPath ? "baseTable" : "dbPath"}\` setting must be set in the migrations config for the generator to work`);
+const invalidConfig = (config) => /* @__PURE__ */ new Error(`\`${config.dbPath ? "baseTable` or `defineTable" : "dbPath"}\` setting must be set in the migrations config for the generator to work`);
 const getDbFromConfig = async (config, dbPath) => {
 	const db = (await config.import(pathToFileURL(path.resolve(config.basePath, dbPath)).toString()))[config.dbExportedAs ?? "db"];
 	if (!db?.$qb) throw new Error(`Unable to import OrchidORM instance as ${config.dbExportedAs ?? "db"} from ${config.dbPath}`);
@@ -3484,84 +3484,119 @@ const processHasAndBelongsToManyColumn = (column, habtmTables, codeItems) => {
 const closeAdapters = (adapters) => {
 	return Promise.all(adapters.map((x) => x.close()));
 };
-const getTableInfosAndFKeys = (asts, config) => {
+const getTableInfos = (asts, config) => {
 	const generateTableTo = config.generateTableTo ?? ((name) => `./tables/${name}.table.ts`);
 	const tableInfos = {};
-	const fkeys = {};
 	for (const ast of asts) if (ast.type === "table") {
 		const tableKey = toCamelCase(ast.name);
 		const dbTableName = ast.schema ? `${ast.schema}.${ast.name}` : ast.name;
 		let tablePath = path.resolve(config.basePath, generateTableTo(tableKey));
 		if (!tablePath.endsWith(".ts")) tablePath += ".ts";
 		const name = toPascalCase(ast.name);
-		const info = {
+		tableInfos[dbTableName] = {
 			dbTableName,
 			key: tableKey,
 			path: tablePath,
 			name,
 			className: `${name}Table`
 		};
-		tableInfos[dbTableName] = info;
-		if (ast.constraints) for (const { references } of ast.constraints) {
-			if (!references) continue;
-			(fkeys[references.fnOrTable] ??= []).push({
-				table: info,
-				references
-			});
-		}
 	}
-	return {
-		tableInfos,
-		fkeys
-	};
+	return tableInfos;
 };
-const appCodeGenTable = (tableInfos, fkeys, ast, baseTablePath, baseTableExportedAs, currentSchema) => {
+const appCodeGenTable = (tableInfos, ast, tableFactorySource, currentSchema) => {
 	const tableInfo = tableInfos[ast.schema ? `${ast.schema}.${ast.name}` : ast.name];
-	const imports = {
-		"orchid-orm": "Selectable, Insertable, Updatable",
-		[getImportPath(tableInfo.path, baseTablePath)]: baseTableExportedAs
+	const content = appCodeGenDefineTable(tableInfo, ast, tableFactorySource, currentSchema);
+	return {
+		...tableInfo,
+		content
 	};
-	const props = [];
-	if (ast.schema) props.push(`schema = ${singleQuote(ast.schema)};`);
-	props.push(`readonly table = ${singleQuote(ast.name)};`);
-	if (ast.comment) props.push(`comment = ${singleQuote(ast.comment)};`);
-	if (ast.noPrimaryKey === "ignore") props.push("noPrimaryKey = true;");
+};
+const appCodeGenDefineTable = (tableInfo, ast, tableFactorySource, currentSchema) => {
+	const tableOptions = getDefineTableOptions(tableInfo, ast);
 	const hasTableData = Boolean(ast.primaryKey || ast.indexes?.length || ast.excludes?.length || ast.constraints?.length);
-	const shapeCode = columnsShapeToCode({
+	const ctx = {
 		t: "t",
+		sql: "sql",
 		table: ast.name,
 		currentSchema
-	}, ast.shape);
-	props.push(`columns = this.setColumns(${hasTableData ? "\n    " : ""}(t) => ({`, hasTableData ? [shapeCode] : shapeCode, hasTableData ? "  })," : "}));");
-	if (hasTableData) props.push(pushTableDataCode([], ast), ");");
-	const relations = [];
-	const belongsTo = fkeys[ast.schema ? `${ast.schema}.${ast.name}` : ast.name];
-	if (belongsTo) for (const { table, references } of belongsTo) {
-		imports[getImportPath(tableInfo.path, table.path)] = table.className;
-		relations.push(`${table.key}: this.belongsTo(() => ${table.className}, {`, [`columns: [${references.foreignColumns.map(singleQuote).join(", ")}],`, `references: [${references.columns.map(singleQuote).join(", ")}],`], "}),");
-	}
-	if (ast.constraints) for (const { references } of ast.constraints) {
-		if (!references) continue;
-		const table = tableInfos[references.fnOrTable];
-		imports[getImportPath(tableInfo.path, table.path)] = table.className;
-		relations.push(`${table.key}: this.hasMany(() => ${table.className}, {`, [`columns: [${references.columns.map(singleQuote).join(", ")}],`, `references: [${references.foreignColumns.map(singleQuote).join(", ")}],`], "}),");
-	}
-	if (relations.length) props.push("", "relations = {", relations, "};");
-	const importsCode = importsToCode(imports);
-	const { name, className } = tableInfo;
-	const code = [
-		`export type ${name} = Selectable<${className}>;
-export type ${name}New = Insertable<${className}>;
-export type ${name}Update = Updatable<${className}>;
-
-export class ${className} extends ${baseTableExportedAs} {`,
-		props,
-		"}\n"
-	];
-	return {
-		...tableInfo,
-		content: importsCode + "\n\n" + codeToString(code, "", "  ")
 	};
+	const shapeCode = columnsShapeToCode(ctx, ast.shape);
+	const { name, className } = tableInfo;
+	const code = [`export type ${name} = Selectable<typeof ${className}>;
+export type ${name}New = Insertable<typeof ${className}>;
+export type ${name}Update = Updatable<typeof ${className}>;
+`];
+	if (tableOptions.length) code.push(`export const ${className} = ${tableFactorySource.exportedAs}(`, [
+		`${singleQuote(tableInfo.key)},`,
+		...tableOptions,
+		"(t) => ({",
+		shapeCode,
+		"}),"
+	], `)${hasTableData ? "" : ";"}`);
+	else if (hasTableData && getTableDataItemsCount(ast) === 1) code.push(`export const ${className} = ${tableFactorySource.exportedAs}(`, [
+		`${singleQuote(tableInfo.key)},`,
+		"(t) => ({",
+		shapeCode,
+		"}),"
+	], ")");
+	else code.push(`export const ${className} = ${tableFactorySource.exportedAs}(${singleQuote(tableInfo.key)}, (t) => ({`, shapeCode, `}))${hasTableData ? "" : ";"}`);
+	if (hasTableData) {
+		let tableDataCode = getTableDataChainCode(ast, ctx);
+		if (ast.constraints?.some(({ check }) => check)) tableDataCode = addTrailingSemicolon(tableDataCode);
+		code.push(tableDataCode, ";");
+	}
+	return importsToCode({
+		"orchid-orm": "Selectable, Insertable, Updatable",
+		[getImportPath(tableInfo.path, tableFactorySource.path)]: ctx.isSqlUsed ? `${tableFactorySource.exportedAs}, sql` : tableFactorySource.exportedAs
+	}) + "\n\n" + formatColumnSqlChains(codeToString(code, "", "  ")) + "\n";
+};
+const getDefineTableOptions = (tableInfo, ast) => {
+	const options = [];
+	if (ast.schema) options.push(`schema: ${singleQuote(ast.schema)},`);
+	if (tableInfo.key !== ast.name) options.push(`nameInDb: ${singleQuote(ast.name)},`);
+	if (ast.comment) options.push(`comment: ${singleQuote(ast.comment)},`);
+	if (ast.noPrimaryKey === "ignore") options.push("noPrimaryKey: true,");
+	return options.length ? [
+		"{",
+		options,
+		"},"
+	] : [];
+};
+const getTableDataChainCode = (ast, ctx) => {
+	const code = [];
+	if (ast.primaryKey) code.push(primaryKeyInnerToCode(ast.primaryKey, ""));
+	if (ast.indexes) for (const index of ast.indexes) code.push(...removeTrailingComma(indexToCode(index, "")));
+	if (ast.excludes) for (const exclude of ast.excludes) code.push(...removeTrailingComma(excludeToCode(exclude, "")));
+	if (ast.constraints) for (const constraint of ast.constraints) code.push(...removeTrailingComma(constraintToCode(constraint, "", true, "", ctx)));
+	return code;
+};
+const getTableDataItemsCount = (ast) => {
+	return (ast.primaryKey ? 1 : 0) + (ast.indexes?.length ?? 0) + (ast.excludes?.length ?? 0) + (ast.constraints?.length ?? 0);
+};
+const removeTrailingComma = (code) => {
+	if (typeof code === "string") return removeComma(code);
+	const copy = [...code];
+	const lastIndex = copy.length - 1;
+	const last = copy[lastIndex];
+	if (last !== void 0) copy[lastIndex] = removeTrailingComma(last);
+	return copy;
+};
+const removeComma = (code) => code.endsWith(",") ? code.slice(0, -1) : code;
+const formatColumnSqlChains = (code) => {
+	return code.replace(/^(\s+\S+: )t((?:\.\w+\([^{}\n]*\))+)\.index\(\{\n((?:\s+[^\n]*\n)*?)(\s+)\}\)(\.check\(sql[^\n]*)$/gm, (line, prefix, chain, options, _closeIndent, check) => {
+		const methodIndent = `${" ".repeat(line.match(/^\s*/)?.[0].length ?? 0)}  `;
+		const optionIndent = `${methodIndent}  `;
+		const optionLines = options.split("\n").filter(Boolean).map((line) => `${optionIndent}${line.trimStart()}`).join("\n");
+		return `${prefix}t${chain.replace(/\./g, `\n${methodIndent}.`)}\n${methodIndent}.index({\n${optionLines}\n${methodIndent}})\n${methodIndent}${check}`;
+	});
+};
+const addTrailingSemicolon = (code) => {
+	if (typeof code === "string") return `${code};`;
+	const copy = [...code];
+	const lastIndex = copy.length - 1;
+	const last = copy[lastIndex];
+	if (last !== void 0) copy[lastIndex] = addTrailingSemicolon(last);
+	return copy;
 };
 function importsToCode(imports) {
 	return Object.entries(imports).map(([from, name]) => `import { ${name} } from '${from}';`).join("\n");
@@ -3673,14 +3708,20 @@ const applyChanges = (content, changes) => {
 	return changes.length ? changes.map((item) => typeof item === "string" ? item : content.slice(item[0], item[1])).join("") : content;
 };
 const pull = async (adapters, config) => {
-	if (!config.dbPath || !config.baseTable) throw new Error(`\`${config.dbPath ? "baseTable" : "dbPath"}\` setting must be set in the migrations config for pull command`);
-	const baseTablePath = config.baseTable.getFilePath();
-	const baseTableExportedAs = config.baseTable.exportAs;
+	const { defineTable } = config;
+	if (!config.dbPath || !defineTable) throw new Error(`\`${config.dbPath ? "defineTable" : "dbPath"}\` setting must be set in the migrations config for pull command`);
+	if (!defineTable.types) throw new Error("defineTable is missing types");
+	if (!defineTable.exportAs) throw new Error("defineTable is missing exportAs");
+	if (typeof defineTable.getFilePath !== "function") throw new Error("defineTable is missing getFilePath");
+	const tableFactorySource = {
+		path: defineTable.getFilePath(),
+		exportedAs: defineTable.exportAs
+	};
 	const [adapter] = adapters;
 	const adapterSchema = adapter.getSchema();
 	const currentSchema = (typeof adapterSchema === "function" ? adapterSchema() : adapterSchema) ?? "public";
 	const asts = await structureToAst(makeStructureToAstCtx(config, currentSchema), adapter, config);
-	const { tableInfos, fkeys } = getTableInfosAndFKeys(asts, config);
+	const tableInfos = getTableInfos(asts, config);
 	const exclusiveWriteOptions = { flag: "wx" };
 	const pendingFileWrites = [];
 	const tables = {};
@@ -3689,7 +3730,7 @@ const pull = async (adapters, config) => {
 	let firstTable;
 	for (const ast of asts) switch (ast.type) {
 		case "table": {
-			const table = appCodeGenTable(tableInfos, fkeys, ast, baseTablePath, baseTableExportedAs, currentSchema);
+			const table = appCodeGenTable(tableInfos, ast, tableFactorySource, currentSchema);
 			tables[table.key] = table;
 			if (!firstTable) firstTable = table;
 			pendingFileWrites.push([