Add support for sparse indexes

[whimzyLive]

Proposed

When parsing entity indexes, allow for sparse indexes

I.e
for Index with sortKey: PUB_ID#${id} do not auto parse, when index is marked as sparse index

Implementation

• Add sparse index option on @entity -> indexes (ideally isSparse: boolean)
• Allow optional values when parsing sparse marked key
• If parsing an sparse index and referenced variable is missing value, DO NOT ADD partition or sort key attributes for that index

[typedorm-bot]

🎉 This issue has been resolved in version 1.6.0-beta.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[typedorm-bot]

🎉 This issue has been resolved in version 1.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[michael-pont]

Hi @whimzyLive
Just wanted to understand the exact behavior of isSparse
From documentation:

(property) isSparse?: boolean
DynamoDB only adds item to index if both Partition Key and Sort Key defined for any given GSI contains value

Indexes missing sort key value will not be added to index.

However, when I define false for a sparseIndex I expect undefined/optional values to be allowed for sort key

    GSI2: {
      partitionKey: 'COMPANY#{{companyId}}',
      sortKey: 'DEPT#{{deptId}}',
      type: INDEX_TYPE.GSI,
      isSparse: false,
    },

...
  @Attribute()
  companyId: string;

  @Attribute()
  deptId?: string;
...

This is not working though when I try to create a new user with companyId defined but deptId empty.
I get the following error:

"deptId" was referenced in DEPT#{
    {deptId
    }
} but it's value could not be resolved.

Additionally, if i define a default value for deptId, the same error occurs, so it appears as if the code here is running before default value is set.

  @Attribute({
    default: '',
  })
  deptId?: string;

So my question is what exactly is the expected behavior when isSparse: false?

[michael-pont]

As a followup to my previous comment, I observed the opposite behavior with the same entity but a different index:

    GSI3: {
      partitionKey: 'COMPANY#{{companyId}}',
      sortKey: {
        alias: 'officeStatus',
      },
      type: INDEX_TYPE.GSI,
    },

...
  @Attribute({
    default: OfficeStatus.REMOTE,
  })
  officeStatus: OfficeStatus;
...

When I create a user and leave officeStatus undefined it will create the default value for me and will not throw any error like the one from the previous comment. Querying then with PK = companyId and officeStatus = remote works and returns users

[structurr]

I'm running into the same issue as @michael-pont mentioned above. Please allow sort keys to be optional when defining GSIs on a table.