github/directus
1
1
Fork 0
mirror of https://github.com/directus/directus.git synced 2026-04-03 03:00:39 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve type definitions for o2m item queries involving deep, filter or sort (#13214)

Browse Source 
* DeepQueryMany takes type from property by key

* filter, sort & deep resolve (ID|T)[] arrays to T

* Simplified Sort definition to use SingleItem alias
This commit is contained in:
Will Foxall
2022-05-10 21:11:33 +01:00
committed by GitHub
parent 25dea417b3
commit 46df8dc844
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
packages/sdk/src/items.ts
View File

@@ -32,7 +32,7 @@ export enum Meta {
export type QueryOne<T> = {
fields?: keyof T | (keyof T)[] | '*' | '*.*' | '*.*.*' | string | string[];
search?: string;
deep?: Record<string, DeepQueryMany<T>>;
deep?: Deep<T>;
export?: 'json' | 'csv' | 'xml';
filter?: Filter<T>;
};
@@ -48,15 +48,17 @@ export type QueryMany<T> = QueryOne<T> & {
alias?: Record<string, string>;
};
export type Deep<T> = { [K in keyof SingleItem<T>]?: DeepQueryMany<SingleItem<T>[K]> };
export type DeepQueryMany<T> = {
[K in keyof QueryMany<T> as `_${string & K}`]: QueryMany<T>[K];
[K in keyof QueryMany<SingleItem<T>> as `_${string & K}`]: QueryMany<SingleItem<T>>[K];
};
export type Aggregate = {
[K in keyof SharedAggregate]: string;
};
export type Sort<T> = (`${Extract<keyof T, string>}` | `-${Extract<keyof T, string>}`)[];
export type Sort<T> = (`${Extract<keyof SingleItem<T>, string>}` | `-${Extract<keyof SingleItem<T>, string>}`)[];
export type FilterOperators<T> = {
_eq?: T;
@@ -90,15 +92,18 @@ export type LogicalFilterOr<T> = { _or: Filter<T>[] };
export type LogicalFilter<T> = LogicalFilterAnd<T> | LogicalFilterOr<T>;
export type FieldFilter<T> = {
[K in keyof T]?: FilterOperators<T[K]> | FieldFilter<T[K]>;
[K in keyof SingleItem<T>]?: FilterOperators<SingleItem<T>[K]> | FieldFilter<SingleItem<T>[K]>;
};
export type Filter<T> = LogicalFilter<T> | FieldFilter<T extends Array<unknown> ? T[number] : T>;
export type Filter<T> = LogicalFilter<T> | FieldFilter<T>;
export type ItemsOptions = {
requestOptions: TransportRequestOptions;
};
type SingleItem<T> = Exclude<Single<T>, ID>;
type Single<T> = T extends Array<unknown> ? T[number] : T;
/**
* CRUD at its finest
*/