feat(aws-sdk-v3): [WIP] update imports

remove makeRequest method on dynamo-db-wrapper.ts since no underlying method is available

Author: Michael Wittwer

src/dynamo/batchget/batch-get.request.ts

@@ -18,7 +18,7 @@ import { BatchGetResponse } from './batch-get.response'
  * Request class for the BatchGetItem operation. Read multiple items from one or more tables.
  */
 export class BatchGetRequest {
-  get dynamoDB(): DynamoDB {
+  get dynamoDB(): DynamoDB.DynamoDB {
     return this.dynamoDBWrapper.dynamoDB
   }
 
@@ -27,7 +27,7 @@ export class BatchGetRequest {
   private readonly tables: Map<string, ModelConstructor<any>> = new Map()
   private itemCounter = 0
 
-  constructor(dynamoDB?: DynamoDB) {
+  constructor(dynamoDB?: DynamoDB.DynamoDB) {
     this.dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
     this.params = {
       RequestItems: {},

src/dynamo/batchwrite/batch-write.request.ts

@@ -14,15 +14,15 @@ import { BATCH_WRITE_DEFAULT_TIME_SLOT, BATCH_WRITE_MAX_REQUEST_ITEM_COUNT } fro
  * Request class for the BatchWriteItem operation. Put or delete multiple items in one or more table.
  */
 export class BatchWriteRequest {
-  get dynamoDB(): DynamoDB {
+  get dynamoDB(): DynamoDB.DynamoDB {
     return this.dynamoDBWrapper.dynamoDB
   }
 
   readonly params: DynamoDB.BatchWriteItemInput
   private readonly dynamoDBWrapper: DynamoDbWrapper
   private itemCount = 0
 
-  constructor(dynamoDB?: DynamoDB) {
+  constructor(dynamoDB?: DynamoDB.DynamoDB) {
     this.dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
     this.params = {
       RequestItems: {},

src/dynamo/dynamo-db-wrapper.ts

@@ -10,61 +10,65 @@ import { dynamoEasyConfig } from '../config/dynamo-easy-config'
  * @hidden
  */
 export class DynamoDbWrapper {
-  readonly dynamoDB: DynamoDB
+  readonly dynamoDB: DynamoDB.DynamoDB
 
-  constructor(dynamoDB?: DynamoDB) {
+  constructor(dynamoDB?: DynamoDB.DynamoDB) {
     // create the actual dynamoDB client
-    this.dynamoDB = dynamoDB || new DynamoDB.default()
+    // TODO v3: check if any default configuration should be provided, possibly from dynamoEasyConfig
+    this.dynamoDB = dynamoDB || new DynamoDB.DynamoDB({})
   }
 
   /*
    * make all the dynamo requests return an promise
    */
   putItem(params: DynamoDB.PutItemInput): Promise<DynamoDB.PutItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.putItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.putItem(params))
   }
 
   getItem(params: DynamoDB.GetItemInput): Promise<DynamoDB.GetItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.getItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.getItem(params))
   }
 
   updateItem(params: DynamoDB.UpdateItemInput): Promise<DynamoDB.UpdateItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.updateItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.updateItem(params))
   }
 
   deleteItem(params: DynamoDB.DeleteItemInput): Promise<DynamoDB.DeleteItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.deleteItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.deleteItem(params))
   }
 
   batchWriteItem(params: DynamoDB.BatchWriteItemInput): Promise<DynamoDB.BatchWriteItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.batchWriteItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.batchWriteItem(params))
   }
 
   batchGetItems(params: DynamoDB.BatchGetItemInput): Promise<DynamoDB.BatchGetItemOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.batchGetItem(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.batchGetItem(params))
   }
 
   transactWriteItems(params: DynamoDB.TransactWriteItemsInput): Promise<DynamoDB.TransactWriteItemsOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.transactWriteItems(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.transactWriteItems(params))
   }
 
   transactGetItems(params: DynamoDB.TransactGetItemsInput): Promise<DynamoDB.TransactGetItemsOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.transactGetItems(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.transactGetItems(params))
   }
 
   scan(params: DynamoDB.ScanInput): Promise<DynamoDB.ScanOutput> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.scan(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.scan(params))
   }
 
   query(params: DynamoDB.QueryInput): Promise<DynamoDB.QueryOutput> {
     if (!params.KeyConditionExpression) {
       throw new Error('key condition expression must be defined')
     }
 
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.query(params).promise())
+    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.query(params))
   }
 
-  makeRequest(operation: string, params?: Record<string, any>): Promise<any> {
-    return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.makeRequest(operation, params).promise())
-  }
+  /*
+   * TODO v3: check for replacement. DynamoDB.executeStatement is now used to execute statements using PartiQL
+   */
+  // makeRequest(operation: string, params?: Record<string, any>): Promise<any> {
+  //   return dynamoEasyConfig.sessionValidityEnsurer().then(() => this.dynamoDB.executeStatement(operation as any, params))
+  // }
 }

