betterddb 0.8.2 → 1.0.0

package/README.md

@@ -1,7 +1,7 @@
 # BetterDDB
 
 [![npm version](https://badge.fury.io/js/betterddb.svg)](https://badge.fury.io/js/betterddb)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![GitHub](https://img.shields.io/badge/GitHub-Repository-blue?logo=github)](https://github.com/ryanrawlingswang/betterddb)
 
 **BetterDDB** is a type-safe DynamoDB wrapper library that combines runtime validation with compile-time type checking. It provides a high-level, opinionated interface for DynamoDB operations with built-in schema validation using [Zod](https://github.com/colinhacks/zod).
 
@@ -12,7 +12,7 @@
 - 🎯 **Smart Key Management**: Automatic computation of partition keys, sort keys, and GSI keys
 - 🛠️ **Fluent Query API**: Intuitive builder pattern for all DynamoDB operations
 - ⚡ **Developer Experience**: Reduced boilerplate and improved code maintainability
-- 🔄 **Built-in Conveniences**: Automatic timestamp handling, versioning support
+- 🔄 **Built-in Conveniences**: Automatic timestamp handling, counter support
 
 ## Installation
 
@@ -23,7 +23,7 @@ npm install betterddb
 ## Quick Start
 
 ```typescript
-import { BetterDDB } from "betterddb";
+import { BetterDDB, Operator } from "betterddb";
 import { z } from "zod";
 import { DynamoDBDocumentClient, DynamoDB } from "@aws-sdk/lib-dynamodb";
 
@@ -89,17 +89,28 @@ async function example() {
 
   // Query with type-safe filters
   const results = await userDdb
+    .query({ id: "user-123" })
+    .filter("name", Operator.BEGINS_WITH, "A")
+    .limitResults(10)
+    .execute();
+
+  // Query using a Global Secondary Index (GSI)
+  const gsiResults = await userDdb
     .query({ email: "alice@example.com" })
     .usingIndex("EmailIndex")
-    .filter("name", "begins_with", "A")
     .limitResults(10)
     .execute();
 
   // Update with automatic timestamp handling
   const updated = await userDdb
-    .update({ id: "user-123" })
+    .update({ id: "user-123", email: "alice@example.com" })
     .set({ name: "Alice B." })
     .execute();
+
+  // Delete an item
+  await userDdb
+    .delete({ id: "user-123", email: "alice@example.com" })
+    .execute();
 }
 ```
 
@@ -107,34 +118,55 @@ async function example() {
 
 ### Schema Validation
 
-BetterDDB uses Zod for both runtime validation and TypeScript type inference:
+BetterDDB uses Zod for both runtime validation and TypeScript type inference. Your schema should allow computed fields like DynamoDB keys and timestamps:
 
 ```typescript
-const Schema = z
+import { z } from "zod";
+
+const UserSchema = z
   .object({
     id: z.string(),
     name: z.string(),
     email: z.string().email(),
+    // Optional fields for automatic timestamps
+    createdAt: z.string().optional(),
+    updatedAt: z.string().optional(),
   })
-  .passthrough(); // Allow computed fields
+  .passthrough(); // Allow computed fields like pk, sk, gsi keys
 
-type Entity = z.infer<typeof Schema>; // TypeScript type inference
+type User = z.infer<typeof UserSchema>; // TypeScript type inference
 ```
 
 ### Key Management
 
-Define how your keys should be computed from your entity:
+Define how your keys should be computed from your entity. Keys can be simple property references or computed using a build function:
 
 ```typescript
 const ddb = new BetterDDB<User>({
   keys: {
+    // Primary key configuration
     primary: {
       name: "pk",
       definition: { build: (raw) => `USER#${raw.id}` },
     },
+    // Sort key (optional)
     sort: {
       name: "sk",
-      definition: { build: (raw) => `TYPE#${raw.type}` },
+      definition: { build: (raw) => `EMAIL#${raw.email}` },
+    },
+    // Global Secondary Indexes (optional)
+    gsis: {
+      EmailIndex: {
+        name: "EmailIndex",
+        primary: {
+          name: "gsi1pk",
+          definition: { build: (raw) => `USER#${raw.email}` },
+        },
+        sort: {
+          name: "gsi1sk",
+          definition: { build: (raw) => `USER#${raw.email}` },
+        },
+      },
     },
   },
 });
