@wxn0brp/vql 0.4.2 → 0.4.3

package/dist/vql.d.ts

@@ -0,0 +1,323 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface Data {
+	[key: string]: any;
+}
+export interface VContext {
+	[key: string]: any;
+}
+export type KeysMatching<T, V, C = V> = {
+	[K in keyof T]-?: T[K] extends C ? K : never;
+}[keyof T];
+export type PartialOfType<T, V, C = V> = Partial<Record<KeysMatching<T, V, C>, V>>;
+export type PartialPickMatching<T, V, C = V> = Partial<Pick<T, KeysMatching<T, V, C>>>;
+/** Logical Operators */
+export type LogicalOperators<T = any> = {
+	/**
+	 * Recursively applies multiple conditions, all of which must evaluate to true.
+	 * Can include other operators such as $gt, $exists, or nested $and/$or conditions.
+	 */
+	$and?: Array<SearchOptions<T>>;
+	/**
+	 * Recursively applies multiple conditions, at least one of which must evaluate to true.
+	 * Can include other operators such as $lt, $type, or nested $and/$or conditions.
+	 */
+	$or?: Array<SearchOptions<T>>;
+	/**
+	 * Negates a single condition.
+	 * Can include any other operator as its value.
+	 */
+	$not?: SearchOptions<T>;
+};
+/** Comparison Operators */
+export type ComparisonOperators<T = any> = {
+	$gt?: PartialOfType<T, number>;
+	$lt?: PartialOfType<T, number>;
+	$gte?: PartialOfType<T, number>;
+	$lte?: PartialOfType<T, number>;
+	$between?: PartialOfType<T, [
+		number,
+		number
+	], number>;
+	$in?: Partial<Record<keyof T, T[keyof T][]>>;
+	$nin?: Partial<Record<keyof T, T[keyof T][]>>;
+};
+/** Type and Existence Operators */
+export type TypeAndExistenceOperators<T = any> = {
+	$exists?: PartialOfType<T, boolean, any>;
+	$type?: PartialOfType<T, string>;
+};
+/** Array Operators */
+export type ArrayOperators<T = any> = {
+	$arrinc?: PartialPickMatching<T, any[]>;
+	$arrincall?: PartialPickMatching<T, any[]>;
+	$size?: PartialOfType<T, number>;
+};
+/** String Operators */
+export type StringOperators<T = any> = {
+	$regex?: PartialOfType<T, RegExp, string>;
+	$startsWith?: PartialOfType<T, string>;
+	$endsWith?: PartialOfType<T, string>;
+};
+/** Other Operators */
+export type OtherOperators<T = any> = {
+	$subset?: Partial<Record<keyof T, T[keyof T]>>;
+};
+/** Predefined Search Operators */
+export type PredefinedSearchOperators<T = any> = LogicalOperators<T> & ComparisonOperators<T> & TypeAndExistenceOperators<T> & ArrayOperators<T> & StringOperators<T> & OtherOperators<T>;
+/**
+ * SearchOptions can be either a function or an object with predefined operators.
+ */
+export type SearchOptions<T = any> = PredefinedSearchOperators<T> & Arg<T>;
+/** Arrays */
+export type ArrayUpdater<T = any> = {
+	$push?: PartialOfType<T, any>;
+	/** Pushes items into an array and removes duplicates */
+	$pushset?: PartialOfType<T, any>;
+	$pull?: PartialOfType<T, any>;
+	$pullall?: PartialOfType<T, any>;
+};
+/** Objects */
+export type ObjectUpdater<T = any> = {
+	$merge?: PartialOfType<T, any[]>;
+};
+/** Values */
+export type ValueUpdater<T = any> = {
+	$inc?: PartialOfType<T, number>;
+	$dec?: PartialOfType<T, number>;
+	$unset?: PartialOfType<T, any>;
+	$rename?: PartialOfType<T, any>;
+};
+export type UpdaterArg<T = any> = ArrayUpdater<T> & ObjectUpdater<T> & ValueUpdater<T> & Arg<T>;
+export type Arg<T = any> = {
+	[K in keyof T]?: any;
+} & Record<string, any>;
+export type SearchFunc<T = any> = (data: T, context: VContext) => boolean;
+export type UpdaterFunc<T = any> = (data: T, context: VContext) => boolean;
+export type Search<T = any> = SearchOptions<T> | SearchFunc<T>;
+export type Updater<T = any> = UpdaterArg<T> | UpdaterArg<T>[] | UpdaterFunc<T>;
+export interface DbFindOpts<T = any> {
+	reverse?: boolean;
+	max?: number;
+	offset?: number;
+	sortBy?: KeysMatching<T, any>;
+	sortAsc?: boolean;
+}
+export interface FindOpts<T = any> {
+	select?: KeysMatching<T, any>[];
+	exclude?: KeysMatching<T, any>[];
+	transform?: Function;
+}
+declare class CollectionManager {
+	private db;
+	private collection;
+	constructor(db: ValtheraCompatible, collection: string);
+	/**
+	 * Add data to a database.
+	 */
+	add<T = Data>(data: Arg, id_gen?: boolean): Promise<T>;
+	/**
+	 * Find data in a database.
+	 */
+	find<T = Data>(search: Search, context?: VContext, options?: DbFindOpts, findOpts?: FindOpts): Promise<T[]>;
+	/**
+	 * Find one data entry in a database.
+	 */
+	findOne<T = Data>(search: Search, context?: VContext, findOpts?: FindOpts): Promise<T>;
+	/**
+	 * Update data in a database.
+	 */
+	update(search: Search, updater: Updater, context?: VContext): Promise<boolean>;
+	/**
+	 * Update one data entry in a database.
+	 */
+	updateOne(search: Search, updater: Updater, context?: VContext): Promise<boolean>;
+	/**
+	 * Remove data from a database.
+	 */
+	remove(search: Search, context?: VContext): Promise<boolean>;
+	/**
+	 * Remove one data entry from a database.
+	 */
+	removeOne(search: Search, context?: VContext): Promise<boolean>;
+	/**
+	 * Asynchronously updates one entry in a database or adds a new one if it doesn't exist.
+	 */
+	updateOneOrAdd(search: Search, updater: Updater, add_arg?: Arg, context?: VContext, id_gen?: boolean): Promise<boolean>;
+}
+export interface ValtheraCompatible {
+	c(collection: string): CollectionManager;
+	getCollections(): Promise<string[]>;
+	checkCollection(collection: string): Promise<boolean>;
+	issetCollection(collection: string): Promise<boolean>;
+	add<T = Data>(collection: string, data: Arg<T>, id_gen?: boolean): Promise<T>;
+	find<T = Data>(collection: string, search: Search<T>, context?: VContext, options?: DbFindOpts<T>, findOpts?: FindOpts<T>): Promise<T[]>;
+	findOne<T = Data>(collection: string, search: Search<T>, context?: VContext, findOpts?: FindOpts<T>): Promise<T | null>;
+	update<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: VContext): Promise<boolean>;
+	updateOne<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, context?: VContext): Promise<boolean>;
+	remove<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
+	removeOne<T = Data>(collection: string, search: Search<T>, context?: VContext): Promise<boolean>;
+	removeCollection(collection: string): Promise<boolean>;
+	updateOneOrAdd<T = Data>(collection: string, search: Search<T>, updater: Updater<T>, add_arg?: Arg<T>, context?: VContext, id_gen?: boolean): Promise<boolean>;
+}
+declare namespace RelationTypes {
+	type Path = [
+		string,
+		string
+	];
+	type FieldPath = string[];
+	interface DBS {
+		[key: string]: ValtheraCompatible;
+	}
+	interface Relation {
+		[key: string]: RelationConfig;
+	}
+	interface RelationConfig {
+		path: Path;
+		pk?: string;
+		fk?: string;
+		as?: string;
+		select?: string[];
+		findOpts?: DbFindOpts;
+		type?: "1" | "11" | "1n" | "nm";
+		relations?: Relation;
+		through?: {
+			table: string;
+			db?: string;
+			pk: string;
+			fk: string;
+		};
+	}
+}
+export interface VQLQuery<T = any> {
+	find: VQLFind<T>;
+	findOne: VQLFindOne<T>;
+	f: VQLFindOne<T>;
+	add: VQLAdd<T>;
+	update: VQLUpdate<T>;
+	updateOne: VQLUpdateOne<T>;
+	remove: VQLRemove<T>;
+	removeOne: VQLRemoveOne<T>;
+	updateOneOrAdd: VQLUpdateOneOrAdd<T>;
+	removeCollection: VQLCollectionOperation;
+	checkCollection: VQLCollectionOperation;
+	issetCollection: VQLCollectionOperation;
+	getCollections: {};
+}
+export type VQLQueryData<T = any> = {
+	find: VQLFind<T>;
+} | {
+	findOne: VQLFindOne<T>;
+} | {
+	f: VQLFindOne<T>;
+} | {
+	add: VQLAdd<T>;
+} | {
+	update: VQLUpdate<T>;
+} | {
+	updateOne: VQLUpdateOne<T>;
+} | {
+	remove: VQLRemove<T>;
+} | {
+	removeOne: VQLRemoveOne<T>;
+} | {
+	updateOneOrAdd: VQLUpdateOneOrAdd<T>;
+} | {
+	removeCollection: VQLCollectionOperation;
+} | {
+	checkCollection: VQLCollectionOperation;
+} | {
+	issetCollection: VQLCollectionOperation;
+} | {
+	getCollections: {};
+};
+export interface VQLRequest<T = any> {
+	db: string;
+	d: VQLQueryData<T>;
+}
+export interface VQLFind<T = any> {
+	collection: string;
+	search?: Search<T>;
+	limit?: number;
+	fields?: VQLFields;
+	select?: VQLFields;
+	relations?: VQLRelations;
+	options?: DbFindOpts<T>;
+	searchOpts?: FindOpts<T>;
+}
+export interface VQLFindOne<T = any> {
+	collection: string;
+	search: Search<T>;
+	fields?: VQLFields;
+	select?: VQLFields;
+	relations?: VQLRelations;
+	searchOpts?: FindOpts<T>;
+}
+export interface VQLAdd<T = any> {
+	collection: string;
+	data: Arg<T>;
+	id_gen?: boolean;
+}
+export interface VQLUpdate<T = any> {
+	collection: string;
+	search: Search<T>;
+	updater: UpdaterArg<T>;
+}
+export interface VQLUpdateOne<T = any> {
+	collection: string;
+	search: Search<T>;
+	updater: UpdaterArg<T>;
+}
+export interface VQLRemove<T = any> {
+	collection: string;
+	search: Search<T>;
+}
+export interface VQLRemoveOne<T = any> {
+	collection: string;
+	search: Search<T>;
+}
+export interface VQLUpdateOneOrAdd<T = any> {
+	collection: string;
+	search: Search<T>;
+	updater: UpdaterArg<T>;
+	add_arg?: Arg<T>;
+	id_gen?: boolean;
+}
+export interface VQLCollectionOperation {
+	collection: string;
+}
+export type VQLFields = Record<string, boolean | number> | string[];
+export type VQLRelations = Record<string, VQLFind | VQLFindOne>;
+export interface RelationQuery {
+	r: {
+		path: RelationTypes.Path;
+		search: Search;
+		relations: RelationTypes.Relation;
+		many?: boolean;
+		options?: DbFindOpts;
+		select?: RelationTypes.FieldPath[];
+	};
+}
+export interface VQLRef {
+	ref?: string;
+	var?: {
+		[k: string]: any;
+	};
+}
+export type VQLRefRequired = VQLRef & Required<Pick<VQLRef, "ref">>;
+export type DeepPartial<T> = {
+	[P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export type VQL<T = any> = (VQLRequest<T> | RelationQuery) & VQLRef;
+export type VQLR<T = any> = VQL<T> | (DeepPartial<VQL<T>> & VQLRefRequired) | VQLRefRequired;
+export interface VQLError {
+	err: true;
+	msg: string;
+	c: number;
+	why?: string;
+}
+export type VqlQueryRaw<T = any> = VQLR<T> | string | {
+	query: string;
+} & VQLRef;
+
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wxn0brp/vql",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "main": "dist/index.js",
   "author": "wxn0brP",
   "license": "MIT",