breadfruit 2.2.1 → 3.0.1

package/README.md

@@ -1,49 +1,107 @@
 # breadfruit
 
-[![NPM](https://nodei.co/npm/breadfruit.png?compact=true)](https://nodei.co/npm/breadfruit/)
+[![npm version](https://img.shields.io/npm/v/breadfruit.svg)](https://www.npmjs.com/package/breadfruit)
+[![CI](https://github.com/iceddev/breadfruit/actions/workflows/ci.yml/badge.svg)](https://github.com/iceddev/breadfruit/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/iceddev/breadfruit/branch/main/graph/badge.svg)](https://codecov.io/gh/iceddev/breadfruit)
+[![node](https://img.shields.io/node/v/breadfruit.svg)](https://nodejs.org)
+[![npm downloads](https://img.shields.io/npm/dm/breadfruit.svg)](https://www.npmjs.com/package/breadfruit)
+[![license](https://img.shields.io/npm/l/breadfruit.svg)](https://github.com/iceddev/breadfruit/blob/main/LICENSE)
 
-Not really bread. Not really fruit. Just like this package.  Some simple helpers on top of knex.
+Not really bread. Not really fruit. Just like this package. Simple CRUD helpers on top of [knex](https://knexjs.org/).
 
 ![breadfruit](happy_breadfruit.png)
 
-## create an instance of breadfruit
+## Install
+
+```sh
+npm install breadfruit
+```
+
+Requires Node.js `>=20`.
+
+## Usage
+
+Breadfruit is an ES module with a default export.
+
+```js
+import breadfruit from 'breadfruit';
 
-```javascript
 const config = {
-  client: 'postgresql',
+  client: 'pg',
   connection: 'postgres://postgres@localhost:5432/someDatabase',
-  pool: { min: 1, max: 7 }
+  pool: { min: 1, max: 7 },
 };
 
-const bread = require('breadfruit')(config);
+const { browse, read, edit, add, del, raw } = breadfruit(config);
 ```
 
-## Browse, Read, Edit, Add, Delete, Raw
+## API
 
-```javascript
-const {browse, read, edit, add, del, raw} = require('breadfruit')(config);
+### `browse(table, fields, filter, options?)`
 
-//get an array of users, by table, columns, and a filter
-const users = await browse('users', ['username', 'user_id'], {active: true});
+Returns an array of rows.
 
+```js
+const users = await browse('users', ['username', 'user_id'], { active: true });
+```
 
-//get a single user by table, columns, and a filter
-const user = await read('users', ['username', 'first_name'], {user_id: 1337});
+Supported `options`:
+- `limit` (default `1000`)
+- `offset` (default `0`)
+- `orderBy` — column name or array of column names
+- `sortOrder` — `'ASC'` / `'DESC'` (default `'ASC'`), or an array matching `orderBy`
+- `dateField` (default `'created_at'`)
+- `search_start_date` / `search_end_date` — adds a `whereBetween` on `dateField`
+- `dbApi` — override the internal knex instance (useful for transactions)
 
+### `read(table, fields, filter, options?)`
 
-//edit a user by table, returned columns, updated values, and a filter
-const updatedUser = await edit('users', ['username', 'first_name'], {first_name: 'Howard'}, {user_id: 1337});
+Returns a single row.
 
+```js
+const user = await read('users', ['username', 'first_name'], { user_id: 1337 });
+```
 
-//add a new user by table, returned columns, and user data
-const newUser = await add('users', ['user_id'], {first_name: 'Howard', username: 'howitzer'});
+### `add(table, returnFields, data, options?)`
 
+Inserts and returns the new row.
 
-//delete a user by table and a filter
-const deleteCount = await del('users', {user_id: 1337});
+```js
+const newUser = await add('users', ['user_id'], {
+  first_name: 'Howard',
+  username: 'howitzer',
+});
+```
 
+### `edit(table, returnFields, data, filter, options?)`
 
-//perform a raw query
-const rows = await raw('select * from users');
+Updates matching rows and returns the first updated row.
 
+```js
+const updated = await edit(
+  'users',
+  ['username', 'first_name'],
+  { first_name: 'Howard' },
+  { user_id: 1337 },
+);
 ```
+
+### `del(table, filter, options?)`
+
+Deletes matching rows and returns the count.
+
+```js
+const count = await del('users', { user_id: 1337 });
+```
+
+### `raw(sql, options?)`
+
+Runs a raw SQL statement and returns rows.
+
+```js
+const rows = await raw('select * from users');
+```
+
+## License
+
+ISC

package/index.js

@@ -1,89 +1,79 @@
-const knexConstructor = require('knex');
+import knexConstructor from 'knex';
 
-function connect(settings) {
+export default function connect(settings) {
   const knex = knexConstructor(settings);
-  const defaultOptions = {
+  const defaults = {
     dateField: 'created_at',
-    dbApi: knex,
     limit: 1000,
     offset: 0,
     sortOrder: 'ASC',
   };
 
-  return {
-    browse(table, fields, filter, options = {}) {
-      const dbApi = options.dbApi || defaultOptions.dbApi || knex;
-      const limit = options.limit || defaultOptions.limit;
-      const offset = options.offset || defaultOptions.offset;
-      const dateField = options.dateField || defaultOptions.dateField;
-      const sortOrder = options.sortOrder || defaultOptions.sortOrder;
+  function browse(table, fields, filter, options = {}) {
+    const dbApi = options.dbApi || knex;
+    const limit = options.limit ?? defaults.limit;
+    const offset = options.offset ?? defaults.offset;
+    const dateField = options.dateField || defaults.dateField;
+    const sortOrder = options.sortOrder || defaults.sortOrder;
 
-      let query = dbApi(table)
-        .where(filter)
-        .select(fields)
-        .limit(limit)
-        .offset(offset);
+    let query = dbApi(table)
+      .where(filter)
+      .select(fields)
+      .limit(limit)
+      .offset(offset);
 
-      if (options.search_start_date && options.search_end_date) {
-        query = query
-          .whereBetween(dateField, [options.search_start_date, options.search_end_date]);
-      }
-
-      if (options.orderBy) {
-        if(Array.isArray(options.orderBy)) {
-          options.orderBy.forEach((orderBy, index) => {
-            if(Array.isArray(sortOrder)) {
-              return query = query.orderBy(orderBy, sortOrder[index]);
-            }
-            query = query.orderBy(orderBy, sortOrder);
-          });
-        } else {
-          query = query.orderBy(options.orderBy, sortOrder);
-        }
-      }
+    if (options.search_start_date && options.search_end_date) {
+      query = query.whereBetween(dateField, [
+        options.search_start_date,
+        options.search_end_date,
+      ]);
+    }
 
-      return query;
-    },
-    read(table, fields, filter, options = {}) {
-      const dbApi = options.dbApi || knex;
-      return dbApi(table)
-        .where(filter)
-        .select(fields)
-        .then(([row]) => {
-          return row;
+    if (options.orderBy) {
+      if (Array.isArray(options.orderBy)) {
+        options.orderBy.forEach((orderBy, index) => {
+          const order = Array.isArray(sortOrder) ? sortOrder[index] : sortOrder;
+          query = query.orderBy(orderBy, order);
         });
-    },
-    add(table, fields, data, options = {}) {
-      const dbApi = options.dbApi || knex;
-      return dbApi(table)
-        .returning(fields)
-        .insert(data)
-        .then(([row]) => {
-          return row;
-        });
-    },
-    edit(table, fields, data, filter, options = {}) {
-      const dbApi = options.dbApi || knex;
-      return dbApi(table)
-        .where(filter)
-        .returning(fields)
-        .update(data)
-        .then(([row]) => {
-          return row;
-        });
-    },
-    del(table, filter, options = {}) {
-      const dbApi = options.dbApi || knex;
-      return dbApi(table)
-        .where(filter)
-        .del();
-    },
-    raw(sql, options = {}) {
-      const dbApi = options.dbApi || knex;
-      return dbApi.raw(sql, options)
-        .then(res => res.rows || res);
+      } else {
+        query = query.orderBy(options.orderBy, sortOrder);
+      }
     }
-  };
-}
 
-module.exports = connect;
+    return query;
+  }
+
+  async function read(table, fields, filter, options = {}) {
+    const dbApi = options.dbApi || knex;
+    const [row] = await dbApi(table).where(filter).select(fields);
+    return row;
+  }
+
+  async function add(table, fields, data, options = {}) {
+    const dbApi = options.dbApi || knex;
+    const [row] = await dbApi(table).returning(fields).insert(data);
+    return row;
+  }
+
+  async function edit(table, fields, data, filter, options = {}) {
+    const dbApi = options.dbApi || knex;
+    const [row] = await dbApi(table)
+      .where(filter)
+      .returning(fields)
+      .update(data);
+    return row;
+  }
+
+  function del(table, filter, options = {}) {
+    const dbApi = options.dbApi || knex;
+    return dbApi(table).where(filter).del();
+  }
+
+  async function raw(sql, options = {}) {
+    const dbApi = options.dbApi || knex;
+    const res = await dbApi.raw(sql, options);
+    return res.rows || res;
+  }
+
+  return { browse, read, add, edit, del, raw, knex };
+}

package/package.json

@@ -1,10 +1,28 @@
 {
   "name": "breadfruit",
-  "version": "2.2.1",
-  "description": "Boilerplate sql query system for Node.js using Knex",
-  "main": "index.js",
+  "version": "3.0.1",
+  "description": "Boilerplate SQL query helpers for Node.js using Knex",
+  "type": "module",
+  "main": "./index.js",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
   "scripts": {
-    "test": "nyc --reporter=lcov --reporter=text-summary mocha"
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test": "node --test",
+    "test:coverage": "c8 --reporter=text --reporter=lcov node --test",
+    "prepublishOnly": "npm run lint && npm test"
   },
   "author": "Alyson Zepeda",
   "license": "ISC",
@@ -14,14 +32,26 @@
   "homepage": "https://github.com/iceddev/breadfruit#readme",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/iceddev/breadfruit.git"
+    "url": "git+https://github.com/iceddev/breadfruit.git"
   },
+  "keywords": [
+    "knex",
+    "sql",
+    "crud",
+    "postgres",
+    "mysql",
+    "database"
+  ],
   "dependencies": {
-    "knex": "^0.21.5"
+    "knex": "^3.2.0"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "mocha": "^8.1.3",
-    "nyc": "^15.1.0"
+    "@eslint/js": "^10.0.1",
+    "c8": "^11.0.0",
+    "eslint": "^10.2.0",
+    "globals": "^17.5.0"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package/.coveralls.yml

@@ -1,2 +0,0 @@
-service_name: travis-pro
-repo_token: 

package/.travis.yml

@@ -1,4 +0,0 @@
-language: node_js
-node_js:
-  - '6'
-after_success: 'npm run coveralls'

package/test/index.js

@@ -1,95 +0,0 @@
-'use strict';
-
-var chai = require('chai');
-
-
-var expect = chai.expect;
-chai.should();
-
-var breadfruit = require('../');
-
-describe('breadfruit', function(){
-
-  it('be awesome', function(done){
-    done();
-  });
-
-  it('should create an instance of the api', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.should.be.an('object');
-    done();
-  });
-
-  it('should fail to browse without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.browse('tableName', [], {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to browse without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.browse('tableName', [], {}, {orderBy: 'someColumn'})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to browse without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.browse('tableName', [], {}, {orderBy: ['someColumn', 'otherColumn']})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to browse without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.browse('tableName', [], {}, {orderBy: ['someColumn', 'otherColumn'], sortOrder: ['asc', 'desc']})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to read without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.read('tableName', [], {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to add without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.add('tableName', [], {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to edit without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.edit('tableName', [], {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to delete without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.del('tableName', [], {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-  it('should fail to do raw query without a real connection', function(done) {
-    const api = breadfruit({client: 'pg'});
-    api.raw('select NOW()', {})
-      .catch((error) => {
-        done();
-      });
-  });
-
-});