@h3ravel/arquebus 0.4.1 → 0.5.0

package/dist/migrations/index.js

@@ -1,5 +1,5 @@
 import { __export } from "./chunk-PECeCxCb.js";
-import { Logger, TaskManager } from "@h3ravel/shared";
+import { FileSystem, Logger, TaskManager } from "@h3ravel/shared";
 import { assign, camel, diff, flat, get, isArray, isEmpty, isEqual, isString, omit, pick, set, snake, trim } from "radashi";
 import advancedFormat from "dayjs/plugin/advancedFormat.js";
 import dayjs from "dayjs";
@@ -8,12 +8,11 @@ import Knex$1 from "knex";
 import path from "path";
 import { existsSync } from "fs";
 import pluralize from "pluralize";
-import fs from "node:fs/promises";
+import fs, { copyFile, mkdir, readFile, readdir, writeFile } from "node:fs/promises";
 import { access } from "fs/promises";
 import escalade from "escalade/sync";
 import resolveFrom from "resolve-from";
-import { existsSync as existsSync$1, readFileSync } from "node:fs";
-import { dirname } from "node:path";
+import path$1, { dirname } from "node:path";
 import { fileURLToPath } from "node:url";
 
 //#region src/migrations/migration-repository.ts
@@ -2338,8 +2337,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);
 	}
@@ -2378,7 +2377,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() + ".*"];
@@ -2656,9 +2655,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();
@@ -2680,6 +2676,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 = {}) {
@@ -2768,8 +2765,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",
@@ -2832,7 +2831,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();
 				};
@@ -2889,7 +2888,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) {
@@ -3128,14 +3127,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 = {};
@@ -3145,6 +3145,7 @@ var Model = class Model extends BaseModel {
 	eagerLoad = {};
 	exists = false;
 	with = [];
+	name;
 	trx = null;
 	constructor(attributes = {}) {
 		super();
@@ -3916,8 +3917,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);
 	}
@@ -4093,7 +4094,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",
@@ -4156,7 +4159,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();
 			};
@@ -5153,8 +5156,8 @@ var Utils = class {
 		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)];
+	static async getMigrationPaths(cwd, migrator, defaultPath, path$2) {
+		if (path$2) return [join(cwd, path$2)];
 		return [...migrator.getPaths(), join(cwd, defaultPath)];
 	}
 	/**
@@ -5163,9 +5166,9 @@ var Utils = class {
 	* @param path 
 	* @returns 
 	*/
