@resistdesign/voltra 3.0.0-alpha.52 → 3.0.0-alpha.54

package/api/ORM/drivers/DynamoDBDataItemDBDriver/ConfigTypes.d.ts

@@ -69,6 +69,10 @@ export type RetryStrategy = {
  * DynamoDB client configuration subset for generated docs.
  */
 export type DynamoDBSpecificConfig = {
+    /**
+     * When true, the first sort field is treated as the DynamoDB index name.
+     */
+    useFirstSortFieldAsIndexName?: boolean;
     /**
      * Custom request handler override.
      */

package/api/ORM/drivers/DynamoDBDataItemDBDriver.d.ts

@@ -1,14 +1,16 @@
 /**
  * @packageDocumentation
  *
- * DynamoDB-backed data item driver for TypeInfo ORM. Supports CRUD and scan-based
- * list operations with SearchCriteria filters.
+ * DynamoDB-backed data item driver for TypeInfo ORM. Supports CRUD and list
+ * operations using scans by default, with optional GSI-backed queries when the
+ * first sort field is configured to act as an index name.
  */
 import { DataItemDBDriver, DataItemDBDriverConfig, SupportedDataItemDBDriverEntry } from "./common/Types";
 import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
 import { TypeInfoDataItem } from "../../../common/TypeParsing/TypeInfo";
 import { TypeInfoORMUpdateConfig } from "../../../common/TypeInfoORM";
 import { ListItemsConfig, ListItemsResults } from "../../../common/SearchTypes";
+import type { DynamoDBSpecificConfig } from "./DynamoDBDataItemDBDriver/ConfigTypes";
 /**
  * A {@link DataItemDBDriver} that uses DynamoDB as its database.
  * */
@@ -18,6 +20,7 @@ export declare class DynamoDBDataItemDBDriver<ItemType extends TypeInfoDataItem,
      */
     protected config: DataItemDBDriverConfig<ItemType, UniquelyIdentifyingFieldName>;
     protected dynamoDBClient: DynamoDBClient;
+    protected specificConfig: DynamoDBSpecificConfig;
     /**
      * @param config Driver configuration including DynamoDB client settings.
      */

package/api/index.js

@@ -5429,6 +5429,13 @@ var ConfigTypeInfoMap_default2 = {
   },
   DynamoDBSpecificConfig: {
     fields: {
+      useFirstSortFieldAsIndexName: {
+        type: "boolean",
+        array: false,
+        readonly: false,
+        optional: true,
+        tags: {}
+      },
       requestHandler: {
         type: "string",
         array: false,
@@ -5843,11 +5850,14 @@ var DynamoDBDataItemDBDriver = class {
   constructor(config) {
     this.config = config;
     const { dbSpecificConfig } = config;
-    this.dynamoDBClient = new DynamoDBClient(
-      dbSpecificConfig
-    );
+    const { useFirstSortFieldAsIndexName, ...clientConfig } = dbSpecificConfig ?? {};
+    this.specificConfig = {
+      useFirstSortFieldAsIndexName
+    };
+    this.dynamoDBClient = new DynamoDBClient(clientConfig);
   }
   dynamoDBClient;
+  specificConfig;
   /**
    * Create an item in the database.
    * @returns Generated identifier for the created item.
@@ -5964,6 +5974,8 @@ var DynamoDBDataItemDBDriver = class {
       ExpressionAttributeNames,
       ExpressionAttributeValues
     } = createFilterExpression(fieldCriteria, logicalOperator);
+    const primarySortField = sortFields?.[0];
+    const indexName = this.specificConfig.useFirstSortFieldAsIndexName ? primarySortField?.field : void 0;
     const params = {
       TableName: tableName,
       Select: selectedFields && selectedFields.length > 0 ? "SPECIFIC_ATTRIBUTES" : "ALL_ATTRIBUTES",
@@ -5998,14 +6010,24 @@ var DynamoDBDataItemDBDriver = class {
         };
       }
     }
-    const command = new ScanCommand({
+    const commandInput = indexName ? {
+      ...params,
+      IndexName: indexName,
+      KeyConditionExpression: FilterExpression,
+      ExclusiveStartKey: structuredCursor,
+      Limit: itemsPerPage,
+      ScanIndexForward: !primarySortField?.reverse
+    } : {
       ...params,
       ExclusiveStartKey: structuredCursor,
       Limit: itemsPerPage
-    });
-    const { Items = [], LastEvaluatedKey } = await this.dynamoDBClient.send(command);
+    };
+    const command = indexName ? new QueryCommand(commandInput) : new ScanCommand(commandInput);
+    const { Items = [], LastEvaluatedKey } = await this.dynamoDBClient.send(
+      command
+    );
     const unmarshalledItems = Items.map((item) => unmarshall(item));
-    const sortedItems = getSortedItems(sortFields, unmarshalledItems);
+    const sortedItems = indexName ? unmarshalledItems : getSortedItems(sortFields, unmarshalledItems);
     return {
       items: sortedItems,
       cursor: LastEvaluatedKey ? JSON.stringify(unmarshall(LastEvaluatedKey)) : void 0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resistdesign/voltra",
-  "version": "3.0.0-alpha.52",
+  "version": "3.0.0-alpha.54",
   "description": "With our powers combined!",
   "homepage": "https://voltra.app",
   "repository": "git@github.com:resistdesign/voltra.git",