stabilize-orm 1.0.5 → 1.0.7

package/README.md

@@ -1,9 +1,52 @@
 # Stabilize ORM
 
-A lightweight, type-safe ORM for Bun.js, supporting SQLite, MySQL, PostgreSQL, and Redis caching.
+Stabilize is a lightweight, retry-aware ORM built on Bun's native SQL API. It provides a unified interface for SQLite, MySQL, and PostgreSQL with features like connection pooling, automatic retries, transactions, savepoints, and logging. It's designed for simplicity, performance, and stability in Bun applications.
+
+## Features
+
+- **Unified API**: Works seamlessly with SQLite, MySQL, and PostgreSQL via Bun SQL.
+- **Retry Logic**: Automatic exponential backoff retries for queries and transactions.
+- **Connection Management**: Pooling, switching connections, and metrics.
+- **Transactions & Savepoints**: Built-in support with retry handling.
+- **Prepared Statements**: Cached for SQLite to improve performance.
+- **Logging**: Pluggable logger (default: ConsoleLogger).
+- **Error Handling**: Custom `StabilizeError` with database-specific codes.
+- **CLI**: Simple command-line tool for database operations (e.g., migrations, queries).
 
 ## Installation
 
+Stabilize requires Bun (v1.0+).
+
 ```bash
-bun add stabilize
+# Install via bun 
+bun add stabilize-orm
 ```
+## Usage
+
+```bash 
+# Imports
+import { DBClient } from 'stabilize-orm/src/client';
+import { DBConfig } from 'stabilize-orm/src/types';
+
+const config: DBConfig = {
+  type: 'sqlite', // or 'mysql', 'postgres'
+  connectionString: 'myapp.db',
+  poolSize: 10,
+  retryAttempts: 3,
+};
+
+const db = new DBClient(config);
+
+async function run() {
+  const users = await db.query<{ id: number; name: string }>('SELECT * FROM users');
+  console.log(users);
+
+  await db.transaction(async () => {
+    await db.query('INSERT INTO users (name) VALUES (?)', ['Alice']);
+  });
+
+  await db.close();
+}
+
+run();
+```

package/package.json

@@ -1,16 +1,28 @@
 {
   "name": "stabilize-orm",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "A lightweight, type-safe ORM for Bun.js with support for SQLite, MySQL, PostgreSQL, and Redis caching",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "bin": {
     "stabilize": "./dist/cli/stabilize-cli.js"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
     "build": "bun build src/index.ts --outdir dist --target bun --minify && bun build cli/stabilize-cli.ts --outdir dist/cli --target bun --minify",
-    
     "prepublishOnly": "bun run build && bun run test",
+    "build:exe": "bun build cli/stabilize-cli.ts --compile --outfile dist/stabilize-cli --target bun",
     "format": "bunx prettier --write .",
     "lint": "eslint src tests cli examples",
     "cli": "bun run cli/stabilize-cli.ts"
@@ -28,19 +40,20 @@
   "author": "th3b0tk1ill3r <lwazicd@icloud.com>",
   "license": "MIT",
   "dependencies": {
-    "ioredis": "^5.4.1",
-    "reflect-metadata": "^0.2.2",
     "commander": "^12.1.0",
-    "glob": "^11.0.0"
+    "figlet": "^1.9.3",
+    "glob": "^11.0.0",
+    "ioredis": "^5.4.1",
+    "reflect-metadata": "^0.2.2"
   },
   "devDependencies": {
-    "vitest": "^2.1.3",
+    "@typescript-eslint/eslint-plugin": "^8.7.0",
+    "@typescript-eslint/parser": "^8.7.0",
     "@vitest/coverage-v8": "^2.1.3",
-    "typescript": "^5.6.3",
-    "prettier": "^3.3.3",
     "eslint": "^9.12.0",
-    "@typescript-eslint/parser": "^8.7.0",
-    "@typescript-eslint/eslint-plugin": "^8.7.0"
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.3",
+    "vitest": "^2.1.3"
   },
   "repository": {
     "type": "git",

package/.eslintrc.json

@@ -1,10 +0,0 @@
-{
-  "env": { "node": true },
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint"],
-  "extends": ["plugin:@typescript-eslint/recommended"],
-  "rules": {
-    "no-unused-vars": "off",
-    "@typescript-eslint/no-unused-vars": "error"
-  }
-}

package/.github/workflows/ci-cd.yml

@@ -1,73 +0,0 @@
-name: CI/CD Pipeline for Stabilize ORM
-
-on:
-  push:
-    branches:
-      - main
-    tags:
-      - "v*.*.*"
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    services:
-      redis:
-        image: redis:latest
-        ports:
-          - 6379:6379
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Setup Bun
-        uses: oven-sh/setup-bun@v2
-        with:
-          bun-version: "latest"
-      - name: Install dependencies
-        run: bun install
-      - name: Check formatting
-        run: bunx prettier --check .
-      - name: Lint code
-        run: bun run lint
-      - name: Run tests
-        run: bun run test
-        env:
-          REDIS_URL: redis://localhost:6379
-      - name: Build project
-        run: bun run build
-      - name: Test CLI
-        run: |
-          bun run dist/cli/stabilize-cli.js generate model TestModel
-          bun run dist/cli/stabilize-cli.js generate seed TestSeed
-          bun run dist/cli/stabilize-cli.js seed -c examples/config/database.ts
-      - name: Upload coverage
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-
-  publish:
-    needs: test
-    runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Setup Bun
-        uses: oven-sh/setup-bun@v2
-        with:
-          bun-version: "latest"
-      - name: Install dependencies
-        run: bun install
-      - name: Build project
-        run: bun run build
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20"
-          registry-url: "https://registry.npmjs.org"
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}