tsledge 0.1.10 → 0.1.11

package/README.md

@@ -1,5 +1,100 @@
 # TSledge
 
-My playground and some helpful tools for web development 
+A TypeScript playground and toolkit for web development.
 
-![thumbnail](docs/res/thumbnail.png)
+![thumbnail](docs/res/thumbnail.png)
+
+## Installation
+
+This project requires the following dependencies:
+
+```bash
+npm install mongoose@9.2.1
+```
+
+## Tutorials
+
+### Create Mongoose Collection
+
+```typescript
+import mongoose from "mongoose";
+
+export interface User {
+  ofUserGroup: mongoose.Schema.Types.ObjectId;
+  username: string;
+  email: string;
+  secretHash: string;
+}
+
+export type UserDocument = User & mongoose.Document;
+
+const UserSchema = new mongoose.Schema<UserDocument>(
+  {
+    ofUserGroup: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'UserGroup',
+      alias: 'userGroup',
+      required: true,
+    },
+    username: { type: String, unique: true, required: true, filter: true }, // 'filter' is a fluent-pattern-handler feature
+    email: { type: String, unique: true, required: true, select: false },
+    secretHash: { type: String, select: false },
+  },
+  { collection: 'users', timestamps: true }
+);
+
+UserSchema.set('toJSON', {
+  transform: (_doc, ret: any) => {
+    delete ret.secretHash;
+    return ret;
+  }
+});
+
+export const UserModel = mongoose.model<UserDocument>('User', UserSchema);
+```
+
+### Using FluentInterface
+
+```typescript
+router.get(
+  '/',
+  async (
+    req: FluentExpressRequest,
+    res: FluentExpressResponse
+  ) => {
+    try {
+      let queryBuilder = new QueryBuilder({
+        model: UserModel
+      });
+      let codec = await FluentPatternHandler.getInstance().exec({
+        req,
+        res,
+        queryBuilder
+      });
+
+      codec.sendToClient(res);
+    } catch (e) {
+      console.log(e);
+      res.status(500).json();
+    }
+  }
+);
+```
+
+### API Examples
+
+#### Search across all filter fields
+
+```http
+GET /?filter=john_doe&limit=10&offset=5
+```
+
+Search in all fields marked with `filter: true` option.
+
+#### Search in a specific field
+
+```http
+GET /?username=john_doe&limit=10&offset=5
+```
+
+Search only in the `username` field.

package/dist/fluent-interface/fluent-pattern-handler.d.ts

