Installations
npm install @midwayjs/sessionDeveloper Guide
Typescript
No
Module System
CommonJS
Min. Node Version
>=12
Node Version
18.20.4
NPM Version
lerna/7.4.2/node@v18.20.4+arm64 (darwin)
Score
75.3
Supply Chain
98.4
Quality
94.6
Maintenance
100
Vulnerability
100
License
Releases
Contributors
Languages
TypeScript (62.09%)
Shell (34.75%)
JavaScript (2.97%)
CSS (0.15%)
HTML (0.03%)
Developer
Download Statistics
Total Downloads
174,160
Last Day
32
Last Week
491
Last Month
3,954
Last Year
63,307
GitHub Statistics
7,462 Stars
4,080 Commits
578 Forks
100 Watching
34 Branches
172 Contributors
Bundle Size
13.97 kB
Minified
5.20 kB
Minified + Gzipped
Maintainers
Package Meta Information
Latest Version
3.20.0
Package Id
@midwayjs/session@3.20.0
Unpacked Size
42.80 kB
Size
12.40 kB
File Count
24
NPM Version
lerna/7.4.2/node@v18.20.4+arm64 (darwin)
Node Version
18.20.4
Publised On
14 Jan 2025
Total Downloads
Cumulative downloads
Total Downloads
174,160
Last day
-84.7%
32
Compared to previous day
Last week
-51.6%
491
Compared to previous week
Last month
3.9%
3,954
Compared to previous month
Last year
20%
63,307
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
2
@midwayjs/session
Session component for @midwayjs/koa and @midwayjs/faas
Install
1$ npm i @midwayjs/session --save
Usage
@midwayjs/koa has enabled this component by default, @midwayjs/faas needs to be manually enabled.
1// src/configuration.ts 2 3import { join } from 'path'; 4import * as faas from '@midwayjs/faas'; 5import * as session from '@midwayjs/session'; 6 7@Configuration({ 8 imports: [ 9 faas, 10 session, 11 ], 12 // ... 13}) 14export class ContainerLifeCycle implements ILifeCycle {} 15
Config
You can configure session in your config.*.ts.
default value.
1export const session = { 2 maxAge: 24 * 3600 * 1000, // ms 3 key: 'mw.sess', 4 httpOnly: true, 5 encrypt: true, 6 // sameSite: null, 7 logValue: true, 8};
you can use all config from koa-session.
Custom Session Store
Write a session store class first, extends abstract SessionStore class.
1import { SessionStore } from '@midwayjs/session'; 2 3@Provide() 4@Scope(ScopeEnum.Singleton) 5export class MemorySessionStore extends SessionStore { 6 sessions = {}; 7 async get(key) { 8 return this.sessions[key]; 9 } 10 11 async set(key, value) { 12 this.sessions[key] = value; 13 } 14 15 async destroy(key) { 16 this.sessions[key] = undefined; 17 } 18}
add custom sessionStore to session component.
1import { MemorySessionStore } from './store'; 2import * as session from '@midwayjs/session'; 3 4@Configuration({ 5 imports: [ 6 koa, 7 session, 8 ], 9 //... 10}) 11export class AutoConfiguration { 12 @Inject() 13 memoryStore: MemorySessionStore; 14 15 @Inject() 16 sessionStoreManager: session.SessionStoreManager; 17 18 async onReady() { 19 this.sessionStoreManager.setSessionStore(this.memoryStore); 20 } 21}
Questions & Suggestions
Please open an issue here.
License
MIT
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
no binaries found in the repo
Reason
Found 4/11 approved changesets -- score normalized to 3
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/benchmark.yml:1
- Warn: no topLevel permission defined: .github/workflows/nodejs.yml:1
- Warn: no topLevel permission defined: .github/workflows/precheck.yml:1
- Warn: no topLevel permission defined: .github/workflows/site.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
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
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 26 are checked with a SAST tool
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/benchmark.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/benchmark.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/benchmark.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/lock.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:87: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/nodejs.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/nodejs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/nodejs.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/nodejs.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/nodejs.yml:115: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/nodejs.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/precheck.yml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/precheck.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/precheck.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/precheck.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/precheck.yml:84: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/precheck.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/site.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/site.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/site.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/site.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/site.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/site.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/site.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/midwayjs/midway/site.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: benchmark/ready.sh:5
- Warn: npmCommand not pinned by hash: benchmark/ready.sh:15
- Warn: npmCommand not pinned by hash: scripts/install_npm.sh:10
- Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:49
- Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:51
- Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:101
- Warn: npmCommand not pinned by hash: .github/workflows/nodejs.yml:101
- Warn: npmCommand not pinned by hash: .github/workflows/precheck.yml:89
- Warn: npmCommand not pinned by hash: .github/workflows/site.yml:34
- Warn: npmCommand not pinned by hash: .github/workflows/site.yml:43
- Info: 0 out of 9 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 6 third-party GitHubAction dependencies pinned
- Info: 0 out of 10 npmCommand dependencies pinned
Reason
34 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-325j-24f4-qv5x
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
4.1
/10
Last Scanned on 2025-01-27
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