Fixed ts errors,

Added types to with(), .withCount(), .withExists()

Author: StemateF

src/drivers/default/builders/queryBuilder.ts

@@ -1,23 +1,24 @@
-import {HttpMethod} from '../enums/httpMethod';
-import {Model} from '../../../model';
-import {ModelConstructor} from '../../../contracts/modelConstructor';
-import {Scope} from '../scope';
-import {Filter} from '../filter';
-import {FilterOperator} from '../enums/filterOperator';
-import {FilterType} from '../enums/filterType';
-import {Sorter} from '../sorter';
-import {SortDirection} from '../enums/sortDirection';
-import {UrlBuilder} from '../../../builders/urlBuilder';
-import {ExtractModelAttributesType} from '../../../types/extractModelAttributesType';
+import { HttpMethod } from '../enums/httpMethod';
+import { Model } from '../../../model';
+import { ModelConstructor } from '../../../contracts/modelConstructor';
+import { Scope } from '../scope';
+import { Filter } from '../filter';
+import { FilterOperator } from '../enums/filterOperator';
+import { FilterType } from '../enums/filterType';
+import { Sorter } from '../sorter';
+import { SortDirection } from '../enums/sortDirection';
+import { UrlBuilder } from '../../../builders/urlBuilder';
+import { ExtractModelAttributesType } from '../../../types/extractModelAttributesType';
 import {
 	ExtractModelPersistedAttributesType
 } from '../../../types/extractModelPersistedAttributesType';
-import {ExtractModelRelationsType} from '../../../types/extractModelRelationsType';
-import {HttpClient} from '../../../httpClient';
-import {AxiosResponse} from 'axios';
-import {Orion} from '../../../orion';
-import {ExtractModelKeyType} from '../../../types/extractModelKeyType';
+import { ExtractModelRelationsType } from '../../../types/extractModelRelationsType';
+import { HttpClient } from '../../../httpClient';
+import { AxiosResponse } from 'axios';
+import { Orion } from '../../../orion';
+import { ExtractModelKeyType } from '../../../types/extractModelKeyType';
 import { AggregateItem } from '../../../types/AggregateItem';
+import { ModelRelations } from '../../../types/ModelRelations';
 
 export class QueryBuilder<
 	M extends Model,
@@ -31,11 +32,11 @@ export class QueryBuilder<
 	protected modelConstructor: ModelConstructor<M, Attributes, PersistedAttributes, Relations, Key>;
 	protected httpClient: HttpClient;
 
-	protected includes: string[] = [];
+	protected includes: ModelRelations<Relations>[] = [];
 	protected fetchTrashed: boolean = false;
 	protected fetchOnlyTrashed: boolean = false;
-	protected withCountRelations: string[] = [];
-	protected withExistsRelations: string[] = [];
+	protected withCountRelations: ModelRelations<Relations>[] = [];
+	protected withExistsRelations: ModelRelations<Relations>[] = [];
 	protected withAvgRelations: AggregateItem<Relations>[] = [];
 	protected withSumRelations: AggregateItem<Relations>[] = [];
 	protected withMinRelations: AggregateItem<Relations>[] = [];
@@ -64,7 +65,7 @@ export class QueryBuilder<
 		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			'',
 			HttpMethod.GET,
-			this.prepareQueryParams({limit, page})
+			this.prepareQueryParams({ limit, page })
 		);
 
 		return response.data.data.map((attributes: AllAttributes & Relations) => {
@@ -76,12 +77,12 @@ export class QueryBuilder<
 		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			'/search',
 			HttpMethod.POST,
-			this.prepareQueryParams({limit, page}),
+			this.prepareQueryParams({ limit, page }),
 			{
 				scopes: this.scopes,
 				filters: this.filters,
-				search: {value: this.searchValue},
-				sort: this.sorters,
+				search: { value: this.searchValue },
+				sort: this.sorters
 			}
 		);
 
@@ -116,7 +117,7 @@ export class QueryBuilder<
 			resources: items.map(x => x.$attributes)
 		};
 
-		const response = await this.httpClient.request<{data: Array<AllAttributes & Relations> }>(
+		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			`/batch`,
 			HttpMethod.POST,
 			null,
@@ -125,7 +126,7 @@ export class QueryBuilder<
 
 		return response.data.data.map((attributes) => {
 			return this.hydrate(attributes, response);
-		})
+		});
 	}
 
 	public async update(key: Key, attributes: Attributes): Promise<M> {
@@ -145,12 +146,12 @@ export class QueryBuilder<
 		};
 		items.forEach((v) => data.resources[v.$getKey()] = v.$attributes);
 
