feat: add option to set custom dynamo ttl attribute name. (#164)

* feat: add option to set custom dynamo `ttl` attribute name.

* Add way to modify the dynamo ttl attribute name

Author: natac13

.changeset/six-eyes-design.md

@@ -0,0 +1,5 @@
+---
+"@openauthjs/openauth": patch
+---
+
+Add way to modify the dynamo ttl attribute name

packages/openauth/src/storage/dynamo.ts

@@ -41,17 +41,24 @@ export interface DynamoStorageOptions {
   table: string
   /**
    * The primary key column name.
+   * @default "pk"
    */
   pk?: string
   /**
    * The sort key column name.
+   * @default "sk"
    */
   sk?: string
   /**
    * Endpoint URL for the DynamoDB service. Useful for local testing.
    * @default "https://dynamodb.{region}.amazonaws.com"
    */
   endpoint?: string
+  /**
+   * The name of the time to live attribute.
+   * @default "expiry"
+   */
+  ttl?: string
 }
 
 /**
@@ -62,6 +69,7 @@ export function DynamoStorage(options: DynamoStorageOptions): StorageAdapter {
   const c = client()
   const pk = options.pk || "pk"
   const sk = options.sk || "sk"
+  const ttl = options.ttl || "expiry"
   const tableName = options.table
 
   function parseKey(key: string[]) {
@@ -109,7 +117,7 @@ export function DynamoStorage(options: DynamoStorageOptions): StorageAdapter {
       }
       const result = await dynamo("GetItem", params)
       if (!result.Item) return
-      if (result.Item.expiry && result.Item.expiry.N < Date.now() / 1000) {
+      if (result.Item[ttl] && result.Item[ttl].N < Date.now() / 1000) {
         return
       }
       return JSON.parse(result.Item.value.S)
@@ -124,7 +132,7 @@ export function DynamoStorage(options: DynamoStorageOptions): StorageAdapter {
           [sk]: { S: parsed.sk },
           ...(expiry
             ? {
-                expiry: { N: Math.floor(expiry.getTime() / 1000).toString() },
+                [ttl]: { N: Math.floor(expiry.getTime() / 1000).toString() },
               }
             : {}),
           value: { S: JSON.stringify(value) },
@@ -172,7 +180,7 @@ export function DynamoStorage(options: DynamoStorageOptions): StorageAdapter {
         const result = await dynamo("Query", params)
 
         for (const item of result.Items || []) {
-          if (item.expiry && item.expiry.N < now) {
+          if (item[ttl] && item[ttl].N < now) {
             continue
           }
           yield [[item[pk].S, item[sk].S], JSON.parse(item.value.S)]