stabilize-orm 1.1.1 → 1.1.3

package/.github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+# Pull Request
+
+## Description
+
+Please include a summary of the change and which issue is fixed. List any dependencies required for this change.
+
+## Type of change
+
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Breaking change
+- [ ] Documentation update
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my code
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Related issues
+
+Closes #[issue-number]

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+labels: bug
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. macOS, Linux, Windows]
+ - Bun version
+ - Stabilize ORM version
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+labels: enhancement
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is.
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

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

@@ -1,23 +1,16 @@
-name: CI/CD Pipeline for Stabilize ORM
+name: Stabilize ORM CI
 
 on:
   push:
     branches:
       - main
-    tags:
-      - "v*.*.*"
   pull_request:
     branches:
       - main
 
 jobs:
-  test:
+  simple-test:
     runs-on: ubuntu-latest
-    services:
-      redis:
-        image: redis:latest
-        ports:
-          - 6379:6379
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -25,49 +18,5 @@ jobs:
         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 }}
+      - name: Install dependencies (bun install)
+        run: bun install

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.1.2] - 2025-10-14
+
+### Added
+- Improved repository QueryBuilder with chainable joins, advanced where clauses, and cache support.
+- Added support for model decorators and repository pattern.
+- New CLI features for migrations, seeds, rollback, and status.
+- Security, funding, conduct, and contributing markdowns.
+- More expressive README and docs.
+
+### Changed
+- Updated ORM configuration examples.
+- Enhanced documentation for open source best practices.
+
+### Fixed
+- Various bug fixes for connection handling and retry logic.
+
+## [Unreleased]
+
+- Further features and improvements coming soon.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,87 @@
+# 📝 Contributor Covenant Code of Conduct
+
+## 💚 Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+---
+
+## 🌟 Our Standards
+
+**Positive behaviors include:**
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+**Unacceptable behaviors include:**
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others’ private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+---
+
+## 🛡️ Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+---
+
+## 🌍 Scope
+
+This Code of Conduct applies within all community spaces and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+---
+
+## 📣 Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at **lwazicd@icloud.com**.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+---
+
+## ⚖️ Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+- **Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+- **Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. May include a public apology.
+
+### 2. Warning
+
+- **Community Impact:** A violation through a single incident or series of actions.
+- **Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+- **Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
+- **Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+- **Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+- **Consequence:** A permanent ban from any sort of public interaction within the community.
+
+---
+
+## 📜 Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at  
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).  
+Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
+
+---

package/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# 🤝 Contributing to Stabilize ORM
+
+Thank you for your interest in making Stabilize ORM even better! Your ideas, code, and feedback help drive this project forward.
+
+---
+
+## 🚀 How to Contribute
+
+1. **Fork the Repository:**  
+   Click "Fork" to make your own copy.
+2. **Create Your Branch:**  
+   Branch off `main` for your feature or fix.
+3. **Write Code:**  
+   - Use TypeScript.
+   - Follow established formatting and naming conventions.
+4. **Test Your Changes:**  
+   Ensure your code passes all tests.
+5. **Update Documentation:**  
+   If you change APIs, update the docs and README.
+6. **Open a Pull Request:**  
+   - Fill out the PR template.
+   - Describe your changes clearly.
+
+---
+
+## 💡 Code Style
+
+- **Language:** TypeScript only
+- **Formatting:** Use project conventions (Prettier, ESLint, etc.)
+- **Naming:** Be descriptive and consistent
+
+---
+
+## 🐞 Reporting Issues
+
+- For bugs, use the [Bug Report Issue Template](.github/ISSUE_TEMPLATE/bug_report.md).
+- For feature ideas, use the [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md).
+
+If in doubt, ask or open a discussion!
+
+---
+
+## 🙏 Thank You
+
+Your contributions make Stabilize ORM stable, expressive, and truly open source.  
+Happy coding!
+
+---

package/FUNDING.md

