locality-idb 1.5.4 → 1.5.7

package/README.md

@@ -26,6 +26,15 @@
 
 ---
 
+## Why Not Raw IndexedDB?
+
+If you're weighing using `Locality IDB` vs. the raw `IndexedDB` API:
+
+- **Type safety**: schema-driven types reduce runtime errors.
+- **Query ergonomics**: SQL-like query builder replaces verbose cursor boilerplate.
+- **Validation built-in**: column type checks and custom validators run automatically.
+- **Consistency**: reusable schema + shared helpers keep data access uniform.
+
 ## 📋 Table of Contents
 
 - [Features](#-features)
@@ -56,6 +65,7 @@
   - [Utility Functions](#utility-functions)
   - [Validation](#validation)
 - [Type System](#-type-system)
+- [FAQ / Common Pitfalls](#-faq--common-pitfalls)
 - [License](#-license)
 
 ---
@@ -64,16 +74,16 @@
 
 - 🎯 **Type-Safe**: Full TypeScript support with automatic type inference
 - 🔍 **SQL-like Queries**: Familiar query syntax inspired by Drizzle ORM
-- 🚀 **Modern API**: Clean and intuitive interface for IndexedDB operations
+- 🚀 **Modern API**: Clean and intuitive interface for `IndexedDB` operations
 - 📦 **Zero Dependencies**: Lightweight with only development dependencies
 - 🔄 **Auto-Generation**: Automatic UUID and timestamp generation
 - 🎨 **Schema-First**: Define your database schema with a simple, declarative API
 - 🛠️ **Rich Column Types**: Support for various data types including custom types
-- ✅ **Built-in Validation**: Automatic data type validation for built-in column types during insert and update operations
+- ✅ **Built-in Validation**: Validation for built-in column types during insert and update operations
 - 🔧 **Custom Validators**: Define custom validation logic for columns to enforce complex rules
-- 🔒 **Atomic Transactions**: Execute multiple operations across tables with automatic rollback on failure
+- 🔒 **Transactions**: Execute multiple operations across tables with automatic rollback on failure
 - 📤 **Database Export**: Export database data as JSON for backup, migration, or debugging
-- 📥 **Database Import**: Import exported data with merge, replace, or upsert modes
+- 📥 **Database Import**: Import exported data with `'merge'`, `'replace'`, or `'upsert'` modes
 
 ---
 
@@ -322,9 +332,10 @@ const schema = defineSchema({
 > - Auto-generated values can be overridden by providing explicit values during insert.
 > - Use the `default()` modifier to set custom default values instead of auto-generated ones.
 > - Auto-generated values are generated at runtime during insert operations.
+> - `onUpdate()` modifier can be used to auto-update values on update operations (e.g. `updatedAt` timestamp).
 > - Type extensions for `uuid` and `timestamp` are not applicable since they are already typed.
 > - For custom UUID versions, use [`uuid`](https://toolbox.nazmul-nhb.dev/docs/utilities/hash/uuid) utility from [`nhb-toolbox`](https://www.npmjs.com/package/nhb-toolbox).
-> - For custom timestamp formats, use date libraries like [`Chronos`](https://toolbox.nazmul-nhb.dev/docs/classes/Chronos) (from [`nhb-toolbox`](https://www.npmjs.com/package/nhb-toolbox)) or [`date-fns`](https://www.npmjs.com/package/date-fns) to generate ISO 8601 strings.
+> - For custom timestamp formats, use date libraries like [`Chronos`](https://toolbox.nazmul-nhb.dev/docs/classes/Chronos) or [`getTimestamp`](https://toolbox.nazmul-nhb.dev/docs/utilities/date/getTimestamp) (from [`nhb-toolbox`](https://www.npmjs.com/package/nhb-toolbox)); or [`date-fns`](https://www.npmjs.com/package/date-fns) to generate ISO 8601 strings.
 
 ##### Boolean Types (`bool`, `boolean`)
 
@@ -2214,16 +2225,13 @@ type UserRow = $InferRow<typeof schema.users.columns>;
 
 ### Branded Types
 
-Locality IDB uses branded types for better type safety:
+Locality IDB uses branded type for UUIDv4 for better type safety:
 
 ```typescript
-import type { UUID, Timestamp } from 'locality-idb';
+import type { UUID } from 'locality-idb';
 
 // UUID types are branded with their version
 type UserId = UUID<'v4'>; // Branded UUID v4
-
-// Timestamps are branded ISO 8601 strings
-type CreatedAt = Timestamp; // Branded timestamp string
 ```
 
 ### Helper Types
@@ -2325,6 +2333,15 @@ type PagedResult = PageResult<User, null>;
 
 ---
 
+## ❓ FAQ / Common Pitfalls
+
+- **Schema changes aren’t automatic**: any schema change should bump the database `version` so the upgrade path runs.
+- **Index queries require indexes**: `where('field', value)` only works for primary keys or fields defined with `.index()` or `.unique()`.
+- **Predicate filters are in-memory**: `where((row) => ...)` filters client-side after fetching rows, so prefer indexes for large datasets.
+- **IndexedDB is browser-only**: calls will fail in SSR/Node environments without a shim.
+
+---
+
 ## 📄 License
 
 [MIT](LICENSE) © [Nazmul Hassan](https://github.com/nazmul-nhb)

package/dist/index.cjs

@@ -1,6 +1,6 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
 function isNumber(value) {
 	return typeof value === "number" && Number.isFinite(value);
 }
@@ -24,7 +24,7 @@ function isNonEmptyString(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
 function isArray(value) {
 	return Array.isArray(value);
 }
@@ -54,13 +54,13 @@ function isMap(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/string/utilities.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/string/utilities.js
 const extractNumbersFromString = (input) => {
 	return (input.match(/\d+/g) || [])?.map(Number);
 };
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/specials.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/specials.js
 function isEmail$1(value) {
 	return isString(value) && /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(value);
 }
@@ -82,7 +82,7 @@ function isNumericString(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/array/sort.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/array/sort.js
 function naturalSort(a, b, options) {
 	const { caseInsensitive = true, localeAware = false } = options || {};
 	const _createChunks = (str) => {
@@ -151,7 +151,7 @@ function sortAnArray(array, options) {
 
 //#endregion
 //#region src/core.ts
-/** Symbol key for column column data type */
+/** Symbol key for column data type */
 const ColumnType = Symbol("ColumnType");
 /** Symbol key for primary key marker */
 const IsPrimaryKey = Symbol("IsPrimaryKey");
@@ -401,7 +401,7 @@ function uuidV4(uppercase = false) {
 * * Get current timestamp in ISO 8601 format
 * @param value Optional date input (string, number, or Date object). Defaults to {@link Date new Date()}
 * @remarks If the provided value is invalid, the current date and time will be used.
-* @return Timestamp string in ISO 8601 format
+* @returns Timestamp string in ISO 8601 format
 */
 function getTimestamp(value) {
 	let date = value instanceof Date ? value : new Date(isNonEmptyString(value) ? value.replace(/['"]/g, "") : value ?? Date.now());
@@ -705,7 +705,7 @@ var SelectQuery = class {
 		return this;
 	}
 	/**
-	* @instance  Order results by specified key and direction
+	* @instance Order results by specified key and direction
 	* @param key Key to order by
 	* @param dir Direction: 'asc' | 'desc' (default: 'asc')
 	*
@@ -1395,7 +1395,7 @@ var Locality = class Locality {
 	/**
 	* @instance Select records from a table.
 	* @param table Table name.
-	* @returns
+	* @returns Select query builder for the table.
 	*/
 	from(table) {
 		return new SelectQuery(table, () => this.#db, this.#readyPromise);
@@ -1575,7 +1575,7 @@ var Locality = class Locality {
 	* 	}),
 	* });
 	*
-	* // Export all tables pretty-printed pretty-printed with default filename
+	* // Export all tables pretty-printed with default filename
 	* await db.export();
 	*
 	* // Export specific tables pretty-printed with custom filename

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 //#region src/core.d.ts
-/** Symbol key for column column data type */
+/** Symbol key for column data type */
 declare const ColumnType: unique symbol;
 /** Symbol key for primary key marker */
 declare const IsPrimaryKey: unique symbol;
@@ -162,7 +162,7 @@ declare class SelectQuery<T extends GenericObject, S extends Partial<Record<stri
    */
   where<IdxKey extends $InferPrimaryKey<Tbl['columns']> | $InferIndex<Tbl['columns']>>(indexName: IdxKey, query: IDBKeyRange | T[IdxKey]): this;
   /**
-   * @instance  Order results by specified key and direction
+   * @instance Order results by specified key and direction
    * @param key Key to order by
    * @param dir Direction: 'asc' | 'desc' (default: 'asc')
    *
@@ -300,9 +300,9 @@ type $Brand<B> = {
 /**
  * * Creates a branded version of a base type by intersecting it with a unique compile-time marker.
  *
- * @param T - Base type to brand.
- * @param B - Brand identifier used to distinguish this type from structurally similar types.
- 
+ * @typeParam T - Base type to brand.
+ * @typeParam B - Brand identifier used to distinguish this type from structurally similar types.
+ *
  * @remarks Useful for preventing accidental mixing of structurally identical types, while keeping the runtime value unchanged.
  *
  * @example
@@ -313,7 +313,10 @@ type Branded<T, B> = T & $Brand<B>;
 /**
  * * Broadens a literal union (typically `string` or `number`) to also accept any other value of the base type, without losing IntelliSense autocomplete for the provided literals.
  *
- * *This is especially useful in API design where you want to provide suggestions for common options but still allow flexibility for custom user-defined values.*
+ * @remarks
+ * This is especially useful in API design where you want to provide suggestions for common options but still allow flexibility for custom user-defined values.
+ *
+ * Technically, this uses intersection with primitive base types (`string & {}` or `number & {}`) to retain IntelliSense while avoiding type narrowing.
  *
  * @example
  * // ✅ String literal usage
@@ -332,8 +335,6 @@ type Branded<T, B> = T & $Brand<B>;
  * const m2: Mixed = 2;            // ✅
  * const m3: Mixed = 'anything';   // ✅
  * const m4: Mixed = 123;          // ✅
- *
- * @note Technically, this uses intersection with primitive base types (`string & {}` or `number & {}`) to retain IntelliSense while avoiding type narrowing.
  */
 type LooseLiteral<T extends string | number> = T | (T extends string ? string & {} : number & {});
 type ForcedAny = any;
@@ -365,7 +366,7 @@ type $UnionToTuple<T, L = $LastOf<T>> = [T] extends [never] ? [] : [...$UnionToT
  * - If `T` is a single type, it produces a one-element tuple `[T]`.
  * - If `T` is `never`, it produces an empty tuple `[]`.
  *
- * @param T - The type to convert into a tuple.
+ * @typeParam T - The type to convert into a tuple.
  * @returns A tuple type containing the elements of `T`.
  *
  * @example
@@ -383,7 +384,7 @@ type Tuple<T> = [T] extends [never] ? [] : $UnionToTuple<T>;
  * - Useful when you want to preserve all possible union members as a tuple literal instead of an array.
  * - For converting any type to tuple use {@link Tuple}.
  *
- * @param T - An array type whose element type is a union.
+ * @typeParam T - An array type whose element type is a union.
  * @returns A tuple type containing each member of the union in order.
  *
  * @example
@@ -435,7 +436,7 @@ type AdvancedTypes = Array<unknown> | File | FileList | Blob | Date | RegExp | C
 /**
  * * Extracts the parameters of the first overload of a function type `T`.
  *
- * @template T - The function type to extract parameters from.
+ * @typeParam T - The function type to extract parameters from.
  *
  * @returns A tuple type representing the parameters of the first overload of `T`.
  *
@@ -457,8 +458,8 @@ type FirstOverloadParams<T> = T extends ({
 /**
  * * Maps all values of object `T` to a fixed type `R`, keeping original keys.
  *
- * @template T - The source object type.
- * @template R - The replacement value type.
+ * @typeParam T - The source object type.
+ * @typeParam R - The replacement value type.
  *
  * @example
  * type T = { name: string; age: number };
@@ -488,14 +489,15 @@ type PageResult<T, Selection extends Partial<Record<keyof T, boolean>> | null> =
   /** Retrieved items for the current page */items: Selection extends null ? T[] : SelectFields<T, Extract<Selection, object>>[]; /** Cursor key for the next page, if more results are available */
   nextCursor: Maybe<IDBValidKey>;
 };
-/** - Extract only primitive keys from an object, including nested dot-notation keys. */
+/** Extract only primitive keys from an object, including nested dot-notation keys. */
 type NestedPrimitiveKey<T> = T extends AdvancedTypes ? never : T extends GenericObject ? { [K in keyof T & string]: T[K] extends Function ? never : T[K] extends NormalPrimitive ? K : T[K] extends GenericObject ? `${K}.${NestedPrimitiveKey<T[K]>}` : never }[keyof T & string] : never;
-/** - Generic object but with `any` value */
+/** Generic object but with `any` value */
 type GenericObject = Record<string, any>;
 /**
  * * Forces TypeScript to simplify a complex or inferred type into a more readable flat object.
  *
- * *Useful when working with utility types like `Merge`, `Omit`, etc., that produce deeply nested or unresolved intersections.*
+ * @remarks
+ * Useful when working with utility types like `Merge`, `Omit`, etc., that produce deeply nested or unresolved intersections.
  *
  * @example
  * type A = { a: number };
@@ -574,7 +576,7 @@ type $InferUUID<T extends ColumnDefinition> = { [K in keyof T]: T[K] extends Col
 /** Finds the field name with {@link Timestamp} type. */
 type $InferTimestamp<T extends ColumnDefinition> = { [K in keyof T]: T[K] extends Column<infer C, TypeName> ? C extends Timestamp ? K : never : never }[keyof T];
 /** Timestamp string type in ISO 8601 format */
-type Timestamp = Branded<string, 'Timestamp'>;
+type Timestamp = `${number}-${number}-${number}T${number}:${number}:${number}.${number}${'Z' | `${'+' | '-'}${number}:${number}`}`;
 /** Sort direction type for ordering queries */
 type SortDirection = 'asc' | 'desc';
 /** Predicate function type for WHERE clauses in queries */
@@ -696,7 +698,7 @@ declare class Locality<DBName extends string = string, Version extends number =
   /**
    * @instance Select records from a table.
    * @param table Table name.
-   * @returns
+   * @returns Select query builder for the table.
    */
   from<T extends TName, Row extends $InferRow<Schema[T]['columns']>>(table: T): SelectQuery<Row, null, Schema[T]>;
   /**
@@ -824,7 +826,7 @@ declare class Locality<DBName extends string = string, Version extends number =
    * 	}),
    * });
    *
-   * // Export all tables pretty-printed pretty-printed with default filename
+   * // Export all tables pretty-printed with default filename
    * await db.export();
    *
    * // Export specific tables pretty-printed with custom filename
@@ -1162,7 +1164,7 @@ declare const column: {
    * - This column type is used for storing date and time information in ISO 8601 format.
    * - Automatically generates the current timestamp when no value is provided.
    */
-  timestamp: () => Column<Timestamp, "timestamp">;
+  timestamp: () => Column<`${number}-${number}-${number}T${number}:${number}:${number}.${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}+${number}:${number}` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}-${number}:${number}`, "timestamp">;
   /**
    * Creates an email column.
    * @returns A new {@link Column} instance for emails.
@@ -1372,7 +1374,7 @@ declare function uuidV4(uppercase?: boolean): UUID<'v4'>;
  * * Get current timestamp in ISO 8601 format
  * @param value Optional date input (string, number, or Date object). Defaults to {@link Date new Date()}
  * @remarks If the provided value is invalid, the current date and time will be used.
- * @return Timestamp string in ISO 8601 format
+ * @returns Timestamp string in ISO 8601 format
  */
 declare function getTimestamp(value?: string | number | Date): Timestamp;
 /**

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 //#region src/core.d.ts
-/** Symbol key for column column data type */
+/** Symbol key for column data type */
 declare const ColumnType: unique symbol;
 /** Symbol key for primary key marker */
 declare const IsPrimaryKey: unique symbol;
@@ -162,7 +162,7 @@ declare class SelectQuery<T extends GenericObject, S extends Partial<Record<stri
    */
   where<IdxKey extends $InferPrimaryKey<Tbl['columns']> | $InferIndex<Tbl['columns']>>(indexName: IdxKey, query: IDBKeyRange | T[IdxKey]): this;
   /**
-   * @instance  Order results by specified key and direction
+   * @instance Order results by specified key and direction
    * @param key Key to order by
    * @param dir Direction: 'asc' | 'desc' (default: 'asc')
    *
@@ -300,9 +300,9 @@ type $Brand<B> = {
 /**
  * * Creates a branded version of a base type by intersecting it with a unique compile-time marker.
  *
- * @param T - Base type to brand.
- * @param B - Brand identifier used to distinguish this type from structurally similar types.
- 
+ * @typeParam T - Base type to brand.
+ * @typeParam B - Brand identifier used to distinguish this type from structurally similar types.
+ *
  * @remarks Useful for preventing accidental mixing of structurally identical types, while keeping the runtime value unchanged.
  *
  * @example
@@ -313,7 +313,10 @@ type Branded<T, B> = T & $Brand<B>;
 /**
  * * Broadens a literal union (typically `string` or `number`) to also accept any other value of the base type, without losing IntelliSense autocomplete for the provided literals.
  *
- * *This is especially useful in API design where you want to provide suggestions for common options but still allow flexibility for custom user-defined values.*
+ * @remarks
+ * This is especially useful in API design where you want to provide suggestions for common options but still allow flexibility for custom user-defined values.
+ *
+ * Technically, this uses intersection with primitive base types (`string & {}` or `number & {}`) to retain IntelliSense while avoiding type narrowing.
  *
  * @example
  * // ✅ String literal usage
@@ -332,8 +335,6 @@ type Branded<T, B> = T & $Brand<B>;
  * const m2: Mixed = 2;            // ✅
  * const m3: Mixed = 'anything';   // ✅
  * const m4: Mixed = 123;          // ✅
- *
- * @note Technically, this uses intersection with primitive base types (`string & {}` or `number & {}`) to retain IntelliSense while avoiding type narrowing.
  */
 type LooseLiteral<T extends string | number> = T | (T extends string ? string & {} : number & {});
 type ForcedAny = any;
@@ -365,7 +366,7 @@ type $UnionToTuple<T, L = $LastOf<T>> = [T] extends [never] ? [] : [...$UnionToT
  * - If `T` is a single type, it produces a one-element tuple `[T]`.
  * - If `T` is `never`, it produces an empty tuple `[]`.
  *
- * @param T - The type to convert into a tuple.
+ * @typeParam T - The type to convert into a tuple.
  * @returns A tuple type containing the elements of `T`.
  *
  * @example
@@ -383,7 +384,7 @@ type Tuple<T> = [T] extends [never] ? [] : $UnionToTuple<T>;
  * - Useful when you want to preserve all possible union members as a tuple literal instead of an array.
  * - For converting any type to tuple use {@link Tuple}.
  *
- * @param T - An array type whose element type is a union.
+ * @typeParam T - An array type whose element type is a union.
  * @returns A tuple type containing each member of the union in order.
  *
  * @example
@@ -435,7 +436,7 @@ type AdvancedTypes = Array<unknown> | File | FileList | Blob | Date | RegExp | C
 /**
  * * Extracts the parameters of the first overload of a function type `T`.
  *
- * @template T - The function type to extract parameters from.
+ * @typeParam T - The function type to extract parameters from.
  *
  * @returns A tuple type representing the parameters of the first overload of `T`.
  *
@@ -457,8 +458,8 @@ type FirstOverloadParams<T> = T extends ({
 /**
  * * Maps all values of object `T` to a fixed type `R`, keeping original keys.
  *
- * @template T - The source object type.
- * @template R - The replacement value type.
+ * @typeParam T - The source object type.
+ * @typeParam R - The replacement value type.
  *
  * @example
  * type T = { name: string; age: number };
@@ -488,14 +489,15 @@ type PageResult<T, Selection extends Partial<Record<keyof T, boolean>> | null> =
   /** Retrieved items for the current page */items: Selection extends null ? T[] : SelectFields<T, Extract<Selection, object>>[]; /** Cursor key for the next page, if more results are available */
   nextCursor: Maybe<IDBValidKey>;
 };
-/** - Extract only primitive keys from an object, including nested dot-notation keys. */
+/** Extract only primitive keys from an object, including nested dot-notation keys. */
 type NestedPrimitiveKey<T> = T extends AdvancedTypes ? never : T extends GenericObject ? { [K in keyof T & string]: T[K] extends Function ? never : T[K] extends NormalPrimitive ? K : T[K] extends GenericObject ? `${K}.${NestedPrimitiveKey<T[K]>}` : never }[keyof T & string] : never;
-/** - Generic object but with `any` value */
+/** Generic object but with `any` value */
 type GenericObject = Record<string, any>;
 /**
  * * Forces TypeScript to simplify a complex or inferred type into a more readable flat object.
  *
- * *Useful when working with utility types like `Merge`, `Omit`, etc., that produce deeply nested or unresolved intersections.*
+ * @remarks
+ * Useful when working with utility types like `Merge`, `Omit`, etc., that produce deeply nested or unresolved intersections.
  *
  * @example
  * type A = { a: number };
@@ -574,7 +576,7 @@ type $InferUUID<T extends ColumnDefinition> = { [K in keyof T]: T[K] extends Col
 /** Finds the field name with {@link Timestamp} type. */
 type $InferTimestamp<T extends ColumnDefinition> = { [K in keyof T]: T[K] extends Column<infer C, TypeName> ? C extends Timestamp ? K : never : never }[keyof T];
 /** Timestamp string type in ISO 8601 format */
-type Timestamp = Branded<string, 'Timestamp'>;
+type Timestamp = `${number}-${number}-${number}T${number}:${number}:${number}.${number}${'Z' | `${'+' | '-'}${number}:${number}`}`;
 /** Sort direction type for ordering queries */
 type SortDirection = 'asc' | 'desc';
 /** Predicate function type for WHERE clauses in queries */
@@ -696,7 +698,7 @@ declare class Locality<DBName extends string = string, Version extends number =
   /**
    * @instance Select records from a table.
    * @param table Table name.
-   * @returns
+   * @returns Select query builder for the table.
    */
   from<T extends TName, Row extends $InferRow<Schema[T]['columns']>>(table: T): SelectQuery<Row, null, Schema[T]>;
   /**
@@ -824,7 +826,7 @@ declare class Locality<DBName extends string = string, Version extends number =
    * 	}),
    * });
    *
-   * // Export all tables pretty-printed pretty-printed with default filename
+   * // Export all tables pretty-printed with default filename
    * await db.export();
    *
    * // Export specific tables pretty-printed with custom filename
@@ -1162,7 +1164,7 @@ declare const column: {
    * - This column type is used for storing date and time information in ISO 8601 format.
    * - Automatically generates the current timestamp when no value is provided.
    */
-  timestamp: () => Column<Timestamp, "timestamp">;
+  timestamp: () => Column<`${number}-${number}-${number}T${number}:${number}:${number}.${number}Z` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}+${number}:${number}` | `${number}-${number}-${number}T${number}:${number}:${number}.${number}-${number}:${number}`, "timestamp">;
   /**
    * Creates an email column.
    * @returns A new {@link Column} instance for emails.
@@ -1372,7 +1374,7 @@ declare function uuidV4(uppercase?: boolean): UUID<'v4'>;
  * * Get current timestamp in ISO 8601 format
  * @param value Optional date input (string, number, or Date object). Defaults to {@link Date new Date()}
  * @remarks If the provided value is invalid, the current date and time will be used.
- * @return Timestamp string in ISO 8601 format
+ * @returns Timestamp string in ISO 8601 format
  */
 declare function getTimestamp(value?: string | number | Date): Timestamp;
 /**

package/dist/index.iife.js

@@ -2,7 +2,7 @@ var LocalityIDB = (function(exports) {
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
 	function isNumber(value) {
 		return typeof value === "number" && Number.isFinite(value);
 	}
@@ -26,7 +26,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	}
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
 	function isArray(value) {
 		return Array.isArray(value);
 	}
@@ -56,13 +56,13 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	}
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/string/utilities.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/string/utilities.js
 	const extractNumbersFromString = (input) => {
 		return (input.match(/\d+/g) || [])?.map(Number);
 	};
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/specials.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/specials.js
 	function isEmail$1(value) {
 		return isString(value) && /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(value);
 	}
@@ -84,7 +84,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	}
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/array/sort.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/array/sort.js
 	function naturalSort(a, b, options) {
 		const { caseInsensitive = true, localeAware = false } = options || {};
 		const _createChunks = (str) => {
@@ -153,7 +153,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 //#endregion
 //#region src/core.ts
-/** Symbol key for column column data type */
+/** Symbol key for column data type */
 	const ColumnType = Symbol("ColumnType");
 	/** Symbol key for primary key marker */
 	const IsPrimaryKey = Symbol("IsPrimaryKey");
@@ -403,7 +403,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 	* * Get current timestamp in ISO 8601 format
 	* @param value Optional date input (string, number, or Date object). Defaults to {@link Date new Date()}
 	* @remarks If the provided value is invalid, the current date and time will be used.
-	* @return Timestamp string in ISO 8601 format
+	* @returns Timestamp string in ISO 8601 format
 	*/
 	function getTimestamp(value) {
 		let date = value instanceof Date ? value : new Date(isNonEmptyString(value) ? value.replace(/['"]/g, "") : value ?? Date.now());
@@ -707,7 +707,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 			return this;
 		}
 		/**
-		* @instance  Order results by specified key and direction
+		* @instance Order results by specified key and direction
 		* @param key Key to order by
 		* @param dir Direction: 'asc' | 'desc' (default: 'asc')
 		*
@@ -1397,7 +1397,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		/**
 		* @instance Select records from a table.
 		* @param table Table name.
-		* @returns
+		* @returns Select query builder for the table.
 		*/
 		from(table) {
 			return new SelectQuery(table, () => this.#db, this.#readyPromise);
@@ -1577,7 +1577,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 		* 	}),
 		* });
 		*
-		* // Export all tables pretty-printed pretty-printed with default filename
+		* // Export all tables pretty-printed with default filename
 		* await db.export();
 		*
 		* // Export specific tables pretty-printed with custom filename

package/dist/index.mjs

@@ -1,4 +1,4 @@
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/primitives.js
 function isNumber(value) {
 	return typeof value === "number" && Number.isFinite(value);
 }
@@ -22,7 +22,7 @@ function isNonEmptyString(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/non-primitives.js
 function isArray(value) {
 	return Array.isArray(value);
 }
@@ -52,13 +52,13 @@ function isMap(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/string/utilities.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/string/utilities.js
 const extractNumbersFromString = (input) => {
 	return (input.match(/\d+/g) || [])?.map(Number);
 };
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/guards/specials.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/guards/specials.js
 function isEmail$1(value) {
 	return isString(value) && /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/.test(value);
 }
@@ -80,7 +80,7 @@ function isNumericString(value) {
 }
 
 //#endregion
-//#region node_modules/.pnpm/nhb-toolbox@4.28.66/node_modules/nhb-toolbox/dist/esm/array/sort.js
+//#region node_modules/.pnpm/nhb-toolbox@4.28.80/node_modules/nhb-toolbox/dist/esm/array/sort.js
 function naturalSort(a, b, options) {
 	const { caseInsensitive = true, localeAware = false } = options || {};
 	const _createChunks = (str) => {
@@ -149,7 +149,7 @@ function sortAnArray(array, options) {
 
 //#endregion
 //#region src/core.ts
-/** Symbol key for column column data type */
+/** Symbol key for column data type */
 const ColumnType = Symbol("ColumnType");
 /** Symbol key for primary key marker */
 const IsPrimaryKey = Symbol("IsPrimaryKey");
@@ -399,7 +399,7 @@ function uuidV4(uppercase = false) {
 * * Get current timestamp in ISO 8601 format
 * @param value Optional date input (string, number, or Date object). Defaults to {@link Date new Date()}
 * @remarks If the provided value is invalid, the current date and time will be used.
-* @return Timestamp string in ISO 8601 format
+* @returns Timestamp string in ISO 8601 format
 */
 function getTimestamp(value) {
 	let date = value instanceof Date ? value : new Date(isNonEmptyString(value) ? value.replace(/['"]/g, "") : value ?? Date.now());
@@ -703,7 +703,7 @@ var SelectQuery = class {
 		return this;
 	}
 	/**
-	* @instance  Order results by specified key and direction
+	* @instance Order results by specified key and direction
 	* @param key Key to order by
 	* @param dir Direction: 'asc' | 'desc' (default: 'asc')
 	*
@@ -1393,7 +1393,7 @@ var Locality = class Locality {
 	/**
 	* @instance Select records from a table.
 	* @param table Table name.
-	* @returns
+	* @returns Select query builder for the table.
 	*/
 	from(table) {
 		return new SelectQuery(table, () => this.#db, this.#readyPromise);
@@ -1573,7 +1573,7 @@ var Locality = class Locality {
 	* 	}),
 	* });
 	*
-	* // Export all tables pretty-printed pretty-printed with default filename
+	* // Export all tables pretty-printed with default filename
 	* await db.export();
 	*
 	* // Export specific tables pretty-printed with custom filename

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "locality-idb",
-  "version": "1.5.4",
+  "version": "1.5.7",
   "description": "SQL-like query builder for IndexedDB with Drizzle-style API",
   "type": "module",
   "sideEffects": false,
@@ -47,16 +47,28 @@
     "package.json"
   ],
   "keywords": [
+    "indexeddb",
     "indexed-db",
+    "indexeddb-orm",
+    "indexed-db-orm",
     "sql",
-    "drizzle",
     "db",
+    "orm",
+    "idb",
+    "idb-orm",
+    "typescript",
+    "typescript-orm",
+    "typescript-idb",
+    "typescript-indexeddb",
+    "typescript-indexed-db",
+    "locality-idb",
     "locality",
+    "drizzle",
     "database"
   ],
   "devDependencies": {
     "@eslint/js": "^9.39.2",
-    "@types/node": "^25.2.0",
+    "@types/node": "^25.2.1",
     "@typescript-eslint/eslint-plugin": "^8.54.0",
     "@typescript-eslint/parser": "^8.54.0",
     "eslint": "^9.39.2",
@@ -64,7 +76,7 @@
     "eslint-plugin-prettier": "^5.5.5",
     "globals": "^17.3.0",
     "nhb-scripts": "^1.9.2",
-    "nhb-toolbox": "^4.28.66",
+    "nhb-toolbox": "^4.28.80",
     "prettier": "^3.8.1",
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
@@ -76,6 +88,7 @@
     "build": "tsdown",
     "dev:pkg": "tsdown --watch",
     "dev": "pnpm --dir demo run dev",
+    "install:demo": "pnpm --dir demo install",
     "build:demo": "pnpm --dir demo run build",
     "preview": "pnpm --dir demo run preview",
     "typecheck": "tsc --noEmit",