-	static async fileExists(path$1) {
+	static async fileExists(path$2) {
 		try {
-			await access(path$1);
+			await access(path$2);
 			return true;
 		} catch {
 			return false;
@@ -5336,6 +5339,12 @@ var Migrate = class {
 	}
 };
 
+//#endregion
+//#region node_modules/.pnpm/tsdown@0.15.4_typescript@5.9.2/node_modules/tsdown/esm-shims.js
+const getFilename = () => fileURLToPath(import.meta.url);
+const getDirname = () => path$1.dirname(getFilename());
+const __dirname = /* @__PURE__ */ getDirname();
+
 //#endregion
 //#region src/migrations/migration-creator.ts
 var MigrationCreator = class {
@@ -5354,10 +5363,10 @@ var MigrationCreator = class {
 	* @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.dirname(filePath));
-		await fs.writeFile(filePath, this.populateStub(stub, table));
+		await writeFile(filePath, this.populateStub(stub, table));
 		await this.firePostCreateHooks(table, filePath);
 		return filePath;
 	}
@@ -5368,29 +5377,29 @@ var MigrationCreator = class {
 	* @param callback 
 	*/
 	async publish(dir, callback) {
-		const migrationFiles = await fs.readdir(this.customStubPath ?? "");
+		const migrationFiles = await readdir(this.customStubPath ?? "");
 		await this.ensureDirectoryExists(dir);
 		for (const migrationFile of migrationFiles) {
 			const sourceFilePath = path.join(this.customStubPath ?? "", migrationFile);
 			const destinationFilePath = path.join(dir, migrationFile);
-			await fs.copyFile(sourceFilePath, destinationFilePath);
+			await 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.join(this.customStubPath ?? "", `migration-${this.type}.stub`);
 			console.log("\n", customPath, "---");
-			stub = existsSync$1(customPath) ? customPath : this.stubPath(`/migration-${this.type}.stub`);
+			stub = await FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration-${this.type}.stub`);
 		} else if (create) {
 			const customPath = path.join(this.customStubPath ?? "", `migration.create-${this.type}.stub`);
-			stub = existsSync$1(customPath) ? customPath : this.stubPath(`/migration.create-${this.type}.stub`);
+			stub = await FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration.create-${this.type}.stub`);
 		} else {
 			const customPath = path.join(this.customStubPath ?? "", `migration.update-${this.type}.stub`);
-			stub = existsSync$1(customPath) ? customPath : this.stubPath(`/migration.update-${this.type}.stub`);
+			stub = await FileSystem.fileExists(customPath) ? customPath : this.stubPath(`/migration.update-${this.type}.stub`);
 		}
-		return readFileSync(stub, "utf-8");
+		return await readFile(stub, "utf-8");
 	}
 	populateStub(stub, table) {
 		if (table !== null) stub = stub.replace(/DummyTable|{{\s*table\s*}}/g, table);
@@ -5410,7 +5419,7 @@ var MigrationCreator = class {
 		this.postCreate.push(callback);
 	}
 	async ensureDirectoryExists(dir) {
-		await fs.mkdir(dir, { recursive: true });
+		await mkdir(dir, { recursive: true });
 	}
 	stubPath(stub = "") {
 		const __dirname$1 = this.getDirname(import.meta);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@h3ravel/arquebus",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "description": "Arquebus ORM is a Beautiful, expressive ORM inspired by Laravel's Eloquent, designed for TypeScript applications and for the H3ravel Framework.",
   "homepage": "https://h3ravel.toneflix.net/arquebus",
   "bin": {
@@ -123,7 +123,7 @@
     ]
   },
   "dependencies": {
-    "@h3ravel/shared": "^0.18.1",
+    "@h3ravel/shared": "^0.20.1",
     "chalk": "^5.6.2",
     "collect.js": "^4.36.1",
     "commander": "^14.0.1",
@@ -185,6 +185,6 @@
     "test:postgres": "cross-env DB=postgres vitest --project node",
     "test:sqlite": "cross-env DB=sqlite vitest --project node",
     "test:browser": "vitest --project browser",
-    "release:patch": "pnpm build && git add . && git commit -m \"version: bump version and publish\" && pnpm version patch && pnpm publish --tag latest"
+    "release:patch": "pnpm build && git add . && git commit -m \"version: bump version\" && pnpm version patch && pnpm publish --tag latest"
   }
 }

package/types/builder.ts

@@ -5,25 +5,29 @@ import type BModel from 'src/browser/model'
 import type Builder from 'src/builder'
 import type { IModel } from './modeling'
 import type { IQueryBuilder } from './query-builder'
+import type { Knex } from 'knex'
 import type Model from 'src/model'
+import type { TFunction } from './generics'
 
-// type BaseBuilder<M extends Model, R> = Omit<
-//     IQueryBuilder<M, R>,
-//     'destroy' | 'clone' | 'get' | 'skip' | 'limit' | 'take' | 'offset' | 'chunk' | 'forPage'
-// >
+type BaseBuilder<M extends Model | BModel, R = ICollection<M> | IModel> = Omit<
+    IQueryBuilder<M, R>,
+    'destroy' | 'clone' | 'get' | 'skip' | 'limit' | 'take' | 'offset' | 'chunk' | 'forPage' | 'orWhere' | 'pluck'
+>
 
 export interface IScope {
     apply (builder: Builder<any>, model: Model): void;
 }
 
-
-export interface IBuilder<M extends Model | BModel, R = ICollection<M> | IModel> extends IQueryBuilder<M, R> {
+// @ts-expect-error Errors will come from builder differences but that is fine
+export interface IBuilder<M extends Model | BModel, R = ICollection<M> | IModel> extends BaseBuilder<M, R> {
+    connector: IQueryBuilder<M, R> & Knex.QueryBuilder & { _statements: any[], _single: any } & Knex
     asProxy (): IQueryBuilder<M, R>;
-    // chunk (count: number, callback: (rows: ICollection<M>) => any): Promise<boolean>;
+    chunk (count: number, callback: (rows: ICollection<M>) => any): Promise<boolean>;
     enforceOrderBy (): void;
-    // clone (): IBuilder<M, R>;
-    // forPage (page: number, perPage?: number): this;
-    insert (attributes: any): Promise<any>;
+    idOf (id: string | number): this;
+    clone (): IBuilder<M, R>;
+    forPage (page: number, perPage?: number): this;
+    insert (...attributes: any[]): Promise<any>;
     update (attributes: any): Promise<any>;
     increment (column: string, amount?: number, extra?: any): Promise<any>;
     decrement (column: string, amount?: number, extra?: any): Promise<any>;
@@ -54,6 +58,7 @@ export interface IBuilder<M extends Model | BModel, R = ICollection<M> | IModel>
     doesntHave (relation: string, boolean?: any, callback?: (builder: IBuilder<any>) => void | null): this;
     orDoesntHave (relation: string): this;
     whereHas (relation: string, callback?: (builder: IBuilder<any>) => void | IBuilder<any> | null, operator?: any, count?: number): this;
+    orWhere (...args: any[]): this
     orWhereHas (relation: string, callback?: (builder: IBuilder<any>) => void | IBuilder<any> | null, operator?: any, count?: number): this;
     whereRelation (relation: string, column: string, operator?: any, value?: any): this;
     hasNested (relation: string, operator?: any, count?: number, boolean?: any, callback?: (builder: IBuilder<any>) => void | null): this;
@@ -68,10 +73,10 @@ export interface IBuilder<M extends Model | BModel, R = ICollection<M> | IModel>
     withSum (relation: WithRelationType, column: string): this;
     withExists (relation: WithRelationType): this;
     related (relation: string): this;
-    // take (count: number): this;
-    // skip (count: number): this;
-    // limit (count: number): this;
-    // offset (count: number): this;
+    take (count: number): this;
+    skip (count: number): this;
+    limit (count: number): this;
+    offset (count: number): this;
     first (column?: string | string[]): Promise<M | null | undefined>;
     firstOrFail (column?: string | string[]): Promise<M>;
     findOrFail (key: string | number, columns?: string[]): Promise<M>;
@@ -86,8 +91,8 @@ export interface IBuilder<M extends Model | BModel, R = ICollection<M> | IModel>
     find (key: string | number, columns?: string[]): Promise<M | null | undefined>;
     findMany (keys: string[] | number[] | ICollection<any>, columns?: string[]): Promise<ICollection<M>>;
     pluck<X extends Model = any | M> (column: string): Promise<ICollection<X>>;
-    // destroy (ids: string | number | string[] | number[] | ICollection<any>): Promise<number>;
-    // get (columns?: string[]): Promise<ICollection<M>>;
+    destroy (ids?: string | number | string[] | number[] | TFunction | ICollection<any>): Promise<number>;
+    get (columns?: string[]): Promise<ICollection<M>>;
     all (columns?: string[]): Promise<ICollection<M>>;
     paginate<F extends IPaginatorParams> (page?: number, perPage?: number): Promise<IPaginator<M, F>>;
     [value: string]: any;

package/types/generics.ts

@@ -47,6 +47,7 @@ export type RelationNames<T> = FunctionPropertyNames<T> extends infer R
     : never;
 
 export type MixinConstructor<T = TGeneric> = new (...args: any[]) => T
+export type AbstractConstructor<T = TGeneric> = abstract new (...args: any[]) => T;
 
 // Helper type: combine all mixin instance types into a single intersection
 export type MixinReturn<Base extends MixinConstructor, Mixins extends ((base: any) => any)[]> =

package/types/modeling.ts

@@ -68,15 +68,15 @@ export interface IModel {
     attributes: any
     relations: any
     exists: boolean
-    primaryKey: string
-    builder?: IBuilder<any, any> | null
-    table: string | null
+    // primaryKey: string
+    // builder?: IBuilder<any, any> | null
+    // table: string | null
     connection?: TBaseConfig['client'] | null
-    keyType: string
-    incrementing: boolean
+    // keyType: string
+    // incrementing: boolean
     perPage: number
     with: string | string[] | TGeneric<(...args: any[]) => IBuilder<Model>>
-    withCount: string[]
+    // withCount: string[]
     trx: AnyQueryBuilder | null
     timestamps: boolean
     dateFormat: string
@@ -111,7 +111,7 @@ export interface IModel {
     setConnection (connection: TBaseConfig['client'] | null): this;
     usesUniqueIds (): boolean;
     uniqueIds (): string[];
-    newUniqueId (): string;
+    // newUniqueId (): string;
     setUniqueIds (): void;
     getKeyType (): string;
     getIncrementing (): boolean;

package/types/query-builder.ts

@@ -1,10 +1,11 @@
-import type { AnyQueryBuilder, GroupByMethod, JoinMethod, JoinRawMethod, OrderByMethod, OrderByRawMethod, RawInterface, SelectMethod, SetOperationsMethod, UnionMethod, WhereBetweenMethod, WhereColumnMethod, WhereExistsMethod, WhereFieldExpressionMethod, WhereInMethod, WhereJsonExpressionMethod, WhereMethod, WhereNullMethod, WhereRawMethod, WhereWrappedMethod } from './query-methods'
-import type { ICollection, IPaginator, IPaginatorParams } from './utils'
+import type { AddSelectMethod, AnyQueryBuilder, FirstOrFailMethod, ForceDeleteMethod, GroupByMethod, JoinMethod, JoinRawMethod, OrderByMethod, OrderByRawMethod, RawInterface, RestoreMethod, ReturningMethod, SelectMethod, SetOperationsMethod, UnionMethod, WhereBetweenMethod, WhereColumnMethod, WhereExistsMethod, WhereFieldExpressionMethod, WhereInMethod, WhereJsonExpressionMethod, WhereMethod, WhereNullMethod, WhereRawMethod, WhereWrappedMethod } from './query-methods'
+import type { IPaginator, IPaginatorParams } from './utils'
 import type { TFunction, TGeneric } from './generics'
 
 import type BModel from 'src/browser/model'
 import type { Column } from 'src/inspector/types/column'
 import type { ForeignKey } from 'src/inspector/types/foreign-key'
+import type { IBuilder } from './builder'
 import type { Knex } from 'knex'
 import type Model from 'src/model'
 import type { Table } from 'src/inspector/types/table'
@@ -64,17 +65,22 @@ export type IConnector<M extends TGeneric = any, R = any> = Knex & Knex.QueryBui
 
 export interface IQueryBuilder<M extends Model | BModel = Model, R = M[] | M> {
     // connector: IQueryBuilder<M, R>
+    query: IBuilder<M, R>
     schema: SchemaBuilder
     _statements: IStatement[],
     table (name: string): IQueryBuilder<M, R>
     select: SelectMethod<this>
+    addSelect: AddSelectMethod<this>
     columns: SelectMethod<this>
     column: SelectMethod<this>
     distinct: SelectMethod<this>
+    returning: ReturningMethod<this>
     distinctOn: SelectMethod<this>
     as: AsMethod<this>
     asProxy (): IQueryBuilder<M, R>
     where: WhereMethod<this>
+    firstOrFail: FirstOrFailMethod<this>
+    forceDelete: ForceDeleteMethod
     andWhere: WhereMethod<this>
     // orWhere: WhereMethod<this>
     orWhere (...args: any[]): this
@@ -94,6 +100,7 @@ export interface IQueryBuilder<M extends Model | BModel = Model, R = M[] | M> {
     whereNotExists: WhereExistsMethod<this>
     orWhereNotExists: WhereExistsMethod<this>
 
+    restore: RestoreMethod
     whereIn: WhereInMethod<this>
     orWhereIn: WhereInMethod<this>
     whereNotIn: WhereInMethod<this>

package/types/query-methods.ts

@@ -114,6 +114,26 @@ export interface WhereJsonExpressionMethod<QB extends AnyQueryBuilder> {
     (fieldExpression: FieldExpression, keys: string | string[]): QB;
 }
 
+export interface ReturningMethod<QB extends AnyQueryBuilder> {
+    (key: FieldExpression | FieldExpression[], options?: { [key: string]: any }): QB;
+}
+
+export interface FirstOrFailMethod<QB extends AnyQueryBuilder> {
+    (): Promise<QB>;
+}
+
+export interface AddSelectMethod<QB extends AnyQueryBuilder> {
+    (params: string[]): QB;
+}
+
+export interface ForceDeleteMethod {
+    (): Promise<boolean | number>;
+}
+
+export interface RestoreMethod {
+    (): Promise<number>;
+}
+
 export interface WhereColumnMethod<QB extends AnyQueryBuilder> {
     (col1: ColumnRef, op: Operator, col2: ColumnRef): QB;
     (col1: ColumnRef, col2: ColumnRef): QB;

package/types/utils.ts

@@ -45,6 +45,7 @@ export interface IPaginatorParams {
     total: number,
     last_page: number,
     count: number,
+    paginated?: boolean
 }
 
 export interface IPaginator<T extends Model | BModel, K extends IPaginatorParams = IPaginatorParams> {