Merge pull request #120 from shiftcode/#85-cleanup

#85 cleanup

Author: Simon Mumenthaler

.lintstagedrc.yml

@@ -5,7 +5,7 @@ linters:
     - git add
   "(src/**/*.spec.ts|test/**/*.ts)":
     - prettier --write --config ./.prettierrc.yml
-    # FIXME tslint will not work because of the following error
+    # TODO LOW tslint will not work because of the following error
     # ✖ tslint --project ./tsconfig.jest.json -t codeFrame --fix found some errors. Please fix them and try committing again.
     #'/Users/michaelwittwer/dev/shiftcode/dynamo-easy/test/models/complex.model.ts' is not included in project.
     # - tslint --project ./tsconfig.jest.json -t codeFrame --fix

src/decorator/decorators.spec.ts

@@ -13,13 +13,11 @@ import {
   ModelWithABunchOfIndexes,
   ModelWithCustomMapperModel,
   ModelWithEnum,
-  ModelWithEnumDeclared,
   ModelWithGSI,
   NestedObject,
   SimpleModel,
 } from '../../test/models'
 import { Form } from '../../test/models/real-world'
-import { EnumType } from '../mapper'
 import { GSIPartitionKey, GSISortKey, LSISortKey, PartitionKey, Property, SortedSet, SortKey, Transient } from './impl'
 import { Model } from './impl/model/model.decorator'
 import { Metadata, metadataForClass, metadataForModel, ModelMetadata } from './index'
@@ -336,20 +334,6 @@ describe('Decorators should add correct metadata', () => {
     })
   })
 
