Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
77 lines
3.4 KiB
Plaintext
77 lines
3.4 KiB
Plaintext
import { IfAny, UnpackList } from "./utils.js";
|
|
import { ItemType } from "./schema.js";
|
|
import { HasNestedFields, QueryFields } from "./fields.js";
|
|
import { QueryDeep } from "./deep.js";
|
|
import { QueryFilter } from "./filters.js";
|
|
import { AggregationTypes, GroupByFields } from "./aggregate.js";
|
|
|
|
//#region src/types/query.d.ts
|
|
|
|
/**
|
|
* All query options available
|
|
*/
|
|
interface Query<Schema, Item> {
|
|
readonly fields?: IfAny<Schema, (string | Record<string, any>)[], QueryFields<Schema, Item>> | undefined;
|
|
filter?: IfAny<Schema, Record<string, any>, QueryFilter<Schema, Item>> | undefined;
|
|
search?: string | undefined;
|
|
sort?: IfAny<Schema, string | string[], QuerySort<Schema, Item> | QuerySort<Schema, Item>[]> | undefined;
|
|
limit?: number | undefined;
|
|
offset?: number | undefined;
|
|
page?: number | undefined;
|
|
deep?: IfAny<Schema, Record<string, any>, QueryDeep<Schema, Item>> | undefined;
|
|
backlink?: boolean | undefined;
|
|
readonly alias?: IfAny<Schema, Record<string, string>, QueryAlias<Schema, Item>> | undefined;
|
|
}
|
|
/**
|
|
* All query options with an additional version query option for readItem and readSingleton
|
|
*/
|
|
interface QueryItem<Schema, Item> extends Query<Schema, Item> {
|
|
readonly version?: string | undefined;
|
|
readonly versionRaw?: boolean | undefined;
|
|
}
|
|
/**
|
|
* All query options with additional aggregate, version, and custom property options
|
|
*/
|
|
type ExtendedQuery<Schema, Item> = Query<Schema, Item> & {
|
|
aggregate?: Partial<Record<keyof AggregationTypes, string>>;
|
|
groupBy?: (string | GroupByFields<Schema, Item>)[];
|
|
version?: string | undefined;
|
|
versionRaw?: boolean | undefined;
|
|
} & Record<string, unknown>;
|
|
/**
|
|
* All query options with an additional concurrentIndexCreation query option for updating fields with indexes
|
|
*/
|
|
interface FieldQuery<Schema, Item> extends Query<Schema, Item> {
|
|
readonly concurrentIndexCreation?: boolean;
|
|
}
|
|
/**
|
|
* Returns Item types that are available in the root Schema
|
|
*/
|
|
type ExtractItem<Schema, Item> = Extract<UnpackList<Item>, ItemType<Schema>>;
|
|
/**
|
|
* Returns the relation type from the current item by key
|
|
*/
|
|
type ExtractRelation<Schema, Item extends object, Key$1> = Key$1 extends keyof Item ? ExtractItem<Schema, Item[Key$1]> : never;
|
|
/**
|
|
* Merge union of optional objects
|
|
*/
|
|
type MergeRelationalFields<FieldList> = Exclude<UnpackList<FieldList>, string> extends infer RelatedFields ? { [Key in RelatedFields extends any ? keyof RelatedFields : never]-?: Exclude<RelatedFields[Key], undefined> } : never;
|
|
/**
|
|
* Merge separate relational objects together
|
|
*/
|
|
type MergeFields<FieldList> = HasNestedFields<FieldList> extends never ? Extract<UnpackList<FieldList>, string> : Extract<UnpackList<FieldList>, string> | MergeRelationalFields<FieldList>;
|
|
/**
|
|
* Query sort
|
|
* TODO expand to relational sorting (same object notation as fields i guess)
|
|
*/
|
|
type QuerySort<_Schema, Item> = UnpackList<Item> extends infer FlatItem ? { [Field in keyof FlatItem]: Field | `-${Field & string}` }[keyof FlatItem] : never;
|
|
type MergeObjects<A, B> = object extends A ? (object extends B ? A & B : A) : object extends B ? B : never;
|
|
/**
|
|
* Alias object
|
|
*
|
|
* TODO somehow include these aliases in the Field Types!!
|
|
*/
|
|
type QueryAlias<_Schema, Item> = Record<string, keyof Item>;
|
|
//#endregion
|
|
export { ExtendedQuery, ExtractItem, ExtractRelation, FieldQuery, MergeFields, MergeObjects, MergeRelationalFields, Query, QueryAlias, QueryItem, QuerySort };
|
|
//# sourceMappingURL=query.d.ts.map |