orchid-orm 1.72.7 → 1.72.9

package/dist/index.js

@@ -131,6 +131,19 @@ function createBaseTable({ schemaConfig = pqb_internal.defaultSchemaConfig, colu
 		}
 	};
 	(0, pqb_internal.applyMixins)(base, [pqb_internal.QueryHooks]);
+	const baseWithView = base;
+	baseWithView.View = class View extends base {
+		constructor(..._args) {
+			super(..._args);
+			this.readOnly = true;
+		}
+	};
+	baseWithView.MaterializedView = class MaterializedView extends baseWithView.View {
+		constructor(..._args2) {
+			super(..._args2);
+			this.materialized = true;
+		}
+	};
 	base.prototype.types = columnTypes;
 	base.prototype.snakeCase = snakeCase;
 	base.prototype.language = language;
@@ -1446,10 +1459,10 @@ const defineRls = (rls) => rls;
 */
 const setGrants = (grants) => grants;
 const orchidORMBundleMetadataKey = Symbol("orchidORMBundleMetadataKey");
-const assignTablesToOrm = (tables, result, adapter, qb, asyncStorage, commonOptions, schema) => {
+const assignTablesToOrm = (isTable, tables, result, adapter, qb, asyncStorage, commonOptions, schema) => {
 	const tableInstances = {};
 	for (const key in tables) {
-		if (key[0] === "$") throw new Error(`Table class name must not start with $`);
+		if (key[0] === "$") throw new Error(`${isTable ? "Table" : "View"} class name must not start with $`);
 		const tableClass = tables[key];
 		const tableImmutable = tableClass.instance();
 		const table = Object.create(tableImmutable);
@@ -1467,12 +1480,14 @@ const assignTablesToOrm = (tables, result, adapter, qb, asyncStorage, commonOpti
 			softDelete: table.softDelete,
 			snakeCase: table.snakeCase,
 			comment: table.comment,
-			readOnly: table.readOnly,
-			noPrimaryKey: table.noPrimaryKey ? "ignore" : void 0,
+			readOnly: isTable ? table.readOnly ? true : void 0 : table.materialized || table.readOnly !== false ? true : void 0,
+			materialized: !isTable && table.materialized ? true : void 0,
+			generatorIgnore: table.generatorIgnore,
+			noPrimaryKey: table.noPrimaryKey || !isTable ? "ignore" : void 0,
 			computed: table.computed,
 			nowSQL: tableClass.nowSQL
 		};
-		const dbTable = new pqb.Db(adapter, qb, table.table, table.columns.shape, table.types, asyncStorage, options, table.columns?.data ?? {});
+		const dbTable = new pqb.Db(adapter, qb, isTable ? table.table : table.name, table.columns.shape, table.types, asyncStorage, options, table.columns?.data ?? {}, getViewData(isTable, table));
 		dbTable.definedAs = key;
 		dbTable.db = result;
 		dbTable.filePath = table.filePath;
@@ -1481,11 +1496,28 @@ const assignTablesToOrm = (tables, result, adapter, qb, asyncStorage, commonOpti
 		dbTable.internal.tableGrants = table.grants;
 		result[key] = dbTable;
 	}
-	applyRelations(qb, tableInstances, result, schema);
 	return tableInstances;
 };
-const bundleOrchidORMTables = (tables) => {
+const getViewData = (isTable, table) => {
+	if (isTable) return;
+	return {
+		query: table.query,
+		sql: table.sql,
+		recursive: table.recursive,
+		checkOption: table.checkOption,
+		securityBarrier: table.securityBarrier,
+		securityInvoker: table.securityInvoker,
+		withData: table.withData
+	};
+};
+const bundleOrchidORM = ({ tables = {}, views = {} }) => {
 	const result = {};
+	const bundledViews = {};
+	const hasViews = Object.keys(views).length > 0;
+	Object.defineProperty(result, "$views", {
+		enumerable: hasViews,
+		value: bundledViews
+	});
 	let dbAwareInstance;
 	for (const key in tables) result[key] = {
 		table: tables[key].instance().table,
@@ -1497,10 +1529,21 @@ const bundleOrchidORMTables = (tables) => {
 			};
 		}
 	};
+	for (const key in views) bundledViews[key] = {
+		table: views[key].instance().name,
+		makeHelper(arg) {
+			let fn;
+			return (...args) => {
+				if (!fn) fn = dbAwareInstance.$views[key].makeHelper(arg);
+				return fn(...args);
+			};
+		}
+	};
 	Object.defineProperty(result, orchidORMBundleMetadataKey, {
 		enumerable: false,
 		value: {
 			tables,
+			views,
 			setDbAwareInstance(orm) {
 				dbAwareInstance = orm;
 			}
@@ -1508,16 +1551,18 @@ const bundleOrchidORMTables = (tables) => {
 	});
 	return result;
 };
+const bundleOrchidORMTables = (tables) => bundleOrchidORM({ tables });
 const getOrchidORMBundleMetadata = (orm) => {
 	const meta = orm[orchidORMBundleMetadataKey];
-	if (!meta) throw new Error("Failed to bind Orchid ORM tables: pass a table bundle created by bundleOrchidORMTables.");
+	if (!meta) throw new Error("Failed to bind Orchid ORM tables: pass a bundle created by bundleOrchidORM.");
 	return meta;
 };
 const makeOrchidOrmDbWithAdapter = (orm, options) => {
 	const meta = getOrchidORMBundleMetadata(orm);
-	return privateOrchidORMWithAdapter(options, meta.tables, meta.setDbAwareInstance);
+	return privateOrchidORMWithAdapter(options, meta.tables, meta.views, meta.setDbAwareInstance);
 };
-const privateOrchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKey = "error", schema, ...options }, tables, setDbAwareInstance) => {
+const privateOrchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKey = "error", schema, views, ...options }, tables, bundledViews, setDbAwareInstance) => {
+	if (bundledViews) views = bundledViews;
 	const commonOptions = {
 		log,
 		logger,
@@ -1556,13 +1601,48 @@ const privateOrchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPr
 		$close: adapter.close.bind(adapter),
 		$withOptions: qb.withOptions.bind(qb)
 	};
-	const tableInstances = assignTablesToOrm(tables, result, adapter, qb, asyncStorage, commonOptions, schema);
+	result.$views = {};
+	const tableInstances = assignTablesToOrm(true, tables, result, adapter, qb, asyncStorage, commonOptions, schema);
+	let viewInstances;
+	if (views) {
+		viewInstances = assignTablesToOrm(false, views, result.$views, adapter, qb, asyncStorage, commonOptions, schema);
+		const tableDbNames = Object.values(tableInstances).map((table) => {
+			const s = typeof table.schema === "function" ? table.schema() : table.schema;
+			return `${s ? s + "." : ""}${table.table}`;
+		});
+		for (const key in views) {
+			const view = viewInstances[key];
+			const s = typeof view.schema === "function" ? view.schema() : view.schema;
+			const name = `${s ? s + "." : ""}${view.name}`;
+			if (tableDbNames.includes(name)) throw new Error(`Cannot configure both a table and a view for database relation ${name}`);
+		}
+	}
+	applyRelations(qb, {
+		...tableInstances,
+		...viewInstances
+	}, {
+		...result,
+		...result.$views
+	}, schema);
 	setDbAwareInstance?.(result);
-	for (const key in tables) {
-		const table = tableInstances[key];
-		if (table.init) {
-			table.init(result);
-			Object.assign(result[key].baseQuery.q, table.q);
+	const initItems = [[
+		tableInstances,
+		result,
+		true
+	], [
+		viewInstances,
+		result.$views,
+		false
+	]];
+	for (const [items, queries, isTable] of initItems) {
+		if (!items) continue;
+		for (const key in items) {
+			const table = items[key];
+			if (table.init) {
+				table.init(result);
+				Object.assign(queries[key].baseQuery.q, table.q);
+				if (!isTable) queries[key].internal.viewData = getViewData(false, table);
+			}
 		}
 	}
 	return result;
@@ -1598,6 +1678,7 @@ const createRepo = (table, methods) => {
 		return q[key];
 	} });
 };
+exports.bundleOrchidORM = bundleOrchidORM;
 exports.bundleOrchidORMTables = bundleOrchidORMTables;
 exports.createBaseTable = createBaseTable;
 exports.createRepo = createRepo;