Merge pull request #697 from jeremydaly/create-primary-key-parser-ope…

…ration

create primary key parser operation

src/v1/operations/deleteItem/deleteItemParams/deleteItemParams.ts

@@ -2,7 +2,7 @@ import type { DeleteCommandInput } from '@aws-sdk/lib-dynamodb'
 
 import type { EntityV2 } from 'v1/entity/class'
 import type { KeyInput } from 'v1/operations/types'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { DeleteItemOptions } from '../options'
@@ -25,7 +25,7 @@ export const deleteItemParams = <
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validKeyInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const options = parseDeleteItemOptions(entity, deleteItemOptions)
 

src/v1/operations/errors.ts

@@ -2,8 +2,8 @@ import type { ErrorBlueprint } from 'v1/errors/blueprint'
 
 import type { ScanCommandErrorBlueprints } from './scan/errors'
 import type { QueryCommandErrorBlueprints } from './query/errors'
-import type { OperationUtilsErrorBlueprints } from './utils/errors'
 import type { ExpressionParsersErrorBlueprints } from './expression/errors'
+import type { PrimaryKeyParserErrorBlueprints } from './primaryKeyParser/errors'
 
 type IncompleteOperationErrorBlueprint = ErrorBlueprint<{
   code: 'operations.incompleteOperation'
@@ -74,7 +74,7 @@ type UnknownOptionErrorBlueprint = ErrorBlueprint<{
 export type OperationsErrorBlueprints =
   | ScanCommandErrorBlueprints
   | QueryCommandErrorBlueprints
-  | OperationUtilsErrorBlueprints
+  | PrimaryKeyParserErrorBlueprints
   | IncompleteOperationErrorBlueprint
   | InvalidCapacityOptionErrorBlueprint
   | InvalidClientRequestTokenOptionErrorBlueprint

src/v1/operations/getItem/getItemParams/getItemParams.ts

@@ -2,7 +2,7 @@ import type { GetCommandInput } from '@aws-sdk/lib-dynamodb'
 
 import type { EntityV2 } from 'v1/entity/class'
 import type { KeyInput } from 'v1/operations/types'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { GetItemOptions } from '../options'
@@ -22,7 +22,7 @@ export const getItemParams = <ENTITY extends EntityV2, OPTIONS extends GetItemOp
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validKeyInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const options = parseGetItemOptions(entity, getItemOptions)
 

src/v1/operations/utils/parsePrimaryKey/errors.ts → src/v1/operations/primaryKeyParser/errors.ts

@@ -10,4 +10,4 @@ type InvalidKeyPartErrorBlueprint = ErrorBlueprint<{
   }
 }>
 
-export type ParsePrimaryKeyErrorBlueprints = InvalidKeyPartErrorBlueprint
+export type PrimaryKeyParserErrorBlueprints = InvalidKeyPartErrorBlueprint

src/v1/operations/primaryKeyParser/index.ts

@@ -0,0 +1 @@
+export { PrimaryKeyParser } from './primaryKeyParser'

src/v1/operations/primaryKeyParser/primaryKeyParser.ts

@@ -0,0 +1,70 @@
+import type { EntityV2 } from 'v1/entity/class'
+import type { Schema } from 'v1/schema/schema'
+import type { ParsedValue } from 'v1/schema/actions/parse'
+import type { PrimaryKey } from 'v1/table/generics'
+import { validatorsByPrimitiveType } from 'v1/utils/validation'
+import { DynamoDBToolboxError } from 'v1/errors/dynamoDBToolboxError'
+
+import { $entity, EntityOperation } from '../class'
+
+// TODO: Move to table operations
+export class PrimaryKeyParser<ENTITY extends EntityV2 = EntityV2> extends EntityOperation<ENTITY> {
+  static operationName = 'parsePrimaryKey' as const
+
+  constructor(entity: ENTITY) {
+    super(entity)
+  }
+
+  parse(keyInput: ParsedValue<Schema, { operation: 'key' }>): PrimaryKey<ENTITY['table']> {
+    const { table } = this[$entity]
+    const { partitionKey, sortKey } = table
+
+    const primaryKey: ParsedValue<Schema, { operation: 'key' }> = {}
+
+    const partitionKeyValidator = validatorsByPrimitiveType[partitionKey.type]
+    const partitionKeyValue = keyInput[partitionKey.name]
+
+    if (!partitionKeyValidator(partitionKeyValue)) {
+      throw new DynamoDBToolboxError('operations.parsePrimaryKey.invalidKeyPart', {
+        message: `Invalid partition key: ${partitionKey.name}`,
+        path: partitionKey.name,
+        payload: {
+          expected: partitionKey.type,
+          received: partitionKeyValue,
+          keyPart: 'partitionKey'
+        }
+      })
+    }
+
+    /**
+     * @debt type "TODO: Make validator act as primitive typeguard"
+     */
+    primaryKey[partitionKey.name] = partitionKeyValue as number | string | Buffer
+
+    if (sortKey === undefined) {
+      return primaryKey as PrimaryKey<ENTITY['table']>
+    }
+
+    const sortKeyValidator = validatorsByPrimitiveType[sortKey.type]
+    const sortKeyValue = keyInput[sortKey.name]
+
+    if (!sortKeyValidator(sortKeyValue)) {
+      throw new DynamoDBToolboxError('operations.parsePrimaryKey.invalidKeyPart', {
+        message: `Invalid sort key: ${sortKey.name}`,
+        path: sortKey.name,
+        payload: {
+          expected: sortKey.type,
+          received: sortKeyValue,
+          keyPart: 'sortKey'
+        }
+      })
+    }
+
+    /**
+     * @debt type "TODO: Make validator act as primitive typeguard"
+     */
+    primaryKey[sortKey.name] = sortKeyValue as number | string | Buffer
+
+    return primaryKey as PrimaryKey<ENTITY['table']>
+  }
+}

src/v1/operations/putItem/putItemParams/putItemParams.ts

@@ -1,7 +1,7 @@
 import type { PutCommandInput } from '@aws-sdk/lib-dynamodb'
 
 import type { EntityV2 } from 'v1/entity/class'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { PutItemInput } from '../types'
@@ -22,7 +22,7 @@ export const putItemParams = <ENTITY extends EntityV2, OPTIONS extends PutItemOp
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const options = parsePutItemOptions(entity, putItemOptions)
 

src/v1/operations/transactions/deleteItem/transactDeleteItemParams/transactDeleteItemParams.ts

@@ -2,7 +2,7 @@ import type { TransactWriteCommandInput } from '@aws-sdk/lib-dynamodb'
 
 import type { EntityV2 } from 'v1/entity/class'
 import type { KeyInput } from 'v1/operations/types'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { DeleteItemTransactionOptions } from '../options'
@@ -29,7 +29,7 @@ export const transactDeleteItemParams = <
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validKeyInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const options = parseDeleteItemTransactionOptions(entity, deleteItemTransactionOptions)
 

src/v1/operations/transactions/putItem/transactPutItemParams/transactPutItemParams.ts

@@ -2,7 +2,7 @@ import type { TransactWriteCommandInput } from '@aws-sdk/lib-dynamodb'
 
 import type { EntityV2 } from 'v1/entity/class'
 import type { PutItemInput } from 'v1/operations/putItem'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { PutItemTransactionOptions } from '../options'
@@ -28,7 +28,7 @@ export const transactPutItemParams = <
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const options = parsePutItemTransactionOptions(entity, putItemTransactionOptions)
 

src/v1/operations/transactions/updateItem/transactUpdateItemParams/transactUpdateItemParams.ts

@@ -6,7 +6,7 @@ import type { EntityV2 } from 'v1/entity/class'
 import type { UpdateItemInput } from 'v1/operations/updateItem'
 import { parseUpdate } from 'v1/operations/updateItem/updateExpression/parse'
 import { parseUpdateExtension } from 'v1/operations/updateItem/updateItemParams/extension/parseExtension'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { UpdateItemTransactionOptions } from '../options'
@@ -36,7 +36,7 @@ export const transactUpdateItemParams = <
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const {
     ExpressionAttributeNames: updateExpressionAttributeNames,

src/v1/operations/updateItem/updateItemParams/updateItemParams.ts

@@ -3,7 +3,7 @@ import isEmpty from 'lodash.isempty'
 import omit from 'lodash.omit'
 
 import type { EntityV2 } from 'v1/entity/class'
-import { parsePrimaryKey } from 'v1/operations/utils/parsePrimaryKey'
+import { PrimaryKeyParser } from 'v1/operations/primaryKeyParser'
 import { Parser } from 'v1/schema/actions/parse'
 
 import type { UpdateItemInput } from '../types'
@@ -31,7 +31,7 @@ export const updateItemParams = <
   const transformedInput = parser.next().value
 
   const keyInput = entity.computeKey ? entity.computeKey(validInput) : transformedInput
-  const primaryKey = parsePrimaryKey(entity, keyInput)
+  const primaryKey = entity.build(PrimaryKeyParser).parse(keyInput)
 
   const {
     ExpressionAttributeNames: updateExpressionAttributeNames,