Formatter - support for BigInt

[aaarichter]

I'm using the dynamoDB geo library in combination with dynamoDB toolbox. The geo library is saving hash values like 5159980795834925053 in the geohash attribute. When I query the table entry, the geohash attribute value is returned as geohash: 5159984851327668183n, by the documentClient. Later in the queryCommand code, the formatter.format(item, { attributes }) function fails with the follow error

"Error: Invalid attribute detected while formatting: 'geohash'. Should be a number. Partition key: 515998",
        "    at formatPrimitiveAttrRawValue (/var/task/index.js:30641:11)",
        "    at formatAttrRawValue (/var/task/index.js:30745:14)",
        "    at /var/task/index.js:30781:32",
        "    at Array.forEach (<anonymous>)",
        "    at formatSchemaRawValue (/var/task/index.js:30771:38)",
        "    at Formatter.format (/var/task/index.js:30799:14)",
        "    at EntityFormatter.format (/var/task/index.js:31627:31)",
        "    at _QueryCommand2.send (/var/task/index.js:32099:39)",

A similar issue occurs when putting an item with a large number. DynamoDB toolbox throws here as well

[aaarichter]

https://github.com/dynamodb-toolbox/dynamodb-toolbox/issues/588

[ThomasAribart]

Wow I didn't even know bigint were a thing in DynamoDB 🤦‍♂️ Thanks for reaching out!

I have two ideas in mind:

• Always resolve number() attributes as number | bigint
• OR create a new bigint() atttribute type, that you could use in conjunction with anyOf (anyOf(number(), bigint()))

I think it will depend on:

• Are bigint an extension of number or are they something really different?
• Can bigint be used for indexing?

What do you think?

EDIT:

Well this definitely answers the question: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-2.html#bigint 😅 Will have to create a new primitive

[ThomasAribart]

Actually, because DynamoDB doesn't really differ numbers from bigint, I'll with a number().big() option to allow for big ints.