@uql/core 1.0.10 → 1.0.12

package/README.md

@@ -1,6 +1,4 @@
-# [uql](https://uql.io) · [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rogerpadilla/uql/blob/main/LICENSE) [![tests](https://github.com/rogerpadilla/uql/actions/workflows/tests.yml/badge.svg)](https://github.com/rogerpadilla/uql) [![coverage status](https://coveralls.io/repos/rogerpadilla/uql/badge.svg?branch=main)](https://coveralls.io/r/rogerpadilla/uql?branch=main) [![npm version](https://badge.fury.io/js/%40uql%2Fcore.svg)](https://badge.fury.io/js/%40uql%2Fcore)
-
-Learn more of uql in the website https://uql.io :high_brightness:
+# [uql](https://nukak.org) · [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rogerpadilla/uql/blob/main/LICENSE) [![tests](https://github.com/rogerpadilla/uql/actions/workflows/tests.yml/badge.svg)](https://github.com/rogerpadilla/uql) [![coverage status](https://coveralls.io/repos/rogerpadilla/uql/badge.svg?branch=main)](https://coveralls.io/r/rogerpadilla/uql?branch=main) [![npm version](https://badge.fury.io/js/%40uql%2Fcore.svg)](https://badge.fury.io/js/%40uql%2Fcore)
 
 ## Quick Start
 
@@ -10,13 +8,13 @@ The `uql` queries can be safely written in the frontend (browser/mobile) and sen
 
 ### <a name="features"></a> Features
 
