更新readme

Readme.md

@@ -1,4 +1,6 @@
-![module info](https://nodei.co/npm/@gm5/session.png?downloads=true&downloadRank=true&stars=true)
+
+![downloads](https://img.shields.io/npm/dt/@gm5/session.svg)
+![version](https://img.shields.io/npm/v/@gm5/session.svg)
 
 # @gm5/session
 
@@ -7,17 +9,20 @@
 ## 安装
 
 ```bash
-npm install @gm5/session
+npm i @gm5/session
 ```
 
 ## 使用
 
 ```js
-import { sessionPackage, sessionConnect } from '@gm5/session'
+import { createApp } from '@gm5/core
+import { createSession, SessionModule } from '@gm5/session'
 
-app.install(sessionPackage)
+const app = createApp()
 
-app.use(sessionConnect)
+app.install(SessionModule, {domain: 'your_domain'})
+  .use(createSession)
+  .run()
 
 
 ```

index.js

@@ -8,22 +8,38 @@ import { uuid, sha1 } from 'crypto.js'
 
 import RedisStore from './lib/redis-store.js'
 
+const DEFAULT_CONFIG = {
+  ttl: 3600 * 24 * 7,
+  domain: '', // NODESSID域, 默认等于domain
+  level: 0, // 校验级别, 0: 不校验客户端, 2: ua, 4: ip, 6: ua + ip
+  db: {
+    host: '127.0.0.1',
+    port: 6379,
+    db: 0
+  }
+}
+
 // 会话安装包
-export const sessionPackage = {
+export const SessionModule = {
   name: 'session',
-  install() {
+  install(conf = {}) {
-    var session = this.get('session')
+    if (!conf.domain) {
+      throw new Error('Please make sure to set the `domain` field')
+    }
+    let session = Object.assign({}, DEFAULT_CONFIG, conf)
+    this.set({ session })
     // 这里只创建session的存储器, 而初始化操作在中间件中进行
     return new RedisStore(session)
   }
 }
 
 // 会话中间件
-export function sessionConnect(req, res, next) {
+export function createSession() {
-  var opt = this.get('session')
+  return function (req, res, next) {
-  var cache = req.cookie('NODESSID')
+    let opt = this.get('session')
-  var deviceID = ''
+    let cache = req.cookie('NODESSID')
-  var ssid
+    let deviceID = ''
+    let ssid
 
     // options请求不处理会话
     if (req.method === 'OPTIONS') {
@@ -55,10 +71,15 @@ export function sessionConnect(req, res, next) {
       ssid = cache || sha1(uuid())
     }
 
-  res.cookie('NODESSID', ssid, { maxAge: opt.ttl, domain: opt.domain })
+    res.cookie('NODESSID', ssid, {
+      maxAge: opt.ttl,
+      httpOnly: true,
+      domain: opt.domain
+    })
     // 缓存ssid到req上
     req.ssid = ssid
-  this.$$session.start(ssid)
+    this.$$session.update(ssid)
 
     next()
   }
+}

lib/redis-store.js

@@ -3,29 +3,33 @@
  * @author yutent<yutent.io@gmail.com>
  * @date 2020/09/18 16:35:26
  */
-
+import 'es.shim'
 import Ioredis from 'ioredis'
 
 export default class Session {
+
+  #store = null
+  #ttl = 60
+
   constructor(opt) {
-    this.store = new Ioredis({
+    this.#store = new Ioredis({
       host: opt.db.host || '127.0.0.1',
       port: opt.db.port || 6379,
       db: opt.db.db || 0
     })
-    this.ttl = opt.ttl
+    this.#ttl = opt.ttl
   }
 
-  start(ssid) {
+  update(ssid) {
     // 设置session有效期
-    this.store.expire(ssid, this.ttl)
+    this.#store.expire(ssid, this.#ttl)
   }
 
   // 获取session字段值, 需要await指令
   get(ssid, key) {
-    var defer = Promise.defer()
+    let defer = Promise.defer()
 
-    this.store.hgetall(ssid, (err, obj) => {
+    this.#store.hgetall(ssid, (err, obj) => {
       if (err) {
         return defer.reject(err)
       }
@@ -37,7 +41,7 @@ export default class Session {
       }
       //不传key时,直接返回全部字段
       if (key) {
-        defer.resolve(obj.hasOwnProperty(key) ? obj[key] : null)
+        defer.resolve(obj[key])
       } else {
         defer.resolve(obj)
       }
@@ -49,20 +53,20 @@ export default class Session {
   set(ssid, key, val) {
     if (typeof key === 'object') {
       for (let i in key) {
-        this.store.hset(ssid, i, key[i])
+        this.#store.hset(ssid, i, key[i])
       }
     } else {
-      this.store.hset(ssid, key, val)
+      this.#store.hset(ssid, key, val)
     }
   }
 
   //删除单个字段
   unset(ssid, key) {
-    this.store.hdel(ssid, key)
+    this.#store.hdel(ssid, key)
   }
 
   //清除个人session
   clear(ssid) {
-    this.store.del(ssid)
+    this.#store.del(ssid)
   }
 }

package.json

@@ -1,15 +1,21 @@
 {
   "name": "@gm5/session",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "type": "module",
   "description": "会话中间件。",
   "main": "index.js",
   "author": "yutent <yutent.io@gmail.com>",
-  "keywords": ["fivejs", "session", "http"],
+  "keywords": [
+    "fivejs",
+    "gm5",
+    "session",
+    "http"
+  ],
   "dependencies": {
-    "crypto.js": "^2.0.2",
+    "crypto.js": "^3.1.2",
-    "ioredis": "^4.17.3"
+    "ioredis": "^5.3.2",
+    "es.shim": "^2.2.0"
   },
-  "repository": "https://github.com/bytedo/gmf.session.git",
+  "repository": "https://git.wkit.fun/gm5/session.git",
   "license": "MIT"
 }