# Dynamo Document Builder

> TypeScript library for DynamoDB single-table design with type-safe operations and automatic Zod schema validation. The core mental model is: create one `DynamoTable`, define one or more `DynamoEntity` instances with Zod schemas and computed key functions, then dispatch typed `Commands` via `entity.send()`.

**Version**: 0.4.0 | **License**: MIT

Install: `npm i dynamo-document-builder zod @aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb`

Key capabilities: computed composite keys from entity data, full Zod validation on reads and writes, expressive condition/update/filter APIs, tree-shakable command imports, multi-entity batch and transact operations via `table.send()`, Zod 4.1+ codec support for custom serialization.

## Docs

- [Core Concepts](https://dynamodocumentbuilder.com/llms/core.md): `DynamoTable`, `DynamoEntity`, `key()`, `indexKey()`, sparse indexes, `entity.send()`, `entity.prepare()`, `Entity<T>` and `EncodedEntity<T>` type utilities
- [Read Commands](https://dynamodocumentbuilder.com/llms/read-commands.md): `Get`, `ProjectedGet`, `Query`, `ProjectedQuery` with pagination, `Scan`, `ProjectedScan` with parallel scan, `BatchGet`, `BatchProjectedGet`, `TransactGet`
- [Write Commands](https://dynamodocumentbuilder.com/llms/write-commands.md): `Put`, `ConditionalPut`, `Update`, `ConditionalUpdate`, `Delete`, `ConditionalDelete`, `BatchWrite`, `TransactWrite`, `ConditionCheck` — includes full update operations reference (`ref`, `remove`, `add`, `subtract`, `append`, `prepend`, `addToSet`, `removeFromSet`)
- [Multi-Entity Commands](https://dynamodocumentbuilder.com/llms/multi-entity-commands.md): `TableBatchGet`, `TableBatchWrite`, `TableTransactGet`, `TableTransactWrite` — batch and transact operations across multiple entity types via `table.send()`
- [Conditions API](https://dynamodocumentbuilder.com/llms/conditions.md): Comparison operators (`equals`, `between`, `isIn`, …), logical operators (`and`, `or`, `not`), string operators (`beginsWith`, `contains`), attribute checks (`exists`, `notExists`, `size`, `typeIs`), DynamoDB type descriptors

## Optional

- [Advanced Features](https://dynamodocumentbuilder.com/llms/advanced.md): Zod codecs for custom serialization/deserialization, low-level `parseCondition` / `parseUpdate` / `parseProjection` parsers, `AttributeExpressionMap` API, complete tree-shakable subpath import reference
- [Patterns & Troubleshooting](https://dynamodocumentbuilder.com/llms/patterns.md): Performance best practices, single-table design patterns (user management, hierarchical data, audit trail), Lambda setup guidance, error handling, troubleshooting guide, quick-reference import cheatsheet
- [Full context file](https://dynamodocumentbuilder.com/llms-full.txt): All of the above combined into a single file for agents that prefer one large context load