@h3ravel/arquebus 0.4.1 → 0.6.0

package/dist/migrations/index.cjs

@@ -45,18 +45,16 @@ let path = require("path");
 path = __toESM(path);
 let fs = require("fs");
 fs = __toESM(fs);
-let pluralize = require("pluralize");
-pluralize = __toESM(pluralize);
-let node_fs_promises = require("node:fs/promises");
-node_fs_promises = __toESM(node_fs_promises);
 let fs_promises = require("fs/promises");
 fs_promises = __toESM(fs_promises);
 let escalade_sync = require("escalade/sync");
 escalade_sync = __toESM(escalade_sync);
 let resolve_from = require("resolve-from");
 resolve_from = __toESM(resolve_from);
-let node_fs = require("node:fs");
-node_fs = __toESM(node_fs);
+let pluralize = require("pluralize");
+pluralize = __toESM(pluralize);
+let node_fs_promises = require("node:fs/promises");
+node_fs_promises = __toESM(node_fs_promises);
 let node_path = require("node:path");
 node_path = __toESM(node_path);
 let node_url = require("node:url");
@@ -1451,7 +1449,7 @@ var InvalidArgumentError = class extends BaseError {};
 var mixin_exports = /* @__PURE__ */ __export({ compose: () => compose$1 });
 /**
 * Compose function that merges multiple classes and mixins
-* 
+*
 * @example
 * const SomePlugin = <TBase extends new (...args: any[]) => TGeneric> (Base: TBase) => {
 *     return class extends Base {
@@ -1488,10 +1486,10 @@ var mixin_exports = /* @__PURE__ */ __export({ compose: () => compose$1 });
 * console.log(user.pluginMethod('w')) // "plugin"
 * console.log(user.pluginMethod()) // "plugin"
 * console.log(user.relationPosts()) // "hasMany Posts"
