@uql/core 0.4.81 → 0.4.84

package/README.md

@@ -55,8 +55,8 @@ Given it is just a small library with serializable `JSON` syntax, the queries ca
 | `MySQL`      | `@uql/mysql`    |
 | `MariaDB`    | `@uql/maria`    |
 | `PostgreSQL` | `@uql/postgres` |
-| `SQLite`     | `@uql/sqlite`   |
 | `MongoDB`    | `@uql/mongo`    |
+| `SQLite`     | `@uql/sqlite`   |
 
 E.g. for `PostgreSQL`
 
@@ -86,17 +86,17 @@ Initialization should be done once (e.g. in one of the bootstrap files of your a
 import { setOptions } from '@uql/core';
 import { PgQuerierPool } from '@uql/postgres';
 
-setOptions({
-  querierPool: new PgQuerierPool(
-    {
-      host: 'localhost',
-      user: 'theUser',
-      password: 'thePassword',
-      database: 'theDatabase',
-    },
-    console.log
-  ),
-});
+const querierPool = new PgQuerierPool(
+  {
+    host: 'localhost',
+    user: 'theUser',
+    password: 'thePassword',
+    database: 'theDatabase',
+  },
+  console.log
+);
+
+setOptions({ querierPool });
 ```
 
 ## <a name="entities"></a> Entities
@@ -104,6 +104,8 @@ setOptions({
 Take any dump class (aka DTO) and annotate it with the decorators from `'@uql/core/entity'`.
 
 ```ts
+import { v4 as uuidv4 } from 'uuid';
+
 import { Field, ManyToOne, Id, OneToMany, Entity, OneToOne, ManyToMany } from '@uql/core/entity';
 
 @Entity()
@@ -111,21 +113,21 @@ export class Profile {
   /**
    * primary key
    */
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   picture?: string;
   /**
    * foreign-keys are really simple to specify.
    */
   @Field({ reference: () => User })
-  creatorId?: number;
+  creatorId?: string;
 }
 
 @Entity()
 export class User {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   name?: string;
   @Field()
@@ -141,8 +143,8 @@ export class User {
 
 @Entity()
 export class MeasureUnitCategory {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   name?: string;
   @OneToMany({ entity: () => MeasureUnit, mappedBy: (measureUnit) => measureUnit.category })
@@ -151,20 +153,20 @@ export class MeasureUnitCategory {
 
 @Entity()
 export class MeasureUnit {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   name?: string;
   @Field({ reference: () => MeasureUnitCategory })
-  categoryId?: number;
+  categoryId?: string;
   @ManyToOne({ cascade: 'persist' })
   category?: MeasureUnitCategory;
 }
 
 @Entity()
 export class Item {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   name?: string;
   @Field()
@@ -177,8 +179,8 @@ export class Item {
 
 @Entity()
 export class Tag {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field()
   name?: string;
   @ManyToMany({ entity: () => Item, mappedBy: (item) => item.tags })
@@ -187,12 +189,12 @@ export class Tag {
 
 @Entity()
 export class ItemTag {
-  @Id()
-  id?: number;
+  @Id({ onInsert: uuidv4 })
+  id?: string;
   @Field({ reference: () => Item })
-  itemId?: number;
+  itemId?: string;
   @Field({ reference: () => Tag })
-  tagId?: number;
+  tagId?: string;
 }
 ```
 
@@ -252,6 +254,7 @@ import { getQuerier } from '@uql/core';
 
 async function confirm(confirmation: Confirmation): Promise<void> {
   const querier = await getQuerier();
+
   await querier.transaction(async () => {
     if (confirmation.action === 'signup') {
       await querier.insertOne(User, {
@@ -276,6 +279,7 @@ That &#9650; can also be implemented as this &#9660; (for more granular control)
 ```ts
 async function confirm(confirmation: Confirmation): Promise<void> {
   const querier = await getQuerier();
+
   try {
     await querier.beginTransaction();
     if (confirmation.action === 'signup') {
@@ -326,27 +330,8 @@ import { querierMiddleware } from '@uql/express';
 
 const app = express();
 
-app
-  // ...
-  .use(
-    '/api',
-
-    // this will generate REST APIs for the entities.
-    querierMiddleware({
-      // all entities will be automatically exposed unless
-      // 'include' or 'exclude' options are provided.
-      exclude: [Confirmation],
-
-      // `augmentQuery` callback allows to extend all then queries that are requested to the API,
-      // so it is a good place to add additional filters to the queries,
-      // e.g. for multi tenant apps.
-      augmentQuery: <E>(meta: EntityMeta<E>, qm: Query<E>, req: express.Request): Query<E> => {
-        // ensure the user can only see the data that belongs to his company.
-        qm.$filter = augmentFilter(meta, qm.$filter, { companyId: req.identity.companyId } as QueryFilter<E>);
-        return qm;
-      },
-    })
-  );
+// this will generate REST APIs for the entities.
+app.use('/api', querierMiddleware());
 ```
 
 ## <a name="client"></a> Easily call the generated REST APIs from the Client

package/dialect/abstractSqlDialect-spec.d.ts

@@ -0,0 +1,49 @@
+import { Spec } from '@uql/core/test';
+import { AbstractSqlDialect } from './abstractSqlDialect';
+export declare abstract class AbstractSqlDialectSpec implements Spec {
+    readonly dialect: AbstractSqlDialect;
+    constructor(dialect: AbstractSqlDialect);
+    shouldBeValidEscapeCharacter(): void;
+    shouldBeginTransaction(): void;
+    shouldInsertMany(): void;
+    shouldInsertOne(): void;
+    shouldInsertWithOnInsertId(): void;
+    shouldInsertManyWithSpecifiedIdsAndOnInsertIdAsDefault(): void;
+    shouldUpdate(): void;
+    shouldFind(): void;
+    shouldBeSecure(): void;
+    shouldFind$and(): void;
+    shouldFind$or(): void;
+    shouldFind$not(): void;
+    shouldFind$nor(): void;
+    shouldFind$orAnd$and(): void;
+    shouldFindSingle$filter(): void;
+    shouldFindMultipleComparisonOperators(): void;
+    shouldFind$ne(): void;
+    shouldFindIsNull(): void;
+    shouldFind$in(): void;
+    shouldFind$nin(): void;
+    shouldFind$projectFields(): void;
+    shouldFind$projectOneToOne(): void;
+    shouldFind$projectManyToOne(): void;
+    shouldFind$projectWithAllFieldsAndSpecificFieldsAndFilter(): void;
+    shouldVirtualField(): void;
+    shouldFind$projectDeep(): void;
+    shouldFind$group(): void;
+    shouldFind$limit(): void;
+    shouldFind$skip(): void;
+    shouldFind$project(): void;
+    shouldDelete(): void;
+    shouldFind$projectRaw(): void;
+    shouldFind$filterRaw(): void;
+    shouldFind$startsWith(): void;
+    shouldFind$istartsWith(): void;
+    shouldFind$endsWith(): void;
+    shouldFind$iendsWith(): void;
+    shouldFind$includes(): void;
+    shouldFind$iincludes(): void;
+    shouldFind$like(): void;
+    shouldFind$ilike(): void;
+    shouldFind$regex(): void;
+    shouldFind$text(): void;
+}