Skip to content

Latest commit

 

History

History
125 lines (96 loc) · 6.25 KB

CHANGELOG.md

File metadata and controls

125 lines (96 loc) · 6.25 KB
Raw

Lapis Changelog

Unreleased Changes

0.3.3 - August 24, 2024

  • Files now use the .luau extension instead of .lua. (#61)
  • Switched wally realm to shared. This means Lapis can be used as a shared or server dependency. (#62)
  • beforeClose and beforeSave now throw an error if they yield. For more information, see the PR. (#64)
  • Added Collection:remove to remove the data from a document. (#65)
  • Session locks will now be removed from documents if Document:close fails for the following reasons: (#66)
    • beforeSave/beforeClose threw an error.
    • validate threw an error.
    • validate didn't return true.
  • DataStoreKeyInfo:GetMetadata() is now preserved. Before, it would be erased anytime a Document was saved or closed. (#67)

0.3.2 - August 6, 2024

  • Added Collection:read to view a document's data without editing or session locking it. (#59)
  • IMPORTANT: Fixed bug that resets a saved migration version that is ahead of the server's version and is backwards compatible. (#60)

0.3.1 - July 6, 2024

  • Added Document:keyInfo(). It returns the last updated DataStoreKeyInfo returned from loading, saving, or closing the document. (#50)
  • Migrations can now update the data mutably. Note: The value still needs to be returned from the migration function. (#51)
  • Gracefully handle validate throwing an error in Collection:load. Before it would keep retrying the load and spam the console with confusing errors. (#52)
  • Allow defaultData to be a function. The return value will be validated when a new document is created. (#53)
  • Migrations can now be marked as backwardsCompatible. This allows documents to be loaded on servers with an older version as long as they are compatible. For more information, see the docs. (#54)
  • The validate option for collections is now optional. (#56)
  • Add freezeData option to collections to allow mutable updates to documents. (#57)

0.3.0 - April 14, 2024

  • BREAKING CHANGE: Collection:load no longer caches promises. Each call will now return a unique promise and attempt to load the document separately. This is to fix an edge case that can result in data loss. More information can be found in the pull request. (#48)

0.2.11 - April 9, 2024

  • Fix infinite yield in game:BindToClose caused by a document failing to load. (#45)

0.2.10 - March 25, 2024

  • Document:load now infinitely yields and doesn't load the document after game:BindToClose is called. If a document does load because UpdateAsync is called just before game close, it is automatically closed. (#43)

0.2.9 - January 1, 2024

  • Document:close no longer errors when called again and instead returns the original promise. (#35)
    • This is so it won't error when called from PlayerRemoving if game:BindToClose happens to run first.

0.2.8 - December 27, 2023

  • Removed internal compression code since compression is no longer planned (#31)
  • Data is no longer loaded if it doesn't pass the validate function. This means it won't be session locked and migrated. (#32)

0.2.7 - November 12, 2023

  • Add Document:beforeSave callback to make changes to a document before it saves (#29)

0.2.6 - October 24, 2023

  • Added types (#24)
  • Added document:beforeClose callback to make final changes to a document before it closes (#25)
    • This callback works even when the document is closed by game:BindToClose.
  • Added APIs to set a document's DataStoreKeyInfo:GetUserIds() (#26)
    • Changed Collection:load(key: string) to Collection:load(key: string, defaultUserIds: {number}?)
      • defaultUserIds only applies if it's the first time the document has ever been loaded.
    • Added Document:addUserId(userId: number)
    • Added Document:removeUserId(userId: number)

0.2.5 - September 8, 2023

  • Fix existing data not being frozen on load (#20)

0.2.4 - August 3, 2023

  • Fix game:BindToClose not waiting for documents to close

0.2.3 - July 19, 2023

  • Fix silly mistake where I don't return the collection from createCollection

0.2.2 - July 19, 2023

  • Remove write cooldown throttling since write cooldowns were removed (#11)
  • Fix save merging algorithm (#13)
  • Added new throttle queue which allows load/save/close requests from different keys to be processed at the same time (#15)

0.2.1 - June 10, 2023

  • Move TestEZ and DataStoreServiceMock to dev dependencies
  • Remove unused files from published package

0.2.0 - May 24, 2023

  • Renamed Collection:openDocument to Collection:load
  • Renamed retryAttempts config setting to saveAttempts
  • Renamed acquireLockAttempts config setting to loadAttempts
  • Renamed acquireLockDelay config setting to loadRetryDelay
  • Fixed edge case that allowed documents to load even when their migration version exceeded the server's latest migration