fix(types): inline the KeyType from '@aws-sdk/client-dynamodb'

since the external one caused runtime issues, needs investigation
shiftcode · Mar 20, 2023 · b85e0b5 · b85e0b5
1 parent 2ec7c3f
commit b85e0b5
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 17 deletions.
diff --git a/src/aws-sdk-v2.types.ts b/src/aws-sdk-v2.types.ts
@@ -13,3 +13,9 @@ export type ExpressionAttributeValueMap = { [key: string]: AttributeValue /* was
 export type AttributeMap = { [key: string]: AttributeValue }
 
 export type Key = { [key: string]: AttributeValue }
+
+// FIXME somehow the import of KeyType from @aws-sdk/client-dynamodb does not work at runtime
+export enum KeyType {
+  HASH = 'HASH',
+  RANGE = 'RANGE',
+}
diff --git a/src/decorator/impl/index/gsi-partition-key.decorator.ts b/src/decorator/impl/index/gsi-partition-key.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import { KeyType } from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { IndexType } from './index-type.enum'
 import { initOrUpdateIndex } from './util'
 

diff --git a/src/decorator/impl/index/gsi-sort-key.decorator.ts b/src/decorator/impl/index/gsi-sort-key.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import { KeyType } from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { IndexType } from './index-type.enum'
 import { initOrUpdateIndex } from './util'
 

diff --git a/src/decorator/impl/index/lsi-sort-key.decorator.ts b/src/decorator/impl/index/lsi-sort-key.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import { KeyType } from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { IndexType } from './index-type.enum'
 import { initOrUpdateIndex } from './util'
 

diff --git a/src/decorator/impl/index/util.ts b/src/decorator/impl/index/util.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import * as DynamoDB from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { PropertyMetadata } from '../../metadata/property-metadata.model'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'
 import { KEY_PROPERTY } from '../property/key-property.const'
@@ -12,7 +12,7 @@ import { IndexType } from './index-type.enum'
  */
 export interface IndexData {
   name: string
-  keyType: DynamoDB.KeyType
+  keyType: KeyType
 }
 
 /**
@@ -47,10 +47,7 @@ export function initOrUpdateIndex(indexType: IndexType, indexData: IndexData, ta
 /**
  * @hidden
  */
-function initOrUpdateGSI(
-  indexes: Record<string, DynamoDB.KeyType>,
-  indexData: IndexData,
-): Partial<PropertyMetadata<any>> {
+function initOrUpdateGSI(indexes: Record<string, KeyType>, indexData: IndexData): Partial<PropertyMetadata<any>> {
   if (indexes[indexData.name]) {
     // TODO INVESTIGATE when we throw an error we have a problem where multiple different classes extend one base class, this will be executed multiple times
     // throw new Error(

diff --git a/src/decorator/impl/key/partition-key.decorator.ts b/src/decorator/impl/key/partition-key.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import { KeyType } from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { createOptModelLogger } from '../../../logger/logger'
 import { PropertyMetadata } from '../../metadata/property-metadata.model'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'

diff --git a/src/decorator/impl/key/sort-key.decorator.ts b/src/decorator/impl/key/sort-key.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import { KeyType } from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { initOrUpdateProperty } from '../property/init-or-update-property.function'
 
 export function SortKey(): PropertyDecorator {

diff --git a/src/decorator/impl/model/model.decorator.ts b/src/decorator/impl/model/model.decorator.ts
@@ -1,7 +1,7 @@
 /**
  * @module decorators
  */
-import * as DynamoDB from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../../aws-sdk-v2.types'
 import { kebabCase } from '../../../helper/kebab-case.function'
 import { ModelMetadata } from '../../metadata/model-metadata.model'
 import { PropertyMetadata } from '../../metadata/property-metadata.model'
@@ -63,7 +63,7 @@ export function Model(opts: ModelData = {}): ClassDecorator {
  */
 function testForGSI<T>(
   property: PropertyMetadata<T>,
-): property is PropertyMetadata<T> & { keyForGSI: Record<string, DynamoDB.KeyType> } {
+): property is PropertyMetadata<T> & { keyForGSI: Record<string, KeyType> } {
   return !!(property.keyForGSI && Object.keys(property.keyForGSI).length)
 }
 

diff --git a/src/decorator/metadata/property-metadata.model.ts b/src/decorator/metadata/property-metadata.model.ts
@@ -1,7 +1,7 @@
 /**
  * @module metadata
  */
-import * as DynamoDB from '@aws-sdk/client-dynamodb'
+import { KeyType } from '../../aws-sdk-v2.types'
 import { MapperForType } from '../../mapper/for-type/base.mapper'
 import { Attribute } from '../../mapper/type/attribute.type'
 import { ModelConstructor } from '../../model/model-constructor'
@@ -12,7 +12,7 @@ export interface TypeInfo {
 }
 
 export interface Key {
-  type: DynamoDB.KeyType
+  type: KeyType
 }
 
 export interface PropertyMetadata<T, R extends Attribute = Attribute> {
@@ -41,7 +41,7 @@ export interface PropertyMetadata<T, R extends Attribute = Attribute> {
   mapperForSingleItem?: () => MapperForType<any, any>
 
   // maps the index name to the key type to describe for which GSI this property describes a key attribute
-  keyForGSI?: Record<string, DynamoDB.KeyType>
+  keyForGSI?: Record<string, KeyType>
 
   // holds all the the index names for which this property describes the sort key attribute
   sortKeyForLSI?: string[]

diff --git a/tools/tslint/test/test.ts.lint b/tools/tslint/test/test.ts.lint
@@ -2,4 +2,4 @@ import * as moment from 'moment'
 import * as DynamoDB from 'aws-sdk'
 import { Config } from 'aws-sdk'
 import { Key } from 'aws-sdk/clients/dynamodb'
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [only wildcard import (import * as DynamoDB from 'aws-sdk/clients/dynamodb') is allowed for this module]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [only wildcard import (import * as DynamoDB from '@aws-sdk/client-dynamodb') is allowed for this module]