@promind/honey 1.47.0 → 1.47.13

package/README.md

@@ -9,6 +9,9 @@ A TypeScript-based Node.js declarative library for building RESTful APIs with se
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
+  - [Database Connection](#database-connection)
+  - [Environment Variables](#environment-variables)
+  - [Built-in Defaults](#built-in-defaults)
 - [API Reference](#api-reference)
   - [Core Methods](#core-methods)
   - [CRUD Operations](#crud-operations)
@@ -32,7 +35,7 @@ A TypeScript-based Node.js declarative library for building RESTful APIs with se
 - **TypeScript Ready**: Full TypeScript support with comprehensive type definitions
 - **Validation**: Request validation using Joi
 - **Error Handling**: Consistent error handling and response formatting
-- **Swagger Documentation**: Automatic OpenAPI documentation generation
+- **API Documentation**: Automatic OpenAPI documentation is generated internally via `express-oas-generator`.
 
 ## Prerequisites
 
@@ -104,7 +107,7 @@ honey.deleteById({
 honey.startServer();
 ```
 
-2. Run your server:
+1. Run your server:
 
 ```bash
 # If using TypeScript
@@ -156,6 +159,15 @@ import { createHoney } from '@promind/honey';
 const honey = createHoney(process.env.PORT, process.env.DB_URI);
 ```
 
+### Built-in Defaults
+
+HoneyJS automatically configures the following on startup:
+
+- **CORS**: Enabled for all origins (`*`) with all methods and headers allowed
+- **Body parsing**: JSON and URL-encoded bodies up to 50MB
+- **Cookie parsing**: Enabled via `cookie-parser`
+- **Route prefix**: `/api` (configurable via `metadata.routePrefix`)
+
 ## API Reference
 
 ### Core Methods
@@ -180,12 +192,18 @@ Starts the HTTP server.
 
 Adds global middleware to all routes.
 
+#### `honey.db`
+
+Exposes the underlying Sequelize instance for direct database access.
+
 ### CRUD Operations
 
 #### `honey.create(options)`
 
 Creates a POST endpoint for creating new resources.
 
+The response `data` field contains `{ id }` (the inserted record's ID) by default unless `processResponseData` is provided.
+
 ```typescript
 honey.create({
   resource: 'posts', // Resource name (used in URL path)
@@ -202,10 +220,13 @@ honey.create({
   message: 'Post created', // Success message
   pathOverride: '/blog/posts', // Optional: Custom path
   middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'post', // Optional: Override the HTTP method
   processResponseData: (data, req) => {
     // Optional: Transform response data
     return { ...data, extra: 'info' };
-  }
+  },
+  processErrorResponse: (err) => err // Optional: Customize error response
 });
 ```
 
@@ -213,6 +234,22 @@ honey.create({
 
 Creates a GET endpoint for retrieving a list of resources.
 
+Automatically supports `?page=` and `?limit=` query parameters for pagination. The response shape is:
+
+```json
+{
+  "data": [...],
+  "meta": {
+    "pagination": {
+      "total": 100,
+      "pageSize": 10,
+      "page": 1,
+      "pageCount": 10
+    }
+  }
+}
+```
+
 ```typescript
 honey.get({
   resource: 'posts',
@@ -221,12 +258,18 @@ honey.get({
     // Optional: Query filters
     title: {
       operator: 'like', // Filter operator
-      value: 'string' // Parameter type
+      value: 'string', // Parameter type
+      location: 'query' // Optional: where to read the value from (default: query string)
     },
     published: {
       operator: '=',
       value: 'boolean'
     },
+    author_id: {
+      operator: '=',
+      value: 'number',
+      overrideValue: (req) => req.user?.id // Dynamic value based on request
+    },
     $or: {
       // Logical OR condition
       title: {
@@ -243,10 +286,39 @@ honey.get({
     // Optional: Sorting
     sort: 'DESC', // ASC or DESC
     sortField: 'created_at' // Field to sort by
-  }
+  },
+  joins: [
+    // Optional: SQL joins
+    {
+      table: 'users',
+      type: 'inner', // 'inner' | 'left' | 'right' | 'full' | 'cross' (default: 'inner')
+      on: {
+        left: 'posts.author_id',
+        right: 'users.id',
+        operator: '=' // '=' | '!=' | '<' | '<=' | '>' | '>='
+      },
+      alias: 'author' // Optional alias
+    }
+  ],
+  shouldErrorOnNotFound: false, // Optional: When false, returns empty data instead of 404 (default: true)
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'get' // Optional: Override the HTTP method
 });
 ```
 
+**Filter operators:** `'='`, `'!='`, `'<'`, `'<='`, `'>'`, `'>='`, `'in'`, `'not in'`, `'like'`, `'not like'`
+
+> **Note:** `'like'` uses PostgreSQL `ILIKE` for case-insensitive matching.
+
+**Filter `value` types:** `'string'`, `'number'`, `'boolean'`, `'json'`, `'csv'` (splits comma-separated string into array), `'as-is'` (passes value through unchanged)
+
+**Filter `location` options:** `'query'` (default), `'body'`, `'headers'`, `'request'`, `'params'`
+
+**Filter `overrideValue`:** Can be a static value or a function `(req) => value` for dynamic values based on the request.
+
+**Using joins with dot-notation:** When using joins, fields can use dot-notation to reference columns from joined tables: `'tableName.fieldName'`.
+
 #### `honey.getById(options)`
 
 Creates a GET endpoint for retrieving a single resource by ID.
@@ -262,7 +334,19 @@ honey.getById({
       operator: '=',
       overrideValue: true // Force a value regardless of request
     }
-  }
+  },
+  joins: [
+    // Optional: SQL joins (same as honey.get())
+    {
+      table: 'users',
+      type: 'left',
+      on: { left: 'posts.author_id', right: 'users.id' }
+    }
+  ],
+  shouldErrorOnNotFound: false, // Optional: When false, returns empty data instead of 404 (default: true)
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'get' // Optional: Override the HTTP method
 });
 ```
 
@@ -280,7 +364,17 @@ honey.updateById({
     updated_at: '@updatedAt' // Set to current timestamp
   },
   message: 'Post updated',
-  idField: 'slug' // Optional: Use a different field as identifier
+  idField: 'slug', // Optional: Use a different field as identifier
+  filter: {
+    // Optional: Additional WHERE conditions beyond the ID
+    author_id: {
+      operator: '=',
+      value: 'number'
+    }
+  },
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'put' // Optional: Override the HTTP method
 });
 ```
 
@@ -302,14 +396,21 @@ honey.update({
       value: 'number'
     }
   },
-  message: 'Posts updated'
+  message: 'Posts updated',
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'put' // Optional: Override the HTTP method
 });
 ```
 
+> **Note:** `filter` is **required** for `honey.update()` to prevent unintended bulk updates.
+
 #### `honey.upsertById(options)`
 
 Creates a PUT endpoint for upserting a resource by ID.
 
+After an upsert, `req.isInsert` is set to `true` if the operation was an INSERT, or `false` if it was an UPDATE. This flag is accessible in `processResponseData` and `exitMiddleware`.
+
 ```typescript
 honey.upsertById({
   resource: 'posts',
@@ -319,7 +420,15 @@ honey.upsertById({
     updated_at: '@updatedAt'
   },
   message: 'Post upserted',
-  idField: 'id' // Field to use for conflict detection
+  idField: 'id', // Required: Field to use for conflict detection
+  doNothingOnConflict: false, // Optional: When true, returns existing record unchanged on conflict (default: false)
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'put', // Optional: Override the HTTP method
+  processResponseData: (data, req) => {
+    // req.isInsert is true for INSERT, false for UPDATE
+    return { ...data, wasInserted: req.isInsert };
+  }
 });
 ```
 
@@ -327,6 +436,8 @@ honey.upsertById({
 
 Creates a PUT endpoint for upserting a resource with custom conflict resolution.
 
+After an upsert, `req.isInsert` is set to `true` if the operation was an INSERT, or `false` if it was an UPDATE. This flag is accessible in `processResponseData` and `exitMiddleware`.
+
 ```typescript
 honey.upsert({
   resource: 'posts',
@@ -337,7 +448,11 @@ honey.upsert({
     updated_at: '@updatedAt'
   },
   message: 'Post upserted',
-  conflictTarget: ['slug'] // Fields to check for conflicts
+  conflictTarget: ['slug'], // Fields to check for conflicts
+  doNothingOnConflict: false, // Optional: When true, returns existing record unchanged on conflict (default: false)
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'put' // Optional: Override the HTTP method
 });
 ```
 
@@ -356,10 +471,74 @@ honey.deleteById({
       operator: '=',
       value: 'number'
     }
-  }
+  },
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'delete' // Optional: Override the HTTP method
 });
 ```
 
+#### `honey.delete(options)`
+
+Creates a DELETE endpoint for bulk-deleting resources (no ID in path).
+
+```typescript
+honey.delete({
+  resource: 'posts',
+  filter: {
+    // Filter criteria for records to delete
+    author_id: {
+      operator: '=',
+      value: 'number'
+    }
+  },
+  message: 'Posts deleted',
+  table: 'blog_posts', // Optional: Table name if different from resource
+  pathOverride: '/blog/posts', // Optional: Custom path
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  methodOverride: 'delete', // Optional: Override the HTTP method
+  processErrorResponse: (err) => err // Optional: Customize error response
+});
+```
+
+#### `honey.query(options)`
+
+Creates a custom endpoint backed by a raw Knex query. Useful for complex queries that go beyond standard CRUD operations.
+
+Automatically supports `?page=` and `?limit=` query parameters for pagination.
+
+```typescript
+honey.query({
+  resource: 'stats',
+  methodOverride: 'get', // Optional: HTTP method (default: 'get')
+  query: (knex, req) => {
+    return knex('posts')
+      .select('author_id')
+      .count('id as post_count')
+      .groupBy('author_id');
+  },
+  processResponseData: (data, req) => {
+    return data;
+  },
+  pathOverride: '/stats/posts', // Optional: Custom path
+  middleware: [authMiddleware], // Optional: Route-specific middleware
+  exitMiddleware: [auditMiddleware], // Optional: Middleware that runs after response is sent
+  processErrorResponse: (err) => err // Optional: Customize error response
+});
+```
+
+**Options:**
+
+- `resource` — Resource name used in the URL path
+- `query` — Function receiving `(knex, req)` and returning a Knex `QueryBuilder`
+- `pathOverride` — Optional custom path
+- `methodOverride` — HTTP method (default: `'get'`)
+- `middleware` — Route-specific middleware
+- `exitMiddleware` — Middleware that runs after the response is sent
+- `processResponseData` — Transform the response data
+- `processErrorResponse` — Customize the error response
+
 ### Advanced Usage
 
 #### Custom Response Processing
@@ -414,26 +593,34 @@ HoneyJS provides several utilities for working directly with the database.
 ```typescript
 import { defineModel, DataTypes } from '@promind/honey';
 
-const User = defineModel('users', {
-  id: {
-    type: DataTypes.UUID,
-    defaultValue: DataTypes.UUIDV4,
-    primaryKey: true
-  },
-  name: {
-    type: DataTypes.STRING,
-    allowNull: false
-  },
-  email: {
-    type: DataTypes.STRING,
-    allowNull: false,
-    unique: true
+const User = defineModel(
+  'users',
+  {
+    id: {
+      type: DataTypes.UUID,
+      defaultValue: DataTypes.UUIDV4,
+      primaryKey: true
+    },
+    name: {
+      type: DataTypes.STRING,
+      allowNull: false
+    },
+    email: {
+      type: DataTypes.STRING,
+      allowNull: false,
+      unique: true
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW
+    }
   },
-  created_at: {
-    type: DataTypes.DATE,
-    defaultValue: DataTypes.NOW
+  {
+    // Optional: Sequelize ModelOptions
+    timestamps: false,
+    tableName: 'app_users'
   }
-});
+);
 
 export default User;
 ```
@@ -455,6 +642,35 @@ async function getUsersWithPosts() {
 }
 ```
 
+### `createReqTransit`
+
+`createReqTransit` creates a typed transit object for safely passing data between middleware and controllers via the request object.
+
+```typescript
+import { createReqTransit } from '@promind/honey';
+
+// Create a typed transit for passing data between middleware and controllers
+const userTransit = createReqTransit<User>('currentUser');
+
+// In middleware
+const authMiddleware = (req, res, next) => {
+  const user = verifyToken(req.headers.authorization);
+  userTransit.inject(req, user);
+  next();
+};
+
+// In processResponseData or exitMiddleware
+honey.getById({
+  resource: 'posts',
+  fields: ['id', 'title'],
+  middleware: [authMiddleware],
+  processResponseData: (data, req) => {
+    const user = userTransit.extract(req, null);
+    return { ...data, viewedBy: user?.name };
+  }
+});
+```
+
 ## Error Handling
 
 HoneyJS provides a consistent error handling mechanism:
@@ -501,6 +717,16 @@ honey.create({
 });
 ```
 
+`validateRequestData` accepts the following arguments:
+
+```typescript
+validateRequestData(
+  schema,     // Joi ObjectSchema
+  location?,  // 'body' | 'params' | 'query' | 'headers' | 'cookies' (default: 'body')
+  options?    // Joi ValidationOptions (default: { allowUnknown: true })
+)
+```
+
 ### Custom Middleware
 
 ```typescript
@@ -776,6 +1002,26 @@ honey.create({
 });
 ```
 
+### `ExitMiddleware`
+
+`ExitMiddleware` is middleware that runs after the response has been sent. It receives the response data as its first argument, making it ideal for audit logging, analytics, or post-response side effects.
+
+```typescript
+import { ExitMiddleware } from '@promind/honey';
+
+const auditMiddleware: ExitMiddleware = (data, req, res, next) => {
+  console.log(`Response sent for ${req.method} ${req.path}:`, data);
+  next();
+};
+
+honey.create({
+  resource: 'users',
+  params: { name: 'string', email: 'string' },
+  message: 'User created',
+  exitMiddleware: [auditMiddleware]
+});
+```
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promind/honey",
-  "version": "1.47.0",
+  "version": "1.47.13",
   "description": "An expressJS based library for simplifying the development of CRUD APIs using Postgres",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -85,4 +85,4 @@
     "yamljs": "^0.3.0"
   },
   "packageManager": "yarn@4.9.4"
-}
+}

package/CHANGELOG.md

@@ -1,749 +0,0 @@
-# @promind/honey
-
-## 1.47.0
-
-### Minor Changes
-
-- 00ed488: add optional shouldErrorOnNotFound flag for GET operations
-
-## 1.46.3
-
-### Patch Changes
-
-- Patch
-
-## 1.46.2
-
-### Patch Changes
-
-- Patch
-
-## 1.46.1
-
-### Patch Changes
-
-- Patch
-
-## 1.46.0
-
-### Minor Changes
-
-- 6889afa: Add request transit utility for Express requests and upgrade TypeScript to 5.8.3.
-
-## 1.45.1
-
-### Patch Changes
-
-- Patch
-
-## 1.44.2
-
-### Patch Changes
-
-- Patch
-
-## 1.44.1
-
-### Patch Changes
-
-- Patch
-
-## 1.44.0
-
-### Minor Changes
-
-- f827d97: Add `doNothingOnConflict` option for upsert operations to prevent updates on conflict.
-
-## 1.43.0
-
-### Minor Changes
-
-- 15f6363: Add `isInsert` property to the request object, populated by the upsert controller based on the database's `xmax` value to indicate if a row was inserted.
-
-## 1.42.0
-
-### Minor Changes
-
-- 4c3bad9: add support for in/not-in filters using csv
-
-## 1.41.3
-
-### Patch Changes
-
-- Patch
-
-## 1.41.2
-
-### Patch Changes
-
-- afe3d4e: remove async support from query function
-
-## 1.41.1
-
-### Patch Changes
-
-- 2c30339: Remove unnecessary Promise.resolve around the query function call
-
-## 1.41.0
-
-### Minor Changes
-
-- 8f82e82: support async query functions in queryController
-
-## 1.40.0
-
-### Minor Changes
-
-- 2a73ea2: Update the `upsertByIdController` and `upsertController` to handle the response data correctly by accessing the first element of the result. This change ensures proper data formatting in the response.
-
-## 1.39.1
-
-### Patch Changes
-
-- Patch
-
-## 1.39.0
-
-### Minor Changes
-
-- dec4f79: introduce joins and custom queries
-
-## 1.38.8
-
-### Patch Changes
-
-- Patch
-
-## 1.38.7
-
-### Patch Changes
-
-- Patch
-
-## 1.38.6
-
-### Patch Changes
-
-- Patch
-
-## 1.38.5
-
-### Patch Changes
-
-- Patch
-
-## 1.38.4
-
-### Patch Changes
-
-- Patch
-
-## 1.38.2
-
-### Patch Changes
-
-- Patch
-
-## 1.38.1
-
-### Patch Changes
-
-- Patch
-
-## 1.38.0
-
-### Minor Changes
-
-- a896341: add standalone delete route
-
-## 1.37.0
-
-### Minor Changes
-
-- 660aadb: add support for filter param retrieval location and filter override value callback
-
-## 1.36.2
-
-### Patch Changes
-
-- Patch
-
-## 1.36.1
-
-### Patch Changes
-
-- Patch
-
-## 1.36.0
-
-### Minor Changes
-
-- 7038522: allow all sequelize options for raw query
-
-## 1.35.0
-
-### Minor Changes
-
-- ec2733c: add support for method override
-
-## 1.34.5
-
-### Patch Changes
-
-- Patch
-
-## 1.34.4
-
-### Patch Changes
-
-- Patch
-
-## 1.34.3
-
-### Patch Changes
-
-- Patch
-
-## 1.34.2
-
-### Patch Changes
-
-- Patch
-
-## 1.34.1
-
-### Patch Changes
-
-- Patch
-
-## 1.34.0
-
-### Minor Changes
-
-- a4273b9: switch to knex for query building
-
-## 1.33.4
-
-### Patch Changes
-
-- Patch
-
-## 1.33.3
-
-### Patch Changes
-
-- Patch
-
-## 1.33.2
-
-### Patch Changes
-
-- Patch
-
-## 1.33.1
-
-### Patch Changes
-
-- Patch
-
-## 1.33.0
-
-### Minor Changes
-
-- 84686ff: add support for override values in filters
-
-## 1.32.1
-
-### Patch Changes
-
-- Patch
-
-## 1.32.0
-
-### Minor Changes
-
-- f788ffb: add support for additional filter query to getbyid
-
-## 1.31.0
-
-### Minor Changes
-
-- 01fe775: add support for additional filter query to updatebyid
-
-## 1.30.1
-
-### Patch Changes
-
-- Patch
-
-## 1.30.0
-
-### Minor Changes
-
-- e3a1bde: add support for additional filter query to deletion resource
-
-## 1.29.0
-
-### Minor Changes
-
-- eafc865: add request data validation
-
-## 1.28.2
-
-### Patch Changes
-
-- Patch
-
-## 1.28.1
-
-### Patch Changes
-
-- Patch
-
-## 1.28.0
-
-### Minor Changes
-
-- 35be0f6: add error response processing function
-
-## 1.27.3
-
-### Patch Changes
-
-- Patch
-
-## 1.27.2
-
-### Patch Changes
-
-- Patch
-
-## 1.27.1
-
-### Patch Changes
-
-- Patch
-
-## 1.27.0
-
-### Minor Changes
-
-- 50d7761: expose more types
-
-## 1.26.0
-
-### Minor Changes
-
-- 183512a: add support for table name override
-
-## 1.25.4
-
-### Patch Changes
-
-- eb1f657: bug fix: remove id from request path for update method
-
-## 1.25.2
-
-### Patch Changes
-
-- Patch
-
-## 1.25.1
-
-### Patch Changes
-
-- Patch
-
-## 1.25.0
-
-### Minor Changes
-
-- 0231e1d: add support for custom id field on delete endpoints
-
-## 1.24.6
-
-### Patch Changes
-
-- Patch
-
-## 1.24.5
-
-### Patch Changes
-
-- 530dbd3: fix misuse of processResponseData
-
-## 1.24.4
-
-### Patch Changes
-
-- Patch
-
-## 1.24.3
-
-### Patch Changes
-
-- Patch
-
-## 1.24.2
-
-### Patch Changes
-
-- Patch
-
-## 1.24.1
-
-### Patch Changes
-
-- Patch
-
-## 1.24.0
-
-### Minor Changes
-
-- 7a4e415: update dependencies
-
-## 1.23.1
-
-### Patch Changes
-
-- Patch
-
-## 1.23.0
-
-### Minor Changes
-
-- 6d54494: add upsert and update controllers
-
-## 1.22.3
-
-### Patch Changes
-
-- 1d537f5: fix issue with upsert
-
-## 1.22.2
-
-### Patch Changes
-
-- Patch
-
-## 1.22.1
-
-### Patch Changes
-
-- Patch
-
-## 1.22.0
-
-### Minor Changes
-
-- d28cd30: add support for upsert
-
-## 1.21.3
-
-### Patch Changes
-
-- 36a36f3: fix unreachable code
-
-## 1.21.2
-
-### Patch Changes
-
-- 9bb4921: fix
-
-## 1.21.1
-
-### Patch Changes
-
-- 1c456d7: make req param in processResponseData compulsory
-
-## 1.21.0
-
-### Minor Changes
-
-- e9ae5d5: add request object to process response data
-
-## 1.20.1
-
-### Patch Changes
-
-- 9b7cead: only log response in non-prod to reduce noise
-
-## 1.20.0
-
-### Minor Changes
-
-- 3fe7e9f: remove duplicate code and specify default exit middleware for logging response
-
-## 1.19.0
-
-### Minor Changes
-
-- 27628ba: add support for response data preprocessing
-
-## 1.18.1
-
-### Patch Changes
-
-- 887a3f3: fix
-
-## 1.18.0
-
-### Minor Changes
-
-- e0bfb0f: add full support for raw routes
-
-## 1.17.2
-
-### Patch Changes
-
-- 821421e: expose express raw only
-
-## 1.17.1
-
-### Patch Changes
-
-- 74b8130: expose express
-
-## 1.17.0
-
-### Minor Changes
-
-- 573a9d1: make update and create params optional
-
-## 1.16.1
-
-### Patch Changes
-
-- f656269: return pagination only when used
-
-## 1.16.0
-
-### Minor Changes
-
-- 449a01b: remove GET filters when not present in query params
-
-## 1.15.6
-
-### Patch Changes
-
-- e2289fa: fix table supporting casing
-
-## 1.15.5
-
-### Patch Changes
-
-- fc2fd51: make get query filter optional
-
-## 1.15.4
-
-### Patch Changes
-
-- 61f6c43: fix json formatting for update queriess
-
-## 1.15.3
-
-### Patch Changes
-
-- 77ec734: fix typescript error
-
-## 1.15.2
-
-### Patch Changes
-
-- cc75e3a: do not format json
-
-## 1.15.1
-
-### Patch Changes
-
-- c870306: do not format json
-
-## 1.15.0
-
-### Minor Changes
-
-- fbfeb34: add support for json datatype
-
-## 1.14.3
-
-### Patch Changes
-
-- ce78005: init model
-
-## 1.14.2
-
-### Patch Changes
-
-- 874e3e0: fix binding in model creator
-
-## 1.14.1
-
-### Patch Changes
-
-- 10bc2ba: bind ModelCreator
-
-## 1.14.0
-
-### Minor Changes
-
-- 3eaaf64: add model creator
-
-## 1.13.5
-
-### Patch Changes
-
-- d8b072d: fix function naming
-
-## 1.13.4
-
-### Patch Changes
-
-- d35cf32: fix
-
-## 1.13.3
-
-### Patch Changes
-
-- 54aa6f7: expose express
-
-## 1.13.2
-
-### Patch Changes
-
-- 30d38f0: add more exposed types
-
-## 1.13.1
-
-### Patch Changes
-
-- bc6b6a9: expose all sequelize types
-
-## 1.13.0
-
-### Minor Changes
-
-- bae12c1: refactor for early init of sequelize
-
-## 1.12.0
-
-### Minor Changes
-
-- e4a0c22: add data override for create response and expose http error utility methods
-
-## 1.11.0
-
-### Minor Changes
-
-- ff95bcf: fix race condition and remove params from setupDB call
-
-## 1.10.2
-
-### Patch Changes
-
-- 5c3e838: fix binding for config export
-
-## 1.10.1
-
-### Patch Changes
-
-- b4bc78d: avoid duplicate db connections
-
-## 1.10.0
-
-### Minor Changes
-
-- 082e063: expose db setup
-
-## 1.9.0
-
-### Minor Changes
-
-- ec2d1ee: change response structure for post requests
-
-## 1.8.2
-
-### Patch Changes
-
-- 3c958a1: make params in db query optional
-
-## 1.8.1
-
-### Patch Changes
-
-- e5f5e1a: make replacements optional in db query util
-
-## 1.8.0
-
-### Minor Changes
-
-- 702bf79: add raw db querying utility
-
-## 1.7.0
-
-### Minor Changes
-
-- 1157337: add id field support to update by id
-
-## 1.6.0
-
-### Minor Changes
-
-- 6dc1c38: add jsdoc for fields and fix middleware return type
-
-## 1.5.5
-
-### Patch Changes
-
-- ef81f03: remove duplicate middleware declaration
-
-## 1.5.4
-
-### Patch Changes
-
-- 8f255d8: grant write permission to GH action
-- 8cb3cd5: fix GH Actions
-- 8bf547b: fix GH actions
-- 794d0bd: fix GH action
-- d1e2482: extend middleware interface to support data param
-
-## 1.5.0
-
-### Minor Changes
-
-- return id on data creation requests
-
-## 1.4.1
-
-### Patch Changes
-
-- specify exit middleware type
-
-## 1.4.0
-
-### Minor Changes
-
-- add support for exit Middleware
-
-## 1.3.3
-
-### Patch Changes
-
-- fix routePrefix declaration
-
-## 1.3.2
-
-### Patch Changes
-
-- change metadata interface for createHoney to include routePrefix
-
-## 1.3.1
-
-### Patch Changes
-
-- refactor path prefixing moving default api prefix to the root level
-
-## 1.3.0
-
-### Minor Changes
-
-- add the ability to override paths