tsledge-core 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Niklas Wockenfuß
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,100 @@
+# TSledgeCore
+
+A TypeScript playground and toolkit for web development.
+
+![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.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/app.d.ts

@@ -0,0 +1,14 @@
+import * as core from 'express-serve-static-core';
+/**
+ * Creates and configures an Express application.
+ * @example
+ * ```typescript
+ * const app = tsledge.createApp();
+ * app.listen(PORT, () => {
+ *   console.log(`Server running on port ${PORT}`);
+ * });
+ * ```
+ * @returns {core.Express} The configured Express application.
+ */
+export declare function createApp(): core.Express;
+//# sourceMappingURL=app.d.ts.map

package/dist/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,IAAI,MAAM,2BAA2B,CAAC;AAGlD;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,IAAI,IAAI,CAAC,OAAO,CASxC"}