d1mapper/README.md

A simple ORM-like wrapper for Cloudflare D1 databases in TypeScript

# d1mapper

A simple ORM-like wrapper for Cloudflare D1 databases in TypeScript.

## Defining your schema

First, declare a TypeScript interface for your table, listing all columns and their types:

```ts
interface UserRow {
  id: number;
  name: string;
  age?: number;      // optional column
  bio?: string;      // optional column
}
```

## Installation

```bash
npm install d1mapper
```

## Usage

```ts
import { Database } from 'd1mapper';
import { D1Database } from '@cloudflare/workers-types';

// instantiate with your full schema type
const db = new Database<UserRow>({
  db: env.D1,             // from your worker environment
  tableName: 'users',
  primaryKeyName: 'id',   // required
  // you can omit defaultProperties to let D1 use column defaults
  // or supply only those you want:
  defaultProperties: { name: 'Anonymous' },
});

// insert a record (only provided fields are saved)
await db.insert({ id: 1, name: 'Alice' });

// find one
const user = await db.findOne(['id', 'name', 'age'], 'id', 1);

// update
await db.update({ score: 10 }, 'id', 1);

// increment
await db.increment('score', 5, 'id', 1);

// exists
const has = await db.exists('id', 1);

// find all records selecting specific columns
const users = await db.findAll(['id', 'name', 'age']);

// find many with filter only
const adults = await db.findMany({ age: 30 });

// find many selecting props and filter
const userNames = await db.findMany(['name'], { age: 30 });

// delete
await db.delete('id', 1);

// find by primary key
const userById = await db.findById(['id', 'name', 'age'], 1);

// update by primary key
await db.updateById({ age: 35 }, 1);

// increment by primary key
await db.incrementById('age', 1, 1);

// exists by primary key
const hasById = await db.existsById(1);

// delete by primary key
await db.deleteById(1);

## API Reference

Types and Properties:

- `DatabaseResult`: Object containing `success` and `changes` properties.
- `Database<T>`: The main class for interacting with the database.
- `this.db`: The D1Database instance.
- `this.tableName`: The name of the table.
- `this.primaryKeyName`: The name of the primary key column.
- `this.defaultProperties`: The default properties for the table.

Here is a summary of the available methods on `Database<T>`:

### insert
- **Signature**: `insert(record: Partial<T>): Promise<DatabaseResult>`
- **Description**: Insert a new record into the table. Merges provided fields with default properties, omitting undefined values.
- **Parameters**:
  - `record`: Partial object containing columns to set.
- **Returns**: `Promise<DatabaseResult>` indicating success and number of changes.

### findOne
- **Signature**: `findOne<K extends keyof T>(props: K | K[], conditionKey: keyof T, conditionValue: T[keyof T]): Promise<(Pick<T, K> | T)| null>`
- **Description**: Retrieve a single record matching the given condition.
- **Parameters**:
  - `props`: Column(s) to select. Pass `[]` to select all columns.
  - `conditionKey`: Column to filter by.
  - `conditionValue`: Value to match.
- **Returns**: A single record object or `null` if not found.

### findAll
- **Signature 1**: `findAll<K extends keyof T>(props: [], paginationOptions?: { limit?: number; offset?: number }): Promise<(Pick<T, K> | T)[]>`
- **Signature 2**: `findAll<K extends keyof T>(props: K | K[], paginationOptions?: { limit?: number; offset?: number }): Promise<(Pick<T, K> | T)[]>`
- **Description**: Fetch all records selecting the specified properties.
- **Parameters**:
  - `props`: Column(s) to select. Pass `[]` to select all columns.
  - `paginationOptions` (optional): Object containing `limit` and `offset` properties for pagination.
- **Returns**: Array of records.

### findMany
- **Signature 1**: `findMany(filter: Partial<T>, paginationOptions?: { limit?: number; offset?: number }): Promise<T[]>`
- **Signature 2**: `findMany<K extends keyof T>(props: K | K[], filter: Partial<T>, paginationOptions?: { limit?: number; offset?: number }): Promise<(Pick<T, K> | T)[]>`
- **Description**: Retrieve records matching the filter. When `props` is provided, only selected columns are returned; otherwise full records are returned.
- **Parameters**:
  - `props` (optional): Column(s) to select. Pass `[]` to select all columns.
  - `filter`: Partial object specifying WHERE clause.
  - `paginationOptions` (optional): Object containing `limit` and `offset` properties for pagination.
- **Returns**: Array of matching records or selected fields.

### update
- **Signature**: `update(record: Partial<T>, conditionKey: keyof T, conditionValue: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Update records that match the condition. No-op if no fields provided.
- **Parameters**:
  - `record`: Partial object of columns to update.
  - `conditionKey`: Column to filter by.
  - `conditionValue`: Value to match.
- **Returns**: `Promise<DatabaseResult>` indicating success and number of changes.

### delete
- **Signature**: `delete(conditionKey: keyof T, conditionValue: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Delete records matching the given condition.
- **Parameters**:
  - `conditionKey`: Column to filter by.
  - `conditionValue`: Value to match.
- **Returns**: `Promise<DatabaseResult>`.

### increment
- **Signature**: `increment(column: keyof T, step: number, conditionKey: keyof T, conditionValue: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Increment a numeric column by a specified amount for matching records.
- **Parameters**:
  - `column`: Column to increment.
  - `step`: Amount to add.
  - `conditionKey`: Column to filter by.
  - `conditionValue`: Value to match.
- **Returns**: `Promise<DatabaseResult>`.

### exists
- **Signature**: `exists(conditionKey: keyof T, conditionValue: T[keyof T]): Promise<boolean>`
- **Description**: Check if a record exists matching the given condition.
- **Parameters**:
  - `conditionKey`: Column to filter by.
  - `conditionValue`: Value to match.
- **Returns**: `Promise<boolean>`.

### findById
- **Signature**: `findById<K extends keyof T>(props: K | K[], id: T[keyof T]): Promise<(Pick<T, K> | T) | null>`
- **Description**: Retrieve a record by its primary key.
- **Parameters**:
  - `props`: Column(s) to select.
  - `id`: Primary key value.
- **Returns**: The matching record or `null`.

### updateById
- **Signature**: `updateById(record: Partial<T>, id: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Update record by its primary key.
- **Parameters**:
  - `record`: Partial properties to update.
  - `id`: Primary key value.
- **Returns**: `Promise<DatabaseResult>`.

### deleteById
- **Signature**: `deleteById(id: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Delete a record by its primary key.
- **Parameters**:
  - `id`: Primary key value.
- **Returns**: `Promise<DatabaseResult>`.

### incrementById
- **Signature**: `incrementById(column: keyof T, step: number, id: T[keyof T]): Promise<DatabaseResult>`
- **Description**: Increment a numeric column by its primary key.
- **Parameters**:
  - `column`: Column to increment.
  - `step`: Amount to add.
  - `id`: Primary key value.
- **Returns**: `Promise<DatabaseResult>`.

### existsById
- **Signature**: `existsById(id: T[keyof T]): Promise<boolean>`
- **Description**: Check if a record exists by its primary key.
- **Parameters**:
  - `id`: Primary key value.
- **Returns**: `Promise<boolean>`.

## Full Cloudflare Worker Example

```ts
import { Database } from 'd1mapper';
import { D1Database } from '@cloudflare/workers-types';

interface UserRow {
  id: number;
  name: string;
  age?: number;
  bio?: string;
}

export default {
  async fetch(request: Request, env: any) {
    const db = new Database<UserRow>({
      db: env.D1,
      tableName: 'users',
      primaryKeyName: 'id'
    });

    // Insert a new user
    await db.insert({ id: 2, name: 'Bob', age: 30 });

    // Get the user
    const bob = await db.findOne(['id', 'name', 'age'], 'id', 2);

    // Update the user
    await db.update({ bio: 'Hello!' }, 'id', 2);

    // List all users
    const allUsers = await db.findAll(['id', 'name', 'age', 'bio']);

    // Delete the user
    await db.delete('id', 2);

    return new Response(JSON.stringify({ bob, allUsers }), {
      headers: { 'Content-Type': 'application/json' }
    });
  }
};
```


## Support this project

<a href="https://paypal.me/ltn119412" target="_blank"><img src="https://raw.githubusercontent.com/trungnghiatn/Downgrade-MAS-Applications/main/Images/buy-me-a-coffee.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>

## License
This project is licensed under the MIT License.