@@ -1,20 +1,25 @@
-import { FluentAPIOption, FluentMiddleware, FluentExecParams } from './types';
+import { FluentMiddleware, FluentExecParams } from './types';
 import { PromiseDefaultCodec } from '../core/index';
 export declare class FluentPatternHandler {
+    /**
+     * Singleton instance of FluentPatternHandler. The class is designed
+     */
     private static _singleton;
-    private _options;
+    /**
+     * Array of middleware functions to be executed before the main query execution in the exec method. Each function receives the execution parameters and can modify them as needed.
+     */
     private _execMiddlewareFunctions;
     /**
-     * Constructor for QueryPatternExecutor.
-     * @param options - Array of query pattern options for filtering.
+     * Constructor for FluentPatternHandler.
+     * @param execMiddleware - Optional array of middleware functions to be executed before the main query execution in the exec method.
      */
-    constructor(options?: FluentAPIOption[], execMiddleware?: FluentMiddleware[]);
+    constructor(execMiddleware?: FluentMiddleware[]);
     /**
      * Initializes the singleton instance of FluentPatternHandler with the provided options.
-     * @param options - Array of query pattern options for filtering.
+     * @param execMiddleware - Optional array of middleware functions to be executed before the main query execution in the exec method.
      * @returns Singleton instance of FluentPatternHandler.
      */
-    static init(options?: FluentAPIOption[], execMiddleware?: FluentMiddleware[]): FluentPatternHandler;
+    static init(execMiddleware?: FluentMiddleware[]): FluentPatternHandler;
     /**
      * Returns the singleton instance of FluentPatternHandler.
      * @returns Singleton instance of FluentPatternHandler.
@@ -34,7 +39,7 @@ export declare class FluentPatternHandler {
      */
     private _applyParameters;
     /**
-     * Retrieves filter fields for the given model from the options configuration.
+     * Generates filter fields for the given Mongoose model based on schema options.
      * @param model - The Mongoose model.
      * @returns Array of filter fields.
      */

package/dist/fluent-interface/fluent-pattern-handler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluent-pattern-handler.d.ts","sourceRoot":"","sources":["../../src/fluent-interface/fluent-pattern-handler.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,eAAe,EAEf,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,SAAS,CAAC;AACjB,OAAO,EAA8B,mBAAmB,EAAgB,MAAM,eAAe,CAAC;AAY9F,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAuB;IAChD,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,wBAAwB,CAA0B;IAE1D;;;OAGG;gBACS,OAAO,GAAE,eAAe,EAAO,EAAE,cAAc,GAAE,gBAAgB,EAAO;IAWpF;;;;OAIG;WACW,IAAI,CAChB,OAAO,GAAE,eAAe,EAAO,EAC/B,cAAc,GAAE,gBAAgB,EAAO,GACtC,oBAAoB;IAQvB;;;OAGG;WACW,WAAW,IAAI,oBAAoB;IASjD;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAsChC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAoCxB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAYhC;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAa/B;;;;OAIG;IACY,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,gBAAgB,GAAG,mBAAmB;CAgB1E"}
+{"version":3,"file":"fluent-pattern-handler.d.ts","sourceRoot":"","sources":["../../src/fluent-interface/fluent-pattern-handler.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,SAAS,CAAC;AACjB,OAAO,EAA8B,mBAAmB,EAAgB,MAAM,eAAe,CAAC;AAY9F,qBAAa,oBAAoB;IAC/B;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU,CAAuB;IAChD;;OAEG;IACH,OAAO,CAAC,wBAAwB,CAA0B;IAE1D;;;OAGG;gBACS,cAAc,GAAE,gBAAgB,EAAO;IAUnD;;;;OAIG;WACW,IAAI,CAAC,cAAc,GAAE,gBAAgB,EAAO,GAAG,oBAAoB;IAQjF;;;OAGG;WACW,WAAW,IAAI,oBAAoB;IASjD;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAsChC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAoCxB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAWhC;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAa7B;;;;OAIG;IACU,IAAI,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,gBAAgB,GAAG,mBAAmB;CAgB1E"}

package/dist/fluent-interface/types.d.ts

@@ -1,9 +1,5 @@
-import mongoose from 'mongoose';
 import { Request, Response } from 'express';
 import { DefaultResponseBody, KeysEnum, QueryBuilder } from '../core/index';
-export interface FluentRequestParams extends Record<string, string> {
-    collection: string;
-}
 export interface FluentRequestBody {
 }
 export interface FluentRequestQuery {
@@ -19,11 +15,7 @@ export interface FluentRequestQuery {
  * Attributes of FluentRequestQuery used for validation and parsing.
  */
 export declare const fluentRequestQueryAttributes: KeysEnum<FluentRequestQuery>;
-export interface FluentAPIOption<T = any> {
-    model: mongoose.Model<T>;
-    filters?: string[];
-}
-export type FluentExpressRequest = Request<FluentRequestParams, DefaultResponseBody, FluentRequestBody, FluentRequestQuery>;
+export type FluentExpressRequest = Request<any, DefaultResponseBody, FluentRequestBody, FluentRequestQuery>;
 export type FluentExpressResponse = Response<DefaultResponseBody>;
 export type FluentExecParams = {
     req: FluentExpressRequest;

package/dist/fluent-interface/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent-interface/types.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE5E,MAAM,WAAW,mBAAoB,SAAQ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IACjE,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;CAAG;AAErC,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,QAAQ,CAAC,kBAAkB,CAQrE,CAAC;AAEF,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,GAAG;IAEtC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,OAAO,CACxC,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,oBAAoB,CAAC;IAC1B,GAAG,EAAE,qBAAqB,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent-interface/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE5E,MAAM,WAAW,iBAAiB;CAAG;AAErC,MAAM,WAAW,kBAAkB;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,4BAA4B,EAAE,QAAQ,CAAC,kBAAkB,CAQrE,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,OAAO,CACxC,GAAG,EACH,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,CACnB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AAElE,MAAM,MAAM,gBAAgB,GAAG;IAC7B,GAAG,EAAE,oBAAoB,CAAC;IAC1B,GAAG,EAAE,qBAAqB,CAAC;IAC3B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,gBAAgB,KAAK,IAAI,CAAC"}

package/dist/index.js

@@ -810,30 +810,32 @@ async function httpRequest(config) {
 // src/fluent-interface/fluent-pattern-handler.ts
 var FluentPatternHandler = class _FluentPatternHandler {
   /**
-   * Constructor for QueryPatternExecutor.
-   * @param options - Array of query pattern options for filtering.
+   * Constructor for FluentPatternHandler.
+   * @param execMiddleware - Optional array of middleware functions to be executed before the main query execution in the exec method.
    */
-  constructor(options = [], execMiddleware = []) {
+  constructor(execMiddleware = []) {
+    /**
+     * Array of middleware functions to be executed before the main query execution in the exec method. Each function receives the execution parameters and can modify them as needed.
+     */
     this._execMiddlewareFunctions = [];
     if (_FluentPatternHandler._singleton) {
       throw new Error(
         "FluentPatternHandler is a singleton class. Use FluentPatternHandler.getInstance() to access the instance."
       );
     }
-    this._options = options;
     this._execMiddlewareFunctions = execMiddleware;
     _FluentPatternHandler._singleton = this;
   }
   /**
    * Initializes the singleton instance of FluentPatternHandler with the provided options.
-   * @param options - Array of query pattern options for filtering.
+   * @param execMiddleware - Optional array of middleware functions to be executed before the main query execution in the exec method.
    * @returns Singleton instance of FluentPatternHandler.
    */
-  static init(options = [], execMiddleware = []) {
+  static init(execMiddleware = []) {
     if (_FluentPatternHandler._singleton != void 0) {
       throw new Error("FluentPatternHandler is already initialized");
     }
-    _FluentPatternHandler._singleton = new _FluentPatternHandler(options, execMiddleware);
+    _FluentPatternHandler._singleton = new _FluentPatternHandler(execMiddleware);
     return _FluentPatternHandler._singleton;
   }
   /**
@@ -872,7 +874,7 @@ var FluentPatternHandler = class _FluentPatternHandler {
         excluded = JSON.parse(excludedJSON);
         if (!Array.isArray(excluded)) throw new Error("Excluded must be an array");
       } catch (error) {
-        console.warn("[QueryPatternExecutor] Invalid excluded parameter:", error);
+        console.warn("[FluentPatternHandler] Invalid excluded parameter:", error);
       }
     }
     let ids;
@@ -881,7 +883,7 @@ var FluentPatternHandler = class _FluentPatternHandler {
         ids = JSON.parse(idsJSON);
         if (!Array.isArray(ids)) throw new Error("Ids must be an array");
       } catch (error) {
-        console.warn("[QueryPatternExecutor] Invalid ids parameter:", error);
+        console.warn("[FluentPatternHandler] Invalid ids parameter:", error);
       }
     }
     return { filter, limit, offset, id, excluded, ids, filterFields };
@@ -924,20 +926,19 @@ var FluentPatternHandler = class _FluentPatternHandler {
     }
   }
   /**
-   * Retrieves filter fields for the given model from the options configuration.
+   * Generates filter fields for the given Mongoose model based on schema options.
    * @param model - The Mongoose model.
    * @returns Array of filter fields.
    */
   _getFilterFieldsForModel(model) {
-    for (const option of this._options) {
-      if (option.model.collection.name === model.collection.name) {
-        if (option.filters) {
-          return option.filters;
-        }
-        return [];
+    let filterFields = [];
+    let schema = model.schema;
+    schema.eachPath((path2, type) => {
+      if (type?.options?.filter == true) {
+        filterFields.push(path2);
       }
-    }
-    return [];
+    });
+    return filterFields;
   }
   /**
    * Builds execution parameters for the query builder.
@@ -955,7 +956,7 @@ var FluentPatternHandler = class _FluentPatternHandler {
   /**
    * Executes the query builder with applied filters and returns the result.
    * @param params Execution parameters including the query builder and request query.
-   * @returns 
+   * @returns
    */
   async exec(params) {
     try {
@@ -969,7 +970,7 @@ var FluentPatternHandler = class _FluentPatternHandler {
       const execConfig = this._buildExecutionConfig(queryParams);
       return await params.queryBuilder.exec(execConfig);
     } catch (err) {
-      console.error("[ERROR - QueryPatternExecutor]", err);
+      console.error("[ERROR - FluentPatternHandler]", err);
       return new Codec({ data: [], meta: { total: 0 } }, 500);
     }
   }

package/package.json

@@ -2,7 +2,7 @@
   "author": "Niklas Wockenfuß",
   "homepage": "https://niklaswockenfuss.de/",
   "name": "tsledge",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "license": "MIT",
   "description": "My playground and some helpful tools for web development ",
   "main": "dist/index.js",