-- `JSON` (serializable) syntax for all the [queries](https://uql.io/docs/querying-logical-operators).
-- uses the power of `TypeScript` to get smart type-safety [everywhere](https://uql.io/docs/api-repository).
-- the generated queries are [performant](https://uql.io/docs/querying-retrieve-relations), safe, and human-readable.
-- `$project`, `$filter`, `$sort`, `$limit` works at [multiple levels](https://uql.io/docs/querying-retrieve-relations) (including deep relations and their fields).
-- [declarative](https://uql.io/docs/transactions-declarative) and [imperative](https://uql.io/docs/transactions-imperative) `transactions`.
-- [soft-delete](https://uql.io/docs/entities-soft-delete), [virtual fields](https://uql.io/docs/entities-virtual-fields), [repositories](https://uql.io/docs/api-repository), `connection pooling`.
-- transparent support for [inheritance](https://uql.io/docs/entities-advanced) between entities.
+- `JSON` (serializable) syntax for all the [queries](https://nukak.org/docs/querying-logical-operators).
+- uses the power of `TypeScript` to get smart type-safety [everywhere](https://nukak.org/docs/api-repository).
+- the generated queries are [performant](https://nukak.org/docs/querying-retrieve-relations), safe, and human-readable.
+- `$project`, `$filter`, `$sort`, `$limit` works at [multiple levels](https://nukak.org/docs/querying-retrieve-relations) (including deep relations and their fields).
+- [declarative](https://nukak.org/docs/transactions-declarative) and [imperative](https://nukak.org/docs/transactions-imperative) `transactions`.
+- [soft-delete](https://nukak.org/docs/entities-soft-delete), [virtual fields](https://nukak.org/docs/entities-virtual-fields), [repositories](https://nukak.org/docs/api-repository), `connection pooling`.
+- transparent support for [inheritance](https://nukak.org/docs/entities-advanced) between entities.
 - supports `Postgres`, `MySQL`, `MariaDB`, `SQLite`, `MongoDB`.
 
 ### <a name="installation"></a> Installation
@@ -176,4 +174,4 @@ await querier.release();
 
 ---
 
-See more in https://uql.io :high_brightness:
+See more in https://nukak.org :high_brightness:

package/entity/decorator/relation.d.ts

@@ -1,6 +1,6 @@
 import { RelationOptions, RelationOneToOneOptions, RelationOneToManyOptions, RelationManyToOneOptions, RelationManyToManyOptions } from '../../type';
 declare function Relation<E>(opts: RelationOptions<E>): (target: object, key: string) => void;
-declare type RelationReturn = ReturnType<typeof Relation>;
+type RelationReturn = ReturnType<typeof Relation>;
 export declare function OneToOne<E>(opts?: RelationOneToOneOptions<E>): RelationReturn;
 export declare function ManyToOne<E>(opts?: RelationManyToOneOptions<E>): RelationReturn;
 export declare function OneToMany<E>(opts: RelationOneToManyOptions<E>): RelationReturn;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@uql/core",
-  "homepage": "https://uql.io",
+  "homepage": "https://nukak.org",
   "description": "flexible and efficient ORM, with declarative JSON syntax and smart type-safety",
   "license": "MIT",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "main": "index.js",
   "types": "./index.d.ts",
   "scripts": {
@@ -18,7 +18,7 @@
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@types/node": "^18.0.3",
+    "@types/node": "^18.0.6",
     "@types/sqlstring": "^2.3.0",
     "@types/uuid": "^8.3.4",
     "copyfiles": "^2.4.1",
@@ -60,4 +60,4 @@
     "access": "public"
   },
   "gitHead": "3ced0c218364ddcd9e234096155ff205a7583b13"
-}
+}

package/type/entity.d.ts

@@ -1,28 +1,28 @@
 import { QueryRaw } from './query';
 import { Scalar, Type } from './utility';
 export declare const idKey: unique symbol;
-export declare type Key<E> = keyof E & string;
-export declare type FieldKey<E> = {
+export type Key<E> = keyof E & string;
+export type FieldKey<E> = {
     readonly [K in keyof E]: E[K] extends Scalar ? K : never;
 }[Key<E>];
-export declare type RelationKey<E> = {
+export type RelationKey<E> = {
     readonly [K in keyof E]: E[K] extends Scalar ? never : K;
 }[Key<E>];
-export declare type FieldValue<E> = E[FieldKey<E>];
-export declare type IdKey<E> = E extends {
+export type FieldValue<E> = E[FieldKey<E>];
+export type IdKey<E> = E extends {
     [idKey]?: infer K;
 } ? K & FieldKey<E> : E extends {
     _id?: unknown;
 } ? '_id' & FieldKey<E> : E extends {
     id?: unknown;
 } ? 'id' & FieldKey<E> : FieldKey<E>;
-export declare type IdValue<E> = E[IdKey<E>];
-export declare type RelationValue<E> = E[RelationKey<E>];
-export declare type EntityOptions = {
+export type IdValue<E> = E[IdKey<E>];
+export type RelationValue<E> = E[RelationKey<E>];
+export type EntityOptions = {
     readonly name?: string;
     readonly softDelete?: boolean;
 };
-export declare type FieldOptions = {
+export type FieldOptions = {
     readonly name?: string;
     readonly isId?: true;
     readonly type?: any;
@@ -32,10 +32,10 @@ export declare type FieldOptions = {
     readonly onUpdate?: OnFieldCallback;
     readonly onDelete?: OnFieldCallback;
 };
-export declare type OnFieldCallback = Scalar | QueryRaw | (() => Scalar | QueryRaw);
-export declare type EntityGetter<E = any> = () => Type<E>;
-export declare type CascadeType = 'persist' | 'delete';
-export declare type RelationOptions<E = any> = {
+export type OnFieldCallback = Scalar | QueryRaw | (() => Scalar | QueryRaw);
+export type EntityGetter<E = any> = () => Type<E>;
+export type CascadeType = 'persist' | 'delete';
+export type RelationOptions<E = any> = {
     entity?: EntityGetter<E>;
     cardinality: RelationCardinality;
     readonly cascade?: boolean | CascadeType;
@@ -43,24 +43,24 @@ export declare type RelationOptions<E = any> = {
     through?: EntityGetter<RelationValue<E>>;
     references?: RelationReferences;
 };
-declare type RelationOptionsOwner<E> = Pick<RelationOptions<E>, 'entity' | 'references' | 'cascade'>;
-declare type RelationOptionsInverseSide<E> = Required<Pick<RelationOptions<E>, 'entity' | 'mappedBy'>> & Pick<RelationOptions<E>, 'cascade'>;
-declare type RelationOptionsThroughOwner<E> = Required<Pick<RelationOptions<E>, 'entity'>> & Pick<RelationOptions<E>, 'through' | 'references' | 'cascade'>;
-export declare type RelationKeyMap<E> = {
+type RelationOptionsOwner<E> = Pick<RelationOptions<E>, 'entity' | 'references' | 'cascade'>;
+type RelationOptionsInverseSide<E> = Required<Pick<RelationOptions<E>, 'entity' | 'mappedBy'>> & Pick<RelationOptions<E>, 'cascade'>;
+type RelationOptionsThroughOwner<E> = Required<Pick<RelationOptions<E>, 'entity'>> & Pick<RelationOptions<E>, 'through' | 'references' | 'cascade'>;
+export type RelationKeyMap<E> = {
     readonly [K in keyof E]: K;
 };
-export declare type RelationKeyMapper<E> = (keyMap: RelationKeyMap<E>) => Key<E>;
-export declare type RelationReferences = {
+export type RelationKeyMapper<E> = (keyMap: RelationKeyMap<E>) => Key<E>;
+export type RelationReferences = {
     readonly local: string;
     readonly foreign: string;
 }[];
-export declare type RelationMappedBy<E> = Key<E> | RelationKeyMapper<E>;
-export declare type RelationCardinality = '11' | 'm1' | '1m' | 'mm';
-export declare type RelationOneToOneOptions<E> = RelationOptionsOwner<E> | RelationOptionsInverseSide<E>;
-export declare type RelationOneToManyOptions<E> = RelationOptionsInverseSide<E> | RelationOptionsThroughOwner<E>;
-export declare type RelationManyToOneOptions<E> = RelationOptionsOwner<E> | RelationOptionsInverseSide<E>;
-export declare type RelationManyToManyOptions<E> = RelationOptionsThroughOwner<E> | RelationOptionsInverseSide<E>;
-export declare type EntityMeta<E> = {
+export type RelationMappedBy<E> = Key<E> | RelationKeyMapper<E>;
+export type RelationCardinality = '11' | 'm1' | '1m' | 'mm';
+export type RelationOneToOneOptions<E> = RelationOptionsOwner<E> | RelationOptionsInverseSide<E>;
+export type RelationOneToManyOptions<E> = RelationOptionsInverseSide<E> | RelationOptionsThroughOwner<E>;
+export type RelationManyToOneOptions<E> = RelationOptionsOwner<E> | RelationOptionsInverseSide<E>;
+export type RelationManyToManyOptions<E> = RelationOptionsThroughOwner<E> | RelationOptionsInverseSide<E>;
+export type EntityMeta<E> = {
     readonly entity: Type<E>;
     name?: string;
     id?: IdKey<E>;

package/type/querier.d.ts

@@ -6,11 +6,11 @@ import { UniversalQuerier } from './universalQuerier';
 /**
  * logger function to debug queries.
  */
-export declare type QuerierLogger = (message: any, ...args: any[]) => any;
+export type QuerierLogger = (message: any, ...args: any[]) => any;
 /**
  * Isolation levels for transactions.
  */
-export declare type IsolationLevel = 'read uncommitted' | 'read committed' | 'repeteable read' | 'serializable';
+export type IsolationLevel = 'read uncommitted' | 'read committed' | 'repeteable read' | 'serializable';
 export interface Querier extends UniversalQuerier {
     count<E>(entity: Type<E>, qm?: QuerySearch<E>): Promise<number>;
     findOneById<E>(entity: Type<E>, id: IdValue<E>, qm?: QueryUnique<E>): Promise<E>;

package/type/querierPool.d.ts

@@ -2,7 +2,7 @@ import { Querier, QuerierLogger } from './querier';
 /**
  * querier pool.
  */
-export declare type QuerierPool<Q extends Querier = Querier> = {
+export type QuerierPool<Q extends Querier = Querier> = {
     /**
      * logger function to print debug messages.
      */

package/type/query.d.ts

@@ -1,6 +1,6 @@
 import { FieldKey, IdValue, Key, RelationKey } from './entity';
 import { BooleanLike, ExpandScalar, Scalar, Type, Unpacked } from './utility';
-export declare type QueryOptions = {
+export type QueryOptions = {
     /**
      * use or omit `softDelete` attribute.
      */
@@ -14,7 +14,7 @@ export declare type QueryOptions = {
      */
     readonly autoPrefix?: boolean;
 };
-export declare type QueryProjectOptions = {
+export type QueryProjectOptions = {
     /**
      * prefix the query with this.
      */
@@ -27,19 +27,19 @@ export declare type QueryProjectOptions = {
 /**
  * query projection as an array.
  */
-export declare type QueryProjectArray<E> = readonly (Key<E> | QueryRaw)[];
+export type QueryProjectArray<E> = readonly (Key<E> | QueryRaw)[];
 /**
  * query projection as a map.
  */
-export declare type QueryProjectMap<E> = QueryProjectFieldMap<E> | QueryProjectRelationMap<E>;
+export type QueryProjectMap<E> = QueryProjectFieldMap<E> | QueryProjectRelationMap<E>;
 /**
  * query projection.
  */
-export declare type QueryProject<E> = QueryProjectArray<E> | QueryProjectMap<E>;
+export type QueryProject<E> = QueryProjectArray<E> | QueryProjectMap<E>;
 /**
  * query projection of fields as a map.
  */
-export declare type QueryProjectFieldMap<E> = {
+export type QueryProjectFieldMap<E> = {
     [K in FieldKey<E>]?: BooleanLike;
 } | {
     [K: string]: QueryRaw;
@@ -47,19 +47,19 @@ export declare type QueryProjectFieldMap<E> = {
 /**
  * query projection of relations as a map.
  */
-export declare type QueryProjectRelationMap<E> = {
+export type QueryProjectRelationMap<E> = {
     [K in RelationKey<E>]?: BooleanLike | readonly Key<Unpacked<E[K]>>[] | QueryProjectRelationOptions<E[K]>;
 };
 /**
  * options to project a relation.
  */
-export declare type QueryProjectRelationOptions<E> = (E extends any[] ? Query<Unpacked<E>> : QueryUnique<Unpacked<E>>) & {
+export type QueryProjectRelationOptions<E> = (E extends any[] ? Query<Unpacked<E>> : QueryUnique<Unpacked<E>>) & {
     readonly $required?: boolean;
 };
 /**
  * options for full-text-search operator.
  */
-export declare type QueryTextSearchOptions<E> = {
+export type QueryTextSearchOptions<E> = {
     /**
      * text to search for.
      */
@@ -72,17 +72,17 @@ export declare type QueryTextSearchOptions<E> = {
 /**
  * value for a logical filtering.
  */
-export declare type QueryFilterLogical<E> = readonly QueryFilter<E>[];
+export type QueryFilterLogical<E> = readonly QueryFilter<E>[];
 /**
  * comparison by fields.
  */
-export declare type QueryFilterFieldMap<E> = {
+export type QueryFilterFieldMap<E> = {
     readonly [K in FieldKey<E>]?: QueryFilterFieldValue<E[K]>;
 };
 /**
  * complex operators.
  */
-export declare type QueryFilterMap<E> = QueryFilterFieldMap<E> & {
+export type QueryFilterMap<E> = QueryFilterFieldMap<E> & {
     /**
      * joins query clauses with a logical `AND`, returns records that match all the clauses.
      */
@@ -112,7 +112,7 @@ export declare type QueryFilterMap<E> = QueryFilterFieldMap<E> & {
      */
     readonly $nexists?: QueryRaw;
 };
-export declare type QueryFilterFieldOperatorMap<T> = {
+export type QueryFilterFieldOperatorMap<T> = {
     /**
      * whether a value is equal to the given value.
      */
@@ -189,57 +189,57 @@ export declare type QueryFilterFieldOperatorMap<T> = {
 /**
  * Value for a field comparison.
  */
-export declare type QueryFilterFieldValue<T> = T | readonly T[] | QueryFilterFieldOperatorMap<T> | QueryRaw;
+export type QueryFilterFieldValue<T> = T | readonly T[] | QueryFilterFieldOperatorMap<T> | QueryRaw;
 /**
  * query filter.
  */
-export declare type QueryFilter<E> = IdValue<E> | readonly IdValue<E>[] | QueryRaw | QueryFilterMap<E>;
+export type QueryFilter<E> = IdValue<E> | readonly IdValue<E>[] | QueryRaw | QueryFilterMap<E>;
 /**
  * direction for the sort.
  */
-export declare type QuerySortDirection = -1 | 1 | 'asc' | 'desc';
+export type QuerySortDirection = -1 | 1 | 'asc' | 'desc';
 /**
  * sort by tuples
  */
-export declare type QuerySortTuples<E> = readonly [FieldKey<E>, QuerySortDirection][];
+export type QuerySortTuples<E> = readonly [FieldKey<E>, QuerySortDirection][];
 /**
  * sort by objects.
  */
-export declare type QuerySortObjects<E> = readonly {
+export type QuerySortObjects<E> = readonly {
     readonly field: FieldKey<E>;
     readonly sort: QuerySortDirection;
 }[];
 /**
  * sort by fields.
  */
-export declare type QuerySortFieldMap<E> = {
+export type QuerySortFieldMap<E> = {
     [K in FieldKey<E>]?: QuerySortDirection;
 };
 /**
  * sort by relations fields.
  */
-export declare type QuerySortRelationMap<E> = {
+export type QuerySortRelationMap<E> = {
     [K in RelationKey<E>]?: QuerySortMap<Unpacked<E[K]>>;
 };
 /**
  * sort by map.
  */
-export declare type QuerySortMap<E> = QuerySortFieldMap<E> | QuerySortRelationMap<E>;
+export type QuerySortMap<E> = QuerySortFieldMap<E> | QuerySortRelationMap<E>;
 /**
  * sort options.
  */
-export declare type QuerySort<E> = QuerySortMap<E> | QuerySortTuples<E> | QuerySortObjects<E>;
+export type QuerySort<E> = QuerySortMap<E> | QuerySortTuples<E> | QuerySortObjects<E>;
 /**
  * pager options.
  */
-export declare type QueryPager = {
+export type QueryPager = {
     $skip?: number;
     $limit?: number;
 };
 /**
  * search options.
  */
-export declare type QuerySearch<E> = {
+export type QuerySearch<E> = {
     /**
      * filtering options.
      */
@@ -256,7 +256,7 @@ export declare type QuerySearch<E> = {
 /**
  * criteria options.
  */
-export declare type QueryCriteria<E> = QuerySearch<E> & {
+export type QueryCriteria<E> = QuerySearch<E> & {
     /**
      * sorting options.
      */
@@ -265,7 +265,7 @@ export declare type QueryCriteria<E> = QuerySearch<E> & {
 /**
  * query options.
  */
-export declare type Query<E> = {
+export type Query<E> = {
     /**
      * projection options.
      */
@@ -274,21 +274,21 @@ export declare type Query<E> = {
 /**
  * options to get a single record.
  */
-export declare type QueryOne<E> = Omit<Query<E>, '$limit'>;
+export type QueryOne<E> = Omit<Query<E>, '$limit'>;
 /**
  * options to get an unique record.
  */
-export declare type QueryUnique<E> = Pick<Query<E>, '$project' | '$filter'>;
+export type QueryUnique<E> = Pick<Query<E>, '$project' | '$filter'>;
 /**
  * stringified query.
  */
-export declare type QueryStringified = {
+export type QueryStringified = {
     readonly [K in keyof Query<any>]?: string;
 };
 /**
  * result of an update operation.
  */
-export declare type QueryUpdateResult = {
+export type QueryUpdateResult = {
     /**
      * number of changes.
      */
@@ -301,7 +301,7 @@ export declare type QueryUpdateResult = {
 /**
  * options for the `raw` function.
  */
-export declare type QueryRawFnOptions = {
+export type QueryRawFnOptions = {
     /**
      * the current dialect.
      */
@@ -318,7 +318,7 @@ export declare type QueryRawFnOptions = {
 /**
  * a `raw` function
  */
-export declare type QueryRawFn = (opts?: QueryRawFnOptions) => string;
+export type QueryRawFn = (opts?: QueryRawFnOptions) => string;
 export declare class QueryRaw {
     readonly value: Scalar | QueryRawFn;
     readonly alias?: string;
@@ -327,7 +327,7 @@ export declare class QueryRaw {
 /**
  * comparison options.
  */
-export declare type QueryComparisonOptions = QueryOptions & {
+export type QueryComparisonOptions = QueryOptions & {
     /**
      * use precedence for the comparison or not.
      */
@@ -336,7 +336,7 @@ export declare type QueryComparisonOptions = QueryOptions & {
 /**
  * query filter options.
  */
-export declare type QueryFilterOptions = QueryComparisonOptions & {
+export type QueryFilterOptions = QueryComparisonOptions & {
     /**
      * clause to be used in the filter.
      */

package/type/repository.d.ts

@@ -5,7 +5,7 @@ import { Type } from './utility';
 /**
  * A `repository` allows to interact with the datasource to perform persistence operations on a specific entity.
  */
-export declare type UniversalRepository<E> = {
+export type UniversalRepository<E> = {
     /**
      * counts the number of records matching the given search parameters.
      * @param qm the search options

package/type/utility.d.ts

@@ -1,12 +1,12 @@
 /// <reference types="node" />
-export declare type Type<T> = new (...args: any[]) => T;
-export declare type BooleanLike = boolean | 0 | 1;
-export declare type MongoId = {
+export type Type<T> = new (...args: any[]) => T;
+export type BooleanLike = boolean | 0 | 1;
+export type MongoId = {
     toHexString: () => string;
 };
-export declare type Scalar = string | number | boolean | bigint | Symbol | Date | RegExp | Buffer | MongoId;
-export declare type ExpandScalar<T> = null | (T extends Date ? Date | string : T);
-export declare type Writable<T> = {
+export type Scalar = string | number | boolean | bigint | Symbol | Date | RegExp | Buffer | MongoId;
+export type ExpandScalar<T> = null | (T extends Date ? Date | string : T);
+export type Writable<T> = {
     -readonly [K in keyof T]: T[K];
 };
-export declare type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;
+export type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;

package/util/dialect.util.d.ts

@@ -1,5 +1,5 @@
 import { EntityMeta, QueryProject, CascadeType, RelationKey, FieldOptions, QueryRaw, QuerySort, QuerySortMap, QueryRawFnOptions, QueryFilter, QueryFilterMap, OnFieldCallback } from '../type';
-declare type CallbackKey = keyof Pick<FieldOptions, 'onInsert' | 'onUpdate' | 'onDelete'>;
+type CallbackKey = keyof Pick<FieldOptions, 'onInsert' | 'onUpdate' | 'onDelete'>;
 export declare function getRawValue(opts: QueryRawFnOptions & {
     value: QueryRaw;
     autoPrefixAlias?: boolean;