bradb 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thorque Software
+
+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,133 @@
+# Brad API Utilities
+
+**Brad** is a utility library designed to dramatically speed up the development of RESTful APIs in Node.js. It natively integrates [Express](https://expressjs.com/), [Drizzle ORM](https://orm.drizzle.team/), and [Zod](https://zod.dev/) to provide a solid and efficient foundation for your projects.
+
+The philosophy of `brad` is simple: reduce repetitive boilerplate code to a minimum, allowing you to focus on business logic.
+
+## Core Features
+
+-   **Base CRUD Controller:** Automatically generates endpoints for `getAll`, `getById`, `create`, `update`, and `delete`.
+-   **Standardized Services:** Factory functions to create database access logic (`findAll`, `findOne`, `create`, etc.).
+-   **Automatic Pagination and Filtering:** Extracts pagination (`page`, `pageSize`) and filter parameters from the URL.
+-   **Validation with Zod:** Uses Zod schemas to validate input data.
+-   **Integrated Error Handling:** An Express `errorHandler` that catches and formats errors from `Zod`, `Drizzle`, and custom service errors.
+
+## Installation
+
+```bash
+npm install brad
+```
+
+Make sure to also install the `peer` dependencies:
+
+```bash
+npm install express drizzle-orm pg zod
+npm install -D @types/express @types/pg
+```
+
+## Quickstart Guide
+
+Here is an example of how to structure an API with `brad`.
+
+### 1. Define Your Drizzle Schema
+
+Create your database schema as you normally would with Drizzle.
+
+`src/schema.ts`:
+```typescript
+import { pgTable, serial, text, timestamp } from "drizzle-orm/pg-core";
+
+export const serviceTable = pgTable("services", {
+    id: serial("id").primaryKey(),
+    name: text("name").notNull(),
+    // ... other fields
+    deletedAt: timestamp("deleted_at", { withTimezone: true, mode: "date" })
+});
+```
+
+### 2. Create the Service
+
+Use `brad`'s factory functions to create a CRUD service for your table.
+
+`src/services.ts`:
+```typescript
+import { db } from "./db"; // Your Drizzle instance
+import { serviceTable } from "./schema";
+import { create, findAll, findOne, softDelete, update, count } from "brad";
+import { eq } from "drizzle-orm";
+
+// Filter map for queries
+const filterMap = {
+    name: (value: string) => eq(serviceTable.name, value)
+};
+
+export const serviceService = {
+    findAll: findAll(filterMap, db.select().from(serviceTable)),
+    findOne: findOne(serviceTable, db.select().from(serviceTable)),
+    create: create(db, serviceTable),
+    update: update(db, serviceTable),
+    delete: softDelete(db, serviceTable),
+    count: count(db, serviceTable, filterMap)
+};
+```
+
+### 3. Create the Controller
+
+Extend `brad`'s `BaseController`, passing it the service and Zod validation schemas.
+
+`src/controllers.ts`:
+```typescript
+import { BaseController } from "brad";
+import { serviceService } from "./services";
+import { serviceTable } from "./schema";
+import { z } from "zod";
+import { createSelectSchema } from "drizzle-zod";
+
+// Base Zod schema from the Drizzle schema
+const serviceSchema = createSelectSchema(serviceTable);
+
+export const serviceController = new BaseController(
+    serviceService,
+    serviceSchema,
+    serviceSchema.pick({ name: true }).partial() // Schema for filters
+);
+```
+
+### 4. Set up the Router and Server
+
+Connect the routes to the controller methods and don't forget to add the `errorHandler`.
+
+`src/router.ts`:
+```typescript
+import { Router } from "express";
+import { serviceController } from "./controllers";
+
+const router = Router();
+
+router.get("/", serviceController.getAll);
+router.get("/:id", serviceController.getById);
+router.post("/", serviceController.create);
+router.put("/:id", serviceController.update);
+router.delete("/:id", serviceController.delete);
+
+export default router;
+```
+
+`src/index.ts`:
+```typescript
+import express from "express";
+import serviceRouter from "./router";
+import { errorHandler } from "brad";
+
+const app = express();
+app.use(express.json());
+
+app.use("/services", serviceRouter);
+
+// Important! Add the error handler at the end
+app.use(errorHandler);
+
+app.listen(3000, () => {
+    console.log(`Server is running on port 3000`);
+});
+```

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './src/types';
+export * from './src/controller';
+export * from './src/standard';
+export * from './src/relational';
+export * from './src/utils';
+export * from './src/errors';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/types"), exports);
+__exportStar(require("./src/controller"), exports);
+__exportStar(require("./src/standard"), exports);
+__exportStar(require("./src/relational"), exports);
+__exportStar(require("./src/utils"), exports);
+__exportStar(require("./src/errors"), exports);

package/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "bradb",
+    "version": "1.0.0",
+    "description": "",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "rm -rf dist/ && tsc",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "keywords": [
+        "api",
+        "orm"
+    ],
+    "author": "Thorque Software",
+    "license": "MIT",
+    "type": "commonjs",
+    "devDependencies": {
+        "@types/express": "^5.0.3",
+        "@types/pg": "^8.15.5",
+        "typescript": "^5.9.2"
+    },
+    "peerDependencies": {
+        "@types/pg": "^8.15.5",
+        "drizzle-orm": "^0.44.5",
+        "express": "^5.1.0",
+        "pg": "^8.16.3",
+        "zod": "^4.1.5"
+    }
+}