@webtypen/webframez-core 0.2.14 → 0.2.16

package/README.md

@@ -28,9 +28,7 @@ Alternatively, a function can be specified directly or a previously imported one
 
 ```ts
 // Directly
-Route.get("/", (req: Request, res: Response) =>
-  res.send({ status: "success" })
-);
+Route.get("/", (req: Request, res: Response) => res.send({ status: "success" }));
 
 // Imported
 import { myFunction } from "./myfunction";
@@ -43,10 +41,10 @@ Middleware functions are also registered in `app/Kernel.ts.` A middleware functi
 
 Middleware functions are usually created under `app/Middleware`. A middleware function is called with the parameters (next, abort, req and res):
 
-- `next`: Function that signals when called that the request may be continued
-- `abort`: Function that aborts the request when called. An HTTP status code can be specified in the first parameter and a request body (usually text or JSON) in the second.
-- `req`: The Request-Object
-- `res`: The Response-Object
+-   `next`: Function that signals when called that the request may be continued
+-   `abort`: Function that aborts the request when called. An HTTP status code can be specified in the first parameter and a request body (usually text or JSON) in the second.
+-   `req`: The Request-Object
+-   `res`: The Response-Object
 
 Alternatively, middleware functions can also be defined directly in Kernel.ts:
 
@@ -73,7 +71,7 @@ Route.get("/auth-data", "AuthController@authData", { middleware: ["auth"] });
 
 With the grouping of routes, the code of the application can be significantly reduced and kept clear. Here's how the following configurations can be used with a multiple route definition:
 
-- `prefix`: A route path prefix used for all routes in this group:
+-   `prefix`: A route path prefix used for all routes in this group:
 
 ```ts
 Route.group({ prefix: "/admin", () => {
@@ -82,7 +80,7 @@ Route.group({ prefix: "/admin", () => {
 }});
 ```
 
-- `middleware`: An array of middleware-keys used for all routes in this group:
+-   `middleware`: An array of middleware-keys used for all routes in this group:
 
 ```ts
 Route.group({ middleware: ["auth"], () => {
@@ -100,12 +98,12 @@ Nesting of the route groups is also possible:
 
 ```ts
 Route.group({ prefix: "/test" }, () => {
-  Route.get("/", "TestController@test"); // Path: /test/
-  Route.get("/test2", "TestController@test"); // Path: /test2/
+    Route.get("/", "TestController@test"); // Path: /test/
+    Route.get("/test2", "TestController@test"); // Path: /test2/
 
-  Route.group({ middleware: ["auth"], prefix: "/auth" }, () => {
-    Route.get("/data", "AuthController@data"); // Path: /test/auth/data; Middleware: auth
-  });
+    Route.group({ middleware: ["auth"], prefix: "/auth" }, () => {
+        Route.get("/data", "AuthController@data"); // Path: /test/auth/data; Middleware: auth
+    });
 });
 ```
 
@@ -117,7 +115,7 @@ The application can handle multiple database connections, but one is defined as
 
 The connections are configured in the `config/database.ts` file. Each connection is given a unique key in the `connections` object and uses a driver. The following drivers are currently available:
 
-- MongoDB Driver
+-   MongoDB Driver
 
 Depending on the driver, the database connection must be configured with different parameters.
 
@@ -125,13 +123,13 @@ Depending on the driver, the database connection must be configured with differe
 
 ```ts
 export default {
-  defaultConnection: "default",
-  connections: {
-    ["default"]: {
-      driver: "mongodb",
-      url: "mongodb://...",
+    defaultConnection: "default",
+    connections: {
+        ["default"]: {
+            driver: "mongodb",
+            url: "mongodb://...",
+        },
     },
-  },
 };
 ```
 
@@ -140,9 +138,59 @@ export default {
 Models are usually placed under `app/Models`. Each model class inherits from `Model` and must store the table / collection name, in which the models data sets are stored, in the `__table` attribute.
 
 ```ts
-import { Model } from "@webtypen/webframez-core";
-
-export class Test extends Model {
-  __table = "test_table";
+import { Model, hasMany, QueryBuilder } from "@webtypen/webframez-core";
+import { File } from "./File";
+import { Session } from "./Session";
+
+export class User extends Model {
+    __table = "users";
+
+    /**
+     * @param File                 Dependency Model
+     * @param foreignKey
+     * @param localKey             (optional)
+     * @param queryBuilderFunction (optional) customize the query
+     **/
+    @hasOne(() => File, "_user_avatar", "_id", (query: QueryBuilder) => {
+        query.where("status", "=", "uploaded");
+    })
+    avatar!: () => File;
+
+    /**
+     * @param File                 Dependency Model
+     * @param foreignKey
+     * @param localKey             (optional)
+     * @param queryBuilderFunction (optional) customize the query
+     **/
+    @hasMany(() => Session, "_user")
+    sessions!: () => Session[];
 }
 ```
+
+### Load a model
+
+```ts
+import { User } from "../Models/User";
+
+const users = await User.where("is_active", "=", true).get();
+const testUser = await User.where("email", "=", "test@test.de").where("is_active", "=", true).first();
+```
+
+#### Dependency Injection
+
+```ts
+const sessions = await testUser.session();
+const avatarUrl = await testUser.avatar()?.url;
+```
+
+##### Disable cache / force dependency-reload:
+
+```ts
+const refreshedData = await testUser.session({ force: true });
+```
+
+##### Get dependency-query:
+
+```ts
+const oldSessions = await testUser.session({ query: true }).where("date", "<", moment().subtract(30, "days").format("YYYY-MM-DD")).get();
+```

package/dist/Datatable/Datatable.d.ts

@@ -1,4 +1,5 @@
 import { Request } from "../Router/Request";
+type DatatableAutoApplyMatchModeType = "begin" | "end" | null;
 export declare class Datatable {
     collection: string | Function;
     aggregation: {
@@ -18,6 +19,8 @@ export declare class Datatable {
     perPage: number;
     onRow?: Function;
     onAttributes?: Function;
+    autoApplyFilter: DatatableAutoApplyMatchModeType;
+    autoApplySearch: DatatableAutoApplyMatchModeType;
     getInit(req: Request): Promise<any>;
     getAggregation(req: Request): Promise<any>;
     getSubAggregation(req: Request): Promise<any>;
@@ -36,3 +39,4 @@ export declare class Datatable {
     private formatFilterEntryVal;
     getFilterMatch(req: Request, searchOrFilter: any): Promise<any>;
 }
+export {};

package/dist/Datatable/Datatable.js

@@ -22,6 +22,8 @@ class Datatable {
         this.onPressLink = null;
         this.exports = null;
         this.perPage = 25;
+        this.autoApplyFilter = "begin";
+        this.autoApplySearch = null;
     }
     getInit(req) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -62,7 +64,24 @@ class Datatable {
     }
     getAggregation(req) {
         return __awaiter(this, void 0, void 0, function* () {
-            return typeof this.aggregation === "function" ? yield this.aggregation(req) : this.aggregation;
+            const aggr = typeof this.aggregation === "function" ? yield this.aggregation(req) : this.aggregation;
+            if (this.autoApplyFilter && req.body.filter && typeof req.body.filter === "object") {
+                if (this.autoApplyFilter === "begin") {
+                    return [{ $match: Object.assign({}, this.getFilterMatch(req, req.body.filter)) }, ...aggr];
+                }
+                else if (this.autoApplyFilter === "end") {
+                    return [...aggr, { $match: Object.assign({}, this.getFilterMatch(req, req.body.filter)) }];
+                }
+            }
+            else if (this.autoApplySearch && req.body.search && typeof req.body.search === "object") {
+                if (this.autoApplySearch === "begin") {
+                    return [{ $match: Object.assign({}, this.getFilterMatch(req, req.body.search)) }, ...aggr];
+                }
+                else if (this.autoApplySearch === "end") {
+                    return [...aggr, { $match: Object.assign({}, this.getFilterMatch(req, req.body.search)) }];
+                }
+            }
+            return aggr;
         });
     }
     getSubAggregation(req) {
@@ -317,6 +336,28 @@ class Datatable {
                         }
                         break;
                 }
+                if (value !== undefined && filterEl && filterEl.cast) {
+                    if (typeof filterEl.cast === "function") {
+                        value = yield filterEl.cast(value, entry, req);
+                    }
+                    else if (filterEl.cast === "string") {
+                        value = value.toString();
+                    }
+                    else if (filterEl.cast === "objectId") {
+                        if (value.length === 12 || value.length === 24) {
+                            value = yield DBConnection_1.DBConnection.objectId(value);
+                        }
+                    }
+                    else if (filterEl.cast === "integer") {
+                        value = parseInt(value);
+                    }
+                    else if (filterEl.cast === "float") {
+                        value = parseFloat(value);
+                    }
+                    else if (filterEl.cast === "boolean") {
+                        value = value === true || value === 1 || value.toString() === "1" || value.toString() === "true" ? true : false;
+                    }
+                }
                 if (value !== undefined) {
                     out[filterEl && filterEl.mapping && filterEl.mapping.trim() !== "" ? filterEl.mapping : key] = value;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@webtypen/webframez-core",
-    "version": "0.2.14",
+    "version": "0.2.16",
     "description": "The core package of the typescript based webframez (web-framework) by webtypen.de",
     "homepage": "https://webtypen.de/",
     "license": "MIT",

package/src/Datatable/Datatable.ts

@@ -2,6 +2,8 @@ import { DBConnection } from "../Database/DBConnection";
 import { NumericFunctions } from "../Functions/NumericFunctions";
 import { Request } from "../Router/Request";
 
+type DatatableAutoApplyMatchModeType = "begin" | "end" | null;
+
 export class Datatable {
     collection: string | Function = "";
     aggregation: { [key: string]: any } | Function | null = null;
@@ -13,6 +15,8 @@ export class Datatable {
     perPage: number = 25;
     onRow?: Function;
     onAttributes?: Function;
+    autoApplyFilter: DatatableAutoApplyMatchModeType = "begin";
+    autoApplySearch: DatatableAutoApplyMatchModeType = null;
 
     async getInit(req: Request) {
         const out: any = { table: req.body._table };
@@ -60,7 +64,21 @@ export class Datatable {
     }
 
     async getAggregation(req: Request) {
-        return typeof this.aggregation === "function" ? await this.aggregation(req) : this.aggregation;
+        const aggr = typeof this.aggregation === "function" ? await this.aggregation(req) : this.aggregation;
+        if (this.autoApplyFilter && req.body.filter && typeof req.body.filter === "object") {
+            if (this.autoApplyFilter === "begin") {
+                return [{ $match: { ...this.getFilterMatch(req, req.body.filter) } }, ...aggr];
+            } else if (this.autoApplyFilter === "end") {
+                return [...aggr, { $match: { ...this.getFilterMatch(req, req.body.filter) } }];
+            }
+        } else if (this.autoApplySearch && req.body.search && typeof req.body.search === "object") {
+            if (this.autoApplySearch === "begin") {
+                return [{ $match: { ...this.getFilterMatch(req, req.body.search) } }, ...aggr];
+            } else if (this.autoApplySearch === "end") {
+                return [...aggr, { $match: { ...this.getFilterMatch(req, req.body.search) } }];
+            }
+        }
+        return aggr;
     }
 
     async getSubAggregation(req: Request) {
@@ -331,6 +349,24 @@ export class Datatable {
                     break;
             }
 
+            if (value !== undefined && filterEl && filterEl.cast) {
+                if (typeof filterEl.cast === "function") {
+                    value = await filterEl.cast(value, entry, req);
+                } else if (filterEl.cast === "string") {
+                    value = value.toString();
+                } else if (filterEl.cast === "objectId") {
+                    if (value.length === 12 || value.length === 24) {
+                        value = await DBConnection.objectId(value);
+                    }
+                } else if (filterEl.cast === "integer") {
+                    value = parseInt(value);
+                } else if (filterEl.cast === "float") {
+                    value = parseFloat(value);
+                } else if (filterEl.cast === "boolean") {
+                    value = value === true || value === 1 || value.toString() === "1" || value.toString() === "true" ? true : false;
+                }
+            }
+
             if (value !== undefined) {
                 out[filterEl && filterEl.mapping && filterEl.mapping.trim() !== "" ? filterEl.mapping : key] = value;
             }