dynoquery 0.1.25 → 0.2.0

package/README.md

@@ -66,7 +66,7 @@ async function userExample() {
 
 #### Second-Level Objects (Single-Row Operations)
 
-For a more flexible way to work with individual rows, you can use `draft()` and `get()` to obtain an `Item` object, then call `create()`, `update()`, or `save()` on it directly. You can also use a shorthand by passing a second argument to your model function (as shown in the examples below).
+For a more flexible way to work with individual rows, you can use `draft()` and `get()` to obtain an `Item` object, then call `save()` on it directly. You can also use a shorthand by passing a second argument to your model function (as shown in the examples below).
 
 ```typescript
 const john = db.User('john@example.com');
@@ -78,8 +78,8 @@ johnMeta.email = 'johndoe@johnmail.com';
 await johnMeta.save();
 
 // 2. Create with properties in arguments
-const johnStat = john.draft('STAT');
-await johnStat.create({ views: 100 });
+const johnStat = john.draft('STAT', { views: 100 });
+await johnStat.save();
 
 // 3. Get and update an existing row
 const johnBio = await john.get('BIO');
@@ -87,8 +87,7 @@ johnBio.birthYear = 1986;
 await johnBio.save();
 
 // 4. Partial update without fetching
-const johnFriend1 = john.draft('FRIEND#1');
-await johnFriend1.update({ Name: 'Alice', rank: 1 });
+await john.update('FRIEND#1', { Name: 'Alice', rank: 1 });
 
 // 5. Set properties during initialization
 const johnPref = john.draft('PREF', { theme: 'dark' });
@@ -96,7 +95,8 @@ await johnPref.save();
 
 // 6. Shorthand access (returns an Item object directly)
 const johnMeta = db.User('john@example.com', 'METADATA');
-await johnMeta.update({ name: 'John Doe' });
+johnMeta.name = 'John Doe';
+await johnMeta.save();
 ```
 
 ### 2. Global Secondary Indexes (findBy)
@@ -137,7 +137,7 @@ async function indexExample() {
 
 ### 3. Creating Items with GSI Support
 
-You can pass index queries directly to `create()` or `update()` to automatically populate GSI attributes. This works on both the Partition level and the Item level.
+You can pass index queries directly to `create()` or `update()` to automatically populate GSI attributes. This works on the Partition level.
 
 #### Using Partition.create() and Partition.update()
 ```typescript
@@ -153,23 +153,8 @@ await db.Product('p123').create('INFO', {
 await db.Product('p123').update('INFO', { price: 45 }, [electronics]);
 ```
 
-#### Using Item.create() and Item.update()
-```typescript
-const electronics = db.findByCategory('ELECTRONICS', 'RANK#1');
-const mouse = db.Product('p123', 'INFO');
-
-// Pass data and indices directly to create()
-await mouse.create({ 
-  name: 'Gaming Mouse', 
-  price: 50 
-}, [electronics]);
-
-// Or use update() directly on the item for partial updates
-await mouse.update({ price: 40 }, [electronics]);
-```
-
 #### Using setIndex() for persistence
-You can also use `setIndex()` to attach indices to an item so they are used automatically whenever you call `save()`.
+You can also use `setIndex()` to attach indices to an item so they are used automatically whenever you call `save()`. This is useful when you have an Item object (e.g., from `draft()` or `get()`).
 
 ```typescript
 const electronics = db.findByCategory('ELECTRONICS', 'RANK#1');
@@ -242,6 +227,31 @@ if (items[0]) {
 }
 ```
 
+### 6. Time To Live (TTL)
+
+DynamoDB TTL allows you to automatically delete items after a certain timestamp. To use it in DynoQuery, configure `ttlAttributeName` when initializing the client.
+
+> **Note:** DynoQuery does not enable TTL in DynamoDB. It only sets the values using the `ttl()` function. You must manually enable TTL for your table in the AWS Console or via CLI/CloudFormation first.
+
+```typescript
+const db = new DynoQuery({
+  region: 'us-east-1',
+  tableName: 'MyTable',
+  ttlAttributeName: 'expireAt' // The attribute name which is set in DynamoDB to be used for TTL
+});
+
+async function ttlExample() {
+  const session = db.User('john@example.com').draft('SESSION');
+  
+  // Set TTL to 1 hour from now (timestamp in seconds)
+  const ttl = Math.floor(Date.now() / 1000) + 3600;
+  session.ttl(ttl);
+  
+  session.data = 'some session data';
+  await session.save();
+}
+```
+
 ## Optional Configuration Parameters
 
 | Parameter | Type | Default | Description |
@@ -249,6 +259,7 @@ if (items[0]) {
 | `pkName` | `string` | `'PK'` | Custom attribute name for Partition Key. |
 | `skName` | `string` | `'SK'` | Custom attribute name for Sort Key. |
 | `pkPrefix` | `string` | `''` | Global prefix for all partitions (useful for multitenancy, e.g., `TENANT#A#`). |
+| `ttlAttributeName` | `string` | - | Optional attribute name for DynamoDB TTL. |
 | `endpoint` | `string` | - | Optional endpoint for local development (e.g., `http://localhost:8000`). |
 | `credentials` | `object` | - | Custom AWS credentials (`{ accessKeyId, secretAccessKey, sessionToken? }`). |
 
@@ -277,12 +288,12 @@ Both `Partition.getAll()` and `IndexQuery.getAll()` support pagination.
 
 ```typescript
 const index = db.findByCategory('ELECTRONICS');
-const items = await index.getAll({ limit: 10 });
+const items = await index.getAll({ Limit: 10 });
 
 const token = index.getLastEvaluatedKey();
 if (token) {
   // Fetch next page
-  const nextItems = await index.getAll({ limit: 10, exclusiveStartKey: token });
+  const nextItems = await index.getAll({ Limit: 10, ExclusiveStartKey: token });
 }
 ```
 
@@ -353,7 +364,7 @@ await johnMeta.save();
 
 ### Partition
 - `get(skValue)`: Fetches data for a specific Sort Key value (returns a Promise).
-- `getAll(options?)`: Fetches items in the partition. Options: `{ limit, exclusiveStartKey, filterBuilder, FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
+- `getAll(options?)`: Fetches items in the partition. Options: `{ Limit, ExclusiveStartKey, filterBuilder, FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
 - `create(skValue, data, indices?, options?)`: Creates an item. `options`: `{ conditionBuilder, ConditionExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
 - `update(skValue, data, indices?, options?)`: Partial update of an item. `options`: `{ conditionBuilder, ConditionExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
 - `delete(skValue, options?)`: Deletes an item. `options`: `{ conditionBuilder, ConditionExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
@@ -364,13 +375,12 @@ await johnMeta.save();
 
 ### IndexQuery
 - `get(skValue?)`: Get a single item from the index.
-- `getAll(options?)`: Query index. Options: `{ limit, scanIndexForward, exclusiveStartKey, skValue, filterBuilder, FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
+- `getAll(options?)`: Query index. Options: `{ Limit, ScanIndexForward, ExclusiveStartKey, skValue, filterBuilder, FilterExpression, ExpressionAttributeNames, ExpressionAttributeValues }`.
 - `getLastEvaluatedKey()`: Returns the pagination token from the last `getAll()`.
 
 ### Item (returned by Partition.get or draft)
-- `create(data?, indices?)`: Persists the item as a new record with the provided data. Supports GSI indices and internal `conditionBuilder`.
-- `update(data, indices?)`: Partial update of the item. Supports GSI indices and internal `conditionBuilder`.
 - `save()`: Persists the current state of the item. Uses indices attached via `setIndex()` and internal `conditionBuilder`.
+- `ttl(timestamp)`: Sets the TTL attribute value. Only works if `ttlAttributeName` is configured in `DynoQueryConfig`.
 - `getData()`: Returns a clean data object containing only the database attributes (filters out internal state and methods).
 - `setIndex(indices)`: Attaches one or more `IndexQuery` objects to the item.
 - `setFilter(builder)`: Sets a filter expression builder for the item.

package/dist/index-query.d.ts

@@ -17,12 +17,12 @@ export declare class IndexQuery {
     protected skName: string;
     protected pkValue: string;
     protected skValue?: string;
-    protected lastEvaluatedKey: any;
+    protected LastEvaluatedKey: any;
     constructor(db: DynoQuery, config: IndexQueryConfig);
     getAll<T = any>(options?: {
-        limit?: number;
-        scanIndexForward?: boolean;
-        exclusiveStartKey?: any;
+        Limit?: number;
+        ScanIndexForward?: boolean;
+        ExclusiveStartKey?: any;
         skValue?: string;
         filterBuilder?: ExpressionBuilder;
         FilterExpression?: string;

package/dist/index-query.js

@@ -12,7 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.IndexQuery = void 0;
 class IndexQuery {
     constructor(db, config) {
-        this.lastEvaluatedKey = null;
+        this.LastEvaluatedKey = null;
         this.db = db;
         this.tableName = config.tableName || db.getTableName() || "";
         this.indexName = config.indexName;
@@ -55,19 +55,19 @@ class IndexQuery {
                 FilterExpression: filterExpression,
                 ExpressionAttributeNames: expressionAttributeNames,
                 ExpressionAttributeValues: expressionAttributeValues,
-                Limit: options === null || options === void 0 ? void 0 : options.limit,
-                ScanIndexForward: options === null || options === void 0 ? void 0 : options.scanIndexForward,
-                ExclusiveStartKey: options === null || options === void 0 ? void 0 : options.exclusiveStartKey,
+                Limit: options === null || options === void 0 ? void 0 : options.Limit,
+                ScanIndexForward: options === null || options === void 0 ? void 0 : options.ScanIndexForward,
+                ExclusiveStartKey: options === null || options === void 0 ? void 0 : options.ExclusiveStartKey,
             });
             const items = (response.Items || []);
             const mappedItems = items.map(item => this.db.mapItemToModelItem(item));
-            this.lastEvaluatedKey = response.LastEvaluatedKey || null;
+            this.LastEvaluatedKey = response.LastEvaluatedKey || null;
             return mappedItems;
         });
     }
     get(skValue) {
         return __awaiter(this, void 0, void 0, function* () {
-            const items = yield this.getAll({ limit: 1, skValue });
+            const items = yield this.getAll({ Limit: 1, skValue });
             return items.length > 0 ? items[0] : null;
         });
     }
@@ -84,7 +84,7 @@ class IndexQuery {
         return this.skValue;
     }
     getLastEvaluatedKey() {
-        return this.lastEvaluatedKey;
+        return this.LastEvaluatedKey;
     }
 }
 exports.IndexQuery = IndexQuery;

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export interface DynoQueryConfig {
     region?: string;
     endpoint?: string;
     pkPrefix?: string;
+    ttlAttributeName?: string;
     credentials?: {
         accessKeyId: string;
         secretAccessKey: string;
@@ -32,6 +33,7 @@ export declare class DynoQuery {
     private globalPkPrefix;
     private pkName;
     private skName;
+    private ttlAttributeName?;
     private registeredModels;
     [key: string]: any;
     constructor(config?: DynoQueryConfig);
@@ -83,6 +85,7 @@ export declare class DynoQuery {
     getPkPrefix(): string;
     getPkName(): string;
     getSkName(): string;
+    getTtlAttributeName(): string | undefined;
     getRegisteredModels(): Record<string, {
         pkPrefix: string;
     }>;

package/dist/index.js

@@ -45,7 +45,7 @@ Object.defineProperty(exports, "attr", { enumerable: true, get: function () { re
 class DynoQuery {
     constructor(config = {}) {
         this.registeredModels = {};
-        const { tableName, pkName, skName, pkPrefix, models, findBy } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "models", "findBy"]);
+        const { tableName, pkName, skName, pkPrefix, ttlAttributeName, models, findBy } = config, clientConfig = __rest(config, ["tableName", "pkName", "skName", "pkPrefix", "ttlAttributeName", "models", "findBy"]);
         this.client = new client_dynamodb_1.DynamoDBClient(clientConfig);
         this.docClient = lib_dynamodb_1.DynamoDBDocumentClient.from(this.client, {
             marshallOptions: {
@@ -56,6 +56,7 @@ class DynoQuery {
         this.globalPkPrefix = pkPrefix || "";
         this.pkName = pkName || "PK";
         this.skName = skName || "SK";
+        this.ttlAttributeName = ttlAttributeName;
         if (models) {
             this.registeredModels = models;
             Object.entries(models).forEach(([name, def]) => {
@@ -423,6 +424,9 @@ class DynoQuery {
     getSkName() {
         return this.skName;
     }
+    getTtlAttributeName() {
+        return this.ttlAttributeName;
+    }
     getRegisteredModels() {
         return this.registeredModels;
     }

package/dist/partition.d.ts

@@ -24,15 +24,16 @@ export declare class Partition {
     protected skName: string;
     protected cache: Record<string, any>;
     protected isLoaded: boolean;
-    protected lastEvaluatedKey: any;
+    protected LastEvaluatedKey: any;
+    protected ttlAttributeName?: string;
     constructor(db: DynoQuery, config: PartitionConfig, id?: string);
     /**
      * Fetches all items in the partition and caches them.
      * Returns the data and caches it.
      */
     getAll<T = any>(options?: {
-        limit?: number;
-        exclusiveStartKey?: any;
+        Limit?: number;
+        ExclusiveStartKey?: any;
         filterBuilder?: ExpressionBuilder;
         FilterExpression?: string;
         ExpressionAttributeNames?: Record<string, string>;
@@ -86,6 +87,7 @@ export declare class Partition {
     draftDelete<T = any>(skValue: string): T;
     getTableName(): string;
     getPkValue(): string;
+    getTtlAttributeName(): string | undefined;
     getLastEvaluatedKey(): any;
     /**
      * Delete all data in this partition.

package/dist/partition.js

@@ -47,22 +47,6 @@ class Item {
                         });
                     };
                 }
-                if (prop === "create") {
-                    return (data, indices) => {
-                        const dataToSave = data || {};
-                        const finalIndices = indices || self._indices;
-                        return partition.create(skValue, dataToSave, finalIndices, {
-                            conditionBuilder: self._conditionBuilder,
-                        });
-                    };
-                }
-                if (prop === "update") {
-                    return (data, indices) => {
-                        return partition.update(skValue, data, indices, {
-                            conditionBuilder: self._conditionBuilder,
-                        });
-                    };
-                }
                 if (prop === "setFilter") {
                     return (builder) => {
                         self._filterBuilder = builder;
@@ -92,6 +76,15 @@ class Item {
                         return receiver;
                     };
                 }
+                if (prop === "ttl") {
+                    return (timestamp) => {
+                        const ttlAttr = partition.getTtlAttributeName();
+                        if (ttlAttr) {
+                            self[ttlAttr] = timestamp;
+                        }
+                        return receiver;
+                    };
+                }
                 if (prop === "getPartition") {
                     return () => partition;
                 }
@@ -111,11 +104,12 @@ class Partition {
     constructor(db, config, id) {
         this.cache = {};
         this.isLoaded = false;
-        this.lastEvaluatedKey = null;
+        this.LastEvaluatedKey = null;
         this.db = db;
         this.tableName = config.tableName || db.getTableName();
         this.pkName = db.getPkName();
         this.skName = db.getSkName();
+        this.ttlAttributeName = db.getTtlAttributeName();
         if (config.pk) {
             this.pkValue = config.pk;
         }
@@ -169,8 +163,8 @@ class Partition {
                 FilterExpression: filterExpression,
                 ExpressionAttributeNames: expressionAttributeNames,
                 ExpressionAttributeValues: expressionAttributeValues,
-                Limit: options === null || options === void 0 ? void 0 : options.limit,
-                ExclusiveStartKey: options === null || options === void 0 ? void 0 : options.exclusiveStartKey,
+                Limit: options === null || options === void 0 ? void 0 : options.Limit,
+                ExclusiveStartKey: options === null || options === void 0 ? void 0 : options.ExclusiveStartKey,
             });
             const items = (response.Items || []);
             items.forEach((item) => {
@@ -178,10 +172,10 @@ class Partition {
                     this.cache[item[this.skName]] = item;
                 }
             });
-            if (!(options === null || options === void 0 ? void 0 : options.exclusiveStartKey) && !response.LastEvaluatedKey) {
+            if (!(options === null || options === void 0 ? void 0 : options.ExclusiveStartKey) && !response.LastEvaluatedKey) {
                 this.isLoaded = true;
             }
-            this.lastEvaluatedKey = response.LastEvaluatedKey || null;
+            this.LastEvaluatedKey = response.LastEvaluatedKey || null;
             return items.map((item) => new Item(this, item[this.skName], item));
         });
     }
@@ -327,8 +321,11 @@ class Partition {
     getPkValue() {
         return this.pkValue;
     }
+    getTtlAttributeName() {
+        return this.ttlAttributeName;
+    }
     getLastEvaluatedKey() {
-        return this.lastEvaluatedKey;
+        return this.LastEvaluatedKey;
     }
     /**
      * Delete all data in this partition.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dynoquery",
-  "version": "0.1.25",
+  "version": "0.2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/devspikejs/dynoquery.git"