@h3ravel/arquebus 0.4.1 → 0.6.0

package/dist/index.js

@@ -6,12 +6,14 @@ import collect$1, { Collection, collect } from "collect.js";
 import Knex$1 from "knex";
 import path from "path";
 import { existsSync } from "fs";
-import pluralize from "pluralize";
-import { Logger, TaskManager } from "@h3ravel/shared";
-import fs from "node:fs/promises";
 import { access } from "fs/promises";
 import escalade from "escalade/sync";
 import resolveFrom from "resolve-from";
+import pluralize from "pluralize";
+import { Logger, TaskManager } from "@h3ravel/shared";
+import fs, { access as access$1, mkdir, readFile, writeFile } from "node:fs/promises";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
 
 //#region rolldown:runtime
 var __defProp = Object.defineProperty;
@@ -97,7 +99,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 {
@@ -134,10 +136,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) {
 	/**
@@ -198,10 +200,10 @@ const getAttrName = (attrMethod) => {
 };
 /**
 * 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);
@@ -1041,8 +1043,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);
 	}
@@ -1081,7 +1083,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() + ".*"];
@@ -1359,9 +1361,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();
@@ -1383,6 +1382,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 = {}) {
@@ -1471,8 +1471,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",
@@ -1535,7 +1537,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();
 				};
@@ -1592,7 +1594,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) {
@@ -1656,6 +1658,59 @@ var QueryBuilder = class QueryBuilder extends Inference$2 {
 };
 var query_builder_default = QueryBuilder;
 
+//#endregion
+//#region src/cli/utils.ts
+const join = path.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.join(packageName, "package.json");
+		const resolved = resolveFrom.silent(cwd ?? process.cwd(), packageJson);
+		if (!resolved) return;
+		return path.join(path.dirname(resolved), parts.join("/"));
+	}
+	static async getMigrationPaths(cwd, migrator, defaultPath, path$1) {
+		if (path$1) return [join(cwd, path$1)];
+		return [...migrator.getPaths(), join(cwd, defaultPath)];
+	}
+	/**
+	* Check if file exists
+	*
+	* @param path
+	* @returns
+	*/
+	static async fileExists(path$1) {
+		try {
+			await access(path$1);
+			return true;
+		} catch {
+			return false;
+		}
+	}
+	static findUpConfig(cwd, name, extensions) {
+		return escalade(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 {
@@ -1677,22 +1732,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);
@@ -1729,11 +1784,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] = {
@@ -1750,13 +1806,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;
@@ -1773,6 +1829,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.join(process.cwd(), "test", "cli"),
+			path.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) {
@@ -1831,14 +1904,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 = {};
@@ -1848,6 +1922,7 @@ var Model = class Model extends BaseModel {
 	eagerLoad = {};
 	exists = false;
 	with = [];
+	name;
 	trx = null;
 	constructor(attributes = {}) {
 		super();
@@ -2619,8 +2694,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);
 	}
@@ -2796,7 +2871,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",
@@ -2859,7 +2936,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();
 			};
@@ -4953,7 +5030,7 @@ var SchemaInspector = class {
 
 //#endregion
 //#region src/migrations/migrator.ts
-async function glob(folderPath) {
+async function glob$1(folderPath) {
 	const files = await fs.readdir(folderPath);
 	const allFiles = [];
 	for (const file of files) {
@@ -4961,7 +5038,7 @@ async function glob(folderPath) {
 		const stats = await fs.stat(filePath);
 		if (stats.isFile()) allFiles.push(filePath);
 		else if (stats.isDirectory()) {
-			const subFiles = await glob(filePath);
+			const subFiles = await glob$1(filePath);
 			allFiles.push(...subFiles);
 		}
 	}
@@ -5055,9 +5132,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 */
@@ -5104,7 +5181,7 @@ var Migrator = class {
 				files.push(p);
 				continue;
 			}
-			files.push(...await glob(p));
+			files.push(...await glob$1(p));
 		}
 		return files.filter(Boolean).reduce((result, file) => {
 			result[this.getMigrationName(file)] = file;
@@ -5149,59 +5226,6 @@ var Migrator = class {
 };
 var migrator_default = Migrator;
 
-//#endregion
-//#region src/cli/utils.ts
-const join = path.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.join(packageName, "package.json");
-		const resolved = resolveFrom.silent(cwd ?? process.cwd(), packageJson);
-		if (!resolved) return;
-		return path.join(path.dirname(resolved), parts.join("/"));
-	}
-	static async getMigrationPaths(cwd, migrator, defaultPath, path$1) {
-		if (path$1) return [join(cwd, path$1)];
-		return [...migrator.getPaths(), join(cwd, defaultPath)];
-	}
-	/**
-	* Check if file exists
-	* 
-	* @param path 
-	* @returns 
-	*/
-	static async fileExists(path$1) {
-		try {
-			await access(path$1);
-			return true;
-		} catch {
-			return false;
-		}
-	}
-	static findUpConfig(cwd, name, extensions) {
-		return escalade(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 {
@@ -5213,10 +5237,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);
@@ -5230,10 +5254,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);
@@ -5247,10 +5271,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);
@@ -5265,10 +5289,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);
@@ -5277,10 +5301,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);
@@ -5290,8 +5314,8 @@ var Migrate = class {
 	}
 	/**
 	* Prepares the database for migration
-	* 
-	* @param migrator 
+	*
+	* @param migrator
 	*/
 	async prepareDatabase(migrator) {
 		if (!await migrator.repositoryExists()) {
@@ -5303,11 +5327,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);
@@ -5334,9 +5358,9 @@ var Migrate = class {
 	}
 	/**
 	* Setup the database connection
-	* 
-	* @param config 
-	* @returns 
+	*
+	* @param config
+	* @returns
 	*/
 	async setupConnection(config) {
 		var _config$migrations;
@@ -5368,6 +5392,112 @@ var Migration = class extends Inference {
 };
 var migration_default = Migration;
 
+//#endregion
+//#region src/seeders/seeder.ts
+var Seeder = class {};
+var seeder_default = Seeder;
+
+//#endregion
+//#region src/seeders/runner.ts
+async function glob(folderPath) {
+	const { default: escalade$1 } = await import("escalade");
+	const entries = [];
+	await escalade$1(folderPath, async (dir, names) => {
+		await Promise.all(names.map(async (name) => {
+			const p = path.join(dir, name);
+			try {
+				await access$1(p);
+				if (p.endsWith(".js") || p.endsWith(".ts")) entries.push(p);
+			} catch {}
+		}));
+		return "";
+	});
+	return entries;
+}
+var SeederRunner = class {
+	resolver;
+	connection;
+	paths = [];
+	constructor(resolver) {
+		this.resolver = resolver;
+	}
+	path(p) {
+		this.paths = Array.from(new Set([...this.paths, p]));
+	}
+	getPaths() {
+		return this.paths;
+	}
+	resolveConnection(connection) {
+		var _getInstance, _ref, _instance$connections;
+		const name = connection || this.connection || "default";
+		const instance = ((_getInstance = (_ref = this.resolver).getInstance) === null || _getInstance === void 0 ? void 0 : _getInstance.call(_ref)) ?? null;
+		if (!!!(instance === null || instance === void 0 || (_instance$connections = instance.connections) === null || _instance$connections === void 0 ? void 0 : _instance$connections[name])) this.resolver.autoLoad().catch(() => {
+			/** noop */
+		});
+		return this.resolver.fire(name);
+	}
+	setConnection(connection) {
+		this.connection = connection;
+		return this;
+	}
+	async getSeederFiles(paths) {
+		const files = [];
+		for (const p of paths) {
+			if (p.endsWith(".js") || p.endsWith(".ts")) {
+				files.push(p);
+				continue;
+			}
+			files.push(...await glob(p));
+		}
+		return files;
+	}
+	async resolvePath(filePath) {
+		try {
+			const mod = await import(filePath);
+			return new (mod.default ?? mod.Seeder)();
+		} catch {
+			return null;
+		}
+	}
+	async run(paths, connection) {
+		const files = await this.getSeederFiles(paths);
+		const conn = this.resolveConnection(connection);
+		for (const file of files) {
+			const seeder = await this.resolvePath(file);
+			if (seeder && typeof seeder.run === "function") await seeder.run(conn);
+		}
+	}
+};
+var runner_default = SeederRunner;
+
+//#endregion
+//#region src/seeders/seeder-creator.ts
+var SeederCreator = class {
+	constructor(customStubPath) {
+		this.customStubPath = customStubPath;
+	}
+	async create(dir, name, type = "js") {
+		await mkdir(dir, { recursive: true });
+		const stubPath = this.getStubPath(type);
+		let stub = await readFile(stubPath, "utf-8");
+		stub = stub.replace(/{{ name }}/g, name);
+		const filePath = path.join(dir, `${name}.${type}`);
+		await writeFile(filePath, stub);
+		return filePath;
+	}
+	getStubPath(type) {
+		if (this.customStubPath) return path.join(this.customStubPath, `seeder-${type}.stub`);
+		const __dirname$1 = this.getDirname(import.meta);
+		return path.join(__dirname$1, "stubs", `seeder-${type}.stub`);
+	}
+	getDirname(meta) {
+		if (typeof __dirname !== "undefined") return __dirname;
+		if (meta && meta.url) return dirname(fileURLToPath(meta.url));
+		throw new Error("Unable to determine dirname");
+	}
+};
+var seeder_creator_default = SeederCreator;
+
 //#endregion
 //#region src/pivot.ts
 var pivot_default = Pivot;
@@ -5543,7 +5673,7 @@ const make = (model, data, options = {}) => {
 	return model.make(data);
 };
 const makeCollection = (model, data) => new collection_default(data.map((item) => model.make(item)));
-const makePaginator = (model, data) => new paginator_default(data.data.map((item) => model.make(item)), data.total, data.per_page, data.current_page);
+const makePaginator = (model, data, _) => new paginator_default(data.data.map((item) => model.make(item)), data.total, data.per_page, data.current_page);
 
 //#endregion
-export { attribute_default as Attribute, builder_default as Builder, casts_attributes_default as CastsAttributes, collection_default as Collection, has_unique_ids_default as HasUniqueIds, InvalidArgumentError, Migrate, migration_default as Migration, model_default as Model, ModelNotFoundError, paginator_default as Paginator, pivot_default as Pivot, query_builder_default as QueryBuilder, RelationNotFoundError, scope_default as Scope, soft_deletes_default as SoftDeletes, arquebus_default as arquebus, compose, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };
+export { attribute_default as Attribute, builder_default as Builder, casts_attributes_default as CastsAttributes, collection_default as Collection, has_unique_ids_default as HasUniqueIds, InvalidArgumentError, Migrate, migration_default as Migration, model_default as Model, ModelNotFoundError, paginator_default as Paginator, pivot_default as Pivot, query_builder_default as QueryBuilder, RelationNotFoundError, scope_default as Scope, seeder_default as Seeder, seeder_creator_default as SeederCreator, runner_default as SeederRunner, soft_deletes_default as SoftDeletes, arquebus_default as arquebus, compose, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };