@mastra/dynamodb 0.0.2-alpha.0

package/LICENSE.md

@@ -0,0 +1,46 @@
+# Elastic License 2.0 (ELv2)
+
+Copyright (c) 2025 Mastra AI, Inc.
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,144 @@
+# @mastra/dynamodb
+
+A DynamoDB storage implementation for Mastra using a single-table design pattern with ElectroDB.
+
+## Features
+
+- Efficient single-table design for all Mastra storage needs
+- Based on ElectroDB for type-safe DynamoDB access
+- Support for AWS credentials, regions, and endpoints
+- Compatible with AWS DynamoDB Local for development
+- Thread, Message, Trace, Eval, and Workflow operations
+- Optimized for serverless environments
+
+## Installation
+
+```bash
+npm install @mastra/dynamodb
+# or
+pnpm add @mastra/dynamodb
+# or
+yarn add @mastra/dynamodb
+```
+
+## Prerequisites
+
+Before using this package, you need to create a DynamoDB table with the required structure. See [TABLE_SETUP.md](./TABLE_SETUP.md) for detailed instructions on how to set up the table using CloudFormation or AWS CDK.
+
+## Usage
+
+### Basic Usage
+
+```typescript
+import { Memory } from '@mastra/memory';
+import { DynamoDBStore } from '@mastra/dynamodb';
+import { PineconeVector } from '@mastra/pinecone';
+
+// Initialize the DynamoDB storage
+const storage = new DynamoDBStore({
+  name: 'dynamodb',
+  config: {
+    region: 'us-east-1',
+    tableName: 'mastra-single-table', // Name of your DynamoDB table
+  },
+});
+
+// Initialize vector store (if using semantic recall)
+const vector = new PineconeVector({
+  apiKey: process.env.PINECONE_API_KEY,
+  environment: process.env.PINECONE_ENVIRONMENT,
+  index: process.env.PINECONE_INDEX,
+});
+
+// Memory combines storage (like DynamoDBStore) with an optional vector store for recall
+// Create memory with DynamoDB storage
+const memory = new Memory({
+  storage,
+  vector,
+  options: {
+    lastMessages: 10,
+    semanticRecall: true,
+  },
+});
+```
+
+### Local Development
+
+For local development, you can use DynamoDB Local:
+
+```typescript
+const storage = new DynamoDBStore({
+  name: 'dynamodb',
+  config: {
+    region: 'us-east-1',
+    tableName: 'mastra-single-table',
+    endpoint: 'http://localhost:8000', // Local DynamoDB endpoint
+  },
+});
+```
+
+### AWS IAM Permissions
+
+The IAM role or user used by this package needs the following permissions:
+
+```json
+{
+  "Version": "2012-10-17",
+  "Statement": [
+    {
+      "Effect": "Allow",
+      "Action": [
+        "dynamodb:DescribeTable",
+        "dynamodb:GetItem",
+        "dynamodb:PutItem",
+        "dynamodb:UpdateItem",
+        "dynamodb:DeleteItem",
+        "dynamodb:Query",
+        "dynamodb:Scan",
+        "dynamodb:BatchGetItem",
+        "dynamodb:BatchWriteItem"
+      ],
+      "Resource": [
+        "arn:aws:dynamodb:*:*:table/${YOUR_TABLE_NAME}",
+        "arn:aws:dynamodb:*:*:table/${YOUR_TABLE_NAME}/index/*"
+      ]
+    }
+  ]
+}
+```
+
+## Configuration Options
+
+The `DynamoDBStore` constructor accepts the following configuration options:
+
+| Option               | Type   | Required | Description                                                |
+| -------------------- | ------ | -------- | ---------------------------------------------------------- |
+| `name`               | string | Yes      | A name for the storage instance                            |
+| `config.region`      | string | No       | AWS region (default: 'us-east-1')                          |
+| `config.tableName`   | string | Yes      | The name of your DynamoDB table                            |
+| `config.endpoint`    | string | No       | Custom endpoint for DynamoDB (e.g., for local development) |
+| `config.credentials` | object | No       | AWS credentials (accessKeyId, secretAccessKey)             |
+
+## Architectural Approach
+
+This storage adapter utilizes a **single-table design pattern** leveraging [ElectroDB](https://electrodb.dev/), which is a common and recommended approach for DynamoDB. This differs architecturally from relational database adapters (like `@mastra/pg` or `@mastra/libsql`) that typically use multiple tables, each dedicated to a specific entity (threads, messages, etc.).
+
+Key aspects of this approach:
+
+- **DynamoDB Native:** The single-table design is optimized for DynamoDB's key-value and query capabilities, often leading to better performance and scalability compared to mimicking relational models.
+- **External Table Management:** Unlike some adapters that might offer helper functions to create tables via code, this adapter **expects the DynamoDB table and its associated Global Secondary Indexes (GSIs) to be provisioned externally** before use. Please refer to `TABLE_SETUP.md` for detailed instructions using tools like AWS CloudFormation or CDK. The adapter focuses solely on interacting with the pre-existing table structure.
+- **Consistency via Interface:** While the underlying storage model differs, this adapter adheres to the same `MastraStorage` interface as other adapters, ensuring it can be used interchangeably within the Mastra `Memory` component.
+
+## Advantage of Single-Table Design
+
+This implementation uses a single-table design pattern with ElectroDB, which offers several advantages within the context of DynamoDB:
+
+1. **Lower cost**: One table means fewer read/write capacity units to provision
+2. **Better performance**: Related data is stored together for faster access
+3. **Simplified administration**: Only one table to monitor and back up
+4. **Reduced complexity**: Consistent access patterns across entities
+5. **Transaction support**: Atomic operations across different entity types
+
+## License
+
+MIT