orchid-orm 1.69.0 → 1.69.1

package/dist/index.d.ts

@@ -174,9 +174,23 @@ declare function afterCommit(this: {
 interface FromQuery extends Query {
   returnType: 'all';
 }
-type OrchidORM<T extends TableClasses = TableClasses> = { [K in keyof T]: T[K] extends {
+interface OrchidORMQueryHelper<Q extends Query, Args extends unknown[], Result> {
+  <T extends Q>(q: T, ...args: Args): Result;
+  isQueryHelper: true;
+  table: Q['table'];
+  args: Args;
+  result: Result;
+}
+interface OrchidORMTableHelper<T extends Query> {
+  makeHelper<Args extends unknown[], Result>(fn: (q: T, ...args: Args) => Result): OrchidORMQueryHelper<T, Args, Result>;
+}
+type OrchidORMTables<T extends TableClasses = TableClasses> = { [K in keyof T]: T[K] extends {
+  new (): infer R extends ORMTableInput;
+} ? OrchidORMTableHelper<TableToDb<R>> : never };
+type OrchidORMDbTables<T extends TableClasses = TableClasses> = { [K in keyof T]: T[K] extends {
   new (): infer R extends ORMTableInput;
-} ? TableToDb<R> : never } & OrchidORMMethods;
+} ? TableToDb<R> : never };
+type OrchidORM<T extends TableClasses = TableClasses> = OrchidORMDbTables<T> & OrchidORMMethods;
 /**
  * Identity helper for table row-level security configuration.
  */
@@ -328,14 +342,13 @@ interface OrchidORMMethods {
   $close(): Promise<void>;
 }
 type OrchidOrmParam<Options> = true | null extends true ? 'Set strict: true to tsconfig' : Options;
-declare const orchidORMWithAdapter: <T extends TableClasses>({
-  log,
-  logger,
-  autoPreparedStatements,
-  noPrimaryKey,
-  schema,
-  ...options
-}: OrchidOrmParam<({
+declare const bundleOrchidORMTables: <T extends TableClasses>(tables: T) => OrchidORMTables<T>;
+declare const makeOrchidOrmDbWithAdapter: <T extends TableClasses>(orm: OrchidORMTables<T>, options: OrchidOrmParam<({
+  db: Query;
+} | {
+  adapter: Adapter;
+}) & DbSharedOptions>) => OrchidORM<T>;
+declare const orchidORMWithAdapter: <T extends TableClasses>(options: OrchidOrmParam<({
   db: Query;
 } | {
   adapter: Adapter;
@@ -760,4 +773,4 @@ declare const createRepo: <T extends Query, Methods extends MethodsBase<T>>(tabl
   table: T["table"];
   shape: T["shape"];
 }>(q: Q) => Query & Q & MapMethods<T, Methods>) & T, Methods>;
-export { BaseTableClass, BaseTableInstance, DefaultSelect, FromQuery, Insertable, MapMethods, MapQueryMethods, MethodsBase, ORMTableInput, OrchidORM, OrchidOrmParam, Queryable, Repo, Selectable, SetColumnsResult, Table, TableClass, TableClasses, TableInfo, TableToDb, Updatable, createBaseTable, createRepo, defineRls, orchidORMWithAdapter };
+export { BaseTableClass, BaseTableInstance, DefaultSelect, FromQuery, Insertable, MapMethods, MapQueryMethods, MethodsBase, ORMTableInput, OrchidORM, OrchidORMDbTables, OrchidORMTableHelper, OrchidORMTables, OrchidOrmParam, Queryable, Repo, Selectable, SetColumnsResult, Table, TableClass, TableClasses, TableInfo, TableToDb, Updatable, bundleOrchidORMTables, createBaseTable, createRepo, defineRls, makeOrchidOrmDbWithAdapter, orchidORMWithAdapter };

package/dist/index.js

@@ -971,11 +971,11 @@ const makeHasAndBelongsToManyMethod = (tableConfig, table, qb, relation, relatio
 	const { options } = relation;
 	const { snakeCase } = table.internal;
 	const primaryKeys = options.columns;
-	const foreignKeys = options.references;
-	const originalForeignKeys = snakeCase ? [...foreignKeys] : foreignKeys;
+	const originalForeignKeys = options.references;
+	const foreignKeys = snakeCase ? [...originalForeignKeys] : originalForeignKeys;
 	const joinTable = options.through.table;
-	const throughForeignKeys = options.through.columns;
-	const originalThroughForeignKeys = snakeCase ? [...throughForeignKeys] : throughForeignKeys;
+	const originalThroughForeignKeys = options.through.columns;
+	const throughForeignKeys = snakeCase ? [...originalThroughForeignKeys] : originalThroughForeignKeys;
 	const throughPrimaryKeys = options.through.references;
 	const { on } = options;
 	if (on) {
@@ -1375,7 +1375,68 @@ function afterCommit(hook) {
 * Identity helper for table row-level security configuration.
 */
 const defineRls = (rls) => rls;
-const orchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKey = "error", schema, ...options }, tables) => {
+const orchidORMBundleMetadataKey = Symbol("orchidORMBundleMetadataKey");
+const assignTablesToOrm = (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 $`);
+		const tableClass = tables[key];
+		const table = tableClass.instance();
+		tableInstances[key] = table;
+		const options = {
+			...commonOptions,
+			schema: table.schema || schema,
+			language: table.language,
+			scopes: table.scopes,
+			softDelete: table.softDelete,
+			snakeCase: table.snakeCase,
+			comment: table.comment,
+			noPrimaryKey: table.noPrimaryKey ? "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.constructor.prototype.columns?.data ?? {});
+		dbTable.definedAs = key;
+		dbTable.db = result;
+		dbTable.filePath = table.filePath;
+		dbTable.name = table.constructor.name;
+		dbTable.internal.tableRls = table.rls;
+		result[key] = dbTable;
+	}
+	applyRelations(qb, tableInstances, result, schema);
+	return tableInstances;
+};
+const bundleOrchidORMTables = (tables) => {
+	const result = {};
+	let dbAwareInstance;
+	for (const key in tables) result[key] = { makeHelper(arg) {
+		let fn;
+		return (...args) => {
+			if (!fn) fn = dbAwareInstance[key].makeHelper(arg);
+			return fn(...args);
+		};
+	} };
+	Object.defineProperty(result, orchidORMBundleMetadataKey, {
+		enumerable: false,
+		value: {
+			tables,
+			setDbAwareInstance(orm) {
+				dbAwareInstance = orm;
+			}
+		}
+	});
+	return result;
+};
+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.");
+	return meta;
+};
+const makeOrchidOrmDbWithAdapter = (orm, options) => {
+	const meta = getOrchidORMBundleMetadata(orm);
+	return privateOrchidORMWithAdapter(options, meta.tables, meta.setDbAwareInstance);
+};
+const privateOrchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKey = "error", schema, ...options }, tables, setDbAwareInstance) => {
 	const commonOptions = {
 		log,
 		logger,
@@ -1414,33 +1475,8 @@ const orchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKe
 		$close: adapter.close.bind(adapter),
 		$withOptions: qb.withOptions.bind(qb)
 	};
-	const tableInstances = {};
-	for (const key in tables) {
-		if (key[0] === "$") throw new Error(`Table class name must not start with $`);
-		const tableClass = tables[key];
-		const table = tableClass.instance();
-		tableInstances[key] = table;
-		const options = {
-			...commonOptions,
-			schema: table.schema || schema,
-			language: table.language,
-			scopes: table.scopes,
-			softDelete: table.softDelete,
-			snakeCase: table.snakeCase,
-			comment: table.comment,
-			noPrimaryKey: table.noPrimaryKey ? "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.constructor.prototype.columns?.data ?? {});
-		dbTable.definedAs = key;
-		dbTable.db = result;
-		dbTable.filePath = table.filePath;
-		dbTable.name = table.constructor.name;
-		dbTable.internal.tableRls = table.rls;
-		result[key] = dbTable;
-	}
-	applyRelations(qb, tableInstances, result, schema);
+	const tableInstances = assignTablesToOrm(tables, result, adapter, qb, asyncStorage, commonOptions, schema);
+	setDbAwareInstance?.(result);
 	for (const key in tables) {
 		const table = tableInstances[key];
 		if (table.init) {
@@ -1450,6 +1486,7 @@ const orchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPrimaryKe
 	}
 	return result;
 };
+const orchidORMWithAdapter = (options, tables) => privateOrchidORMWithAdapter(options, tables);
 function $getAdapter() {
 	return this.$qb.$getAdapter();
 }
@@ -1480,9 +1517,11 @@ const createRepo = (table, methods) => {
 		return q[key];
 	} });
 };
+exports.bundleOrchidORMTables = bundleOrchidORMTables;
 exports.createBaseTable = createBaseTable;
 exports.createRepo = createRepo;
 exports.defineRls = defineRls;
+exports.makeOrchidOrmDbWithAdapter = makeOrchidOrmDbWithAdapter;
 exports.orchidORMWithAdapter = orchidORMWithAdapter;
 Object.keys(pqb).forEach(function(k) {
 	if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {