feat: add aggregates operations

Merge pull request #42 from StemateF/main

Author: alexzarbn

src/drivers/default/builders/queryBuilder.ts

@@ -1,22 +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,
@@ -33,6 +35,12 @@ export class QueryBuilder<
 	protected includes: string[] = [];
 	protected fetchTrashed: boolean = false;
 	protected fetchOnlyTrashed: boolean = false;
+	protected withCountRelations: ModelRelations<Relations>[] = [];
+	protected withExistsRelations: ModelRelations<Relations>[] = [];
+	protected withAvgRelations: AggregateItem<Relations>[] = [];
+	protected withSumRelations: AggregateItem<Relations>[] = [];
+	protected withMinRelations: AggregateItem<Relations>[] = [];
+	protected withMaxRelations: AggregateItem<Relations>[] = [];
 
 	protected scopes: Array<Scope> = [];
 	protected filters: Array<Filter> = [];
@@ -57,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) => {
@@ -69,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
 			}
 		);
 
@@ -109,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,
@@ -118,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> {
@@ -138,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);
@@ -154,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,
@@ -196,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,
@@ -209,7 +216,7 @@ export class QueryBuilder<
 	}
 
 
-	public with(relations: string[]): this {
+	public with(relations: ModelRelations<Relations>[]): this {
 		this.includes = relations;
 
 		return this;
@@ -281,6 +288,101 @@ export class QueryBuilder<
 		return model;
 	}
 
+	/**
+	 * Include the count of the specified relations.
+	 * 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: ModelRelations<Relations>[] | ModelRelations<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withCountRelations.push(...relations);
+
+		return this;
+	}
+
+	/**
+	 * Include the exists of the specified relations.
+	 * The relations need to be whitelisted in the controller.
+	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
+	 * @param relations
+	 */
+	public withExists(relations: ModelRelations<Relations>[] | ModelRelations<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withExistsRelations.push(...relations);
+
+		return this;
+	}
+
+	/**
+	 * Include the avg of the specified relations.
+	 * The relations need to be whitelisted in the controller.
+	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
+	 * @param relations
+	 */
+	public withAvg(relations: AggregateItem<Relations>[] | AggregateItem<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withAvgRelations.push(...relations);
+
+		return this;
+	}
+
+	/**
+	 * Include the sum of the specified relations.
+	 * The relations need to be whitelisted in the controller.
+	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
+	 * @param relations
+	 */
+	public withSum(relations: AggregateItem<Relations>[] | AggregateItem<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withSumRelations.push(...relations);
+
+		return this;
+	}
+
+	/**
+	 * Include the min of the specified relations.
+	 * The relations need to be whitelisted in the controller.
+	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
+	 * @param relations
+	 */
+	public withMin(relations: AggregateItem<Relations>[] | AggregateItem<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withMinRelations.push(...relations);
+
+		return this;
+	}
+
+	/**
+	 * Include the max of the specified relations.
+	 * The relations need to be whitelisted in the controller.
+	 * @link https://tailflow.github.io/laravel-orion-docs/v2.x/guide/search.html#aggregates
+	 * @param relations
+	 */
+	public withMax(relations: AggregateItem<Relations>[] | AggregateItem<Relations>): this {
+		if (!Array.isArray(relations)) {
+			relations = [relations];
+		}
+
+		this.withMaxRelations.push(...relations);
+
+		return this;
+	}
+
 	public getHttpClient(): HttpClient {
 		return this.httpClient;
 	}
@@ -298,6 +400,40 @@ export class QueryBuilder<
 			operationParams.include = this.includes.join(',');
 		}
 
+		if (this.withCountRelations.length > 0) {
+			operationParams.with_count = this.withCountRelations.join(',');
+		}
+
+		if (this.withExistsRelations.length > 0) {
+			operationParams.with_exists = this.withExistsRelations.join(',');
+		}
+
+		if (this.withAvgRelations.length > 0) {
+			operationParams.with_avg = this.withAvgRelations.map((item) => {
+				return `${item.relation}.${item.column}`;
+			}).join(',');
+		}
+
+		if (this.withSumRelations.length > 0) {
+			operationParams.with_sum = this.withSumRelations.map((item) => {
+				return `${item.relation}.${item.column}`;
+			}).join(',');
+		}
+
+		if (this.withMinRelations.length > 0) {
+			operationParams.with_min = this.withMinRelations.map((item) => {
+				item.relation;
+				return `${item.relation}.${item.column}`;
+			}).join(',');
+		}
+
+		if (this.withMaxRelations.length > 0) {
+			operationParams.with_max = this.withMaxRelations.map((item) => {
+				return `${item.relation}.${item.column}`;
+			}).join(',');
+		}
+
+
 		return operationParams;
 	}
 }

src/types/AggregateItem.ts

@@ -0,0 +1,6 @@
+import { ModelRelations } from './ModelRelations';
+
+export type AggregateItem<Relations> = {
+	relation: 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>