@midwayjs/session 3.13.0 → 3.13.6

package/dist/interface.d.ts

@@ -21,10 +21,14 @@ export interface ISession {
      * commit this session's headers if autoCommit is set to false.
      */
     manuallyCommit(): Promise<void>;
+    /**
+     * regenerate this session
+     */
+    regenerate(callback?: () => void): void;
     /**
      * save this session no matter whether it is populated
      */
-    save(): void;
+    save(callback?: () => void): void;
     /**
      * allow to put any value on session object
      */

package/dist/lib/context.d.ts

@@ -64,8 +64,11 @@ export declare class ContextSession {
      *
      * @api public
      */
-    commit(): Promise<void>;
-    _shouldSaveSession(): "" | "force" | "changed" | "rolling" | "renew";
+    commit({ save, regenerate }?: {
+        save?: boolean;
+        regenerate?: boolean;
+    }): Promise<void>;
+    _shouldSaveSession(): "" | "changed" | "rolling" | "renew";
     /**
      * remove session
      * @api private

package/dist/lib/context.js

@@ -194,7 +194,7 @@ class ContextSession {
      *
      * @api public
      */
-    async commit() {
+    async commit({ save = false, regenerate = false } = {}) {
         const session = this.session;
         const opts = this.opts;
         const ctx = this.ctx;
@@ -206,7 +206,15 @@ class ContextSession {
             await this.remove();
             return;
         }
-        const reason = this._shouldSaveSession();
+        if (regenerate) {
+            await this.remove();
+            if (this.store)
+                this.externalKey = opts.genid && opts.genid(ctx);
+        }
+        // force save session when `session._requireSave` set
+        const reason = save || regenerate || session._requireSave
+            ? 'force'
+            : this._shouldSaveSession();
         debug('should save session: %s', reason);
         if (!reason)
             return;
@@ -220,9 +228,6 @@ class ContextSession {
     _shouldSaveSession() {
         const prevHash = this.prevHash;
         const session = this.session;
-        // force save session when `session._requireSave` set
-        if (session._requireSave)
-            return 'force';
         // do nothing if new and not populated
         const json = session.toJSON();
         if (!prevHash && !Object.keys(json).length)

package/dist/lib/session.d.ts

@@ -61,12 +61,20 @@ export declare class Session implements ISession {
      *
      * @api public
      */
-    save(): void;
+    save(callback: any): any;
+    /**
+     * regenerate this session
+     *
+     * @param  {Function} callback the optional function to call after regenerating the session
+     * @api public
+     */
+    regenerate(callback: any): any;
     /**
      * commit this session's headers if autoCommit is set to false
      *
      * @api public
      */
-    manuallyCommit(): Promise<void>;
+    manuallyCommit(): any;
+    commit(options?: any, callback?: any): any;
 }
 //# sourceMappingURL=session.d.ts.map

package/dist/lib/session.js

@@ -96,16 +96,38 @@ class Session {
      *
      * @api public
      */
-    save() {
-        this._requireSave = true;
+    save(callback) {
+        return this.commit({ save: true }, callback);
+    }
+    /**
+     * regenerate this session
+     *
+     * @param  {Function} callback the optional function to call after regenerating the session
+     * @api public
+     */
+    regenerate(callback) {
+        return this.commit({ regenerate: true }, callback);
     }
     /**
      * commit this session's headers if autoCommit is set to false
      *
      * @api public
      */
-    async manuallyCommit() {
-        await this._sessCtx.commit();
+    manuallyCommit() {
+        return this.commit();
+    }
+    commit(options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+        const promise = this._sessCtx.commit(options);
+        if (callback) {
+            promise.then(() => callback(), callback);
+        }
+        else {
+            return promise;
+        }
     }
 }
 exports.Session = Session;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@midwayjs/session",
   "description": "midway session component for koa and faas",
-  "version": "3.13.0",
+  "version": "3.13.6",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,8 +10,8 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.13.0",
-    "@midwayjs/mock": "^3.13.0"
+    "@midwayjs/core": "^3.13.6",
+    "@midwayjs/mock": "^3.13.6"
   },
   "dependencies": {
     "@midwayjs/cookies": "^1.0.2"
@@ -39,5 +39,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "9f55734afa5b08dcf46bc89493ec8edaa8c6202b"
+  "gitHead": "684bb9ff9e66bf0d4e2e13559fac562dd9205bc4"
 }