@@ -142,16 +174,37 @@ const ddb = new BetterDDB<User>({
 
 ### Query Building
 
-Fluent API for building type-safe queries:
+Fluent API for building type-safe queries with support for filters, index usage, and pagination:
 
 ```typescript
+import { Operator } from "betterddb";
+
+// Query on primary key with filter
 const results = await ddb
   .query({ id: "user-123" })
-  .usingIndex("EmailIndex")
-  .where("begins_with", { email: "alice" })
-  .filter("name", "contains", "Smith")
+  .filter("name", Operator.BEGINS_WITH, "Alice")
   .limitResults(10)
   .execute();
+
+// Query using a Global Secondary Index
+const gsiResults = await ddb
+  .query({ email: "alice@example.com" })
+  .usingIndex("EmailIndex")
+  .limitResults(5)
+  .execute();
+
+// Query with sort key condition
+const sortedResults = await ddb
+  .query({ id: "user-123" })
+  .where(Operator.BEGINS_WITH, { email: "alice" })
+  .execute();
+
+// Scan with filters
+const scanResults = await ddb
+  .scan()
+  .filter("name", Operator.CONTAINS, "Smith")
+  .limitResults(20)
+  .execute();
 ```
 
 ## API Reference
@@ -164,7 +217,7 @@ This documentation covers:
 - CRUD operations (Create, Read, Update, Delete)
 - Query and Scan operations with filtering
 - Batch and transaction operations
-- Advanced features like automatic timestamps and versioning
+- Advanced features like automatic timestamps and counter support
 - Schema validation and key management
 
 ## Contributing

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "betterddb",
-  "version": "0.8.2",
+  "version": "1.0.0",
   "description": "A definition-based DynamoDB wrapper library that provides a schema-driven and fully typesafe DAL.",
   "type": "module",
   "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
   "files": [
     "dist",
     "README.md",
@@ -13,15 +21,16 @@
   ],
   "scripts": {
     "build": "tsc",
-    "docker:up": "docker-compose up -d",
+    "docker:up": "docker-compose up -d --wait",
     "docker:down": "docker-compose down",
-    "test": "npm run docker:up && jest && npm run docker:down",
-    "test:watch": "npm run docker:up && jest --watch",
-    "test:coverage": "npm run docker:up && jest --coverage && npm run docker:down",
+    "test:watch": "bun test --watch",
+    "test:coverage": "bun test --coverage",
     "format": "prettier --write 'src/**/*.ts'",
     "lint": "eslint src/**/*.ts",
     "clean": "del-cli ./dist",
     "typecheck": "tsc --noEmit",
+    "release": "semantic-release --dry-run",
+    "release:ci": "semantic-release --ci",
     "prepublishOnly": "npm run clean && npm run build"
   },
   "keywords": [
@@ -38,6 +47,10 @@
   ],
   "author": "R.R. Wang",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ryanrawlingswang/betterddb.git"
+  },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.744.0",
     "@aws-sdk/lib-dynamodb": "^3.744.0",
@@ -48,6 +61,7 @@
     "@babel/preset-env": "^7.28.0",
     "@babel/preset-typescript": "^7.27.1",
     "@eslint/js": "^9.11.1",
+    "@types/bun": "^1.3.9",
     "@types/jest": "^29.5.14",
     "@types/node": "^22.13.5",
     "@typescript-eslint/eslint-plugin": "^8.24.1",
@@ -60,6 +74,16 @@
     "jest": "^29.7.0",
     "prettier": "^3.3.3",
     "ts-jest": "^29.2.5",
-    "typescript": "latest"
+    "typescript": "latest",
+    "semantic-release": "^25.0.3",
+    "@semantic-release/npm": "^13.1.4",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/release-notes-generator": "^14.0.1",
+    "@semantic-release/git": "^10.0.1"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7.0"
   }
 }