-  describe('enum', () => {
-    let metadata: Metadata<ModelWithEnumDeclared>
-
-    beforeEach(() => {
-      metadata = metadataForClass(ModelWithEnumDeclared)
-    })
-
-    it('should add enum type to property', () => {
-      const enumPropertyMetadata = metadata.forProperty('type')!
-      expect(enumPropertyMetadata.typeInfo).toBeDefined()
-      expect(enumPropertyMetadata.typeInfo).toEqual({ type: EnumType, isCustom: true })
-    })
-  })
-
   describe('with inheritance', () => {
     it('should override the table name', () => {
       @Model({ tableName: 'super-table-name' })

src/decorator/impl/enum/enum.decorator.ts

@@ -4,8 +4,6 @@ export * from './collection/typed-set.decorator'
 export * from './collection/typed-array.decorator'
 // date
 export * from './date/date.decorator'
-// enum
-export * from './enum/enum.decorator'
 // index
 export * from './index/secondary-index'
 export * from './index/gsi-partition-key.decorator'

src/decorator/impl/index.ts

@@ -50,11 +50,6 @@ export interface PropertyMetadata<T, R extends Attribute = Attribute> {
   transient?: boolean
 }
 
-// todo: fixme
-// export function hasSortKey(propertyMetadata: PropertyMetadata<any, any>): propertyMetadata is PropertyMetadata<any, any> & {} {
-//   return propertyMetadata.getSortKey() !== null
-// }
-
 export function hasGenericType(
   propertyMetadata?: PropertyMetadata<any, any>,
 ): propertyMetadata is PropertyMetadata<any, any> & { typeInfo: { genericType: ModelConstructor<any> } } {

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

@@ -81,8 +81,7 @@ export function buildFilterExpression(
   existingValueNames: string[] | undefined,
   metadata: Metadata<any> | undefined,
 ): Expression {
-  // TODO LOW:INVESTIGATE is there a use case for undefined desired to be a value
-  // metadata rid of undefined values
+  // metadata get rid of undefined values
   values = deepFilter(values, value => value !== undefined)
 
   // check if provided values are valid for given operator
@@ -229,7 +228,7 @@ function buildDefaultConditionExpression(
     let attribute: Attribute | null
     switch (operator) {
       case 'contains':
-        // TODO think about validation
+        // TODO LOW:VALIDATION think about concept
         // validateValueForContains(values[0], propertyMetadata)
         attribute = toDbOne(values[0], propertyMetadata)
         break
@@ -301,14 +300,14 @@ function validateValues(operator: ConditionOperator, values?: any[]) {
   }
 }
 
-// TODO should we support other types than String, Number, Binary (can we search a boolean set for example with boolean as string?)
+// TODO LOW:VALIDATION should we support other types than String, Number, Binary (can we search a boolean set for example with boolean as string?)
 // private static validateValueForContains(value: any, propertyMetadata?: PropertyMetadata<any>): { S: string } {
 //   let finalValue: { S: string }
 //   if (propertyMetadata && propertyMetadata.typeInfo) {
 //     switch (propertyMetadata.typeInfo.type) {
 //       case Array:
 //       case Set:
-//         // FIXME REVIEW the validation logic
+//         // TODO LOW:VALIDATION REVIEW the validation logic
 //         // const genericType = propertyMetadata.typeInfo.genericType
 //         // if ((!genericType && (typeof value === 'number' || typeof value === 'string' || typeof value === '')) || (
 //         //   genericType &&

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

@@ -12,7 +12,7 @@ import { ConditionOperator } from './type/condition-operator.type'
 import { ExpressionType } from './type/expression-type.type'
 import { Expression } from './type/expression.type'
 import { RequestConditionFunction } from './type/request-condition-function'
-import { RequestSortKeyConditionFunction } from './type/sort-key-condition-function'
+import { SortKeyConditionFunction } from './type/sort-key-condition-function'
 import { UpdateActionDef } from './type/update-action-def'
 import { UPDATE_ACTION_DEFS } from './type/update-action-defs.const'
 import {
@@ -44,19 +44,19 @@ export function addCondition<R extends ConditionalParamsHost>(
 export function addSortKeyCondition<R extends ConditionalParamsHost>(
   keyName: keyof any,
   request: R,
-): RequestSortKeyConditionFunction<R>
+): SortKeyConditionFunction<R>
 
 export function addSortKeyCondition<T, R extends ConditionalParamsHost>(
   keyName: keyof T,
   request: R,
   metadata: Metadata<T>,
-): RequestSortKeyConditionFunction<R>
+): SortKeyConditionFunction<R>
 
 export function addSortKeyCondition<T, R extends ConditionalParamsHost>(
   keyName: keyof T,
   request: R,
   metadata?: Metadata<T>,
-): RequestSortKeyConditionFunction<R> {
+): SortKeyConditionFunction<R> {
   const f = (operator: ConditionOperator) => {
     return (...values: any[]): R => {
       return doAddCondition('KeyConditionExpression', <string>keyName, request, metadata, operator, ...values)

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

@@ -10,7 +10,6 @@ export * from './expression-type.type'
 export * from './function-operator.type'
 export * from './request-condition-function'
 export * from './sort-key-condition-function'
-export * from './sort-key-condition-function.type'
 export * from './update-action.type'
 export * from './update-action-def'
 export * from './update-action-defs.const'

src/dynamo/expression/type/index.ts

@@ -11,11 +11,7 @@ import { ConditionalParamsHost } from '../../operation-params.type'
  *      begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand.
  *      (You cannot use this function with a sort key that is of formType Number.) Note that the function name begins_with is case-sensitive.
  */
-
-export interface RequestSortKeyConditionFunction<R extends ConditionalParamsHost> {
-  // TODO LOW:TYPINGS narrow typing when possible -> https://github.com/Microsoft/TypeScript/issues/13573
-  // [key in OperatorAlias]: (...value: any[]) => R;
-  [key: string]: (...value: any[]) => R
+export interface SortKeyConditionFunction<R extends ConditionalParamsHost> {
   equals: (value: any) => R
   eq: (value: any) => R
   lt: (value: any) => R