-* 
-* @param Base 
-* @param mixins 
-* @returns 
+*
+* @param Base
+* @param mixins
+* @returns
 */
 function compose$1(Base, ...mixins) {
 	/**
@@ -1545,10 +1543,10 @@ const getSetterMethod = (attr) => {
 };
 /**
 * Tap into a model a collection instance
-* 
-* @param instance 
-* @param callback 
-* @returns 
+*
+* @param instance
+* @param callback
+* @returns
 */
 const tap = (instance, callback) => {
 	const result = callback(instance);
@@ -2384,8 +2382,8 @@ var HasManyThrough = class extends relation_default {
 		const results = await this.take(1).get(columns);
 		return results.count() > 0 ? results.first() : null;
 	}
-	async firstOrFail(columns = ["*"]) {
-		const model = await this.first(columns);
+	async firstOrFail(...columns) {
+		const model = await this.first(...columns);
 		if (model) return model;
 		throw new ModelNotFoundError().setModel(this.related.constructor);
 	}
@@ -2424,7 +2422,7 @@ var HasManyThrough = class extends relation_default {
 	}
 	async paginate(perPage = null, columns = ["*"], pageName = "page", page = null) {
 		this.query.addSelect(this.shouldSelect(columns));
-		return await this.query.paginate(perPage, columns, pageName, page);
+		return await this.query.paginate(perPage ?? 15, columns, pageName, page);
 	}
 	shouldSelect(columns = ["*"]) {
 		if ((columns === null || columns === void 0 ? void 0 : columns.at(0)) == "*") columns = [this.related.getTable() + ".*"];
@@ -2702,9 +2700,6 @@ const UniqueIds = (Model$1) => {
 		uniqueIds() {
 			return [];
 		}
-		newUniqueId() {
-			return null;
-		}
 		setUniqueIds() {
 			const uniqueIds = this.uniqueIds();
 			for (const column of uniqueIds) if (this[column] === null || this[column] === void 0) this[column] = this.newUniqueId();
@@ -2726,6 +2721,7 @@ var Paginator = class {
 	options = {};
 	static setFormatter(formatter) {
 		if (typeof formatter !== "function" && formatter !== null && formatter !== void 0) throw new Error("Paginator formatter must be a function or null");
+		if (!formatter) return;
 		this.formatter = formatter;
 	}
 	constructor(items, total, perPage, currentPage = 1, options = {}) {
@@ -2814,8 +2810,10 @@ var QueryBuilder = class QueryBuilder extends Inference$2 {
 	asProxy() {
 		return new Proxy(this, {
 			get: function(target, prop) {
+				var _target$connector$cli;
 				if (typeof target[prop] !== "undefined") return target[prop];
 				if (["destroy", "schema"].includes(prop)) return target.connector.schema;
+				const skipReturning = !!((_target$connector$cli = target.connector.client.config) === null || _target$connector$cli === void 0 || (_target$connector$cli = _target$connector$cli.client) === null || _target$connector$cli === void 0 ? void 0 : _target$connector$cli.includes("mysql")) && prop === "returning";
 				if ([
 					"select",
 					"from",
@@ -2878,7 +2876,7 @@ var QueryBuilder = class QueryBuilder extends Inference$2 {
 					"clearWhere",
 					"clearHaving",
 					"clearGroup"
-				].includes(prop)) return (...args) => {
+				].includes(prop) && !skipReturning) return (...args) => {
 					target.connector[prop](...args);
 					return target.asProxy();
 				};
@@ -2935,7 +2933,7 @@ var QueryBuilder = class QueryBuilder extends Inference$2 {
 		} while (countResults === count);
 		return true;
 	}
-	async paginate(page = 1, perPage = 15) {
+	async paginate(page = 1, perPage = 15, _pageName, _page) {
 		const total = await this.clone().clearOrder().count("*");
 		let results;
 		if (total > 0) {
@@ -2999,6 +2997,59 @@ var QueryBuilder = class QueryBuilder extends Inference$2 {
 };
 var query_builder_default = QueryBuilder;
 
+//#endregion
+//#region src/cli/utils.ts
+const join = path.default.join;
+var Utils = class {
+	/**
+	* Wraps text with chalk
+	*
+	* @param txt
+	* @param color
+	* @returns
+	*/
+	static textFormat(txt, color) {
+		return String(txt).split(":").map((e, i, a) => i == 0 && a.length > 1 ? color(" " + e + ": ") : e).join("");
+	}
+	static findModulePkg(moduleId, cwd) {
+		const parts = moduleId.replace(/\\/g, "/").split("/");
+		let packageName = "";
+		if (parts.length > 0 && parts[0][0] === "@") packageName += parts.shift() + "/";
+		packageName += parts.shift();
+		const packageJson = path.default.join(packageName, "package.json");
+		const resolved = resolve_from.default.silent(cwd ?? process.cwd(), packageJson);
+		if (!resolved) return;
+		return path.default.join(path.default.dirname(resolved), parts.join("/"));
+	}
+	static async getMigrationPaths(cwd, migrator, defaultPath, path$7) {
+		if (path$7) return [join(cwd, path$7)];
+		return [...migrator.getPaths(), join(cwd, defaultPath)];
+	}
+	/**
+	* Check if file exists
+	*
+	* @param path
+	* @returns
+	*/
+	static async fileExists(path$7) {
+		try {
+			await (0, fs_promises.access)(path$7);
+			return true;
+		} catch {
+			return false;
+		}
+	}
+	static findUpConfig(cwd, name, extensions) {
+		return (0, escalade_sync.default)(cwd, (_dir, names) => {
+			for (const ext of extensions) {
+				const filename = `${name}.${ext}`;
+				if (names.includes(filename)) return filename;
+			}
+			return false;
+		});
+	}
+};
+
 //#endregion
 //#region src/arquebus.ts
 var arquebus = class arquebus {
@@ -3020,22 +3071,22 @@ var arquebus = class arquebus {
 		return this.instance;
 	}
 	/**
-	* Initialize a new database connection 
-	* 
-	* @returns 
+	* Initialize a new database connection
+	*
+	* @returns
 	*/
 	static fire(connection = null) {
 		return this.getInstance().getConnection(connection);
 	}
 	/**
-	* Initialize a new database connection 
-	* 
+	* Initialize a new database connection
+	*
 	* This is an alias of `arquebus.fire()` and will be removed in the future
-	* 
+	*
 	* @deprecated since version 0.3.0
 	* @alias fire
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	static connection(connection = null) {
 		return this.fire(connection);
@@ -3072,11 +3123,12 @@ var arquebus = class arquebus {
 	}
 	getConnection(name = null) {
 		name = name || "default";
-		if (this.manager[name] === void 0) {
-			const queryBuilder = new query_builder_default(this.connections[name], arquebus.getConnectorFactory());
-			this.manager[name] = queryBuilder;
+		const resolvedName = this.connections[name] ? name : "default";
+		if (this.manager[resolvedName] === void 0) {
+			const queryBuilder = new query_builder_default(this.connections[resolvedName], arquebus.getConnectorFactory());
+			this.manager[resolvedName] = queryBuilder;
 		}
-		return this.manager[name];
+		return this.manager[resolvedName];
 	}
 	addConnection(config, name = "default") {
 		this.connections[name] = {
@@ -3093,13 +3145,13 @@ var arquebus = class arquebus {
 	}
 	/**
 	* Autoload the config file
-	* 
-	* @param addConnection 
+	*
+	* @param addConnection
 	* @default true
-	* If set to `false` we will no attempt add the connection, we 
+	* If set to `false` we will no attempt add the connection, we
 	* will just go ahead and return the config
-	* 
-	* @returns 
+	*
+	* @returns
 	*/
 	static async autoLoad(addConnection = true) {
 		let config;
@@ -3116,6 +3168,23 @@ var arquebus = class arquebus {
 			if (addConnection) instance.addConnection(config, config.client);
 			return config;
 		} else throw new Error("arquebus.config.ts found in production without build step");
+		const candidateDirs = [
+			process.cwd(),
+			path.default.join(process.cwd(), "test", "cli"),
+			path.default.join(process.cwd(), "test")
+		];
+		for (const dir of candidateDirs) {
+			const found = Utils.findUpConfig(dir, "arquebus.config", [
+				"js",
+				"ts",
+				"cjs"
+			]);
+			if (found) if (!found.endsWith(".ts") || process.env.NODE_ENV !== "production") {
+				config = (await import(found)).default;
+				if (addConnection) instance.addConnection(config, config.client);
+				return config;
+			} else throw new Error("arquebus.config.ts found in production without build step");
+		}
 		return {};
 	}
 	beginTransaction(connection = null) {
@@ -3174,14 +3243,15 @@ var arquebus_default = arquebus;
 
 //#endregion
 //#region src/model.ts
-const BaseModel = compose(class {}, has_attributes_default, hides_attributes_default, has_relations_default, has_timestamps_default, has_hooks_default, has_global_scopes_default, unique_ids_default);
+const ModelClass = class {};
+const BaseModel = compose(ModelClass, has_attributes_default, hides_attributes_default, has_relations_default, has_timestamps_default, has_hooks_default, has_global_scopes_default, unique_ids_default);
 var Model = class Model extends BaseModel {
-	primaryKey = "id";
 	builder = null;
 	table = null;
 	keyType = "int";
 	incrementing = true;
 	withCount = [];
+	primaryKey = "id";
 	perPage = 15;
 	static globalScopes = {};
 	static pluginInitializers = {};
@@ -3191,6 +3261,7 @@ var Model = class Model extends BaseModel {
 	eagerLoad = {};
 	exists = false;
 	with = [];
+	name;
 	trx = null;
 	constructor(attributes = {}) {
 		super();
@@ -3962,8 +4033,8 @@ var BelongsToMany = class extends compose(relation_default, interacts_with_pivot
 		const results = await this.take(1).get(columns);
 		return results.count() > 0 ? results.first() : null;
 	}
-	async firstOrFail(columns = ["*"]) {
-		const model = await this.first(columns);
+	async firstOrFail(...columns) {
+		const model = await this.first(...columns);
 		if (model !== null) return model;
 		throw new ModelNotFoundError().setModel(this.related.constructor);
 	}
@@ -4139,7 +4210,9 @@ var Builder = class Builder extends Inference$1 {
 	}
 	asProxy() {
 		return new Proxy(this, { get(target, prop) {
+			var _target$query$connect;
 			if (typeof target[prop] !== "undefined") return target[prop];
+			const skipReturning = !!((_target$query$connect = target.query.connector) === null || _target$query$connect === void 0 || (_target$query$connect = _target$query$connect.client.config) === null || _target$query$connect === void 0 || (_target$query$connect = _target$query$connect.client) === null || _target$query$connect === void 0 ? void 0 : _target$query$connect.includes("mysql")) && prop === "returning";
 			if ([
 				"select",
 				"from",
@@ -4202,7 +4275,7 @@ var Builder = class Builder extends Inference$1 {
 				"clearWhere",
 				"clearHaving",
 				"clearGroup"
-			].includes(prop)) return (...args) => {
+			].includes(prop) && !skipReturning) return (...args) => {
 				target.query[prop](...args);
 				return target.asProxy();
 			};
@@ -5081,9 +5154,9 @@ var Migrator = class {
 	}
 	/**
 	* Drop all tables and re-run all migrations
-	* 
-	* @param paths 
-	* @param options 
+	*
+	* @param paths
+	* @param options
 	*/
 	async fresh(paths, options) {
 		/** Initialise connections */
@@ -5175,59 +5248,6 @@ var Migrator = class {
 };
 var migrator_default = Migrator;
 
-//#endregion
-//#region src/cli/utils.ts
-const join = path.default.join;
-var Utils = class {
-	/**
-	* Wraps text with chalk
-	* 
-	* @param txt 
-	* @param color 
-	* @returns 
-	*/
-	static textFormat(txt, color) {
-		return String(txt).split(":").map((e, i, a) => i == 0 && a.length > 1 ? color(" " + e + ": ") : e).join("");
-	}
-	static findModulePkg(moduleId, cwd) {
-		const parts = moduleId.replace(/\\/g, "/").split("/");
-		let packageName = "";
-		if (parts.length > 0 && parts[0][0] === "@") packageName += parts.shift() + "/";
-		packageName += parts.shift();
-		const packageJson = path.default.join(packageName, "package.json");
-		const resolved = resolve_from.default.silent(cwd ?? process.cwd(), packageJson);
-		if (!resolved) return;
-		return path.default.join(path.default.dirname(resolved), parts.join("/"));
-	}
-	static async getMigrationPaths(cwd, migrator, defaultPath, path$5) {
-		if (path$5) return [join(cwd, path$5)];
-		return [...migrator.getPaths(), join(cwd, defaultPath)];
-	}
-	/**
-	* Check if file exists
-	* 
-	* @param path 
-	* @returns 
-	*/
-	static async fileExists(path$5) {
-		try {
-			await (0, fs_promises.access)(path$5);
-			return true;
-		} catch {
-			return false;
-		}
-	}
-	static findUpConfig(cwd, name, extensions) {
-		return (0, escalade_sync.default)(cwd, (_dir, names) => {
-			for (const ext of extensions) {
-				const filename = `${name}.${ext}`;
-				if (names.includes(filename)) return filename;
-			}
-			return false;
-		});
-	}
-};
-
 //#endregion
 //#region src/migrate.ts
 var Migrate = class {
@@ -5239,10 +5259,10 @@ var Migrate = class {
 	}
 	/**
 	* Runs all pending migrations
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
 	*/
 	async run(config, options = {}, destroyAll = false) {
 		const { arquebus: arquebus$1, migrator } = await this.setupConnection(config);
@@ -5256,10 +5276,10 @@ var Migrate = class {
 	}
 	/**
 	* Rollback the last migration
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
 	*/
 	async rollback(config, options = {}, destroyAll = false) {
 		const { arquebus: arquebus$1, migrator } = await this.setupConnection(config);
@@ -5273,10 +5293,10 @@ var Migrate = class {
 	}
 	/**
 	* Rollback all database migrations
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
 	*/
 	async reset(config, options = {}, destroyAll = false) {
 		const { arquebus: arquebus$1, migrator } = await this.setupConnection(config);
@@ -5291,10 +5311,10 @@ var Migrate = class {
 	}
 	/**
 	* Reset and re-run all migrations
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
 	*/
 	async refresh(config, options = {}, destroyAll = false) {
 		await this.reset(config, Object.assign({}, options, { quiet: true }), false);
@@ -5303,10 +5323,10 @@ var Migrate = class {
 	}
 	/**
 	* Drop all tables and re-run all migrations
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
 	*/
 	async fresh(config, options = {}, destroyAll = false) {
 		const { arquebus: arquebus$1, migrator } = await this.setupConnection(config);
@@ -5316,8 +5336,8 @@ var Migrate = class {
 	}
 	/**
 	* Prepares the database for migration
-	* 
-	* @param migrator 
+	*
+	* @param migrator
 	*/
 	async prepareDatabase(migrator) {
 		if (!await migrator.repositoryExists()) {
@@ -5329,11 +5349,11 @@ var Migrate = class {
 	}
 	/**
 	* Check the status of available migrations
-	* 
-	* @param config 
-	* @param options 
-	* @param destroyAll 
-	* @returns 
+	*
+	* @param config
+	* @param options
+	* @param destroyAll
+	* @returns
 	*/
 	async status(config, options = {}, destroyAll = false) {
 		const { arquebus: arquebus$1, migrator } = await this.setupConnection(config);
@@ -5360,9 +5380,9 @@ var Migrate = class {
 	}
 	/**
 	* Setup the database connection
-	* 
-	* @param config 
-	* @returns 
+	*
+	* @param config
+	* @returns
 	*/
 	async setupConnection(config) {
 		var _config$migrations;
@@ -5392,54 +5412,54 @@ var MigrationCreator = class {
 	}
 	/**
 	* Create a new migration file
-	* 
-	* @param name 
-	* @param dir 
-	* @param table 
-	* @param create 
-	* @returns 
+	*
+	* @param name
+	* @param dir
+	* @param table
+	* @param create
+	* @returns
 	*/
 	async create(name, dir, table, create = false) {
-		const stub = this.getStub(table, create);
+		const stub = await this.getStub(table, create);
 		const filePath = this.getPath(name, dir);
 		await this.ensureDirectoryExists(path.default.dirname(filePath));
-		await node_fs_promises.default.writeFile(filePath, this.populateStub(stub, table));
+		await (0, node_fs_promises.writeFile)(filePath, this.populateStub(stub, table));
 		await this.firePostCreateHooks(table, filePath);
 		return filePath;
 	}
 	/**
 	* Publish migrations from third party vendors
-	* 
-	* @param dir 
-	* @param callback 
+	*
+	* @param dir
+	* @param callback
 	*/
 	async publish(dir, callback) {
-		const migrationFiles = await node_fs_promises.default.readdir(this.customStubPath ?? "");
+		const migrationFiles = await (0, node_fs_promises.readdir)(this.customStubPath ?? "");
 		await this.ensureDirectoryExists(dir);
 		for (const migrationFile of migrationFiles) {
 			const sourceFilePath = path.default.join(this.customStubPath ?? "", migrationFile);
 			const destinationFilePath = path.default.join(dir, migrationFile);
-			await node_fs_promises.default.copyFile(sourceFilePath, destinationFilePath);
+			await (0, node_fs_promises.copyFile)(sourceFilePath, destinationFilePath);
 			if (callback) callback(migrationFile, sourceFilePath, destinationFilePath);
 		}
 	}
-	getStub(table, create = false) {
+	async getStub(table, create = false) {
 		let stub;
 		if (!table) {
 			const customPath = path.default.join(this.customStubPath ?? "", `migration-${this.type}.stub`);
 			console.log("\n", customPath, "---");
-			stub = (0, node_fs.existsSync)(customPath) ? customPath : this.stubPath(`/migration-${this.type}.stub`);
+			stub = await __h3ravel_shared.FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration-${this.type}.stub`);
 		} else if (create) {
 			const customPath = path.default.join(this.customStubPath ?? "", `migration.create-${this.type}.stub`);
-			stub = (0, node_fs.existsSync)(customPath) ? customPath : this.stubPath(`/migration.create-${this.type}.stub`);
+			stub = await __h3ravel_shared.FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration.create-${this.type}.stub`);
 		} else {
 			const customPath = path.default.join(this.customStubPath ?? "", `migration.update-${this.type}.stub`);
-			stub = (0, node_fs.existsSync)(customPath) ? customPath : this.stubPath(`/migration.update-${this.type}.stub`);
+			stub = await __h3ravel_shared.FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration.update-${this.type}.stub`);
 		}
-		return (0, node_fs.readFileSync)(stub, "utf-8");
+		return await (0, node_fs_promises.readFile)(stub, "utf-8");
 	}
 	populateStub(stub, table) {
-		if (table !== null) stub = stub.replace(/DummyTable|{{\s*table\s*}}/g, table);
+		if (table) stub = stub.replace(/DummyTable|{{\s*table\s*}}/g, table);
 		return stub;
 	}
 	getClassName(name) {
@@ -5456,7 +5476,7 @@ var MigrationCreator = class {
 		this.postCreate.push(callback);
 	}
 	async ensureDirectoryExists(dir) {
-		await node_fs_promises.default.mkdir(dir, { recursive: true });
+		await (0, node_fs_promises.mkdir)(dir, { recursive: true });
 	}
 	stubPath(stub = "") {
 		const __dirname$1 = this.getDirname({});