Installations

npm install objection-visibility

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Pull Requests

Open

7

Total

71

Closed

46

Merged

18

Issues

Open

1

Total

7

Closed

6

Releases

2

v1.1.0

Updated on Jul 29, 2020

init

0.1.0

Updated on Jun 15, 2017

View All 2 releases

Languages

1

TypeScript

TypeScript (100%)

Developer

oscaroox

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

45 Stars

83 Commits

9 Forks

1 Watchers

8 Branches

4 Contributors

Updated on Oct 07, 2023

Maintainers

1

View All 4 Contributors

Package Meta Information

Latest Version

1.2.0

Package Id

objection-visibility@1.2.0

Unpacked Size

15.75 kB

Size

5.70 kB

File Count

19

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

1

objection

Dev Dependencies

15

@types/chai @types/knex @types/lodash.omit @types/lodash.pick @types/mocha @types/node chai knex mocha objection rimraf sqlite3 ts-node tslint typescript

objection-visibility

This plugin adds the ability to whitelist or blacklists model properties.

Installation

1npm install objection-visibility

Usage

You can enable this plugin by either setting the static property hidden or visible to your model.

It is possible to have a model which have both properties defined, note that the visible method is called first and the hidden method second.

Blacklist properties

To enable blacklisting on your model add the static property hidden on your model and return an array with the fields you want to blacklist.

The listed fields are gone after being serialized to json

1const Model = require('objection').Model
2const visibilityPlugin = require('objection-visibility').default;
3
4class User extends visibilityPlugin(Model) {
5  static get hidden() {
6    return ['hashed_password'];
7  }
8}
9

Whitelist properties

To enable whitelisting on your model add a static property visible on your model and return an array with the fields you want to be whitelisted

The listed fields will be the only properties available after being serialized to json

1const Model = require('objection').Model
2const visibilityPlugin = require('objection-visibility').default;
3
4class User extends visibilityPlugin(Model) {
5  static get visible() {
6    return ['firstName', 'id']
7  }
8}

Using with multiple models

Can be used on a base model and have it readily available on all your models

Models that dont have the static properties visible or hidden will remain untouched.

1
2    // base.js
3    class BaseModel extends visibilityPlugin(Model) {}
4
5    // post.js
6    class Post extends BaseModel {
7        static get visible () {
8            return ['description', 'title']
9        }
10    }
11
12    // user.js
13    class User extends BaseModel {
14        static get hidden () {
15            return ['hashedPassword']
16        }
17    }

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More