electrodb - npm Package Versions

[2.9.1]

Fixed

• Version 2.9.0 was accidentally published without the dependency @aws-sdk/lib-dynamodb

[2.9.0]

Added

• Addresses Issue #277 Introduces new composite() method for update and patch operations. The composite method is used to help electrodb complete and format keys when updating a subset of the key's composite attributes. Prior to this update, updating a key partially resulted in an invalid query error, which caused difficulties when some composite attributes were flagged as readOnly. [read more]
• Adds more deliberate collection validation to ensure entity compatibility. This will allow for indexes defined with "template" be used with collections. This also might cause some existing implementations to now throw on service instantiation, however that would mean these services were never valid to begin with.

[2.8.2] - 2023-08-19

Fixed

• Fixes bug reported via Issue #281: ElectroDB failed to use an attribute's field name when it was updated via watch.
• Fixes bug reported via Issue #229: ElectroDB would generate empty string keys on item creating. This would occur only in cases where a key's field name matched an attribute's field name.

Changed

• Relaxes validation surrounding the use of composite attributes appearing as composite attributes in both the partition and sort key for the same index. Reported in Issue#265, validation surrounding this pattern have been relaxed to only throw when a composite attribute in both the pk and sk AND the sk contains greater than one composite attribute. This constraint is critical for ElectroDB to reliably generate/format sort key values.

[2.8.1] - 2023-08-06

Fixed

• Fixes bug with creating sets when client is provided or changed after initial Entity construction

[2.8.0] - 2023-08-06

Adds

• Adds new cast option for indexes to allow users to cast index values to a different type than their composite attribute. This change comers from a user requested feature and addresses issue #237

Fixed

• Fixed edge case when model defines an index without composites while using the template syntax that prevented ignoreOwnership from correctly gating return records

[2.7.2] - 2023-07-03

Fixed

• Fixed bug reported via Issue #271: Root map object with required flag would not set empty object even when it was provided.

[2.7.1] - 2023-07-03

Fixed

• Upsert now only allies if_not_exists() if the attribute is not a composite attribute in an index.

[2.7.0] - 2023-07-01

Fixed

• Fixes return typing for delete, remove, update and upsert operations. These types were incorrect and did not reflect the real values returned. Instead of breaking the APIs, changing response types to T | null, the new response type is now the Entity's key composite values by default. You can also now use the Execution Option response to get back the item as it exists in the table. This is the closed I could get to a non-breaking change that also fixes the incorrect return typing for these methods.
• Fixes typing for contains where conditions to accept collection element values (e.g., set and list type attributes).
• The exported type UpdateEntityItem was incorrectly typed, it now includes the correct typing as the values that can be passed to the set method

Changed

• Upsert operations now take into consideration readOnly attributes when applying changes. If an attribute is configured as readOnly ElectroDB will apply the property with an if_not_exists set operation to prevent overwriting the existing value if one is set.

[2.6.1] - 2023-06-09

Added

• For queries, ElectroDB now trims the ExclusiveStartKey object to only include the keys associated with the index provided. DynamoDB currently rejects queries when properties not associated with the keys of the queried index are provided on the ExclusiveStartKey. By removing irrelevant properties, ElectroDB offers users more flexibility and opportunities for dynamic querying.

[2.6.0] - 2023-05-22

Added

• Adds new query execution option hydrate. When a GSI uses a KEYS_ONLY projection, the hydrate option will perform the query and then a subsequent batchGet to "hydrate" the results.
• Adds new conversion methods to help transform values between "composite attributes", "keys", and "cursors".
• Adds improved return typing for patch operations. The response type for patch now returns an Entity item when passed the execution options { response: 'all_new' } or { response: 'all_old' }.

Fixed

• A common issue amongst new users, was unexpected errors when using a terminal method twice on a query chain. This would often come up when a user called .params() to log out parameters and then call .go() on the same chain. The fix was to prevent duplicative side effects from occurring on each subsequent terminal method call.
• Fixes typing issue with transactGet api that would type response.data as never when the transaction included more than one element.