@exabugs/dynamodb-client 0.3.6 → 0.3.7

package/CHANGELOG.md

@@ -7,6 +7,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.7] - 2024-12-19
+
+### Removed
+
+- **BREAKING CHANGE**: Complete removal of legacy shadow configuration support
+  - Removed `LegacyShadowConfig` and `ResourceShadowConfig` types from shadows module
+  - Removed duplicate shadow configuration types from server module
+  - Removed all shadow.config.json file support
+  - Only v0.3.x environment variable-based configuration is now supported
+
+### Changed
+
+- Simplified type exports to only include v0.3.x specification types
+- Updated documentation to reflect complete v0.3.x migration
+- Consolidated shadow configuration to single source (environment variables)
+
+### Migration Guide
+
+- Replace any usage of `ResourceShadowConfig` or `LegacyShadowConfig` with environment variables
+- Use `SHADOW_CREATED_AT_FIELD`, `SHADOW_UPDATED_AT_FIELD`, `SHADOW_STRING_MAX_BYTES`, `SHADOW_NUMBER_PADDING`
+- Remove any shadow.config.json files from your project
+
 ## [0.3.6] - 2024-12-02
 
 ### Changed

package/README.md

@@ -20,6 +20,24 @@
 
 ---
 
+## 📖 Overview
+
+**DynamoDB Client SDK** is a TypeScript-first library that brings MongoDB-like simplicity to AWS DynamoDB. Built for modern serverless applications, it provides a familiar API while leveraging DynamoDB's single-table design patterns for optimal performance and cost efficiency.
+
+### Why DynamoDB Client SDK?
+
+- **🎯 Familiar API**: Use MongoDB-style queries with DynamoDB's power
+- **⚡ Single-Table Design**: Optimized data modeling without the complexity
+- **🔄 Shadow Records**: Efficient sorting without expensive Global Secondary Indexes
+- **🛡️ Type Safety**: Full TypeScript support with compile-time validation
+- **🚀 Serverless Ready**: Built for AWS Lambda with ARM64 optimization
+- **🎨 Admin UI**: Integrated react-admin interface for content management
+- **🏗️ Infrastructure**: Complete Terraform modules for production deployment
+
+Perfect for building scalable web applications, content management systems, and serverless APIs that need the performance of DynamoDB with the developer experience of MongoDB.
+
+---
+
 ## ✨ Features
 
 <table>
@@ -108,9 +126,9 @@ graph TB
     C -->|HTTPS| D
     D -->|AWS SDK| E
 
-    style A fill:#61dafb,stroke:#333,stroke-width:2px
-    style B fill:#61dafb,stroke:#333,stroke-width:2px
-    style C fill:#61dafb,stroke:#333,stroke-width:2px
+    style A fill:#2563eb,stroke:#333,stroke-width:2px,color:#fff
+    style B fill:#2563eb,stroke:#333,stroke-width:2px,color:#fff
+    style C fill:#2563eb,stroke:#333,stroke-width:2px,color:#fff
     style D fill:#ff9900,stroke:#333,stroke-width:2px
     style E fill:#527fff,stroke:#333,stroke-width:2px
 ```
@@ -141,32 +159,23 @@ This example includes:
 ### Quick Example
 
 ```typescript
-// 1. Define schema
-export const MySchema: SchemaRegistryConfig = {
-  database: {
-    name: 'myapp',
-    timestamps: {
-      createdAt: 'createdAt',
-      updatedAt: 'updatedAt',
-    },
-  },
-  resources: {
-    articles: {
-      resource: 'articles',
-      type: {} as Article,
-      shadows: { sortableFields: { title: { type: 'string' } } },
-    },
-  },
-};
+// 1. Define your data types
+interface Article {
+  id: string;
+  title: string;
+  content: string;
+  createdAt: string;
+  updatedAt: string;
+}
 
 // 2. Deploy with Terraform (see dynamodb-client-example)
 // terraform apply
 
 // 3. Use the client
 const client = new DynamoClient(FUNCTION_URL);
-const articles = client.db().collection('articles');
+const articles = client.db().collection<Article>('articles');
 
-await articles.insertOne({ title: 'Hello DynamoDB' });
+await articles.insertOne({ title: 'Hello DynamoDB', content: 'Getting started...' });
 const article = await articles.findOne({ title: 'Hello DynamoDB' });
 ```
 
@@ -295,16 +304,19 @@ const record = {
 };
 
 // Automatically generates shadow records:
-// - id#01HQXYZ123#id#01HQXYZ123
 // - title#Article#id#01HQXYZ123
 // - viewCount#1000000000000123#id#01HQXYZ123
 // - published#1#id#01HQXYZ123
 // - tags#["aws","tech"]#id#01HQXYZ123
 // - metadata#{"category":"tech"}#id#01HQXYZ123
+//
+// Note: 'id' field does NOT generate a shadow record
+// Main record (SK = id#01HQXYZ123) is used for id-based sorting
 ```
 
 ### Exclusion Rules
 
+- **`id` field is excluded** - Main record (`SK = id#{ULID}`) is used for id-based sorting
 - Fields starting with `__` are excluded (internal metadata)
 - `null` or `undefined` values are excluded