@@ -0,0 +1,14 @@
+# ❤️ Support Stabilize ORM
+
+If you love Stabilize ORM and want to help it grow, you can support ongoing development in a few ways:
+
+- **GitHub Sponsors:**  
+  [Sponsor ElectronSz on GitHub](https://github.com/sponsors/ElectronSz)
+
+- **Patreon:**  
+  [Become a Patron](https://patreon.com/ElectronSz)
+
+- **Ko-fi:**  
+  [Buy ElectronSz a coffee](https://ko-fi.com/ElectronSz)
+
+Your support helps with maintenance, new features, and keeping Stabilize ORM open source for everyone. Thank you! 🙏

package/README.md

@@ -1,52 +1,293 @@
 # Stabilize ORM
 
-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.
+_Stable, Fast, and Expressive ORM for Bun_
 
-## 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).
+**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 connection pooling, automatic retries, transactions, savepoints, and robust logging. Designed for simplicity, performance, and reliability in Bun applications.
 
-## Installation
+---
+
+## 🚀 Features
+
+- **Unified API**: Supports SQLite, MySQL, and PostgreSQL
+- **Retry Logic**: Automatic exponential backoff for queries & transactions
+- **Connection Management**: Pooling, connection switching, live metrics
+- **Transactions & Savepoints**: Built-in support with retry handling
+- **Prepared Statements**: Cached for SQLite to maximize performance
+- **Pluggable Logging**: Default ConsoleLogger, extensible for files or services
+- **Custom Errors**: `StabilizeError` with clear, database-specific codes
+- **CLI Tool**: Migrate, seed, and query from the command line
+- **Model & Repository Pattern**: Clean, scalable code with decorators
+- **Relationships & Joins**: Model relationships and flexible SQL joins
+
+---
+
+## 📦 Installation
 
 Stabilize requires Bun (v1.0+).
 
 ```bash
-# Install via bun 
 bun add stabilize-orm
 ```
-## Usage
 
-```bash 
-# Imports
-import { DBClient } from 'stabilize-orm/src/client';
-import { DBConfig } from 'stabilize-orm/src/types';
+---
+
+## 📃 Documentation & Community
 
-const config: DBConfig = {
-  type: 'sqlite', // or 'mysql', 'postgres'
-  connectionString: 'myapp.db',
-  poolSize: 10,
-  retryAttempts: 3,
+- [Changelog](./CHANGELOG.md)
+- [License](./LICENSE.md)
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+- [Contributing Guide](./CONTRIBUTING.md)
+- [Security Policy](./SECURITY.md)
+- [Support](./SUPPORT.md)
+- [Funding](./FUNDING.md)
+
+---
+
+## ⚙️ ORM Configuration
+
+```typescript
+// config/database.ts
+import { DBType, Stabilize, type CacheConfig, type DBConfig } from "stabilize-orm";
+
+export const dbConfig: DBConfig = {
+  type: DBType.Postgres, // or DBType.SQLite, DBType.MySQL
+  connectionString: process.env.DB_CONNECTION_STRING || "postgres://admin:P@ssw0rd@localhost:5432/db",
+  poolSize: Number(process.env.DB_POOL_SIZE) || 10,
+  retryAttempts: Number(process.env.DB_RETRY_ATTEMPTS) || 3,
+  retryDelay: Number(process.env.DB_RETRY_DELAY) || 1000,
+  maxJitter: Number(process.env.DB_MAX_JITTER) || 100,
 };
 
-const db = new DBClient(config);
+export const cacheConfig: CacheConfig = {
+  enabled: process.env.CACHE_ENABLED === "true",
+  ttl: Number(process.env.CACHE_TTL) || 60,
+  redisUrl: process.env.REDIS_URL || "redis://localhost:6379",
+};
+
+export const orm = new Stabilize(dbConfig, cacheConfig);
+```
+
+---
+
+## 🏗️ Models, Relationships & Repositories
+
+Define models with decorators, express relationships, and interact using repositories:
+
+```typescript
+// models/User.ts
+import "reflect-metadata";
+import { Model, Column, Required } from "stabilize-orm";
+
+@Model("users")
+export class User {
+  @Column("id", "TEXT") @Required()
+  id: string = crypto.randomUUID();
+
+  @Column("name", "TEXT") @Required()
+  name?: string;
+
+  @Column("email", "TEXT") @Required()
+  email?: string;
+
+  @Column("active", "BOOLEAN") @Required()
+  active?: boolean;
+}
+```
+
+```typescript
+// models/Role.ts
+import "reflect-metadata";
+import { Model, Column, Required } from "stabilize-orm";
+
+@Model("roles")
+export class Role {
+  @Column("id", "TEXT") @Required()
+  id: string = crypto.randomUUID();
+
+  @Column("name", "TEXT") @Required()
+  name?: string;
+}
+```
+
+```typescript
+// models/UserRole.ts
+import "reflect-metadata";
+import { Model, Column, Required, ManyToOne } from "stabilize-orm";
+import { User } from "./User";
+import { Role } from "./Role";
+
+@Model("userroles")
+export class UserRole {
+  @Column("id", "TEXT") @Required()
+  id: string = crypto.randomUUID();
+
+  @Column("user_id", "TEXT") @Required()
+  user_id!: string;
+
+  @Column("role_id", "TEXT") @Required()
+  role_id!: string;
+
+  // Relationships
+  @ManyToOne(() => User, "user_id")
+  user?: User;
+
+  @ManyToOne(() => Role, "role_id")
+  role?: Role;
+}
+```
+
+```typescript
+// repository/userRepository.ts
+import { orm } from "../config/database";
+import { User } from "../models/User";
+export const userRepository = orm.getRepository(User);
+```
+
+---
 
-async function run() {
-  const users = await db.query<{ id: number; name: string }>('SELECT * FROM users');
-  console.log(users);
+## 🔀 Table Joins & Relationships
 
-  await db.transaction(async () => {
-    await db.query('INSERT INTO users (name) VALUES (?)', ['Alice']);
-  });
+Stabilize ORM supports relationships and flexible SQL joins to help you write advanced queries.
 
-  await db.close();
+**Relationship Decorators Example:**
+
+```typescript
+@Model("user_roles")
+export class UserRole {
+  // ...columns...
+  @ManyToOne(() => User, "user_id")
+  user?: User;
+  @ManyToOne(() => Role, "role_id")
+  role?: Role;
 }
+```
+
+**Join Example:**
+
+```typescript
+const adminUsers = await orm.getRepository(UserRole)
+  .find()
+  .join("users", "user_roles.user_id = users.id")
+  .join("roles", "use_rroles.role_id = roles.id")
+  .select("users.id", "users.name", "roles.name AS role")
+  .where("roles.name = ?", "Admin")
+  .orderBy("users.name ASC")
+  .execute(orm["client"]);
+```
+- Use `.join(table, condition)` to add joins, then combine with `.select`, `.where`, `.orderBy`, etc.
+
+---
+
+## 🧑‍💻 Query Builder
+
+The repository `.find()` method returns a chainable query builder:
+
+```typescript
+const qb = userRepository.find()
+  .where("active = ?", true)
+  .orderBy("created_at DESC")
+  .limit(10)
+  .offset(20)
+  .select("id", "name", "email");
+
+const { query, params } = qb.build();
+console.log(query, params);
+
+const users = await qb.execute(orm["client"]);
+```
+
+**API:**
+
+```typescript
+{
+  select(...fields: string[]): QueryBuilder<User>;
+  where(condition: string, ...params: any[]): QueryBuilder<User>;
+  join(table: string, condition: string): QueryBuilder<User>;
+  orderBy(clause: string): QueryBuilder<User>;
+  limit(limit: number): QueryBuilder<User>;
+  offset(offset: number): QueryBuilder<User>;
+  build(): { query: string; params: any[] };
+  execute(client: DBClient, cache?: Cache, cacheKey?: string): Promise<User[]>;
+}
+```
+
+---
+
+## 📚 More Usage Examples
+
+```typescript
+// Get all users
+export const getAll = async () => userRepository.find().execute(orm["client"]);
+
+// Get active users, ordered by name
+export const getActiveUsers = async () =>
+  userRepository.find().where("active = ?", true).orderBy("name ASC").execute(orm["client"]);
+
+// Paginated query
+export const getPaginatedUsers = async (limit: number, offset: number) =>
+  userRepository.find().orderBy("created_at DESC").limit(limit).offset(offset).execute(orm["client"]);
+```
+
+---
+
+## 🌐 ExpressJS Integration
+
+```typescript
+import express from "express";
+import { userRepository } from "./repository/userRepository";
+import { orm } from "./config/database";
+
+const app = express();
+app.use(express.json());
+
+app.get("/users", async (req, res) => {
+  try {
+    const users = await userRepository.find().execute(orm["client"]);
+    res.json(users);
+  } catch {
+    res.status(500).json({ error: "Failed to fetch users." });
+  }
+});
+
+app.get("/users/active", async (req, res) => {
+  try {
+    const users = await userRepository.find()
+      .where("active = ?", true)
+      .orderBy("name ASC")
+      .execute(orm["client"]);
+    res.json(users);
+  } catch {
+    res.status(500).json({ error: "Failed to fetch active users." });
+  }
+});
+
+app.post("/users", async (req, res) => {
+  try {
+    const user = await userRepository.create(req.body);
+    res.status(201).json(user);
+  } catch {
+    res.status(500).json({ error: "User creation failed." });
+  }
+});
+
+app.listen(3000, () => {
+  console.log("Express server listening on port 3000");
+});
+```
+
+---
+
+
+## 📑 License
+
+See [LICENSE.md](./LICENSE.md)
+
+---
+
+<div align="center">
+
+Created with ❤️ in Eswatini by ElectronSz
 
-run();
-```
+</div>

package/SECURITY.md

@@ -0,0 +1,35 @@
+# 🛡️ Security Policy
+
+## Supported Versions
+
+We encourage responsible disclosure of security vulnerabilities for all actively maintained versions of Stabilize ORM.
+
+| Version      | Supported         |
+|--------------|------------------|
+| Latest (main)| ✅ Yes            |
+| Older (< 6mo)| ✅ Yes            |
+| Unmaintained | ❌ No             |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please **do not disclose it publicly**.
+
+### Secure Reporting Steps
+
+1. **Email:**  
+   Contact ElectronSz directly at [lwazicd@icloud.com](mailto:lwazicd@icloud.com) with full details.
+
+2. **GitHub Security Advisory:**  
+   Alternatively, open a [GitHub security advisory](https://github.com/ElectronSz/stabilize-orm/security/advisories) (private by default).
+
+3. **Wait for Response:**  
+   Please allow up to 72 hours for a first response. We may request more details or verification.
+
+4. **Coordinated Disclosure:**  
+   We will work with you to verify, patch, and coordinate public disclosure.
+
+---
+
+> **Please do NOT post vulnerabilities in GitHub issues, discussions, or any public forum until a fix is released.**
+
+Thank you for helping keep Stabilize ORM and its users safe!