@midwayjs/express-session 3.0.0-beta.9

package/README.md

@@ -0,0 +1,76 @@
+# @midwayjs/express-session
+
+Session component for @midwayjs/express
+
+
+## Install
+
+```bash
+$ npm i @midwayjs/express-session --save
+$ npm i @types/express-session --save-dev
+```
+
+
+## Usage
+
+@midwayjs/express has enabled this component by default.
+
+We use [cookie-session](https://github.com/expressjs/cookie-session) to keep session by default and use [express-session](https://github.com/expressjs/session) when set custom session store.
+
+## Config
+
+You can configure session in your `config.*.ts`.
+
+default value.
+
+```ts
+export const session = {
+  secret: undefined, // must be set in application
+  name: 'MW_SESS',
+  cookie: {
+    maxAge: 24 * 3600 * 1000, // ms
+    httpOnly: true,
+    // sameSite: null,
+  },
+};
+```
+
+You can set 'session.cookie' for cookie-session config.
+
+## Custom Session Store
+
+You can use compatible session store [here](https://github.com/expressjs/session#compatible-session-stores).
+
+Let's give an example for [memorystore](https://github.com/roccomuso/memorystore).
+
+```ts
+import { Configuration, Inject } from '@midwayjs/decorator';
+import * as session from '@midwayjs/express-session';
+import MemoryStore = require('memorystore');
+
+@Configuration({
+  imports: [
+    express,
+    session,
+  ],
+  //...
+})
+export class AutoConfiguration {
+  @Inject()
+  sessionStoreManager: session.SessionStoreManager;
+
+  async onReady() {
+    this.sessionStoreManager.setSessionStore(MemoryStore, {
+      checkPeriod: 86400000 // prune expired entries every 24h
+    });
+  }
+}
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/midwayjs/midway/issues/).
+
+## License
+
+MIT

package/dist/config/config.default.d.ts

@@ -0,0 +1,3 @@
+import { SessionOptions } from 'express-session';
+export declare const session: SessionOptions;
+//# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.session = void 0;
+exports.session = {
+    secret: undefined,
+    name: 'MW_SESS',
+    resave: true,
+    saveUninitialized: true,
+    cookie: {
+        maxAge: 24 * 3600 * 1000,
+        httpOnly: true,
+        // sameSite: null,
+    },
+};
+//# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -0,0 +1,6 @@
+import { MidwayApplicationManager } from '@midwayjs/core';
+export declare class SessionConfiguration {
+    applicationManager: MidwayApplicationManager;
+    onReady(): Promise<void>;
+}
+//# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -0,0 +1,39 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionConfiguration = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const DefaultConfig = require("./config/config.default");
+const session_1 = require("./middleware/session");
+const core_1 = require("@midwayjs/core");
+let SessionConfiguration = class SessionConfiguration {
+    async onReady() {
+        this.applicationManager.getApplications(['express']).forEach(app => {
+            app.useMiddleware(session_1.SessionMiddleware);
+        });
+    }
+};
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], SessionConfiguration.prototype, "applicationManager", void 0);
+SessionConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        namespace: 'session',
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
+    })
+], SessionConfiguration);
+exports.SessionConfiguration = SessionConfiguration;
+//# sourceMappingURL=configuration.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { SessionConfiguration as Configuration } from './configuration';
+export * from './middleware/session';
+export * from './store';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Configuration = void 0;
+var configuration_1 = require("./configuration");
+Object.defineProperty(exports, "Configuration", { enumerable: true, get: function () { return configuration_1.SessionConfiguration; } });
+__exportStar(require("./middleware/session"), exports);
+__exportStar(require("./store"), exports);
+//# sourceMappingURL=index.js.map

package/dist/middleware/session.d.ts

@@ -0,0 +1,10 @@
+import { IMiddleware, MidwayConfigService } from '@midwayjs/core';
+import { SessionStoreManager } from '../store';
+export declare class SessionMiddleware implements IMiddleware<any, any> {
+    sessionConfig: any;
+    logger: any;
+    sessionStoreManager: SessionStoreManager;
+    configService: MidwayConfigService;
+    resolve(): any;
+}
+//# sourceMappingURL=session.d.ts.map

package/dist/middleware/session.js

@@ -0,0 +1,64 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionMiddleware = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const core_1 = require("@midwayjs/core");
+const session = require("express-session");
+const cookieSession = require("cookie-session");
+const store_1 = require("../store");
+let SessionMiddleware = class SessionMiddleware {
+    resolve() {
+        var _a, _b;
+        const secret = (_b = (_a = this.sessionConfig.secret) !== null && _a !== void 0 ? _a : this.configService.getConfiguration('express.keys')) !== null && _b !== void 0 ? _b : this.configService.getConfiguration('keys');
+        if (!secret) {
+            throw new core_1.MidwayConfigMissingError('config.session.secret');
+        }
+        this.sessionConfig.secret = [].concat(secret);
+        if (!this.sessionConfig.cookie.httpOnly) {
+            this.logger.warn('[midway-session]: please set `config.session.cookie.httpOnly` to true. It is very dangerous if session can read by client JavaScript.');
+        }
+        const store = this.sessionStoreManager.getSessionStore(session);
+        if (store) {
+            this.sessionConfig.store = store;
+        }
+        if (!this.sessionConfig.store) {
+            return cookieSession(Object.assign(this.sessionConfig.cookie, {
+                keys: this.sessionConfig.secret,
+                name: this.sessionConfig.name,
+            }));
+        }
+        else {
+            return session(this.sessionConfig);
+        }
+    }
+};
+__decorate([
+    (0, decorator_1.Config)('session'),
+    __metadata("design:type", Object)
+], SessionMiddleware.prototype, "sessionConfig", void 0);
+__decorate([
+    (0, decorator_1.Logger)(),
+    __metadata("design:type", Object)
+], SessionMiddleware.prototype, "logger", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", store_1.SessionStoreManager)
+], SessionMiddleware.prototype, "sessionStoreManager", void 0);
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayConfigService)
+], SessionMiddleware.prototype, "configService", void 0);
+SessionMiddleware = __decorate([
+    (0, decorator_1.Middleware)()
+], SessionMiddleware);
+exports.SessionMiddleware = SessionMiddleware;
+//# sourceMappingURL=session.js.map

package/dist/store.d.ts

@@ -0,0 +1,8 @@
+export declare class SessionStoreManager {
+    private sessionStoreClz;
+    private sessionStore;
+    private sessionStoreOptions;
+    setSessionStore(sessionStore: any, options: any): void;
+    getSessionStore(session?: any): any;
+}
+//# sourceMappingURL=store.d.ts.map

package/dist/store.js

@@ -0,0 +1,28 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionStoreManager = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+let SessionStoreManager = class SessionStoreManager {
+    setSessionStore(sessionStore, options) {
+        this.sessionStoreClz = sessionStore;
+        this.sessionStoreOptions = options;
+    }
+    getSessionStore(session) {
+        if (!this.sessionStore && this.sessionStoreClz) {
+            this.sessionStore = new (this.sessionStoreClz(session))(this.sessionStoreOptions);
+        }
+        return this.sessionStore;
+    }
+};
+SessionStoreManager = __decorate([
+    (0, decorator_1.Provide)(),
+    (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
+], SessionStoreManager);
+exports.SessionStoreManager = SessionStoreManager;
+//# sourceMappingURL=store.js.map

package/index.d.ts

@@ -0,0 +1,8 @@
+import { SessionOptions } from 'express-session';
+export * from './dist/index';
+
+declare module '@midwayjs/core/dist/interface' {
+  interface MidwayConfig {
+    session: Partial<SessionOptions>;
+  }
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@midwayjs/express-session",
+  "description": "midway session component for express",
+  "version": "3.0.0-beta.9",
+  "main": "dist/index",
+  "typings": "index.d.ts",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "@midwayjs/core": "^3.0.0-beta.9",
+    "@midwayjs/decorator": "^3.0.0-beta.9",
+    "@midwayjs/mock": "^3.0.0-beta.9",
+    "@types/express-session": "^1.17.4",
+    "memorystore": "^1.6.6"
+  },
+  "dependencies": {
+    "cookie-session": "^1.4.0",
+    "express-session": "^1.17.2"
+  },
+  "keywords": [
+    "midway",
+    "web",
+    "express",
+    "session"
+  ],
+  "author": "czy88840616 <czy88840616@gmail.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "ci": "npm run test",
+    "lint": "mwts check"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/midwayjs/midway.git"
+  }
+}