fix(util-dynamodb): fix signature overload resolution for marshall() fn

Author: kuhe

packages/util-dynamodb/src/marshall.spec.ts

@@ -1,3 +1,5 @@
+import { AttributeValue } from "@aws-sdk/client-dynamodb";
+
 import { convertToAttr } from "./convertToAttr";
 import { marshall } from "./marshall";
 
@@ -52,6 +54,26 @@ describe("marshall", () => {
     expect(convertToAttr).toHaveBeenCalledWith(input, undefined);
   });
 
+  it("should resolve signatures correctly", () => {
+    // eslint-disable @typescript-eslint/no-unused-vars
+    const ss: AttributeValue.SSMember = marshall(new Set(["a"]));
+    const ns: AttributeValue.NSMember = marshall(new Set([0]));
+    const bs: AttributeValue.BSMember = marshall(new Set([new Uint8Array()]));
+    const s: AttributeValue.SMember = marshall("a");
+    const n: AttributeValue.NMember = marshall(0);
+    const nil: AttributeValue.NULLMember = marshall(null);
+    const bool: AttributeValue.BOOLMember = marshall(false);
+    const array: AttributeValue[] = marshall([]);
+    const object: Record<string, AttributeValue> = marshall({
+      pk: "abc",
+      sk: "xyz",
+    });
+    const unrecognizedClassInstance1: Record<string, AttributeValue> = marshall(new Map());
+    const unrecognizedClassInstance2: Record<string, AttributeValue> = marshall(new Date());
+    const unrecognizedNonClassInstanceValue: AttributeValue.$UnknownMember = marshall(BigInt(0));
+    // eslint-enable @typescript-eslint/no-unused-vars
+  });
+
   it("with class instance as an input", () => {
     class TestInputClass {
       constructor(private readonly a: string, private readonly b: string) {}

packages/util-dynamodb/src/marshall.ts

@@ -39,16 +39,16 @@ export interface marshallOptions {
 export function marshall(data: Set<string>, options?: marshallOptions): AttributeValue.SSMember;
 export function marshall(data: Set<number>, options?: marshallOptions): AttributeValue.NSMember;
 export function marshall(data: Set<NativeAttributeBinary>, options?: marshallOptions): AttributeValue.BSMember;
-export function marshall<M extends { [K in keyof M]: NativeAttributeValue }>(
-  data: M,
-  options?: marshallOptions
-): Record<string, AttributeValue>;
-export function marshall<L extends NativeAttributeValue[]>(data: L, options?: marshallOptions): AttributeValue[];
 export function marshall(data: string, options?: marshallOptions): AttributeValue.SMember;
 export function marshall(data: number, options?: marshallOptions): AttributeValue.NMember;
 export function marshall(data: NativeAttributeBinary, options?: marshallOptions): AttributeValue.BMember;
 export function marshall(data: null, options?: marshallOptions): AttributeValue.NULLMember;
 export function marshall(data: boolean, options?: marshallOptions): AttributeValue.BOOLMember;
+export function marshall<L extends NativeAttributeValue[]>(data: L, options?: marshallOptions): AttributeValue[];
+export function marshall<M extends Record<string, NativeAttributeValue>>(
+  data: M,
+  options?: marshallOptions
+): Record<string, AttributeValue>;
 export function marshall(data: unknown, options?: marshallOptions): AttributeValue.$UnknownMember;
 export function marshall(data: unknown, options?: marshallOptions) {
   const attributeValue: AttributeValue = convertToAttr(data, options);