litedbmodel 1.0.1 → 1.1.0

package/docs/api/interfaces/CreatedMiddlewareClass.md

@@ -0,0 +1,110 @@
+[**litedbmodel v1.0.1**](../README.md)
+
+***
+
+[litedbmodel](../globals.md) / CreatedMiddlewareClass
+
+# Interface: CreatedMiddlewareClass\<S\>
+
+Defined in: Middleware.ts:427
+
+Type for the middleware class created by createMiddleware.
+Provides typed access to state via getCurrentContext().
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `S` *extends* `object` | The state object type |
+
+## Constructors
+
+### Constructor
+
+```ts
+new CreatedMiddlewareClass(): Middleware & S;
+```
+
+Defined in: Middleware.ts:437
+
+Constructor
+
+#### Returns
+
+[`Middleware`](../classes/Middleware.md) & `S`
+
+## Methods
+
+### getCurrentContext()
+
+```ts
+getCurrentContext(): S;
+```
+
+Defined in: Middleware.ts:429
+
+Get the current request's state (creates new instance if none exists)
+
+#### Returns
+
+`S`
+
+***
+
+### run()
+
+```ts
+run<R>(fn: () => R): R;
+```
+
+Defined in: Middleware.ts:431
+
+Run a function with a fresh middleware context
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `R` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `fn` | () => `R` |
+
+#### Returns
+
+`R`
+
+***
+
+### hasContext()
+
+```ts
+hasContext(): boolean;
+```
+
+Defined in: Middleware.ts:433
+
+Check if a context exists for the current request
+
+#### Returns
+
+`boolean`
+
+***
+
+### clearContext()
+
+```ts
+clearContext(): void;
+```
+
+Defined in: Middleware.ts:435
+
+Clear the current context (useful for testing)
+
+#### Returns
+
+`void`

package/docs/api/interfaces/DBConfig.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 
@@ -22,4 +22,4 @@ Database configuration
 | <a id="max"></a> `max?` | `number` | Maximum pool size | DBHandler.ts:52 |
 | <a id="timeout"></a> `timeout?` | `number` | Connection timeout in seconds | DBHandler.ts:54 |
 | <a id="querytimeout"></a> `queryTimeout?` | `number` | Query timeout in seconds | DBHandler.ts:56 |
-| <a id="driver"></a> `driver?` | `"postgres"` \| `"sqlite"` \| `"mysql"` | Driver type: 'postgres' (default), 'sqlite', or 'mysql' | DBHandler.ts:58 |
+| <a id="driver"></a> `driver?` | `"postgres"` \| `"mysql"` \| `"sqlite"` | Driver type: 'postgres' (default), 'sqlite', or 'mysql' | DBHandler.ts:58 |

package/docs/api/interfaces/DBConfigOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/DeleteOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/InsertOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 
@@ -24,5 +24,5 @@ Insert options with type-safe column references.
 | <a id="returning"></a> `returning?` | `boolean` | If true, return PkeyResult with affected primary keys. If false (default), return null for better performance. | types.ts:157 |
 | <a id="conflict"></a> ~~`conflict?`~~ | `string` | **Deprecated** Use onConflict instead | types.ts:159 |
 | <a id="onconflict"></a> `onConflict?` | \| [`Column`](Column.md)\<`unknown`, `Model`\> \| [`Column`](Column.md)\<`unknown`, `Model`\>[] | Columns for ON CONFLICT clause (unique constraint columns). Must be Column symbols from the same model for type safety. **Example** `// Single column onConflict: User.email // Multiple columns (composite unique constraint) onConflict: [UserPref.user_id, UserPref.key]` | types.ts:169 |
-| <a id="onconflictupdate"></a> `onConflictUpdate?` | [`Column`](Column.md)\<`unknown`, `Model`\>[] \| `"all"` | Columns to update on conflict. Can be: - 'all': Update all inserted columns - Array of Column symbols from the same model **Example** `// Update all columns onConflictUpdate: 'all' // Update specific columns onConflictUpdate: [User.name, User.updated_at]` | types.ts:181 |
+| <a id="onconflictupdate"></a> `onConflictUpdate?` | `"all"` \| [`Column`](Column.md)\<`unknown`, `Model`\>[] | Columns to update on conflict. Can be: - 'all': Update all inserted columns - Array of Column symbols from the same model **Example** `// Update all columns onConflictUpdate: 'all' // Update specific columns onConflictUpdate: [User.name, User.updated_at]` | types.ts:181 |
 | <a id="onconflictignore"></a> `onConflictIgnore?` | `boolean` | If true, ignore the insert on conflict (DO NOTHING). Cannot be used with onConflictUpdate. | types.ts:186 |

package/docs/api/interfaces/LimitConfig.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/MiddlewareConfig.md

