Merge pull request #135 from shiftcode/#133-use-ts-record-type

#133 use ts record type

Author: michaelwittwer

src/decorator/impl/index/util.ts

@@ -34,7 +34,7 @@ export function initOrUpdateIndex(indexType: IndexType, indexData: IndexData, ta
   initOrUpdateProperty(propertyMetadata, target, propertyKey)
 }
 
-function initOrUpdateGSI(indexes: { [key: string]: KeyType }, indexData: IndexData): Partial<PropertyMetadata<any>> {
+function initOrUpdateGSI(indexes: Record<string, KeyType>, indexData: IndexData): Partial<PropertyMetadata<any>> {
   if (indexes[indexData.name]) {
     // TODO LOW:INVESTIGATE when we throw an error we have a problem where multiple different classes extend one base class, this will be executed by multiple times
     // throw new Error(

src/decorator/impl/model/model.decorator.ts

@@ -57,7 +57,7 @@ export function Model(opts: ModelData = {}): ClassDecorator {
 
 function testForGSI<T>(
   property: PropertyMetadata<T>,
-): property is PropertyMetadata<T> & { keyForGSI: { [key: string]: KeyType } } {
+): property is PropertyMetadata<T> & { keyForGSI: Record<string, KeyType> } {
   return !!(property.keyForGSI && Object.keys(property.keyForGSI).length)
 }
 
@@ -82,7 +82,7 @@ function getGlobalSecondaryIndexes(properties: Array<PropertyMetadata<any>>): Ma
               throw new Error(
                 `there is already a partition key defined for global secondary index ${indexName} (property name: ${
                   property.nameDb
-                })`,
+                  })`,
               )
             }
 
@@ -93,7 +93,7 @@ function getGlobalSecondaryIndexes(properties: Array<PropertyMetadata<any>>): Ma
               throw new Error(
                 `there is already a sort key defined for global secondary index ${indexName} (property name: ${
                   property.nameDb
-                })`,
+                  })`,
               )
             }
 
@@ -133,7 +133,7 @@ function getLocalSecondaryIndexes(
           throw new Error(
             `only one sort key can be defined for the same local secondary index, ${
               property.nameDb
-            } is already defined as sort key for index ${indexName}`,
+              } is already defined as sort key for index ${indexName}`,
           )
         }
 

src/decorator/metadata/property-metadata.model.ts

@@ -41,7 +41,7 @@ export interface PropertyMetadata<T, R extends Attribute = Attribute> {
   mapper?: () => MapperForType<any, R>
 
   // maps the index name to the key type to describe for which GSI this property describes a key attribute
-  keyForGSI?: { [key: string]: KeyType }
+  keyForGSI?: Record<string, KeyType>
 
   // holds all the the index names for which this property describes the sort key attribute
   sortKeyForLSI?: string[]

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

@@ -1,2 +1,2 @@
 // tslint:disable-next-line:interface-over-type-literal
-export type BatchGetResponse = { [tableName: string]: any[] }
+export type BatchGetResponse = Record<string /* tableName */ , any[]>

src/dynamo/dynamo-rx.ts

@@ -76,9 +76,9 @@ export class DynamoRx {
       .pipe(switchMap(() => from(this.dynamoDb.query(params).promise())))
   }
 
-  makeRequest(operation: string, params?: { [key: string]: any }): Observable<any> {
+  makeRequest(operation: string, params?: Record<string, any>): Observable<any> {
     return dynamoEasyConfig.sessionValidityEnsurer()
       .pipe(switchMap(() => from(this.dynamoDb.makeRequest(operation, params).promise())),
-    )
+      )
   }
 }

src/dynamo/dynamo-store.ts

@@ -83,7 +83,7 @@ export class DynamoStore<T> {
     return new TransactGetSingleTableRequest(this.dynamoRx, this.modelClazz, keys)
   }
 
-  makeRequest<Z>(operation: DynamoApiOperations, params?: { [key: string]: any }): Observable<Z> {
+  makeRequest<Z>(operation: DynamoApiOperations, params?: Record<string, any>): Observable<Z> {
     this.logger.debug('request', params)
     return this.dynamoRx.makeRequest(operation, params).pipe(tap(response => this.logger.debug('response', response)))
   }

src/dynamo/expression/condition-expression-builder.ts

@@ -17,7 +17,7 @@ type BuildFilterFn = (
   attributePath: string,
   namePlaceholder: string,
   valuePlaceholder: string,
-  attributeNames: { [key: string]: string },
+  attributeNames: Record<string, string>,
   values: any[],
   existingValueNames: string[] | undefined,
   propertyMetadata: PropertyMetadata<any> | undefined,
@@ -56,7 +56,7 @@ export function deepFilter(obj: any, filterFn: (value: any) => boolean): any {
 
     return returnArr.length ? new Set(returnArr) : null
   } else if (isPlainObject(obj)) {
-    const returnObj: { [key: string]: any } = {}
+    const returnObj: Record<string, any> = {}
 
     forEach(obj, (value: any, key: string) => {
       const item = deepFilter(value, filterFn)
@@ -156,7 +156,7 @@ function buildInConditionExpression(
   attributePath: string,
   namePlaceholder: string,
   valuePlaceholder: string,
-  attributeNames: { [key: string]: string },
+  attributeNames: Record<string, string>,
   values: any[],
   existingValueNames: string[] | undefined,
   propertyMetadata: PropertyMetadata<any> | undefined,
@@ -189,7 +189,7 @@ function buildBetweenConditionExpression(
   attributePath: string,
   namePlaceholder: string,
   valuePlaceholder: string,
-  attributeNames: { [key: string]: string },
+  attributeNames: Record<string, string>,
   values: string[],
   existingValueNames: string[] | undefined,
   propertyMetadata: PropertyMetadata<any> | undefined,
@@ -222,7 +222,7 @@ function buildDefaultConditionExpression(
   attributePath: string,
   namePlaceholder: string,
   valuePlaceholder: string,
-  attributeNames: { [key: string]: string },
+  attributeNames: Record<string, string>,
   values: any[],
   existingValueNames: string[] | undefined,
   propertyMetadata: PropertyMetadata<any> | undefined,

src/dynamo/expression/functions/attribute-names.function.ts

@@ -6,10 +6,10 @@ const NESTED_ATTR_PATH_REGEX = /^.+((\[(\d+)])|(\.)).*$/
 export function resolveAttributeNames(
   attributePath: string,
   propertyMetadata?: PropertyMetadata<any>,
-): { placeholder: string; attributeNames: { [key: string]: string } } {
+): { placeholder: string; attributeNames: Record<string, string> } {
   let placeholder: string
   // tslint:disable-next-line:no-shadowed-variable
-  const attributeNames: { [key: string]: string } = {}
+  const attributeNames: Record<string, string> = {}
   if (NESTED_ATTR_PATH_REGEX.test(attributePath)) {
     // nested attribute with document path (map or list)
     let re

src/dynamo/expression/prepare-and-add-update-expressions.function.ts

@@ -30,7 +30,7 @@ export function prepareAndAddUpdateExpressions(
 
     const actionStatements: string[] = []
     let attributeValues: Attributes = {}
-    let attributeNames: { [key: string]: string } = {}
+    let attributeNames: Record<string, string> = {}
 
     forEach(sortedByActionKeyWord, (value, key) => {
       const statements: string[] = []

src/dynamo/expression/type/expression.type.ts

@@ -1,7 +1,7 @@
 import { Attributes } from '../../../mapper/type/attribute.type'
 
 export interface Expression {
-  attributeNames: { [key: string]: string }
+  attributeNames: Record<string, string>
   attributeValues: Attributes<any>
   statement: string
 }