express-mysql-framework

Lightweight TypeScript helper for using Knex with MySQL in Express projects.

Overview

This small library provides a base Model class and a simple Knex db wrapper to make building database-backed models easier in TypeScript + Express apps.

Key features:

• Minimal base Model with a table() helper that returns a Knex query builder.
• Knex configuration driven by environment variables.

Quick start

1. Install dependencies:

npm install

2. Provide environment variables (see .env example below).

3. Type-check only:

npx tsc --noEmit

4. Build:

npm run build

Local .env example

Create a .env file at the project root (not committed to source control):

DB_HOST=127.0.0.1
DB_PORT=3306
DB_USER=root
DB_PASSWORD=secret
DB_NAME=my_database
NODE_ENV=development
DB_POOL_MIN=2
DB_POOL_MAX=10

Usage

Example usage in TypeScript source:

import UserModel from './src/User.mode.js';

const users = new UserModel();
const q = users.table().select('*').limit(10);
// await q to run query in async context

Notes:

• Set protected tableName in model subclasses to match your database table.
• The base Model defaults primaryKey to id.

package.json review (A → Z)

• name: express-mysql-framework — OK for publishing if desired.
• type: module — code uses ES module imports/exports.
• main/module/types: point to ./dist/* — matches compiled output.
• scripts: contains build (tsc) and lifecycle hooks (prepare, prepublishOnly).
• dependencies: dotenv, knex, mysql2 — appropriate for runtime.
• devDependencies: typescript, @types/node recommended and added.
• repository/homepage: update to your repo if different from current value.
• keywords: contains useful tags; duplicates were removed.

Scripts

• build — compile TypeScript into dist using tsc.
• prepare / prepublishOnly — run build steps before publishing.

Add a test script if you introduce tests.

Publishing checklist

• Bump version in package.json for releases.
• Confirm repository, bugs, and homepage point to the correct repository.
• Run npm run build and verify dist contains index.js and .d.ts files.
• Optionally add CI to run npx tsc --noEmit on PRs.

Recommendations

• Install dev types for Node if not already present:

npm install -D @types/node

• Consider adding a small integration test or local script that verifies DB connectivity using your .env settings.

Changes made

• Added comments to src/Model.ts and src/db.ts.
• Fixed src/User.mode.ts to use tableName and set a sensible default.
• Removed duplicate keyword in package.json and added @types/node.

If you want, I can run npm install here to pull dependencies and then run npx tsc --noEmit to re-check types. Which would you like me to do next?