@@ -0,0 +1,40 @@
+[**litedbmodel v1.0.1**](../README.md)
+
+***
+
+[litedbmodel](../globals.md) / MiddlewareConfig
+
+# Interface: MiddlewareConfig\<S\>
+
+Defined in: Middleware.ts:311
+
+Configuration object for createMiddleware.
+All hook functions receive `this` bound to the state object.
+
+Hook signature matches the Middleware class:
+- Method-level hooks: `(model, next, ...args)`
+- execute hook: `(next, sql, params)`
+
+## Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `S` *extends* `object` | `Record`\<`string`, `never`\> | Type of the state object (defaults to empty object) |
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="state"></a> `state?` | `S` | Initial state for each request context. A fresh copy is created for each request via structuredClone. Access via `this` in hook functions or `getCurrentContext()`. | Middleware.ts:317 |
+| <a id="init"></a> `init?` | (`this`: `S`) => `void` | Called when a new context is created | Middleware.ts:320 |
+| <a id="find"></a> `find?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextFind`\<`T`\>, `conditions`: `Conds`, `options?`: [`SelectOptions`](SelectOptions.md)) => `Promise`\<`InstanceType`\<`T`\>[]\> | Intercept find() | Middleware.ts:323 |
+| <a id="findone"></a> `findOne?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextFindOne`\<`T`\>, `conditions`: `Conds`, `options?`: [`SelectOptions`](SelectOptions.md)) => `Promise`\<`InstanceType`\<`T`\> \| `null`\> | Intercept findOne() | Middleware.ts:332 |
+| <a id="findbyid"></a> `findById?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextFindById`\<`T`\>, `id`: `unknown`, `options?`: [`SelectOptions`](SelectOptions.md)) => `Promise`\<`InstanceType`\<`T`\>[]\> | Intercept findById() | Middleware.ts:341 |
+| <a id="count"></a> `count?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextCount`, `conditions`: `Conds`) => `Promise`\<`number`\> | Intercept count() | Middleware.ts:350 |
+| <a id="create"></a> `create?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextCreate`, `pairs`: readonly readonly \[[`Column`](Column.md)\<`any`, `any`\>, `any`\][], `options?`: [`InsertOptions`](InsertOptions.md)\<`unknown`\>) => `Promise`\<[`PkeyResult`](PkeyResult.md) \| `null`\> | Intercept create() | Middleware.ts:358 |
+| <a id="createmany"></a> `createMany?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextCreateMany`, `pairsArray`: readonly readonly readonly \[[`Column`](Column.md)\<`any`, `any`\>, `any`\][][], `options?`: [`InsertOptions`](InsertOptions.md)\<`unknown`\>) => `Promise`\<[`PkeyResult`](PkeyResult.md) \| `null`\> | Intercept createMany() | Middleware.ts:367 |
+| <a id="update"></a> `update?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextUpdate`, `conditions`: `Conds`, `values`: readonly readonly \[[`Column`](Column.md)\<`any`, `any`\>, `any`\][], `options?`: [`UpdateOptions`](UpdateOptions.md)) => `Promise`\<[`PkeyResult`](PkeyResult.md) \| `null`\> | Intercept update() | Middleware.ts:376 |
+| <a id="updatemany"></a> `updateMany?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextUpdateMany`, `records`: readonly readonly readonly \[[`Column`](Column.md)\<`any`, `any`\>, `any`\][][], `options?`: [`UpdateManyOptions`](UpdateManyOptions.md)) => `Promise`\<[`PkeyResult`](PkeyResult.md) \| `null`\> | Intercept updateMany() | Middleware.ts:386 |
+| <a id="delete"></a> `delete?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextDelete`, `conditions`: `Conds`, `options?`: [`DeleteOptions`](DeleteOptions.md)) => `Promise`\<[`PkeyResult`](PkeyResult.md) \| `null`\> | Intercept delete() | Middleware.ts:395 |
+| <a id="execute"></a> `execute?` | (`this`: `S`, `next`: `NextExecute`, `sql`: `string`, `params?`: `unknown`[]) => `Promise`\<`ExecuteResult`\> | Intercept execute() - lowest level, catches ALL SQL queries | Middleware.ts:404 |
+| <a id="query"></a> `query?` | \<`T`\>(`this`: `S`, `model`: `T`, `next`: `NextQuery`\<`T`\>, `sql`: `string`, `params?`: `unknown`[]) => `Promise`\<`InstanceType`\<`T`\>[]\> | Intercept query() - catches raw SQL that returns model instances | Middleware.ts:412 |

package/docs/api/interfaces/ModelOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/PkeyResult.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/SelectOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/SqlCondition.md

@@ -0,0 +1,27 @@
+[**litedbmodel v1.0.1**](../README.md)
+
+***
+
+[litedbmodel](../globals.md) / SqlCondition
+
+# Interface: SqlCondition\<M\>
+
+Defined in: SqlFragment.ts:48
+
+A SQL condition with embedded parameter values.
+Used for Pattern B (value-embedded) conditions and value-free conditions (IS NULL).
+
+## Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `M` | `unknown` | The model type the Column belongs to |
+
+## Properties
+
+| Property | Modifier | Type | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlCondition"` | SqlFragment.ts:49 |
+| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:50 |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:51 |
+| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | SqlFragment.ts:52 |