package/dist/src/betterddb.d.ts

@@ -1,137 +0,0 @@
-import { type z } from "zod";
-import { QueryBuilder } from "./builders/query-builder.js";
-import { ScanBuilder } from "./builders/scan-builder.js";
-import { UpdateBuilder } from "./builders/update-builder.js";
-import { CreateBuilder } from "./builders/create-builder.js";
-import { GetBuilder } from "./builders/get-builder.js";
-import { DeleteBuilder } from "./builders/delete-builder.js";
-import { type NativeAttributeValue, type DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
-import { BatchGetBuilder } from "./builders/batch-get-builder.js";
-export type PrimaryKeyValue = string | number;
-/**
- * A key definition can be either a simple key (a property name)
- * or an object containing a build function that computes the value.
- * (In this design, the attribute name is provided separately.)
- */
-export type KeyDefinition<T> = keyof T | {
-    build: (rawKey: Partial<T>) => string;
-};
-/**
- * Configuration for a primary (partition) key.
- */
-export interface PrimaryKeyConfig<T> {
-    /** The attribute name for the primary key in DynamoDB */
-    name: string;
-    /** How to compute the key value; if a keyof T, then the raw value is used;
-     * if an object, the build function is used.
-     */
-    definition: KeyDefinition<T>;
-}
-/**
- * Configuration for a sort key.
- */
-export interface SortKeyConfig<T> {
-    /** The attribute name for the sort key in DynamoDB */
-    name: string;
-    /** How to compute the sort key value */
-    definition: KeyDefinition<T>;
-}
-/**
- * Configuration for a Global Secondary Index (GSI).
- */
-export interface GSIConfig<T> {
-    /** The name of the GSI in DynamoDB */
-    name: string;
-    /** The primary key configuration for the GSI */
-    primary: PrimaryKeyConfig<T>;
-    /** The sort key configuration for the GSI, if any */
-    sort?: SortKeyConfig<T>;
-}
-/**
- * Keys configuration for the table.
- */
-export interface KeysConfig<T> {
-    primary: PrimaryKeyConfig<T>;
-    sort?: SortKeyConfig<T>;
-    gsis?: Record<string, GSIConfig<T>>;
-}
-/**
- * Options for initializing BetterDDB.
- */
-export interface BetterDDBOptions<T> {
-    schema: z.AnyZodObject;
-    tableName: string;
-    entityType?: string;
-    keys: KeysConfig<T>;
-    client: DynamoDBDocumentClient;
-    counter?: boolean;
-    /**
-     * If true, automatically inject timestamp fields:
-     * - On create, sets both `createdAt` and `updatedAt`
-     * - On update, sets `updatedAt`
-     *
-     * (T should include these fields if enabled.)
-     */
-    timestamps?: boolean;
-}
-/**
- * BetterDDB is a definition-based DynamoDB wrapper library.
- */
-export declare class BetterDDB<T> {
-    protected schema: z.AnyZodObject;
-    protected tableName: string;
-    protected entityType?: string;
-    protected client: DynamoDBDocumentClient;
-    protected keys: KeysConfig<T>;
-    protected timestamps: boolean;
-    protected counter: boolean;
-    constructor(options: BetterDDBOptions<T>);
-    getCounter(): boolean;
-    getKeys(): KeysConfig<T>;
-    getTableName(): string;
-    getClient(): DynamoDBDocumentClient;
-    getSchema(): z.AnyZodObject;
-    getTimestamps(): boolean;
-    getEntityType(): string | undefined;
-    protected getKeyValue(def: KeyDefinition<T>, rawKey: Partial<T>): string;
-    /**
-     * Build the primary key from a raw key object.
-     */
-    buildKey(rawKey: Partial<T>): Record<string, NativeAttributeValue>;
-    /**
-     * Build index attributes for each defined GSI.
-     */
-    buildIndexes(rawItem: Partial<T>): Record<string, NativeAttributeValue>;
-    /**
-     * Create an item:
-     * - Computes primary key and index attributes,
-     * - Optionally injects timestamps,
-     * - Validates the item and writes it to DynamoDB.
-     */
-    create(item: T): CreateBuilder<T>;
-    /**
-     * Get an item by its primary key.
-     */
-    get(rawKey: Partial<T>): GetBuilder<T>;
-    /**
-     * Get multiple items by their primary keys.
-     */
-    batchGet(rawKeys: Partial<T>[]): BatchGetBuilder<T>;
-    /**
-     * Update an item.
-     */
-    update(key: Partial<T>): UpdateBuilder<T>;
-    /**
-     * Delete an item.
-     */
-    delete(rawKey: Partial<T>): DeleteBuilder<T>;
-    /**
-     * Query items.
-     */
-    query(key: Partial<T>): QueryBuilder<T>;
-    /**
-     * Scan for items.
-     */
-    scan(): ScanBuilder<T>;
-}
-//# sourceMappingURL=betterddb.d.ts.map

package/dist/src/betterddb.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"betterddb.d.ts","sourceRoot":"","sources":["../../src/betterddb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC;AAE9C;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IACvB,MAAM,CAAC,GACP;IAEE,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC;CACvC,CAAC;AAEN;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC9B,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,gDAAgD;IAChD,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC7B,qDAAqD;IACrD,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC;IACjC,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IACpB,MAAM,EAAE,sBAAsB,CAAC;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,qBAAa,SAAS,CAAC,CAAC;IACtB,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,YAAY,CAAC;IACjC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,MAAM,EAAE,sBAAsB,CAAC;IACzC,SAAS,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;IAC9B,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAC9B,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;gBAEf,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAUjC,UAAU,IAAI,OAAO;IAIrB,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC;IAIxB,YAAY,IAAI,MAAM;IAItB,SAAS,IAAI,sBAAsB;IAInC,SAAS,IAAI,CAAC,CAAC,YAAY;IAI3B,aAAa,IAAI,OAAO;IAIxB,aAAa,IAAI,MAAM,GAAG,SAAS;IAK1C,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM;IAYxE;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAyBzE;;OAEG;IACI,YAAY,CACjB,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAClB,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC;IA+BvC;;;;;OAKG;IACI,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAIxC;;OAEG;IACI,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAI7C;;OAEG;IACI,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC;IAI1D;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAIhD;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAInD;;OAEG;IACI,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IAI9C;;OAEG;IACI,IAAI,IAAI,WAAW,CAAC,CAAC,CAAC;CAG9B"}

package/dist/src/betterddb.js

@@ -1,165 +0,0 @@
-import {} from "zod";
-import { QueryBuilder } from "./builders/query-builder.js";
-import { ScanBuilder } from "./builders/scan-builder.js";
-import { UpdateBuilder } from "./builders/update-builder.js";
-import { CreateBuilder } from "./builders/create-builder.js";
-import { GetBuilder } from "./builders/get-builder.js";
-import { DeleteBuilder } from "./builders/delete-builder.js";
-import {} from "@aws-sdk/lib-dynamodb";
-import { BatchGetBuilder } from "./builders/batch-get-builder.js";
-/**
- * BetterDDB is a definition-based DynamoDB wrapper library.
- */
-export class BetterDDB {
-    schema;
-    tableName;
-    entityType;
-    client;
-    keys;
-    timestamps;
-    counter;
-    constructor(options) {
-        this.schema = options.schema;
-        this.tableName = options.tableName;
-        this.entityType = options.entityType?.toUpperCase();
-        this.keys = options.keys;
-        this.client = options.client;
-        this.timestamps = options.timestamps ?? false;
-        this.counter = options.counter ?? false;
-    }
-    getCounter() {
-        return this.counter;
-    }
-    getKeys() {
-        return this.keys;
-    }
-    getTableName() {
-        return this.tableName;
-    }
-    getClient() {
-        return this.client;
-    }
-    getSchema() {
-        return this.schema;
-    }
-    getTimestamps() {
-        return this.timestamps;
-    }
-    getEntityType() {
-        return this.entityType;
-    }
-    // Helper: Retrieve the key value from a KeyDefinition.
-    getKeyValue(def, rawKey) {
-        if (typeof def === "string" ||
-            typeof def === "number" ||
-            typeof def === "symbol") {
-            return String(rawKey[def]);
-        }
-        else {
-            return def.build(rawKey);
-        }
-    }
-    /**
-     * Build the primary key from a raw key object.
-     */
-    buildKey(rawKey) {
-        const keyObj = {};
-        // For primary (partition) key:
-        const pkConfig = this.keys.primary;
-        keyObj[pkConfig.name] =
-            typeof pkConfig.definition === "string" ||
-                typeof pkConfig.definition === "number" ||
-                typeof pkConfig.definition === "symbol"
-                ? String(rawKey[pkConfig.definition])
-                : pkConfig.definition.build(rawKey);
-        // For sort key, if defined:
-        if (this.keys.sort) {
-            const skConfig = this.keys.sort;
-            keyObj[skConfig.name] =
-                typeof skConfig.definition === "string" ||
-                    typeof skConfig.definition === "number" ||
-                    typeof skConfig.definition === "symbol"
-                    ? String(rawKey[skConfig.definition])
-                    : skConfig.definition.build(rawKey);
-        }
-        return keyObj;
-    }
-    /**
-     * Build index attributes for each defined GSI.
-     */
-    buildIndexes(rawItem) {
-        const indexAttributes = {};
-        if (this.keys.gsis) {
-            for (const gsiName in this.keys.gsis) {
-                const gsiConfig = this.keys.gsis[gsiName];
-                if (!gsiConfig)
-                    continue;
-                // Compute primary index attribute.
-                const primaryConfig = gsiConfig.primary;
-                indexAttributes[primaryConfig.name] =
-                    typeof primaryConfig.definition === "string" ||
-                        typeof primaryConfig.definition === "number" ||
-                        typeof primaryConfig.definition === "symbol"
-                        ? String(rawItem[primaryConfig.definition])
-                        : primaryConfig.definition.build(rawItem);
-                // Compute sort index attribute if provided.
-                if (gsiConfig?.sort) {
-                    const sortConfig = gsiConfig.sort;
-                    indexAttributes[sortConfig.name] =
-                        typeof sortConfig.definition === "string" ||
-                            typeof sortConfig.definition === "number" ||
-                            typeof sortConfig.definition === "symbol"
-                            ? String(rawItem[sortConfig.definition])
-                            : sortConfig.definition.build(rawItem);
-                }
-            }
-        }
-        return indexAttributes;
-    }
-    /**
-     * Create an item:
-     * - Computes primary key and index attributes,
-     * - Optionally injects timestamps,
-     * - Validates the item and writes it to DynamoDB.
-     */
-    create(item) {
-        return new CreateBuilder(this, item);
-    }
-    /**
-     * Get an item by its primary key.
-     */
-    get(rawKey) {
-        return new GetBuilder(this, rawKey);
-    }
-    /**
-     * Get multiple items by their primary keys.
-     */
-    batchGet(rawKeys) {
-        return new BatchGetBuilder(this, rawKeys);
-    }
-    /**
-     * Update an item.
-     */
-    update(key) {
-        return new UpdateBuilder(this, key);
-    }
-    /**
-     * Delete an item.
-     */
-    delete(rawKey) {
-        return new DeleteBuilder(this, rawKey);
-    }
-    /**
-     * Query items.
-     */
-    query(key) {
-        return new QueryBuilder(this, key);
-    }
-    /**
-     * Scan for items.
-     */
-    scan() {
-        return new ScanBuilder(this);
-    }
-}
-//# sourceMappingURL=betterddb.js.map

package/dist/src/betterddb.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"betterddb.js","sourceRoot":"","sources":["../../src/betterddb.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,MAAM,KAAK,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAC7D,OAAO,EAGN,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AA8ElE;;GAEG;AACH,MAAM,OAAO,SAAS;IACV,MAAM,CAAiB;IACvB,SAAS,CAAS;IAClB,UAAU,CAAU;IACpB,MAAM,CAAyB;IAC/B,IAAI,CAAgB;IACpB,UAAU,CAAU;IACpB,OAAO,CAAU;IAE3B,YAAY,OAA4B;QACtC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,EAAE,WAAW,EAAE,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,KAAK,CAAC;IAC1C,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAEM,YAAY;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAEM,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,uDAAuD;IAC7C,WAAW,CAAC,GAAqB,EAAE,MAAkB;QAC7D,IACE,OAAO,GAAG,KAAK,QAAQ;YACvB,OAAO,GAAG,KAAK,QAAQ;YACvB,OAAO,GAAG,KAAK,QAAQ,EACvB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,MAAkB;QAChC,MAAM,MAAM,GAAyC,EAAE,CAAC;QAExD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;QACnC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACnB,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;gBACvC,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;gBACvC,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;gBACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACrC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAExC,4BAA4B;QAC5B,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;YAChC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACnB,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;oBACvC,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;oBACvC,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;oBACrC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;oBACrC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC1C,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,YAAY,CACjB,OAAmB;QAEnB,MAAM,eAAe,GAAyC,EAAE,CAAC;QACjE,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACrC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC1C,IAAI,CAAC,SAAS;oBAAE,SAAS;gBAEzB,mCAAmC;gBACnC,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,CAAC;gBACxC,eAAe,CAAC,aAAa,CAAC,IAAI,CAAC;oBACjC,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ;wBAC5C,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ;wBAC5C,OAAO,aAAa,CAAC,UAAU,KAAK,QAAQ;wBAC1C,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;wBAC3C,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE9C,4CAA4C;gBAC5C,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC;oBACpB,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC;oBAClC,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC;wBAC9B,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;4BACzC,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;4BACzC,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ;4BACvC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;4BACxC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAO;QACnB,OAAO,IAAI,aAAa,CAAI,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,MAAkB;QAC3B,OAAO,IAAI,UAAU,CAAI,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,OAAqB;QACnC,OAAO,IAAI,eAAe,CAAI,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,GAAe;QAC3B,OAAO,IAAI,aAAa,CAAI,IAAI,EAAE,GAAG,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAkB;QAC9B,OAAO,IAAI,aAAa,CAAI,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,GAAe;QAC1B,OAAO,IAAI,YAAY,CAAI,IAAI,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,WAAW,CAAI,IAAI,CAAC,CAAC;IAClC,CAAC;CACF"}

package/dist/src/builders/batch-get-builder.d.ts

@@ -1,16 +0,0 @@
-import { type BetterDDB } from "../betterddb.js";
-export declare class BatchGetBuilder<T> {
-    private parent;
-    private keys;
-    /**
-     * @param parent - The BetterDDB instance for the table.
-     * @param keys - An array of partial keys for the items you wish to retrieve.
-     */
-    constructor(parent: BetterDDB<T>, keys: Partial<T>[]);
-    /**
-     * Executes the batch get operation.
-     * Returns an array of parsed items of type T.
-     */
-    execute(): Promise<T[]>;
-}
-//# sourceMappingURL=batch-get-builder.d.ts.map

package/dist/src/builders/batch-get-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batch-get-builder.d.ts","sourceRoot":"","sources":["../../../src/builders/batch-get-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIjD,qBAAa,eAAe,CAAC,CAAC;IAM1B,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,IAAI;IANd;;;OAGG;gBAEO,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE;IAG5B;;;OAGG;IACU,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;CAqCrC"}

package/dist/src/builders/batch-get-builder.js

@@ -1,54 +0,0 @@
-/* eslint-disable no-unused-vars */
-import {} from "../betterddb.js";
-import { BatchGetCommand } from "@aws-sdk/lib-dynamodb";
-import {} from "@aws-sdk/client-dynamodb";
-export class BatchGetBuilder {
-    parent;
-    keys;
-    /**
-     * @param parent - The BetterDDB instance for the table.
-     * @param keys - An array of partial keys for the items you wish to retrieve.
-     */
-    constructor(parent, keys) {
-        this.parent = parent;
-        this.keys = keys;
-    }
-    /**
-     * Executes the batch get operation.
-     * Returns an array of parsed items of type T.
-     */
-    async execute() {
-        if (this.keys.length === 0) {
-            return [];
-        }
-        const seen = new Set();
-        const deduplicatedKeys = this.keys.filter((key) => {
-            const keyString = JSON.stringify(key);
-            if (seen.has(keyString)) {
-                return false;
-            }
-            seen.add(keyString);
-            return true;
-        });
-        const tableName = this.parent.getTableName();
-        // Build an array of keys using the parent's key builder.
-        const keysArray = deduplicatedKeys.map((key) => this.parent.buildKey(key));
-        // Construct the BatchGet parameters.
-        const params = {
-            RequestItems: {
-                [tableName]: {
-                    Keys: keysArray,
-                },
-            },
-        };
-        const result = await this.parent
-            .getClient()
-            .send(new BatchGetCommand(params));
-        const responses = result.Responses ? result.Responses[tableName] : [];
-        if (!responses) {
-            return [];
-        }
-        return this.parent.getSchema().array().parse(responses);
-    }
-}
-//# sourceMappingURL=batch-get-builder.js.map

package/dist/src/builders/batch-get-builder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"batch-get-builder.js","sourceRoot":"","sources":["../../../src/builders/batch-get-builder.ts"],"names":[],"mappings":"AAAA,mCAAmC;AACnC,OAAO,EAAkB,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAA0B,MAAM,0BAA0B,CAAC;AAElE,MAAM,OAAO,eAAe;IAMhB;IACA;IANV;;;OAGG;IACH,YACU,MAAoB,EACpB,IAAkB;QADlB,WAAM,GAAN,MAAM,CAAc;QACpB,SAAI,GAAJ,IAAI,CAAc;IACzB,CAAC;IAEJ;;;OAGG;IACI,KAAK,CAAC,OAAO;QAClB,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;YAChD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC;QAC7C,yDAAyD;QACzD,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3E,qCAAqC;QACrC,MAAM,MAAM,GAAsB;YAChC,YAAY,EAAE;gBACZ,CAAC,SAAS,CAAC,EAAE;oBACX,IAAI,EAAE,SAAS;iBAChB;aACF;SACF,CAAC;QAEF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM;aAC7B,SAAS,EAAE;aACX,IAAI,CAAC,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;QACrC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAQ,CAAC;IACjE,CAAC;CACF"}

package/dist/src/builders/create-builder.d.ts

@@ -1,12 +0,0 @@
-import { type TransactWriteItem } from "@aws-sdk/client-dynamodb";
-import { type BetterDDB } from "../betterddb.js";
-export declare class CreateBuilder<T> {
-    private parent;
-    private item;
-    private extraTransactItems;
-    constructor(parent: BetterDDB<T>, item: T);
-    execute(): Promise<T>;
-    transactWrite(ops: TransactWriteItem[] | TransactWriteItem): this;
-    toTransactPut(): TransactWriteItem;
-}
-//# sourceMappingURL=create-builder.d.ts.map

package/dist/src/builders/create-builder.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-builder.d.ts","sourceRoot":"","sources":["../../../src/builders/create-builder.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,KAAK,iBAAiB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,qBAAa,aAAa,CAAC,CAAC;IAIxB,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,IAAI;IAJd,OAAO,CAAC,kBAAkB,CAA2B;gBAG3C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EACpB,IAAI,EAAE,CAAC;IAGJ,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IA+C3B,aAAa,CAAC,GAAG,EAAE,iBAAiB,EAAE,GAAG,iBAAiB,GAAG,IAAI;IASjE,aAAa,IAAI,iBAAiB;CAwB1C"}