https://github.com/alecperkins/sequelize-strict-attributes
Plugin that configures Sequelize to throw when accessing attributes omitted from a select.
https://github.com/alecperkins/sequelize-strict-attributes
plugin sequelize
Last synced: about 2 months ago
JSON representation
Plugin that configures Sequelize to throw when accessing attributes omitted from a select.
- Host: GitHub
- URL: https://github.com/alecperkins/sequelize-strict-attributes
- Owner: alecperkins
- License: mit
- Created: 2023-03-23T00:17:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T14:11:12.000Z (about 2 years ago)
- Last Synced: 2025-03-17T23:15:04.442Z (2 months ago)
- Topics: plugin, sequelize
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/sequelize-strict-attributes
- Size: 303 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# sequelize-strict-attributes
[](https://www.npmjs.com/package/sequelize-strict-attributes) [](https://github.com/alecperkins/sequelize-strict-attributes) [](https://github.com/alecperkins/sequelize-strict-attributes/blob/main/LICENSE) [](https://github.com/alecperkins/sequelize-strict-attributes/actions/workflows/test.yml)
`sequelize-strict-attributes` is a plugin for [Sequelize](https://sequelize.org) that adds stricter treatment of attribute access after [specifying attributes](https://sequelize.org/docs/v6/core-concepts/model-querying-basics/#specifying-attributes-for-select-queries) in a query. This way, attempts to access instance attributes omitted from the query using `attributes` will throw rather than silently failing by returning undefined. This is especially useful for scenarios where the column is expected to sometimes be null so a fallback value is provided for calculations.
_Note: this is a runtime check. Types are included for the plugin itself, but the types of the returned instances will not be changed. To type checking, the instances will appear to still have omitted attributes._
## Installation
`npm install sequelize-strict-attributes`
and include as a JavaScript or TypeScript module (types included):
```typescript
import sequelizeStrictAttributes from 'sequelize-strict-attributes';
```
…or a CommonJS module:
```javascript
const sequelizeStrictAttributes = require('sequelize-strict-attributes');
```
Supports the latest stable Sequelize, version 6.
## Usage
Call the plugin with the active Sequelize instance immediately after it's instantiated.
```javascript
const sequelize = new Sequelize(…);
sequelizeStrictAttributes(sequelize);
```
From this point on, any `Model.findAll` or `Model.findOne` query that specifies `attributes:`—and does not use `raw: true`—will throw if you try to access an attribute not included in the select list.
### Example
For example, given a model that looks something like this:
```javascript
const Cart = sequelize.define("Cart", {
subtotal: DataTypes.STRING,
tax: DataTypes.INTEGER,
});
```
And an instance fetched like this:
```javascript
const cart = await Cart.findOne({
attributes: ["subtotal"],
});
```
When accessing the omitted attribute to determine if `tax` needs to be calculated, the program will throw:
```javascript
if (cart.tax === null) { // <-- Throws!
cart.tax = cart.subtotal * TAX_RATE;
}
```
```javascript
if (cart.get("tax") === null) { // <-- Also throws
```
### Includes
Included models will similarly be restricted if their attributes are specified on the `include`.
```javascript
const cart = await Cart.findOne({
attributes: [],
include: {
model: Customer,
attributes: ["name"],
},
});
await sendReceiptEmail({
name: cart.Customer.name,
email: cart.Customer.email, // <-- Throws here!
});
```
### Setting attributes
Setting the attribute directly or using `Model::set` will still work. These changes can be saved as expected, though you won't be able to read them back on the same instance, even after a `.reload()`. (Though shortcuts like addition–assignment will naturally throw.)
## Motivation
Disallowing access of attributes that were excluded from a select is a common feature of other ORMs for good reason (eg [Prisma](https://www.prisma.io/docs/concepts/components/prisma-client/select-fields#select-specific-fields) excludes it from the returned type, [ActiveRecord](https://guides.rubyonrails.org/active_record_querying.html#selecting-specific-fields) and [Django](https://docs.djangoproject.com/en/dev/ref/models/querysets/#values) throw errors on access). However, the Sequelize authors [declined to support it](https://github.com/sequelize/sequelize/issues/12108) in the core library. In lieu of core support, this plugin will help guard against the hazard.
## Author
[Alec Perkins](https://alecperkins.net)
## License
This package is licensed under the [MIT License](https://opensource.org/licenses/MIT).
See `./LICENSE` for more information.