package/docs/api/interfaces/SqlFragment.md

@@ -0,0 +1,20 @@
+[**litedbmodel v1.0.1**](../README.md)
+
+***
+
+[litedbmodel](../globals.md) / SqlFragment
+
+# Interface: SqlFragment
+
+Defined in: SqlFragment.ts:21
+
+A general SQL fragment with parameterized values.
+Used for withQuery, QUERY, and execute.
+
+## Properties
+
+| Property | Modifier | Type | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlFragment"` | SqlFragment.ts:22 |
+| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:23 |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:24 |

package/docs/api/interfaces/SqlTypedFragment.md

@@ -0,0 +1,29 @@
+[**litedbmodel v1.0.1**](../README.md)
+
+***
+
+[litedbmodel](../globals.md) / SqlTypedFragment
+
+# Interface: SqlTypedFragment\<V, M\>
+
+Defined in: SqlFragment.ts:34
+
+A typed SQL fragment that preserves the Column's value type.
+Used as the first element of a condition tuple (Pattern A).
+
+## Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `V` | `unknown` | The value type of the referenced Column |
+| `M` | `unknown` | The model type the Column belongs to |
+
+## Properties
+
+| Property | Modifier | Type | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="_tag"></a> `_tag` | `readonly` | `"SqlTypedFragment"` | SqlFragment.ts:35 |
+| <a id="sql"></a> `sql` | `readonly` | `string` | SqlFragment.ts:36 |
+| <a id="params"></a> `params` | `readonly` | readonly `unknown`[] | SqlFragment.ts:37 |
+| <a id="__valuetype"></a> `__valueType?` | `readonly` | `V` | SqlFragment.ts:38 |
+| <a id="__modeltype"></a> `__modelType?` | `readonly` | `M` | SqlFragment.ts:39 |

package/docs/api/interfaces/TransactionOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/UpdateManyOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/api/interfaces/UpdateOptions.md

@@ -1,4 +1,4 @@
-[**litedbmodel v0.20.1**](../README.md)
+[**litedbmodel v1.0.1**](../README.md)
 
 ***
 

package/docs/sql-tagged-template.md

@@ -139,14 +139,14 @@ class UserActivityModel extends DBModel {
       ${User.id} AS user_id,
       ${User.name} AS user_name,
       COUNT(${Post.id}) AS total_posts
-    FROM ${User.TABLE_NAME}
-    LEFT JOIN ${Post.TABLE_NAME} ON ${User.id} = ${Post.user_id}
+    FROM ${User}
+    LEFT JOIN ${Post} ON ${User.id} = ${Post.user_id}
     GROUP BY ${User.id}, ${User.name}
   `;
 }
 ```
 
-When only Column references and `TABLE_NAME` objects are interpolated (no runtime values), the `sql` tag embeds them directly in the SQL string with no parameters.
+When only Column references and Model classes are interpolated (no runtime values), the `sql` tag embeds them directly in the SQL string with no parameters.
 
 String `QUERY` is still supported for backward compatibility.
 
@@ -175,7 +175,7 @@ The `sql` tag processes interpolated values according to their type:
 | Interpolated Value | Processing | Example Output |
 |---|---|---|
 | `Column` | Embedded as column name | `age`, `name` |
-| `{ TABLE_NAME }` | Embedded as table name | `users`, `posts` |
+| Model class (`{ TABLE_NAME }`) | Embedded as table name | `users`, `posts` |
 | `sql.raw(str)` | Embedded as raw SQL (no parameterization) | `ASC`, `DISTINCT` |
 | `sql.ref(col)` | Embedded as `table.column` | `users.id` |
 | `parentRef(col)` | Embedded as `table.column` | `users.id` |
@@ -235,7 +235,7 @@ The `sql` tag returns different types based on the interpolated values, enabling
 |---|---|---|
 | Single `Column` only | `SqlTypedFragment<V, M>` | Condition tuple first element, or value-free condition (IS NULL) |
 | Single `Column` + value(s) | `SqlCondition<M>` | Direct condition element (Pattern B) |
-| Multiple Columns / TABLE_NAMEs | `SqlFragment` | `QUERY`, `withQuery`, `execute` |
+| Multiple Columns / Model classes | `SqlFragment` | `QUERY`, `withQuery`, `execute` |
 | Mixed (Columns + values) | `SqlFragment` | `withQuery`, `execute` |
 
 - `SqlTypedFragment<V, M>` carries the Column's value type `V` and model type `M`, enabling type checking on the tuple's second element.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "litedbmodel",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A lightweight TypeScript ORM for PostgreSQL, MySQL, and SQLite with Active Record pattern",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",