fix(mapper): use provided db name for property

when creating the key attributes use the db name for property, this is only relevant when a custom name was provided which is different from the js property name in model

Author: michaelwittwer

src/mapper/mapper.spec.ts

@@ -28,9 +28,12 @@ import {
   SimpleModel,
   SimpleWithCompositePartitionKeyModel,
   SimpleWithPartitionKeyModel,
+  SimpleWithRenamedCompositePartitionKeyModel,
+  SimpleWithRenamedPartitionKeyModel,
   StringType,
   Type,
 } from '../../test/models'
+import { ModelWithCombinedDecoratorsModel } from '../../test/models/model-with-combined-decorators.model'
 import { IdMapper } from '../../test/models/model-with-custom-mapper.model'
 import { ModelWithEmptyValues } from '../../test/models/model-with-empty-values'
 import {
@@ -667,10 +670,7 @@ describe('Mapper', () => {
 
       describe('model with autogenerated id', () => {
         it('should create an uuid', () => {
-          const toDbVal: Attributes<ModelWithAutogeneratedId> = toDb(
-            new ModelWithAutogeneratedId(),
-            ModelWithAutogeneratedId,
-          )
+          const toDbVal = toDb(new ModelWithAutogeneratedId(), ModelWithAutogeneratedId)
           expect(toDbVal.id).toBeDefined()
           expect(keyOf(toDbVal.id)).toBe('S')
           // https://stackoverflow.com/questions/7905929/how-to-test-valid-uuid-guid
@@ -680,6 +680,12 @@ describe('Mapper', () => {
         })
       })
 
+      describe('model with combined decorators', () => {
+        const toDbValue: ModelWithCombinedDecoratorsModel = { id: 'idValue' }
+        const mapped = toDb(toDbValue, ModelWithCombinedDecoratorsModel)
+        expect(mapped).toEqual({ custom_id: { S: 'idValue' } })
+      })
+
       describe('model with non string/number/binary keys', () => {
         it('should accept date as HASH or RANGE key', () => {
           const now = new Date()
@@ -978,6 +984,13 @@ describe('Mapper', () => {
       })
     })
 
+    it('PartitionKey only (custom db name)', () => {
+      const attrs = createKeyAttributes(metadataForModel(SimpleWithRenamedPartitionKeyModel), 'myId')
+      expect(attrs).toEqual({
+        custom_id: { S: 'myId' },
+      })
+    })
+
     it('PartitionKey + SortKey', () => {
       const now = new Date()
       const attrs = createKeyAttributes(metadataForModel(SimpleWithCompositePartitionKeyModel), 'myId', now)
@@ -987,6 +1000,15 @@ describe('Mapper', () => {
       })
     })
 
+    it('PartitionKey + SortKey (custom db name)', () => {
+      const now = new Date()
+      const attrs = createKeyAttributes(metadataForModel(SimpleWithRenamedCompositePartitionKeyModel), 'myId', now)
+      expect(attrs).toEqual({
+        custom_id: { S: 'myId' },
+        custom_date: { S: now.toISOString() },
+      })
+    })
+
     it('should throw when required sortKey is missing', () => {
       expect(() => createKeyAttributes(metadataForModel(SimpleWithCompositePartitionKeyModel), 'myId')).toThrow()
     })
@@ -996,17 +1018,27 @@ describe('Mapper', () => {
     it('should throw when model has no defined properties', () => {
       expect(() => createToKeyFn(SimpleModel)).toThrow()
     })
+
     it('should throw when given partial has undefined key properties', () => {
       expect(() => toKey({}, SimpleWithPartitionKeyModel)).toThrow()
       expect(() => toKey({ id: 'myId' }, SimpleWithCompositePartitionKeyModel)).toThrow()
       expect(() => toKey({ creationDate: new Date() }, SimpleWithCompositePartitionKeyModel)).toThrow()
     })
+
     it('should create key attributes of simple key', () => {
       const key = toKey({ id: 'myId' }, SimpleWithPartitionKeyModel)
       expect(key).toEqual({
         id: { S: 'myId' },
       })
     })
+
+    it('should create key attributes of simple key (custom db name)', () => {
+      const key = toKey({ id: 'myId' }, SimpleWithRenamedPartitionKeyModel)
+      expect(key).toEqual({
+        custom_id: { S: 'myId' },
+      })
+    })
+
     it('should create key attributes of composite key', () => {
       const partial: Partial<SimpleWithCompositePartitionKeyModel> = { id: 'myId', creationDate: new Date() }
       const key = toKey(partial, SimpleWithCompositePartitionKeyModel)
@@ -1015,6 +1047,16 @@ describe('Mapper', () => {
         creationDate: { S: partial.creationDate!.toISOString() },
       })
     })
+
+    it('should create key attributes of composite key (custom db name)', () => {
+      const partial: Partial<SimpleWithRenamedCompositePartitionKeyModel> = { id: 'myId', creationDate: new Date() }
+      const key = toKey(partial, SimpleWithRenamedCompositePartitionKeyModel)
+      expect(key).toEqual({
+        custom_id: { S: partial.id! },
+        custom_date: { S: partial.creationDate!.toISOString() },
+      })
+    })
+
     it('should create key with custom mapper', () => {
       const partial: ModelWithCustomMapperModel = { id: new Id(7, 2018) }
       const key = toKey(partial, ModelWithCustomMapperModel)

src/mapper/mapper.ts

@@ -167,7 +167,7 @@ export function createToKeyFn<T>(modelConstructor: ModelConstructor<T>): (item:
           throw new Error(`there is no value for property ${propMeta.name.toString()} but is ${propMeta.key.type} key`)
         }
         const propertyValue = getPropertyValue(item, propMeta.name)
-        key[propMeta.name] = <Attribute>toDbOne(propertyValue, propMeta)
+        key[propMeta.nameDb] = <Attribute>toDbOne(propertyValue, propMeta)
         return key
       },
       <Attributes<T>>{},
@@ -192,16 +192,27 @@ export function createKeyAttributes<T>(
 ): Attributes<Partial<T>> {
   const partitionKeyProp = metadata.getPartitionKey()
 
+  const partitionKeyMetadata = metadata.forProperty(partitionKeyProp)
+
+  if (!partitionKeyMetadata) {
+    throw new Error('metadata for partition key must be defined')
+  }
+
   const keyAttributeMap = <Attributes<T>>{
-    [partitionKeyProp]: toDbOne(partitionKey, metadata.forProperty(partitionKeyProp)),
+    [partitionKeyMetadata.nameDb]: toDbOne(partitionKey, partitionKeyMetadata),
   }
 
   if (hasSortKey(metadata)) {
     if (sortKey === null || sortKey === undefined) {
       throw new Error(`please provide the sort key for attribute ${metadata.getSortKey()}`)
     }
     const sortKeyProp = metadata.getSortKey()
-    keyAttributeMap[sortKeyProp] = <Attribute>toDbOne(sortKey, metadata.forProperty(sortKeyProp))
+    const sortKeyMetadata = metadata.forProperty(sortKeyProp)
+    if (!sortKeyMetadata) {
+      throw new Error('metadata for sort key must be defined')
+    }
+
+    keyAttributeMap[sortKeyMetadata.nameDb] = <Attribute>toDbOne(sortKey,sortKeyMetadata)
   }
 
   return keyAttributeMap

test/models/simple-with-composite-partition-key.model.ts

@@ -1,4 +1,4 @@
-import { DateProperty, Model, PartitionKey, SortKey } from '../../src/dynamo-easy'
+import { DateProperty, Model, PartitionKey, Property, SortKey } from '../../src/dynamo-easy'
 
 @Model()
 export class SimpleWithCompositePartitionKeyModel {
@@ -11,3 +11,16 @@ export class SimpleWithCompositePartitionKeyModel {
 
   age: number
 }
+
+@Model()
+export class SimpleWithRenamedCompositePartitionKeyModel {
+  @PartitionKey()
+  @Property({ name: 'custom_id' })
+  id: string
+
+  @SortKey()
+  @DateProperty({ name: 'custom_date' })
+  creationDate: Date
+
+  age: number
+}

test/models/simple-with-partition-key.model.ts

@@ -1,4 +1,4 @@
-import { Model, PartitionKey } from '../../src/dynamo-easy'
+import { Model, PartitionKey, Property } from '../../src/dynamo-easy'
 
 @Model()
 export class SimpleWithPartitionKeyModel {
@@ -7,3 +7,12 @@ export class SimpleWithPartitionKeyModel {
 
   age: number
 }
+
+@Model()
+export class SimpleWithRenamedPartitionKeyModel {
+  @PartitionKey()
+  @Property({ name: 'custom_id' })
+  id: string
+
+  age: number
+}