fix: allow use of index for getItem

packages/spacecat-shared-dynamo/src/index.d.ts

@@ -18,16 +18,11 @@ export declare interface Logger {
   info(message: string, ...args: unknown[]): void;
 }
 
-export declare interface DynamoDbKey {
-  partitionKey: string;
-  sortKey?: string;
-}
-
 export declare interface DynamoDbClient {
   query(originalParams: QueryCommandInput): Promise<object[]>;
-  getItem(tableName: string, key: DynamoDbKey): Promise<object>;
+  getItem(tableName: string, indexName: string, key: object): Promise<object>;
   putItem(tableName: string, item: object): Promise<{ message: string }>;
-  removeItem(tableName: string, key: DynamoDbKey): Promise<{ message: string }>;
+  removeItem(tableName: string, key: object): Promise<{ message: string }>;
 }
 
 export function createClient(

packages/spacecat-shared-dynamo/src/index.js

@@ -32,7 +32,7 @@ const createClient = (
   docClient = DynamoDBDocument.from(dbClient),
 ) => ({
   query: (params) => query(docClient, params, log),
-  getItem: (tableName, key) => getItem(docClient, tableName, key, log),
+  getItem: (tableName, indexName, key) => getItem(docClient, tableName, indexName, key, log),
   putItem: (tableName, item) => putItem(docClient, tableName, item, log),
   removeItem: (tableName, key) => removeItem(docClient, tableName, key, log),
 });

packages/spacecat-shared-dynamo/src/modules/getItem.js

@@ -12,25 +12,40 @@
 
 import { performance } from 'perf_hooks';
 
+import { hasText } from '@adobe/spacecat-shared-utils';
+
 import { guardKey, guardTableName } from '../utils/guards.js';
 
 /**
  * Retrieves an item from DynamoDB using a table name and key object.
  *
  * @param {DynamoDBDocumentClient} docClient - The AWS SDK DynamoDB Document client instance.
  * @param {string} tableName - The name of the DynamoDB table.
- * @param {DynamoDbKey} key - The key object containing partitionKey and optionally sortKey.
+ * @param {string} [indexName] - Optional. The name of the DynamoDB index.
+ * @param {object} key - The key object containing partitionKey and optionally sortKey.
  * @param {Logger} log - The logging object, defaults to console.
  * @returns {Promise<Object>} A promise that resolves to the retrieved item.
  * @throws {Error} Throws an error if the DynamoDB get operation fails or input validation fails.
  */
-async function getItem(docClient, tableName, key, log = console) {
+async function getItem(
+  docClient,
+  tableName,
+  indexName,
+  key,
+  log = console,
+) {
   guardTableName(tableName);
   guardKey(key);
 
+  const indexProperties = {};
+  if (hasText(indexName)) {
+    indexProperties.IndexName = indexName;
+  }
+
   const params = {
     TableName: tableName,
     Key: key,
+    ...indexProperties,
   };
 
   try {

packages/spacecat-shared-dynamo/src/modules/removeItem.js

@@ -19,7 +19,7 @@ import { guardKey, guardTableName } from '../utils/guards.js';
  *
  * @param {DynamoDBDocumentClient} docClient - The AWS SDK DynamoDB Document client instance.
  * @param {string} tableName - The name of the DynamoDB table.
- * @param {DynamoDbKey} key - The key object containing partitionKey and optionally sortKey.
+ * @param {object} key - The key object containing partitionKey and optionally sortKey.
  * @param {Logger} log - The logging object, defaults to console.
  * @returns {Promise<Object>} A promise that resolves to a message indicating successful removal.
  * @throws {Error} Throws an error if the DynamoDB delete operation fails or input validation fails.

packages/spacecat-shared-dynamo/test/modules/getItem.test.js

@@ -29,13 +29,19 @@ describe('getItem', () => {
 
   it('gets an item from the database', async () => {
     const key = { partitionKey: 'testPartitionKey' };
-    const result = await dynamoDbClient.getItem('TestTable', key);
+    const result = await dynamoDbClient.getItem('TestTable', null, key);
     expect(result).to.be.an('object');
   });
 
   it('gets an item from the database with sort key', async () => {
     const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' };
-    const result = await dynamoDbClient.getItem('TestTable', key);
+    const result = await dynamoDbClient.getItem('TestTable', null, key);
+    expect(result).to.be.an('object');
+  });
+
+  it('gets an item from the database with index', async () => {
+    const key = { partitionKey: 'testPartitionKey', sortKey: 'testSortKey' };
+    const result = await dynamoDbClient.getItem('TestTable', 'test-index', key);
     expect(result).to.be.an('object');
   });
 
@@ -51,7 +57,7 @@ describe('getItem', () => {
 
   it('throws an error for getItem with invalid key', async () => {
     try {
-      await dynamoDbClient.getItem('TestTable', null);
+      await dynamoDbClient.getItem('TestTable', null, null);
       expect.fail('getItem did not throw with invalid key');
     } catch (error) {
       expect(error.message).to.equal('Key must be a non-empty object.');
@@ -64,7 +70,7 @@ describe('getItem', () => {
     };
 
     try {
-      await dynamoDbClient.getItem('TestTable', { partitionKey: 'testPartitionKey' });
+      await dynamoDbClient.getItem('TestTable', null, { partitionKey: 'testPartitionKey' });
       expect.fail('getItem did not throw as expected');
     } catch (error) {
       expect(error.message).to.equal('Get failed');