Recent reordering of marshall function overload signatures returns incorrect signature

[jeremydaly]

Checkboxes for prior research

• I've gone through Developer Guide and API reference
• I've checked AWS Forums and StackOverflow.
• I've searched for previous similar issues and didn't find any solution.

Describe the bug

The change made in commit cb4a0e3 incorrectly reorders the overload that returns AttributeValue[] type instead of Record<string, AttributeValue> when passing in a JavaScript object to be marshalled.

SDK version number

@aws-sdk/util-dynamodb@3.363.0

Which JavaScript Runtime is this issue in?

Node.js

Details of the browser/Node.js/ReactNative version

v18.15.0

Reproduction Steps

import { marshall } from '@aws-sdk/util-dynamodb';

const data = {
  pk: 'abc',
  sk: 'xyz'
}

const ExpressionAttributeValues = marshall(data);

Observed Behavior

The code above assigns ExpressionAttributeValues a type of AttributeValue[].

Expected Behavior

ExpressionAttributeValues should be assigned a type of Record<string, AttributeValue>.

Possible Solution

Swap the two overload signatures so that the one returning Record<string, AttributeValue> takes precedence. Otherwise this breaks a lot of existing implementations.

Additional Information/Context

No response

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

[kuhe]

In review, I don't see how this issue was possible.

The resolution order was

export function marshall<L extends NativeAttributeValue[]>(data: L, options?: marshallOptions): AttributeValue[];
export function marshall<M extends { [K in keyof M]: NativeAttributeValue }>(
  data: M,
  options?: marshallOptions
): Record<string, AttributeValue>;

and object literals do not match XYZ[] (array) types.

[kuhe]

it's possible the object was typed as any in code not shown, which matches array signatures