-		const response = await this.httpClient.request<{ data: Array< AllAttributes & Relations > }>(
+		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			`batch`,
 			HttpMethod.PATCH,
 			null,
 			data
-		)
+		);
 
 		return response.data.data.map((attributes: AllAttributes & Relations) => {
 			return this.hydrate(attributes, response);
@@ -161,22 +162,21 @@ export class QueryBuilder<
 		const response = await this.httpClient.request<{ data: AllAttributes & Relations }>(
 			`/${key}`,
 			HttpMethod.DELETE,
-			this.prepareQueryParams({force})
+			this.prepareQueryParams({ force })
 		);
 
 		return this.hydrate(response.data.data, response);
 	}
 
-	public async batchDelete(items: Key[]): Promise<M[]>
-	{
+	public async batchDelete(items: Key[]): Promise<M[]> {
 		if (!items.length)
 			return [];
 
 		const data = {
 			resources: items
 		};
 
-		const response = await this.httpClient.request<{ data: Array< AllAttributes & Relations > }>(
+		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			`/batch`,
 			HttpMethod.DELETE,
 			null,
@@ -203,7 +203,7 @@ export class QueryBuilder<
 			resources: items
 		};
 
-		const response = await this.httpClient.request<{ data: Array< AllAttributes & Relations > }>(
+		const response = await this.httpClient.request<{ data: Array<AllAttributes & Relations> }>(
 			`/batch/restore`,
 			HttpMethod.POST,
 			null,
@@ -216,7 +216,7 @@ export class QueryBuilder<
 	}
 
 
-	public with(relations: string[]): this {
+	public with(relations: ModelRelations<Relations>[]): this {
 		this.includes = relations;
 
 		return this;
@@ -261,7 +261,7 @@ export class QueryBuilder<
 	public hydrate(raw: AllAttributes & Relations, response?: AxiosResponse): M {
 		const model = new this.modelConstructor();
 
-		for (const field of Object.keys(raw)) {
+		for (const field of Object.keys(raw as Record<string, unknown>)) {
 			const rawValue = raw[field];
 
 			if (typeof model[field] === 'function') {
@@ -293,14 +293,14 @@ export class QueryBuilder<
 	 * The relations need to be whitelisted in the controller.
 	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
 	 */
-	public withCount(relations: string[] | string): this {
+	public withCount(relations: ModelRelations<Relations>[] | ModelRelations<Relations>): this {
 		if (!Array.isArray(relations)) {
 			relations = [relations];
 		}
 
 		this.withCountRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	/**
@@ -309,14 +309,14 @@ export class QueryBuilder<
 	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
 	 * @param relations
 	 */
-	public withExists(relations: string[] | string): this {
+	public withExists(relations: ModelRelations<Relations>[] | ModelRelations<Relations>): this {
 		if (!Array.isArray(relations)) {
 			relations = [relations];
 		}
 
 		this.withExistsRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	/**
@@ -332,7 +332,7 @@ export class QueryBuilder<
 
 		this.withAvgRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	/**
@@ -348,7 +348,7 @@ export class QueryBuilder<
 
 		this.withSumRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	/**
@@ -364,7 +364,7 @@ export class QueryBuilder<
 
 		this.withMinRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	/**
@@ -380,7 +380,7 @@ export class QueryBuilder<
 
 		this.withMaxRelations.push(...relations);
 
-		return this
+		return this;
 	}
 
 	public getHttpClient(): HttpClient {
@@ -422,6 +422,7 @@ export class QueryBuilder<
 
 		if (this.withMinRelations.length > 0) {
 			operationParams.with_min = this.withMinRelations.map((item) => {
+				item.relation;
 				return `${item.relation}.${item.column}`;
 			}).join(',');
 		}

src/types/AggregateItem.ts

@@ -1,4 +1,6 @@
+import { ModelRelations } from './ModelRelations';
+
 export type AggregateItem<Relations> = {
-	relation: keyof Relations;
+	relation: string & ModelRelations<Relations>;
 	column: string;
 }

src/types/ModelRelations.ts

@@ -0,0 +1,9 @@
+import { ExtractModelRelationsType } from './extractModelRelationsType';
+
+export type DirectModelRelations<Relations> = string & (keyof Relations)
+export type ChildModelRelations<Relations> = `${DirectModelRelations<Relations>}.${DirectModelRelations<ExtractModelRelationsType<Relations[keyof Relations]>>}`
+
+
+export type ModelRelations<Relations> =
+	DirectModelRelations<Relations>
+	| ChildModelRelations<Relations>

tests/integration/drivers/default/builders/queryBuilder.test.ts

@@ -59,12 +59,12 @@ describe('QueryBuilder tests', () => {
 
 	test('retrieving a paginated list resources with included relations', async () => {
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		await queryBuilder.with(['user', 'profile']).get();
+		await queryBuilder.with(['user']).get();
 		const requests = server.pretender.handledRequests;
 		expect(requests[0].queryParams).toStrictEqual({
 			limit: '15',
 			page: '1',
-			include: 'user,profile'
+			include: 'user'
 		});
 	});
 
@@ -158,13 +158,13 @@ describe('QueryBuilder tests', () => {
 
 	test('searching for resources with included relations', async () => {
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		await queryBuilder.with(['user', 'profile']).search();
+		await queryBuilder.with(['user']).search();
 
 		const requests = server.pretender.handledRequests;
 		expect(requests[0].queryParams).toStrictEqual({
 			limit: '15',
 			page: '1',
-			include: 'user,profile'
+			include: 'user'
 		});
 	});
 
@@ -181,7 +181,7 @@ describe('QueryBuilder tests', () => {
 
 	test('storing a resource and getting its relations', async () => {
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		const post = await queryBuilder.with(['user', 'profile']).store({
+		const post = await queryBuilder.with(['user']).store({
 			title: 'Test Post'
 		});
 
@@ -190,7 +190,7 @@ describe('QueryBuilder tests', () => {
 		expect(server.schema.posts.find('1').attrs.title).toBe('Test Post');
 
 		const requests = server.pretender.handledRequests;
-		expect(requests[0].queryParams).toStrictEqual({ include: 'user,profile' });
+		expect(requests[0].queryParams).toStrictEqual({ include: 'user' });
 	});
 
 	test('retrieving a resource', async () => {
@@ -217,13 +217,13 @@ describe('QueryBuilder tests', () => {
 		server.schema.posts.create({ title: 'Test Post' });
 
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		const post = await queryBuilder.with(['user', 'profile']).find('1');
+		const post = await queryBuilder.with(['user']).find('1');
 
 		expect(post).toBeInstanceOf(Post);
 		expect(post.$attributes).toStrictEqual({ id: '1', title: 'Test Post' });
 
 		const requests = server.pretender.handledRequests;
-		expect(requests[0].queryParams).toStrictEqual({ include: 'user,profile' });
+		expect(requests[0].queryParams).toStrictEqual({ include: 'user' });
 	});
 
 	test('updating a resource', async () => {
@@ -243,7 +243,7 @@ describe('QueryBuilder tests', () => {
 		server.schema.posts.create({ title: 'Test Post' });
 
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		const post = await queryBuilder.with(['user', 'profile']).update('1', {
+		const post = await queryBuilder.with(['user']).update('1', {
 			title: 'Updated Post'
 		});
 
@@ -252,7 +252,7 @@ describe('QueryBuilder tests', () => {
 		expect(server.schema.posts.find('1').attrs.title).toBe('Updated Post');
 
 		const requests = server.pretender.handledRequests;
-		expect(requests[0].queryParams).toStrictEqual({ include: 'user,profile' });
+		expect(requests[0].queryParams).toStrictEqual({ include: 'user' });
 	});
 
 	test('updating a soft deleted resource', async () => {
@@ -290,7 +290,7 @@ describe('QueryBuilder tests', () => {
 		server.schema.posts.create({ title: 'Test Post' });
 
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		const post = await queryBuilder.with(['user', 'profile']).destroy('1');
+		const post = await queryBuilder.with(['user']).destroy('1');
 
 		expect(post).toBeInstanceOf(Post);
 		expect(post.$attributes).toStrictEqual({
@@ -301,7 +301,7 @@ describe('QueryBuilder tests', () => {
 		expect(server.schema.posts.find('1').attrs.deleted_at).toBeDefined();
 
 		const requests = server.pretender.handledRequests;
-		expect(requests[0].queryParams).toStrictEqual({ force: 'false', include: 'user,profile' });
+		expect(requests[0].queryParams).toStrictEqual({ force: 'false', include: 'user' });
 	});
 
 	test('restoring a resource', async () => {
@@ -319,14 +319,14 @@ describe('QueryBuilder tests', () => {
 		server.schema.posts.create({ title: 'Test Post', deleted_at: Date.now() });
 
 		const queryBuilder = new QueryBuilder<Post, PostAttributes>(Post);
-		const post = await queryBuilder.with(['user', 'profile']).restore('1');
+		const post = await queryBuilder.with(['user']).restore('1');
 
 		expect(post).toBeInstanceOf(Post);
 		expect(post.$attributes).toStrictEqual({ id: '1', title: 'Test Post', deleted_at: null });
 		expect(server.schema.posts.find('1').attrs.deleted_at).toBeNull();
 
 		const requests = server.pretender.handledRequests;
-		expect(requests[0].queryParams).toStrictEqual({ include: 'user,profile' });
+		expect(requests[0].queryParams).toStrictEqual({ include: 'user' });
 	});
 
 	test('force deleting a resource', async () => {

tests/integration/orion.test.ts

@@ -29,7 +29,8 @@ describe('Orion tests', () => {
 			await Orion.csrf();
 			expect(false).toBeTruthy();
 		} catch (error) {
-			expect(error.message).toBe(
+
+			expect((error as Error).message).toBe(
 				`Current auth driver is set to "${AuthDriver.Passport}". Fetching CSRF cookie can only be used with "sanctum" driver.`
 			);
 		}