Gathering detailed insights and metrics for mst-persist
Gathering detailed insights and metrics for mst-persist
Persist and hydrate MobX-state-tree stores (in < 100 LoC)
Installations
npm install mst-persistDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
18.16.1
NPM Version
9.5.1
Score
72.4
Supply Chain
96.9
Quality
75.7
Maintenance
100
Vulnerability
100
License
Releases
7
v0.1.4 -- more permissive MST peerDep
v0.1.4
Updated on Jul 13, 2023
v0.1.3 -- fixes missing __esModule in CJS
v0.1.3
Updated on Dec 04, 2019
v0.1.2 -- fixes `jsonify: false` and localStorage `Illegal Invocation` errors
v0.1.2
Updated on Nov 19, 2019
v0.1.1 -- fixes/enables support for Node usage
v0.1.1
Updated on Jul 27, 2019
v0.1.0 -- adds types and new build variants
v0.1.0
Updated on Jul 14, 2019
v0.0.2 -- fixes bug when key does not yet exist in storage
v0.0.2
Updated on Jul 07, 2019
Languages
1
TypeScript
TypeScript (100%)
Developer
agilgur5
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
NOASSERTION License
86 Stars
67 Commits
17 Forks
4 Watchers
4 Branches
2 Contributors
Updated on Dec 21, 2024
Maintainers
1
Package Meta Information
Latest Version
0.1.4
Package Id
mst-persist@0.1.4
Unpacked Size
33.74 kB
Size
7.37 kB
File Count
12
NPM Version
9.5.1
Node Version
18.16.1
Published on
Jul 13, 2023
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
mst-persist
Persist and hydrate MobX-state-tree stores.
Installation
1npm i -S mst-persist
Usage
1import { types } from 'mobx-state-tree' 2import localForage from 'localForage' 3import { persist } from 'mst-persist' 4 5const SomeStore = types.model('Store', { 6 name: 'John Doe', 7 age: 32 8}) 9 10const someStore = SomeStore.create() 11 12persist('some', someStore, { 13 storage: localForage, // or AsyncStorage in react-native. 14 // default: localStorage 15 jsonify: false // if you use AsyncStorage, this shoud be true 16 // default: true 17 whitelist: ['name'] // only these keys will be persisted 18}).then(() => console.log('someStore has been hydrated')) 19
API
persist(key, store, options)
-
arguments
- key string The key of your storage engine that you want to persist to.
- store MST store The store to be persisted.
- options object Additional configuration options.
- storage localForage / AsyncStorage / localStorage
Any Storage Engine that has a Promise-style API similar to
localForage. The default islocalStorage, which has a built-in adaptor to make it support Promises. For React Native, one may configureAsyncStorageinstead.
Any ofredux-persist's Storage Engines should also be compatible withmst-persist. - jsonify bool Enables serialization as JSON (default:
true). - whitelist Array<string> Only these keys will be persisted (defaults to all keys).
- blacklist Array<string> These keys will not be persisted (defaults to all keys).
- storage localForage / AsyncStorage / localStorage
Any Storage Engine that has a Promise-style API similar to
-
returns a void Promise
Node and Server-Side Rendering (SSR) Usage
Node environments are supported so long as you configure a Storage Engine that supports Node, such as redux-persist-node-storage, redux-persist-cookie-storage, etc.
This allows you to hydrate your store server-side.
For SSR though, you may not want to hydrate your store server-side, so in that case you can call persist conditionally:
1if (typeof window !== 'undefined') { // window is undefined in Node 2 persist(...) 3}
With this conditional check, your store will only be hydrated client-side.
Examples
None yet, but can take a look at agilgur5/react-native-manga-reader-app which uses it in production. Can view the commit that implements it here.
How it works
Basically just a small wrapper around MST's onSnapshot and applySnapshot.
The source code is currently shorter than this README, so take a look under the hood! :)
Credits
Inspiration for parts of the code and API came from redux-persist, mobx-persist, and this MST persist PoC gist
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/agilgur5/mst-persist/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/agilgur5/mst-persist/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/agilgur5/mst-persist/ci.yml/main?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 1/19 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 22 are checked with a SAST tool
Reason
54 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
- Warn: Project is vulnerable to: MAL-2023-462
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3
/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