src/dynamo/dynamo-store.ts

@@ -4,7 +4,6 @@
 import * as DynamoDB from '@aws-sdk/client-dynamodb'
 import { createLogger, Logger } from '../logger/logger'
 import { ModelConstructor } from '../model/model-constructor'
-import { DynamoApiOperations } from './dynamo-api-operations.type'
 import { DynamoDbWrapper } from './dynamo-db-wrapper'
 import { getTableName } from './get-table-name.function'
 import { BatchGetSingleTableRequest } from './request/batchgetsingletable/batch-get-single-table.request'
@@ -21,15 +20,15 @@ import { UpdateRequest } from './request/update/update.request'
  * DynamoStore
  */
 export class DynamoStore<T> {
-  get dynamoDB(): DynamoDB {
+  get dynamoDB(): DynamoDB.DynamoDB {
     return this.dynamoDBWrapper.dynamoDB
   }
 
   readonly tableName: string
   private readonly logger: Logger
   private readonly dynamoDBWrapper: DynamoDbWrapper
 
-  constructor(private modelClazz: ModelConstructor<T>, dynamoDB?: DynamoDB) {
+  constructor(private modelClazz: ModelConstructor<T>, dynamoDB?: DynamoDB.DynamoDB) {
     this.logger = createLogger('dynamo.DynamoStore', modelClazz)
     this.dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
     this.tableName = getTableName(modelClazz)
@@ -82,10 +81,13 @@ export class DynamoStore<T> {
     return new TransactGetSingleTableRequest(this.dynamoDBWrapper, this.modelClazz, keys)
   }
 
-  makeRequest<Z>(operation: DynamoApiOperations, params?: Record<string, any>): Promise<Z> {
-    this.logger.debug('request', params)
-    return this.dynamoDBWrapper
-      .makeRequest(operation, params)
-      .then(promiseTap((r: Z) => this.logger.debug('response', r)))
-  }
+  /**
+   * TODO v3: check for potential replacement
+   */
+  // makeRequest<Z>(operation: DynamoApiOperations, params?: Record<string, any>): Promise<Z> {
+  //   this.logger.debug('request', params)
+  //   return this.dynamoDBWrapper
+  //     .makeRequest(operation, params)
+  //     .then(promiseTap((r: Z) => this.logger.debug('response', r)))
+  // }
 }

src/dynamo/expression/param-util.ts

@@ -1,6 +1,7 @@
 /**
  * @module expression
  */
+import DynamoDB from '@aws-sdk/client-dynamodb'
 import { isEmpty } from '../../helper/is-empty.function'
 import { isString } from '../../helper/is-string.function'
 import { ConditionalParams } from '../operation-params.type'

src/dynamo/transactget/transact-get.request.ts

@@ -19,15 +19,15 @@ const MAX_REQUEST_ITEM_COUNT = 10
  * Request class for the TransactGetItems operation. Read up to 10 items from one or more tables in a transaction.
  */
 export class TransactGetRequest {
-  get dynamoDB(): DynamoDB {
+  get dynamoDB(): DynamoDB.DynamoDB {
     return this.dynamoDBWrapper.dynamoDB
   }
 
   readonly params: DynamoDB.TransactGetItemsInput
   private readonly dynamoDBWrapper: DynamoDbWrapper
   private readonly tables: Array<ModelConstructor<any>> = []
 
-  constructor(dynamoDB?: DynamoDB) {
+  constructor(dynamoDB?: DynamoDB.DynamoDB) {
     this.dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
     this.params = {
       TransactItems: [],

src/dynamo/transactwrite/transact-write.request.ts

@@ -9,14 +9,14 @@ import { TransactOperation } from './transact-operation.type'
  * Request class for the TransactWriteItems operation. Write up to 25 items to one or many tables in a transaction.
  */
 export class TransactWriteRequest {
-  get dynamoDB(): DynamoDB {
+  get dynamoDB(): DynamoDB.DynamoDB {
     return this.dynamoDBWrapper.dynamoDB
   }
 
-  readonly params: DynamoDB.TransactWriteItemsInput
+  readonly params: DynamoDB.TransactWriteItemsInput & { TransactItems: DynamoDB.TransactWriteItem[] }
   private readonly dynamoDBWrapper: DynamoDbWrapper
 
-  constructor(dynamoDB?: DynamoDB) {
+  constructor(dynamoDB?: DynamoDB.DynamoDB) {
     this.dynamoDBWrapper = new DynamoDbWrapper(dynamoDB)
     this.params = {
       TransactItems: [],