Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Collection.values, fix editField and file return types, fix bad fields showing up in some searches #18

Merged
merged 14 commits into from
Feb 22, 2024
Merged
67 changes: 65 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,75 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [1.10.2] - 2023-21-07
## [Unreleased]

### 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.
- Use 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 `WriteConfirmation`s 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 package of node
- crypto module as it is now deprecated and a built-in node package
134 changes: 61 additions & 73 deletions README.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@
"axios": "^1.6.7"
},
"devDependencies": {
"chai": "^4.3.10",
"chai": "^4.4.1",
"docdash": "^2.0.2",
"form-data": "^4.0.0",
"glob": "^10.3.10",
"jsdoc": "^4.0.2",
"jsdoc-to-markdown": "^8.0.1",
"mocha": "^10.2.0",
"mocha": "^10.3.0",
"nyc": "^15.1.0",
"prettier": "^3.2.4",
"prettier": "^3.2.5",
"recursive-copy": "^2.0.14",
"typescript": "^5.3.3"
}
Expand Down
Loading
Loading