Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 4.32 KB

CHANGELOG.md

File metadata and controls

114 lines (78 loc) · 4.32 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.13.0] - 2024-05-09

Added

  • Exposed Collection.collectionName as a readonly property for TypeScript usage.
  • TypeScript overview to the README.
  • Optional replacement argument for array-splice edit fields.
  • array-contains-none option for array fields.
  • Optional constructor for the JSONDatabase PHP class to reduce repetitive code.
  • "Advanced" section to the README for previously undocumented features.
  • original option for readRaw to not insert ID fields, for easier non-relational collection usage.

Changed

  • Rejected incorrect parameters are now TypeErrors instead of regular Errors.
  • Deprecated firestorm.table(name) method, since firestorm.collection(name) does exactly the same thing.
  • Reformatted the repository and improved README.md to make it easier to set up Firestorm.
  • Clean up and standardize JSDoc comments.
  • editField and editFieldBulk now return confirmations like all other write methods.
  • editField and editFieldBulk now reject with a descriptive error message on failure rather than silently failing.

Fixed

  • PHP-level errors not being rejected properly in GET requests.
  • Certain write commands mutating data internally and affecting parameters outside Firestorm.
  • Collection.searchKeys and Collection.values not returning proper Error objects sometimes.
  • files.upload not allowing the form-data package's typing of FormData in TypeScript.
  • Inconsistent use of indentation and formatting in PHP files.
  • Various typos in PHP files.
  • Collection class being exported in TypeScript despite the actual class being private.
  • array-splice edit fields being incorrectly typed as array-slice.
  • Platform-specific PHP error when searching nested keys.
  • Collection.remove rejecting numeric keys, despite Collection.removeBulk not doing so.
  • editField and editFieldBulk validation issues.

[1.12.0] - 2024-02-22

Added

  • Collection.values method, which gets all distinct non-null values for a given key across a collection.

Changed

  • Refactored JavaScript part to be less verbose and reuse existing code better.
  • Added JSDoc {@link } properties.
  • Cleaned up and clarified README.md.
  • Renamed AllCriteria to AnyCriteria to be more accurate.
  • Replaced broken NoMethods<T> type with a more generalized RemoveMethods<T> type.
  • Replaced Writable<T> with more specific Settable<T> and Addable<T> types for set and add operations respectively.
  • Collection.select now picks the correct return parameters directly instead of returning a partial object.

Fixed

  • Ran everything through a spelling checker.
  • Method fields are no longer shown as valid in searches and selections.
  • Collection.editField and Collection.editFieldBulk now return confirmations like the other write methods.
  • files.upload and files.delete extract the Axios request and return WriteConfirmations like all other methods.

[1.11.1] - 2024-02-12

Fixed

  • Write methods being annotated as returning elements rather than confirmations
  • Missing Collection.select return type.
  • Make the JavaScript and TypeScript JSDoc entirely consistent.
  • Fix file namespace being declared as an abstract class rather than a constant object.

[1.11.0] - 2023-12-17

Changed

  • Deprecated Collection.read_raw and Collection.write_raw methods in favor of their camelCased counterparts.
  • Changed type casing style to PascalCase everywhere.
  • Use ES6 method notation everywhere.

Removed

  • Raw<T> type in favor of Record<K, V>.

Fixed

  • Broken Exception types
  • Prettier not running on TypeScript files
  • Nested keys not being typed properly
  • Fix file namespace

[1.10.3] - 2023-11-01

Added

  • Prettier

Fixed

  • Updated and cleaned up README.md
  • Fixed types being placed under wrong namespace

[1.10.2] - 2023-07-21

Changed

  • Updated README.md with working badges
  • Moved to pnpm for dependency version w/ tests

Removed

  • crypto module as it is now deprecated and a built-in node package